From c67342094a0192419f5160f7e9f2d8babd9f477b Mon Sep 17 00:00:00 2001
From: Laurent Bercot
Date: Tue, 23 May 2017 11:04:33 +0000
Subject: Switch doc to schemeless URLs
---
doc/index.html | 20 +++++++--------
doc/quickstart.html | 18 ++++++-------
doc/s6-halt.html | 6 ++---
doc/s6-linux-init-maker.html | 60 ++++++++++++++++++++++----------------------
doc/s6-poweroff.html | 6 ++---
doc/s6-reboot.html | 6 ++---
doc/upgrade.html | 54 +++++++++++++++++++--------------------
7 files changed, 85 insertions(+), 85 deletions(-)
diff --git a/doc/index.html b/doc/index.html
index 1669b07..94a9523 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -6,13 +6,13 @@
s6-linux-init - tools for a Linux init system
-
+
-Software
-skarnet.org
+Software
+skarnet.org
s6-linux-init
@@ -21,7 +21,7 @@
s6-linux-init is a set of minimalistic tools to create a
-s6-based init
+s6-based init
system, including a /sbin/init binary, on a Linux kernel.
@@ -49,15 +49,15 @@ a small FAQ.
@@ -132,7 +132,7 @@ the previous versions of s6-linux-init and the current one.
- s6-linux-init is discussed on the
-skaware mailing-list.
+skaware mailing-list.
- There is a #s6 IRC channel on Freenode. Sometimes people
are there and even answer questions.
diff --git a/doc/quickstart.html b/doc/quickstart.html
index dac9779..619fbbd 100644
--- a/doc/quickstart.html
+++ b/doc/quickstart.html
@@ -6,14 +6,14 @@
s6-linux-init: quickstart and FAQ
-
+
s6-linux-init
-Software
-skarnet.org
+Software
+skarnet.org
Quickstart and FAQ for s6-linux-init
@@ -23,11 +23,11 @@
- Install all the s6-linux-init dependencies:
- Install s6-linux-init itself
- Save your old /sbin/init binary
@@ -37,7 +37,7 @@
a machine shutdown script in /etc/rc.shutdown. Make them executable.
- If, at shutdown time, you need to run a script before the
supervision tree is torn down (for instance if you're using
-s6-rc and want to
+s6-rc and want to
cleanly stop all your services), write that script in
/etc/rc.tini.
- Check that your devtmpfs is automounted by your kernel at boot time. If it is not,
diff --git a/doc/s6-halt.html b/doc/s6-halt.html
index b6a326c..6f2a30e 100644
--- a/doc/s6-halt.html
+++ b/doc/s6-halt.html
@@ -6,14 +6,14 @@
s6-linux-init: the s6-halt program
-
+
s6-linux-init
-Software
-skarnet.org
+Software
+skarnet.org
The s6-halt program
diff --git a/doc/s6-linux-init-maker.html b/doc/s6-linux-init-maker.html
index 1960563..b7648ed 100644
--- a/doc/s6-linux-init-maker.html
+++ b/doc/s6-linux-init-maker.html
@@ -6,14 +6,14 @@
s6-linux-init: the s6-linux-init-maker program
-
+
s6-linux-init
-Software
-skarnet.org
+Software
+skarnet.org
The s6-linux-init-maker program
@@ -24,7 +24,7 @@ the command line, and outputs a directory to place in the
root filesystem. That directory contains a script suitable
as an init program, as well as support file hierarchies to
get a complete
-s6
+s6
infrastructure running when the system is booted on that
script.
@@ -33,8 +33,8 @@ script.
s6-linux-init-maker only writes scripts. At boot time, these
scripts will call commands provided by other skarnet.org packages
such as
-execline or
-s6. It is the
+execline or
+s6. It is the
responsibility of the administrator to make sure that all the
dependencies are properly installed at boot time, and that the
correct options have been given to s6-linux-init-maker so that
@@ -81,7 +81,7 @@ or its contents.
declared as basedir. Be careful: it contains fifos, files with
precise uid/gid permissions, and files with non-standard access rights,
so be sure to copy it verbatim. The
-s6-hiercopy
+s6-hiercopy
tool can do it, as well as the GNU or busybox cp -a or mv commands.
@@ -102,9 +102,9 @@ also known as stage 1. and this is what happens:
- stage 1 is an
-execline script, so
+execline script, so
the first process run by the kernel is the
-execlineb
+execlineb
program launcher.
- stage 1 mounts a
tmpfs
@@ -113,17 +113,17 @@ filesystem on tmpfsdir.
tmpfsdir.
- stage 1 empties its environment, then reads a global set of environment variables from the
basedir/env
-environment directory.
+environment directory.
- stage 1 forks a child that will block until
-s6-svscan is running.
+s6-svscan is running.
- stage 1 executes, as process 1, into
-s6-svscan,
+s6-svscan,
with tmpfsdir/service as a
-scan directory.
+scan directory.
- This scan directory already contains at least one service, which is the
catch-all logger: error messages from the supervision tree, and
from services that do not have a dedicated logger, are handled by a
-special s6-log
+special s6-log
instance and made available in tmpfsdir/uncaught-logs
instead of clogging the system console.
- If the -G option has been given to s6-linux-init-maker, the
@@ -150,10 +150,10 @@ to the catch-all logger, depending on the -r option.
- Depending on the kernel boot command line, the root filesystem
may be in read-only mode.
- There is a tmpfs available for root only in tmpfsdir.
- - s6-svscan
+
- s6-svscan
is running as process 1. At any time, it is possible to make it supervise a long-lived
process by linking the appropriate
-service directory
+service directory
into tmpfsdir/service, then running the command
s6-svscanctl -a tmpfsdir/service. Services without a
dedicated logger will send their output to the catch-all logger.
@@ -181,7 +181,7 @@ real machine and service initialization should happen in stage2.
s6-reboot commands.
- Those commands send a signal to the
-s6-svscan
+s6-svscan
process running as pid 1; this signal is caught and s6-svscan runs the
corresponding "signal handler" script that has been placed by
s6-linux-init-maker into the
@@ -194,13 +194,13 @@ must have been written by the administrator. The purpose of
while the supervision tree is still alive. Typically, when using a
service manager, stage2_finish would tell the service manager
to bring all services down. When using
-s6-rc, a typical
+s6-rc, a typical
stage2_finish script just contains s6-rc -da change.
More generally speaking, stage2_finish should undo what
stage2 has done at boot time.
- The "signal handler" script then tells s6-svscan to exit via an
-appropriate s6-svscanctl
+appropriate s6-svscanctl
command: s6-svscan then executes into the stage3 script, which, like
stage2 and stage2_finish, is the responsibility of the
administrator. When stage3 runs, the machine is in the following
@@ -209,11 +209,11 @@ state:
- The supervision tree has been torn down: it is not operational
anymore. (So, commands such as
-s6-rc, which
+s6-rc, which
require a live supervision tree, will not work.)
- stage3 runs as process 1. Doing so makes it easier to recover
after killing all processes by kill -9 -1 or
-s6-nuke.
+s6-nuke.
- Its working directory is / and its stdin is /dev/null
- Its stdout and stderr are both /dev/console
- Depending on the exact configuration and what the administrator has
@@ -237,7 +237,7 @@ contains an example of /etc/rc.init, /etc/rc.tini
and /etc/rc.shutdown scripts, suitable for
stage2, stage2_finish and stage3
respectively. Those scripts can practically be used as is if the machine
-is managed by the s6-rc
+is managed by the s6-rc
service manager.
@@ -260,7 +260,7 @@ the root filesystem, and be empty. tmpfsdir must be absolute. Default i
- -b execline_bindir : init is run by the kernel
without a PATH, and since it is a script, it is necessary to tell it where
to find the
-execlineb
+execlineb
launcher and the first few early commands before PATH can be set.
execline_bindir is the location where the execline binaries can be
found. It must be absolute. Default is
@@ -323,10 +323,10 @@ It must be absolute. Default is
set the PATH environment variable to, for all the starting processes.
This will be done as early as possible in stage 1. It is
absolutely necessary for
-execline,
-s6,
-s6-portable-utils and
-s6-linux-utils
+execline,
+s6,
+s6-portable-utils and
+s6-linux-utils
binaries to be accessible via initial_path, else the machine
will not boot. Default is
/usr/bin:/bin.
@@ -359,7 +359,7 @@ into the whole process tree. However, sometimes those variables are
needed at a later time; in that case, giving the -s option
to s6-linux-init-maker makes stage 1 init dump the "kernel" environment
variables into the env_store directory, via the
-s6-dumpenv
+s6-dumpenv
program, before erasing them. env_store should obviously be
a writable directory, so it should be located under tmpfsdir!
If this option is not given (which is the default), the environment
@@ -380,7 +380,7 @@ the global environment.
The difficult parts of
-running
+running
s6-svscan as process 1 are:
@@ -404,7 +404,7 @@ virtual machine, a container, or anything similar that does not
have the /dev/console issue or the read-only rootfs issue,
you will probably not reap much benefit from using s6-linux-init-maker:
you could probably invoke
-s6-svscan
+s6-svscan
directly as your process 1, or build a script by hand, which
would result in a simpler init with less dependencies.
diff --git a/doc/s6-poweroff.html b/doc/s6-poweroff.html
index 9a268af..e215c38 100644
--- a/doc/s6-poweroff.html
+++ b/doc/s6-poweroff.html
@@ -6,14 +6,14 @@
s6-linux-init: the s6-poweroff program
-
+
s6-linux-init
-Software
-skarnet.org
+Software
+skarnet.org
The s6-poweroff program
diff --git a/doc/s6-reboot.html b/doc/s6-reboot.html
index e116235..16043c5 100644
--- a/doc/s6-reboot.html
+++ b/doc/s6-reboot.html
@@ -6,14 +6,14 @@
s6-linux-init: the s6-reboot program
-
+
s6-linux-init
-Software
-skarnet.org
+Software
+skarnet.org
The s6-reboot program
diff --git a/doc/upgrade.html b/doc/upgrade.html
index 08b9e43..8108b4d 100644
--- a/doc/upgrade.html
+++ b/doc/upgrade.html
@@ -6,14 +6,14 @@
s6-linux-init: how to upgrade
-
+
s6-linux-init
-Software
-skarnet.org
+Software
+skarnet.org
What has changed in s6-linux-init
@@ -21,35 +21,35 @@
in 0.3.0.0
in 0.2.0.0