commit 073a5dd078faa071ef42cfcc429f88f20416f1c4
parent f093e718eda9e002efd23fb5c1e4b52584312931
Author: Friedel Schon <[email protected]>
Date: Tue, 25 Apr 2023 12:39:33 +0200
updating manual pages
Diffstat:
12 files changed, 242 insertions(+), 339 deletions(-)
diff --git a/man/finit.8 b/man/finit.8
@@ -1,57 +0,0 @@
-.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/finit.8.md b/man/finit.8.md
@@ -0,0 +1,58 @@
+# finit 1 "MAY 2023" "01.0" "fiss man page"
+
+## NAME
+
+fiss - a UNIX process no 1
+
+## SYNOPSIS
+
+`fsvc`
+when running as PID 0 (as init)
+
+`fsvc` \<0|6\>
+when running regulary to controll init
+
+## CONTROLLING
+
+If `finit` is invoked by any other user than _root_, it failes.
+
+`finit` 0
+halts the system
+
+`finit` 6
+reboots the system
+
+## DESCRIPTION
+
+`fiss` 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:
+
+## 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.
+
+## 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.
+
+## 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
+
+## SIGNALS
+
+`finit` only accepts signals in stage 2.
+
+If `finit` receives a CONT signal and the file `finit`
+is told to shutdown the system.
+
+if `finit` receives an INT signal, `finit` restarts the system.
+
+## SEE ALSO
+
+fiss-init(8), runsvdir(8), runsvchdir(8), sv(8), runsv(8), chpst(8), utmpset(8), svlogd(8)
+
+## AUTHOR
+
+Friedel Schön \<[email protected]\>
diff --git a/man/fsvc.8 b/man/fsvc.8
@@ -1,76 +0,0 @@
-." 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/fsvc.8.md b/man/fsvc.8.md
@@ -0,0 +1,102 @@
+# fsvc 1 "MAY 2023" "01.0" "fiss man page"
+
+## NAME
+
+fsvc - fiss' service controller
+
+## SYNOPSIS
+
+`fsvc` `start` \[_options_] \[`--pin_`] \<service>
+
+`fsvc` `stop` \[_options_] \[`--pin`] \<service>
+
+`fsvc` `enable` \[_options_] \[`--once`] \<service>
+
+`fsvc` `disable` \[_options_] \[`--once`] \<service>
+
+`fsvc` kill \[_options_] \<service> \<signal|signo>
+
+`fsvc` status \[_options_] \[`--check`] \[\<service>]
+
+`fsvc` pause \[_options_] \<service>
+
+`fsvc` resume \[_options_] \<service>
+
+`fsvc` switch \[_options_] \[`--reset`] \<runlevel>
+
+## DESCRIPTION
+
+`fsvc` 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.
+
+## OPTIONS
+
+The following options are available for every command:
+
+`-q, --short`
+Will print brief information about the service.
+
+`-r, --runlevel <runlevel>`
+Will use \fBrunlevel\fB instead of _default_.
+
+`-s, --service-dir <path>`
+Will use `path` as service directory instead of _/etc/fiss/service.d_.
+
+`-v, --verbose`
+Prints verbose information.
+
+`-V, --version`
+Prints the version and exits.
+
+The following options are available per command:
+
+`-p, --pin`
+Pins the state. If issued with `start` it will cause the service to restart.
+If issued with `stop` it will cause the service to be hold down.
+
+`-o, --once`
+Specifies that the service should only be enabled/disabled once and not automatically started/stopped on subsequent bootups.
+
+`-c, --check`
+Command will return _0_ if the specified service is active otherwise _1_
+
+`-r, --reset`
+Specifies that the switch command should reset all running services (if manually set to up/down)
+
+## COMMANDS
+
+The following commands are available:
+
+`start`
+Starts the specified service. A synonym is `up`.
+
+`stop`
+Stops the specified service. A synonym is `down`.
+
+`enable`
+Enables the specified service, causing it to automatically start on subsequent bootups.
+
+`disable`
+Disables the specified service, causing it to not start automatically on subsequent bootups.
+
+`kill`
+Sends the specified signal or signal number to the specified service. A synonym is `send`.
+
+`status`
+Displays the status of the specified service. If no service is specified, displays the status of all services.
+
+`pause`
+Pauses the specified service.
+
+`resume`
+Resumes the specified service.
+
+`switch`
+Switches the runlevel to the specified value.
+
+## SEE ALSO
+
+finit(1), fsvc(8), fsvs(8), halt(8), modules-load(8), shutdown(8),
+
+## AUTHOR
+
+Friedel Schön \<[email protected]>
diff --git a/man/fsvs.8 b/man/fsvs.8
@@ -1,37 +0,0 @@
-." 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
@@ -1,72 +0,0 @@
-.Dd September 5, 2019
-.Dt HALT 8
-.Os Linux
-.Sh NAME
-.Nm halt ,
-.Nm reboot ,
-.Nm poweroff
-.Nd stop the system
-.Sh SYNOPSIS
-.Nm halt
-.Op Fl n
-.Op Fl f
-.Op Fl d
-.Op Fl w
-.Op Fl B
-.Nm reboot
-.Op Fl n
-.Op Fl f
-.Nm poweroff
-.Op Fl n
-.Op Fl f
-.Sh DESCRIPTION
-.Nm halt
-/
-.Nm reboot
-/
-.Nm poweroff
-tells
-.Xr init 8
-to bring down, reboot, or power off the system.
-Without
-.Fl f ,
-it is a shortcut for
-.Nm init 0
-/
-.Nm init 6 .
-.Bl -tag -width indent
-.It Fl n
-Don't sync before reboot or halt.
-Note that the kernel and storage drivers may still sync.
-.It Fl f
-Force halt or reboot, don't call
-.Xr init 8 .
-This is
-.Sy dangerous !
-.It Fl d
-Do not write the wtmp record.
-.It Fl w
-Just write the wtmp record.
-.It Fl B
-Just write the wtmp record, but for a boot.
-.El
-.Sh UNSUPPORTED OPTIONS
-This version of
-.Nm
-is based on
-.Xr fiss 8 ,
-the following features are
-.Sy not
-supported and silently ignored:
-.Bl -tag -width indent
-.It Fl h
-to put hard drives in standby mode.
-.It Fl i
-to shut down network interfaces.
-.El
-.Sh SEE ALSO
-.Xr init 8 ,
-.Xr shutdown 8
-.Sh AUTHOR
-.An Leah Neukirchen ,
-.Mt [email protected] .
diff --git a/man/halt.8.md b/man/halt.8.md
@@ -0,0 +1,39 @@
+# halt 8 "MAY 2023" "0.1.0" "fiss man page"
+
+## NAME
+
+halt, reboot, poweroff - stop the system
+
+## SYNOPSIS
+
+`poweroff` \[`-n`] \[`-f`] \[`-d`] \[`-w`] \[`-b`]
+
+`reboot` \[`-n`] \[`-f`] \[`-d`] \[`-w`] \[`-b`]
+
+`halt` \[`-n`] \[`-f`] \[`-d`] \[`-w`] \[`-b`]
+
+## 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>`
+
+## OPTIONS
+
+`-n`
+Don't sync devices, this doensn't imply that the kernel is not synced already
+
+`-f`
+Forces halt / reboot without notifying `init`. Forcing the system to halt should be the last hope and can be dangerous, you should not try it
+
+`-d`
+Don't write the _wtmp_ record
+
+`w`
+Only write the wtmp record, no further action
+
+## SEE ALSO
+
+finit(1), fsvc(8), fsvs(8), halt(8), modules-load(8), shutdown(8),
+
+## AUTHOR
+
+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.roff
diff --git a/man/shutdown.8 b/man/shutdown.8.roff
diff --git a/man/vlogger.8 b/man/vlogger.8.roff
diff --git a/man/zzz.8 b/man/zzz.8
@@ -1,94 +0,0 @@
-.Dd July 25, 2014
-.Dt ZZZ 8
-.Os Linux
-.Sh NAME
-.Nm zzz ,
-.Nm ZZZ
-.Nd suspend or hibernate your computer
-.Sh SYNOPSIS
-.Nm zzz
-.Op Fl nSzZRH
-.Nm ZZZ
-.Op Fl nSzZRH
-.Sh DESCRIPTION
-.Nm
-is a simple script to suspend or hibernate your computer.
-It supports hooks before and after suspending.
-.Bl -tag -width indent
-.It Fl n
-dry-run mode.
-Instead of performing an ACPI action,
-.Nm
-will just sleep for a few seconds.
-.It Fl S
-Enter low-power idle mode (ACPI S1, kernel name "freeze").
-.It Fl z
-Enter suspend to RAM mode (ACPI S3, kernel name "mem").
-This is the default for
-.Nm zzz .
-.It Fl Z
-Enter hibernate to disk mode (ACPI S4, kernel name "disk") and power off.
-This is the default for
-.Nm ZZZ .
-.It Fl R
-Enter hibernate to disk mode and reboot.
-This can be used to switch operating systems.
-.It Fl H
-Enter hibernate to disk mode and suspend.
-This is also know as suspend-hybrid.
-.El
-.Sh FILES
-Before suspending,
-.Nm zzz
-runs the executable files in
-.Pa /etc/zzz.d/suspend
-in alphanumeric order.
-After suspending,
-.Nm zzz
-runs the executable files in
-.Pa /etc/zzz.d/resume
-in alphanumeric order (not in reverse order!).
-.Pp
-The environment variable
-.Ev ZZZ_MODE
-can be used in these hooks to differentiate between
-.Ic standby ,
-.Ic suspend ,
-and
-.Ic resume .
-.Sh DIAGNOSTICS
-.Bl -tag -width indent
-.It suspend/hibernate not supported
-The hardware does not support ACPI S3/S4 with this kernel.
-.It sleep permission denied
-You lack sufficent privilege to write to
-.Pa /sys/power/state .
-.It another instance of zzz is running
-.Nm
-locks
-.Pa /sys/power
-during operation.
-Perhaps a hook is stuck?
-.It Zzzz... yawn.
-The system has woken up again.
-Everything is fine.
-You feel refreshed.
-.Sh SEE ALSO
-.Xr pm-action 8 ,
-.Xr s2disk 8 ,
-.Xr s2ram 8 ,
-OpenBSD's
-.Xr apm 8
-.Sh HISTORY
-A similar
-.Nm apm
-command appeared in
-.Nx 1.3
-and
-.Ox 1.2 .
-.Sh AUTHOR
-.An Leah Neukirchen ,
-.Mt [email protected] .
-.Sh LICENSE
-.Nm
-is in the public domain.
diff --git a/man/zzz.8.md b/man/zzz.8.md
@@ -0,0 +1,43 @@
+# zzz 8 "MAY 2023" "0.1.0" "fiss man page"
+
+## NAME
+
+zzz - suspend or hibernate your system
+
+## SYNOPSIS
+
+`zzz [-nSzZRH]`
+
+## DESCRIPTION
+
+`zzz` is a simple utility to hibernate or suspend your computer and part of the FISS-system. It supports suspend/resume-hooks.
+
+`-n, --noop`
+dry-run, sleep for 5sec instead of actually running ACPI actions.
+
+`-S, --freeze`
+enter low-power idle mode
+
+`-z, --suspend`
+suspend to RAM, this is the default behaviour of `zzz`
+
+`-Z, --hibernate`
+hibernate to disk and power off
+
+`-R, --reboot`
+hibernate to disk and reboot (useful for switching operating systems)
+
+`-H, --hybrid`
+hibernate to disk and suspend
+
+# HOOKS
+
+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.
+
+## SEE ALSO
+
+fiss-init(8), runsvdir(8), runsvchdir(8), sv(8), runsv(8), chpst(8), utmpset(8), svlogd(8)
+
+## AUTHOR
+
+Based on the version of Leah Neukirchen \<[email protected]\>, rewritten by Friedel Schön \<[email protected]\>
