diff options
| author | PS <p@0x53.net> | 2026-02-07 10:20:30 +0100 |
|---|---|---|
| committer | PS <p@0x53.net> | 2026-02-07 10:20:30 +0100 |
| commit | 5e95d487982b9362b544139b98d1da55fa6ef78c (patch) | |
| tree | 1abf6d91f9e6d0b6d0ac7b7d759663f2531eb51b /doc/bin/user-rc.html | |
| parent | f7df2f7bb6abbea365cccb1345dcf1a1b7a80797 (diff) | |
| download | goetia-base-5e95d487982b9362b544139b98d1da55fa6ef78c.tar.gz goetia-base-5e95d487982b9362b544139b98d1da55fa6ef78c.tar.bz2 goetia-base-5e95d487982b9362b544139b98d1da55fa6ef78c.zip | |
Add doc
Diffstat (limited to 'doc/bin/user-rc.html')
| -rw-r--r-- | doc/bin/user-rc.html | 74 |
1 files changed, 74 insertions, 0 deletions
diff --git a/doc/bin/user-rc.html b/doc/bin/user-rc.html new file mode 100644 index 0000000..3bad0c5 --- /dev/null +++ b/doc/bin/user-rc.html @@ -0,0 +1,74 @@ +<!DOCTYPE html> +<html> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <meta http-equiv="Content-Language" content="en" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <title>user-rc</title> + <meta name="Description" content="Convenience wrapper around s6-rc to control the user supervision tree." /> + <meta name="Keywords" content="goetia s6-rc user supervision tree" /> + </head> + <header> + <p> + <a href="//0x53.net/software/goetia/goetia-base">goetia-base</a> + <br /> + <a href="//0x53.net/software/goetia">goetia</a> + <br /> + <a href="//0x53.net/software">Software</a> + <br /> + <a href="//0x53.net">0x53.net</a> + </p> + </header> + <body> + <h1>The user-rc program</h1> + <p> + The user-rc program is a thin convenience wrapper around + <a href="https://skarnet.org/software/s6-rc/s6-rc.html">s6-rc</a> + doing nothing more then pointing it to the right livedir. + </p> + <p> + Read the page of + <a href="https://skarnet.org/software/s6-rc/s6-rc.html">s6-rc</a> + to understand what this utility does. + </p> + <h2>Interface</h2> + <pre> user-rc ... <a href="https://skarnet.org/software/s6-rc/s6-rc.html">see s6-rc</a> ...</pre> + <ul> + <li> + user-rc reads the <code>USER</code> environment variable, + if it is empty it exits 100. + </li> + <li> + It reads the <code>USERTREE</code> environment variable, + if it is empty it exits 100. + </li> + <li> + It runs + <a href="https://skarnet.org/software/s6-rc/s6-rc.html">s6-rc</a> + with the appropriate livedir option. + </li> + </ul> + <h2>Exit codes</h2> + <ul> + <li> + 100 if a critical environment variable is missing. + </li> + <li> + Since user-rc is a thin wrapper around + <a href="https://skarnet.org/software/s6-rc/s6-rc.html">s6-rc</a> + it behaves almost exactly like it. + </li> + <li> + See also: + <a href="https://skarnet.org/software/execline/exitcodes.html">execline exit code handling</a>. + </li> + </ul> + <h2>Options</h2> + <ul> + <li> + user-rc takes exactly the same options as + <a href="https://skarnet.org/software/s6-rc/s6-rc.html">s6-rc</a>. + </li> + </ul> + </body> +</html> |