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