man-pages/man1/nm-online.1.html
2021-03-31 01:06:50 +01:00

154 lines
3.4 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of NM-ONLINE</TITLE>
</HEAD><BODY>
<H1>NM-ONLINE</H1>
Section: General Commands Manual (1)<BR>Updated: <BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
nm-online - ask NetworkManager whether the network is connected
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<DL COMPACT>
<DT id="1">
<B>nm-online</B> [<I>OPTIONS</I>...]
</DL>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<P>
<B>nm-online</B>
<DD>is a utility to find out whether we are online. It is done by asking NetworkManager about its status. When run,
<B>nm-online</B>
waits until NetworkManager reports an active connection, or specified timeout expires. On exit, the returned status code should be checked (see the return codes below).
<P>
By default NetworkManager waits for IPv4 dynamic addressing to complete but does not wait for the
auto
IPv6 dynamic addressing. To wait for IPv6 addressing to complete, either (1) change the network connection's IPv6
may-fail
setting to
no, and/or (2) change the IPv6 addressing method to
manual
or
dhcp, to indicate that IPv6 connectivity is expected.
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>
<P>
<B>-h</B> | <B>--help</B>
<DL COMPACT><DT id="2"><DD>
Print help information.
</DL>
<P>
<B>-q</B> | <B>--quiet</B>
<DL COMPACT><DT id="3"><DD>
Don't print anything.
</DL>
<P>
<B>-s</B> | <B>--wait-for-startup</B>
<DL COMPACT><DT id="4"><DD>
Wait for NetworkManager startup to complete, rather than waiting for network connectivity specifically. Startup is considered complete once NetworkManager has activated (or attempted to activate) every auto-activate connection which is available given the current network state. (This is generally only useful at boot time; after startup has completed,
<B>nm-online -s</B>
will just return immediately, regardless of the current network state.)
</DL>
<P>
<B>-t</B> | <B>--timeout</B> <I>seconds</I>
<DL COMPACT><DT id="5"><DD>
Time to wait for a connection, in seconds. If the option is not provided, the default timeout is 30 seconds.
</DL>
<P>
<B>-x</B> | <B>--exit</B>
<DL COMPACT><DT id="6"><DD>
Exit immediately if NetworkManager is not running or connecting.
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>EXIT STATUS</H2>
<P>
<B>nm-online</B>
exits with status 0 if it succeeds, a value greater than 0 is returned if an error occurs.
<P>
<B>0</B>
<DL COMPACT><DT id="7"><DD>
Success - already online or connection established within given timeout.
</DL>
<P>
<B>1</B>
<DL COMPACT><DT id="8"><DD>
Offline or not online within given timeout.
</DL>
<P>
<B>2</B>
<DL COMPACT><DT id="9"><DD>
Unknown or unspecified error.
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>SEE ALSO</H2>
<P>
<B><A HREF="/cgi-bin/man/man2html?1+nmcli">nmcli</A></B>(1),
<B><A HREF="/cgi-bin/man/man2html?8+NetworkManager">NetworkManager</A></B>(8).
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="10"><A HREF="#lbAB">NAME</A><DD>
<DT id="11"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="12"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="13"><A HREF="#lbAE">OPTIONS</A><DD>
<DT id="14"><A HREF="#lbAF">EXIT STATUS</A><DD>
<DT id="15"><A HREF="#lbAG">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:20 GMT, March 31, 2021
</BODY>
</HTML>