]> code.delx.au - refind/blobdiff - docs/man/refind-install.8
More cleanup relating to ARM64 support.
[refind] / docs / man / refind-install.8
index ac84672c5c8ef724f2806ae81ef2fefa2f2f7962..6c874f643e618840b3b606e2d24cde50eb129751 100644 (file)
@@ -20,6 +20,119 @@ steps can be performed manually; however, the \fBrefind-install\fR command
 provides an automated way to perform these tasks under both Linux and OS X.
 The exact behavior and options vary depending on the OS, however.
 
 provides an automated way to perform these tasks under both Linux and OS X.
 The exact behavior and options vary depending on the OS, however.
 
+Some details that can affect how the script runs include the following:
+
+.TP
+.B *
+If you run the script as an ordinary user, it attempts to acquire
+\fBroot\fR privileges by using the \fBsudo\fR command. This works on Mac OS
+X and some Linux installations (such as under Ubuntu or if you've added
+yourself to the \fBsudo\fR users list), but on some Linux installations
+this will fail. On such systems, you should run \fBrefind\-install\fR as
+root.
+
+.TP
+.B *
+Under OS X, you can run the script with a mouse by opening a Terminal
+session and then dragging\-and\-dropping the \fBrefind\-install\fR file to
+the Terminal window. You'll need to press the Return or Enter key to run
+the script.
+
+.TP
+.B *
+If you're using OS X 10.7's Whole Disk Encryption (WDE) feature, or the
+loogical volumes feature in OS X 10.10, you must install rEFInd to the ESP
+or to a separate HFS+ partition. The default in rEFInd 0.8.4 and later is
+to install to the ESP. If you prefer to use a separate HFS+ volume, the
+\fB\-\-ownhfs \fIdevice-file\fR option to \fBrefind\-install\fR is required.
+
+.TP
+.B *
+If you're not using WDE or logical volumes, you can install rEFInd to the
+OS X root (/) partition by using the \-\-notesp option to
+\fBrefind\-install\fR. Using this option is recommended when upgrading from
+a working rEFInd installation in this location.
+
+.TP
+.B *
+If you're replacing rEFIt with rEFInd on a Mac, there's a chance that
+\fBrefind\-install\fR will warn you about the presence of a program called
+\fB/Library/StartupItems/rEFItBlesser\fR and ask if you want to delete it.
+This program is designed to keep rEFIt set as the boot manager by
+automatically re\-blessing it if the default boot manager changes. This is
+obviously undesirable if you install rEFInd as your primary boot manager,
+so it's generally best to remove this program. If you prefer to keep your
+options open, you can answer \fBN\fR when \fBrefind\-install\fR asks if you
+want to delete rEFItBlesser, and instead manually copy it elsewhere. If you
+subsequently decide to go back to using rEFIt as your primary boot manager,
+you can restore rEFItBlesser to its place.
+
+.TP
+.B *
+If you intend to boot BIOS-based OSes on a UEFI-based PC, you must edit the
+\fBrefind.conf\fR file's \fBscanfor\fR line to enable the relevant
+searches. This is not necessary on Macs, though; because of the popularity
+of dual boots with Windows on Macs, the BIOS/legacy scans are enabled by
+default on Macs.
+
+.TP
+.B *
+On Linux, \fBrefind\-install\fR checks the filesystem type of the
+\fB/boot\fR directory and, if a matching filesystem driver is available,
+installs it. Note that the "\fB/boot\fR directory" may be on a separate
+partition or it may be part of your root (\fB/\fR) filesystem, in which
+case the driver for your root filesystem is installed. This feature is
+unlikely to work properly from an emergency system, although it might if
+you have a separate \fB/boot\fR partition and if you mount that partition
+at \fB/boot\fR in your emergency system, and the ESP at \fB/boot/efi\fR.
+
+.TP
+.B *
+On OS X, \fBrefind\-install\fR checks your partition tables for signs of a
+Linux installation. If such a sign is found, the script installs the EFI
+filesystem driver for the Linux ext4 filesystem. This will enable rEFInd to
+read your Linux kernel if it's on an ext2, ext3, or ext4 filesystem. Note
+that some configurations will require a \fB/boot/refind_linux.conf\fR file,
+which can be reliably generated only under Linux. (The \fBmkrlconf\fR
+script that comes with rEFInd will do this job once you've booted Linux.)
+In the meantime, you can launch GRUB from rEFInd or press F2 or Insert
+twice after highlighting the Linux option in rEFInd. This will enable you
+to enter a \fBroot=\fI/dev/whatever\fR specification, where
+\fI/dev/whatever\fR is the device identifier of your Linux root (\fB/\fR)
+filesystem.
+
+.TP
+.B *
+If you run \fBrefind\-install\fR on Linux and if
+\fB/boot/refind_linux.conf\fR doesn't already exist, \fBrefind\-install\fR
+creates this file and populates it with a few sample entries. If
+\fB/boot\fR is on a FAT partition (or HFS+ on a Mac), or if it's on an
+ext2fs, ext3fs, ext4fs, ReiserFS, Btrfs, or HFS+ partition and you install
+an appropriate driver, the result is that rEFInd will detect your kernel
+and will probably boot it correctly. Some systems will require manual
+tweaking to \fBrefind_linux.conf\fR, though -- for instance, to add
+\fBdolvm\fR to the boot options on Gentoo systems that use LVM.
+
+.TP
+.B *
+If you pass the \fB\-\-shim\fR option to the script (along with a filename
+for a Shim binary), the script sets up for a Secure Boot configuration via
+Shim. By default, this causes the rEFInd binary to be renamed as
+\fBgrubx64.efi\fR. Recent versions of Shim support passing the name of the
+follow-on program to Shim via a parameter, though. If you want to use this
+feature, you can pass the \fB\-\-keepname\fR option to
+\fBrefind\-install\fR.
+
+.PP
+
+After you run \fBrefind\-install\fR, you should peruse the script's output
+to ensure that everything looks OK. \fBrefind\-install\fR displays error
+messages when it encounters errors, such as if the ESP is mounted read-only
+or if you run out of disk space. You may need to correct such problems
+manually and re\-run the script. In some cases you may need to fall back on
+manual installation, which gives you better control over details such as
+which partition to use for installation.
+
 .SH "OPTIONS"
 
 .TP
 .SH "OPTIONS"
 
 .TP
@@ -36,8 +149,9 @@ logical volumes.
 .TP
 .B \-\-usedefault \fIdevice-file\fR
 You can install rEFInd to a disk using the default/fallback filename of
 .TP
 .B \-\-usedefault \fIdevice-file\fR
 You can install rEFInd to a disk using the default/fallback filename of
-\fBEFI/BOOT/bootx64.efi\fR (and \fBEFI/BOOT/bootia32.efi\fR, if the 32\-bit
-build is available) using this option. The device\-file should be an
+\fBEFI/BOOT/bootx64.efi\fR (as well as \fBEFI/BOOT/bootia32.efi\fR and
+\fBEFI/BOOT/bootaa64.efi\fR, if the IA\-32 and ARM64
+builds are available) using this option. The device\-file should be an
 unmounted ESP, or at least a FAT partition, as in \fB\-\-usedefault
 /dev/sdc1\fR. Your computer's NVRAM entries will not be modified when
 installing in this way. The intent is that you can create a bootable USB
 unmounted ESP, or at least a FAT partition, as in \fB\-\-usedefault
 /dev/sdc1\fR. Your computer's NVRAM entries will not be modified when
 installing in this way. The intent is that you can create a bootable USB