summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2012-01-04 15:46:29 +0000
committerChristian Grothoff <christian@grothoff.org>2012-01-04 15:46:29 +0000
commit99b3965d149e93fd3a2c6bc3a29b3a2d372cc8de (patch)
treebc513332cbba53c745860a44c6245d76163bcf6c /doc
parent3fe560c0a435d823c5afbafabb6de4734c1d4c50 (diff)
-formatting patch from GArik_
Diffstat (limited to 'doc')
-rw-r--r--doc/man/gnunet-arm.126
-rw-r--r--doc/man/gnunet-monkey.120
-rw-r--r--doc/man/gnunet-nat-server.18
-rw-r--r--doc/man/gnunet-statistics.126
4 files changed, 30 insertions, 50 deletions
diff --git a/doc/man/gnunet-arm.1 b/doc/man/gnunet-arm.1
index e8b7c7a61..1bd44677d 100644
--- a/doc/man/gnunet-arm.1
+++ b/doc/man/gnunet-arm.1
@@ -1,4 +1,4 @@
-.TH GNUNET\-ARM 1 "Mar 7, 2009" "GNUnet"
+.TH GNUNET\-ARM 1 "Jan 4, 2012" "GNUnet"
.SH NAME
gnunet\-arm \- control GNUnet services
@@ -12,36 +12,28 @@ gnunet\-arm \- control GNUnet services
\fBgnunet\-arm\fP can be used to start or stop GNUnet services, including the ARM service itself. The ARM service is a supervisor for GNUnet's service processes. ARM starts services on-demand or as configured and re-starts them if they crash.
.SH OPTIONS
-
-.TP
+.B
.IP "\-c FILENAME, \-\-config=FILENAME"
Use the configuration file FILENAME.
-
-.TP
+.B
.IP "\-e, \-\-end"
Shutdown all GNUnet services (including ARM itself). Running "gnunet-arm -e" is the usual way to shutdown a GNUnet peer.
-
-.TP
+.B
.IP "\-h, \-\-help"
Print short help on options.
-
-.TP
+.B
.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
-
-.TP
+.B
.IP "\-i SERVICE, \-\-init=SERVICE"
Starts the specified SERVICE if it is not already running. More specifically, this makes the service behave as if it were in the default services list.
-
-.TP
+.B
.IP "\-k SERVICE, \-\-kill=SERVICE"
Stop the specified SERVICE if it is running. While this will kill the service right now, the service may be restarted immediately if other services depend on it (service is then started 'on-demand'). If the service used to be a 'default' service, its default-service status will be revoked. If the service was not a default service, it will just be (temporarily) stopped, but could be re-started on-demand at any time.
-
-.TP
+.B
.IP "\-s, \-\-start"
Start all GNUnet default services on this system (and also ARM). Naturally, if a service is demanded by a default service, it will then also be started. Running "gnunet-arm -s" is the usual way to start a GNUnet peer.
-
-.TP
+.B
.IP "\-v, \-\-version"
Print GNUnet version number.
diff --git a/doc/man/gnunet-monkey.1 b/doc/man/gnunet-monkey.1
index 49ce45db1..d939da73f 100644
--- a/doc/man/gnunet-monkey.1
+++ b/doc/man/gnunet-monkey.1
@@ -1,4 +1,4 @@
-.TH GNUNET\-MONKEY 1 "Nov 4, 2010" "GNUnet"
+.TH GNUNET\-MONKEY 1 "Jan 4, 2012" "GNUnet"
.SH NAME
gnunet\-monkey \- automatically debugging for services
@@ -12,28 +12,22 @@ gnunet\-monkey \- automatically debugging for services
\fBgnunet\-monkey\fP used to automatically debug a service.
.SH OPTIONS
-
-.TP
+.B
.IP "\-h, \-\-help"
Print short help on options.
-
-.TP
+.B
.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
-
-.TP
+.B
.IP "\-m, \-\-mode"
Monkey's mode of operation: text: for writing debugging report in a text file, email: for sending debugging report to an email address.
-
-.TP
+.B
.IP "\-b, \-\-binary"
Path of the binary to debug with Monkey.
-
-.TP
+.B
.IP "\-o, \-\-output"
Only required in text mode: The path of the text file in which Monkey should write the debugging report.
-
-.TP
+.B
.IP "\-v, \-\-version"
Print GNUnet version number.
diff --git a/doc/man/gnunet-nat-server.1 b/doc/man/gnunet-nat-server.1
index a35ad3b01..bd1ab4167 100644
--- a/doc/man/gnunet-nat-server.1
+++ b/doc/man/gnunet-nat-server.1
@@ -1,11 +1,12 @@
-.TH GNUNET\-NAT\-SERVER 1 "Jul 1, 2011" "GNUnet"
+.TH GNUNET\-NAT\-SERVER 1 "Jan 4, 2012" "GNUnet"
.SH NAME
gnunet\-nat\-server \- help GNUnet setup test network setup with NAT
.SH SYNOPSIS
.B gnunet\-nat\-server
-.RI [ options ] PORT
+.RI [ options ]
+.RI PORT
.br
.SH DESCRIPTION
@@ -22,8 +23,7 @@ Note that gnunet\-nat\-server could be run via gnunet\-arm but typically is not.
.SH OPTIONS
-
-.TP
+.B
.IP "\-c FILENAME, \-\-config=FILENAME"
Use the configuration file FILENAME.
diff --git a/doc/man/gnunet-statistics.1 b/doc/man/gnunet-statistics.1
index 25f548ef6..e6c744f12 100644
--- a/doc/man/gnunet-statistics.1
+++ b/doc/man/gnunet-statistics.1
@@ -1,11 +1,12 @@
-.TH GNUNET\-STATISTICS 1 "Mar 6, 2009" "GNUnet"
+.TH GNUNET\-STATISTICS 1 "Jan 4, 2012" "GNUnet"
.SH NAME
gnunet\-statistics \- Display statistics about your GNUnet system
.SH SYNOPSIS
.B gnunet\-statistics
-.RI [ options ] [ VALUE ]
+.RI [ options ]
+.RI [ VALUE ]
.br
.SH DESCRIPTION
@@ -13,32 +14,25 @@ gnunet\-statistics \- Display statistics about your GNUnet system
gnunet\-statistics can be used to set a value by giving the options \-n, \-s and also a VALUE.
.SH OPTIONS
-
-.TP
+.B
.IP "\-c FILENAME, \-\-config=FILENAME"
Use the configuration file FILENAME.
-
-.TP
+.B
.IP "\-h, \-\-help"
Print short help on options.
-
-.TP
+.B
.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
-
-.TP
+.B
.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
+.B
.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
+.B
.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
+.B
.IP "\-v, \-\-version"
Print GNUnet version number.