xref: /freebsd/stand/defaults/loader.conf (revision 8ddb146abcdf061be9f2c0db7e391697dafad85c)
1# This is loader.conf - a file full of useful variables that you can
2# set to change the default load behavior of your system. You should
3# not edit this file!  Put any overrides into one of the
4# loader_conf_files instead and you will be able to update these
5# defaults later without spamming your local configuration information.
6#
7# All arguments must be in double quotes.
8#
9# $FreeBSD$
10
11###  Basic configuration options  ############################
12exec="echo Loading /boot/defaults/loader.conf"
13
14kernel="kernel"		# /boot sub-directory containing kernel and modules
15bootfile="kernel"	# Kernel name (possibly absolute path)
16kernel_options=""	# Flags to be passed to the kernel
17loader_conf_files="/boot/device.hints /boot/loader.conf /boot/loader.conf.local"
18loader_conf_dirs="/boot/loader.conf.d"
19nextboot_conf="/boot/nextboot.conf"
20verbose_loading="NO"		# Set to YES for verbose loader output
21
22###  Splash screen configuration  ############################
23splash_bmp_load="NO"		# Set this to YES for bmp splash screen!
24splash_pcx_load="NO"		# Set this to YES for pcx splash screen!
25splash_txt_load="NO"		# Set this to YES for TheDraw splash screen!
26vesa_load="NO"			# Set this to YES to load the vesa module
27bitmap_load="NO"		# Set this to YES if you want splash screen!
28bitmap_name="splash.bmp"	# Set this to the name of the file
29bitmap_type="splash_image_data" # and place it on the module_path
30
31###  Screen saver modules  ###################################
32# This is best done in rc.conf
33screensave_load="NO"		# Set to YES to load a screensaver module
34screensave_name="green_saver"	# Set to the name of the screensaver module
35
36###  Early hostid configuration ############################
37hostuuid_load="YES"
38hostuuid_name="/etc/hostid"
39hostuuid_type="hostuuid"
40
41###  Random number generator configuration  ##################
42# See rc.conf(5). The entropy_boot_file config variable must agree with the
43# settings below.
44entropy_cache_load="YES"		# Set this to NO to disable loading
45					# cached entropy at boot time
46entropy_cache_name="/boot/entropy"	# Set this to the name of the file
47entropy_cache_type="boot_entropy_cache"	# Required for the kernel to find
48					# the boot-time entropy cache. This
49					# must not change value even if the
50					# _name above does change!
51entropy_efi_seed="YES"		# Set this to NO to disable loading
52					# entropy from the UEFI hardware random number generator API
53
54###  RAM Blacklist configuration  ############################
55ram_blacklist_load="NO"			# Set this to YES to load a file
56					# containing a list of addresses to
57					# exclude from the running system.
58ram_blacklist_name="/boot/blacklist.txt" # Set this to the name of the file
59ram_blacklist_type="ram_blacklist"	# Required for the kernel to find
60					# the blacklist module
61
62###  Microcode loading configuration  ########################
63cpu_microcode_load="NO"			# Set this to YES to load and apply a
64					# microcode update file during boot.
65cpu_microcode_name="/boot/firmware/ucode.bin" # Set this to the microcode
66					      # update file path.
67cpu_microcode_type="cpu_microcode"	# Required for the kernel to find
68					# the microcode update file.
69
70###  ACPI settings  ##########################################
71acpi_dsdt_load="NO"		# DSDT Overriding
72acpi_dsdt_type="acpi_dsdt"	# Don't change this
73acpi_dsdt_name="/boot/acpi_dsdt.aml"
74				# Override DSDT in BIOS by this file
75acpi_video_load="NO"		# Load the ACPI video extension driver
76
77###  Audit settings  #########################################
78audit_event_load="NO"		# Preload audit_event config
79audit_event_name="/etc/security/audit_event"
80audit_event_type="etc_security_audit_event"
81
82###  Initial memory disk settings  ###########################
83#mdroot_load="YES"		# The "mdroot" prefix is arbitrary.
84#mdroot_type="md_image"		# Create md(4) disk at boot.
85#mdroot_name="/boot/root.img"	# Path to a file containing the image.
86#rootdev="ufs:/dev/md0"		# Set the root filesystem to md(4) device.
87
88###  Loader settings  ########################################
89#loader_delay="3"		# Delay in seconds before loading anything.
90				# Default is unset and disabled (no delay).
91#autoboot_delay="10"		# Delay in seconds before autobooting,
92				# -1 for no user interrupts, NO to disable
93#password=""			# Prevent changes to boot options
94#bootlock_password=""		# Prevent booting (see check-password.4th(8))
95#geom_eli_passphrase_prompt="NO" # Prompt for geli(8) passphrase to mount root
96bootenv_autolist="YES"		# Auto populate the list of ZFS Boot Environments
97#beastie_disable="NO"		# Turn the beastie boot menu on and off
98efi_max_resolution="1x1"	# Set the max resolution for EFI loader to use:
99				# 480p, 720p, 1080p, 2160p/4k, 5k, or specify
100				# WidthxHeight (e.g. 1920x1080)
101#kernels="kernel kernel.old"	# Kernels to display in the boot menu
102kernels_autodetect="YES"	# Auto-detect kernel directories in /boot
103#loader_logo="orbbw"		# Desired logo: orbbw, orb, fbsdbw, beastiebw, beastie, none
104#comconsole_speed="9600"	# Set the current serial console speed
105#console="vidconsole"		# A comma separated list of console(s)
106#currdev="disk1s1a"		# Set the current device
107module_path="/boot/modules;/boot/dtb;/boot/dtb/overlays"	# Set the module search path
108module_blacklist="drm drm2 radeonkms i915kms amdgpu"	# Loader module blacklist
109#prompt="\\${interpret}"	# Set the command prompt
110#root_disk_unit="0"		# Force the root disk unit number
111#rootdev="disk1s1a"		# Set the root filesystem
112#dumpdev="disk1s1b"		# Set a dump device early in the boot process
113#tftp.blksize="1428"		# Set the RFC 2348 TFTP block size.
114				# If the TFTP server does not support RFC 2348,
115				# the block size is set to 512. Valid: (8,9007)
116#twiddle_divisor="16"		# >16 slows down the progress indicator;
117				# <16 speeds up the progress indicator.
118
119###  Kernel settings  ########################################
120# The following boot_ variables are enabled by setting them to any value.
121# Their presence in the kernel environment (see kenv(1)) has the same
122# effect as setting the given boot flag (see boot(8)).
123#boot_askname=""	# -a: Prompt the user for the name of the root device
124#boot_cdrom=""		# -C: Attempt to mount root file system from CD-ROM
125#boot_ddb=""		# -d: Instructs the kernel to start in the DDB debugger
126#boot_dfltroot=""	# -r: Use the statically configured root file system
127#boot_gdb=""		# -g: Selects gdb-remote mode for the kernel debugger
128#boot_multicons=""	# -D: Use multiple consoles
129#boot_mute=""		# -m: Mute the console
130#boot_pause=""		# -p: Pause after each line during device probing
131#boot_serial=""		# -h: Use serial console
132#boot_single=""		# -s: Start system in single-user mode
133#boot_verbose=""	# -v: Causes extra debugging information to be printed
134#init_path="/sbin/init:/sbin/oinit:/sbin/init.bak:/rescue/init"
135			# Sets the list of init candidates
136#init_shell="/bin/sh"	# The shell binary used by init(8).
137#init_script=""		# Initial script to run by init(8) before chrooting.
138#init_chroot=""		# Directory for init(8) to chroot into.
139
140###  Kernel tunables  ########################################
141#hw.physmem="1G"		# Limit physical memory. See loader(8)
142#kern.dfldsiz=""		# Set the initial data size limit
143#kern.dflssiz=""		# Set the initial stack size limit
144#kern.hz="100"			# Set the kernel interval timer rate
145#kern.maxbcache=""		# Set the max buffer cache KVA storage
146#kern.maxdsiz=""		# Set the max data size
147#kern.maxfiles=""		# Set the sys. wide open files limit
148#kern.maxproc=""		# Set the maximum # of processes
149#kern.maxssiz=""		# Set the max stack size
150#kern.maxswzone=""		# Set the max swmeta KVA storage
151#kern.maxtsiz=""		# Set the max text size
152#kern.maxusers="32"		# Set size of various static tables
153#kern.msgbufsize="65536"	# Set size of kernel message buffer
154#kern.nbuf=""			# Set the number of buffer headers
155#kern.ncallout=""		# Set the maximum # of timer events
156#kern.ngroups="1023"		# Set the maximum # of supplemental groups
157#kern.sgrowsiz=""		# Set the amount to grow stack
158#kern.cam.boot_delay="10000"	# Delay (in ms) of root mount for CAM bus
159				# registration, useful for USB sticks as root
160#kern.cam.scsi_delay="2000"	# Delay (in ms) before probing SCSI
161#kern.ipc.maxsockets=""		# Set the maximum number of sockets available
162#kern.ipc.nmbclusters=""	# Set the number of mbuf clusters
163#kern.ipc.nsfbufs=""		# Set the number of sendfile(2) bufs
164#net.inet.tcp.tcbhashsize=""	# Set the value of TCBHASHSIZE
165#vfs.root.mountfrom=""		# Specify root partition
166#vm.kmem_size=""		# Sets the size of kernel memory (bytes)
167#debug.kdb.break_to_debugger="0" # Allow console to break into debugger.
168#debug.ktr.cpumask="0xf"	# Bitmask of CPUs to enable KTR on
169#debug.ktr.mask="0x1200"	# Bitmask of KTR events to enable
170#debug.ktr.verbose="1"		# Enable console dump of KTR events
171
172###  Module loading syntax example  ##########################
173#module_load="YES"		# loads module "module"
174#module_name="realname"		# uses "realname" instead of "module"
175#module_type="type"		# passes "-t type" to load
176#module_flags="flags"		# passes "flags" to the module
177#module_before="cmd"		# executes "cmd" before loading the module
178#module_after="cmd"		# executes "cmd" after loading the module
179#module_error="cmd"		# executes "cmd" if load fails
180