integrate gnunet-transport-list-connections with gnunet-transport
[oweals/gnunet.git] / doc / man / gnunet-transport.1
1 .TH gnunet\-transport "1" "26 Oct 2011" "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\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR
18 configuration file to use
19 .TP
20 \fB\-C \fIPEER\fR, \fB\-\-connect=PEER\fR
21 peer to connect to (and to use for sending if used in conjunction with \-s)
22 .TP
23 \fB\-h\fR, \fB\-\-help\fR
24 print help page
25 .TP
26 \fB\-i\fR, \fB\-\-information\fR
27 print information about our current connections (once)
28 .TP
29 \fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR
30 Change the loglevel.  Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
31 .TP
32 \fB\-s\fR, \fB\-\-send\fR
33 transmit (dummy) traffic as quickly as possible to the peer specified with the \-C 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.
34 .TP
35 \fB\-v\fR, \fB\-\-version\fR
36 print the version number
37 .TP
38 \fB\-V\fR, \fB\-\-verbose\fR
39 be verbose
40
41 .SH NOTES
42
43
44 .SH "REPORTING BUGS"
45 Report bugs by using mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
46 .SH "SEE ALSO"
47 \fBgnunet\-arm\fP(1)