From ebb50dc335bcbd563b4e7f4f2083f2af484a893a Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Thu, 4 Feb 2021 10:37:39 +0000 Subject: Doc fixes, thanks flexibeast --- AUTHORS | 1 + doc/minidentd.html | 6 +++--- doc/s6-sntpclock.html | 4 ++-- doc/s6-taiclock.html | 2 +- doc/s6-tcpclient.html | 2 +- doc/s6-tcpserver.html | 2 +- doc/s6-tcpserver4-socketbinder.html | 2 +- doc/s6-tcpserver4.html | 4 ++-- doc/s6-tcpserver6.html | 4 ++-- doc/s6-tlsc-io.html | 6 +++--- doc/s6-tlsc.html | 4 ++-- doc/s6-tlsserver.html | 9 ++++----- doc/s6-ucspitlsc.html | 2 +- doc/tls-overview.html | 2 +- 14 files changed, 25 insertions(+), 25 deletions(-) diff --git a/AUTHORS b/AUTHORS index 1254022..fa18529 100644 --- a/AUTHORS +++ b/AUTHORS @@ -4,6 +4,7 @@ Main author: Contributors: John Regan Michael Forney + Alexis Thanks to: Jean Marot diff --git a/doc/minidentd.html b/doc/minidentd.html index 007326c..d1fb546 100644 --- a/doc/minidentd.html +++ b/doc/minidentd.html @@ -45,7 +45,7 @@ call failure.

minidentd does not contact the network directly. It's meant to -run under a superserver like +run under a super-server like s6-tcpserver. minidentd will work with IPv4 as well as IPv6.

@@ -53,9 +53,9 @@ work with IPv4 as well as IPv6.

