diff options
author | ng0 <ng0@n0.is> | 2019-10-16 17:55:45 +0000 |
---|---|---|
committer | ng0 <ng0@n0.is> | 2019-10-16 17:55:45 +0000 |
commit | 3553ca94cece25a12e2c0202ec7512d5e7aa7e2b (patch) | |
tree | 31de07c8aac1db250e73af8bd0b41150b6297662 /doc/man | |
parent | 06d7bccf5a43b921b13e4136e5c4fe73284e6afa (diff) | |
download | gnunet-3553ca94cece25a12e2c0202ec7512d5e7aa7e2b.tar.gz gnunet-3553ca94cece25a12e2c0202ec7512d5e7aa7e2b.zip |
clarify gnunet-arm(1) more and add syntax.
Diffstat (limited to 'doc/man')
-rw-r--r-- | doc/man/gnunet-arm.1 | 30 |
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 | |||
55 | if they crash. | 55 | if 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 |
58 | Use the configuration file FILENAME. | 58 | Use the configuration file |
59 | .Pa FILENAME Ns . | ||
59 | .It Fl d | -delete | 60 | .It Fl d | -delete |
60 | Delete config file and directory on exit. | 61 | Delete configuration file and directory on exit. |
61 | .It Fl e | -end | 62 | .It Fl e | -end |
62 | Shutdown all GNUnet services (including ARM itself). | 63 | Shutdown all GNUnet services (including ARM itself). |
63 | Running "gnunet-arm -e" is the usual way to shutdown a GNUnet peer. | 64 | Running "gnunet-arm -e" is the usual way to shutdown a GNUnet peer. |
64 | .It Fl E | -no-stderr | 65 | .It Fl E | -no-stderr |
65 | Don't let gnunet-arm inherit standard error. | 66 | Don't let gnunet-arm inherit stderr (standard error). |
66 | .It Fl h | -help | 67 | .It Fl h | -help |
67 | Print short help on options. | 68 | Print 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 |
69 | Starts the specified SERVICE if it is not already running. | 70 | Starts the specified |
71 | .Ar SERVICE | ||
72 | if it is not already running. | ||
70 | More specifically, this makes the service behave as if it were in | 73 | More specifically, this makes the service behave as if it were in |
71 | the default services list. | 74 | the default services list. |
72 | .It Fl I | -info | 75 | .It Fl I | -info |
73 | List all running services. | 76 | List 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 |
75 | Stop the specified SERVICE if it is running. | 78 | Stop |
79 | .Ar SERVICE | ||
80 | if it is running. | ||
76 | While this will kill the service right now, the service may be | 81 | While this will kill the service right now, the service may be |
77 | restarted immediately if other services depend on it (service is | 82 | restarted immediately if other services depend on it (the service is |
78 | then started 'on-demand'). | 83 | then started 'on-demand'). |
79 | If the service used to be a 'default' service, its default-service | 84 | If the service used to be a 'default' service, its default-service |
80 | status will be revoked. | 85 | status will be revoked. |
81 | If the service was not a default service, it will just | 86 | 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. | 87 | be (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 |
84 | Write logs to FILENAME. | 89 | Write 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 |
86 | Use LOGLEVEL for logging. | 92 | Use |
93 | .Ar LOGLEVEL | ||
94 | for logging. | ||
87 | Valid values are DEBUG, INFO, WARNING and ERROR. | 95 | Valid values are DEBUG, INFO, WARNING and ERROR. |
88 | .It Fl m | -monitor | 96 | .It Fl m | -monitor |
89 | Monitor service activity of ARM. | 97 | Monitor service activity of ARM. |
90 | In this mode, the command will not terminate until the user presses CTRL-C. | 98 | In 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 |
92 | Don't let gnunet-arm inherit standard output | 100 | Don'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 | |||
100 | then also be started. | 108 | then also be started. |
101 | Running "gnunet-arm -s" is the usual way to start a GNUnet peer. | 109 | Running "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 |
103 | Exit with error status if operation does not finish after DELAY | 111 | Exit with error status if operation does not finish after |
112 | .Ar DELAY Ns , | ||
113 | provided in number of microseconds. | ||
104 | .It Fl v | -version | 114 | .It Fl v | -version |
105 | Print GNUnet version number. | 115 | Print GNUnet version number. |
106 | .El | 116 | .El |