From 1bfba3b0be32306b078f5ee527b864e758b2c77b Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Fri, 26 Apr 2019 15:52:54 +0000 Subject: Make a single hpr. Full doc, first draft. --- doc/index.html | 96 ++++++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 70 insertions(+), 26 deletions(-) (limited to 'doc/index.html') diff --git a/doc/index.html b/doc/index.html index c8d7e7e..1b4dda6 100644 --- a/doc/index.html +++ b/doc/index.html @@ -26,22 +26,52 @@ system, including a /sbin/init binary, on a Linux kernel.

- s6-linux-init is meant to automate creation of scripts revolving -around the use of other skarnet.org tools, especially s6, in order -to provide a complete booting environment with integrated supervision -and logging without having to hand-craft all the details. + The resulting architecture follows the Unix philosophy (one job → +one tool) as closely as possible, and is fully dedicated to the s6 way of +managing a system:

+ + +

+ Nevertheless, the architecture is fully compliant with various +empirical and historical specifications. For instance, it provides: +

+ + + +

Getting started

+

Please read the documentation for the s6-linux-init-maker program carefully, but if you're impatient, you can also read this -quickstart guide, which includes -a small FAQ. +quickstart guide.

+ + +
+

Installation

Requirements

@@ -50,30 +80,31 @@ a small FAQ.
  • A Linux-based system with a standard C development environment
  • GNU make, version 3.81 or later
  • skalibs version -2.6.4.0 or later
    • +2.8.0.1 or later
  • execline version -2.3.0.4 or later
    • -
  • s6-portable-utils version -2.2.1.1 or later
    • -
  • s6-linux-utils version -2.4.0.2 or later
    • +2.5.1.0 or later
  • s6 version -2.7.1.0 or later
    • +2.8.0.0 or later

    -When you build s6-linux-init, the - s6-linux-init-maker tool -is created (as well as the shutdown commands); - then you run that tool to create an init script, -and then you can boot your system on that init script. + The following optional dependencies are also supported:

    + +

    - skalibs is a build-time dependency. If you are linking binaries -against the shared version of the skalibs library, it also becomes a -run-time and boot-time dependency.
    - All the other listed packages are boot-time dependencies only. + All those dependencies are build-time and run-time, +except possibly skalibs, which is not needed at run time if you are linking +all the other packages against the static version of libskarnet.

    Licensing

    @@ -87,7 +118,7 @@ against the shared version of the skalibs library, it also becomes a