aboutsummaryrefslogtreecommitdiff
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)
downloadgnunet-99b3965d149e93fd3a2c6bc3a29b3a2d372cc8de.tar.gz
gnunet-99b3965d149e93fd3a2c6bc3a29b3a2d372cc8de.zip
-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 @@
1.TH GNUNET\-ARM 1 "Mar 7, 2009" "GNUnet" 1.TH GNUNET\-ARM 1 "Jan 4, 2012" "GNUnet"
2 2
3.SH NAME 3.SH NAME
4gnunet\-arm \- control GNUnet services 4gnunet\-arm \- control GNUnet services
@@ -12,36 +12,28 @@ gnunet\-arm \- control GNUnet services
12\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. 12\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.
13 13
14.SH OPTIONS 14.SH OPTIONS
15 15.B
16.TP
17.IP "\-c FILENAME, \-\-config=FILENAME" 16.IP "\-c FILENAME, \-\-config=FILENAME"
18Use the configuration file FILENAME. 17Use the configuration file FILENAME.
19 18.B
20.TP
21.IP "\-e, \-\-end" 19.IP "\-e, \-\-end"
22Shutdown all GNUnet services (including ARM itself). Running "gnunet-arm -e" is the usual way to shutdown a GNUnet peer. 20Shutdown all GNUnet services (including ARM itself). Running "gnunet-arm -e" is the usual way to shutdown a GNUnet peer.
23 21.B
24.TP
25.IP "\-h, \-\-help" 22.IP "\-h, \-\-help"
26Print short help on options. 23Print short help on options.
27 24.B
28.TP
29.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 25.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
30Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. 26Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
31 27.B
32.TP
33.IP "\-i SERVICE, \-\-init=SERVICE" 28.IP "\-i SERVICE, \-\-init=SERVICE"
34Starts 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. 29Starts 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.
35 30.B
36.TP
37.IP "\-k SERVICE, \-\-kill=SERVICE" 31.IP "\-k SERVICE, \-\-kill=SERVICE"
38Stop 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. 32Stop 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.
39 33.B
40.TP
41.IP "\-s, \-\-start" 34.IP "\-s, \-\-start"
42Start 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. 35Start 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.
43 36.B
44.TP
45.IP "\-v, \-\-version" 37.IP "\-v, \-\-version"
46Print GNUnet version number. 38Print GNUnet version number.
47 39
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 @@
1.TH GNUNET\-MONKEY 1 "Nov 4, 2010" "GNUnet" 1.TH GNUNET\-MONKEY 1 "Jan 4, 2012" "GNUnet"
2 2
3.SH NAME 3.SH NAME
4gnunet\-monkey \- automatically debugging for services 4gnunet\-monkey \- automatically debugging for services
@@ -12,28 +12,22 @@ gnunet\-monkey \- automatically debugging for services
12\fBgnunet\-monkey\fP used to automatically debug a service. 12\fBgnunet\-monkey\fP used to automatically debug a service.
13 13
14.SH OPTIONS 14.SH OPTIONS
15 15.B
16.TP
17.IP "\-h, \-\-help" 16.IP "\-h, \-\-help"
18Print short help on options. 17Print short help on options.
19 18.B
20.TP
21.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 19.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
22Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. 20Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
23 21.B
24.TP
25.IP "\-m, \-\-mode" 22.IP "\-m, \-\-mode"
26Monkey's mode of operation: text: for writing debugging report in a text file, email: for sending debugging report to an email address. 23Monkey's mode of operation: text: for writing debugging report in a text file, email: for sending debugging report to an email address.
27 24.B
28.TP
29.IP "\-b, \-\-binary" 25.IP "\-b, \-\-binary"
30Path of the binary to debug with Monkey. 26Path of the binary to debug with Monkey.
31 27.B
32.TP
33.IP "\-o, \-\-output" 28.IP "\-o, \-\-output"
34Only required in text mode: The path of the text file in which Monkey should write the debugging report. 29Only required in text mode: The path of the text file in which Monkey should write the debugging report.
35 30.B
36.TP
37.IP "\-v, \-\-version" 31.IP "\-v, \-\-version"
38Print GNUnet version number. 32Print GNUnet version number.
39 33
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 @@
1.TH GNUNET\-NAT\-SERVER 1 "Jul 1, 2011" "GNUnet" 1.TH GNUNET\-NAT\-SERVER 1 "Jan 4, 2012" "GNUnet"
2 2
3.SH NAME 3.SH NAME
4gnunet\-nat\-server \- help GNUnet setup test network setup with NAT 4gnunet\-nat\-server \- help GNUnet setup test network setup with NAT
5 5
6.SH SYNOPSIS 6.SH SYNOPSIS
7.B gnunet\-nat\-server 7.B gnunet\-nat\-server
8.RI [ options ] PORT 8.RI [ options ]
9.RI PORT
9.br 10.br
10 11
11.SH DESCRIPTION 12.SH DESCRIPTION
@@ -22,8 +23,7 @@ Note that gnunet\-nat\-server could be run via gnunet\-arm but typically is not.
22 23
23 24
24.SH OPTIONS 25.SH OPTIONS
25 26.B
26.TP
27.IP "\-c FILENAME, \-\-config=FILENAME" 27.IP "\-c FILENAME, \-\-config=FILENAME"
28Use the configuration file FILENAME. 28Use the configuration file FILENAME.
29 29
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 @@
1.TH GNUNET\-STATISTICS 1 "Mar 6, 2009" "GNUnet" 1.TH GNUNET\-STATISTICS 1 "Jan 4, 2012" "GNUnet"
2 2
3.SH NAME 3.SH NAME
4gnunet\-statistics \- Display statistics about your GNUnet system 4gnunet\-statistics \- Display statistics about your GNUnet system
5 5
6.SH SYNOPSIS 6.SH SYNOPSIS
7.B gnunet\-statistics 7.B gnunet\-statistics
8.RI [ options ] [ VALUE ] 8.RI [ options ]
9.RI [ VALUE ]
9.br 10.br
10 11
11.SH DESCRIPTION 12.SH DESCRIPTION
@@ -13,32 +14,25 @@ gnunet\-statistics \- Display statistics about your GNUnet system
13gnunet\-statistics can be used to set a value by giving the options \-n, \-s and also a VALUE. 14gnunet\-statistics can be used to set a value by giving the options \-n, \-s and also a VALUE.
14 15
15.SH OPTIONS 16.SH OPTIONS
16 17.B
17.TP
18.IP "\-c FILENAME, \-\-config=FILENAME" 18.IP "\-c FILENAME, \-\-config=FILENAME"
19Use the configuration file FILENAME. 19Use the configuration file FILENAME.
20 20.B
21.TP
22.IP "\-h, \-\-help" 21.IP "\-h, \-\-help"
23Print short help on options. 22Print short help on options.
24 23.B
25.TP
26.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 24.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
27Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. 25Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR.
28 26.B
29.TP
30.IP "\-n NAME, \-\-name=NAME" 27.IP "\-n NAME, \-\-name=NAME"
31Each 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. 28Each 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.
32 29.B
33.TP
34.IP "\-p, \-\-persistent" 30.IP "\-p, \-\-persistent"
35When 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. 31When 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.
36 32.B
37.TP
38.IP "\-s SUBSYSTEM, \-\-subsystem=SUBSYSTEM" 33.IP "\-s SUBSYSTEM, \-\-subsystem=SUBSYSTEM"
39Statistics are kept for various subsystems. With this option, the output can be restricted to a particular subsystem only. 34Statistics are kept for various subsystems. With this option, the output can be restricted to a particular subsystem only.
40 35.B
41.TP
42.IP "\-v, \-\-version" 36.IP "\-v, \-\-version"
43Print GNUnet version number. 37Print GNUnet version number.
44 38