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