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

Last change on this file since 129850 was 123948, checked in by cal@…, 5 years ago

base: unify formatting in manpages

  • all options are printed in bold
  • 'Portfile' is always underlined
  • fix list in port-lint.1
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 3.4 KB
Line 
1// vim: set et sw=4 ts=8 ft=asciidoc tw=80:
2port-info(1)
3============
4$Id: port-info.1.txt 123948 2014-08-16 13:45:03Z cal@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] [--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]
20     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
21
22DESCRIPTION
23-----------
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.
29
30OPTIONS
31-------
32The following options do not select fields for the output but change how the
33information is obtained or formatted:
34
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
38    the effects of any variants specified.
39
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*, *--categories*::
50    List the categories of a port.
51
52*--depends*, *--depends_fetch*, *--depends_extract*, *--depends_build*, *--depends_lib*, *--depends_run*::
53    List the specified dependencies of a port. *--depends* is a shorthand option
54    for all other *--depends_** options.
55
56*--description*, *--long_description*::
57    Print the short or 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*, *--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*, *--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*, *--variants*::
96    List the variants defined by a port by name.
97
98include::global-flags.txt[]
99
100*-q*::
101    Do not print the field description when using *--pretty* output.
102
103SEE ALSO
104--------
105man:port[1]
106
107AUTHORS
108-------
109 (C) 2014 The MacPorts Project
110 Clemens Lang <cal@macports.org>
Note: See TracBrowser for help on using the repository browser.