Ignore:
Timestamp:
Aug 15, 2014, 8:06:28 PM (6 years ago)
Author:
cal@…
Message:

base: document port cd, distfiles, dmg, mdmg, pkg, mpkg, echo, exit, quit, gohome, info; #44530

File:
1 copied

Legend:

Unmodified
Added
Removed
  • trunk/base/doc/port-info.1.txt

    r123711 r123889  
    11// vim: set et sw=4 ts=8 ft=asciidoc tw=80:
    2 port-deps(1)
     2port-info(1)
    33============
    44$Id$
     
    66NAME
    77----
    8 port-deps, port-rdeps - Display a dependency listing for the given port(s)
     8port-info - Return information about the given ports.
    99
    1010SYNOPSIS
    1111--------
    1212[cmdsynopsis]
    13 *port* [*-D* 'portdir'] *deps*
    14      [--index] [--no-build]
    15      [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
    16 
    17 [cmdsynopsis]
    18 *port* [*-D* 'portdir'] *rdeps*
    19      [--full] [--index] [--no-build]
     13*port* [*-q*] [*-D* 'portdir'] *info*
     14     [--categories|--category] [--depends] [--depends_fetch] [--depends_extract]
     15     [--depends_build] [--depends_lib] [--depends_run] [--description] [--epoch]
     16     [--fullname] [--heading] [--homepage] [--index] [--license] [--line]
     17     [--long_description] [--maintainer|--maintainers] [--name]
     18     [--platform|--platforms] [--portdir] [--pretty] [--replaced_by]
     19     [--revision] [--subports] [--variant|--variants] [--version]
    2020     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
    2121
    2222DESCRIPTION
    2323-----------
    24 *port deps* lists all dependencies of the given port(s), i.e., the ports that
    25 need to be installed to build or use a port.
    26 
    27 *port rdeps* recursively descends into the dependencies and displays a tree of
    28 dependencies for a given port.
     24*port info* prints information about the given ports. Specifying at least one of
     25the options limits the output to the corresponding field. If no fields are
     26specified, a useful default set consisting of name, epoch, version, revision,
     27categories, replaced_by, variants, description, homepage, dependencies,
     28platforms, license, and maintainers is shown.
    2929
    3030OPTIONS
    3131-------
    32 *--full*::
    33     When using *rdeps*, display all branches of the dependency tree instead of
    34     listing each dependency only once.
     32The following options do not select fields for the output but change how the
     33information is obtained or formatted:
    3534
    36 *--index*::
    37     Do not read Portfiles, but instead rely solely on the PortIndex information.
    38     Note that this option will prevent the dependencies reported from reflecting
     35--index::
     36    Do not read the Portfile, but rely solely on the port index information.
     37    Note that this option will prevent the information reported from reflecting
    3938    the effects of any variants specified.
    4039
    41 *--no-build*::
    42     Exclude dependencies only required at build time, i.e., fetch, extract, and
    43     build dependencies.
     40--line::
     41    Print a single line for each port. Fields are separated by spaces.
     42
     43--pretty::
     44    Format the output in a convenient, human-readable fashion. This is the
     45    default when no options are specified.
     46
     47The rest of the options affect which fields will be given in the output:
     48
     49--category, or --categories::
     50    List the categories of a port.
     51
     52--depends, --depends_fetch, --depends_extract, --depends_build, --depends_lib, and --depends_run::
     53    List the specified dependencies of a port. *--depends* is a shorthand option
     54    for all other *--depends_** options.
     55
     56--description, and --long_description::
     57    Print the short, and long description of a port, respectively.
     58
     59--epoch, --version, --revision::
     60    List the components of a MacPorts version tuple, epoch, version and
     61    revision, respectively.
     62
     63--fullname::
     64    Print name and the full MacPorts version tuple, e.g., "yubico-pam @2.16".
     65
     66--heading::
     67    Like *--fullname* but including the categories.
     68
     69--homepage::
     70    List the homepage of a port.
     71
     72--license::
     73    Print the license that applies to the source code of a port.
     74
     75--maintainer, or --maintainers::
     76    List the email address(es) of a port's maintainer(s).
     77
     78--name::
     79    Print the name of a port.
     80
     81--platform, or --platforms::
     82    List the platforms supported by a port. This field exists for historical
     83    reasons only. In modern MacPorts, this is always 'darwin', i.e., OS X.
     84
     85--portdir::
     86    Print the path to a port's directory relative to the port tree root.
     87
     88--replaced_by::
     89    List the name of the port that replaces a port, if any.
     90
     91--subports::
     92    Print a list of subports defined by this port's Portfile, i.e., ports that
     93    are defined in the same Portfile because they share common parts.
     94
     95--variant, or --variants::
     96    List the variants defined by a port by name.
    4497
    4598include::global-flags.txt[]
    4699
    47 include::dependents-vs-dependencies.txt[]
     100-q::
     101    Do not print the field description when using *--pretty* output.
    48102
    49103SEE ALSO
    50104--------
    51 man:port[1], man:port-variants[1]
     105man:port[1]
    52106
    53107AUTHORS
Note: See TracChangeset for help on using the changeset viewer.