s6-rc: the s6-rc-set-change program

From 7551c712d73f1d07f6dec2c9b8183a43204f4aa5 Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Sat, 24 Jan 2026 16:17:39 +0000 Subject: Rename "sub" to "prescription" --- doc/repodefs.html | 54 +++++++++++++++++------------------------------ doc/s6-rc-db.html | 4 ++-- doc/s6-rc-repo-sync.html | 6 +++--- doc/s6-rc-set-change.html | 20 +++++++++--------- doc/s6-rc-set-commit.html | 4 ++-- doc/s6-rc-set-copy.html | 2 +- doc/s6-rc-set-delete.html | 2 +- doc/s6-rc-set-fix.html | 8 +++---- doc/s6-rc-set-new.html | 10 ++++----- doc/s6-rc-set-status.html | 14 ++++++------ 10 files changed, 54 insertions(+), 70 deletions(-) (limited to 'doc') diff --git a/doc/repodefs.html b/doc/repodefs.html index 8a8a6a9..1f8fb6d 100644 --- a/doc/repodefs.html +++ b/doc/repodefs.html @@ -51,9 +51,7 @@ simply because they manage a repository of services.

Definitions

Store

Store: place where service definitions are stored @@ -81,9 +79,7 @@ an administrator could be /etc/s6-rc/sources.

Repository

Repository: place in the filesystem where the repo commands work, @@ -118,9 +114,7 @@ instance, what non-root users would do in order to manage their own sets of services.

-
-
Reference database
-
+
Reference database

Reference database: the dependency graph between all the services @@ -140,9 +134,7 @@ the unions of all the stores is consistent: if not, the initialization fails, so the problem is reported as early as possible.
-
-
Set
-
+
Set

Set: a set of services with all the states the user wants them @@ -156,9 +148,8 @@ and what users will interact the most with. A set contains all the services defined in the reference database (so, each service listed in all the stores used by the repository) and associates, to each service, a given state that the user -wants this service to be in when the system boots. This target state is also -called a sub, because target states are implemented by -subdirectories of the directory holding a set. +wants this service to be in when the system boots. This target state is +called a prescription, or rx for shirt.

@@ -169,17 +160,15 @@ target states are reachable. When satisfied with the states, the user can commit the set, then install it.
-
-
Subs
-
+
Prescriptions

- Sub: the state the user wants a service to reach at boot time. + Prescription (or rx): the state the user wants a service to reach at boot time.

- A sub is the target state for every service in a set. At all times, -each service is in one and only one sub. The list of subs the service can be in + A prescription is the target state for every service in a set. At all times, +each service is in one and only one rx. The list of rxs the service can be in is the following:
@@ -187,7 +176,7 @@ is the following:
masked: when the set is committed, masked services will not be included in the compiled set database. They will be completely absent; if the set database is installed, s6-rc will not know them. -A service in another sub cannot depend on a masked service. Users typically mask +A service in another rx cannot depend on a masked service. Users typically mask services that are included in a store but are superfluous to them, services they just do not want to interact with.

disabled: these services will appear in the compiled set database, @@ -202,20 +191,18 @@ Other names for enabled are: active.

essential, aka always: these services have been marked as essential in their source definition directories, so they will always be enabled. They cannot be disabled or masked. They cannot depend on non-essential -services. This sub is typically used by early boot services that should always +services. This rx is typically used by early boot services that should always run.

- Working on a set basically means moving services from one of these subs to + Working on a set basically means moving services from one of these rxs to another, mostly choosing what services to enable or disable, and sometimes masking services the user does not want to see at all. Once the user is happy with a set, they should commit it.
-
-
Commit
-
+
Commit

Committing a set means assembling a subset of all the source @@ -224,9 +211,7 @@ definition directories in the set and compiling them into a set. This set database can then be installed.
-
-
Install
-
+
Install

