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.129
1 files changed, 18 insertions, 11 deletions
diff --git a/doc/man/gnunet-arm.1 b/doc/man/gnunet-arm.1
index c25b10bb5..599478a07 100644
--- a/doc/man/gnunet-arm.1
+++ b/doc/man/gnunet-arm.1
@@ -26,8 +26,7 @@
26.Os 26.Os
27.Sh NAME 27.Sh NAME
28.Nm gnunet-arm 28.Nm gnunet-arm
29.Nd 29.Nd control GNUnet services
30control GNUnet services
31.Sh SYNOPSIS 30.Sh SYNOPSIS
32.Nm 31.Nm
33.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 32.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
@@ -49,9 +48,11 @@ control GNUnet services
49.Op Fl v | \-version 48.Op Fl v | \-version
50.Sh DESCRIPTION 49.Sh DESCRIPTION
51.Nm 50.Nm
52can be used to start or stop GNUnet services, including the ARM service itself. 51can be used to start or stop GNUnet services,
52including the ARM service itself.
53The ARM service is a supervisor for GNUnet's service processes. 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. 54ARM starts services on-demand or as configured and restarts them
55if they crash.
55.Bl -tag -width Ds 56.Bl -tag -width Ds
56.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME 57.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
57Use the configuration file FILENAME. 58Use the configuration file FILENAME.
@@ -59,21 +60,26 @@ Use the configuration file FILENAME.
59Delete config file and directory on exit. 60Delete config file and directory on exit.
60.It Fl e | \-end 61.It Fl e | \-end
61Shutdown all GNUnet services (including ARM itself). 62Shutdown all GNUnet services (including ARM itself).
62Running "gnunet-arm \-e" is the usual way to shutdown a GNUnet peer. 63Running "gnunet-arm -e" is the usual way to shutdown a GNUnet peer.
63.It Fl E | \-no-stderr 64.It Fl E | \-no-stderr
64Don't let gnunet-arm inherit standard error. 65Don't let gnunet-arm inherit standard error.
65.It Fl h | \-help 66.It Fl h | \-help
66Print short help on options. 67Print short help on options.
67.It Fl i Ar SERVICE | Fl \-init= Ns Ar SERVICE 68.It Fl i Ar SERVICE | Fl \-init= Ns Ar SERVICE
68Starts the specified SERVICE if it is not already running. 69Starts the specified SERVICE if it is not already running.
69More specifically, this makes the service behave as if it were in the default services list. 70More specifically, this makes the service behave as if it were in
71the default services list.
70.It Fl I | \-info 72.It Fl I | \-info
71List all running services. 73List all running services.
72.It Fl k Ar SERVICE | Fl \-kill= Ns Ar SERVICE 74.It Fl k Ar SERVICE | Fl \-kill= Ns Ar SERVICE
73Stop the specified SERVICE if it is running. 75Stop 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'). 76While this will kill the service right now, the service may be
75If the service used to be a 'default' service, its default-service status will be revoked. 77restarted immediately if other services depend on it (service is
76If the service was not a default service, it will just be (temporarily) stopped, but could be re-started on-demand at any time. 78then started 'on-demand').
79If the service used to be a 'default' service, its default-service
80status will be revoked.
81If the service was not a default service, it will just
82be (temporarily) stopped, but could be re-started on-demand at any time.
77.It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME 83.It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
78Write logs to FILENAME. 84Write logs to FILENAME.
79.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL 85.It Fl L Ar LOGLEVEL | Fl \-loglevel= Ns Ar LOGLEVEL
@@ -90,8 +96,9 @@ Don't print status messages.
90Stop and start all GNUnet default services. 96Stop and start all GNUnet default services.
91.It Fl s | \-start 97.It Fl s | \-start
92Start all GNUnet default services on this system (and also ARM). 98Start 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. 99Naturally, if a service is demanded by a default service, it will
94Running "gnunet-arm \-s" is the usual way to start a GNUnet peer. 100then also be started.
101Running "gnunet-arm -s" is the usual way to start a GNUnet peer.
95.It Fl T DELAY | \-timeout= Ns Ar DELAY 102.It Fl T DELAY | \-timeout= Ns Ar DELAY
96Exit with error status if operation does not finish after DELAY 103Exit with error status if operation does not finish after DELAY
97.It Fl v | \-version 104.It Fl v | \-version