diff options
Diffstat (limited to 'doc/s6-rc-set-list.html')
| -rw-r--r-- | doc/s6-rc-set-list.html | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/doc/s6-rc-set-list.html b/doc/s6-rc-set-list.html new file mode 100644 index 0000000..18a04ee --- /dev/null +++ b/doc/s6-rc-set-list.html @@ -0,0 +1,78 @@ +<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-rc: the s6-rc-set-list program</title> + <meta name="Description" content="s6-rc: the s6-rc-set-list program" /> + <meta name="Keywords" content="s6-rc s6-rc-set-list repo set sub list services" /> + <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> --> + </head> +<body> + +<p> +<a href="index.html">s6-rc</a><br /> +<a href="//skarnet.org/software/">Software</a><br /> +<a href="//skarnet.org/">skarnet.org</a> +</p> + +<h1> The s6-rc-set-list program </h1> + +<p> + s6-rc-set-list lists all the services of a <a href="repodefs.html#set">set</a>, +along with the <a href="repodefs.html#sub">sub</a> each service is on. +</p> + +<h2> Interface </h2> + +<pre> + s6-rc-set-list [ -v <em>verbosity</em> ] [ -r <em>repo</em> ] <em>set</em> +</pre> + +<ul> + <li> s6-rc-set-list prints all the services in set <em>set</em> of repository +<em>repo</em>, one per line, to stdout. Each line contains: + <ul> + <li> The name of the service </li> + <li> A slash (<tt>/</tt>) character </li> + <li> The canonical name for the sub the service is in. </li> + </ul> </li> + <li> It exits 0. </li> +</ul> + +<h2> Options </h2> + +<dl> + <dt> -v <em>verbosity</em>, --verbosity=<em>verbosity</em> </dt> + <dd> Be more or less verbose. The default is <strong>1</strong>, which means +that error messages and warnings will be written to stderr. 0 means that only +error messages will be written, and 2 or more adds informational messages. </dd> + + <dt> -r <em>repo</em>, --repository=<em>repo</em> </dt> + <dd> Use the repository in <em>repo</em>, which must exist. Default is +<strong>/var/lib/s6-rc/repository</strong>. + </dd> +</dl> + +<h2> Exit codes </h2> + +<dl> + <dt> 0 </dt> <dd> Success. </dd> + <dt> 3 </dt> <dd> Nonexistent set. </dd> + <dt> 100 </dt> <dd> Incorrect usage. </dd> + <dt> 102 </dt> <dd> Invalid repository. </dd> + <dt> 111 </dt> <dd> System call failed. </dd> +</dl> + +<h2> Notes </h2> + +<ul> + <li> s6-rc-set-list is meant to be used with automation such as +<a href="https://pubs.opengroup.org/onlinepubs/9799919799/utilities/cut.html">cut</a> +or util-linux's <a href="https://man7.org/linux/man-pages/man1/column.1.html">column</a> +for formatting. A slash is used to separate the service name for the sub because +slashes cannot appear in service names. </li> +</ul> + +</body> +</html> |
