From 8bffa1c19fd05f4f04dad4b5b98f85b94f23113c Mon Sep 17 00:00:00 2001
From: Laurent Bercot
Date: Mon, 26 Jan 2015 22:26:57 +0000
Subject: - added s6-fdholder-delete(c) - small s6-fdholder-* fixes -
s6-fdholder documentation (in review) - s6_svstatus_* bugfix (thanks Olivier
Brunel)
---
doc/index.html | 104 +++++++++++++++++++++++++++++++++++++++++++++++----------
1 file changed, 87 insertions(+), 17 deletions(-)
(limited to 'doc/index.html')
diff --git a/doc/index.html b/doc/index.html
index 57d1ef1..7fcf79a 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -22,9 +22,35 @@
s6 is a small suite of programs for UNIX, designed to allow process supervision
(a.k.a service supervision),
in the line of daemontools
-and runit.
+and runit, as well as various
+operations on processes and daemons. It is meant to be a toolbox for
+low-level process and service administration, providing different sets of
+independent tools that can be used within or without the framework, and
+that can be assembled together to achieve powerful functionality with
+a very small amount of code.
+
+ Examples of things you can do by assembling together several programs
+provided by s6:
+
+
+
+ - syslogd functionality,
+using much less resources than the traditional syslogd.
+ - Reliable service readiness notification, which is the basis for
+service dependency management.
+ - Controlled privileged gain as with
+sudo, without using
+any suid programs.
+ - The useful parts of
+socket
+activation[1]
+without having to change application code or link servers
+against any specific library, and without having to switch to any
+specific init system.
+
+
The s6 documentation tries to be complete and self-contained; however,
if you have never heard of process supervision before, you might be
@@ -51,11 +77,14 @@ supervision that might help you understand the basics.
- A POSIX-compliant system with a standard C development environment
- - GNU make, version 4.0 or later
+ - GNU make, version 4.0 or later. Please be aware that s6 will not build
+with an earlier version.
- skalibs version
-2.2.1.0 or later
+2.2.1.0 or later. It's a build-time requirement. It's also a run-time
+requirement if you link against the shared version of the skalibs
+library.
- execline version
-2.0.1.1 or later
+2.0.1.1 or later. It's a build-time and run-time requirement.
Licensing
@@ -120,32 +149,24 @@ a user interface to control those processes and monitor service states.
The s6-notifywhenup program
- Other daemontools-like utilities
+ Daemontools-like utilities
These programs are a rewrite of the corresponding utilities from
daemontools, with
-a few extras. The
-s6-log program is important in itself: it's
-a powerful, scriptable, general-purpose filtering and logging tool
-that can be used to entirely replace syslogd. It has many more
-features than its multilog
-counterpart.
+a few extras.
Fifodir management, notification and subscription
@@ -174,6 +195,11 @@ synchronization.
The s6-ftrig-listen1 program
The s6-ftrig-listen program
+
+
+
Local service management and access control
@@ -203,14 +229,44 @@ synchronization.
The s6-sudod program
- Internal commands
+ Logging
+
+ Timed lock acquisition
+
+
+ fd-holding, a.k.a. the sensible part of socket activation
+
+
+
+
Libraries
@@ -220,6 +276,7 @@ synchronization.
The ftrigr library interface
The s6lock library interface
The accessrules library interface
+The s6-fdholder library interface
Definitions
@@ -259,6 +316,10 @@ daemontools.)
approach to process supervision, with the same goals.
perp, yet another slightly different
approach to process supervision, also with the same goals.
+ nosh
+is another suite of system-level utilities with similarities in the design
+and approach. It is written in C++, though, and is coded in quite a
+different way than the previous items on this list.
Other init systems
@@ -302,5 +363,14 @@ software, and it's short. Expect more use of s6- in future skarnet.org software
releases. And please avoid using that prefix for your own projects.
+ Footnotes
+
+
+ [1]
+ Take everything you read on that link with two or three salt shakers.
+(This is true for anything written by the author of that document.)
+
+
+