view vinit.8 @ 7:7d40d4ae7377 default tip @

misc: update copyright years
author David Demelier <markand@malikania.fr>
date Sun, 02 Jan 2022 10:26:58 +0100
parents d2a58a85bec2
children
line wrap: on
line source

.\"
.\" vinit.8 -- the Vanilla Linux init
.\"
.\" Copyright (c) 2021-2022 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 28, 2021
.Dt VINIT 8
.Os
.Sh NAME
.Nm vinit
.Nd the vanilla minimalist init
.Sh DESCRIPTION
.Nm
is the official default init system for vanilla. It's sole purpose is to start
init scripts and shutdown the system.
.Ss Startup
When the system starts,
.Nm
invokes
.Pa @SYSCONFDIR@/vinit.start
which setups the system and starts some services. There is no respawning
process, an external tool should be used for that purpose.
.Ss Shutdown
When a signal is received the script
.Pa @SYSCONFDIR@/vinit.shutdown
is invoked with a unique argument defined as follow:
.Bl -tag
.It USR1
Pass
.Dq halt
as argument, halt the system without powering off. The
.Xr halt 8
command can be used.
.It USR2
Pass
.Dq poweroff
as argument, halt the system and powering it off. The
.Xr poweroff 8
command can be used.
.It TERM
Pass
.Dq reboot
as argument, kill services and reboot the system. The
.Xr reboot 8
command can be used.
.Sh AVAILABLE SCRIPTS
The following scripts are available and installed by default, they are all
meant to be user edited:
.Bl -tag -width "Pa @SYSCONFDIR@/vinit.start"
.It Pa @SYSCONFDIR@/vinit.start
File executed by boot process to perform the machine initialization. It mounts
filesystem, checks devices and finally sets configuration from
.Pa @SYSCONFDIR@/vinit.conf
file.
.It Pa @SYSCONFDIR@/vinit.net
Enable network interfaces and configure them. Called just before starting user
services and mostly used for static address scenarios.
.It Pa @SYSCONFDIR@/vinit.shutdown
This file is executed when the machine is going off. Its purpose is to shutdown
all processed, unmount filesystem and halts the machine. It takes an argument
which can be one of:
.Dq halt ,
.Dq poweroff
or
.Dq reboot .
.Sh CONFIGURATION
The configuration lives in the
.Pa @SYSCONFDIR@/vinit.conf
file, see the
.Xr vinit.conf 5
manual page for more information.
.Sh AUTHORS
.Nm
was written by
.An David Demelier <markand@malikania.fr> .