commit f8536ea0d905993652caf1950d6aae1fca881e0f
parent b15e98850f0fd136a7e370c9287faace4ed97825
Author: sin <sin@2f30.org>
Date: Thu, 4 Dec 2014 14:07:35 +0000
Update manpage
Diffstat:
| M | sinit.8 | | | 78 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++----------------------- |
1 file changed, 55 insertions(+), 23 deletions(-)
diff --git a/sinit.8 b/sinit.8
@@ -1,30 +1,62 @@
-.TH SINIT 8 sinit-VERSION
-.SH NAME
-sinit \- The suckless init
-.SH DESCRIPTION
-sinit is a simple init. It is configured by modifying `config.h'
+.Dd December 4, 2014
+.Dt SINIT 8 sinit\-VERSION
+.Os
+.Sh NAME
+.Nm sinit
+.Nd simple init
+.Sh DESCRIPTION
+.Nm
+is a simple init. It is configured by modifying
+.Dq config.h
and recompiling the code.
-.SS Init sequence
-sinit will by default execute `/bin/rc.init'. You can chain
-your init scripts together at that point to allow for single-user
-and multi-user mode.
-.SS Signal handling
-sinit will respond to the following set of signals:
-.IP USR1
+.Ss Init sequence
+By default
+.Nm
+will execute
+.Dq /bin/rc.init .
+You can chain your init scripts together at that point to allow for
+single-user and multi-user operation.
+.Ss Signal handling
+.Nm
+will respond to the following signals:
+.Bl -tag -width xxxxxxxx
+.It USR1
Default action is to initiate the shutdown sequence by
-executing `/bin/rc.shutdown poweroff'.
-.IP INT
+executing
+.Dq /bin/rc.shutdown poweroff .
+.It INT
Default action is to initiate the reboot sequence by
-executing `/bin/rc.shutdown reboot'.
-.IP CHLD
+executing
+.Dq /bin/rc.shutdown reboot .
+.It CHLD
Reap children.
-.SS General considerations
-Running the rc.shutdown script directly is not recommended. If any
+.El
+.Ss General considerations
+Running the
+.Dq rc.shutdown
+script directly is not recommended. If any
process in your session has stale filesystem references then it is
likely your init scripts will fail to unmount the filesystem cleanly.
-It is recommended to signal sinit via a wrapper script.
-Similarly, sinit does not clear utmp records. The version of getty(8)
+It is recommended to signal
+.Nm
+via a wrapper script.
+.Pp
+.Nm
+does not clear utmp records. The version of
+.Xr getty 8
in ubase clears the utmp entries on the specified tty before it
-spawns the given program, usually login(1).
-.SH SEE ALSO
-killall5(8), getty(8)
+spawns the given program, usually
+.Xr login 1 .
+.Pp
+.Nm
+does not restart
+.Xr getty 8
+or interact with it in any way. You will need an external
+respawning mechanism to restart it.
+.Sh SEE ALSO
+.Xr killall5 8 ,
+.Xr getty 8
+.Sh AUTHORS
+The
+.Nm
+program was written by Dimitris Papastamos <sin@2f30.org>.
