source: trunk/base/src/port/port.1 @ 9134

Last change on this file since 9134 was 9134, checked in by toby, 13 years ago

Note that -d implies -v.

  • Property svn:eol-style set to native
File size: 5.7 KB
Line 
1.\" port.1
2.\"
3.\" Copyright (c) 2002 Apple Computer, Inc.
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. Neither the name of Apple Computer, Inc. nor the names of its
15.\"    contributors may be used to endorse or promote products derived from
16.\"    this software without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19.\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
22.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.Dd August 24, 2002
31.Dt PORT 1 "Apple Computer, Inc."
32.Os
33.Sh NAME
34.Nm port
35.Nd build darwin ports
36.Sh SYNOPSIS
37.Nm
38.Op Fl vdqfonausbck
39.Op Fl D Ar portdir
40.Ar target
41.Op Ar portname
42.Op Ar options ...
43.Op Ar variants ...
44.Nm
45.Ic provides
46.Ar file
47.Sh DESCRIPTION
48.Nm
49is designed to read and execute the build instructions of a darwin port. If no
50.Ar portdir
51or
52.Ar portname
53is specified, the current working directory is assumed.
54If no
55.Ar target
56is specified, the usage is displayed.
57Port
58.Ar options
59are specified as key=value pairs and take precedence over individual port options and system-wide settings.
60Port
61.Ar variants
62are specified as +name, which indicates the variant is desired, and -name, which indicates the
63variant is not desired. In case of ambiguities, a port can be fully specified with the format
64.Ar version_revision+variants
65.Sh OPTIONS
66.Bl -tag -width -indent
67.It Fl v
68verbose mode (generate verbose messages)
69.It Fl d
70debug mode (generate debugging messages; implies
71.Fl v )
72.It Fl q
73quiet mode (suppress messages)
74.It Fl c
75autoclean mode (execute clean after install)
76.It Fl k
77keep mode (don't autoclean after install)
78.It Fl D
79specify
80.Ar portdir
81.It Fl f
82force mode (ignore state file)
83.It Fl o
84honor state files older than Portfile
85.El
86.Sh TARGETS
87.Nm
88knows several targets. The most important is the "install" target, which installs the supplied port to its final destination on the system.
89.Pp
90The other targets are:
91.Pp
92.Dl uninstall
93.Dl deactivate
94.Dl activate
95.Dl clean
96.Dl distclean
97.Dl search
98.Dl list
99.Dl contents
100.Dl deps
101.Dl variants
102.Dl info
103.Pp
104Besides the main targets
105.Nm
106takes each single stage of the port building process as a possible target. These
107stages (besides "install") are:
108.Pp
109.Dl fetch
110.Dl extract
111.Dl patch
112.Dl configure
113.Dl build
114.Dl destroot
115.Dl test
116.Pp
117There are also targets for packaging ports:
118.Pp
119.Dl pkg
120.Dl mpkg
121.Dl dmg
122.Dl rpmpackage
123.Pp
124Additionally, the
125.Ic provides
126command determines which port owns a given file.
127.Sh EXAMPLES
128Invoking
129.Nm
130with the "install" target on the "vim" port:
131.Pp
132.Dl "port install vim
133.Pp
134To uninstall a port, invoke
135.Nm
136with the "uninstall" target:
137.Pp
138.Dl "port uninstall vim
139.Pp
140To clean up after the port was build:
141.Pp
142.Dl "port clean vim
143.Pp
144To remove a port's distfiles:
145.Pp
146.Dl "port distclean vim
147.Pp
148To deactivate a port (in image mode):
149.Pp
150.Dl "port deactivate vim
151.Pp
152To reactivate a port previously deactivated (in image mode):
153.Pp
154.Dl "port activate vim
155.Pp
156A port can be installed if another version/variant is installed but deactivated. To reactivate one of the installed version of a port previously deactivated (in image mode):
157.Pp
158.Dl "port activate vim 6.2.532_0+aqua
159.Pp
160To build and "install" vim into an intermediate destination root (or "destroot")
161.Pp
162.Dl "port destroot vim"
163.Pp
164This can be useful during development of a new port, for testing, or for
165creating an "installation" of a port which can be subsequently packaged
166or copied elsewhere without having to modify the host system.
167.Pp
168Using
169.Nm
170to list all available ports:
171.Pp
172.Dl "port search .+
173.Pp
174or:
175.Pp
176.Dl "port list
177.Pp
178To look for a specific port, supply a search string:
179.Pp
180.Dl "port search vim
181.Pp
182To list the files (table of contents) installed by a given port (in this case apr):
183.Pp
184.Dl "port contents apr"
185.Pp
186To list a port's dependencies:
187.Pp
188.Dl "port deps exim"
189.Pp
190To list installed ports:
191.Pp
192.Dl "port installed"
193.Pp
194To list a port's variants:
195.Pp
196.Dl "port variants php"
197.Pp
198To view all of a port's metadata:
199.Pp
200.Dl "port info vim"
201.Pp
202The following demonstrates invoking
203.Nm
204with the "extract" target on portdir "textproc/figlet" and extract.suffix set to ".tgz":
205.Pp
206.Dl "port extract -d textproc/figlet extract.suffix=.tgz"
207.Pp
208To package a port as an OS X package, use the "pkg" target:
209.Pp
210.Dl "port pkg gimp"
211.Pp
212or use
213.Nm
214with the 'dmg' target to create an internet-enabled disk image containing an OS X package:
215.Pp
216.Dl "port dmg gimp"
217.Pp
218To build an RPM from a port, use the "rpmpackage" target instead:
219.Pp
220.Dl "port rpmpackage gimp"
221.Pp
222.Sh DIAGNOSTICS
223.Ex -std
224.Sh AUTHORS
225.An Landon Fuller Aq landonf@opendarwin.org
226.An Kevin Van Vechten Aq kevin@opendarwin.org
227.An Jordan K. Hubbard Aq jkh@opendarwin.org
Note: See TracBrowser for help on using the repository browser.