Changeset 28008 for trunk/doc


Ignore:
Timestamp:
Aug 17, 2007, 7:26:19 PM (12 years ago)
Author:
markd@…
Message:

Add a section for 'port sync' and minor cleanup.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/guide/new/xml/using.xml

    r27992 r28008  
    2020      <title>selfupdate</title>
    2121
    22       <para>The selfupdate option should be used regularly to download new
    23       ports and updated versions of current ports. It also checks for later
    24       revisions of the MacPorts infrastructure and updates it when
    25       necessary.</para>
     22      <para>The <option>selfupdate</option> option should be used regularly to
     23      <option>sync</option> the local ports tree with the global MacPorts
     24      ports repository to get the latest port updates. It also checks for new
     25      revisions of the MacPorts infrastructure, called MacPorts base, and
     26      upgrades it when necessary.</para>
    2627
    2728      <programlisting><prompt>%%</prompt> <userinput>sudo port selfupdate</userinput></programlisting>
     
    4243
    4344    <section>
     45      <title>sync</title>
     46
     47      <para>The sync option performs a subset of selfupdate actions. It
     48      synchonizes the ports tree, as does <option>selfupdate</option>, but it
     49      does not check for upgrades to MacPorts base. Unless you have a special
     50      reason not to, you should use <option>selfupdate</option>. </para>
     51    </section>
     52
     53    <section>
    4454      <title>list</title>
    4555
    46       <para>The <userinput>list</userinput> option is used to get a list of
    47       all available ports.</para>
     56      <para>The <option>list</option> option is used to get a list of all
     57      available ports.</para>
    4858
    4959      <programlisting><prompt>%%</prompt> <userinput>port list</userinput></programlisting>
     
    5363      <title>search</title>
    5464
    55       <para>The <userinput>search</userinput> option is very useful to find
    56       port names by partial matches.</para>
     65      <para>The <option>search</option> option is very useful to find port
     66      names by partial matches.</para>
    5767
    5868      <programlisting><prompt>%%</prompt> <userinput>port search rrd</userinput></programlisting>
     
    6575      <title>info</title>
    6676
    67       <para>The <userinput>info</userinput> option is used to get information
    68       about a port: description, maintainer, etc.</para>
     77      <para>The <option>info</option> option is used to get information about
     78      a port: description, maintainer, etc.</para>
    6979
    7080      <programlisting><prompt>%%</prompt> <userinput>port info flowd</userinput></programlisting>
     
    8292      <title>deps</title>
    8393
    84       <para>The <userinput>deps</userinput> option shows you the dependencies
    85       of a port; dependencies are explicitly declared in
     94      <para>The <option>deps</option> option shows you the dependencies of a
     95      port; dependencies are explicitly declared in
    8696      <filename>Portfile</filename>s.</para>
    8797
     
    99109      <title>variants</title>
    100110
    101       <para>The <userinput>variants</userinput> option allows you to check
    102       what variations of a port are available before you install it. Variants
    103       are a way for port authors to provide options that may be invoked at
    104       install time.</para>
     111      <para>The <option>variants</option> option allows you to check what
     112      variations of a port are available before you install it. Variants are a
     113      way for port authors to provide options that may be invoked at install
     114      time. See the Variants" section below for install instructions.</para>
    105115
    106116      <programlisting><prompt>%%</prompt> <userinput>port variants nmap</userinput></programlisting>
     
    116126      <title>install</title>
    117127
    118       <para>The option <userinput>install</userinput> is used to install a
     128      <para>The option <option>install</option> is used to install a
    119129      port.</para>
    120130
     
    124134        <para>You may break up a port's installation into smaller steps for
    125135        troubleshooting by passing <command>port</command> a prior
    126         installation phase such as <userinput>fetch</userinput>,
    127         <userinput>configure</userinput>, <userinput>build</userinput>, or
    128         <userinput>destroot</userinput>.</para>
     136        installation phase such as fetch, configure, build, or
     137        destroot.</para>
    129138      </note>
    130139
    131       <para>Variants are a way for port authors to provide options for ports
    132       that may be invoked at install time. Variants are invoked by appending
    133       the name preceeded by a "+" after the install option.</para>
    134 
    135140      <programlisting><prompt>%%</prompt> <userinput>sudo port install nmap +no_ssl</userinput></programlisting>
    136141    </section>
     
    139144      <title>clean</title>
    140145
    141       <para>The option <userinput>clean</userinput> deletes all intermediate
    142       files that MacPorts creates while building a port. A <userinput>port
     146      <para>The option <option>clean</option> deletes all intermediate files
     147      that MacPorts creates while building a port. A <userinput>port
    143148      clean</userinput> is also often necessary to remove corrupted tarballs
    144149      after a failed <userinput>fetch</userinput> phase.</para>
     
    148153      <note>
    149154        <para>You may also clean files selectively by using options
    150         <userinput>--dist</userinput>, <userinput>--archive</userinput>, or
    151         <userinput>--work</userinput>.</para>
     155        <option>--dist</option>, <option>--archive</option>, or
     156        <option>--work</option>.</para>
    152157      </note>
    153158    </section>
     
    156161      <title>uninstall</title>
    157162
    158       <para>The <userinput>uninstall</userinput> option will uninstall an
    159       installed port.</para>
     163      <para>The <option>uninstall</option> option will uninstall an installed
     164      port.</para>
    160165
    161166      <programlisting><prompt>%%</prompt> <userinput>port uninstall vile</userinput></programlisting>
     
    175180      <title>contents</title>
    176181
    177       <para>The <userinput>contents</userinput> option displays the files that
    178       have been installed by a given port.</para>
     182      <para>The <option>contents</option> option displays the files that have
     183      been installed by a given port.</para>
    179184
    180185      <programlisting><prompt>%%</prompt> <userinput>port contents render</userinput></programlisting>
     
    191196      <title>installed</title>
    192197
    193       <para>The <userinput>installed</userinput> option displays all installed
     198      <para>The <option>installed</option> option displays all installed
    194199      ports.</para>
    195200
     
    213218      <title>outdated</title>
    214219
    215       <para>The <userinput>outdated</userinput> option checks your installed
    216       ports against the MacPorts repository to see if updated
    217       <filename>Portfile</filename>s have been released since your ports were
    218       installed.</para>
     220      <para>The <option>outdated</option> option checks your installed ports
     221      against the MacPorts repository to see if updated Portfiles have been
     222      released since your ports were installed.</para>
    219223
    220224      <programlisting><prompt>%%</prompt> <userinput>port outdated</userinput></programlisting>
     
    230234      <title>upgrade</title>
    231235
    232       <para>The <userinput>upgrade</userinput> option upgrades installed ports
    233       and their dependencies when a <filename>Portfile</filename> in the
     236      <para>The <option>upgrade</option> option upgrades installed ports and
     237      their dependencies when a <filename>Portfile</filename> in the
    234238      repository has been updated after a port was installed.</para>
    235239
    236       <programlisting><userinput>%%</userinput> <userinput>port upgrade gnome</userinput></programlisting>
     240      <programlisting><prompt>%%</prompt> <userinput>port upgrade gnome</userinput></programlisting>
    237241
    238242      <para>If you wish not to upgrade a port's dependencies, use the -n
    239       option.</para>
     243      switch.</para>
    240244
    241245      <programlisting><prompt>%%</prompt> <userinput>port -n upgrade gnome</userinput></programlisting>
     
    247251
    248252      <note>
    249         <para>The <userinput>upgrade</userinput> option by default does not
     253        <para>The <option>upgrade</option> option by default does not
    250254        uninstall an upgraded port —it deactivates it (see section Port
    251255        Installation Phases below). If you wish to uninstall the old version
Note: See TracChangeset for help on using the changeset viewer.