From edbab43eff926edc1dd520c7f051facf6e2e0d5c Mon Sep 17 00:00:00 2001
From: Colin Booth
Date: Thu, 22 Jan 2026 22:18:50 +0000
Subject: s6_set.html: small language cleanup, list format consistency
---
doc/s6_set.html | 74 +++++++++++++++++++++++++++------------------------------
1 file changed, 35 insertions(+), 39 deletions(-)
diff --git a/doc/s6_set.html b/doc/s6_set.html
index 3421c22..3666c65 100644
--- a/doc/s6_set.html
+++ b/doc/s6_set.html
@@ -20,10 +20,10 @@
The s6 set command
- s6 set regroups actions on
+ s6 set groups actions on
service sets,
telling the service manager what services should be enabled or disabled
-at boot time, or even should be masked, i.e. should not even appear in
+at boot time, and which should be masked, i.e. should not even appear in
the list of services available at next boot.
@@ -31,7 +31,7 @@ the list of services available at next boot.
Unlike s6 live, which deals with starting and stopping services
that are currently running, s6 set is an offline tool,
setting services in a state that remains theoretical until the user
-commits to it and installs the set, making it live.
+commits it and installs the set, making it live.
@@ -100,7 +100,7 @@ as name.
- - s6 set delete delete the saved sets named names...
+ - s6 set delete deletes the saved sets named names...
- No options are defined.
@@ -114,8 +114,7 @@ as name.
- s6 set list lists all the services in the current set,
-printing their names on stdout, one per line.
-the current working set, which always exists.
+printing their names on stdout, one per line.
Options
@@ -145,30 +144,30 @@ the state that they should be in at boot time: masked, disabled (listed
as usable), enabled (listed as active), or essential
(listed as always).
- - masked means that the service will not even appear
+
- masked: the service will not even appear
in the live service database, it will be entirely omitted. If a
-service depends on a masked service, it should be masked too, else
+service depends on a masked service, it should be masked too, otherwise
the set is said to be inconsistent.
- - usable means that the service will be listed in the
-live service database, but will not be brought up by default at boot
+
- usable: the service will be listed in the
+live service database but will not be brought up by default at boot
time. It can later be brought up manually via the
s6 live start command.
- - active means that the service will be brought up by
+
- active: the service will be brought up by
default at boot time. It can later be brought down manually via the
s6 live stop command.
- - always means that the service is considered essential:
-it will always be brought up at boot time, and it cannot be brought down
+
- always: the service is considered essential:
+it will always be brought up at boot time and it cannot be brought down
without special options to force it down; it normally stays up until
the machine is shut down. Essential services are marked as such in the
-stores, and should generally not be tampered with via s6 set
+stores and generally should not be tampered with via s6 set
commands.
The service name is normally followed by a slash (/)
-followed by the name of the sub the service is in. On a terminal,
-with util-linux support, every line is pretty-printed into columns
+then the name of the sub the service is in. On a terminal
+with util-linux support every line is pretty-printed into columns
instead.
If names... is empty, all the services in the set
-are printed, along with their subs.
+are printed along with their subs.
Options
@@ -189,6 +188,11 @@ default.
enable, disable, mask, unmask, make-essential
+
+ These subcommands are the bread and butter of the s6 set commands. They
+allow the user to tailor the boot sequence to their needs without touching the
+currently running database.
+
Interface
@@ -197,22 +201,22 @@ default.
- - These subcommands are build with the same model and do the same
+
- These subcommands are built with the same model and do the same
thing: they move the services listed in services... from their
current subs to another.
- - mask masks the services. Masking means that the service will not appear in the live
+
- mask hides the services. Masking means that the service will not appear in the live
service database at all, it will not be listed, it will not be usable until it is unmasked in
a new working set that is subsequently committed and installed. Masking is useful when the stores
-provide services that come from random installed packages, and the user never wants to run these
-services and it's just better not to see them.
+provide services that come from random installed packages, the user never wants to run these
+services, and it's just better not to see them.
- unmask and disable put the services in the usable sub, i.e. unmasked and disabled.
- - enable enables the services.
+ - enable puts the services in the enabled sub.
- make-essential enables the services and marks them as essential. This command should normally not
be used: essential services are marked as such in the stores and should not be touched. The command exists for
troubleshooting purposes.
- Dependencies across services are computed, and the command will print a message if the change would
+ Dependencies across services are computed and the command will print a message if the change would
make the set inconsistent.
@@ -235,22 +239,14 @@ or pull.
warn: perform the operation with a warning message. The set might
be inconsistent afterwards, that can be changed by manually changing the dependencies
or by fixing the set (see below).
- pull: pull the dependencies into the
-same sub as the listed service, so there is no inconsistency. For enable,
+ pull: resolve inconsistencies by pulling the dependencies into the
+same sub as the listed service. For enable,
service dependencies are made active as well. For disable, reverse
dependencies are disabled as well. For mask, reverse dependencies are
masked as well.
- Notes
-
-
- These subcommands are the bread and butter of the s6 set commands. They
-allow the user to tailor the boot sequence to their needs without touching the
-currently running database.
-
-
check
Interface
@@ -261,7 +257,7 @@ currently running database.
- s6 set check checks the current working set for
-inconsistencies, and prints anything it finds to stdout.
+inconsistencies, printing anything it finds to stdout.
Options
@@ -312,7 +308,7 @@ service database out of the set.
This command must be run once all desired modifications have been
done to the set and that its consistency has been ensured, for instance
by a s6 set check -F command.
- Once the set has been committed, in order to actually be used, it must
+ Once the set has been committed, in order to actually be used it must
be installed via the s6 live install
command.
@@ -325,13 +321,13 @@ command.
last time the set was committed.
-K, --keep-old
- If an old compiled database exists for the set, do not delete it,
-but print its path to stdout. By default, the old database is deleted
+ If an old compiled database exists for the set, do not delete it
+and instead print its path to stdout. By default the old database is deleted
when the set is successfully committed.
-D defaultbundle, --default-bundle=defaultbundle
- The name of the bundle that will hold all active and always
-services, and that will be started at boot time. There is generally no reason
+ The name of the bundle that holds all active and always
+services and that will be started at boot time. There is generally no reason
to change the default, which depends on the distribution and is probably called
default.
--
cgit v1.3.1