gnunet-nse.1: follow standards
[oweals/gnunet.git] / doc / man / gnunet-transport.1
1 .TH GNUNET\-TRANSPORT "1" "October 17, 2015" "GNUnet"
2 .SH NAME
3 gnunet\-transport \- measure and control the transport subsystem
4 .SH SYNOPSIS
5 .B gnunet\-transport
6 [\fIOPTIONS\fR]
7 .SH DESCRIPTION
8 .PP
9 gnunet\-transport is a tool to access various functions of GNUnet's
10 transport subsystem from the command\-line.  Most of these are not
11 expected to be useful for end-users.  gnunet\-transport can be used to
12 evaluate the performance of the transports, force a peer to connect to
13 another peer (if possible).  Other functions should be added in the
14 near future.
15 .TP
16 \fB\-b\fR, \fB\-\-benchmark\fR
17 measure how fast we are receiving data (from all connections).  On
18 exit, the data rate will be reported.  Runs until aborted with CTRL-C.
19 .TP
20 \fB\-D\fR, \fB\-\-disconnect\fR
21 force disconnection from a peer (used in conjunction with \-p).
22 Note that you can use the gnunet\-ats command\-line tool to suggest connects.
23 .TP
24 \fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
25 configuration file to use
26 .TP
27 \fB\-e \fB\-\-events\fR
28 provide information about all connect and disconnect events (continuously)
29 .TP
30 \fB\-h\fR, \fB\-\-help\fR
31 print help page
32 .TP
33 \fB\-i\fR, \fB\-\-information\fR
34 print information about our current connections (once)
35 .TP
36 \fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR
37 Change the loglevel.  Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
38 .TP
39 \fB\-l \fILOGFILE\fR, \fB\-\-logfile=LOGFILE\fR
40 configure logging to write logs to LOGFILE
41 .TP
42 \fB\-m\fR, \fB\-\-monitor\fR
43 print information about our current connections (continuously)
44 .TP
45 \fB\-p \fIPEER\fR, \fB\-\-peer=PEER\fR
46 the peer identity to connect to or monitor
47 .TP
48 \fB\-P, \fB\-\-plugins\fR
49 monitor session state of transport plugins
50 .TP
51 \fB\-s\fR, \fB\-\-send\fR
52 transmit (dummy) traffic as quickly as possible to the peer specified
53 with the \-p option.  The rate will still be limited by the quota(s)
54 determined by the peers (ATS subsystem).  Will run until CTRL\-C is
55 pressed or until the connection to the other peer is disrupted.
56 .TP
57 \fB\-v\fR, \fB\-\-version\fR
58 print the version number
59 .TP
60 \fB\-V\fR, \fB\-\-verbose\fR
61 be verbose
62 .SH "REPORTING BUGS"
63 Report bugs by using mantis <https://bugs.gnunet.org/> or by sending electronic mail to <gnunet\-developers@gnu.org>
64 .SH "SEE ALSO"
65 \fBgnunet\-arm\fP(1), \fBgnunet\-ats\fP(1)
66 The full documentation for
67 .B gnunet
68 is maintained as a Texinfo manual.  If the
69 .B info
70 and
71 .B gnunet
72 programs are properly installed at your site, the command
73 .IP
74 .B info gnunet
75 .PP
76 should give you access to the complete handbook,
77 .IP
78 .B info gnunet-c-tutorial
79 .PP
80 will give you access to a tutorial for developers.
81 .PP
82 Depending on your installation, this information is also
83 available in
84 \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).