fiss

Friedel's Initialization and Service Supervision
Log | Files | Refs | LICENSE

commit ff4f9784d2c57520a2f384c28174224a7c5335c1
parent 32a5a0c767ddd33fe06efd9eba890e998600d55f
Author: Friedel Schön <[email protected]>
Date:   Fri, 19 May 2023 13:17:30 +0200

updating manuals

Diffstat:
Aman/chpst.8 | 80+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Mman/finit.8 | 2+-
Mman/fsvc.8 | 4++--
Aman/fsvs.8 | 26++++++++++++++++++++++++++
Mman/halt.8 | 2+-
Mman/modules-load.8 | 87+++++++++++++++++++++++++++++++++----------------------------------------------
Mman/shutdown.8 | 148+++++++++++++++++++++++++++++++++++++------------------------------------------
Aman/sigremap.8 | 28++++++++++++++++++++++++++++
Aman/vlogger.1 | 115+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Dman/vlogger.8 | 209-------------------------------------------------------------------------------
Mman/zzz.8 | 2+-
Asrc/man/chpst.8.md | 83+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Msrc/man/finit.8.md | 2+-
Msrc/man/fsvc.8.md | 4++--
Asrc/man/fsvs.8.md | 30++++++++++++++++++++++++++++++
Msrc/man/halt.8.md | 2+-
Asrc/man/modules-load.8.md | 43+++++++++++++++++++++++++++++++++++++++++++
Dsrc/man/modules-load.8.roff | 52----------------------------------------------------
Asrc/man/shutdown.8.md | 73+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Dsrc/man/shutdown.8.roff | 90-------------------------------------------------------------------------------
Asrc/man/sigremap.8.md | 32++++++++++++++++++++++++++++++++
Asrc/man/vlogger.1.md | 109+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Dsrc/man/vlogger.8.roff | 209-------------------------------------------------------------------------------
Msrc/man/zzz.8.md | 2+-
24 files changed, 735 insertions(+), 699 deletions(-)

