Changeset 70151 for trunk/doc-new


Ignore:
Timestamp:
Jul 30, 2010, 6:11:45 PM (9 years ago)
Author:
jmr@…
Message:

guide: correct references to "option" that should have been "action", and improve descriptions of list, installed and outdated actions

File:
1 edited

Legend:

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

    r38337 r70151  
    2020      <title>selfupdate</title>
    2121
    22       <para>The <option>selfupdate</option> option should be used regularly to
     22      <para>The <option>selfupdate</option> action should be used regularly to
    2323      <option>sync</option> the local ports tree with the global MacPorts
    2424      ports repository so you will have the latest port versions. It also
     
    2828      <note>
    2929        <para>Selfupdate runs only on Mac OS X. If you are running MacPorts on
    30         another platform, you must use option <link
    31         linkend="using.port.sync">sync</link> to update the ports tree; to
     30        another platform, you must use the <link
     31        linkend="using.port.sync">sync</link> action to update the ports tree; to
    3232        update MacPorts base you must manually install a newer version from
    3333        source.</para>
     
    6767      <title>sync</title>
    6868
    69       <para>The <option>sync</option> option performs a subset of
     69      <para>The <option>sync</option> action performs a subset of
    7070      <option>selfupdate</option> actions. It synchronizes the ports tree, as
    7171      does <option>selfupdate</option>, but it does not check for upgrades to
     
    8484      <title>list</title>
    8585
    86       <para>The <option>list</option> option is used to get a list of all
    87       available ports. The list of available ports is very long, so use <link
     86      <para>The <option>list</option> action lists the currently available version of
     87      the specified ports, or if no ports are specified, displays a list of all available
     88      ports. The list of available ports is very long, so use <link
    8889      linkend="using.port.search">search</link> if you know a port's name or
    8990      part of it.</para>
     
    9596      <title>search</title>
    9697
    97       <para>The <option>search</option> option is very useful to find port
     98      <para>The <option>search</option> action is very useful to find port
    9899      names by partial matches.</para>
    99100
     
    107108      <title>info</title>
    108109
    109       <para>The <option>info</option> option is used to get information about
     110      <para>The <option>info</option> action is used to get information about
    110111      a port: description, maintainer, etc.</para>
    111112
     
    124125      <title>deps</title>
    125126
    126       <para>The <option>deps</option> option shows you the dependencies of a
     127      <para>The <option>deps</option> action shows you the dependencies of a
    127128      port; dependencies are explicitly declared in
    128129      <filename>Portfile</filename>s.</para>
     
    141142      <title>variants</title>
    142143
    143       <para>The <option>variants</option> option allows you to check what
     144      <para>The <option>variants</option> action allows you to check what
    144145      variations of a port are available before you install it. Variants are a
    145146      way for port authors to provide options that may be invoked at install
     
    159160      <title>install</title>
    160161
    161       <para>The option <option>install</option> is used to install a port. See
     162      <para>The action <option>install</option> is used to install a port. See
    162163      <link linkend="using.variants.invoking">Invoking Port Variants</link>
    163164      below to install ports that have variants.</para>
     
    177178      <title>clean</title>
    178179
    179       <para>The option <option>clean</option> deletes all intermediate files
     180      <para>The action <option>clean</option> deletes all intermediate files
    180181      that MacPorts creates while building a port. A <userinput>port
    181182      clean</userinput> is also often necessary to remove corrupted tarballs
     
    194195      <title>uninstall</title>
    195196
    196       <para>The <option>uninstall</option> option will uninstall an installed
     197      <para>The <option>uninstall</option> action will uninstall an installed
    197198      port.</para>
    198199
     
    214215      <title>contents</title>
    215216
    216       <para>The <option>contents</option> option displays the files that have
     217      <para>The <option>contents</option> action displays the files that have
    217218      been installed by a given port. Uninstalled ports will always show no
    218219      contents.</para>
     
    231232      <title>installed</title>
    232233
    233       <para>The <option>installed</option> option displays all installed
     234      <para>The <option>installed</option> action displays the installed versions,
     235      variants and activation status of the
     236      specified ports, or if no ports are specified, all installed
    234237      ports.</para>
    235238
     
    253256      <title>outdated</title>
    254257
    255       <para>The <option>outdated</option> option checks your installed ports
    256       against the MacPorts repository to see if updated Portfiles have been
    257       released since your ports were installed.</para>
     258      <para>The <option>outdated</option> action checks your installed ports
     259      against the current ports tree to see if updated Portfiles have been
     260      released since your ports were installed. Note that you will not see new
     261      versions unless you have updated your ports tree using <option>selfupdate</option>
     262      or <option>sync</option>.</para>
    258263
    259264      <programlisting><prompt>%%</prompt> <userinput>port outdated</userinput></programlisting>
     
    269274      <title>upgrade</title>
    270275
    271       <para>The <option>upgrade</option> option upgrades installed ports and
     276      <para>The <option>upgrade</option> action upgrades installed ports and
    272277      their dependencies when a <filename>Portfile</filename> in the
    273278      repository has been updated after a port was installed.</para>
     
    286291
    287292      <note>
    288         <para>The <option>upgrade</option> option by default does not
     293        <para>The <option>upgrade</option> action by default does not
    289294        uninstall an upgraded port —it deactivates it. See section <link
    290295        linkend="internals.images">Port Images</link>, and also Destroot and
     
    300305      <title>dependents</title>
    301306
    302       <para>The <option>dependents</option> option reports what ports depend
     307      <para>The <option>dependents</option> action reports what ports depend
    303308      upon a given port, if any. MacPorts learns about dependents during port
    304309      installation, so uninstalled ports will always report that there are no
     
    315320      <title>livecheck</title>
    316321
    317       <para>The livecheck option checks to see if the application
     322      <para>The livecheck action checks to see if the application
    318323      corresponding to a given port has been updated at the developer's
    319324      download site. It's especially useful for port maintainers, but others
     
    338343      <title>lint</title>
    339344
    340       <para>The lint option checks if the Portfile conforms to the MacPorts
     345      <para>The lint action checks if the Portfile conforms to the MacPorts
    341346      standards specified in <link linkend="development">Portfile
    342347      Development</link>.</para>
Note: See TracChangeset for help on using the changeset viewer.