Changeset 8630 for trunk/doc


Ignore:
Timestamp:
Oct 6, 2004, 8:57:28 PM (15 years ago)
Author:
wbb4
Message:

Bug:
Submitted by:
Reviewed by:
Approved by:
Obtained from:

Update and clean up the Using DarwinPorts chapter, mainly the installation/configuration, to bring it up to date with Panther :)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/guide/xml/user/user.xml

    r8275 r8630  
    120120                        <title>What you need</title>
    121121                       
    122                         <para>Currently DarwinPorts is only supported on Mac OS X 10.2 or later
    123                         (i.e., Darwin 6.0 or later).   However, these instructions should also
    124                         enable it to  work on FreeBSD and NetBSD, at least most of the time;
    125                         not every build of DarwinPorts is tested on those platforms, so some
    126                         minor breakage may creep in from time to time.</para>
    127 
     122                        <para>DarwinPorts primary target platform is Mac OS X 10.3
     123                        "Panther" or later (i.e. Darwin 7.0 or later).  However,
     124                        DarwinPorts should still work on Mac OS X 10.2 "Jaguar", although
     125                        most ports are no longer tested on Jaguar.  DarwinPorts is also
     126                        known to work on various other operating systems such as FreeBSD,
     127                        NetBSD, OpenBSD, and various Linux distributions.  These
     128                        instructions should enable DarwinPorts to be installed on any of
     129                        these platforms.</para>
    128130
    129131                        <para>To install and use DarwinPorts you must install the Developer
    130                         tools (gcc, autoconf etc on other platforms). All the other
    131                         prerequisites are pre-installed on Mac OS X 10.2 and later. On other
    132                         platforms you will need to ensure you have installed Tcl (8.3 or
    133                         later). </para>
    134 
    135                        
     132                        tools (gcc, autoconf etc on other platforms, also known as the
     133                        "Xcode tools" on Mac OS X 10.3.)  All the other prerequisites are
     134                        pre-installed on Mac OS X 10.2 and later. On other platforms you
     135                        will need to ensure you have installed Tcl (8.3 or later). </para>
     136
    136137                </sect2>
    137138               
     
    152153                        directory (i.e. /Users/mike/darwinports/) you should replace the username
    153154                        with your own username and edit the commands I give so they work
    154                         correctly on your installation. <programlisting><![CDATA[
    155  
    156 % cd ~/
     155                        correctly on your installation. <programlisting><![CDATA[% cd ~/
    157156% cvs -d :pserver:anonymous@anoncvs.opendarwin.org:/Volumes/src/cvs/od login
    158 % cvs -d :pserver:anonymous@anoncvs.opendarwin.org:/Volumes/src/cvs/od co -P darwinports
    159 ]]>
    160                                 </programlisting></para>
    161        
     157% cvs -d :pserver:anonymous@anoncvs.opendarwin.org:/Volumes/src/cvs/od co -P darwinports ]]></programlisting></para>
    162158                       
    163159                        <para>These commands first ensure you are currently in your home
     
    178174                        ports as it can be used to update your port descriptions (and
    179175                        is currently the only way to do so). </para>
    180 
    181176                       
    182177                </sect2>
     
    190185                        the <userinput>cd</userinput> command appropriately if you did
    191186                        otherwise.
    192                         <programlisting><![CDATA[
    193 % cd ~/darwinports/base
     187                        <programlisting><![CDATA[% cd ~/darwinports/base
    194188% ./configure
    195189% make
    196 % sudo make install
    197 ]]>
    198                         </programlisting>
     190% sudo make install]]></programlisting>
    199191                        This will compile and install all the necessary software. In order
    200192                        to install DarwinPorts on *BSD the default group-ownership must be
    201193                        passed to each make command: <userinput>make DSTGRP=wheel
    202194                        </userinput>.</para>
    203 
    204                        
    205                         <para>To configure DarwinPorts you should edit
    206                         /etc/ports/sources.conf. The sources.conf lists the location of
    207                         both local and remote port software hierarchies (Currently there is
    208                         not a remote repository). Add an entry for your local ports tree:
    209                         <userinput>file:///Users/mike/darwinports/dports</userinput>. To
    210                         edit the file you must use a command line text editor like pico
    211                         or vi. </para>
    212 
    213                         <para>Please note, if you are using Mac OS X 10.2 "Jaguar", then
    214                                 you will need to edit <file>/etc/ports/ports.conf</file> and
     195                </sect2>
     196
     197                <sect2 id='configure_dports'>
     198                        <title>Configuring for DarwinPorts</title>
     199                       
     200                        <para>It is no longer necessary to edit
     201                        <filename>/etc/ports/sources.conf</filename> after installing
     202                        DarwinPorts.  If you change the location of the
     203                        <filename>dports</filename> directory, which was in
     204                        <filename>~/darwinports/dports</filename> based on the above
     205                        examples, then you will still need to edit
     206                        <filename>/etc/ports/sources.conf</filename> and modify the
     207                        <userinput>file:///Users/mike/darwinports/dports</userinput> line
     208                        to reflect the new location.  To edit the file you must use a
     209                        command line text editor like pico or vi. </para>
     210
     211                        <note><para>Please note, if you are using Mac OS X 10.2 "Jaguar", then
     212                                you will need to edit <filename>/etc/ports/ports.conf</filename> and
    215213                                change: <computeroutput>portinstalltype image</computeroutput>
    216                                 to: <userinput>portinstalltype direct</userinput></para>
     214                                to: <userinput>portinstalltype direct</userinput></para></note>
    217215                       
    218216                        <para>You should add /opt/local/bin (or wherever you chose to
    219                         install DarwinPorts) to your path. If you aren't sure how, add
    220                         <userinput>set path=($path /opt/local/bin)</userinput> to your
    221                         .cshrc file. You may need to create the file first if you
    222                         haven't set one up before. Then close the Terminal window and
    223                         open a new one so the new path setting takes effect.</para>
    224 
    225                        
     217                        install DarwinPorts) to your shell's path.</para>
     218
     219                        <para>If you are using Mac OS X 10.3 "Panther" or a Bourne shell
     220                        (bash, zsh), add the following line to your
     221                        <filename>~/.profile</filename>:</para>
     222
     223                        <para><userinput>export PATH=$PATH:/opt/local/bin</userinput></para>
     224
     225                        <para>If you are using Mac OS X 10.2 "Jaguar" or a C shell (tcsh),
     226                        add the following line to your
     227                        <filename>~/.cshrc</filename>:</para>
     228
     229                        <para><userinput>set path=($path /opt/local/bin)</userinput></para>
     230       
     231                        <para>These changes will not take effect until you have opened a
     232                        new shell.</para>
     233
    226234                        <para>Once you have got this far, you should have a working
    227235                        installation of DarwinPorts, you have installed the 'port'
    228                         command (by default this installed as /opt/local/bin/port)
    229                         and the libraries it needs (in /opt/local/share/darwinports
    230                         and /System/Library/Tcl/8.3/darwinports1.0 by default.
     236                        command (by default this installed as
     237                        <filename>/opt/local/bin/port</filename>)
     238                        and the libraries it needs (in
     239                        <filename>/opt/local/share/darwinports</filename>
     240                        and <filename>/Library/Tcl/darwinports1.0</filename> by
     241                        default.)
    231242                        </para>
    232243
    233244                       
    234245                </sect2>
     246
     247                <sect2  id='updating_dports'>
     248                        <title>Updating DarwinPorts</title>
     249                       
     250                        <para>New ports are always being added to the DarwinPorts dports
     251                        tree, you should regularly update your tree to get access to new
     252                        ports, and (hopefully) improved versions of current ports.  Currently
     253                        the simplest way you can update the dports tree is to use
     254                        <command>cvs</command>.  You can also use <command>cvs</command>
     255                        to fetch a new version of the DarwinPorts infrastructure (eg the
     256                        <command>port</command> command and associated libraries).</para>
     257
     258                        <variablelist>
     259                                <varlistentry>
     260                                        <term>Updating your DarwinPorts ports</term>
     261
     262                                        <listitem>
     263                                                <para>To get the latest Portfiles (the instructions for
     264                                                        building ports), you need to update your
     265                                                        <filename>dports</filename> tree from
     266                                                        <command>cvs</command>:
     267                                                        <programlisting><![CDATA[% cd ~/darwinports/dports
     268% cvs -q -z3 update -dP]]></programlisting></para>
     269
     270                                                <para>By using the -q flag to
     271                                                        <command>cvs</command>, you will see in the output what
     272                                                        Ports have changed or have been added.</para>
     273                                        </listitem>             
     274                                </varlistentry>
     275
     276                                <varlistentry>
     277                                        <term>Updating your DarwinPorts infrastructure</term>
     278
     279                                        <listitem>
     280                                                <para>To get the latest DarwinPorts infrastructure (or
     281                                                        "base") for building ports, you need to update your
     282                                                        <filename>base</filename> from <command>cvs</command>:
     283                                                        <programlisting><![CDATA[% cd ~/darwinports/base
     284% cvs -q -z3 update -dP
     285% ./configure
     286% make clean && make
     287% sudo make install]]></programlisting></para>
     288                                        </listitem>
     289                                </varlistentry>
     290                        </variablelist>
     291                </sect2>
     292
    235293        </sect1>
    236        
    237294       
    238295        <sect1>
     
    345402
    346403                                <varlistentry>
     404                                        <term>Getting Info about a Port</term>
     405
     406                                        <listitem>
     407                                                <para>You may want to get information about a port, such as
     408                                                a description, its maintainer, and more.  You can do this by
     409                                                using the <userinput>info</userinput> option:</para>
     410
     411                                                <para><userinput>port info vim</userinput></para>
     412                                        </listitem>
     413                                </varlistentry>
     414
     415                                <varlistentry>
    347416                                        <term>Listing Ports</term>
    348417
     
    414483                        build an index file called PortIndex.</para>
    415484
    416                        
    417                 </sect2>
    418                
    419                 <sect2  id='updating_dports'>
    420                         <title>Updating DarwinPorts</title>
    421                        
    422                         <para>New ports are always being added to the DarwinPorts dports
    423                         tree, you should regularly update your tree to get access to new
    424                         ports, and (hopefully) improved versions of current ports.  Currently
    425                         the simplest way you can update the dports tree is to use
    426                         <command>cvs</command>.  You can also use <command>cvs</command>
    427                         to fetch a new version of the DarwinPorts infrastructure (eg the
    428                         <command>port</command> command and associated libraries).</para>
    429 
    430                         <variablelist>
    431                                 <varlistentry>
    432                                         <term>Updating your DarwinPorts ports</term>
    433 
    434                                         <listitem>
    435                                                 <para>To get the latest Portfiles (the instructions for
    436                                                         building ports), you need to update your
    437                                                         <filename>dports</filename> tree from
    438                                                         <command>cvs</command>:
    439                                                         <programlisting><![CDATA[
    440 % cd ~/darwinports/dports
    441 % cvs -q -z3 update -dP
    442 ]]>
    443                                                         </programlisting></para>
    444 
    445                                                 <para>By using the -q flag to
    446                                                         <command>cvs</command>, you will see in the output what
    447                                                         Ports have changed or have been added.</para>
    448                                         </listitem>             
    449                                 </varlistentry>
    450 
    451                                 <varlistentry>
    452                                         <term>Updating your DarwinPorts infrastructure</term>
    453 
    454                                         <listitem>
    455                                                 <para>To get the latest DarwinPorts infrastructure (or
    456                                                         "base") for building ports, you need to update your
    457                                                         <filename>base</filename> from <command>cvs</command>:
    458                                                         <programlisting><![CDATA[
    459 % cd ~/darwinports/base
    460 % cvs -q -z3 update -dP
    461 % ./configure
    462 % make clean && make
    463 % sudo make install
    464 ]]>
    465                                                         </programlisting></para>
    466                                         </listitem>
    467                                 </varlistentry>
    468                         </variablelist>
    469                 </sect2>
    470                
     485                </sect2>
     486               
     487       
    471488                <sect2 id='uninstall_dports'>
    472489                        <title>Removing ports</title>
     
    483500                        <para>At the moment there is not a 'port upgrade' command so
    484501                        to upgrade a port you must uninstall and then install it again.
    485                         <programlisting><![CDATA[
    486  
    487 % sudo port uninstall vile
    488 % sudo port install vile
    489 ]]>
    490                                 </programlisting></para>
     502                        <programlisting><![CDATA[% sudo port uninstall vile
     503% sudo port install vile]]></programlisting></para>
    491504
    492505                       
     
    600613
    601614                                                                <programlisting>
    602 <![CDATA[
    603 Portname-1.2.3
     615<![CDATA[Portname-1.2.3
    604616
    605617the error log can be found here: URL or ATTACHED or INLINE
     
    612624================INLINE CONTENT================
    613625--
    614 your sig if you'd like
    615 ]]>
    616                                                 </programlisting>
     626your sig if you'd like]]> </programlisting>
    617627                                                               
    618628                                                </listitem>
Note: See TracChangeset for help on using the changeset viewer.