diff options
Diffstat (limited to 'doc/man/gnunet-arm.1')
-rw-r--r-- | doc/man/gnunet-arm.1 | 29 |
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 |
30 | control 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 |
52 | can be used to start or stop GNUnet services, including the ARM service itself. | 51 | can be used to start or stop GNUnet services, |
52 | including the ARM service itself. | ||
53 | The ARM service is a supervisor for GNUnet's service processes. | 53 | The ARM service is a supervisor for GNUnet's service processes. |
54 | ARM starts services on-demand or as configured and restarts them if they crash. | 54 | ARM starts services on-demand or as configured and restarts them |
55 | if 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 |
57 | Use the configuration file FILENAME. | 58 | Use the configuration file FILENAME. |
@@ -59,21 +60,26 @@ Use the configuration file FILENAME. | |||
59 | Delete config file and directory on exit. | 60 | Delete config file and directory on exit. |
60 | .It Fl e | \-end | 61 | .It Fl e | \-end |
61 | Shutdown all GNUnet services (including ARM itself). | 62 | Shutdown all GNUnet services (including ARM itself). |
62 | Running "gnunet-arm \-e" is the usual way to shutdown a GNUnet peer. | 63 | Running "gnunet-arm -e" is the usual way to shutdown a GNUnet peer. |
63 | .It Fl E | \-no-stderr | 64 | .It Fl E | \-no-stderr |
64 | Don't let gnunet-arm inherit standard error. | 65 | Don't let gnunet-arm inherit standard error. |
65 | .It Fl h | \-help | 66 | .It Fl h | \-help |
66 | Print short help on options. | 67 | Print 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 |
68 | Starts the specified SERVICE if it is not already running. | 69 | Starts the specified SERVICE if it is not already running. |
69 | More specifically, this makes the service behave as if it were in the default services list. | 70 | More specifically, this makes the service behave as if it were in |
71 | the default services list. | ||
70 | .It Fl I | \-info | 72 | .It Fl I | \-info |
71 | List all running services. | 73 | List 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 |
73 | Stop the specified SERVICE if it is running. | 75 | Stop the specified SERVICE if it is running. |
74 | 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'). | 76 | While this will kill the service right now, the service may be |
75 | If the service used to be a 'default' service, its default-service status will be revoked. | 77 | restarted immediately if other services depend on it (service is |
76 | If the service was not a default service, it will just be (temporarily) stopped, but could be re-started on-demand at any time. | 78 | then started 'on-demand'). |
79 | If the service used to be a 'default' service, its default-service | ||
80 | status will be revoked. | ||
81 | If the service was not a default service, it will just | ||
82 | be (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 |
78 | Write logs to FILENAME. | 84 | Write 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. | |||
90 | Stop and start all GNUnet default services. | 96 | Stop and start all GNUnet default services. |
91 | .It Fl s | \-start | 97 | .It Fl s | \-start |
92 | Start all GNUnet default services on this system (and also ARM). | 98 | Start all GNUnet default services on this system (and also ARM). |
93 | Naturally, if a service is demanded by a default service, it will then also be started. | 99 | Naturally, if a service is demanded by a default service, it will |
94 | Running "gnunet-arm \-s" is the usual way to start a GNUnet peer. | 100 | then also be started. |
101 | Running "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 |
96 | Exit with error status if operation does not finish after DELAY | 103 | Exit with error status if operation does not finish after DELAY |
97 | .It Fl v | \-version | 104 | .It Fl v | \-version |