doc/manpages/dinitctl.8.m4

   1 changequote(`@@@',`$$$')dnl
   2 @@@.TH DINITCTL "8" "$$$MONTH YEAR@@@" "Dinit $$$VERSION@@@" "Dinit \- service management system"
   3 .SH NAME
   4 dinitctl \- control services supervised by Dinit
   5 .\"
   6 .SH SYNOPSIS
   7 .\"
   8 .B dinitctl
   9 [\fIoptions\fR] \fBstart\fR [\fB\-\-no\-wait\fR] [\fB\-\-pin\fR] \fIservice-name\fR
  10 .br
  11 .B dinitctl
  12 [\fIoptions\fR] \fBstop\fR [\fB\-\-no\-wait\fR] [\fB\-\-pin\fR] \fIservice-name\fR
  13 .br
  14 .B dinitctl
  15 [\fIoptions\fR] \fBrestart\fR [\fB\-\-no\-wait\fR] \fIservice-name\fR
  16 .br
  17 .B dinitctl
  18 [\fIoptions\fR] \fBwake\fR [\fB\-\-no\-wait\fR] \fIservice-name\fR
  19 .br
  20 .B dinitctl
  21 [\fIoptions\fR] \fBrelease\fR \fIservice-name\fR
  22 .br
  23 .B dinitctl
  24 [\fIoptions\fR] \fBunpin\fR \fIservice-name\fR
  25 .br
  26 .B dinitctl
  27 [\fIoptions\fR] \fBunload\fR \fIservice-name\fR
  28 .br
  29 .B dinitctl
  30 [\fIoptions\fR] \fBlist\fR
  31 .br
  32 .B dinitctl
  33 [\fIoptions\fR] \fBshutdown\fR
  34 .br
  35 .B dinitctl
  36 [\fIoptions\fR] \fBadd-dep\fR \fIdependency-type\fR \fIfrom-service\fR \fIto-service\fR
  37 .br
  38 .B dinitctl
  39 [\fIoptions\fR] \fBrm-dep\fR \fIdependency-type\fR \fIfrom-service\fR \fIto-service\fR
  40 .br
  41 .B dinitctl
  42 [\fIoptions\fR] \fBenable\fR [\fB\-\-from\fR \fIfrom-service\fR] \fIto-service\fR
  43 .br
  44 .B dinitctl
  45 [\fIoptions\fR] \fBdisable\fR [\fB\-\-from\fR \fIfrom-service\fR] \fIto-service\fR
  46 .\"
  47 .SH DESCRIPTION
  48 .\"
  49 \fBdinitctl\fR is a utility to control services being managed by the
  50 \fBdinit\fR daemon. It allows starting and stopping services, and listing
  51 service status, amongst other actions. It functions by issuing commands to the daemon
  52 via a control socket.
  53 .\"
  54 .SH GENERAL OPTIONS
  55 .TP
  56 \fB\-\-help\fR
  57 display this help and exit
  58 .TP
  59 \fB\-s\fR, \fB\-\-system\fR
  60 Control the system init process (this is the default unless run as a non-root user). This option
  61 determines the default path to the control socket used to communicate with the \fBdinit\fR daemon
  62 process (it does not override the \fB\-s\fR option).
  63 .TP
  64 \fB\-u\fR, \fB\-\-user\fR
  65 Control the user init process (this is the default when not run as root). This option determines
  66 the default path to the control socket used to communicate with the \fBdinit\fR daemon process
  67 (it does not override the \fB\-s\fR option).
  68 .TP
  69 \fB\-\-socket\-path\fR \fIsocket-path\fR, \fB\-p\fR \fIsocket-path\fR
  70 Specify the path to the socket used for communicating with the service manager daemon.
  71 .TP
  72 \fB\-\-quiet\fR
  73 Suppress status output, except for errors.
  74 .\"
  75 .SH COMMAND OPTIONS
  76 .TP
  77 \fB\-\-no\-wait\fR
  78 Do not wait for issued command to complete; exit immediately.
  79 .TP
  80 \fB\-\-pin\fR
  81 Pin the service in the requested state. The service will not leave the state until it is unpinned, although
  82 start/stop commands will be "remembered" while the service is pinned.
  83 .TP
  84 \fB\-\-force\fR
  85 Stop the service even if it will require stopping other services which depend on the specified service.
  86 .TP
  87 \fIservice-name\fR
  88 Specifies the name of the service to which the command applies.
  89 .TP
  90 \fBstart\fR
  91 Start the specified service. The service is marked as explicitly activated and will not be stopped
  92 automatically if its dependents stop. If the service is currently stopping it will generally continue
  93 to stop before it is then restarted.
  94 .TP
  95 \fBstop\fR
  96 Stop the specified service, and remove explicit activation. If the service has (non-soft) dependents, an
  97 error will be displayed unless the \fB\-\-force\fR option is used.
  98
  99 A service with any dependents via soft dependencies will have these dependency links broken when it stops.
 100
 101 The \fBrestart\fR option applied to the stopped service will not by itself cause the service to restart
 102 when it is stopped via this command. However, a dependent which is configured to restart may
 103 cause the service itself to restart as a result.
 104
 105 Any pending \fBstart\fR orders are cancelled,
 106 though a service which is starting will continue its startup before then stopping (unless the service is
 107 configured to have an interruptible startup or is otherwise at a stage of startup which can be safely
 108 interrupted).
 109 .TP
 110 \fBrestart\fR
 111 Restart the specified service. The service will be stopped and then restarted, without affecting explicit
 112 activation status or dependency links from dependents.
 113 .TP
 114 \fBwake\fR
 115 Start the specified service after reattaching dependency links from all active dependents of the specified
 116 service. The service will not be marked explicitly activated, and so will stop if the dependents stop.
 117 .TP
 118 \fBrelease\fR
 119 Clear the explicit activation mark from a service (the service will then stop if it has no active dependents).
 120 .TP
 121 \fBunpin\fR
 122 Remove start- and stop- pins from a service. If a started service is not explicitly activated and
 123 has no active dependents, it will stop. If a started service has a dependency service which is stopping,
 124 it will stop. If a stopped service has a dependent service which is starting, it will start. Otherwise,
 125 any pending start/stop commands will be carried out.
 126 .TP
 127 \fBunload\fR
 128 Completely unload a service. This can only be done if the service is stopped and has no loaded dependents
 129 (i.e. dependents must be unloaded before their dependencies).
 130 .TP
 131 \fBlist\fR
 132 List loaded services and their state. Before each service, one of the following state indicators is
 133 displayed:
 134
 135 .RS
 136 .nf
 137 \f[C]\m[blue][{+}\ \ \ \ \ ]\m[]\fR \[em] service has started.
 138 \f[C]\m[blue][{\ }<<\ \ \ ]\m[]\fR \[em] service is starting.
 139 \f[C]\m[blue][\ \ \ <<{\ }]\m[]\fR \[em] service is starting, will stop once started.
 140 \f[C]\m[blue][{\ }>>\ \ \ ]\m[]\fR \[em] service is stopping, will start once stopped.
 141 \f[C]\m[blue][\ \ \ >>{\ }]\m[]\fR \[em] service is stopping.
 142 \f[C]\m[blue][\ \ \ \ \ {-}]\m[]\fR \[em] service has stopped.
 143 .fi
 144
 145 The << and >> symbols represent a transition state (starting and stopping respectively); curly braces
 146 indicate the desired state (left: started, right: stopped). An 's' in place of '+' means that service
 147 startup was skipped (possible only if the service is configured as skippable). An 'X' in place of '-'
 148 means that the service failed to start, or that the service process unexpectedly terminated with an
 149 error status or signal while running.
 150
 151 Additional information, if available, will be printed after the service name: whether the service owns,
 152 or is waiting to acquire, the console; the process ID; the exit status or signal that caused termination.
 153 .RE
 154 .TP
 155 \fBshutdown\fR
 156 Stop all services (without restart) and terminate Dinit. If issued to the system instance of Dinit,
 157 this will also shut down the system.
 158 .TP
 159 \fBadd-dep\fR
 160 Add a dependency between two services. The \fIdependency-type\fR must be one of \fBregular\fR,
 161 \fBmilestone\fR or \fBwaits-for\fR. Note that adding a regular dependency requires that the service
 162 states are consistent with the dependency (i.e. if the "from" service is started, the "to" service
 163 must also be started). Circular dependency chains may not be created.
 164 .TP
 165 \fBrm-dep\fR
 166 Remove a dependency between two services. The \fIdependency-type\fR must be one of \fBregular\fR,
 167 \fBmilestone\fR or \fBwaits-for\fR. If the "to" service is not otherwise active it may be stopped
 168 as a result of removing the dependency.
 169 .TP
 170 \fBenable\fR
 171 Permanently enable a \fBwaits-for\fR dependency between two services. This is much like \fBadd-dep\fR
 172 but it also starts the dependency if the dependent is started (without explicit activation, so the
 173 dependency will stop if the dependent stops), and it creates a symbolic link in the directory
 174 specified via the \fBwaits-for.d\fR directive in the service description (there must be only one such
 175 directive). The dependency should therefore be persistent.
 176
 177 If the \fB--from\fR option is not used to specify the dependent, the dependency is created from the
 178 \fBboot\fR service by default.
 179 .TP
 180 \fBdisable\fR
 181 Permanently disable a \fBwaits-for\fR dependency between two services. This is the complement of the
 182 \fBenable\fR command; see the description above for more information.
 183 .\"
 184 .SH SERVICE OPERATION
 185 .\"
 186 Normally, services are only started if they have been explicitly activated (\fBstart\fR command) or if
 187 a started service depends on them. Therefore, starting a service also starts all services that the first
 188 depends on; stopping the same service then also stops the dependency services, unless they are also
 189 required by another explicitly activated service.
 190 .LP
 191 A service can be pinned in either the started or stopped state. This is mainly intended to be used to
 192 prevent automated stop or start of a service, including via a dependency or dependent service, during
 193 a manual administrative procedure.
 194 .LP
 195 Stopping a service does not in general prevent it from restarting. A service configured to restart
 196 automatically, or with a dependent service configured to do so, will restart immediately after stopping
 197 unless pinned.
 198 .\"
 199 .SH SEE ALSO
 200 \fBdinit\fR(8).
 201 .\"
 202 .SH AUTHOR
 203 Dinit, and this manual, were written by Davin McCall.
 204 $$$dnl