1.\" Copyright (c) 1999 Daniel C. Sobral 2.\" 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.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.\" $FreeBSD: src/sys/boot/forth/loader.conf.5,v 1.18 2002/08/27 01:02:56 trhodes Exp $ 26.Dd October 6, 2010 27.Dt LOADER.CONF 5 28.Os 29.Sh NAME 30.Nm loader.conf 31.Nd system bootstrap configuration information 32.Sh DESCRIPTION 33The file 34.Nm 35contains descriptive information on bootstrapping the system. 36Through it you can specify the kernel to be booted, 37parameters to be passed to it, 38and additional kernel modules to be loaded; 39and generally set all variables described in 40.Xr loader 8 . 41.Pp 42A file 43.Pa dloader.rc 44must contain the following lines for 45.Nm 46to be automatically processed: 47.Pp 48.Dl include defaults/loader.conf 49.Dl optinclude loader.conf 50.Dl optinclude loader.conf.local 51.Pp 52If no 53.Pa /boot/dloader.rc 54exists at installworld time, one with the above lines will be installed. 55.Sh SYNTAX 56Though 57.Nm Ns 's 58format was defined explicitly to resemble 59.Xr rc.conf 5 , 60and can be sourced by 61.Xr sh 1 , 62some settings are treated in a special fashion. 63Also, the behavior of some settings is defined by the setting's suffix; 64the prefix identifies which module the setting controls. 65.Pp 66The general parsing rules are: 67.Bl -bullet 68.It 69Spaces and empty lines are ignored. 70.It 71A 72.Ql # 73sign will mark the remainder of the line as a comment. 74.It 75Only one setting can be present on each line. 76.El 77.Pp 78All settings have the following format: 79.Pp 80.Dl variable="value" 81.Pp 82This assigns value to a local variable. 83If variable is in a list of known kernel environment variables or 84is a kernel tunable, 85it is also assigned to the kernel environment variable of the given name. 86.Pp 87The settings that receive special treatment are listed below. 88Settings beginning with 89.Aq Ar module 90below define the kernel modules to be loaded. 91All such settings sharing a common 92prefix refer to the same module. 93.Bl -tag -width indent 94.It Ar kernel 95Name of the kernel to be loaded. 96If no kernel name is set, no additional 97modules will be loaded. 98.It Ar kernel_options 99Flags to be passed to the kernel (see 100.Xr boot 8 ) . 101.It Ar verbose_loading 102If set to 103.Dq YES , 104module names will be displayed as they are loaded. 105.It Ao Ar module Ac Ns Ar _load 106If set to 107.Dq YES , 108that kernel module will be loaded. 109If no 110.Ao Ar module Ac Ns Ar _name 111is defined (see below), the 112module's name is taken to be 113.Aq Ar module . 114.It Ao Ar module Ac Ns Ar _name 115Defines the name of the module. 116.It Ao Ar module Ac Ns Ar _type 117Defines the module's type. 118If none is given, it defaults to a 119.Xr kld 4 120module. 121.It Ao Ar module Ac Ns Ar _flags 122Flags and parameters to be passed to the module. 123.It Ao Ar module Ac Ns Ar _before 124Commands to be executed before the module is loaded. 125Use of this setting 126should be avoided. 127.It Ao Ar module Ac Ns Ar _after 128Commands to be executed after the module is loaded. 129Use of this setting 130should be avoided. 131.It Ao Ar module Ac Ns Ar _error 132Commands to be executed if the loading of a module fails. 133Except for the 134special value 135.Dq abort , 136which aborts the bootstrap process, use of this setting should be avoided. 137.El 138.Sh DEFAULT SETTINGS 139See 140.Pa /boot/defaults/loader.conf 141for 142.Nm Ns 's 143default settings. 144The few of them which are important 145or useful are: 146.Bl -tag -width indent 147.It Va bitmap_load 148.Pq Dq NO 149If set to 150.Dq YES , 151a bitmap will be loaded to be displayed on screen while booting. 152.It Va bitmap_name 153.Pq Dq splash.bmp 154Name of the bitmap to be loaded. 155Any other name can be used. 156.It Va boot_verbose 157.Pq Dq NO 158Set to 159.Dq YES 160to enable verbose booting. 161.It Va console 162.Pq Dq vidconsole 163.Dq comconsole 164selects serial console, 165.Dq vidconsole 166selects the video console, and 167.Dq nullconsole 168selects a mute console 169(useful for systems with neither a video console nor a serial port). 170.It Va fred_disable 171.Pq Dq NO 172Shows a monochrome version of Fred, the official 173.Dx 174mascot, when the 175boot menu appears. 176To make his life a bit more colorful, consider setting 177.Pa loader_color 178to 179.Dq YES . 180.It Va fred_on_left 181.Pq Dq NO 182Shows Fred on the left side of the menu rather than the right side. 183.It Va kernel 184.Pq Dq kernel . 185.It Va loader_color 186.Pq Dq NO 187If set to 188.Dq YES , 189you'll meet Fred, the official 190.Dx 191mascot, in technicolor when the 192boot menu appears (remember to set 193.Pa fred_disable 194to 195.Dq NO 196for this to work.) 197.It Va splash_bmp_load 198.Pq Dq NO 199If set to 200.Dq YES , 201will load the splash screen module, making it possible to display a bmp image 202on the screen while booting. 203.It Va splash_pcx_load 204.Pq Dq NO 205If set to 206.Dq YES , 207will load the splash screen module, making it possible to display a pcx image 208on the screen while booting. 209.It Va userconfig_script_load 210.Pq Dq NO 211If set to 212.Dq YES , 213will load the userconfig data. 214.It Va vesa_load 215.Pq Dq NO 216If set to 217.Dq YES , 218the vesa module will be loaded, enabling bitmaps above VGA resolution to 219be displayed. 220.El 221.Sh FILES 222.Bl -tag -width ".Pa /boot/defaults/dloader.menu" -compact 223.It Pa /boot/defaults/dloader.menu 224default settings for menu setup -- do not change this file. 225.It Pa /boot/defaults/loader.conf 226default settings -- do not change this file. 227.It Pa /boot/dloader.menu 228defines the commands used by 229.Nm loader 230to setup menus. 231.It Pa /boot/loader.conf 232user defined settings. 233.It Pa /boot/loader.conf.local 234machine-specific settings for sites with a common loader.conf. 235.It Pa /boot/dloader.rc 236contains the instructions to automatically process. 237.El 238.Sh SEE ALSO 239.Xr boot 8 , 240.Xr loader 8 241.Sh HISTORY 242The file 243.Nm 244first appeared in 245.Fx 3.2 . 246.Sh AUTHORS 247This manual page was written by 248.An Daniel C. Sobral Aq dcs@FreeBSD.org . 249
