You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+24-15Lines changed: 24 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,9 +18,9 @@ A Boot Manager for Mac and PC
18
18
19
19
## Overview
20
20
21
-
RefindPlus builds on _`rEFInd`_ to extend its functionality with enhancements and fixes that include several Apple Mac and UEFI-PC related items that may be of interest to anyone requiring a capable boot manager.
21
+
RefindPlus is a fork of _`rEFInd`_ that provides extended functionality via enhancements and fixes that include several Apple Mac and UEFI-PC related items that may be of interest to anyone requiring a boot manager for Mac and PC.
22
22
23
-
RefindPlus is particularly useful for those with additional configuration needs or that require advanced or otherwise non-typical options for running operating systems and uEFI utilities on Mac and PC.
23
+
RefindPlus is particularly useful for those with additional configuration needs or that require advanced or otherwise non-typical (hence typically unavailable) options for running operating systems and uEFI utilities on Mac and PC.
24
24
25
25
Some features:
26
26
- Maintains feature and configuration parity with `Upstream v0.14.2` base.
@@ -54,7 +54,9 @@ Some features:
54
54
55
55
## Installation
56
56
57
-
[MyBootMgr](https://www.dakanji.com/creations/index.html) is recommended to automate installing RefindPlus when running Mac OS on Intel-based Macs. Alternatively, as the RefindPlus efi file can function as a drop-in replacement for the upstream efi file, the [rEFInd package](https://www.rodsbooks.com/refind/installing.html) can be installed first and its efi file replaced with the RefindPlus efi file (Rename RefindPlus file to match). This allows installing RefindPlus on other compatible operating systems supported upstream. See `UEFI Secure Boot` under the [Divergence Section](https://github.com/RefindPlusRepo/RefindPlus#divergence) for how to enable this if required.
57
+
A straightforward way is to make the RefindPlus efi file a `UEFI Fallback File` by naming it accordingly, `BOOTx64.efi`, and placing this in the `UEFI Fallback Path` of a disk, `/EFI/BOOT`.
58
+
59
+
[MyBootMgr](https://www.dakanji.com/creations/index.html) is recommended to automate installing RefindPlus when running Mac OS on Intel-based Macs. Alternatively, as the RefindPlus efi file can function as a drop-in replacement for the upstream efi file, the [rEFInd package](https://www.rodsbooks.com/refind/installing.html) can be installed first and its efi file replaced with the RefindPlus efi file (rename RefindPlus file to match). This allows installing RefindPlus on other compatible operating systems supported upstream. See `UEFI Secure Boot` under the [Divergence Section](https://github.com/RefindPlusRepo/RefindPlus#divergence) for how to enable this if required.
58
60
59
61
> [!NOTE]
60
62
>
@@ -97,10 +99,12 @@ decline_help_size |Disables feature that sets additional UI scaling for very
97
99
decline_help_text |Disables feature that sets screen text to complementary colours
98
100
decouple_key_f10 |Unmaps the `F10` key from native screenshots (the `\` key remains mapped)
99
101
disable_apfs_load |Disables inbuilt provision of APFS filesystem capability
100
-
disable_apfs_sync |Disables feature allowing direct APFS/FileVault boot (Without "PreBoot")
101
-
disable_bootlogo |Disables display of boot logos on loading some items if required
102
-
disable_check_amfi |Disables AMFI Checks on Mac OS if required
103
-
disable_check_compat |Disables Mac version compatibility checks if required
102
+
disable_apfs_sync |Disables feature allowing direct APFS/FileVault boot (without "PreBoot")
103
+
disable_check_amfi |Disables AMFI Checks on Mac OS
104
+
disable_check_compat |Disables Mac version compatibility checks
105
+
disable_exitlogo_clear|Disables clearing displayed exit logo images on exit screens
106
+
disable_exitlogo_image|Disables display of exit logo images on exit screens
107
+
disable_exitlogo_scale|Disables scaling displayed exit logo images on exit screens
104
108
disable_pass_gop_thru |Disables feature that provides GOP instance on UGA for some loading screens
105
109
disable_legacy_sync |Disables detailed indentification of Mac legacy BIOS boot capability
106
110
disable_nvram_paniclog|Disables logging Mac OS kernel panics to nvRAM
@@ -110,7 +114,7 @@ disable_rescan_dxe |Disables scanning for newly revealed DXE drivers when con
110
114
disable_set_applefb |Disables provision, under some circumstances, of missing Apple Framebuffers
111
115
disable_set_consolegop|Disables feature that fixes some issues with GOP graphics on legacy units
112
116
enable_esp_filter |Prevents other ESPs other than the RefindPlus ESP being scanned for loaders
113
-
force_trim |Forces `TRIM` on Third-Party SSDs on Macs if required
117
+
force_trim |Allows forcing `TRIM` on Third-Party SSDs on Macs
114
118
hidden_icons_external |Allows scanning for `.VolumeIcon` icons on external volumes
115
119
hidden_icons_ignore |Disables scanning for `.VolumeIcon` image icons if not required
116
120
hidden_icons_prefer |Prioritises `.VolumeIcon` and `.VolumeBadge` image icons when available
@@ -144,12 +148,17 @@ In addition to the new functionality listed above, the following upstream tokens
144
148
-`tools` option to _enable_ graphics mode loading for such.
145
149
-`none` option to _disable_ graphics mode loading for everything.
146
150
-`everything` option to _enable_ graphics mode loading for everything.
147
-
-`OpenCore` and `Clover` can be specifically set to load in graphics mode.
148
-
-**"showtools":**Additional tool added:
151
+
-`SystemD`, `OpenCore`, and `Clover` can be set to load in graphics mode.
152
+
-**"showtools":**Defaults changed and additional tool added:
149
153
-`clean_nvram` : Allows resetting nvRAM directly from RefindPlus.
150
154
- When run on Apple firmware, RefindPlus will additionally trigger nvRAM garbage collection
151
155
-**menuentry:** Additional OSTypes added for manual stanzas:
152
-
-`RefitVariant`, `OpenCore`, and `Clover` can be additionally defined
156
+
-`RefitVariant`, `SystemD`, `OpenCore`, and `Clover` can be additionally defined
-`follow_symlinks OFF "Vol_1,Vol_2"`: Symlinks followed unless on list
161
+
-`follow_symlinks ON "Vol_9,Vol_10"`: Symlinks followed only if listed
153
162
-**"csr_values":** A value of `0` can be set as the `Enabled` value to allow `Over The Air (OTA)` updates when running Mac OS 11.x (Big Sur) or newer with SIP enabled.
154
163
- This is equivalent to activating the `csr_normalise` token.
155
164
-**"log_level":** Controls the native log format and an implementation of the upstream format.
@@ -173,8 +182,8 @@ In addition to the new functionality listed above, the following upstream tokens
173
182
## Divergence
174
183
175
184
Significant visible implementation differences vis-a-vis the upstream base are:
176
-
-**UEFI Secure Boot:** RefindPlus binaries are currently not signed for secure boot support and do not include the `Secure Boot Advanced Targeting (SBAT)` sections required by Shim v15.3/newer.
177
-
-> The process [outlined here](https://www.rodsbooks.com/refind/secureboot.html#installation) for signing self built upstream binaries can be followed to enable suport.
185
+
-**UEFI Secure Boot:** RefindPlus binaries as from v0.14.2.AD include `Secure Boot Advanced Targeting (SBAT)` sections required by Shim v15.3/newer for secure boot support but require users to self-sign the binaries and to enroll the certificate.
186
+
-> The process [outlined upstream](https://www.rodsbooks.com/refind/secureboot.html#installation) for self-signing can be followed to enable support.
178
187
-> An adaptation of the process for RefindPlus is [provided here](https://github.com/RefindPlusRepo/RefindPlus/discussions/190#discussioncomment-10130431). Modify for newer releases as required.
179
188
-> Refer to [this summation](https://forum.manjaro.org/t/howto-enable-secure-boot-with-refind/121403/6) for futher insight.
180
189
-**GZipped Loaders:** RefindPlus only provides stub support for handling GZipped loaders as this is largely only relevant for units on the ARM architecture.
@@ -195,15 +204,15 @@ Significant visible implementation differences vis-a-vis the upstream base are:
195
204
-> Activate the RefindPlus-specific `disable_apfs_load` setting to switch this feature off.
196
205
-**APFS PreBoot Volumes:** RefindPlus always synchronises APFS System and PreBoot partitions transparently such that the Preboot partitions of APFS volumes are always used to boot APFS formatted Mac OS. Hence, a single option for booting Mac OS on APFS volumes is presented in RefindPlus to provide maximum APFS compatibility. This is done using an inbuilt `SyncAPFS` feature.
197
206
-> Activate the RefindPlus-specific `disable_apfs_sync` setting to switch this feature off.
198
-
-**Mac nvRAM Protection:** RefindPlus always prevents UEFI Windows Secure Boot from saving certificates to Mac nvRAM as this can result in damage and, ultimately, an inability to boot anything on some Macs (Typically Pre 2013 Vintage). Blocking these certificates does not impact the operation of UEFI Windows on such Macs. This filtering only happens when Mac firmware is detected and is not applied to other types of firmware. This is done using an inbuilt `ProtectNVRAM` feature.
207
+
-**Mac nvRAM Protection:** RefindPlus always prevents UEFI Windows Secure Boot from saving certificates to Mac nvRAM as this can result in damage and, ultimately, an inability to boot anything on some Macs (typically Pre 2013 Vintage). Blocking these certificates does not impact the operation of UEFI Windows on such Macs. This filtering only happens when Mac firmware is detected and is not applied to other types of firmware. This is done using an inbuilt `ProtectNVRAM` feature.
199
208
-> Activate the RefindPlus-specific `disable_nvram_protect` setting to switch this feature off.
200
209
-**Mac Legacy BIOS Boot:** RefindPlus originally assumed all Macs were capable of legacy BIOS boot based on code that went in upstream back in 2012 when this was a reasonable default. However, some later Intel Macs do not support legacy BIOS boot and RefindPlus now attempts to categorise Macs to enable/disable legacy boot accordingly.
201
210
-> Activate the RefindPlus-specific `disable_legacy_sync` setting to keep the old assumption.
202
211
-**Secondary Configuration Files:** While the upstream documentation prohibits including tertiary configuration files from secondary configuration files, there is no mechanism enforcing this prohibition. Hence, tertiary, quaternary, quinary, and more, configuration files can in fact be included.
203
212
-> RefindPlus enforces the limitation for inclusion to secondary configuration files.
204
213
-**Shortcut Keys:** RefindPlus does not allocate shortcut keys based on the operating system type/name as there is no way of knowing what would actually be loaded in many cases.
205
214
-> Keys are allocated based on display position in the order of `Key 1` to `Key Z`.
206
-
-> Alphabetic `Keys I and O` are not used while Numeric `Key 0` is reserved for internal use.
215
+
-> Alphabetic `Keys I and O` are not used, while Numeric `Key 0` is reserved for internal use.
207
216
-> Keys are not allocated to `Tools` apart from `Key A` for `About Refindplus` and `Key Z` for `System Shutdown`.
208
217
-**Disabled Manual Stanzas:** The processing of a user configured boot stanza is halted, and the `Entry` object immediately discarded, once a `Disabled` setting is encountered. The outcome is the same as upstream, which always continues to create and return a fully built object that is later discarded in such cases. The approach adopted in RefindPlus allows for an optimised loading process particularly when such `Disabled` tokens are placed immediately after the `menuentry` line (see examples near the bottom of the `config.conf-sample` file).
209
218
-> This also applies to `submenuentry` items which can be enabled or disabled separately.
0 commit comments