diff options
author | Christian Grothoff <christian@grothoff.org> | 2011-10-26 21:00:53 +0000 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2011-10-26 21:00:53 +0000 |
commit | 8ff0618cd174a9270d9bad688bdc4da45984067b (patch) | |
tree | e3ea72aefff17cb8c3940a2ed54f1915dd806a25 /doc | |
parent | f7ac06c047ff39c29a9b3bd3b057f7e5c887f0cf (diff) | |
download | gnunet-8ff0618cd174a9270d9bad688bdc4da45984067b.tar.gz gnunet-8ff0618cd174a9270d9bad688bdc4da45984067b.zip |
documenting gnunet-transport a bit
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man/Makefile.am | 1 | ||||
-rw-r--r-- | doc/man/gnunet-directory.1 | 4 | ||||
-rw-r--r-- | doc/man/gnunet-nat-server.1 | 4 | ||||
-rw-r--r-- | doc/man/gnunet-transport.1 | 44 |
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 = \ | |||
8 | gnunet-publish.1 \ | 8 | gnunet-publish.1 \ |
9 | gnunet-search.1 \ | 9 | gnunet-search.1 \ |
10 | gnunet-statistics.1 \ | 10 | gnunet-statistics.1 \ |
11 | gnunet-transport.1 \ | ||
11 | gnunet-unindex.1 \ | 12 | gnunet-unindex.1 \ |
12 | gnunet-monkey.1 | 13 | gnunet-monkey.1 |
13 | 14 | ||
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 @@ | |||
1 | .TH gnunet-directory "1" "10 Dec 2009" "GNUnet" | 1 | .TH gnunet-directory "1" "26 Oct 2011" "GNUnet" |
2 | .SH NAME | 2 | .SH NAME |
3 | gnunet\-directory \- display directories | 3 | gnunet\-directory \- display directories |
4 | 4 | ||
@@ -32,4 +32,4 @@ GNUnet directories use the (unregistered) mimetype \fBapplication/gnunet\-direct | |||
32 | .SH "REPORTING BUGS" | 32 | .SH "REPORTING BUGS" |
33 | Report bugs by using mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> | 33 | Report bugs by using mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> |
34 | .SH "SEE ALSO" | 34 | .SH "SEE ALSO" |
35 | \fBgnunet\-gtk\fP(1), \fBgnunet\-publish\fP(1), \fBgnunet\-search\fP(1), \fBgnunet\-download\fP(1) | 35 | \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. | |||
28 | Use the configuration file FILENAME. | 28 | Use the configuration file FILENAME. |
29 | 29 | ||
30 | .SH BUGS | 30 | .SH BUGS |
31 | Report bugs by using Mantis <https://gnunet.org/mantis/> or by sending electronic mail to <gnunet\-developers@gnu.org> | 31 | Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> |
32 | 32 | ||
33 | .SH SEE ALSO | 33 | .SH SEE ALSO |
34 | gnunet\-service\-transport(1) | 34 | gnunet\-transport(1) |
35 | 35 | ||
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 @@ | |||
1 | .TH gnunet\-transport "1" "26 Oct 2011" "GNUnet" | ||
2 | .SH NAME | ||
3 | gnunet\-transport \- measure and control the transport subsystem | ||
4 | |||
5 | .SH SYNOPSIS | ||
6 | .B gnunet\-transport | ||
7 | [\fIOPTIONS\fR] | ||
8 | .SH DESCRIPTION | ||
9 | .PP | ||
10 | |||
11 | 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. | ||
12 | |||
13 | .TP | ||
14 | \fB\-b\fR, \fB\-\-benchmark\fR | ||
15 | measure how fast we are receiving data (from all connections). On exit, the data rate will be reported. Runs until aborted with CTRL-C. | ||
16 | .TP | ||
17 | \fB\-c \fIFILENAME\fR, \fB\-\-config=FILENAME\fR | ||
18 | configuration file to use | ||
19 | .TP | ||
20 | \fB\-C \fIPEER\fR, \fB\-\-connect=PEER\fR | ||
21 | peer to connect to (and to use for sending if used in conjunction with \-s) | ||
22 | .TP | ||
23 | \fB\-h\fR, \fB\-\-help\fR | ||
24 | print help page | ||
25 | .TP | ||
26 | \fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=LOGLEVEL\fR | ||
27 | Change the loglevel. Possible values for LOGLEVEL are ERROR, WARNING, INFO and DEBUG. | ||
28 | .TP | ||
29 | \fB\-s\fR, \fB\-\-send\fR | ||
30 | 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. | ||
31 | .TP | ||
32 | \fB\-v\fR, \fB\-\-version\fR | ||
33 | print the version number | ||
34 | .TP | ||
35 | \fB\-V\fR, \fB\-\-verbose\fR | ||
36 | be verbose | ||
37 | |||
38 | .SH NOTES | ||
39 | |||
40 | |||
41 | .SH "REPORTING BUGS" | ||
42 | Report bugs by using mantis <https://gnunet.org/bugs/> or by sending electronic mail to <gnunet\-developers@gnu.org> | ||
43 | .SH "SEE ALSO" | ||
44 | \fBgnunet\-arm\fP(1) | ||