diff --git a/man/chpst.8 b/man/chpst.8 @@ -0,0 +1,80 @@ +.TH chpst 8 "MAY 2023" "0.2.2" "fiss man page" +.SH NAME +.PP +\fB\fCchpst\fR \- runs a program with a changed process state +.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...] +.SH DESCRIPTION +.PP +\fB\fC\-u [:]user[:group]\fR +.PP +setuidgid. Set uid and gid to the user's uid and gid, as found in /etc/passwd. If user is followed by a colon and a group, set the gid to group's gid, as found in /etc/group, instead of user's gid. If group consists of a colon\-separated list of group names, chpst sets the group ids of all listed groups. If user is prefixed with a colon, the user and all group arguments are interpreted as uid and gids respectivly, and not looked up in the password or group file. All initial supplementary groups are removed. +.PP +\fB\fC\-U [:]user[:group]\fR +.PP +envuidgid. Set the environment variables $UID and $GID to the user's uid and gid, as found in /etc/passwd. If user is followed by a colon and a group, set $GID to the group's gid, as found in /etc/group, instead of user's gid. If user is prefixed with a colon, the user and group arguments are interpreted as uid and gid respectivly, and not looked up in the password or group file. +.PP +\fB\fC\-b argv0\fR +Run prog with argv0 as the 0th argument. +.PP +\fB\fC\-e dir\fR +Set various environment variables as specified by files in the directory dir: If dir contains a file named k whose first line is v, chpst removes the environment variable k if it exists, and then adds the environment variable k with the value v. The name k must not contain =. Spaces and tabs at the end of v are removed, and nulls in v are changed to newlines. If +the file k is empty (0 bytes long), chpst removes the environment variable k if it exists, without adding a new variable. +.PP +\fB\fC\-/ root\fR +Change the root directory to root before starting prog. +.PP +\fB\fC\-C pwd\fR +Change the working directory to pwd before starting prog. When combined with \-/, the working directory is changed after the chroot. +.PP +\fB\fC\-n inc\fR +Add inc to the +.BR nice (2) +value before starting prog. inc must be an integer, and may start with a minus or plus. +.PP +\fB\fC\-l lock\fR +Open the file lock for writing, and obtain an exclusive lock on it. lock will be created if it does not exist. If lock is locked by another process, wait until a new lock can be obtained. +.PP +\fB\fC\-L lock\fR +The same as \-l, but fail immediately if lock is locked by another process. +.PP +\fB\fC\-m bytes\fR +Limit the data segment, stack segment, locked physical pages, and total of all segment per process to bytes bytes each. +.PP +\fB\fC\-d bytes\fR +limit data segment. Limit the data segment per process to bytes bytes. +.PP +\fB\fC\-o n\fR +Limit the number of open file descriptors per process to n. +.PP +\fB\fC\-p n\fR +Limit the number of processes per uid to n. +.PP +\fB\fC\-f bytes\fR +Limit the output file size to bytes bytes. +.PP +\fB\fC\-c bytes\fR +Limit the core file size to bytes bytes. +.PP +\fB\fC\-v\fR +Print verbose messages to standard error. This includes warnings about limits unsupported by the system. +.PP +\fB\fC\-P\fR +Run prog in a new process group. +.PP +\fB\fC\-0\fR +Close standard input before starting prog. +.PP +\fB\fC\-1\fR +Close standard output before starting prog. +.PP +\fB\fC\-2\fR +Close standard error before starting prog. +.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. +.SH AUTHOR +.PP +Based on the implementation by Gerrit Pape \[la][email protected]\[ra], +rewritten by Friedel Schon \[la][email protected]\[ra] diff --git a/man/finit.8 b/man/finit.8 @@ -1,4 +1,4 @@ -.TH finit 1 "MAY 2023" "01.0" "fiss man page" +.TH finit 8 "MAY 2023" "01.0" "fiss man page" .SH NAME .PP fiss \- a UNIX process no 1 diff --git a/man/fsvc.8 b/man/fsvc.8 @@ -1,7 +1,7 @@ -.TH fsvc 1 "MAY 2023" "01.0" "fiss man page" +.TH fsvc 8 "MAY 2023" "0.2.2" "fiss man page" .SH NAME .PP -fsvc \- fiss' service controller +\fB\fCfsvc\fR \- fiss' service controller .SH SYNOPSIS .PP \fB\fCfsvc\fR \fB\fCstart\fR [\fIoptions\fP] [\fB\fC\-\-pin_\fR] <service> diff --git a/man/fsvs.8 b/man/fsvs.8 @@ -0,0 +1,26 @@ +.TH fsvs 8 "MAY 2023" "0.2.2" "fiss man page" +.SH NAME +.PP +\fB\fCfsvs\fR \- friedel's service superviser +.SH SYNOPSIS +.PP +\fB\fCfsvs\fR [options] service\-dir runlevel +.SH DESCRIPTION +.PP +\fB\fCfsvs\fR is the superviser called by \fB\fCfinit\fR but without initialization. +.PP +Following options are available: +.PP +\fB\fC\-v, \-\-verbose\fR +Prints more information, easier to debug problems +.PP +\fB\fC\-f, \-\-force\fR +Forces the socket if existing, if called without \fB\fC\-f\fR and the socket already exists, it failes. +.PP +\fB\fC\-V, \-\-version\fR +Prints the version and exits. +.PP +Services can be controlled with \fB\fCfsvc 8\fR +.SH AUTHORS +.PP +Friedel Schon \[la][email protected]\[ra] diff --git a/man/halt.8 b/man/halt.8 @@ -1,4 +1,4 @@ -.TH halt 8 "MAY 2023" "0.1.0" "fiss man page" +.TH halt 8 "MAY 2023" "0.2.2" "fiss man page" .SH NAME .PP halt, reboot, poweroff \- stop the system diff --git a/man/modules-load.8 b/man/modules-load.8 @@ -1,52 +1,37 @@ -.Dd June 1, 2016 -.Dt MODULES-LOAD 8 -.Os Linux -.Sh NAME -.Nm modules-load -.Nd Configure kernel modules to load at boot -.Sh SYNOPSIS -.Nm modules-load -.Op Fl nv -.Sh DESCRIPTION -.Nm -reads files which contain kernel modules to load during boot from the list of -locations below. -.Bl -tag -width indent -.It Fl n -dry-run mode. -This option does everything but actually insert or delete the modules. -.It Fl v -verbose mode. -Print messages about what the program is doing. -.El -.Sh FILES +.TH modules\-load 8 "MAY 2023" "0.2.2" "fiss man page" +.SH NAME +.PP +\fB\fCmodules\-load\fR \- configure kernel modules at boot +.SH SYNOPSIS +.PP +\fB\fCmodules\-load\fR [\fB\fC\-nv\fR] +.SH DESCRIPTION +.PP +modules\-load reads files which contain kernel modules to load during boot from the list of locations below. +.PP +\fB\fC\-n\fR +dry\-run mode. This option does everything but actually insert or +delete the modules. +.PP +\fB\fC\-v\fR +verbose mode. Print messages about what the program is doing. +.SH FILES +.PP Configuration files are read from the following locations: -.Bl -tag -width indent -.It /etc/modules-load.d/*.conf -.It /run/modules-load.d/*.conf -.It /usr/lib/modules-load.d/*.conf -.El -.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. -.Sh EXAMPLES -.Pa /etc/modules-load.d/virtio-net.conf : -.Bd -literal -offset indent -# Load virtio-net.ko at boot -virtio-net -.Ed -.Sh SEE ALSO -.Xr modprobe 8 -.Sh HISTORY -This program is a replacement for the -.Nm modules-load -utility provided by -.Nm systemd . -.Sh AUTHOR -.An Leah Neukirchen , -.Mt [email protected] . -.Sh LICENSE -.Nm -is in the public domain. +.PP +\fI/etc/modules\-load.d/*\&.conf\fP +.PP +\fI/run/modules\-load.d/*\&.conf\fP +.PP +\fI/usr/lib/modules\-load.d/*\&.conf\fP +.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. +.SH HISTORY +.PP +This program is a replacement for the modules\-load utility provided by +systemd. +.SH AUTHOR +.PP +Leah Neukirchen, \[la][email protected]\[ra]\&. diff --git a/man/shutdown.8 b/man/shutdown.8 @@ -1,90 +1,82 @@ -.Dd July 29, 2014 -.Dt SHUTDOWN 8 -.Os Linux -.Sh NAME -.Nm shutdown -.Nd bring down the system -.Sh SYNOPSIS -.Nm shutdown -.Op Fl rhP -.Op Fl fF -.Op Cm now | Cm + Ns Ar mins -.Op Ar message ... -.Sh DESCRIPTION -.Nm -brings the system down in a secure way. -All logged-in users -are notified that the system is going down, and -.Xr login 1 +.TH shutdown 8 "MAY 2023" "0.2.2" "fiss man page" +.SH NAME +.PP +\fB\fCshutdown\fR – bring down the system +.SH SYNOPSIS +.PP +\fB\fCshutdown\fR [\fB\fC\-rhP\fR] [\fB\fC\-fF\fR] [now | +mins] [message ...] +.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 +.BR login (1) is blocked. -.Pp -By default, -.Nm -puts the system into single user mode. -Rebooting and halting the system can be done using the following options: -.Bl -tag -width indent -.It Fl c +.PP +By default, shutdown puts the system into single user mode. Rebooting and halting the system can be done using the following options: +.PP +\fB\fC\-c\fR Cancel an ongoing shutdown. -.It Fl f -Enable fast booting; skip -.Xr fsck 8 +.PP +\fB\fC\-f\fR +Enable fast booting; skip +.BR fsck (8) on next boot. -.It Fl F -Force run of -.Xr fsck 8 +.PP +\fB\fC\-F\fR +Force run of +.BR fsck (8) on next boot. -.It Fl h +.PP +\fB\fC\-h\fR Halt the system. -.It Fl k +.PP +\fB\fC\-k\fR Don't really shutdown; only send the warning messages to everybody. -.It Fl P +.PP +\fB\fC\-P\fR Poweroff the system. -.It Fl r +.PP +\fB\fC\-r\fR Reboot the system. -.It Cm now +.PP +\fB\fCnow\fR Shutdown without further waiting. -.It Cm + Ns Ar mins -Wait -.Ar mins -minutes before shutting down. -.It Ar message +.PP +\fB\fC+mins\fR +Wait mins minutes before shutting down. +.PP +\fB\fCmessage\fR +.PP Message displayed to all users, defaults to "system is going down". -.El -.Sh UNSUPPORTED OPTIONS -This version of -.Nm -is based on -.Xr fiss 8 , -the following features are -.Sy not -supported: -.Bl -tag -width indent -.It Fl t Ar secs -to wait -.Ar secs -seconds between SIGKILL and SIGTERM on shutdown is silently ignored. -.It Fl a -Use -.Pa /etc/shutdown.allow . -.It Fl H +.SH UNSUPPORTED OPTIONS +.PP +This version of shutdown is based on +.BR 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. +.PP +\fB\fC\-a\fR +Use /etc/shutdown.allow. +.PP +\fB\fC\-H\fR Drop into boot monitor. -.It Fl n -Don't call -.Xr init 8 . -.It Ar hh Ns : Ns Ar mm +.PP +\fB\fC\-n\fR +Don't call +.BR init (8). +.PP +\fB\fChh:mm\fR Absolute time specification is not implemented. -.El -.Sh EXAMPLES -Turn off the system: -.Dl # shutdown -h now -.Sh SEE ALSO -.Xr fsck 8 , -.Xr halt 8 , -.Xr init 8 , -.Xr poweroff 8 , -.Xr reboot 8 , -.Xr fiss 8 , -.Xr runsvchdir 8 -.Sh AUTHOR -.An Leah Neukirchen , -.Mt [email protected] . +.SH SEE ALSO +.PP +.BR fsck (8), +.BR halt (8), +.BR init (8), +.BR poweroff (8), +.BR reboot (8), +.BR fiss (8), +.BR runsvchdir (8) +.SH AUTHOR +.PP +Leah Neukirchen, \[la][email protected]\[ra]\&. diff --git a/man/sigremap.8 b/man/sigremap.8 @@ -0,0 +1,28 @@ +.TH sigremap 8 "MAY 2023" "0.2.2" "fiss man page" +.SH NAME +.PP +\fB\fCsigremap\fR \- a minimal init system for Linux containers +.SH SYNOPSIS +.PP +\fB\fCsigremap\fR [option] [old\-signal=new\-signal...] command [arguments ...] +.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 +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. +.PP +\fB\fC\-v, \-\-verbose\fR +Print debugging information to stderr. +.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. +.SH AUTHORS +.PP +\fB\fCsigremap\fR is based on dumb\-init by Yelp. +Rewritten by Friedel Schon \[la][email protected]\[ra] diff --git a/man/vlogger.1 b/man/vlogger.1 @@ -0,0 +1,115 @@ +.TH vlogger 1 "MAY 2023" "0.2.2" "fiss man page" +.SH NAME +.PP +\fB\fCvlogger\fR \- log messages to syslog or an arbitrary executable +.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 ...] +.SH DESCRIPTION +.PP +The vlogger utility writes messages to the system log or an arbitrary executable. +.PP +If vlogger is executed as logger it will always use the system log and behave like the regular +.BR logger (1). +.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 +If vlogger is executed as a log service for +.BR 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 +The options are as follows: +.PP +\fB\fC\-f file\fR +Read lines from the specified file. This option cannot be combine message arguments. +.PP +\fB\fC\-i\fR +Log the PID of the vlogger process. Only supported if +.BR syslog (3) +is used. +.PP +\fB\fC\-p pri\fR +The. pri can be facility.level or just facility. See FACILITIES, LEVELS or +.BR syslog (3). +The default is “user.notice”. +.PP +\fB\fC\-S\fR +Force vlogger to use +.BR syslog (3) +even if /etc/vlogger exists. +.PP +\fB\fC\-s\fR +Output the message to standard error, as well as +.BR syslog (3). +Only supported if +.BR syslog (3) +is used. +.PP +\fB\fC\-t tag\fR +Defines the +.BR openlog (3) +ident which is used as prefix for each log message or passed as first argument to /etc/vlogger. The default is the LOGNAME environment variable. +.PP +\fB\fCmessage\fR +Write the message to the system log. +.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. +.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. +.SH FILES +.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. +.SH EXIT STATUS +.PP +The vlogger utility exits 0 on success, and >0 if an error occurs. +.SH EXAMPLES +.PP +\fB\fC/etc/vlogger:\fR +.SH !/bin/sh +.PP +exec svlogd /var/log/$1 +.SH SEE ALSO +.PP +.BR logger (1), +.BR syslog (3), +.BR svlogd (8) +.SH HISTORY +.PP +This program is a replacement for the logger utility provided by util\-linux and forked from daemontools. +.SH AUTHORS +.PP +Duncan Overbruck \[la][email protected]\[ra] +.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 +\[la]http://creativecommons.org/publicdomain/zero/1.0/\[ra] diff --git a/man/vlogger.8 b/man/vlogger.8 @@ -1,209 +0,0 @@ -.Dd March 1, 2017 -.Dt VLOGGER 8 -.Os -.Sh NAME -.Nm vlogger -.Nd log messages to syslog or an arbitrary executable -.Sh SYNOPSIS -.Nm vlogger -.Op Fl isS -.Op Fl f Ar file -.Op Fl p Ar pri -.Op Fl t Ar tag -.Op Ar message ... -.Sh DESCRIPTION -The -.Nm -utility writes messages to the system log or an arbitrary executable. -.Pp -If -.Nm -is executed as -.Nm logger -it will always use the system log and behave like the regular -.Xr logger 1 . -.Pp -Without -.Ar message -arguments -.Nm -reads messages from -.Dv stdin -or the file specified with the -.Fl f -flag. -If the -.Pa /etc/vlogger -executable exists -.Nm -executes it with -.Ar tag , -.Ar level -and -.Ar facility -as arguments, -replacing the -.Nm -process. -.Pp -If -.Nm -is executed as a log service for -.Xr fiss 8 -or another daemontools like -supervision suite it uses the service name as default -.Ar tag . -As example if -.Nm -is linked to -.Pa /var/service/foo/log/run -it uses -.Dq foo -as -.Ar tag -and -.Dq daemon.notice -as -.Ar pri . -.Pp -The options are as follows: -.Bl -tag -width "-f file" -.It Fl f Ar file -Read lines from the specified -.Ar file . -This option cannot be combine -.Ar message -arguments. -.It Fl i -Log the PID of the -.Nm -process. -Only supported if -.Xr syslog 3 -is used. -.It Fl p Ar pri -The. -.Ar pri -can be -.Pa facility.level -or just -.Pa facility . -See -.Sx FACILITIES , -.Sx LEVELS -or -.Xr syslog 3 . -The default is -.Dq user.notice . -.It Fl S -Force -.Nm -to use -.Xr syslog 3 -even if -.Pa /etc/vlogger -exists. -.It Fl s -Output the message to standard error, as well as -.Xr syslog 3 . -Only supported if -.Xr syslog 3 -is used. -.It Fl t Ar tag -Defines the -.Xr openlog 3 -.Pa ident -which is used as prefix for each log message or passed as first argument to -.Pa /etc/vlogger . -The default is the -.Ev LOGNAME -environment variable. -.It Ar message -Write the -.Ar message -to the system log. -.El -.Sh FACILITIES -.Bl -tag -width 11n -compact -.It auth -.It authpriv -.It cron -.It daemon -.It ftp -.It kern -can not be used from userspace replaced with -.Pa daemon . -.It lpr -.It mail -.It news -.It syslog -.It user -.It uucp -.It local[0-7] -.It security -deprecated synonym for -.Pa auth . -.El -.Sh LEVELS -.Bl -tag -width 11n -compact -.It emerg -.It alert -.It crit -.It err -.It warning -.It notice -.It info -.It debug -.It panic -deprecated synonym for -.Pa emerg . -.It error -deprecated synonym for -.Ar err . -.It warn -deprecated synonym for -.Pa warning . -.El -.Sh FILES -.Bl -tag -width indent -.It /etc/vlogger -An optional executable file that is used to handle the messages. -It is executed with -.Ar tag , -.Ar level -and -.Ar facility -as arguments -and replaces the -.Nm -process. -.El -.Sh EXIT STATUS -.Ex -std -.Sh EXAMPLES -.Pa /etc/vlogger : -.Bd -literal -offset indent -#!/bin/sh -exec svlogd /var/log/$1 -.Ed -.Sh SEE ALSO -.Xr logger 1 , -.Xr syslog 3 , -.Xr svlogd 8 -.Sh HISTORY -This program is a replacement for the -.Nm logger -utility provided by -.Nm util-linux . -.Sh AUTHORS -.An Duncan Overbruck Aq Mt [email protected] -.Sh LICENSE -.Nm -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 -.Lk http://creativecommons.org/publicdomain/zero/1.0/ diff --git a/man/zzz.8 b/man/zzz.8 @@ -1,4 +1,4 @@ -.TH zzz 8 "MAY 2023" "0.1.0" "fiss man page" +.TH zzz 8 "MAY 2023" "0.1.2" "fiss man page" .SH NAME .PP zzz \- suspend or hibernate your system diff --git a/src/man/chpst.8.md b/src/man/chpst.8.md @@ -0,0 +1,83 @@ +# chpst 8 "MAY 2023" "0.2.2" "fiss man page" + +## NAME + +`chpst` - runs a program with a changed process state + +## SYNOPSIS + +`chpst` \[`-vP012`] \[`-u` user] \[`-U` user] \[`-b` argv0] \[`-e` dir] \[`-/` root] \[`-n` inc] \[`-l`|`-L` lock] \[`-m` bytes] \[`-d` bytes] \[`-o` n] \[`-p` n] \[`-f` bytes] \[`-c` bytes] prog \[arguments...] + +## DESCRIPTION + +`-u [:]user[:group]` + +setuidgid. Set uid and gid to the user's uid and gid, as found in /etc/passwd. If user is followed by a colon and a group, set the gid to group's gid, as found in /etc/group, instead of user's gid. If group consists of a colon-separated list of group names, chpst sets the group ids of all listed groups. If user is prefixed with a colon, the user and all group arguments are interpreted as uid and gids respectivly, and not looked up in the password or group file. All initial supplementary groups are removed. + +`-U [:]user[:group]` + +envuidgid. Set the environment variables $UID and $GID to the user's uid and gid, as found in /etc/passwd. If user is followed by a colon and a group, set $GID to the group's gid, as found in /etc/group, instead of user's gid. If user is prefixed with a colon, the user and group arguments are interpreted as uid and gid respectivly, and not looked up in the password or group file. + +`-b argv0` +Run prog with argv0 as the 0th argument. + +`-e dir` +Set various environment variables as specified by files in the directory dir: If dir contains a file named k whose first line is v, chpst removes the environment variable k if it exists, and then adds the environment variable k with the value v. The name k must not contain =. Spaces and tabs at the end of v are removed, and nulls in v are changed to newlines. If +the file k is empty (0 bytes long), chpst removes the environment variable k if it exists, without adding a new variable. + +`-/ root` +Change the root directory to root before starting prog. + +`-C pwd` +Change the working directory to pwd before starting prog. When combined with -/, the working directory is changed after the chroot. + +`-n inc` +Add inc to the nice(2) value before starting prog. inc must be an integer, and may start with a minus or plus. + +`-l lock` +Open the file lock for writing, and obtain an exclusive lock on it. lock will be created if it does not exist. If lock is locked by another process, wait until a new lock can be obtained. + +`-L lock` +The same as -l, but fail immediately if lock is locked by another process. + +`-m bytes` +Limit the data segment, stack segment, locked physical pages, and total of all segment per process to bytes bytes each. + +`-d bytes` +limit data segment. Limit the data segment per process to bytes bytes. + +`-o n` +Limit the number of open file descriptors per process to n. + +`-p n` +Limit the number of processes per uid to n. + +`-f bytes` +Limit the output file size to bytes bytes. + +`-c bytes` +Limit the core file size to bytes bytes. + +`-v` +Print verbose messages to standard error. This includes warnings about limits unsupported by the system. + +`-P` +Run prog in a new process group. + +`-0` +Close standard input before starting prog. + +`-1` +Close standard output before starting prog. + +`-2` +Close standard error before starting prog. + +## EXIT CODES + +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. + +## AUTHOR + +Based on the implementation by Gerrit Pape <[email protected]>, +rewritten by Friedel Schon <[email protected]> diff --git a/src/man/finit.8.md b/src/man/finit.8.md @@ -1,4 +1,4 @@ -# finit 1 "MAY 2023" "01.0" "fiss man page" +# finit 8 "MAY 2023" "01.0" "fiss man page" ## NAME diff --git a/src/man/fsvc.8.md b/src/man/fsvc.8.md @@ -1,8 +1,8 @@ -# fsvc 1 "MAY 2023" "01.0" "fiss man page" +# fsvc 8 "MAY 2023" "0.2.2" "fiss man page" ## NAME -fsvc - fiss' service controller +`fsvc` - fiss' service controller ## SYNOPSIS diff --git a/src/man/fsvs.8.md b/src/man/fsvs.8.md @@ -0,0 +1,30 @@ +# fsvs 8 "MAY 2023" "0.2.2" "fiss man page" + +## NAME + +`fsvs` - friedel's service superviser + +## SYNOPSIS + +`fsvs` \[options] service-dir runlevel + +## DESCRIPTION + +`fsvs` is the superviser called by `finit` but without initialization. + +Following options are available: + +`-v, --verbose` +Prints more information, easier to debug problems + +`-f, --force` +Forces the socket if existing, if called without `-f` and the socket already exists, it failes. + +`-V, --version` +Prints the version and exits. + +Services can be controlled with `fsvc 8` + +## AUTHORS + +Friedel Schon <[email protected]> diff --git a/src/man/halt.8.md b/src/man/halt.8.md @@ -1,4 +1,4 @@ -# halt 8 "MAY 2023" "0.1.0" "fiss man page" +# halt 8 "MAY 2023" "0.2.2" "fiss man page" ## NAME diff --git a/src/man/modules-load.8.md b/src/man/modules-load.8.md @@ -0,0 +1,43 @@ +# modules-load 8 "MAY 2023" "0.2.2" "fiss man page" + +## NAME + +`modules-load` - configure kernel modules at boot + +## SYNOPSIS + +`modules-load` \[`-nv`] + +## DESCRIPTION + +modules-load reads files which contain kernel modules to load during boot from the list of locations below. + +`-n` +dry-run mode. This option does everything but actually insert or +delete the modules. + +`-v` +verbose mode. Print messages about what the program is doing. + +## FILES + +Configuration files are read from the following locations: + +_/etc/modules-load.d/\*.conf_ + +_/run/modules-load.d/\*.conf_ + +_/usr/lib/modules-load.d/\*.conf_ + +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. + +## HISTORY + +This program is a replacement for the modules-load utility provided by +systemd. + +## AUTHOR + +Leah Neukirchen, [email protected]. diff --git a/src/man/modules-load.8.roff b/src/man/modules-load.8.roff @@ -1,52 +0,0 @@ -.Dd June 1, 2016 -.Dt MODULES-LOAD 8 -.Os Linux -.Sh NAME -.Nm modules-load -.Nd Configure kernel modules to load at boot -.Sh SYNOPSIS -.Nm modules-load -.Op Fl nv -.Sh DESCRIPTION -.Nm -reads files which contain kernel modules to load during boot from the list of -locations below. -.Bl -tag -width indent -.It Fl n -dry-run mode. -This option does everything but actually insert or delete the modules. -.It Fl v -verbose mode. -Print messages about what the program is doing. -.El -.Sh FILES -Configuration files are read from the following locations: -.Bl -tag -width indent -.It /etc/modules-load.d/*.conf -.It /run/modules-load.d/*.conf -.It /usr/lib/modules-load.d/*.conf -.El -.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. -.Sh EXAMPLES -.Pa /etc/modules-load.d/virtio-net.conf : -.Bd -literal -offset indent -# Load virtio-net.ko at boot -virtio-net -.Ed -.Sh SEE ALSO -.Xr modprobe 8 -.Sh HISTORY -This program is a replacement for the -.Nm modules-load -utility provided by -.Nm systemd . -.Sh AUTHOR -.An Leah Neukirchen , -.Mt [email protected] . -.Sh LICENSE -.Nm -is in the public domain. diff --git a/src/man/shutdown.8.md b/src/man/shutdown.8.md @@ -0,0 +1,73 @@ +# shutdown 8 "MAY 2023" "0.2.2" "fiss man page" + +## NAME + +`shutdown` – bring down the system + +## SYNOPSIS + +`shutdown` \[`-rhP`] \[`-fF`] \[now | +mins] \[message ...] + +## 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. + +By default, shutdown puts the system into single user mode. Rebooting and halting the system can be done using the following options: + +`-c` +Cancel an ongoing shutdown. + +`-f` +Enable fast booting; skip fsck(8) on next boot. + +`-F` +Force run of fsck(8) on next boot. + +`-h` +Halt the system. + +`-k` +Don't really shutdown; only send the warning messages to everybody. + +`-P` +Poweroff the system. + +`-r` +Reboot the system. + +`now` +Shutdown without further waiting. + +`+mins` +Wait mins minutes before shutting down. + +`message` + +Message displayed to all users, defaults to "system is going down". + +## UNSUPPORTED OPTIONS + +This version of shutdown is based on runit(8), the following features are not supported: + +`-t secs` +to wait secs seconds between SIGKILL and SIGTERM on shutdown is silently ignored. + +`-a` +Use /etc/shutdown.allow. + +`-H` +Drop into boot monitor. + +`-n` +Don't call init(8). + +`hh:mm` +Absolute time specification is not implemented. + +## SEE ALSO + +fsck(8), halt(8), init(8), poweroff(8), reboot(8), fiss(8), runsvchdir(8) + +## AUTHOR + +Leah Neukirchen, [email protected]. diff --git a/src/man/shutdown.8.roff b/src/man/shutdown.8.roff @@ -1,90 +0,0 @@ -.Dd July 29, 2014 -.Dt SHUTDOWN 8 -.Os Linux -.Sh NAME -.Nm shutdown -.Nd bring down the system -.Sh SYNOPSIS -.Nm shutdown -.Op Fl rhP -.Op Fl fF -.Op Cm now | Cm + Ns Ar mins -.Op Ar message ... -.Sh DESCRIPTION -.Nm -brings the system down in a secure way. -All logged-in users -are notified that the system is going down, and -.Xr login 1 -is blocked. -.Pp -By default, -.Nm -puts the system into single user mode. -Rebooting and halting the system can be done using the following options: -.Bl -tag -width indent -.It Fl c -Cancel an ongoing shutdown. -.It Fl f -Enable fast booting; skip -.Xr fsck 8 -on next boot. -.It Fl F -Force run of -.Xr fsck 8 -on next boot. -.It Fl h -Halt the system. -.It Fl k -Don't really shutdown; only send the warning messages to everybody. -.It Fl P -Poweroff the system. -.It Fl r -Reboot the system. -.It Cm now -Shutdown without further waiting. -.It Cm + Ns Ar mins -Wait -.Ar mins -minutes before shutting down. -.It Ar message -Message displayed to all users, defaults to "system is going down". -.El -.Sh UNSUPPORTED OPTIONS -This version of -.Nm -is based on -.Xr fiss 8 , -the following features are -.Sy not -supported: -.Bl -tag -width indent -.It Fl t Ar secs -to wait -.Ar secs -seconds between SIGKILL and SIGTERM on shutdown is silently ignored. -.It Fl a -Use -.Pa /etc/shutdown.allow . -.It Fl H -Drop into boot monitor. -.It Fl n -Don't call -.Xr init 8 . -.It Ar hh Ns : Ns Ar mm -Absolute time specification is not implemented. -.El -.Sh EXAMPLES -Turn off the system: -.Dl # shutdown -h now -.Sh SEE ALSO -.Xr fsck 8 , -.Xr halt 8 , -.Xr init 8 , -.Xr poweroff 8 , -.Xr reboot 8 , -.Xr fiss 8 , -.Xr runsvchdir 8 -.Sh AUTHOR -.An Leah Neukirchen , -.Mt [email protected] . diff --git a/src/man/sigremap.8.md b/src/man/sigremap.8.md @@ -0,0 +1,32 @@ +# sigremap 8 "MAY 2023" "0.2.2" "fiss man page" + +## NAME + +`sigremap` - a minimal init system for Linux containers + +## SYNOPSIS + +`sigremap` \[option] \[old-signal=new-signal...] command \[arguments ...] + +## 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: + +`-c, --single` +Run in single-child mode. In this mode, signals are only proxied to the direct child and not any of its descendants. + +`-v, --verbose` +Print debugging information to stderr. + +`-V, --version` +Print the current version and exit. + +`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. + +## AUTHORS + +`sigremap` is based on dumb-init by Yelp. +Rewritten by Friedel Schon <[email protected]> diff --git a/src/man/vlogger.1.md b/src/man/vlogger.1.md @@ -0,0 +1,109 @@ +# vlogger 1 "MAY 2023" "0.2.2" "fiss man page" + +## NAME + +`vlogger` - log messages to syslog or an arbitrary executable + +## SYNOPSIS + +`vlogger` \[`-isS`] \[`-f` file] \[`-p` pri] \[`-t` tag] \[message ...] + +## 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 options are as follows: + +`-f file` +Read lines from the specified file. This option cannot be combine message arguments. + +`-i` +Log the PID of the vlogger process. Only supported if syslog(3) is used. + +`-p pri` +The. pri can be facility.level or just facility. See FACILITIES, LEVELS or syslog(3). The default is “user.notice”. + +`-S` +Force vlogger to use syslog(3) even if /etc/vlogger exists. + +`-s` +Output the message to standard error, as well as syslog(3). Only supported if syslog(3) is used. + +`-t tag` +Defines the openlog(3) ident which is used as prefix for each log message or passed as first argument to /etc/vlogger. The default is the LOGNAME environment variable. + +`message` +Write the message to the system log. + +## 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. + +## LEVELS + +emerg +alert +crit +err +warning +notice +info +debug +panic deprecated synonym for emerg. +error deprecated synonym for err. +warn deprecated synonym for warning. + +## FILES + +`/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. + +## EXIT STATUS + +The vlogger utility exits 0 on success, and >0 if an error occurs. + +## EXAMPLES + +`/etc/vlogger:` +#!/bin/sh +exec svlogd /var/log/$1 + +## SEE ALSO + +logger(1), syslog(3), svlogd(8) + +## HISTORY + +This program is a replacement for the logger utility provided by util-linux and forked from daemontools. + +## AUTHORS + +Duncan Overbruck <[email protected]> + +## LICENSE + +vlogger is in the public domain. + +To the extent possible under law, the creator of this work has waived all copyright and related or neighboring rights to this work. + +http://creativecommons.org/publicdomain/zero/1.0/ diff --git a/src/man/vlogger.8.roff b/src/man/vlogger.8.roff @@ -1,209 +0,0 @@ -.Dd March 1, 2017 -.Dt VLOGGER 8 -.Os -.Sh NAME -.Nm vlogger -.Nd log messages to syslog or an arbitrary executable -.Sh SYNOPSIS -.Nm vlogger -.Op Fl isS -.Op Fl f Ar file -.Op Fl p Ar pri -.Op Fl t Ar tag -.Op Ar message ... -.Sh DESCRIPTION -The -.Nm -utility writes messages to the system log or an arbitrary executable. -.Pp -If -.Nm -is executed as -.Nm logger -it will always use the system log and behave like the regular -.Xr logger 1 . -.Pp -Without -.Ar message -arguments -.Nm -reads messages from -.Dv stdin -or the file specified with the -.Fl f -flag. -If the -.Pa /etc/vlogger -executable exists -.Nm -executes it with -.Ar tag , -.Ar level -and -.Ar facility -as arguments, -replacing the -.Nm -process. -.Pp -If -.Nm -is executed as a log service for -.Xr fiss 8 -or another daemontools like -supervision suite it uses the service name as default -.Ar tag . -As example if -.Nm -is linked to -.Pa /var/service/foo/log/run -it uses -.Dq foo -as -.Ar tag -and -.Dq daemon.notice -as -.Ar pri . -.Pp -The options are as follows: -.Bl -tag -width "-f file" -.It Fl f Ar file -Read lines from the specified -.Ar file . -This option cannot be combine -.Ar message -arguments. -.It Fl i -Log the PID of the -.Nm -process. -Only supported if -.Xr syslog 3 -is used. -.It Fl p Ar pri -The. -.Ar pri -can be -.Pa facility.level -or just -.Pa facility . -See -.Sx FACILITIES , -.Sx LEVELS -or -.Xr syslog 3 . -The default is -.Dq user.notice . -.It Fl S -Force -.Nm -to use -.Xr syslog 3 -even if -.Pa /etc/vlogger -exists. -.It Fl s -Output the message to standard error, as well as -.Xr syslog 3 . -Only supported if -.Xr syslog 3 -is used. -.It Fl t Ar tag -Defines the -.Xr openlog 3 -.Pa ident -which is used as prefix for each log message or passed as first argument to -.Pa /etc/vlogger . -The default is the -.Ev LOGNAME -environment variable. -.It Ar message -Write the -.Ar message -to the system log. -.El -.Sh FACILITIES -.Bl -tag -width 11n -compact -.It auth -.It authpriv -.It cron -.It daemon -.It ftp -.It kern -can not be used from userspace replaced with -.Pa daemon . -.It lpr -.It mail -.It news -.It syslog -.It user -.It uucp -.It local[0-7] -.It security -deprecated synonym for -.Pa auth . -.El -.Sh LEVELS -.Bl -tag -width 11n -compact -.It emerg -.It alert -.It crit -.It err -.It warning -.It notice -.It info -.It debug -.It panic -deprecated synonym for -.Pa emerg . -.It error -deprecated synonym for -.Ar err . -.It warn -deprecated synonym for -.Pa warning . -.El -.Sh FILES -.Bl -tag -width indent -.It /etc/vlogger -An optional executable file that is used to handle the messages. -It is executed with -.Ar tag , -.Ar level -and -.Ar facility -as arguments -and replaces the -.Nm -process. -.El -.Sh EXIT STATUS -.Ex -std -.Sh EXAMPLES -.Pa /etc/vlogger : -.Bd -literal -offset indent -#!/bin/sh -exec svlogd /var/log/$1 -.Ed -.Sh SEE ALSO -.Xr logger 1 , -.Xr syslog 3 , -.Xr svlogd 8 -.Sh HISTORY -This program is a replacement for the -.Nm logger -utility provided by -.Nm util-linux . -.Sh AUTHORS -.An Duncan Overbruck Aq Mt [email protected] -.Sh LICENSE -.Nm -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 -.Lk http://creativecommons.org/publicdomain/zero/1.0/ diff --git a/src/man/zzz.8.md b/src/man/zzz.8.md @@ -1,4 +1,4 @@ -# zzz 8 "MAY 2023" "0.1.0" "fiss man page" +# zzz 8 "MAY 2023" "0.1.2" "fiss man page" ## NAME