diff options
author | ng0 <ng0@n0.is> | 2019-04-03 10:19:31 +0000 |
---|---|---|
committer | ng0 <ng0@n0.is> | 2019-04-03 10:19:31 +0000 |
commit | c1eea71192ecdd9dd978acd9ea756af56273d3ee (patch) | |
tree | 65d76f8efc7ffc9e6a89989e76d00d26eda5e06d | |
parent | 93ec9874d03589b4f67ce58c7f36d69d5eaee1fe (diff) | |
download | gnunet-c1eea71192ecdd9dd978acd9ea756af56273d3ee.tar.gz gnunet-c1eea71192ecdd9dd978acd9ea756af56273d3ee.zip |
man: statistics (update)
-rw-r--r-- | doc/man/gnunet-statistics.1 | 137 |
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 |
3 | gnunet\-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 |
10 | various 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 |
12 | gnunet\-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 | ||
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 | ||
16 | Use the configuration file FILENAME. | 31 | Use the configuration file FILENAME. |
17 | .IP "\-h, \-\-help" | 32 | .It Fl h | \-help |
18 | Print short help on options. | 33 | Print short help on options. |
19 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | 34 | .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL |
20 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. | 35 | Use 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 |
22 | Each statistic has a name that is unique with in its subsystem. With | 37 | Configure logging to write logs to FILENAME |
23 | this option, the output can be restricted to statistics that have a | 38 | .It Fl n Ar NAME | Fl \-name= Ns Ar NAME |
24 | particular name. | 39 | Each statistic has a NAME that is unique with in its subsystem. |
25 | .IP "\-p, \-\-persistent" | 40 | With this option, the output can be restricted to statistics that have a particular NAME. |
26 | When setting a value, make the value persistent. If the value used to | 41 | .It Fl o Ar PORT | Fl \-port= Ns Ar PORT |
27 | be persistent and this flag is not given, it will be marked as | 42 | PORT for remote host |
28 | non\-persistent. | 43 | .It Fl p | \-persistent |
29 | .IP "\-s SUBSYSTEM, \-\-subsystem=SUBSYSTEM" | 44 | When setting a value, make the value persistent. |
30 | Statistics are kept for various subsystems. With this option, the | 45 | If the value used to be persistent and this flag is not given, it will be marked as non-persistent. |
31 | output can be restricted to a particular subsystem only. | 46 | .It Fl q | \-quiet |
32 | .IP "\-S SEPARATOR, \-\-csv-separator=SEPARATOR" | 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 | ||
33 | Specify a separator for generating csv-output. | 51 | Specify 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 |
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 | ||
35 | When running testbed, you can get statistics of all peers with specefying the | 56 | 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. | 57 | folder 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 | ||
38 | Print GNUnet version number. | 62 | Print GNUnet version number. |
39 | .SH BUGS | 63 | .It Fl w | \-watch |
40 | Report bugs by using Mantis <https://gnunet.org/mantis/> or by sending | 64 | Watch value continuously. |
41 | electronic mail to <gnunet\-developers@gnu.org> | 65 | .El |
42 | .SH SEE ALSO | 66 | .Sh SEE ALSO |
43 | gnunet\-service\-statistics(1) | 67 | .Xr gnunet-service-statistics 1 |
44 | .PP | 68 | .sp |
45 | The full documentation for | 69 | The full documentation for gnunet is maintained as a Texinfo manual. |
46 | .B gnunet | ||
47 | is maintained as a Texinfo manual. | ||
48 | If the | 70 | If the |
49 | .B info | 71 | .Xr info 1 |
50 | and | 72 | and gnunet programs are properly installed at your site, the command |
51 | .B gnunet | 73 | .Pp |
52 | programs are properly installed at your site, the command | 74 | .Dl info gnunet |
53 | .IP | 75 | .Pp |
54 | .B info gnunet | ||
55 | .PP | ||
56 | should give you access to the complete handbook, | 76 | should 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 |
60 | will give you access to a tutorial for developers. | 80 | will give you access to a tutorial for developers. |
61 | .PP | 81 | .sp |
62 | Depending on your installation, this information is also | 82 | Depending on your installation, this information is also available in |
63 | available 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 | ||
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 . | ||