doc/man/gnunet-transport.1

   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)