diff --git a/usr.sbin/bootparamd/callbootd/Makefile b/usr.sbin/bootparamd/callbootd/Makefile --- a/usr.sbin/bootparamd/callbootd/Makefile +++ b/usr.sbin/bootparamd/callbootd/Makefile @@ -1,5 +1,5 @@ PROG= callbootd -MAN= +MAN= callbootd.8 SRCS= callbootd.c ${GENSRCS} GENSRCS=bootparam_prot.h bootparam_prot_clnt.c bootparam_prot_xdr.c diff --git a/usr.sbin/bootparamd/callbootd/callbootd.8 b/usr.sbin/bootparamd/callbootd/callbootd.8 new file mode 100644 --- /dev/null +++ b/usr.sbin/bootparamd/callbootd/callbootd.8 @@ -0,0 +1,92 @@ +.\" SPDX-License-Identifier: FreeBSD-DOC +.\" +.\" Copyright 2025 The FreeBSD Project. All rights reserved. +.\" +.\" Redistribution and use in source (SGML DocBook) and 'compiled' forms +.\" (SGML, HTML, PDF, PostScript, RTF and so forth) with or without +.\" modification, are permitted provided that the following conditions are met: +.\" +.\" 1. Redistributions of source code (SGML DocBook) must retain the above +.\" copyright notice, this list of conditions and the following disclaimer +.\" as the first lines of this file unmodified. +.\" 2. Redistributions in compiled form (transformed to other DTDs, +.\" converted to PDF, PostScript, RTF and other formats) 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 DOCUMENTATION IS PROVIDED BY THE FREEBSD DOCUMENTATION PROJECT "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 FREEBSD DOCUMENTATION PROJECT +.\" 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 DOCUMENTATION, EVEN IF +.\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd February 6, 2025 +.Dt CALLBOOTD 8 +.Os +.Sh NAME +.Nm callbootd +.Nd Contact boot parameter server for boot parameters +.Sh SYNOPSIS +.\" callbootd server procnum (IP-addr | host fileid) +.\" "usage: callbootd (all | server) [ip_addr | hostname]" +.Nm +.Ar server +.Op ip_addr | hostname +.Sh DESCRIPTION +The +.Nm +utility is a client application that provides information to +.Xr diskless 8 +clients necessary for booting. +.Nm +runs after the kernel initializes networking +but before mounting the root filesystem. +It retrieves hostname, domain, router, and +NFS boot file information from +.Xr bootparamd 8 . +This information is used to configure networking +and determine the NFS root filesystem. +.Sh OPTIONS +.Bl -tag -width Fl +.It Ar server +Contact server to request boot parameters. +If server is "all", then a broadcast message is sent +to all hosts on the local network. +Otherwise, if no client IP address or hostname is specified, +.Nm +sends a whoami request and prints the client hostname, +domain_name, and router (default gateway) for each response received. +.It Op ip_addr | hostname +Contact +.Ar server +to request the boot server name, boot server address, +and NFS path associated with the client IP address (ip_addr) or hostname. +.El +.Sh EXAMPLES +To broadcast a request for whoami information: +.Pp +.Ql "callbootd all" +.Pp +To contact a server at 192.168.0.3 for whoami information: +.Pp +.Ql "callbootd 192.168.0.3" +.Sh SEE ALSO +.Xr bootparams 5 , +.Xr bootparamd 8 , +.Xr diskless 8 +.Sh AUTHORS +.Nm +was written by +.An Klas Heggemann Aq Mt klas@nada.kth.se . +This manpage was written by Felix Johnson +.Aq Mt felix.the.red@gmail.com . +.Sh BUGS +.Nm +only supports IPv4. diff --git a/usr.sbin/bootparamd/callbootd/callbootd.c b/usr.sbin/bootparamd/callbootd/callbootd.c --- a/usr.sbin/bootparamd/callbootd/callbootd.c +++ b/usr.sbin/bootparamd/callbootd/callbootd.c @@ -149,8 +149,8 @@ static void usage(void) { - fprintf(stderr, - "usage: callbootd server procnum (IP-addr | host fileid)\n"); + fprintf(stderr, "usage: callbootd server [ip_addr | hostname]\n"); + fprintf(stderr, "callbootd all [ip_addr | hostname]\n"); exit(1); }