From 54b6467013bfbdb3ee606961c02fbff1271ca582 Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Fri, 19 Sep 2014 15:01:58 +0000 Subject: initial commit --- doc/index.html | 126 +++++++++++++++++++++++++++++++++++++++++++++++ doc/s6-chroot.html | 40 +++++++++++++++ doc/s6-devd.html | 80 ++++++++++++++++++++++++++++++ doc/s6-freeramdisk.html | 32 ++++++++++++ doc/s6-halt.html | 36 ++++++++++++++ doc/s6-hiercopy.html | 66 +++++++++++++++++++++++++ doc/s6-hostname.html | 39 +++++++++++++++ doc/s6-logwatch.html | 72 +++++++++++++++++++++++++++ doc/s6-mount.html | 52 ++++++++++++++++++++ doc/s6-pivotchroot.html | 41 ++++++++++++++++ doc/s6-poweroff.html | 39 +++++++++++++++ doc/s6-ps.html | 128 ++++++++++++++++++++++++++++++++++++++++++++++++ doc/s6-reboot.html | 38 ++++++++++++++ doc/s6-swapoff.html | 36 ++++++++++++++ doc/s6-swapon.html | 36 ++++++++++++++ doc/s6-umount.html | 38 ++++++++++++++ doc/upgrade.html | 32 ++++++++++++ 17 files changed, 931 insertions(+) create mode 100644 doc/index.html create mode 100644 doc/s6-chroot.html create mode 100644 doc/s6-devd.html create mode 100644 doc/s6-freeramdisk.html create mode 100644 doc/s6-halt.html create mode 100644 doc/s6-hiercopy.html create mode 100644 doc/s6-hostname.html create mode 100644 doc/s6-logwatch.html create mode 100644 doc/s6-mount.html create mode 100644 doc/s6-pivotchroot.html create mode 100644 doc/s6-poweroff.html create mode 100644 doc/s6-ps.html create mode 100644 doc/s6-reboot.html create mode 100644 doc/s6-swapoff.html create mode 100644 doc/s6-swapon.html create mode 100644 doc/s6-umount.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..1d289cc --- /dev/null +++ b/doc/index.html @@ -0,0 +1,126 @@ + + + + + s6-linux-utils - skarnet's tiny Linux-specific utilities + + + + + + +

+Software
+skarnet.org +

+ +

s6-linux-utils

+ +

What is it ?

+ +

+ s6-linux-utils is a set of minimalistic Linux-specific system utilities. +

+ +
+ +

Installation

+ +

Requirements

+ + + +

Licensing

+ +

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

+ +

Download

+ + + +

Compilation

+ + + +

Upgrade notes

+ + + +
+ +

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. +

+ + + +

Related resources

+ + + +

Similar work

+ +

+ There are several good projects aiming to provide a minimal userspace +environment for Linux, suitable for embedded systems. Among them, for +instance: +

+ + + +

+ Most of the time, these projects aim to implement standard commands in a +lightweight way, and +they do it well enough. So, although some standard reimplentation already +exists in s6-linux-utils and its sibling package +s6-portable-utils, +it is an explicit non-goal of those packages to duplicate the work of those +projects, and no more rewriting of standard commands will occur. +

+ + + diff --git a/doc/s6-chroot.html b/doc/s6-chroot.html new file mode 100644 index 0000000..a15d0fa --- /dev/null +++ b/doc/s6-chroot.html @@ -0,0 +1,40 @@ + + + + + s6-linux-utils: the s6-chroot program + + + + + + +

+s6-linux-utils
+Software
+skarnet.org +

+ +

The s6-chroot program

+ +

+s6-chroot executes a program in a chroot jail. +

+ +

Interface

+ +
+     s6-chroot newroot prog...
+
+ + + + + diff --git a/doc/s6-devd.html b/doc/s6-devd.html new file mode 100644 index 0000000..5ae6160 --- /dev/null +++ b/doc/s6-devd.html @@ -0,0 +1,80 @@ + + + + + s6-linux-utils: the s6-devd program + + + + + + +

+s6-linux-utils
+Software
+skarnet.org +

+ +

The s6-devd program

+ +

+s6-devd listens to the netlink interface for udev events, and +launches a helper program for every event, similarly to what the hotplug +interface does. +

+ +

Interface

+ +
+     s6-devd [ -q | -v ] [ -b kbufsz ] [ -t l:t:k ] prog...
+
+ + + +

Options

+ + + +

Notes

