]> code.delx.au - refind/blob - refind.conf-sample
New "Reboot to Firmware User Interface" feature.
[refind] / refind.conf-sample
1 #
2 # refind.conf
3 # Configuration file for the rEFInd boot menu
4 #
5
6 # Timeout in seconds for the main menu screen. Setting the timeout to 0
7 # disables automatic booting (i.e., no timeout).
8 #
9 timeout 20
10
11 # Hide user interface elements for personal preference or to increase
12 # security:
13 # banner - the rEFInd title banner (built-in or loaded via "banner")
14 # label - boot option text label in the menu
15 # singleuser - remove the submenu options to boot Mac OS X in single-user
16 # or verbose modes; affects ONLY MacOS X
17 # safemode - remove the submenu option to boot Mac OS X in "safe mode"
18 # hwtest - the submenu option to run Apple's hardware test
19 # arrows - scroll arrows on the OS selection tag line
20 # hints - brief command summary in the menu
21 # editor - the options editor (+, F2, or Insert on boot options menu)
22 # all - all of the above
23 # Default is none of these (all elements active)
24 #
25 #hideui singleuser
26 #hideui all
27
28 # Set the name of a subdirectory in which icons are stored. Icons must
29 # have the same names they have in the standard directory. The directory
30 # name is specified relative to the main rEFInd binary's directory. If
31 # an icon can't be found in the specified directory, an attempt is made
32 # to load it from the default directory; thus, you can replace just some
33 # icons in your own directory and rely on the default for others.
34 # Default is "icons".
35 #
36 #icons_dir myicons
37
38 # Use a custom title banner instead of the rEFInd icon and name. The file
39 # path is relative to the directory where refind.efi is located. The color
40 # in the top left corner of the image is used as the background color
41 # for the menu screens. Currently uncompressed BMP images with color
42 # depths of 24, 8, 4 or 1 bits are supported, as well as PNG images.
43 #
44 #banner hostname.bmp
45 #banner mybanner.png
46
47 # Custom images for the selection background. There is a big one (144 x 144)
48 # for the OS icons, and a small one (64 x 64) for the function icons in the
49 # second row. If only a small image is given, that one is also used for
50 # the big icons by stretching it in the middle. If only a big one is given,
51 # the built-in default will be used for the small icons.
52 #
53 # Like the banner option above, these options take a filename of an
54 # uncompressed BMP image file with a color depth of 24, 8, 4, or 1 bits,
55 # or a PNG image. The PNG format is required if you need transparency
56 # support (to let you "see through" to a full-screen banner).
57 #
58 #selection_big selection-big.bmp
59 #selection_small selection-small.bmp
60
61 # Set the font to be used for all textual displays in graphics mode.
62 # The font must be a PNG file with alpha channel transparency. It must
63 # contain ASCII characters 32-126 (space through tilde), inclusive, plus
64 # a glyph to be displayed in place of characters outside of this range,
65 # for a total of 96 glyphs. Only monospaced fonts are supported. Fonts
66 # may be of any size, although large fonts can produce display
67 # irregularities.
68 # The default is rEFInd's built-in font, Luxi Mono Regular 12 point.
69 #
70 #font myfont.png
71
72 # Use text mode only. When enabled, this option forces rEFInd into text mode.
73 # Passing this option a "0" value causes graphics mode to be used. Pasing
74 # it no value or any non-0 value causes text mode to be used.
75 # Default is to use graphics mode.
76 #
77 #textonly
78
79 # Set the EFI text mode to be used for textual displays. This option
80 # takes a single digit that refers to a mode number. Mode 0 is normally
81 # 80x25, 1 is sometimes 80x50, and higher numbers are system-specific
82 # modes. Mode 1024 is a special code that tells rEFInd to not set the
83 # text mode; it uses whatever was in use when the program was launched.
84 # If you specify an invalid mode, rEFInd pauses during boot to inform
85 # you of valid modes.
86 # CAUTION: On VirtualBox, and perhaps on some real computers, specifying
87 # a text mode and uncommenting the "textonly" option while NOT specifying
88 # a resolution can result in an unusable display in the booted OS.
89 # Default is 1024 (no change)
90 #
91 #textmode 2
92
93 # Set the screen's video resolution. Pass this option either:
94 # * two values, corresponding to the X and Y resolutions
95 # * one value, corresponding to a GOP (UEFI) video mode
96 # Note that not all resolutions are supported. On UEFI systems, passing
97 # an incorrect value results in a message being shown on the screen to
98 # that effect, along with a list of supported modes. On EFI 1.x systems
99 # (e.g., Macintoshes), setting an incorrect mode silently fails. On both
100 # types of systems, setting an incorrect resolution results in the default
101 # resolution being used. A resolution of 1024x768 usually works, but higher
102 # values often don't.
103 # Default is "0 0" (use the system default resolution, usually 800x600).
104 #
105 #resolution 1024 768
106 #resolution 3
107
108 # Launch specified OSes in graphics mode. By default, rEFInd switches
109 # to text mode and displays basic pre-launch information when launching
110 # all OSes except OS X. Using graphics mode can produce a more seamless
111 # transition, but displays no information, which can make matters
112 # difficult if you must debug a problem. Also, on at least one known
113 # computer, using graphics mode prevents a crash when using the Linux
114 # kernel's EFI stub loader. You can specify an empty list to boot all
115 # OSes in text mode.
116 # Valid options:
117 # osx - Mac OS X
118 # linux - A Linux kernel with EFI stub loader
119 # elilo - The ELILO boot loader
120 # grub - The GRUB (Legacy or 2) boot loader
121 # windows - Microsoft Windows
122 # Default value: osx
123 #
124 #use_graphics_for osx,linux
125
126 # Which non-bootloader tools to show on the tools line, and in what
127 # order to display them:
128 # shell - the EFI shell (requires external program; see rEFInd
129 # documentation for details)
130 # gptsync - the (dangerous) gptsync.efi utility (requires external
131 # program; see rEFInd documentation for details)
132 # apple_recovery - boots the Apple Recovery HD partition, if present
133 # mok_tool - makes available the Machine Owner Key (MOK) maintenance
134 # tool, MokManager.efi, used on Secure Boot systems
135 # about - an "about this program" option
136 # exit - a tag to exit from rEFInd
137 # shutdown - shuts down the computer (a bug causes this to reboot
138 # EFI systems)
139 # reboot - a tag to reboot the computer
140 # firmware - a tag to reboot the computer into the firmware's
141 # user interface (ignored on older computers)
142 # Default is shell,apple_recovery,mok_tool,about,shutdown,reboot,firmware
143 #
144 #showtools shell, mok_tool, about, reboot, exit, firmware
145
146 # Directories in which to search for EFI drivers. These drivers can
147 # provide filesystem support, give access to hard disks on plug-in
148 # controllers, etc. In most cases none are needed, but if you add
149 # EFI drivers and you want rEFInd to automatically load them, you
150 # should specify one or more paths here. rEFInd always scans the
151 # "drivers" and "drivers_{arch}" subdirectories of its own installation
152 # directory (where "{arch}" is your architecture code); this option
153 # specifies ADDITIONAL directories to scan.
154 # Default is to scan no additional directories for EFI drivers
155 #
156 #scan_driver_dirs EFI/tools/drivers,drivers
157
158 # Which types of boot loaders to search, and in what order to display them:
159 # internal - internal EFI disk-based boot loaders
160 # external - external EFI disk-based boot loaders
161 # optical - EFI optical discs (CD, DVD, etc.)
162 # hdbios - BIOS disk-based boot loaders
163 # biosexternal - BIOS external boot loaders (USB, eSATA, etc.)
164 # cd - BIOS optical-disc boot loaders
165 # manual - use stanzas later in this configuration file
166 # Note that the legacy BIOS options require firmware support, which is
167 # not present on all computers.
168 # On UEFI PCs, default is internal,external,optical,manual
169 # On Macs, default is internal,hdbios,external,biosexternal,optical,cd,manual
170 #
171 #scanfor internal,external,optical,manual
172
173 # Delay for the specified number of seconds before scanning disks.
174 # This can help some users who find that some of their disks
175 # (usually external or optical discs) aren't detected initially,
176 # but are detected after pressing Esc.
177 # The default is 0.
178 #
179 #scan_delay 5
180
181 # When scanning volumes for EFI boot loaders, rEFInd always looks for
182 # Mac OS X's and Microsoft Windows' boot loaders in their normal locations,
183 # and scans the root directory and every subdirectory of the /EFI directory
184 # for additional boot loaders, but it doesn't recurse into these directories.
185 # The also_scan_dirs token adds more directories to the scan list.
186 # Directories are specified relative to the volume's root directory. This
187 # option applies to ALL the volumes that rEFInd scans UNLESS you include
188 # a volume name and colon before the directory name, as in "myvol:/somedir"
189 # to scan the somedir directory only on the filesystem named myvol. If a
190 # specified directory doesn't exist, it's ignored (no error condition
191 # results). The default is to scan the "boot" directory in addition to
192 # various hard-coded directories.
193 #
194 #also_scan_dirs boot,ESP2:EFI/linux/kernels
195
196 # Partitions to omit from scans. You must specify a volume by its
197 # label, which you can obtain in an EFI shell by typing "vol", from
198 # Linux by typing "blkid /dev/{devicename}", or by examining the
199 # disk's label in various OSes' file browsers.
200 # The default is "Recovery HD".
201 #
202 #dont_scan_volumes "Recovery HD"
203
204 # Directories that should NOT be scanned for boot loaders. By default,
205 # rEFInd doesn't scan its own directory or the EFI/tools directory.
206 # You can "blacklist" additional directories with this option, which
207 # takes a list of directory names as options. You might do this to
208 # keep EFI/boot/bootx64.efi out of the menu if that's a duplicate of
209 # another boot loader or to exclude a directory that holds drivers
210 # or non-bootloader utilities provided by a hardware manufacturer. If
211 # a directory is listed both here and in also_scan_dirs, dont_scan_dirs
212 # takes precedence. Note that this blacklist applies to ALL the
213 # filesystems that rEFInd scans, not just the ESP, unless you precede
214 # the directory name by a filesystem name, as in "myvol:EFI/somedir"
215 # to exclude EFI/somedir from the scan on the myvol volume but not on
216 # other volumes.
217 #
218 #dont_scan_dirs ESP:/EFI/boot,EFI/Dell
219
220 # Files that should NOT be included as EFI boot loaders (on the
221 # first line of the display). If you're using a boot loader that
222 # relies on support programs or drivers that are installed alongside
223 # the main binary or if you want to "blacklist" certain loaders by
224 # name rather than location, use this option. Note that this will
225 # NOT prevent certain binaries from showing up in the second-row
226 # set of tools. Most notably, MokManager.efi is in this blacklist,
227 # but will show up as a tool if present in certain directories. You
228 # can control the tools row with the showtools token.
229 # The default is shim.efi,TextMode.efi,ebounce.efi,GraphicsConsole.efi,MokManager.efi,HashTool.efi,HashTool-signed.efi
230 #
231 #dont_scan_files shim.efi,MokManager.efi
232
233 # Scan for Linux kernels that lack a ".efi" filename extension. This is
234 # useful for better integration with Linux distributions that provide
235 # kernels with EFI stub loaders but that don't give those kernels filenames
236 # that end in ".efi", particularly if the kernels are stored on a
237 # filesystem that the EFI can read. When uncommented, this option causes
238 # all files in scanned directories with names that begin with "vmlinuz"
239 # or "bzImage" to be included as loaders, even if they lack ".efi"
240 # extensions. The drawback to this option is that it can pick up kernels
241 # that lack EFI stub loader support and other files. Passing this option
242 # a "0" value causes kernels without ".efi" extensions to NOT be scanned;
243 # passing it alone or with any other value causes all kernels to be scanned.
244 # Default is to NOT scan for kernels without ".efi" extensions.
245 #
246 scan_all_linux_kernels
247
248 # Set the maximum number of tags that can be displayed on the screen at
249 # any time. If more loaders are discovered than this value, rEFInd shows
250 # a subset in a scrolling list. If this value is set too high for the
251 # screen to handle, it's reduced to the value that the screen can manage.
252 # If this value is set to 0 (the default), it's adjusted to the number
253 # that the screen can handle.
254 #
255 #max_tags 0
256
257 # Set the default menu selection. The available arguments match the
258 # keyboard accelerators available within rEFInd. You may select the
259 # default loader using:
260 # - A digit between 1 and 9, in which case the Nth loader in the menu
261 # will be the default.
262 # - Any substring that corresponds to a portion of the loader's title
263 # (usually the OS's name or boot loader's path).
264 #
265 #default_selection 1
266
267 # Include a secondary configuration file within this one. This secondary
268 # file is loaded as if its options appeared at the point of the "include"
269 # token itself, so if you want to override a setting in the main file,
270 # the secondary file must be referenced AFTER the setting you want to
271 # override. Note that the secondary file may NOT load a tertiary file.
272 #
273 #include manual.conf
274
275 # Sample manual configuration stanzas. Each begins with the "menuentry"
276 # keyword followed by a name that's to appear in the menu (use quotes
277 # if you want the name to contain a space) and an open curly brace
278 # ("{"). Each entry ends with a close curly brace ("}"). Common
279 # keywords within each stanza include:
280 #
281 # volume - identifies the filesystem from which subsequent files
282 # are loaded. You can specify the volume by label or by
283 # a number followed by a colon (as in "0:" for the first
284 # filesystem or "1:" for the second).
285 # loader - identifies the boot loader file
286 # initrd - Specifies an initial RAM disk file
287 # icon - specifies a custom boot loader icon
288 # ostype - OS type code to determine boot options available by
289 # pressing Insert. Valid values are "MacOS", "Linux",
290 # "Windows", and "XOM". Case-sensitive.
291 # graphics - set to "on" to enable graphics-mode boot (useful
292 # mainly for MacOS) or "off" for text-mode boot.
293 # Default is auto-detected from loader filename.
294 # options - sets options to be passed to the boot loader; use
295 # quotes if more than one option should be passed or
296 # if any options use characters that might be changed
297 # by rEFInd parsing procedures (=, /, #, or tab).
298 # disabled - use alone or set to "yes" to disable this entry.
299 #
300 # Note that you can use either DOS/Windows/EFI-style backslashes (\)
301 # or Unix-style forward slashes (/) as directory separators. Either
302 # way, all file references are on the ESP from which rEFInd was
303 # launched.
304 # Use of quotes around parameters causes them to be interpreted as
305 # one keyword, and for parsing of special characters (spaces, =, /,
306 # and #) to be disabled. This is useful mainly with the "options"
307 # keyword. Use of quotes around parameters that specify filenames is
308 # permissible, but you must then use backslashes instead of slashes,
309 # except when you must pass a forward slash to the loader, as when
310 # passing a root= option to a Linux kernel.
311
312 # Below are several sample boot stanzas. All are disabled by default.
313 # Find one similar to what you need, copy it, remove the "disabled" line,
314 # and adjust the entries to suit your needs.
315
316 # A sample entry for a Linux 3.3 kernel with its new EFI boot stub
317 # support on a filesystem called "KERNELS". This entry includes
318 # Linux-specific boot options and specification of an initial RAM disk.
319 # Note uses of Linux-style forward slashes, even in the initrd
320 # specification. Also note that a leading slash is optional in file
321 # specifications.
322 menuentry Linux {
323 icon EFI/refind/icons/os_linux.icns
324 volume KERNELS
325 loader bzImage-3.3.0-rc7
326 initrd initrd-3.3.0.img
327 options "ro root=UUID=5f96cafa-e0a7-4057-b18f-fa709db5b837"
328 disabled
329 }
330
331 # A sample entry for loading Ubuntu using its standard name for
332 # its GRUB 2 boot loader. Note uses of Linux-style forward slashes
333 menuentry Ubuntu {
334 loader /EFI/ubuntu/grubx64.efi
335 icon /EFI/refined/icons/os_linux.icns
336 disabled
337 }
338
339 # A minimal ELILO entry, which probably offers nothing that
340 # auto-detection can't accomplish.
341 menuentry "ELILO" {
342 loader \EFI\elilo\elilo.efi
343 disabled
344 }
345
346 # Like the ELILO entry, this one offers nothing that auto-detection
347 # can't do; but you might use it if you want to disable auto-detection
348 # but still boot Windows....
349 menuentry "Windows 7" {
350 loader \EFI\Microsoft\Boot\bootmgfw.efi
351 disabled
352 }
353
354 # EFI shells are programs just like boot loaders, and can be
355 # launched in the same way. You can pass a shell the name of a
356 # script that it's to run on the "options" line. The script
357 # could initialize hardware and then launch an OS, or it could
358 # do something entirely different.
359 menuentry "Windows via shell script" {
360 icon \EFI\refind\icons\os_win.icns
361 loader \EFI\tools\shell.efi
362 options "fs0:\EFI\tools\launch_windows.nsh"
363 disabled
364 }
365
366 # Mac OS is normally detected and run automatically; however,
367 # if you want to do something unusual, a manual boot stanza may
368 # be the way to do it. This one does nothing very unusual, but
369 # it may serve as a starting point. Note that you'll almost
370 # certainly need to change the "volume" line for this example
371 # to work.
372 menuentry "My Mac OS X" {
373 icon \EFI\refind\icons\os_mac.icns
374 volume "OS X boot"
375 loader \System\Library\CoreServices\boot.efi
376 disabled
377 }