commit 2f4fa5e7ce04f2025597e0f2747f2ece3d2398ba
parent 54859c9016b40e4fe93bc161588ab72d923ae3a2
Author: Friedel Schon <[email protected]>
Date: Sun, 30 Apr 2023 00:33:42 +0200
adding static manuals
Diffstat:
14 files changed, 237 insertions(+), 0 deletions(-)
diff --git a/man/finit.8.md b/man-src/finit.8.md
diff --git a/man/fsvc.8.md b/man-src/fsvc.8.md
diff --git a/man/halt.8.md b/man-src/halt.8.md
diff --git a/man/modules-load.8.roff b/man-src/modules-load.8.roff
diff --git a/man/shutdown.8.roff b/man-src/shutdown.8.roff
diff --git a/man/vlogger.8.roff b/man-src/vlogger.8.roff
diff --git a/man/zzz.8.md b/man-src/zzz.8.md
diff --git a/man/finit.8 b/man/finit.8
@@ -0,0 +1,55 @@
+.TH finit 1 "MAY 2023" "01.0" "fiss man page"
+.SH NAME
+.PP
+fiss \- a UNIX process no 1
+.SH SYNOPSIS
+.PP
+\fB\fCfsvc\fR
+when running as PID 0 (as init)
+.PP
+\fB\fCfsvc\fR <0|6>
+when running regulary to controll init
+.SH CONTROLLING
+.PP
+If \fB\fCfinit\fR is invoked by any other user than \fIroot\fP, it failes.
+.PP
+\fB\fCfinit\fR 0
+halts the system
+.PP
+\fB\fCfinit\fR 6
+reboots the system
+.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:
+.SH STAGE 1
+.PP
+\fB\fCfiss\fR runs \fI/etc/fiss/start\fP and waits for it to terminate. The system's one time tasks are done here. \fI/etc/fiss/start\fP has full control of \fI/dev/console\fP to be able to start an emergency shell if the one time initialization tasks fail. If \fI/etc/fiss/start\fP crashes, \fB\fCfinit\fR will skip stage 2 and enter stage 3.
+.SH STAGE 2
+.PP
+\fB\fCfiss\fR starts all services in \fI/etc/fiss/service.d\fP which should not return until system shutdown; if it crashes, it will be restarted.
+.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\fP\&. 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
+.SH SIGNALS
+.PP
+\fB\fCfinit\fR only accepts signals in stage 2.
+.PP
+If \fB\fCfinit\fR receives a CONT signal and the file \fB\fCfinit\fR
+is told to shutdown the system.
+.PP
+if \fB\fCfinit\fR receives an INT signal, \fB\fCfinit\fR restarts the system.
+.SH SEE ALSO
+.PP
+.BR fiss-init (8),
+.BR runsvdir (8),
+.BR runsvchdir (8),
+.BR sv (8),
+.BR runsv (8),
+.BR chpst (8),
+.BR utmpset (8),
+.BR svlogd (8)
+.SH AUTHOR
+.PP
+Friedel Schön <\[la][email protected]\[ra]>
diff --git a/man/fsvc.8 b/man/fsvc.8
@@ -0,0 +1,100 @@
+.TH fsvc 1 "MAY 2023" "01.0" "fiss man page"
+.SH NAME
+.PP
+fsvc \- fiss' service controller
+.SH SYNOPSIS
+.PP
+\fB\fCfsvc\fR \fB\fCstart\fR [\fIoptions\fP] [\fB\fC\-\-pin_\fR] <service>
+.PP
+\fB\fCfsvc\fR \fB\fCstop\fR [\fIoptions\fP] [\fB\fC\-\-pin\fR] <service>
+.PP
+\fB\fCfsvc\fR \fB\fCenable\fR [\fIoptions\fP] [\fB\fC\-\-once\fR] <service>
+.PP
+\fB\fCfsvc\fR \fB\fCdisable\fR [\fIoptions\fP] [\fB\fC\-\-once\fR] <service>
+.PP
+\fB\fCfsvc\fR kill [\fIoptions\fP] <service> <signal|signo>
+.PP
+\fB\fCfsvc\fR status [\fIoptions\fP] [\fB\fC\-\-check\fR] [<service>]
+.PP
+\fB\fCfsvc\fR pause [\fIoptions\fP] <service>
+.PP
+\fB\fCfsvc\fR resume [\fIoptions\fP] <service>
+.PP
+\fB\fCfsvc\fR switch [\fIoptions\fP] [\fB\fC\-\-reset\fR] <runlevel>
+.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.
+.SH OPTIONS
+.PP
+The following options are available for every command:
+.PP
+\fB\fC\-q, \-\-short\fR
+Will print brief information about the service.
+.PP
+\fB\fC\-r, \-\-runlevel <runlevel>\fR
+Will use \[rs]fBrunlevel\[rs]fB instead of \fIdefault\fP\&.
+.PP
+\fB\fC\-s, \-\-service\-dir <path>\fR
+Will use \fB\fCpath\fR as service directory instead of \fI/etc/fiss/service.d\fP\&.
+.PP
+\fB\fC\-v, \-\-verbose\fR
+Prints verbose information.
+.PP
+\fB\fC\-V, \-\-version\fR
+Prints the version and exits.
+.PP
+The following options are available per command:
+.PP
+\fB\fC\-p, \-\-pin\fR
+Pins the state. If issued with \fB\fCstart\fR it will cause the service to restart.
+If issued with \fB\fCstop\fR it will cause the service to be hold down.
+.PP
+\fB\fC\-o, \-\-once\fR
+Specifies that the service should only be enabled/disabled once and not automatically started/stopped on subsequent bootups.
+.PP
+\fB\fC\-c, \-\-check\fR
+Command will return \fI0\fP if the specified service is active otherwise \fI1\fP
+.PP
+\fB\fC\-r, \-\-reset\fR
+Specifies that the switch command should reset all running services (if manually set to up/down)
+.SH COMMANDS
+.PP
+The following commands are available:
+.PP
+\fB\fCstart\fR
+Starts the specified service. A synonym is \fB\fCup\fR\&.
+.PP
+\fB\fCstop\fR
+Stops the specified service. A synonym is \fB\fCdown\fR\&.
+.PP
+\fB\fCenable\fR
+Enables the specified service, causing it to automatically start on subsequent bootups.
+.PP
+\fB\fCdisable\fR
+Disables the specified service, causing it to not start automatically on subsequent bootups.
+.PP
+\fB\fCkill\fR
+Sends the specified signal or signal number to the specified service. A synonym is \fB\fCsend\fR\&.
+.PP
+\fB\fCstatus\fR
+Displays the status of the specified service. If no service is specified, displays the status of all services.
+.PP
+\fB\fCpause\fR
+Pauses the specified service.
+.PP
+\fB\fCresume\fR
+Resumes the specified service.
+.PP
+\fB\fCswitch\fR
+Switches the runlevel to the specified value.
+.SH SEE ALSO
+.PP
+.BR finit (1),
+.BR fsvc (8),
+.BR fsvs (8),
+.BR halt (8),
+.BR modules-load (8),
+.BR shutdown (8),
+.SH AUTHOR
+.PP
+Friedel Schön <\[la][email protected]\[ra]>
diff --git a/man/halt.8 b/man/halt.8
@@ -0,0 +1,38 @@
+.TH halt 8 "MAY 2023" "0.1.0" "fiss man page"
+.SH NAME
+.PP
+halt, reboot, poweroff \- stop the system
+.SH SYNOPSIS
+.PP
+\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]
+.PP
+\fB\fChalt\fR [\fB\fC\-n\fR] [\fB\fC\-f\fR] [\fB\fC\-d\fR] [\fB\fC\-w\fR] [\fB\fC\-b\fR]
+.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
+.SH OPTIONS
+.PP
+\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\fP record
+.PP
+\fB\fCw\fR
+Only write the wtmp record, no further action
+.SH SEE ALSO
+.PP
+.BR finit (1),
+.BR fsvc (8),
+.BR fsvs (8),
+.BR halt (8),
+.BR modules-load (8),
+.BR shutdown (8),
+.SH AUTHOR
+.PP
+Based on the version of Leah Neukirchen <\[la][email protected]\[ra]>, rewritten by Friedel Schön <\[la][email protected]\[ra]>
diff --git a/man/modules-load.8.roff b/man/modules-load.8
diff --git a/man/shutdown.8.roff b/man/shutdown.8
diff --git a/man/vlogger.8.roff b/man/vlogger.8
diff --git a/man/zzz.8 b/man/zzz.8
@@ -0,0 +1,44 @@
+.TH zzz 8 "MAY 2023" "0.1.0" "fiss man page"
+.SH NAME
+.PP
+zzz \- suspend or hibernate your system
+.SH SYNOPSIS
+.PP
+\fB\fCzzz [\-nSzZRH]\fR
+.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
+\fB\fC\-n, \-\-noop\fR
+dry\-run, sleep for 5sec instead of actually running ACPI actions.
+.PP
+\fB\fC\-S, \-\-freeze\fR
+enter low\-power idle mode
+.PP
+\fB\fC\-z, \-\-suspend\fR
+suspend to RAM, this is the default behaviour of \fB\fCzzz\fR
+.PP
+\fB\fC\-Z, \-\-hibernate\fR
+hibernate to disk and power off
+.PP
+\fB\fC\-R, \-\-reboot\fR
+hibernate to disk and reboot (useful for switching operating systems)
+.PP
+\fB\fC\-H, \-\-hybrid\fR
+hibernate to disk and suspend
+.SH HOOKS
+.PP
+Before suspending, \fB\fCzzz\fR executes \fI/usr/share/fiss/suspend\fP which intents to execute scripts inside \fI/etc/zzz.d/suspend\fP in alphanumeric order. After resuming, \fB\fCzzz\fR executes \fI/usr/share/fiss/resume\fP which intents to execute scripts inside \fI/etc/zzz.d/resume\fP in alphanumeric order.
+.SH SEE ALSO
+.PP
+.BR fiss-init (8),
+.BR runsvdir (8),
+.BR runsvchdir (8),
+.BR sv (8),
+.BR runsv (8),
+.BR chpst (8),
+.BR utmpset (8),
+.BR svlogd (8)
+.SH AUTHOR
+.PP
+Based on the version of Leah Neukirchen <\[la][email protected]\[ra]>, rewritten by Friedel Schön <\[la][email protected]\[ra]>
