diff options
author | ng0 <ng0@n0.is> | 2019-03-09 09:24:20 +0000 |
---|---|---|
committer | ng0 <ng0@n0.is> | 2019-03-09 09:24:20 +0000 |
commit | 006b7d94863d1ed70f7d67142f62995190e50803 (patch) | |
tree | ed190ff78c2d7e07edb257061d451435bcc501b1 /doc/man | |
parent | 8bfe3519ce31eb8b73f470dfcf2a72d368b96a1d (diff) | |
download | gnunet-006b7d94863d1ed70f7d67142f62995190e50803.tar.gz gnunet-006b7d94863d1ed70f7d67142f62995190e50803.zip |
gnunet-arm.1: lint and license
Diffstat (limited to 'doc/man')
-rw-r--r-- | doc/man/gnunet-arm.1 | 107 |
1 files changed, 62 insertions, 45 deletions
diff --git a/doc/man/gnunet-arm.1 b/doc/man/gnunet-arm.1 index b17e74a73..6acfeb7c7 100644 --- a/doc/man/gnunet-arm.1 +++ b/doc/man/gnunet-arm.1 | |||
@@ -1,58 +1,74 @@ | |||
1 | .\" This file is part of GNUnet. | ||
2 | .\" Copyright (C) 2001-2019 GNUnet e.V. | ||
3 | .\" | ||
4 | .\" Permission is granted to copy, distribute and/or modify this document | ||
5 | .\" under the terms of the GNU Free Documentation License, Version 1.3 or | ||
6 | .\" any later version published by the Free Software Foundation; with no | ||
7 | .\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A | ||
8 | .\" copy of the license is included in the file | ||
9 | .\" ``FDL-1.3''. | ||
10 | .\" | ||
11 | .\" A copy of the license is also available from the Free Software | ||
12 | .\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}. | ||
13 | .\" | ||
14 | .\" Alternately, this document is also available under the General | ||
15 | .\" Public License, version 3 or later, as published by the Free Software | ||
16 | .\" Foundation. A copy of the license is included in the file | ||
17 | .\" ``GPL3''. | ||
18 | .\" | ||
19 | .\" A copy of the license is also available from the Free Software | ||
20 | .\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}. | ||
21 | .\" | ||
22 | .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later | ||
23 | .\" | ||
1 | .TH GNUNET\-ARM 1 "January 4, 2012" "GNUnet" | 24 | .TH GNUNET\-ARM 1 "January 4, 2012" "GNUnet" |
2 | .SH NAME | 25 | .SH NAME |
3 | gnunet\-arm \- control GNUnet services | 26 | gnunet\-arm \- control GNUnet services |
4 | .SH SYNOPSIS | 27 | .SH SYNOPSIS |
5 | .B gnunet\-arm | 28 | .B gnunet\-arm |
6 | .RI [ options ] | 29 | .RI [-c\ FILENAME\ |\ --config=FILENAME] |
30 | .RI [-e\ |\ --end] | ||
31 | .RI [-h\ |\ --help] | ||
32 | .RI [-L\ LOGLEVEL\ |\ --loglevel=LOGLEVEL] | ||
33 | .RI [-i\ SERVICE\ |\ --init=SERVICE] | ||
34 | .RI [-k\ SERVICE\ |\ --kill=SERVICE] | ||
35 | .RI [-m\ |\ --monitor] | ||
36 | .RI [-s\ |\ --start] | ||
37 | .RI [-v\ |\ --version] | ||
7 | .SH DESCRIPTION | 38 | .SH DESCRIPTION |
8 | \fBgnunet\-arm\fP can be used to start or stop GNUnet services, including | 39 | \fBgnunet\-arm\fP can be used to start or stop GNUnet services, including the ARM service itself. |
9 | the ARM service itself. The ARM service is a supervisor for GNUnet's | 40 | The ARM service is a supervisor for GNUnet's service processes. |
10 | service processes. ARM starts services on-demand or as configured and | 41 | ARM starts services on-demand or as configured and re-starts them if they crash. |
11 | re-starts them if they crash. | ||
12 | .SH OPTIONS | 42 | .SH OPTIONS |
13 | .B | 43 | .IP "\-c FILENAME\ | \-\-config=FILENAME" |
14 | .IP "\-c FILENAME, \-\-config=FILENAME" | ||
15 | Use the configuration file FILENAME. | 44 | Use the configuration file FILENAME. |
16 | .B | 45 | .IP "\-e\ | \-\-end" |
17 | .IP "\-e, \-\-end" | 46 | Shutdown all GNUnet services (including ARM itself). |
18 | Shutdown all GNUnet services (including ARM itself). Running | 47 | Running "gnunet-arm \-e" is the usual way to shutdown a GNUnet peer. |
19 | "gnunet-arm \-e" is the usual way to shutdown a GNUnet peer. | 48 | .IP "\-h\ | \-\-help" |
20 | .B | ||
21 | .IP "\-h, \-\-help" | ||
22 | Print short help on options. | 49 | Print short help on options. |
23 | .B | 50 | .IP "\-L LOGLEVEL\ | \-\-loglevel=LOGLEVEL" |
24 | .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" | 51 | Use LOGLEVEL for logging. |
25 | Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. | 52 | Valid values are DEBUG, INFO, WARNING and ERROR. |
26 | .B | 53 | .IP "\-i SERVICE\ | \-\-init=SERVICE" |
27 | .IP "\-i SERVICE, \-\-init=SERVICE" | 54 | Starts the specified SERVICE if it is not already running. |
28 | Starts the specified SERVICE if it is not already running. More specifically, | 55 | More specifically, this makes the service behave as if it were in the default services list. |
29 | this makes the service behave as if it were in the default services list. | 56 | .IP "\-k SERVICE\ | \-\-kill=SERVICE" |
30 | .B | 57 | Stop the specified SERVICE if it is running. |
31 | .IP "\-k SERVICE, \-\-kill=SERVICE" | 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'). |
32 | Stop the specified SERVICE if it is running. While this will kill the service | 59 | If the service used to be a 'default' service, its default-service status will be revoked. |
33 | right now, the service may be restarted immediately if other services depend | 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. |
34 | on it (service is then started 'on-demand'). If the service used to be a 'default' | 61 | .IP "\-m\ | \-\-monitor" |
35 | service, its default-service status will be revoked. If the | 62 | Monitor service activity of ARM. |
36 | service was not a default service, it will just be (temporarily) stopped, | 63 | In this mode, the command will not terminate until the user presses CTRL-C. |
37 | but could be re-started on-demand at any time. | 64 | .IP "\-s\ | \-\-start" |
38 | .B | 65 | Start all GNUnet default services on this system (and also ARM). |
39 | .IP "\-m, \-\-monitor" | 66 | Naturally, if a service is demanded by a default service, it will then also be started. |
40 | Monitor service activity of ARM. In this mode, the command will not terminate | ||
41 | until the user presses CTRL-C. | ||
42 | .B | ||
43 | .IP "\-s, \-\-start" | ||
44 | Start all GNUnet default services on this system (and also ARM). Naturally, | ||
45 | if a service is demanded by a default service, it will then also be started. | ||
46 | Running "gnunet-arm \-s" is the usual way to start a GNUnet peer. | 67 | Running "gnunet-arm \-s" is the usual way to start a GNUnet peer. |
47 | .B | 68 | .IP "\-I\ | \-\-info" |
48 | .IP "\-I, \-\-info" | ||
49 | List all running services. | 69 | List all running services. |
50 | .B | 70 | .IP "\-v\ | \-\-version" |
51 | .IP "\-v, \-\-version" | ||
52 | Print GNUnet version number. | 71 | Print GNUnet version number. |
53 | .SH BUGS | ||
54 | Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending | ||
55 | electronic mail to <gnunet\-developers@gnu.org> | ||
56 | .SH SEE ALSO | 72 | .SH SEE ALSO |
57 | gnunet\-config(1), gnunet\-setup(1) | 73 | gnunet\-config(1), gnunet\-setup(1) |
58 | .PP | 74 | .PP |
@@ -73,6 +89,7 @@ should give you access to the complete handbook, | |||
73 | .PP | 89 | .PP |
74 | will give you access to a tutorial for developers. | 90 | will give you access to a tutorial for developers. |
75 | .PP | 91 | .PP |
76 | Depending on your installation, this information is also | 92 | Depending on your installation, this information is also available in |
77 | available in | ||
78 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). | 93 | \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). |
94 | .SH BUGS | ||
95 | Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending electronic mail to <gnunet\-developers@gnu.org>. | ||