diff options
author | ng0 <ng0@n0.is> | 2019-04-02 16:16:03 +0000 |
---|---|---|
committer | ng0 <ng0@n0.is> | 2019-04-02 16:16:03 +0000 |
commit | 352f2f70902ae60204751e8c4ef0797aa57e92d7 (patch) | |
tree | 8a0899f117ea0af98d8120b2baa0152c4094729c /doc | |
parent | aa0e773ad90171d0dd0ab54aaf4543e2c1a30cfc (diff) | |
download | gnunet-352f2f70902ae60204751e8c4ef0797aa57e92d7.tar.gz gnunet-352f2f70902ae60204751e8c4ef0797aa57e92d7.zip |
man: gnunet-arm: Extend manpage, add missing functions, etc.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man/gnunet-arm.1 | 141 |
1 files changed, 90 insertions, 51 deletions
diff --git a/doc/man/gnunet-arm.1 b/doc/man/gnunet-arm.1 index 6acfeb7c7..c25b10bb5 100644 --- a/doc/man/gnunet-arm.1 +++ b/doc/man/gnunet-arm.1 | |||
@@ -21,75 +21,114 @@ | |||
21 | .\" | 21 | .\" |
22 | .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later | 22 | .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later |
23 | .\" | 23 | .\" |
24 | .TH GNUNET\-ARM 1 "January 4, 2012" "GNUnet" | 24 | .Dd January 4, 2012 |
25 | .SH NAME | 25 | .Dt GNUNET-ARM 1 |
26 | gnunet\-arm \- control GNUnet services | 26 | .Os |
27 | .SH SYNOPSIS | 27 | .Sh NAME |
28 | .B gnunet\-arm | 28 | .Nm gnunet-arm |
29 | .RI [-c\ FILENAME\ |\ --config=FILENAME] | 29 | .Nd |
30 | .RI [-e\ |\ --end] | 30 | control GNUnet services |
31 | .RI [-h\ |\ --help] | 31 | .Sh SYNOPSIS |
32 | .RI [-L\ LOGLEVEL\ |\ --loglevel=LOGLEVEL] | 32 | .Nm |
33 | .RI [-i\ SERVICE\ |\ --init=SERVICE] | 33 | .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME |
34 | .RI [-k\ SERVICE\ |\ --kill=SERVICE] | 34 | .Op Fl d | \-delete |
35 | .RI [-m\ |\ --monitor] | 35 | .Op Fl e | \-end |
36 | .RI [-s\ |\ --start] | 36 | .Op Fl E | \-no-stderr |
37 | .RI [-v\ |\ --version] | 37 | .Op Fl h | \-help |
38 | .SH DESCRIPTION | 38 | .Op Fl i Ar SERVICE | Fl \-init= Ns Ar SERVICE |
39 | \fBgnunet\-arm\fP can be used to start or stop GNUnet services, including the ARM service itself. | 39 | .Op Fl I | \-info |
40 | .Op Fl k Ar SERVICE | Fl \-kill= Ns Ar SERVICE | ||
41 | .Op Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME | ||
42 | .Op Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL | ||
43 | .Op Fl m | \-monitor | ||
44 | .Op Fl O | \-no-stdout | ||
45 | .Op Fl q | \-quiet | ||
46 | .Op Fl r | \-restart | ||
47 | .Op Fl s | \-start | ||
48 | .Op Fl T DELAY | \-timeout= Ns Ar TIMEOUT | ||
49 | .Op Fl v | \-version | ||
50 | .Sh DESCRIPTION | ||
51 | .Nm | ||
52 | can be used to start or stop GNUnet services, including the ARM service itself. | ||
40 | The ARM service is a supervisor for GNUnet's service processes. | 53 | The ARM service is a supervisor for GNUnet's service processes. |
41 | ARM starts services on-demand or as configured and re-starts them if they crash. | 54 | ARM starts services on-demand or as configured and restarts them if they crash. |
42 | .SH OPTIONS | 55 | .Bl -tag -width Ds |
43 | .IP "\-c FILENAME\ | \-\-config=FILENAME" | 56 | .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME |
44 | Use the configuration file FILENAME. | 57 | Use the configuration file FILENAME. |
45 | .IP "\-e\ | \-\-end" | 58 | .It Fl d | \-delete |
59 | Delete config file and directory on exit. | ||
60 | .It Fl e | \-end | ||
46 | Shutdown all GNUnet services (including ARM itself). | 61 | Shutdown all GNUnet services (including ARM itself). |
47 | Running "gnunet-arm \-e" is the usual way to shutdown a GNUnet peer. | 62 | Running "gnunet-arm \-e" is the usual way to shutdown a GNUnet peer. |
48 | .IP "\-h\ | \-\-help" | 63 | .It Fl E | \-no-stderr |
64 | Don't let gnunet-arm inherit standard error. | ||
65 | .It Fl h | \-help | ||
49 | Print short help on options. | 66 | Print short help on options. |
50 | .IP "\-L LOGLEVEL\ | \-\-loglevel=LOGLEVEL" | 67 | .It Fl i Ar SERVICE | Fl \-init= Ns Ar SERVICE |
51 | Use LOGLEVEL for logging. | ||
52 | Valid values are DEBUG, INFO, WARNING and ERROR. | ||
53 | .IP "\-i SERVICE\ | \-\-init=SERVICE" | ||
54 | Starts the specified SERVICE if it is not already running. | 68 | Starts the specified SERVICE if it is not already running. |
55 | More specifically, this makes the service behave as if it were in the default services list. | 69 | More specifically, this makes the service behave as if it were in the default services list. |
56 | .IP "\-k SERVICE\ | \-\-kill=SERVICE" | 70 | .It Fl I | \-info |
71 | List all running services. | ||
72 | .It Fl k Ar SERVICE | Fl \-kill= Ns Ar SERVICE | ||
57 | Stop the specified SERVICE if it is running. | 73 | Stop the specified SERVICE if it is running. |
58 | 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'). | 74 | 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'). |
59 | If the service used to be a 'default' service, its default-service status will be revoked. | 75 | If the service used to be a 'default' service, its default-service status will be revoked. |
60 | If the service was not a default service, it will just be (temporarily) stopped, but could be re-started on-demand at any time. | 76 | If the service was not a default service, it will just be (temporarily) stopped, but could be re-started on-demand at any time. |
61 | .IP "\-m\ | \-\-monitor" | 77 | .It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME |
78 | Write logs to FILENAME. | ||
79 | .It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL | ||
80 | Use LOGLEVEL for logging. | ||
81 | Valid values are DEBUG, INFO, WARNING and ERROR. | ||
82 | .It Fl m | \-monitor | ||
62 | Monitor service activity of ARM. | 83 | Monitor service activity of ARM. |
63 | In this mode, the command will not terminate until the user presses CTRL-C. | 84 | In this mode, the command will not terminate until the user presses CTRL-C. |
64 | .IP "\-s\ | \-\-start" | 85 | .It Fl O | \-no-stdout |
86 | Don't let gnunet-arm inherit standard output | ||
87 | .It Fl q | \-quiet | ||
88 | Don't print status messages. | ||
89 | .It Fl r | \-restart | ||
90 | Stop and start all GNUnet default services. | ||
91 | .It Fl s | \-start | ||
65 | Start all GNUnet default services on this system (and also ARM). | 92 | Start all GNUnet default services on this system (and also ARM). |
66 | Naturally, if a service is demanded by a default service, it will then also be started. | 93 | Naturally, if a service is demanded by a default service, it will then also be started. |
67 | Running "gnunet-arm \-s" is the usual way to start a GNUnet peer. | 94 | Running "gnunet-arm \-s" is the usual way to start a GNUnet peer. |
68 | .IP "\-I\ | \-\-info" | 95 | .It Fl T DELAY | \-timeout= Ns Ar DELAY |
69 | List all running services. | 96 | Exit with error status if operation does not finish after DELAY |
70 | .IP "\-v\ | \-\-version" | 97 | .It Fl v | \-version |
71 | Print GNUnet version number. | 98 | Print GNUnet version number. |
72 | .SH SEE ALSO | 99 | .El |
73 | gnunet\-config(1), gnunet\-setup(1) | 100 | .Sh EXAMPLES |
74 | .PP | 101 | Start the gnunet-arm for the user: |
75 | The full documentation for | 102 | .Pp |
76 | .B gnunet | 103 | .Dl gnunet-arm -s |
77 | is maintained as a Texinfo manual. | 104 | .Pp |
105 | Stop the gnunet-arm for the user: | ||
106 | .Pp | ||
107 | .Dl $ gnunet-arm -e | ||
108 | .Sh SEE ALSO | ||
109 | .Xr gnunet-config 1 , | ||
110 | .Xr gnunet-setup 1 | ||
111 | .sp | ||
112 | The full documentation for gnunet is maintained as a Texinfo manual. | ||
78 | If the | 113 | If the |
79 | .B info | 114 | .Xr info 1 |
80 | and | 115 | and gnunet programs are properly installed at your site, the command |
81 | .B gnunet | 116 | .Pp |
82 | programs are properly installed at your site, the command | 117 | .Dl info gnunet |
83 | .IP | 118 | .Pp |
84 | .B info gnunet | ||
85 | .PP | ||
86 | should give you access to the complete handbook, | 119 | should give you access to the complete handbook, |
87 | .IP | 120 | .Pp |
88 | .B info gnunet-c-tutorial | 121 | .Dl info gnunet-c-tutorial |
89 | .PP | 122 | .Pp |
90 | will give you access to a tutorial for developers. | 123 | will give you access to a tutorial for developers. |
91 | .PP | 124 | .sp |
92 | Depending on your installation, this information is also available in | 125 | Depending on your installation, this information is also available in |
93 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). | 126 | .Xr gnunet 7 and |
94 | .SH BUGS | 127 | .Xr gnunet-c-tutorial 7 . |
95 | Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending electronic mail to <gnunet\-developers@gnu.org>. | 128 | .\".Sh HISTORY |
129 | .\".Sh AUTHORS | ||
130 | .Sh BUGS | ||
131 | Report bugs by using | ||
132 | .Lk https://bugs.gnunet.org | ||
133 | or by sending electronic mail to | ||
134 | .Aq Mt gnunet-developers@gnu.org . | ||