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