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 <refentry id="elogind-rc-local-generator">
   8
   9   <refentryinfo>
  10     <title>elogind-rc-local-generator</title>
  11     <productname>elogind</productname>
  12
  13     <authorgroup>
  14       <author>
  15         <contrib>Developer</contrib>
  16         <firstname>Lennart</firstname>
  17         <surname>Poettering</surname>
  18         <email>lennart@poettering.net</email>
  19       </author>
  20     </authorgroup>
  21   </refentryinfo>
  22
  23   <refmeta>
  24     <refentrytitle>elogind-rc-local-generator</refentrytitle>
  25     <manvolnum>8</manvolnum>
  26   </refmeta>
  27
  28   <refnamediv>
  29     <refname>elogind-rc-local-generator</refname>
  30     <refpurpose>Compatibility generator for starting <filename>/etc/rc.local</filename> and <filename>/usr/sbin/halt.local</filename> during boot and shutdown</refpurpose>
  31   </refnamediv>
  32
  33   <refsynopsisdiv>
  34     <para><filename>/usr/lib/elogind/system-generators/elogind-rc-local-generator</filename></para>
  35   </refsynopsisdiv>
  36
  37   <refsect1>
  38     <title>Description</title>
  39
  40     <para><filename>elogind-rc-local-generator</filename> is a generator that checks whether
  41     <filename>/etc/rc.local</filename> exists and is executable, and if it is pulls the
  42     <filename>rc-local.service</filename> unit into the boot process. This unit is responsible for running this script
  43     during late boot. Note that the script will be run with slightly different semantics than the original System V
  44     version, which was run "last" in the boot process, which is a concept that does not translate to elogind. The
  45     script is run after <filename>network.target</filename>, but in parallel with most other regular system
  46     services.</para>
  47
  48     <para><filename>elogind-rc-local-generator</filename> also checks whether <filename>/usr/sbin/halt.local</filename>
  49     exists and is executable, and if it is pulls the <filename>halt-local.service</filename> unit into the shutdown
  50     process. This unit is responsible for running this script during later shutdown.</para>
  51
  52     <para>Support for both <filename>/etc/rc.local</filename> and <filename>/usr/sbin/halt.local</filename> is provided
  53     for compatibility with specific System V systems only. However, it is strongly recommended to avoid making use of
  54     these scripts today, and instead provide proper unit files with appropriate dependencies for any scripts to run
  55     during the boot or shutdown processes.</para>
  56
  57     <para><filename>elogind-rc-local-generator</filename> implements
  58     <citerefentry><refentrytitle>elogind.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
  59   </refsect1>
  60
  61   <refsect1>
  62     <title>See Also</title>
  63     <para>
  64       <citerefentry><refentrytitle>elogind</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  65       <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
  66     </para>
  67   </refsect1>
  68
  69 </refentry>