verify: use manager_load_startable_unit_or_warn() to load units for verification

[thirdparty/systemd.git] / man / networkctl.xml

diff --git a/man/networkctl.xml b/man/networkctl.xml
index c688714b307ca653dc03964b60ae7b729ac4b08b..33e0629d803830e6f6b2b1dd238e9c65fd34f5db 100644 (file)
--- a/man/networkctl.xml
+++ b/man/networkctl.xml
@@ -3,6 +3,8 @@
 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 
 <!--
+  SPDX-License-Identifier: LGPL-2.1+
+
   This file is part of systemd.
 
   Copyright 2015 Zbigniew Jędrzejewski-Szmek
@@ -102,12 +104,14 @@
       <varlistentry>
         <term>
           <command>list</command>
+          <optional><replaceable>LINK…</replaceable></optional>
         </term>
 
         <listitem>
-          <para>Show a list of existing links and their
-          status. Produces output similar to <programlisting>
-IDX LINK         TYPE     OPERATIONAL SETUP
+          <para>Show a list of existing links and their status. If no further arguments are specified shows all links,
+          otherwise just the specified links. Produces output similar to:
+
+          <programlisting>IDX LINK         TYPE     OPERATIONAL SETUP
   1 lo           loopback carrier     unmanaged
   2 eth0         ether    routable    configured
   3 virbr0       ether    no-carrier  unmanaged
@@ -120,7 +124,7 @@ IDX LINK         TYPE     OPERATIONAL SETUP
       <varlistentry>
         <term>
           <command>status</command>
-          <optional><replaceable>LINK...</replaceable></optional>
+          <optional><replaceable>LINK…</replaceable></optional>
         </term>
 
         <listitem>
@@ -128,10 +132,10 @@ IDX LINK         TYPE     OPERATIONAL SETUP
           state, kernel module driver, hardware and IP address,
           configured DNS servers, etc.</para>
 
-          <para>When no links are specified, routable links are
-          shown. Also see the option <option>--all</option>.</para>
+          <para>When no links are specified, an overall network status is shown. Also see the option
+          <option>--all</option>.</para>
 
-          <para>Produces output similar to
+          <para>Produces output similar to:
           <programlisting>
 ●      State: routable
      Address: 10.193.76.5 on eth0
@@ -148,21 +152,62 @@ IDX LINK         TYPE     OPERATIONAL SETUP
       <varlistentry>
         <term>
           <command>lldp</command>
+          <optional><replaceable>LINK…</replaceable></optional>
         </term>
 
         <listitem>
-          <para>Show LLDP (Link Layer Discovery Protocol)
-          status.</para>
+          <para>Show discovered LLDP (Link Layer Discovery Protocol) neighbors. If one or more link names 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 on the specific interface, see
+          <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>
+        </listitem>
+      </varlistentry>
+
+      <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
+        <citerefentry><refentrytitle>ip-addrlabel</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+        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>
         </listitem>
       </varlistentry>
+
     </variablelist>
   </refsect1>
 
   <refsect1>
     <title>Exit status</title>
 
-    <para>On success, 0 is returned, a non-zero failure
-    code otherwise.</para>
+    <para>On success, 0 is returned, a non-zero failure code otherwise.</para>
   </refsect1>
 
   <refsect1>
@@ -170,7 +215,8 @@ IDX LINK         TYPE     OPERATIONAL SETUP
     <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><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+      <citerefentry project='die-net'><refentrytitle>ip</refentrytitle><manvolnum>8</manvolnum></citerefentry>
     </para>
   </refsect1>
 </refentry>