From: Yu Watanabe <watanabe.yu+github@gmail.com>
Date: Wed, 6 Mar 2019 14:47:29 +0000 (+0900)
Subject: man: update wait-online and RequiredForOnline= setting
X-Git-Tag: v242-rc1~151^2~2
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=8d6082e4dda2b90e26da95021bab73d68bd23786;p=thirdparty%2Fsystemd.git

man: update wait-online and RequiredForOnline= setting
---

diff --git a/man/systemd-networkd-wait-online.service.xml b/man/systemd-networkd-wait-online.service.xml
index 95abf5b8736..1b1bcf96fa9 100644
--- a/man/systemd-networkd-wait-online.service.xml
+++ b/man/systemd-networkd-wait-online.service.xml
@@ -6,7 +6,8 @@
   SPDX-License-Identifier: LGPL-2.1+
 -->
 
-<refentry id="systemd-networkd-wait-online.service" conditional='ENABLE_NETWORKD'>
+<refentry id="systemd-networkd-wait-online.service" conditional='ENABLE_NETWORKD'
+          xmlns:xi="http://www.w3.org/2001/XInclude">
 
   <refentryinfo>
     <title>systemd-networkd-wait-online.service</title>
@@ -48,8 +49,8 @@
 
     <variablelist>
       <varlistentry>
-        <term><option>-i</option></term>
-        <term><option>--interface=</option></term>
+        <term><option>-i</option> <replaceable>INTERFACE</replaceable><optional>:<replaceable>OPERSTATE</replaceable></optional></term>
+        <term><option>--interface=</option><replaceable>INTERFACE</replaceable><optional>:<replaceable>OPERSTATE</replaceable></optional></term>
 
         <listitem><para>Network interface to wait for before deciding
         if the system is online. This is useful when a system has
@@ -57,21 +58,53 @@
         one is necessary to access some network resources. This option
         may be used more than once to wait for multiple network
         interfaces. When used, all other interfaces are ignored.
+        Optinally, required minimum operational state can be
+        specified after a colon <literal>:</literal>. Please see
+        <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+        for possible operational states. If the operational state is not specified here, then
+        the value from <varname>RequiredForOnline=</varname> in the corresponding
+        <filename>.network</filename> file is used if present, and <literal>degraded</literal> otherwise.
         </para></listitem>
       </varlistentry>
+
       <varlistentry>
-        <term><option>--ignore=</option></term>
+        <term><option>--ignore=</option><replaceable>INTERFACE</replaceable></term>
+
         <listitem><para>Network interfaces to be ignored when deciding
         if the system is online. By default, only the loopback
         interface is ignored. This option may be used more than once
         to ignore multiple network interfaces. </para></listitem>
       </varlistentry>
+
+      <varlistentry>
+        <term><option>-o</option> <replaceable>OPERSTATE</replaceable></term>
+        <term><option>--operational-state=</option><replaceable>OPERSTATE</replaceable></term>
+
+        <listitem><para>Takes an operational state. Please see
+        <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+        for possible operational states. If set, the specified value overrides
+        <varname>RequiredForOnline=</varname> settings in <filename>.network</filename> files.
+        But this does not override operational states specified in <option>--interface</option> option.
+        </para></listitem>
+      </varlistentry>
+
       <varlistentry>
-        <term><option>--timeout=</option></term>
+        <term><option>--timeout=</option> <replaceable>SECS</replaceable></term>
+
         <listitem><para>Fail the service if the network is not online
         by the time the timeout elapses. A timeout of 0 disables the
         timeout. Defaults to 120 seconds. </para></listitem>
       </varlistentry>
+
+      <varlistentry>
+        <term><option>-q</option></term>
+        <term><option>--quiet</option></term>
+
+        <listitem><para>Suppress log messages.</para></listitem>
+      </varlistentry>
+
+      <xi:include href="standard-options.xml" xpointer="help" />
+      <xi:include href="standard-options.xml" xpointer="version" />
     </variablelist>
   </refsect1>
 
@@ -80,7 +113,8 @@
     <para>
       <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
-      <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+      <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+      <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
     </para>
   </refsect1>
 
diff --git a/man/systemd.network.xml b/man/systemd.network.xml
index 1a3d24aa763..0dd553adc1c 100644
--- a/man/systemd.network.xml
+++ b/man/systemd.network.xml
@@ -255,15 +255,19 @@
       <varlistentry>
         <term><varname>RequiredForOnline=</varname></term>
         <listitem>
-          <para>Takes a boolean. When <literal>yes</literal>, the network is deemed
-          required when determining whether the system is online when running
-          <literal>systemd-networkd-wait-online</literal>.
-          When <literal>no</literal>, the network is ignored when checking for
-          online state. Defaults to <literal>yes</literal>.</para>
+          <para>Takes a boolean or operational state. Please see
+          <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+          for possible operational states. When <literal>yes</literal>, the network is deemed required when
+          determining whether the system is online when running
+          <command>systemd-networkd-wait-online</command>. When <literal>no</literal>, the network is ignored
+          when checking for online state. When an operational state is set, <literal>yes</literal> is implied,
+          and this controls the operational state required for the network interface to be considered online.
+          Defaults to <literal>yes</literal>.</para>
+
           <para>The network will be brought up normally in all cases, but in
           the event that there is no address being assigned by DHCP or the
           cable is not plugged in, the link will simply remain offline and be
-          skipped automatically by <literal>systemd-networkd-wait-online</literal>
+          skipped automatically by <command>systemd-networkd-wait-online</command>
           if <literal>RequiredForOnline=no</literal>.</para>
         </listitem>
       </varlistentry>