diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/index.html | 18 | ||||
| -rw-r--r-- | doc/overview.html | 12 | ||||
| -rw-r--r-- | doc/s6-linux-init-logouthookd.html | 2 | ||||
| -rw-r--r-- | doc/s6-linux-init-maker.html | 7 | ||||
| -rw-r--r-- | doc/s6-linux-init-shutdownd.html | 6 | ||||
| -rw-r--r-- | doc/s6-linux-init.html | 4 | ||||
| -rw-r--r-- | doc/why.html | 2 |
7 files changed, 26 insertions, 25 deletions
diff --git a/doc/index.html b/doc/index.html index 1b4dda6..a428ccf 100644 --- a/doc/index.html +++ b/doc/index.html @@ -20,7 +20,7 @@ <h2> What is it ? </h2> <p> - s6-linux-init is a set of minimalistic tools to create a + s6-linux-init is a set of minimalistic tools used to create a <a href="//skarnet.org/software/s6/">s6</a>-based init system, including a <tt>/sbin/init</tt> binary, on a Linux kernel. </p> @@ -54,20 +54,12 @@ kernel command line </li> <a href="http://refspecs.linuxbase.org/LSB_3.0.0/LSB-PDA/LSB-PDA/shutdown.html">LSB specification</a> </li> </ul> -<h2> Getting started </h2> - -<p> - Please read the documentation for the -<a href="s6-linux-init-maker.html">s6-linux-init-maker</a> program -carefully, but if you're impatient, you can also read this -<a href="quickstart.html">quickstart guide</a>. -</p> - <hr /> <ul> <li> <a href="why.html">Why</a> s6-linux-init ? </li> <li> <a href="overview.html">An overview</a> of s6-linux-init </li> + <li> <a href="quickstart.html">A quickstart guide</a> for the impatient </li> </ul> <hr /> @@ -168,7 +160,7 @@ the previous versions of s6-linux-init and the current one. </li> <li><a href="s6-linux-init-shutdownd.html">The <tt>s6-linux-init-shutdownd</tt> program</a></li> <li><a href="s6-linux-init-telinit.html">The <tt>s6-linux-init-telinit</tt> program</a></li> <li><a href="s6-linux-init-logouthookd.html">The <tt>s6-linux-init-logouthookd</tt> program</a></li> -<li><a href="s6-linux-init-echo.html">The <tt>s6-linux-init-umountall</tt> program</a></li> +<li><a href="s6-linux-init-echo.html">The <tt>s6-linux-init-echo</tt> program</a></li> <li><a href="s6-linux-init-umountall.html">The <tt>s6-linux-init-umountall</tt> program</a></li> </ul> @@ -176,7 +168,9 @@ the previous versions of s6-linux-init and the current one. </li> <ul> <li> <tt>s6-linux-init</tt> is discussed on the -<a href="//skarnet.org/lists.html#skaware">skaware</a> mailing-list. </li> +<a href="//skarnet.org/lists.html#skaware">skaware</a> and +<a href="//skarnet.org/lists.html#supervision">supervision</a> +mailing-lists. </li> <li> There is a <tt>#s6</tt> IRC channel on Freenode. Sometimes people are there and even answer questions. </li> </ul> diff --git a/doc/overview.html b/doc/overview.html index e1f3b31..8f19bcd 100644 --- a/doc/overview.html +++ b/doc/overview.html @@ -26,16 +26,16 @@ following: </p> <ul> - <li> <em>Binaries</em>, that are typically installed in <tt>/bin</tt> + <li> <em>Binaries</em>, that are typically installed in <tt>/bin</tt>: <ul> <li> <a href="s6-linux-init-maker.html">s6-linux-init-maker</a> is the main program of the package and is used to create <tt>/sbin/init</tt> scripts and their supporting environment depending on configuration parameters given on its command line. </li> <li> <a href="s6-linux-init-hpr.html">s6-linux-init-hpr</a> is an -implementation of the sysv <tt>halt</tt>, <tt>poweroff</tt> and <tt>reboot</tt> +implementation of the SysV <tt>halt</tt>, <tt>poweroff</tt> and <tt>reboot</tt> commands; <a href="s6-linux-init-telinit.html">s6-linux-init-telinit</a> -is an implementation of the sysv <tt>telinit</tt> command; and +is an implementation of the SysV <tt>telinit</tt> command; and <a href="s6-linux-init-shutdown.html">s6-linux-init-shutdown</a> is an implementation of the <a href="http://refspecs.linuxbase.org/LSB_3.0.0/LSB-PDA/LSB-PDA/shutdown.html">shutdown</a> @@ -44,8 +44,8 @@ implementation of stage 1 <tt>/sbin/init</tt>, but it needs to be given command-line options in order to do what the user has chosen. An invocation of <a href="s6-linux-init-maker.html">s6-linux-init-maker</a> will create proper wrappers for all those commands, named after their -short sysv names; the wrappers are directly usable as turnkey replacements -for sysv commands. </li> +short SysV names; the wrappers are directly usable as turnkey replacements +for SysV commands. </li> <li> Other binaries are support binaries, not meant to be called directly by the user. They are called internally, in scripts created by a @@ -63,7 +63,7 @@ page for details. </li> <p /> <li> <em>Skeleton scripts</em>, installed by default in <tt>/etc/s6-linux-init/skel</tt>; that location can be changed at build time via the <tt>--skeldir</tt> configure option. At -<tt>s6-linux-init-maker</tt>, the scripts are copied from the skeleton +<tt>s6-linux-init-maker</tt> invocation time, the scripts are copied from the skeleton directory to the <tt>scripts</tt> subdirectory of the directory created by <tt>s6-linux-init-maker</tt>, and the copy is meant to be edited by the user. The skeleton scripts are commented and examples of diff --git a/doc/s6-linux-init-logouthookd.html b/doc/s6-linux-init-logouthookd.html index 34f5bd8..51edca1 100644 --- a/doc/s6-linux-init-logouthookd.html +++ b/doc/s6-linux-init-logouthookd.html @@ -76,7 +76,7 @@ and when it happens, the user's utmp record will automatically be cleaned up. <li> The <a href="//skarnet.org/software/s6/localservice.html">local service</a> implementing logouthook support is automatically created at boot time when the <tt>-L</tt> option has been given to -<a href="s6-linux-init-maker">s6-linux-init-maker</a>. Client-side, though, +<a href="s6-linux-init-maker.html">s6-linux-init-maker</a>. Client-side, though, the various login programs must be patched at the source level. </li> </ul> diff --git a/doc/s6-linux-init-maker.html b/doc/s6-linux-init-maker.html index 45284ab..161ce6b 100644 --- a/doc/s6-linux-init-maker.html +++ b/doc/s6-linux-init-maker.html @@ -358,6 +358,13 @@ other machines is not supported. </p> <p> + After booting, <em>basedir</em> should remain untouched during the +lifetime of the machine, because the machine state change and shutdown +procedures will look for data in <em>basedir</em>. New invocations of +<tt>s6-linux-init-maker</tt> should use a different <em>basedir</em>. +</p> + +<p> The difficult parts of <a href="//skarnet.org/software/s6/s6-svscan-1.html">running s6-svscan as process 1</a> are: diff --git a/doc/s6-linux-init-shutdownd.html b/doc/s6-linux-init-shutdownd.html index f4cf8a0..c601466 100644 --- a/doc/s6-linux-init-shutdownd.html +++ b/doc/s6-linux-init-shutdownd.html @@ -42,7 +42,7 @@ created the shutdownd service. </li> <li> When this script exits, <tt>s6-linux-init-shutdownd</tt> kills all processes, first with a SIGTERM, then (after the grace time specified by the shutdown command) with a SIGKILL. </li> - <li> It then runs the automatically-generated <em>stage 4</em> script, + <li> It then runs an automatically-generated script (called <em>stage 4</em>), which unmounts the file systems and halts, powers off or reboots the machine. </li> </ul> @@ -58,8 +58,8 @@ machine. </li> <ul> <li> <tt>-c <em>basedir</em></tt> : look for the -<em>stage3</em> and <em>stage4</em> scripts in the <em>basedir</em> -directory. Default is <tt>/etc/s6-linux-init</tt>. </li> +<em>rc.shutdown</em> script in the <em>basedir</em><tt>/scripts</tt> +directory. Default is <tt>/etc/s6-linux-init/current</tt>. </li> <li> <tt>-g <em>gracetime</em></tt> : if the shutdown command does not specify a grace time between the SIGTERM and the SIGKILL, use <em>gracetime</em> milliseconds. Default is 3000. </li> diff --git a/doc/s6-linux-init.html b/doc/s6-linux-init.html index a4bb636..e8ab361 100644 --- a/doc/s6-linux-init.html +++ b/doc/s6-linux-init.html @@ -106,14 +106,14 @@ it uses <em>initdefault</em>. </li> </ul> </li> <li> It also makes the catch-all logger's fifo its stderr. </li> <li> It execs into <a href="//skarnet.org/software/s6/s6-svscan.html">s6-svscan</a> -with <tt>/run/service</tt> as its scandir (or <em>tmpfsdir</em>/service) </li>. +with <tt>/run/service</tt> as its scandir (or <em>tmpfsdir</em>/service). </li> <ul> <li> <a href="//skarnet.org/software/s6/s6-svscan.html">s6-svscan</a> spawns the early services that are defined in <tt><em>basedir</em>/run-image/service</tt>, and have been copied into <tt>/run/service</tt> (or <em>tmpfsdir</em>/service). </li> <li> One of those early services is <tt>s6-svscan-log</tt>, which is -the catch-all logger. When this service is up, <tt>s6-linux-init<tt>'s +the catch-all logger. When this service is up, <tt>s6-linux-init</tt>'s child unblocks. </li> <li> The child execs into <tt><em>basedir</em>/scripts/rc.init</tt>. The first argument to <em>rc.init</em> is the chosen runlevel. The kernel diff --git a/doc/why.html b/doc/why.html index 2c200c5..43c7f84 100644 --- a/doc/why.html +++ b/doc/why.html @@ -52,7 +52,7 @@ package. </li> <p> As explained in <a href="https://archive.fosdem.org/2017/schedule/event/s6_supervision/">this -presentation"></a>, an init system is made of four parts: +presentation</a>, an init system is made of four parts: </p> <ol> |