summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2011-10-26 21:00:53 +0000
committerChristian Grothoff <christian@grothoff.org>2011-10-26 21:00:53 +0000
commit8ff0618cd174a9270d9bad688bdc4da45984067b (patch)
treee3ea72aefff17cb8c3940a2ed54f1915dd806a25 /doc
parentf7ac06c047ff39c29a9b3bd3b057f7e5c887f0cf (diff)
documenting gnunet-transport a bit
Diffstat (limited to 'doc')
-rw-r--r--doc/man/Makefile.am1
-rw-r--r--doc/man/gnunet-directory.14
-rw-r--r--doc/man/gnunet-nat-server.14
-rw-r--r--doc/man/gnunet-transport.144
4 files changed, 49 insertions, 4 deletions
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index dcc60e6fb..20575204f 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -8,6 +8,7 @@ man_MANS = \
gnunet-publish.1 \
gnunet-search.1 \
gnunet-statistics.1 \
+ gnunet-transport.1 \
gnunet-unindex.1 \
gnunet-monkey.1
diff --git a/doc/man/gnunet-directory.1 b/doc/man/gnunet-directory.1
index 07732530a..1c3e244f3 100644
--- a/doc/man/gnunet-directory.1
+++ b/doc/man/gnunet-directory.1
@@ -1,4 +1,4 @@
-.TH gnunet-directory "1" "10 Dec 2009" "GNUnet"
+.TH gnunet-directory "1" "26 Oct 2011" "GNUnet"
.SH NAME
gnunet\-directory \- display directories
@@ -32,4 +32,4 @@ GNUnet directories use the (unregistered) mimetype \fBapplication/gnunet\-direct
.SH "REPORTING BUGS"
Report bugs by using mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
.SH "SEE ALSO"
-\fBgnunet\-gtk\fP(1), \fBgnunet\-publish\fP(1), \fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1)
+\fBgnunet\-fs\-gtk\fP(1), \fBgnunet\-publish\fP(1), \fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1)
diff --git a/doc/man/gnunet-nat-server.1 b/doc/man/gnunet-nat-server.1
index e8f47b75c..a35ad3b01 100644
--- a/doc/man/gnunet-nat-server.1
+++ b/doc/man/gnunet-nat-server.1
@@ -28,8 +28,8 @@ Note that gnunet\-nat\-server could be run via gnunet\-arm but typically is not.
Use the configuration file FILENAME.
.SH BUGS
-Report bugs by using Mantis <https://gnunet.org/mantis/> or by sending electronic mail to <gnunet\-developers@gnu.org>
+Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
.SH SEE ALSO
-gnunet\-service\-transport(1)
+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 <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org>
+.SH "SEE ALSO"
+\fBgnunet\-arm\fP(1)