summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLaurent Bercot <ska-skaware@skarnet.org>2020-03-30 17:21:37 +0000
committerLaurent Bercot <ska-skaware@skarnet.org>2020-03-30 17:21:37 +0000
commitf98ae7a1bc204afa4badc3593d8422a6efa977d9 (patch)
treebf6cc7f9705a5a0cf18099d6d916c9b8b8dcf5de /doc
parente59f30c77eab4c98d77a34fa69d6d1e6b1a87390 (diff)
downloads6-f98ae7a1bc204afa4badc3593d8422a6efa977d9.tar.xz
heliocat's html fixes
Diffstat (limited to 'doc')
-rw-r--r--doc/fifodir.html2
-rw-r--r--doc/index.html9
-rw-r--r--doc/libs6/s6-fdholder.html2
-rw-r--r--doc/libs6/s6lockd-helper.html4
-rw-r--r--doc/libs6/s6lockd.html5
-rw-r--r--doc/overview.html3
-rw-r--r--doc/s6-accessrules-cdb-from-fs.html12
-rw-r--r--doc/s6-accessrules-fs-from-cdb.html6
-rw-r--r--doc/s6-connlimit.html2
-rw-r--r--doc/s6-fdholder-getdump.html2
-rw-r--r--doc/s6-fdholderd.html4
-rw-r--r--doc/s6-log.html2
-rw-r--r--doc/s6-sudo.html2
-rw-r--r--doc/s6-svstat.html1
-rw-r--r--doc/servicedir.html2
-rw-r--r--doc/upgrade.html16
16 files changed, 32 insertions, 42 deletions
diff --git a/doc/fifodir.html b/doc/fifodir.html
index 7c01ca0..811ed38 100644
--- a/doc/fifodir.html
+++ b/doc/fifodir.html
@@ -152,7 +152,7 @@ can write to the fifo </li>
</ul>
<p>
- The <a href="ftrig.html">libftrig<a/> interface takes care of all
+ The <a href="ftrig.html">libftrig</a> interface takes care of all
the subtleties.
</p>
diff --git a/doc/index.html b/doc/index.html
index 4f70ad2..421646e 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -198,20 +198,14 @@ synchronization</a>.
<li><a href="s6-mkfifodir.html">The <tt>s6-mkfifodir</tt> program</a></li>
<li><a href="s6-cleanfifodir.html">The <tt>s6-cleanfifodir</tt> program</a></li>
</ul>
-<p>
-</p>
<ul>
<li><a href="s6-ftrig-notify.html">The <tt>s6-ftrig-notify</tt> program</a></li>
</ul>
-<p>
-</p>
<ul>
<li><a href="s6-ftrig-wait.html">The <tt>s6-ftrig-wait</tt> program</a></li>
<li><a href="s6-ftrig-listen1.html">The <tt>s6-ftrig-listen1</tt> program</a></li>
<li><a href="s6-ftrig-listen.html">The <tt>s6-ftrig-listen</tt> program</a></li>
</ul>
-<p>
-</p>
<ul>
<li><a href="libs6/s6-ftrigrd.html">The <tt>s6-ftrigrd</tt> internal program</a></li>
</ul>
@@ -225,12 +219,10 @@ synchronization</a>.
<li><a href="s6-ipcserverd.html">The <tt>s6-ipcserverd</tt> program</a></li>
<li><a href="s6-ioconnect.html">The <tt>s6-ioconnect</tt> program</a></li>
</ul>
-<p></p>
<ul>
<li><a href="s6-ipcserver-access.html">The <tt>s6-ipcserver-access</tt> program</a></li>
<li><a href="s6-connlimit.html">The <tt>s6-connlimit</tt> program</a></li>
</ul>
-<p></p>
<ul>
<li><a href="s6-accessrules-cdb-from-fs.html">The <tt>s6-accessrules-cdb-from-fs</tt> program</a></li>
<li><a href="s6-accessrules-fs-from-cdb.html">The <tt>s6-accessrules-fs-from-cdb</tt> program</a></li>
@@ -265,7 +257,6 @@ synchronization</a>.
<li><a href="s6-fdholder-daemon.html">The <tt>s6-fdholder-daemon</tt> program</a></li>
<li><a href="s6-fdholderd.html">The <tt>s6-fdholderd</tt> program</a></li>
</ul>
-<p></p>
<ul>
<li><a href="s6-fdholder-store.html">The <tt>s6-fdholder-store</tt> program</a></li>
<li><a href="s6-fdholder-retrieve.html">The <tt>s6-fdholder-retrieve</tt> program</a></li>
diff --git a/doc/libs6/s6-fdholder.html b/doc/libs6/s6-fdholder.html
index 6aabe39..38a2343 100644
--- a/doc/libs6/s6-fdholder.html
+++ b/doc/libs6/s6-fdholder.html
@@ -67,7 +67,7 @@ tain_now_g() ;
s6_fdholder_init(&amp;a, fd) ;
(...)
-s6_fdholder_free(&a) ;
+s6_fdholder_free(&amp;a) ;
</pre>
<p>
diff --git a/doc/libs6/s6lockd-helper.html b/doc/libs6/s6lockd-helper.html
index 1d4c558..bc3d1a5 100644
--- a/doc/libs6/s6lockd-helper.html
+++ b/doc/libs6/s6lockd-helper.html
@@ -10,10 +10,12 @@
</head>
<body>
+<p>
<a href="index.html">libs6</a><br />
<a href="../">s6</a><br />
<a href="//skarnet.org/software/">Software</a><br />
-<a href="//skarnet.org/">skarnet.org</a><p />
+<a href="//skarnet.org/">skarnet.org</a>
+</p>
<h1> The <tt>s6lockd-helper</tt> program </h1>
diff --git a/doc/libs6/s6lockd.html b/doc/libs6/s6lockd.html
index 4acfb2a..9fcb055 100644
--- a/doc/libs6/s6lockd.html
+++ b/doc/libs6/s6lockd.html
@@ -10,10 +10,12 @@
</head>
<body>
+<p>
<a href="index.html">libs6</a><br />
<a href="../">s6</a><br />
<a href="//skarnet.org/software/">Software</a><br />
-<a href="//skarnet.org/">skarnet.org</a><p />
+<a href="//skarnet.org/">skarnet.org</a>
+</p>
<h1> The <tt>s6lockd</tt> program </h1>
@@ -49,7 +51,6 @@ client with different permissions. </li>
For once, <em>this is the recommended setup</em>: s6lockd creates empty
lock files, and having all s6lockd instances run under the same user
simplifies permissions management considerably. </li>
- </li>
</ol>
<p>
diff --git a/doc/overview.html b/doc/overview.html
index 781fa70..cecdde6 100644
--- a/doc/overview.html
+++ b/doc/overview.html
@@ -305,9 +305,6 @@ the same PID.)
</p>
<p>
-</p>
-
-<p>
Some examples of s6 programs meant to be used in run scripts:
</p>
diff --git a/doc/s6-accessrules-cdb-from-fs.html b/doc/s6-accessrules-cdb-from-fs.html
index 2f435bc..9ca2bcd 100644
--- a/doc/s6-accessrules-cdb-from-fs.html
+++ b/doc/s6-accessrules-cdb-from-fs.html
@@ -21,8 +21,8 @@
<p>
<tt>s6-accessrules-cdb-from-fs</tt> compiles a directory
containing a ruleset suitable for
-<a href="s6-ipcserver-access.html">s6-ipcserver-access<a> or
-<a href="//skarnet.org/software/s6-networking/s6-tcpserver-access.html">s6-tcpserver-access<a> into a
+<a href="s6-ipcserver-access.html">s6-ipcserver-access</a> or
+<a href="//skarnet.org/software/s6-networking/s6-tcpserver-access.html">s6-tcpserver-access</a> into a
<a href="http://en.wikipedia.org/wiki/Cdb_(software)">CDB file</a>.
</p>
@@ -43,8 +43,8 @@ directory containing a ruleset into a
<p>
To be understood by s6-accessrules-cdb-from-fs,
-<a href="s6-ipcserver-access.html">s6-ipcserver-access<a>, or
-<a href="//skarnet.org/software/s6-networking/s6-tcpserver-access.html">s6-tcpserver-access<a>,
+<a href="s6-ipcserver-access.html">s6-ipcserver-access</a>, or
+<a href="//skarnet.org/software/s6-networking/s6-tcpserver-access.html">s6-tcpserver-access</a>,
<em>dir</em> must have a specific format.
</p>
@@ -63,9 +63,9 @@ directory containing a ruleset into a
<p>
Depending on the application, other directories can appear in <em>dir</em>
and be compiled into <em>cdbfile</em>, but
-<a href="//skarnet.org/software/s6-networking/s6-tcpserver-access.html">s6-tcpserver-access<a> only
+<a href="//skarnet.org/software/s6-networking/s6-tcpserver-access.html">s6-tcpserver-access</a> only
uses the first three, and
-<a href="s6-ipcserver-access.html">s6-ipcserver-access<a> only
+<a href="s6-ipcserver-access.html">s6-ipcserver-access</a> only
uses the last two.
</p>
diff --git a/doc/s6-accessrules-fs-from-cdb.html b/doc/s6-accessrules-fs-from-cdb.html
index 4873ce3..57aad97 100644
--- a/doc/s6-accessrules-fs-from-cdb.html
+++ b/doc/s6-accessrules-fs-from-cdb.html
@@ -21,10 +21,10 @@
<p>
<tt>s6-accessrules-fs-from-cdb</tt> decompiles a CDB database
containing a ruleset suitable for
-<a href="s6-ipcserver-access.html">s6-ipcserver-access<a> or
-<a href="//skarnet.org/software/s6-networking/s6-tcpserver-access.html">s6-tcpserver-access<a> and
+<a href="s6-ipcserver-access.html">s6-ipcserver-access</a> or
+<a href="//skarnet.org/software/s6-networking/s6-tcpserver-access.html">s6-tcpserver-access</a> and
that has been compiled with
-<a href="s6-accessrules-cdb-from-fs.html">s6-accessrules-cdb-from-fs<a>.
+<a href="s6-accessrules-cdb-from-fs.html">s6-accessrules-cdb-from-fs</a>.
</p>
<h2> Interface </h2>
diff --git a/doc/s6-connlimit.html b/doc/s6-connlimit.html
index fb7d0c2..aeb739d 100644
--- a/doc/s6-connlimit.html
+++ b/doc/s6-connlimit.html
@@ -97,7 +97,7 @@ default of 40.
<ul>
<li> The s6-connlimit utility was once part of the
-<a href=""//skarnet.org/software/s6-networking/">s6-networking</a>
+<a href="//skarnet.org/software/s6-networking/">s6-networking</a>
suite, and is mostly useful with TCP connections, which is why the
examples here involve TCP. Nevertheless, it can be used with connections
across Unix domain sockets, and that is why it has been moved to the s6
diff --git a/doc/s6-fdholder-getdump.html b/doc/s6-fdholder-getdump.html
index 46bb2b6..513d276 100644
--- a/doc/s6-fdholder-getdump.html
+++ b/doc/s6-fdholder-getdump.html
@@ -84,7 +84,7 @@ open file descriptor. </li>
<li> <tt>S6_FDLIMIT_<em>i</em></tt>&nbsp;: contains the expiration date of
the <em>i</em>th open file descriptor, if applicable. That date is stored in
<a href="http://cr.yp.to/libtai/tai64.html#tai64n">external TAI64N
-format</a>. </li>
+format</a>.<br />
If the file descriptor is not supposed to expire, that environment variable
is not defined. </li>
</ul> </li>
diff --git a/doc/s6-fdholderd.html b/doc/s6-fdholderd.html
index 171b1c7..4b4794b 100644
--- a/doc/s6-fdholderd.html
+++ b/doc/s6-fdholderd.html
@@ -126,8 +126,8 @@ special characters will be quoted when printed by
recommended to only use reasonable characters in identifiers: clients
should be able to know at a glance what file descriptor is represented by
an identifier. Identifiers have no special meaning to the server. </li>
- <li> A good convention is to use <tt>unix:/<em>path</em>/<em>to</em>/<em>socket</em></tt> for
-Unix domain sockets and <tt><em>protocol</em>:<em>ip</em>:</em><em>port</em></tt>
+ <li> A good convention is to use <tt>unix:<em>path</em>/<em>to</em>/<em>socket</em></tt> for
+Unix domain sockets and <tt><em>protocol</em>:<em>ip</em>:<em>port</em></tt>
for INET domain sockets. </li>
<li> An identifier is chosen by the storing client, within the limits of
what the server authorizes it to use. </li>
diff --git a/doc/s6-log.html b/doc/s6-log.html
index f042c70..9384fa9 100644
--- a/doc/s6-log.html
+++ b/doc/s6-log.html
@@ -452,7 +452,7 @@ error descriptor</em>, i.e. fd 2. <em>This is why it's open for.</em> </li>
<li> When process 1 starts, the logging chain is rooted to the
<em>machine console</em>: anything process 1 sends to its stderr
appears, without modification, on the machine console, which should
-at any time remain the last resort place where logs are sent. </em>
+at any time remain the last resort place where logs are sent. </li>
<li> Process 1 should spawn and supervise a <em>catch-all logging
mechanism</em> that handles logs from every service that does not
take care of its own logging. Error messages from this logging
diff --git a/doc/s6-sudo.html b/doc/s6-sudo.html
index 3fdd38f..00232cd 100644
--- a/doc/s6-sudo.html
+++ b/doc/s6-sudo.html
@@ -47,7 +47,7 @@ client's behalf. </li>
<h2> Options </h2>
<ul>
- <li> The <tt>-q</tt>, <tt>-Q</tt>, <tt>-v</tt>, <tt>-p</tt> and </tt>-l</tt>
+ <li> The <tt>-q</tt>, <tt>-Q</tt>, <tt>-v</tt>, <tt>-p</tt> and <tt>-l</tt>
options are passed to <a href="s6-ipcclient.html">s6-ipcclient</a>. </li>
<li> The <tt>-e</tt>, <tt>-t</tt> and <tt>-T</tt> options are passed to
<a href="s6-sudoc.html">s6-sudoc</a>. </li>
diff --git a/doc/s6-svstat.html b/doc/s6-svstat.html
index d40ec3b..d90e1f1 100644
--- a/doc/s6-svstat.html
+++ b/doc/s6-svstat.html
@@ -58,7 +58,6 @@ if it is, the number of seconds that it has been.
A service reported as down and ready simply means that it is ready
to be brought up. A service is down and not ready when it is in the
cleanup phase, i.e. the <tt>./finish</tt> script is still being executed. </li>
- </li>
</ul>
<p>
diff --git a/doc/servicedir.html b/doc/servicedir.html
index 31bf751..7c5d613 100644
--- a/doc/servicedir.html
+++ b/doc/servicedir.html
@@ -56,7 +56,7 @@ if your service is logged, the run script should make sure that its
stderr goes into the log pipe (which is on stdout by default), which
is achieved by <tt><a href="//skarnet.org/software/execline/fdmove.html">fdmove</a>
-c 2 1</tt> in <a href="//skarnet.org/software/execline/">execline</a>,
-and <tt>exec 2>&1</tt> in <a href="http://pubs.opengroup.org/onlinepubs/9699919799/utilities/sh.html">shell</a>.
+and <tt>exec 2&gt;&amp;1</tt> in <a href="http://pubs.opengroup.org/onlinepubs/9699919799/utilities/sh.html">shell</a>.
By default, in a normal supervision tree situation, a run script's stdin will
be <tt>/dev/null</tt>, and its stdout and stderr will both be a pipe to a
catch-all logging program. </li>
diff --git a/doc/upgrade.html b/doc/upgrade.html
index f7413f5..a26fc88 100644
--- a/doc/upgrade.html
+++ b/doc/upgrade.html
@@ -27,7 +27,7 @@
<h2> in 2.9.1.0 </h2>
<ul>
- <li> <a href="//skarnet.org/software/skalibs/"></a>skalibs</a>
+ <li> <a href="//skarnet.org/software/skalibs/">skalibs</a>
dependency bumped to 2.9.2.0. </li>
<li> <a href="//skarnet.org/software/execline/">execline</a>
dependency bumped to 2.6.0.0. (And made optional, see below.) </li>
@@ -38,17 +38,17 @@ disabled when execline support is disabled. </li>
<li> A new '?' directive has been added to <a href="s6-log.html">s6-log</a>,
it declares a processor command line that is spawned with the <tt>/bin/sh</tt>
interpreter. </li>
- <li> A new <tt>-X</tt> option has been added to <a href="s6-svscan.html>s6-svscan</a>
+ <li> A new <tt>-X</tt> option has been added to <a href="s6-svscan.html">s6-svscan</a>
to better support <a href="//skarnet.org/software/s6-linux-init/">s6-linux-init</a>
installations. </li>
- <li> <a href="s6-svscan.html>s6-svscan</a> now handles SIGPWR and SIGWINCH, when
+ <li> <a href="s6-svscan.html">s6-svscan</a> now handles SIGPWR and SIGWINCH, when
diverted, on systems that define those signals. </li>
</ul>
<h2> in 2.9.0.1 </h2>
<ul>
- <li> <a href="//skarnet.org/software/skalibs/"></a>skalibs</a>
+ <li> <a href="//skarnet.org/software/skalibs/">skalibs</a>
dependency bumped to 2.9.1.0. </li>
<li> <a href="//skarnet.org/software/execline/">execline</a>
dependency bumped to 2.5.3.0. </li>
@@ -57,7 +57,7 @@ dependency bumped to 2.5.3.0. </li>
<h2> in 2.9.0.0 </h2>
<ul>
- <li> <a href="//skarnet.org/software/skalibs/"></a>skalibs</a>
+ <li> <a href="//skarnet.org/software/skalibs/">skalibs</a>
dependency bumped to 2.9.0.0. </li>
<li> <a href="//skarnet.org/software/execline/">execline</a>
dependency bumped to 2.5.2.0. </li>
@@ -68,14 +68,14 @@ removed. </li>
<h2> in 2.8.0.1 </h2>
<ul>
- <li> <a href="//skarnet.org/software/skalibs/"></a>skalibs</a>
+ <li> <a href="//skarnet.org/software/skalibs/">skalibs</a>
dependency bumped to 2.8.1.0. </li>
</ul>
<h2> in 2.8.0.0 </h2>
<ul>
- <li> <a href="//skarnet.org/software/skalibs/"></a>skalibs</a>
+ <li> <a href="//skarnet.org/software/skalibs/">skalibs</a>
dependency bumped to 2.8.0.0. </li>
<li> <a href="//skarnet.org/software/execline/">execline</a>
dependency bumped to 2.5.1.0. </li>
@@ -110,7 +110,7 @@ supervision tree, then start your services again. Failure to do so
<ul>
<li> Optional <a href="//skarnet.org/software/nsss/">nsss</a> support added. </li>
- <li> <a href="//skarnet.org/software/skalibs/"></a>skalibs</a>
+ <li> <a href="//skarnet.org/software/skalibs/">skalibs</a>
dependency bumped to 2.7.0.0. </li>
<li> <a href="//skarnet.org/software/execline/">execline</a>
dependency bumped to 2.5.0.1. </li>