Browse Source

doc: update man page for dinitcheck

Document new options related to "online" operation.
Davin McCall 3 months ago
parent
commit
c2ae495767
1 changed files with 28 additions and 5 deletions
  1. 28 5
      doc/manpages/dinitcheck.8.m4

+ 28 - 5
doc/manpages/dinitcheck.8.m4

@@ -38,10 +38,31 @@ same search paths (for service description files) as \fBdinit\fR.
 Specifies \fIdir\fP as the directory containing service description files (can
 be given multiple times to specify multiple service directories).
 Default directories are not searched for services when this option is provided.
-.sp
-If not specified, the default for the user instance is \fI$XDG_CONFIG_HOME/dinit.d\fR
-and \fI$HOME/.config/dinit.d\fR or, for the system instance, each of \fI/etc/dinit.d\fR,
-\fI/run/dinit.d/\fR, \fI/usr/local/lib/dinit.d\fR, and \fI/lib/dinit.d\fR (searched in that order).
+See \fBdinit\fR(8) for defaults.
+.TP
+\fB\-n\fR, \fB\-\-online\fR
+Operate in "online" mode; contact a running instance of \fBdinit\fR to obtain the service directories
+and environment variables (used for substitution in service setting values).
+The  \fB\-\-services\-dir\fR (\fB\-d\fR) and \fB\-\-env\-file\fR (\fB\-e\fR) options will be ignored.
+.TP
+\fB\-s\fR, \fB\-\-system\fR
+Use defaults for a system instance. This affects default service directories, environment file, and
+(when in online mode) control socket path. It is the default when run as the root user.
+.TP
+\fB\-u\fR, \fB\-\-user\fR
+Use defaults for a user instance. This affects default service directories, environment file, and
+(when in online mode) control socket path. It is the default when not run as the root user.
+.TP
+\fB\-\-socket\-path\fR \fIsocket-path\fR, \fB\-p\fR \fIsocket-path\fR
+Specify the path to the socket used for communicating with the service manager daemon.
+When not specified, the value from the \fBDINIT_SOCKET_PATH\fR environment variable is used, with
+the default path (as documented for \fBdinit\fR(8)) used if the variable is unset.
+This option is ignored unless \fB\-\-online\fR (\fB\-n\fR) is also specified.
+.TP
+\fB\-e\fR \fIfile\fP, \fB\-\-env\-file\fR \fIfile\fP
+Read supplementary environment from \fIfile\fR, which should be in the format used by \fBdinit\fR(8).
+If not specified, the default is as for \fBdinit\fR(8).
+This setting is not used when \fB\-\-online\fR (\fB\-n\fR) is specified.
 .TP
 \fB\-\-help\fR
 Display brief help text and then exit.
@@ -58,7 +79,9 @@ For service properties that are subject to environment variable substitution, in
 \fBsocket\-listen\fR, \fBlogfile\fR, \fBenv\-file\fR, \fBworking\-dir\fR and \fBpid\-file\fR, the
 substitution may have a different result when performed by \fBdinitcheck\fR than when performed by
 \fBdinit\fR if the two processes have a different environment.
-For this reason \fBdinitcheck\fR will issue a warning whenever substitution is used.
+For this reason \fBdinitcheck\fR will issue a warning whenever substitution is used, unless run in
+"online" mode (\fB\-\-online\fR or \fB\-n\fR), in which case environment variable values are obtained
+from the running instance of \fBdinit\fR.
 .\"
 .SH SEE ALSO
 .\"