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-or-later -->
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    <refname>rc-local.service</refname>
23    <refpurpose>Compatibility generator and service to start <filename>&RC_LOCAL_PATH;</filename> during boot</refpurpose>
24  </refnamediv>
25
26  <refsynopsisdiv>
27    <para><filename>/usr/lib/systemd/system-generators/systemd-rc-local-generator</filename></para>
28    <para><filename>rc-local.service</filename></para>
29  </refsynopsisdiv>
30
31  <refsect1>
32    <title>Description</title>
33
34    <para><command>systemd-rc-local-generator</command> is a generator that checks whether
35    <filename>&RC_LOCAL_PATH;</filename> exists and is executable, and if it is, pulls the
36    <filename>rc-local.service</filename> unit into the boot process. This unit is responsible for running
37    this script during late boot. The script is run after <filename>network.target</filename>, but in
38    parallel with most other regular system services.</para>
39
40    <para>Note that <filename>rc-local.service</filename> runs with slightly different semantics than the
41    original System V version, which was executed "last" in the boot process, which is a concept that does
42    not translate to systemd.</para>
43
44    <para>Also note that <filename>rc-local.service</filename> is ordered after
45    <filename>network.target</filename>, which does not mean that the network is functional, see
46    <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>.
47    If the script requires a configured network connection, it may be desirable to pull in and order it after
48    <filename>network-online.target</filename> with a drop-in:</para>
49
50    <programlisting># /etc/systemd/system/rc-local.service.d/network.conf
51[Unit]
52Wants=network-online.target
53After=network-online.target
54</programlisting>
55
56    <para>Support for <filename>&RC_LOCAL_PATH;</filename> is provided for compatibility with specific System
57    V systems only. However, it is strongly recommended to avoid making use of this script today, and instead
58    provide proper unit files with appropriate dependencies for any scripts to run during the boot process.
59    Note that the path to the script is set at compile time and varies between distributions.</para>
60
61    <para><filename>systemd-rc-local-generator</filename> implements
62    <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
63  </refsect1>
64
65  <refsect1>
66    <title>See Also</title>
67    <para>
68      <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
69      <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
70    </para>
71  </refsect1>
72</refentry>
73