From d4ce4dc23a189daae4310f9b727ea92454b734ab Mon Sep 17 00:00:00 2001
From: Laurent Bercot <ska-skaware@skarnet.org>
Date: Tue, 31 Dec 2019 01:20:10 +0000
Subject:  Add s6-frontend-alias* documentation

---
 doc/s6-frontend-alias-sv.html | 35 ++++++++++++++++++++++++++++++-----
 1 file changed, 30 insertions(+), 5 deletions(-)

(limited to 'doc/s6-frontend-alias-sv.html')

diff --git a/doc/s6-frontend-alias-sv.html b/doc/s6-frontend-alias-sv.html
index 8c1f92a..a619661 100644
--- a/doc/s6-frontend-alias-sv.html
+++ b/doc/s6-frontend-alias-sv.html
@@ -16,25 +16,50 @@
 <a href="//skarnet.org/">skarnet.org</a>
 </p>
 
-<h1> The s6-frontend-alias-sv program </h1>
+<h1> The <tt>s6-frontend-alias-sv</tt> program </h1>
 
 <p>
-s6-frontend-alias-sv
+<tt>s6-frontend-alias-sv</tt> implements
+<a href="http://smarden.org/runit/">runit</a>'s
+<a href="http://smarden.org/runit/sv.8.html">sv</a> command over a
+<a href="//skarnet.org/software/s6/">s6</a> supervision tree, via
+native <a href="//skarnet.org/software/s6/">s6</a> commands.
+
 </p>
 
 <h2> Interface </h2>
 
 <pre>
-     s6-frontend-alias-sv
+     s6-frontend-alias-sv [ -v ] [ -w <em>secs</em> ] <em>command</em> <em>services...</em>
 </pre>
 
 <p>
+ When s6-frontend has been configured with the
+<tt>--enable-aliases-runit</tt> option, the
+<tt>s6-frontend-alias-sv</tt> program is built, and at installation
+time, a <tt>sv</tt> symbolic link is created, pointing to it.
+</p>
+
+<p>
+ <tt>s6-frontend-alias-sv</tt> implements most of the functionality of
+<a href="http://smarden.org/runit/sv.8.html">sv</a>, as closely as
+possible. When some functionality cannot be emulated on a s6
+supervision tree, it prints an error message to stderr and exits 100.
 </p>
 
-<h2> Options </h2>
+<h2> Notes </h2>
 
 <ul>
- <li> <tt>-v</tt>&nbsp;: verbose. </li>
+ <li> <tt>s6-frontend-alias-sv</tt> is a convenience program, written
+so that runit users can keep using <tt>sv</tt> to control their
+s6 services. However, it is not an "official" interface, because there
+are a few fundamental differences between the conception of runit and
+the conception of s6 that make <tt>sv</tt> a poor fit to accurately
+interface with the advanced features of s6. It is recommended that
+<tt>sv</tt> users become familiar with idiomatic s6 commands such as
+<a href="//skarnet.org/software/s6/s6-svc.html">s6-svc</a>,
+<a href="//skarnet.org/software/s6/s6-svstat.html">s6-svstat</a>, and
+<a href="//skarnet.org/software/s6/s6-svwait.html">s6-svwait</a>. </li>
 </ul>
 
 </body>
-- 
cgit v1.3.1