fdo-mirrors/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git synced 2026-05-09 07:08:02 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

man: add a manpage for nm-online

Browse source
This commit is contained in:
Jiří Klimeš 2010-08-06 13:51:41 +02:00 • committed by Dan Williams
parent efb5bd5379
commit 3a32e5c31d
3 changed files with 67 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
configure.ac
View file

@ -518,6 +518,7 @@ man/NetworkManager.8
man/NetworkManager.conf.5 man/NetworkManager.conf.5
man/nm-system-settings.conf.5 man/nm-system-settings.conf.5
man/nm-tool.1 man/nm-tool.1
man/nm-online.1
man/nmcli.1 man/nmcli.1
po/Makefile.in po/Makefile.in
policy/Makefile policy/Makefile

2
man/Makefile.am
View file

@ -3,6 +3,7 @@ man_MANS = \
NetworkManager.conf.5 \ NetworkManager.conf.5 \
nm-system-settings.conf.5 \ nm-system-settings.conf.5 \
nm-tool.1 \ nm-tool.1 \
nm-online.1 \
nmcli.1 nmcli.1
EXTRA_DIST = \ EXTRA_DIST = \
@ -11,6 +12,7 @@ EXTRA_DIST = \
NetworkManager.conf.5.in \ NetworkManager.conf.5.in \
nm-system-settings.conf.5.in \ nm-system-settings.conf.5.in \
nm-tool.1.in \ nm-tool.1.in \
nm-online.1.in \
nmcli.1.in nmcli.1.in
CLEANFILES = $(man_MANS) CLEANFILES = $(man_MANS)

64
man/nm-online.1.in Normal file
View file

@ -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).