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.130
1 files changed, 20 insertions, 10 deletions
diff --git a/doc/man/gnunet-arm.1 b/doc/man/gnunet-arm.1
index 7e15b171d..80d65ef94 100644
--- a/doc/man/gnunet-arm.1
+++ b/doc/man/gnunet-arm.1
@@ -55,39 +55,47 @@ ARM starts services on-demand or as configured and restarts them
55if they crash. 55if they crash.
56.Bl -tag -width indent 56.Bl -tag -width indent
57.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME 57.It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
58Use the configuration file FILENAME. 58Use the configuration file
59.Pa FILENAME Ns .
59.It Fl d | -delete 60.It Fl d | -delete
60Delete config file and directory on exit. 61Delete configuration file and directory on exit.
61.It Fl e | -end 62.It Fl e | -end
62Shutdown all GNUnet services (including ARM itself). 63Shutdown all GNUnet services (including ARM itself).
63Running "gnunet-arm -e" is the usual way to shutdown a GNUnet peer. 64Running "gnunet-arm -e" is the usual way to shutdown a GNUnet peer.
64.It Fl E | -no-stderr 65.It Fl E | -no-stderr
65Don't let gnunet-arm inherit standard error. 66Don't let gnunet-arm inherit stderr (standard error).
66.It Fl h | -help 67.It Fl h | -help
67Print short help on options. 68Print short help on options.
68.It Fl i Ar SERVICE | Fl -init= Ns Ar SERVICE 69.It Fl i Ar SERVICE | Fl -init= Ns Ar SERVICE
69Starts the specified SERVICE if it is not already running. 70Starts the specified
71.Ar SERVICE
72if it is not already running.
70More specifically, this makes the service behave as if it were in 73More specifically, this makes the service behave as if it were in
71the default services list. 74the default services list.
72.It Fl I | -info 75.It Fl I | -info
73List all running services. 76List all running services.
74.It Fl k Ar SERVICE | Fl -kill= Ns Ar SERVICE 77.It Fl k Ar SERVICE | Fl -kill= Ns Ar SERVICE
75Stop the specified SERVICE if it is running. 78Stop
79.Ar SERVICE
80if it is running.
76While this will kill the service right now, the service may be 81While this will kill the service right now, the service may be
77restarted immediately if other services depend on it (service is 82restarted immediately if other services depend on it (the service is
78then started 'on-demand'). 83then started 'on-demand').
79If the service used to be a 'default' service, its default-service 84If the service used to be a 'default' service, its default-service
80status will be revoked. 85status will be revoked.
81If the service was not a default service, it will just 86If the service was not a default service, it will just
82be (temporarily) stopped, but could be re-started on-demand at any time. 87be (temporarily) stopped, but could be re-started on-demand at any time.
83.It Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME 88.It Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME
84Write logs to FILENAME. 89Write logs to
90.Pa FILENAME Ns .
85.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL 91.It Fl L Ar LOGLEVEL | Fl -loglevel= Ns Ar LOGLEVEL
86Use LOGLEVEL for logging. 92Use
93.Ar LOGLEVEL
94for logging.
87Valid values are DEBUG, INFO, WARNING and ERROR. 95Valid values are DEBUG, INFO, WARNING and ERROR.
88.It Fl m | -monitor 96.It Fl m | -monitor
89Monitor service activity of ARM. 97Monitor service activity of ARM.
90In this mode, the command will not terminate until the user presses CTRL-C. 98In this mode, the command will not terminate until the user presses CTRL-C (thus sending SIGTERM or SIGINT).
91.It Fl O | -no-stdout 99.It Fl O | -no-stdout
92Don't let gnunet-arm inherit standard output 100Don't let gnunet-arm inherit standard output
93.It Fl q | -quiet 101.It Fl q | -quiet
@@ -100,7 +108,9 @@ Naturally, if a service is demanded by a default service, it will
100then also be started. 108then also be started.
101Running "gnunet-arm -s" is the usual way to start a GNUnet peer. 109Running "gnunet-arm -s" is the usual way to start a GNUnet peer.
102.It Fl T DELAY | -timeout= Ns Ar DELAY 110.It Fl T DELAY | -timeout= Ns Ar DELAY
103Exit with error status if operation does not finish after DELAY 111Exit with error status if operation does not finish after
112.Ar DELAY Ns ,
113provided in number of microseconds.
104.It Fl v | -version 114.It Fl v | -version
105Print GNUnet version number. 115Print GNUnet version number.
106.El 116.El