Installing a committed set means copying the compiled set @@ -278,14 +263,14 @@ here.
Whenever the admin wants to customize their startup process:
-
They can create new sets (with default subs coming from policy that's +
They can create new sets (with default prescriptions coming from policy that's hardcoded in the stores) with s6-rc-set-new, make a copy of an existing set with s6-rc-set-copy, or delete sets with s6-rc-set-delete.

They can list the existing sets with s6-rc-repo-list.

They can mask, unmask, enable or disable services in their favorite set with s6-rc-set-change.
-
They can check the list of services and their subs with +
They can check the list of services and their prescriptions with s6-rc-set-status.

They can check for inconsistencies and fix them with s6-rc-set-fix.
@@ -302,9 +287,8 @@ commands are involved.

- Note that all these steps will be made easier in the near future by the higher-level -user interface provided by -s6-frontend. + All these steps can be done manually, but they are made easier by the higher-level +user interface provided by s6-frontend.
diff --git a/doc/s6-rc-db.html b/doc/s6-rc-db.html index 564ee59..97c4afe 100644 --- a/doc/s6-rc-db.html +++ b/doc/s6-rc-db.html @@ -233,13 +233,13 @@ bundle). It means the service cannot be downed by normal means: s6-rc -d change atomicname will not work, the -D option to s6-rc is needed. Additionally, when importing atomicname in a set, -it will automatically be put in the always sub, which means +it will automatically be put in the always rx, which means it will always be enabled by default.

Bit 1 is set if there's a flag-recommended file in the source directory (or if the "essential" flag was inherited from a bundle). When importing atomicname in a set, -it will automatically be put in the active sub rather than the +it will automatically be put in the active rx rather than the latent one: unless the user actively makes a change before committing the set, atomicname will be in the default bundle and be started at boot time.
diff --git a/doc/s6-rc-repo-sync.html b/doc/s6-rc-repo-sync.html index cc2501b..9fb74ca 100644 --- a/doc/s6-rc-repo-sync.html +++ b/doc/s6-rc-repo-sync.html @@ -43,9 +43,9 @@ and synchronizes them with the services in all the stores:
If a service doesn't appear in the stores, it is removed from all sets.

If a new service is defined in the stores, it is added to all sets. Services with the essential flag are added to the always -sub; services with -the recommended flag are added to the active sub; others are added -to the usable sub.
+rx; services with +the recommended flag are added to the active rx; others are added +to the usable rx.
It exits 0.
diff --git a/doc/s6-rc-set-change.html b/doc/s6-rc-set-change.html index 3a718c4..8d0b13a 100644 --- a/doc/s6-rc-set-change.html +++ b/doc/s6-rc-set-change.html @@ -5,7 +5,7 @@ s6-rc: the s6-rc-set-change program - + @@ -20,18 +20,18 @@
s6-rc-set-change modifies a set by changing -the sub of some services. +the rx of some services.

Interface

- s6-rc-set-change [ -v verbosity ] [ -r repo ] [ -E | -e ] [ -f | -I fail|pull|warn ] [ -n ] set newsub services... + s6-rc-set-change [ -v verbosity ] [ -r repo ] [ -E | -e ] [ -f | -I fail|pull|warn ] [ -n ] set newrx services...

s6-rc-set-change operates on set set in repository repo.
-
It attempts to move all the services listed in services... into sub newsub.
+
It attempts to move all the services listed in services... into rx newrx.

It exits 0.

@@ -49,19 +49,19 @@ error messages will be written, and 2 or more adds informational messages.
-E, --no-force-essential
-
If a service needs to be moved to/from the always sub, fail and report +
If a service needs to be moved to/from the always rx, fail and report an error. This is the default. Services marked as always are normally defined in the stores with flag-essential, and inconsistencies between essential services should be resolved in the stores.

-e, --force-essential
-
Move services to/from the always sub if they need to be. This option +
Move services to/from the always rx if they need to be. This option should only be used temporarily until the store inconsistency is fixed. Be aware that moving a service from always to usable or masked may result in an unbootable set.

-f, --ignore-dependencies
-
Change services... to newsub, but do not change any other +
Change services... to newrx, but do not change any other services, even if the dependency graph would normally mandate it. This may result in an inconsistent set that you cannot commit.
@@ -69,7 +69,7 @@ in an inconsistent set that you cannot commit.
-I action, --if-dependencies-found=action

Determine what to do if a dependency would make the set inconsistent. For instance, if service A depends on service B, they are both -in the latent sub, and you are trying to change A to active +in the latent rx, and you are trying to change A to active without mentioning B, this would not work: in order to be brought up at boot time, A would first need B to also be brought up at boot time, so A can only be active if B also is. In that situation, @@ -78,7 +78,7 @@ what s6-rc-set-change does depends on the value of action:
fail: print an error message and exit 1.

warn: print a warning message and proceed. This is the default.

pull: print a warning message and pull the dependencies of -services... into newsub. (Or the reverse dependencies, if +services... into newrx. (Or the reverse dependencies, if you're trying to disable or mask services.
The warning messages are not printed if verbosity is 0.
@@ -92,7 +92,7 @@ appropriate, but do not perform the actual modifications.

0

Success.

1

-I fail was given and dependencies prevented services... -from being changed to newsub.
+from being changed to newrx.
3

A service in services... was not found in the reference database.
4

Invalid or corrupted reference database.

100

Incorrect usage.
diff --git a/doc/s6-rc-set-commit.html b/doc/s6-rc-set-commit.html index a331d00..e1200a2 100644 --- a/doc/s6-rc-set-commit.html +++ b/doc/s6-rc-set-commit.html @@ -37,7 +37,7 @@ directory with them. It includes all the bundles defined in the subs: +services' rxs:

If a service is masked, it will not appear in the database at all, and neither will any bundle it's a part of.
@@ -107,7 +107,7 @@ change to the source version, s6-rc-set-commit notices it and does nothing.
s6-rc-set-commit is essentially a wrapper around s6-rc-compile, that translates a user-oriented view of services ("which services do I want available, and -which do I want started at boot time?"), implemented via subs, into the source format for +which do I want started at boot time?"), implemented via rxs, into the source format for s6-rc-compile, then builds the corresponding service database.

s6-rc-set-commit is the ultimate verification step for consistency. When it passes, diff --git a/doc/s6-rc-set-copy.html b/doc/s6-rc-set-copy.html index 9d0681c..422a114 100644 --- a/doc/s6-rc-set-copy.html +++ b/doc/s6-rc-set-copy.html @@ -5,7 +5,7 @@ s6-rc: the s6-rc-set-copy program - + diff --git a/doc/s6-rc-set-delete.html b/doc/s6-rc-set-delete.html index efb1820..1009d7c 100644 --- a/doc/s6-rc-set-delete.html +++ b/doc/s6-rc-set-delete.html @@ -5,7 +5,7 @@ s6-rc: the s6-rc-set-delete program - + diff --git a/doc/s6-rc-set-fix.html b/doc/s6-rc-set-fix.html index eae3d69..564584f 100644 --- a/doc/s6-rc-set-fix.html +++ b/doc/s6-rc-set-fix.html @@ -33,7 +33,7 @@ dependency inconsistencies, and fixes them.
s6-rc-set-fix checks all the sets listed in sets... for dependency inconsistencies that may prevent s6-rc-set-commit from succeeding. If sets... is empty, all the sets in the repository are checked.
-
s6-rc-set-fix prints what it finds and changes the subs +
s6-rc-set-fix prints what it finds and changes the rxs of impacted services so the resulting set is consistent.

@@ -69,15 +69,15 @@ will be started at boot time than the set initially declared. This is the defaul
-E, --no-force-essential

If fixing a dependency inconsistency would imply moving a service down from the -always sub, or up to the always sub, when its service definition +always rx, or up to the always rx, when its service definition directory does not declare it as essential, do not attempt fixing it and fail the operation. This is the default. If such a situation occurs, it means that the set of services -provided in the stores is not consistent, and that +provided in the stores is not consistent, and that is what should be fixed.

-e, --force-essential

If fixing a dependency inconsistency would imply moving a service down from the -always sub, or up to the always sub, when its service definition +always rx, or up to the always rx, when its service definition directory does not declare it as essential, do it, even though it goes against a service definition in a store. This can help you keep a service set consistent until the store is fixed.
diff --git a/doc/s6-rc-set-new.html b/doc/s6-rc-set-new.html index 4d4642b..688f9db 100644 --- a/doc/s6-rc-set-new.html +++ b/doc/s6-rc-set-new.html @@ -5,7 +5,7 @@ s6-rc: the s6-rc-set-new program - + @@ -33,12 +33,12 @@ in a repository.
For every argument in setname..., s6-rc-set-new creates a set with that name, in the repository repo. Under that set name, it attributes a default -sub to every service listed in the +rx to every service listed in the stores:
-
Services with the essential flag are added to the always sub
-
Services with the recommended flag are added to the active sub
-
Others are added to the usable sub.
+
Services with the essential flag are added to the always rx
+
Services with the recommended flag are added to the active rx
+
Others are added to the usable rx.

It exits 0.
diff --git a/doc/s6-rc-set-status.html b/doc/s6-rc-set-status.html index 7e55a11..53c1b28 100644 --- a/doc/s6-rc-set-status.html +++ b/doc/s6-rc-set-status.html @@ -5,7 +5,7 @@ s6-rc: the s6-rc-set-status program - + @@ -20,7 +20,7 @@
s6-rc-set-status lists some of, or all, the services of a set, -along with the sub each service is on. +along with the rx each service is on.

Interface
@@ -37,7 +37,7 @@ services in the set. Each line consists of:

The name of the service

A slash (/) character
-
The canonical name for the sub the service is in.
+
The canonical name for the rx the service is in.

It exits 0.
@@ -56,14 +56,14 @@ error messages will be written, and 2 or more adds informational messages.
-E, --with-essentials
-
Do not ignore services in the always sub, i.e. services marked as +
Do not ignore services in the always rx, i.e. services marked as essential. This is the default.

-e, --without-essentials
-
Ignore services in the always sub: do not print them.
+
Ignore services in the always rx: do not print them.

-L. --list
-
Do not print /sub at the end of each line: only print the service names.
+
Do not print /rx at the end of each line: only print the service names.

Exit codes
@@ -81,7 +81,7 @@ essential. This is the default.

s6-rc-set-status is meant to be used with automation such as util-linux's column -for formatting. A slash is used to separate the service name for the sub because +for formatting. A slash is used to separate the service name for the rx because slashes cannot appear in service names.

-- cgit v1.3.1