PORT(1)

NAME
port - operate on individual or multiple Darwin ports

SYNOPSIS
port [-vdqfonRusbckt] [-D portdir] action [actionflags] [[portname | pseudo-portname | port-url] [@version] [+/-variant ...] ... [option=value ...]]

DESCRIPTION
port is designed to operate on individual or multiple Darwin ports, optionally within a single call, based on the requested action. If no portdir or portname is specified, the current working directory is assumed; if no action is specified, the usage is displayed. Port options are passed as key=value pairs and take precedence over individual port options and system-wide settings.

Port variants can specified as +name, which indicates the variant is desired, or -name, indicating the contrary. In case of ambiguities, a port can be fully specified with the @version_revision+variants format.

Installed ports can be activated or deactivated without being uninstalled. A port can be installed if all other version/variant(s) combinations installed at any given moment are deactivated.

The port command knows various pseudo-portnames that will expand to the specified set of ports from the available dports tree(s). These may be used in place of a portname. Common options are:

•   all: all the ports in each dports tree listed in sources.conf

•   current: the port in the current working directory.

•   active: set of installed and active ports.

•   inactive: set of installed but inactive ports.

•   installed: set of all installed ports.

•   uninstalled: ports in the dports tree(s) that aren't installed.

•   outdated: installed ports that are out of date with respect to their current version/revision in the dports tree(s)

Other options, also known as pseudo-portname selectors, matching the most common keys used in a Portfile are also accepted, in both singular and plural form where applicable. These are:

•   name
•   version
•   revision
•   epoch
•   variant
•   variants
•   category
•   categories
•   maintainer
•   maintainers
•   platform
•   platforms
•   description
•   long_description
•   homepage
•   portdir

Search strings that will expand to a set of matching ports can be constructed based on the ”pseudo-portname selector“:regex combination used. portnames containing valid UNIX glob patterns will also expand to the set of matching ports. Any action passed to port will be invoked on each of them. For example:

    port list variant:no_ssl
    port uninstall name:sql
    port echo apache*

Logical operators "and", "or", "not", "!", "(" and ")" may be used to combine individual portnames, port glob patterns and/or pseudo-portnames to construct complex port expressions that expand to the set of matching ports. For example:

    port upgrade installed and apache*
    port echo maintainer:jberry and uninstalled and \( category:java and not commons* \)

The port command also recognizes several command line flags and targets:

OPTIONS

-v  verbose mode (generate verbose messages)

-d  debug mode (generate debugging messages, implies -v)

-q  quiet mode (suppress messages)

-n  don't follow dependencies in upgrade (only for upgrading)

-R  also upgrade dependents (only for upgrading)

-u  uninstall non-active ports when upgrading and uninstalling

-f  force mode (ignore state file)

-o  honor state files older than Portfile

-s  source-only mode (only build and install from source, ignores all binary archives, does not create/recreate binary archives) (only applies when archive mode is enabled)

-b  binary-only mode (only build and install from binary archives, ignores source, fails when no archive present, and does not create/recreate binary archives from source) (only applies when archive mode is enabled)

-c  autoclean mode (execute clean after install)

