Browse Source

More tweaks to manpages - make lazy service loading behaviour more clear

Davin McCall 10 months ago
parent
commit
a058e8e920
2 changed files with 15 additions and 5 deletions
  1. 4 3
      doc/manpages/dinit-service.5.m4
  2. 11 2
      doc/manpages/dinit.8.m4

+ 4 - 3
doc/manpages/dinit-service.5.m4

@@ -18,8 +18,9 @@ Service description files specify the various attributes of a service. A
 service description file is named after the service it represents, and is
 a plain-text file with simple key-value format.
 The description files are located in a service description directory; by default,
-the system process searches \fI/etc/dinit.d\fR, \fI/usr/local/lib/dinit.d\fR and
+the system \fBdinit\fR process searches \fI/etc/dinit.d\fR, \fI/usr/local/lib/dinit.d\fR and
 \fI/lib/dinit.d\fR, while a user process searches \fI$HOME/.config/dinit.d\fR.
+See \fBdinit\fR(8) for more details of how and when service descriptions are loaded.
 .LP
 All services have a \fItype\fR and a set of \fIdependencies\fR. These are discussed
 in the following subsections. The type, dependencies, and other attributes are
@@ -168,7 +169,7 @@ the platform, or the user could not be found in passwd database.
 .TP
 \fBenv\-file\fR = \fIfile\fR
 Specifies a file containing value assignments for environment variables, in the same
-format recognised by the \fBdinit\fR command's \fB\-\-env\-file\fR option (see \fBdinit\fR(5)).
+format recognised by the \fBdinit\fR command's \fB\-\-env\-file\fR option (see \fBdinit\fR(8)).
 The file is read when the service is loaded, therefore values from it can be used in variable
 substitutions (see \fBVARIABLE SUBSTITUTION\fR).
 Variable substitution is not performed on the \fBenv\-file\fR property value itself.
@@ -485,7 +486,7 @@ This service mounts the root filesystem read/write (or at least mounts the
 normal writable filesystems for the system).
 This prompts Dinit to attempt to create its control socket, if it has not already managed to do so,
 and similarly log boot time to the system \fBwtmp\fR(5) database (if supported) if not yet done.
-This option may be specified on multiple services, which may be useful if the wtmp database becomes
+This option may be specified on multiple services, which may be useful if the \fBwtmp\fR database becomes
 writable at a different stage than the control socket location becomes writable, for example.
 If the control socket has already been created, this option currently causes Dinit to check that
 the socket "file" still exists and re-create it if not. It is not recommended to rely on this

+ 11 - 2
doc/manpages/dinit.8.m4

@@ -129,8 +129,11 @@ They are named for the service they describe, and are found in \fI/etc/dinit.d\f
 for a system instance or \fI$HOME/.config/dinit.d\fR for a user instance.
 .LP
 Service description files are read by Dinit on an "as needed" basis.
-Once a service description has been read the configuration can be altered or reloaded via the
-\fBdinitctl\fR(8) program (with some limitations).
+Once loaded, a service description is never automatically unloaded (even if the service
+stops or fails).
+A service description can however be unloaded (if the service is stopped) or reloaded
+(with some limitations) via \fBdinitctl\fR(8) using the \fBunload\fR and \fBreload\fR subcommands
+respectively.
 .LP
 See \fBdinit-service\fR(5) for details of the format and available parameters.
 .\"
@@ -234,6 +237,12 @@ value from the original environment.
 Imports the value of the named variables from the original environment, overriding the effect of any
 value set previously as well as the effect of previous \fB!unset\fR and \fB!clear\fR commands.
 .RE
+.TP
+\fI/etc/dinit.d\fR, \fI/usr/local/lib/dinit.d\fR, \fI/lib/dinit.d\fR
+Default locations for service description files. The directories are searched in the order listed.
+.TP
+\fI$HOME/.config/dinit.d\fR
+Default location for service description files for user instances. 
 .\"
 .SH SIGNALS
 .LP