mirror of
https://gitlab.freedesktop.org/NetworkManager/NetworkManager
synced 2024-07-22 02:35:25 +00:00
77 lines
2.8 KiB
Groff
77 lines
2.8 KiB
Groff
.\" nm-online (1) manual page
|
|
.\"
|
|
.\" This is free documentation; you can redistribute it and/or
|
|
.\" modify it under the terms of the GNU General Public License as
|
|
.\" published by the Free Software Foundation; either version 2 of
|
|
.\" the License, or (at your option) any later version.
|
|
.\"
|
|
.\" The GNU General Public License's references to "object code"
|
|
.\" and "executables" are to be interpreted as the output of any
|
|
.\" document formatting or typesetting system, including
|
|
.\" intermediate and printed output.
|
|
.\"
|
|
.\" This manual is distributed in the hope that it will be useful,
|
|
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
.\" GNU General Public License for more details.
|
|
.\"
|
|
.\" You should have received a copy of the GNU General Public Licence along
|
|
.\" with this manual; if not, write to the Free Software Foundation, Inc.,
|
|
.\" 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
.\"
|
|
.\" Copyright (C) 2010 - 2014 Red Hat, Inc.
|
|
.\"
|
|
.TH NM-ONLINE "1" "25 March 2014"
|
|
|
|
.SH NAME
|
|
nm-online \- ask NetworkManager whether the network is connected
|
|
.SH SYNOPSIS
|
|
.B nm-online
|
|
.RI " [ " OPTIONS " ]
|
|
|
|
.SH DESCRIPTION
|
|
.B nm-online
|
|
is a utility to find out whether we are online. It is done by asking
|
|
NetworkManager about its status. When run, \fInm\-online\fP waits until
|
|
NetworkManager reports an active connection, or specified timeout expires. On
|
|
exit, the returned status code should be checked (see the return codes bellow).
|
|
.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.
|
|
.SH OPTIONS
|
|
.TP
|
|
.B \-t, \-\-timeout <timeout_value>
|
|
Time to wait for a connection, in seconds. If the option is not provided,
|
|
the default timeout is 30 seconds.
|
|
.TP
|
|
.B \-x, \-\-exit
|
|
Exit immediately if NetworkManager is not running or connecting.
|
|
.TP
|
|
.B \-q, \-\-quiet
|
|
Don't print anything.
|
|
.TP
|
|
.B \-s, \-\-wait-for-startup
|
|
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, \fInm-online -s\fP will just return immediately, regardless
|
|
of the current network state.)
|
|
|
|
.SH EXIT STATUS
|
|
|
|
.IP "0" 4
|
|
Success - already online or connection established within given timeout
|
|
.IP "1" 4
|
|
Offline or not online within given timeout
|
|
.IP "2" 4
|
|
Unspecified error
|
|
|
|
.SH SEE ALSO
|
|
.BR nmcli (1),
|
|
.BR NetworkManager(8).
|