+ + + + + diff --git a/doc/s6-freeramdisk.html b/doc/s6-freeramdisk.html new file mode 100644 index 0000000..859571a --- /dev/null +++ b/doc/s6-freeramdisk.html @@ -0,0 +1,32 @@ + + + + + s6-linux-utils: the s6-freeramdisk program + + + + + + +

+s6-linux-utils
+Software
+skarnet.org +

+ +

The s6-freeramdisk program

+ +

+freeramdisk frees the memory occupied by a RAM disk. Call it +when your RAM disk is not in use anymore. +

+ +

Interface

+ +
+     s6-freeramdisk ramdisk-device
+
+ + + diff --git a/doc/s6-halt.html b/doc/s6-halt.html new file mode 100644 index 0000000..2c11c5a --- /dev/null +++ b/doc/s6-halt.html @@ -0,0 +1,36 @@ + + + + + s6-linux-utils: the s6-halt program + + + + + + +

+s6-linux-utils
+Software
+skarnet.org +

+ +

The s6-halt program

+ +

+s6-halt syncs the filesystems and halts the machine +immediately, without switching the power off. +
This is different from the sysvinit halt +command, which is an alias for shutdown -h. The +s6-linux-utils s6-halt command is more or less equivalent to +sysvinit's halt -f. +

+ +

Interface

+ +
+     s6-halt
+
+ + + diff --git a/doc/s6-hiercopy.html b/doc/s6-hiercopy.html new file mode 100644 index 0000000..e8dd2ed --- /dev/null +++ b/doc/s6-hiercopy.html @@ -0,0 +1,66 @@ + + + + + s6-linux-utils: the s6-hiercopy program + + + + + + +

+s6-linux-utils
+Software
+skarnet.org +

+ +

The s6-hiercopy program

+ +

+s6-hiercopy copies a directory structure recursively. +

+ +

Interface

+ +
+     s6-hiercopy source destination
+
+ + + +

Notes

+ +

+ Copying files and browsing through directories is one of Unix's +weakest points, and s6-hiercopy is not meant to work around +the problem; it's only a quick hack that I needed to boot my embedded +platform. I originally planned to write the ultimate cp utility, +portable and reliable and featureful and everything - while needing +approximately a hundred times less resources than GNU cp does, +of course. But I eventually dropped the idea: it's just impossible to +design, much less write, such a utility. +

+ + + + + diff --git a/doc/s6-hostname.html b/doc/s6-hostname.html new file mode 100644 index 0000000..8ff0081 --- /dev/null +++ b/doc/s6-hostname.html @@ -0,0 +1,39 @@ + + + + + s6-linux-utils: the s6-hostname program + + + + + + +

+s6-linux-utils
+Software
+skarnet.org +

+ +

The s6-hostname program

+ +

+s6-hostname gets or sets the machine hostname. +

+ +

Interface

+ +
+     s6-hostname [ name ]
+
+ + + + + diff --git a/doc/s6-logwatch.html b/doc/s6-logwatch.html new file mode 100644 index 0000000..5075d83 --- /dev/null +++ b/doc/s6-logwatch.html @@ -0,0 +1,72 @@ + + + + + s6-linux-utils: the s6-logwatch program + + + + + + +

+s6-linux-utils
+Software
+skarnet.org +

+ +

The s6-logwatch program

+ +

+s6-logwatch watches the current file of a logdir, printing it +in real time. +

+ +

Interface

+ +
+     s6-logwatch [ -m buflen ] logdir
+
+ + + +

Options

+ + + +

Bugs

+ + + +

Notes

+ + + + + diff --git a/doc/s6-mount.html b/doc/s6-mount.html new file mode 100644 index 0000000..b12c505 --- /dev/null +++ b/doc/s6-mount.html @@ -0,0 +1,52 @@ + + + + + s6-linux-utils: the s6-mount program + + + + + + +

+s6-linux-utils
+Software
+skarnet.org +

+ +

The s6-mount program

+ +

+s6-mount mounts filesystems. +

+ +

Interface

+ +
+     s6-mount -a
+     s6-mount [ -r | -w ] [ -t fstype ] [ -o option[,option...] ] device mntpoint
+
+ + + +

Options

+ + + + + diff --git a/doc/s6-pivotchroot.html b/doc/s6-pivotchroot.html new file mode 100644 index 0000000..42ba383 --- /dev/null +++ b/doc/s6-pivotchroot.html @@ -0,0 +1,41 @@ + + + + + s6-linux-utils: the s6-pivotchroot program + + + + + + +

+s6-linux-utils
+Software
+skarnet.org +

+ +

The s6-pivotchroot program

