xref: /openbsd-src/usr.sbin/rpc.bootparamd/bootparams.5 (revision f2da64fbbbf1b03f09f390ab01267c93dfd77c4c)
1.\" $OpenBSD: bootparams.5,v 1.11 2014/02/12 17:12:53 schwarze 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 $Mdocdate: February 12 2014 $
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 bootparams
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 bootparams
44file containing the pathnames for its "root" and (optionally) "swap" areas.
45.Pp
46Each line in the file
47(other than comment lines that begin with a
48.Sq # )
49specifies the client name followed by the pathnames that
50the client may request by their logical names.
51The components of the line are delimited with blank or tab,
52and may be continued onto multiple lines with a backslash.
53.Pp
54For example:
55.Bd -literal -offset indent
56client	root=server:/export/client/root \e
57	swap=server:/export/client/swap \e
58	dump=server:/export/client/swap
59.Ed
60.Pp
61When the client named "client" requests the pathname for
62its logical "root" it will be given the server name "server"
63and the pathname
64.Pa /export/client/root
65as the response to its
66.Tn RPC
67request.
68.Pp
69A line containing simply
70.Sq +
71will cause YP lookups to be done on the YP map "bootparams".
72.Sh FILES
73.Bl -tag -width /etc/bootparams -compact
74.It Pa /etc/bootparams
75default configuration file
76.El
77.Sh SEE ALSO
78.Xr diskless 8 ,
79.Xr rpc.bootparamd 8 ,
80.Xr yp 8
81