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