aboutsummaryrefslogtreecommitdiff
path: root/doc/man/gnunet-statistics.1
diff options
context:
space:
mode:
authorng0 <ng0@n0.is>2019-04-03 10:19:31 +0000
committerng0 <ng0@n0.is>2019-04-03 10:19:31 +0000
commitc1eea71192ecdd9dd978acd9ea756af56273d3ee (patch)
tree65d76f8efc7ffc9e6a89989e76d00d26eda5e06d /doc/man/gnunet-statistics.1
parent93ec9874d03589b4f67ce58c7f36d69d5eaee1fe (diff)
downloadgnunet-c1eea71192ecdd9dd978acd9ea756af56273d3ee.tar.gz
gnunet-c1eea71192ecdd9dd978acd9ea756af56273d3ee.zip
man: statistics (update)
Diffstat (limited to 'doc/man/gnunet-statistics.1')
-rw-r--r--doc/man/gnunet-statistics.1137
1 files changed, 82 insertions, 55 deletions
diff --git a/doc/man/gnunet-statistics.1 b/doc/man/gnunet-statistics.1
index 9b5d52ccc..c0d5e8fe3 100644
--- a/doc/man/gnunet-statistics.1
+++ b/doc/man/gnunet-statistics.1
@@ -1,64 +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.IP "\-c FILENAME, \-\-config=FILENAME" 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
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
16Use the configuration file FILENAME. 31Use the configuration file FILENAME.
17.IP "\-h, \-\-help" 32.It Fl h | \-help
18Print short help on options. 33Print short help on options.
19.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 34.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
20Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. 35Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
21.IP "\-n NAME, \-\-name=NAME" 36.It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
22Each statistic has a name that is unique with in its subsystem. With 37Configure logging to write logs to FILENAME
23this option, the output can be restricted to statistics that have a 38.It Fl n Ar NAME | Fl \-name= Ns Ar NAME
24particular name. 39Each statistic has a NAME that is unique with in its subsystem.
25.IP "\-p, \-\-persistent" 40With this option, the output can be restricted to statistics that have a particular NAME.
26When setting a value, make the value persistent. If the value used to 41.It Fl o Ar PORT | Fl \-port= Ns Ar PORT
27be persistent and this flag is not given, it will be marked as 42PORT for remote host
28non\-persistent. 43.It Fl p | \-persistent
29.IP "\-s SUBSYSTEM, \-\-subsystem=SUBSYSTEM" 44When setting a value, make the value persistent.
30Statistics are kept for various subsystems. With this option, the 45If the value used to be persistent and this flag is not given, it will be marked as non-persistent.
31output can be restricted to a particular subsystem only. 46.It Fl q | \-quiet
32.IP "\-S SEPARATOR, \-\-csv-separator=SEPARATOR" 47Just print the statistics value
48.It Fl r Ar REMOTE | Fl \-remote= Ns Ar REMOTE
49Connect to a remote host given as REMOTE.
50.It Fl S Ar SEPARATOR | Fl \-csv-separator= Ns Ar SEPARATOR
33Specify a separator for generating csv-output. 51Specify a separator for generating csv-output.
34.IP "\-t TESTBED_PATH, \-\-subsystem=TESTBED_PATH" 52.It Fl s Ar SUBSYSTEM | Fl \-subsystem= Ns Ar SUBSYSTEM
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
35When 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
36folder containing the data of all testbed nodes like \fBgnunet\-statistics -t /tmp/testbedARtmQv\fP. 57folder containing the data of all testbed nodes like
37.IP "\-v, \-\-version" 58.Pp
59.Dl $ gnunet-statistics -t /tmp/testbedARtmQv
60.Pp
61.It Fl v | \-version
38Print GNUnet version number. 62Print GNUnet version number.
39.SH BUGS 63.It Fl w | \-watch
40Report bugs by using Mantis <https://gnunet.org/mantis/> or by sending 64Watch value continuously.
41electronic mail to <gnunet\-developers@gnu.org> 65.El
42.SH SEE ALSO 66.Sh SEE ALSO
43gnunet\-service\-statistics(1) 67.Xr gnunet-service-statistics 1
44.PP 68.sp
45The full documentation for 69The full documentation for gnunet is maintained as a Texinfo manual.
46.B gnunet
47is maintained as a Texinfo manual.
48If the 70If the
49.B info 71.Xr info 1
50and 72and gnunet programs are properly installed at your site, the command
51.B gnunet 73.Pp
52programs are properly installed at your site, the command 74.Dl info gnunet
53.IP 75.Pp
54.B info gnunet
55.PP
56should give you access to the complete handbook, 76should give you access to the complete handbook,
57.IP 77.Pp
58.B info gnunet-c-tutorial 78.Dl info gnunet-c-tutorial
59.PP 79.Pp
60will give you access to a tutorial for developers. 80will give you access to a tutorial for developers.
61.PP 81.sp
62Depending on your installation, this information is also 82Depending on your installation, this information is also available in
63available in 83.Xr gnunet 7 and
64\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 .