USES| Feature | Arguments | Description |
|---|---|---|
ada | (none), 47, 49,
5 | Depends on an Ada-capable
compiler, and sets CC accordingly.
Defaults to a gcc 4.9 based
compiler, use :47 to use the older
gcc 4.7 based one and
:5 to use the newer
gcc 5 based one. |
autoreconf | (none), build | Runs autoreconf. It encapsulates
the aclocal,
autoconf,
autoheader,
automake, autopoint,
and libtoolize commands. Each command
applies to
${CONFIGURE_WRKSRC}/configure.ac or
its old name,
${CONFIGURE_WRKSRC}/configure.in. If
configure.ac defines subdirectories
with their own configure.ac using
AC_CONFIG_SUBDIRS,
autoreconf will recursively update
those as well. The :build argument
only adds build time dependencies on those tools but does
not run autoreconf. |
blaslapack | (none), atlas,
netlib (default),
gotoblas,
openblas | Adds dependencies on Blas / Lapack libraries. |
bison | (none), build,
run, both | Uses devel/bison
By default, with no arguments or with the
build argument, it implies
bison is a build-time dependency,
run implies a run-time dependency, and
both implies both run-time and
build-time dependencies. |
charsetfix | (none) | Prevents the port from installing
charset.alias. This must be
installed only by
converters/libiconv.
CHARSETFIX_MAKEFILEIN can be set to a
path relative to WRKSRC if
charset.alias is not installed by
${WRKSRC}/Makefile.in. |
cmake | (none), outsource,
run | Uses CMake for configuring
and building. With the outsource
argument, an out-of-source build will be performed. With
the run argument, a run-time dependency
is registered. For more information see
Section 6.5.4, “Using cmake”. |
compiler | (none), c++0x,
c++11-lang,
gcc-c++11-lib,
c++11-lib, c11,
openmp, nestedfct,
features | Determines which compiler to use based on any given
wishes. Use c++11-lang if the port
needs a C++11-capable compiler,
gcc-c++11-lib if the port needs the
g++ compiler with a C++11 library, and
c++11-lib if the port also needs a
C++11-ready standard library. If the port needs a
compiler understanding C++0X, C11, OpenMP, or nested
functions, the corresponding parameters can be used. Use
features to request a list of features
supported by the default compiler. After including
bsd.port.pre.mk the port can inspect
the results using these variables:
|
cpe | (none) |
Include Common Platform Enumeration
(CPE) information in package manifest
as a CPE 2.3 formatted string. See the
CPE
specification for details. To add
CPE information to a port, follow these
steps:
|
cran | (none), auto-plist | Uses the Comprehensive R Archive Network. Specify
auto-plist to automatically generate
pkg-plist. |
desktop-file-utils | (none) | Uses
update-desktop-database from
devel/desktop-file-utils.
An extra post-install step will be run without interfering
with any post-install steps already in the port
Makefile. A line with @desktop-file-utils
will be added to the plist. |
desthack | (none) | Changes the behavior of GNU configure to properly
support DESTDIR in case the original
software does not. |
display | (none), ARGS | Set up a virtual display environment. If the
environment variable DISPLAY is not
set, then Xvfb is added as a
build dependency, and CONFIGURE_ENV is
extended with the port number of the currently running
instance of Xvfb. The
ARGS parameter defaults to
install and controls the phase around
which to start and stop the virtual display. |
dos2unix | (none) | The port has files with line endings in
DOS format which need to be converted.
Three variables can be set to control which files will be
converted. The default is to convert
all files, including binaries. See
Section 4.4.3, “Simple Automatic Replacements” for
examples.
|
drupal | 6, 7,
module,
theme | Automate installation of a port that is a
Drupal
theme or module. Use with the version of Drupal that the
port is expecting. For example,
USES=drupal:6,module says that this
port creates a Drupal 6 module. A Drupal 7 theme can be
specified with
USES=drupal:7,theme. |
execinfo | (none) | Add a library dependency on devel/libexecinfo if
libexecinfo.so is not present in the
base system. |
fakeroot | (none) | Changes some default behaviour of build systems to
allow installing as a user. See http://fakeroot.alioth.debian.org/ for
more information on fakeroot. |
fam | (none), fam, gamin | Uses a File Alteration Monitor as a library dependency, either devel/fam or devel/gamin. End users can set WITH_FAM_SYSTEM to specify their preference. |
fmake | (none) | Uses devel/fmake as a build-time dependency. |
fonts | (none) | Adds a runtime dependency on tools needed to register
fonts, and add an @fcfontsdir
${FONTSDIR} entry to the plist.
FONTSDIR defaults to
${PREFIX}/lib/X11/fonts/${FONTNAME}
and FONTNAME to
${PORTNAME}. |
fortran | gcc (default),
ifort | Uses the Fortran compiler from either GNU or Intel. |
fuse | (none) | The port will depend on the FUSE library and handle the dependency on the kernel module depending on the version of FreeBSD. |
gecko | libxul (default),
firefox, seamonkey,
thunderbird, build,
| Add a dependency on different
gecko based applications. If
libxul is used, it is the only argument
allowed. When the argument is not
libxul, the firefox,
seamonkey, or
thunderbird arguments can be used,
along with optional build and
|
gettext | (none) | Deprecated. Will include both gettext-runtime
and gettext-tools. |
gettext-runtime | (none), lib (default),
build, run | Uses devel/gettext-runtime. By
default, with no arguments or with the
lib argument, implies a library
dependency on libintl.so.
build and run
implies, respectively a build-time and a run-time
dependency on gettext. |
gettext-tools | (none), build (default),
run | Uses devel/gettext-tools. By default,
with no argument, or with the build
argument, a build time dependency on
msgfmt is registered. With the
run argument, a run-time dependency is
registered. |
gmake | (none), lite | Uses devel/gmake, or
devel/gmake-lite if the
lite argument is used, as a
build-time dependency and sets up the environment to use
gmake as the default
make for the build. |
gperf | (none) | Add a buildtime dependency on devel/gperf if
gperf is not present in the base
system. |
gssapi | (none), base (default),
heimdal, mit,
flags,
bootstrap |
Handle dependencies needed by consumers of the
GSS-API. Only libraries that provide
the Kerberos mechanism are
available. By default, or set to
When the local Kerberos
installation is not in These variables are exported for the ports to use:
The The Example 15.1. Typical Use OPTIONS_SINGLE= GSSAPI
OPTIONS_SINGLE_GSSAPI= GSSAPI_BASE GSSAPI_HEIMDAL GSSAPI_MIT GSSAPI_NONE
GSSAPI_BASE_USES= gssapi
GSSAPI_BASE_CONFIGURE_ON= --with-gssapi=${GSSAPIBASEDIR} ${GSSAPI_CONFIGURE_ARGS}
GSSAPI_HEIMDAL_USES= gssapi:heimdal
GSSAPI_HEIMDAL_CONFIGURE_ON= --with-gssapi=${GSSAPIBASEDIR} ${GSSAPI_CONFIGURE_ARGS}
GSSAPI_MIT_USES= gssapi:mit
GSSAPI_MIT_CONFIGURE_ON= --with-gssapi=${GSSAPIBASEDIR} ${GSSAPI_CONFIGURE_ARGS}
GSSAPI_NONE_CONFIGURE_ON= --without-gssapi |
horde | (none) | Add buildtime and runtime dependencies on devel/pear-channel-horde. Other
Horde dependencies can be added
with USE_HORDE_BUILD and
USE_HORDE_RUN. See Section 6.14.4.1, “Horde Modules” for more information. |
iconv | (none), lib,
build,
patch, translit,
wchar_t | Uses iconv functions, either from
the port
converters/libiconv as a
build-time and run-time dependency, or from the base
system on 10-CURRENT after a native
iconv was committed in
254273. By default, with no
arguments or with the lib argument,
implies iconv with build-time and
run-time dependencies. build implies a
build-time dependency, and patch
implies a patch-time dependency. If the port uses the
WCHAR_T or
//TRANSLIT iconv extensions, add the
relevant arguments so that the correct iconv is used. For
more information see
Section 6.22, “Using iconv”. |
imake | (none), env,
notall,
noman | Add devel/imake as a
build-time dependency and run xmkmf -a
during the configure stage. If
the env argument is given, the
configure target is not set.
If the -a flag is a problem for the port,
add the notall argument. If
xmkmf does not generate a
install.man target, add the
noman argument. |
kmod | (none) | Fills in the boilerplate for kernel module ports,
currently:
|
lha | (none) | Set EXTRACT_SUFX to
.lzh |
libtool | (none), keepla,
build | Patches libtool scripts. This
must be added to all ports that use
libtool. The keepla
argument can be used to keep .la
files. Some ports do not ship with their own copy of
libtool and need a build time dependency on devel/libtool, use the
:build argument to add such
dependency. |
lua | (none),
build,
run | Adds a dependency on Lua.
By default this is a library dependency, unless
overridden by the build or
run option. The default version is
5.2, unless set by the
51 or
52+). |
makeinfo | build (default),
run, both | Add the corresponding dependencies on
makeinfo. |
makeself | (none) | Indicates that the distribution files are makeself archives and sets the appropriate dependencies. |
metaport | (none) | Sets the following variables to make it easier to
create a metaport: MASTER_SITES,
DISTFILES,
EXTRACT_ONLY,
NO_BUILD, NO_INSTALL,
NO_MTREE, NO_ARCH.
|
mono | (none) | Adds a dependency on the Mono (currently only C#) framework by setting the appropriate dependencies. |
motif | (none) | Uses
x11-toolkits/open-motif as
a library dependency. End users can set
WANT_LESSTIF for the dependency to be
on x11-toolkits/lesstif
instead of x11-toolkits/open-motif. |
ncurses | (none), base,
port | Uses ncurses, and causes some useful variables to be set. |
ninja | (none) | Uses ninja to build the
port. End users can set NINJA_VERBOSE
for verbose output. |
objc | (none) | Add objective C dependencies (compiler, runtime library) if the base system does not support it. |
openal | al, soft
(default), si,
alut | Uses OpenAL. The backend
can be specified, with the software implementation as the
default. The user can specify a preferred backend with
WANT_OPENAL. Valid values for
this knob are soft (default) and
si. |
pathfix | (none) | Look for Makefile.in and
configure in the port's
associated sources and fix common paths to make sure they
respect the FreeBSD hierarchy. If the port uses
automake, set
PATHFIX_MAKEFILEIN to
Makefile.am if needed. |
pear | (none) | Adds a dependency on devel/pear. It will setup default behavior for software using the PHP Extension and Application Repository. See Section 6.14.4, “PEAR Modules” for more information. |
perl5 | (none) | Depends on Perl. These
variables can be set:
|
pgsql | (none),
|
Provide support for PostgreSQL. Maintainer can set version required. Minimum and maximum versions can be specified; for example, 9.0-, 8.4+. Add PostgreSQL component dependency, using
|
pkgconfig | (none), build (default),
run, both | Uses devel/pkgconf.
With no arguments or with the build
argument, it implies pkg-config as a
build-time dependency. run implies a
run-time dependency and both implies
both run-time and build-time dependencies. |
pure | (none), ffi | Uses lang/pure.
Largely used for building related
pure ports. With the
ffi argument, it implies
devel/pure-ffi as a
run-time dependency. |
python | (none),
build,
run
| Uses Python. A supported
version or version range can be specified. If Python is
only needed at build or run time, it can be set as a build
or run dependency with build or
run. See Section 6.15, “Using Python”
for more information. |
qmail | (none), build,
run,
both, vars | Uses mail/qmail. With
the build argument, it implies
qmail as a build-time dependency.
run implies a run-time dependency.
Using no argument or the both argument
implies both run-time and build-time dependencies.
vars will only set QMAIL variables for
the port to use. |
qmake | (none), norecursive,
outsource | Uses QMake for
configuring. For more information see
Section 6.11.3, “Using qmake”. |
readline | (none), port | Uses readline as a library
dependency, and sets CPPFLAGS and
LDFLAGS as necessary. If the
port argument is used or if readline
is not present in the base system, add a dependency on
devel/readline |
scons | (none) | Provide support for the use of devel/scons |
shared-mime-info | (none) | Uses update-mime-database
from misc/shared-mime-info.
This uses will automatically add a post-install step in
such a way that the port itself still can specify there
own post-install step if needed. It also add an @shared-mime-info
entry to the plist. |
shebangfix | (none) | A lot of software uses incorrect locations for script
interpreters, most notably
/usr/bin/perl and
/bin/bash. This fixes shebang lines
in scripts listed in SHEBANG_FILES.
Currently Bash,
Java,
Ksh,
Perl,
PHP,
Python,
Ruby,
Tcl, and
Tk are supported by default.
To support another interpreter, set
SHEBANG_LANG,
lua_OLD_CMD and
lua_CMD. For example
SHEBANG_LANG=lua, then
lua_OLD_CMD=/usr/bin/lua and
lua_CMD=${LOCALBASE}/bin/lua. |
tar | (none), Z, bz2,
bzip2, lzma,
tbz, tgz,
txz, xz | Set EXTRACT_SUFX to
.tar, .tar.Z,
.tar.bz2, .tar.bz2,
.tar.lzma, .tbz,
.tgz, .txz or
.tar.xz respectively. |
tcl | PORT | Add a dependency on Tcl.
The PORT parameter can be either
tcl or tk. Either a
version or wrapper dependency can be appended using
PORT:version or
PORT:wrapper. The version can be
empty, one or more exact version numbers (currently
84, 85, or
86), or a minimal version number
(currently 84+, 85+
or 86+). A build- or run-time only
dependency can be specified using
PORT,build or
PORT,run. After including
bsd.port.pre.mk the port can inspect
the results using these variables:
|
tk | Same as arguments for tcl | Small wrapper when using both Tcl and Tk. The same variables are returned as when using Tcl. |
twisted | (none), ARGS | Add a dependency on
twistedCore. The list of
required components can be specified as a value of this
variable. ARGS can be one of:
build and
run, one or more other supported
twisted components can be
specified. Supported values are listed in
Uses/twisted.mk. |
uidfix | (none) | Changes some default behavior (mostly variables) of
the build system to allow installing this port as a normal
user. Try this in the port before adding
NEED_ROOT=yes |
uniquefiles | (none), dirs | Make files or directories 'unique', by adding a
prefix or suffix. If the dirs argument
is used, the port needs a prefix (a only a prefix) based
on UNIQUE_PREFIX for standard
directories DOCSDIR,
EXAMPLESDIR,
DATADIR, WWWDIR,
ETCDIR. These variables are
available for ports:
|
webplugin | (none), ARGS | Automatically create and remove symbolic links for
each application that supports the webplugin framework.
ARGS can be one of:
|
xfce | (none), gtk3 |
Provide support for Xfce related ports. See Section 6.23, “Using Xfce” for details. The |
zip | (none), infozip | Indicates that the distribution files use the ZIP
compression algorithm. For files using the InfoZip
algorithm the infozip argument must be
passed to set the appropriate dependencies. |
zope | (none) | Uses www/zope. Mostly
used for building zope related
ports. ZOPE_VERSION can be used by a
port to indicate that a specific version of
zope shall be used. |
All FreeBSD documents are available for download at http://ftp.FreeBSD.org/pub/FreeBSD/doc/
Questions that are not answered by the
documentation may be
sent to <[email protected]>.
Send questions about this document to <[email protected]>.