summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLaurent Bercot <ska-skaware@skarnet.org>2021-01-07 23:38:06 +0000
committerLaurent Bercot <ska-skaware@skarnet.org>2021-01-07 23:38:06 +0000
commitc771aabafeaea4ba903dd8f06ad6fc1e95504946 (patch)
tree7c101679ac52be46827de669440883c6ef1c9a6c /doc
parentf481d14e9d9c5b2d57995aa0d9094500676e013e (diff)
downloads6-c771aabafeaea4ba903dd8f06ad6fc1e95504946.tar.xz
Doc clarification, QoL fix for s6-usertree-maker
Diffstat (limited to 'doc')
-rw-r--r--doc/s6-usertree-maker.html22
1 files changed, 20 insertions, 2 deletions
diff --git a/doc/s6-usertree-maker.html b/doc/s6-usertree-maker.html
index 4756006..847f04a 100644
--- a/doc/s6-usertree-maker.html
+++ b/doc/s6-usertree-maker.html
@@ -39,7 +39,7 @@ for the <a href="//skarnet.org/software/s6-rc/">s6-rc</a> service manager.
[ -d <em>userscandir</em> ] \
[ -p <em>path</em> ] \
[ -E <em>envdir</em> [ -e <em>var</em> -e <em>var</em> ... ] ] \
- [ -r <em>service</em>/<em>logger</em>/<em>pipeline</em> ] \
+ [ -r <em>service</em>/<em>logger</em>[/<em>pipeline</em>] ] \
[ -l <em>loguser</em> ] \
[ -t <em>stamptype</em> ] \
[ -n <em>nfiles</em> ] \
@@ -208,7 +208,7 @@ then <a href="s6-svscan.html">s6-svscan</a> will be run on
<tt>/home/ska/service</tt>.
</p>
-<h2> Example </h2>
+<h2> Examples </h2>
<pre>
s6-usertree-maker -d '/run/user/${UID}/service' -p '${HOME}/bin:/usr/bin:/bin' -E /etc/user-env -e XDG_CONFIG_HOME -l catchlog ska /var/log/usertree/ska usertree-ska
@@ -225,6 +225,24 @@ as user catchlog, and storing its data in the <tt>/var/log/usertree/ska</tt>
directory.
</p>
+<p>
+ Note that simple quotes are used here to prevent the shell from
+interpreting <tt>${UID}</tt> and <tt>${HOME}</tt>.
+</p>
+
+<pre>
+ s6-usertree-maker -d '/run/user/${UID}/service' -p '${HOME}/bin:/usr/bin:/bin' -E /etc/user-env -e XDG_CONFIG_HOME -l catchlog -r usertree-ska/usertree-ska-log/usertree-ska-pipeline ska /var/log/usertree/ska usertree
+</pre>
+
+<p>
+ Same as above, except it does not create a service directory &mdash; instead, it
+creates a <tt>usertree</tt> directory containing two subdirectories: <tt>usertree-ska</tt>, the
+<a href="//skarnet.org/software/s6-rc/">s6-rc</a> source definition directory
+for the service, and <tt>usertree-ska-log</tt>, the source definition directory
+for its logger, and an implicit <tt>usertree-ska-pipeline</tt> bundle
+containing both the service and the logger.
+</p>
+
<h2> Notes </h2>
<ul>