diff options
Diffstat (limited to 'doc/s6.conf.html')
| -rw-r--r-- | doc/s6.conf.html | 105 |
1 files changed, 105 insertions, 0 deletions
diff --git a/doc/s6.conf.html b/doc/s6.conf.html new file mode 100644 index 0000000..39b1e76 --- /dev/null +++ b/doc/s6.conf.html @@ -0,0 +1,105 @@ +<html> + <head> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="color-scheme" content="dark light" /> + <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + <meta http-equiv="Content-Language" content="en" /> + <title>s6-frontend: the s6.conf configuration file</title> + <meta name="Description" content="s6-frontend: the s6.conf configuration file" /> + <meta name="Keywords" content="s6.conf s6-frontend configuration file execline variable" /> + <!-- <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>/etc/s6.conf</tt> configuration file </h1> + +<h2 id="goal"> Goal and usage </h2> + +<p> + <tt>/etc/s6.conf</tt> is a configuration file provided by the +distribution, or written by the system administrator, defining various +settings for the <a href="s6.html">s6</a> commands, as well as the default +policies of an s6-based system (i.e. where various directories and files +are located). +</p> + +<p> + For instance, this is what allows the +<a href="s6_process_restart#restart">s6 process restart foobar</a> command to send +<a href="//skarnet.org/software/s6/s6-svc.html">s6-svc -r</a> to the +<em>foobar</em> service without the user needing to type, or even remember, +what the full path to the <em>foobar</em> service directory is. +</p> + +<h2 id="description"> Description </h2> + +<p> +The <tt>/etc/s6.conf</tt> file follows the +<a href="//skarnet.org/software/execline/envfile.html#syntax">envfile syntax</a>: +simple <code>key = value</code> lines, comments permitted. +</p> + +<p> + If a value is left empty, the compiled-in default is used. +</p> + +<p> + The variables that can be set are the following: +</p> + +<dl> +<dt> scandir </dt> +<dd> The directory where <a href="//skarnet.org/software/s6/s6-svscan.html">s6-svscan</a> +is running. +The default is <tt>/run/service</tt> (possibly overridden by the <tt>--scandir</tt> build-time configure option to +<a href="//skarnet.org/software/s6-linux-init/">s6-linux-init</a> or to +<a href="//skarnet.org/software/s6-frontend/">s6-frontend</a>). </dd> + +<dt> livedir </dt> +<dd> The directory hosting the live service database managed by +<a href="//skarnet.org/software/s6-rc/s6-rc.html">s6-rc</a>. +The default is <tt>/run/s6-rc</tt> (possibly overridden by the <tt>--livedir</tt> build-time configure option to +<a href="//skarnet.org/software/s6-rc/">s6-rc</a> or to +<a href="//skarnet.org/software/s6-frontend/">s6-frontend</a>). </dd> + +<dt> repodir </dt> +<dd> The directory hosting the repository of service sets managed by the +<a href="//skarnet.org/software/s6-rc/repodefs.html">s6-rc <em>repo</em> commands</a>. +The default is <tt>/var/lib/s6-rc/repository</tt> (possibly overridden by the <tt>--repodir</tt> build-time configure option to +<a href="//skarnet.org/software/s6-rc/">s6-rc</a> or to +<a href="//skarnet.org/software/s6-frontend/">s6-frontend</a>). </dd> + +<dt> bootdb </dt> +<dd> The path to the boot-time compiled service database. +The default is <tt>/etc/s6-rc/compiled/current</tt> (possibly overridden by the <tt>--bootdb</tt> build-time configure option to +<a href="//skarnet.org/software/s6-rc/">s6-rc</a> or to +<a href="//skarnet.org/software/s6-frontend/">s6-frontend</a>). </dd> + +<dt> stmpdir </dt> +<dd> A directory suitable for root-only runtime data and temporary files for s6-frontend. +The default is <tt>/run/s6-frontend</tt> (possibly overridden by the <tt>--stmpdir</tt> build-time configure option to +<a href="//skarnet.org/software/s6-frontend/">s6-frontend</a>). </dd> + +<dt> storelist </dt> +<dd> A colon-separated (<tt>:</tt>) list of directories containing the +<a href="//skarnet.org/software/s6-rc/repodefs.html#store">stores</a> of s6-rc service +definition directories. +The default is <tt>/usr/share/s6/sources:/etc/s6/sources</tt> +(possibly overridden by the <tt>--storelist</tt> build-time configure option to +<a href="//skarnet.org/software/s6-frontend/">s6-frontend</a>). </dd> + +<dt> verbosity </dt> +<dd> The default verbosity for <a href="s6.html">s6</a> and its invoked commands. 0 is +terse (only print fatal error messages), 1 is normal (print error messages and warnings), +over 1 is increasingly verbose (print informational messages, up to tracing and debug +messages at level 4-5). The default is <strong>1</strong>. </dd> +</dl> + +</body> +</html> |
