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

Last change on this file since 123889 was 123889, checked in by cal@…, 6 years ago

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

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 3.4 KB
RevLine 
[65836]1// vim: set et sw=4 ts=8 ft=asciidoc tw=80:
[123889]2port-info(1)
[123681]3============
[66014]4$Id: port-info.1.txt 123889 2014-08-15 20:06:28Z cal@macports.org $
[49496]5
6NAME
7----
[123889]8port-info - Return information about the given ports.
[49496]9
10SYNOPSIS
11--------
[65980]12[cmdsynopsis]
[123889]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]
[49496]20     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
21
22DESCRIPTION
23-----------
[123889]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.
[49496]29
[123681]30OPTIONS
31-------
[123889]32The following options do not select fields for the output but change how the
33information is obtained or formatted:
[123678]34
[123889]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
[123681]38    the effects of any variants specified.
[123678]39
[123889]40--line::
41    Print a single line for each port. Fields are separated by spaces.
[123678]42
[123889]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.
97
[123681]98include::global-flags.txt[]
99
[123889]100-q::
101    Do not print the field description when using *--pretty* output.
[123678]102
[49496]103SEE ALSO
104--------
[123889]105man:port[1]
[49496]106
107AUTHORS
108-------
[123074]109 (C) 2014 The MacPorts Project
110 Clemens Lang <cal@macports.org>
Note: See TracBrowser for help on using the repository browser.