shaba/systemd
1
0
Fork 0
mirror of https://github.com/systemd/systemd.git synced 2024-12-23 21:35:11 +03:00
Code
c18c7e2322
systemd/man/networkctl.xml

617 lines
24 KiB
XML
Raw Normal View History

man: drop mode line in file headers This is already included in .dir-locals, so we don't need it in the files themselves.
2018-07-03 00:15:39 +03:00
<?xml version='1.0'?>
man: use same header for all files The "include" files had type "book" for some raeason. I don't think this is meaningful. Let's just use the same everywhere. $ perl -i -0pe 's^..DOCTYPE (book|refentry) PUBLIC "-//OASIS//DTD DocBook XML V4.[25]//EN"\s+"http^<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"\n "http^gms' man/*.xml
2019-03-14 16:40:58 +03:00
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
man: use same version in public and system ident.
2023-12-25 17:48:33 +03:00
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
license: LGPL-2.1+ -> LGPL-2.1-or-later
2020-11-09 07:23:58 +03:00
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
man: add networkctl(1)
2015-01-20 05:44:16 +03:00
man: install networkctl and sysusers.d man page conditionally
2015-06-23 11:37:34 +03:00
<refentry id="networkctl" conditional='ENABLE_NETWORKD'
man: add networkctl(1)
2015-01-20 05:44:16 +03:00
xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>networkctl</title>
<productname>systemd</productname>
</refentryinfo>
<refmeta>
<refentrytitle>networkctl</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>networkctl</refname>
Synposis and description of networkctl man page reflecting only part of its functionality (#27264) * Fix inaccurate synposis, and description Before the fix, they reflected only part of networkctl functionality.
2023-04-13 23:30:42 +03:00
<refpurpose>Query or modify the status of network links</refpurpose>
man: add networkctl(1)
2015-01-20 05:44:16 +03:00
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>networkctl</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">COMMAND</arg>
<arg choice="opt" rep="repeat">LINK</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
Synposis and description of networkctl man page reflecting only part of its functionality (#27264) * Fix inaccurate synposis, and description Before the fix, they reflected only part of networkctl functionality.
2023-04-13 23:30:42 +03:00
<para><command>networkctl</command> may be used to query or modify the
man: add networkctl(1)
2015-01-20 05:44:16 +03:00
state of the network links as seen by
<command>systemd-networkd</command>. Please refer to
<citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
man: remove repeated word "the" and polish
2015-06-29 22:20:02 +03:00
for an introduction to the basic concepts, functionality, and
man: add networkctl(1)
2015-01-20 05:44:16 +03:00
configuration syntax.</para>
</refsect1>
<refsect1>
<title>Commands</title>
<para>The following commands are understood:</para>
<variablelist>
<varlistentry>
<term>
<command>list</command>
man: network: replace LINK -> PATTERN
2019-02-15 07:46:34 +03:00
<optional><replaceable>PATTERN…</replaceable></optional>
man: add networkctl(1)
2015-01-20 05:44:16 +03:00
</term>
<listitem>
Typos found by codespell
2021-10-20 10:38:57 +03:00
<para>Show a list of existing links and their status. If one or more
man: network: replace LINK -> PATTERN
2019-02-15 07:46:34 +03:00
<replaceable>PATTERN</replaceable>s are specified, only links matching one of them are shown.
If no further arguments are specified shows all links,
networkctl: extend "networkctl list" and "networctl lldp" to optionally take interface names This way, the output may be reduced to only show data about the specified interfaces.
2016-02-19 20:57:11 +03:00
otherwise just the specified links. Produces output similar to:
<programlisting>IDX LINK TYPE OPERATIONAL SETUP
man: add networkctl(1)
2015-01-20 05:44:16 +03:00
1 lo loopback carrier unmanaged
2 eth0 ether routable configured
3 virbr0 ether no-carrier unmanaged
4 virbr0-nic ether off unmanaged
4 links listed.</programlisting></para>
man: Document networkd states in networkctl(1) (#10033) The manpage gives example outputs with the states, but it never explains what the states are. Fixes #575
2018-09-07 17:39:44 +03:00
<para>The operational status is one of the following:
<variablelist>
wait-online: Support waiting for interfaces to disappear
2020-01-14 16:08:03 +03:00
<varlistentry>
<term>missing</term>
<listitem>
man/networkctl,systemd-soft-reboot: capitalize and add periods We added version information, so now each bullet point contains multiple paragraphs, so we need proper sentences.
2023-11-06 17:02:20 +03:00
<para>The device is missing.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v245"/>
wait-online: Support waiting for interfaces to disappear
2020-01-14 16:08:03 +03:00
</listitem>
</varlistentry>
man: Document networkd states in networkctl(1) (#10033) The manpage gives example outputs with the states, but it never explains what the states are. Fixes #575
2018-09-07 17:39:44 +03:00
<varlistentry>
<term>off</term>
<listitem>
man/networkctl,systemd-soft-reboot: capitalize and add periods We added version information, so now each bullet point contains multiple paragraphs, so we need proper sentences.
2023-11-06 17:02:20 +03:00
<para>The device is powered down.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v240"/>
man: Document networkd states in networkctl(1) (#10033) The manpage gives example outputs with the states, but it never explains what the states are. Fixes #575
2018-09-07 17:39:44 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term>no-carrier</term>
<listitem>
man/networkctl,systemd-soft-reboot: capitalize and add periods We added version information, so now each bullet point contains multiple paragraphs, so we need proper sentences.
2023-11-06 17:02:20 +03:00
<para>The device is powered up, but does not yet have a carrier.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v240"/>
man: Document networkd states in networkctl(1) (#10033) The manpage gives example outputs with the states, but it never explains what the states are. Fixes #575
2018-09-07 17:39:44 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term>dormant</term>
<listitem>
man/networkctl,systemd-soft-reboot: capitalize and add periods We added version information, so now each bullet point contains multiple paragraphs, so we need proper sentences.
2023-11-06 17:02:20 +03:00
<para>The device has a carrier, but is not yet ready for normal traffic.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v240"/>
man: Document networkd states in networkctl(1) (#10033) The manpage gives example outputs with the states, but it never explains what the states are. Fixes #575
2018-09-07 17:39:44 +03:00
</listitem>
</varlistentry>
network: introduce 'degraded-carrier' operstate to order all states Previously, 'degraded' state is ambiguous for bonding or bridge master: 1. one or more slave interfaces does not have carrier, 2. no link local address is assigned to the master, 3. combination of the above two. This makes the above case 1 and 3 are in the new 'degraded-carrier' state, and makes 'degraded' state as all slaves are active but no link local address on master.
2019-03-05 08:41:56 +03:00
<varlistentry>
<term>degraded-carrier</term>
<listitem>
man/networkctl,systemd-soft-reboot: capitalize and add periods We added version information, so now each bullet point contains multiple paragraphs, so we need proper sentences.
2023-11-06 17:02:20 +03:00
<para>One of the bonding or bridge slave network interfaces is in off, no-carrier, or
dormant state, and the master interface has no address.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v242"/>
network: introduce 'degraded-carrier' operstate to order all states Previously, 'degraded' state is ambiguous for bonding or bridge master: 1. one or more slave interfaces does not have carrier, 2. no link local address is assigned to the master, 3. combination of the above two. This makes the above case 1 and 3 are in the new 'degraded-carrier' state, and makes 'degraded' state as all slaves are active but no link local address on master.
2019-03-05 08:41:56 +03:00
</listitem>
</varlistentry>
man: Document networkd states in networkctl(1) (#10033) The manpage gives example outputs with the states, but it never explains what the states are. Fixes #575
2018-09-07 17:39:44 +03:00
<varlistentry>
<term>carrier</term>
<listitem>
man/networkctl,systemd-soft-reboot: capitalize and add periods We added version information, so now each bullet point contains multiple paragraphs, so we need proper sentences.
2023-11-06 17:02:20 +03:00
<para>The link has carrier, or for bond or bridge master, all bonding or bridge slave
network interfaces are enslaved to the master.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v240"/>
man: Document networkd states in networkctl(1) (#10033) The manpage gives example outputs with the states, but it never explains what the states are. Fixes #575
2018-09-07 17:39:44 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term>degraded</term>
<listitem>
man/networkctl,systemd-soft-reboot: capitalize and add periods We added version information, so now each bullet point contains multiple paragraphs, so we need proper sentences.
2023-11-06 17:02:20 +03:00
<para>The link has carrier and addresses valid on the local link configured. For bond or
network: make degraded-carrier bond/bridge as routable (#27776) This makes a bond or bridge interface in the degraded-carrier state but has a routable address handled as routable operational state. If the carrier is degraded but the address state is routable then the operational state should be seen as routable and not degraded because that may be the case for bonds if some of the links are down, but when that happens the bond as whole is still routable. This also makes operational state to degraded if address state is degraded even if the link state is degraded-carrier. Fixes #22713.
2023-06-15 07:32:10 +03:00
bridge master this means that not all slave network interfaces have carrier but at least
one does.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v240"/>
man: Document networkd states in networkctl(1) (#10033) The manpage gives example outputs with the states, but it never explains what the states are. Fixes #575
2018-09-07 17:39:44 +03:00
</listitem>
</varlistentry>
man: mention new enslaved operational state
2019-02-09 21:50:48 +03:00
<varlistentry>
<term>enslaved</term>
<listitem>
man/networkctl,systemd-soft-reboot: capitalize and add periods We added version information, so now each bullet point contains multiple paragraphs, so we need proper sentences.
2023-11-06 17:02:20 +03:00
<para>The link has carrier and is enslaved to bond or bridge master network interface.
</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v242"/>
man: mention new enslaved operational state
2019-02-09 21:50:48 +03:00
</listitem>
</varlistentry>
man: Document networkd states in networkctl(1) (#10033) The manpage gives example outputs with the states, but it never explains what the states are. Fixes #575
2018-09-07 17:39:44 +03:00
<varlistentry>
<term>routable</term>
<listitem>
man/networkctl,systemd-soft-reboot: capitalize and add periods We added version information, so now each bullet point contains multiple paragraphs, so we need proper sentences.
2023-11-06 17:02:20 +03:00
<para>The link has carrier and routable address configured. For bond or bridge master it is
network: make degraded-carrier bond/bridge as routable (#27776) This makes a bond or bridge interface in the degraded-carrier state but has a routable address handled as routable operational state. If the carrier is degraded but the address state is routable then the operational state should be seen as routable and not degraded because that may be the case for bonds if some of the links are down, but when that happens the bond as whole is still routable. This also makes operational state to degraded if address state is degraded even if the link state is degraded-carrier. Fixes #22713.
2023-06-15 07:32:10 +03:00
not necessary for all slave network interfaces to have carrier, but at least one must.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v240"/>
man: Document networkd states in networkctl(1) (#10033) The manpage gives example outputs with the states, but it never explains what the states are. Fixes #575
2018-09-07 17:39:44 +03:00
</listitem>
</varlistentry>
</variablelist>
</para>
<para>The setup status is one of the following:
<variablelist>
<varlistentry>
<term>pending</term>
<listitem>
man/networkctl,systemd-soft-reboot: capitalize and add periods We added version information, so now each bullet point contains multiple paragraphs, so we need proper sentences.
2023-11-06 17:02:20 +03:00
<para><citerefentry><refentrytitle>systemd-udevd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
is still processing the link, we don't yet know if we will manage it.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v240"/>
man: Document networkd states in networkctl(1) (#10033) The manpage gives example outputs with the states, but it never explains what the states are. Fixes #575
2018-09-07 17:39:44 +03:00
</listitem>
</varlistentry>
<varlistentry>
man/networkctl: mention initialized state Closes #23262.
2022-05-04 15:22:56 +03:00
<term>initialized</term>
man: Document networkd states in networkctl(1) (#10033) The manpage gives example outputs with the states, but it never explains what the states are. Fixes #575
2018-09-07 17:39:44 +03:00
<listitem>
man/networkctl,systemd-soft-reboot: capitalize and add periods We added version information, so now each bullet point contains multiple paragraphs, so we need proper sentences.
2023-11-06 17:02:20 +03:00
<para><citerefentry><refentrytitle>systemd-udevd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
has processed the link, but we don't yet know if we will manage it.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v251"/>
man: Document networkd states in networkctl(1) (#10033) The manpage gives example outputs with the states, but it never explains what the states are. Fixes #575
2018-09-07 17:39:44 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term>configuring</term>
<listitem>
man/networkctl,systemd-soft-reboot: capitalize and add periods We added version information, so now each bullet point contains multiple paragraphs, so we need proper sentences.
2023-11-06 17:02:20 +03:00
<para>Configuration for the link is being retrieved or the link is being configured.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v240"/>
man: Document networkd states in networkctl(1) (#10033) The manpage gives example outputs with the states, but it never explains what the states are. Fixes #575
2018-09-07 17:39:44 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term>configured</term>
<listitem>
man/networkctl,systemd-soft-reboot: capitalize and add periods We added version information, so now each bullet point contains multiple paragraphs, so we need proper sentences.
2023-11-06 17:02:20 +03:00
<para>Link has been configured successfully.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v240"/>
man: Document networkd states in networkctl(1) (#10033) The manpage gives example outputs with the states, but it never explains what the states are. Fixes #575
2018-09-07 17:39:44 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term>unmanaged</term>
<listitem>
man/networkctl,systemd-soft-reboot: capitalize and add periods We added version information, so now each bullet point contains multiple paragraphs, so we need proper sentences.
2023-11-06 17:02:20 +03:00
<para><command>systemd-networkd</command> is not handling the link.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v240"/>
man: Document networkd states in networkctl(1) (#10033) The manpage gives example outputs with the states, but it never explains what the states are. Fixes #575
2018-09-07 17:39:44 +03:00
</listitem>
</varlistentry>
man/networkctl: mention initialized state Closes #23262.
2022-05-04 15:22:56 +03:00
<varlistentry>
<term>failed</term>
<listitem>
man/networkctl,systemd-soft-reboot: capitalize and add periods We added version information, so now each bullet point contains multiple paragraphs, so we need proper sentences.
2023-11-06 17:02:20 +03:00
<para><command>systemd-networkd</command> failed to configure the link.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v240"/>
man/networkctl: mention initialized state Closes #23262.
2022-05-04 15:22:56 +03:00
</listitem>
</varlistentry>
man: Document networkd states in networkctl(1) (#10033) The manpage gives example outputs with the states, but it never explains what the states are. Fixes #575
2018-09-07 17:39:44 +03:00
<varlistentry>
<term>linger</term>
<listitem>
man/networkctl,systemd-soft-reboot: capitalize and add periods We added version information, so now each bullet point contains multiple paragraphs, so we need proper sentences.
2023-11-06 17:02:20 +03:00
<para>The link is gone, but has not yet been dropped by <command>systemd-networkd</command>.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v240"/>
man: Document networkd states in networkctl(1) (#10033) The manpage gives example outputs with the states, but it never explains what the states are. Fixes #575
2018-09-07 17:39:44 +03:00
</listitem>
</varlistentry>
</variablelist>
</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 18:03:38 +03:00
<xi:include href="version-info.xml" xpointer="v219"/>
man: add networkctl(1)
2015-01-20 05:44:16 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>status</command>
man: network: replace LINK -> PATTERN
2019-02-15 07:46:34 +03:00
<optional><replaceable>PATTERN…</replaceable></optional>
man: add networkctl(1)
2015-01-20 05:44:16 +03:00
</term>
<listitem>
man: network: replace LINK -> PATTERN
2019-02-15 07:46:34 +03:00
<para>Show information about the specified links: type, state, kernel module driver, hardware and
Typos found by codespell
2021-10-20 10:38:57 +03:00
IP address, configured DNS servers, etc. If one or more <replaceable>PATTERN</replaceable>s are
man: network: replace LINK -> PATTERN
2019-02-15 07:46:34 +03:00
specified, only links matching one of them are shown.</para>
man: add networkctl(1)
2015-01-20 05:44:16 +03:00
networkctl: extend "networkctl list" and "networctl lldp" to optionally take interface names This way, the output may be reduced to only show data about the specified interfaces.
2016-02-19 20:57:11 +03:00
<para>When no links are specified, an overall network status is shown. Also see the option
<option>--all</option>.</para>
man: add networkctl(1)
2015-01-20 05:44:16 +03:00
networkctl: extend "networkctl list" and "networctl lldp" to optionally take interface names This way, the output may be reduced to only show data about the specified interfaces.
2016-02-19 20:57:11 +03:00
<para>Produces output similar to:
man: add networkctl(1)
2015-01-20 05:44:16 +03:00
<programlisting>
man: describe overall online status in networkctl(1)
2021-04-27 11:58:18 +03:00
● State: routable
Online state: online
Address: 10.193.76.5 on eth0
192.168.122.1 on virbr0
169.254.190.105 on eth0
fe80::5054:aa:bbbb:cccc on eth0
Gateway: 10.193.11.1 (CISCO SYSTEMS, INC.) on eth0
DNS: 8.8.8.8
8.8.4.4</programlisting></para>
<para>In the overall network status, the online state depends on the individual online state of all
required links. Managed links are required for online by default. In this case, the online state is
one of the following:
<variablelist>
<varlistentry>
<term>unknown</term>
<listitem>
man/networkctl,systemd-soft-reboot: capitalize and add periods We added version information, so now each bullet point contains multiple paragraphs, so we need proper sentences.
2023-11-06 17:02:20 +03:00
<para>All links have unknown online status (i.e. there are no required links).</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v249"/>
man: describe overall online status in networkctl(1)
2021-04-27 11:58:18 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term>offline</term>
<listitem>
man/networkctl,systemd-soft-reboot: capitalize and add periods We added version information, so now each bullet point contains multiple paragraphs, so we need proper sentences.
2023-11-06 17:02:20 +03:00
<para>All required links are offline.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v249"/>
man: describe overall online status in networkctl(1)
2021-04-27 11:58:18 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term>partial</term>
<listitem>
man/networkctl,systemd-soft-reboot: capitalize and add periods We added version information, so now each bullet point contains multiple paragraphs, so we need proper sentences.
2023-11-06 17:02:20 +03:00
<para>Some, but not all, required links are online.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v249"/>
man: describe overall online status in networkctl(1)
2021-04-27 11:58:18 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term>online</term>
<listitem>
man/networkctl,systemd-soft-reboot: capitalize and add periods We added version information, so now each bullet point contains multiple paragraphs, so we need proper sentences.
2023-11-06 17:02:20 +03:00
<para>All required links are online.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v249"/>
man: describe overall online status in networkctl(1)
2021-04-27 11:58:18 +03:00
</listitem>
</varlistentry>
</variablelist>
</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 18:03:38 +03:00
<xi:include href="version-info.xml" xpointer="v219"/>
man: add networkctl(1)
2015-01-20 05:44:16 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term>
<command>lldp</command>
man: network: replace LINK -> PATTERN
2019-02-15 07:46:34 +03:00
<optional><replaceable>PATTERN…</replaceable></optional>
man: add networkctl(1)
2015-01-20 05:44:16 +03:00
</term>
<listitem>
man: network: replace LINK -> PATTERN
2019-02-15 07:46:34 +03:00
<para>Show discovered LLDP (Link Layer Discovery Protocol) neighbors. If one or more
<replaceable>PATTERN</replaceable>s are specified only neighbors on those interfaces are shown.
Otherwise shows discovered neighbors on all interfaces. Note that for this feature to work,
<varname>LLDP=</varname> must be turned on for the specific interface, see
networkctl: extend "networkctl list" and "networctl lldp" to optionally take interface names This way, the output may be reduced to only show data about the specified interfaces.
2016-02-19 20:57:11 +03:00
<citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
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
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>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 18:03:38 +03:00
<xi:include href="version-info.xml" xpointer="v219"/>
man: add networkctl(1)
2015-01-20 05:44:16 +03:00
</listitem>
</varlistentry>
Add networkctl label to man and shell completion
2017-06-27 17:30:41 +03:00
<varlistentry>
<term>
<command>label</command>
</term>
<listitem><para>Show numerical address labels that can be used for address selection.
This is the same information that
man: fix links to various external man pages In cases where we used both die-net and man-pages for the same reference, I switched to use man-pages everywhere.
2020-06-25 15:37:24 +03:00
<citerefentry project='die-net'><refentrytitle>ip-addrlabel</refentrytitle><manvolnum>8</manvolnum></citerefentry>
Add networkctl label to man and shell completion
2017-06-27 17:30:41 +03:00
shows. See <ulink url="https://tools.ietf.org/html/rfc3484">RFC 3484</ulink>
for a discussion of address labels.</para>
<para>Produces output similar to:
<programlisting>Prefix/Prefixlen Label
::/0 1
fc00::/7 5
fec0::/10 11
2002::/16 2
3ffe::/16 12
2001:10::/28 7
2001::/32 6
::ffff:0.0.0.0/96 4
::/96 3
::1/128 0</programlisting></para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v234"/>
Add networkctl label to man and shell completion
2017-06-27 17:30:41 +03:00
</listitem>
</varlistentry>
networkctl: add support to delete virtual netdevs We now don't have the support to delete netdevs and dependent upon iproute to delete. With this we can delete via networkctl and use in our test cases too. Note that it supports deleting multiple links at once. ``` sudo ./networkctl delete test1 test2 test3 test4 ```
2019-05-22 12:46:41 +03:00
<varlistentry>
<term>
<command>delete</command>
man: clarify that several networkctl commands takes device names
2020-08-27 10:35:25 +03:00
<replaceable>DEVICE…</replaceable>
networkctl: add support to delete virtual netdevs We now don't have the support to delete netdevs and dependent upon iproute to delete. With this we can delete via networkctl and use in our test cases too. Note that it supports deleting multiple links at once. ``` sudo ./networkctl delete test1 test2 test3 test4 ```
2019-05-22 12:46:41 +03:00
</term>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<listitem><para>Deletes virtual netdevs. Takes interface name or index number.</para>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 18:03:38 +03:00
<xi:include href="version-info.xml" xpointer="v243"/></listitem>
networkctl: add support to delete virtual netdevs We now don't have the support to delete netdevs and dependent upon iproute to delete. With this we can delete via networkctl and use in our test cases too. Note that it supports deleting multiple links at once. ``` sudo ./networkctl delete test1 test2 test3 test4 ```
2019-05-22 12:46:41 +03:00
</varlistentry>
networkctl: Add support to set link up and down
2020-03-24 09:10:53 +03:00
<varlistentry>
<term>
<command>up</command>
man: clarify that several networkctl commands takes device names
2020-08-27 10:35:25 +03:00
<replaceable>DEVICE…</replaceable>
networkctl: Add support to set link up and down
2020-03-24 09:10:53 +03:00
</term>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<listitem><para>Bring devices up. Takes interface name or index number.</para>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 18:03:38 +03:00
<xi:include href="version-info.xml" xpointer="v246"/></listitem>
networkctl: Add support to set link up and down
2020-03-24 09:10:53 +03:00
</varlistentry>
<varlistentry>
<term>
<command>down</command>
man: clarify that several networkctl commands takes device names
2020-08-27 10:35:25 +03:00
<replaceable>DEVICE…</replaceable>
networkctl: Add support to set link up and down
2020-03-24 09:10:53 +03:00
</term>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<listitem><para>Bring devices down. Takes interface name or index number.</para>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 18:03:38 +03:00
<xi:include href="version-info.xml" xpointer="v246"/></listitem>
networkctl: Add support to set link up and down
2020-03-24 09:10:53 +03:00
</varlistentry>
networkctl: add renew command
2019-07-18 16:26:49 +03:00
<varlistentry>
<term>
<command>renew</command>
man: clarify that several networkctl commands takes device names
2020-08-27 10:35:25 +03:00
<replaceable>DEVICE…</replaceable>
networkctl: add renew command
2019-07-18 16:26:49 +03:00
</term>
<listitem><para>Renew dynamic configurations e.g. addresses received from DHCP server.
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
Takes interface name or index number.</para>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 18:03:38 +03:00
<xi:include href="version-info.xml" xpointer="v244"/></listitem>
networkctl: add renew command
2019-07-18 16:26:49 +03:00
</varlistentry>
network: Add support in networkctl for DHCP server forcerenew
2020-02-19 09:42:26 +03:00
<varlistentry>
<term>
<command>forcerenew</command>
man: clarify that several networkctl commands takes device names
2020-08-27 10:35:25 +03:00
<replaceable>DEVICE…</replaceable>
network: Add support in networkctl for DHCP server forcerenew
2020-02-19 09:42:26 +03:00
</term>
<listitem><para>Send a FORCERENEW message to all connected clients, triggering DHCP reconfiguration.
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
Takes interface name or index number.</para>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 18:03:38 +03:00
<xi:include href="version-info.xml" xpointer="v246"/></listitem>
network: Add support in networkctl for DHCP server forcerenew
2020-02-19 09:42:26 +03:00
</varlistentry>
networkctl: introduce reconfigure method
2019-10-23 16:36:04 +03:00
<varlistentry>
<term>
<command>reconfigure</command>
man: clarify that several networkctl commands takes device names
2020-08-27 10:35:25 +03:00
<replaceable>DEVICE…</replaceable>
networkctl: introduce reconfigure method
2019-10-23 16:36:04 +03:00
</term>
man: mention that 'networkctl reconfigure' does not reload configs
2020-08-28 07:58:00 +03:00
<listitem><para>Reconfigure network interfaces. Takes interface name or index number. Note that
this does not reload <filename>.netdev</filename> or <filename>.network</filename>
man,NEWS: fix "the the"
2020-11-18 10:27:14 +03:00
corresponding to the specified interface. So, if you edit config files, it is necessary to call
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<command>networkctl reload</command> first to apply new settings.</para>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 18:03:38 +03:00
<xi:include href="version-info.xml" xpointer="v244"/></listitem>
networkctl: introduce reconfigure method
2019-10-23 16:36:04 +03:00
</varlistentry>
networkctl: add reload command
2019-10-23 16:24:42 +03:00
<varlistentry>
<term>
<command>reload</command>
</term>
<listitem><para>Reload <filename>.netdev</filename> and <filename>.network</filename> files.
If a new <filename>.netdev</filename> file is found, then the corresponding netdev is created.
Note that even if an existing <filename>.netdev</filename> is modified or removed,
<command>systemd-networkd</command> does not update or remove the netdev.
If a new, modified or removed <filename>.network</filename> file is found, then all interfaces
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
which match the file are reconfigured.</para>
<xi:include href="version-info.xml" xpointer="v244"/></listitem>
networkctl: add reload command
2019-10-23 16:24:42 +03:00
</varlistentry>
networkctl: add verb edit and cat to operate on network configs This adds two verbs, edit and cat, to networkctl for operating on network configs (namely .network, .netdev and .link files). Specially, if the config name is prefixed by @, it will be treated as network interface name, and operations will be performed on config files associated with the link. Closes #26906
2023-04-01 14:44:29 +03:00
<varlistentry>
<term>
<command>edit</command>
<replaceable>FILE</replaceable>|<replaceable>@DEVICE</replaceable>…
</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
networkctl: introduce --runtime for editing network config under /run/
2023-11-17 17:08:28 +03:00
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.
networkctl: add verb edit and cat to operate on network configs This adds two verbs, edit and cat, to networkctl for operating on network configs (namely .network, .netdev and .link files). Specially, if the config name is prefixed by @, it will be treated as network interface name, and operations will be performed on config files associated with the link. Closes #26906
2023-04-01 14:44:29 +03:00
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)
or <literal>:link</literal>, in order to choose the type of network config to operate on.</para>
<para>If <option>--drop-in=</option> is specified, edit the drop-in file instead of
the main configuration file. Unless <option>--no-reload</option> is specified,
<command>systemd-networkd</command> will be reloaded after the edit of the
<filename>.network</filename> or <filename>.netdev</filename> files finishes.
man: more hyperlinks and other fixes Closes https://github.com/systemd/systemd/issues/29814.
2023-11-06 16:59:00 +03:00
The same applies for <filename>.link</filename> files and
<citerefentry><refentrytitle>systemd-udevd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
networkctl: add verb edit and cat to operate on network configs This adds two verbs, edit and cat, to networkctl for operating on network configs (namely .network, .netdev and .link files). Specially, if the config name is prefixed by @, it will be treated as network interface name, and operations will be performed on config files associated with the link. Closes #26906
2023-04-01 14:44:29 +03:00
Note that the changed link settings are not automatically applied after reloading.
To achieve that, trigger uevents for the corresponding interface. Refer to
<citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
for more information.</para>
<xi:include href="version-info.xml" xpointer="v254"/></listitem>
networkctl: add verb edit and cat to operate on network configs This adds two verbs, edit and cat, to networkctl for operating on network configs (namely .network, .netdev and .link files). Specially, if the config name is prefixed by @, it will be treated as network interface name, and operations will be performed on config files associated with the link. Closes #26906
2023-04-01 14:44:29 +03:00
</varlistentry>
<varlistentry>
<term>
<command>cat</command>
<replaceable>FILE</replaceable>|<replaceable>@DEVICE</replaceable>…
</term>
<listitem><para>Show network configuration files. This command honors
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
the <literal>@</literal> prefix in the same way as <command>edit</command>.</para>
<xi:include href="version-info.xml" xpointer="v254"/></listitem>
networkctl: add verb edit and cat to operate on network configs This adds two verbs, edit and cat, to networkctl for operating on network configs (namely .network, .netdev and .link files). Specially, if the config name is prefixed by @, it will be treated as network interface name, and operations will be performed on config files associated with the link. Closes #26906
2023-04-01 14:44:29 +03:00
</varlistentry>
networkctl: introduce verb mask and unmask Suggested in https://github.com/systemd/systemd/pull/29928#discussion_r1386626565
2023-12-19 10:38:32 +03:00
<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>
man: add networkctl(1)
2015-01-20 05:44:16 +03:00
</variablelist>
</refsect1>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 18:58:44 +03:00
<refsect1>
<title>Options</title>
<para>The following options are understood:</para>
<variablelist>
<varlistentry>
<term>
<option>-a</option>
<option>--all</option>
</term>
<listitem>
<para>Show all links with <command>status</command>.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v219"/>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 18:58:44 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-s</option>
<option>--stats</option>
</term>
<listitem>
<para>Show link statistics with <command>status</command>.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v243"/>
networkctl: status command also shows logs of networkd Closes #14050.
2020-01-07 05:32:03 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term><option>-l</option></term>
<term><option>--full</option></term>
<listitem>
networkctl: set table width 0 when --full is specified
2020-01-10 06:12:00 +03:00
<para>Do not ellipsize the output.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v245"/>
networkctl: status command also shows logs of networkd Closes #14050.
2020-01-07 05:32:03 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term><option>-n</option></term>
<term><option>--lines=</option></term>
<listitem>
<para>When used with <command>status</command>, controls the number of journal lines to show,
counting from the most recent ones. Takes a positive integer argument. Defaults to 10.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v245"/>
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 18:58:44 +03:00
</listitem>
</varlistentry>
networkctl: add verb edit and cat to operate on network configs This adds two verbs, edit and cat, to networkctl for operating on network configs (namely .network, .netdev and .link files). Specially, if the config name is prefixed by @, it will be treated as network interface name, and operations will be performed on config files associated with the link. Closes #26906
2023-04-01 14:44:29 +03:00
<varlistentry>
man: more hyperlinks and other fixes Closes https://github.com/systemd/systemd/issues/29814.
2023-11-06 16:59:00 +03:00
<term><option>--drop-in=</option><replaceable>NAME</replaceable></term>
networkctl: add verb edit and cat to operate on network configs This adds two verbs, edit and cat, to networkctl for operating on network configs (namely .network, .netdev and .link files). Specially, if the config name is prefixed by @, it will be treated as network interface name, and operations will be performed on config files associated with the link. Closes #26906
2023-04-01 14:44:29 +03:00
<listitem>
<para>When used with <command>edit</command>, edit the drop-in file <replaceable>NAME</replaceable>
instead of the main configuration file.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v254"/>
networkctl: add verb edit and cat to operate on network configs This adds two verbs, edit and cat, to networkctl for operating on network configs (namely .network, .netdev and .link files). Specially, if the config name is prefixed by @, it will be treated as network interface name, and operations will be performed on config files associated with the link. Closes #26906
2023-04-01 14:44:29 +03:00
</listitem>
</varlistentry>
<varlistentry>
<term><option>--no-reload</option></term>
<listitem>
networkctl: introduce verb mask and unmask Suggested in https://github.com/systemd/systemd/pull/29928#discussion_r1386626565
2023-12-19 10:38:32 +03:00
<para>When used with <command>edit</command>, <command>mask</command>, or <command>unmask</command>,
man: more hyperlinks and other fixes Closes https://github.com/systemd/systemd/issues/29814.
2023-11-06 16:59:00 +03:00
<citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
or
<citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
networkctl: introduce verb mask and unmask Suggested in https://github.com/systemd/systemd/pull/29928#discussion_r1386626565
2023-12-19 10:38:32 +03:00
will not be reloaded after the operation finishes.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-22 19:52:36 +03:00
<xi:include href="version-info.xml" xpointer="v254"/>
networkctl: add verb edit and cat to operate on network configs This adds two verbs, edit and cat, to networkctl for operating on network configs (namely .network, .netdev and .link files). Specially, if the config name is prefixed by @, it will be treated as network interface name, and operations will be performed on config files associated with the link. Closes #26906
2023-04-01 14:44:29 +03:00
</listitem>
man: move misplaced </varlistentry>
2023-12-23 15:38:40 +03:00
</varlistentry>
networkctl: introduce --runtime for editing network config under /run/
2023-11-17 17:08:28 +03:00
<varlistentry>
<term><option>--runtime</option></term>
<listitem>
networkctl: introduce verb mask and unmask Suggested in https://github.com/systemd/systemd/pull/29928#discussion_r1386626565
2023-12-19 10:38:32 +03:00
<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>
networkctl: introduce --runtime for editing network config under /run/
2023-11-17 17:08:28 +03:00
<xi:include href="version-info.xml" xpointer="v256"/>
</listitem>
</varlistentry>
networkctl: add verb edit and cat to operate on network configs This adds two verbs, edit and cat, to networkctl for operating on network configs (namely .network, .netdev and .link files). Specially, if the config name is prefixed by @, it will be treated as network interface name, and operations will be performed on config files associated with the link. Closes #26906
2023-04-01 14:44:29 +03:00
networkctl: introduce --json option for "status" and "list" commands When `--json` option is specified, "status" and "list" commands gives the same information, as originally "list" just gives partial information of "status" in different format.
2021-05-12 18:22:14 +03:00
<xi:include href="standard-options.xml" xpointer="json" />
Move the Commands section above Options section For executables which take a verb, we should list the verbs first, and then options which modify those verbs second. The general layout of the man page is from general description to specific details, usually Overview, Commands, Options, Return Value, Examples, References.
2019-10-08 18:58:44 +03:00
<xi:include href="standard-options.xml" xpointer="help" />
<xi:include href="standard-options.xml" xpointer="version" />
<xi:include href="standard-options.xml" xpointer="no-legend" />
<xi:include href="standard-options.xml" xpointer="no-pager" />
</variablelist>
</refsect1>
man: add networkctl(1)
2015-01-20 05:44:16 +03:00
<refsect1>
<title>Exit status</title>
Add networkctl label to man and shell completion
2017-06-27 17:30:41 +03:00
<para>On success, 0 is returned, a non-zero failure code otherwise.</para>
man: add networkctl(1)
2015-01-20 05:44:16 +03:00
</refsect1>
<refsect1>
<title>See Also</title>
man: use <simplelist> for 'See also' sections This is just a slight markup improvement; there should be no difference in rendering.
2023-12-22 21:09:32 +03:00
<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>
man: add networkctl(1)
2015-01-20 05:44:16 +03:00
</refsect1>
</refentry>
Copy Permalink