Skip to content
This repository has been archived by the owner on Apr 6, 2023. It is now read-only.

Commit

Permalink
Correct sectioning.
Browse files Browse the repository at this point in the history
  • Loading branch information
flexibeast committed Sep 28, 2021
1 parent e9ccca8 commit 4e8cd3e
Show file tree
Hide file tree
Showing 27 changed files with 404 additions and 403 deletions.
61 changes: 31 additions & 30 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,44 +1,45 @@
MANPATH ?= /usr/share/man
man1 = $(MANPATH)/man1/
man7 = $(MANPATH)/man7/

man1_targets = \
s6-clockadd.1 \
s6-clockview.1 \
s6-getservbyname.1 \
s6-ident-client.1 \
s6-sntpclock.1 \
s6-taiclock.1 \
s6-taiclockd.1 \
s6-tcpclient.1 \
s6-tcpserver.1 \
s6-tcpserver-access.1 \
s6-tcpserver4.1 \
s6-tcpserver4-socketbinder.1 \
s6-tcpserver4d.1 \
s6-tcpserver6.1 \
s6-tcpserver6-socketbinder.1 \
s6-tcpserver6d.1 \
s6-tlsc.1 \
s6-tlsc-io.1 \
s6-tlsclient.1 \
s6-tlsd.1 \
s6-tlsd-io.1 \
s6-tlsserver.1 \
s6-ucspitlsc.1 \
s6-ucspitlsd.1
man8 = $(MANPATH)/man8/

man7_targets = \
s6-tls.7

man8_targets = \
s6-clockadd.8 \
s6-clockview.8 \
s6-getservbyname.8 \
s6-ident-client.8 \
s6-sntpclock.8 \
s6-taiclock.8 \
s6-taiclockd.8 \
s6-tcpclient.8 \
s6-tcpserver.8 \
s6-tcpserver-access.8 \
s6-tcpserver4.8 \
s6-tcpserver4-socketbinder.8 \
s6-tcpserver4d.8 \
s6-tcpserver6.8 \
s6-tcpserver6-socketbinder.8 \
s6-tcpserver6d.8 \
s6-tlsc.8 \
s6-tlsc-io.8 \
s6-tlsclient.8 \
s6-tlsd.8 \
s6-tlsd-io.8 \
s6-tlsserver.8 \
s6-ucspitlsc.8 \
s6-ucspitlsd.8


all: install

install:
install -D -m 644 -t $(man1) $(man1_targets)
install -D -m 644 -t $(man7) $(man7_targets)
cd man7; install -D -m 644 -t $(man7) $(man7_targets)
cd man8; install -D -m 644 -t $(man8) $(man8_targets)

uninstall:
cd $(man1); rm -f $(man1_targets)
cd $(man7); rm -f $(man7_targets)
cd $(man8); rm -f $(man8_targets)

