Manual Pages  — PORTS

The ports tree, typically located at /usr/ports, consists of subdirectories, one for each category; those in turn contain individual ports. Each port is a directory with metadata and patches necessary to make the original application source code compile and run on FreeBSD . Compiling an application is as simple as typing "make build" in the port directory. The Makefile automatically fetches the application source code, either from a local disk or the network, unpacks it, applies the patches, and compiles it. It also recursively handles dependencies — other pieces of software the port depends on in order to build and work. Afterwards, "make install" installs the application.

For more information about using ports, see the "Packages and Ports section" in The FreeBSD Handbookamp;:

.Lk https://docs.FreeBSD.org/en/books/handbook/ports/

For information about creating new ports, see The Porter's Handbookamp;:

.Lk https://docs.FreeBSD.org/en/books/porters-handbook/

The following targets will be run automatically by each proceeding target in order. That is, build will be run (if necessary) by install, and so on all the way to fetch. Usually, you will only use the install target.

config	Configure OPTIONS for this port using dialog4ports(1).
fetch	Fetch all of the files needed to build this port from the sites listed in MASTER_SITES and PATCH_SITES. See FETCH_CMD, MASTER_SITE_OVERRIDE and MASTER_SITE_BACKUP.
checksum	Verify that the fetched distfile's checksum matches the one the port was tested against. If the distfile's checksum does not match, it also fetches the distfiles which are missing or failed the checksum calculation. Defining NO_CHECKSUM will skip this step.
depends	Install (or compile if only compilation is necessary) any dependencies of the current port. When called by the extract or fetch targets, this is run in piecemeal as fetch-depends, build-depends, etc. Defining NO_DEPENDS will skip this step.
extract	Expand the distfile into a work directory.
patch	Apply any patches that are necessary for the port.
configure
	Configure the port. Some ports will ask you questions during this stage. See INTERACTIVE and BATCH.
build	Build the port. This is the same as calling the all target.
install	Install the port and register it with the package system. This is all you really need to do.

The following targets are not run during the normal install process.

showconfig	Display OPTIONS config for this port.
showconfig-recursive
	Display OPTIONS config for this port and all its dependencies.
rmconfig	Remove OPTIONS config for this port.
rmconfig-recursive
	Remove OPTIONS config for this port and all its dependencies.
config-conditional
	Skip the ports which have already had their OPTIONS configured.
config-recursive
	Configure OPTIONS for this port and all its dependencies using dialog4ports(1).
fetch-list	Show list of files to be fetched in order to build the port.
fetch-recursive
	Fetch the distfiles of the port and all its dependencies.
fetch-recursive-list
	Show list of files that would be retrieved by fetch-recursive.
run-depends-list, build-depends-list
	Print a list of all the compile and run dependencies, and dependencies of those dependencies, by port directory.
all-depends-list
	Print a list of all dependencies for the port.
pretty-print-run-depends-list, pretty-print-build-depends-list
	Print a list of all the compile and run dependencies, and dependencies of those dependencies, by port name and version.
missing	Print a list of missing dependencies to be installed for the port.
clean	Remove the expanded source code. This recurses to dependencies unless NOCLEANDEPENDS is defined.
distclean	Remove the port's distfiles and perform the clean target. The clean portion recurses to dependencies unless NOCLEANDEPENDS is defined, but the distclean portion never recurses (this is perhaps a bug).
reinstall	Use this to restore a port after using pkg-delete(8) when you should have used deinstall.
deinstall	Remove an installed port from the system, similar to pkg-delete(8).
deinstall-all	Remove all installed ports with the same PKGORIGIN from the system.
package	Make a binary package for the port. The port will be installed if it has not already been. The package is a .tbz file that you can use to install the port on other machines with pkg-add(8). If the directory specified by PACKAGES does not exist, the package will be put into the current directory. See PKGREPOSITORY and PKGFILE.
package-recursive
	Like package, but makes a package for each depending port as well.
package-name	Prints the name with version of the port.
readmes	Create a port's README.html. This can be used from /usr/ports to create a browsable web of all ports on your system!
search	Search the INDEX file for the pattern specified by the key (searches the port name, comment, and dependencies), name (searches the port name only), path (searches the port path), info (searches the port info), maint (searches the port maintainer), cat (searches the port category), bdeps (searches the port build-time dependency), rdeps (searches the port run-time dependency), www (searches the port web site) make(1) variables, and their exclusion counterparts: xname, xkey etc. For example, one would type:     cd /usr/ports && make search name=query to find all ports whose name matches "query". Results include the matching ports' path, comment, maintainer, build dependencies, and run dependencies. cd /usr/ports && make search name=pear- \ xbdeps=apache To find all ports whose names contain "pear-" and which do not have apache listed in build-time dependencies. cd /usr/ports && make search name=pear- \ xname='ht(tp|ml)' To find all ports whose names contain "pear-", but not "html" or "http". make search key=apache display=name,path,info keylim=1 To find ports that contain "apache" in either of the name, path, info fields, ignore the rest of the record. By default the search is not case-sensitive. In order to make it case-sensitive you can use the icase variable: make search name=p5-R icase=0
quicksearch	Reduced search output. Only display name, path and info.
describe	Generate a one-line description of each port for use in the INDEX file.
maintainer	Display the port maintainer's email address.
index	Create /usr/ports/INDEX, which is used by the pretty-print-* and search targets. Running the index target will ensure your INDEX file is up to date with your ports tree.
fetchindex	Fetch the INDEX file from the FreeBSD cluster.

Additional developer documentation:

	portlint(1)
	/usr/ports/Mk/bsd.port.mk

Additional user documentation:

	pkg(8)
	.Lk https://www.FreeBSD.org/ports Searchable index of all ports