2 .\" Copyright (c) 1997 David E. O'Brien
4 .\" All rights reserved.
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
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.
15 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 .Nd contributed applications
38 offers a simple way for users and
39 administrators to install applications.
42 contains any patches necessary to make the original
43 application source code compile and run on
46 application is as simple as typing
48 in the port directory!
51 automatically fetches the
52 application source code, either from a local disk or via FTP, unpacks it
53 on your system, applies the patches, and compiles it.
57 to install the application.
59 It is possible to download and use ports from the
62 that are newer than the installed system; however it is important to
63 install the appropriate
66 .Pa http://www.FreeBSD.org/ports/
69 .Xr portcheckout 1 Pq Pa ports/ports-mgmt/portcheckout
70 script (also a port, of course!) will help to download new ports.
72 For more information about using ports, see
73 .Dq "Packages and Ports"
75 .%B "The FreeBSD Handbook" ,
76 .Pa ( file:/usr/share/doc/en_US.ISO8859-1/books/handbook/ports.html
78 .Pa http://www.FreeBSD.org/doc/en_US.ISO8859-1/books/handbook/ports.html ) .
79 For information about creating new ports, see
80 .%B "The Porter's Handbook"
81 .Pa ( file:/usr/share/doc/en_US.ISO8859-1/books/porters-handbook/index.html
83 .Pa http://www.FreeBSD.org/doc/en_US.ISO8859-1/books/porters-handbook/ ) .
85 Some of the targets work recursively through subdirectories.
86 This lets you, for example, install all of the
89 The targets that do this are
90 .Cm build , checksum , clean , configure ,
91 .Cm depends , extract , fetch , install ,
95 The following targets will be run automatically by each proceeding
103 and so on all the way to
105 Usually, you will only use the
108 .Bl -tag -width ".Cm configure"
115 Fetch all of the files needed to build this port from the sites
121 .Va FETCH_CMD , MASTER_SITE_OVERRIDE
123 .Va MASTER_SITE_BACKUP .
125 Verify that the fetched distfile's checksum matches the one the port was
132 (or compile if only compilation is necessary)
133 any dependencies of the current port.
138 targets, this is run in piecemeal as
139 .Cm fetch-depends , build-depends ,
145 Expand the distfile into a work directory.
147 Apply any patches that are necessary for the port.
150 Some ports will ask you questions during this stage.
157 This is the same as calling the
161 Install the port and register it with the package system.
162 This is all you really need to do.
165 The following targets are not run during the normal install process.
166 .Bl -tag -width ".Cm fetch-recursive"
170 config for this port.
171 .It Cm showconfig-recursive
174 config for this port and all its dependencies.
178 config for this port.
179 .It Cm rmconfig-recursive
182 config for this port and all its dependencies.
183 .It Cm config-conditional
184 Skip the ports which have already had their
187 .It Cm config-recursive
190 for this port and all its dependencies using
193 Show list of files to be fetched in order to build the port.
194 .It Cm fetch-recursive
195 Fetch the distfiles of the port and all its dependencies.
196 .It Cm fetch-recursive-list
197 Show list of files that would be retrieved by
198 .Cm fetch-recursive .
199 .It Cm run-depends-list , build-depends-list
200 Print a list of all the compile and run dependencies, and dependencies
201 of those dependencies, by port directory.
202 .It Cm all-depends-list
203 Print a list of all dependencies for the port.
204 .It Cm pretty-print-run-depends-list , pretty-print-build-depends-list
205 Print a list of all the compile and run dependencies, and dependencies
206 of those dependencies, by port name and version.
208 Print a list of missing dependencies to be installed for the port.
210 Remove the expanded source code.
211 This recurses to dependencies unless
215 Remove the port's distfiles and perform the
220 portion recurses to dependencies unless
224 portion never recurses
225 (this is perhaps a bug).
227 Use this to restore a port after using
229 when you should have used
232 Remove an installed port from the system, similar to
235 Remove all installed ports with the same
239 Make a binary package for the port.
240 The port will be installed if it has not already been.
243 file that you can use to
244 install the port on other machines with
246 If the directory specified by
248 does not exist, the package will be put into the current directory.
253 .It Cm package-recursive
256 but makes a package for each depending port as well.
258 Prints the name with version of the port.
262 This can be used from
264 to create a browsable web of all ports on your system!
268 file for the pattern specified by the
270 (searches the port name, comment, and dependencies),
272 (searches the port name only),
274 (searches the port path),
276 (searches the port info),
278 (searches the port maintainer),
280 (searches the port category),
282 (searches the port build-time dependency),
284 (searches the port run-time dependency),
286 (searches the port web site)
288 variables, and their exclusion counterparts:
291 For example, one would type:
293 .Dl "cd /usr/ports && make search name=query"
295 to find all ports whose
298 Results include the matching ports' path, comment, maintainer,
299 build dependencies, and run dependencies.
300 .Bd -literal -offset indent
301 cd /usr/ports && make search name=pear- \e
305 To find all ports whose
308 and which do not have apache
309 listed in build-time dependencies.
310 .Bd -literal -offset indent
311 cd /usr/ports && make search name=pear- \e
315 To find all ports whose names contain
321 .Bd -literal -offset indent
322 make search key=apache display=name,path,info keylim=1
325 To find ports that contain
327 in either of the name, path, info
328 fields, ignore the rest of the record.
330 By default the search is not case-sensitive.
331 In order to make it case-sensitive you can use the
334 .Bd -literal -offset indent
335 make search name=p5-R icase=0
341 Only display name, path and info.
343 Generate a one-line description of each port for use in the
347 Display the port maintainer's email address.
350 .Pa /usr/ports/INDEX ,
358 target will ensure your
360 file is up to date with your ports tree.
369 You can change all of these.
370 .Bl -tag -width ".Va MASTER_SITES"
372 Location of the ports tree.
384 Where to create any temporary files.
387 is read-only (perhaps mounted from a CD-ROM).
389 Where to find/put distfiles, normally
396 target; the base directory for the packages tree, normally
400 If this directory exists, the package tree will be (partially) constructed.
401 This directory does not have to exist; if it does not, packages will be
402 placed into the current directory, or you can define one of
403 .Bl -tag -width ".Va PKGREPOSITORY"
405 Directory to put the package in.
407 The full path to the package.
410 Where to install things in general
414 Primary sites for distribution files if not found locally.
416 Primary locations for distribution patch files if not found
418 .It Va MASTER_SITE_FREEBSD
419 If set, go to the master
422 .It Va MASTER_SITE_OVERRIDE
423 Try going to these sites for all files and patches, first.
424 .It Va MASTER_SITE_BACKUP
425 Try going to these sites for all files and patches, last.
426 .It Va RANDOMIZE_MASTER_SITES
427 Try the download locations in a random order.
429 Sort the download locations according to user supplied pattern.
431 .Dl .dk .sunet.se .se dk.php.net .no .de heanet.dl.sourceforge.net
432 .It Va MASTER_SITE_INDEX
441 .Pa http://www.FreeBSD.org/ports/ .
450 .It Va NOCLEANDEPENDS
451 If defined, do not let
453 recurse to dependencies.
455 Command to use to fetch files.
458 .It Va FORCE_PKG_REGISTER
459 If set, overwrite any existing package registration on the system.
462 .Pa libXm. Ns Brq Pa a , Ns Pa so .
464 If defined, only operate on a port if it requires interaction.
466 If defined, only operate on a port if it can be installed 100% automatically.
467 .It Va DISABLE_VULNERABILITIES
468 If defined, disable check for security vulnerabilities using
469 .Xr portaudit 1 Pq Pa ports/ports-mgmt/portaudit
470 when installing new ports.
472 If defined, allow installation of ports marked as
474 The default behavior of the Ports framework is to abort when the
475 installation of a forbidden port is attempted.
476 Of course, these ports may not work as expected, but if you really know
477 what you are doing and are sure about installing a forbidden port, then
481 If defined, attempt to build a port even if it is marked as
484 Directory where the results of configuring
491 have been configured will have a uniquely named sub-directory, containing a
496 .Bl -tag -width ".Pa /usr/ports/Mk/bsd.port.mk" -compact
498 The default ports directory
503 The default ports directory
505 .It Pa /usr/ports/Mk/bsd.port.mk
516 The following are part of the ports collection:
522 .%B "The FreeBSD Handbook"
525 .Pa http://www.FreeBSD.org/ports
526 (searchable index of all ports)
531 It has since spread to
537 This manual page was originated by
540 Ports documentation is split over four places \(em
541 .Pa /usr/ports/Mk/bsd.port.mk ,
542 .%B "The Porter's Handbook" ,
544 .Dq "Packages and Ports"
546 .%B "The FreeBSD Handbook" ,