aboutsummaryrefslogtreecommitdiff
path: root/doc/man/gnunet-transport.1
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2009-05-29 00:46:26 +0000
committerChristian Grothoff <christian@grothoff.org>2009-05-29 00:46:26 +0000
commit0a217a8df1657b4334b55b0e4a6c7837a8dbcfd9 (patch)
tree6b552f40eb089db96409a312a98d9b12bd669102 /doc/man/gnunet-transport.1
downloadgnunet-0a217a8df1657b4334b55b0e4a6c7837a8dbcfd9.tar.gz
gnunet-0a217a8df1657b4334b55b0e4a6c7837a8dbcfd9.zip
ng
Diffstat (limited to 'doc/man/gnunet-transport.1')
-rw-r--r--doc/man/gnunet-transport.196
1 files changed, 96 insertions, 0 deletions
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
3gnunet\-transport \- a tool to test a GNUnet transport service
4.SH SYNOPSIS
5.B gnunet\-transport\
6[\fIOPTIONS\fR]
7.SH DESCRIPTION
8.PP
9gnunet\-transport can be used to test or profile
10a GNUnet transport service. The tool can be used to test
11both the correctness of the software as well as the correctness
12of the configuration. gnunet\-transport features two modes,
13called loopback mode and ping mode. In loopback mode the test is limited to testing if the
14transport can be used to communicate with itself (loopback).
15This mode does not include communication with other peers which
16may be blocked by firewalls and other general Internet connectivity
17problems. The loopback mode is particularly useful to test
18the SMTP transport service since this service is fairly hard to
19configure correctly and most problems can be reveiled by just
20testing the loopback. In ping mode the tool will attempt to download
21peer advertisements from the URL specified in the configuration file
22and then try to contact each of the peers. Note that it is perfectly
23normal that some peers do not respond, but if no peer responds something
24is likely to be wrong. The configuration is always taken
25from the configuration file. Do not run gnunetd while running
26gnunet\-transport since the transport services cannot
27be used by two processes at the same time.
28.PP
29gnunet\-transport will always produce an error\-message for
30the NAT transport in loopback mode. If NAT is configured in accept\-mode (as in,
31accept connections from peers using network address translation),
32the check will fail with the message "could not create HELO",
33which is correct since the peer itself is clearly not going to
34advertise itself as a NAT. If the peer is configured in NAT\-mode,
35that is, the peer is behind a NAT box, the message will be
36'could not connect'. For NAT, both messages are NOT errors
37but exactly what is supposed to happen.
38.PP
39Similarly, a NAT\-ed peer should typically configure the TCP transport
40to use port 0 (not listen on any port). In this case,
41gnunet\-transport will print 'could not create HELO' for the
42TCP transport. This is also ok. In fact, a correctly configured
43peer using NAT should give just two errors (could not connect for
44tcp and could not create HELO for NAT) when tested using
45gnunet\-transport\. The reason is, that gnunet\-transport\
46only tests loopback connectivity, and for a NAT\-ed peer, that just
47does not apply.
48.PP
49Note that in ping mode the HTTP download times out after 5 minutes,
50so if the list of peers is very large and not all peers can be
51queried within the 5 minutes the tool may abort before trying all
52peers.
53.TP
54\fB\-c \fIFILENAME\fR, \fB\-\-config=\fIFILENAME\fR
55use config file (default: /etc/gnunetd.conf)
56.TP
57\fB\-h\fR, \fB\-\-help\fR
58print help page
59.TP
60\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=\fILOGLEVEL\fR
61change 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
64use ping mode (loopback mode is default)
65.TP
66\fB\-r\fI COUNT \fB\-\-repeat=\fICOUNT\fR
67send COUNT messages in a sequence over the same connection
68.TP
69\fB\-s\fI SIZE \fB\-\-size=\fISIZE\fR
70test using the specified message size, default is 11
71.TP
72\fB\-t\fI TRANSPORT\fR, \fB\-\-transport=\fITRANSPORT\fR
73run using the specified transport, if not given the transports
74configured in the configuration file are used.
75.TP
76\fB\-u \fIUSER\fR, \fB\-\-user=USER\fR
77run as user USER (and if available as group USER). Note that to use this option, you will probably have to start gnunet-transport as
78root. It is typically better to directly start gnunet-transport as that user instead.
79.TP
80\fB\-v\fR, \fB\-\-version\fR
81print the version number
82.TP
83\fB\-V\fR, \fB\-\-verbose\fR
84be verbose
85.SH NOTES
86gnunet\-transport can run for a long time, depending on
87how high you have set the \fICOUNT\fR level. Run first with small numbers
88for \fICOUNT\fR to get an initial estimate on the runtime.
89.SH FILES
90.TP
91/etc/gnunetd.conf
92default gnunetd configuration file
93.SH "REPORTING BUGS"
94Report 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)