From d4ce4dc23a189daae4310f9b727ea92454b734ab Mon Sep 17 00:00:00 2001
From: Laurent Bercot
Date: Tue, 31 Dec 2019 01:20:10 +0000
Subject: Add s6-frontend-alias* documentation
---
doc/s6-frontend-alias-chpst.html | 52 +++++++++++++++++++---
doc/s6-frontend-alias-sv.html | 35 ++++++++++++---
doc/s6-frontend-alias.html | 95 ++++++++++++++++++++++++++++++++++++++--
3 files changed, 168 insertions(+), 14 deletions(-)
diff --git a/doc/s6-frontend-alias-chpst.html b/doc/s6-frontend-alias-chpst.html
index 6c2fe2d..8cfe011 100644
--- a/doc/s6-frontend-alias-chpst.html
+++ b/doc/s6-frontend-alias-chpst.html
@@ -16,25 +16,67 @@
skarnet.org
- The s6-frontend-alias-chpst program
+ The s6-frontend-alias-chpst program
-s6-frontend-alias-chpst
+s6-frontend-alias-chpst implements
+runit's
+chpst command
+by rewriting itself into a command line made of idiomatic
+chainloading s6 commands.
Interface
- s6-frontend-alias-chpst
+ s6-frontend-alias-chpst [ -v ] [ -P ] [ -0 ] [ -1 ] [ -2 ] [ -u user ] [ -U user ] [ -b argv0 ] [ -e dir ] [ -/ root ] [ -n inclock ] [ -m bytes ] [ -d bytes ] [ -o n ] [ -p n ] [ -f bytes ] [ -c bytes ] prog...
+ When s6-frontend has been configured with the
+--enable-aliases-runit option, the
+s6-frontend-alias-chpst program is built, and at installation
+time, a chpst symbolic link is created, pointing to it.
- Options
+
+ s6-frontend-alias-chpst implements most of the functionality of
+chpst, as closely as
+possible. It does so by rewriting itself into a command line that may
+invoke one or more of the following programs:
+
+
+
+
+ Notes
- - -v : verbose.
+ - When the -v option is given,
+s6-frontend-alias-chpst prints an informational
+message to stderr, showing the entire command line it is going to execute into.
+ - s6-frontend-alias-chpst is a convenience program, written
+so that runit users can keep using chpst while learning the
+corresponding idiomatic s6 commands. However, it is not an "official"
+interface. chpst acts as a big toolbox, whereas s6 prefers the
+"one function = one tool" philosophy. It is recommended that runit users
+who are new to s6 use the -v option to see how their chpst
+invocation translates into s6 parlance.
+ - Some chpst -u invocations do not translate perfectly
+because s6 uses a slightly different model of acquiring user and group
+identity via
+s6-envuidgid.
+This should not prevent chpst from working.