From e4821d7a10ee2096b689a66baa9b974d51339bc3 Mon Sep 17 00:00:00 2001
From: Laurent Bercot
Date: Tue, 23 May 2017 11:05:54 +0000
Subject: Switch doc to schemeless URLs
---
doc/faq.html | 20 +++++++--------
doc/index.html | 16 ++++++------
doc/overview.html | 20 +++++++--------
doc/s6-rc-bundle.html | 10 ++++----
doc/s6-rc-compile.html | 28 ++++++++++-----------
doc/s6-rc-db.html | 6 ++---
doc/s6-rc-dryrun.html | 6 ++---
doc/s6-rc-fdholder-filler.html | 14 +++++------
doc/s6-rc-init.html | 14 +++++------
doc/s6-rc-oneshot-run.html | 6 ++---
doc/s6-rc-update.html | 10 ++++----
doc/s6-rc.html | 12 ++++-----
doc/upgrade.html | 56 +++++++++++++++++++++---------------------
doc/why.html | 24 +++++++++---------
14 files changed, 121 insertions(+), 121 deletions(-)
(limited to 'doc')
diff --git a/doc/faq.html b/doc/faq.html
index 09c3a99..bfb995b 100644
--- a/doc/faq.html
+++ b/doc/faq.html
@@ -6,14 +6,14 @@
s6-rc: FAQ
-
+
s6-rc
-Software
-skarnet.org
+Software
+skarnet.org
s6-rc: Frequently Asked Questions
@@ -93,7 +93,7 @@ file.
Using the filesystem as a key-value store is
a good technique to avoid parsing, and skarnet.org packages do it
everywhere: for instance,
-s6-envdir
+s6-envdir
uses the file name as a key and the file contents as a value.
The s6-rc-compile source format is just another instance of this
technique.
@@ -196,7 +196,7 @@ time you compile a service database, you could run:
When you compile a new service database, always compile it to a
unique name, preferrably in the same directory as your current compiled
database. You can for instance use a TAI64N timestamp, obtained by
-s6-clock,
+s6-clock,
to create such a name:
stamp=`s6-clock`
@@ -218,14 +218,14 @@ new database will be used on the next boot, atomically update the link:
s6-ln -nsf compiled-$stamp /etc/s6-rc/compiled
The use of the
-s6-ln
+s6-ln
utility is recommended, because the
ln
standard actually forbids an atomic replacement, so utilities that
follow it to the letter, for instance, ln from GNU coreutils, cannot
be atomic: they first remove the old link, then create the new one. If you
do not have
-s6-ln,
+s6-ln,
you need to perform an unintuitive workaround to get POSIX-compliant tools to
do the right thing:
ln -sf compiled-$stamp /etc/s6-rc/compiled/compiled &&
@@ -284,7 +284,7 @@ using OpenRC
You can now run compile your s6-rc service database, and use the
s6-rc engine as your service manager.
Transitions will use your original init scripts, and the supervision
-features of s6 will
+features of s6 will
not be used, but you will get proper dependency tracking and
easy state changes.
@@ -321,7 +321,7 @@ bundle that contains nothing at all!
In your boot script (/etc/rc.init, for instance, if
you're using
-s6-linux-init),
+s6-linux-init),
after invoking
s6-rc-init, just ask
s6-rc to start the set of services you want up
@@ -416,7 +416,7 @@ addressed by Unix distributions.
- Like the rest of skarnet.org
+ Like the rest of skarnet.org
software, s6-rc aims to provide mechanism, not policy:
it is OS-agnostic and distribution-agnostic. Providing boot scripts,
or anything of this kind, would go against this principle; it is
diff --git a/doc/index.html b/doc/index.html
index e4132c5..c83d0f3 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -6,13 +6,13 @@
s6-rc - a service manager for s6
-
+
-Software
-skarnet.org
+Software
+skarnet.org
s6-rc
@@ -21,7 +21,7 @@
s6-rc is a service manager for
-s6-based
+s6-based
systems, i.e. a suite of programs that can start and stop
services, both long-running daemons and one-time
initialization scripts, in the proper order according to a
@@ -47,11 +47,11 @@ scripts are also run in a controlled environment.
- A POSIX-compliant system with a standard C development environment
- GNU make, version 3.81 or later
- - skalibs version
+
- skalibs version
2.5.1.0 or later
- - execline version
+
- execline version
2.3.0.1 or later
- - s6 version
+
- s6 version
2.5.1.0 or later
@@ -125,7 +125,7 @@ the previous versions of s6-rc and the current one.
- s6-rc is discussed on the
-skaware mailing-list.
+skaware mailing-list.
Similar work
diff --git a/doc/overview.html b/doc/overview.html
index 12d5e4d..c585cbb 100644
--- a/doc/overview.html
+++ b/doc/overview.html
@@ -6,14 +6,14 @@
s6-rc: an overview
-
+
s6-rc
-Software
-skarnet.org
+Software
+skarnet.org
An overview of s6-rc
@@ -59,11 +59,11 @@ around while the filesystem is mounted.
- A longrun is the exact equivalent of a service
in the supervision sense. It is defined by a
-service
+service
directory, with a run script and optional other data. The
service is considered up as long as the long-lived
process is alive and, for daemons that support it, has
-notified
+notified
its readiness. It is considered down otherwise.
- A oneshot, on the other hand, is totally unknown
from supervision suites, because there is no daemon to manage.
@@ -143,15 +143,15 @@ them in a human-friendly format.
- First, the chosen init should make sure that a
-s6
+s6
supervision tree is up and running. s6-rc will only work
if there is an active
-s6-svscan
+s6-svscan
process monitoring a
-scan
+scan
directory. On Linux, for instance, it is possible to achieve such a state
by using an init created by the
-s6-linux-init-maker
+s6-linux-init-maker
tool: when control reaches stage 2, s6-svscan is guaranteed to run,
so using s6-rc in the stage 2 script is the way to go.
- The boot process, let's name it stage2, should then call the
@@ -194,7 +194,7 @@ managed by s6-rc should be brought down in the proper order (via the
s6-rc -da change command). Once all those services have been
brought down successfully, the final shutdown procedure can take place;
for instance, if s6-svscan is running as process 1 with the
-s6-linux-init
+s6-linux-init
defaults, s6-svscanctl -6 /run/service will kill the
supervision tree and call /etc/rc.shutdown reboot, which should
reboot the machine.
diff --git a/doc/s6-rc-bundle.html b/doc/s6-rc-bundle.html
index 21a1f8a..6365f32 100644
--- a/doc/s6-rc-bundle.html
+++ b/doc/s6-rc-bundle.html
@@ -6,14 +6,14 @@
s6-rc: the s6-rc-bundle program
-
+
s6-rc
-Software
-skarnet.org
+Software
+skarnet.org
The s6-rc-bundle program
@@ -112,9 +112,9 @@ s6-rc-bundle invocation.
Performs multiple bundle deletions and additions. This subcommand is best
-used in an execline
+used in an execline
script, because it uses
-blocks.
+blocks.
diff --git a/doc/s6-rc-compile.html b/doc/s6-rc-compile.html
index 453c6ac..d78e7ad 100644
--- a/doc/s6-rc-compile.html
+++ b/doc/s6-rc-compile.html
@@ -6,14 +6,14 @@
s6-rc: the s6-rc-compile program
-
+
s6-rc
-Software
-skarnet.org
+Software
+skarnet.org
The s6-rc-compile program
@@ -73,7 +73,7 @@ use this database with s6-rc to start and
stop services. gids must be a comma-separated list of
numerical GIDs.
- -h fdhuser : arrange for the
-s6-fdholder-daemon
+s6-fdholder-daemon
program, which maintains the pipes for the longrun pipelines, to run
as user fdhuser. By default, it runs as the user owning
the supervision tree, i.e. most likely root.
@@ -201,7 +201,7 @@ complain and exit 1.
- Two regular files named up and down, which
must each contain a single Unix command line. The files will be interpreted by the
-execlineb
+execlineb
lexer at compile time and the results will be stored into the
compiled database in an internal form. up will be run when
the service is started, and down will be executed when the service
@@ -215,10 +215,10 @@ does nothing and always succeeds.
up and down are interpreted by
-execlineb, but
+execlineb, but
that does not mean they have to be entirely written in the
-execline language. The
-execlineb
+execline language. The
+execlineb
lexer is only used because it can compile a Unix command line from a text file
and store the compiled result, whereas a shell would have to be invoked
everytime the script is run. There are many ways to write up and
@@ -248,7 +248,7 @@ You don't.
The s6-rc service definition directory for a longrun service is similar to
-a s6 service
+a s6 service
directory, but there are a few differences:
@@ -277,9 +277,9 @@ about pipelines.
named finish, notification-fd, timeout-kill,
timeout-finish and nosetsid. These
files will be copied, or recreated, in the generated
-service directory:
+service directory:
they are meant to be used by the
-s6-supervise
+s6-supervise
process that will manage the longrun service.
- Optional directories named data and env. These will
be copied verbatim into the generated service directory.
@@ -311,7 +311,7 @@ use relative paths, not absolute ones.
Note that you cannot create a ./down file for
-s6-supervise
+s6-supervise
in a generated service
directory. Even if such a file exists in the definition directory, it will
be ignored - it will not be replicated in the service directory.
@@ -369,7 +369,7 @@ detect and reject cycles as well as collisions.
The pipe linking a producer with a consumer is created and stored at
run-time in a
-s6-fdholder-daemon
+s6-fdholder-daemon
instance managed by an automatically generated longrun service named
s6rc-fdholder.
@@ -381,7 +381,7 @@ instance managed by an automatically generated longrun service named
of service definition directories, which is actually a working, valid set for a
Linux system running
busybox and the
-skarnet.org packages; of course, only
+skarnet.org packages; of course, only
the service definition set has been kept, and private information has been
removed, so it won't work out-of-the-box without the proper specific files,
notably configuration in /etc - but nevertheless, you can browse the
diff --git a/doc/s6-rc-db.html b/doc/s6-rc-db.html
index 5c664f5..bc527a6 100644
--- a/doc/s6-rc-db.html
+++ b/doc/s6-rc-db.html
@@ -6,14 +6,14 @@
s6-rc: the s6-rc-db program
-
+
s6-rc
-Software
-skarnet.org
+Software
+skarnet.org
The s6-rc-db program
diff --git a/doc/s6-rc-dryrun.html b/doc/s6-rc-dryrun.html
index ee23d3b..11210bd 100644
--- a/doc/s6-rc-dryrun.html
+++ b/doc/s6-rc-dryrun.html
@@ -6,14 +6,14 @@
s6-rc: the s6-rc-dryrun program
-
+
s6-rc
-Software
-skarnet.org
+Software
+skarnet.org
The s6-rc-dryrun internal program
diff --git a/doc/s6-rc-fdholder-filler.html b/doc/s6-rc-fdholder-filler.html
index a835663..4904afd 100644
--- a/doc/s6-rc-fdholder-filler.html
+++ b/doc/s6-rc-fdholder-filler.html
@@ -6,21 +6,21 @@
s6-rc: the s6-rc-fdholder-filler program
-
+
s6-rc
-Software
-skarnet.org
+Software
+skarnet.org
The s6-rc-fdholder-filler internal program
s6-rc-fdholder-filler creates anonymous pipes and stores them into a
-s6-fdholderd
+s6-fdholderd
"fd-holding" daemon.
@@ -40,14 +40,14 @@ in internal scripts created by
- s6-rc-fdholder-filler expects file descriptor 6 to be open and
connected to the
-s6-fdholderd
+s6-fdholderd
daemon instance managed by s6-rc as the internal s6rc-fdholder service.
- It reads a list of longrun names from its stdin, one per line.
Empty lines are ignored; comments starting with # are ignored;
leading whitespace is ignored, but trailing whitespace is not.
- For every name longrun that it finds, it
creates an anonymous pipe, and stores both ends of that pipe into the
-s6-fdholderd
+s6-fdholderd
instance, with the pipe:s6-rc-r-longrun (for the reading
end) and pipe:s6-rc-w-longrun (for the writing end)
identifiers, and an infinite timeout.
@@ -79,7 +79,7 @@ default, timeout is 0, meaning infinite.
should only be used to understand s6-rc internals.
- s6-rc-fdholder-filler is used in the s6rc-fdholder internal
service's run script, right after the
-s6-fdholderd
+s6-fdholderd
daemon is started; its arguments are the names of all the consumer longrun
services declared in the service database.
- The point is to create all the pipes for the longrun pipelines in
diff --git a/doc/s6-rc-init.html b/doc/s6-rc-init.html
index c0ae6fc..54692bf 100644
--- a/doc/s6-rc-init.html
+++ b/doc/s6-rc-init.html
@@ -6,14 +6,14 @@
s6-rc: the s6-rc-init program
-
+
s6-rc
-Software
-skarnet.org
+Software
+skarnet.org
The s6-rc-init program
@@ -37,7 +37,7 @@ invocation of the
- s6-rc-init expects to find a compiled service database
in compiled. It expects to be able to create a directory
named live. It also expects that an instance of
-s6-svscan
+s6-svscan
is running on scandir.
- s6-rc-init initializes the live state in live. It
declares compiled as the current service database and
@@ -46,9 +46,9 @@ sets the state as "all services down".
the service directories declared by compiled into a
subdirectory of live, adds ./down files to the live copies
and links those live copies into scandir. It then triggers
-s6-svscan,
+s6-svscan,
which will pick up the new service directories and start
-s6-supervise
+s6-supervise
processes on them - but the service themselves will not be started
right away, because of the ./down files.
- s6-rc-init waits for all s6-supervise processes to be
@@ -104,7 +104,7 @@ invocation of the s6-rc change command.)
For instance, when using an init created by
-s6-linux-init,
+s6-linux-init,
s6-rc-init should be the first command in the
stage2 (by default /etc/rc.init) script.
diff --git a/doc/s6-rc-oneshot-run.html b/doc/s6-rc-oneshot-run.html
index 8cddcb5..49ed63b 100644
--- a/doc/s6-rc-oneshot-run.html
+++ b/doc/s6-rc-oneshot-run.html
@@ -6,14 +6,14 @@
s6-rc: the s6-rc-oneshot-run program
-
+
s6-rc
-Software
-skarnet.org
+Software
+skarnet.org
The s6-rc-oneshot-run internal program
diff --git a/doc/s6-rc-update.html b/doc/s6-rc-update.html
index 52ab42d..165f8de 100644
--- a/doc/s6-rc-update.html
+++ b/doc/s6-rc-update.html
@@ -6,14 +6,14 @@
s6-rc: the s6-rc-update program
-
+
s6-rc
-Software
-skarnet.org
+Software
+skarnet.org
The s6-rc-update program
@@ -194,7 +194,7 @@ the next.
A line is lexed into words by the
-execlineb
+execlineb
lexer, which means that words are normally separated by whitespace, but
can be quoted, that # comments are recognized, etc.
@@ -256,7 +256,7 @@ to the real directory containing the live information, not the name of the
real directory.
- If a longrun service is renamed from oldname to newname,
but not restarted, the
-s6-supervise
+s6-supervise
process in charge of it will still show up in the process list as
s6-supervise oldname. This is purely cosmetic and
will have no impact on the service; nevertheless, if you wish to avoid that,
diff --git a/doc/s6-rc.html b/doc/s6-rc.html
index a6e64d9..957c108 100644
--- a/doc/s6-rc.html
+++ b/doc/s6-rc.html
@@ -6,14 +6,14 @@
s6-rc: the s6-rc program
-
+
s6-rc
-Software
-skarnet.org
+Software
+skarnet.org
The s6-rc program
@@ -234,14 +234,14 @@ is considered down by s6-rc will have a ./down file in its live service
directory; a service that is considered up by s6-rc will not.) The
transition is considered successful as soon as the daemon dies (for
down transitions), or becomes up and
-ready
+ready
(for up transitions). If a longrun service does not support
readiness notification, the
-s6-svc
+s6-svc
command that is invoked by s6-rc will print a warning message, and
the transition will be considered successful as soon as the daemon
is up, i.e. as soon as the ./run script is executed by
-s6-supervise.
+s6-supervise.
diff --git a/doc/upgrade.html b/doc/upgrade.html
index a35db65..3db2fd0 100644
--- a/doc/upgrade.html
+++ b/doc/upgrade.html
@@ -6,14 +6,14 @@
s6-rc: how to upgrade
-
+
s6-rc
-Software
-skarnet.org
+Software
+skarnet.org
What has changed in s6-rc
@@ -21,22 +21,22 @@
in 0.2.0.1
in 0.2.0.0
- - skalibs
+
- skalibs
dependency bumped to 2.5.0.0.
- - execline
+
- execline
dependency bumped to 2.3.0.0.
- - s6
+
- s6
dependency bumped to 2.5.0.0.
- s6-rc commands taking a lock on the live directory or the
service database now fail instantly if the lock is already held.
@@ -47,29 +47,29 @@ lock is released" behaviour.
in 0.1.0.0
in 0.0.3.0
in 0.0.2.1
- - s6
+
- s6
dependency bumped to 2.2.4.2.
@@ -78,22 +78,22 @@ dependency bumped to 2.2.4.2.
in 0.0.1.5
@@ -114,22 +114,22 @@ dependency bumped to 2.2.3.1.
in 0.0.1.1
diff --git a/doc/why.html b/doc/why.html
index 775f81d..157a27e 100644
--- a/doc/why.html
+++ b/doc/why.html
@@ -6,14 +6,14 @@
s6-rc: why?
-
+
s6-rc
-Software
-skarnet.org
+Software
+skarnet.org
Why s6-rc ?
@@ -22,7 +22,7 @@
Supervision suites such as
-s6,
+s6,
runit,
perp or
daemontools
@@ -32,7 +32,7 @@ way in a controlled environment and keep it alive if it dies;
they also provide daemon management tools to, among others,
send signals to the daemon without knowing its PID. They can
control individual long-lived processes perfectly well, and
-s6 also provides
+s6 also provides
tools to manage a whole supervision tree. To any system administrator
concerned about reliability, supervision suites are a good thing.
@@ -132,7 +132,7 @@ oneshots or longruns, one by one, even when the dependency graph says
that some services could be started in parallel. Also, the daemons
they start are always unsupervised, even when the underlying init
system provides supervision features. There usually is no
-readiness
+readiness
notification support on daemons either, daemons are fire-and-forget
(but that's more on the
scripts themselves than on the frameworks). Another common criticism
@@ -195,7 +195,7 @@ guys.
- systemd,
the main protagonist (or antagonist) in the "init wars". It has the same
problems as launchd, up by an order of magnitude;
-here is why.
+here is why.
systemd avowedly aims to replace the whole low-level user-space of
Linux systems, but its design is horrendous. It doesn't even
get readiness notification right.
@@ -246,16 +246,16 @@ readiness notification support, reproducible script execution, and
sysv-rc or OpenRC. It is not an init system.
You can run s6-rc with any init system of your choosing.
Of course, s6-rc requires a
-s6 supervision tree to be running on
+s6 supervision tree to be running on
the system, since it delegates the management of longrun services
to that supervision tree, but it does not require that s6 be the
init system itself. s6-rc will work
-when s6-svscan
+when s6-svscan
runs as process 1 (on Linux, such a setup can be easily achieved
via the help of the
-s6-linux-init
+s6-linux-init
package), and it will also work
-when
+when
s6-svscan runs under another init process.
- The service manager runs on top of a supervision
suite. It does not try to make it perform boot/shutdown operations or
@@ -277,7 +277,7 @@ simple, in order to allow external tools to automatically write
service definitions for s6-rc - for instance for conversions between
service manager formats.
- Like every
-skarnet.org tool, s6-rc
+skarnet.org tool, s6-rc
is made of very little code, that does its job and nothing else.
The binaries are small, it is very light in memory usage, and the
code paths are extremely short.
--
cgit v1.2.3