.PHONY: all install uninstall
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@ HTML versions can be produced with
[mandoc(1)](https://man.openbsd.org/mandoc.1)'s `-T` flag:

```
$ mandoc -T html s6-clockadd.1 > s6-clockadd.1.html
$ mandoc -T html man8/s6-clockadd.8 > s6-clockadd.8.html
```
74 changes: 37 additions & 37 deletions s6-tls.7 → man7/s6-tls.7
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.Dd February 16, 2021
.Dd September 29, 2021
.Dt S6-TLS 7
.Os
.Sh NAME
Expand All @@ -24,14 +24,14 @@ you're interested in using a client or a server.
.Pp
Of course, they do not have to be used together.
You can run a TLS-enabled super-server via
.Xr s6-tlsserver 1
.Xr s6-tlsserver 8
and it will work with any client speaking the correct TLS-enabled
protocol, not only
.Xr s6-tlsclient 1 .
.Xr s6-tlsclient 8 .
.Ss The core TLS engine: s6-tlsc-io and s6-tlsd-io
.Xr s6-tlsc-io 1
.Xr s6-tlsc-io 8
and
.Xr s6-tlsd-io 1
.Xr s6-tlsd-io 8
are the only programs that actually perform TLS operations; the only
ones that are linked against the BearSSL or LibreSSL libraries.
.Pp
Expand Down Expand Up @@ -60,15 +60,15 @@ Other programs in the
set perform various operations such as Unix file descriptor plumbing
in order to provide a specific interface, but they always end up
spawning an
.Xr s6-tlsc-io 1
.Xr s6-tlsc-io 8
or
.Xr s6-tlsd-io 1
.Xr s6-tlsd-io 8
child that will handle the actual TLS management for them.
.Ss Regular TLSification of a service: s6-tlsc and s6-tlsd
The
.Xr s6-tlsc 1
.Xr s6-tlsc 8
and
.Xr s6-tlsd 1
.Xr s6-tlsd 8
programs are
.Dq immediate encryption Ns
-type programs.
Expand All @@ -79,9 +79,9 @@ servers); their goal is to provide this application with transparent
encryption.
.Pp
They first spawn an
.Xr s6-tlsc-io 1
.Xr s6-tlsc-io 8
or
.Xr s6-tlsd-io 1
.Xr s6-tlsd-io 8
child to initialize the TLS connection.
.Pp
When the TLS handshake has completed, they exec into the rest of their
Expand All @@ -99,9 +99,9 @@ whole lifetime of the application, or until the application closes the
fds it uses to communicate with (what it thinks is) the network.
.Ss Opportunistic TLS: s6-ucspitlsc and s6-ucspitlsd
The
.Xr s6-ucspitlsc 1
.Xr s6-ucspitlsc 8
and
.Xr s6-ucspitlsd 1
.Xr s6-ucspitlsd 8
programs are
.Dq delayed encryption Ns
-type programs.
Expand All @@ -118,52 +118,52 @@ The child stays and waits for a command.
.Pp
When the
application sends a command to start TLS, the child execs into
.Xr s6-tlsc-io 1
.Xr s6-tlsc-io 8
or
.Xr s6-tlsd-io 1 ,
.Xr s6-tlsd-io 8 ,
which initializes a TLS connection and performs a handshake.
.Pp
The application then communicates via the fds that have been provided
to it via the ucspi-tls protocol.
Those fds go through the TLS engine.
.Ss High-level client connections and super-servers: s6-tlsclient and s6-tlsserver
The
.Xr s6-tlsclient 1
.Xr s6-tlsclient 8
and
.Xr s6-tlsserver 1
.Xr s6-tlsserver 8
programs are high-level wrappers around TCP client and server
functionality, followed by the establishment of a TLS tunnel, followed
by the execution of an application.
.Pp
They're meant to provide simpler interfaces over long, complex command
lines.
.Pp
.Xr s6-tlsclient 1
.Xr s6-tlsclient 8
rewrites itself into a command line involving
.Xr s6-tcpclient 1
.Xr s6-tcpclient 8
and
.Xr s6-tlsc 1 .
.Xr s6-tlsc 8 .
.Pp
.Xr s6-tlsserver 1
.Xr s6-tlsserver 8
rewrites itself into a command line involving (depending on the given options)
.Xr s6-tcpserver 1 ,
.Xr s6-tcpserver-access 1 ,
.Xr s6-tlsd 1 ,
.Xr s6-tcpserver 8 ,
.Xr s6-tcpserver-access 8 ,
.Xr s6-tlsd 8 ,
and
.Xr s6-applyuidgid 1 .
.Xr s6-applyuidgid 8 .
.Sh SEE ALSO
.Xr s6-applyuidgid 1 ,
.Xr s6-tcpclient 1 ,
.Xr s6-tcpserver 1 ,
.Xr s6-tcpserver-access 1 ,
.Xr s6-tlsc 1 ,
.Xr s6-tlsc-io 1 ,
.Xr s6-tlsclient 1 ,
.Xr s6-tlsd 1 ,
.Xr s6-tlsd-io 1 ,
.Xr s6-tlsserver 1 ,
.Xr s6-ucspitlsc 1 ,
.Xr s6-ucspitlsd 1
.Xr s6-applyuidgid 8 ,
.Xr s6-tcpclient 8 ,
.Xr s6-tcpserver 8 ,
.Xr s6-tcpserver-access 8 ,
.Xr s6-tlsc 8 ,
.Xr s6-tlsc-io 8 ,
.Xr s6-tlsclient 8 ,
.Xr s6-tlsd 8 ,
.Xr s6-tlsd-io 8 ,
.Xr s6-tlsserver 8 ,
.Xr s6-ucspitlsc 8 ,
.Xr s6-ucspitlsd 8
.Pp
[1]
.Lk https://web.archive.org/web/20150311223933/http://www.suspectclass.com/sgifford/ucspi-tls/ucspi-tls.txt
Expand Down
16 changes: 8 additions & 8 deletions s6-clockadd.1 → man8/s6-clockadd.8
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.Dd February 16, 2021
.Dt S6-CLOCKADD 1
.Dd September 29, 2021
.Dt S6-CLOCKADD 8
.Os
.Sh NAME
.Nm s6-clockadd
Expand All @@ -11,9 +11,9 @@
.Sh DESCRIPTION
.Nm
reads its stdin, expecting input from a program such as
.Xr s6-taiclock 1
.Xr s6-taiclock 8
or
.Xr s6-sntpclock 1
.Xr s6-sntpclock 8
(which get time from a time server).
.Pp
It sets the system clock so the system time becomes the one given by
Expand Down Expand Up @@ -44,10 +44,10 @@ By default,
is 2000.
.El
.Sh SEE ALSO
.Xr s6-clockview 1 ,
.Xr s6-sntpclock 1 ,
.Xr s6-taiclock 1 ,
.Xr s6-taiclockd 1
.Xr s6-clockview 8 ,
.Xr s6-sntpclock 8 ,
.Xr s6-taiclock 8 ,
.Xr s6-taiclockd 8
.Pp
This man page is ported from the authoritative documentation at:
.Lk https://skarnet.org/software/s6-networking/s6-clockadd.html
Expand Down
16 changes: 8 additions & 8 deletions s6-clockview.1 → man8/s6-clockview.8
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.Dd February 16, 2021
.Dt S6-CLOCKVIEW 1
.Dd September 29, 2021
.Dt S6-CLOCKVIEW 8
.Os
.Sh NAME
.Nm s6-clockview
Expand All @@ -9,18 +9,18 @@
.Sh DESCRIPTION
.Nm
reads its stdin, expecting input from a program such as
.Xr s6-taiclock 1
.Xr s6-taiclock 8
or
.Xr s6-sntpclock 1
.Xr s6-sntpclock 8
(which get time from a time server).
.Pp
It prints the local system time, and the time given by the server, in
human-readable form, then exits 0.
.Sh SEE ALSO
.Xr s6-clockadd 1 ,
.Xr s6-sntpclock 1 ,
.Xr s6-taiclock 1 ,
.Xr s6-taiclockd 1
.Xr s6-clockadd 8 ,
.Xr s6-sntpclock 8 ,
.Xr s6-taiclock 8 ,
.Xr s6-taiclockd 8
.Pp
This man page is ported from the authoritative documentation at:
.Lk https://skarnet.org/software/s6-networking/s6-clockview.html
Expand Down
4 changes: 2 additions & 2 deletions s6-getservbyname.1 → man8/s6-getservbyname.8
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.Dd January 29, 2021
.Dt S6-GETSERVBYNAME 1
.Dd September 29, 2021
.Dt S6-GETSERVBYNAME 8
.Os
.Sh NAME
.Nm s6-getservbyname
Expand Down
4 changes: 2 additions & 2 deletions s6-ident-client.1 → man8/s6-ident-client.8
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.Dd February 16, 2021
.Dt S6-IDENT-CLIENT 1
.Dd September 29, 2021
.Dt S6-IDENT-CLIENT 8
.Os
.Sh NAME
.Nm s6-ident-client
Expand Down
24 changes: 12 additions & 12 deletions s6-sntpclock.1 → man8/s6-sntpclock.8
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.Dd February 16, 2021
.Dt S6-SNTPCLOCK 1
.Dd September 29, 2021
.Dt S6-SNTPCLOCK 8
.Os
.Sh NAME
.Nm s6-sntpclock
Expand Down Expand Up @@ -33,9 +33,9 @@ system clock and the one given by the server.
.Pp
It prints the difference to stdout in a format understood
by
.Xr s6-clockadd 1
.Xr s6-clockadd 8
and
.Xr s6-clockview 1 .
.Xr s6-clockview 8 .
It then exits 0.
.Pp
There are a lot of infelicities in the NTP protocol (which SNTP is
Expand All @@ -58,9 +58,9 @@ to one second off when used during a leap second, and this is bound to
the use of UTC: there is nothing you can do about it.
The only solution to get reliable results even around a leap second is
to use linear time such as TAI; the
.Xr s6-taiclock 1
.Xr s6-taiclock 8
and
.Xr s6-taiclockd 1
.Xr s6-taiclockd 8
programs provide tools to do so.
.Ss A word on ntpd
From a Unix software engineering standpoint, the well-known ntpd[2]
Expand Down Expand Up @@ -101,7 +101,7 @@ Those are already 3 separate tasks.
Local system clock management itself involves several duties.
There is the regular setting of the system clock, which can be done
with a loop over a simple program such as
.Xr s6-clockadd 1 .
.Xr s6-clockadd 8 .
There is also control of the clock skew, which s6-networking does not
provide because there is no portable interface for that; there is such
a tool in the clockspeed[4] package.
Expand Down Expand Up @@ -134,7 +134,7 @@ However, I wish that the main NTP implementation weren't written as a
big fat clumsy process running as root.
.Nm
together with
.Xr s6-clockadd 1
.Xr s6-clockadd 8
aims to provide a small, simple tool to keep system clocks, especially
in embedded devices, synchronized to a NTP server.
.Sh OPTIONS
Expand Down Expand Up @@ -207,10 +207,10 @@ By default,
is 123.
.El
.Sh SEE ALSO
.Xr s6-clockadd 1 ,
.Xr s6-clockview 1 ,
.Xr s6-taiclock 1 ,
.Xr s6-taiclockd 1
.Xr s6-clockadd 8 ,
.Xr s6-clockview 8 ,
.Xr s6-taiclock 8 ,
.Xr s6-taiclockd 8
.Pp
[1]
.Lk https://skarnet.org/software/s6-portable-utils/s6-clock.html
Expand Down
Loading

0 comments on commit 4e8cd3e

Please sign in to comment.