aboutsummaryrefslogtreecommitdiff
path: root/doc/man/gnunet-transport.1
blob: b8f509dc2935dfac2dea0629a23b85f19d2e111a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
.\" This file is part of GNUnet.
.\" Copyright (C) 2001-2019 GNUnet e.V.
.\"
.\" Permission is granted to copy, distribute and/or modify this document
.\" under the terms of the GNU Free Documentation License, Version 1.3 or
.\" any later version published by the Free Software Foundation; with no
.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.  A
.\" copy of the license is included in the file
.\" FDL-1.3.
.\"
.\" A copy of the license is also available from the Free Software
.\" Foundation Web site at http://www.gnu.org/licenses/fdl.html}.
.\"
.\" Alternately, this document is also available under the General
.\" Public License, version 3 or later, as published by the Free Software
.\" Foundation.  A copy of the license is included in the file
.\" GPL3.
.\"
.\" A copy of the license is also available from the Free Software
.\" Foundation Web site at http://www.gnu.org/licenses/gpl.html
.\"
.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
.\"
.Dd October 17, 2015
.Dt GNUNET-TRANSPORT 1
.Os
.Sh NAME
.Nm gnunet-transport
.Nd measure and control the transport subsystem
.Sh SYNOPSIS
.Nm
.Op Fl b | -benchmark
.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
.Op Fl D | -disconnect
.Op Fl e | -events
.Op Fl h | -help
.Op Fl i | -information
.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
.Op Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
.Op Fl m | -monitor
.Op Fl p Ar PEER | Fl -peer= Ns Ar PEER
.Op Fl P | -plugins
.Op Fl s | -send
.Op Fl v | -version
.Op Fl V | -verbose
.Sh DESCRIPTION
.Nm
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.
.Bl -tag -width indent
.It Fl b | -benchmark
Measure how fast we are receiving data (from all connections).
On exit, the data rate will be reported.
Runs until aborted with CTRL-C.
.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
configuration file to use
.It Fl D | -disconnect
Force disconnection from a peer (used in conjunction with
.Fl p Ns ).
Note that you can use the gnunet-ats command-line tool to suggest connects.
.It Fl e | -events
Provide information about all connect and disconnect events (continuously).
.It Fl h | -help
Print the help page.
.It Fl i | -information
Print information about our current connections (once).
.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
Change the loglevel.
Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
.It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
Configure logging to write logs to LOGFILE.
.It Fl m | -monitor
Print information about our current connections (continuously).
.It Fl p Ar PEER | Fl -peer= Ns Ar PEER
The peer identity to connect to or monitor.
.It Fl P | -plugins
Monitor session state of transport plugins.
.It Fl s | -send
Transmit (dummy) traffic as quickly as possible to the peer specified with the
.Fl 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.
.It Fl v | -version
Print out the version number.
.It Fl V | -verbose
be verbose
.El
.Sh SEE ALSO
.Xr gnunet-arm 1 ,
.Xr gnunet-ats 1
.sp
The full documentation for gnunet is maintained as a Texinfo manual.
If the
.Xr info 1
and gnunet programs are properly installed at your site, the command
.Pp
.Dl info gnunet
.Pp
should give you access to the complete handbook,
.Pp
.Dl info gnunet-c-tutorial
.Pp
will give you access to a tutorial for developers.
.sp
Depending on your installation, this information is also available in
.Xr gnunet 7 and
.Xr gnunet-c-tutorial 7 .
.\".Sh HISTORY
.\".Sh AUTHORS
.Sh BUGS
Report bugs by using
.Lk https://bugs.gnunet.org
or by sending electronic mail to
.Aq Mt gnunet-developers@gnu.org .