xref: /freebsd/usr.sbin/bootparamd/bootparamd/bootparams.5 (revision 3078531de10dcae44b253a35125c949ff4235284)
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.\" $FreeBSD$
29.\"
30.Dd October 2, 1994
31.Dt BOOTPARAMS 5
32.Os
33.Sh NAME
34.Nm bootparams
35.Nd boot parameter database
36.Sh SYNOPSIS
37.Nm /etc/bootparams
38.Sh DESCRIPTION
39The
40.Nm
41file specifies the boot parameters that
42.Xr diskless 8
43clients may request when booting over the network.
44Each client supported by this server must have an entry in the
45.Nm
46file containing the pathnames for its
47.Dq root
48and (optionally)
49.Dq swap
50areas.
51.Pp
52Each line in the file
53(other than comment lines that begin with a
54.Ql # )
55specifies the client name followed by the pathnames that
56the client may request by their logical names.
57The components of the line are delimited with blank or tab,
58and may be continued onto multiple lines with a backslash.
59.Pp
60For example:
61.Bd -literal -offset indent
62dummy	root=host:/export/dummy/root \\
63	swap=host:/export/dummy/swap \\
64	dump=host:/export/dummy/swap
65.Ed
66.Pp
67When the client named
68.Dq dummy
69requests the pathname for its logical
70.Dq root
71it will be given the pathname
72.Dq Pa host:/export/dummy/root
73as the response to its
74.Tn RPC
75request.
76The
77.Dq host:
78component must be supplied.
79.Sh FILES
80.Bl -tag -width /etc/bootparams -compact
81.It Pa /etc/bootparams
82default configuration file
83.El
84.Sh SEE ALSO
85.Xr bootparamd 8 ,
86.Xr diskless 8
87