diff options
author | Christian Grothoff <christian@grothoff.org> | 2009-05-29 00:46:26 +0000 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2009-05-29 00:46:26 +0000 |
commit | 0a217a8df1657b4334b55b0e4a6c7837a8dbcfd9 (patch) | |
tree | 6b552f40eb089db96409a312a98d9b12bd669102 /doc/man | |
download | gnunet-0a217a8df1657b4334b55b0e4a6c7837a8dbcfd9.tar.gz gnunet-0a217a8df1657b4334b55b0e4a6c7837a8dbcfd9.zip |
ng
Diffstat (limited to 'doc/man')
-rw-r--r-- | doc/man/Makefile.am | 7 | ||||
-rw-r--r-- | doc/man/gnunet-arm.1 | 57 | ||||
-rw-r--r-- | doc/man/gnunet-peerinfo.1 | 42 | ||||
-rw-r--r-- | doc/man/gnunet-statistics.1 | 50 | ||||
-rw-r--r-- | doc/man/gnunet-transport.1 | 96 |
5 files changed, 252 insertions, 0 deletions
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am new file mode 100644 index 000000000..734fc9c85 --- /dev/null +++ b/doc/man/Makefile.am | |||
@@ -0,0 +1,7 @@ | |||
1 | man_MANS = \ | ||
2 | gnunet-arm.1 \ | ||
3 | gnunet-peerinfo.1 \ | ||
4 | gnunet-statistics.1 \ | ||
5 | gnunet-transport.c | ||
6 | |||
7 | EXTRA_DIST = ${man_MANS} | ||
diff --git a/doc/man/gnunet-arm.1 b/doc/man/gnunet-arm.1 new file mode 100644 index 000000000..e440479c3 --- /dev/null +++ b/doc/man/gnunet-arm.1 | |||
@@ -0,0 +1,57 @@ | |||
1 | .TH GNUNET\-ARM 1 "Mar 7, 2009" "GNUnet" | ||
2 | |||
3 | .SH NAME | ||
4 | gnunet\-arm \- control GNUnet services | ||
5 | |||
6 | .SH SYNOPSIS | ||
7 | .B gnunet-arm | ||
8 | .RI [ options ] | ||
9 | .br | ||
10 | |||
11 | .SH DESCRIPTION | ||
12 | \fBgnunet\-arm\fP can be used to start or stop GNUnet services, including the ARM service itself. | ||
13 | |||
14 | .SH OPTIONS | ||
15 | |||
16 | .TP | ||
17 | .IP "\-c FILENAME, \-\-config=FILENAME" | ||
18 | Use the configuration file FILENAME. | ||
19 | |||
20 | .TP | ||
21 | .IP "\-e, \-\-end" | ||
22 | Shutdown all GNUnet services (including ARM). | ||
23 | |||
24 | .TP | ||
25 | .IP "\-h, \-\-help" | ||
26 | Print short help on options. | ||
27 | |||
28 | .TP | ||
29 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | ||
30 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. | ||
31 | |||
32 | .TP | ||
33 | .IP "\-i SERVICE, \-\-init=SERVICE" | ||
34 | Starts the specified SERVICE if it is not already running. | ||
35 | |||
36 | .TP | ||
37 | .IP "\-k SERVICE, \-\-kill=SERVICE" | ||
38 | Stop the specified SERVICE if it is running. | ||
39 | |||
40 | .TP | ||
41 | .IP "\-s, \-\-start" | ||
42 | Start all GNUnet default services on this system (including ARM). | ||
43 | |||
44 | .TP | ||
45 | .IP "\-t SERVICE, \-\-test=SERVICE" | ||
46 | Report if the specified SERVICE is running. | ||
47 | |||
48 | .TP | ||
49 | .IP "\-v, \-\-version" | ||
50 | Print GNUnet version number. | ||
51 | |||
52 | |||
53 | .SH BUGS | ||
54 | Report bugs by using Mantis <https://gnunet.org/mantis/> or by sending electronic mail to <gnunet\-developers@gnu.org> | ||
55 | |||
56 | .SH SEE ALSO | ||
57 | gnunet\-service\-arm(1) | ||
diff --git a/doc/man/gnunet-peerinfo.1 b/doc/man/gnunet-peerinfo.1 new file mode 100644 index 000000000..2980d3544 --- /dev/null +++ b/doc/man/gnunet-peerinfo.1 | |||
@@ -0,0 +1,42 @@ | |||
1 | .TH GNUNET-PEERINFO 1 "Mar 15, 2009" "GNUnet" | ||
2 | |||
3 | .SH NAME | ||
4 | gnunet\-peerinfo \- Display information about other peers. | ||
5 | |||
6 | .SH SYNOPSIS | ||
7 | .B gnunet\-peerinfo | ||
8 | .RI [ options ] | ||
9 | .br | ||
10 | |||
11 | .SH DESCRIPTION | ||
12 | .PP | ||
13 | \fBgnunet\-peerinfo\fP display the known addresses and trust of known peers. | ||
14 | |||
15 | .SH OPTIONS | ||
16 | .B | ||
17 | .IP "\-c FILENAME, \-\-config=FILENAME" | ||
18 | Load config file (default: /etc/gnunet.conf) | ||
19 | .B | ||
20 | .IP "\-h, \-\-help" | ||
21 | Print help page | ||
22 | .B | ||
23 | .IP "\-n, \-\-numeric" | ||
24 | Disable resolution of IPs to hostnames | ||
25 | .B | ||
26 | .IP "\-q, \-\-quiet" | ||
27 | Do not print anything but the peer identities | ||
28 | .B | ||
29 | .IP "\-s, \-\-self" | ||
30 | Print only our own identity (together with "\-q", this is the exact line that other peers would have to put in to their friends file in order to consider this peer one of their friends in F2F mode). | ||
31 | .B | ||
32 | .IP "\-v, \-\-version" | ||
33 | Print the version number | ||
34 | .B | ||
35 | .IP "\-L LOGLEVEL, \-\-loglelvel=LOGLEVEL" | ||
36 | Set the loglevel | ||
37 | |||
38 | .SH BUGS | ||
39 | Report bugs by using mantis <https://gnunet.org/mantis/> or by sending electronic mail to <gnunet\-developers@gnu.org> | ||
40 | |||
41 | .SH SEE ALSO | ||
42 | gnunet.conf(5) | ||
diff --git a/doc/man/gnunet-statistics.1 b/doc/man/gnunet-statistics.1 new file mode 100644 index 000000000..8a23e01e0 --- /dev/null +++ b/doc/man/gnunet-statistics.1 | |||
@@ -0,0 +1,50 @@ | |||
1 | .TH GNUNET\-STATISTICS 1 "Mar 6, 2009" "GNUnet" | ||
2 | |||
3 | .SH NAME | ||
4 | gnunet\-statistics \- Display statistics about your GNUnet system | ||
5 | |||
6 | .SH SYNOPSIS | ||
7 | .B gnunet-statistics | ||
8 | .RI [ options ] [ VALUE ] | ||
9 | .br | ||
10 | |||
11 | .SH DESCRIPTION | ||
12 | \fBgnunet\-statistics\fP is used to display detailed information about various aspect of GNUnet's operation. This tool only works if the "statistics" service is available. | ||
13 | gnunet\-statistics can be used to set a value by giving the options \-n, \-s and also a VALUE. | ||
14 | |||
15 | .SH OPTIONS | ||
16 | |||
17 | .TP | ||
18 | .IP "\-c FILENAME, \-\-config=FILENAME" | ||
19 | Use the configuration file FILENAME. | ||
20 | |||
21 | .TP | ||
22 | .IP "\-h, \-\-help" | ||
23 | Print short help on options. | ||
24 | |||
25 | .TP | ||
26 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | ||
27 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. | ||
28 | |||
29 | .TP | ||
30 | .IP "\-n NAME, \-\-name=NAME" | ||
31 | Each statistic has a name that is unique with in its subsystem. With this option, the output can be restricted to statistics that have a particular name. | ||
32 | |||
33 | .TP | ||
34 | .IP "\-p, \-\-persistent" | ||
35 | When setting a value, make the value persistent. If the value used to be persistent and this flag is not given, it will be marked as non\-persistent. | ||
36 | |||
37 | .TP | ||
38 | .IP "\-s SUBSYSTEM, \-\-subsystem=SUBSYSTEM" | ||
39 | Statistics are kept for various subsystems. With this option, the output can be restricted to a particular subsystem only. | ||
40 | |||
41 | .TP | ||
42 | .IP "\-v, \-\-version" | ||
43 | Print GNUnet version number. | ||
44 | |||
45 | |||
46 | .SH BUGS | ||
47 | Report bugs by using Mantis <https://gnunet.org/mantis/> or by sending electronic mail to <gnunet\-developers@gnu.org> | ||
48 | |||
49 | .SH SEE ALSO | ||
50 | gnunet\-service\-statistics(1) | ||
diff --git a/doc/man/gnunet-transport.1 b/doc/man/gnunet-transport.1 new file mode 100644 index 000000000..643759395 --- /dev/null +++ b/doc/man/gnunet-transport.1 | |||
@@ -0,0 +1,96 @@ | |||
1 | .TH GNUNET-TRANSPORT "1" "23 Dec 2006" "GNUnet" | ||
2 | .SH NAME | ||
3 | gnunet\-transport \- a tool to test a GNUnet transport service | ||
4 | .SH SYNOPSIS | ||
5 | .B gnunet\-transport\ | ||
6 | [\fIOPTIONS\fR] | ||
7 | .SH DESCRIPTION | ||
8 | .PP | ||
9 | gnunet\-transport can be used to test or profile | ||
10 | a GNUnet transport service. The tool can be used to test | ||
11 | both the correctness of the software as well as the correctness | ||
12 | of the configuration. gnunet\-transport features two modes, | ||
13 | called loopback mode and ping mode. In loopback mode the test is limited to testing if the | ||
14 | transport can be used to communicate with itself (loopback). | ||
15 | This mode does not include communication with other peers which | ||
16 | may be blocked by firewalls and other general Internet connectivity | ||
17 | problems. The loopback mode is particularly useful to test | ||
18 | the SMTP transport service since this service is fairly hard to | ||
19 | configure correctly and most problems can be reveiled by just | ||
20 | testing the loopback. In ping mode the tool will attempt to download | ||
21 | peer advertisements from the URL specified in the configuration file | ||
22 | and then try to contact each of the peers. Note that it is perfectly | ||
23 | normal that some peers do not respond, but if no peer responds something | ||
24 | is likely to be wrong. The configuration is always taken | ||
25 | from the configuration file. Do not run gnunetd while running | ||
26 | gnunet\-transport since the transport services cannot | ||
27 | be used by two processes at the same time. | ||
28 | .PP | ||
29 | gnunet\-transport will always produce an error\-message for | ||
30 | the NAT transport in loopback mode. If NAT is configured in accept\-mode (as in, | ||
31 | accept connections from peers using network address translation), | ||
32 | the check will fail with the message "could not create HELO", | ||
33 | which is correct since the peer itself is clearly not going to | ||
34 | advertise itself as a NAT. If the peer is configured in NAT\-mode, | ||
35 | that is, the peer is behind a NAT box, the message will be | ||
36 | 'could not connect'. For NAT, both messages are NOT errors | ||
37 | but exactly what is supposed to happen. | ||
38 | .PP | ||
39 | Similarly, a NAT\-ed peer should typically configure the TCP transport | ||
40 | to use port 0 (not listen on any port). In this case, | ||
41 | gnunet\-transport will print 'could not create HELO' for the | ||
42 | TCP transport. This is also ok. In fact, a correctly configured | ||
43 | peer using NAT should give just two errors (could not connect for | ||
44 | tcp and could not create HELO for NAT) when tested using | ||
45 | gnunet\-transport\. The reason is, that gnunet\-transport\ | ||
46 | only tests loopback connectivity, and for a NAT\-ed peer, that just | ||
47 | does not apply. | ||
48 | .PP | ||
49 | Note that in ping mode the HTTP download times out after 5 minutes, | ||
50 | so if the list of peers is very large and not all peers can be | ||
51 | queried within the 5 minutes the tool may abort before trying all | ||
52 | peers. | ||
53 | .TP | ||
54 | \fB\-c \fIFILENAME\fR, \fB\-\-config=\fIFILENAME\fR | ||
55 | use config file (default: /etc/gnunetd.conf) | ||
56 | .TP | ||
57 | \fB\-h\fR, \fB\-\-help\fR | ||
58 | print help page | ||
59 | .TP | ||
60 | \fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=\fILOGLEVEL\fR | ||
61 | change the loglevel. Possible values for \fILOGLEVEL\fR are NOTHING, FATAL, ERROR, FAILURE, WARNING, MESSAGE, INFO, DEBUG, CRON and EVERYTHING. | ||
62 | .TP | ||
63 | \fB\-p\fR, \fB\-\-ping\fR | ||
64 | use ping mode (loopback mode is default) | ||
65 | .TP | ||
66 | \fB\-r\fI COUNT \fB\-\-repeat=\fICOUNT\fR | ||
67 | send COUNT messages in a sequence over the same connection | ||
68 | .TP | ||
69 | \fB\-s\fI SIZE \fB\-\-size=\fISIZE\fR | ||
70 | test using the specified message size, default is 11 | ||
71 | .TP | ||
72 | \fB\-t\fI TRANSPORT\fR, \fB\-\-transport=\fITRANSPORT\fR | ||
73 | run using the specified transport, if not given the transports | ||
74 | configured in the configuration file are used. | ||
75 | .TP | ||
76 | \fB\-u \fIUSER\fR, \fB\-\-user=USER\fR | ||
77 | run as user USER (and if available as group USER). Note that to use this option, you will probably have to start gnunet-transport as | ||
78 | root. It is typically better to directly start gnunet-transport as that user instead. | ||
79 | .TP | ||
80 | \fB\-v\fR, \fB\-\-version\fR | ||
81 | print the version number | ||
82 | .TP | ||
83 | \fB\-V\fR, \fB\-\-verbose\fR | ||
84 | be verbose | ||
85 | .SH NOTES | ||
86 | gnunet\-transport can run for a long time, depending on | ||
87 | how high you have set the \fICOUNT\fR level. Run first with small numbers | ||
88 | for \fICOUNT\fR to get an initial estimate on the runtime. | ||
89 | .SH FILES | ||
90 | .TP | ||
91 | /etc/gnunetd.conf | ||
92 | default gnunetd configuration file | ||
93 | .SH "REPORTING BUGS" | ||
94 | Report bugs by using mantis <https://gnunet.org/mantis/> or by sending electronic mail to <gnunet-developers@gnu.org> | ||
95 | .SH "SEE ALSO" | ||
96 | \fBgnunetd.conf\fP(5), \fBgnunetd\fP(1) | ||