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

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

base: regenerate roff from asciidoc source

File size: 5.0 KB
Line 
1'\" t
2.TH "PORT\-INFO" "1" "2014\-08\-16" "MacPorts 2\&.3\&.99" "MacPorts Manual"
3.\" -----------------------------------------------------------------
4.\" * Define some portability stuff
5.\" -----------------------------------------------------------------
6.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7.\" http://bugs.debian.org/507673
8.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10.ie \n(.g .ds Aq \(aq
11.el       .ds Aq '
12.\" -----------------------------------------------------------------
13.\" * set default formatting
14.\" -----------------------------------------------------------------
15.\" disable hyphenation
16.nh
17.\" disable justification (adjust text to left margin only)
18.ad l
19.\" -----------------------------------------------------------------
20.\" * MAIN CONTENT STARTS HERE *
21.\" -----------------------------------------------------------------
22.SH "NAME"
23port-info \- Return information about the given ports\&.
24.SH "SYNOPSIS"
25.sp
26.nf
27\fBport\fR [\fB\-q\fR] [\fB\-D\fR \fIportdir\fR] \fBinfo\fR
28     [\-\-categories|\-\-category] [\-\-depends] [\-\-depends_fetch] [\-\-depends_extract]
29     [\-\-depends_build] [\-\-depends_lib] [\-\-depends_run] [\-\-description] [\-\-epoch]
30     [\-\-fullname] [\-\-heading] [\-\-homepage] [\-\-index] [\-\-license] [\-\-line]
31     [\-\-long_description] [\-\-maintainer|\-\-maintainers] [\-\-name]
32     [\-\-platform|\-\-platforms] [\-\-portdir] [\-\-pretty] [\-\-replaced_by]
33     [\-\-revision] [\-\-subports] [\-\-variant|\-\-variants] [\-\-version]
34     [[\fIportname\fR | \fIpseudo\-portname\fR | \fIport\-expressions\fR | \fIport\-url\fR]]
35.fi
36.SH "DESCRIPTION"
37.sp
38\fBport info\fR prints information about the given ports\&. Specifying at least one of the options limits the output to the corresponding field\&. If no fields are specified, a useful default set consisting of name, epoch, version, revision, categories, replaced_by, variants, description, homepage, dependencies, platforms, license, and maintainers is shown\&.
39.SH "OPTIONS"
40.sp
41The following options do not select fields for the output but change how the information is obtained or formatted:
42.PP
43\fB\-\-index\fR
44.RS 4
45Do not read the
46\fIPortfile\fR, but rely solely on the port index information\&. Note that this option will prevent the information reported from reflecting the effects of any variants specified\&.
47.RE
48.PP
49\fB\-\-line\fR
50.RS 4
51Print a single line for each port\&. Fields are separated by spaces\&.
52.RE
53.PP
54\fB\-\-pretty\fR
55.RS 4
56Format the output in a convenient, human\-readable fashion\&. This is the default when no options are specified\&.
57.RE
58.sp
59The rest of the options affect which fields will be given in the output:
60.PP
61\fB\-\-category\fR, \fB\-\-categories\fR
62.RS 4
63List the categories of a port\&.
64.RE
65.PP
66\fB\-\-depends\fR, \fB\-\-depends_fetch\fR, \fB\-\-depends_extract\fR, \fB\-\-depends_build\fR, \fB\-\-depends_lib\fR, \fB\-\-depends_run\fR
67.RS 4
68List the specified dependencies of a port\&.
69\fB\-\-depends\fR
70is a shorthand option for all other
71\fB\-\-depends_\fR* options\&.
72.RE
73.PP
74\fB\-\-description\fR, \fB\-\-long_description\fR
75.RS 4
76Print the short or long description of a port, respectively\&.
77.RE
78.PP
79\fB\-\-epoch\fR, \fB\-\-version\fR, \fB\-\-revision\fR
80.RS 4
81List the components of a MacPorts version tuple, epoch, version and revision, respectively\&.
82.RE
83.PP
84\fB\-\-fullname\fR
85.RS 4
86Print name and the full MacPorts version tuple, e\&.g\&., \(lqyubico\-pam @2\&.16\(rq\&.
87.RE
88.PP
89\fB\-\-heading\fR
90.RS 4
91Like
92\fB\-\-fullname\fR
93but including the categories\&.
94.RE
95.PP
96\fB\-\-homepage\fR
97.RS 4
98List the homepage of a port\&.
99.RE
100.PP
101\fB\-\-license\fR
102.RS 4
103Print the license that applies to the source code of a port\&.
104.RE
105.PP
106\fB\-\-maintainer\fR, \fB\-\-maintainers\fR
107.RS 4
108List the email address(es) of a port\(cqs maintainer(s)\&.
109.RE
110.PP
111\fB\-\-name\fR
112.RS 4
113Print the name of a port\&.
114.RE
115.PP
116\fB\-\-platform\fR, \fB\-\-platforms\fR
117.RS 4
118List the platforms supported by a port\&. This field exists for historical reasons only\&. In modern MacPorts, this is always
119\fIdarwin\fR, i\&.e\&., OS X\&.
120.RE
121.PP
122\fB\-\-portdir\fR
123.RS 4
124Print the path to a port\(cqs directory relative to the port tree root\&.
125.RE
126.PP
127\fB\-\-replaced_by\fR
128.RS 4
129List the name of the port that replaces a port, if any\&.
130.RE
131.PP
132\fB\-\-subports\fR
133.RS 4
134Print a list of subports defined by this port\(cqs
135\fIPortfile\fR, i\&.e\&., ports that are defined in the same
136\fIPortfile\fR
137because they share common parts\&.
138.RE
139.PP
140\fB\-\-variant\fR, \fB\-\-variants\fR
141.RS 4
142List the variants defined by a port by name\&.
143.RE
144.SH "GLOBAL OPTIONS"
145.sp
146Please see the section \fBGLOBAL OPTIONS\fR in the \fBport\fR(1) man page for a description of global port options\&.
147.PP
148\fB\-q\fR
149.RS 4
150Do not print the field description when using
151\fB\-\-pretty\fR
152output\&.
153.RE
154.SH "SEE ALSO"
155.sp
156\fBport\fR(1)
157.SH "AUTHORS"
158.sp
159.if n \{\
160.RS 4
161.\}
162.nf
163(C) 2014 The MacPorts Project
164Clemens Lang <cal@macports\&.org>
165.fi
166.if n \{\
167.RE
168.\}
Note: See TracBrowser for help on using the repository browser.