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