Changeset 73671 for trunk/doc-new


Ignore:
Timestamp:
Nov 21, 2010, 5:01:35 AM (9 years ago)
Author:
jmr@…
Message:

guide: in the Using Macports chapter,

  • add the help action,
  • mention options to search action,
  • update examples and their output
  • mention -v option's effect on installed action
  • warn that -n causes problems
File:
1 edited

Legend:

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

    r73026 r73671  
    1616    <filename>Portfile</filename>s and the MacPorts infrastructure, and
    1717    install and manage ports.</para>
     18
     19    <section id="using.port.help">
     20      <title>help</title>
     21
     22      <para>The <option>help</option> action shows some brief information about
     23      the specified action, or if no action is specified, shows basic usage
     24      information for the <command>port</command> command in general.</para>
     25
     26      <programlisting><prompt>%%</prompt> <userinput>port help selfupdate</userinput></programlisting>
     27      <screen>Usage: selfupdate --nosync
     28
     29Upgrade MacPorts itself and run the sync target</screen>
     30    </section>
    1831
    1932    <section id="using.port.selfupdate">
     
    96109      <title>search</title>
    97110
    98       <para>The <option>search</option> action is very useful to find port
    99       names by partial matches.</para>
     111      <para>The <option>search</option> action allows finding ports
     112      by partial matches of the name or description. Other fields can be matched
     113      against, and matched in different ways, by using options. Run <userinput>port help search</userinput>
     114      for details.</para>
    100115
    101116      <programlisting><prompt>%%</prompt> <userinput>port search rrd</userinput></programlisting>
    102117
    103       <screen>rrdtool          net/rrdtool       1.2.23    Round Robin Database
    104 php5-rrdtool     www/php5-rrdtool  1.0       PHP 5 glue for RRDtool</screen>
     118      <screen>php5-rrdtool @1.0 (php, net, devel)
     119    PHP 5 glue for rrdtool
     120
     121rrdtool @1.4.4 (net)
     122    Round Robin Database
     123
     124Found 2 ports.</screen>
    105125    </section>
    106126
     
    113133      <programlisting><prompt>%%</prompt> <userinput>port info flowd</userinput></programlisting>
    114134
    115       <screen>flowd 0.9, net/flowd (Variants: universal, darwin_8)
    116 http://www.mindrot.org/flowd.html
    117 
    118 flowd is a small, fast and secure NetFlow collector.
    119 
    120 Platforms: darwin
    121 Maintainers: nomaintainer@macports.org</screen>
     135      <screen>flowd @0.9 (net)
     136Variants:             universal
     137
     138Description:          flowd is a small, fast and secure NetFlow collector.
     139Homepage:             http://www.mindrot.org/flowd.html
     140
     141Platforms:            darwin
     142License:              unknown
     143Maintainers:          nomaintainer@macports.org</screen>
    122144    </section>
    123145
     
    131153      <programlisting><prompt>%%</prompt> <userinput>port deps apache2</userinput></programlisting>
    132154
    133       <screen>apache2 has library dependencies on:
    134         apr
    135         apr-util
    136         expat
    137         openssl
    138         pcre</screen>
     155      <screen>Full Name: apache2 @2.2.17_0+preforkmpm
     156Library Dependencies: apr, apr-util, expat, openssl, pcre</screen>
    139157    </section>
    140158
     
    151169
    152170      <screen>nmap has the variants:
    153         universal
    154         gtk2
    155         no_ssl
    156         no_pcre</screen>
     171   no_pcre: build without pcre support
     172   no_ssl: build without ssl support
     173   universal: Build for multiple architectures
     174   zenmap: build zenmap in addition to nmap</screen>
    157175    </section>
    158176
     
    216234
    217235      <para>The <option>contents</option> action displays the files that have
    218       been installed by a given port. Uninstalled ports will always show no
    219       contents.</para>
    220 
    221       <programlisting><prompt>%%</prompt> <userinput>port contents render</userinput></programlisting>
    222 
    223       <screen>Port render contains:
     236      been installed by a given port. Uninstalled ports cannot have their
     237      contents listed.</para>
     238
     239      <programlisting><prompt>%%</prompt> <userinput>port contents xorg-renderproto</userinput></programlisting>
     240
     241      <screen>Port xorg-renderproto contains:
    224242  /opt/local/include/X11/extensions/render.h
    225243  /opt/local/include/X11/extensions/renderproto.h
    226   /opt/local/lib/pkgconfig/render.pc
    227   /opt/local/share/doc/render/library
    228   /opt/local/share/doc/render/protocol</screen>
     244  /opt/local/lib/pkgconfig/renderproto.pc
     245  /opt/local/share/doc/renderproto/renderproto.txt</screen>
    229246    </section>
    230247
     
    235252      variants and activation status of the
    236253      specified ports, or if no ports are specified, all installed
    237       ports.</para>
     254      ports. Use the <option>-v</option> option to also display the platform and
     255      CPU architecture(s) for which the ports were built, and any variants which were
     256      explicitly negated.</para>
    238257
    239258      <programlisting><prompt>%%</prompt> <userinput>port installed</userinput></programlisting>
     
    247266[ ... trimmed ...]
    248267
    249   wxWidgets @2.8.4_2+darwin_8 (active)
     268  wxWidgets @2.8.4_2 (active)
    250269  Xft2 @2.1.7_0 (active)
    251   xrender @0.9.0_0+darwin_8 (active)
     270  xrender @0.9.0_0 (active)
    252271  zlib @1.2.3_1 (active)</screen>
     272
     273    <programlisting><prompt>%%</prompt> <userinput>port -v installed atlas</userinput></programlisting>
     274    <screen>The following ports are currently installed:
     275  atlas @3.8.3_4+gcc44-gcc43 (active) platform='darwin 10' archs='x86_64'</screen>
    253276    </section>
    254277
     
    281304
    282305      <para>If you wish not to upgrade a port's dependencies, use the
    283       <option>-n</option> switch.</para>
     306      <option>-n</option> switch. Note that this will often cause problems.</para>
    284307
    285308      <programlisting><prompt>%%</prompt> <userinput>port -n upgrade gnome</userinput></programlisting>
Note: See TracChangeset for help on using the changeset viewer.