diff core/rc/rc.7 @ 585:75c8521c9b7a

core/rc: add initial documentation
author David Demelier <markand@malikania.fr>
date Mon, 08 Jul 2019 20:30:00 +0200
parents
children b8fa19b6a221
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/core/rc/rc.7	Mon Jul 08 20:30:00 2019 +0200
@@ -0,0 +1,54 @@
+.\"
+.\" Copyright (c) 2019 David Demelier <markand@malikania.fr>
+.\"
+.\" Permission to use, copy, modify, and/or distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd July 08, 2019
+.Dt RC 7
+.Os
+.Sh NAME
+.Nm rc
+.Nd vanilla init scripts
+.Sh DESCRIPTION
+Vanilla runs either
+.Ar busybox
+or
+.Ar sysvinit
+init daemons. The former one is more minimalistic and does not support runlevels
+while sysvinit is more traditional.
+.Sh FILES AND DIRECTORIES
+All files specified here are user editable and protected by
+.Nm vpk .
+Therefore, you can safely edit them for your own purposes.
+.Pp
+The following files and directories are understood by Vanilla's init process:
+.Bl -tag -width indent-xxxxxxxxxx
+.It Pa /etc/rc.conf
+The global configuration file for system initialization and basic configuration.
+See
+.Xr rc.conf 5
+for more details.
+.It Pa /etc/rc.init
+File executed early by boot process to perform the machine initialization. It
+mounts filesystem, checks devices sets configuration from
+.Pa /etc/rc.conf
+file.
+.It Pa /etc/rc.start
+This script is executed after the initialization and start users services. It
+takes a runlevel number as argument which is in the range 0-6.
+.It Pa /etc/rc.shutdown
+This file is executed when the machine is going off. Its purpose is to shutdown
+all processed, unmount filesystem and halts the machine.
+.El
+.Sh SEE ALSO
+.Xr rc.conf 5