summaryrefslogtreecommitdiff
path: root/doc/libs6
diff options
context:
space:
mode:
authorLaurent Bercot <ska-skaware@skarnet.org>2020-09-16 12:04:55 +0000
committerLaurent Bercot <ska-skaware@skarnet.org>2020-09-16 12:04:55 +0000
commitb0fe68c13b04af8c098d53ea999bba6b7395163d (patch)
tree298bab9f755edd10f4fd09c22beadb89f05f1be3 /doc/libs6
parent997b02adcc8384906339ea81ece5ba7244f3ef60 (diff)
downloads6-b0fe68c13b04af8c098d53ea999bba6b7395163d.tar.xz
Documentation fixes, by flexibeast
Diffstat (limited to 'doc/libs6')
-rw-r--r--doc/libs6/accessrules.html8
-rw-r--r--doc/libs6/ftrigr.html8
-rw-r--r--doc/libs6/s6-fdholder.html2
-rw-r--r--doc/libs6/s6-ftrigrd.html8
-rw-r--r--doc/libs6/s6lock.html8
-rw-r--r--doc/libs6/s6lockd.html12
6 files changed, 23 insertions, 23 deletions
diff --git a/doc/libs6/accessrules.html b/doc/libs6/accessrules.html
index 2360cfc..51d0a58 100644
--- a/doc/libs6/accessrules.html
+++ b/doc/libs6/accessrules.html
@@ -88,7 +88,7 @@ under, in the format understood by
<a href="../s6-accessrules-cdb-from-fs.html">s6-accessrules-cdb-from-fs</a>. </li>
<li> <tt>s6_accessrules_backend_cdb</tt> takes a <tt>struct cdb *</tt>
<em>handle</em> and looks up <em>key</em> in the
-<a href="http://cr.yp.to/cdb.html">CDB</a> it points to. <em>handle</em> must
+<a href="https://cr.yp.to/cdb.html">CDB</a> it points to. <em>handle</em> must
already be mapped to a CDB file. Such a file can be built with the
<a href="../s6-accessrules-cdb-from-fs.html">s6-accessrules-cdb-from-fs</a>
utility. </li>
@@ -143,7 +143,7 @@ starting with <em>key</em> itself and ending with <em>key</em>'s TLD,
it looks up <tt>reversedns/<em>k</em></tt>. The final dot is excluded from
<em>k</em>. If no match can be found, the function checks <tt>reversedns/@</tt>
and returns the result. For instance, if <em>key</em> is "foo.bar.com",
-the following strings are looked up, in that order:
+the following strings are looked up, in this order:
<ul>
<li> reversedns/foo.bar.com </li>
<li> reversedns/bar.com </li>
@@ -158,7 +158,7 @@ netmask <em>mask</em> from 32 to 0, it constructs the IPv4 network
prefix <em>addr</em> corresponding to that address, and looks up
<tt>ip4/<em>addr</em>_<em>mask</em></tt>. For instance, if <em>key</em>
is "\300\250\001\007", representing the 192.168.1.7 address, the following
-strings are looked up, in that order:
+strings are looked up, in this order:
<ul>
<li> ip4/192.168.1.7_32 </li>
<li> ip4/192.168.1.6_31 </li>
@@ -187,7 +187,7 @@ and looks up
<tt>ip6/<em>addr</em>_<em>mask</em></tt>. For instance, if <em>key</em>
is "*\0\024P@\002\b\003\0\0\0\0\0\0\020\006", representing the
2a00:1450:4002:803::1006 address, the following
-strings are looked up, in that order:
+strings are looked up, in this order:
<ul>
<li> ip6/2a00:1450:4002:803::1006_128 </li>
<li> ip6/2a00:1450:4002:803::1006_127 </li>
diff --git a/doc/libs6/ftrigr.html b/doc/libs6/ftrigr.html
index 84ab1cd..d1b2efe 100644
--- a/doc/libs6/ftrigr.html
+++ b/doc/libs6/ftrigr.html
@@ -45,7 +45,7 @@ simply ignoring pids you don't know.
<p>
If your application has trouble handling unknown
-children, consider using a ftrigrd service. (And fix your application!)
+children, consider using an ftrigrd service. (And fix your application!)
</p>
<h3> A programming example </h3>
@@ -112,11 +112,11 @@ ftrigr_startf(&amp;a, &amp;deadline, &amp;stamp) ;
</pre>
<p>
-<tt>ftrigr_start</tt> starts a session with a ftrigrd service listening on
+<tt>ftrigr_start</tt> starts a session with an ftrigrd service listening on
<em>path</em>. <br />
-<tt>ftrigr_startf</tt> starts a session with a ftrigrd process as a child
+<tt>ftrigr_startf</tt> starts a session with an ftrigrd process as a child
(which is the simplest usage). <br />
-<tt>a</tt> is a ftrigr_t structure that must be declared in the stack and
+<tt>a</tt> is an ftrigr_t structure that must be declared in the stack and
initialized to FTRIGR_ZERO.
<tt>stamp</tt> must be an accurate enough timestamp. <br />
If the session initialization fails, the function returns 0 and errno is set;
diff --git a/doc/libs6/s6-fdholder.html b/doc/libs6/s6-fdholder.html
index 38a2343..4a2fb25 100644
--- a/doc/libs6/s6-fdholder.html
+++ b/doc/libs6/s6-fdholder.html
@@ -72,7 +72,7 @@ s6_fdholder_free(&amp;a) ;
<p>
<tt>s6_fdholder_init</tt> assumes that <em>fd</em> is a socket already
-connected to a s6-fdholderd daemon. The <em>a</em> structure must be
+connected to an s6-fdholderd daemon. The <em>a</em> structure must be
initialized to <tt>S6_FDHOLDER_ZERO</tt> before use.
</p>
diff --git a/doc/libs6/s6-ftrigrd.html b/doc/libs6/s6-ftrigrd.html
index 23c63c2..7325c72 100644
--- a/doc/libs6/s6-ftrigrd.html
+++ b/doc/libs6/s6-ftrigrd.html
@@ -39,10 +39,10 @@ stdout is a pipe writing to the client; its stderr is the same as the client's;
there's an additional pipe from s6-ftrigrd to the client, used for asynchronous
notifications. </li>
<li> If the client program uses <tt>ftrigr_start()</tt>, then it tries to connect
-to a Unix domain socket. A ftrigrd <a href="../localservice.html">local service</a> should be listening to that
-socket, i.e. a Unix domain superserver such as
+to a Unix domain socket. An ftrigrd <a href="../localservice.html">local service</a> should be listening to that
+socket, i.e. a Unix domain super-server such as
<a href="s6-ipcserver.html">s6-ipcserver</a>
-spawning a s6-ftrigrd program on every connection. Then a s6-ftrigrd instance is created
+spawning an s6-ftrigrd program on every connection. Then an s6-ftrigrd instance is created
for the client. </li>
<li> When the client uses <tt>ftrigr_end()</tt>, or closes s6-ftrigrd's stdin in
any way, s6-ftrigrd exits 0. </li>
@@ -71,7 +71,7 @@ to read them. To avoid uncontrolled growth, make sure your client calls
</p>
<p>
- A s6-ftrigrd instance can only handle up to FTRIGRD_MAX (defined in <tt>s6/ftrigr.h</tt>)
+ An s6-ftrigrd instance can only handle up to FTRIGRD_MAX (defined in <tt>s6/ftrigr.h</tt>)
subscriptions at once. By default, this number is 1000, which is more than enough for
any reasonable system.
</p>
diff --git a/doc/libs6/s6lock.html b/doc/libs6/s6lock.html
index 5eb580b..049ed44 100644
--- a/doc/libs6/s6lock.html
+++ b/doc/libs6/s6lock.html
@@ -40,7 +40,7 @@ options are usually available. </li>
<a href="../localservice.html">s6lockd service</a> concurrently
accessed by several applications using such locks to gate shared
resources. </li>
- <li> If you're not using a s6lockd service,
+ <li> If you're not using an s6lockd service,
make sure your application is not disturbed by children it doesn't
know it has. Using nonblocking waits, ignoring pids you don't know, and
using a
@@ -65,13 +65,13 @@ s6lock_start_g(&amp;a, path, &amp;deadline) ;
</pre>
<p>
-<tt>s6lock_start_g</tt> starts a session by connecting to a s6lockd service
+<tt>s6lock_start_g</tt> starts a session by connecting to an s6lockd service
listening on <em>path</em>. The working directory is set by the administrator
of the service. <br />
-<tt>s6lock_startf_g</tt> starts a session with a s6lockd process as a child,
+<tt>s6lock_startf_g</tt> starts a session with an s6lockd process as a child,
using <em>lockdir</em> as its working directory.
<br />
-<tt>a</tt> is a s6lock_t structure that must be declared in the stack and
+<tt>a</tt> is an s6lock_t structure that must be declared in the stack and
initialized to S6LOCK_ZERO.
If the session initialization fails, the function returns 0 and errno is set;
else the function returns 1.
diff --git a/doc/libs6/s6lockd.html b/doc/libs6/s6lockd.html
index 9fcb055..089de57 100644
--- a/doc/libs6/s6lockd.html
+++ b/doc/libs6/s6lockd.html
@@ -39,11 +39,11 @@ user: it will be spawned by the
<ol>
<li> Use the <tt>s6lock_startf()</tt> library call.
-A <tt>s6lockd</tt> child will then be spawned from your
+An <tt>s6lockd</tt> child will then be spawned from your
calling process, and automatically reaped when you call
<tt>s6lock_end()</tt>. It requires care with applications that
trap SIGCHLD. It also requires care with lock file permissions:
-a s6lockd instance might not be able
+an s6lockd instance might not be able
to open a lock file created by a former instance run by another
client with different permissions. </li>
<li> Use the <tt>s6lock_start()</tt> library call, together with a
@@ -56,10 +56,10 @@ simplifies permissions management considerably. </li>
<p>
When run as a service, s6lockd has no "standalone" mode: it is
designed to work with a Unix
-domain superserver, like
+domain super-server, like
<a href="../s6-ipcserver.html">s6-ipcserver</a>.
-s6lockd follows the <a href="http://cr.yp.to/proto/ucspi.txt">UCSPI</a>
-interface, it can be directly executed from the superserver.
+s6lockd follows the <a href="https://cr.yp.to/proto/ucspi.txt">UCSPI</a>
+interface, it can be directly executed from the super-server.
</p>
<h2> Notes </h2>
@@ -67,7 +67,7 @@ interface, it can be directly executed from the superserver.
<ul>
<li> Unix does not natively provide a way to stop blocking on a lock
acquisition after a timeout. To emulate such behaviour, s6lockd actually
-spawns a <a href="s6lockd-helper.html">s6lockd-helper</a> child per
+spawns an <a href="s6lockd-helper.html">s6lockd-helper</a> child per
requested lock. </li>
</ul>