aboutsummaryrefslogtreecommitdiff
path: root/doc/man/gnunet-transport.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/gnunet-transport.1')
-rw-r--r--doc/man/gnunet-transport.190
1 files changed, 47 insertions, 43 deletions
diff --git a/doc/man/gnunet-transport.1 b/doc/man/gnunet-transport.1
index 64cfce385..3c463d76e 100644
--- a/doc/man/gnunet-transport.1
+++ b/doc/man/gnunet-transport.1
@@ -26,66 +26,70 @@
26.Os 26.Os
27.Sh NAME 27.Sh NAME
28.Nm gnunet-transport 28.Nm gnunet-transport
29.Nd 29.Nd measure and control the transport subsystem
30measure and control the transport subsystem
31.Sh SYNOPSIS 30.Sh SYNOPSIS
32.Nm 31.Nm
33.Op Fl b | \-benchmark 32.Op Fl b | -benchmark
34.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 33.Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
35.Op Fl D | \-disconnect 34.Op Fl D | -disconnect
36.Op Fl e | \-events 35.Op Fl e | -events
37.Op Fl h | \-help 36.Op Fl h | -help
38.Op Fl i | \-information 37.Op Fl i | -information
39.Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 38.Op Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
40.Op Fl l Ar LOGFILE | Fl \-logfile= Ns Ar LOGFILE 39.Op Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
41.Op Fl m | \-monitor 40.Op Fl m | -monitor
42.Op Fl p Ar PEER | Fl \-peer= Ns Ar PEER 41.Op Fl p Ar PEER | Fl -peer= Ns Ar PEER
43.Op Fl P | \-plugins 42.Op Fl P | -plugins
44.Op Fl s | \-send 43.Op Fl s | -send
45.Op Fl v | \-version 44.Op Fl v | -version
46.Op Fl V | \-verbose 45.Op Fl V | -verbose
47.Sh DESCRIPTION 46.Sh DESCRIPTION
48.Nm 47.Nm
49is a tool to access various functions of GNUnet's transport subsystem from the command-line. 48is a tool to access various functions of GNUnet's transport subsystem
49from the command-line.
50Most of these are not expected to be useful for end-users. 50Most of these are not expected to be useful for end-users.
51gnunet-transport can be used to evaluate the performance of the transports, force a peer to connect to another peer (if possible). 51gnunet-transport can be used to evaluate the performance of
52the transports, force a peer to connect to another peer (if possible).
52Other functions should be added in the near future. 53Other functions should be added in the near future.
53.Bl -tag -width Ds 54.Bl -tag -width indent
54.It Fl b | \-benchmark 55.It Fl b | -benchmark
55measure how fast we are receiving data (from all connections). 56Measure how fast we are receiving data (from all connections).
56On exit, the data rate will be reported. 57On exit, the data rate will be reported.
57Runs until aborted with CTRL-C. 58Runs until aborted with CTRL-C.
58.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 59.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
59configuration file to use 60configuration file to use
60.It Fl D | \-disconnect 61.It Fl D | -disconnect
61force disconnection from a peer (used in conjunction with \-p). 62Force disconnection from a peer (used in conjunction with
63.Fl p Ns ).
62Note that you can use the gnunet-ats command-line tool to suggest connects. 64Note that you can use the gnunet-ats command-line tool to suggest connects.
63.It Fl e | \-events 65.It Fl e | -events
64provide information about all connect and disconnect events (continuously) 66Provide information about all connect and disconnect events (continuously).
65.It Fl h | \-help 67.It Fl h | -help
66Print the help page. 68Print the help page.
67.It Fl i | \-information 69.It Fl i | -information
68print information about our current connections (once) 70Print information about our current connections (once).
69.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 71.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
70Change the loglevel. 72Change the loglevel.
71Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. 73Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG.
72.It Fl l Ar LOGFILE | Fl \-logfile= Ns Ar LOGFILE 74.It Fl l Ar LOGFILE | Fl -logfile= Ns Ar LOGFILE
73Configure logging to write logs to LOGFILE. 75Configure logging to write logs to LOGFILE.
74.It Fl m | \-monitor 76.It Fl m | -monitor
75print information about our current connections (continuously) 77Print information about our current connections (continuously).
76.It Fl p Ar PEER | Fl \-peer= Ns Ar PEER 78.It Fl p Ar PEER | Fl -peer= Ns Ar PEER
77the peer identity to connect to or monitor 79The peer identity to connect to or monitor.
78.It Fl P | \-plugins 80.It Fl P | -plugins
79monitor session state of transport plugins 81Monitor session state of transport plugins.
80.It Fl s | \-send 82.It Fl s | -send
81Transmit (dummy) traffic as quickly as possible to the peer specified with the 83Transmit (dummy) traffic as quickly as possible to the peer specified with the
82.Fl p 84.Fl p
83option. 85option.
84The rate will still be limited by the quota(s) determined by the peers (ATS subsystem). 86The rate will still be limited by the quota(s) determined by
85Will run until CTRL-C is pressed or until the connection to the other peer is disrupted. 87the peers (ATS subsystem).
86.It Fl v | \-version 88Will run until CTRL-C is pressed or until the connection
87print the version number 89to the other peer is disrupted.
88.It Fl V | \-verbose 90.It Fl v | -version
91Print out the version number.
92.It Fl V | -verbose
89be verbose 93be verbose
90.El 94.El
91.Sh SEE ALSO 95.Sh SEE ALSO