From dc81389ed5a1b5f380651b12bfdca0f9219fafcd Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Tue, 19 Sep 2023 13:25:30 +0000 Subject: Document -V option to s6-l-i-m Signed-off-by: Laurent Bercot --- doc/s6-linux-init-maker.html | 45 +++++++++++++++++++++++++------------------- 1 file 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. If it is not the case, the system will fail to boot. 
      s6-linux-init-maker \
+       [ -V boot_verbosity ] \
        [ -c basedir ] \
        [ -u log_user ] \
        [ -G early_getty ] \
@@ -162,17 +163,23 @@ exactly what it does.
 
 s6-linux-init-maker options 

 
 
    
+ 
  •  -V boot_verbosity : how
+verbose the boot will be. Default is 1,
+which means that only important warnings will be printed. Increasing
+this value may yield more, but usually harmless, warning messages. 
    •  
    
+
+
  
  •  -c basedir : at boot time, stage 1,
 which should be accessible as basedir/init,
 will read its read-only data from basedir. After running
 s6-linux-init-maker, you should make sure to copy the
 created directory dir to basedir. basedir
 must be absolute. Default is
-/etc/s6-linux-init/current. 
    •  
    
+/etc/s6-linux-init/current.  
    
 
  
  •  -u log_user : the catch-all
 logger will run as the log_user user. Default is
-root. 
    •  
    
+root.  
    
 
  
  •  -G early_getty : if this option
 is set, s6-linux-init-maker will define an additional s6 service
@@ -181,7 +188,7 @@ at the same time rc.init is executed. This early service
 should be a getty, or equivalent, to allow logins even if stage2 fails.
 early_getty should be a simple command line: for instance,
 "/sbin/getty 38400 tty1". By default, no early service
-is defined. 
    •  
    
+is defined.  
    
 
  
  •  -1 : 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 /dev/console.) 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
-tty2 and leave tty1 for /dev/console to print on. 
    •  
    
+tty2 and leave tty1 for /dev/console to print on.  
    
 
  
  •  -L : add an early s6-linux-init-logouthookd
 service to clean up utmp records at user logout time. Check the
 s6-linux-init-logouthookd page
-for details. 
    •  
    
+for details.  
    
 
  
  •  -p initial_path : the initial value
 for the PATH environment variable, that will be transmitted to all the
@@ -208,11 +215,11 @@ It is absolutely necessary for
 s6
 binaries to be accessible via initial_path, else the machine
 will not boot. Default is
-/usr/bin:/bin. 
    •  
    
+/usr/bin:/bin.  
    
 
  
  •  -m initial_umask : the value of
 the initial file umask for all the starting processes, in octal.
-Default is 022. 
    •  
    
+Default is 022.  
    
 
  
  •  -t timestamp_style : how
 logs are timestamped by the catch-all logger. 0 means no
@@ -221,7 +228,7 @@ timestamp, 1 means
 2 means
 ISO 8601 format,
 and 3 means both. Default is
-1. 
    •  
    
+1.  
    
 
  
  •  -d slashdev : mount a devtmpfs.
 If this option is given, s6-linux-init
@@ -229,7 +236,7 @@ will mount a devtmpfs pseudo-filesystem on slashdev. This
 is useful if the kernel has not been configured to mount
 the devtmpfs at boot time and there is no static /dev.
 By default, it is assumed that there is a suitable /dev
-at boot time, and no additional devtmpfs is mounted. 
    •  
    
+at boot time, and no additional devtmpfs is mounted.  
    
 
  
  •  -s env_store : stage 1 init sometimes
 inherits a few environment variables from the kernel. (These variables
@@ -247,7 +254,7 @@ before erasing them. env_store should obviously be
 a writable directory, so it should be located under /run
 (or your chosen tmpfsdir)!
 If this option is not given, the environment inherited from the kernel
-isn't saved anywhere - which is the default. 
    •  
    
+isn't saved anywhere - which is the default.  
    
 
  
  •  -e initial_envvar : this option
 can be repeated. For every initial_envvar, s6-linux-init-maker
@@ -261,7 +268,7 @@ process (as well as the rc.init 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. 
    •  
    
+the global environment.  
    
 
  
  •  -q finalsleeptime : when the machine
 shuts down, all processes that have not already been killed during
@@ -270,7 +277,7 @@ them to exit gracefully; then, after finalsleeptime
 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 3000, meaning a grace period of 3 seconds. 
    •  
    
+Default is 3000, meaning a grace period of 3 seconds.  
    
 
  
  •  -D initdefault : boot the system with
 a runlevel set to initdefault, which can be an arbitrary
@@ -279,7 +286,7 @@ sysvinit behaviour) or default (OpenRC behaviour). Default is
 default. Note that if a 2, 3,
 4, 5, or default 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. 
    •  
    
+the system on, and will override the default given here.  
    
 
  
  •  -n : at boot time, assume that a tmpfs is already
 present on /run (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. Do not use
 this option if you are not sure: failure to remount /run
 will cause init to die and the kernel to panic. This option is
-incompatible with the -N option. 
    •  
    
+incompatible with the -N option.  
    
 
  
  •  -N : at boot time, do not perform
 mounting/unmounting/remounting on /run (or the tmpfsdir
@@ -309,7 +316,7 @@ which case the rootfs is already read-write and in RAM and mounting
 an additional tmpfs is unnecessary. Do not use this
 option if your rootfs is read-only: failure to write to /run
 will cause init to die and the kernel to panic. This option is
-incompatible with the -n option. 
    •  
    
+incompatible with the -n option.  
    
 
  
  •  -f skeldir : copy the skeleton
 scripts from directory skeldir. By default, skeldir
@@ -318,7 +325,7 @@ that has been
 given as an argument to the --skeldir configure option at
 build time. This option is typically useful when distributions run
 s6-linux-init-maker in packaging scripts, when preparing
-files in a staging directory. 
    •  
    
+files in a staging directory.  
    
 
  
  •  -R resource_limit_list : 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. Warning: 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. 
    •  
    
+resources.  
    
 
  
  •  -C : create a set of scripts that is suitable
 for running in a container. This modifies some behaviours:
@@ -383,7 +390,7 @@ the exit code to its parent, you should:
     

  All the running services will be killed, all the zombies will be
 reaped, and the container will exit with the required exit code. 
-   
+    

 
  
  •  -B : 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 -C
 option), it simply means that these outputs go to the default stdout and
 stderr given to the container's init - this should generally
-not be the default, but might be useful in some cases. 
    • 
+not be the default, but might be useful in some cases.  
    
 
  
  •  -S : when used with the -C option, set up
 the container so the disks are synced on container halt. By
-- 
cgit v1.2.3