commit a4f0154cb866284baca3645bbe43a7a0a36fb390
parent 8b31de3b4b151b861b083d6445dd04818c949b0f
Author: Friedel Schon <[email protected]>
Date: Mon, 17 Apr 2023 14:17:34 +0200
manuals
Diffstat:
7 files changed, 177 insertions(+), 43 deletions(-)
diff --git a/man/finit.8 b/man/finit.8
@@ -0,0 +1,57 @@
+.TH fiss 8
+.SH NAME
+fiss \- a UNIX process no 1
+.SH SYNOPSIS
+.TP
+\fBfsvc\fR
+when running as PID 0 (as init)
+.TP
+\fBfsvc\fR <0|6>
+when running regulary to controll init
+.SH CONTROLLING
+If \fBfinit\fR is invoked by any other user than \fIfroot\fR, it failes.
+.P
+.TP
+\fBfinit\fR 0
+halts the system
+.TP
+\fBfinit\fR 6
+reboots the system
+.SH DESCRIPTION
+\fBfiss\fR 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:
+.SH STAGE 1
+\fBfiss\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,\fBfinit\fR will skip stage 2 and enter stage 3.
+.SH STAGE 2
+\fBfiss\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.
+.SH STAGE 3
+If \fBfiss\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, \fBfinit\fR checks if the file
+.SH SIGNALS
+\fBfinit\fR only accepts signals in stage 2.
+.P
+If \fBfinit\fR receives a CONT signal and the file \fBfinit\fR
+is told to shutdown the system.
+.P
+if \fBfinit\fR receives an INT signal, \fBfinit\fR restarts the system.
+.SH SEE ALSO
+fiss-init(8),
+runsvdir(8),
+runsvchdir(8),
+sv(8),
+runsv(8),
+chpst(8),
+utmpset(8),
+svlogd(8)
+.SH AUTHOR
+Friedel Schön <[email protected]>
+\ No newline at end of file
diff --git a/man/fsvc.8 b/man/fsvc.8
@@ -0,0 +1,76 @@
+." Manpage for fsvc.
+.TH fsvc 1 "2023-04-13" "1.0" "fsvc man page"
+.SH NAME
+fsvc - fiss' service controller
+.SH SYNOPSIS
+\fBfsvc\fR start [--pin] <service>
+
+\fBfsvc\fR stop [--pin] <service>
+
+\fBfsvc\fR enable [--once] <service>
+
+\fBfsvc\fR disable [--once] <service>
+
+\fBfsvc\fR kill <service> <signal|signo>
+
+\fBfsvc\fR status [--check] [<service>]
+
+\fBfsvc\fR pause <service>
+
+\fBfsvc\fR resume <service>
+
+\fBfsvc\fR switch [--reset] <runlevel>
+.SH DESCRIPTION
+\fBfsvc\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.
+.SH OPTIONS
+The following options are available:
+.TP
+\fB--pin\fR
+Pins the state. If issued with \fBstart\fR it will cause the service to restart, otherwise if will cause the service to be hold down.
+.TP
+\fB--once\fR
+Specifies that the service should only be enabled/disabled once and not automatically started/stopped on subsequent bootups.
+.TP
+\fB--check\fR
+Command will return 0 if the specified service is active otherwise 1
+.TP
+\fB--reset\fR
+Specifies that the switch command should reset all running services (if manually set to up/down)
+.SH COMMANDS
+The following commands are available:
+.TP
+\fBstart\fR
+Starts the specified service. A synonym is \fBup\fR.
+.TP
+\fBstop\fR
+Stops the specified service. A synonym is \fBdown\fR.
+.TP
+\fBenable\fR
+Enables the specified service, causing it to automatically start on subsequent bootups.
+.TP
+\fBdisable\fR
+Disables the specified service, causing it to not start automatically on subsequent bootups.
+.TP
+\fBkill\fR
+Sends the specified signal or signal number to the specified service. A synonym is \fBsend\fR.
+.TP
+\fBstatus\fR
+Displays the status of the specified service. If no service is specified, displays the status of all services.
+.TP
+\fBpause\fR
+Pauses the specified service.
+.TP
+\fBresume\fR
+Resumes the specified service.
+.TP
+\fBswitch\fR
+Switches the runlevel to the specified value.
+.SH SEE ALSO
+finit(1),
+fsvc(8),
+fsvs(8),
+halt(8),
+modules-load(8),
+shutdown(8)
+.SH AUTHOR
+Friedel Schön <[email protected]>
+\ No newline at end of file
diff --git a/man/fsvs.8 b/man/fsvs.8
@@ -0,0 +1,37 @@
+." Manpage for fsvs.
+.TH fsvs 1 "2023-04-13" "1.0" "fsvs man page"
+.SH NAME
+fsvs - fiss' service supervisor
+.SH SYNOPSIS
+\fBfsvs\fR [options] <runlevel>
+.SH DESCRIPTION
+\fBfsvs\fR is a command line tool for supervising services on a FISS system. It provides various options for executing start/stop scripts, printing service stdout/stderr in the console, using a custom service directory, and enabling verbose output.
+.SH OPTIONS
+The following options are available:
+.TP
+\fB-h, --help\fR
+Prints the help message and exits.
+.TP
+\fB-i, --as-init\fR
+Executes the start/stop script as init process.
+.TP
+\fB-o, --stdout\fR
+Prints the service stdout/stderr in the console.
+.TP
+\fB-s, --service-dir <path>\fR
+Uses the specified service directory instead of the default SV_SERVICE_DIR.
+.TP
+\fB-v, --verbose\fR
+Prints more detailed output.
+.TP
+\fB-V, --version\fR
+Prints the current version of fsvs and exits.
+.SH COMMANDS
+The following command is available:
+.TP
+\fB<runlevel>\fR
+Specifies the runlevel to supervise services for.
+.SH SEE ALSO
+fsvc(1)
+.SH AUTHOR
+fsvs was written by ChatGPT, a language model trained by OpenAI.
+\ No newline at end of file
diff --git a/man/halt.8 b/man/halt.8
@@ -54,7 +54,7 @@ Just write the wtmp record, but for a boot.
This version of
.Nm
is based on
-.Xr runit 8 ,
+.Xr fiss 8 ,
the following features are
.Sy not
supported and silently ignored:
diff --git a/man/pause.1 b/man/pause.1
@@ -1,39 +0,0 @@
-.Dd September 27, 2012
-.Dt PAUSE 1
-.Os Linux
-.Sh NAME
-.Nm pause
-.Nd don't exit, efficiently
-.Sh SYNOPSIS
-.Nm pause
-.Sh DESCRIPTION
-.Nm pause
-waits to be terminated by a signal.
-It can be used when service supervision is used but there is no
-long-running program to supervise.
-.Nm pause
-uses minimal system resources.
-.Sh EXAMPLES
-Setting up a static IP address with
-.Xr plugsv 8 .
-.Pp
-.Pa /etc/netsv/eth0/run :
-.Bd -literal -offset indent
-#!/bin/sh
-ip link set eth0 up
-ip addr add 192.0.2.1/24 dev eth0
-exec pause
-.Ed
-.Pp
-.Pa /etc/netsv/eth0/finish :
-.Bd -literal -offset indent
-#!/bin/sh
-ip addr del 192.0.2.1/24 dev eth0
-ip link set eth0 down
-.Ed
-.Sh SEE ALSO
-.Xr sleep 1 ,
-.Xr pause 2
-.Sh AUTHOR
-.An Leah Neukirchen ,
-.Mt [email protected] .
diff --git a/man/shutdown.8 b/man/shutdown.8
@@ -54,7 +54,7 @@ Message displayed to all users, defaults to "system is going down".
This version of
.Nm
is based on
-.Xr runit 8 ,
+.Xr fiss 8 ,
the following features are
.Sy not
supported:
@@ -83,7 +83,7 @@ Turn off the system:
.Xr init 8 ,
.Xr poweroff 8 ,
.Xr reboot 8 ,
-.Xr runit 8 ,
+.Xr fiss 8 ,
.Xr runsvchdir 8
.Sh AUTHOR
.An Leah Neukirchen ,
diff --git a/man/vlogger.8 b/man/vlogger.8
@@ -49,7 +49,7 @@ process.
If
.Nm
is executed as a log service for
-.Xr runit 8
+.Xr fiss 8
or another daemontools like
supervision suite it uses the service name as default
.Ar tag .
