aboutsummaryrefslogtreecommitdiff
path: root/doc/man/gnunet-arm.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/gnunet-arm.1')
-rw-r--r--doc/man/gnunet-arm.1198
1 files changed, 127 insertions, 71 deletions
diff --git a/doc/man/gnunet-arm.1 b/doc/man/gnunet-arm.1
index b17e74a73..c25b10bb5 100644
--- a/doc/man/gnunet-arm.1
+++ b/doc/man/gnunet-arm.1
@@ -1,78 +1,134 @@
1.TH GNUNET\-ARM 1 "January 4, 2012" "GNUnet" 1.\" This file is part of GNUnet.
2.SH NAME 2.\" Copyright (C) 2001-2019 GNUnet e.V.
3gnunet\-arm \- control GNUnet services 3.\"
4.SH SYNOPSIS 4.\" Permission is granted to copy, distribute and/or modify this document
5.B gnunet\-arm 5.\" under the terms of the GNU Free Documentation License, Version 1.3 or
6.RI [ options ] 6.\" any later version published by the Free Software Foundation; with no
7.SH DESCRIPTION 7.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
8\fBgnunet\-arm\fP can be used to start or stop GNUnet services, including 8.\" copy of the license is included in the file
9the ARM service itself. The ARM service is a supervisor for GNUnet's 9.\" ``FDL-1.3''.
10service processes. ARM starts services on-demand or as configured and 10.\"
11re-starts them if they crash. 11.\" A copy of the license is also available from the Free Software
12.SH OPTIONS 12.\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
13.B 13.\"
14.IP "\-c FILENAME, \-\-config=FILENAME" 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.\"
24.Dd January 4, 2012
25.Dt GNUNET-ARM 1
26.Os
27.Sh NAME
28.Nm gnunet-arm
29.Nd
30control GNUnet services
31.Sh SYNOPSIS
32.Nm
33.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
34.Op Fl d | \-delete
35.Op Fl e | \-end
36.Op Fl E | \-no-stderr
37.Op Fl h | \-help
38.Op Fl i Ar SERVICE | Fl \-init= Ns Ar SERVICE
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
52can be used to start or stop GNUnet services, including the ARM service itself.
53The ARM service is a supervisor for GNUnet's service processes.
54ARM starts services on-demand or as configured and restarts them if they crash.
55.Bl -tag -width Ds
56.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
15Use the configuration file FILENAME. 57Use the configuration file FILENAME.
16.B 58.It Fl d | \-delete
17.IP "\-e, \-\-end" 59Delete config file and directory on exit.
18Shutdown all GNUnet services (including ARM itself). Running 60.It Fl e | \-end
19"gnunet-arm \-e" is the usual way to shutdown a GNUnet peer. 61Shutdown all GNUnet services (including ARM itself).
20.B 62Running "gnunet-arm \-e" is the usual way to shutdown a GNUnet peer.
21.IP "\-h, \-\-help" 63.It Fl E | \-no-stderr
64Don't let gnunet-arm inherit standard error.
65.It Fl h | \-help
22Print short help on options. 66Print short help on options.
23.B 67.It Fl i Ar SERVICE | Fl \-init= Ns Ar SERVICE
24.IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL" 68Starts the specified SERVICE if it is not already running.
25Use LOGLEVEL for logging. Valid values are DEBUG, INFO, WARNING and ERROR. 69More specifically, this makes the service behave as if it were in the default services list.
26.B 70.It Fl I | \-info
27.IP "\-i SERVICE, \-\-init=SERVICE"
28Starts the specified SERVICE if it is not already running. More specifically,
29this makes the service behave as if it were in the default services list.
30.B
31.IP "\-k SERVICE, \-\-kill=SERVICE"
32Stop the specified SERVICE if it is running. While this will kill the service
33right now, the service may be restarted immediately if other services depend
34on it (service is then started 'on-demand'). If the service used to be a 'default'
35service, its default-service status will be revoked. If the
36service was not a default service, it will just be (temporarily) stopped,
37but could be re-started on-demand at any time.
38.B
39.IP "\-m, \-\-monitor"
40Monitor service activity of ARM. In this mode, the command will not terminate
41until the user presses CTRL-C.
42.B
43.IP "\-s, \-\-start"
44Start all GNUnet default services on this system (and also ARM). Naturally,
45if a service is demanded by a default service, it will then also be started.
46Running "gnunet-arm \-s" is the usual way to start a GNUnet peer.
47.B
48.IP "\-I, \-\-info"
49List all running services. 71List all running services.
50.B 72.It Fl k Ar SERVICE | Fl \-kill= Ns Ar SERVICE
51.IP "\-v, \-\-version" 73Stop the specified SERVICE if it is running.
74While 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').
75If the service used to be a 'default' service, its default-service status will be revoked.
76If the service was not a default service, it will just be (temporarily) stopped, but could be re-started on-demand at any time.
77.It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
78Write logs to FILENAME.
79.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
80Use LOGLEVEL for logging.
81Valid values are DEBUG, INFO, WARNING and ERROR.
82.It Fl m | \-monitor
83Monitor service activity of ARM.
84In this mode, the command will not terminate until the user presses CTRL-C.
85.It Fl O | \-no-stdout
86Don't let gnunet-arm inherit standard output
87.It Fl q | \-quiet
88Don't print status messages.
89.It Fl r | \-restart
90Stop and start all GNUnet default services.
91.It Fl s | \-start
92Start all GNUnet default services on this system (and also ARM).
93Naturally, if a service is demanded by a default service, it will then also be started.
94Running "gnunet-arm \-s" is the usual way to start a GNUnet peer.
95.It Fl T DELAY | \-timeout= Ns Ar DELAY
96Exit with error status if operation does not finish after DELAY
97.It Fl v | \-version
52Print GNUnet version number. 98Print GNUnet version number.
53.SH BUGS 99.El
54Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending 100.Sh EXAMPLES
55electronic mail to <gnunet\-developers@gnu.org> 101Start the gnunet-arm for the user:
56.SH SEE ALSO 102.Pp
57gnunet\-config(1), gnunet\-setup(1) 103.Dl gnunet-arm -s
58.PP 104.Pp
59The full documentation for 105Stop the gnunet-arm for the user:
60.B gnunet 106.Pp
61is maintained as a Texinfo manual. 107.Dl $ gnunet-arm -e
108.Sh SEE ALSO
109.Xr gnunet-config 1 ,
110.Xr gnunet-setup 1
111.sp
112The full documentation for gnunet is maintained as a Texinfo manual.
62If the 113If the
63.B info 114.Xr info 1
64and 115and gnunet programs are properly installed at your site, the command
65.B gnunet 116.Pp
66programs are properly installed at your site, the command 117.Dl info gnunet
67.IP 118.Pp
68.B info gnunet
69.PP
70should give you access to the complete handbook, 119should give you access to the complete handbook,
71.IP 120.Pp
72.B info gnunet-c-tutorial 121.Dl info gnunet-c-tutorial
73.PP 122.Pp
74will give you access to a tutorial for developers. 123will give you access to a tutorial for developers.
75.PP 124.sp
76Depending on your installation, this information is also 125Depending on your installation, this information is also available in
77available in 126.Xr gnunet 7 and
78\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 127.Xr gnunet-c-tutorial 7 .
128.\".Sh HISTORY
129.\".Sh AUTHORS
130.Sh BUGS
131Report bugs by using
132.Lk https://bugs.gnunet.org
133or by sending electronic mail to
134.Aq Mt gnunet-developers@gnu.org .
generated by cgit v1.2.3 (git 2.39.1) at 2024-05-18 19:44:40 +0000