Skip to content
Snippets Groups Projects
Commit 5aa2f8e8 authored by Eric Vidal's avatar Eric Vidal :speech_balloon:
Browse files

adapt 66-xxx program documentation

parent c5984c76
No related branches found
No related tags found
No related merge requests found
...@@ -9,4 +9,4 @@ author: Eric Vidal <eric@obarun.org> ...@@ -9,4 +9,4 @@ author: Eric Vidal <eric@obarun.org>
# 66-echo # 66-echo
Exact copy of [s6-echo](https://skarnet.org/software/s6-portable-utils/s6-echo.html). Adapted to the 66 tools suite to avoid a dependency on [s6-portable-utils](https://skarnet.org/software/s6-portable-utils/) at compilation time of `66`. Details and further information on the command can be found at the [s6-echo](https://skarnet.org/software/s6-portable-utils/s6-echo.html) documentation page. Exact copy of [s6-echo](https://skarnet.org/software/s6-portable-utils/s6-echo.html). Adapted to the `66` suite to avoid a dependency on [s6-portable-utils](https://skarnet.org/software/s6-portable-utils/) at compilation time of `66`. Details and further information on the command can be found at the [s6-echo](https://skarnet.org/software/s6-portable-utils/s6-echo.html) documentation page.
...@@ -9,12 +9,14 @@ author: Eric Vidal <eric@obarun.org> ...@@ -9,12 +9,14 @@ author: Eric Vidal <eric@obarun.org>
# 66-hpr # 66-hpr
Triggers the software shutdown procedure. Performs an immediate hardware shutdown with the **‑f** option. It is normally invoked by `halt`, `poweroff` or `reboot` wrappers installed by default at `%%skel%%`. This program is a modified copy of [s6-linux-init-hpr](https://skarnet.org/software/s6-linux-init/s6-linux-init-hpr.html). Triggers the software shutdown procedure. Performs an immediate hardware shutdown with the **‑f** option. It is normally invoked by `66 halt`, `66 poweroff` or `66 reboot` command. This program is a modified copy of [s6-linux-init-hpr](https://skarnet.org/software/s6-linux-init/s6-linux-init-hpr.html).
This program is primarily used internally by `66`. User may prefer to use `66 halt`, `66 poweroff` or `66 reboot` instead.
## Interface ## Interface
``` ```
66-hpr [ -H ] [ -l live ] [ -b banner ] [ -f ] [ -h | -p | -r ] [ -n ] [ -d | -w ] [ -W ] 66-hpr [ -H ] [ -l live ] [ -b banner ] [ -f ] [ -h | -p | -r ] [ -n ] [ -d | -w ] [ -W ]
``` ```
- If the **-f** option is passed the system is stopped or rebooted immediately without properly cleaning up. - If the **-f** option is passed the system is stopped or rebooted immediately without properly cleaning up.
...@@ -25,12 +27,6 @@ Triggers the software shutdown procedure. Performs an immediate hardware shutdow ...@@ -25,12 +27,6 @@ Triggers the software shutdown procedure. Performs an immediate hardware shutdow
This is the traditional sysvinit interface for the `halt`, `poweroff` and `reboot` programs. *66‑hpr* must always be called with either **‑h**, **‑p** or **‑r**. This is the traditional sysvinit interface for the `halt`, `poweroff` and `reboot` programs. *66‑hpr* must always be called with either **‑h**, **‑p** or **‑r**.
## Exit codes
- *0* success
- *100* wrong usage
- *111* system call failed
## Options ## Options
- **-H**: prints this help. - **-H**: prints this help.
......
...@@ -9,5 +9,5 @@ author: Eric Vidal <eric@obarun.org> ...@@ -9,5 +9,5 @@ author: Eric Vidal <eric@obarun.org>
# 66-nuke # 66-nuke
Exact copy of [s6-linux-init-nuke](https://skarnet.org/software/s6-linux-init/s6-linux-init-nuke.html). It was adapted to avoid the dependency on [s6‑linux‑init](https://skarnet.org/software/s6‑linux‑init) at *66* tools compile time. Refer to the [s6‑linux‑init](https://skarnet.org/software/s6‑linux‑init) documentation page for further details. Exact copy of [s6-linux-init-nuke](https://skarnet.org/software/s6-linux-init/s6-linux-init-nuke.html). It was adapted to avoid the dependency on [s6‑linux‑init](https://skarnet.org/software/s6‑linux‑init) at `66` compile time. Refer to the [s6‑linux‑init](https://skarnet.org/software/s6‑linux‑init) documentation page for further details.
...@@ -11,14 +11,15 @@ author: Eric Vidal <eric@obarun.org> ...@@ -11,14 +11,15 @@ author: Eric Vidal <eric@obarun.org>
Triggers the system shutdown procedure. It is normally invoked as shutdown at your binary system directory. This program is a modified copy of [s6-linux-init-shutdown](https://skarnet.org/software/s6-linux-init/s6-linux-init-shutdown.html). Triggers the system shutdown procedure. It is normally invoked as shutdown at your binary system directory. This program is a modified copy of [s6-linux-init-shutdown](https://skarnet.org/software/s6-linux-init/s6-linux-init-shutdown.html).
The *66-shutdown* binary is not meant to be called directly. User may prefer to use the `66 halt`, `66 poweroff` or `66 reboot` command.
## Interface ## Interface
``` ```
66-shutdown [ -H ] [ -l live ] [ -h | -p | -r | -k ] [ -a ] [ -t sec ] [ -f | -F ] time [ message ] 66-shutdown [ -H ] [ -l live ] [ -h | -p | -r | -k ] [ -a ] [ -t sec ] [ -f | -F ] time [ message ]
66-shutdown -c [ message ] 66-shutdown -c [ message ]
``` ```
- Will cancel a pending shutdown if *-c* is passed. - Will cancel a pending shutdown if *-c* is passed.
- Else plans the shutdown procedure at time time. - Else plans the shutdown procedure at time time.
- If a message argument has been given it is broadcast to all logged in users as tracked by utmp. - If a message argument has been given it is broadcast to all logged in users as tracked by utmp.
...@@ -34,13 +35,6 @@ The *66-shutdown* program abides to the standards of the LSB-3.0.0 [shutdown](ht ...@@ -34,13 +35,6 @@ The *66-shutdown* program abides to the standards of the LSB-3.0.0 [shutdown](ht
- *hh:mm*: absolute time; triggers the shutdown sequence when the time *hh:mm* occurs. If that time has passed for the current day, it will wait for the next day. *hh* can have 1 or 2 digits; *mm* must have 2 digits. - *hh:mm*: absolute time; triggers the shutdown sequence when the time *hh:mm* occurs. If that time has passed for the current day, it will wait for the next day. *hh* can have 1 or 2 digits; *mm* must have 2 digits.
## Exit codes
- *0* success
- *100* wrong usage
- *111* system call failed
## Options ## Options
- **-H**: prints this help. - **-H**: prints this help.
...@@ -67,7 +61,4 @@ The *66-shutdown* program abides to the standards of the LSB-3.0.0 [shutdown](ht ...@@ -67,7 +61,4 @@ The *66-shutdown* program abides to the standards of the LSB-3.0.0 [shutdown](ht
## Notes ## Notes
The *66-shutdown* binary is not meant to be called directly. It should always be referenced by the shutdown skeleton file installed by default at `%%skel%%`. The binary **should be copied** or **symlinked** into the binary directory of the system.
The **-f** and **-F** exist for compatibility reasons. The LSB sepcification says they are used to advise the system to skip or enforce a `fsck` after rebooting. But they are only advisory and for decades now systems have used other methods of evaluating whether they should perform filesystem checks so these options are largely obsolete nowadays. The **-f** and **-F** exist for compatibility reasons. The LSB sepcification says they are used to advise the system to skip or enforce a `fsck` after rebooting. But they are only advisory and for decades now systems have used other methods of evaluating whether they should perform filesystem checks so these options are largely obsolete nowadays.
...@@ -9,12 +9,14 @@ author: Eric Vidal <eric@obarun.org> ...@@ -9,12 +9,14 @@ author: Eric Vidal <eric@obarun.org>
# 66-shutdownd # 66-shutdownd
The daemon that manages the shutdown procedure for a [66-boot](66-boot.html) installation. It is not meant to be called directly. This program is a modified copy of [s6-linux-init-shudownd](https://skarnet.org/software/s6-linux-init/s6-linux-init-shutdownd.html). The daemon that manages the shutdown procedure for a [66 boot](66-boot.html) initialization. It is not meant to be called directly and automatically generated by a [66 scandir create|start](scandir.html) command invocation.
This program is a modified copy of [s6-linux-init-shudownd](https://skarnet.org/software/s6-linux-init/s6-linux-init-shutdownd.html).
## Interface ## Interface
``` ```
66-shutdownd [ -h ] [ -l live ] [ -s skel ] [ -g gracetime ] [ -B ] [ -c ] 66-shutdownd [ -h ] [ -l live ] [ -s skel ] [ -g gracetime ] [ -B ] [ -c ]
``` ```
- 66-shutdownd opens the `%%livedir%%/scandir/0/shutdownd/fifo` pipe and listens to it. Programs such as [66-shutdown](66-shutdown.html) send their commands to this pipe when they are told to trigger the shutdown procedure. - 66-shutdownd opens the `%%livedir%%/scandir/0/shutdownd/fifo` pipe and listens to it. Programs such as [66-shutdown](66-shutdown.html) send their commands to this pipe when they are told to trigger the shutdown procedure.
...@@ -25,12 +27,6 @@ The daemon that manages the shutdown procedure for a [66-boot](66-boot.html) ins ...@@ -25,12 +27,6 @@ The daemon that manages the shutdown procedure for a [66-boot](66-boot.html) ins
- It then runs an automatically generated script called `stage4` which unmounts all file systems and halts, powers off or reboots the machine. - It then runs an automatically generated script called `stage4` which unmounts all file systems and halts, powers off or reboots the machine.
## Exit codes
- *0* success
- *100* wrong usage
- *111* system call failed
## Options ## Options
- **-h**: prints this help. - **-h**: prints this help.
......
...@@ -9,4 +9,4 @@ author: Eric Vidal <eric@obarun.org> ...@@ -9,4 +9,4 @@ author: Eric Vidal <eric@obarun.org>
# 66-umountall # 66-umountall
Exact copy of [s6-linux-init-umountall](https://skarnet.org/software/s6-linux-init/s6-linux-init-umountall.html). It was adapted to avoid the dependency on [s6‑linux‑init](https://skarnet.org/software/s6‑linux‑init) at *66* tools compile time. Refer to the [s6‑linux‑init](https://skarnet.org/software/s6‑linux‑init) documentation page for further details. Exact copy of [s6-linux-init-umountall](https://skarnet.org/software/s6-linux-init/s6-linux-init-umountall.html). It was adapted to avoid the dependency on [s6‑linux‑init](https://skarnet.org/software/s6‑linux‑init) at `66` compile time. Refer to the [s6‑linux‑init](https://skarnet.org/software/s6‑linux‑init) documentation page for further details.
...@@ -14,9 +14,9 @@ A mix of [s6-envdir](https://skarnet.org/software/s6/s6-envdir.html) and [import ...@@ -14,9 +14,9 @@ A mix of [s6-envdir](https://skarnet.org/software/s6/s6-envdir.html) and [import
## Interface ## Interface
``` ```
execl-envfile [ -h ] [ -v verbosity ] [ -l ] src prog execl-envfile [ -h ] [ -v verbosity ] [ -l ] src prog
``` ```
This tool expects to find a regular file or a directory in *src* containing one or multiple `key=value` pair(s). It will parse that file, import the `key=value` and then exec the given *prog* with the modified environment. In case of directory for each file found it apply the same process. *src* can be an absolute or a relative path. This program expects to find a regular file or a directory in *src* containing one or multiple `key=value` pair(s). It will parse that file, import the `key=value` and then exec the given *prog* with the modified environment. In case of directory for each file found it apply the same process. *src* can be an absolute or a relative path.
- It opens and reads a file. - It opens and reads a file.
...@@ -30,13 +30,6 @@ This tool expects to find a regular file or a directory in *src* containing one ...@@ -30,13 +30,6 @@ This tool expects to find a regular file or a directory in *src* containing one
- It execs *prog* with the modified environment. - It execs *prog* with the modified environment.
## Exit codes
- *0* success
- *100* wrong usage
- *111* system call failed
## Options ## Options
- **-h**: prints this help. - **-h**: prints this help.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment