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 @url{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 @url{http://www.gnu.org/licenses/gpl.html}.
  21 .\"
  22 .\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
  23 .\"
  24 .TH GNUNET\-ARM 1 "January 4, 2012" "GNUnet"
  25 .SH NAME
  26 gnunet\-arm \- control GNUnet services
  27 .SH SYNOPSIS
  28 .B gnunet\-arm
  29 .RI [-c\ FILENAME\ |\ --config=FILENAME]
  30 .RI [-e\ |\ --end]
  31 .RI [-h\ |\ --help]
  32 .RI [-L\ LOGLEVEL\ |\ --loglevel=LOGLEVEL]
  33 .RI [-i\ SERVICE\ |\ --init=SERVICE]
  34 .RI [-k\ SERVICE\ |\ --kill=SERVICE]
  35 .RI [-m\ |\ --monitor]
  36 .RI [-s\ |\ --start]
  37 .RI [-v\ |\ --version]
  38 .SH DESCRIPTION
  39 \fBgnunet\-arm\fP can be used to start or stop GNUnet services, including the ARM service itself.
  40 The ARM service is a supervisor for GNUnet's service processes.
  41 ARM starts services on-demand or as configured and re-starts them if they crash.
  42 .SH OPTIONS
  43 .IP "\-c FILENAME\ | \-\-config=FILENAME"
  44 Use the configuration file FILENAME.
  45 .IP "\-e\ | \-\-end"
  46 Shutdown all GNUnet services (including ARM itself).
  47 Running "gnunet-arm \-e" is the usual way to shutdown a GNUnet peer.
  48 .IP "\-h\ | \-\-help"
  49 Print short help on options.
  50 .IP "\-L LOGLEVEL\ | \-\-loglevel=LOGLEVEL"
  51 Use LOGLEVEL for logging.
  52 Valid values are DEBUG, INFO, WARNING and ERROR.
  53 .IP "\-i SERVICE\ | \-\-init=SERVICE"
  54 Starts the specified SERVICE if it is not already running.
  55 More specifically, this makes the service behave as if it were in the default services list.
  56 .IP "\-k SERVICE\ | \-\-kill=SERVICE"
  57 Stop the specified SERVICE if it is running.
  58 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').
  59 If the service used to be a 'default' service, its default-service status will be revoked.
  60 If the service was not a default service, it will just be (temporarily) stopped, but could be re-started on-demand at any time.
  61 .IP "\-m\ | \-\-monitor"
  62 Monitor service activity of ARM.
  63 In this mode, the command will not terminate until the user presses CTRL-C.
  64 .IP "\-s\ | \-\-start"
  65 Start all GNUnet default services on this system (and also ARM).
  66 Naturally, if a service is demanded by a default service, it will then also be started.
  67 Running "gnunet-arm \-s" is the usual way to start a GNUnet peer.
  68 .IP "\-I\ | \-\-info"
  69 List all running services.
  70 .IP "\-v\ | \-\-version"
  71 Print GNUnet version number.
  72 .SH SEE ALSO
  73 gnunet\-config(1), gnunet\-setup(1)
  74 .PP
  75 The full documentation for
  76 .B gnunet
  77 is maintained as a Texinfo manual.
  78 If the
  79 .B info
  80 and
  81 .B gnunet
  82 programs are properly installed at your site, the command
  83 .IP
  84 .B info gnunet
  85 .PP
  86 should give you access to the complete handbook,
  87 .IP
  88 .B info gnunet-c-tutorial
  89 .PP
  90 will give you access to a tutorial for developers.
  91 .PP
  92 Depending on your installation, this information is also available in
  93 \fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).
  94 .SH BUGS
  95 Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending electronic mail to <gnunet\-developers@gnu.org>.