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 .Dd January 4, 2012
  25 .Dt GNUNET-ARM 1
  26 .Os
  27 .Sh NAME
  28 .Nm gnunet-arm
  29 .Nd
  30 control GNUnet services
  31 .Sh SYNOPSIS
  32 .Nm
  33 .Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
  34 .Op Fl d | \-delete
  35 .Op Fl e | \-end
  36 .Op Fl E | \-no-stderr
  37 .Op Fl h | \-help
  38 .Op Fl i Ar SERVICE | Fl \-init= Ns Ar SERVICE
  39 .Op Fl I | \-info
  40 .Op Fl k Ar SERVICE | Fl \-kill= Ns Ar SERVICE
  41 .Op Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
  42 .Op Fl L Ar LOGLEVEL |  Fl \-loglevel= Ns Ar LOGLEVEL
  43 .Op Fl m | \-monitor
  44 .Op Fl O | \-no-stdout
  45 .Op Fl q | \-quiet
  46 .Op Fl r | \-restart
  47 .Op Fl s | \-start
  48 .Op Fl T DELAY | \-timeout= Ns Ar TIMEOUT
  49 .Op Fl v | \-version
  50 .Sh DESCRIPTION
  51 .Nm
  52 can be used to start or stop GNUnet services, 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 if they crash.
  55 .Bl -tag -width Ds
  56 .It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
  57 Use the configuration file FILENAME.
  58 .It Fl d | \-delete
  59 Delete config file and directory on exit.
  60 .It Fl e | \-end
  61 Shutdown all GNUnet services (including ARM itself).
  62 Running "gnunet-arm \-e" is the usual way to shutdown a GNUnet peer.
  63 .It Fl E | \-no-stderr
  64 Don't let gnunet-arm inherit standard error.
  65 .It Fl h | \-help
  66 Print short help on options.
  67 .It Fl i Ar SERVICE | Fl \-init= Ns Ar SERVICE
  68 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 .It Fl I | \-info
  71 List all running services.
  72 .It Fl k Ar SERVICE | Fl \-kill= Ns Ar SERVICE
  73 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').
  75 If the service used to be a 'default' service, its default-service status will be revoked.
  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.
  77 .It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
  78 Write logs to FILENAME.
  79 .It Fl L Ar LOGLEVEL |  Fl \-loglevel= Ns Ar LOGLEVEL
  80 Use LOGLEVEL for logging.
  81 Valid values are DEBUG, INFO, WARNING and ERROR.
  82 .It Fl m | \-monitor
  83 Monitor service activity of ARM.
  84 In this mode, the command will not terminate until the user presses CTRL-C.
  85 .It Fl O | \-no-stdout
  86 Don't let gnunet-arm inherit standard output
  87 .It Fl q | \-quiet
  88 Don't print status messages.
  89 .It Fl r | \-restart
  90 Stop and start all GNUnet default services.
  91 .It Fl s | \-start
  92 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.
  94 Running "gnunet-arm \-s" is the usual way to start a GNUnet peer.
  95 .It Fl T DELAY | \-timeout= Ns Ar DELAY
  96 Exit with error status if operation does not finish after DELAY
  97 .It Fl v | \-version
  98 Print GNUnet version number.
  99 .El
 100 .Sh EXAMPLES
 101 Start the gnunet-arm for the user:
 102 .Pp
 103 .Dl gnunet-arm -s
 104 .Pp
 105 Stop the gnunet-arm for the user:
 106 .Pp
 107 .Dl $ gnunet-arm -e
 108 .Sh SEE ALSO
 109 .Xr gnunet-config 1 ,
 110 .Xr gnunet-setup 1
 111 .sp
 112 The full documentation for gnunet is maintained as a Texinfo manual.
 113 If the
 114 .Xr info 1
 115 and gnunet programs are properly installed at your site, the command
 116 .Pp
 117 .Dl info gnunet
 118 .Pp
 119 should give you access to the complete handbook,
 120 .Pp
 121 .Dl info gnunet-c-tutorial
 122 .Pp
 123 will give you access to a tutorial for developers.
 124 .sp
 125 Depending on your installation, this information is also available in
 126 .Xr gnunet 7 and
 127 .Xr gnunet-c-tutorial 7 .
 128 .\".Sh HISTORY
 129 .\".Sh AUTHORS
 130 .Sh BUGS
 131 Report bugs by using
 132 .Lk https://bugs.gnunet.org
 133 or by sending electronic mail to
 134 .Aq Mt gnunet-developers@gnu.org .