man/systemd-rc-local-generator.xml

   1 <?xml version='1.0'?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
   4 <!ENTITY % entities SYSTEM "custom-entities.ent" >
   5 %entities;
   6 ]>
   7 <!-- SPDX-License-Identifier: LGPL-2.1+ -->
   8
   9 <refentry id="systemd-rc-local-generator" conditional='HAVE_SYSV_COMPAT'>
  10   <refentryinfo>
  11     <title>systemd-rc-local-generator</title>
  12     <productname>systemd</productname>
  13   </refentryinfo>
  14
  15   <refmeta>
  16     <refentrytitle>systemd-rc-local-generator</refentrytitle>
  17     <manvolnum>8</manvolnum>
  18   </refmeta>
  19
  20   <refnamediv>
  21     <refname>systemd-rc-local-generator</refname>
  22     <refpurpose>Compatibility generator for starting <filename>&RC_LOCAL_PATH;</filename> during boot</refpurpose>
  23   </refnamediv>
  24
  25   <refsynopsisdiv>
  26     <para><filename>/usr/lib/systemd/system-generators/systemd-rc-local-generator</filename></para>
  27   </refsynopsisdiv>
  28
  29   <refsect1>
  30     <title>Description</title>
  31
  32     <para><filename>systemd-rc-local-generator</filename> is a generator that checks whether
  33     <filename>&RC_LOCAL_PATH;</filename> exists and is executable, and if it is pulls the
  34     <filename>rc-local.service</filename> unit into the boot process. This unit is responsible for running
  35     this script during late boot. Note that the script will be run with slightly different semantics than the
  36     original System V version, which was run "last" in the boot process, which is a concept that does not
  37     translate to systemd. The script is run after <filename>network.target</filename>, but in parallel with
  38     most other regular system services.</para>
  39
  40     <para>Support for <filename>&RC_LOCAL_PATH;</filename> is provided for compatibility with specific System
  41     V systems only. However, it is strongly recommended to avoid making use of this script today, and instead
  42     provide proper unit files with appropriate dependencies for any scripts to run during the boot process.
  43     Note that the path to the script is set a compile time and varies between distributions.</para>
  44
  45     <para><filename>systemd-rc-local-generator</filename> implements
  46     <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
  47   </refsect1>
  48
  49   <refsect1>
  50     <title>See Also</title>
  51     <para>
  52       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
  53       <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
  54     </para>
  55   </refsect1>
  56 </refentry>