Document -V option to s6-l-i-m

Signed-off-by: Laurent Bercot <ska@appnovation.com>

1 files changed, 26 insertions, 19 deletions

diff --git a/doc/s6-linux-init-maker.html b/doc/s6-linux-init-maker.html
index 802d8f9..afbe8cd 100644
--- a/doc/s6-linux-init-maker.html
+++ b/doc/s6-linux-init-maker.html
@@ -46,6 +46,7 @@ machine</em>. If it is not the case, the system will fail to boot.
 
 <pre>
      s6-linux-init-maker \
+       [ -V <em>boot_verbosity</em> ] \
        [ -c <em>basedir</em> ] \
        [ -u <em>log_user</em> ] \
        [ -G <em>early_getty</em> ] \
@@ -162,17 +163,23 @@ exactly what it does.
 <h2> s6-linux-init-maker options </h2>
 
 <ul>
+ <li> <tt>-V</tt>&nbsp;<em>boot_verbosity</em>&nbsp;: how
+verbose the boot will be. Default is <strong><tt>1</tt></strong>,
+which means that only important warnings will be printed. Increasing
+this value may yield more, but usually harmless, warning messages. </li> <br>
+
+
  <li> <tt>-c</tt>&nbsp;<em>basedir</em>&nbsp;: at boot time, <em>stage 1</em>,
 which should be accessible as <tt><em>basedir</em>/init</tt>,
 will read its read-only data from <em>basedir</em>. After running
 <tt>s6-linux-init-maker</tt>, you should make sure to copy the
 created directory <em>dir</em> to <em>basedir</em>. <em>basedir</em>
 must be absolute. Default is
-<strong><tt>/etc/s6-linux-init/current</tt></strong>. </li> <br />
+<strong><tt>/etc/s6-linux-init/current</tt></strong>. </li> <br>
 
  <li> <tt>-u</tt>&nbsp;<em>log_user</em>&nbsp;: the catch-all
 logger will run as the <em>log_user</em> user. Default is
-<strong><tt>root</tt></strong>. </li> <br />
+<strong><tt>root</tt></strong>. </li> <br>
 
  <li> <tt>-G</tt>&nbsp;<em>early_getty</em>&nbsp;: if this option
 is set, <tt>s6-linux-init-maker</tt> will define an additional s6 service
@@ -181,7 +188,7 @@ at the same time <em>rc.init</em> is executed. This early service
 should be a getty, or equivalent, to allow logins even if <em>stage2</em> fails.
 <em>early_getty</em> should be a simple command line: for instance,
 <tt>"/sbin/getty 38400 tty1"</tt>. By default, no early service
-is defined. </li> <br />
+is defined. </li> <br>
 
  <li> <tt>-1</tt>&nbsp;: make it so that all the messages that are
 sent to the catch-all logger (i.e. all the error messages that are not
@@ -192,12 +199,12 @@ copied to <tt>/dev/console</tt>.) This is generally useful to
 debug a system at a glance, but if a failing program keeps sending
 error messages, it may interfere with comfortable usage of an early
 getty. A common workaround is to make the early getty start on
-<tt>tty2</tt> and leave tty1 for <tt>/dev/console</tt> to print on. </li> <br />
+<tt>tty2</tt> and leave tty1 for <tt>/dev/console</tt> to print on. </li> <br>
 
  <li> <tt>-L</tt>&nbsp;: add an early <tt>s6-linux-init-logouthookd</tt>
 service to clean up utmp records at user logout time. Check the
 <a href="s6-linux-init-logouthookd.html">s6-linux-init-logouthookd</a> page
-for details. </li> <br />
+for details. </li> <br>
 
  <li> <tt>-p</tt>&nbsp;<em>initial_path</em>&nbsp;: the initial value
 for the PATH environment variable, that will be transmitted to all the
@@ -208,11 +215,11 @@ It is absolutely necessary for
 <a href="//skarnet.org/software/s6/">s6</a>
 binaries to be accessible via <em>initial_path</em>, else the machine
 will not boot. Default is
-<strong><tt>/usr/bin:/bin</tt></strong>. </li> <br />
+<strong><tt>/usr/bin:/bin</tt></strong>. </li> <br>
 
  <li> <tt>-m</tt>&nbsp;<em>initial_umask</em>&nbsp;: the value of
 the initial file umask for all the starting processes, in octal.
-Default is <strong><tt>022</tt></strong>. </li> <br />
+Default is <strong><tt>022</tt></strong>. </li> <br>
 
  <li> <tt>-t</tt>&nbsp;<em>timestamp_style</em>&nbsp;: how
 logs are timestamped by the catch-all logger. 0 means no
@@ -221,7 +228,7 @@ timestamp, 1 means
 2 means
 <a href="https://www.iso.org/iso/home/standards/iso8601.htm">ISO 8601 format</a>,
 and 3 means both. Default is
-<strong><tt>1</tt></strong>. </li> <br />
+<strong><tt>1</tt></strong>. </li> <br>
 
  <li> <tt>-d</tt>&nbsp;<em>slashdev</em>&nbsp;: mount a devtmpfs.
 If this option is given, <a href="s6-linux-init.html">s6-linux-init</a>
@@ -229,7 +236,7 @@ will mount a devtmpfs pseudo-filesystem on <em>slashdev</em>. This
 is useful if the kernel has not been configured to mount
 the devtmpfs at boot time and there is no static <tt>/dev</tt>.
 By default, it is assumed that there is a suitable <tt>/dev</tt>
