move -C option from gnunet-transport to gnunet-ats; also, use blacklisting API to...
[oweals/gnunet.git] / doc / man / gnunet-transport.1
1 .TH gnunet\-transport "1" "17 Oct 2015" "GNUnet"
2 .SH NAME
3 gnunet\-transport \- measure and control the transport subsystem
4
5 .SH SYNOPSIS
6 .B gnunet\-transport
7 [\fIOPTIONS\fR]
8 .SH DESCRIPTION
9 .PP
10
11 gnunet\-transport is a tool to access various functions of GNUnet's transport subsystem from the command\-line.  Most of these are not expected to be useful for end-users.  gnunet\-transport can be used to evaluate the performance of the transports, force a peer to connect to another peer (if possible).  Other functions should be added in the near future.
12
13 .TP
14 \fB\-b\fR, \fB\-\-benchmark\fR
15 measure how fast we are receiving data (from all connections).  On exit, the data rate will be reported.  Runs until aborted with CTRL-C.
16 .TP
17 \fB\-D\fR, \fB\-\-disconnect\fR
18 force disconnection from a peer (used in conjunction with \-p).
19 Note that you can use the gnunet\-ats command\-line tool to suggest connects.
20 .TP
21 \fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
22 configuration file to use
23 .TP
24 \fB\-e \fB\-\-events\fR
25 provide information about all connect and disconnect events (continuously)
26 .TP
27 \fB\-h\fR, \fB\-\-help\fR
28 print help page
29 .TP
30 \fB\-i\fR, \fB\-\-information\fR
31 print information about our current connections (once)
32 .TP
33 \fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR
34 Change the loglevel.  Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
35 .TP
36 \fB\-l \fILOGFILE\fR, \fB\-\-logfile=LOGFILE\fR
37 configure logging to write logs to LOGFILE
38 .TP
39 \fB\-m\fR, \fB\-\-monitor\fR
40 print information about our current connections (continuously)
41 .TP
42 \fB\-p \fIPEER\fR, \fB\-\-peer=PEER\fR
43 the peer identity to connect to or monitor
44 .TP
45 \fB\-P, \fB\-\-plugins\fR
46 monitor session state of transport plugins
47 .TP
48 \fB\-s\fR, \fB\-\-send\fR
49 transmit (dummy) traffic as quickly as possible to the peer specified with the \-p option.  The rate will still be limited by the quota(s) determined by the peers (ATS subsystem).  Will run until CTRL\-C is pressed or until the connection to the other peer is disrupted.
50 .TP
51 \fB\-t\fR, \fB\-\-test\fR
52 test transport configuration.  With this flag, the tool will check if each of the configured transport plugins has a working address.  Plugins that do not have a listen port configured will be ignored.  The test is performed with the help of an external server (by default running on gnunet.org) which tries to contact the local machine.  The test can only work if the local GNUnet peer is not yet running.
53 .TP
54 \fB\-v\fR, \fB\-\-version\fR
55 print the version number
56 .TP
57 \fB\-V\fR, \fB\-\-verbose\fR
58 be verbose
59
60 .SH NOTES
61
62
63 .SH "REPORTING BUGS"
64 Report bugs by using mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
65 .SH "SEE ALSO"
66 \fBgnunet\-arm\fP(1), \fBgnunet\-ats\fP(1)