dinitctl man: add enable and disable command descriptions.
authorDavin McCall <davmac@davmac.org>
Thu, 18 Oct 2018 17:59:33 +0000 (18:59 +0100)
committerDavin McCall <davmac@davmac.org>
Thu, 18 Oct 2018 20:19:29 +0000 (21:19 +0100)
doc/manpages/dinitctl.8

index 606ac22a47b247de5f07c0c38da8693832e3fcc2..94928237642bff11d233def31616d9c0f0c99ab7 100644 (file)
@@ -5,34 +5,40 @@ dinitctl \- control services supervised by Dinit
 .SH SYNOPSIS
 .\"
 .B dinitctl
-[\-s] [\-\-quiet] start [\-\-no\-wait] [\-\-pin] [\fIservice-name\fR]
+[\fB\-s\fR] [\fB\-\-quiet\fR] \fBstart\fR [\fB\-\-no\-wait\fR] [\fB\-\-pin\fR] \fIservice-name\fR
 .br
 .B dinitctl
-[\-s] [\-\-quiet] stop [\-\-no\-wait] [\-\-pin] [\fIservice-name\fR]
+[\fB\-s\fR] [\fB\-\-quiet\fR] \fBstop\fR [\fB\-\-no\-wait\fR] [\fB\-\-pin\fR] \fIservice-name\fR
 .br
 .B dinitctl
-[\-s] [\-\-quiet] wake [\-\-no\-wait] [\fIservice-name\fR]
+[\fB\-s\fR] [\fB\-\-quiet\fR] \fBwake\fR [\fB\-\-no\-wait\fR] \fIservice-name\fR
 .br
 .B dinitctl
-[\-s] [\-\-quiet] release [\fIservice-name\fR]
+[\fB\-s\fR] [\fB\-\-quiet\fR] \fBrelease\fR \fIservice-name\fR
 .br
 .B dinitctl
-[\-s] [\-\-quiet] unpin [\fIservice-name\fR]
+[\fB\-s\fR] [\fB\-\-quiet\fR] \fBunpin\fR \fIservice-name\fR
 .br
 .B dinitctl
-unload [\fIservice-name\fR]
+[\fB\-s\fR] \fBunload\fR \fIservice-name\fR
 .br
 .B dinitctl
-[\-s] list
+[\fB\-s\fR] \fBlist\fR
 .br
 .B dinitctl
-[\-s] shutdown
+[\fB\-s\fR] \fBshutdown\fR
 .br
 .B dinitctl
-[\-s] add-dep [\fIdependency-type\fR] [\fIfrom-service\fR] [\fIto-service\fR]
+[\fB\-s\fR] \fBadd-dep\fR \fIdependency-type\fR \fIfrom-service\fR \fIto-service\fR
 .br
 .B dinitctl
-[\-s] rm-dep [\fIdependency-type\fR] [\fIfrom-service\fR] [\fIto-service\fR]
+[\fB\-s\fR] \fBrm-dep\fR \fIdependency-type\fR \fIfrom-service\fR \fIto-service\fR
+.br
+.B dinitctl
+[\fB\-s\fR] \fBenable\fR [\fB\-\-from\fR \fIfrom-service\fR] \fIto-service\fR
+.br
+.B dinitctl
+[\fB\-s\fR] \fBdisable\fR [\fB\-\-from\fR \fIfrom-service\fR] \fIto-service\fR
 .\"
 .SH DESCRIPTION
 .\"
@@ -124,6 +130,17 @@ must also be started). Circular dependency chains may not be created.
 Remove a dependency between two services. The \fIdependency-type\fR must be one of \fBregular\fR,
 \fBmilestone\fR or \fBwaits-for\fR. If the "to" service is not otherwise active it may be stopped
 as a result of removing the dependency.  
+.TP
+\fBenable\fR
+Permanently enable a \fBwaits-for\fR dependency between two services. This is much like \fBadd-dep\fR
+but it also starts the dependency if the dependent is started (without explicit activation, so the
+dependency will stop if the dependent stops), and it creates a symbolic link in the directory
+specified via the \fBwaits-for.d\fR directive in the service description (there must be only one such
+directive). The dependency should therefore be persistent. 
+.TP
+\fBdisable\fR
+Permanently disable a \fBwaits-for\fR dependency between two services. This is the complement of the
+\fBenable\fR command; see the description above for more information.
 .\"
 .SH SERVICE OPERATION
 .\"