macports-www/install.php

<?php
    /* -*- coding: utf-8; mode: php; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- vim:set fenc=utf-8 filetype=php et sw=4 ts=4 sts=4: */
    /* Copyright (c) 2004, OpenDarwin. */
    /* Copyright (c) 2004-2013, The MacPorts Project. */
    include_once("includes/common.inc");
    print_header('The MacPorts Project -- Download &amp; Installation', 'utf-8');
?>


<div id="content">

    <h2 class="hdr" id="quickstart">Quickstart</h2>

    <ol>
        <li>Install Apple's Command Line Developer Tools: <code>xcode-select --install</code></li>
        <li>Install MacPorts for your version of the Mac operating system:
            <ul>
                <li><a href="<?php echo $tahoe_pkg; ?>">macOS Tahoe v26</a></li>
                <li><a href="<?php echo $sequoia_pkg; ?>">macOS Sequoia v15</a></li>
                <li><a href="<?php echo $sonoma_pkg; ?>">macOS Sonoma v14</a></li>
                <li><a href="<?php echo $ventura_pkg; ?>">macOS Ventura v13</a></li>
                <li><a href="#installing">Older OS? See here.</a></li>
            </ul>
        </li>
    </ol>

    <h2 class="hdr" id="installing">Installing MacPorts</h2>

    <p>MacPorts version <?php print $macports_version_latest; ?> is available in various formats for download and installation (note, if you are upgrading to a new major release of macOS, see the <a href="<?php print $trac_url . 'wiki/Migration'; ?>">migration info page</a>):
    </p>

    <ul>
        <li>&#8220;pkg&#8221; installers for
        <a href="<?php print $tahoe_pkg; ?>">Tahoe</a>,
        <a href="<?php print $sequoia_pkg; ?>">Sequoia</a>,
        <a href="<?php print $sonoma_pkg; ?>">Sonoma</a>, and
        <a href="<?php print $ventura_pkg; ?>">Ventura</a>,
        for use with the macOS Installer.
        This is the simplest installation
        procedure that most users should <a href="#pkg">follow</a> after meeting the requirements listed <a href="#requirements">
        below</a>. Installers for legacy platforms
        <a href="<?php print $monterey_pkg; ?>">Monterey</a>,
        <a href="<?php print $bigsur_pkg; ?>">Big Sur</a>,
        <a href="<?php print $catalina_pkg; ?>">Catalina</a>,
        <a href="<?php print $mojave_pkg; ?>">Mojave</a>,
        <a href="<?php print $highsierra_pkg; ?>">High Sierra</a>,
        <a href="<?php print $sierra_pkg; ?>">Sierra</a>,
        <a href="<?php print $elcapitan_pkg; ?>">El Capitan</a>,
        <a href="<?php print $yosemite_pkg; ?>">Yosemite</a>,
        <a href="<?php print $mavericks_pkg; ?>">Mavericks</a>,
        <a href="<?php print $mountainlion_pkg; ?>">Mountain Lion</a>,
        <a href="<?php print $lion_pkg; ?>">Lion</a>,
        <a href="<?php print $snowleopard_pkg; ?>">Snow Leopard</a>,
        and <a href="<?php print $leopard_dmg; ?>">Leopard</a> are
        also available.</li>
        <li>In <a href="#source">source form</a> as either a <a href="<?php print $bz2_tarball ?>">tar.bz2</a> package or a
        <a href="<?php print $gz_tarball; ?>">tar.gz</a> one for manual compilation, if you intend to customize your installation
        in any way.</li>
        <li><a href="#git">Git clone</a> of the unpackaged sources, if you wish to follow MacPorts development.</li>
        <li>The <a href="#selfupdate">selfupdate</a> target of the <kbd>port(1)</kbd> command, for users who already have
        MacPorts installed and wish to upgrade to a newer release.</li>
    </ul>

    <p>Checksums for our packaged <a href="<?php print $downloads_overview; ?>">downloads</a> are contained in the corresponding <a
    href="<?php print $checksums; ?>">checksums file</a>.</p>
    
    <p>The public key to verify the detached GPG signatures can be found under the <a href="https://trac.macports.org/wiki/jmr#no1">attachments section on jmr's wiki page</a>. (<a href="https://trac.macports.org/attachment/wiki/jmr/jmr_at_macports_org-2013.pubkey">Direct Link</a>).</p>


    <div id="requirements">

        <p>For some ports, your system might require installations of the following components:</p>

        <ol>
            <li><p>Apple's Command Line Developer Tools, in case a port you're installing or one of its dependencies
            are not available as binaries.</p>
            <p>It can be installed on recent OS versions by running this command in the Terminal:</p>
            <pre>xcode-select --install</pre>
            <p>Older versions are found at the <a href="https://developer.apple.com/downloads/">Apple Developer</a> site,
            or they can be installed from within Xcode back to version 4.  Users of Xcode 3 or earlier can install them by ensuring that the appropriate
            option(s) are selected at the time of Xcode's install ("UNIX Development", "System Tools", "Command Line Tools", or
            "Command Line Support").</p></li>
            <li><p>(Optional) Apple's <a href="https://developer.apple.com/technologies/tools/">Xcode</a> Developer Tools, when building some ports from source.
            MacPorts will let you know if this is the case.</p>
            <p>Using the latest available version that will run on your OS is highly recommended, except for Snow Leopard where the last free version,
            3.2.6, is recommended:</p>
            <ul>
                <li>26.0 or later for Tahoe</li>
                <li>16.0 or later for Sequoia</li>
                <li>15.0 or later for Sonoma</li>
                <li>14.1 or later for Ventura</li>
                <li>13.1 or later for Monterey</li>
                <li>12.2 or later for Big Sur</li>
                <li>11.3 or later for Catalina</li>
                <li>10.0 or later for Mojave</li>
                <li>9.0 or later for High Sierra</li>
                <li>8.0 or later for Sierra</li>
                <li>7.0 or later for El Capitan</li>
                <li>6.1 or later for Yosemite</li>
                <li>5.0.1 or later for Mavericks</li>
                <li>4.4 or later for Mountain Lion</li>
                <li>4.1 or later for Lion</li>
                <li>3.2 or later for Snow Leopard</li>
                <li>3.1 or later for Leopard</li>
            </ul>
            <p>It can be found on the <a href="https://developer.apple.com/downloads/">Apple Developer</a>
            site, on your Mac operating system installation CDs/DVD, or in the Mac App Store.</p>
            <p>With Xcode 4 and later, users need to accept the Xcode EULA by either launching Xcode or running:</p>
            <pre>xcodebuild -license</pre>
            </li>
            <li>(Optional) The X11 windowing environment, for ports that depend on the functionality it provides to run.  You have
            multiple choices for an X11 server:
                <ul>
                    <li>Install the xorg-server port from MacPorts (recommended).</li>
                    <li>The <a href="https://www.xquartz.org">XQuartz Project</a> provides a complete X11 release
                    for macOS including server and client libraries and applications.</li>
                    <li>Apple's X11.app is provided by the &#8220;X11 User&#8221; package on older OS versions. It is always installed on Lion, and
                    is an optional installation on your system CDs/DVD with previous OS versions.</li>
                </ul>
            </li>
        </ol>

    </div>


    <h3 class="subhdr" id="pkg">macOS Package (.pkg) Installer</h3>

    <p>The easiest way to install MacPorts on a Mac is by downloading the pkg or dmg for
    <a href="<?php print $tahoe_pkg; ?>">Tahoe</a>,
    <a href="<?php print $sequoia_pkg; ?>">Sequoia</a>,
    <a href="<?php print $sonoma_pkg; ?>">Sonoma</a>,
    <a href="<?php print $ventura_pkg; ?>">Ventura</a>,
    <a href="<?php print $monterey_pkg; ?>">Monterey</a>,
    <a href="<?php print $bigsur_pkg; ?>">Big Sur</a>,
    <a href="<?php print $catalina_pkg; ?>">Catalina</a>,
    <a href="<?php print $mojave_pkg; ?>">Mojave</a>,
    <a href="<?php print $highsierra_pkg; ?>">High Sierra</a>,
    <a href="<?php print $sierra_pkg; ?>">Sierra</a>,
    <a href="<?php print $elcapitan_pkg; ?>">El Capitan</a>,
    <a href="<?php print $yosemite_pkg; ?>">Yosemite</a>,
    <a href="<?php print $mavericks_pkg; ?>">Mavericks</a>,
    <a href="<?php print $mountainlion_pkg; ?>">Mountain Lion</a>,
    <a href="<?php print $lion_pkg; ?>">Lion</a>,
    <a href="<?php print $snowleopard_pkg; ?>">Snow Leopard</a>,
    or <a href="<?php print $leopard_dmg; ?>">Leopard</a>
    and running the system's Installer by double-clicking on the pkg contained therein,
    following the on-screen instructions until completion.</p>

    <p>This procedure will place a fully-functional and default MacPorts installation on your host system, ready for usage.
    If needed your shell configuration files will be <a href="<?php print $guide_url . '#installing.shell'; ?>">adapted by
    the installer</a> to include the necessary settings to run MacPorts and the programs it installs, but you may need to
    open a new shell for these changes to take effect.</p>

    <p>The MacPorts &#8220;<kbd>selfupdate</kbd>&#8221; command will also be run for you by the installer to ensure you have our
    latest available release and the latest revisions to the &#8220;Portfiles&#8221; that contain the instructions employed
    in the building and installation of ports. After installation is done, it is recommended that you run this step manually
    on a regular basis to to keep your MacPorts system always current:</p>

    <pre>sudo port -v selfupdate</pre>

    <p>At this point you should be ready to enjoy MacPorts!</p>

    <p>Type &#8220;<kbd>man port</kbd>&#8221; at the command line prompt and/or browse over to our <a href="<?php print
    $guide_url; ?>">Guide</a> to find out more information about using MacPorts. <a href="#help">Help</a> is also available.
    </p>


    <h3 class="subhdr" id="source">Source Installation</h3>

    <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
    after downloading the tarball before you can start installing ports, namely compiling and installing MacPorts itself:</p>


    <ol>
        <li>&#8220;<kbd>cd</kbd>&#8221; into the directory where you downloaded the package and run &#8220;<kbd>tar xjvf
        <a href="<?php print $bz2_tarball; ?>">MacPorts-<?php print $macports_version_latest; ?>.tar.bz2</a></kbd>&#8221; or
        &#8220;<kbd>tar xzvf <a href="<?php print $gz_tarball; ?>">MacPorts-<?php print $macports_version_latest; ?>.tar.gz</a></kbd>&#8221;,
        depending on whether you downloaded the bz2 tarball or the gz one, respectively.</li>
        <li>Build and install the recently unpacked sources:
            <ul>
                <li><kbd>cd MacPorts-<?php print $macports_version_latest; ?></kbd></li>
                <li><kbd>./configure &amp;&amp; make &amp;&amp; sudo make install</kbd></li>
            </ul>
            Optionally:
            <ul>
                <li><kbd>cd ../</kbd></li>
                <li><kbd>rm -rf MacPorts-<?php print $macports_version_latest; ?>*</kbd></li>
            </ul>

        </li>
    </ol>

    <p>These steps need to be perfomed from an administrator account, for which &#8220;<kbd>sudo</kbd>&#8221; will ask the
    password upon installation. This procedure will install a pristine MacPorts system and, if the optional steps are taken,
    remove the as of now unnecessary MacPorts-<?php print $macports_version_latest; ?> source directory and corresponding tarball.</p>

    <p>To customize your installation you should read the output of &#8220;<kbd>./configure --help | more</kbd>&#8221; and
    pass the appropriate options for the settings you wish to tweak to the configuration script in the steps detailed above.</p>

    <p>You will need to manually adapt your shell's environment to work with MacPorts and your chosen installation <kbd>
    prefix</kbd> (the value passed to <kbd>configure</kbd>'s <kbd>--prefix</kbd> flag, defaulting to <kbd>/opt/local</kbd>):
    </p>

    <ul>
        <li><kbd>Add ${prefix}/bin</kbd> and <kbd>${prefix}/sbin</kbd> to the start of your <kbd>PATH</kbd> environment variable
        so that MacPorts-installed programs take precedence over system-provided programs of the same name.</li>
        <li>If a standard <kbd>MANPATH</kbd> environment variable already exists (that is, one that doesn't contain any empty
        components), add the <kbd>${prefix}/share/man</kbd> path to it so that MacPorts-installed man pages are found by your
        shell.</li>
        <li>For Tiger and earlier only, add an appropriate X11 <kbd>DISPLAY</kbd> environment variable to run X11-dependent
        programs, as Leopard takes care of this requirement on its own.</li>
    </ul>

    <p>Lastly, you need to synchronize your installation with the MacPorts rsync server:</p>

    <pre>sudo port -v selfupdate</pre>

    <p>Upon completion MacPorts will be ready to install ports!</p>

    <p>It is recommended to run the above command on a regular basis to keep your installation current. Type &#8220;<kbd>man
    port</kbd>&#8221; at the command line prompt and/or browse over to our <a href="<?php print $guide_url; ?>">Guide</a> to
    find out more information about using MacPorts. <a href="#help">Help</a> is also available.</p>


    <h3 class="subhdr" id="git">Git Sources</h3>

    <p>If you are developer or a user with a taste for the bleeding edge and wish for the latest changes and feature additions,
    you may acquire the MacPorts sources through git. See the Guide section on <a href="<?php print $guide_url; ?>#installing.macports.git">installing from git</a>.</p>

    <p>Purpose-specific branches are also available at the <kbd><?php print $github_url . 'macports-base/branches'; ?></kbd> url.</p>

    <p>Alternatively, if you'd simply like to view the git repository without checking it out, you can do so via the <a
    href="<?php print $github_url . 'macports-base/'; ?>">GitHub web interface</a>.</p>


    <h3 class="subhdr" id="selfupdate">Selfupdate</h3>

    <p>If you already have MacPorts installed and have no restrictions to use the rsync networking protocol (tcp port 873 by
    default), the easiest way to upgrade to our latest available release, <b><?php print $macports_version_latest; ?></b>, is
    by using the <kbd>selfupdate</kbd> target of the <kbd>port(1)</kbd> command. This will both update your ports tree (by
    performing a <kbd>sync</kbd> operation) and rebuild your current installation if it's outdated, preserving your customizations,
    if any.</p>


    <h3 class="subhdr" id="other">Other Platforms</h3>

    <p>Running on platforms other than macOS is not the main focus of The MacPorts Project, so remaining cross-platform is
    not an actively-pursued development goal. Nevertheless, it is not an actively-discouraged goal either and as a result some
    experimental support does exist for other POSIX-compliant platforms such as *BSD and GNU/Linux.</p>

    <p>The full list of requirements to run MacPorts on these other platforms is as follows (we assume you have the basics such
    as GCC and X11):</p>

    <ul>
        <li><b>mtree</b> for directory hierarchy.</li>
        <li><a href="http://rsync.samba.org/">rsync</a> for syncing the ports.</li>
        <li><a href="http://curl.haxx.se/">cURL</a> for downloading distfiles.</li>
        <li><a href="https://gnustep.github.io/">GNUstep</a> (Base), for Foundation (optional, can be disabled via configure args).</li>
        <li><a href="http://www.openssl.org/">OpenSSL</a> for signature verification, and optionally for checksums. <b>libmd</b> may
            be used instead for checksums.</li>
    </ul>

    <p>Normally you must install from <a href="#source">source</a> or from an <a href="#git">git checkout</a> to run MacPorts
    on any of these platforms.</p>


    <h3 class="subhdr" id="help">Help</h3>

    <p>Help on a wide variety of topics is also available in the project <a href="<?php print $guide_url; ?>">Guide</a> and
    through our <a href="<?php print $trac_url; ?>">Trac portal</a> should you run into any problems installing and/or using
    MacPorts. Of particular relevance are the <a href="<?php print $guide_url . '#installing'; ?>">installation</a> &amp;
    <a href="<?php print $guide_url . '#using'; ?>">usage</a> sections of the former and the <a href="<?php print $trac_url .
    'wiki/FAQ'; ?>">FAQ</a> section of the <a href="<?php print $trac_url . 'wiki'; ?>">Wiki</a>, where we keep track of questions
    frequently fielded on our <a href="contact.php#Lists">mailing lists</a>.</p>

    <p>If any of these resources do not answer your questions or if you need any kind of extended support, there are many ways
    to <a href="contact.php">contact us</a>!</p>


</div>


<?php
    print_footer();
?>