From c26a1a7ee5aec722905bc18884ee309762619f52 Mon Sep 17 00:00:00 2001 From: ng0 Date: Tue, 2 Apr 2019 22:13:53 +0000 Subject: man: transport --- doc/man/gnunet-transport.1 | 142 ++++++++++++++++++++++++--------------------- 1 file changed, 75 insertions(+), 67 deletions(-) (limited to 'doc') 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 @@ -.TH GNUNET\-TRANSPORT "1" "October 17, 2015" "GNUnet" -.SH NAME -gnunet\-transport \- measure and control the transport subsystem -.SH SYNOPSIS -.B gnunet\-transport -[\fIOPTIONS\fR] -.SH DESCRIPTION -.PP -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. -.TP -\fB\-b\fR, \fB\-\-benchmark\fR -measure how fast we are receiving data (from all connections). On -exit, the data rate will be reported. Runs until aborted with CTRL-C. -.TP -\fB\-D\fR, \fB\-\-disconnect\fR -force disconnection from a peer (used in conjunction with \-p). -Note that you can use the gnunet\-ats command\-line tool to suggest connects. -.TP -\fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR +.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 Ds +.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 -.TP -\fB\-e \fB\-\-events\fR +.It Fl D | \-disconnect +force disconnection from a peer (used in conjunction with \-p). +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) -.TP -\fB\-h\fR, \fB\-\-help\fR +.It Fl h | \-help print help page -.TP -\fB\-i\fR, \fB\-\-information\fR +.It Fl i | \-information print information about our current connections (once) -.TP -\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR +.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL Change the loglevel. Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. -.TP -\fB\-l \fILOGFILE\fR, \fB\-\-logfile=LOGFILE\fR +.It Fl l Ar LOGFILE | Fl \-logfile= Ns Ar LOGFILE configure logging to write logs to LOGFILE -.TP -\fB\-m\fR, \fB\-\-monitor\fR +.It Fl m | \-monitor print information about our current connections (continuously) -.TP -\fB\-p \fIPEER\fR, \fB\-\-peer=PEER\fR +.It Fl p Ar PEER | Fl \-peer= Ns Ar PEER the peer identity to connect to or monitor -.TP -\fB\-P, \fB\-\-plugins\fR +.It Fl P | \-plugins monitor session state of transport plugins -.TP -\fB\-s\fR, \fB\-\-send\fR +.It Fl s | \-send 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. -.TP -\fB\-v\fR, \fB\-\-version\fR +.It Fl v | \-version print the version number -.TP -\fB\-V\fR, \fB\-\-verbose\fR +.It Fl V | \-verbose be verbose -.SH "REPORTING BUGS" -Report bugs by using mantis or by sending electronic mail to -.SH "SEE ALSO" -\fBgnunet\-arm\fP(1), \fBgnunet\-ats\fP(1) -The full documentation for -.B gnunet -is maintained as a Texinfo manual. If the -.B info -and -.B gnunet -programs are properly installed at your site, the command -.IP -.B info gnunet -.PP +.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, -.IP -.B info gnunet-c-tutorial -.PP +.Pp +.Dl info gnunet-c-tutorial +.Pp will give you access to a tutorial for developers. -.PP -Depending on your installation, this information is also -available in -\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). +.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 . -- cgit v1.2.3