From dd0220fd2c0866b16ed2e34f8701b014aea9d623 Mon Sep 17 00:00:00 2001 From: Joachim Nilsson Date: Wed, 26 Sep 2012 13:47:53 +0200 Subject: [PATCH] Update and clarify README Signed-off-by: Joachim Nilsson --- README.rst | 33 ++++++++++++++++++--------------- 1 file changed, 18 insertions(+), 15 deletions(-) diff --git a/README.rst b/README.rst index ce855fdf..c5597760 100644 --- a/README.rst +++ b/README.rst @@ -1,5 +1,5 @@ ============================================================================== - Finit — A fast plugin-based /sbin/init replacement with service monitoring + Finit — A fast plugin-based /sbin/init with service monitoring ============================================================================== Welcome to finit! @@ -8,7 +8,7 @@ This is a heavily extended version of the original /sbin/init replacement finit_. The original was a reimplementation of the EeePC "fastinit" daemon based on its system calls with gaps filled with frog DNA. -Focus of this extended version is towards small embedded Linux systems and +Focus of this extended version is on small embedded GNU/Linux systems and headless miniature servers with a need for extremely fast boot. In such environments configurations rarely change and setup is rather static and straight forward. @@ -22,13 +22,14 @@ If you chose finit you know what you want, a fast boot with no hassle. Features -------- -Finit supports the following features: +:Service monitoring: + Restarting a service when it exits +:Plugins: + Extend and modify finit behavior. See examples in plugins/ directory -- Service monitoring, restarting a service when it exits -- Plugins, see example plugins/ directory. Plugins provide: - - Optional service callbacks, should the service run/restart/stop? - - Hooks, hook into the boot at predefined points to extend finit - - I/O, listen to external events and control finit behaviour/services + * Service callbacks — should the service run/restart/stop? + * Hooks — hook into the boot at predefined points to extend finit + * I/O — listen to external events and control finit behaviour/services Most extensions and functionality not purely related to what an /sbin/init needs to start a system from the original finit_ has been reactored into @@ -40,8 +41,10 @@ plugins with either hooks or I/O demands. Contrary to most script based init alternatives (SysV init_, upstart_, OpenRC_ and the likes) finit reads its configuration from /etc/finit.conf, see the -source code for available options, or the examples/ for a Debian 6.0 example -configuration. +source code for available options. + +Try out the examples/finit.conf for a Debian 6.0 example configuration +capable of service monitoring SSH, sysklogd, gdm and a console getty! /etc/finit.d @@ -72,15 +75,15 @@ more useful comile-time tweaks. Contact ------- -Finit is maintained collaborativly at htps://github.com/troglobit/finit — +Finit is maintained collaborativly at https://github.com/troglobit/finit — please file a bug report, clone it, or send pull requests for bug fixes and proposed extensions, or become a co-maintainer by contacting the main author. Regards /Joachim Nilsson -:: _finit: http://helllabs.org/finit/ -:: _init: http://savannah.nongnu.org/projects/sysvinit -:: _upstart: http://upstart.ubuntu.com/ -:: _openrc: http://www.gentoo.org/proj/en/base/openrc/ +.. _finit: http://helllabs.org/finit/ +.. _init: http://savannah.nongnu.org/projects/sysvinit +.. _upstart: http://upstart.ubuntu.com/ +.. _openrc: http://www.gentoo.org/proj/en/base/openrc/