roy.marples.name Git - dhcpcd-ui/blob - src/dhcpcd-online/dhcpcd-online.8

   1 .\" Copyright (c) 2014 Roy Marples
   2 .\" All rights reserved
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .Dd September 2, 2014
  26 .Dt DHCPCD-ONLINE
  27 .Os
  28 .Sh NAME
  29 .Nm dhcpcd-online
  30 .Nd a utility to work out if
  31 .Xr dhcpcd 8
  32 is in the connected state
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Op Fl q
  36 .Op Fl t Ar timeout
  37 .Op Fl x
  38 .Sh DESCRIPTION
  39 .Nm
  40 connects to
  41 .Xr dhcpcd 8
  42 and waits for a maximum of
  43 .Ar timeout
  44 seconds until the status changes to
  45 .Va connected .
  46 This tool is intended for use in the startup of the host system
  47 where
  48 .Xr dhcpcd 8
  49 is started in parallel with other services who depend on a network connection
  50 being available.
  51 .Bl -tag --width flag
  52 .It Fl q
  53 Suppresses the reporting of non error messages.
  54 .It Fl t Ar timeout
  55 Sets the number of seconds
  56 .Nm
  57 waits for
  58 .Xr dhcpcd 8
  59 to reach the connected state.
  60 If not specified, a default value of 30 is used.
  61 .It Fl x
  62 Exits immediately if
  63 .Xr dhcpcd 8
  64 is not running.
  65 .El
  66 .Sh AUTHORS
  67 .An Roy Marples Aq roy@marples.name
  68 .Sh BUGS
  69 Please report them to http://roy.marples.name/projects/dhcpcd-ui