Changeset 126123


Ignore:
Timestamp:
Oct 4, 2014, 11:44:06 AM (5 years ago)
Author:
cal@…
Message:

base: document port platform, #44530

File:
1 copied

Legend:

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

    r126120 r126123  
    11// vim: set et sw=4 ts=8 ft=asciidoc tw=80:
    2 port-dir(1)
    3 ===========
     2port-platform(1)
     3================
    44$Id$
    55
    66NAME
    77----
    8 port-dir, port-url, port-file, port-location, port-work - Print paths for
    9 certain properties of a port
     8port-platform - Print the OS version for which MacPorts was built
    109
    1110SYNOPSIS
    1211--------
    1312[cmdsynopsis]
    14 *port* [*-D* 'portdir'] *dir*
    15      [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
    16 
    17 [cmdsynopsis]
    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*
    31      [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
     13*port* [*-q*] *platform*
    3214
    3315DESCRIPTION
    3416-----------
    35 These commands print a path for each given port. The meaning of the path
    36 differs by the command given:
     17This command prints the version of your operating system used to configure and
     18build MacPorts. This value is used to detect OS updates and refer users to the
     19wiki:Migration[] instructions.
    3720
    38 *port dir* prints the directory that contains the 'Portfile' for the given port
    39 expression. This can be quite handy in your shell, if you want to locate
    40 a 'Portfile':
     21Since MacPorts picks up a number of paths at configure-time and uses them later
     22on, changes in the operating system can break a MacPorts installation. For
     23example, this happened when Apple removed ``/usr/bin/gnutar'' from OS X with the
     24release of Mavericks. Since MacPorts keeps the path to its tar command in
     25a file, this change required rebuilding MacPorts.
    4126
    42 ----
    43 cd $(port dir <portname>)
    44 ----
    45 
    46 *port url* prints a unique URL for the given port expression. This command
    47 mostly exists for historical reasons and isn't of much use nowadays.
    48 
    49 *port file* prints the path of the 'Portfile' for the given port expression.
    50 This can be useful to locate a port's definition. Note that you can always get
    51 this by using *port dir* and appending 'Portfile'. You could use *port file* in
    52 a shell to edit a Portfile, but note that you can also use man:port-edit[1] to
    53 achieve the same.
    54 
    55 *port location* only works for installed ports and prints the location of the
    56 archive MacPorts internally uses to be able to deactivate and activate a port.
    57 See man:port-activate[1] for more details on that. This command might be useful
    58 for you if you want to setup a local binary mirror of MacPorts packages that are
    59 not 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
    62 directory used by MacPorts to build a port. No output is generated if no build
    63 directory exists, e.g., because there is no unfinished build in progress for the
    64 given port. Work directories are deleted after successful installation or using
    65 man:port-clean[1].
    6627
    6728include::global-flags.txt[]
    6829
     30*-q*::
     31    Do not print the ``Platform:'' prefix.
     32
    6933SEE ALSO
    7034--------
    71 man:port[1], man:port-edit[1], man:port-activate[1], man:port-clean[1]
     35man:port[1], wiki:Migration[]
    7236
    7337AUTHORS
Note: See TracChangeset for help on using the changeset viewer.