summaryrefslogtreecommitdiffstats
path: root/man/networkctl.xml
diff options
context:
space:
mode:
Diffstat (limited to 'man/networkctl.xml')
-rw-r--r--man/networkctl.xml101
1 files changed, 83 insertions, 18 deletions
diff --git a/man/networkctl.xml b/man/networkctl.xml
index 68b1d97..5e2126f 100644
--- a/man/networkctl.xml
+++ b/man/networkctl.xml
@@ -1,6 +1,6 @@
<?xml version='1.0'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
- "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+ "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
<refentry id="networkctl" conditional='ENABLE_NETWORKD'
@@ -302,15 +302,15 @@
details.</para>
<para>Produces output similar to:
- <programlisting>LINK CHASSIS ID SYSTEM NAME CAPS PORT ID PORT DESCRIPTION
-enp0s25 00:e0:4c:00:00:00 GS1900 ..b........ 2 Port #2
+ <programlisting>LINK SYSTEM-NAME SYSTEM-DESCRIPTION CHASSIS-ID PORT-ID PORT-DESCRIPTION CAPS
+enp0s25 GS1900 - 00:e0:4c:00:00:00 2 Port #2 ..b........
Capability Flags:
o - Other; p - Repeater; b - Bridge; w - WLAN Access Point; r - Router;
t - Telephone; d - DOCSIS cable device; a - Station; c - Customer VLAN;
s - Service VLAN, m - Two-port MAC Relay (TPMR)
-1 neighbors listed.</programlisting></para>
+1 neighbor(s) listed.</programlisting></para>
<xi:include href="version-info.xml" xpointer="v219"/>
</listitem>
@@ -430,7 +430,8 @@ s - Service VLAN, m - Two-port MAC Relay (TPMR)
</term>
<listitem><para>Edit network configuration files, which include <filename>.network</filename>,
<filename>.netdev</filename>, and <filename>.link</filename> files. If no network config file
- matching the given name is found, a new one will be created under <filename>/etc/</filename>.
+ matching the given name is found, a new one will be created under <filename>/etc/</filename> or
+ <filename>/run/</filename>, depending on whether <option>--runtime</option> is specified.
Specially, if the name is prefixed by <literal>@</literal>, it will be treated as
a network interface, and editing will be performed on the network config files associated
with it. Additionally, the interface name can be suffixed with <literal>:network</literal> (default)
@@ -453,12 +454,65 @@ s - Service VLAN, m - Two-port MAC Relay (TPMR)
<varlistentry>
<term>
<command>cat</command>
- <replaceable>FILE</replaceable>|<replaceable>@DEVICE</replaceable>…
+ <optional><replaceable>FILE</replaceable>|<replaceable>@DEVICE</replaceable>…</optional>
</term>
- <listitem><para>Show network configuration files. This command honors
- the <literal>@</literal> prefix in the same way as <command>edit</command>.</para>
+ <listitem>
+ <para>Show network configuration files. This command honors the <literal>@</literal> prefix in the
+ same way as <command>edit</command>. When no argument is specified,
+ <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+ and its drop-in files will be shown.</para>
- <xi:include href="version-info.xml" xpointer="v254"/></listitem>
+ <xi:include href="version-info.xml" xpointer="v254"/>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <command>mask</command>
+ <replaceable>FILE</replaceable>…
+ </term>
+ <listitem><para>Mask network configuration files, which include <filename>.network</filename>,
+ <filename>.netdev</filename>, and <filename>.link</filename> files. A symlink of the given name will
+ be created under <filename>/etc/</filename> or <filename>/run/</filename>, depending on
+ whether <option>--runtime</option> is specified, that points to <filename>/dev/null</filename>.
+ If a non-empty config file with the specified name exists under the target directory or a directory
+ with higher priority (e.g. <option>--runtime</option> is used while an existing config resides
+ in <filename>/etc/</filename>), the operation is aborted.</para>
+
+ <para>This command honors <option>--no-reload</option> in the same way as <command>edit</command>.
+ </para>
+
+ <xi:include href="version-info.xml" xpointer="v256"/></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <command>unmask</command>
+ <replaceable>FILE</replaceable>…
+ </term>
+ <listitem><para>Unmask network configuration files, i.e. reverting the effect of <command>mask</command>.
+ Note that this command operates regardless of the scope of the directory, i.e. <option>--runtime</option>
+ is of no effect.</para>
+
+ <para>This command honors <option>--no-reload</option> in the same way as <command>edit</command>
+ and <command>mask</command>.</para>
+
+ <xi:include href="version-info.xml" xpointer="v256"/></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>
+ <command>persistent-storage</command>
+ <replaceable>BOOL</replaceable>
+ </term>
+ <listitem>
+ <para>Notify <filename>systemd-networkd.service</filename> that the persistent storage for the
+ service is ready. This is called by
+ <filename>systemd-networkd-persistent-storage.service</filename>. Usually, this command should not
+ be called manually by users or administrators.</para>
+
+ <xi:include href="version-info.xml" xpointer="v256"/>
+ </listitem>
</varlistentry>
</variablelist>
</refsect1>
@@ -519,7 +573,7 @@ s - Service VLAN, m - Two-port MAC Relay (TPMR)
</varlistentry>
<varlistentry>
- <term><option>--drop-in=</option><replaceable>NAME</replaceable></term>
+ <term><option>--drop-in=<replaceable>NAME</replaceable></option></term>
<listitem>
<para>When used with <command>edit</command>, edit the drop-in file <replaceable>NAME</replaceable>
@@ -533,16 +587,27 @@ s - Service VLAN, m - Two-port MAC Relay (TPMR)
<term><option>--no-reload</option></term>
<listitem>
- <para>When used with <command>edit</command>,
+ <para>When used with <command>edit</command>, <command>mask</command>, or <command>unmask</command>,
<citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
or
<citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
- will not be reloaded after the editing finishes.</para>
+ will not be reloaded after the operation finishes.</para>
<xi:include href="version-info.xml" xpointer="v254"/>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><option>--runtime</option></term>
+
+ <listitem>
+ <para>When used with <command>edit</command> or <command>mask</command>,
+ operate on the file under <filename>/run/</filename> instead of <filename>/etc/</filename>.</para>
+
+ <xi:include href="version-info.xml" xpointer="v256"/>
+ </listitem>
+ </varlistentry>
+
<xi:include href="standard-options.xml" xpointer="json" />
<xi:include href="standard-options.xml" xpointer="help" />
<xi:include href="standard-options.xml" xpointer="version" />
@@ -560,11 +625,11 @@ s - Service VLAN, m - Two-port MAC Relay (TPMR)
<refsect1>
<title>See Also</title>
- <para>
- <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
- <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
- <citerefentry project='die-net'><refentrytitle>ip</refentrytitle><manvolnum>8</manvolnum></citerefentry>
- </para>
+ <para><simplelist type="inline">
+ <member><citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
+ <member><citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
+ <member><citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
+ <member><citerefentry project='die-net'><refentrytitle>ip</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
+ </simplelist></para>
</refsect1>
</refentry>
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-15 16:58:09 +0000