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