sbin/mkinitrd/mkinitrd.8

   1 .\"
   2 .\" Copyright (c) 2010 The DragonFly Project.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\"
   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
  12 .\"    the documentation and/or other materials provided with the
  13 .\"    distribution.
  14 .\" 3. Neither the name of The DragonFly Project nor the names of its
  15 .\"    contributors may be used to endorse or promote products derived
  16 .\"    from this software without specific, prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  21 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  22 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  23 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  24 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  25 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  26 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  27 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  28 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .Dd July 1, 2010
  32 .Os
  33 .Dt MKINITRD 8
  34 .Sh NAME
  35 .Nm mkinitrd
  36 .Nd build an initial ramdisk image for use as early userland
  37 .Sh SYNOPSIS
  38 .Nm
  39 .\".Op Ar options ...
  40 .\".Ar target ...
  41 .Sh DESCRIPTION
  42 The
  43 .Nm
  44 script builds a ramdisk (md) image based on the UFS filesystem containing
  45 only the most basic tools, such as a minimal
  46 .Xr init 8 ,
  47 .Xr sh 1
  48 as well as many
  49 .Xr mount 8
  50 utilities.
  51 .Pp
  52 It will also copy the contents of
  53 .Pa /usr/share/initrd
  54 onto the ramdisk, maintaining the same hierarchy.
  55 .Pp
  56 On completion, the final image will be copied to
  57 .Pa /boot/initrd.img ,
  58 ready to be used as an early userland.
  59 .Pp
  60 The
  61 .Nm
  62 script will check for
  63 .Pa /etc/defaults/mkinitrd.conf
  64 and
  65 .Pa /etc/mkinitrd.conf
  66 and include the configuration from these files in the given order, allowing
  67 the user to override or add to the following variables:
  68 .Bd -literal -offset indent
  69 BUILD_DIR
  70 INITRD_SIZE
  71 BIN_TOOLS
  72 SBIN_TOOLS
  73 INITRD_DIRS
  74 CONTENT_DIRS
  75 .Ed
  76 .Pp
  77 Adding the following lines to
  78 .Pa /boot/loader.conf
  79 will enable the use of the created initrd image:
  80 .Bd -literal -offset indent
  81 initrd.img_load="YES"
  82 initrd.img_type="md_image"
  83 vfs.root.mountfrom="ufs:md0s0"
  84 .Ed
  85 .Pp
  86 The format for vfs.root.realroot in
  87 .Pa /boot/loader.conf
  88 that allows the user to specify what system to mount as the
  89 new root in the initrd is specified in its general form below:
  90 .Bd -literal -offset indent
  91 vfs.root.realroot="<type>:[arg1[:arg2[:argN]]]"
  92 .Ed
  93 .Pp
  94 Currently, two types of real root are supported,
  95 .Pa local
  96 and
  97 .Pa crypt .
  98 The
  99 .Pa local
 100 type allows to mount any local file system that does not require any
 101 special setup apart from the initial discovery and calling the
 102 .Pa mount
 103 program. The general format is as follows:
 104 .Bd -literal -offset indent
 105 vfs.root.realroot="local:<FS TYPE>:<DEVICE PATH>[:<OPTIONS>]"
 106 .Ed
 107 .Pp
 108 The
 109 .Pa crypt
 110 type allows to mount volumes supported by cryptsetup. The device will
 111 be set up by prompting the user for his key, and this volume will then
 112 be mounted as the new root.
 113 .Bd -literal -offset indent
 114 vfs.root.realroot="crypt:<FS TYPE>:<DEVICE PATH>:<VOLUME NAME>[:<OPTIONS>]"
 115 .Ed
 116
 117 .Sh EXAMPLES
 118 .Bd -literal -offset indent
 119 vfs.root.realroot="local:ufs:/dev/vg00/lv0[:OPTIONS]"
 120 .Ed
 121 .Bd -literal -offset indent
 122 vfs.root.realroot="crypt:ufs:/dev/ad0s0a:secvolume[:OPTIONS]"
 123 .Ed
 124 .Sh SEE ALSO
 125 .Xr md 4 ,
 126 .Xr loader.conf 5