source: trunk/base/doc/port-info.1.txt @ 134980

Last change on this file since 134980 was 133631, checked in by raimue@…, 4 years ago

base: expose already implemented 'port info --conflicts' to command line interface

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 3.8 KB
Line 
1// vim: set et sw=4 ts=8 ft=asciidoc tw=80:
2port-info(1)
3============
4$Id: port-info.1.txt 133631 2015-03-07 15:10:00Z raimue@macports.org $
5
6NAME
7----
8port-info - Return information about the given ports.
9
10SYNOPSIS
11--------
12[cmdsynopsis]
13*port* [*-q*] [*-D* 'portdir'] *info*
14     [--categories|--category] [--conflicts] [--depends] [--depends_fetch]
15     [--depends_extract] [--depends_build] [--depends_lib] [--depends_run]
16     [--description] [--epoch] [--fullname] [--heading] [--homepage] [--index]
17     [--license] [--line] [--long_description] [--maintainer|--maintainers]
18     [--name] [--patchfiles] [--platform|--platforms] [--portdir] [--pretty]
19     [--replaced_by] [--revision] [--subports] [--variant|--variants]
20     [--version]
21     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
22
23DESCRIPTION
24-----------
25*port info* prints information about the given ports. Specifying at least one of
26the options limits the output to the corresponding field. If no fields are
27specified, a useful default set consisting of name, epoch, version, revision,
28categories, replaced_by, variants, description, homepage, dependencies,
29platforms, license, and maintainers is shown.
30
31OPTIONS
32-------
33The following options do not select fields for the output but change how the
34information is obtained or formatted:
35
36*--index*::
37    Do not read the 'Portfile', but rely solely on the port index information.
38    Note that this option will prevent the information reported from reflecting
39    the effects of any variants specified.
40
41*--line*::
42    Print a single line for each port. Fields are separated by spaces.
43
44*--pretty*::
45    Format the output in a convenient, human-readable fashion. This is the
46    default when no options are specified.
47
48The rest of the options affect which fields will be given in the output:
49
50*--category*, *--categories*::
51    List the categories of a port.
52
53*--conflicts*::
54    List other ports that cannot be active at the same time as the given port.
55
56*--depends*, *--depends_fetch*, *--depends_extract*, *--depends_build*, *--depends_lib*, *--depends_run*::
57    List the specified dependencies of a port. *--depends* is a shorthand option
58    for all other *--depends_** options.
59
60*--description*, *--long_description*::
61    Print the short or long description of a port, respectively.
62
63*--epoch*, *--version*, *--revision*::
64    List the components of a MacPorts version tuple, epoch, version and
65    revision, respectively.
66
67*--fullname*::
68    Print name and the full MacPorts version tuple, e.g., ``yubico-pam @2.16''.
69
70*--heading*::
71    Like *--fullname* but including the categories.
72
73*--homepage*::
74    List the homepage of a port.
75
76*--license*::
77    Print the license that applies to the source code of a port.
78
79*--maintainer*, *--maintainers*::
80    List the email address(es) of a port's maintainer(s).
81
82*--name*::
83    Print the name of a port.
84
85*--patchfiles*::
86    List the patches that will be applied to the port, taking the current
87    platform and selected variants into account. This information will not be
88    available if *--index* is specified.
89
90*--platform*, *--platforms*::
91    List the platforms supported by a port. This field exists for historical
92    reasons only. In modern MacPorts, this is always 'darwin', i.e., OS X.
93
94*--portdir*::
95    Print the path to a port's directory relative to the port tree root.
96
97*--replaced_by*::
98    List the name of the port that replaces a port, if any.
99
100*--subports*::
101    Print a list of subports defined by this port's 'Portfile', i.e., ports that
102    are defined in the same 'Portfile' because they share common parts.
103
104*--variant*, *--variants*::
105    List the variants defined by a port by name.
106
107include::global-flags.txt[]
108
109*-q*::
110    Do not print the field description when using *--pretty* output.
111
112SEE ALSO
113--------
114man:port[1]
115
116AUTHORS
117-------
118 (C) 2014-2015 The MacPorts Project
119 Clemens Lang <cal@macports.org>
Note: See TracBrowser for help on using the repository browser.