xref: /freebsd/stand/defaults/loader.conf (revision f4a69a933cd645e384b337db5ef2ccf41a1ddd5b)
1b6955dfdSWarner Losh# This is loader.conf - a file full of useful variables that you can
2b6955dfdSWarner Losh# set to change the default load behavior of your system. You should
3b6955dfdSWarner Losh# not edit this file!  Put any overrides into one of the
4b6955dfdSWarner Losh# loader_conf_files instead and you will be able to update these
5b6955dfdSWarner Losh# defaults later without spamming your local configuration information.
6b6955dfdSWarner Losh#
7b6955dfdSWarner Losh# All arguments must be in double quotes.
8b6955dfdSWarner Losh#
9b6955dfdSWarner Losh
10b6955dfdSWarner Losh###  Basic configuration options  ############################
11b6955dfdSWarner Loshexec="echo Loading /boot/defaults/loader.conf"
12b6955dfdSWarner Losh
13b6955dfdSWarner Loshkernel="kernel"		# /boot sub-directory containing kernel and modules
14b6955dfdSWarner Loshbootfile="kernel"	# Kernel name (possibly absolute path)
15b6955dfdSWarner Loshkernel_options=""	# Flags to be passed to the kernel
16c475e61fSStéphane Rochoyloader_conf_files="/boot/device.hints /boot/loader.conf"
1772cf7db3SKyle Evansloader_conf_dirs="/boot/loader.conf.d"
18c475e61fSStéphane Rochoylocal_loader_conf_files="/boot/loader.conf.local"
19b6955dfdSWarner Loshnextboot_conf="/boot/nextboot.conf"
20b6955dfdSWarner Loshverbose_loading="NO"		# Set to YES for verbose loader output
21b6955dfdSWarner Losh
22b6955dfdSWarner Losh###  Splash screen configuration  ############################
23b6955dfdSWarner Loshsplash_bmp_load="NO"		# Set this to YES for bmp splash screen!
24b6955dfdSWarner Loshsplash_pcx_load="NO"		# Set this to YES for pcx splash screen!
25b6955dfdSWarner Loshsplash_txt_load="NO"		# Set this to YES for TheDraw splash screen!
26b6955dfdSWarner Loshvesa_load="NO"			# Set this to YES to load the vesa module
27b6955dfdSWarner Loshbitmap_load="NO"		# Set this to YES if you want splash screen!
28b6955dfdSWarner Loshbitmap_name="splash.bmp"	# Set this to the name of the file
29b6955dfdSWarner Loshbitmap_type="splash_image_data" # and place it on the module_path
30b6955dfdSWarner Losh
313929cadbSWarner Losh###  Screen saver modules  ###################################
323929cadbSWarner Losh# This is best done in rc.conf
333929cadbSWarner Loshscreensave_load="NO"		# Set to YES to load a screensaver module
343929cadbSWarner Loshscreensave_name="green_saver"	# Set to the name of the screensaver module
35b6955dfdSWarner Losh
36c3188289SKyle Evans###  Early hostid configuration ############################
37c3188289SKyle Evanshostuuid_load="YES"
38c3188289SKyle Evanshostuuid_name="/etc/hostid"
39c3188289SKyle Evanshostuuid_type="hostuuid"
40c3188289SKyle Evans
41b6955dfdSWarner Losh###  Random number generator configuration  ##################
42b6955dfdSWarner Losh# See rc.conf(5). The entropy_boot_file config variable must agree with the
43b6955dfdSWarner Losh# settings below.
44b6955dfdSWarner Loshentropy_cache_load="YES"		# Set this to NO to disable loading
455c73b3e0SColin Percival					# cached entropy at boot time
46b6955dfdSWarner Loshentropy_cache_name="/boot/entropy"	# Set this to the name of the file
47b6955dfdSWarner Loshentropy_cache_type="boot_entropy_cache"	# Required for the kernel to find
48b6955dfdSWarner Losh					# the boot-time entropy cache. This
49b6955dfdSWarner Losh					# must not change value even if the
50b6955dfdSWarner Losh					# _name above does change!
515c73b3e0SColin Percivalentropy_efi_seed="YES"			# Set this to NO to disable loading
52*f4a69a93SColin Percival					# entropy from the UEFI hardware
53*f4a69a93SColin Percival					# random number generator API
54*f4a69a93SColin Percivalentropy_efi_seed_size="2048"		# Set this to a different value to
55*f4a69a93SColin Percival					# change the amount of entropy
56*f4a69a93SColin Percival					# requested from EFI
57b6955dfdSWarner Losh
5871dcf98dSWarner Losh###  RAM Blacklist configuration  ############################
5971dcf98dSWarner Loshram_blacklist_load="NO"			# Set this to YES to load a file
60b6955dfdSWarner Losh					# containing a list of addresses to
61b6955dfdSWarner Losh					# exclude from the running system.
6271dcf98dSWarner Loshram_blacklist_name="/boot/blacklist.txt" # Set this to the name of the file
6371dcf98dSWarner Loshram_blacklist_type="ram_blacklist"	# Required for the kernel to find
64b6955dfdSWarner Losh					# the blacklist module
65b6955dfdSWarner Losh
6640dfdf43SMark Johnston###  Microcode loading configuration  ########################
6740dfdf43SMark Johnstoncpu_microcode_load="NO"			# Set this to YES to load and apply a
6840dfdf43SMark Johnston					# microcode update file during boot.
6940dfdf43SMark Johnstoncpu_microcode_name="/boot/firmware/ucode.bin" # Set this to the microcode
7040dfdf43SMark Johnston					      # update file path.
7140dfdf43SMark Johnstoncpu_microcode_type="cpu_microcode"	# Required for the kernel to find
7240dfdf43SMark Johnston					# the microcode update file.
7340dfdf43SMark Johnston
743929cadbSWarner Losh###  ACPI settings  ##########################################
753929cadbSWarner Loshacpi_dsdt_load="NO"		# DSDT Overriding
763929cadbSWarner Loshacpi_dsdt_type="acpi_dsdt"	# Don't change this
773929cadbSWarner Loshacpi_dsdt_name="/boot/acpi_dsdt.aml"
783929cadbSWarner Losh				# Override DSDT in BIOS by this file
793929cadbSWarner Loshacpi_video_load="NO"		# Load the ACPI video extension driver
80b6955dfdSWarner Losh
81deea362cSRobert Watson###  Audit settings  #########################################
82deea362cSRobert Watsonaudit_event_load="NO"		# Preload audit_event config
83deea362cSRobert Watsonaudit_event_name="/etc/security/audit_event"
84deea362cSRobert Watsonaudit_event_type="etc_security_audit_event"
85deea362cSRobert Watson
86b6955dfdSWarner Losh###  Initial memory disk settings  ###########################
87b6955dfdSWarner Losh#mdroot_load="YES"		# The "mdroot" prefix is arbitrary.
88b6955dfdSWarner Losh#mdroot_type="md_image"		# Create md(4) disk at boot.
89b6955dfdSWarner Losh#mdroot_name="/boot/root.img"	# Path to a file containing the image.
90b6955dfdSWarner Losh#rootdev="ufs:/dev/md0"		# Set the root filesystem to md(4) device.
91b6955dfdSWarner Losh
92b6955dfdSWarner Losh###  Loader settings  ########################################
93b6955dfdSWarner Losh#loader_delay="3"		# Delay in seconds before loading anything.
94b6955dfdSWarner Losh				# Default is unset and disabled (no delay).
95b6955dfdSWarner Losh#autoboot_delay="10"		# Delay in seconds before autobooting,
9696378b08SJohn Baldwin				# -1 for no user interrupts, NO to disable
97b6955dfdSWarner Losh#password=""			# Prevent changes to boot options
98b6955dfdSWarner Losh#bootlock_password=""		# Prevent booting (see check-password.4th(8))
99b6955dfdSWarner Losh#geom_eli_passphrase_prompt="NO" # Prompt for geli(8) passphrase to mount root
100b6955dfdSWarner Loshbootenv_autolist="YES"		# Auto populate the list of ZFS Boot Environments
101b6955dfdSWarner Losh#beastie_disable="NO"		# Turn the beastie boot menu on and off
102643dc495SKyle Evansefi_max_resolution="1x1"	# Set the max resolution for EFI loader to use:
1037edbf69bSDag-Erling Smørgrav				# 480p, 720p, 1080p, 1440p, 2160p/4k, 5k, or
10405e8899dSKyle Evans				# WidthxHeight (e.g. 1920x1080)
105b6955dfdSWarner Losh#kernels="kernel kernel.old"	# Kernels to display in the boot menu
106e0a28d24SKyle Evanskernels_autodetect="YES"	# Auto-detect kernel directories in /boot
107b6955dfdSWarner Losh#loader_logo="orbbw"		# Desired logo: orbbw, orb, fbsdbw, beastiebw, beastie, none
1084722ceb7SEd Maste#comconsole_speed="115200"	# Set the current serial console speed
109b6955dfdSWarner Losh#console="vidconsole"		# A comma separated list of console(s)
110b6955dfdSWarner Losh#currdev="disk1s1a"		# Set the current device
111d5a390e6SKyle Evansmodule_path="/boot/modules;/boot/dtb;/boot/dtb/overlays"	# Set the module search path
112532dc172SKyle Evansmodule_blacklist="drm drm2 radeonkms i915kms amdgpu"	# Loader module blacklist
113b6955dfdSWarner Losh#prompt="\\${interpret}"	# Set the command prompt
114b6955dfdSWarner Losh#root_disk_unit="0"		# Force the root disk unit number
115b6955dfdSWarner Losh#rootdev="disk1s1a"		# Set the root filesystem
116b6955dfdSWarner Losh#dumpdev="disk1s1b"		# Set a dump device early in the boot process
117b6955dfdSWarner Losh#tftp.blksize="1428"		# Set the RFC 2348 TFTP block size.
118b6955dfdSWarner Losh				# If the TFTP server does not support RFC 2348,
1193929cadbSWarner Losh				# the block size is set to 512. Valid: (8,9007)
12074578402SColin Percival#twiddle_divisor="16"		# >16 slows down the progress indicator;
12174578402SColin Percival				# <16 speeds up the progress indicator.
122b6955dfdSWarner Losh
123b6955dfdSWarner Losh###  Kernel settings  ########################################
124b6955dfdSWarner Losh# The following boot_ variables are enabled by setting them to any value.
125b6955dfdSWarner Losh# Their presence in the kernel environment (see kenv(1)) has the same
126b6955dfdSWarner Losh# effect as setting the given boot flag (see boot(8)).
127b6955dfdSWarner Losh#boot_askname=""	# -a: Prompt the user for the name of the root device
128b6955dfdSWarner Losh#boot_cdrom=""		# -C: Attempt to mount root file system from CD-ROM
129b6955dfdSWarner Losh#boot_ddb=""		# -d: Instructs the kernel to start in the DDB debugger
130b6955dfdSWarner Losh#boot_dfltroot=""	# -r: Use the statically configured root file system
131b6955dfdSWarner Losh#boot_gdb=""		# -g: Selects gdb-remote mode for the kernel debugger
132b6955dfdSWarner Losh#boot_multicons=""	# -D: Use multiple consoles
133b6955dfdSWarner Losh#boot_mute=""		# -m: Mute the console
134b6955dfdSWarner Losh#boot_pause=""		# -p: Pause after each line during device probing
135b6955dfdSWarner Losh#boot_serial=""		# -h: Use serial console
136b6955dfdSWarner Losh#boot_single=""		# -s: Start system in single-user mode
137b6955dfdSWarner Losh#boot_verbose=""	# -v: Causes extra debugging information to be printed
138b6955dfdSWarner Losh#init_path="/sbin/init:/sbin/oinit:/sbin/init.bak:/rescue/init"
139b6955dfdSWarner Losh			# Sets the list of init candidates
140b6955dfdSWarner Losh#init_shell="/bin/sh"	# The shell binary used by init(8).
141b6955dfdSWarner Losh#init_script=""		# Initial script to run by init(8) before chrooting.
142b6955dfdSWarner Losh#init_chroot=""		# Directory for init(8) to chroot into.
143b6955dfdSWarner Losh
144b6955dfdSWarner Losh###  Kernel tunables  ########################################
145b6955dfdSWarner Losh#hw.physmem="1G"		# Limit physical memory. See loader(8)
146b6955dfdSWarner Losh#kern.dfldsiz=""		# Set the initial data size limit
147b6955dfdSWarner Losh#kern.dflssiz=""		# Set the initial stack size limit
148b6955dfdSWarner Losh#kern.hz="100"			# Set the kernel interval timer rate
149b6955dfdSWarner Losh#kern.maxbcache=""		# Set the max buffer cache KVA storage
150b6955dfdSWarner Losh#kern.maxdsiz=""		# Set the max data size
151b6955dfdSWarner Losh#kern.maxfiles=""		# Set the sys. wide open files limit
152b6955dfdSWarner Losh#kern.maxproc=""		# Set the maximum # of processes
153b6955dfdSWarner Losh#kern.maxssiz=""		# Set the max stack size
154b6955dfdSWarner Losh#kern.maxswzone=""		# Set the max swmeta KVA storage
155b6955dfdSWarner Losh#kern.maxtsiz=""		# Set the max text size
156b6955dfdSWarner Losh#kern.maxusers="32"		# Set size of various static tables
157b6955dfdSWarner Losh#kern.msgbufsize="65536"	# Set size of kernel message buffer
158b6955dfdSWarner Losh#kern.nbuf=""			# Set the number of buffer headers
159b6955dfdSWarner Losh#kern.ncallout=""		# Set the maximum # of timer events
160b6955dfdSWarner Losh#kern.ngroups="1023"		# Set the maximum # of supplemental groups
161b6955dfdSWarner Losh#kern.sgrowsiz=""		# Set the amount to grow stack
162b6955dfdSWarner Losh#kern.cam.boot_delay="10000"	# Delay (in ms) of root mount for CAM bus
163b6955dfdSWarner Losh				# registration, useful for USB sticks as root
164b6955dfdSWarner Losh#kern.cam.scsi_delay="2000"	# Delay (in ms) before probing SCSI
165b6955dfdSWarner Losh#kern.ipc.maxsockets=""		# Set the maximum number of sockets available
166b6955dfdSWarner Losh#kern.ipc.nmbclusters=""	# Set the number of mbuf clusters
167b6955dfdSWarner Losh#kern.ipc.nsfbufs=""		# Set the number of sendfile(2) bufs
168b6955dfdSWarner Losh#net.inet.tcp.tcbhashsize=""	# Set the value of TCBHASHSIZE
1693929cadbSWarner Losh#vfs.root.mountfrom=""		# Specify root partition
170b6955dfdSWarner Losh#vm.kmem_size=""		# Sets the size of kernel memory (bytes)
171b6955dfdSWarner Losh#debug.kdb.break_to_debugger="0" # Allow console to break into debugger.
172b6955dfdSWarner Losh#debug.ktr.cpumask="0xf"	# Bitmask of CPUs to enable KTR on
173b6955dfdSWarner Losh#debug.ktr.mask="0x1200"	# Bitmask of KTR events to enable
174b6955dfdSWarner Losh#debug.ktr.verbose="1"		# Enable console dump of KTR events
175b6955dfdSWarner Losh
176b6955dfdSWarner Losh###  Module loading syntax example  ##########################
177b6955dfdSWarner Losh#module_load="YES"		# loads module "module"
178b6955dfdSWarner Losh#module_name="realname"		# uses "realname" instead of "module"
179b6955dfdSWarner Losh#module_type="type"		# passes "-t type" to load
180b6955dfdSWarner Losh#module_flags="flags"		# passes "flags" to the module
181b6955dfdSWarner Losh#module_before="cmd"		# executes "cmd" before loading the module
182b6955dfdSWarner Losh#module_after="cmd"		# executes "cmd" after loading the module
183b6955dfdSWarner Losh#module_error="cmd"		# executes "cmd" if load fails
184