1.\"	$NetBSD: bootparams.5,v 1.11 2002/02/28 01:19:48 lukem Exp $
2.\"
3.\" Copyright (c) 1994 Gordon W. Ross
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. The name of the author may not be used to endorse or promote products
15.\"    derived from this software without specific prior written permission.
16.\"
17.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27.\"
28.Dd February 28, 2002
29.Dt BOOTPARAMS 5
30.Os
31.Sh NAME
32.Nm bootparams
33.Nd boot parameter database
34.Sh SYNOPSIS
35.Nm /etc/bootparams
36.Sh DESCRIPTION
37The
38.Nm
39file specifies the boot parameters that
40.Xr diskless 8
41clients may request when booting over the network.
42Each client supported by this server must have an entry in the
43.Nm
44file containing the servers and pathnames for its
45.Pa root ,
46area.  It may optionally contain
47.Pa swap ,
48.Pa dump ,
49and other entry types.
50.Pp
51Each line in the file
52(other than comment lines that begin with a #)
53specifies the client name followed by the pathnames that
54the client may request by their logical names.  Names
55are matched in a case-insensitive fashion, and may also
56be wildcarded using shell-style globbing characters.
57.Pp
58The components of the line are delimited with blank or tab,
59and may be continued onto multiple lines with a backslash.
60.Pp
61For example:
62.Bd -literal -offset indent
63dummy	root=server:/export/dummy/root \\
64	swap=server:/export/dummy/swap \\
65	dump=server:/export/dummy/swap \\
66	gateway=router:255.255.255.0
67.Ed
68.Pp
69When the client named "dummy" requests the pathname for
70its logical "root" it will be given server
71.Dq Pa "server"
72and pathname
73.Dq Pa "/export/dummy/root"
74as the response to its
75.Tn RPC
76request.
77.Pp
78.Bd -literal -offset indent
79netra[1-5]www*	root=server:/export/jumpstart/netra_www
80.Ed
81.Pp
82When any client with a name matching the pattern "netra[1-5]www*"
83requests the pathname for its logical "root" it will be given server
84.Dq Pa "server"
85and pathname
86.Dq Pa "/export/jumpstart/netra_www"
87as the response to its
88.Tn RPC
89request.  As this example implies, this is useful for setting up
90Jumpstart servers for Sun clients.
91.Sh NOTES
92The server does not default to the localhost, and must be filled in.
93.Sh FILES
94.Bl -tag -width /etc/bootparams -compact
95.It Pa /etc/bootparams
96default configuration file
97.El
98.Sh SEE ALSO
99.Xr diskless 8 ,
100.Xr rpc.bootparamd 8
101