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