doc/man/gnunet-statistics.1

   1 .Dd January 4, 2012
   2 .Dt GNUNET-STATISTICS 1
   3 .Os
   4 .Sh NAME
   5 .Nm gnunet-statistics
   6 .Nd display statistics about your GNUnet system
   7 .Sh SYNOPSIS
   8 .Nm
   9 .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
  10 .Op Fl h | \-help
  11 .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
  12 .Op Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
  13 .Op Fl n Ar NAME | Fl \-name= Ns Ar NAME
  14 .Op Fl o Ar PORT | Fl \-port= Ns Ar PORT
  15 .Op Fl p | \-persistent
  16 .Op Fl q | \-quiet
  17 .Op Fl r Ar REMOTE | Fl \-remote= Ns Ar REMOTE
  18 .Op Fl S Ar SEPARATOR | Fl \-csv-separator= Ns Ar SEPARATOR
  19 .Op Fl s Ar SUBSYSTEM | Fl \-subsystem= Ns Ar SUBSYSTEM
  20 .Op Fl t Ar PATH | Fl \-testbed= Ns Ar PATH
  21 .Op Fl v | \-version
  22 .Op Fl w | \-watch
  23 .Ao Ar VALUE Ac
  24 .Sh DESCRIPTION
  25 .Nm
  26 is used to display detailed information about various aspect of GNUnet's operation.
  27 This tool only works if the "statistics" service is available.
  28 gnunet-statistics can be used to set a value by giving the options \-n, \-s and also a VALUE.
  29 .Bl -tag -width Ds
  30 .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
  31 Use the configuration file FILENAME.
  32 .It Fl h | \-help
  33 Print short help on options.
  34 .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
  35 Use LOGLEVEL for logging.  Valid values are DEBUG, INFO, WARNING and ERROR.
  36 .It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
  37 Configure logging to write logs to FILENAME
  38 .It Fl n Ar NAME | Fl \-name= Ns Ar NAME
  39 Each statistic has a NAME that is unique with in its subsystem.
  40 With this option, the output can be restricted to statistics that have a particular NAME.
  41 .It Fl o Ar PORT | Fl \-port= Ns Ar PORT
  42 PORT for remote host
  43 .It Fl p | \-persistent
  44 When setting a value, make the value persistent.
  45 If the value used to be persistent and this flag is not given, it will be marked as non-persistent.
  46 .It Fl q | \-quiet
  47 Just print the statistics value
  48 .It Fl r Ar REMOTE | Fl \-remote= Ns Ar REMOTE
  49 Connect to a remote host given as REMOTE.
  50 .It Fl S Ar SEPARATOR | Fl \-csv-separator= Ns Ar SEPARATOR
  51 Specify a separator for generating csv-output.
  52 .It Fl s Ar SUBSYSTEM | Fl \-subsystem= Ns Ar SUBSYSTEM
  53 Statistics are kept for various subsystems.
  54 With this option, the output can be restricted to a particular subsystem only.
  55 .It Fl t Ar PATH | Fl \-testbed= Ns Ar PATH
  56 When running testbed, you can get statistics of all peers with specefying the
  57 folder containing the data of all testbed nodes like
  58 .Pp
  59 .Dl $ gnunet-statistics -t /tmp/testbedARtmQv
  60 .Pp
  61 .It Fl v | \-version
  62 Print GNUnet version number.
  63 .It Fl w | \-watch
  64 Watch value continuously.
  65 .El
  66 .Sh SEE ALSO
  67 .Xr gnunet-service-statistics 1
  68 .sp
  69 The full documentation for gnunet is maintained as a Texinfo manual.
  70 If the
  71 .Xr info 1
  72 and gnunet programs are properly installed at your site, the command
  73 .Pp
  74 .Dl info gnunet
  75 .Pp
  76 should give you access to the complete handbook,
  77 .Pp
  78 .Dl info gnunet-c-tutorial
  79 .Pp
  80 will give you access to a tutorial for developers.
  81 .sp
  82 Depending on your installation, this information is also available in
  83 .Xr gnunet 7 and
  84 .Xr gnunet-c-tutorial 7 .
  85 .\".Sh HISTORY
  86 .\".Sh AUTHORS
  87 .Sh BUGS
  88 Report bugs by using
  89 .Lk https://bugs.gnunet.org
  90 or by sending electronic mail to
  91 .Aq Mt gnunet-developers@gnu.org .