-at boot time, and no additional devtmpfs is mounted. </li> <br />
+at boot time, and no additional devtmpfs is mounted. </li> <br>
 
  <li> <tt>-s</tt>&nbsp;<em>env_store</em>&nbsp;: stage 1 init sometimes
 inherits a few environment variables from the kernel. (These variables
@@ -247,7 +254,7 @@ before erasing them. <em>env_store</em> should obviously be
 a writable directory, so it should be located under <tt>/run</tt>
 (or your chosen tmpfsdir)!
 If this option is not given, the environment inherited from the kernel
-isn't saved anywhere - which is the default. </li> <br />
+isn't saved anywhere - which is the default. </li> <br>
 
  <li> <tt>-e</tt>&nbsp;<em>initial_envvar</em>&nbsp;: this option
 can be repeated. For every <em>initial_envvar</em>, <tt>s6-linux-init-maker</tt>
@@ -261,7 +268,7 @@ process (as well as the <em>rc.init</em> script) will run with,
 so it will be inherited by default by every process running on
 the system.
 The TZ variable, for instance, is a good candidate to be set in
-the global environment. </li> <br />
+the global environment. </li> <br>
 
  <li> <tt>-q</tt>&nbsp;<em>finalsleeptime</em>&nbsp;: when the machine
 shuts down, all processes that have not already been killed during
@@ -270,7 +277,7 @@ them to exit gracefully; then, after <em>finalsleeptime</em>
 milliseconds, they will receive a SIGKILL and the shutdown sequence
 will go on. This option configures the amount of time that will
 elapse between the SIGTERM/SIGHUP and the SIGKILL.
-Default is <strong>3000</strong>, meaning a grace period of 3 seconds. </li> <br />
+Default is <strong>3000</strong>, meaning a grace period of 3 seconds. </li> <br>
 
  <li> <tt>-D</tt>&nbsp;<em>initdefault</em>&nbsp;: boot the system with
 a runlevel set to <em>initdefault</em>, which can be an arbitrary
@@ -279,7 +286,7 @@ sysvinit behaviour) or <tt>default</tt> (OpenRC behaviour). Default is
 <strong><tt>default</tt></strong>. Note that if a <tt>2</tt>, <tt>3</tt>,
 <tt>4</tt>, <tt>5</tt>, or <tt>default</tt> argument is encountered in
 the kernel command line, it will be interpreted as the runlevel to boot
-the system on, and will override the default given here. </li> <br />
+the system on, and will override the default given here. </li> <br>
 
  <li> <tt>-n</tt>&nbsp;: at boot time, assume that a tmpfs is already
 present on <tt>/run</tt> (or the argument that was given to the
@@ -296,7 +303,7 @@ unfortunately, a lot of distributions do not care.) By default,
 then a tmpfs will be mounted on it. <strong>Do not</strong> use
 this option if you are not sure: failure to remount <tt>/run</tt>
 will cause init to die and the kernel to panic. This option is
-incompatible with the <tt>-N</tt> option. </li> <br />
+incompatible with the <tt>-N</tt> option. </li> <br>
 
  <li> <tt>-N</tt>&nbsp;: at boot time, do not perform
 mounting/unmounting/remounting on <tt>/run</tt> (or the <em>tmpfsdir</em>
@@ -309,7 +316,7 @@ which case the rootfs is already read-write and in RAM and mounting
 an additional tmpfs is unnecessary. <strong>Do not</strong> use this
 option if your rootfs is read-only: failure to write to <tt>/run</tt>
 will cause init to die and the kernel to panic. This option is
-incompatible with the <tt>-n</tt> option. </li> <br />
+incompatible with the <tt>-n</tt> option. </li> <br>
 
  <li> <tt>-f</tt>&nbsp;<em>skeldir</em>&nbsp;: copy the skeleton
 scripts from directory <em>skeldir</em>. By default, <em>skeldir</em>
@@ -318,7 +325,7 @@ that has been
 given as an argument to the <tt>--skeldir</tt> configure option at
 build time. This option is typically useful when distributions run
 <tt>s6-linux-init-maker</tt> in packaging scripts, when preparing
-files in a staging directory. </li> <br />
+files in a staging directory. </li> <br>
 
  <li> <tt>-R</tt>&nbsp;<em>resource_limit_list</em>&nbsp;: declare
 global resource limits (a.k.a. "hard limits") for the system to be
@@ -337,7 +344,7 @@ whole system to be booted: it will be impossible to raise soft limits
 above these values. <strong>Warning:</strong> misuse of this option is
 likely to make your system unbootable; make sure you don't prevent
 process 1 and the whole process hierarchy from allocating enough
-resources. </li> <br />
+resources. </li> <br>
 
  <li> <tt>-C</tt>&nbsp;: create a set of scripts that is suitable
 for running <em>in a container</em>. This modifies some behaviours:
@@ -383,7 +390,7 @@ the exit code to its parent, you should:
     </ul>
  All the running services will be killed, all the zombies will be
 reaped, and the container will exit with the required exit code. </li>
-  </ul> </li>
+  </ul> </li> <br>
 
  <li> <tt>-B</tt>&nbsp;: run the system without a catch-all logger.
 On a non-containerized system, that means that all the logs from the
@@ -393,7 +400,7 @@ services running under the supervision tree: use of this option is
 discouraged. On a containerized system (when paired with the <tt>-C</tt>
 option), it simply means that these outputs go to the default stdout and
 stderr given to the container's <tt>init</tt> - this should generally
-not be the default, but might be useful in some cases. </li>
+not be the default, but might be useful in some cases. </li> <br>
 
  <li> <tt>-S</tt>&nbsp;: when used with the <tt>-C</tt> option, set up
 the container so the disks are <tt>sync</tt>ed on container halt. By