.\" port.1
.\"
.\" Copyright (c) 2002 Apple Computer, Inc.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of Apple Computer, Inc. nor the names of its
.\"    contributors may be used to endorse or promote products derived from
.\"    this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
.\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd April 29, 2007
.Dt PORT 1 "MacPorts"
.Os
.Sh NAME
.Nm port
.Nd operate on individual or multiple Mac
.Ar ports
.Sh SYNOPSIS
.Nm
.Op Fl vdqfonRusbckixpt
.Op Fl D Ar portdir
.Op Fl F Ar cmdfile
.Op Ar action
.Op Ar actionflags
.Op Oo Ar portname | pseudo-portname | port-url Oc
.Op Oo Ar @version Oc Oo +/-variant ... Oc ... Oo option=value ... Oc
.Sh DESCRIPTION
.Nm
is designed to operate on individual or multiple Mac
.Ar ports ,
optionally within a single call, based on the requested
.Ar action .
If no
.Ar portdir
or
.Ar portname
is specified, the current working directory is assumed; if no
.Ar action
is specified the port command enters interactive mode, in which commands are read via stdin. Batch commands may be
passed via a
.Ar cmdfile .
Port 
.Ar options 
are passed as key=value pairs and take precedence over individual
.Ar portname
options as specified in its Portfile and system-wide settings.
.Pp
Port
.Ar variants
can specified as
.Ar +name ,
which indicates the variant is desired, or
.Ar -name ,
indicating the contrary. In case of ambiguities, a port can be fully specified with the
.Ar @version_revision+variants
format.
.Pp
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.
.Pp
The
.Nm
command knows various
.Ar pseudo-portnames
that will expand to the specified set of ports from the available ports tree(s). These may be used in place of a
.Ar portname .
Common options are:
.Pp
.Bl -bullet -offset indent -compact
.It
.Ar all :
all the ports in each ports tree listed in
.Ar sources.conf
.Pp
.It
.Ar current :
the port in the current working directory.
.Pp
.It
.Ar active :
set of installed and active ports.
.Pp
.It
.Ar inactive :
set of installed but inactive ports.
.Pp
.It
.Ar installed :
set of all installed ports.
.Pp
.It
.Ar uninstalled :
ports in the ports tree(s) that aren't installed.
.Pp
.It
.Ar outdated :
installed ports that are out of date with respect to their current version/revision in the ports tree(s)
.Pp
.El
Other options, also known as
.Ar pseudo-portname selectors ,
matching the most common keys used in a
.Ar Portfile
are also accepted, in both singular and plural form where applicable. These are:
.Pp
.Bl -bullet -offset indent -compact
.It
.Ar name
.It
.Ar version
.It
.Ar revision
.It
.Ar epoch
.It
.Ar variant
.It
.Ar variants
.It
.Ar category
.It
.Ar categories
.It
.Ar maintainer
.It
.Ar maintainers
.It
.Ar platform
.It
.Ar platforms
.It
.Ar description
.It
.Ar long_description
.It
.Ar homepage
.It
.Ar portdir
.El
.Pp
Search strings that will expand to a set of matching ports can be constructed based on the 
.Ar \(rqpseudo-portname selector\(lq:regex
combination used.
.Ar portnames
containing valid UNIX glob patterns will also expand to the set of matching ports. Any
.Ar action
passed to
.Nm
will be invoked on each of them. For example:
.Pp
.Dl port list variant:no_ssl
.Dl port uninstall name:sql
.\" COMMENT: glob pattern expansion in portnames:
.\" write an example here that illustrats better glob pattern expansion in portnames, but that does not employ
.\" logical operators (and, or, not, !) because I still haven't gotten to them yet.
.Dl port echo apache*
.Pp
Logical operators "and", "or", "not", "!", "(" and ")" may be used to combine individual
.Ar portnames ,
port glob patterns and/or
.Ar pseudo-portnames
to construct complex port expressions that expand to the set of matching ports. For example:
.Pp
.Dl port upgrade installed and "apache*"
.Dl port echo maintainer:jberry and uninstalled and \e(\ category:java and not commons*\ \e)
.\" COMMENT: more complex exmaples here would be useful.
.\" PENDING: port-url explanation. Proposed text:
.\".Pp
.\"A
.\".Ar portname
.\"may also be specified as a URL pointing to the location of the
.\".Ar portdir
.\" ...
.Pp
The
.Nm
command also recognizes several command line flags and
.Ar targets :
.Sh OPTIONS
.Bl -tag -width -indent
.It Fl v
verbose mode (generate verbose messages)
.It Fl d
debug mode (generate debugging messages, implies
.Fl v )
.It Fl q
quiet mode (suppress messages)
.It Fl n
don't follow dependencies in upgrade (only for upgrading)
.It Fl R
also upgrade dependents (only for upgrading)
.It Fl u
uninstall non-active ports when upgrading and uninstalling
.It Fl f
force mode (ignore state file)
.It Fl o
honor state files older than Portfile
.It Fl s
source-only mode (build and install from source, ignore all binary archives, do not create/recreate binary archives) (only applies when archive mode is enabled)
.It Fl b
binary-only mode (build and install from binary archives, ignore source, abort if no archive present; do not create/recreate binary archives from source) (only applies when archive mode is enabled)
.It Fl c
autoclean mode (execute clean after install)
.It Fl k
keep mode (don't autoclean after install)
.It Fl D
specify
.Ar portdir
.It Fl F
Read and process the
.Ar file
of commands specified by the argument. If the argument is '-', then read commands from stdin. If the option is given multiple times, then multiple files will be read.
.It Fl i
Read commands from stdin. Short for -F -
.It Fl x
In batch and interactive mode, exit on the first error encountered. Otherwise, errors during batch execution are simply reported.
.It Fl p
Despite any errors encountered, proceed to process multiple ports and commands.
.It Fl t
enable trace mode debug facilities on platforms that support it (Mac OS 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 ${workpath}).
.El
.Sh USER TARGETS
Targets most commonly used by regular MacPorts users are:
.Ss search
Search for an available port whose name matches a regular expression. For example:
.Pp
.Dl "port search vim"
.Pp
.Ss info
Displays all the meta-information available for
.Ar portname .
Specific meta-information may be requested through an option such as
.Fl -maintainer
or
.Fl -category
(recognized field names are those from the PortIndex). If the global option
.Fl q
is in effect, the meta-info fields will not be labeled.
If the option
.Fl -line
is provided, all such data will be consolidated into a single line per port,
suitable for processing in a pipe of commands.
If the option
.Fl -index
is provided, the information will be pulled from the PortIndex rather than
from the Portfile (in this case variant information, such as dependencies,
will not affect the output).
.Pp
For example:
.br
.Dl "port info vim +ruby"
.Dl "port info --category --name apache*"
.Dl "port -q info --category --name --version category:java"
.Dl "port info --line --category --name all"
.Dl "port info --index python24"
.Ss variants
Lists the build variants available for
.Ar portname .
.Ss deps
Lists the other ports that are required to build and run
.Ar portname .
.Ss dependents
Lists the installed ports that depend on the port
.Ar portname .
.Ss install
Install and activate
.Ar portname .
.Ss uninstall
Deactivate and uninstall
.Ar portname .
To uninstall all installed but inactive ports, use
.Fl u .
To recursively uninstall all dependents of this port, use
.Fl -follow-dependents .
.Pp
For example:
.Pp
.Dl "port uninstall vim"
.Dl "port -u uninstall"
.Dl "port uninstall --follow-dependents python24"
.Ss activate
Activate the installed
.Ar portname .
.Ss deactivate
Deactivate the installed
.Ar portname .
.Ss installed
List all installed ports.
.Ss location
Print the install location of a given port.
.Ss contents
Lists the files installed by
.Ar portname .
.Ss provides
Determines which port owns a given file and can take either a relative or absolute path. For example:
.Pp
.Dl "port provides /opt/local/etc/irssi.conf"
.Dl "port provides include/tiff.h"
.Ss sync
Performs a sync operation only on the ports tree of a MacPorts installation, pulling in the latest
revision available of the
.Ar Portfiles
from the MacPorts rsync server. To update you would normally do:
.Pp
.Dl "sudo port -d sync"
.Pp
If any of the ports tree(s) uses a file: URL that points to a local subversion working copy,
.Ic sync
will perform an
.Ic "svn update"
on the working copy with the user set to the owner of the working copy.
.Ss outdated
List the installed ports that need upgrading.
.Ss 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.
.Pp    
Upgrade the installed
.Ar portname .
For example:
.Pp
.Dl "port upgrade vim"
.Pp
To upgrade all installed ports:
.Pp
.Dl "port upgrade installed"
.Pp
To upgrade
.Ar portname
and the ports that depend on it:
.Pp
.Dl "port -R upgrade libiconv"
.Pp
To force an upgrade (rebuild) use:
.Pp
.Dl "port -f upgrade vim"
.Pp
To upgrade
.Ar portname
without following its dependencies, use
.Fl n .
For example:
.Pp
.Dl "port -n upgrade wireshark"
.Ss clean
Clean the files used for building
.Ar portname .
To just remove the work files, use the
.Fl -work
.Ar actionflag .
To remove the distribution files (tarballs, etc), specify
.Fl -dist .
To remove the archive(s) for the current version of a port, pass
.Fl -archive .
To remove the work files, distribution files and archives, pass
.Fl -all .
For example:
.Pp
.Dl "port clean --dist vim"
.Dl "port clean --archive vim"
.Pp
To remove only certain version(s) of a port's archives (
.Ar version
is any valid UNIX glob pattern), you can use:
.Pp
.Dl "port clean --archive vim 6.2.114"
.Pp
or:
.Pp
.Dl "port clean --archive vim '6.*'"
.Ss echo
Writes to stdout the arguments passed to
.Nm .
This follows the expansion of
.Ar pseudo-portnames ,
portname glob patterns,
.Ar pseudo-portname selectors
and the evaluation of port expressions.
.Nm 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:
.Pp
.Dl port echo category:net
.Dl port echo maintainer:jmpp and name:netw
.Dl port echo maintainer:jmpp and \e(\ net* or category:text\ \e)
.Pp
.Ss list
If no argument is given, display a list of the latest version of all available ports.
If portname(s) are given as arguments, display a list of the latest version of each port.
.Ss version
Display the release number of the installed MacPorts infrastructure.
.Ss selfupdate
Updates the MacPorts system, ports tree(s) and base tools if needed, from the MacPorts rsync server,
installing the newest infrastructure available. To update you would typically do:
.Pp
.Dl "sudo port -d selfupdate"
.Pp
See
.Ic sync
for more information about updating ports tree(s).
.Ss help
Displays a summary of all available actions and port command syntax on stdout.
.Sh 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:
.Ss dir
Displays the path to the directory containing
.Ar portname .
.Ss file
Displays the path to the Portfile for
.Ar portname .
.Ss cat
Concatenates and prints the contents of
.Ar Portfile
on stdout.
.Ss edit
Opens
.Ar Portfile 
with your default editor specified in your shell's environment variable. Alias
.Ar ed
also invokes this command.
.Pp
You can also use the
.Fl -editor
flag on the command line to specify an alternative editor. For example:
.Dl port edit --editor nano apache2
.Pp
.Ss unarchive
Unpack the port from a pre-built binary archive. When archive mode is enabled, this command is called automatically, prior to
.Ar fetch ,
to check for an existing binary archive to unpack. If found, it is unpacked and all stages up to
.Ar install
are then skipped.
.Ss fetch
Fetches the distribution files required to build
.Ar portname .
.Ss checksum
Compute the checksums of the distribution files for 
.Ar portname ,
and compare them to the checksums listed in 
.Ar Portfile .
.Ss extract
Extracts the distribution files for
.Ar portname .
.Ss patch
Applies any required patches to 
.Ar portname's
extracted distribution files.
.Ss configure
Runs any configure process for
.Ar portname .
.Ss build
Build
.Ar portname .
.Ss destroot
Installs
.Ar portname
to a temporary directory.
.Ss test
Tests
.Ar portname .
.Ss lint
Verifies Portfile for
.Ar portname .
To nitpick about whitespace and patchfile names, use
.Fl -nitpick .
.Ss archive
Archive the port for a later
.Ar unarchive .
When archive mode is enabled, binary archives will be created automatically whenever an
.Ar install
is performed, or when the
.Ar archive
target is called explicitly.
.Ss distcheck
Check if the distfiles haven't changed and can be fetched.
.Ss distfiles
Display each distfile, its checksums, and the URLs used to fetch it.
.Ss livecheck
Check if the software hasn't been updated since the Portfile was last modified.
.Sh PACKAGING TARGETS
There are also targets for producing installable packages of ports:
.Pp
.Ss pkg
Creates an OS X installer package of
.Ar portname.
.Ss mpkg
Creates an OS X installer metapackage of 
.Ar portname
and its dependencies.
.Ss dmg
Creates an internet-enabled disk image containing an OS X package of
.Ar portname .
.Ss mdmg
Creates an internet-enabled disk image containing an OS X metapackage of
.Ar portname
and its dependencies.
.Ss rpm
Creates an RPM binary package of
.Ar portname ,
similar to a tgz "archive".
.Ss srpm
Creates a SRPM source package of
.Ar portname ,
similar to a xar "portpkg".
.Ss dpkg
Creates a DEB binary package of
.Ar portname .
.Sh EXAMPLES
The following demonstrates invoking
.Nm
with the
.Ar extract
target on
.Ar portdir
\&"textproc/figlet" and extract.suffix set to ".tgz":
.Pp
.Dl "port extract -D textproc/figlet extract.suffix=.tgz"
.Pp
.Sh FILES
.Bl -tag -width
.It Va ${prefix}/etc/macports/macports.conf
Global configuration file for the MacPorts system.
.It Va ${prefix}/etc/macports/sources.conf
Global listing of the ports trees used by MacPorts. This file also enables rsync synchronization.
.It Va ${prefix}/etc/macports/variants.conf
Global variants used when a port is installed.
.It Va ~/.macports/macports.conf
User configuration file for the MacPorts system. It overrides the global
.Ar macports.conf
file.
.El
.Sh DIAGNOSTICS
.Ex -std
.Sh SEE ALSO
.Xr macports.conf 5 ,
.Xr portfile 7 ,
.Xr portgroup 7 ,
.Xr portstyle 7 ,
.Xr porthier 7
.Sh AUTHORS
.An "Landon Fuller" Aq landonf@macports.org
.An "James Berry" Aq jberry@macports.org
.An "Jordan K. Hubbard" Aq jkh@macports.org
.An "Juan Manuel Palacios" Aq jmpp@macports.org
.An "Kevin Van Vechten" Aq kevin@opendarwin.org
.An "Ole Guldberg Jensen" Aq olegb@opendarwin.org
.An "Robert Shaw" Aq rshaw@opendarwin.org
.An "Chris Ridd" Aq cjr@opendarwin.org
.An "Matt Anton" Aq matt@opendarwin.org
.An "Joe Auty" Aq joe@opendarwin.org