Imported Upstream version 0.8.2 upstream/0.8.2

1 files changed, 64 insertions, 0 deletions

diff --git a/man/nm-online.1 b/man/nm-online.1
new file mode 100644
index 00000000..2c8c9e9a
--- /dev/null
+++ b/man/nm-online.1
@@ -0,0 +1,64 @@
+.\" 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
+.\" License along with this manual; if not, write to the Free
+.\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
+.\" USA.
+.\"
+.\" Copyright (C) 2010 Red Hat, Inc.
+.\"
+.TH NM-ONLINE "1" "6 August 2010"
+
+.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).
+
+.SH OPTIONS
+.TP
+.B \-t, \-\-timeout
+Time to wait for a connection, in seconds.  If not specified, the default is 30
+seconds.
+.TP
+.B \-x, \-\-exit
+Exit immediately if NetworkManager is not running or connecting.
+.TP
+.B \-q, \-\-quiet
+Don't print anything.
+
+.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 nm\-tool (1),
+.BR nmcli (1),
+.BR NetworkManager(8).