--- name: "ports" section: "7" platform: "openbsd" package: "man" version: "8.0-current-20261101" release: "OpenBSD 8.0-current (2026-11-01)" platforms: ["freebsd", "openbsd"] url: "https://new.carta.tech/ports" --- # ports(7) contributed applications ## NAME **ports** – contributed applications ## DESCRIPTION The OpenBSD Ports Collection is the infrastructure used to create binary packages for third party applications. For normal usage refer to [packages(7)](/packages/7.md), as most ports produce binary packages which are available from the official HTTP mirrors. Each port contains any patches necessary to make the original application source code compile and run on OpenBSD. Compiling an application is as simple as typing **make** in the port directory! The *Makefile* automatically fetches the application source code, either from a local disk or via HTTP, unpacks it on the local system, applies the patches, and compiles it. If all goes well, simply type **doas** **make** **install** to install the application. For more information about using ports, see *Working with Ports:* **https://www.openbsd.org/faq/ports/ports.html**. For information about creating new ports, see *The OpenBSD Porter's Handbook:* **https://www.openbsd.org/faq/ports/**. For a detailed description of the build process, see [bsd.port.mk(5)](/bsd.port.mk/5.md). ## PORTS MASTER MAKEFILE The ports master Makefile, normally located in */usr/ports/Makefile* (but see PORTSDIR below) offers a few deprecated targets for the time being. - **print-index** display the contents of the index in a ‘user-friendly’ way, - **search** invoked with a key, e.g., **make** **search** **key=foo**, retrieve information relevant to a given port (obsolescent). Starting in OpenBSD 4.0, there is a port, *databases/sqlports*, that builds an sqlite database containing most information relevant to every port in the ports tree. This database can be searched using any tool able to manipulate such databases, for instance sqlitebrowser, or a script language with an sqlite interface, e.g., perl, python, ocaml, lua, php. All static index generating information has now been superseded by the *sqlports*, *portslist* or *pkglocatedb* packages, which contain similar information to the old INDEX file, but are frequently updated. See *databases/sqlports* *databases/pkglocatedb* and [pkg\_mklocatedb(1)](/pkg_mklocatedb/1.md) for details. ## SELECTING A SET OF PORTS One can define SUBDIRLIST to point to a file that contains a list of FULLPKGPATHs, one per line, to build stuff only in some directories. If *portslist* is up to date, it is possible to select subsets by setting the following variables on the command line: - *key* package name matching the given key, - *category* port belonging to category, - *maintainer* port maintained by a given person. For instance, to invoke **clean** on all ports in the x11 category, one can say: ``` $ make category=x11 clean ``` The index search is done by a perl script, so all regular expressions from [perlre(1)](/perlre/1.md) apply. ## TARGETS Individual ports are controlled through a few documented targets. Some of these targets work recursively through subdirectories, so that someone can, for example, install all of the net ports. The variable SKIPDIR can hold a set of package directories to avoid during recursion. These are always specified relative to the root of the ports tree, and can contain a flavor or subpackage part( see [packages-specs(7)](/packages-specs/7.md)). SKIPDIR is handled by a **case** statement, and so can contain simple wildcards( see [sh(1)](/sh/1.md) “File name patterns”), e.g., SKIPDIR='editors/openoffice\*'. The variable STARTDIR can hold the path to a starting directory. The recursion will skip all directories up to that package path. This can be used to resume a full build at some specific point without having to go through thousands of directories first. The variable STARTAFTER can hold the path to a starting directory. The recursion will skip all directories up to and including that package path. This can be used to resume a full build after some specific point without having to go through thousands of directories first. In case of failure in a subdirectory, the shell fragment held in REPORT\_PROBLEM is executed. Default behavior is to call exit, but this can be overridden on the command line, e.g., to avoid stopping after each problem. ``` $ make REPORT_PROBLEM=true ``` If REPORT\_PROBLEM\_LOGFILE is non empty, then REPORT\_PROBLEM will default to: ``` echo $$subdir ($@) >>$${REPORT_PROBLEM_LOGFILE} ``` That is, any failure will append the faulty directory name together with the target that failed to *${REPORT\_PROBLEM\_LOGFILE}* and proceed. Some targets that do this are **all**, **build**, **checksum**, **clean**, **configure**, **extract**, **fake**, **fetch**, **install**, **distclean**, **deinstall**, **reinstall**, **package**, **prepare**, **show**, **regress**, **lib-depends-check**, **license-check**, **all-dir-depends**, **build-dir-depends**, **run-dir-depends** and **generate-readmes**. Target names starting with ‘\_’ are private to the ports infrastructure, should not be invoked directly, and are liable to change without notice. In the following list, each target will run the preceding targets in order automatically. That is, **build** will be run (if necessary) by **install**, and so on all the way to **fetch**. In typical use, one will only run **install** explicitly (as normal user, with SUDO defined in */etc/mk.conf*), or **build** (as user), then **install** (as root). - **fetch** Fetch all of the files needed to build this port from the site(s) listed in SITES. See FETCH\_CMD. Use [dpb(1)](/dpb/1.md) with option **-F** to quickly fetch distfiles for a subtree. - **checksum** Verify that the fetched distfile matches the one the port was tested against. Defining NO\_CHECKSUM to Yes will skip this step. Sometimes, distfiles change without warning. The main OpenBSD mirror should still hold a copy of old distfiles, indexed by checksum. Using ``` $ make checksum REFETCH=true ``` will try to get a set of distfiles that match the recorded checksum. - **prepare** Install any build dependencies of the current port. Defining NO\_DEPENDS to Yes will skip this step. - **extract** Expand the distfile into a work directory. - **patch** Apply any patches that are necessary for the port. - **gen** Recreate configure machinery if needed, mainly used by GNU based software that wants autogen/autoconf/automake. - **configure** Configure the port. Some ports will ask questions during this stage. See INTERACTIVE and BATCH. - **build** Build the port. This is the same as calling the **all** target. - **fake** Pretend to install the port under a subdirectory of the work directory. - **generate-readmes** Create READMEs and rc scripts under the fake subdirectory. - **package** Create a binary package from the fake installation. The package is a .tgz file that can be used to install the port with pkg\_add(1). - **install** Install the resulting package. The following targets are not run during the normal install process( exception **clean** is run for dependencies with the default settings of BULK=Auto). - **print-build-depends**, **print-run-depends** Print an ordered list of all the compile and run dependencies. - **clean** Remove the expanded source code. This does not recurse to dependencies unless CLEANDEPENDS is defined to Yes. - **distclean** Remove the port's distfile(s). This does not recurse to dependencies. - **regress** Runs the ports regression tests. Usually needs a completed build. - **reinstall** Use this to restore a port after using [pkg\_delete(1)](/pkg_delete/1.md). - **update** Alternative target to **install**. Does not install new packages, but updates existing ones. ## LOCK INFRASTRUCTURE The ports tree can be used concurrently for building several ports at the same time, thanks to a locking mechanism. By default, locks are stored under */tmp/portslocks*. Defining LOCKDIR will point them elsewhere, or disable the mechanism if set to an empty value. All locks will be stored in *${LOCKDIR}*. LOCK\_CMD should be used to acquire a lock, and UNLOCK\_CMD should be used to release it. Locks are named *${LOCKDIR}/${FULLPKGNAME}.lock*, or *${LOCKDIR}/${DISTFILE}.lock* for distfiles fetching. The default values of LOCK\_CMD and UNLOCK\_CMD are appropriate for most uses. The locking protocol follows a big-lock model: each top-level target in a port directory will acquire the corresponding lock, complete its job, then release the lock, e.g., running ``` $ make build ``` will acquire the lock, run the port through **fetch**, **checksum**, **extract**, **patch**, **configure**, **build**, then release the lock. If dependencies are involved, they will invoke top-level targets in other directories, and thus acquire some other locks as well. The infrastructure contains some protection against acquiring the same lock twice, thus recursive locking is not needed for LOCK\_CMD. Starting with OpenBSD 4.3, the infrastructure supports manual locking: the targets **lock** and **unlock** can be used to acquire and release individual locks. Both these targets output a shell command that must be used to update environment variables. Manual locking can be used to protect a directory against interference by an automated build job, while the user is looking at or modifying a given port. ## UPDATING PACKAGES Instead of deinstalling each package and rebuilding from scratch, the ports tree can be used to update installed packages. The **update** target will replace an installed package using pkg\_add(1) in replacement mode. If FORCE\_UPDATE is set to Yes, dependencies will also be updated first, and packages will always be updated, even if there is no difference between the old and the new packages. Updates use a mechanism similar to bulk cookies and deposit cookies in the UPDATE\_COOKIES\_DIR. See the next section for more details, since most of the fine points of bulk package building also apply to updates. However, also note that make update is not guaranteed to work, see CAVEATS below. ## BULK PACKAGE BUILDING Building any significant number of packages from the ports tree should use [dpb(1)](/dpb/1.md), a tool located inside the ports tree proper( normally as */usr/ports/infrastructure/bin/dpb*). In particular, it can take advantage of machine clusters (same architecture and same installation), and of multi-core machines. For more detailed information, see [bulk(8)](/bulk/8.md). ## FLAVORS The OpenBSD ports tree comes with a mechanism called **FLAVORS**. Thanks to this mechanism, users can select specific options provided by a given port. If a port is "flavored", there should be a terse description of available flavors in the *pkg/DESCR* file. For example, the *misc/screen* port comes with a flavor called **static**. This changes the building process so a statically compiled version of the program will be built. To avoid confusion with other packages or flavors, the package name will be extended with a dash-separated list of the selected flavors. In this instance, the corresponding package will be called **screen-4.0.2-static**. To see the flavors of a port, use the **show** target: ``` $ make show=FLAVORS ``` To build a port with a specific flavor, just pass FLAVOR in the environment of the [make(1)](/make/1.md) command: ``` $ env FLAVOR="static" make package ``` and of course, use the same settings for the subsequent invocations of make: ``` $ env FLAVOR="static" make install $ env FLAVOR="static" make clean ``` More than one flavor may be specified: ``` $ cd /usr/ports/mail/exim $ env FLAVOR="mysql ldap" make package ``` Specifying a flavor that does not exist is an error. Additionally, some ports impose some further restrictions on flavor combinations, when such combinations do not make sense. Lots of ports can be built without X11 requirement and accordingly have a **no\_x11** flavor. Flavor settings are not propagated to dependencies. If a specific combination is needed, careful hand-building of the required set of packages is still necessary. ## MULTI\_PACKAGES The OpenBSD ports tree comes with a mechanism called **MULTI\_PACKAGES**. This mechanism is used when a larger package is broken down into several smaller components referred to as subpackages. If a port is "subpackaged", each subpackage will have a corresponding description in the *pkg/DESCR-subpackage* file. For example, the *databases/mariadb* port comes with subpackages called **-main**, **-tests** and **-server**. In this instance, the build will yield multiple packages, one corresponding to each subpackage. In the case of our mariadb example, the packages will be called **mariadb-client-\**, **mariadb-tests-\**, and **mariadb-server-\**. To install/deinstall a specific subpackage of a port, you may pkg\_add(1) them manually, or alternatively, you may set SUBPACKAGE in the environment of the [make(1)](/make/1.md) command during the install/deinstall phase: ``` $ env SUBPACKAGE="-server" make install $ env SUBPACKAGE="-server" make deinstall ``` ## PORT VARIABLES These can be changed in the environment, or in */etc/mk.conf* for persistence. They can also be set on make's command line, e.g., **make** **VAR\_FOO**=foo Boolean variables should be set to Yes instead of simply being defined, for uniformity and future compatibility. Variable names starting with ‘\_’ are private to the ports infrastructure, should not be changed by the user, and are liable to change without notice. - PORTS\_PRIVSEP If set to ‘Yes’, all operations will happen as restricted users *\_pfetch* and *\_pbuild*. - PORTSDIR Location of the ports tree (usually */usr/ports*). - DISTDIR Where to find/put distfiles, normally *${PORTSDIR}/distfiles*. - PACKAGE\_REPOSITORY Used only for the **package** target; the base directory for the packages tree, normally *${PORTSDIR}/packages*. If this directory exists, the package tree will be (partially) constructed. - BULK\_COOKIES\_DIR During bulk package building, used to store cookies for already built packages to avoid rebuilding them, since the actual working directory will already have been cleaned out. Defaults to *${PORTSDIR}/bulk/${MACHINE\_ARCH}*. - UPDATE\_COOKIES\_DIR Used to store cookies for package updates, defaults to *${PORTSDIR}/update/${MACHINE\_ARCH}*. If set to empty, it will revert to a file under *${WRKDIR}*. - LOCALBASE Where to install things in general (usually */usr/local*). - SITES Primary sites for distribution files if not found locally. - CLEANDEPENDS If set to Yes, let **clean** recurse to dependencies. - FETCH\_CMD Command to use to fetch files. Normally [ftp(1)](/ftp/1.md). - FETCH\_PACKAGES If set, try to use as options to pkg\_add(1) to install missing packages from PKG\_PATH. [bsd.port.mk(5)](/bsd.port.mk/5.md) does not set FETCH\_PACKAGES, so even an empty value amounts to setting the variable. For instance, to run pkg\_add(1) with default options : ``` make FETCH_PACKAGES= ``` or, to use the snapshots directory during the final beta period: ``` make FETCH_PACKAGES=-Dsnap ``` - PATCH\_DEBUG If defined, display verbose output when applying each patch. - INTERACTIVE If defined, only operate on a port if it requires interaction. - BATCH If defined, only operate on a port if it can be installed 100% automatically. ## USING A READ-ONLY PORTS TREE Select read-write partition(s) that can accommodate working directories, the distfiles repository, and the built packages. Set WRKOBJDIR, PACKAGE\_REPOSITORY, BULK\_COOKIES\_DIR, UPDATE\_COOKIES\_DIR, DISTDIR, and PLIST\_REPOSITORY in */etc/mk.conf* accordingly. ## FILES - */usr/ports* The default ports directory. - */usr/ports/Makefile* Ports master Makefile. - */usr/local/share/ports-INDEX* Ports index, part of the *portlist* package. - */usr/ports/pobj* Build directories. A number of insecurely coded ports require a dedicated file system with the **wxallowed** [mount(8)](/mount/8.md) option. - */usr/ports/infrastructure/mk/bsd.port.mk* The ports main engine. - */usr/ports/infrastructure/db/network.conf* Network configuration. - */usr/ports/infrastructure/db/user.list* List of users and groups created by ports. ## SEE ALSO [dpb(1)](/dpb/1.md), [make(1)](/make/1.md), pkg\_add(1), [pkg\_create(1)](/pkg_create/1.md), [pkg\_delete(1)](/pkg_delete/1.md), [pkg\_info(1)](/pkg_info/1.md), [bsd.port.mk(5)](/bsd.port.mk/5.md), [port-modules(5)](/port-modules/5.md), [mirroring-ports(7)](/mirroring-ports/7.md), [packages(7)](/packages/7.md) The OpenBSD Ports System: **https://www.openbsd.org/faq/ports/ports.html** The OpenBSD Porter's Handbook: **https://www.openbsd.org/faq/ports/** ## HISTORY **The** **Ports** **Collection** appeared in FreeBSD 1.0. It was introduced in OpenBSD by Ejovi Nuwere, with much initial effort by Angelos D. Keromytis. Maintenance passed then to Marco S. Hyman, and then to Christopher Turan. It is currently managed by Marc Espie, Christian Weisgerber, along with a host of others found at *ports@openbsd.org*. ## AUTHORS This man page was originated by David O'Brien, from the FreeBSD project. ## CAVEATS Building a new version of an already installed package is not guaranteed to work. The safer way would be to create a sandbox for building the updated port using [proot(1)](/proot/1.md) (see also [bulk(8)](/bulk/8.md)), and then update the installed package. Specifically: most software expects building in a virgin environment with only the required dependency. As a result, lots of time, libraries and headers under */usr/local* will be favored over the currently building version.