From f98ae7a1bc204afa4badc3593d8422a6efa977d9 Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Mon, 30 Mar 2020 17:21:37 +0000 Subject: heliocat's html fixes --- doc/fifodir.html | 2 +- doc/index.html | 9 --------- doc/libs6/s6-fdholder.html | 2 +- doc/libs6/s6lockd-helper.html | 4 +++- doc/libs6/s6lockd.html | 5 +++-- doc/overview.html | 3 --- doc/s6-accessrules-cdb-from-fs.html | 12 ++++++------ doc/s6-accessrules-fs-from-cdb.html | 6 +++--- doc/s6-connlimit.html | 2 +- doc/s6-fdholder-getdump.html | 2 +- doc/s6-fdholderd.html | 4 ++-- doc/s6-log.html | 2 +- doc/s6-sudo.html | 2 +- doc/s6-svstat.html | 1 - doc/servicedir.html | 2 +- doc/upgrade.html | 16 ++++++++-------- 16 files changed, 32 insertions(+), 42 deletions(-) (limited to 'doc') 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

- The libftrig interface takes care of all + The libftrig interface takes care of all the subtleties.

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.

The s6-cleanfifodir program

The s6-ftrig-notify program

The s6-ftrigrd internal program

@@ -225,12 +219,10 @@ synchronization.

The s6-ipcserverd program

The s6-ioconnect program

The s6-accessrules-cdb-from-fs program
The s6-accessrules-fs-from-cdb program
The s6-fdholder-daemon program
The s6-fdholderd program

The s6-fdholder-store program
The s6-fdholder-retrieve program

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 @@ +

libs6
s6
Software
-skarnet.org

+skarnet.org +

The `s6lockd-helper` program

libs6
s6
Software
-skarnet.org

+skarnet.org +

The `s6lockd` program

this is the recommended setup

diff --git a/doc/overview.html b/doc/overview.html index 781fa70..cecdde6 100644 --- a/doc/overview.html +++ b/doc/overview.html @@ -304,9 +304,6 @@ provided that running it eventually results in a long-lived process with the same PID.)

Some examples of s6 programs meant to be used in run scripts:

s6-accessrules-cdb-from-fs compiles a directory containing a ruleset suitable for -s6-ipcserver-access or -s6-tcpserver-access into a +s6-ipcserver-access or +s6-tcpserver-access into a CDB file.

To be understood by s6-accessrules-cdb-from-fs, -s6-ipcserver-access , or -s6-tcpserver-access , +s6-ipcserver-access, or +s6-tcpserver-access, dir must have a specific format.

Depending on the application, other directories can appear in dir and be compiled into cdbfile, but -s6-tcpserver-access only +s6-tcpserver-access only uses the first three, and -s6-ipcserver-access only +s6-ipcserver-access only uses the last two.

s6-accessrules-fs-from-cdb decompiles a CDB database containing a ruleset suitable for -s6-ipcserver-access or -s6-tcpserver-access and +s6-ipcserver-access or +s6-tcpserver-access and that has been compiled with -s6-accessrules-cdb-from-fs . +s6-accessrules-cdb-from-fs.

Interface

The s6-connlimit utility was once part of the -s6-networking +s6-networking 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.
S6_FDLIMIT_i : contains the expiration date of the ith open file descriptor, if applicable. That date is stored in external TAI64N -format.

A good convention is to use unix:/path/to/socket for -Unix domain sockets and protocol:ip:port +
A good convention is to use unix:path/to/socket for +Unix domain sockets and protocol:ip:port for INET domain sockets.
An identifier is chosen by the storing client, within the limits of what the server authorizes it to use.

This is why it's open for.

When process 1 starts, the logging chain is rooted to the machine console: 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. +at any time remain the last resort place where logs are sent.
Process 1 should spawn and supervise a catch-all logging mechanism 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.

Options

The -q, -Q, -v, -p and -l +
The -q, -Q, -v, -p and -l options are passed to s6-ipcclient.
The -e, -t and -T options are passed to s6-sudoc.

./finish

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 fdmove -c 2 1 in execline, -and exec 2>&1 in shell. +and exec 2>&1 in shell. By default, in a normal supervision tree situation, a run script's stdin will be /dev/null, and its stdout and stderr will both be a pipe to a catch-all logging program. 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 @@

in 2.9.1.0

skalibs +
skalibs dependency bumped to 2.9.2.0.
execline dependency bumped to 2.6.0.0. (And made optional, see below.)
A new '?' directive has been added to s6-log, it declares a processor command line that is spawned with the /bin/sh interpreter.
A new -X option has been added to s6-svscan to better support s6-linux-init installations.
s6-svscan now handles SIGPWR and SIGWINCH, when diverted, on systems that define those signals.

in 2.9.0.1

skalibs +
skalibs dependency bumped to 2.9.1.0.
execline dependency bumped to 2.5.3.0.

in 2.9.0.0

skalibs +
skalibs dependency bumped to 2.9.0.0.
execline dependency bumped to 2.5.2.0.

in 2.8.0.1

skalibs +
skalibs dependency bumped to 2.8.1.0.

in 2.8.0.0

skalibs +
skalibs dependency bumped to 2.8.0.0.
execline dependency bumped to 2.5.1.0.

Optional nsss support added.
skalibs +
skalibs dependency bumped to 2.7.0.0.
execline dependency bumped to 2.5.0.1.

The s6lockd-helper program

The s6lockd program