commit ea776098c478da0098ed6ac1fd7477a752570d1f
parent d75301059d390b1baa10b7c9684af1237eaff40f
Author: Friedel Schön <[email protected]>
Date: Thu, 1 Jun 2023 13:52:48 +0200
prettifying manuals
Diffstat:
31 files changed, 354 insertions(+), 233 deletions(-)
diff --git a/docs/chpst.8.html b/docs/chpst.8.html
@@ -81,7 +81,7 @@ chpst exits 100 when called with wrong options. It prints an error message and e
<a class=title id=author href=#author>Author</a>
--------------------------------------------------------------------------------
-Based on the implementation by Gerrit Pape <[email protected]>, rewritten by Friedel Schon <[email protected]>
+Based on the implementation by Gerrit Pape <[email protected]>, rewritten by Friedel Schon <[email protected]>
</div>
</body>
</html>
diff --git a/docs/finit.8.html b/docs/finit.8.html
@@ -11,17 +11,19 @@
<body>
<div id=wrapper>
+<span class=header><a class=title id=top href=#top>finit(8) 0.3.3</a><span class=right><span id=toggle_dark onclick=toggle_dark()> turn the lights on </span> <a href=https://github.com/friedelschoen/fiss><img id=github alt=GitHub src=assets/github-mark.svg /></a></span></span>
+================================================================================
<a class=title id=name href=#name>Name</a>
--------------------------------------------------------------------------------
-fiss - a UNIX process no 1
+<b>fiss</b> - a UNIX process no 1
+
<a class=title id=synopsis href=#synopsis>Synopsis</a>
--------------------------------------------------------------------------------
-
<ul>
<li><b>fsvc</b> when running as PID 0 (as init) </li>
-<li><b>fsvc</b> <0|6> when running regulary to controll init </li></ul>
+<li><b>fsvc</b> <0|6> when running regulary to controll init </li></ul>
<a class=title id=controlling href=#controlling>Controlling</a>
--------------------------------------------------------------------------------
@@ -34,32 +36,38 @@ If <b>finit</b> is invoked by any other user than <i>root</i>, it failes.
<b>fiss</b> must be run as Unix process no 1 if invoked without arguments and handles the boot process in user-land.
This happens in three stages:
+
<a class=title id=stage href=#stage>Stage 1</a>
--------------------------------------------------------------------------------
<b>fiss</b> runs <i>/etc/fiss/start</i> and waits for it to terminate. The system's one time tasks are done here. <i>/etc/fiss/start</i> has full control of <i>/dev/console</i> to be able to start an emergency shell if the one time initialization tasks fail. If <i>/etc/fiss/start</i> crashes, <b>finit</b> will skip stage 2 and enter stage 3.
+
<a class=title id=stage href=#stage>Stage 2</a>
--------------------------------------------------------------------------------
<b>fiss</b> starts all services in <i>/etc/fiss/service.d</i> which should not return until system shutdown; if it crashes, it will be restarted.
+
<a class=title id=stage href=#stage>Stage 3</a>
--------------------------------------------------------------------------------
If <b>fiss</b> is told to shutdown the system, it terminates stage 2 if it is running, and runs <i>/etc/fiss/stop</i>. The systems tasks to shutdown and possibly halt or reboot the system are done here. If stage 3 returns, <b>finit</b> checks if the file
+
<a class=title id=signals href=#signals>Signals</a>
--------------------------------------------------------------------------------
<b>finit</b> only accepts signals in stage 2.
If <b>finit</b> receives a CONT signal and the file <b>finit</b> is told to shutdown the system.
if <b>finit</b> receives an INT signal, <b>finit</b> restarts the system.
-<a class=title id=see href=#see>See ALSO</a>
+
+<a class=title id=see href=#see>See Also</a>
--------------------------------------------------------------------------------
fiss-init(8), runsvdir(8), runsvchdir(8), sv(8), runsv(8), chpst(8), utmpset(8), svlogd(8)
+
<a class=title id=author href=#author>Author</a>
--------------------------------------------------------------------------------
-Friedel Schön <[email protected]> <
+Friedel Schön <[email protected]> <
</div>
</body>
</html>
diff --git a/docs/fsvc.8.html b/docs/fsvc.8.html
@@ -11,23 +11,27 @@
<body>
<div id=wrapper>
+<span class=header><a class=title id=top href=#top>fsvc(8) 0.3.3</a><span class=right><span id=toggle_dark onclick=toggle_dark()> turn the lights on </span> <a href=https://github.com/friedelschoen/fiss><img id=github alt=GitHub src=assets/github-mark.svg /></a></span></span>
+================================================================================
<a class=title id=name href=#name>Name</a>
--------------------------------------------------------------------------------
<b>fsvc</b> - fiss' service controller
+
<a class=title id=synopsis href=#synopsis>Synopsis</a>
--------------------------------------------------------------------------------
-<b>fsvc</b> <b>start</b> [<i>options</i>] [<b>--pin_</b>] <service>
-<b>fsvc</b> <b>stop</b> [<i>options</i>] [<b>--pin</b>] <service>
-<b>fsvc</b> <b>enable</b> [<i>options</i>] [<b>--once</b>] <service>
-<b>fsvc</b> <b>disable</b> [<i>options</i>] [<b>--once</b>] <service>
-<b>fsvc</b> <b>kill</b> [<i>options</i>] <service> <signal|signo>
-<b>fsvc</b> <b>status</b> [<i>options</i>] [<b>--check</b>] [<service>]
-<b>fsvc</b> <b>pause</b> [<i>options</i>] <service>
-<b>fsvc</b> <b>resume</b> [<i>options</i>] <service>
-<b>fsvc</b> <b>switch</b> [<i>options</i>] [<b>--reset</b>] <runlevel>
+<b>fsvc</b> <b>start</b> [<i>options</i>] [<b>--pin_</b>] <service>
+<b>fsvc</b> <b>stop</b> [<i>options</i>] [<b>--pin</b>] <service>
+<b>fsvc</b> <b>enable</b> [<i>options</i>] [<b>--once</b>] <service>
+<b>fsvc</b> <b>disable</b> [<i>options</i>] [<b>--once</b>] <service>
+<b>fsvc</b> <b>kill</b> [<i>options</i>] <service> <signal|signo>
+<b>fsvc</b> <b>status</b> [<i>options</i>] [<b>--check</b>] [<service>]
+<b>fsvc</b> <b>pause</b> [<i>options</i>] <service>
+<b>fsvc</b> <b>resume</b> [<i>options</i>] <service>
+<b>fsvc</b> <b>switch</b> [<i>options</i>] [<b>--reset</b>] <runlevel>
+
<a class=title id=description href=#description>Description</a>
--------------------------------------------------------------------------------
@@ -38,8 +42,8 @@
The following options are available for every command:
<ul>
<li><b>-q, --short</b> Will print brief information about the service. </li>
-<li><b>-r, --runlevel <runlevel></b> Will use fBrunlevelfB instead of <i>default</i>. </li>
-<li><b>-s, --service-dir <path></b> Will use <b>path</b> as service directory instead of <i>/etc/fiss/service.d</i>. </li>
+<li><b>-r, --runlevel <runlevel></b> Will use fBrunlevelfB instead of <i>default</i>. </li>
+<li><b>-s, --service-dir <path></b> Will use <b>path</b> as service directory instead of <i>/etc/fiss/service.d</i>. </li>
<li><b>-v, --verbose</b> Prints verbose information. </li>
<li><b>-V, --version</b> Prints the version and exits. </li>
<li>The following options are available per command: </li>
@@ -68,7 +72,7 @@ finit(1), fsvc(8), fsvs(8), halt(8), modules-load(8), shutdown(8),
<a class=title id=author href=#author>Author</a>
--------------------------------------------------------------------------------
-Friedel Schön <[email protected]> <
+Friedel Schön <[email protected]> <
</div>
</body>
</html>
diff --git a/docs/fsvs.8.html b/docs/fsvs.8.html
@@ -11,15 +11,19 @@
<body>
<div id=wrapper>
+<span class=header><a class=title id=top href=#top>fsvc(8) 0.3.3</a><span class=right><span id=toggle_dark onclick=toggle_dark()> turn the lights on </span> <a href=https://github.com/friedelschoen/fiss><img id=github alt=GitHub src=assets/github-mark.svg /></a></span></span>
+================================================================================
<a class=title id=name href=#name>Name</a>
--------------------------------------------------------------------------------
<b>fsvs</b> - friedel's service superviser
+
<a class=title id=synopsis href=#synopsis>Synopsis</a>
--------------------------------------------------------------------------------
<b>fsvs</b> [options] service-dir runlevel
+
<a class=title id=description href=#description>Description</a>
--------------------------------------------------------------------------------
@@ -30,10 +34,11 @@ Following options are available:
<li><b>-f, --force</b> Forces the socket if existing, if called without <b>-f</b> and the socket already exists, it failes. </li>
<li><b>-V, --version</b> Prints the version and exits. </li></ul>
Services can be controlled with <b>fsvc 8</b>
+
<a class=title id=authors href=#authors>Authors</a>
--------------------------------------------------------------------------------
-Friedel Schon <[email protected]>
+Friedel Schon <[email protected]>
</div>
</body>
</html>
diff --git a/docs/halt.8.html b/docs/halt.8.html
@@ -11,14 +11,16 @@
<body>
<div id=wrapper>
+<span class=header><a class=title id=top href=#top>halt(8) 0.3.3</a><span class=right><span id=toggle_dark onclick=toggle_dark()> turn the lights on </span> <a href=https://github.com/friedelschoen/fiss><img id=github alt=GitHub src=assets/github-mark.svg /></a></span></span>
+================================================================================
<a class=title id=name href=#name>Name</a>
--------------------------------------------------------------------------------
-halt, reboot, poweroff - stop the system
+<b>halt</b>, <b>reboot</b>, <b>poweroff</b> - stop the system
+
<a class=title id=synopsis href=#synopsis>Synopsis</a>
--------------------------------------------------------------------------------
-
<ul>
<li><b>poweroff</b> [<b>-n</b>] [<b>-f</b>] [<b>-d</b>] [<b>-w</b>] [<b>-b</b>] </li>
<li><b>reboot</b> [<b>-n</b>] [<b>-f</b>] [<b>-d</b>] [<b>-w</b>] [<b>-b</b>] </li>
@@ -26,23 +28,24 @@ halt, reboot, poweroff - stop the system
<a class=title id=description href=#description>Description</a>
--------------------------------------------------------------------------------
-<b>poweroff</b> / <b>reboot</b> / <b>halt</b> tells <b>init</b> to stop running services and stop the system. Invoked without <b>-f</b>, it is a shortcut for <b>init <0|6></b>
+<b>poweroff</b> / <b>reboot</b> / <b>halt</b> tells <b>init</b> to stop running services and stop the system. Invoked without <b>-f</b>, it is a shortcut for <b>init <0|6></b>
+
<a class=title id=options href=#options>Options</a>
--------------------------------------------------------------------------------
-
<ul>
<li><b>-n</b> Don't sync devices, this doensn't imply that the kernel is not synced already </li>
<li><b>-f</b> Forces halt / reboot without notifying <b>init</b>. Forcing the system to halt should be the last hope and can be dangerous, you should not try it </li>
<li><b>-d</b> Don't write the <i>wtmp</i> record </li>
-<li><b>w</b> Only write the wtmp record, no further action </li></ul>
+<li><b>-w</b> Only write the wtmp record, no further action </li></ul>
<a class=title id=see href=#see>See ALSO</a>
--------------------------------------------------------------------------------
finit(1), fsvc(8), fsvs(8), halt(8), modules-load(8), shutdown(8),
+
<a class=title id=author href=#author>Author</a>
--------------------------------------------------------------------------------
-Based on the version of Leah Neukirchen <[email protected]>, rewritten by Friedel Schön <[email protected]> <
+Based on the version of Leah Neukirchen <[email protected]>, rewritten by Friedel Schön <[email protected]> <
</div>
</body>
</html>
diff --git a/docs/modules-load.8.html b/docs/modules-load.8.html
@@ -11,15 +11,19 @@
<body>
<div id=wrapper>
+<span class=header><a class=title id=top href=#top>modules-load(8) 0.3.3</a><span class=right><span id=toggle_dark onclick=toggle_dark()> turn the lights on </span> <a href=https://github.com/friedelschoen/fiss><img id=github alt=GitHub src=assets/github-mark.svg /></a></span></span>
+================================================================================
<a class=title id=name href=#name>Name</a>
--------------------------------------------------------------------------------
<b>modules-load</b> - configure kernel modules at boot
+
<a class=title id=synopsis href=#synopsis>Synopsis</a>
--------------------------------------------------------------------------------
<b>modules-load</b> [<b>-nv</b>]
+
<a class=title id=description href=#description>Description</a>
--------------------------------------------------------------------------------
@@ -36,14 +40,17 @@ Configuration files are read from the following locations:
<li><i>/run/modules-load.d/*.conf</i> </li>
<li><i>/usr/lib/modules-load.d/*.conf</i> </li></ul>
The configuration files should simply contain a list of kernel module names to load, separated by newlines. Empty lines and lines whose first non-whitespace character is # or ; are ignored.
+
<a class=title id=history href=#history>History</a>
--------------------------------------------------------------------------------
This program is a replacement for the modules-load utility provided by systemd.
+
<a class=title id=author href=#author>Author</a>
--------------------------------------------------------------------------------
-Leah Neukirchen, [email protected].
+Leah Neukirchen, [email protected] (first shell-implementation)
+Friedel Schon, [email protected] (C-implementation)
</div>
</body>
</html>
diff --git a/docs/shutdown.8.html b/docs/shutdown.8.html
@@ -11,15 +11,19 @@
<body>
<div id=wrapper>
+<span class=header><a class=title id=top href=#top>shutdown(8) 0.3.3</a><span class=right><span id=toggle_dark onclick=toggle_dark()> turn the lights on </span> <a href=https://github.com/friedelschoen/fiss><img id=github alt=GitHub src=assets/github-mark.svg /></a></span></span>
+================================================================================
<a class=title id=name href=#name>Name</a>
--------------------------------------------------------------------------------
<b>shutdown</b> – bring down the system <
+
<a class=title id=synopsis href=#synopsis>Synopsis</a>
--------------------------------------------------------------------------------
<b>shutdown</b> [<b>-rhP</b>] [<b>-fF</b>] [now | +mins] [message ...]
+
<a class=title id=description href=#description>Description</a>
--------------------------------------------------------------------------------
@@ -39,16 +43,17 @@ By default, shutdown puts the system into single user mode. Rebooting and haltin
<a class=title id=unsupported href=#unsupported>Unsupported OPTIONS</a>
--------------------------------------------------------------------------------
-This version of shutdown is based on runit(8), the following features are not supported:
-<b>-t secs</b> to wait secs seconds between SIGKILL and SIGTERM on shutdown is silently ignored.
-<b>-a</b> Use /etc/shutdown.allow.
-<b>-H</b> Drop into boot monitor.
-<b>-n</b> Don't call init(8).
-<b>hh:mm</b> Absolute time specification is not implemented.
-<a class=title id=see href=#see>See ALSO</a>
+This version of shutdown is based on runit(8), the following features are not supported: <ul>
+<li><b>-t secs</b> to wait secs seconds between SIGKILL and SIGTERM on shutdown is silently ignored. </li>
+<li><b>-a</b> Use /etc/shutdown.allow. </li>
+<li><b>-H</b> Drop into boot monitor. </li>
+<li><b>-n</b> Don't call init(8). </li>
+<li><b>hh:mm</b> Absolute time specification is not implemented. </li></ul>
+<a class=title id=see href=#see>See Also</a>
--------------------------------------------------------------------------------
fsck(8), halt(8), init(8), poweroff(8), reboot(8), fiss(8), runsvchdir(8)
+
<a class=title id=author href=#author>Author</a>
--------------------------------------------------------------------------------
diff --git a/docs/sigremap.8.html b/docs/sigremap.8.html
@@ -11,29 +11,35 @@
<body>
<div id=wrapper>
+<span class=header><a class=title id=top href=#top>sigremap(8) 0.3.3</a><span class=right><span id=toggle_dark onclick=toggle_dark()> turn the lights on </span> <a href=https://github.com/friedelschoen/fiss><img id=github alt=GitHub src=assets/github-mark.svg /></a></span></span>
+================================================================================
<a class=title id=name href=#name>Name</a>
--------------------------------------------------------------------------------
<b>sigremap</b> - a minimal init system for Linux containers
+
<a class=title id=synopsis href=#synopsis>Synopsis</a>
--------------------------------------------------------------------------------
<b>sigremap</b> [option] [old-signal=new-signal...] command [arguments ...]
+
<a class=title id=description href=#description>Description</a>
--------------------------------------------------------------------------------
<b>sigremap</b> is a simple process supervisor that forwards signals to children. It is designed to run as PID1 in minimal container environments.
+
Optional arguments:
<ul>
<li><b>-c, --single</b> Run in single-child mode. In this mode, signals are only proxied to the direct child and not any of its descendants. </li>
<li><b>-v, --verbose</b> Print debugging information to stderr. </li>
<li><b>-V, --version</b> Print the current version and exit. </li>
-<li><b>old-signal=new-signal...</b> Rewrite received signal s to new signal r before proxying. To ignore (not proxy) a signal, rewrite it to 0. This option can be specified multiple times. </li></ul>
+<li><b>old-signal=new-signal</b> Rewrite received signal s to new signal r before proxying. To ignore (not proxy) a signal, rewrite it to 0. This option can be specified multiple times. </li></ul>
<a class=title id=authors href=#authors>Authors</a>
--------------------------------------------------------------------------------
-<b>sigremap</b> is based on dumb-init by Yelp. Rewritten by Friedel Schon <[email protected]>
+<b>sigremap</b> is based on <a href="https://github.com/Yelp/dumb-init">dumb-init by Yelp</a>.
+Rewritten by Friedel Schon <[email protected]>
</div>
</body>
</html>
diff --git a/docs/vlogger.1.html b/docs/vlogger.1.html
@@ -11,22 +11,30 @@
<body>
<div id=wrapper>
+<span class=header><a class=title id=top href=#top>vlogger(1) 0.3.3</a><span class=right><span id=toggle_dark onclick=toggle_dark()> turn the lights on </span> <a href=https://github.com/friedelschoen/fiss><img id=github alt=GitHub src=assets/github-mark.svg /></a></span></span>
+================================================================================
<a class=title id=name href=#name>Name</a>
--------------------------------------------------------------------------------
<b>vlogger</b> - log messages to syslog or an arbitrary executable
+
<a class=title id=synopsis href=#synopsis>Synopsis</a>
--------------------------------------------------------------------------------
<b>vlogger</b> [<b>-isS</b>] [<b>-f</b> file] [<b>-p</b> pri] [<b>-t</b> tag] [message ...]
+
<a class=title id=description href=#description>Description</a>
--------------------------------------------------------------------------------
The vlogger utility writes messages to the system log or an arbitrary executable.
+
If vlogger is executed as logger it will always use the system log and behave like the regular logger(1).
+
Without message arguments vlogger reads messages from stdin or the file specified with the -f flag. If the /etc/vlogger executable exists vlogger executes it with tag, level and facility as arguments, replacing the vlogger process.
+
If vlogger is executed as a log service for fiss(8) or another daemontools like supervision suite it uses the service name as default tag. As example if vlogger is linked to /var/service/foo/log/run it uses “foo” as tag and “daemon.notice” as pri. The opt
+
The options are as follows:
<ul>
<li><b>-f file</b> Read lines from the specified file. This option cannot be combine message arguments. </li>
@@ -39,35 +47,62 @@ The options are as follows:
<a class=title id=facilities href=#facilities>Facilities</a>
--------------------------------------------------------------------------------
-auth authpriv cron daemon ftp kern can not be used from userspace replaced with daemon. lpr mail news syslog user uucp local[0-7] security deprecated synonym for auth.
+auth
+authpriv
+cron
+daemon
+ftp
+kern can not be used from userspace replaced with daemon
+lpr
+mail
+news
+syslog
+user
+uucp
+local[0-7]
+security deprecated synonym for auth
+
<a class=title id=levels href=#levels>Levels</a>
--------------------------------------------------------------------------------
-emerg alert crit err warning notice info debug panic deprecated synonym for emerg. error deprecated synonym for err. warn deprecated synonym for warning.
+emerg
+alert
+crit
+err
+warning
+notice
+info
+debug
+panic deprecated synonym for emerg
+error deprecated synonym for err
+warn deprecated synonym for warning
+
+
<a class=title id=files href=#files>Files</a>
--------------------------------------------------------------------------------
-
-<b>/etc/vlogger</b> An optional executable file that is used to handle the messages. It is executed with tag, level and facility as arguments and replaces the vlogger process.
+<ul>
+<li><b>/etc/vlogger</b>
+An optional executable file that is used to handle the messages. It is executed with tag, level and facility as arguments and replaces the vlogger process. </li></ul>
<a class=title id=exit href=#exit>Exit STATUS</a>
--------------------------------------------------------------------------------
-The vlogger utility exits 0 on success, and >0 if an error occurs.
-<a class=title id=examples href=#examples>Examples</a>
---------------------------------------------------------------------------------
+The vlogger utility exits 0 on success, and >0 if an error occurs.
-<b>/etc/vlogger:</b> #!/bin/sh exec svlogd /var/log/$1
-<a class=title id=see href=#see>See ALSO</a>
+<a class=title id=see href=#see>See Also</a>
--------------------------------------------------------------------------------
logger(1), syslog(3), svlogd(8)
+
<a class=title id=history href=#history>History</a>
--------------------------------------------------------------------------------
This program is a replacement for the logger utility provided by util-linux and forked from daemontools.
+
<a class=title id=authors href=#authors>Authors</a>
--------------------------------------------------------------------------------
-Duncan Overbruck <[email protected]>
+Duncan Overbruck <[email protected]>
+
<a class=title id=license href=#license>License</a>
--------------------------------------------------------------------------------
diff --git a/docs/zzz.8.html b/docs/zzz.8.html
@@ -11,15 +11,19 @@
<body>
<div id=wrapper>
+<span class=header><a class=title id=top href=#top>zzz(8) 0.3.3</a><span class=right><span id=toggle_dark onclick=toggle_dark()> turn the lights on </span> <a href=https://github.com/friedelschoen/fiss><img id=github alt=GitHub src=assets/github-mark.svg /></a></span></span>
+================================================================================
<a class=title id=name href=#name>Name</a>
--------------------------------------------------------------------------------
zzz - suspend or hibernate your system
+
<a class=title id=synopsis href=#synopsis>Synopsis</a>
--------------------------------------------------------------------------------
<b>zzz [-nSzZRH]</b>
+
<a class=title id=description href=#description>Description</a>
--------------------------------------------------------------------------------
@@ -35,14 +39,16 @@ zzz - suspend or hibernate your system
--------------------------------------------------------------------------------
Before suspending, <b>zzz</b> executes <i>/usr/share/fiss/suspend</i> which intents to execute scripts inside <i>/etc/zzz.d/suspend</i> in alphanumeric order. After resuming, <b>zzz</b> executes <i>/usr/share/fiss/resume</i> which intents to execute scripts inside <i>/etc/zzz.d/resume</i> in alphanumeric order.
+
<a class=title id=see href=#see>See ALSO</a>
--------------------------------------------------------------------------------
fiss-init(8), runsvdir(8), runsvchdir(8), sv(8), runsv(8), chpst(8), utmpset(8), svlogd(8)
+
<a class=title id=author href=#author>Author</a>
--------------------------------------------------------------------------------
-Based on the version of Leah Neukirchen <[email protected]>, rewritten by Friedel Schön <[email protected]> <
+Based on the version of Leah Neukirchen <[email protected]>, rewritten by Friedel Schön <[email protected]> <
</div>
</body>
</html>
diff --git a/make-man.py b/make-man.py
@@ -4,6 +4,8 @@ import re
def inline_convert(text):
text = re.sub(r'\*(.+?)\*', r'\\fB\\fC\1\\fR', text)
text = re.sub(r'_(.+?)_', r'\\fI\1\\fR', text)
+ text = re.sub(r'\[(.*?)\]\((.*?)\)', r'\1', text)
+ text = text.replace('<', '<').replace('>', '>')
return text
in_list = False
diff --git a/man/chpst.8 b/man/chpst.8
@@ -1,19 +1,14 @@
.TH chpst 8 "MAY 2023" "0.3.3" "fiss man page"
-
.PP
.SH NAME
-
.PP
\fB\fCchpst\fR - runs a program with a changed process state
.PP
-
.PP
.SH SYNOPSIS
-
.PP
\fB\fCchpst\fR [\fB\fC-vP012\fR] [\fB\fC-u\fR user] [\fB\fC-U\fR user] [\fB\fC-b\fR argv0] [\fB\fC-e\fR dir] [\fB\fC-/\fR root] [\fB\fC-n\fR inc] [\fB\fC-l\fR|\fB\fC-L\fR lock] [\fB\fC-m\fR bytes] [\fB\fC-d\fR bytes] [\fB\fC-o\fR n] [\fB\fC-p\fR n] [\fB\fC-f\fR bytes] [\fB\fC-c\fR bytes] prog [arguments...]
.PP
-
.PP
.SH DESCRIPTION
\fB\fC-u [:]user[:group]\fR
@@ -52,10 +47,8 @@ Close standard output before starting prog.
\fB\fC-2\fR
Close standard error before starting prog.
.PP
-
.PP
.SH NOT IMPLEMENTED
-
.PP
Following options are defined in runit's chpst but are ignored by fiss' implementation.
.PP
@@ -84,13 +77,10 @@ Limit the core file size to bytes bytes.
Print verbose messages to standard error. This includes warnings about limits unsupported by the system.
.PP
.SH EXIT CODES
-
.PP
chpst exits 100 when called with wrong options. It prints an error message and exits 111 if it has trouble changing the process state. Otherwise its exit code is the same as that of prog.
.PP
-
.PP
.SH AUTHOR
-
.PP
-Based on the implementation by Gerrit Pape <[email protected]>, rewritten by Friedel Schon <[email protected]>
-\ No newline at end of file
+Based on the implementation by Gerrit Pape <[email protected]>, rewritten by Friedel Schon <[email protected]>
diff --git a/man/finit.8 b/man/finit.8
@@ -1,20 +1,16 @@
-.TH finit 8 "MAY 2023" "01.0" "fiss man page"
-
+.TH finit 8 "MAY 2023" "0.3.3" "fiss man page"
.PP
.SH NAME
-
.PP
-fiss - a UNIX process no 1
+\fB\fCfiss\fR - a UNIX process no 1
.PP
-.SH SYNOPSIS
-
.PP
+.SH SYNOPSIS
\fB\fCfsvc\fR when running as PID 0 (as init)
.PP
\fB\fCfsvc\fR <0|6> when running regulary to controll init
.PP
.SH CONTROLLING
-
.PP
If \fB\fCfinit\fR is invoked by any other user than \fIroot\fR, it failes.
.PP
@@ -23,29 +19,28 @@ If \fB\fCfinit\fR is invoked by any other user than \fIroot\fR, it failes.
\fB\fCfinit\fR 6 reboots the system
.PP
.SH DESCRIPTION
-
.PP
\fB\fCfiss\fR must be run as Unix process no 1 if invoked without arguments and handles the boot process in user-land.
.PP
This happens in three stages:
.PP
+.PP
.SH STAGE 1
-
.PP
\fB\fCfiss\fR runs \fI/etc/fiss/start\fR and waits for it to terminate. The system's one time tasks are done here. \fI/etc/fiss/start\fR has full control of \fI/dev/console\fR to be able to start an emergency shell if the one time initialization tasks fail. If \fI/etc/fiss/start\fR crashes, \fB\fCfinit\fR will skip stage 2 and enter stage 3.
.PP
+.PP
.SH STAGE 2
-
.PP
\fB\fCfiss\fR starts all services in \fI/etc/fiss/service.d\fR which should not return until system shutdown; if it crashes, it will be restarted.
.PP
+.PP
.SH STAGE 3
-
.PP
If \fB\fCfiss\fR is told to shutdown the system, it terminates stage 2 if it is running, and runs \fI/etc/fiss/stop\fR. The systems tasks to shutdown and possibly halt or reboot the system are done here. If stage 3 returns, \fB\fCfinit\fR checks if the file
.PP
+.PP
.SH SIGNALS
-
.PP
\fB\fCfinit\fR only accepts signals in stage 2.
.PP
@@ -53,12 +48,12 @@ If \fB\fCfinit\fR receives a CONT signal and the file \fB\fCfinit\fR is told to
.PP
if \fB\fCfinit\fR receives an INT signal, \fB\fCfinit\fR restarts the system.
.PP
+.PP
.SH SEE ALSO
-
.PP
fiss-init(8), runsvdir(8), runsvchdir(8), sv(8), runsv(8), chpst(8), utmpset(8), svlogd(8)
.PP
+.PP
.SH AUTHOR
-
.PP
-Friedel Schön <[email protected]>
-\ No newline at end of file
+Friedel Schön <[email protected]>
diff --git a/man/fsvc.8 b/man/fsvc.8
@@ -1,13 +1,11 @@
.TH fsvc 8 "MAY 2023" "0.3.3" "fiss man page"
-
.PP
.SH NAME
-
.PP
\fB\fCfsvc\fR - fiss' service controller
.PP
+.PP
.SH SYNOPSIS
-
.PP
\fB\fCfsvc\fR \fB\fCstart\fR [\fIoptions\fR] [\fB\fC--pin_\fR] <service>
.PP
@@ -27,13 +25,12 @@
.PP
\fB\fCfsvc\fR \fB\fCswitch\fR [\fIoptions\fR] [\fB\fC--reset\fR] <runlevel>
.PP
+.PP
.SH DESCRIPTION
-
.PP
\fB\fCfsvc\fR is a command line tool for controlling services on a fiss system. It provides various commands for starting, stopping, enabling, disabling, sending signals to, checking the status of, pausing, resuming, and switching the runlevel of services.
.PP
.SH OPTIONS
-
.PP
The following options are available for every command:
.PP
@@ -58,7 +55,6 @@ The following options are available per command:
\fB\fC-r, --reset\fR Specifies that the switch command should reset all running services (if manually set to up/down)
.PP
.SH COMMANDS
-
.PP
The following commands are available:
.PP
@@ -81,11 +77,9 @@ The following commands are available:
\fB\fCswitch\fR Switches the runlevel to the specified value.
.PP
.SH SEE ALSO
-
.PP
finit(1), fsvc(8), fsvs(8), halt(8), modules-load(8), shutdown(8),
.PP
.SH AUTHOR
-
.PP
-Friedel Schön <[email protected]>
-\ No newline at end of file
+Friedel Schön <[email protected]>
diff --git a/man/fsvs.8 b/man/fsvs.8
@@ -1,18 +1,16 @@
.TH fsvs 8 "MAY 2023" "0.3.3" "fiss man page"
-
.PP
.SH NAME
-
.PP
\fB\fCfsvs\fR - friedel's service superviser
.PP
+.PP
.SH SYNOPSIS
-
.PP
\fB\fCfsvs\fR [options] service-dir runlevel
.PP
+.PP
.SH DESCRIPTION
-
.PP
\fB\fCfsvs\fR is the superviser called by \fB\fCfinit\fR but without initialization.
.PP
@@ -26,7 +24,7 @@ Following options are available:
.PP
Services can be controlled with \fB\fCfsvc 8\fR
.PP
+.PP
.SH AUTHORS
-
.PP
-Friedel Schon <[email protected]>
-\ No newline at end of file
+Friedel Schon <[email protected]>
diff --git a/man/halt.8 b/man/halt.8
@@ -1,14 +1,11 @@
.TH halt 8 "MAY 2023" "0.3.3" "fiss man page"
-
.PP
.SH NAME
-
.PP
-halt, reboot, poweroff - stop the system
+\fB\fChalt\fR, \fB\fCreboot\fR, \fB\fCpoweroff\fR - stop the system
.PP
-.SH SYNOPSIS
-
.PP
+.SH SYNOPSIS
\fB\fCpoweroff\fR [\fB\fC-n\fR] [\fB\fC-f\fR] [\fB\fC-d\fR] [\fB\fC-w\fR] [\fB\fC-b\fR]
.PP
\fB\fCreboot\fR [\fB\fC-n\fR] [\fB\fC-f\fR] [\fB\fC-d\fR] [\fB\fC-w\fR] [\fB\fC-b\fR]
@@ -16,27 +13,24 @@ halt, reboot, poweroff - stop the system
\fB\fChalt\fR [\fB\fC-n\fR] [\fB\fC-f\fR] [\fB\fC-d\fR] [\fB\fC-w\fR] [\fB\fC-b\fR]
.PP
.SH DESCRIPTION
-
.PP
\fB\fCpoweroff\fR / \fB\fCreboot\fR / \fB\fChalt\fR tells \fB\fCinit\fR to stop running services and stop the system. Invoked without \fB\fC-f\fR, it is a shortcut for \fB\fCinit <0|6>\fR
.PP
-.SH OPTIONS
-
.PP
+.SH OPTIONS
\fB\fC-n\fR Don't sync devices, this doensn't imply that the kernel is not synced already
.PP
\fB\fC-f\fR Forces halt / reboot without notifying \fB\fCinit\fR. Forcing the system to halt should be the last hope and can be dangerous, you should not try it
.PP
\fB\fC-d\fR Don't write the \fIwtmp\fR record
.PP
-\fB\fCw\fR Only write the wtmp record, no further action
+\fB\fC-w\fR Only write the wtmp record, no further action
.PP
.SH SEE ALSO
-
.PP
finit(1), fsvc(8), fsvs(8), halt(8), modules-load(8), shutdown(8),
.PP
+.PP
.SH AUTHOR
-
.PP
-Based on the version of Leah Neukirchen <[email protected]>, rewritten by Friedel Schön <[email protected]>
-\ No newline at end of file
+Based on the version of Leah Neukirchen <[email protected]>, rewritten by Friedel Schön <[email protected]>
diff --git a/man/modules-load.8 b/man/modules-load.8
@@ -1,18 +1,16 @@
.TH modules-load 8 "MAY 2023" "0.3.3" "fiss man page"
-
.PP
.SH NAME
-
.PP
\fB\fCmodules-load\fR - configure kernel modules at boot
.PP
+.PP
.SH SYNOPSIS
-
.PP
\fB\fCmodules-load\fR [\fB\fC-nv\fR]
.PP
+.PP
.SH DESCRIPTION
-
.PP
modules-load reads files which contain kernel modules to load during boot from the list of locations below.
.PP
@@ -21,7 +19,6 @@ modules-load reads files which contain kernel modules to load during boot from t
\fB\fC-v\fR verbose mode. Print messages about what the program is doing.
.PP
.SH FILES
-
.PP
Configuration files are read from the following locations:
.PP
@@ -33,12 +30,14 @@ Configuration files are read from the following locations:
.PP
The configuration files should simply contain a list of kernel module names to load, separated by newlines. Empty lines and lines whose first non-whitespace character is # or ; are ignored.
.PP
+.PP
.SH HISTORY
-
.PP
This program is a replacement for the modules-load utility provided by systemd.
.PP
+.PP
.SH AUTHOR
-
.PP
-Leah Neukirchen, [email protected].
-\ No newline at end of file
+Leah Neukirchen, [email protected] (first shell-implementation)
+.PP
+Friedel Schon, [email protected] (C-implementation)
diff --git a/man/shutdown.8 b/man/shutdown.8
@@ -1,18 +1,16 @@
.TH shutdown 8 "MAY 2023" "0.3.3" "fiss man page"
-
.PP
.SH NAME
-
.PP
\fB\fCshutdown\fR – bring down the system .P
.PP
+.PP
.SH SYNOPSIS
-
.PP
\fB\fCshutdown\fR [\fB\fC-rhP\fR] [\fB\fC-fF\fR] [now | +mins] [message ...]
.PP
+.PP
.SH DESCRIPTION
-
.PP
shutdown brings the system down in a secure way. All logged-in users are notified that the system is going down, and login(1) is blocked.
.PP
@@ -39,11 +37,8 @@ By default, shutdown puts the system into single user mode. Rebooting and haltin
\fB\fCmessage\fR Message displayed to all users, defaults to "system is going down".
.PP
.SH UNSUPPORTED OPTIONS
-
.PP
-This version of shutdown is based on runit(8), the following features are not supported:
-.PP
-\fB\fC-t secs\fR to wait secs seconds between SIGKILL and SIGTERM on shutdown is silently ignored.
+This version of shutdown is based on runit(8), the following features are not supported: \fB\fC-t secs\fR to wait secs seconds between SIGKILL and SIGTERM on shutdown is silently ignored.
.PP
\fB\fC-a\fR Use /etc/shutdown.allow.
.PP
@@ -54,11 +49,10 @@ This version of shutdown is based on runit(8), the following features are not su
\fB\fChh:mm\fR Absolute time specification is not implemented.
.PP
.SH SEE ALSO
-
.PP
fsck(8), halt(8), init(8), poweroff(8), reboot(8), fiss(8), runsvchdir(8)
.PP
+.PP
.SH AUTHOR
-
.PP
-Leah Neukirchen, [email protected].
-\ No newline at end of file
+Leah Neukirchen, [email protected].
diff --git a/man/sigremap.8 b/man/sigremap.8
@@ -1,21 +1,20 @@
.TH sigremap 8 "MAY 2023" "0.3.3" "fiss man page"
-
.PP
.SH NAME
-
.PP
\fB\fCsigremap\fR - a minimal init system for Linux containers
.PP
+.PP
.SH SYNOPSIS
-
.PP
\fB\fCsigremap\fR [option] [old-signal=new-signal...] command [arguments ...]
.PP
+.PP
.SH DESCRIPTION
-
.PP
\fB\fCsigremap\fR is a simple process supervisor that forwards signals to children. It is designed to run as PID1 in minimal container environments.
.PP
+.PP
Optional arguments:
.PP
\fB\fC-c, --single\fR Run in single-child mode. In this mode, signals are only proxied to the direct child and not any of its descendants.
@@ -24,9 +23,10 @@ Optional arguments:
.PP
\fB\fC-V, --version\fR Print the current version and exit.
.PP
-\fB\fCold-signal=new-signal...\fR Rewrite received signal s to new signal r before proxying. To ignore (not proxy) a signal, rewrite it to 0. This option can be specified multiple times.
+\fB\fCold-signal=new-signal\fR Rewrite received signal s to new signal r before proxying. To ignore (not proxy) a signal, rewrite it to 0. This option can be specified multiple times.
.PP
.SH AUTHORS
-
.PP
-\fB\fCsigremap\fR is based on dumb-init by Yelp. Rewritten by Friedel Schon <[email protected]>
-\ No newline at end of file
+\fB\fCsigremap\fR is based on dumb-init by Yelp.
+.PP
+Rewritten by Friedel Schon <[email protected]>
diff --git a/man/vlogger.1 b/man/vlogger.1
@@ -1,27 +1,29 @@
.TH vlogger 1 "MAY 2023" "0.3.3" "fiss man page"
-
.PP
.SH NAME
-
.PP
\fB\fCvlogger\fR - log messages to syslog or an arbitrary executable
.PP
+.PP
.SH SYNOPSIS
-
.PP
\fB\fCvlogger\fR [\fB\fC-isS\fR] [\fB\fC-f\fR file] [\fB\fC-p\fR pri] [\fB\fC-t\fR tag] [message ...]
.PP
+.PP
.SH DESCRIPTION
-
.PP
The vlogger utility writes messages to the system log or an arbitrary executable.
.PP
+.PP
If vlogger is executed as logger it will always use the system log and behave like the regular logger(1).
.PP
+.PP
Without message arguments vlogger reads messages from stdin or the file specified with the -f flag. If the /etc/vlogger executable exists vlogger executes it with tag, level and facility as arguments, replacing the vlogger process.
.PP
+.PP
If vlogger is executed as a log service for fiss(8) or another daemontools like supervision suite it uses the service name as default tag. As example if vlogger is linked to /var/service/foo/log/run it uses “foo” as tag and “daemon.notice” as pri. .PP.PP
.PP
+.PP
The options are as follows:
.PP
\fB\fC-f file\fR Read lines from the specified file. This option cannot be combine message arguments.
@@ -39,50 +41,90 @@ The options are as follows:
\fB\fCmessage\fR Write the message to the system log.
.PP
.SH FACILITIES
-
.PP
-auth authpriv cron daemon ftp kern can not be used from userspace replaced with daemon. lpr mail news syslog user uucp local[0-7] security deprecated synonym for auth.
+auth
+.PP
+authpriv
+.PP
+cron
+.PP
+daemon
+.PP
+ftp
+.PP
+kern can not be used from userspace replaced with daemon
+.PP
+lpr
+.PP
+mail
+.PP
+news
+.PP
+syslog
+.PP
+user
+.PP
+uucp
+.PP
+local[0-7]
+.PP
+security deprecated synonym for auth
+.PP
.PP
.SH LEVELS
-
.PP
-emerg alert crit err warning notice info debug panic deprecated synonym for emerg. error deprecated synonym for err. warn deprecated synonym for warning.
+emerg
.PP
-.SH FILES
-
+alert
+.PP
+crit
+.PP
+err
+.PP
+warning
+.PP
+notice
+.PP
+info
+.PP
+debug
+.PP
+panic deprecated synonym for emerg
.PP
-\fB\fC/etc/vlogger\fR An optional executable file that is used to handle the messages. It is executed with tag, level and facility as arguments and replaces the vlogger process.
+error deprecated synonym for err
+.PP
+warn deprecated synonym for warning
+.PP
+.PP
+.PP
+.SH FILES
+\fB\fC/etc/vlogger\fR
+An optional executable file that is used to handle the messages. It is executed with tag, level and facility as arguments and replaces the vlogger process.
.PP
.SH EXIT STATUS
-
.PP
The vlogger utility exits 0 on success, and >0 if an error occurs.
.PP
-.SH EXAMPLES
-
-.PP
-\fB\fC/etc/vlogger:\fR #!/bin/sh exec svlogd /var/log/$1
.PP
.SH SEE ALSO
-
.PP
logger(1), syslog(3), svlogd(8)
.PP
+.PP
.SH HISTORY
-
.PP
This program is a replacement for the logger utility provided by util-linux and forked from daemontools.
.PP
+.PP
.SH AUTHORS
-
.PP
Duncan Overbruck <[email protected]>
.PP
+.PP
.SH LICENSE
-
.PP
vlogger is in the public domain.
.PP
To the extent possible under law, the creator of this work has waived all copyright and related or neighboring rights to this work.
.PP
-http://creativecommons.org/publicdomain/zero/1.0/
-\ No newline at end of file
+http://creativecommons.org/publicdomain/zero/1.0/
diff --git a/man/zzz.8 b/man/zzz.8
@@ -1,18 +1,16 @@
.TH zzz 8 "MAY 2023" "0.3.3" "fiss man page"
-
.PP
.SH NAME
-
.PP
zzz - suspend or hibernate your system
.PP
+.PP
.SH SYNOPSIS
-
.PP
\fB\fCzzz [-nSzZRH]\fR
.PP
+.PP
.SH DESCRIPTION
-
.PP
\fB\fCzzz\fR is a simple utility to hibernate or suspend your computer and part of the fiss-system. It supports suspend/resume-hooks.
.PP
@@ -29,16 +27,15 @@ zzz - suspend or hibernate your system
\fB\fC-H, --hybrid\fR hibernate to disk and suspend
.PP
.SH HOOKS
-
.PP
Before suspending, \fB\fCzzz\fR executes \fI/usr/share/fiss/suspend\fR which intents to execute scripts inside \fI/etc/zzz.d/suspend\fR in alphanumeric order. After resuming, \fB\fCzzz\fR executes \fI/usr/share/fiss/resume\fR which intents to execute scripts inside \fI/etc/zzz.d/resume\fR in alphanumeric order.
.PP
+.PP
.SH SEE ALSO
-
.PP
fiss-init(8), runsvdir(8), runsvchdir(8), sv(8), runsv(8), chpst(8), utmpset(8), svlogd(8)
.PP
+.PP
.SH AUTHOR
-
.PP
-Based on the version of Leah Neukirchen <[email protected]>, rewritten by Friedel Schön <[email protected]>
-\ No newline at end of file
+Based on the version of Leah Neukirchen <[email protected]>, rewritten by Friedel Schön <[email protected]>
diff --git a/src/man/chpst.8.txt b/src/man/chpst.8.txt
@@ -89,5 +89,5 @@ chpst exits 100 when called with wrong options. It prints an error message and e
@title author Author
-Based on the implementation by Gerrit Pape <[email protected]>,
-rewritten by Friedel Schon <[email protected]>
+Based on the implementation by Gerrit Pape <[email protected]>,
+rewritten by Friedel Schon <[email protected]>
diff --git a/src/man/finit.8.txt b/src/man/finit.8.txt
@@ -1,16 +1,17 @@
-@man finit 8 "MAY 2023" "01.0" "fiss man page"
+@man finit 8 "MAY 2023" "%VERSION%" "fiss man page"
+@header finit(8) %VERSION%
@title name Name
-fiss - a UNIX process no 1
+*fiss* - a UNIX process no 1
-@title synopsis Synopsis
+@title synopsis Synopsis
@list
*fsvc*
when running as PID 0 (as init)
-*fsvc* <0|6>
+*fsvc* <0|6>
when running regulary to controll init
@endlist
@@ -32,18 +33,22 @@ reboots the system
This happens in three stages:
+
@title stage Stage 1
*fiss* runs _/etc/fiss/start_ and waits for it to terminate. The system's one time tasks are done here. _/etc/fiss/start_ has full control of _/dev/console_ to be able to start an emergency shell if the one time initialization tasks fail. If _/etc/fiss/start_ crashes, *finit* will skip stage 2 and enter stage 3.
+
@title stage Stage 2
*fiss* starts all services in _/etc/fiss/service.d_ which should not return until system shutdown; if it crashes, it will be restarted.
+
@title stage Stage 3
If *fiss* is told to shutdown the system, it terminates stage 2 if it is running, and runs _/etc/fiss/stop_. The systems tasks to shutdown and possibly halt or reboot the system are done here. If stage 3 returns, *finit* checks if the file
+
@title signals Signals
*finit* only accepts signals in stage 2.
@@ -53,10 +58,12 @@ is told to shutdown the system.
if *finit* receives an INT signal, *finit* restarts the system.
-@title see See ALSO
+
+@title see See Also
fiss-init(8), runsvdir(8), runsvchdir(8), sv(8), runsv(8), chpst(8), utmpset(8), svlogd(8)
+
@title author Author
-Friedel Schön <[email protected]>
+Friedel Schön <[email protected]>
diff --git a/src/man/fsvc.8.txt b/src/man/fsvc.8.txt
@@ -1,28 +1,31 @@
@man fsvc 8 "MAY 2023" "%VERSION%" "fiss man page"
+@header fsvc(8) %VERSION%
@title name Name
*fsvc* - fiss' service controller
+
@title synopsis Synopsis
-*fsvc* *start* [_options_] [*--pin_*] <service>
+*fsvc* *start* [_options_] [*--pin_*] <service>
+
+*fsvc* *stop* [_options_] [*--pin*] <service>
-*fsvc* *stop* [_options_] [*--pin*] <service>
+*fsvc* *enable* [_options_] [*--once*] <service>
-*fsvc* *enable* [_options_] [*--once*] <service>
+*fsvc* *disable* [_options_] [*--once*] <service>
-*fsvc* *disable* [_options_] [*--once*] <service>
+*fsvc* *kill* [_options_] <service> <signal|signo>
-*fsvc* *kill* [_options_] <service> <signal|signo>
+*fsvc* *status* [_options_] [*--check*] [<service>]
-*fsvc* *status* [_options_] [*--check*] [<service>]
+*fsvc* *pause* [_options_] <service>
-*fsvc* *pause* [_options_] <service>
+*fsvc* *resume* [_options_] <service>
-*fsvc* *resume* [_options_] <service>
+*fsvc* *switch* [_options_] [*--reset*] <runlevel>
-*fsvc* *switch* [_options_] [*--reset*] <runlevel>
@title description Description
@@ -36,10 +39,10 @@ The following options are available for every command:
*-q, --short*
Will print brief information about the service.
-*-r, --runlevel <runlevel>*
+*-r, --runlevel <runlevel>*
Will use fBrunlevelfB instead of _default_.
-*-s, --service-dir <path>*
+*-s, --service-dir <path>*
Will use *path* as service directory instead of _/etc/fiss/service.d_.
*-v, --verbose*
@@ -103,4 +106,4 @@ finit(1), fsvc(8), fsvs(8), halt(8), modules-load(8), shutdown(8),
@title author Author
-Friedel Schön <[email protected]>
+Friedel Schön <[email protected]>
diff --git a/src/man/fsvs.8.txt b/src/man/fsvs.8.txt
@@ -1,13 +1,16 @@
@man fsvs 8 "MAY 2023" "%VERSION%" "fiss man page"
+@header fsvc(8) %VERSION%
@title name Name
*fsvs* - friedel's service superviser
+
@title synopsis Synopsis
*fsvs* [options] service-dir runlevel
+
@title description Description
*fsvs* is the superviser called by *finit* but without initialization.
@@ -27,6 +30,7 @@ Prints the version and exits.
Services can be controlled with *fsvc 8*
+
@title authors Authors
-Friedel Schon <[email protected]>
+Friedel Schon <[email protected]>
diff --git a/src/man/halt.8.txt b/src/man/halt.8.txt
@@ -1,11 +1,12 @@
@man halt 8 "MAY 2023" "%VERSION%" "fiss man page"
+@header halt(8) %VERSION%
@title name Name
-halt, reboot, poweroff - stop the system
+*halt*, *reboot*, *poweroff* - stop the system
-@title synopsis Synopsis
+@title synopsis Synopsis
@list
*poweroff* [*-n*] [*-f*] [*-d*] [*-w*] [*-b*]
@@ -16,10 +17,10 @@ halt, reboot, poweroff - stop the system
@title description Description
-*poweroff* / *reboot* / *halt* tells *init* to stop running services and stop the system. Invoked without *-f*, it is a shortcut for *init <0|6>*
+*poweroff* / *reboot* / *halt* tells *init* to stop running services and stop the system. Invoked without *-f*, it is a shortcut for *init <0|6>*
-@title options Options
+@title options Options
@list
*-n*
Don't sync devices, this doensn't imply that the kernel is not synced already
@@ -30,7 +31,7 @@ Forces halt / reboot without notifying *init*. Forcing the system to halt should
*-d*
Don't write the _wtmp_ record
-*w*
+*-w*
Only write the wtmp record, no further action
@endlist
@@ -38,6 +39,7 @@ Only write the wtmp record, no further action
finit(1), fsvc(8), fsvs(8), halt(8), modules-load(8), shutdown(8),
+
@title author Author
-Based on the version of Leah Neukirchen <[email protected]>, rewritten by Friedel Schön <[email protected]>
+Based on the version of Leah Neukirchen <[email protected]>, rewritten by Friedel Schön <[email protected]>
diff --git a/src/man/modules-load.8.txt b/src/man/modules-load.8.txt
@@ -1,13 +1,16 @@
@man modules-load 8 "MAY 2023" "%VERSION%" "fiss man page"
+@header modules-load(8) %VERSION%
@title name Name
*modules-load* - configure kernel modules at boot
+
@title synopsis Synopsis
*modules-load* [*-nv*]
+
@title description Description
modules-load reads files which contain kernel modules to load during boot from the list of locations below.
@@ -37,11 +40,15 @@ The configuration files should simply contain a list of kernel module
names to load, separated by newlines. Empty lines and lines whose first
non-whitespace character is # or ; are ignored.
+
@title history History
This program is a replacement for the modules-load utility provided by
systemd.
+
@title author Author
-Leah Neukirchen, [email protected].
+Leah Neukirchen, [email protected] (first shell-implementation)
+
+Friedel Schon, [email protected] (C-implementation)
+\ No newline at end of file
diff --git a/src/man/shutdown.8.txt b/src/man/shutdown.8.txt
@@ -1,13 +1,16 @@
@man shutdown 8 "MAY 2023" "%VERSION%" "fiss man page"
+@header shutdown(8) %VERSION%
@title name Name
*shutdown* – bring down the system
+
@title synopsis Synopsis
*shutdown* [*-rhP*] [*-fF*] [now | +mins] [message ...]
+
@title description Description
shutdown brings the system down in a secure way. All logged-in users are notified that the system is going down, and login(1) is blocked.
@@ -49,7 +52,7 @@ Message displayed to all users, defaults to "system is going down".
@title unsupported Unsupported OPTIONS
This version of shutdown is based on runit(8), the following features are not supported:
-
+@list
*-t secs*
to wait secs seconds between SIGKILL and SIGTERM on shutdown is silently ignored.
@@ -64,11 +67,13 @@ Don't call init(8).
*hh:mm*
Absolute time specification is not implemented.
+@endlist
-@title see See ALSO
+@title see See Also
fsck(8), halt(8), init(8), poweroff(8), reboot(8), fiss(8), runsvchdir(8)
+
@title author Author
Leah Neukirchen, [email protected].
diff --git a/src/man/sigremap.8.txt b/src/man/sigremap.8.txt
@@ -1,17 +1,21 @@
@man sigremap 8 "MAY 2023" "%VERSION%" "fiss man page"
+@header sigremap(8) %VERSION%
@title name Name
*sigremap* - a minimal init system for Linux containers
+
@title synopsis Synopsis
*sigremap* [option] [old-signal=new-signal...] command [arguments ...]
+
@title description Description
*sigremap* is a simple process supervisor that forwards signals to children. It is designed to run as PID1 in minimal container environments.
+
Optional arguments:
@list
@@ -24,11 +28,12 @@ Print debugging information to stderr.
*-V, --version*
Print the current version and exit.
-*old-signal=new-signal...*
+*old-signal=new-signal*
Rewrite received signal s to new signal r before proxying. To ignore (not proxy) a signal, rewrite it to 0. This option can be specified multiple times.
@endlist
@title authors Authors
-*sigremap* is based on dumb-init by Yelp.
-Rewritten by Friedel Schon <[email protected]>
+*sigremap* is based on [dumb-init by Yelp](https://github.com/Yelp/dumb-init).
+
+Rewritten by Friedel Schon <[email protected]>
diff --git a/src/man/vlogger.1.txt b/src/man/vlogger.1.txt
@@ -1,24 +1,31 @@
@man vlogger 1 "MAY 2023" "%VERSION%" "fiss man page"
+@header vlogger(1) %VERSION%
@title name Name
*vlogger* - log messages to syslog or an arbitrary executable
+
@title synopsis Synopsis
*vlogger* [*-isS*] [*-f* file] [*-p* pri] [*-t* tag] [message ...]
+
@title description Description
The vlogger utility writes messages to the system log or an arbitrary executable.
+
If vlogger is executed as logger it will always use the system log and behave like the regular logger(1).
+
Without message arguments vlogger reads messages from stdin or the file specified with the -f flag. If the /etc/vlogger executable exists vlogger executes it with tag, level and facility as arguments, replacing
the vlogger process.
+
If vlogger is executed as a log service for fiss(8) or another daemontools like supervision suite it uses the service name as default tag. As example if vlogger is linked to /var/service/foo/log/run it uses “foo” as tag and “daemon.notice” as pri.The op
+
The options are as follows:
@list
@@ -46,61 +53,62 @@ Write the message to the system log.
@title facilities Facilities
-auth
-authpriv
-cron
-daemon
-ftp
-kern can not be used from userspace replaced with daemon.
-lpr
-mail
-news
-syslog
-user
-uucp
-local[0-7]
-security deprecated synonym for auth.
+auth~
+authpriv~
+cron~
+daemon~
+ftp~
+kern can not be used from userspace replaced with daemon~
+lpr~
+mail~
+news~
+syslog~
+user~
+uucp~
+local[0-7]~
+security deprecated synonym for auth
+
@title levels Levels
-emerg
-alert
-crit
-err
-warning
-notice
-info
-debug
-panic deprecated synonym for emerg.
-error deprecated synonym for err.
-warn deprecated synonym for warning.
+emerg~
+alert~
+crit~
+err~
+warning~
+notice~
+info~
+debug~
+panic deprecated synonym for emerg~
+error deprecated synonym for err~
+warn deprecated synonym for warning~
-@title files Files
-*/etc/vlogger*
+@title files Files
+@list
+*/etc/vlogger*~
An optional executable file that is used to handle the messages. It is executed with tag, level and facility as arguments and replaces the vlogger process.
+@endlist
@title exit Exit STATUS
-The vlogger utility exits 0 on success, and >0 if an error occurs.
-
-@title examples Examples
+The vlogger utility exits 0 on success, and >0 if an error occurs.
-*/etc/vlogger:*
-#!/bin/sh
-exec svlogd /var/log/$1
-@title see See ALSO
+@title see See Also
logger(1), syslog(3), svlogd(8)
+
@title history History
This program is a replacement for the logger utility provided by util-linux and forked from daemontools.
+
@title authors Authors
-Duncan Overbruck <[email protected]>
+Duncan Overbruck <[email protected]>
+
@title license License
diff --git a/src/man/zzz.8.txt b/src/man/zzz.8.txt
@@ -1,13 +1,16 @@
@man zzz 8 "MAY 2023" "%VERSION%" "fiss man page"
+@header zzz(8) %VERSION%
@title name Name
zzz - suspend or hibernate your system
+
@title synopsis Synopsis
*zzz [-nSzZRH]*
+
@title description Description
*zzz* is a simple utility to hibernate or suspend your computer and part of the fiss-system. It supports suspend/resume-hooks.
@@ -36,10 +39,12 @@ hibernate to disk and suspend
Before suspending, *zzz* executes _/usr/share/fiss/suspend_ which intents to execute scripts inside _/etc/zzz.d/suspend_ in alphanumeric order. After resuming, *zzz* executes _/usr/share/fiss/resume_ which intents to execute scripts inside _/etc/zzz.d/resume_ in alphanumeric order.
+
@title see See ALSO
fiss-init(8), runsvdir(8), runsvchdir(8), sv(8), runsv(8), chpst(8), utmpset(8), svlogd(8)
+
@title author Author
-Based on the version of Leah Neukirchen <[email protected]>, rewritten by Friedel Schön <[email protected]>
+Based on the version of Leah Neukirchen <[email protected]>, rewritten by Friedel Schön <[email protected]>
