diff options
author | ng0 <ng0@n0.is> | 2019-04-02 22:13:53 +0000 |
---|---|---|
committer | ng0 <ng0@n0.is> | 2019-04-02 22:13:53 +0000 |
commit | c26a1a7ee5aec722905bc18884ee309762619f52 (patch) | |
tree | 49830e18d8dd7606cd889bb827d8eafa9aa6d27a /doc/man/gnunet-transport.1 | |
parent | 2bcf3d08acee6259b209fd7de211817874df6034 (diff) | |
download | gnunet-c26a1a7ee5aec722905bc18884ee309762619f52.tar.gz gnunet-c26a1a7ee5aec722905bc18884ee309762619f52.zip |
man: transport
Diffstat (limited to 'doc/man/gnunet-transport.1')
-rw-r--r-- | doc/man/gnunet-transport.1 | 142 |
1 files changed, 75 insertions, 67 deletions
diff --git a/doc/man/gnunet-transport.1 b/doc/man/gnunet-transport.1 index eef762174..f5ed47ad1 100644 --- a/doc/man/gnunet-transport.1 +++ b/doc/man/gnunet-transport.1 | |||
@@ -1,84 +1,92 @@ | |||
1 | .TH GNUNET\-TRANSPORT "1" "October 17, 2015" "GNUnet" | 1 | .Dd October 17, 2015 |
2 | .SH NAME | 2 | .Dt GNUNET-TRANSPORT 1 |
3 | gnunet\-transport \- measure and control the transport subsystem | 3 | .Os |
4 | .SH SYNOPSIS | 4 | .Sh NAME |
5 | .B gnunet\-transport | 5 | .Nm gnunet-transport |
6 | [\fIOPTIONS\fR] | 6 | .Nd |
7 | .SH DESCRIPTION | 7 | measure and control the transport subsystem |
8 | .PP | 8 | .Sh SYNOPSIS |
9 | gnunet\-transport is a tool to access various functions of GNUnet's | 9 | .Nm |
10 | transport subsystem from the command\-line. Most of these are not | 10 | .Op Fl b | \-benchmark |
11 | expected to be useful for end-users. gnunet\-transport can be used to | 11 | .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME |
12 | evaluate the performance of the transports, force a peer to connect to | 12 | .Op Fl D | \-disconnect |
13 | another peer (if possible). Other functions should be added in the | 13 | .Op Fl e | \-events |
14 | near future. | 14 | .Op Fl h | \-help |
15 | .TP | 15 | .Op Fl i | \-information |
16 | \fB\-b\fR, \fB\-\-benchmark\fR | 16 | .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL |
17 | measure how fast we are receiving data (from all connections). On | 17 | .Op Fl l Ar LOGFILE | Fl \-logfile= Ns Ar LOGFILE |
18 | exit, the data rate will be reported. Runs until aborted with CTRL-C. | 18 | .Op Fl m | \-monitor |
19 | .TP | 19 | .Op Fl p Ar PEER | Fl \-peer= Ns Ar PEER |
20 | \fB\-D\fR, \fB\-\-disconnect\fR | 20 | .Op Fl P | \-plugins |
21 | force disconnection from a peer (used in conjunction with \-p). | 21 | .Op Fl s | \-send |
22 | Note that you can use the gnunet\-ats command\-line tool to suggest connects. | 22 | .Op Fl v | \-version |
23 | .TP | 23 | .Op Fl V | \-verbose |
24 | \fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR | 24 | .Sh DESCRIPTION |
25 | .Nm | ||
26 | is a tool to access various functions of GNUnet's transport subsystem from the command-line. | ||
27 | Most of these are not expected to be useful for end-users. | ||
28 | gnunet-transport can be used to evaluate the performance of the transports, force a peer to connect to another peer (if possible). | ||
29 | Other functions should be added in the near future. | ||
30 | .Bl -tag -width Ds | ||
31 | .It Fl b | \-benchmark | ||
32 | measure how fast we are receiving data (from all connections). | ||
33 | On exit, the data rate will be reported. | ||
34 | Runs until aborted with CTRL-C. | ||
35 | .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME | ||
25 | configuration file to use | 36 | configuration file to use |
26 | .TP | 37 | .It Fl D | \-disconnect |
27 | \fB\-e \fB\-\-events\fR | 38 | force disconnection from a peer (used in conjunction with \-p). |
39 | Note that you can use the gnunet-ats command-line tool to suggest connects. | ||
40 | .It Fl e | \-events | ||
28 | provide information about all connect and disconnect events (continuously) | 41 | provide information about all connect and disconnect events (continuously) |
29 | .TP | 42 | .It Fl h | \-help |
30 | \fB\-h\fR, \fB\-\-help\fR | ||
31 | print help page | 43 | print help page |
32 | .TP | 44 | .It Fl i | \-information |
33 | \fB\-i\fR, \fB\-\-information\fR | ||
34 | print information about our current connections (once) | 45 | print information about our current connections (once) |
35 | .TP | 46 | .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL |
36 | \fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR | ||
37 | Change the loglevel. Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. | 47 | Change the loglevel. Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. |
38 | .TP | 48 | .It Fl l Ar LOGFILE | Fl \-logfile= Ns Ar LOGFILE |
39 | \fB\-l \fILOGFILE\fR, \fB\-\-logfile=LOGFILE\fR | ||
40 | configure logging to write logs to LOGFILE | 49 | configure logging to write logs to LOGFILE |
41 | .TP | 50 | .It Fl m | \-monitor |
42 | \fB\-m\fR, \fB\-\-monitor\fR | ||
43 | print information about our current connections (continuously) | 51 | print information about our current connections (continuously) |
44 | .TP | 52 | .It Fl p Ar PEER | Fl \-peer= Ns Ar PEER |
45 | \fB\-p \fIPEER\fR, \fB\-\-peer=PEER\fR | ||
46 | the peer identity to connect to or monitor | 53 | the peer identity to connect to or monitor |
47 | .TP | 54 | .It Fl P | \-plugins |
48 | \fB\-P, \fB\-\-plugins\fR | ||
49 | monitor session state of transport plugins | 55 | monitor session state of transport plugins |
50 | .TP | 56 | .It Fl s | \-send |
51 | \fB\-s\fR, \fB\-\-send\fR | ||
52 | transmit (dummy) traffic as quickly as possible to the peer specified | 57 | 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) | 58 | 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 | 59 | determined by the peers (ATS subsystem). Will run until CTRL\-C is |
55 | pressed or until the connection to the other peer is disrupted. | 60 | pressed or until the connection to the other peer is disrupted. |
56 | .TP | 61 | .It Fl v | \-version |
57 | \fB\-v\fR, \fB\-\-version\fR | ||
58 | print the version number | 62 | print the version number |
59 | .TP | 63 | .It Fl V | \-verbose |
60 | \fB\-V\fR, \fB\-\-verbose\fR | ||
61 | be verbose | 64 | be verbose |
62 | .SH "REPORTING BUGS" | 65 | .El |
63 | Report bugs by using mantis <https://bugs.gnunet.org/> or by sending electronic mail to <gnunet\-developers@gnu.org> | 66 | .Sh SEE ALSO |
64 | .SH "SEE ALSO" | 67 | .Xr gnunet-arm 1 , |
65 | \fBgnunet\-arm\fP(1), \fBgnunet\-ats\fP(1) | 68 | .Xr gnunet-ats 1 |
66 | The full documentation for | 69 | .sp |
67 | .B gnunet | 70 | The full documentation for gnunet is maintained as a Texinfo manual. |
68 | is maintained as a Texinfo manual. If the | 71 | If the |
69 | .B info | 72 | .Xr info 1 |
70 | and | 73 | and gnunet programs are properly installed at your site, the command |
71 | .B gnunet | 74 | .Pp |
72 | programs are properly installed at your site, the command | 75 | .Dl info gnunet |
73 | .IP | 76 | .Pp |
74 | .B info gnunet | ||
75 | .PP | ||
76 | should give you access to the complete handbook, | 77 | should give you access to the complete handbook, |
77 | .IP | 78 | .Pp |
78 | .B info gnunet-c-tutorial | 79 | .Dl info gnunet-c-tutorial |
79 | .PP | 80 | .Pp |
80 | will give you access to a tutorial for developers. | 81 | will give you access to a tutorial for developers. |
81 | .PP | 82 | .sp |
82 | Depending on your installation, this information is also | 83 | Depending on your installation, this information is also available in |
83 | available in | 84 | .Xr gnunet 7 and |
84 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). | 85 | .Xr gnunet-c-tutorial 7 . |
86 | .\".Sh HISTORY | ||
87 | .\".Sh AUTHORS | ||
88 | .Sh BUGS | ||
89 | Report bugs by using | ||
90 | .Lk https://bugs.gnunet.org | ||
91 | or by sending electronic mail to | ||
92 | .Aq Mt gnunet-developers@gnu.org . | ||