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