diff options
| author | Laurent Bercot <ska-skaware@skarnet.org> | 2026-06-04 09:47:23 +0000 |
|---|---|---|
| committer | Laurent Bercot <ska-skaware@skarnet.org> | 2026-06-04 09:47:23 +0000 |
| commit | af9550cfe7ea35590d9c8e246ebeaa32f6469966 (patch) | |
| tree | 22063e47aa79f0b437274f10b84d7efaca87c682 /doc | |
| parent | 270fbc30f23b8153f0b618728d8145d636acdfef (diff) | |
| download | s6-af9550cfe7ea35590d9c8e246ebeaa32f6469966.tar.gz | |
Prepare for 2.15.1.0; add s6-svscanboot
Also fix links on why.html. s6-svscanboot doc coming soon.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/index.html | 7 | ||||
| -rw-r--r-- | doc/overview.html | 12 | ||||
| -rw-r--r-- | doc/s6-svscan-not-1.html | 18 | ||||
| -rw-r--r-- | doc/s6-svscan.html | 2 | ||||
| -rw-r--r-- | doc/upgrade.html | 5 | ||||
| -rw-r--r-- | doc/why.html | 6 |
6 files changed, 30 insertions, 20 deletions
diff --git a/doc/index.html b/doc/index.html index 53d0b49..d9b8918 100644 --- a/doc/index.html +++ b/doc/index.html @@ -89,7 +89,7 @@ requirement if you link against the shared version of the skalibs library. </li> <li> (Optional, but really recommended for full functionality): <a href="//skarnet.org/software/execline/">execline</a> version -2.9.9.1 or later. When s6 is built with execline support (which is the default), +2.9.9.2 or later. When s6 is built with execline support (which is the default), execline is a build-time requirement, and also a run-time requirement for certain binaries that spawn scripts interpreted with <a href="//skarnet.org/software/execline/execlineb.html">execlineb</a>. </li> @@ -116,8 +116,8 @@ want nsswitch-like functionality: <h3> Download </h3> <ul> - <li> The current released version of s6 is <a href="s6-2.15.0.1.tar.gz">2.15.0.1</a>. -You can access its checksum <a href="s6-2.15.0.1.tar.gz.sha256">here</a>. </li> + <li> The current released version of s6 is <a href="s6-2.15.1.0.tar.gz">2.15.1.0</a>. +You can access its checksum <a href="s6-2.15.1.0.tar.gz.sha256">here</a>. </li> <li> Alternatively, you can checkout a copy of the <a href="//git.skarnet.org/cgi-bin/cgit.cgi/s6/">s6 git repository</a>: @@ -175,6 +175,7 @@ a user interface to control those processes and monitor service states. <li><a href="s6-svscanctl.html">The <tt>s6-svscanctl</tt> program</a></li> <li><a href="s6-supervise.html">The <tt>s6-supervise</tt> program</a></li> <li><a href="s6-svc.html">The <tt>s6-svc</tt> program</a></li> +<li><a href="s6-svscanboot.html">The <tt>s6-svscanboot</tt> program</a></li> <li><a href="s6-svok.html">The <tt>s6-svok</tt> program</a></li> <li><a href="s6-svstat.html">The <tt>s6-svstat</tt> program</a></li> <li><a href="s6-svperms.html">The <tt>s6-svperms</tt> program</a></li> diff --git a/doc/overview.html b/doc/overview.html index 164cffd..599ca4f 100644 --- a/doc/overview.html +++ b/doc/overview.html @@ -219,7 +219,17 @@ context entirely. </li> on an empty scan directory, then populate it step by step and send an update command to s6-svscan via <a href="s6-svscanctl.html">s6-svscanctl</a> whenever the supervision -tree should pick up the differences and start the services you added. </li> +tree should pick up the differences and start the services you added. + <ul> + <li> If you're running Linux and want the smallest possible amount +of overhead, you should check the +<a href="//skarnet.org/software/s6-linux-init/">s6-linux-init</a> companion +package, which will start <a href="s6-svscan.html">s6-svscan</a> as process +1 for you, no need for another initialization system. </li> + <li> If you have an init system you're happy with and just want to run +a self-sufficient supervision tree, the +<a href="s6-svscanboot.html">s6-svscanboot</a> program is a good option. </li> + </ul> </li> <li> That's it, your services are running. To control them manually, you can use the <a href="s6-svc.html">s6-svc</a> command. </li> <li> At the end of the system's lifetime, you can use diff --git a/doc/s6-svscan-not-1.html b/doc/s6-svscan-not-1.html index 163b792..632dab2 100644 --- a/doc/s6-svscan-not-1.html +++ b/doc/s6-svscan-not-1.html @@ -50,17 +50,15 @@ of by the logging tools. </li> <li> You can use a trick similar to the <a href="s6-svscan-1.html#log">process 1 output logging trick</a> so the supervision tree's messages are logged via a service that's maintained by the supervision tree itself. Then your init -system should not launch s6-svscan directly, but a wrapper script that performs -the proper redirections. The -<tt>examples/s6-svscanboot</tt> file in the s6 distribution gives an example of -such a script. Make sure that your initial <a href="scandir.html">scan -directory</a> contains a <a href="servicedir.html">service directory</a> for your -initial logging service, that must read on the logging FIFO. </li> +system should not launch s6-svscan directly, but a wrapper script, or a binary, + that performs the proper redirections. The +<a href="s6-svscanboot.html">s6-svscanboot</a> binary is an example of such +a program, and it is recommended that you use it. </li> </ul> <p> In some of the following examples, we'll assume that <tt>/command/s6-svscanboot</tt> -is the name of the script you are using to start s6-svscan. We will also assume +is the name of the program you are using to start s6-svscan. We will also assume that all of the s6 executables are available through the <tt>/command</tt> path. Adjust this accordingly. </p> @@ -76,7 +74,7 @@ config file with <tt>telinit q</tt>. <h3> Example </h3> -<pre> SV:123456:respawn:/command/s6-svscanboot </pre> +<pre>SV:123456:respawn:/command/s6-svscanboot -c /dev/console /run/service</pre> <a name="upstart"> @@ -97,7 +95,7 @@ stop on runlevel [!2345] oom never respawn -exec /command/s6-svscanboot +exec /command/s6-svscanboot -c /dev/console /run/service </pre> <a name="systemd"> @@ -149,7 +147,7 @@ file with <tt>kill -s HUP 1</tt>. <h3> Example </h3> -<pre> sv /command/s6-svscanboot "" on </pre> +<pre> sv "/command/s6-svscanboot -c /dev/console /run/service" "" on </pre> <a name="launchd"> <h2> MacOS launchd </h2> diff --git a/doc/s6-svscan.html b/doc/s6-svscan.html index 5a09527..fc50f60 100644 --- a/doc/s6-svscan.html +++ b/doc/s6-svscan.html @@ -28,7 +28,7 @@ the root or a branch of a <em>supervision tree</em>. <h2> Interface </h2> <pre> - s6-svscan [ -d <em>notif</em> ] [ -X <em>consoleholder</em> ] [ -C services_max ] [ -L name_max ] [ -t <em>rescan</em> ] <em>scandir</em> + s6-svscan [ -d <em>notif</em> ] [ -X <em>consoleholder</em> ] [ -C <em>services_max</em> ] [ -L <em>name_max</em> ] [ -t <em>rescan</em> ] <em>scandir</em> </pre> <ul> diff --git a/doc/upgrade.html b/doc/upgrade.html index e8cf485..43bd3f4 100644 --- a/doc/upgrade.html +++ b/doc/upgrade.html @@ -19,13 +19,14 @@ <h1> What has changed in s6 </h1> -<h2> in 2.15.0.1 </h2> +<h2> in 2.15.1.0 </h2> <ul> <li> <a href="//skarnet.org/software/skalibs/">skalibs</a> dependency bumped to 2.15.0.1. </li> <li> <a href="//skarnet.org/software/execline/">execline</a> -recommended dependency bumped to 2.9.9.1. </li> +recommended dependency bumped to 2.9.9.2. </li> + <li> New <a href="s6-svscanboot.html">s6-svscanboot</a> binary. </li> </ul> <h2> in 2.15.0.0 </h2> diff --git a/doc/why.html b/doc/why.html index bfb4b13..c75dda0 100644 --- a/doc/why.html +++ b/doc/why.html @@ -32,9 +32,9 @@ developers is using <tt>/etc/ttys</tt> to this purpose, so I won't consider BSD <li> <a href="http://smarden.org/runit/">runit</a>, Gerrit Pape's suite, well-integrated with Debian </li> <li> <a href="http://b0llix.net/perp/">perp</a>, Wayne Marshall's take on supervision </li> <li> Integrated init systems providing a lot of features, process supervision being one of them. -For instance, <a href="https://upstart.ubuntu.com/">Upstart</a>, MacOS X's -<a href="https://developer.apple.com/library/mac/#documentation/Darwin/Reference/ManPages/man8/launchd.8.html">launchd</a>, -and Fedora's <a href="https://freedesktop.org/wiki/Software/systemd">systemd</a>. </li> +For instance, <a href="https://wiki.ubuntu.com/Upstart">Upstart</a>, MacOS X's +<a href="https://www.launchd.info/">launchd</a>, +and Fedora's <a href="https://systemd.io/">systemd</a>. </li> </ul> <p> |
