Changeset 134968 for trunk/base


Ignore:
Timestamp:
Apr 12, 2015, 7:06:25 PM (5 years ago)
Author:
cal@…
Message:

base: document port usage, #44530

File:
1 copied

Legend:

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

    r133158 r134968  
    11// vim: set et sw=4 ts=8 ft=asciidoc tw=80:
    2 port-select(1)
    3 ==============
     2port-usage(1)
     3=============
    44$Id$
    55
    66NAME
    77----
    8 port-select - Switch between different implementations of a tool
     8port-usage - Show a short command synopsis summary for the port command
    99
    1010SYNOPSIS
    1111--------
    1212[cmdsynopsis]
    13 *port* [*-dvp*] *select* --summary
    14 
    15 [cmdsynopsis]
    16 *port* [*-dvp*] *select* --show 'group'
    17 
    18 [cmdsynopsis]
    19 *port* [*-dvp*] *select* [--list] 'group'
    20 
    21 [cmdsynopsis]
    22 *port* [*-dvp*] *select* [--set] 'group' 'option'
     13*port* *usage*
    2314
    2415DESCRIPTION
    2516-----------
    26 *port select* provides a mechanism to choose from different implementations of
    27 a common tool or port. Selecting one of the options makes it the primary version
    28 or implementation, e.g. the one to be run by default when you do not explicitly
    29 select a version or implementation on the command line.
    30 
    31 Note that *port select* is only for your convenience as user. It does not, for
    32 example, affect which compiler MacPorts uses when it compiles software, or
    33 against which copy of MySQL a port builds. If there is a user-visible choice, it
    34 is usually offered as a variant on the port. If the *port select* mechanism
    35 affects how a port builds, that should be considered a bug.
    36 
    37 One example is the set of MySQL and forks of MySQL, where there are mysql51,
    38 mysql55, mysql56, mariadb, mariadb-10.0, mariadb-11.0, percona, possibly among
    39 others. *port select* lets you choose which of these becomes the version run,
    40 when you simply run 'mysql' or other commands from the MySQL suite.
    41 
    42 *port select* has multiple modes of operation: It can display a summary, show
    43 the current primary implementation and list all available implementations given
    44 a group name, and change the primary implementation. See *OPTIONS* below for
    45 details.
    46 
    47 OPTIONS
    48 -------
    49 *--summary*::
    50     Display a summary of all available selection groups, their current primary
    51     implementation and a list of all available choices.
    52 
    53 *--show* 'group'::
    54     Print the current primary implementation for the given group.
    55 
    56 *--list* 'group'::
    57     Print a list of all currently available choices for the given group. This is
    58     the default when *port select* is called with one argument.
    59 
    60 *--set* 'group' 'option'::
    61     Make 'option' the primary selection for the 'group' group. This is the
    62     default when *port select* is called with two arguments.
    63 
    64 include::global-flags.txt[]
    65 
    66 EXAMPLES
    67 --------
    68 If you have both the mysql56 and the percona port installed, you can switch your
    69 implementation of the 'mysql' command by running
    70 ----
    71 $> sudo port select --set mysql $option
    72 ----
    73 where '$option' is 'mysql56' if you want the version from MySQL, or 'percona',
    74 if you want the version from Percona.
     17*port usage* displays a very brief summary of all possible options of
     18man:port[1] and the canonical order in which port expects them. It prints the
     19*SYNOPSIS* port of the man:port[1] manpage.
    7520
    7621SEE ALSO
Note: See TracChangeset for help on using the changeset viewer.