From 8ff0618cd174a9270d9bad688bdc4da45984067b Mon Sep 17 00:00:00 2001 From: Christian Grothoff Date: Wed, 26 Oct 2011 21:00:53 +0000 Subject: documenting gnunet-transport a bit --- doc/man/gnunet-transport.1 | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 doc/man/gnunet-transport.1 (limited to 'doc/man/gnunet-transport.1') diff --git a/doc/man/gnunet-transport.1 b/doc/man/gnunet-transport.1 new file mode 100644 index 000000000..7443219a3 --- /dev/null +++ b/doc/man/gnunet-transport.1 @@ -0,0 +1,44 @@ +.TH gnunet\-transport "1" "26 Oct 2011" "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\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR +configuration file to use +.TP +\fB\-C \fIPEER\fR, \fB\-\-connect=PEER\fR +peer to connect to (and to use for sending if used in conjunction with \-s) +.TP +\fB\-h\fR, \fB\-\-help\fR +print help page +.TP +\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR +Change the loglevel. Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. +.TP +\fB\-s\fR, \fB\-\-send\fR +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. +.TP +\fB\-v\fR, \fB\-\-version\fR +print the version number +.TP +\fB\-V\fR, \fB\-\-verbose\fR +be verbose + +.SH NOTES + + +.SH "REPORTING BUGS" +Report bugs by using mantis or by sending electronic mail to +.SH "SEE ALSO" +\fBgnunet\-arm\fP(1) -- cgit v1.2.3