Changeset 123812


Ignore:
Timestamp:
Aug 14, 2014, 9:41:49 PM (5 years ago)
Author:
cal@…
Message:

base: document port-{dir,file,location,url,work}, #44530

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

Legend:

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

    r123681 r123812  
    3131                port-deps.1 \
    3232                port-destroot.1 \
     33                port-dir.1 \
    3334                port-edit.1 \
    3435                port-extract.1 \
    3536                port-fetch.1 \
     37                port-file.1 \
    3638                port-help.1 \
    3739                port-install.1 \
     40                port-location.1 \
    3841                port-patch.1 \
    3942                port-rdeps.1 \
     
    4144                port-selfupdate.1 \
    4245                port-uninstall.1 \
     46                port-url.1 \
     47                port-work.1 \
    4348                port.1 \
    4449
  • trunk/base/doc/port-dir.1.txt

    r123711 r123812  
    66NAME
    77----
    8 port-deps, port-rdeps - Display a dependency listing for the given port(s)
     8port-dir, port-url, port-file, port-location, port-work - Print paths for
     9certain properties of a port
    910
    1011SYNOPSIS
    1112--------
    1213[cmdsynopsis]
    13 *port* [*-D* 'portdir'] *deps*
    14      [--index] [--no-build]
     14*port* [*-D* 'portdir'] *dir*
    1515     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
    1616
    1717[cmdsynopsis]
    18 *port* [*-D* 'portdir'] *rdeps*
    19      [--full] [--index] [--no-build]
     18*port* [*-D* 'portdir'] *url*
     19     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
     20
     21[cmdsynopsis]
     22*port* [*-D* 'portdir'] *file*
     23     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
     24
     25[cmdsynopsis]
     26*port* [*-q*] [*-D* 'portdir'] *location*
     27     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
     28
     29[cmdsynopsis]
     30*port* [*-D* 'portdir'] *work*
    2031     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
    2132
    2233DESCRIPTION
    2334-----------
    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.
     35These commands print a path for each given port. The meaning of the path
     36differs by the command given:
    2637
    27 *port rdeps* recursively descends into the dependencies and displays a tree of
    28 dependencies for a given port.
     38*port dir* prints the directory that contains the Portfile for the given port
     39expression. This can be quite handy in your shell, if you want to locate
     40a Portfile:
    2941
    30 OPTIONS
    31 -------
    32 *--full*::
    33     When using *rdeps*, display all branches of the dependency tree instead of
    34     listing each dependency only once.
     42----
     43cd $(port dir <portname>)
     44----
    3545
    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
    39     the effects of any variants specified.
     46*port url* prints a unique URL for the given port expression. This command
     47mostly exists for historical reasons and isn't of much use nowadays.
    4048
    41 *--no-build*::
    42     Exclude dependencies only required at build time, i.e., fetch, extract, and
    43     build dependencies.
     49*port file* prints the path of the Portfile for the given port expression. This
     50can be useful to locate a port's definition. Note that you can always get this
     51by using *port dir* and appending 'Portfile'. You could use *port file* in
     52a shell to edit a Portfile, but note that you can also use man:port-edit[1] to
     53achieve the same.
     54
     55*port location* only works for installed ports and prints the location of the
     56archive MacPorts internally uses to be able to deactivate and activate a port.
     57See man:port-activate[1] for more details on that. This command might be useful
     58for you if you want to setup a local binary mirror of MacPorts packages that are
     59not available from our official infrastructure due to licensing reasons.
     60
     61*port work* prints the path to the so-called 'work' directory, i.e., the
     62directory used by MacPorts to build a port. No output is generated if no build
     63directory exists, e.g., because there is no unfinished build in progress for the
     64given port. Work directories are deleted after successful installation or using
     65man:port-clean[1].
    4466
    4567include::global-flags.txt[]
    4668
    47 include::dependents-vs-dependencies.txt[]
    48 
    4969SEE ALSO
    5070--------
    51 man:port[1], man:port-variants[1]
     71man:port[1], man:port-edit[1], man:port-activate[1], man:port-clean[1]
    5272
    5373AUTHORS
Note: See TracChangeset for help on using the changeset viewer.