doc/man/gnunet-arm.1

   1 .\" This file is part of GNUnet.
   2 .\" Copyright (C) 2001-2019 GNUnet e.V.
   3 .\"
   4 .\" Permission is granted to copy, distribute and/or modify this document
   5 .\" under the terms of the GNU Free Documentation License, Version 1.3 or
   6 .\" any later version published by the Free Software Foundation; with no
   7 .\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.  A
   8 .\" copy of the license is included in the file
   9 .\" FDL-1.3.
  10 .\"
  11 .\" A copy of the license is also available from the Free Software
  12 .\" Foundation Web site at http://www.gnu.org/licenses/fdl.html}.
  13 .\"
  14 .\" Alternately, this document is also available under the General
  15 .\" Public License, version 3 or later, as published by the Free Software
  16 .\" Foundation.  A copy of the license is included in the file
  17 .\" GPL3.
  18 .\"
  19 .\" A copy of the license is also available from the Free Software
  20 .\" Foundation Web site at http://www.gnu.org/licenses/gpl.html
  21 .\"
  22 .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
  23 .\"
  24 .Dd January 4, 2012
  25 .Dt GNUNET-ARM 1
  26 .Os
  27 .Sh NAME
  28 .Nm gnunet-arm
  29 .Nd control GNUnet services
  30 .Sh SYNOPSIS
  31 .Nm
  32 .Op Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
  33 .Op Fl d | -delete
  34 .Op Fl e | -end
  35 .Op Fl E | -no-stderr
  36 .Op Fl h | -help
  37 .Op Fl i Ar SERVICE | Fl -init= Ns Ar SERVICE
  38 .Op Fl I | -info
  39 .Op Fl k Ar SERVICE | Fl -kill= Ns Ar SERVICE
  40 .Op Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME
  41 .Op Fl L Ar LOGLEVEL |  Fl -loglevel= Ns Ar LOGLEVEL
  42 .Op Fl m | -monitor
  43 .Op Fl O | -no-stdout
  44 .Op Fl q | -quiet
  45 .Op Fl r | -restart
  46 .Op Fl s | -start
  47 .Op Fl T DELAY | -timeout= Ns Ar TIMEOUT
  48 .Op Fl v | -version
  49 .Sh DESCRIPTION
  50 .Nm
  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.
  54 ARM starts services on-demand or as configured and restarts them
  55 if they crash.
  56 .Bl -tag -width indent
  57 .It Fl c Ar FILENAME | Fl -config= Ns Ar FILENAME
  58 Use the configuration file
  59 .Pa FILENAME Ns .
  60 .It Fl d | -delete
  61 Delete configuration file and directory on exit.
  62 .It Fl e | -end
  63 Shutdown all GNUnet services (including ARM itself).
  64 Running "gnunet-arm -e" is the usual way to shutdown a GNUnet peer.
  65 .It Fl E | -no-stderr
  66 Don't let gnunet-arm inherit stderr (standard error).
  67 .It Fl h | -help
  68 Print short help on options.
  69 .It Fl i Ar SERVICE | Fl -init= Ns Ar SERVICE
  70 Starts the specified
  71 .Ar SERVICE
  72 if it is not already running.
  73 More specifically, this makes the service behave as if it were in
  74 the default services list.
  75 .It Fl I | -info
  76 List all running services.
  77 .It Fl k Ar SERVICE | Fl -kill= Ns Ar SERVICE
  78 Stop
  79 .Ar SERVICE
  80 if it is running.
  81 While this will kill the service right now, the service may be
  82 restarted immediately if other services depend on it (the service is
  83 then started 'on-demand').
  84 If the service used to be a 'default' service, its default-service
  85 status will be revoked.
  86 If the service was not a default service, it will just
  87 be (temporarily) stopped, but could be re-started on-demand at any time.
  88 .It Fl l Ar FILENAME | Fl -logfile= Ns Ar FILENAME
  89 Write logs to
  90 .Pa FILENAME Ns .
  91 .It Fl L Ar LOGLEVEL |  Fl -loglevel= Ns Ar LOGLEVEL
  92 Use
  93 .Ar LOGLEVEL
  94 for logging.
  95 Valid values are DEBUG, INFO, WARNING and ERROR.
  96 .It Fl m | -monitor
  97 Monitor service activity of ARM.
  98 In this mode, the command will not terminate until the user presses CTRL-C (thus sending SIGTERM or SIGINT).
  99 .It Fl O | -no-stdout
 100 Don't let gnunet-arm inherit standard output
 101 .It Fl q | -quiet
 102 Don't print status messages.
 103 .It Fl r | -restart
 104 Stop and start all GNUnet default services.
 105 .It Fl s | -start
 106 Start all GNUnet default services on this system (and also ARM).
 107 Naturally, if a service is demanded by a default service, it will
 108 then also be started.
 109 Running "gnunet-arm -s" is the usual way to start a GNUnet peer.
 110 .It Fl T DELAY | -timeout= Ns Ar DELAY
 111 Exit with error status if operation does not finish after
 112 .Ar DELAY Ns ,
 113 provided in number of microseconds.
 114 .It Fl v | -version
 115 Print GNUnet version number.
 116 .El
 117 .Sh EXAMPLES
 118 Start the gnunet-arm for the user:
 119 .Pp
 120 .Dl gnunet-arm -s
 121 .Pp
 122 Stop the gnunet-arm for the user:
 123 .Pp
 124 .Dl $ gnunet-arm -e
 125 .Sh SEE ALSO
 126 .Xr gnunet-config 1 ,
 127 .Xr gnunet-setup 1
 128 .sp
 129 The full documentation for gnunet is maintained as a Texinfo manual.
 130 If the
 131 .Xr info 1
 132 and gnunet programs are properly installed at your site, the command
 133 .Pp
 134 .Dl info gnunet
 135 .Pp
 136 should give you access to the complete handbook,
 137 .Pp
 138 .Dl info gnunet-c-tutorial
 139 .Pp
 140 will give you access to a tutorial for developers.
 141 .sp
 142 Depending on your installation, this information is also available in
 143 .Xr gnunet 7 and
 144 .Xr gnunet-c-tutorial 7 .
 145 .\".Sh HISTORY
 146 .\".Sh AUTHORS
 147 .Sh BUGS
 148 Report bugs by using
 149 .Lk https://bugs.gnunet.org
 150 or by sending electronic mail to
 151 .Aq Mt gnunet-developers@gnu.org .