usr.sbin/bootparamd/bootparamd/bootparams.5

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