NetBSD/usr.sbin/rpc.bootparamd/bootparams.5

.\"	$NetBSD: bootparams.5,v 1.11 2002/02/28 01:19:48 lukem Exp $
.\"
.\" Copyright (c) 1994 Gordon W. Ross
.\" 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.
.\" 3. The name of the author may not be used to endorse or promote products
.\"    derived from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 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 February 28, 2002
.Dt BOOTPARAMS 5
.Os
.Sh NAME
.Nm bootparams
.Nd boot parameter database
.Sh SYNOPSIS
.Nm /etc/bootparams
.Sh DESCRIPTION
The
.Nm
file specifies the boot parameters that
.Xr diskless 8
clients may request when booting over the network.
Each client supported by this server must have an entry in the
.Nm
file containing the servers and pathnames for its
.Pa root ,
area.  It may optionally contain
.Pa swap ,
.Pa dump ,
and other entry types.
.Pp
Each line in the file
(other than comment lines that begin with a #)
specifies the client name followed by the pathnames that
the client may request by their logical names.  Names
are matched in a case-insensitive fashion, and may also
be wildcarded using shell-style globbing characters.
.Pp
The components of the line are delimited with blank or tab,
and may be continued onto multiple lines with a backslash.
.Pp
For example:
.Bd -literal -offset indent
dummy	root=server:/export/dummy/root \\
	swap=server:/export/dummy/swap \\
	dump=server:/export/dummy/swap \\
	gateway=router:255.255.255.0
.Ed
.Pp
When the client named "dummy" requests the pathname for
its logical "root" it will be given server
.Dq Pa "server"
and pathname
.Dq Pa "/export/dummy/root"
as the response to its
.Tn RPC
request.
.Pp
.Bd -literal -offset indent
netra[1-5]www*	root=server:/export/jumpstart/netra_www
.Ed
.Pp
When any client with a name matching the pattern "netra[1-5]www*"
requests the pathname for its logical "root" it will be given server
.Dq Pa "server"
and pathname
.Dq Pa "/export/jumpstart/netra_www"
as the response to its
.Tn RPC
request.  As this example implies, this is useful for setting up
Jumpstart servers for Sun clients.
.Sh NOTES
The server does not default to the localhost, and must be filled in.
.Sh FILES
.Bl -tag -width /etc/bootparams -compact
.It Pa /etc/bootparams
default configuration file
.El
.Sh SEE ALSO
.Xr diskless 8 ,
.Xr rpc.bootparamd 8
provide "gateway" example "file" 2002-02-28 04:19:48 +03:00			`.\" $NetBSD: bootparams.5,v 1.11 2002/02/28 01:19:48 lukem Exp $`
Add a man page and a link for bootparamd(8). 1994-10-03 21:48:40 +03:00			`.\"`
			`.\" Copyright (c) 1994 Gordon W. Ross`
			`.\" 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.`
			`.\" 3. The name of the author may not be used to endorse or promote products`
			`.\" derived from this software without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 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.`
			`.\"`
provide "gateway" example "file" 2002-02-28 04:19:48 +03:00			`.Dd February 28, 2002`
Add a man page and a link for bootparamd(8). 1994-10-03 21:48:40 +03:00			`.Dt BOOTPARAMS 5`
			`.Os`
			`.Sh NAME`
			`.Nm bootparams`
			`.Nd boot parameter database`
Fix SEE ALSO and FILES. 1994-10-03 22:26:13 +03:00			`.Sh SYNOPSIS`
			`.Nm /etc/bootparams`
Add a man page and a link for bootparamd(8). 1994-10-03 21:48:40 +03:00			`.Sh DESCRIPTION`
			`The`
WARNSify; generate ansi c code with rpcgen, cleanup manpage 1997-10-17 19:59:05 +04:00			`.Nm`
Add a man page and a link for bootparamd(8). 1994-10-03 21:48:40 +03:00			`file specifies the boot parameters that`
Add section to a .Xr. 2001-04-03 15:28:44 +04:00			`.Xr diskless 8`
Add a man page and a link for bootparamd(8). 1994-10-03 21:48:40 +03:00			`clients may request when booting over the network.`
			`Each client supported by this server must have an entry in the`
WARNSify; generate ansi c code with rpcgen, cleanup manpage 1997-10-17 19:59:05 +04:00			`.Nm`
expand a bit on the sematics required. 1997-04-23 04:28:03 +04:00			`file containing the servers and pathnames for its`
WARNSify; generate ansi c code with rpcgen, cleanup manpage 1997-10-17 19:59:05 +04:00			`.Pa root ,`
expand a bit on the sematics required. 1997-04-23 04:28:03 +04:00			`area. It may optionally contain`
Add support for globbing when matching the host name in the bootparams(5) file, a'la Solaris. This is extremely useful for configuring Jumpstart servers. From Dan Mercer <dmercer@zembu.com>. 2000-06-28 05:30:56 +04:00			`.Pa swap ,`
			`.Pa dump ,`
			`and other entry types.`
Add a man page and a link for bootparamd(8). 1994-10-03 21:48:40 +03:00			`.Pp`
			`Each line in the file`
			`(other than comment lines that begin with a #)`
			`specifies the client name followed by the pathnames that`
Add support for globbing when matching the host name in the bootparams(5) file, a'la Solaris. This is extremely useful for configuring Jumpstart servers. From Dan Mercer <dmercer@zembu.com>. 2000-06-28 05:30:56 +04:00			`the client may request by their logical names. Names`
			`are matched in a case-insensitive fashion, and may also`
			`be wildcarded using shell-style globbing characters.`
			`.Pp`
Add a man page and a link for bootparamd(8). 1994-10-03 21:48:40 +03:00			`The components of the line are delimited with blank or tab,`
			`and may be continued onto multiple lines with a backslash.`
			`.Pp`
			`For example:`
			`.Bd -literal -offset indent`
paths are specified as server:/path and the server and path are both returned. 1996-06-18 21:30:16 +04:00			`dummy root=server:/export/dummy/root \\`
			`swap=server:/export/dummy/swap \\`
provide "gateway" example "file" 2002-02-28 04:19:48 +03:00			`dump=server:/export/dummy/swap \\`
			`gateway=router:255.255.255.0`
Add a man page and a link for bootparamd(8). 1994-10-03 21:48:40 +03:00			`.Ed`
			`.Pp`
			`When the client named "dummy" requests the pathname for`
Minor formatting update. 1996-06-18 21:45:24 +04:00			`its logical "root" it will be given server`
			`.Dq Pa "server"`
			`and pathname`
Add a man page and a link for bootparamd(8). 1994-10-03 21:48:40 +03:00			`.Dq Pa "/export/dummy/root"`
			`as the response to its`
			`.Tn RPC`
			`request.`
Add support for globbing when matching the host name in the bootparams(5) file, a'la Solaris. This is extremely useful for configuring Jumpstart servers. From Dan Mercer <dmercer@zembu.com>. 2000-06-28 05:30:56 +04:00			`.Pp`
			`.Bd -literal -offset indent`
			`netra[1-5]www* root=server:/export/jumpstart/netra_www`
			`.Ed`
			`.Pp`
			`When any client with a name matching the pattern "netra[1-5]www*"`
			`requests the pathname for its logical "root" it will be given server`
			`.Dq Pa "server"`
			`and pathname`
			`.Dq Pa "/export/jumpstart/netra_www"`
			`as the response to its`
			`.Tn RPC`
			`request. As this example implies, this is useful for setting up`
			`Jumpstart servers for Sun clients.`
expand a bit on the sematics required. 1997-04-23 04:28:03 +04:00			`.Sh NOTES`
			`The server does not default to the localhost, and must be filled in.`
Fix SEE ALSO and FILES. 1994-10-03 22:26:13 +03:00			`.Sh FILES`
			`.Bl -tag -width /etc/bootparams -compact`
			`.It Pa /etc/bootparams`
			`default configuration file`
			`.El`
change: .Sh "SEE ALSO" to: .Sh SEE ALSO The doc macros check for the latter (actually just for 'SEE' as the first argument to .Sh) to set the section header SEE ALSO flag, which modifies some behaviour (e.g. references done with .Rs/.Re). 1999-04-06 08:54:19 +04:00			`.Sh SEE ALSO`
Add a man page and a link for bootparamd(8). 1994-10-03 21:48:40 +03:00			`.Xr diskless 8 ,`
			`.Xr rpc.bootparamd 8`