networkd-wait-online: drop config file and add commandline options instead

[elogind.git] / man / systemd-networkd-wait-online.service.xml

diff --git a/man/systemd-networkd-wait-online.service.xml b/man/systemd-networkd-wait-online.service.xml
index d8f2226552fda889c9c179af33a0993fff980fb8..c8190e1ab93d64ad49dffc40465ea3ac8b283df0 100644 (file)
--- a/man/systemd-networkd-wait-online.service.xml
+++ b/man/systemd-networkd-wait-online.service.xml
@@ -45,7 +45,7 @@
         <refnamediv>
                 <refname>systemd-networkd-wait-online.service</refname>
                 <refname>systemd-networkd-wait-online</refname>
-                <refpurpose>Wait for network to become online</refpurpose>
+                <refpurpose>Wait for network to come online</refpurpose>
         </refnamediv>
 
         <refsynopsisdiv>
@@ -58,22 +58,37 @@
 
                 <para><command>systemd-networkd-wait-online</command> is a
                 one-shot system service that waits for the network to be configured.
-                It will wait for all links managed by
+                By default it will wait for all links it is aware of that are managed by
                 <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-                to be fully configured. It will wait for at least one link managed by
-                systemd-networkd to appear, or for a link to be brought up by someone else.
+                to be fully configured or failed, and for at least one link to gain a
+                carrier.</para>
+        </refsect1>
 
-                To wait for a specific set of links, see
-                <citerefentry><refentrytitle>systemd-networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
-                This may be necessary on systems with more than one active link.
-                </para>
+        <refsect1>
+                <title>Options</title>
+
+                <para>The following options are understood:</para>
+
+                <variablelist>
+                        <varlistentry>
+                                <term><option>-i</option></term>
+                                <term><option>--interface=</option></term>
+
+                                <listitem><para>Network interface to wait for
+                                before deciding if the system is online. This is
+                                useful when a system has several interfaces which
+                                will be configured, but a particular one is necessary
+                                to access some network resources. This option may be
+                                used more than once to wait for multiple network
+                                interfaces.</para></listitem>
+                        </varlistentry>
+                </variablelist>
         </refsect1>
 
         <refsect1>
                 <title>See Also</title>
                 <para>
                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
-                        <citerefentry><refentrytitle>systemd-networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                         <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                 </para>
         </refsect1>