Differential D3524 Diff 8318 sys/boot/forth/loader.conf.5

Changeset View

Standalone View

sys/boot/forth/loader.conf.5

	Show All 17 Lines
	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS			.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)			.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT			.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY			.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF			.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	.\" SUCH DAMAGE.			.\" SUCH DAMAGE.
	.\"			.\"
	.\" $FreeBSD$			.\" $FreeBSD$
	.Dd April 27, 2014			.Dd April 27, 2014
				wblockUnsubmitted Not Done Inline Actions Remember to update this. wblock: Remember to update this.
	.Dt LOADER.CONF 5			.Dt LOADER.CONF 5
	.Os			.Os
	.Sh NAME			.Sh NAME
	.Nm loader.conf			.Nm loader.conf
	.Nd "system bootstrap configuration information"			.Nd "system bootstrap configuration information"
	.Sh DESCRIPTION			.Sh DESCRIPTION
	The file			The file
				wblockUnsubmitted Not Done Inline Actions The wblock: ```The```
	.Nm			.Nm
	contains descriptive information on bootstrapping the system.			contains descriptive information on bootstrapping the system.
				wblockUnsubmitted Not Done Inline Actions file contains settings for bootstrapping the system. wblock: ```file contains settings for bootstrapping the system.```
	Through			Through
				wblockUnsubmitted Not Done Inline Actions Delete. wblock: Delete.
	it you can specify the kernel to be booted, parameters to be passed to			it you can specify the kernel to be booted, parameters to be passed to
				wblockUnsubmitted Not Done Inline Actions Settings in this file can specify the kernel to be booted, parameters to be passed to wblock: ```Settings in this file can specify the kernel to be booted, parameters to be passed to```
	it, and additional modules to be loaded; and generally set all variables			it, and additional modules to be loaded; and generally set all variables
				wblockUnsubmitted Not Done Inline Actions the kernel, and additional modules to be loaded. Most variables described in .Xr loader 8 can also be set here.`` wblock: ```the kernel, and additional modules to be loaded. Most variables described in .Xr loader 8…
	described in			described in
				wblockUnsubmitted Not Done Inline Actions Delete. wblock: Delete.
	.Xr loader 8 .			.Xr loader 8 .
				wblockUnsubmitted Not Done Inline Actions Delete. wblock: Delete.
	.Pp			.Pp
	The file			The file
				wblockUnsubmitted Not Done Inline Actions The wblock: ```The```
	.Pa /boot/loader.rc			.Pa /boot/loader.rc
	must contain the following two lines for			must contain the following two lines for
				wblockUnsubmitted Not Done Inline Actions file must contain these two lines for wblock: ```file must contain these two lines for```
	.Nm			.Nm
	to be automatically processed:			to be automatically processed:
	.Pp			.Pp
	.Dl include /boot/loader.4th			.Dl include /boot/loader.4th
	.Dl start			.Dl start
	.Pp			.Pp
	If no			If no
				wblockUnsubmitted Not Done Inline Actions If wblock: ```If```
	.Pa /boot/loader.rc			.Pa /boot/loader.rc
	exists at installworld time, one with the above lines will be installed.			exists at installworld time, one with the above lines will be installed.
				wblockUnsubmitted Not Done Inline Actions does not exist at installworld time, one with the above lines will be installed. wblock: ```does not exist at installworld time, one with the above lines will be installed.```
	.Sh SYNTAX			.Sh SYNTAX
	Though			Though
	.Nm Ns 's			.Nm Ns 's
	format was defined explicitly to resemble			format was defined explicitly to resemble
	.Xr rc.conf 5 ,			.Xr rc.conf 5 ,
	and can be sourced by			and can be sourced by
	.Xr sh 1 ,			.Xr sh 1 ,
	some settings are treated in a special fashion.			some settings are treated in a special fashion.
	Also, the			Also, the
	behavior of some settings is defined by the setting's suffix;			behavior of some settings is defined by the setting's suffix;
				wblockUnsubmitted Not Done Inline Actions Break sentence: behavior of some settings is defined by the setting's suffix. wblock: Break sentence: ```behavior of some settings is defined by the setting's suffix.```
	the prefix identifies which module the setting controls.			the prefix identifies which module the setting controls.
				wblockUnsubmitted Not Done Inline Actions s/the/The/ wblock: s/the/The/
	.Pp			.Pp
	The general parsing rules are:			The general parsing rules are:
	.Bl -bullet			.Bl -bullet
	.It			.It
	Spaces and empty lines are ignored.			Spaces and empty lines are ignored.
	.It			.It
	A # sign will mark the remainder of the line as a comment.			A # sign will mark the remainder of the line as a comment.
				wblockUnsubmitted Not Done Inline Actions s/will mark/marks/ wblock: s/will mark/marks/
	.It			.It
	Only one setting can be present on each line.			Only one setting can be present on each line.
	.El			.El
	.Pp			.Pp
	All settings have the following format:			All settings have the following format:
				wblockUnsubmitted Not Done Inline Actions s/the following/this/ wblock: s/the following/this/
	.Pp			.Pp
	.Dl variable="value"			.Dl variable="value"
	.Pp			.Pp
	Unless it belongs to one of the classes of settings that receive special			Unless it belongs to one of the classes of settings that receive special
	treatment, a setting will set the value of a			treatment, a setting will set the value of a
	.Xr loader 8			.Xr loader 8
	environment variable.			environment variable.
	The settings that receive special			The settings that receive special
	treatment are listed below.			treatment are listed below.
	Settings beginning with			Settings beginning with
	.Qq *			.Qq *
	below define the modules to be loaded and			below define the modules to be loaded and
	may have any prefix; the prefix identifies a module.			may have any prefix; the prefix identifies a module.
	All such settings sharing a common			All such settings sharing a common
	prefix refer to the same module.			prefix refer to the same module.
	.Bl -tag -width Ar			.Bl -tag -width Ar
	.It Ar exec			.It Ar exec
	Immediately executes a			Immediately executes a
				wblockUnsubmitted Not Done Inline Actions s/executes/execute/ wblock: s/executes/execute/
	.Xr loader 8			.Xr loader 8
	command.			command.
	This type of setting cannot be processed by programs other			This type of setting cannot be processed by programs other
	than			than
	.Xr loader 8 ,			.Xr loader 8 ,
	so its use should be avoided.			so its use should be avoided.
	Multiple instances of it will be processed			Multiple instances of it will be processed
	independently.			independently.
	.It Ar loader_conf_files			.It Ar loader_conf_files
	Defines additional configuration files to be processed right after the			Defines additional configuration files to be processed right after the
				wblockUnsubmitted Not Done Inline Actions s/Defines/Define/ wblock: s/Defines/Define/
	present file.			present file.
	.It Ar kernel			.It Ar kernel
	Name of the kernel to be loaded.			Name of the kernel to be loaded.
	If no kernel name is set, no additional			If no kernel name is set, no additional
	modules will be loaded.			modules will be loaded.
	The name must be a subdirectory of			The name must be a subdirectory of
	.Pa /boot			.Pa /boot
	that contains a kernel.			that contains a kernel.
	.It Ar kernel_options			.It Ar kernel_options
	Flags to be passed to the kernel.			Flags to be passed to the kernel.
	.It Ar password			.It Ar password
	Protect boot menu with a password without interrupting			Protect boot menu with a password without interrupting
				wblockUnsubmitted Not Done Inline Actions s/boot/the boot/ s/interrupting/interrupting the/ wblock: s/boot/the boot/ s/interrupting/interrupting the/
	.Ic autoboot			.Ic autoboot
	process.			process.
	The password should be in clear text format.			The password should be in clear text format.
	If a password is set, boot menu will not appear until any key is pressed during			If a password is set, boot menu will not appear until any key is pressed during
				wblockUnsubmitted Not Done Inline Actions If a password is set, the boot menu will not appear until a key is pressed during wblock: ```If a password is set, the boot menu will not appear until a key is pressed during```
	countdown period specified by			countdown period specified by
				wblockUnsubmitted Not Done Inline Actions the countdown period specified by the wblock: ```the countdown period specified by the```
	.Va autoboot_delay			.Va autoboot_delay
	variable or			variable or
				wblockUnsubmitted Not Done Inline Actions variable or the wblock: ```variable or the```
	.Ic autoboot			.Ic autoboot
	process fails.			process fails.
	In both cases user should provide specified password to be able to access boot			In both cases user should provide specified password to be able to access boot
				wblockUnsubmitted Not Done Inline Actions In both cases, the user must provide the password to be able to access the boot wblock: ```In both cases, the user must provide the password to be able to access the boot```
	menu.			menu.
	.It Ar bootlock_password			.It Ar bootlock_password
	Provides a password to be required by check-password before execution is			Provides a password to be required by check-password before execution is
				wblockUnsubmitted Not Done Inline Actions s/Provides/Set/ wblock: s/Provides/Set/
	allowed to continue.			allowed to continue.
	The password should be in clear text format.			The password should be in clear text format.
	If a password is set, the user must provide specified password to boot.			If a password is set, the user must provide specified password to boot.
				wblockUnsubmitted Not Done Inline Actions If a password is set, the user must enter the password to boot. wblock: ```If a password is set, the user must enter the password to boot.```
				.It Ar geom_eli_passphrase_prompt
				Prompt the user for the GELI passphrase at the loader menu.
				Without this option the user will be prompted for a passphrase just
				wblockUnsubmitted Not Done Inline Actions Needs a comma after "option", but saying "without this option" is kind of confusing anyway. Delay prompting for the GELI passphrase until the loader menu is shown.``` (Is it really when the loader menu is shown, or just before?) ```The default behavior without this option is to prompt for the GELI passphrase just This could be reversed: explain the default behavior first, then say that this option can be added so the prompt is displayed later. wblock: Needs a comma after "option", but saying "without this option" is kind of confusing anyway.
				before the root partition is mounted, where the prompt can become
				obscured by late device attachment messages.
	.It Ar verbose_loading			.It Ar verbose_loading
	If set to			If set to
	.Dq YES ,			.Dq YES ,
	module names will be displayed as they are loaded.			module names will be displayed as they are loaded.
	.It Ar *_load			.It Ar *_load
	If set to			If set to
	.Dq YES ,			.Dq YES ,
	that module will be loaded.			that module will be loaded.
	If no name is defined (see below), the			If no name is defined (see below), the
	module's name is taken to be the same as the prefix.			module's name is taken to be the same as the prefix.
	.It Ar *_name			.It Ar *_name
	Defines the name of the module.			Defines the name of the module.
				wblockUnsubmitted Not Done Inline Actions s/Defines/Define/ wblock: s/Defines/Define/
	.It Ar *_type			.It Ar *_type
	Defines the module's type.			Defines the module's type.
				wblockUnsubmitted Not Done Inline Actions s/Defines/Define/ wblock: s/Defines/Define/
	If none is given, it defaults to a kld module.			If none is given, it defaults to a kld module.
	.It Ar *_flags			.It Ar *_flags
	Flags and parameters to be passed to the module.			Flags and parameters to be passed to the module.
	.It Ar *_before			.It Ar *_before
	Commands to be executed before the module is loaded.			Commands to be executed before the module is loaded.
	Use of this setting			Use of this setting
	should be avoided.			should be avoided.
	.It Ar *_after			.It Ar *_after
	Show All 10 Lines
	.Pp			.Pp
	.Em WARNING:			.Em WARNING:
	developers should never use these suffixes for any kernel environment			developers should never use these suffixes for any kernel environment
	variables (tunables) or conflicts will result.			variables (tunables) or conflicts will result.
	.Sh DEFAULT SETTINGS			.Sh DEFAULT SETTINGS
	Most of			Most of
	.Nm Ns 's			.Nm Ns 's
	default settings can be ignored.			default settings can be ignored.
	The few of them which are important			The few of them which are important
				wblockUnsubmitted Not Done Inline Actions s/of them// wblock: s/of them//
	or useful are:			or useful are:
	.Bl -tag -width bootfile -offset indent			.Bl -tag -width bootfile -offset indent
	.It Va bitmap_load			.It Va bitmap_load
	.Pq Dq NO			.Pq Dq NO
	If set to			If set to
	.Dq YES ,			.Dq YES ,
	a bitmap will be loaded to be displayed on screen while booting.			a bitmap will be loaded to be displayed on screen while booting.
	.It Va bitmap_name			.It Va bitmap_name
	.Pq Dq Pa /boot/splash.bmp			.Pq Dq Pa /boot/splash.bmp
	Name of the bitmap to be loaded.			Name of the bitmap to be loaded.
	Any other name can be used.			Any other name can be used.
	.It Va comconsole_speed			.It Va comconsole_speed
	.Dq ( 9600			.Dq ( 9600
	or the value of the			or the value of the
	.Va BOOT_COMCONSOLE_SPEED			.Va BOOT_COMCONSOLE_SPEED
	variable when			variable when
	.Xr loader 8			.Xr loader 8
	was compiled).			was compiled).
	Sets the speed of the serial console.			Sets the speed of the serial console.
				wblockUnsubmitted Not Done Inline Actions s/Sets/Set/ wblock: s/Sets/Set/
	If the previous boot loader stage specified that a serial console			If the previous boot loader stage specified that a serial console
	is in use then the default speed is determined from the current			is in use then the default speed is determined from the current
				wblockUnsubmitted Not Done Inline Actions s/use/use,/ wblock: s/use/use,/
	serial port speed setting.			serial port speed setting.
				wblockUnsubmitted Not Done Inline Actions "setting" is probably not needed here. wblock: "setting" is probably not needed here.
	.It Va console			.It Va console
	.Pq Dq vidconsole			.Pq Dq vidconsole
	.Dq comconsole			.Dq comconsole
	selects serial console,			selects serial console,
				wblockUnsubmitted Not Done Inline Actions s/selects/selects the/ wblock: s/selects/selects the/
	.Dq vidconsole			.Dq vidconsole
	selects the video console,			selects the video console,
	.Dq nullconsole			.Dq nullconsole
	selects a mute console			selects a mute console
	(useful for systems with neither a video console nor a serial port), and			(useful for systems with neither a video console nor a serial port), and
	.Dq spinconsole			.Dq spinconsole
	selects the video console which prevents any input and hides all output			selects the video console which prevents any input and hides all output
	replacing it with			replacing it with
				wblockUnsubmitted Not Done Inline Actions s/with/with a/ wblock: s/with/with a/
	.Dq spinning			.Dq spinning
	character (useful for embedded products and such).			character (useful for embedded products and such).
	.It Va kernel			.It Va kernel
	.Pq Dq kernel			.Pq Dq kernel
	.It Va kernels			.It Va kernels
	.Pq Dq kernel kernel.old			.Pq Dq kernel kernel.old
	Space or comma separated list of kernels to present in the boot menu.			Space or comma separated list of kernels to present in the boot menu.
	.It Va loader_conf_files			.It Va loader_conf_files
	.Pq Dq Pa /boot/loader.conf /boot/loader.conf.local			.Pq Dq Pa /boot/loader.conf /boot/loader.conf.local
	.It Va splash_bmp_load			.It Va splash_bmp_load
	.Pq Dq NO			.Pq Dq NO
	If set to			If set to
	.Dq YES ,			.Dq YES ,
	will load the splash screen module, making it possible to display a bmp image			will load the splash screen module, making it possible to display a bmp image
				wblockUnsubmitted Not Done Inline Actions s/will load/load/ wblock: s/will load/load/
	on the screen while booting.			on the screen while booting.
	.It Va splash_pcx_load			.It Va splash_pcx_load
	.Pq Dq NO			.Pq Dq NO
	If set to			If set to
	.Dq YES ,			.Dq YES ,
	will load the splash screen module, making it possible to display a pcx image			will load the splash screen module, making it possible to display a pcx image
				wblockUnsubmitted Not Done Inline Actions s/will load/load/ wblock: s/will load/load/
	on the screen while booting.			on the screen while booting.
	.It Va vesa_load			.It Va vesa_load
	.Pq Dq NO			.Pq Dq NO
	If set to			If set to
	.Dq YES ,			.Dq YES ,
	the vesa module will be loaded, enabling bitmaps above VGA resolution to			the vesa module will be loaded, enabling bitmaps above VGA resolution to
				wblockUnsubmitted Not Done Inline Actions s/will be/is/ s/higher/with higher than/ wblock: s/will be/is/ s/higher/with higher than/
	be displayed.			be displayed.
	.It Va beastie_disable			.It Va beastie_disable
	If set to			If set to
	.Dq YES ,			.Dq YES ,
	the beastie boot menu will be skipped.			the beastie boot menu will be skipped.
				wblockUnsubmitted Not Done Inline Actions s/will be/is/ wblock: s/will be/is/
	The beastie boot menu is always skipped if booting UEFI or running non-x86			The beastie boot menu is always skipped if booting UEFI or running non-x86
	hardware.			hardware.
	.It Va loader_logo Pq Dq Li orbbw			.It Va loader_logo Pq Dq Li orbbw
	Selects a desired logo in the beastie boot menu.			Selects a desired logo in the beastie boot menu.
				wblockUnsubmitted Not Done Inline Actions s/Selects/Select/ wblock: s/Selects/Select/
	Possible values are:			Possible values are:
	.Dq Li orbbw ,			.Dq Li orbbw ,
	.Dq Li orb ,			.Dq Li orb ,
	.Dq Li fbsdbw ,			.Dq Li fbsdbw ,
	.Dq Li beastiebw ,			.Dq Li beastiebw ,
	.Dq Li beastie ,			.Dq Li beastie ,
	and			and
	.Dq Li none .			.Dq Li none .
	.It Va loader_color			.It Va loader_color
	If set to			If set to
	.Dq NO ,			.Dq NO ,
	the beastie boot menu will be displayed without ANSI coloring.			the beastie boot menu will be displayed without ANSI coloring.
				wblockUnsubmitted Not Done Inline Actions s/will be/is/ wblock: s/will be/is/
	.It Va entropy_cache_load			.It Va entropy_cache_load
	.Pq Dq YES			.Pq Dq YES
	If set to			If set to
	.Dq NO ,			.Dq NO ,
	the very early			the very early
	boot-time entropy file			boot-time entropy file
	will not be loaded.			will not be loaded.
				wblockUnsubmitted Not Done Inline Actions s/will not/is not/ wblock: s/will not/is not/
	See the entropy entries in			See the entropy entries in
	.Xr rc.conf 5 .			.Xr rc.conf 5 .
	.It Va entropy_cache_name			.It Va entropy_cache_name
	.Pq Dq /boot/entropy			.Pq Dq /boot/entropy
	The name of the very early			The name of the very early
	boot-time entropy cache file.			boot-time entropy cache file.
	.El			.El
	.Sh FILES			.Sh FILES
	Show All 25 Lines
	This manual page was written by			This manual page was written by
	.An Daniel C. Sobral Aq dcs@FreeBSD.org .			.An Daniel C. Sobral Aq dcs@FreeBSD.org .
	.Sh BUGS			.Sh BUGS
	The			The
	.Xr loader 8			.Xr loader 8
	stops reading			stops reading
	.Nm			.Nm
	when it encounters a syntax error, so any options which are vital for			when it encounters a syntax error, so any options which are vital for
	booting a particular system (i.e.\&			booting a particular system (i.e.\&
				wblockUnsubmitted Not Done Inline Actions booting a particular system (such as wblock: ```booting a particular system (such as```
	.Dq Va hw.ata.ata_dma Ns "=0" )			.Dq Va hw.ata.ata_dma Ns "=0" )
	should precede any experimental additions to			should precede any experimental additions to
	.Nm .			.Nm .