Changeset 123020


Ignore:
Timestamp:
Aug 3, 2014, 9:09:18 PM (5 years ago)
Author:
cal@…
Message:

base: document port help, move links to further documentation into separate file for re-usability

Location:
trunk/base/doc
Files:
1 added
2 edited
1 copied

Legend:

Unmodified
Added
Removed
  • trunk/base/doc/Makefile.in

    r123016 r123020  
    2727                port-extract.1 \
    2828                port-fetch.1 \
     29                port-help.1 \
    2930                port-install.1 \
    3031                port-patch.1 \
  • trunk/base/doc/port-help.1.txt

    r123016 r123020  
    11// vim: set et sw=4 ts=8 ft=asciidoc tw=80:
    2 port-contents(1)
    3 ================
     2port-help(1)
     3============
    44$Id$
    55
    66NAME
    77----
    8 port-contents - List the files installed by a given port
     8port-help - Get help on MacPorts commands
    99
    1010SYNOPSIS
    1111--------
    1212[cmdsynopsis]
    13 *port* [*-q*] [*-D* 'portdir'] *contents*
    14      [--size] [--units *UNIT*]
    15      [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
     13*port* *help* ['action' | 'help-topic']
    1614
    1715DESCRIPTION
    1816-----------
    19 *port contents* displays a list of all files that have been installed by a given
    20 port. You can only use *contents* for ports that are 'active' and installed.
     17*port help* opens the manpage for a given port action such as 'install',
     18'upgrade', 'selfupdate', etc. or a specific help topic like 'macports.conf'.
     19MacPorts even has help for its help feature. MacPorts will however not engage in
     20higher level abstractions: There is no help on the help on the help.
    2121
    22 Common uses for *contents* include finding the location of a port's executable
    23 after installing it. You can combine *port contents* with other tools to
    24 simplify this, e.g.
    25 ----
    26 port -q contents asciidoc | grep -E '/s?bin/'
    27 ----
    28 
    29 OPTIONS
    30 -------
    31 
    32 --size::
    33     Enable printing a human-readable representation of the files' sizes. The
    34     size output can be adjusted using the *--units UNIT* flag.
    35 
    36 --units UNIT::
    37     Used in conjunction with *--size* to choose the unit in which the size is
    38     given. Valid values for 'UNIT' are
    39 
    40     B:::
    41         List sizes in bytes.
    42 
    43     K, Ki, or KiB:::
    44         List sizes in KiB, i.e., 1024 bytes.
    45 
    46     Mi, or MiB:::
    47         List sizes in MiB, i.e., 1024 * 1024 bytes.
    48 
    49     Gi, or GiB:::
    50         List sizes in GiB, i.e., 1024 * 1024 * 1024 bytes.
    51 
    52     k, or kB:::
    53         List sizes in kB, i.e., 1000 bytes.
    54 
    55     M, or MB:::
    56         List sizes in MB, i.e., 1000 * 1000 bytes.
    57 
    58     G, or GB:::
    59         List sizes in GB, i.e., 1000 * 1000 * 1000 bytes.
    60 
    61 
    62 include::global-flags.txt[]
    63 
    64 -q::
    65     Do not print the header line.
    66 
     22include::furtherdocs.txt[]
    6723
    6824SEE ALSO
  • trunk/base/doc/portundocumented.7.txt

    r123002 r123020  
    1313pages. Sorry.
    1414
    15 Further documentation on MacPorts can be found in the following places:
    16 
    17 guide:[The MacPorts Guide]::
    18     Detailed help and support guide
    19 wiki:[The MacPorts Wiki]::
    20     MacPorts usage, development, and support
    21 wiki:MailingLists[Mailing Lists]::
    22     Ask questions on the mailing lists:
    23     macports-dev for base and Portfile development,
    24     macports-users for user support questions
    25 wiki:FAQ[]::
    26     Frequently Asked Questions
    27 wiki:ProblemHotlist[Problem Hotlist]::
    28     Solutions for the most common error messages and other problems
    29 
     15include::furtherdocs.txt[]
    3016
    3117CONTRIBUTING
Note: See TracChangeset for help on using the changeset viewer.