+ +

+s6-pivotchroot performs a pivot_root system call, +then changes root to the new root filesystem and executes a program. +

+ +

Interface

+ +
+     s6-pivotchroot newroot putold prog...
+
+ + + + + diff --git a/doc/s6-poweroff.html b/doc/s6-poweroff.html new file mode 100644 index 0000000..3685fff --- /dev/null +++ b/doc/s6-poweroff.html @@ -0,0 +1,39 @@ + + + + + s6-linux-utils: the s6-poweroff program + + + + + + +

+s6-linux-utils
+Software
+skarnet.org +

+ +

The s6-poweroff program

+ +

+s6-poweroff syncs the filesystems and halts the machine +immediately, switching the power off if possible. +

+ +

+ This is different from the sysvinit poweroff +command, which performs shutdown. The +s6-linux-utils s6-poweroff command is more or less equivalent to +sysvinit's poweroff -f. +

+ +

Interface

+ +
+     s6-poweroff
+
+ + + diff --git a/doc/s6-ps.html b/doc/s6-ps.html new file mode 100644 index 0000000..43ed0d2 --- /dev/null +++ b/doc/s6-ps.html @@ -0,0 +1,128 @@ + + + + + s6-linux-utils: the s6-ps program + + + + + + +

+s6-linux-utils
+Software
+skarnet.org +

+ +

The s6-ps program

+ +

+ s6-ps shows a list of processes on the system. +

+ +

Interface

+ +
+     s6-ps [ -H ] [ -w spacing ] [ -W chanfile ] [ -l | -o field,field,... ]
+
+ + + +

Options

+ + + +

Fields

+ +

+ The -o option makes it possible to customize s6-ps's output. Here are the +recognized field keywords and the corresponding field they display. +

+ + + + + diff --git a/doc/s6-reboot.html b/doc/s6-reboot.html new file mode 100644 index 0000000..9d2c594 --- /dev/null +++ b/doc/s6-reboot.html @@ -0,0 +1,38 @@ + + + + + s6-linux-utils: the s6-reboot program + + + + + + +

+s6-linux-utils
+Software
+skarnet.org +

+ +

The s6-reboot program

+ +

+s6-reboot syncs the filesystems and reboots the machine +immediately. +

+ +

This is different from the sysvinit reboot +command, which is an alias for shutdown -r. The +s6-linux-utils s6-reboot command is more or less equivalent to +sysvinit's reboot -f. +

+ +

Interface

+ +
+     s6-reboot
+
+ + + diff --git a/doc/s6-swapoff.html b/doc/s6-swapoff.html new file mode 100644 index 0000000..00307da --- /dev/null +++ b/doc/s6-swapoff.html @@ -0,0 +1,36 @@ + + + + + s6-linux-utils: the s6-swapoff program + + + + + + +

+s6-linux-utils
+Software
+skarnet.org +

+ +

The s6-swapoff program

+ +s6-swapoff deactivates swap partitions. + +

Interface

+ +
+     s6-swapoff [ -a | device ]
+
+ + + + + diff --git a/doc/s6-swapon.html b/doc/s6-swapon.html new file mode 100644 index 0000000..3298478 --- /dev/null +++ b/doc/s6-swapon.html @@ -0,0 +1,36 @@ + + + + + s6-linux-utils: the s6-swapon program + + + + + + +

+s6-linux-utils
+Software
+skarnet.org +

+ +

The s6-swapon program

+ +s6-swapon activates swap partitions. + +

Interface

+ +
+     s6-swapon [ -a | device ]
+
+ + + + + diff --git a/doc/s6-umount.html b/doc/s6-umount.html new file mode 100644 index 0000000..3efe82c --- /dev/null +++ b/doc/s6-umount.html @@ -0,0 +1,38 @@ + + + + + s6-linux-utils: the s6-umount program + + + + + + +

+s6-linux-utils
+Software
+skarnet.org +

+ +

The s6-umount program

+ +

+ s6-umount unmounts filesystems. +

+ +

Interface

+ +
+     s6-umount [ -a | mntpoint ]
+
+ + + + + diff --git a/doc/upgrade.html b/doc/upgrade.html new file mode 100644 index 0000000..5ab660e --- /dev/null +++ b/doc/upgrade.html @@ -0,0 +1,32 @@ + + + + + s6-linux-utils: how to upgrade + + + + + + +

+s6-linux-utils
+Software
+skarnet.org +

+ +

How to upgrade s6-linux-utils

+ +

to 2.0.0.0

+ + + + + -- cgit v1.2.3