gnunet-statistics.1 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114
  1. .\" This file is part of GNUnet.
  2. .\" Copyright (C) 2001-2019 GNUnet e.V.
  3. .\"
  4. .\" Permission is granted to copy, distribute and/or modify this document
  5. .\" under the terms of the GNU Free Documentation License, Version 1.3 or
  6. .\" any later version published by the Free Software Foundation; with no
  7. .\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
  8. .\" copy of the license is included in the file
  9. .\" FDL-1.3.
  10. .\"
  11. .\" A copy of the license is also available from the Free Software
  12. .\" Foundation Web site at http://www.gnu.org/licenses/fdl.html}.
  13. .\"
  14. .\" Alternately, this document is also available under the General
  15. .\" Public License, version 3 or later, as published by the Free Software
  16. .\" Foundation. A copy of the license is included in the file
  17. .\" GPL3.
  18. .\"
  19. .\" A copy of the license is also available from the Free Software
  20. .\" Foundation Web site at http://www.gnu.org/licenses/gpl.html
  21. .\"
  22. .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
  23. .\"
  24. .Dd January 4, 2012
  25. .Dt GNUNET-STATISTICS 1
  26. .Os
  27. .Sh NAME
  28. .Nm gnunet-statistics
  29. .Nd display statistics about your GNUnet system
  30. .Sh SYNOPSIS
  31. .Nm
  32. .Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
  33. .Op Fl h | -help
  34. .Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
  35. .Op Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME
  36. .Op Fl n Ar NAME | Fl -name= Ns Ar NAME
  37. .Op Fl o Ar PORT | Fl -port= Ns Ar PORT
  38. .Op Fl p | -persistent
  39. .Op Fl q | -quiet
  40. .Op Fl r Ar REMOTE | Fl -remote= Ns Ar REMOTE
  41. .Op Fl S Ar SEPARATOR | Fl -csv-separator= Ns Ar SEPARATOR
  42. .Op Fl s Ar SUBSYSTEM | Fl -subsystem= Ns Ar SUBSYSTEM
  43. .Op Fl t Ar PATH | Fl -testbed= Ns Ar PATH
  44. .Op Fl v | -version
  45. .Op Fl w | -watch
  46. .Ao Ar VALUE Ac
  47. .Sh DESCRIPTION
  48. .Nm
  49. is used to display detailed information about various aspect of GNUnet's operation.
  50. This tool only works if the "statistics" service is available.
  51. gnunet-statistics can be used to set a value by giving the options -n, -s and also a VALUE.
  52. .Bl -tag -width indent
  53. .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
  54. Use the configuration file FILENAME.
  55. .It Fl h | -help
  56. Print short help on options.
  57. .It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
  58. Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
  59. .It Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME
  60. Configure logging to write logs to FILENAME
  61. .It Fl n Ar NAME | Fl -name= Ns Ar NAME
  62. Each statistic has a NAME that is unique with in its subsystem.
  63. With this option, the output can be restricted to statistics that have a particular NAME.
  64. .It Fl o Ar PORT | Fl -port= Ns Ar PORT
  65. PORT for remote host
  66. .It Fl p | -persistent
  67. When setting a value, make the value persistent.
  68. If the value used to be persistent and this flag is not given, it will be marked as non-persistent.
  69. .It Fl q | -quiet
  70. Just print the statistics value
  71. .It Fl r Ar REMOTE | Fl -remote= Ns Ar REMOTE
  72. Connect to a remote host given as REMOTE.
  73. .It Fl S Ar SEPARATOR | Fl -csv-separator= Ns Ar SEPARATOR
  74. Specify a separator for generating csv-output.
  75. .It Fl s Ar SUBSYSTEM | Fl -subsystem= Ns Ar SUBSYSTEM
  76. Statistics are kept for various subsystems.
  77. With this option, the output can be restricted to a particular subsystem only.
  78. .It Fl t Ar PATH | Fl -testbed= Ns Ar PATH
  79. When running testbed, you can get statistics of all peers with specefying the
  80. folder containing the data of all testbed nodes like
  81. .Pp
  82. .Dl $ gnunet-statistics -t /tmp/testbedARtmQv
  83. .Pp
  84. .It Fl v | -version
  85. Print GNUnet version number.
  86. .It Fl w | -watch
  87. Watch value continuously.
  88. .El
  89. .Sh SEE ALSO
  90. .Xr gnunet-service-statistics 1
  91. .sp
  92. The full documentation for gnunet is maintained as a Texinfo manual.
  93. If the
  94. .Xr info 1
  95. and gnunet programs are properly installed at your site, the command
  96. .Pp
  97. .Dl info gnunet
  98. .Pp
  99. should give you access to the complete handbook,
  100. .Pp
  101. .Dl info gnunet-c-tutorial
  102. .Pp
  103. will give you access to a tutorial for developers.
  104. .sp
  105. Depending on your installation, this information is also available in
  106. .Xr gnunet 7 and
  107. .Xr gnunet-c-tutorial 7 .
  108. .\".Sh HISTORY
  109. .\".Sh AUTHORS
  110. .Sh BUGS
  111. Report bugs by using
  112. .Lk https://bugs.gnunet.org
  113. or by sending electronic mail to
  114. .Aq Mt gnunet-developers@gnu.org .