source: trunk/www/install.php @ 42773

Last change on this file since 42773 was 40141, checked in by ryandesign@…, 12 years ago

install.php: clarify that the given Xcode versions are minimum requirements

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
  • Property svn:mime-type set to text/x-php
File size: 12.2 KB
2    /* -*- coding: utf-8; mode: php; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- vim:fenc=utf-8:filetype=php:et:sw=4:ts=4:sts=4 */
3    /* $Id: install.php 40141 2008-09-22 08:51:44Z $ */
4    /* Copyright (c) 2004, OpenDarwin. */
5    /* Copyright (c) 2004-2007, The MacPorts Project. */
7    include_once("$MPWEB/includes/");
8    print_header('The MacPorts Project -- Download &amp; Installation', 'utf-8');
12<div id="content">
14    <h2 class="hdr">Installing MacPorts</h2>
16    <p>MacPorts version <?php print $macports_version_major; ?> is available in various formats for download and installation:
17    </p>
19    <ul>
20        <li>&#8220;dmg&#8221; disk images for <a href="<?php print $leopard_dmg; ?>">Leopard (Universal)</a>, <a
21        href="<?php print $tiger_dmg; ?>">Tiger (Universal)</a> and <a href="<?php print $panther_dmg; ?>">Panther (PowerPC)
22        </a> as a legacy platform, containing pkg installers for use with the Mac OS X Installer. By far the simplest installation
23        procedure that most users should <a href="#pkg">follow</a> after meeting the requirements listed <a href="#requirements">
24        below</a>.</li>
25        <li>In <a href="#source">source form</a> as either a <a href="<?php print $bz2_tarball ?>">tar.bz2</a> package or a
26        <a href="<?php print $gz_tarball; ?>">tar.gz</a> one for manual compilation, if you intend to customize your installation
27        in any way.</li>
28        <li><a href="#svn">SVN checkout</a> of the unpackaged sources, if you wish to follow MacPorts development.</li>
29        <li>The <a href="#selfupdate">selfupdate</a> target of the <kbd>port(1)</kbd> command, for users who already have
30        MacPorts installed and wish to upgrade to a newer release.</li>
31    </ul>
33    <p>Checksums for our packaged <a href="<?php print $downloads; ?>">downloads</a> are contained in the corresponding <a
34    href="<?php print $checksums; ?>">checksums file</a>.</p>
37    <div id="requirements">
39        <p>Please note that in order to install and run MacPorts on Mac OS X, your system must have installations of the following
40        components:</p>
42        <ol>
43            <li>Apple's <a href="">Xcode</a> Developer Tools (version 3.0 or later for
44            Leopard, or 2.4.1 or later for Tiger), found at the <a href="">Apple Developer Connection</a>
45            site or on your Mac OS X installation CDs/DVD.</li>
46            <li>The X11 windowing environment (A.K.A. &#8220;X11 User&#8221;) and its related SDK package (&#8220;X11SDK&#8221;)
47            for ports that depend on the functionality they provide to compile and run.
48                <ul>
49                    <li>the &#8220;X11 User&#8221; package is an optional installation on your system CDs/DVD for Panther and
50                    Tiger, enabled through the &#8220;Customize&#8221; button of the installer, whereas it is included by default
51                    on Leopard.</li>
52                    <li>the &#8220;X11 SDK&#8221; package from the Xcode installer will be automatically selected if &#8220;X11
53                    User&#8221; is already installed, so be sure to install that first.</li>
54                </ul>
55            </li>
56        </ol>
58    </div>
61    <h3 class="subhdr" id="pkg">Mac OS X Package (.pkg) Installer</h3>
63    <p>The easiest way to install MacPorts on a Mac OS X system is by downloading the dmg for <a href="<?php print $leopard_dmg;
64    ?>">Leopard (Universal)</a>, <a href="<?php print $tiger_dmg; ?>">Tiger (Universal)</a> or <a href="<?php print $panther_dmg;
65    ?>">Panther (PowerPC)</a>, respectively, and running the system's Installer by double-clicking on the pkg contained therein,
66    following the on-screen instructions until completion.</p>
68    <p>This procedure will place a fully-functional and default MacPorts installation on your host system, ready for usage.
69    If needed your shell configuration files will be <a href="<?php print $guide_url . ''; ?>">adapted by
70    the installer</a> to include the necessary settings to run MacPorts and the programs it installs, but you may need to
71    open a new shell for these changes to take effect.</p>
73    <p>The MacPorts &#8220;<kbd>selfupdate</kbd>&#8221; command will also be run for you by the installer to ensure you have our
74    latest available release and the latest revisions to the &#8220;Portfiles&#8221; that contain the instructions employed
75    in the building and installation of ports. After installation is done, it is recommended that you run this step manually
76    on a regular basis to to keep your MacPorts system always current:</p>
78    <pre>sudo port -v selfupdate</pre>
80    <p>At this point you should be ready to enjoy MacPorts!</p>
82    <p>Type &#8220;<kbd>man port</kbd>&#8221; at the command line prompt and/or browse over to our <a href="<?php print
83    $guide_url; ?>">Guide</a> to find out more information about using MacPorts. <a href="#help">Help</a> is also available.
84    </p>
87    <h3 class="subhdr" id="source">Source Installation</h3>
89    <p>If on the other hand you decide to install MacPorts from source, there are still a couple of things you will need to do
90    after downloading the tarball before you can start installing ports, namely compiling and installing MacPorts itself:</p>
93    <ol>
94        <li>&#8220;<kbd>cd</kbd>&#8221; into the directory where you downloaded the package and run &#8220;<kbd>tar xjvf
95        <a href="<?php print $bz2_tarball; ?>">MacPorts-<?php print $macports_version_major; ?>.tar.bz2</a></kbd>&#8221; or
96        &#8220;<kbd>tar xzvf <a href="<?php print $gz_tarball; ?>">MacPorts-<?php print $macports_version_major; ?>.tar.gz</a></kbd>&#8221;,
97        depending on whether you downloaded the bz2 tarball or the gz one, respectively.</li>
98        <li>Build and install the recently unpacked sources:
99            <ul>
100                <li><kbd>cd MacPorts-<?php print $macports_version_major; ?></kbd></li>
101                <li><kbd>./configure &amp;&amp; make &amp;&amp; sudo make install</kbd></li>
102            </ul>
103            Optionally:
104            <ul>
105                <li><kbd>cd ../</kbd></li>
106                <li><kbd>rm -rf MacPorts-<?php print $macports_version_major; ?>*</kbd></li>
107            </ul>
109        </li>
110    </ol>
112    <p>These steps need to be perfomed from an administrator account, for which &#8220;<kbd>sudo</kbd>&#8221; will ask the
113    password upon installation. This procedure will install a pristine MacPorts system and, if the optional steps are taken,
114    remove the as of now unnecessary MacPorts-<?php print $macports_version_major; ?> source directory and corresponding tarball.</p>
116    <p>To customize your installation you should read the output of &#8220;<kbd>./configure --help | more</kbd>&#8221; and
117    pass the appropriate options for the settings you wish to tweak to the configuration script in the steps detailed above.</p>
119    <p>You will need to manually adapt your shell's environment to work with MacPorts and your chosen installation <kbd>
120    prefix</kbd> (the value passed to <kbd>configure</kbd>'s <kbd>--prefix</kbd> flag, defaulting to <kbd>/opt/local</kbd>):
121    </p>
123    <ul>
124        <li><kbd>Add ${prefix}/bin</kbd> and <kbd>${prefix}/sbin</kbd> to the start of your <kbd>PATH</kbd> environment variable
125        so that MacPorts-installed programs take precedence over system-provided programs of the same name.</li>
126        <li>If a standard <kbd>MANPATH</kbd> environment variable already exists (that is, one that doesn't contain any empty
127        components), add the <kbd>${prefix}/share/man</kbd> path to it so that MacPorts-installed man pages are found by your
128        shell.</li>
129        <li>For Tiger and earlier only, add an appropriate X11 <kbd>DISPLAY</kbd> environment variable to run X11-dependent
130        programs, as Leopard takes care of this requirement on its own.</li>
131    </ul>
133    <p>Lastly, you need to synchronize your installation with the MacPorts rsync server:</p>
135    <pre>sudo port -v selfupdate</pre>
137    <p>Upon completion MacPorts will be ready to install ports!</p>
139    <p>It is recommended to run the above command on a regular basis to keep your installation current. Type &#8220;<kbd>man
140    port</kbd>&#8221; at the command line prompt and/or browse over to our <a href="<?php print $guide_url; ?>">Guide</a> to
141    find out more information about using MacPorts. <a href="#help">Help</a> is also available.</p>
144    <h3 class="subhdr" id="svn">SVN Sources</h3>
146    <p>If you are developer or a user with a taste for the bleeding edge and wish for the latest changes and feature additions,
147    you may acquire the MacPorts sources through SVN.</p>
149    <p>Use the following command to check the project's &#8220;trunk&#8221; out of the MacPorts anonymous subversion repository,
150    containing all of our source modules (MacPorts' &#8220;base&#8221;, the ports tree and all of documentation in raw form):</p>
152    <pre>svn co <?php print $svn_url . 'trunk'; ?></pre>
154    <p>Purpose-specific branches are also available at the <kbd><?php print $svn_url . 'branches'; ?></kbd> url.</p>
156    <p>Alternatively, if you'd simply like to view the SVN repository without checking it out, you can do so via the <a
157    href="<?php print $trac_url . 'browser'; ?>">Trac source browser</a>.</p>
160    <h3 class="subhdr" id="selfupdate">Selfupdate</h3>
162    <p>If you already have MacPorts installed and have no restrictions to use the rsync networking protocol (tcp port 873 by
163    default), the easiest way to upgrade to our latest available release, <b><?php print $macports_version_latest; ?></b>, is
164    by using the <kbd>selfupdate</kbd> target of the <kbd>port(1)</kbd> command. This will both update your ports tree (by
165    performing a <kbd>sync</kbd> operation) and rebuild your current installation if it's outdated, preserving your customizations,
166    if any.</p>
169    <h3 class="subhdr" id="other">Other Platforms</h3>
171    <p>Running on platforms other than Mac OS X is not the main focus of The MacPorts Project, so remaining cross-platform is
172    not an actively-pursued development goal. Nevertheless, it is not an actively-discouraged goal either and as a result some
173    experimental support does exist for other POSIX-compliant platforms such as *BSD and GNU/Linux.</p>
175    <p>The full list of requirements to run MacPorts on these other platforms is as follows (we assume you have the basics such
176    as GCC and X11):</p>
178    <ul>
179        <li><a href="">Tcl</a> (8.3 or 8.4), with threads.</li>
180        <li><a href="">GNUstep</a> (Base), for Foundation.</li>
181        <li><b>mtree</b> for directory hierarchy.</li>
182        <li><a href="">rsync</a> for syncing the ports.</li>
183        <li><a href="">cURL</a> for downloading distfiles.</li>
184        <li><a href="">OpenSSL</a> or <a href="">libmd</a> for checksums.</li>
185    </ul>
187    <p>Normally you must install from <a href="#source">source</a> or from an <a href="#svn">SVN checkout</a> to run MacPorts
188    on any of these platforms. Experimental packaging is available for the FreeBSD (.tbz package), Fedora (.rpm package) and
189    Ubuntu (.deb package) operating systems.</p>
192    <h3 class="subhdr" id="help">Help</h3>
194    <p>Help on a wide variety of topics is also available in the project <a href="<?php print $guide_url; ?>">Guide</a> and
195    through our <a href="<?php print $trac_url; ?>">Trac portal</a> should you run into any problems installing and/or using
196    MacPorts. Of particular relevance are the <a href="<?php print $guide_url . '#installing'; ?>">installation</a> &amp;
197    <a href="<?php print $guide_url . '#using'; ?>">usage</a> sections of the former and the <a href="<?php print $trac_url .
198    'wiki/FAQ'; ?>">FAQ</a> section of the <a href="<?php print $trac_url . 'wiki'; ?>">Wiki</a>, where we keep track of questions
199    frequently fielded on our <a href="contact.php#lists">mailing lists</a>.</p>
201    <p>If any of these resources do not answer your questions or if you need any kind of extended support, there are many ways
202    to <a href="contact.php">contact us</a>!</p>
209  print_footer();
Note: See TracBrowser for help on using the repository browser.