]> code.delx.au - refind/commitdiff
Updated installation instructions.
authorsrs5694 <srs5694@users.sourceforge.net>
Tue, 8 May 2012 02:46:15 +0000 (22:46 -0400)
committersrs5694 <srs5694@users.sourceforge.net>
Tue, 8 May 2012 02:46:15 +0000 (22:46 -0400)
BUILDING.txt
docs/refind/installing.html

index 7c14bf69e4503dcc53d485c6e9ea8a86d76d0ce3..2c59bb47e42fd83dffb7f5322a927f46754b961a 100644 (file)
@@ -82,7 +82,8 @@ With your development system set up, you can compile rEFInd as follows:
    "refind", "libeg", and "include".
 
 4) Type "make". With any luck, rEFInd will compile without error, leaving
-   the "refind.efi" file in the "refind" subdirectory.
+   the "refind_ia32.efi" or "refind_x64.efi" file, depending on your
+   platform, in the "refind" subdirectory.
 
 If rEFInd doesn't compile correctly, you'll need to track down the source
 of the problem. Double-check that you've got all the necessary development
@@ -118,22 +119,24 @@ flag. In GNU-EFI, this can be added to the CFLAGS line in Make.defaults.
 Installing rEFInd
 =================
 
-With rEFInd compiled, you can install it. On a UEFI-based system, you'll
-want to copy files on the ESP as follows:
+With rEFInd compiled, you can install it. The easiest way to do this is
+with the install.sh script, which works on both Linux and Mac OS X.
+Alternatively, you can type "make install" to install using this script.
+Note that this installation copies files to the ESP and uses "efibootmgr"
+(on Linux) or "bless" (on OS X) to add rEFInd to the firmware's boot loader
+list. The docs/refind/installing.html file provides more details on this
+script and its use.
+
+If install.sh doesn't work for you or if you prefer to do the job manually,
+you may. On a UEFI-based system, you'll want to copy files on the ESP as
+follows:
 
 * Create a directory for rEFInd, such as EFI/refind.
-* Copy refind/refind.efi to the ESP's EFI/refind directory.
+* Copy refind/refind_ia32.efi or refind_x64.efi to the ESP's EFI/refind
+  directory.
 * Copy refind.conf-sample to the EFI/refind directory as refind.conf.
 * Copy the icons subdirectory, including all its files, to EFI/refind.
 
 You'll then need to activate rEFInd in your EFI. This can be done with
 tools such as "efibootmgr" under Linux or "bless" under OS X. See the
-docs/installing.html file for details.
-
-You may have noticed an install.sh script in the source package. This
-script is intended for distribution with my own binary packages of rEFInd,
-and it copies files from the "refind" subdirectory (relative to the
-script's location) -- namely refind_x64.efi or refind_ia32.efi,
-refind.conf-sample, and an icons subdirectory. You can rearrange your files
-to provide this layout, but it's no more work to copy the files as just
-described.
+docs/refind/installing.html file for details.
index ab9c120006dc6578683724fbd48a6c5a9f7ab884..7be19bd29837f1edce073c608b8fd4bb6f075406 100644 (file)
@@ -94,20 +94,6 @@ href="mailto:rodsmith@rodsbooks.com">rodsmith@rodsbooks.com</a></p>
 
 <p>Once you've uncompressed a rEFInd binary zip file, you must install it to your computer's ESP (or conceivably to some other location). The details of how you to this depend on your OS and your computer (UEFI-based PC vs. Macintosh). The upcoming sections provide details. For Linux and Mac OS X, you can use the installation script, <a href="#installsh"><tt>install.sh</tt>,</a> which provides easy one-command installation on most systems. Occasionally this script will fail, though, so I also provide explicit instructions for <a href="#linux">Linux</a> and <a href="#osx">Mac OS X.</a> Installation under <a href="#windows">Windows</a> also must be done manually. In some cases, you'll have to deviate from the default naming conventions, as described in <a href="#naming">a section on this topic.</a> If you're upgrading rEFInd, see the <a href="#upgrading">section on upgrading.</a> Finally, I describe how to install some <a href="#addons">additional components</a> you might find useful.</a></p>
 
-<!--
-
-can copy the entire <tt>refind</tt> directory into your EFI System Partition's (ESP's) <tt>EFI</tt> directory on UEFI-based PCs, so that rEFInd resides in <tt>EFI/refind</tt>. If you've tried rEFInd using a CD-R image file, you can copy the files from the <tt>EFI/refind</tt> directory on the CD to create an equivalent directory on the ESP. To avoid confusion, though, you should delete the rEFInd binary file for the CPU type your computer does <i>not</i> use. To the best of my knowledge, all UEFI-based PCs use 64-bit CPUs, so you should keep the <tt>refind_x64.efi</tt> binary and delete the <tt>refind_ia32.efi</tt> binary. Most Intel-based Macs also have 64-bit EFI implementations, so you should do the same thing; but very early Intel-based Macs have 32-bit EFIs (and sometimes 32-bit CPUs), which require the <tt>refind_ia32.efi</tt> file. You can determine whether your Mac needs the <i>x</i>86-64 or IA32 build by typing the following command in a Mac Terminal window:</p>
-
-<pre class="listing">
-$ <b>ioreg -l -p IODeviceTree | grep firmware-abi</b>
-</pre>
-
-<p>The result should read either <tt>EFI32</tt> or <tt>EFI64</tt>, indicating that you should use the <tt>refind_ia32.efi</tt> or <tt>refind_x64.efi</tt> binary, respectively.</p>
-
-<p>Of course, before you can install the files, you must be able to access the ESP. The details of this task vary from one OS to another. If you have a choice, I recommend using <a href="#linux">Linux</a> for rEFInd installation on UEFI PCs and <a href="#osx">OS X</a> on Macs. (On Macs, you can optionally use OS X's main partition rather than the ESP for this purpose.) <a href="#windows">Windows</a> provides relatively primitive tools for accessing the ESP and manipulating the EFI's boot list. I also describe some <a href="#naming">options for naming rEFInd</a> that may be useful on some systems. Finally, I describe how to install some <a href="#addons">extra tools</a> that you may find useful but that are not included with rEFInd.</p>
-
--->
-
 <a name="installsh">
 <h2>Installing rEFInd Using <tt>install.sh</tt> under Linux or Mac OS X</h2>