From ed9dadb2778ab4ff7683622907e22ed8c561bfda Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Mon, 30 Dec 2019 23:27:32 +0000 Subject: Initial commit. --- doc/index.html | 149 +++++++++++++++++++++++++++++++++ doc/quickstart.html | 26 ++++++ doc/s6-frontend-alias.html | 41 +++++++++ doc/s6-frontend-config-preprocess.html | 87 +++++++++++++++++++ doc/upgrade.html | 28 +++++++ 5 files changed, 331 insertions(+) create mode 100644 doc/index.html create mode 100644 doc/quickstart.html create mode 100644 doc/s6-frontend-alias.html create mode 100644 doc/s6-frontend-config-preprocess.html create mode 100644 doc/upgrade.html (limited to 'doc') diff --git a/doc/index.html b/doc/index.html new file mode 100644 index 0000000..bd6512c --- /dev/null +++ b/doc/index.html @@ -0,0 +1,149 @@ + + + + + + s6-frontend - a frontend to the s6 ecosystem + + + + + + +

+Software
+skarnet.org +

+ +

s6-frontend

+ +

What is it ?

+ +

+ s6-frontend is still in development. +

+ +

+ s6-frontend is a frontend to the s6 ecosystem. It is made of +several parts: +

+ +

A set of user-friendly commands, making it easier to manage a +s6-based system for people who are used to other tools.
An independent configuration file format, +and tools that automatically analyze a configuration written in that +format and transform it into a configuration suitable for booting a +system via +s6, +s6-linux-init and +s6-rc. This should help +users who are not familiar with s6 and s6-rc directory-based configuration +but are used to, for instance, systemd unit files.
A prepackaged set of configuration files, implementing policy, +suitable for booting a large majority of Linux-based systems. This should +help distributions that want to switch to s6 but do not want to rewrite all +their init scripts in yet another format.

+ +

+ These parts are all independent from one another. But when put all together, +they implement a powerful, fast, turnkey init system that is usable on +any distribution. +

+ +

Quickstart and FAQ

+ +

Installation

+ +

Requirements

+ +

A Linux-based system with a standard C development environment
GNU make, version 3.81 or later
skalibs version +2.9.1.0 or later
execline version +2.6.0.0 or later
s6 version +2.9.0.1 or later
s6-rc version +0.5.1.1 or later
s6-linux-init version +1.0.3.1 or later

+ +

+ Those are all build-time dependencies as well as run-time dependencies. +skalibs is only a run-time dependency if you link the binaries against +the shared version of the skarnet library. +

+ +

Licensing

+ +

+ s6-frontend is free software. It is available under the +ISC license. +

+ +

Download

+ +

The current released version of s6-frontend is +0.0.1.0. (unavailable while in development)
Alternatively, you can checkout a copy of the +s6-frontend +git repository: +
```
 git clone git://git.skarnet.org/s6-frontend 
```
There's also a +GitHub mirror +of the s6-frontend git repository.

+ +

Compilation

+ +

See the enclosed INSTALL file for installation details.

+ +

Upgrade notes

+ +

This page lists the differences to be aware of between +the previous versions of s6-frontend and the current one.

+ +

Reference

+ +

Commands

+ +

+ All these commands exit 111 if they encounter a temporary error, and +100 if they encounter a permanent error - such as a misuse. +

+ +

The s6-frontend-config-preprocess program
The s6-frontend-alias program
The s6-frontend-alias-chpst program
The s6-frontend-alias-sv program

+ +

Related resources

+ +

s6-frontend is discussed on the +supervision mailing-list.
There is a #s6 IRC channel on Freenode. Sometimes people +are there and even answer questions.

+ + + diff --git a/doc/quickstart.html b/doc/quickstart.html new file mode 100644 index 0000000..6c99510 --- /dev/null +++ b/doc/quickstart.html @@ -0,0 +1,26 @@ + + + + + + s6-frontend: quickstart and FAQ + + + + + + +

+s6-frontend
+Software
+skarnet.org +

+ +

Quickstart and FAQ for s6-frontend

+ +

+ (To be written.) +

+ + + diff --git a/doc/s6-frontend-alias.html b/doc/s6-frontend-alias.html new file mode 100644 index 0000000..4e824c9 --- /dev/null +++ b/doc/s6-frontend-alias.html @@ -0,0 +1,41 @@ + + + + + + s6-frontend: the s6-frontend-alias program + + + + + + +

+s6-frontend
+Software
+skarnet.org +

+ +

The s6-frontend-alias program

+ +

+s6-frontend-alias +

+ +

Interface

+ +

+     s6-frontend-alias
+

+ +

Options

+ +

-v : verbose.

+ + + diff --git a/doc/s6-frontend-config-preprocess.html b/doc/s6-frontend-config-preprocess.html new file mode 100644 index 0000000..f58ff7c --- /dev/null +++ b/doc/s6-frontend-config-preprocess.html @@ -0,0 +1,87 @@ + + + + + + s6-frontend: the s6-frontend-config-preprocess program + + + + + + +

+s6
+Software
+skarnet.org +

+ +

The s6-frontend-config-preprocess program

+ +

+ s6-frontend-config-preprocess reads a s6-frontend configuration +file and executes all its inclusion directives, also preprocessing the +included files. It streams the result to stdout, which is a complete +configuration file without inclusions. +

+ +

Interface

+ +

+     s6-frontend-config-preprocess file
+

+ +

+ s6-frontend-config-preprocess reads file and prints it +to stdout. It removes lines starting with !!. +

+ + + When it finds a !include or !includeonce directive +in file, it replaces it with the contents of the included +file - recursively preprocessed. + + + + When it finds a !includedir or !includedironce +directive in file, it replaces it with the recursively +preprocessed contents of every file present in the included +directory. The files are sorted alphabetically according to the +C locale. + + + + !includeonce and !includedironce only print +a file (resp. a directory) the first time they encounter it, and +silently ignore subsequent instances. !include and +!includedir directives will happily include the same +files several times. + + + + To avoid loops, a nesting limit exists. s6-frontend-config-preprocess +will fail if there are too many nested inclusions. + + + Exit codes + + + 0: success + 1: syntax error in a configuration file + 2: other error in a configuration file + 3: too many nested inclusions + 100: usage error + 111: system call failed + + + Notes + + + s6-frontend-config-preprocess is not meant to be +called directly by the user. It is normally invoked by +s6-frontend-config-parse. +However, the binary is made available for debugging purposes. + + + + diff --git a/doc/upgrade.html b/doc/upgrade.html new file mode 100644 index 0000000..24f7bfb --- /dev/null +++ b/doc/upgrade.html @@ -0,0 +1,28 @@ + + + + + + s6-frontend: how to upgrade + + + + + + + +s6-frontend +Software +skarnet.org + + + What has changed in s6-frontend + + in 0.0.1.0 + + + Initial release. + + + + -- cgit v1.3.1