Changeset 123889


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

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

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

Legend:

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

    r123190 r123889  
    1212To be used only in interactive mode:
    1313
     14[cmdsynopsis]
    1415*cd*
    1516    ['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']
     
    2223shell.
    2324
    24 Note that *port cd* can be used from the command line, but is a no-op.
     25BUGS
     26----
     27*port cd* can be used from the command line, but is a no-op.
    2528
    2629SEE ALSO
  • trunk/base/doc/port-distfiles.1.txt

    r123711 r123889  
    11// vim: set et sw=4 ts=8 ft=asciidoc tw=80:
    2 port-cat(1)
    3 ===========
     2port-distfiles(1)
     3=================
    44$Id$
    55
    66NAME
    77----
    8 port-cat - Print the contents of a Portfile
     8port-distfiles - Print a list of distribution files for a port
    99
    1010SYNOPSIS
    1111--------
    1212[cmdsynopsis]
    13 *port* [*-D* 'portdir'] *cat*
     13*port* [*-qvd*] [*-D* 'portdir'] *distfiles*
    1414     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
    1515
    1616DESCRIPTION
    1717-----------
    18 Print the 'Portfile' of the given port(s). Note that always the latest version
    19 in your local ports tree is printed.
     18Print a list of source archives required to build the given port along with the
     19checksums for the file and a list of mirrors. If you want to verify that all
     20mirrors actually serve the same file see man:port-distcheck[1].
     21
     22To delete the distfiles once they have been downloaded, use *port clean --dist*.
     23See man:port-clean[1] for more information regarding the *clean* command.
    2024
    2125SEE ALSO
    2226--------
    23 man:port[1], man:port-selfupdate[1]
     27man:port[1], man:port-distcheck[1], man:port-clean[1]
    2428
    2529AUTHORS
  • trunk/base/doc/port-dmg.1.txt

    r123825 r123889  
    11// vim: set et sw=4 ts=8 ft=asciidoc tw=80:
    2 port-dir(1)
     2port-dmg(1)
    33===========
    44$Id$
     
    66NAME
    77----
    8 port-dir, port-url, port-file, port-location, port-work - Print paths for
    9 certain properties of a port
     8port-dmg, port-mdmg, port-pkg, port-mpkg - Create binary archives of a port, and
     9optionally its dependencies.
    1010
    1111SYNOPSIS
    1212--------
    1313[cmdsynopsis]
    14 *port* [*-D* 'portdir'] *dir*
     14*port* [*-vdqysbckpotf*] [*-D* 'portdir'] *dmg*
    1515     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
    1616
    1717[cmdsynopsis]
    18 *port* [*-D* 'portdir'] *url*
     18*port* [*-vdqysbckpotf*] [*-D* 'portdir'] *mdmg*
    1919     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
    2020
    2121[cmdsynopsis]
    22 *port* [*-D* 'portdir'] *file*
     22*port* [*-vdqysbckpotf*] [*-D* 'portdir'] *pkg*
    2323     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
    2424
    2525[cmdsynopsis]
    26 *port* [*-q*] [*-D* 'portdir'] *location*
    27      [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
    28 
    29 [cmdsynopsis]
    30 *port* [*-D* 'portdir'] *work*
     26*port* [*-vdqysbckpotf*] [*-D* 'portdir'] *mpkg*
    3127     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
    3228
    3329DESCRIPTION
    3430-----------
    35 These commands print a path for each given port. The meaning of the path
    36 differs by the command given:
     31These commands create OS X-native binary archives of a given port. Depending on
     32the command, either a .dmg disk image file, or a .pkg installer package is
     33created.
    3734
    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:
     35*port dmg* creates an OS X disk image. *port pkg* wraps the same files in an OS
     36X installer package. In most cases you probably want to package a port and all
     37its library and runtime dependencies in a single package suitable for binary
     38redistribution. You can use a metapackage to do this. Create one using *port
     39mdmg* or *port mpkg*.
    4140
    42 ----
    43 cd $(port dir <portname>)
    44 ----
     41All packages are placed in a port's work directory, which can be located using
     42man:port-work[1].
    4543
    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.
     44[WARNING]
     45====
     46If you want to create installer packages using MacPorts for redistribution, make
     47sure you do not use a standard installation of MacPorts in '/opt/local'. If you
     48do that, your installer package will conflict on systems that *do* have MacPorts
     49installed.
    4850
    49 *port file* prints the path of the Portfile for the given port expression. This
    50 can be useful to locate a port's definition. Note that you can always get this
    51 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].
     51Instead, follow guide:installing.macports.source.multiple[Section 2.2.4 of the
     52MacPorts Guide] and choose a prefix specific to the software you are trying to
     53package, e.g., '/opt/logrotate' for 'logrotate'. Then use this custom MacPorts
     54installation to build your package.
     55====
    6656
    6757include::global-flags.txt[]
     
    6959SEE ALSO
    7060--------
    71 man:port[1], man:port-edit[1], man:port-activate[1], man:port-clean[1]
     61man:port[1], man:port-work[1], guide:installing.macports.source.multiple[Section
     622.2.4 of the MacPorts Guide]
    7263
    7364AUTHORS
  • trunk/base/doc/port-echo.1.txt

    r123711 r123889  
    11// vim: set et sw=4 ts=8 ft=asciidoc tw=80:
    2 port-contents(1)
    3 ================
     2port-echo(1)
     3============
    44$Id$
    55
    66NAME
    77----
    8 port-contents - List the files installed by a given port
     8port-echo - Print the list of ports the argument expands to
    99
    1010SYNOPSIS
    1111--------
    1212[cmdsynopsis]
    13 *port* [*-q*] [*-D* 'portdir'] *contents*
    14      [--size] [--units 'unit']
     13*port* *echo*
    1514     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
    1615
    1716DESCRIPTION
    1817-----------
    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.
     18*port echo* expands its argument list according to MacPorts' rules and prints
     19a list of ports that match the expression given as argument. It can be useful to
     20see what a pseudo-portname or a pseudo-portname selector (see man:port[1])
     21expands to.
    2122
    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.
     23EXAMPLES
     24--------
     25Common use cases are:
     26
    2527----
    26 port -q contents asciidoc | grep -E '/s?bin/'
     28port echo depends:zlib
     29port echo inactive
     30port echo obsolete
     31port echo requested
     32port echo leaves
     33port echo category:^mail$
    2734----
    2835
    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 
     36Note that *echo* is usually 'not' used to list outdated ports, since a separate
     37action man:port-outdated[1] exists for that. *port outdated* has the advantage
     38compared to *port echo outdated* that it gives the reason why MacPorts considers
     39the port outdated.
    6740
    6841SEE ALSO
    6942--------
    70 man:port[1], man:grep[1]
     43man:port[1], man:port-outdated[1]
    7144
    7245AUTHORS
  • trunk/base/doc/port-exit.1.txt

    r123711 r123889  
    11// vim: set et sw=4 ts=8 ft=asciidoc tw=80:
    2 port-cd(1)
    3 ==========
     2port-exit(1)
     3============
    44$Id$
    55
    66NAME
    77----
    8 port-cd - Change the current working directory in interactive mode.
     8port-exit - Exit interactive mode
    99
    1010SYNOPSIS
     
    1212To be used only in interactive mode:
    1313
    14 *cd*
    15     ['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']
     14[cmdsynopsis]
     15*exit*
     16
     17[cmdsynopsis]
     18*quit*
    1619
    1720DESCRIPTION
    1821-----------
    19 *cd* can be used in interactive mode of *port* (see man:port-interactive[7]) to
    20 change the current working directory to the directory that contains a given
    21 port. The second parameter is not optional, as it usually is with *cd* in your
    22 shell.
     22*exit* or *quit* can only be used in interactive mode of *port* (see
     23man:port-interactive[7]). It causes the interactive interpreter to exit.
    2324
    24 Note that *port cd* can be used from the command line, but is a no-op.
     25BUGS
     26----
     27*port exit* and *port quit* can be used from the command line, but are no-ops.
    2528
    2629SEE ALSO
  • trunk/base/doc/port-gohome.1.txt

    r123711 r123889  
    11// vim: set et sw=4 ts=8 ft=asciidoc tw=80:
    2 port-deps(1)
    3 ============
     2port-gohome(1)
     3==============
    44$Id$
    55
    66NAME
    77----
    8 port-deps, port-rdeps - Display a dependency listing for the given port(s)
     8port-gohome - Open the homepage(s) of the given port(s)
    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* [*-D* 'portdir'] *gohome*
    2014     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
    2115
    2216DESCRIPTION
    2317-----------
    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.
    29 
    30 OPTIONS
    31 -------
    32 *--full*::
    33     When using *rdeps*, display all branches of the dependency tree instead of
    34     listing each dependency only once.
    35 
    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.
    40 
    41 *--no-build*::
    42     Exclude dependencies only required at build time, i.e., fetch, extract, and
    43     build dependencies.
    44 
    45 include::global-flags.txt[]
    46 
    47 include::dependents-vs-dependencies.txt[]
     18*port gohome* opens the homepage of the given port(s) in your default browser.
    4819
    4920SEE ALSO
    5021--------
    51 man:port[1], man:port-variants[1]
     22man:port[1]
    5223
    5324AUTHORS
  • 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.