Options

    -
  • -v : verbose mode. Log queries and replies..
    • +
  • -v : verbose mode. Log queries and replies.
  • -n : send ERROR : HIDDEN-USER replies if -the user has a .ident file in his home directory.
    • +the user has a .ident file in their home directory.
  • -i : user-defined answers. The first 14 chars of the user's .ident file, up to EOF or newline, are used instead of the user name. If the file exists and is empty, send diff --git a/doc/s6-sntpclock.html b/doc/s6-sntpclock.html index 156dacc..3403226 100644 --- a/doc/s6-sntpclock.html +++ b/doc/s6-sntpclock.html @@ -19,7 +19,7 @@

    The s6-sntpclock program

    -s6-sntpclock is a small SNTP client. It connects to a +s6-sntpclock is a small SNTP client. It connects to an SNTP or NTP server, computes an estimated discrepancy between the local clock time and the absolute time given by the server, and outputs it on stdout. @@ -53,7 +53,7 @@ error is too big.

    • By default, verbosity is 1. 0 means only print fatal error messages; 3 means trace every exchange with the server.
  • -r roundtrips : perform roundtrips -exchanges with the server. By default, roundtrip is 10. A lower +exchanges with the server. By default, roundtrips is 10. A lower value yields a higher time uncertainty; a higher value puts more load on the server.
  • -t triptimeout : if a SNTP exchange with diff --git a/doc/s6-taiclock.html b/doc/s6-taiclock.html index ddbc660..3cbf21e 100644 --- a/doc/s6-taiclock.html +++ b/doc/s6-taiclock.html @@ -55,7 +55,7 @@ error is too big.
    • By default, verbosity is 1. 0 means only print fatal error messages; 2 means print advanced warnings.
  • -r roundtrips : perform roundtrips -exchanges with the server. By default, roundtrip is 10. A lower +exchanges with the server. By default, roundtrips is 10. A lower value yields a higher time uncertainty; a higher value puts more load on the server.
  • -t triptimeout : if a TAICLOCK exchange with diff --git a/doc/s6-tcpclient.html b/doc/s6-tcpclient.html index 66fe415..b5eafa5 100644 --- a/doc/s6-tcpclient.html +++ b/doc/s6-tcpclient.html @@ -63,7 +63,7 @@ in the list is able to answer.
  • PROTO: always set to TCP
  • TCPREMOTEIP: set to the chosen IP address of host.
  • TCPREMOTEPORT: set to port.
    • -
  • TCPREMOTEHOST: if the -H has been given, set to the +
  • TCPREMOTEHOST: if the -H option has been given, set to the name obtained by a reverse DNS resolution of the IP address chosen for host. Else unset.
  • TCPLOCALHOST: if the -l option has been given, set to diff --git a/doc/s6-tcpserver.html b/doc/s6-tcpserver.html index 28833ec..362dbf5 100644 --- a/doc/s6-tcpserver.html +++ b/doc/s6-tcpserver.html @@ -61,7 +61,7 @@ given, s6-tcpserver will parse ip to determine its family.
    • s6-tcpserver executes either into s6-tcpserver4, which only serves -IPv4, or into IPv6, which only serves IPv6. It will not bind to every +IPv4, or into s6-tcpserver6, which only serves IPv6. It will not bind to every available IP address of the machine whether they are v4 or v6; on the other hand, it can bind to every available IPv4 address (if ip is 0.0.0.0) or to every available IPv6 address (if ip diff --git a/doc/s6-tcpserver4-socketbinder.html b/doc/s6-tcpserver4-socketbinder.html index 18e9fd7..6bf1c58 100644 --- a/doc/s6-tcpserver4-socketbinder.html +++ b/doc/s6-tcpserver4-socketbinder.html @@ -30,7 +30,7 @@ socket to an IPv4 address and port, then executes a program.
        -
      • s6-tcpserver4-socketbinder creates an TCP socket +
      • s6-tcpserver4-socketbinder creates a TCP socket and binds it to IPv4 address ip, port port. It prepares the socket to accept connections by calling listen().
        • diff --git a/doc/s6-tcpserver4.html b/doc/s6-tcpserver4.html index 1914ff0..bc1bd5e 100644 --- a/doc/s6-tcpserver4.html +++ b/doc/s6-tcpserver4.html @@ -85,10 +85,10 @@ connection attempts will rejected by the kernel. supplementary group list to gidlist after binding the socket. This is only valid when run as root. gidlist must be a comma-separated list of numerical group IDs. -
      • -g gid : change s6-tcpserver4's groupid +
      • -g gid : change s6-tcpserver4's group id to gid after binding the socket. This is only valid when run as root.
        • -
      • -u uid : change s6-tcpserver4's userid +
      • -u uid : change s6-tcpserver4's user id to uid after binding the socket. This is only valid when run as root.
      • -U : change s6-tcpserver4's user id, group id and diff --git a/doc/s6-tcpserver6.html b/doc/s6-tcpserver6.html index ee502bc..01be274 100644 --- a/doc/s6-tcpserver6.html +++ b/doc/s6-tcpserver6.html @@ -85,10 +85,10 @@ connection attempts will rejected by the kernel.
        • supplementary group list to gidlist after binding the socket. This is only valid when run as root. gidlist must be a comma-separated list of numerical group IDs. -
      • -g gid : change s6-tcpserver6's groupid +
      • -g gid : change s6-tcpserver6's group id to gid after binding the socket. This is only valid when run as root.
        • -
      • -u uid : change s6-tcpserver6's userid +
      • -u uid : change s6-tcpserver6's user id to uid after binding the socket. This is only valid when run as root.
      • -U : change s6-tcpserver6's user id, group id and diff --git a/doc/s6-tlsc-io.html b/doc/s6-tlsc-io.html index f432f1e..4466293 100644 --- a/doc/s6-tlsc-io.html +++ b/doc/s6-tlsc-io.html @@ -38,7 +38,7 @@ the options given when configuring s6-networking.

        Interface 

        -     s6-tlsc-io [ -S | -s ] [ -Y | -y ] [ -v verbosity ] [ -K kimeout ] [ -k servername ] [ -d notif ] [ -- ] fdr fdw
+     s6-tlsc-io [ -S | -s ] [ -Y | -y ] [ -v verbosity ] [ -K kimeout ] [ -k servername ] [ -d notif ] [ -- ] fdr fdw
          @@ -205,8 +205,8 @@ TLS handshake has completed, some data (terminated by two null characters) will be sent to file descriptor notif. The data contains information about the TLS parameters of the connection; its exact contents are left unspecified, but there's at least -a SSL_PROTOCOL=protocol string and -a SSL_CIPHER=cipher string, both +an SSL_PROTOCOL=protocol string and +an SSL_CIPHER=cipher string, both null-terminated. Sending this data serves a dual purpose: telling the notif reader that the handshake has completed, and providing it with some diff --git a/doc/s6-tlsc.html b/doc/s6-tlsc.html index 6f644c4..d4e6a98 100644 --- a/doc/s6-tlsc.html +++ b/doc/s6-tlsc.html @@ -36,7 +36,7 @@ TLS/SSL.
        • s6-tlsc expects to have an open TCP connection it can talk to on its (by default) descriptors 6 (for reading) and 7 (for writing).
          • -
        • It spawns a s6-tlsc-io +
        • It spawns an s6-tlsc-io child process that will initiate the TLS connection, perform the handshake (expecting a TLS server on the other side of the network) and maintain the TLS tunnel.
          • @@ -63,7 +63,7 @@ into prog... instead.

          s6-tlsc does not expect to have any particular -environment variables, but it spawns a +environment variables, but it spawns an s6-tlsc-io program that does. So it should pay attention to the following variables:

          diff --git a/doc/s6-tlsserver.html b/doc/s6-tlsserver.html index 04d9951..12de659 100644 --- a/doc/s6-tlsserver.html +++ b/doc/s6-tlsserver.html @@ -40,7 +40,7 @@ involving: listens to TCP connections on IP address ip port port and forks a command line for every connection. Note that s6-tcpserver also rewrites -itself into a more complex commnd line (the final long-lived +itself into a more complex command line (the final long-lived process being s6-tcpserver4d or s6-tcpserver6d), so your end command line may look a lot longer in ps @@ -49,7 +49,7 @@ than what you originally wrote. This is normal and healthy. which performs TCP access control and various operations on the TCP connection.
        • s6-tlsd, which establishes -a TLS transport (server-side) over a connection, via a +a TLS transport (server-side) over a connection, via an s6-tlsd-io child process.
        • (if applicable) s6-applyuidgid, @@ -63,7 +63,7 @@ same pid as s6-tlsd.

          • prog is expected to read from its peer on its standard input and write to its peer on its standard output. -Since there will be a s6-tlsd-io +Since there will be an s6-tlsd-io program between prog and the network to perform the SSL encryption/decryption, those descriptors will not be a network socket - they will be pipes. @@ -193,7 +193,6 @@ given but no -i or -x option.

        • -Z, -z
        • -S, -s
        • -Y, -y
          • -
        • -k servername
        • -K kimeout
        @@ -220,7 +219,7 @@ This will start a server listening to 1.2.3.4 on TCP port 443, reading queries on stdin and replying on stdout, as user www, with a TLS layer protecting the connection, the TLS engine running as user nobody (65534:65534). The server is -authentified by the certificate in /etc/ssl/public/mycert.pem +authenticated by the certificate in /etc/ssl/public/mycert.pem that it sends to the client, and the private key in /etc/ssl/private/mykey.der that it keeps to itself.

        diff --git a/doc/s6-ucspitlsc.html b/doc/s6-ucspitlsc.html index 627945f..518de5b 100644 --- a/doc/s6-ucspitlsc.html +++ b/doc/s6-ucspitlsc.html @@ -50,7 +50,7 @@ command.
      • At any time, prog... can send a command to its control socket provided by s6-ucspitlsc, following the UCSPI-TLS -protocol. Then the s6-ucspitlsc child will exec into a +protocol. Then the s6-ucspitlsc child will exec into an s6-tlsc-io process that will initiate the TLS connection, perform the handshake (expecting a TLS server on the other side of the diff --git a/doc/tls-overview.html b/doc/tls-overview.html index 4ba3f69..32568f0 100644 --- a/doc/tls-overview.html +++ b/doc/tls-overview.html @@ -16,7 +16,7 @@ skarnet.org

        -

        An overview of the tls-related programs

        +

        An overview of the TLS-related programs

        The s6-*tls* programs are organized in a way that minimizes -- cgit v1.2.3