diff options
Diffstat (limited to 'man/nm-online.1')
| -rw-r--r-- | man/nm-online.1 | 96 |
1 files changed, 96 insertions, 0 deletions
diff --git a/man/nm-online.1 b/man/nm-online.1 new file mode 100644 index 00000000..94e6406c --- /dev/null +++ b/man/nm-online.1 @@ -0,0 +1,96 @@ +'\" t +.\" Title: nm-online +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 04/05/2016 +.\" Manual: General Commands Manual +.\" Source: NetworkManager 1.1.93 +.\" Language: English +.\" +.TH "NM\-ONLINE" "1" "" "NetworkManager 1\&.1\&.93" "General Commands Manual" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +nm-online \- ask NetworkManager whether the network is connected +.SH "SYNOPSIS" +.HP \w'\fBnm\-online\fR\ 'u +\fBnm\-online\fR [\fIOPTIONS\fR...] +.SH "DESCRIPTION" +.PP +\fBnm\-online\fR +is a utility to find out whether we are online\&. It is done by asking NetworkManager about its status\&. When run, +\fBnm\-online\fR +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)\&. +.PP +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\*(Aqs 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" +.PP +\fB\-t\fR | \fB\-\-timeout\fR \fIseconds\fR +.RS 4 +Time to wait for a connection, in seconds\&. If the option is not provided, the default timeout is 30 seconds\&. +.RE +.PP +\fB\-x\fR | \fB\-\-exit\fR +.RS 4 +Exit immediately if NetworkManager is not running or connecting\&. +.RE +.PP +\fB\-q\fR | \fB\-\-quiet\fR +.RS 4 +Don\*(Aqt print anything\&. +.RE +.PP +\fB\-s\fR | \fB\-\-wait\-for\-startup\fR +.RS 4 +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, +\fBnm\-online \-s\fR +will just return immediately, regardless of the current network state\&.) +.RE +.SH "EXIT STATUS" +.PP +\fBnm\-online\fR +exits with status 0 if it succeeds, a value greater than 0 is returned if an error occurs\&. +.PP +\fB0\fR +.RS 4 +Success \(en already online or connection established within given timeout\&. +.RE +.PP +\fB1\fR +.RS 4 +Offline or not online within given timeout\&. +.RE +.PP +\fB2\fR +.RS 4 +Unknown or unspecified error\&. +.RE +.SH "SEE ALSO" +.PP +\fBnmcli\fR(1), +\fBNetworkManager\fR(8)\&. |