From 7e59cfe9516722ac8a00adef5d01575c45a0ba2f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Alvin=20=C5=A0ipraga?= <alsi@bang-olufsen.dk>
Date: Tue, 27 Apr 2021 10:58:18 +0200
Subject: man: describe overall online status in networkctl(1)

---
 man/networkctl.xml | 48 ++++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 40 insertions(+), 8 deletions(-)

(limited to 'man/networkctl.xml')

diff --git a/man/networkctl.xml b/man/networkctl.xml
index 19095164ce..2f7e9d7f46 100644
--- a/man/networkctl.xml
+++ b/man/networkctl.xml
@@ -187,14 +187,46 @@
 
           <para>Produces output similar to:
           <programlisting>
-●      State: routable
-     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>
+●        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>
+                <para>all links have unknown online status (i.e. there are no required links)</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term>offline</term>
+              <listitem>
+                <para>all required links are offline</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term>partial</term>
+              <listitem>
+                <para>some, but not all, required links are online</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term>online</term>
+              <listitem>
+                <para>all required links are online</para>
+              </listitem>
+            </varlistentry>
+          </variablelist>
+          </para>
         </listitem>
 
       </varlistentry>
-- 
cgit v1.2.1