diff options
| author | Laurent Bercot <ska-skaware@skarnet.org> | 2025-12-20 13:25:40 +0000 |
|---|---|---|
| committer | Laurent Bercot <ska-skaware@skarnet.org> | 2025-12-20 13:25:40 +0000 |
| commit | 6dd777fafbd23296d6bd91f8076f4b0ea5bae24e (patch) | |
| tree | 58d57a85299a33f5095c50b62ab587a27b2f27f8 /doc | |
| parent | a065d815b1153ea38c58d5f64a2bfdfe31d330a4 (diff) | |
| download | s6-rc-6dd777fafbd23296d6bd91f8076f4b0ea5bae24e.tar.gz | |
Add s6-rc-repo-list
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/repodefs.html | 3 | ||||
| -rw-r--r-- | doc/s6-rc-repo-list.html | 66 |
2 files changed, 68 insertions, 1 deletions
diff --git a/doc/repodefs.html b/doc/repodefs.html index bbd6811..8a8a6a9 100644 --- a/doc/repodefs.html +++ b/doc/repodefs.html @@ -282,7 +282,8 @@ here. </li> hardcoded in the stores) with <a href="s6-rc-set-new.html">s6-rc-set-new</a>, make a copy of an existing set with <a href="s6-rc-set-copy.html">s6-rc-set-copy</a>, or delete sets with <a href="s6-rc-set-delete.html">s6-rc-set-delete</a>. </li> - <li> They mask, unmask, enable or disable services in their favorite set with + <li> They can list the existing sets with <a href="s6-rc-repo-list.html">s6-rc-repo-list</a>. </li> + <li> They can mask, unmask, enable or disable services in their favorite set with <a href="s6-rc-set-change.html">s6-rc-set-change</a>. </li> <li> They can check the list of services and their subs with <a href="s6-rc-set-status.html">s6-rc-set-status</a>. </li> diff --git a/doc/s6-rc-repo-list.html b/doc/s6-rc-repo-list.html new file mode 100644 index 0000000..92869a1 --- /dev/null +++ b/doc/s6-rc-repo-list.html @@ -0,0 +1,66 @@ +<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-repo-list program</title> + <meta name="Description" content="s6-rc: the s6-rc-repo-list program" /> + <meta name="Keywords" content="s6-rc repo list ls sets" /> + <!-- <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-repo-list program </h1> + +<p> + s6-rc-repo-list lists all the <a href="repodefs.html#set">sets</a> in a +<a href="repodefs.html#repository">repository</a>. +</p> + +<h2> Interface </h2> + +<pre> + s6-rc-repo-list [ -v <em>verbosity</em> ] [ -r <em>repo</em> ] [ -x <em>exclude</em> ] +</pre> + +<ul> + <li> s6-rc-repo-list lists all the defined sets in the repository, printing +one set name per line. </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> + + <dt> -x <em>exclude</em>, --exclude=<em>exclude</em> </dt> + <dd> If the list contains a set named <em>exclude</em>, do not print it. +(This can save a <tt>grep -v</tt> invocation to automation using the result +of s6-rc-repo-list.) </dd> +</dl> + +<h2> Exit codes </h2> + +<dl> + <dt> 0 </dt> <dd> Success. </dd> + <dt> 100 </dt> <dd> Incorrect usage. </dd> + <dt> 111 </dt> <dd> System call failed. This usually signals an issue with the +underlying operating system. </dd> +</dl> + +</body> +</html> |