summaryrefslogtreecommitdiff
path: root/man/elogind-rc-local-generator.xml
diff options
context:
space:
mode:
Diffstat (limited to 'man/elogind-rc-local-generator.xml')
-rw-r--r--man/elogind-rc-local-generator.xml86
1 files changed, 86 insertions, 0 deletions
diff --git a/man/elogind-rc-local-generator.xml b/man/elogind-rc-local-generator.xml
new file mode 100644
index 000000000..9292f5cee
--- /dev/null
+++ b/man/elogind-rc-local-generator.xml
@@ -0,0 +1,86 @@
+<?xml version="1.0"?>
+<!--*-nxml-*-->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<!--
+ SPDX-License-Identifier: LGPL-2.1+
+
+ This file is part of elogind.
+
+ Copyright 2017 Lennart Poettering
+
+ elogind is free software; you can redistribute it and/or modify it
+ under the terms of the GNU Lesser General Public License as published by
+ the Free Software Foundation; either version 2.1 of the License, or
+ (at your option) any later version.
+
+ elogind is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ Lesser General Public License for more details.
+
+ You should have received a copy of the GNU Lesser General Public License
+ along with elogind; If not, see <http://www.gnu.org/licenses/>.
+-->
+<refentry id="elogind-rc-local-generator">
+
+ <refentryinfo>
+ <title>elogind-rc-local-generator</title>
+ <productname>elogind</productname>
+
+ <authorgroup>
+ <author>
+ <contrib>Developer</contrib>
+ <firstname>Lennart</firstname>
+ <surname>Poettering</surname>
+ <email>lennart@poettering.net</email>
+ </author>
+ </authorgroup>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>elogind-rc-local-generator</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>elogind-rc-local-generator</refname>
+ <refpurpose>Compatibility generator for starting <filename>/etc/rc.local</filename> and <filename>/usr/sbin/halt.local</filename> during boot and shutdown</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <para><filename>/usr/lib/elogind/system-generators/elogind-rc-local-generator</filename></para>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>Description</title>
+
+ <para><filename>elogind-rc-local-generator</filename> is a generator that checks whether
+ <filename>/etc/rc.local</filename> exists and is executable, and if it is pulls the
+ <filename>rc-local.service</filename> unit into the boot process. This unit is responsible for running this script
+ during late boot. Note that the script will be run with slightly different semantics than the original System V
+ version, which was run "last" in the boot process, which is a concept that does not translate to elogind. The
+ script is run after <filename>network.target</filename>, but in parallel with most other regular system
+ services.</para>
+
+ <para><filename>elogind-rc-local-generator</filename> also checks whether <filename>/usr/sbin/halt.local</filename>
+ exists and is executable, and if it is pulls the <filename>halt-local.service</filename> unit into the shutdown
+ process. This unit is responsible for running this script during later shutdown.</para>
+
+ <para>Support for both <filename>/etc/rc.local</filename> and <filename>/usr/sbin/halt.local</filename> is provided
+ for compatibility with specific System V systems only. However, it is strongly recommended to avoid making use of
+ these scripts today, and instead provide proper unit files with appropriate dependencies for any scripts to run
+ during the boot or shutdown processes.</para>
+
+ <para><filename>elogind-rc-local-generator</filename> implements
+ <citerefentry><refentrytitle>elogind.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
+ </refsect1>
+
+ <refsect1>
+ <title>See Also</title>
+ <para>
+ <citerefentry><refentrytitle>elogind</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+ </para>
+ </refsect1>
+
+</refentry>