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