Merge branch 'master' of ssh://gnunet.org/gnunet
[oweals/gnunet.git] / doc / man / gnunet-arm.1
1 .TH GNUNET\-ARM 1 "Jan 4, 2012" "GNUnet"
2
3 .SH NAME
4 gnunet\-arm \- control GNUnet services
5
6 .SH SYNOPSIS
7 .B gnunet\-arm
8 .RI [ options ]
9 .br
10
11 .SH DESCRIPTION
12 \fBgnunet\-arm\fP can be used to start or stop GNUnet services, including
13 the ARM service itself.  The ARM service is a supervisor for GNUnet's
14 service processes.  ARM starts services on-demand or as configured and
15 re-starts them if they crash.
16
17 .SH OPTIONS
18 .B
19 .IP "\-c FILENAME,  \-\-config=FILENAME"
20 Use the configuration file FILENAME.
21 .B
22 .IP "\-e, \-\-end"
23 Shutdown all GNUnet services (including ARM itself).  Running
24 "gnunet-arm \-e" is the usual way to shutdown a GNUnet peer.
25 .B
26 .IP "\-h, \-\-help"
27 Print short help on options.
28 .B
29 .IP "\-L LOGLEVEL, \-\-loglevel=LOGLEVEL"
30 Use LOGLEVEL for logging.  Valid values are DEBUG, INFO, WARNING and ERROR.
31 .B
32 .IP "\-i SERVICE,  \-\-init=SERVICE"
33 Starts the specified SERVICE if it is not already running.  More specifically,
34 this makes the service behave as if it were in the default services list.
35 .B
36 .IP "\-k SERVICE,  \-\-kill=SERVICE"
37 Stop the specified SERVICE if it is running.  While this will kill the service
38 right now, the service may be restarted immediately if other services depend
39 on it (service is then started 'on-demand').  If the service used to be a 'default'
40 service, its default-service status will be revoked.  If the
41 service was not a default service, it will just be (temporarily) stopped,
42 but could be re-started on-demand at any time.
43 .B
44 .IP "\-m, \-\-monitor"
45 Monitor service activity of ARM.  In this mode, the command will not terminate
46 until the user presses CTRL-C.
47 .B
48 .IP "\-s, \-\-start"
49 Start all GNUnet default services on this system (and also ARM).  Naturally,
50 if a service is demanded by a default service, it will then also be started.
51 Running "gnunet-arm \-s" is the usual way to start a GNUnet peer.
52 .B
53 .IP "\-I, \-\-info"
54 List all running services.
55 .B
56 .IP "\-v, \-\-version"
57 Print GNUnet version number.
58
59
60 .SH BUGS
61 Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
62 electronic mail to <gnunet\-developers@gnu.org>
63
64 .SH SEE ALSO
65 gnunet\-config(1), gnunet\-setup(1)