summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2009-05-29 00:46:26 +0000
committerChristian Grothoff <christian@grothoff.org>2009-05-29 00:46:26 +0000
commit0a217a8df1657b4334b55b0e4a6c7837a8dbcfd9 (patch)
tree6b552f40eb089db96409a312a98d9b12bd669102 /doc
ng
Diffstat (limited to 'doc')
-rw-r--r--doc/man/Makefile.am7
-rw-r--r--doc/man/gnunet-arm.157
-rw-r--r--doc/man/gnunet-peerinfo.142
-rw-r--r--doc/man/gnunet-statistics.150
-rw-r--r--doc/man/gnunet-transport.196
5 files changed, 252 insertions, 0 deletions
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
new file mode 100644
index 000000000..734fc9c85
--- /dev/null
+++ b/doc/man/Makefile.am
@@ -0,0 +1,7 @@
+man_MANS = \
+ gnunet-arm.1 \
+ gnunet-peerinfo.1 \
+ gnunet-statistics.1 \
+ gnunet-transport.c
+
+EXTRA_DIST = ${man_MANS}
diff --git a/doc/man/gnunet-arm.1 b/doc/man/gnunet-arm.1
new file mode 100644
index 000000000..e440479c3
--- /dev/null
+++ b/doc/man/gnunet-arm.1
@@ -0,0 +1,57 @@
+.TH GNUNET\-ARM 1 "Mar 7, 2009" "GNUnet"
+
+.SH NAME
+gnunet\-arm \- control GNUnet services
+
+.SH SYNOPSIS
+.B gnunet-arm
+.RI [ options ]
+.br
+
+.SH DESCRIPTION
+\fBgnunet\-arm\fP can be used to start or stop GNUnet services, including the ARM service itself.
+
+.SH OPTIONS
+
+.TP
+.IP "\-c FILENAME, \-\-config=FILENAME"
+Use the configuration file FILENAME.
+
+.TP
+.IP "\-e, \-\-end"
+Shutdown all GNUnet services (including ARM).
+
+.TP
+.IP "\-h, \-\-help"
+Print short help on options.
+
+.TP
+.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
+Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
+
+.TP
+.IP "\-i SERVICE, \-\-init=SERVICE"
+Starts the specified SERVICE if it is not already running.
+
+.TP
+.IP "\-k SERVICE, \-\-kill=SERVICE"
+Stop the specified SERVICE if it is running.
+
+.TP
+.IP "\-s, \-\-start"
+Start all GNUnet default services on this system (including ARM).
+
+.TP
+.IP "\-t SERVICE, \-\-test=SERVICE"
+Report if the specified SERVICE is running.
+
+.TP
+.IP "\-v, \-\-version"
+Print GNUnet version number.
+
+
+.SH BUGS
+Report bugs by using Mantis <https://gnunet.org/mantis/> or by sending electronic mail to <gnunet\-developers@gnu.org>
+
+.SH SEE ALSO
+gnunet\-service\-arm(1)
diff --git a/doc/man/gnunet-peerinfo.1 b/doc/man/gnunet-peerinfo.1
new file mode 100644
index 000000000..2980d3544
--- /dev/null
+++ b/doc/man/gnunet-peerinfo.1
@@ -0,0 +1,42 @@
+.TH GNUNET-PEERINFO 1 "Mar 15, 2009" "GNUnet"
+
+.SH NAME
+gnunet\-peerinfo \- Display information about other peers.
+
+.SH SYNOPSIS
+.B gnunet\-peerinfo
+.RI [ options ]
+.br
+
+.SH DESCRIPTION
+.PP
+\fBgnunet\-peerinfo\fP display the known addresses and trust of known peers.
+
+.SH OPTIONS
+.B
+.IP "\-c FILENAME, \-\-config=FILENAME"
+Load config file (default: /etc/gnunet.conf)
+.B
+.IP "\-h, \-\-help"
+Print help page
+.B
+.IP "\-n, \-\-numeric"
+Disable resolution of IPs to hostnames
+.B
+.IP "\-q, \-\-quiet"
+Do not print anything but the peer identities
+.B
+.IP "\-s, \-\-self"
+Print only our own identity (together with "\-q", this is the exact line that other peers would have to put in to their friends file in order to consider this peer one of their friends in F2F mode).
+.B
+.IP "\-v, \-\-version"
+Print the version number
+.B
+.IP "\-L LOGLEVEL, \-\-loglelvel=LOGLEVEL"
+Set the loglevel
+
+.SH BUGS
+Report bugs by using mantis <https://gnunet.org/mantis/> or by sending electronic mail to <gnunet\-developers@gnu.org>
+
+.SH SEE ALSO
+gnunet.conf(5)
diff --git a/doc/man/gnunet-statistics.1 b/doc/man/gnunet-statistics.1
new file mode 100644
index 000000000..8a23e01e0
--- /dev/null
+++ b/doc/man/gnunet-statistics.1
@@ -0,0 +1,50 @@
+.TH GNUNET\-STATISTICS 1 "Mar 6, 2009" "GNUnet"
+
+.SH NAME
+gnunet\-statistics \- Display statistics about your GNUnet system
+
+.SH SYNOPSIS
+.B gnunet-statistics
+.RI [ options ] [ VALUE ]
+.br
+
+.SH DESCRIPTION
+\fBgnunet\-statistics\fP is used to display detailed information about various aspect of GNUnet's operation. This tool only works if the "statistics" service is available.
+gnunet\-statistics can be used to set a value by giving the options \-n, \-s and also a VALUE.
+
+.SH OPTIONS
+
+.TP
+.IP "\-c FILENAME, \-\-config=FILENAME"
+Use the configuration file FILENAME.
+
+.TP
+.IP "\-h, \-\-help"
+Print short help on options.
+
+.TP
+.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
+Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
+
+.TP
+.IP "\-n NAME, \-\-name=NAME"
+Each statistic has a name that is unique with in its subsystem. With this option, the output can be restricted to statistics that have a particular name.
+
+.TP
+.IP "\-p, \-\-persistent"
+When setting a value, make the value persistent. If the value used to be persistent and this flag is not given, it will be marked as non\-persistent.
+
+.TP
+.IP "\-s SUBSYSTEM, \-\-subsystem=SUBSYSTEM"
+Statistics are kept for various subsystems. With this option, the output can be restricted to a particular subsystem only.
+
+.TP
+.IP "\-v, \-\-version"
+Print GNUnet version number.
+
+
+.SH BUGS
+Report bugs by using Mantis <https://gnunet.org/mantis/> or by sending electronic mail to <gnunet\-developers@gnu.org>
+
+.SH SEE ALSO
+gnunet\-service\-statistics(1)
diff --git a/doc/man/gnunet-transport.1 b/doc/man/gnunet-transport.1
new file mode 100644
index 000000000..643759395
--- /dev/null
+++ b/doc/man/gnunet-transport.1
@@ -0,0 +1,96 @@
+.TH GNUNET-TRANSPORT "1" "23 Dec 2006" "GNUnet"
+.SH NAME
+gnunet\-transport \- a tool to test a GNUnet transport service
+.SH SYNOPSIS
+.B gnunet\-transport\
+[\fIOPTIONS\fR]
+.SH DESCRIPTION
+.PP
+gnunet\-transport can be used to test or profile
+a GNUnet transport service. The tool can be used to test
+both the correctness of the software as well as the correctness
+of the configuration. gnunet\-transport features two modes,
+called loopback mode and ping mode. In loopback mode the test is limited to testing if the
+transport can be used to communicate with itself (loopback).
+This mode does not include communication with other peers which
+may be blocked by firewalls and other general Internet connectivity
+problems. The loopback mode is particularly useful to test
+the SMTP transport service since this service is fairly hard to
+configure correctly and most problems can be reveiled by just
+testing the loopback. In ping mode the tool will attempt to download
+peer advertisements from the URL specified in the configuration file
+and then try to contact each of the peers. Note that it is perfectly
+normal that some peers do not respond, but if no peer responds something
+is likely to be wrong. The configuration is always taken
+from the configuration file. Do not run gnunetd while running
+gnunet\-transport since the transport services cannot
+be used by two processes at the same time.
+.PP
+gnunet\-transport will always produce an error\-message for
+the NAT transport in loopback mode. If NAT is configured in accept\-mode (as in,
+accept connections from peers using network address translation),
+the check will fail with the message "could not create HELO",
+which is correct since the peer itself is clearly not going to
+advertise itself as a NAT. If the peer is configured in NAT\-mode,
+that is, the peer is behind a NAT box, the message will be
+'could not connect'. For NAT, both messages are NOT errors
+but exactly what is supposed to happen.
+.PP
+Similarly, a NAT\-ed peer should typically configure the TCP transport
+to use port 0 (not listen on any port). In this case,
+gnunet\-transport will print 'could not create HELO' for the
+TCP transport. This is also ok. In fact, a correctly configured
+peer using NAT should give just two errors (could not connect for
+tcp and could not create HELO for NAT) when tested using
+gnunet\-transport\. The reason is, that gnunet\-transport\
+only tests loopback connectivity, and for a NAT\-ed peer, that just
+does not apply.
+.PP
+Note that in ping mode the HTTP download times out after 5 minutes,
+so if the list of peers is very large and not all peers can be
+queried within the 5 minutes the tool may abort before trying all
+peers.
+.TP
+\fB\-c \fIFILENAME\fR, \fB\-\-config=\fIFILENAME\fR
+use config file (default: /etc/gnunetd.conf)
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+print help page
+.TP
+\fB\-L \fILOGLEVEL\fR, \fB\-\-loglevel=\fILOGLEVEL\fR
+change the loglevel. Possible values for \fILOGLEVEL\fR are NOTHING, FATAL, ERROR, FAILURE, WARNING, MESSAGE, INFO, DEBUG, CRON and EVERYTHING.
+.TP
+\fB\-p\fR, \fB\-\-ping\fR
+use ping mode (loopback mode is default)
+.TP
+\fB\-r\fI COUNT \fB\-\-repeat=\fICOUNT\fR
+send COUNT messages in a sequence over the same connection
+.TP
+\fB\-s\fI SIZE \fB\-\-size=\fISIZE\fR
+test using the specified message size, default is 11
+.TP
+\fB\-t\fI TRANSPORT\fR, \fB\-\-transport=\fITRANSPORT\fR
+run using the specified transport, if not given the transports
+configured in the configuration file are used.
+.TP
+\fB\-u \fIUSER\fR, \fB\-\-user=USER\fR
+run as user USER (and if available as group USER). Note that to use this option, you will probably have to start gnunet-transport as
+root. It is typically better to directly start gnunet-transport as that user instead.
+.TP
+\fB\-v\fR, \fB\-\-version\fR
+print the version number
+.TP
+\fB\-V\fR, \fB\-\-verbose\fR
+be verbose
+.SH NOTES
+gnunet\-transport can run for a long time, depending on
+how high you have set the \fICOUNT\fR level. Run first with small numbers
+for \fICOUNT\fR to get an initial estimate on the runtime.
+.SH FILES
+.TP
+/etc/gnunetd.conf
+default gnunetd configuration file
+.SH "REPORTING BUGS"
+Report bugs by using mantis <https://gnunet.org/mantis/> or by sending electronic mail to <gnunet-developers@gnu.org>
+.SH "SEE ALSO"
+\fBgnunetd.conf\fP(5), \fBgnunetd\fP(1)