-k  keep mode (don't autoclean after install)

-D  specify portdir

-t  enable trace mode debug facilities on platforms that support it (MacOS X). This feature is two-folded. It consists in automatically detecting and reporting undeclared dependencies based on what files the port reads or what programs the port executes. In verbose mode, it will also report unused dependencies for each stage of the port installation. It also consists in forbidding and reporting file creation and file writes outside allowed directories (temporary directories and ${worksrcpath}).

USER TARGETS
Targets most commonly used by regular DarwinPorts users are:

  search
Search for an available port whose name matches a regular expression. For example:

    port search vim

  info
Displays all the meta-information available for portname.

  variants
Lists the build variants available for portname.

  deps
Lists the other ports that are required to build and run portname.

  dependents
Lists the ports that depend on the port portname.

  install
Install and activate portname.

  uninstall
Deactivate and uninstall portname. To uninstall all installed but inactive ports, use -u. For example:

    port uninstall vim
    port -u uninstall

  activate
Activate the installed portname.

  deactivate
Deactivate the installed portname.

  installed
List all installed ports.

  location
Print the install location of a given port.

  contents
Lists the files installed by portname.

  provides
Determines which port owns a given file and can take either a relative or absolute path. For example:

    port provides /opt/local/etc/irssi.conf
    port provides include/tiff.h

  sync
Performs a sync operation only on the dports tree of a DarwinPorts installation, pulling in the latest revision available of the Portfiles from the DarwinPorts rsync server. To update you would normally do:

    sudo port -d sync

  outdated
List the installed ports that need upgrading.

  upgrade
The upgrade target works on a port and its dependencies. If you want to change this behaviour, look at the switches for n (no dependencies) and R (dependents) below.

Upgrade the installed portname. For example:

    port upgrade vim

To upgrade all installed ports:

    port upgrade installed

To upgrade portname and the ports that depend on it:

    port -R upgrade libiconv

To force an upgrade (rebuild) use:

    port -f upgrade vim

To upgrade portname without following its dependencies, use -n. For example:

    port -n upgrade ethereal

  clean
Clean the files used for building portname. To just remove the work files, use the --work actionflag. To remove the distribution files (tarballs, etc), specify --dist. To remove the archive(s) for the current version of a port, pass --archive. To remove the work files, distribution files and archives, pass --all. For example:

    port clean --dist vim
    port clean --archive vim

To remove only certain version(s) of a port's archives ( version is any valid UNIX glob pattern), you can use:

    port clean --archive vim 6.2.114

or:

    port clean --archive vim '6.*'

  echo
Writes to stdout the arguments passed to port. This follows the expansion of pseudo-portnames, portname glob patterns, pseudo-portname selectors and the evaluation of port expressions. echo may be used to determine the exact set of ports to which a given string of arguments will expand, without performing any further operations on them. For example:

    port echo category:net
    port echo maintainer:jmpp and name:netw
    port echo maintainer:jmpp and \( net* or category:text \)

  list
List all available ports.

  version
Display the release number of the installed DarwinPorts infrastructure.

  selfupdate
Updates the DarwinPorts system, dports tree(s) and base tools if needed, from the DarwinPorts rsync server, installing the newest infrastructure available. To update you would typically do:

    sudo port -d selfupdate

  help
Displays a summary of all available actions and port command syntax on stdout.

DEVELOPER TARGETS
The targets that are often used by Port developers are intended to provide access to the different phases of a Port's build process:

  dir
Displays the path to the directory containing portname.

  file
Displays the path to the Portfile for portname.

  cat
Concatenates and prints the contents of Portfile on stdout.

  edit
Opens Portfile with your default editor specified in your shell's environment variable. Alias ed also invokes this command.

  unarchive
Unpack the port from a pre-built binary archive. When archive mode is enabled, this command is called automatically, prior to fetch, to check for an existing binary archive to unpack. If found, it is unpacked and all stages up to install are then skipped.

  fetch
Fetches the distribution files required to build portname.

  extract
Extracts the distribution files for portname.

  patch
Applies any required patches to portname's extracted distribution files.

  configure
Runs any configure process for portname.

  build
Build portname.

  destroot
Installs portname to a temporary directory.

  test
Tests portname.

  archive
Archive the port for a later unarchive. When archive mode is enabled, binary archives will be created automatically whenever an install is performed, or when the archive target is called explicitly.

  distcheck
Check if the distfiles haven't changed and can be fetched.

  livecheck
Check if the software hasn't been updated since the Portfile was last modified.

PACKAGING TARGETS
There are also targets for producing installable packages of ports:

  pkg
Creates an OS X installer package of portname.

  mpkg
Creates an OS X installer metapackage of portname and its dependencies.

  dmg
Creates an internet-enabled disk image containing an OS X package of portname.

  rpmpackage
Creates an RPM package of portname.

EXAMPLES
The following demonstrates invoking port with the extract target on portdir "textproc/figlet" and extract.suffix set to ".tgz":

    port extract -D textproc/figlet extract.suffix=.tgz

FILES

${prefix}/etc/ports/ports.conf
    Global configuration file for the DarwinPorts system.

${prefix}/etc/ports/sources.conf
    Global listing of the dports/ trees used by DarwinPorts. This file also enables rsync synchronization.

${prefix}/etc/ports/variants.conf
    Global variants used when a port is installed.

~/.portsrc
    User configuration file for the DarwinPorts system. It overrides the global ports.conf file.

DIAGNOSTICS

SEE ALSO
ports.conf(5), portfile(7), portgroup(7), portstyle(7), porthier(7)

AUTHORS
Landon Fuller <landonf@opendarwin.org> Kevin Van Vechten <kevin@opendarwin.org> Jordan K. Hubbard <jkh@opendarwin.org> Ole Guldberg Jensen <olegb@opendarwin.org> Robert Shaw <rshaw@opendarwin.org> Chris Ridd <cjr@opendarwin.org> Juan Manuel Palacios <jmpp@opendarwin.org> Matt Anton <matt@opendarwin.org> James Berry <jberry@opendarwin.org> Joe Auty <joe@opendarwin.org>