diff options
author | Yu Watanabe <watanabe.yu+github@gmail.com> | 2020-03-05 20:54:32 +0900 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-03-05 20:54:32 +0900 |
commit | c1817e2528258aa941e031fa6a075842d9694514 (patch) | |
tree | 3cd2b883a92c2a3b6df7f6af49d3a403ece894cf | |
parent | 5403e153372e4001820a0e403b6448d81e7e3c05 (diff) | |
parent | 82c8bdff122d7f5774506138c762c070a038b12b (diff) | |
download | systemd-c1817e2528258aa941e031fa6a075842d9694514.tar.gz |
Merge pull request #15023 from keszybz/network-generator-man
Man page for systemd-network-generator
-rw-r--r-- | man/rules/meson.build | 4 | ||||
-rw-r--r-- | man/systemd-network-generator.service.xml | 103 | ||||
-rw-r--r-- | man/systemd-networkd.service.xml | 8 | ||||
-rw-r--r-- | units/systemd-network-generator.service.in | 1 |
4 files changed, 115 insertions, 1 deletions
diff --git a/man/rules/meson.build b/man/rules/meson.build index 6b08add2bb..296dd7da3a 100644 --- a/man/rules/meson.build +++ b/man/rules/meson.build @@ -763,6 +763,10 @@ manpages = [ ''], ['systemd-modules-load.service', '8', ['systemd-modules-load'], 'HAVE_KMOD'], ['systemd-mount', '1', ['systemd-umount'], ''], + ['systemd-network-generator.service', + '8', + ['systemd-network-generator'], + 'ENABLE_NETWORKD'], ['systemd-networkd-wait-online.service', '8', ['systemd-networkd-wait-online'], diff --git a/man/systemd-network-generator.service.xml b/man/systemd-network-generator.service.xml new file mode 100644 index 0000000000..fcb3c69ffb --- /dev/null +++ b/man/systemd-network-generator.service.xml @@ -0,0 +1,103 @@ +<?xml version='1.0'?> <!--*-nxml-*--> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!-- SPDX-License-Identifier: LGPL-2.1+ --> + +<refentry id="systemd-network-generator.service" conditional='ENABLE_NETWORKD'> + + <refentryinfo> + <title>systemd-network-generator.service</title> + <productname>systemd</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>systemd-network-generator.service</refentrytitle> + <manvolnum>8</manvolnum> + </refmeta> + + <refnamediv> + <refname>systemd-network-generator.service</refname> + <refname>systemd-network-generator</refname> + <refpurpose>Generate network configuration from the kernel command line</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <para><filename>systemd-network-generator.service</filename></para> + <para><filename>/usr/lib/systemd/systemd-network-generator</filename></para> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para><filename>systemd-network-generator.service</filename> is a system service that translates + <varname>ip=</varname> and the related settings on the kernel command line (see below) into + <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>, and + <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry> + configuration files understood by + <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> + and + <citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>. + </para> + + <para>Files are generated in <filename>/run/systemd/network/</filename>.</para> + </refsect1> + + <refsect1><title>Kernel command line options</title> + <para>This tool understands the following options:</para> + + <variablelist class='kernel-commandline-options'> + <varlistentry> + <term><varname>ip=</varname></term> + <term><varname>rd.route=</varname></term> + <term><varname>rd.peerdns=</varname></term> + <listitem> + <para>— translated into + <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry> files.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>ifname=</varname></term> + <listitem> + <para>— translated into + <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry> files.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>vlan=</varname></term> + <term><varname>bond=</varname></term> + <term><varname>bridge=</varname></term> + <term><varname>bootdev=</varname></term> + <listitem> + <para>— translated into + <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry> files.</para> + </listitem> + </varlistentry> + + <!-- unsupported: + team=<teammaster>:<teamslaves> + bootdev= + BOOTIF= + bootdev= + bootdev= + bootdev= + --> + </variablelist> + + <para>See + <citerefentry project='man-pages'><refentrytitle>dracut.kernel</refentrytitle><manvolnum>7</manvolnum></citerefentry> + for option syntax and details.</para> + </refsect1> + + <refsect1> + <title>See Also</title> + <para> + <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry><refentrytitle>dracut</refentrytitle><manvolnum>8</manvolnum></citerefentry> + </para> + </refsect1> + +</refentry> diff --git a/man/systemd-networkd.service.xml b/man/systemd-networkd.service.xml index b3ba621ae6..94a7bfd5ef 100644 --- a/man/systemd-networkd.service.xml +++ b/man/systemd-networkd.service.xml @@ -61,6 +61,10 @@ <filename>systemd-networkd</filename> is restarted, netdev interfaces for which configuration was removed will not be dropped, and may need to be cleaned up manually.</para> + + <para><command>systemd-networkd</command> may be introspected and controlled at runtime using + <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>. + </para> </refsect1> <refsect1><title>Configuration Files</title> @@ -82,11 +86,13 @@ <refsect1> <title>See Also</title> <para> + <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-networkd-wait-online.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> + <citerefentry><refentrytitle>systemd-networkd-wait-online.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd-networkd-generator.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> </para> </refsect1> diff --git a/units/systemd-network-generator.service.in b/units/systemd-network-generator.service.in index e314aded9b..1a70ad70e9 100644 --- a/units/systemd-network-generator.service.in +++ b/units/systemd-network-generator.service.in @@ -9,6 +9,7 @@ [Unit] Description=Generate network units from Kernel command line +Documentation=man:systemd-network-generator.service(8) DefaultDependencies=no Before=network-pre.target |