man/elogind-rc-local-generator.xml

   1 <?xml version="1.0"?>
   2 <!--*-nxml-*-->
   3 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4 <!--
   5   SPDX-License-Identifier: LGPL-2.1+
   6
   7   This file is part of elogind.
   8
   9   Copyright 2017 Lennart Poettering
  10
  11   elogind is free software; you can redistribute it and/or modify it
  12   under the terms of the GNU Lesser General Public License as published by
  13   the Free Software Foundation; either version 2.1 of the License, or
  14   (at your option) any later version.
  15
  16   elogind is distributed in the hope that it will be useful, but
  17   WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19   Lesser General Public License for more details.
  20
  21   You should have received a copy of the GNU Lesser General Public License
  22   along with elogind; If not, see <http://www.gnu.org/licenses/>.
  23 -->
  24 <refentry id="elogind-rc-local-generator">
  25
  26   <refentryinfo>
  27     <title>elogind-rc-local-generator</title>
  28     <productname>elogind</productname>
  29
  30     <authorgroup>
  31       <author>
  32         <contrib>Developer</contrib>
  33         <firstname>Lennart</firstname>
  34         <surname>Poettering</surname>
  35         <email>lennart@poettering.net</email>
  36       </author>
  37     </authorgroup>
  38   </refentryinfo>
  39
  40   <refmeta>
  41     <refentrytitle>elogind-rc-local-generator</refentrytitle>
  42     <manvolnum>8</manvolnum>
  43   </refmeta>
  44
  45   <refnamediv>
  46     <refname>elogind-rc-local-generator</refname>
  47     <refpurpose>Compatibility generator for starting <filename>/etc/rc.local</filename> and <filename>/usr/sbin/halt.local</filename> during boot and shutdown</refpurpose>
  48   </refnamediv>
  49
  50   <refsynopsisdiv>
  51     <para><filename>/usr/lib/elogind/system-generators/elogind-rc-local-generator</filename></para>
  52   </refsynopsisdiv>
  53
  54   <refsect1>
  55     <title>Description</title>
  56
  57     <para><filename>elogind-rc-local-generator</filename> is a generator that checks whether
  58     <filename>/etc/rc.local</filename> exists and is executable, and if it is pulls the
  59     <filename>rc-local.service</filename> unit into the boot process. This unit is responsible for running this script
  60     during late boot. Note that the script will be run with slightly different semantics than the original System V
  61     version, which was run "last" in the boot process, which is a concept that does not translate to elogind. The
  62     script is run after <filename>network.target</filename>, but in parallel with most other regular system
  63     services.</para>
  64
  65     <para><filename>elogind-rc-local-generator</filename> also checks whether <filename>/usr/sbin/halt.local</filename>
  66     exists and is executable, and if it is pulls the <filename>halt-local.service</filename> unit into the shutdown
  67     process. This unit is responsible for running this script during later shutdown.</para>
  68
  69     <para>Support for both <filename>/etc/rc.local</filename> and <filename>/usr/sbin/halt.local</filename> is provided
  70     for compatibility with specific System V systems only. However, it is strongly recommended to avoid making use of
  71     these scripts today, and instead provide proper unit files with appropriate dependencies for any scripts to run
  72     during the boot or shutdown processes.</para>
  73
  74     <para><filename>elogind-rc-local-generator</filename> implements
  75     <citerefentry><refentrytitle>elogind.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
  76   </refsect1>
  77
  78   <refsect1>
  79     <title>See Also</title>
  80     <para>
  81       <citerefentry><refentrytitle>elogind</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  82       <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
  83     </para>
  84   </refsect1>
  85
  86 </refentry>