.\" Copyright (c) 2014-2023 Roy Marples
.\" All rights reserved
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd April 4, 2023
.Dt DHCPCD-ONLINE
.Os
.Sh NAME
.Nm dhcpcd-online
.Nd a utility to work out if
.Xr dhcpcd 8
is in the connected state
.Sh SYNOPSIS
.Nm
.Op Fl q
.Op Fl t Ar timeout
.Op Fl x
.Sh DESCRIPTION
.Nm
connects to
.Xr dhcpcd 8
and waits for a maximum of
.Ar timeout
seconds until the status changes to
.Va connected .
This tool is intended for use in the startup of the host system
where
.Xr dhcpcd 8
is started in parallel with other services who depend on a network connection
being available.
.Bl -tag -width timeoutlen
.It Fl q
Suppresses the reporting of non error messages.
.It Fl t Ar timeout
Sets the number of seconds
.Nm
waits for
.Xr dhcpcd 8
to reach the connected state.
If not specified, a default value of 30 is used.
.It Fl x
Exits immediately if
.Xr dhcpcd 8
is not running.
.El
.Sh NOTES
.Xr dhcpcd 8
needs to be running in Master mode for
.Nm
to work.
.Sh AUTHORS
.An Roy Marples Aq roy@marples.name
.Sh BUGS
Please report them to http://roy.marples.name/projects/dhcpcd-ui