diff options
| author | Laurent Bercot <ska-skaware@skarnet.org> | 2026-01-24 16:17:39 +0000 |
|---|---|---|
| committer | Laurent Bercot <ska-skaware@skarnet.org> | 2026-01-24 16:17:39 +0000 |
| commit | 7551c712d73f1d07f6dec2c9b8183a43204f4aa5 (patch) | |
| tree | c219efcd39d6a5ef72bf3cef2898f04b41cfb25f /doc | |
| parent | b71b06951c8f9250f87a16cd1e60b2d779bfcfff (diff) | |
| download | s6-rc-7551c712d73f1d07f6dec2c9b8183a43204f4aa5.tar.gz | |
Rename "sub" to "prescription"
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/repodefs.html | 54 | ||||
| -rw-r--r-- | doc/s6-rc-db.html | 4 | ||||
| -rw-r--r-- | doc/s6-rc-repo-sync.html | 6 | ||||
| -rw-r--r-- | doc/s6-rc-set-change.html | 20 | ||||
| -rw-r--r-- | doc/s6-rc-set-commit.html | 4 | ||||
| -rw-r--r-- | doc/s6-rc-set-copy.html | 2 | ||||
| -rw-r--r-- | doc/s6-rc-set-delete.html | 2 | ||||
| -rw-r--r-- | doc/s6-rc-set-fix.html | 8 | ||||
| -rw-r--r-- | doc/s6-rc-set-new.html | 10 | ||||
| -rw-r--r-- | doc/s6-rc-set-status.html | 14 |
10 files changed, 54 insertions, 70 deletions
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 <em>repository</em> of services. <h2> Definitions </h2> -<div id="store"> -<h3> Store </h3> -</div> +<h3 id="store"> Store </h3> <p> <em> Store: place where service definitions are stored </em> @@ -81,9 +79,7 @@ an administrator could be <tt>/etc/s6-rc/sources</tt>. </p> -<div id="repository"> -<h3> Repository </h3> -</div> +<h3 id="repository"> Repository </h3> <p> <em> 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. </p> -<div id="refdb"> -<h3> Reference database </h3> -</div> +<h3 id="refdb"> Reference database </h3> <p> <em>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. </p> -<div id="set"> -<h3> Set </h3> -</div> +<h3 id="set"> Set </h3> <p> <em> 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 <a href="#refdb">reference database</a> (so, each service listed in all the <a href="#store">stores</a> 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 <a href="#sub">sub</a>, 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 <a href="#rx">prescription</a>, or rx for shirt. </p> <p> @@ -169,17 +160,15 @@ target states are reachable. When satisfied with the states, the user can <a href="#commit">commit</a> the set, then <a href="#install">install</a> it. </p> -<div id="sub"> -<h3> Subs </h3> -</div> +<h3 id="rx"> Prescriptions </h3> <p> - <em> Sub: the state the user wants a service to reach at boot time. </em> + <em> Prescription (or rx): the state the user wants a service to reach at boot time. </em> </p> <p> - A <em>sub</em> 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 <em>prescription</em> 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: </p> @@ -187,7 +176,7 @@ is the following: <li> <em>masked</em>: when the set is committed, masked services <em>will not</em> be included in the compiled set database. They will be completely absent; if the set database is installed, <a href="s6-rc.html">s6-rc</a> 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. </li> <li> <em>disabled</em>: these services will appear in the compiled set database, @@ -202,20 +191,18 @@ Other names for <em>enabled</em> are: <em>active</em>. </li> <li> <em>essential</em>, aka <em>always</em>: 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. </li> </ul> <p> - 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. </p> -<div id="commit"> -<h3> Commit </h3> -</div> +<h3 id="commit"> Commit </h3> <p> <em>Committing</em> 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 <em>installed</em>. </p> -<div id="install"> -<h3> Install </h3> -</div> +<h3 id="install"> Install </h3> <p> <em>Installing</em> a committed set means copying the compiled set @@ -278,14 +263,14 @@ here. </li> <li> <strong>Whenever the admin wants to customize their startup process</strong>: <ul> - <li> They can create new sets (with default subs coming from policy that's + <li> They can create new sets (with default prescriptions coming from policy that's hardcoded in the stores) with <a href="s6-rc-set-new.html">s6-rc-set-new</a>, make a copy of an existing set with <a href="s6-rc-set-copy.html">s6-rc-set-copy</a>, or delete sets with <a href="s6-rc-set-delete.html">s6-rc-set-delete</a>. </li> <li> They can list the existing sets with <a href="s6-rc-repo-list.html">s6-rc-repo-list</a>. </li> <li> They can mask, unmask, enable or disable services in their favorite set with <a href="s6-rc-set-change.html">s6-rc-set-change</a>. </li> - <li> They can check the list of services and their subs with + <li> They can check the list of services and their prescriptions with <a href="s6-rc-set-status.html">s6-rc-set-status</a>. </li> <li> They can check for inconsistencies and fix them with <a href="s6-rc-set-fix.html">s6-rc-set-fix</a>. </li> @@ -302,9 +287,8 @@ commands are involved. </li> </ul> <p> - Note that all these steps will be made easier in the near future by the higher-level -user interface provided by -<a href="s6-frontend.html">s6-frontend</a>. + All these steps can be done manually, but they are made easier by the higher-level +user interface provided by <a href="s6-frontend.html">s6-frontend</a>. </p> </body> 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: <code>s6-rc -d change <em>atomicname</em></code> will not work, the <tt>-D</tt> option to s6-rc is needed. Additionally, when importing <em>atomicname</em> in a <a href="repodefs.html#set">set</a>, -it will automatically be put in the <tt>always</tt> sub, which means +it will automatically be put in the <tt>always</tt> rx, which means it will always be enabled by default. </li> <li> Bit 1 is set if there's a <tt>flag-recommended</tt> file in the source directory (or if the "essential" flag was inherited from a bundle). When importing <em>atomicname</em> in a <a href="repodefs.html#set">set</a>, -it will automatically be put in the <tt>active</tt> sub rather than the +it will automatically be put in the <tt>active</tt> rx rather than the <tt>latent</tt> one: unless the user actively makes a change before committing the set, <em>atomicname</em> will be in the default bundle and be started at boot time. </li> 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: <li> If a service doesn't appear in the stores, it is removed from all sets. </li> <li> If a new service is defined in the stores, it is added to all sets. Services with the <em>essential</em> flag are added to the <tt>always</tt> -<a href="repodefs.html#sub">sub</a>; services with -the <em>recommended</em> flag are added to the <tt>active</tt> sub; others are added -to the <tt>usable</tt> sub. </li> +<a href="repodefs.html#rx">rx</a>; services with +the <em>recommended</em> flag are added to the <tt>active</tt> rx; others are added +to the <tt>usable</tt> rx. </li> </ul> </li> <li> It exits 0. </li> </ul> 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 @@ <meta http-equiv="Content-Language" content="en" /> <title>s6-rc: the s6-rc-set-change program</title> <meta name="Description" content="s6-rc: the s6-rc-set-change program" /> - <meta name="Keywords" content="s6-rc s6-rc-set-change repo set sub change services" /> + <meta name="Keywords" content="s6-rc s6-rc-set-change repo set rx change services" /> <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> --> </head> <body> @@ -20,18 +20,18 @@ <p> s6-rc-set-change modifies a <a href="repodefs.html#set">set</a> by changing -the <a href="repodefs.html#sub">sub</a> of some services. +the <a href="repodefs.html#rx">rx</a> of some services. </p> <h2> Interface </h2> <pre> - s6-rc-set-change [ -v <em>verbosity</em> ] [ -r <em>repo</em> ] [ -E | -e ] [ -f | -I fail|pull|warn ] [ -n ] <em>set</em> <em>newsub</em> <em>services...</em> + s6-rc-set-change [ -v <em>verbosity</em> ] [ -r <em>repo</em> ] [ -E | -e ] [ -f | -I fail|pull|warn ] [ -n ] <em>set</em> <em>newrx</em> <em>services...</em> </pre> <ul> <li> s6-rc-set-change operates on <a href="repodefs.html#set">set</a> <em>set</em> in <a href="repodefs.html#repository">repository</a> <em>repo</em>. </li> - <li> It attempts to move all the services listed in <em>services...</em> into <a href="repodefs.html#sub">sub</a> <em>newsub</em>. </li> + <li> It attempts to move all the services listed in <em>services...</em> into <a href="repodefs.html#rx">rx</a> <em>newrx</em>. </li> <li> It exits 0. </li> </ul> @@ -49,19 +49,19 @@ error messages will be written, and 2 or more adds informational messages. </dd> </dd> <dt> -E, --no-force-essential </dt> - <dd> If a service needs to be moved to/from the <tt>always</tt> sub, fail and report + <dd> If a service needs to be moved to/from the <tt>always</tt> rx, fail and report an error. This is the default. Services marked as <em>always</em> are normally defined in the stores with <tt>flag-essential</tt>, and inconsistencies between essential services should be resolved in the stores. </dd> <dt> -e, --force-essential </dt> - <dd> Move services to/from the <tt>always</tt> sub if they need to be. This option + <dd> Move services to/from the <tt>always</tt> 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 <em>always</em> to <em>usable</em> or <em>masked</em> may result in an unbootable set. </dd> <dt> -f, --ignore-dependencies </dt> - <dd> Change <em>services...</em> to <em>newsub</em>, but do not change any other + <dd> Change <em>services...</em> to <em>newrx</em>, 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. </dd> </dl> @@ -69,7 +69,7 @@ in an inconsistent set that you cannot commit. </dd> <dt> -I <em>action</em>, --if-dependencies-found=<em>action</em> </dt> <dd> Determine what to do if a dependency would make the set inconsistent. For instance, if service <tt>A</tt> depends on service <tt>B</tt>, they are both -in the <tt>latent</tt> sub, and you are trying to change <tt>A</tt> to <tt>active</tt> +in the <tt>latent</tt> rx, and you are trying to change <tt>A</tt> to <tt>active</tt> without mentioning <tt>B</tt>, this would not work: in order to be brought up at boot time, <tt>A</tt> would first need <tt>B</tt> to also be brought up at boot time, so <tt>A</tt> can only be <tt>active</tt> if <tt>B</tt> also is. In that situation, @@ -78,7 +78,7 @@ what s6-rc-set-change does depends on the value of <em>action</em>: <li> <tt>fail</tt>: print an error message and exit 1. </li> <li> <tt>warn</tt>: print a warning message and proceed. This is the default. </li> <li> <tt>pull</tt>: print a warning message and pull the dependencies of -<em>services...</em> into <em>newsub</em>. (Or the reverse dependencies, if +<em>services...</em> into <em>newrx</em>. (Or the reverse dependencies, if you're trying to disable or mask services. </li> </ul> The warning messages are not printed if <em>verbosity</em> is 0. </dd> @@ -92,7 +92,7 @@ appropriate, but do not perform the actual modifications. </dd> <dl> <dt> 0 </dt> <dd> Success. </dd> <dt> 1 </dt> <dd> <tt>-I fail</tt> was given and dependencies prevented <em>services...</em> -from being changed to <em>newsub</em>. </dd> +from being changed to <em>newrx</em>. </dd> <dt> 3 </dt> <dd> A service in <em>services...</em> was not found in the reference database. </dt> <dt> 4 </dt> <dd> Invalid or corrupted reference database. </dd> <dt> 100 </dt> <dd> Incorrect usage. </dd> 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 <a href="repodef as none of the atomic services composing a bundle is masked. If any service in a bundle is masked, the bundle does not appear in the database. </li> <li> It makes an additional bundle, <em>defaultbundle</em>, based on the -services' <a href="repodefs.html#sub">subs</a>: +services' <a href="repodefs.html#rx">rxs</a>: <ul> <li> If a service is <em>masked</em>, it will not appear in the database at all, and neither will any bundle it's a part of. </li> @@ -107,7 +107,7 @@ change to the source version, s6-rc-set-commit notices it and does nothing. </dd <ul> <li> s6-rc-set-commit is essentially a wrapper around <a href="s6-rc-compile.html">s6-rc-compile</a>, 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 <a href="s6-rc-compile.html">s6-rc-compile</a>, then builds the corresponding service database. </li> <li> 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 @@ <meta http-equiv="Content-Language" content="en" /> <title>s6-rc: the s6-rc-set-copy program</title> <meta name="Description" content="s6-rc: the s6-rc-set-copy program" /> - <meta name="Keywords" content="s6-rc s6-rc-set-copy repo set sub copy services" /> + <meta name="Keywords" content="s6-rc s6-rc-set-copy repo set rx copy services" /> <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> --> </head> <body> 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 @@ <meta http-equiv="Content-Language" content="en" /> <title>s6-rc: the s6-rc-set-delete program</title> <meta name="Description" content="s6-rc: the s6-rc-set-delete program" /> - <meta name="Keywords" content="s6-rc s6-rc-set-delete repo set sub deletion services" /> + <meta name="Keywords" content="s6-rc s6-rc-set-delete repo set rx deletion services" /> <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> --> </head> <body> 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. <li> s6-rc-set-fix checks all the sets listed in <em>sets...</em> for dependency inconsistencies that may prevent <a href="s6-rc-set-commit.html">s6-rc-set-commit</a> from succeeding. If <em>sets...</em> is empty, all the sets in the repository are checked. </li> - <li> s6-rc-set-fix prints what it finds and changes the <a href="repodefs.html#sub">subs</a> + <li> s6-rc-set-fix prints what it finds and changes the <a href="repodefs.html#rx">rxs</a> of impacted services so the resulting set is consistent. </li> </ul> @@ -69,15 +69,15 @@ will be started at boot time than the set initially declared. This is the defaul <dt> -E, --no-force-essential </dt> <dd> If fixing a dependency inconsistency would imply moving a service down from the -<em>always</em> sub, or up to the <em>always</em> sub, when its service definition +<em>always</em> rx, or up to the <em>always</em> 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 <a href="repodefs.html#sub">stores</a> is not consistent, and that +provided in the <a href="repodefs.html#rx">stores</a> is not consistent, and that is what should be fixed. </dd> <dt> -e, --force-essential </dt> <dd> If fixing a dependency inconsistency would imply moving a service down from the -<em>always</em> sub, or up to the <em>always</em> sub, when its service definition +<em>always</em> rx, or up to the <em>always</em> 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. </dd> 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 @@ <meta http-equiv="Content-Language" content="en" /> <title>s6-rc: the s6-rc-set-new program</title> <meta name="Description" content="s6-rc: the s6-rc-set-new program" /> - <meta name="Keywords" content="s6-rc s6-rc-set-new repo set sub new services" /> + <meta name="Keywords" content="s6-rc s6-rc-set-new repo set rx new services" /> <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> --> </head> <body> @@ -33,12 +33,12 @@ in a <a href="repodefs.html#repository">repository</a>. <li> For every argument in <em>setname...</em>, s6-rc-set-new creates a <a href="repodefs.html#set">set</a> with that name, in the repository <em>repo</em>. Under that set name, it attributes a default -<a href="repodefs.html#sub">sub</a> to every service listed in the +<a href="repodefs.html#rx">rx</a> to every service listed in the <a href="repodefs.html#store">stores</a>: <ul> - <li> Services with the <em>essential</em> flag are added to the <tt>always</tt> sub </li> - <li> Services with the <em>recommended</em> flag are added to the <tt>active</tt> sub </li> - <li> Others are added to the <tt>usable</tt> sub. </li> + <li> Services with the <em>essential</em> flag are added to the <tt>always</tt> rx </li> + <li> Services with the <em>recommended</em> flag are added to the <tt>active</tt> rx </li> + <li> Others are added to the <tt>usable</tt> rx. </li> </ul> </li> <li> It exits 0. </li> </ul> 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 @@ <meta http-equiv="Content-Language" content="en" /> <title>s6-rc: the s6-rc-set-status program</title> <meta name="Description" content="s6-rc: the s6-rc-set-status program" /> - <meta name="Keywords" content="s6-rc s6-rc-set-status repo set sub list services status" /> + <meta name="Keywords" content="s6-rc s6-rc-set-status repo set rx list services status" /> <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> --> </head> <body> @@ -20,7 +20,7 @@ <p> s6-rc-set-status lists some of, or all, the services of a <a href="repodefs.html#set">set</a>, -along with the <a href="repodefs.html#sub">sub</a> each service is on. +along with the <a href="repodefs.html#rx">rx</a> each service is on. </p> <h2> Interface </h2> @@ -37,7 +37,7 @@ services in the set. Each line consists of: <ul> <li> The name of the service </li> <li> A slash (<tt>/</tt>) character </li> - <li> The canonical name for the sub the service is in. </li> + <li> The canonical name for the rx the service is in. </li> </ul> </li> <li> It exits 0. </li> </ul> @@ -56,14 +56,14 @@ error messages will be written, and 2 or more adds informational messages. </dd> </dd> <dt> -E, --with-essentials </dt> - <dd> Do not ignore services in the <tt>always</tt> sub, i.e. services marked as + <dd> Do not ignore services in the <tt>always</tt> rx, i.e. services marked as essential. This is the default. </dd> <dt> -e, --without-essentials </dt> - <dd> Ignore services in the <tt>always</tt> sub: do not print them. </dd> + <dd> Ignore services in the <tt>always</tt> rx: do not print them. </dd> <dt> -L. --list </dt> - <dd> Do not print <tt>/<em>sub</em></tt> at the end of each line: only print the service names. </dd> + <dd> Do not print <tt>/<em>rx</em></tt> at the end of each line: only print the service names. </dd> </dl> <h2> Exit codes </h2> @@ -81,7 +81,7 @@ essential. This is the default. </dd> <ul> <li> s6-rc-set-status is meant to be used with automation such as util-linux's <a href="https://man7.org/linux/man-pages/man1/column.1.html">column</a> -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. </li> </ul> |
