gnunet-nse.1: follow standards
[oweals/gnunet.git] / doc / man / gnunet-statistics.1
1 .TH GNUNET-STATISTICS 1 "January 4, 2012" "GNUnet"
2 .SH NAME
3 gnunet\-statistics \- Display statistics about your GNUnet system
4 .SH SYNOPSIS
5 .B gnunet\-statistics
6 .RI [ options ]
7 .RI [ VALUE ]
8 .SH DESCRIPTION
9 \fBgnunet\-statistics\fP is used to display detailed information about
10 various aspect of GNUnet's operation.  This tool only works if the
11 "statistics" service is available.
12 gnunet\-statistics can be used to set a value by giving the options
13 \-n, \-s and also a VALUE.
14 .SH OPTIONS
15 .IP "\-c FILENAME,  \-\-config=FILENAME"
16 Use the configuration file FILENAME.
17 .IP "\-h, \-\-help"
18 Print short help on options.
19 .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
20 Use LOGLEVEL for logging.  Valid values are DEBUG, INFO, WARNING and ERROR.
21 .IP "\-n NAME,  \-\-name=NAME"
22 Each statistic has a name that is unique with in its subsystem.  With
23 this option, the output can be restricted to statistics that have a
24 particular name.
25 .IP "\-p,  \-\-persistent"
26 When setting a value, make the value persistent.  If the value used to
27 be persistent and this flag is not given, it will be marked as
28 non\-persistent.
29 .IP "\-s SUBSYSTEM,  \-\-subsystem=SUBSYSTEM"
30 Statistics are kept for various subsystems.  With this option, the
31 output can be restricted to a particular subsystem only.
32 .IP "\-S SEPARATOR,  \-\-csv-separator=SEPARATOR"
33 Specify a separator for generating csv-output.
34 .IP "\-t TESTBED_PATH,  \-\-subsystem=TESTBED_PATH"
35 When running testbed, you can get statistics of all peers with specefying the
36 folder containing the data of all testbed nodes like \fBgnunet\-statistics -t /tmp/testbedARtmQv\fP.
37 .IP "\-v, \-\-version"
38 Print GNUnet version number.
39 .SH BUGS
40 Report bugs by using Mantis <https://gnunet.org/mantis/> or by sending
41 electronic mail to <gnunet\-developers@gnu.org>
42 .SH SEE ALSO
43 gnunet\-service\-statistics(1)
44 .PP
45 The full documentation for
46 .B gnunet
47 is maintained as a Texinfo manual.
48 If the
49 .B info
50 and
51 .B gnunet
52 programs are properly installed at your site, the command
53 .IP
54 .B info gnunet
55 .PP
56 should give you access to the complete handbook,
57 .IP
58 .B info gnunet-c-tutorial
59 .PP
60 will give you access to a tutorial for developers.
61 .PP
62 Depending on your installation, this information is also
63 available in
64 \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).