diff options
| author | Laurent Bercot <ska-skaware@skarnet.org> | 2026-01-06 03:05:27 +0000 |
|---|---|---|
| committer | Laurent Bercot <ska-skaware@skarnet.org> | 2026-01-06 03:05:27 +0000 |
| commit | e135a92c11f1fe1e13c1c17df6616bae56d215e8 (patch) | |
| tree | e0f59e92af707d31be71f1aee8647aa80efdae20 | |
| parent | 9eee47d2db84cca8fecc3cd33e853d3d39277cda (diff) | |
| download | s6-frontend-e135a92c11f1fe1e13c1c17df6616bae56d215e8.tar.gz | |
Update deps, update some docs
| -rw-r--r-- | AUTHORS | 3 | ||||
| -rw-r--r-- | INSTALL | 8 | ||||
| -rw-r--r-- | doc/index.html | 29 | ||||
| -rw-r--r-- | doc/s6-frontend-alias-chpst.html | 83 | ||||
| -rw-r--r-- | doc/s6-frontend-alias-sv.html | 66 | ||||
| -rw-r--r-- | doc/s6-frontend-alias.html | 128 | ||||
| -rw-r--r-- | doc/s6-frontend-config-preprocess.html | 87 | ||||
| -rw-r--r-- | package/deps-build | 4 |
8 files changed, 21 insertions, 387 deletions
@@ -1,5 +1,2 @@ Main author: Laurent Bercot <ska-skaware@skarnet.org> - -Contributors: - Colin Booth <colin@heliocat.net> @@ -6,13 +6,13 @@ Build Instructions - A POSIX compatible system with a standard C development environment - GNU make version 3.81 or later - - skalibs version 2.14.5.0 or later: https://skarnet.org/software/skalibs/ - - nsss version 0.2.1.1 or later: https://skarnet.org/software/nsss/ - - execline version 2.9.8.0 or later: https://skarnet.org/software/execline/ + - skalibs version 2.14.5.1 or later: https://skarnet.org/software/skalibs/ + - execline version 2.9.8.1 or later: https://skarnet.org/software/execline/ - s6 version 2.14.0.0 or later: https://skarnet.org/software/s6/ - s6-rc version 0.6.0.0 or later: https://skarnet.org/software/s6-rc/ - optional: s6-linux-init version 1.2.0.0 or later: https://skarnet.org/software/s6-linux-init/ - - optional: util-linux v2.41.2 or later: https://en.wikipedia.org/wiki/Util-linux + - optional: nsss version 0.2.1.1 or later: https://skarnet.org/software/nsss/ + - optional: util-linux version 2.41.2 or later: https://en.wikipedia.org/wiki/Util-linux * Standard usage diff --git a/doc/index.html b/doc/index.html index a82dbe7..70ca515 100644 --- a/doc/index.html +++ b/doc/index.html @@ -67,24 +67,29 @@ they implement a powerful, fast, turnkey init system that is usable on <li> A Linux-based system with a standard C development environment </li> <li> GNU make, version 3.81 or later </li> <li> <a href="//skarnet.org/software/skalibs/">skalibs</a> version -2.14.5.0 or later </li> - <li> <a href="//skarnet.org/software/nsss/">nsss</a> version -0.2.1.1 or later </li> +2.14.5.1 or later </li> <li> <a href="//skarnet.org/software/execline/">execline</a> version -2.9.8.0 or later </li> +2.9.8.1 or later </li> <li> <a href="//skarnet.org/software/s6/">s6</a> version 2.14.0.0 or later </li> <li> <a href="//skarnet.org/software/s6-rc/">s6-rc</a> version 0.6.0.0 or later </li> - <li> <a href="//skarnet.org/software/s6-linux-init/">s6-linux-init</a> version + <li> Optional: <a href="//skarnet.org/software/nsss/">nsss</a> version +0.2.1.1 or later </li> + <li> Optional: <a href="//skarnet.org/software/s6-linux-init/">s6-linux-init</a> version 1.2.0.0 or later </li> + <li> Optional: <a href="https://en.wikipedia.org/wiki/Util-linux">util-linux</a> version +2.41.2 or later </li> </ul> -<p> - Those are all build-time dependencies as well as run-time dependencies. -skalibs is only a run-time dependency if you link the binaries against -the shared version of the skarnet library. -</p> +<ul> + <li> All the skaware packages are build-time dependencies as well as run-time dependencies. + <ul> + <li> skalibs is only a run-time dependency if you link the binaries against +the shared version of the skarnet library. </li> + </ul> </li> + <li> util-linux is a run-time dependency only. </li> +</ul> <h3> Licensing </h3> @@ -134,10 +139,6 @@ the previous versions of s6-frontend and the current one. </li> </p> <ul> - <li> The <a href="s6-frontend-config-preprocess.html"><tt>s6-frontend-config-preprocess</tt></a> program </li> - <li> The <a href="s6-frontend-alias.html"><tt>s6-frontend-alias</tt></a> program </li> - <li> The <a href="s6-frontend-alias-chpst.html"><tt>s6-frontend-alias-chpst</tt></a> program </li> - <li> The <a href="s6-frontend-alias-sv.html"><tt>s6-frontend-alias-sv</tt></a> program </li> </ul> <h2> Related resources </h2> diff --git a/doc/s6-frontend-alias-chpst.html b/doc/s6-frontend-alias-chpst.html deleted file mode 100644 index f67ab32..0000000 --- a/doc/s6-frontend-alias-chpst.html +++ /dev/null @@ -1,83 +0,0 @@ -<html> - <head> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <meta http-equiv="Content-Language" content="en" /> - <title>s6-frontend: the s6-frontend-alias-chpst program</title> - <meta name="Description" content="s6-frontend: the s6-frontend-alias-chpst program" /> - <meta name="Keywords" content="s6 command s6-frontend alias chpst runit change process state" /> - <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> --> - </head> -<body> - -<p> -<a href="index.html">s6-frontend</a><br /> -<a href="//skarnet.org/software/">Software</a><br /> -<a href="//skarnet.org/">skarnet.org</a> -</p> - -<h1> The <tt>s6-frontend-alias-chpst</tt> program </h1> - -<p> -<tt>s6-frontend-alias-chpst</tt> implements -<a href="http://smarden.org/runit/">runit</a>'s -<a href="http://smarden.org/runit/chpst.8.html">chpst</a> command -by rewriting itself into a command line made of idiomatic -chainloading <a href="//skarnet.org/software/s6/">s6</a> commands. -</p> - -<h2> Interface </h2> - -<pre> - s6-frontend-alias-chpst [ -v ] [ -P ] [ -0 ] [ -1 ] [ -2 ] [ -u <em>user</em> ] [ -U <em>user</em> ] [ -b <em>argv0</em> ] [ -e <em>dir</em> ] [ -/ <em>root</em> ] [ -n <em>niceness</em> ] [ -l|-L <em>lock</em> ] [ -m <em>bytes</em> ] [ -d <em>bytes</em> ] [ -o <em>n</em> ] [ -p <em>n</em> ] [ -f <em>bytes</em> ] [ -c <em>bytes</em> ] <em>prog...</em> -</pre> - -<p> - When s6-frontend has been configured with the -<tt>--enable-aliases-runit</tt> option, the -<tt>s6-frontend-alias-chpst</tt> program is built, and at installation -time, a <tt>chpst</tt> symbolic link is created, pointing to it. -</p> - -<p> - <tt>s6-frontend-alias-chpst</tt> implements most of the functionality of -<a href="http://smarden.org/runit/chpst.8.html">chpst</a>, as closely as -possible. It does so by rewriting itself into a command line that may -invoke one or more of the following programs: -</p> - -<ul> - <li> The Unix <a href="https://pubs.opengroup.org/onlinepubs/9799919799/utilities/nice.html">nice</a> command </li> - <li> The s6 <a href="//skarnet.org/software/s6/s6-setsid.html">s6-setsid</a> command </li> - <li> The s6 <a href="//skarnet.org/software/s6/s6-envdir.html">s6-envdir</a> command </li> - <li> The s6 <a href="//skarnet.org/software/s6/s6-setlock.html">s6-setlock</a> command </li> - <li> The s6 <a href="//skarnet.org/software/s6/s6-applyuidgid.html">s6-applyuidgid</a> command </li> - <li> The s6 <a href="//skarnet.org/software/s6/s6-envuidgid.html">s6-envuidgid</a> command </li> - <li> The s6 <a href="//skarnet.org/software/s6/s6-softlimit.html">s6-softlimit</a> command </li> - <li> The execline <a href="//skarnet.org/software/execline/fdclose.html">fdclose</a> command </li> - <li> The execline <a href="//skarnet.org/software/execline/exec.html">exec</a> command </li> - <li> The non-standard (but ubiquitous) Unix <a href="https://helpmanual.io/man8/chroot/">chroot</a> command </li> -</ul> - -<h2> Notes </h2> - -<ul> - <li> When the <tt>-v</tt> option is given, -<tt>s6-frontend-alias-chpst</tt> prints an informational -message to stderr, showing the entire command line it is going to execute into. </li> - <li> <tt>s6-frontend-alias-chpst</tt> is a convenience program, written -so that runit users can keep using <tt>chpst</tt> while learning the -corresponding idiomatic s6 commands. However, it is not an "official" -interface. <tt>chpst</tt> acts as a big toolbox, whereas s6 prefers the -"one function = one tool" philosophy. It is recommended that runit users -who are new to s6 use the <tt>-v</tt> option to see how their <tt>chpst</tt> -invocation translates into s6 parlance. </li> - <li> Some <tt>chpst -u</tt> invocations do not translate perfectly -because s6 uses a slightly different model of acquiring user and group -identity via -<a href="//skarnet.org/software/s6/s6-envuidgid.html">s6-envuidgid</a>. -This should not prevent <tt>chpst</tt> from working. </li> -</ul> - -</body> -</html> diff --git a/doc/s6-frontend-alias-sv.html b/doc/s6-frontend-alias-sv.html deleted file mode 100644 index a619661..0000000 --- a/doc/s6-frontend-alias-sv.html +++ /dev/null @@ -1,66 +0,0 @@ -<html> - <head> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <meta http-equiv="Content-Language" content="en" /> - <title>s6-frontend: the s6-frontend-alias-sv program</title> - <meta name="Description" content="s6-frontend: the s6-frontend-alias-sv program" /> - <meta name="Keywords" content="s6 command s6-frontend-alias-sv alias sv runit" /> - <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> --> - </head> -<body> - -<p> -<a href="index.html">s6-frontend</a><br /> -<a href="//skarnet.org/software/">Software</a><br /> -<a href="//skarnet.org/">skarnet.org</a> -</p> - -<h1> The <tt>s6-frontend-alias-sv</tt> program </h1> - -<p> -<tt>s6-frontend-alias-sv</tt> implements -<a href="http://smarden.org/runit/">runit</a>'s -<a href="http://smarden.org/runit/sv.8.html">sv</a> command over a -<a href="//skarnet.org/software/s6/">s6</a> supervision tree, via -native <a href="//skarnet.org/software/s6/">s6</a> commands. - -</p> - -<h2> Interface </h2> - -<pre> - s6-frontend-alias-sv [ -v ] [ -w <em>secs</em> ] <em>command</em> <em>services...</em> -</pre> - -<p> - When s6-frontend has been configured with the -<tt>--enable-aliases-runit</tt> option, the -<tt>s6-frontend-alias-sv</tt> program is built, and at installation -time, a <tt>sv</tt> symbolic link is created, pointing to it. -</p> - -<p> - <tt>s6-frontend-alias-sv</tt> implements most of the functionality of -<a href="http://smarden.org/runit/sv.8.html">sv</a>, as closely as -possible. When some functionality cannot be emulated on a s6 -supervision tree, it prints an error message to stderr and exits 100. -</p> - -<h2> Notes </h2> - -<ul> - <li> <tt>s6-frontend-alias-sv</tt> is a convenience program, written -so that runit users can keep using <tt>sv</tt> to control their -s6 services. However, it is not an "official" interface, because there -are a few fundamental differences between the conception of runit and -the conception of s6 that make <tt>sv</tt> a poor fit to accurately -interface with the advanced features of s6. It is recommended that -<tt>sv</tt> users become familiar with idiomatic s6 commands such as -<a href="//skarnet.org/software/s6/s6-svc.html">s6-svc</a>, -<a href="//skarnet.org/software/s6/s6-svstat.html">s6-svstat</a>, and -<a href="//skarnet.org/software/s6/s6-svwait.html">s6-svwait</a>. </li> -</ul> - -</body> -</html> diff --git a/doc/s6-frontend-alias.html b/doc/s6-frontend-alias.html deleted file mode 100644 index 369c792..0000000 --- a/doc/s6-frontend-alias.html +++ /dev/null @@ -1,128 +0,0 @@ -<html> - <head> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <meta http-equiv="Content-Language" content="en" /> - <title>s6-frontend: the s6-frontend-alias program</title> - <meta name="Description" content="s6-frontend: the s6-frontend-alias program" /> - <meta name="Keywords" content="s6 command s6-frontend-alias daemontools runit" /> - <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> --> - </head> -<body> - -<p> -<a href="index.html">s6-frontend</a><br /> -<a href="//skarnet.org/software/">Software</a><br /> -<a href="//skarnet.org/">skarnet.org</a> -</p> - -<h1> The <tt>s6-frontend-alias</tt> program </h1> - -<p> -<tt>s6-frontend-alias</tt> is a multicall binary that implements -functionality from the -<a href="https://cr.yp.to/daemontools.html">daemontools</a> package, -and/or from the -<a href="http://smarden.org/runit/">runit</a> package, whenever -possible, via -<a href="//skarnet.org/software/s6/">s6</a> commands. -</p> - -<h2> Interface </h2> - -<pre> - s6-frontend-alias [ -v ] <em>daemontools_command</em> <em>args...</em> - s6-frontend-alias [ -v ] <em>runit_command</em> <em>args...</em> - <em>daemontools_command</em> <em>args...</em> - <em>runit_command</em> <em>args...</em> -</pre> - -<p> -<tt>s6-frontend-alias</tt> can be called as is: then it takes the command -name as its argument. Or, it can be called directly as the wanted command. -It finds the closest approximation of the command in the s6 world, and -executes into it. When it cannot find a suitable idiomatic s6 version of -the wanted command, it prints an explanatory message to stderr, then -exits 100. -</p> - -<p> -<tt>s6-frontend-alias</tt> is only built when at least one of the -<tt>--enable-alias-daemontools</tt> and <tt>--enable-alias-runit</tt> -options have been given to configure at build time. -</p> - -<p> -When the <tt>--enable-alias-daemontools</tt> option has been given, -the following commands are created at installation time as symbolic -links to <tt>s6-frontend-alias</tt>, which recognizes them: -</p> - -<ul> - <li> envdir </li> - <li> envuidgid </li> - <li> fghack </li> - <li> multilog </li> - <li> pgrphack </li> - <li> readproctitle </li> - <li> setlock </li> - <li> setuidgid </li> - <li> softlimit </li> - <li> supervise </li> - <li> svc </li> - <li> svok </li> - <li> svscan </li> - <li> svscanboot </li> - <li> svstat </li> - <li> tai64n </li> - <li> tai64nlocal </li> -</ul> - -<p> -When the <tt>--enable-alias-runit</tt> option has been given, -the following commands are created at installation time as symbolic -links to <tt>s6-frontend-alias</tt>, which recognizes them: -</p> - -<ul> - <li> runit </li> - <li> runit-init </li> - <li> runsvdir </li> - <li> runsvchdir </li> - <li> runsv </li> - <li> svlogd </li> - <li> utmpset </li> -</ul> - -<p> -(The <tt>chpst</tt> and <tt>sv</tt> runit commands are recognized -by <tt>s6-frontend-alias</tt>, but handled by specific programs, -<a href="s6-frontend-alias-chpst.html">s6-frontend-alias-chpst</a> and -<a href="s6-frontend-alias-sv.html">s6-frontend-alias-sv</a>, and the -<tt>chpst</tt> and <tt>sv</tt> symbolic links point directly to those -programs.) -</p> - -<h2> Options </h2> - -<ul> - <li> <tt>-v</tt> : verbose. When <tt>s6-frontend-alias</tt> -is called under its own name and this option is given, it prints -an explanatory message to stderr before executing into the -corresponding idiomatic s6 command. </li> -</ul> - -<h2> Notes </h2> - -<ul> - <li> <tt>s6-frontend-alias</tt> is a convenience program, written -so that daemontools and runit users can keep using their habits while -transitioning to s6. However, it is not an "official" interface, -because s6 is strictly more powerful than daemontools, and has a few -significant fundamental differences with runit. Daemontools and runit -users are still encouraged to learn and get used to the native -s6 commands. </li> -</ul> - -</body> -</html> diff --git a/doc/s6-frontend-config-preprocess.html b/doc/s6-frontend-config-preprocess.html deleted file mode 100644 index 50a3bfc..0000000 --- a/doc/s6-frontend-config-preprocess.html +++ /dev/null @@ -1,87 +0,0 @@ -<html> - <head> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <meta http-equiv="Content-Language" content="en" /> - <title>s6-frontend: the s6-frontend-config-preprocess program</title> - <meta name="Description" content="s6-frontend: the s6-frontend-config-preprocess program" /> - <meta name="Keywords" content="s6-frontend command s6 configuration unit file s6-frontend-config preprocess preprocessor" /> - <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> --> - </head> -<body> - -<p> -<a href="index.html">s6-frontend</a><br /> -<a href="//skarnet.org/software/">Software</a><br /> -<a href="//skarnet.org/">skarnet.org</a> -</p> - -<h1> The s6-frontend-config-preprocess program </h1> - -<p> - <tt>s6-frontend-config-preprocess</tt> reads a s6-frontend configuration -file and executes all its inclusion directives, also preprocessing the -included files. It streams the result to stdout, which is a complete -configuration file without inclusions. -</p> - -<h2> Interface </h2> - -<pre> - s6-frontend-config-preprocess <em>file</em> -</pre> - -<p> - <tt>s6-frontend-config-preprocess</tt> reads <em>file</em> and prints it -to stdout. It removes lines starting with <tt>!!</tt>. -</p> - -<p> - When it finds a <tt>!include</tt> or <tt>!includeonce</tt> directive -in <em>file</em>, it replaces it with the contents of the included -file - recursively preprocessed. -</p> - -<p> - When it finds a <tt>!includedir</tt> or <tt>!includedironce</tt> -directive in <em>file</em>, it replaces it with the recursively -preprocessed contents of every file present in the included -directory. The files are sorted alphabetically according to the -C locale. -</p> - -<p> - <tt>!includeonce</tt> and <tt>!includedironce</tt> only print -a file (resp. a directory) the first time they encounter it, and -silently ignore subsequent instances. <tt>!include</tt> and -<tt>!includedir</tt> directives will happily include the same -files several times. -</p> - -<p> - To avoid loops, a nesting limit exists. <tt>s6-frontend-config-preprocess</tt> -will fail if there are too many nested inclusions. -</p> - -<h2> Exit codes </h2> - -<ul> - <li> 0: success </li> - <li> 1: syntax error in a configuration file </li> - <li> 2: other error in a configuration file </li> - <li> 3: too many nested inclusions </li> - <li> 100: usage error </li> - <li> 111: system call failed </li> -</ul> - -<h2> Notes </h2> - -<ul> - <li> <tt>s6-frontend-config-preprocess</tt> is not meant to be -called directly by the user. It is normally invoked by -<a href="s6-frontend-config-parse.html">s6-frontend-config-parse</a>. -However, the binary is made available for debugging purposes. </li> -</ul> - -</body> -</html> diff --git a/package/deps-build b/package/deps-build index 32e84d9..b9e7dfa 100644 --- a/package/deps-build +++ b/package/deps-build @@ -1,6 +1,6 @@ -true true /package/prog/skalibs 2.14.5.0 libskarnet +true true /package/prog/skalibs 2.14.5.1 libskarnet $usensss $usensss /package/admin/nsss 0.2.1.1 libnsss -true false /package/admin/execline 2.9.8.0 libexecline +true false /package/admin/execline 2.9.8.1 libexecline true false /package/admin/s6 2.14.0.0 libs6 libs6auto true false /package/admin/s6-rc 0.6.0.0 libs6rc true false /package/admin/s6-linux-init 1.2.0.0 |