diff options
| author | Laurent Bercot <ska-skaware@skarnet.org> | 2019-12-30 23:27:32 +0000 |
|---|---|---|
| committer | Laurent Bercot <ska-skaware@skarnet.org> | 2019-12-30 23:27:32 +0000 |
| commit | ed9dadb2778ab4ff7683622907e22ed8c561bfda (patch) | |
| tree | 59d4341aa2d885d6928e1e30ab6f5f57916c09ee /doc | |
| download | s6-frontend-ed9dadb2778ab4ff7683622907e22ed8c561bfda.tar.xz | |
Initial commit.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/index.html | 149 | ||||
| -rw-r--r-- | doc/quickstart.html | 26 | ||||
| -rw-r--r-- | doc/s6-frontend-alias.html | 41 | ||||
| -rw-r--r-- | doc/s6-frontend-config-preprocess.html | 87 | ||||
| -rw-r--r-- | doc/upgrade.html | 28 |
5 files changed, 331 insertions, 0 deletions
diff --git a/doc/index.html b/doc/index.html new file mode 100644 index 0000000..bd6512c --- /dev/null +++ b/doc/index.html @@ -0,0 +1,149 @@ +<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 - a frontend to the s6 ecosystem</title> + <meta name="Description" content="s6-frontend - a frontend to the s6 ecosystem" /> + <meta name="Keywords" content="s6 s6-rc frontend administration root laurent bercot ska skarnet init" /> + <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> --> + </head> +<body> + +<p> +<a href="//skarnet.org/software/">Software</a><br /> +<a href="//skarnet.org/">skarnet.org</a> +</p> + +<h1> s6-frontend </h1> + +<h2> What is it ? </h2> + +<p> + <strong><em><red> s6-frontend is still in development. </red></em></strong> +</p> + +<p> + s6-frontend is a frontend to the s6 ecosystem. It is made of +several parts: +</p> + +<ul> + <li> A set of user-friendly commands, making it easier to manage a +s6-based system for people who are used to other tools. </li> + <li> An independent configuration file format, +and tools that automatically analyze a configuration written in that +format and transform it into a configuration suitable for booting a +system via +<a href="//skarnet.org/software/s6/">s6</a>, +<a href="//skarnet.org/software/s6-linux-init/">s6-linux-init</a> and +<a href="//skarnet.org/software/s6-rc/">s6-rc</a>. This should help +users who are not familiar with s6 and s6-rc directory-based configuration +but are used to, for instance, systemd unit files.</li> + <li> A prepackaged set of configuration files, implementing <em>policy</em>, +suitable for booting a large majority of Linux-based systems. This should +help distributions that want to switch to s6 but do not want to rewrite all +their init scripts in yet another format. </li> +</ul> + +<p> + These parts are all independent from one another. But when put all together, +they implement a powerful, fast, turnkey init system that is usable on +<em>any</em> distribution. +</p> + +<hr /> + +<ul> + <li> <a href="quickstart.html">Quickstart and FAQ</a> </li> +</ul> + +<hr /> +<h2> Installation </h2> + +<h3> Requirements </h3> + +<ul> + <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.9.1.0 or later </li> + <li> <a href="//skarnet.org/software/execline/">execline</a> version +2.6.0.0 or later </li> + <li> <a href="//skarnet.org/software/s6/">s6</a> version +2.9.0.1 or later </li> + <li> <a href="//skarnet.org/software/s6-rc/">s6-rc</a> version +0.5.1.1 or later </li> + <li> <a href="//skarnet.org/software/s6-linux-init/">s6-linux-init</a> version +1.0.3.1 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> + +<h3> Licensing </h3> + +<p> + s6-frontend is free software. It is available under the +<a href="http://opensource.org/licenses/ISC">ISC license</a>. +</p> + +<h3> Download </h3> + +<ul> + <li> The current released version of s6-frontend is +<a href="s6-frontend-0.0.1.0.tar.gz">0.0.1.0</a>. <strong><red>(unavailable while in development)</red></strong> </li> + <li> Alternatively, you can checkout a copy of the +<a href="//git.skarnet.org/cgi-bin/cgit.cgi/s6-frontend/">s6-frontend +git repository</a>: +<pre> git clone git://git.skarnet.org/s6-frontend </pre> </li> + <li> There's also a +<a href="https://github.com/skarnet/s6-frontend">GitHub mirror</a> +of the s6-frontend git repository. </li> +</ul> + +<h3> Compilation </h3> + +<ul> + <li> See the enclosed INSTALL file for installation details. </li> +</ul> + +<h3> Upgrade notes </h3> + +<ul> + <li> <a href="upgrade.html">This page</a> lists the differences to be aware of between +the previous versions of s6-frontend and the current one. </li> +</ul> + +<hr /> + +<h2> Reference </h2> + +<h3> Commands </h3> + +<p> + All these commands exit 111 if they encounter a temporary error, and +100 if they encounter a permanent error - such as a misuse. +</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> + +<ul> + <li> <tt>s6-frontend</tt> is discussed on the +<a href="//skarnet.org/lists.html#supervision">supervision</a> mailing-list. </li> + <li> There is a <tt>#s6</tt> IRC channel on Freenode. Sometimes people +are there and even answer questions. </li> +</ul> + +</body> +</html> diff --git a/doc/quickstart.html b/doc/quickstart.html new file mode 100644 index 0000000..6c99510 --- /dev/null +++ b/doc/quickstart.html @@ -0,0 +1,26 @@ +<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: quickstart and FAQ</title> + <meta name="Description" content="s6-frontend: quickstart and FAQ" /> + <meta name="Keywords" content="s6-frontend installation quickstart faq" /> + <!-- <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> Quickstart and FAQ for s6-frontend </h1> + +<p> + (To be written.) +</p> + +</body> +</html> diff --git a/doc/s6-frontend-alias.html b/doc/s6-frontend-alias.html new file mode 100644 index 0000000..4e824c9 --- /dev/null +++ b/doc/s6-frontend-alias.html @@ -0,0 +1,41 @@ +<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 s6-frontend-alias program </h1> + +<p> +s6-frontend-alias +</p> + +<h2> Interface </h2> + +<pre> + s6-frontend-alias +</pre> + +<p> +</p> + +<h2> Options </h2> + +<ul> + <li> <tt>-v</tt> : verbose. </li> +</ul> + +</body> +</html> diff --git a/doc/s6-frontend-config-preprocess.html b/doc/s6-frontend-config-preprocess.html new file mode 100644 index 0000000..f58ff7c --- /dev/null +++ b/doc/s6-frontend-config-preprocess.html @@ -0,0 +1,87 @@ +<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</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 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/doc/upgrade.html b/doc/upgrade.html new file mode 100644 index 0000000..24f7bfb --- /dev/null +++ b/doc/upgrade.html @@ -0,0 +1,28 @@ +<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: how to upgrade</title> + <meta name="Description" content="s6-frontend: how to upgrade" /> + <meta name="Keywords" content="s6-frontend installation upgrade" /> + <!-- <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> What has changed in s6-frontend </h1> + +<h2> in 0.0.1.0 </h2> + +<ul> + <li> Initial release. </li> +</ul> + +</body> +</html> |