From 68dff5fb4e99dfe1361edeb51e00d21bfcc6372f Mon Sep 17 00:00:00 2001 From: Colin Booth Date: Mon, 30 Mar 2020 17:19:42 +0000 Subject: s6-linux-init: fix html errors Signed-off-by: Colin Booth --- doc/overview.html | 4 ++-- doc/s6-linux-init-hpr.html | 1 - doc/s6-linux-init-maker.html | 34 +++++++++++++++++----------------- doc/s6-linux-init.html | 5 ++--- 4 files changed, 21 insertions(+), 23 deletions(-) (limited to 'doc') diff --git a/doc/overview.html b/doc/overview.html index adaa414..f535453 100644 --- a/doc/overview.html +++ b/doc/overview.html @@ -51,14 +51,14 @@ directly by the user. They are called internally, in scripts created by a s6-linux-init-maker invocation - typically in run scripts for early services. -

+

  • A small library, that for now contains a single symbol, s6_linux_init_logouthook(), intended for distributions using login programs that add utmp entries for users logging in and expect init to clean up after them when users log out. See the s6-linux-init-logouthookd -page for details.

    • +page for details.

  • Skeleton scripts, installed by default in /etc/s6-linux-init/skel; that location can be changed at build diff --git a/doc/s6-linux-init-hpr.html b/doc/s6-linux-init-hpr.html index 5f09574..4d164e0 100644 --- a/doc/s6-linux-init-hpr.html +++ b/doc/s6-linux-init-hpr.html @@ -17,7 +17,6 @@

    The s6-linux-init-hpr program

    -

    s6-linux-init-hpr triggers the software shutdown procedure, diff --git a/doc/s6-linux-init-maker.html b/doc/s6-linux-init-maker.html index 0fc34df..68fe91f 100644 --- a/doc/s6-linux-init-maker.html +++ b/doc/s6-linux-init-maker.html @@ -164,11 +164,11 @@ 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 @@ -177,7 +177,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 @@ -188,12 +188,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 @@ -204,11 +204,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 @@ -217,7 +217,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 @@ -225,7 +225,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 @@ -243,7 +243,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 @@ -257,7 +257,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 @@ -266,7 +266,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 @@ -275,7 +275,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 @@ -292,7 +292,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 @@ -305,7 +305,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 @@ -314,14 +314,14 @@ 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.

  • -U utmp_user : this option is only available when the s6-linux-init package has been built with the --enable-utmps configure option, that enables support for the utmps package. The option defines the user that the utmpd and wtmpd services -will run as. Default is utmp.

    • +will run as. Default is utmp.

  • -C : create a set of scripts that is suitable for running in a container. This modifies some behaviours: diff --git a/doc/s6-linux-init.html b/doc/s6-linux-init.html index 21d97bf..4d800ce 100644 --- a/doc/s6-linux-init.html +++ b/doc/s6-linux-init.html @@ -34,10 +34,9 @@ and execs into s6-svscan.
  • If s6-linux-init isn't pid 1, it execs into s6-linux-init-telinit with the same arguments.
    • -
  • Else, it performs some early preparation, spawns a process that will run the rc.init script, then execs into -s6-svscan. +s6-svscan.

    • Options

    @@ -137,7 +136,7 @@ command line, as given by the kernel to s6-linux-init (i.e. without the key=value arguments, which were passed into s6-linux-init's environment and were stored into env_store), makes for the rest of the arguments given to rc.init. - +

    -- cgit v1.2.3