Copyright © 2000-2020 The FreeBSD Documentation Project
Copyright
Redistribution and use in source (XML DocBook) and 'compiled' forms (XML, HTML, PDF, PostScript, RTF and so forth) with or without modification, are permitted provided that the following conditions are met:
Redistributions of source code (XML DocBook) must retain the above copyright notice, this list of conditions and the following disclaimer as the first lines of this file unmodified.
Redistributions in compiled form (transformed to other DTDs, converted to PDF, PostScript, RTF and other formats) 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.
THIS DOCUMENTATION IS PROVIDED BY THE FREEBSD DOCUMENTATION PROJECT "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 FREEBSD DOCUMENTATION PROJECT 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 DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
FreeBSD is a registered trademark of the FreeBSD Foundation.
UNIX is a registered trademark of The Open Group in the United States and other countries.
Sun, Sun Microsystems, Java, Java Virtual Machine, JDK, JRE, JSP, JVM, Netra, OpenJDK, Solaris, StarOffice, SunOS and VirtualBox are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries.
Many of the designations used by manufacturers and sellers to distinguish their products are claimed as trademarks. Where those designations appear in this document, and the FreeBSD Project was aware of the trademark claim, the designations have been followed by the “™” or the “®” symbol.
MAINTAINER
COMMENT
PORTSCOUT
MASTERDIR
BINARY_ALIAS
to Rename Commands
Instead of Patching the Buildgettext
iconv
rc
Scripts)pkg-plist
Practicespkg-*
WRKDIR
WRKDIRPREFIX
bsd.port.mk
exec
Statement in Wrapper
ScriptsCC
and
CXX
CFLAGS
README.html
BROKEN
, FORBIDDEN
, or
IGNORE
DEPRECATED
or
EXPIRATION_DATE
.error
Constructsysctl
Makefile
PORTNAME
BlockPATCHFILES
BlockMAINTAINER
BlockLICENSE
BlockBROKEN
/IGNORE
/DEPRECATED
MessagesUSES
and
USE_x
bsd.port.mk
VariablesUSES
MacrosUSES
7z
ada
autoreconf
blaslapack
bdb
bison
cabal
cargo
charsetfix
cmake
compiler
cpe
cran
desktop-file-utils
desthack
display
dos2unix
drupal
eigen
fakeroot
fam
firebird
fonts
fortran
fuse
gem
gettext
gettext-runtime
gettext-tools
ghostscript
gl
gmake
gnome
go
gperf
grantlee
groff
gssapi
horde
iconv
imake
kde
kmod
lha
libarchive
libedit
libtool
linux
localbase
lua
lxqt
makeinfo
makeself
mate
meson
metaport
mysql
mono
motif
ncurses
ninja
objc
openal
pathfix
pear
perl5
pgsql
php
pkgconfig
pure
pyqt
python
qmail
qmake
qt
qt-dist
readline
samba
scons
shared-mime-info
shebangfix
sqlite
ssl
tar
tcl
terminfo
tk
uidfix
uniquefiles
varnish
webplugin
xfce
xorg
xorg-cat
zip
__FreeBSD_version
ValuesDISTVERSION
and the
Derived PORTVERSION
MASTER_SITE_*
MacrosMASTER_SITES
MacrosUSE_GITHUB
DescriptionUSE_GITLAB
DescriptionUSE_*
configure
cmake
cmake
Buildscargo
Buildsmeson
USES= qmake
qmake
WX_CONF_ARGS
USES
Macros__FreeBSD_version
Values__FreeBSD_version
Values__FreeBSD_version
Values__FreeBSD_version
Values__FreeBSD_version
Values__FreeBSD_version
Values__FreeBSD_version
Values__FreeBSD_version
Values__FreeBSD_version
Values__FreeBSD_version
Values__FreeBSD_version
Values__FreeBSD_version
Values__FreeBSD_version
Values.diff
for a New
Port.shar
for a New PortEXTRA_PATCHES
With a
DirectoryDISTVERSION
DISTVERSION
When the Version
Starts with a Letter or a PrefixDISTVERSION
When the Version
Contains Letters Meaning “alpha”,
“beta”, or “pre-release”DISTVERSION
When the
Version Contains Letters Meaning "Patch Level"PORTVERSION
ManuallyDISTNAME
from
PORTVERSION
USE_GITHUB
USE_GITHUB
USE_GITHUB
with
DISTVERSIONPREFIX
USE_GITHUB
When Upstream Does
Not Use VersionsUSE_GITHUB
to Access
a Commit Between Two VersionsUSE_GITHUB
with Multiple
Distribution FilesUSE_GITHUB
with Multiple
Distribution Files Using
GH_TUPLE
USE_GITHUB
with
Git Submodules?USE_GITLAB
USE_GITLAB
USE_GITLAB
with Multiple
Distribution FilesUSE_GITLAB
with Multiple
Distribution Files Using
GL_TUPLE
MASTER_SITES:n
with One File Per SiteMASTER_SITES:n
with More Than One File Per SiteMASTER_SITES:n
in
MASTER_SITE_SUBDIR
MASTER_SITES:n
with Comma
Operator, Multiple Files, Multiple Sites and
Multiple SubdirectoriesMASTER_SITES:n
with SourceForge (SF
)MASTER_SITES:n
with
PATCH_SITES
LICENSE_NAME
LICENSE_FILE
LICENSE_TEXT
LICENSE_DISTFILES
OPTIONS
OPTIONS
OPTIONS
OPT
_IMPLIES
OPT
_PREVENTS
CONFLICTS*
CONFLICTS*
With Globs.BINARY_ALIAS
to Make
gsed
Available as
sed
BINARY_ALIAS
to Provide Aliases
for Hardcoded python3
CommandsUSES= cmake
ExampleCMAKE_ON
and
CMAKE_OFF
USES=meson
ExampleExtUtils::MakeMaker
to BuildModule::Build
to BuildUSE_XORG
ExampleUSES= qmake
ExampleUSE_KDE
ExampleUSE_LXQT
Exampleiconv
Usageiconv
Usage with
configure
-liconv
iconv
AvailabilityUSES=xfce
ExamplePKGNAME
USES=php
ExtensionUSES=python
USES=python
with Version
Requirementsdistutils
@dirrmtryecho
Keyword@sample
is
Implementedmake.conf
to Change Default
Perl.error
USES=shebangfix
USES=shebangfix
USES=shebangfix
with
SHEBANG_REGEX
USES=shebangfix
with
SHEBANG_GLOB
USES=shebangfix
with
SHEBANG_FILES
The FreeBSD Ports Collection is the way almost everyone installs applications ("ports") on FreeBSD. Like everything else about FreeBSD, it is primarily a volunteer effort. It is important to keep this in mind when reading this document.
In FreeBSD, anyone may submit a new port, or volunteer to maintain an existing unmaintained port. No special commit privilege is needed.
Interested in making a new port, or upgrading existing ports? Great!
What follows are some guidelines for creating a new port for FreeBSD. To upgrade an existing port, read this, then read Chapter 11, Upgrading a Port.
When this document is not sufficiently detailed,
refer to /usr/ports/Mk/bsd.port.mk
, which is
included by all port Makefile
s. Even those
not hacking Makefile
s daily can gain much
knowledge from it. Additionally, specific questions can be sent
to the FreeBSD ports mailing list.
Only a fraction of the variables
(
) that can be
overridden are mentioned in this document. Most (if not all)
are documented at the start of
VAR
/usr/ports/Mk/bsd.port.mk
; the others
probably ought to be. Note that this file uses a non-standard
tab setting: Emacs and
Vim will recognize the setting on
loading the file. Both vi(1) and ex(1) can be set to
use the correct value by typing
:set tabstop=4
once the file has been
loaded.
Looking for something easy to start with? Take a look at the list of requested ports and see if you can work on one (or more).
This section describes how to quickly create a new port. For applications where this quick method is not adequate, the full “Slow Porting” process is described in Chapter 4, Slow Porting.
First, get the original tarball and put it into
DISTDIR
, which defaults to
/usr/ports/distfiles
.
These steps assume that the software compiled out-of-the-box. In other words, absolutely no changes were required for the application to work on a FreeBSD system. If anything had to be changed, refer to Chapter 4, Slow Porting.
It is recommended to set the DEVELOPER
make(1) variable in /etc/make.conf
before getting into porting.
#
echo DEVELOPER=yes >> /etc/make.conf
This setting enables the “developer mode”
that displays deprecation warnings and activates some further
quality checks on calling make
.
The minimal Makefile
would look
something like this:
# $FreeBSD$ PORTNAME= oneko DISTVERSION= 1.1b CATEGORIES= games MASTER_SITES= ftp://ftp.cs.columbia.edu/archives/X11R5/contrib/ MAINTAINER= youremail@example.com COMMENT= Cat chasing a mouse all over the screen .include <bsd.port.mk>
In some cases, the Makefile
of an
existing port may contain additional lines in the header,
such as the name of the port and the date it was created.
This additional information has been declared obsolete, and
is being phased out.
Try to figure it out. Do not worry about the
contents of the $FreeBSD$
line, it will be filled in automatically by
Subversion when the port is
imported to our main ports tree. A more detailed
example is shown in the
sample Makefile
section.
There are two description files that are required for
any port, whether they actually package or not. They are
pkg-descr
and
pkg-plist
. Their
pkg-
prefix distinguishes them from other
files.
This is a longer description of the port. One to a few paragraphs concisely explaining what the port does is sufficient.
This is not a manual or an
in-depth description on how to use or compile the port!
Please be careful when copying from the
README
or manpage. Too
often they are not a concise description of the port or
are in an awkward format. For example, manpages have
justified spacing, which looks particularly bad with
monospaced fonts.
On the other hand, the content of
pkg-descr
must be longer than the COMMENT
line from the Makefile. It must explain in more depth what
the port is all about.
A well-written pkg-descr
describes
the port completely enough that users would not have to
consult the documentation or visit the website to understand
what the software does, how it can be useful, or what
particularly nice features it has. Mentioning certain
requirements like a graphical toolkit, heavy dependencies,
runtime environment, or implementation languages help users
decide whether this port will work for them.
Include a URL to the official WWW homepage. Prepend
one of the websites (pick the most
common one) with WWW:
(followed by single
space) so that automated tools will work correctly. If the
URI is the root of the website or directory, it must be
terminated with a slash.
If the listed webpage for a port is not available, try to search the Internet first to see if the official site moved, was renamed, or is hosted elsewhere.
This example shows how
pkg-descr
looks:
This is a port of oneko, in which a cat chases a poor mouse all over the screen. : (etc.) WWW: http://www.oneko.org/
This file lists all the files installed by the port. It
is also called the “packing list” because the
package is generated by packing the files listed here. The
pathnames are relative to the installation prefix (usually
/usr/local
).
Here is a small example:
bin/oneko man/man1/oneko.1.gz lib/X11/app-defaults/Oneko lib/X11/oneko/cat1.xpm lib/X11/oneko/cat2.xpm lib/X11/oneko/mouse.xpm
Refer to the pkg-create(8) manual page for details on the packing list.
It is recommended to keep all the filenames in this file sorted alphabetically. It will make verifying changes when upgrading the port much easier.
Creating a packing list manually can be a very tedious task. If the port installs a large numbers of files, creating the packing list automatically might save time.
There is only one case when
pkg-plist
can be omitted from a port.
If the port installs just a handful of files, list them in
PLIST_FILES
, within the
port's Makefile
. For instance, we
could get along without pkg-plist
in
the above oneko
port by adding these
lines to the Makefile
:
PLIST_FILES= bin/oneko \ man/man1/oneko.1.gz \ lib/X11/app-defaults/Oneko \ lib/X11/oneko/cat1.xpm \ lib/X11/oneko/cat2.xpm \ lib/X11/oneko/mouse.xpm
Usage of PLIST_FILES
should not be
abused. When looking for the origin of a file, people
usually try to grep through the
pkg-plist
files in the ports tree.
Listing files in PLIST_FILES
in the
Makefile
makes that search more
difficult.
If a port needs to create an empty directory, or creates
directories outside of ${PREFIX}
during
installation, refer to Section 8.2.1, “Cleaning Up Empty Directories”
for more information.
As PLIST_FILES
is a make(1) variable,
any entry with spaces must be quoted. For example, if using
keywords described in pkg-create(8) and Section 8.6, “Expanding Package List with Keywords”, the entry must be quoted.
PLIST_FILES= "@sample ${ETCDIR}/oneko.conf.sample"
Later we will see how pkg-plist
and PLIST_FILES
can be used to fulfill
more sophisticated
tasks.
Just type make makesum
. The ports
framework will automatically generate
distinfo
. Do not try to generate the file
manually.
Make sure that the port rules do exactly what is desired, including packaging up the port. These are the important points to verify:
pkg-plist
does not contain
anything not installed by the port.
pkg-plist
contains everything
that is installed by the port.
The port can be installed using the
install
target. This verifies
that the install script works correctly.
The port can be deinstalled properly using the
deinstall
target. This
verifies that the deinstall script works correctly.
The port only has access to network resources during the
fetch
target phase. This is
important for package builders, such as ports-mgmt/poudriere.
Make sure that make package
can be
run as a normal user (that is, not as
root
). If that
fails, the software may need to be patched. See also Section 17.21, “fakeroot
” and Section 17.89, “uidfix
”.
make stage
make stage-qa
make package
make install
make deinstall
make package
(as user)
Make certain no warnings are shown in any of the stages.
Thorough automated testing can be done with
ports-mgmt/poudriere from the
Ports Collection, see Section 10.5, “Poudriere” for
more information. It maintains jails
where
all of the steps shown above can be tested without affecting the
state of the host system.
Please use portlint
to see if the port
conforms to our guidelines. The
ports-mgmt/portlint
program is part of the ports collection. In particular,
check that the
Makefile is in the
right shape and the
package is named
appropriately.
Do not blindly follow the output of
portlint
. It is a static lint tool and
sometimes gets things wrong.
Before submitting the new port, read the DOs and DON'Ts section.
Once happy with the port, the only thing remaining is to put it in the main FreeBSD ports tree and make everybody else happy about it too.
We do not need the work
directory or
the pkgname.txz
package, so delete them
now.
Next, create a patch(1), file.
Assuming the port is called oneko
and is in
the games
category.
.diff
for a New
PortAdd all the files with svn add
.
cd
to the base of the ports tree so full
paths to the changed files are included in the diff, then
generate the diff with svn diff
. For
example:
%
svn add .
%
cd ../..
%
svn diff
games/oneko
>oneko.diff
To make it easier for committers to apply the patch on
their working copy of the ports tree, please generate the
.diff
from the base of your ports
tree.
Submit oneko.diff
with the bug submission
form. Use product “Ports &
Packages”, component “Individual Port(s)”,
and follow the guidelines shown there.
Add a short description of the program to the Description field
of the PR (perhaps a short version of
COMMENT
), and remember to add
oneko.diff
as an attachment.
Giving a good description in the summary of the problem
report makes the work of port committers a lot easier. We
prefer something like “New port:
category
/portname
short description of
the port
” for new ports. Using this
scheme makes it easier and faster to begin the work of
committing the new port.
After submitting the port, please be patient. The time needed to include a new port in FreeBSD can vary from a few days to a few months. A simple search form of the Problem Report database can be searched at https://bugs.freebsd.org/bugzilla/query.cgi.
To get a listing of open port PRs, select Open and Ports & Packages in the search form, then click .
After looking at the new port, we will reply if necessary, and commit it to the tree. The submitter's name will also be added to the list of Additional FreeBSD Contributors and other files.
It is also possible to submit ports using a shar(1) file. Using
the previous example with the oneko
port above.
.shar
for a New Portgo to the directory above where the
port directory is located, and use tar
to
create the shar archive:
%
cd ..
%
tar cf
oneko
.shar --format sharoneko
oneko.shar
can then be submitted in the same way
as oneko.diff
above.
Okay, so it was not that simple, and the port required some modifications to get it to work. In this section, we will explain, step by step, how to modify it to get it to work with the ports paradigm.
First, this is the sequence of events which occurs when the
user first types make
in the port's
directory. Having
bsd.port.mk
in another window while
reading this really helps to understand it.
But do not worry, not many people understand exactly how
bsd.port.mk
is working...
:-)
The fetch
target is run. The
fetch
target is responsible for
making sure that the tarball exists locally in
DISTDIR
. If
fetch
cannot find the required
files in DISTDIR
it will look up the URL
MASTER_SITES
, which is set in the
Makefile, as well as our FTP mirrors where we put distfiles
as backup. It will then attempt to fetch the named
distribution file with FETCH
, assuming
that the requesting site has direct access to the Internet.
If that succeeds, it will save the file in
DISTDIR
for future use and
proceed.
The extract
target is run.
It looks for the port's distribution file (typically a
compressed tarball) in
DISTDIR
and unpacks it into a temporary
subdirectory specified by WRKDIR
(defaults to work
).
The patch
target is run.
First, any patches defined in PATCHFILES
are applied. Second, if any patch files named
patch-
are
found in *
PATCHDIR
(defaults to the
files
subdirectory), they are applied
at this time in alphabetical order.
The configure
target is run.
This can do any one of many different things.
If it exists, scripts/configure
is run.
If HAS_CONFIGURE
or
GNU_CONFIGURE
is set,
WRKSRC/configure
is run.
The build
target is run.
This is responsible for descending into the port's private
working directory (WRKSRC
) and building
it.
The stage
target is run.
This puts the final set of built files into a temporary
directory (STAGEDIR
, see
Section 6.1, “Staging”). The hierarchy of this directory
mirrors that of the system on which the package will be
installed.
The package
target is run.
This creates a package using the files from the temporary
directory created during the
stage
target and the port's
pkg-plist
.
The install
target is run.
This installs the package created during the
package
target into the host
system.
The above are the default actions. In addition,
define targets
pre-
or
something
post-
,
or put scripts with those names, in the
something
scripts
subdirectory, and they will be
run before or after the default actions are done.
For example, if there is a
post-extract
target defined in the
Makefile
, and a file
pre-build
in the
scripts
subdirectory, the
post-extract
target will be called
after the regular extraction actions, and
pre-build
will be executed before
the default build rules are done. It is recommended to
use Makefile
targets if the actions are
simple enough, because it will be easier for someone to figure
out what kind of non-default action the port requires.
The default actions are done by the
do-
targets from something
bsd.port.mk
.
For example, the commands to extract a port are in the target
do-extract
. If
the default target does not do the job right, redefine the
do-
target in the something
Makefile
.
The “main” targets (for example,
extract
,
configure
, etc.) do nothing more
than make sure all the stages up to that one are completed and
call the real targets or scripts, and they are not intended to
be changed. To fix the extraction, fix
do-extract
, but never ever change
the way extract
operates!
Additionally, the target
post-deinstall
is invalid and is
not run by the ports infrastructure.
Now that what goes on when the user types make
install
is better understood, let us go through the
recommended steps to create the perfect port.
Get the original sources (normally) as a compressed tarball
(foo.tar.gz
or
) and
copy it into foo
.tar.bz2DISTDIR
. Always use
mainstream sources when and where
possible.
Set the variable
MASTER_SITES
to reflect where the original
tarball resides. Shorthand definitions exist
for most mainstream sites in bsd.sites.mk
.
Please use these sites—and the associated
definitions—if at all possible, to help avoid the problem
of having the same information repeated over again many times in
the source base. As these sites tend to change over time, this
becomes a maintenance nightmare for everyone involved. See
Section 5.4.2, “MASTER_SITES
” for details.
If there is no FTP/HTTP site that is well-connected to the net, or can only find sites that have irritatingly non-standard formats, put a copy on a reliable FTP or HTTP server (for example, a home page).
If a convenient and reliable place to put the distfile
cannot be found, we can “house” it ourselves on
ftp.FreeBSD.org
; however, this is the
least-preferred solution. The distfile must be placed into
~/public_distfiles/
of someone's
freefall
account. Ask the person who
commits the port to do this. This person will also set
MASTER_SITES
to
LOCAL/
where username
is
their FreeBSD cluster login.username
If the port's distfile changes all the time without any
kind of version update by the author, consider putting the
distfile on a home page and listing it as the first
MASTER_SITES
. Try to talk the
port author out of doing this; it really does help to establish
some kind of source code control. Hosting a specific version
will prevent users from getting
checksum mismatch errors, and also reduce
the workload of maintainers of our FTP site. Also, if there is
only one master site for the port, it is recommended to
house a backup on a home page and list it as the second
MASTER_SITES
.
If the port requires additional patches that are
available on the Internet, fetch them too and put them in
DISTDIR
. Do not worry if they come from a
site other than where the main source tarball comes, we have a
way to handle these situations (see the description of PATCHFILES below).
Unpack a copy of the tarball in a private directory and make whatever changes are necessary to get the port to compile properly under the current version of FreeBSD. Keep careful track of steps, as they will be needed to automate the process shortly. Everything, including the deletion, addition, or modification of files has to be doable using an automated script or patch file when the port is finished.
If the port requires significant user interaction/customization to compile or install, take a look at one of Larry Wall's classic Configure scripts and perhaps do something similar. The goal of the new ports collection is to make each port as “plug-and-play” as possible for the end-user while using a minimum of disk space.
Unless explicitly stated, patch files, scripts, and other files created and contributed to the FreeBSD ports collection are assumed to be covered by the standard BSD copyright conditions.
In the preparation of the port, files that have been added
or changed can be recorded with diff(1) for later feeding
to patch(1). Doing this with a typical file involves
saving a copy of the original file before making any changes
using a .orig
suffix.
%
cp
file
file
.orig
After all changes have been made, cd
back
to the port directory. Use make makepatch
to
generate updated patch files in the files
directory.
Use BINARY_ALIAS
to substitute
hardcoded commands during the build and avoid patching
build files. See Section 5.17, “Use BINARY_ALIAS
to Rename Commands
Instead of Patching the Build” for
more information.
Patch files are stored in PATCHDIR
,
usually files/
, from where they will be
automatically applied. All patches must be relative to
WRKSRC
. Typically
WRKSRC
is a subdirectory of
WRKDIR
, the directory where the distfile is
extracted. Use make -V WRKSRC
to see the
actual path. The patch names are to follow these
rules:
Avoid having more than one patch modify the same file.
For example, having both
patch-foobar.c
and
patch-foobar.c2
making changes to
${WRKSRC}/foobar.c
makes them fragile
and difficult to debug.
When creating names for patch files, replace each
underscore (_
) with two underscores
(__
) and each slash
(/
) with one underscore
(_
). For example, to patch a file
named src/freeglut_joystick.c
, name
the corresponding patch
patch-src_freeglut__joystick.c
. Do
not name patches like patch-aa
or
patch-ab
. Always use the path and
file name in patch names. Using make
makepatch
automatically generates the correct
names.
A patch may modify multiple files if the changes are
related and the patch is named appropriately. For
example,
patch-add-missing-stdlib.h
.
Only use characters [-+._a-zA-Z0-9]
for naming patches. In particular, do not use
::
as a path separator,
use _
instead.
Minimize the amount of non-functional whitespace changes in patches. It is common in the Open Source world for projects to share large amounts of a code base, but obey different style and indenting rules. When taking a working piece of functionality from one project to fix similar areas in another, please be careful: the resulting patch may be full of non-functional changes. It not only increases the size of the ports repository but makes it hard to find out what exactly caused the problem and what was changed at all.
If a file must be deleted, do it in the
post-extract
target rather than as
part of the patch.
Manual patch creation is usually not necessary. Automatic patch generation as described earlier in this section is the preferred method. However, manual patching may be required occasionally.
Patches are saved into files named
patch-*
where
*
indicates the pathname of the
file that is patched, such as
patch-Imakefile
or
patch-src-config.h
.
After the file has been modified, diff(1) is used to
record the differences between the original and the modified
version. -u
causes diff(1) to produce
“unified” diffs, the preferred form.
%
diff -u
file
.origfile
> patch-pathname-file
When generating patches for new, added files,
-N
is used to tell diff(1) to treat the
non-existent original file as if it existed but was
empty:
%
diff -u -N
newfile
.orignewfile
> patch-pathname-newfile
Do not add $FreeBSD$
RCS
strings in patches. When patches are added to the
Subversion repository with
svn add
, the
fbsd:nokeywords
property is set to
yes
automatically so keywords in the patch
are not modified when committed. The property can be added
manually with svn propset fbsd:nokeywords yes
.files...
Using the recurse (-r
) option to
diff(1) to generate patches is fine, but please look at
the resulting patches to make sure there is no unnecessary
junk in there. In particular, diffs between two backup files,
Makefile
s when the port uses
Imake
or GNU configure
,
etc., are unnecessary and have to be deleted. If it was
necessary to edit configure.in
and run
autoconf
to regenerate
configure
, do not take the diffs of
configure
(it often grows to a few thousand
lines!). Instead, define
USES=autoreconf
and take the
diffs of configure.in
.
Simple replacements can be performed directly from the
port Makefile
using the in-place mode of
sed(1). This is useful when changes use the value of a
variable:
post-patch: @${REINPLACE_CMD} -e 's|/usr/local|${PREFIX}|g' ${WRKSRC}/Makefile
Only use sed(1) to replace variable content. You must use patch files instead of sed(1) to replace static content.
Quite often, software being ported uses the CR/LF
convention in source files. This may cause problems with
further patching, compiler warnings, or script execution (like
/bin/sh^M not found
.) To quickly convert
all files from CR/LF to just LF, add this entry to the port
Makefile
:
USES= dos2unix
A list of specific files to convert can be given:
USES= dos2unix DOS2UNIX_FILES= util.c util.h
Use DOS2UNIX_REGEX
to convert a group
of files across subdirectories. Its argument is a
find(1)-compatible regular expression. More on the
format is in re_format(7). This option is useful for
converting all files of a given extension. For example,
convert all source code files, leaving binary files
intact:
USES= dos2unix DOS2UNIX_REGEX= .*\.([ch]|cpp)
A similar option is DOS2UNIX_GLOB
,
which runs find
for each element listed
in it.
USES= dos2unix DOS2UNIX_GLOB= *.c *.cpp *.h
The base directory for the conversion can be set. This is useful when there are multiple distfiles and several contain files which require line-ending conversion.
USES= dos2unix DOS2UNIX_WRKSRC= ${WRKDIR}
Some ports need patches that are only applied for specific
FreeBSD versions or when a particular option is enabled or
disabled. Conditional patches are specified by placing the
full paths to the patch files in
EXTRA_PATCHES
.
.include <bsd.port.options.mk> # Patch in the iconv const qualifier before this .if ${OPSYS} == FreeBSD && ${OSVERSION} < 1100069 EXTRA_PATCHES= ${PATCHDIR}/extra-patch-fbsd10 .endif .include <bsd.port.mk>
When an option
requires a patch, use
and
opt
_EXTRA_PATCHES
to make the patch conditional on the
opt
_EXTRA_PATCHES_OFF
option.
See Section 5.13.3.11, “Generic Variables Replacement,
opt
and
OPT
_VARIABLE
” for more
information.OPT
_VARIABLE
_OFF
OPTIONS_DEFINE= FOO BAR FOO_EXTRA_PATCHES= ${PATCHDIR}/extra-patch-foo BAR_EXTRA_PATCHES_OFF= ${PATCHDIR}/extra-patch-bar.c \ ${PATCHDIR}/extra-patch-bar.h
EXTRA_PATCHES
With a
DirectorySometime, there are many patches that are needed for a
feature, in this case, it is possible to point
EXTRA_PATCHES
to a directory, and it will
automatically apply all files named
patch-
in
it.*
Create a subdirectory in
${PATCHDIR}
, and move the patches in
it. For example:
%
ls -l
-rw-r--r-- 1 root wheel 350 Jan 16 01:27 patch-Makefile.in -rw-r--r-- 1 root wheel 3084 Jan 18 15:37 patch-configurefiles/foo-patches
Then add this to the Makefile
:
OPTIONS_DEFINE= FOO FOO_EXTRA_PATCHES= ${PATCHDIR}/foo-patches
The framework will then use all the files named
patch-
in
that directory.*
Include any additional customization commands in the
configure
script and save it in the
scripts
subdirectory. As mentioned above,
it is also possible do this with Makefile
targets and/or scripts with the name
pre-configure
or
post-configure
.
If the port requires user input to build, configure, or
install, set IS_INTERACTIVE
in the
Makefile
. This will allow
“overnight builds” to skip it. If the user
sets the variable BATCH
in their environment (and
if the user sets the variable INTERACTIVE
, then
only those ports requiring interaction are
built). This will save a lot of wasted time on the set of
machines that continually build ports (see below).
It is also recommended that if there are reasonable default
answers to the questions,
PACKAGE_BUILDING
be used to turn off the
interactive script when it is set. This will allow us to build
the packages for CDROMs and FTP.
MAINTAINER
COMMENT
PORTSCOUT
MASTERDIR
BINARY_ALIAS
to Rename Commands
Instead of Patching the BuildConfiguring the Makefile
is pretty
simple, and again we suggest looking at existing examples
before starting. Also, there is a
sample Makefile in this
handbook, so take a look and please follow the ordering of
variables and sections in that template to make the port easier
for others to read.
Consider these problems in sequence during the
design of the new Makefile
:
Does it live in DISTDIR
as a standard
gzip
ped tarball named something like
foozolix-1.2.tar.gz
? If so, go on
to the next step. If not, the distribution file format might
require overriding one or more of
DISTVERSION
, DISTNAME
,
EXTRACT_CMD
,
EXTRACT_BEFORE_ARGS
,
EXTRACT_AFTER_ARGS
,
EXTRACT_SUFX
, or
DISTFILES
.
In the worst case, create a custom
do-extract
target to override the
default. This is rarely, if ever, necessary.
The first part of the port's Makefile
names the port, describes its version number, and lists it in
the correct category.
Set PORTNAME
to the base name of the
software. It is used as the base for the FreeBSD package, and
for DISTNAME
.
The package name must be unique across the entire ports
tree. Make sure that the PORTNAME
is not
already in use by an existing port, and that no other port
already has the same PKGBASE
. If the
name has already been used, add either PKGNAMEPREFIX
or PKGNAMESUFFIX
.
Set DISTVERSION
to the version number
of the software.
PORTVERSION
is the version used for the
FreeBSD package. It will be automatically derived from
DISTVERSION
to be compatible with FreeBSD's
package versioning scheme. If the version contains
letters, it might be needed to set
PORTVERSION
and not
DISTVERSION
.
Only one of PORTVERSION
and
DISTVERSION
can be set at a time.
From time to time, some software will use a version
scheme that is not compatible with how
DISTVERSION
translates in
PORTVERSION
.
When updating a port, it is possible to use
pkg-version(8)'s -t
argument to
check if the new version is greater or lesser than before.
See Example 5.1, “Using pkg-version(8) to Compare Versions.”.
pkg version -t
takes two versions as
arguments, it will respond with <
,
=
or >
if the first
version is less, equal, or more than the second
version, respectively.
%
pkg version -t 1.2 1.3
<![]()
%
pkg version -t 1.2 1.2
=![]()
%
pkg version -t 1.2 1.2.0
=![]()
%
pkg version -t 1.2 1.2.p1
>![]()
%
pkg version -t 1.2.a1 1.2.b1
<![]()
%
pkg version -t 1.2 1.2p1
<
| |
| |
| |
| |
| |
|
In here, the a
,
b
, and p
are used as
if meaning “alpha”, “beta” or
“pre-release” and “patch level”,
but they are only letters and are sorted alphabetically,
so any letter can be used, and they will be sorted
appropriately.
DISTVERSION
and the
Derived PORTVERSION
DISTVERSION | PORTVERSION |
---|---|
0.7.1d | 0.7.1.d |
10Alpha3 | 10.a3 |
3Beta7-pre2 | 3.b7.p2 |
8:f_17 | 8f.17 |
DISTVERSION
When the version only contains numbers separated by
dots, dashes or underscores, use
DISTVERSION
.
PORTNAME= nekoto DISTVERSION= 1.2-4
It will generate a PORTVERSION
of
1.2.4
.
DISTVERSION
When the Version
Starts with a Letter or a PrefixWhen the version starts or ends with a letter, or a
prefix or a suffix that is not part of the version, use
DISTVERSIONPREFIX
,
DISTVERSION
, and
DISTVERSIONSUFFIX
.
If the version is v1.2-4
:
PORTNAME= nekoto DISTVERSIONPREFIX= v DISTVERSION= 1_2_4
Some of the time, projects using
GitHub will use their name in
their versions. For example, the version could be
nekoto-1.2-4
:
PORTNAME= nekoto DISTVERSIONPREFIX= nekoto- DISTVERSION= 1.2_4
Those projects also sometimes use some string at the end
of the version, for example,
1.2-4_RELEASE
:
PORTNAME= nekoto DISTVERSION= 1.2-4 DISTVERSIONSUFFIX= _RELEASE
Or they do both, for example,
nekoto-1.2-4_RELEASE
:
PORTNAME= nekoto DISTVERSIONPREFIX= nekoto- DISTVERSION= 1.2-4 DISTVERSIONSUFFIX= _RELEASE
DISTVERSIONPREFIX
and
DISTVERSIONSUFFIX
will not be used while
constructing PORTVERSION
, but only used
in DISTNAME
.
All will generate a PORTVERSION
of
1.2.4
.
DISTVERSION
When the Version
Contains Letters Meaning “alpha”,
“beta”, or “pre-release”When the version contains numbers separated by dots,
dashes or underscores, and letters are used to mean
“alpha”, “beta” or
“pre-release”, which is, before the version
without the letters, use
DISTVERSION
.
PORTNAME= nekoto DISTVERSION= 1.2-pre4
PORTNAME= nekoto DISTVERSION= 1.2p4
Both will generate a PORTVERSION
of
1.2.p4
which is before than 1.2.
pkg-version(8) can be used to check that fact:
%
pkg version -t 1.2.p4 1.2
<
DISTVERSION
When the
Version Contains Letters Meaning "Patch Level"When the version contains letters that are not meant as
“alpha”, “beta”, or
“pre”, but more in a “patch
level”, and meaning after the version without the
letters, use PORTVERSION
.
PORTNAME= nekoto PORTVERSION= 1.2p4
In this case, using DISTVERSION
is
not possible because it would generate a version of
1.2.p4
which would be before
1.2
and not after. pkg-version(8)
will verify this:
%
pkg version -t 1.2 1.2.p4
>![]()
%
pkg version -t 1.2 1.2p4
<
For some more advanced examples of setting
PORTVERSION
, when the software's versioning
is really not compatible with FreeBSD's, or
DISTNAME
when the distribution file does
not contain the version itself, see Section 5.4.1, “DISTNAME
”.
PORTREVISION
is a
monotonically increasing value which is reset to 0 with
every increase of DISTVERSION
, typically
every time there is a new official vendor release. If
PORTREVISION
is non-zero, the value is
appended to the package name. Changes to
PORTREVISION
are used by automated tools
like pkg-version(8) to determine that a new package is
available.
PORTREVISION
must be increased each
time a change is made to the port that changes the generated
package in any way. That includes changes that only affect
a package built with non-default
options.
Examples of when PORTREVISION
must be bumped:
Addition of patches to correct security vulnerabilities, bugs, or to add new functionality to the port.
Changes to the port Makefile
to
enable or disable compile-time options in the
package.
Changes in the packing list or the install-time behavior of the package. For example, a change to a script which generates initial data for the package, like ssh(1) host keys.
Version bump of a port's shared library dependency (in this case, someone trying to install the old package after installing a newer version of the dependency will fail since it will look for the old libfoo.x instead of libfoo.(x+1)).
Silent changes to the port distfile which have
significant functional differences. For example,
changes to the distfile requiring a correction to
distinfo
with no corresponding
change to DISTVERSION
, where a
diff -ru
of the old and new versions
shows non-trivial changes to the code.
Examples of changes which do not require a
PORTREVISION
bump:
Style changes to the port skeleton with no functional change to what appears in the resulting package.
Changes to MASTER_SITES
or other
functional changes to the port which do not affect the
resulting package.
Trivial patches to the distfile such as correction of typos, which are not important enough that users of the package have to go to the trouble of upgrading.
Build fixes which cause a package to become
compilable where it was previously failing. As long as
the changes do not introduce any functional change on
any other platforms on which the port did previously
build. Since PORTREVISION
reflects
the content of the package, if the package was not
previously buildable then there is no need to increase
PORTREVISION
to mark a change.
A rule of thumb is to decide whether a change
committed to a port is something which
some people would benefit from having.
Either because of an enhancement, fix,
or by virtue that the new package will actually work at
all. Then weigh that against that fact that it will cause
everyone who regularly updates their ports tree to be
compelled to update. If yes,
PORTREVISION
must be bumped.
People using binary packages will
never see the update if
PORTREVISION
is not bumped. Without
increasing PORTREVISION
, the
package builders have no way to detect the change and
thus, will not rebuild the package.
From time to time a software vendor or FreeBSD porter will do something silly and release a version of their software which is actually numerically less than the previous version. An example of this is a port which goes from foo-20000801 to foo-1.0 (the former will be incorrectly treated as a newer version since 20000801 is a numerically greater value than 1).
The results of version number comparisons are not
always obvious. pkg version
(see
pkg-version(8)) can be used to test the comparison of
two version number strings. For example:
%
pkg version -t 0.031 0.29
>
The >
output indicates that
version 0.031 is considered greater than version 0.29,
which may not have been obvious to the porter.
In situations such as this,
PORTEPOCH
must be increased.
If PORTEPOCH
is nonzero it is appended to
the package name as described in section 0 above.
PORTEPOCH
must never be decreased or
reset to zero, because that would cause comparison to a
package from an earlier epoch to fail. For example, the
package would not be detected as out of date. The new
version number, 1.0,1
in the above
example, is still numerically less than the previous
version, 20000801, but the ,1
suffix is
treated specially by automated tools and found to be greater
than the implied suffix ,0
on the earlier
package.
Dropping or resetting PORTEPOCH
incorrectly leads to no end of grief. If the discussion
above was not clear enough, please consult the
FreeBSD ports mailing list.
It is expected that PORTEPOCH
will
not be used for the majority of ports, and that sensible use
of DISTVERSION
, or that use
PORTVERSION
carefully, can often preempt
it
becoming necessary if a future release of the software
changes the version structure. However, care is
needed by FreeBSD porters when a vendor release is made without
an official version number — such as a code
“snapshot” release. The temptation is to label
the release with the release date, which will cause problems
as in the example above when a new “official”
release is made.
For example, if a snapshot release is made on the date
20000917
, and the previous version of the
software was version 1.2
, do not use
20000917
for
DISTVERSION
. The correct way is a
DISTVERSION
of
1.2.20000917
, or similar, so that the
succeeding release, say 1.3
, is still a
numerically greater value.
The gtkmumble
port, version
0.10
, is committed to the ports
collection:
PORTNAME= gtkmumble DISTVERSION= 0.10
PKGNAME
becomes
gtkmumble-0.10
.
A security hole is discovered which requires a local
FreeBSD patch. PORTREVISION
is bumped
accordingly.
PORTNAME= gtkmumble DISTVERSION= 0.10 PORTREVISION= 1
PKGNAME
becomes
gtkmumble-0.10_1
A new version is released by the vendor, numbered
0.2
(it turns out the author actually
intended 0.10
to actually mean
0.1.0
, not “what comes after
0.9” - oops, too late now). Since the new minor
version 2
is numerically less than the
previous version 10
,
PORTEPOCH
must be bumped to manually
force the new package to be detected as
“newer”. Since it is a new vendor release of
the code, PORTREVISION
is reset to 0 (or
removed from the Makefile
).
PORTNAME= gtkmumble DISTVERSION= 0.2 PORTEPOCH= 1
PKGNAME
becomes
gtkmumble-0.2,1
The next release is 0.3. Since
PORTEPOCH
never decreases, the version
variables are now:
PORTNAME= gtkmumble DISTVERSION= 0.3 PORTEPOCH= 1
PKGNAME
becomes
gtkmumble-0.3,1
If PORTEPOCH
were reset to
0
with this upgrade, someone who had
installed the gtkmumble-0.10_1
package
would not detect the gtkmumble-0.3
package as newer, since 3
is still
numerically less than 10
. Remember,
this is the whole point of PORTEPOCH
in
the first place.
Two optional variables, PKGNAMEPREFIX
and PKGNAMESUFFIX
, are combined with
PORTNAME
and PORTVERSION
to form PKGNAME
as
${PKGNAMEPREFIX}${PORTNAME}${PKGNAMESUFFIX}-${PORTVERSION}
.
Make sure this conforms to our
guidelines for a good
package name. In particular, the use of a
hyphen (-
) in
PORTVERSION
is not
allowed.
Also, if the package name has the
language-
or the
-compiled.specifics
part (see
below), use PKGNAMEPREFIX
and
PKGNAMESUFFIX
, respectively. Do not make
them part of PORTNAME
.
These are the conventions to follow when naming packages. This is to make the package directory easy to scan, as there are already thousands of packages and users are going to turn away if they hurt their eyes!
Package names take the form of
.language_region-name-compiled.specifics-version.numbers
The package name is defined as
${PKGNAMEPREFIX}${PORTNAME}${PKGNAMESUFFIX}-${PORTVERSION}
.
Make sure to set the variables to conform to that
format.
language_region-
FreeBSD strives to support the native language of its
users. The language-
part is
a two letter abbreviation of the natural language
defined by ISO-639 when the port is specific to a
certain language. Examples are ja
for Japanese, ru
for Russian,
vi
for Vietnamese,
zh
for Chinese, ko
for Korean and de
for German.
If the port is specific to a certain region within
the language area, add the two letter country code as
well. Examples are en_US
for US
English and fr_CH
for Swiss
French.
The language-
part is
set in PKGNAMEPREFIX
.
name
Make sure that the port's name and version are
clearly separated and placed into
PORTNAME
and
DISTVERSION
. The only
reason for PORTNAME
to contain a
version part is if the upstream distribution is really
named that way, as in the
textproc/libxml2 or
japanese/kinput2-freewnn
ports. Otherwise, PORTNAME
cannot
contain any version-specific information. It is quite
normal for several ports to have the same
PORTNAME
, as the
www/apache* ports do; in
that case, different versions (and different index
entries) are distinguished by
PKGNAMEPREFIX
and PKGNAMESUFFIX
values.
There is a tradition of naming
Perl 5
modules by prepending
p5-
and converting the double-colon
separator to a hyphen. For example, the
Data::Dumper
module becomes
p5-Data-Dumper
.
-compiled.specifics
If the port can be built with different hardcoded defaults
(usually part of the directory name in a family of
ports), the
-compiled.specifics
part
states the compiled-in defaults. The hyphen is
optional. Examples are paper size and font
units.
The -compiled.specifics
part is set in PKGNAMESUFFIX
.
-version.numbers
The version string follows a dash
(-
) and is a period-separated list of
integers and single lowercase alphabetics. In
particular, it is not permissible to have another dash
inside the version string. The only exception is the
string pl
(meaning
“patchlevel”), which can be used
only when there are no major and
minor version numbers in the software. If the software
version has strings like “alpha”,
“beta”, “rc”, or
“pre”, take the first letter and put it
immediately after a period. If the version string
continues after those names, the numbers follow
the single alphabet without an extra period between
them (for example, 1.0b2
).
The idea is to make it easier to sort ports by
looking at the version string. In particular, make sure
version number components are always delimited by a
period, and if the date is part of the string, use the
d
format, not
yyyy
.mm
.dd
or the non-Y2K compliant
dd
.mm
.yyyy
format. It is important to prefix the version with a
letter, here yy
.mm
.dd
d
(for date), in case a
release with an actual
version number is made, which would be
numerically less than
.yyyy
Package name must be unique among all of the ports
tree, check that there is not already a port with the same
PORTNAME
and if there is add one of PKGNAMEPREFIX
or PKGNAMESUFFIX
.
Here are some (real) examples on how to convert the name
as called by the software authors to a suitable package name,
for each line, only one of DISTVERSION
or
PORTVERSION
is set in, depending on which
would be used in the port's
Makefile
:
Distribution Name | PKGNAMEPREFIX | PORTNAME | PKGNAMESUFFIX | DISTVERSION | PORTVERSION | Reason or comment |
---|---|---|---|---|---|---|
mule-2.2.2 | (empty) | mule | (empty) | 2.2.2 | No changes required | |
mule-1.0.1 | (empty) | mule | 1 | 1.0.1 | This is version 1 of mule, and version 2 already exists | |
EmiClock-1.0.2 | (empty) | emiclock | (empty) | 1.0.2 | No uppercase names for single programs | |
rdist-1.3alpha | (empty) | rdist | (empty) | 1.3alpha | Version will be 1.3.a | |
es-0.9-beta1 | (empty) | es | (empty) | 0.9-beta1 | Version will be 0.9.b1 | |
mailman-2.0rc3 | (empty) | mailman | (empty) | 2.0rc3 | Version will be 2.0.r3 | |
v3.3beta021.src | (empty) | tiff | (empty) | 3.3 | What the heck was that anyway? | |
tvtwm | (empty) | tvtwm | (empty) | p11 | No version in the filename, use what upstream says it is | |
piewm | (empty) | piewm | (empty) | 1.0 | No version in the filename, use what upstream says it is | |
xvgr-2.10pl1 | (empty) | xvgr | (empty) | 2.10.pl1 | In that case, pl1 means patch
level, so using DISTVERSION is not possible. | |
gawk-2.15.6 | ja- | gawk | (empty) | 2.15.6 | Japanese language version | |
psutils-1.13 | (empty) | psutils | -letter | 1.13 | Paper size hardcoded at package build time | |
pkfonts | (empty) | pkfonts | 300 | 1.0 | Package for 300dpi fonts |
If there is absolutely no trace of version information in
the original source and it is unlikely that the original
author will ever release another version, just set the version
string to 1.0
(like the
piewm
example above). Otherwise, ask the
original author or use the date string the source file was
released on
(d
,
or
yyyy
.mm
.dd
d
)
as the version.yyyy
mm
dd
Use any letter. Here, d
here stands
for date, if the source is a Git
repository, g
followed by the commit date
is commonly used, using s
for snapshot is
also common.
When a package is created, it is put under
/usr/ports/packages/All
and links are
made from one or more subdirectories of
/usr/ports/packages
. The names of these
subdirectories are specified by the variable
CATEGORIES
. It is intended to make life
easier for the user when he is wading through the pile of
packages on the FTP site or the CDROM. Please take a look at
the current list of
categories and pick the ones that are suitable for
the port.
This list also determines where in the ports tree the port is imported. If there is more than one category here, the port files must be put in the subdirectory with the name of the first category. See below for more discussion about how to pick the right categories.
Here is the current list of port categories. Those marked
with an asterisk (*
) are
virtual categories—those that do
not have a corresponding subdirectory in the ports tree. They
are only used as secondary categories, and only for search
purposes.
For non-virtual categories, there is a one-line
description in COMMENT
in that
subdirectory's Makefile
.
Category | Description | Notes |
---|---|---|
accessibility | Ports to help disabled users. | |
afterstep
* | Ports to support the AfterStep window manager. | |
arabic | Arabic language support. | |
archivers | Archiving tools. | |
astro | Astronomical ports. | |
audio | Sound support. | |
benchmarks | Benchmarking utilities. | |
biology | Biology-related software. | |
cad | Computer aided design tools. | |
chinese | Chinese language support. | |
comms | Communication software. | Mostly software to talk to the serial port. |
converters | Character code converters. | |
databases | Databases. | |
deskutils | Things that used to be on the desktop before computers were invented. | |
devel | Development utilities. | Do not put libraries here just because they are libraries. They should not be in this category unless they truly do not belong anywhere else. |
dns | DNS-related software. | |
docs
* | Meta-ports for FreeBSD documentation. | |
editors | General editors. | Specialized editors go in the section for those
tools. For example, a mathematical-formula editor
will go in math , and have
editors as a second
category. |
education
* | Education-related software. | This includes applications, utilities, or games primarily or substantially designed to help the user learn a specific topic or study in general. It also includes course-writing applications, course-delivery applications, and classroom or school management applications. |
elisp
* | Emacs-lisp ports. | |
emulators | Emulators for other operating systems. | Terminal emulators do not
belong here. X-based ones go to
x11 and text-based ones to
either comms or
misc , depending on the exact
functionality. |
enlightenment
* | Ports related to the Enlightenment window manager. | |
finance | Monetary, financial and related applications. | |
french | French language support. | |
ftp | FTP client and server utilities. | If the port speaks both FTP
and HTTP, put it
in ftp with a secondary
category of www . |
games | Games. | |
geography
* | Geography-related software. | |
german | German language support. | |
gnome
* | Ports from the GNOME Project. | |
gnustep
* | Software related to the GNUstep desktop environment. | |
graphics | Graphics utilities. | |
hamradio
* | Software for amateur radio. | |
haskell
* | Software related to the Haskell language. | |
hebrew | Hebrew language support. | |
hungarian | Hungarian language support. | |
irc | Internet Relay Chat utilities. | |
japanese | Japanese language support. | |
java | Software related to the Java™ language. | The java category must not
be the only one for a port. Save for ports directly
related to the Java language, porters are also
encouraged not to use java as the
main category of a port. |
kde
* | Ports from the KDE Project (generic). | |
kde-applications
* | Applications from the KDE Project. | |
kde-frameworks
* | Add-on libraries from the KDE Project for programming with Qt. | |
kde-plasma
* | Desktop from the KDE Project. | |
kld
* | Kernel loadable modules. | |
korean | Korean language support. | |
lang | Programming languages. | |
linux
* | Linux applications and support utilities. | |
lisp
* | Software related to the Lisp language. | |
mail | Mail software. | |
mate
* | Ports related to the MATE desktop environment, a fork of GNOME 2. | |
math | Numerical computation software and other utilities for mathematics. | |
mbone
* | MBone applications. | |
misc | Miscellaneous utilities | Things that do not belong anywhere
else. If at all possible, try to find a better
category for the port than misc ,
as ports tend to be overlooked in here. |
multimedia | Multimedia software. | |
net | Miscellaneous networking software. | |
net-im | Instant messaging software. | |
net-mgmt | Networking management software. | |
net-p2p | Peer to peer network applications. | |
net-vpn
* | Virtual Private Network applications. | |
news | USENET news software. | |
parallel
* | Applications dealing with parallelism in computing. | |
pear
* | Ports related to the Pear PHP framework. | |
perl5
* | Ports that require Perl version 5 to run. | |
plan9
* | Various programs from Plan9. | |
polish | Polish language support. | |
ports-mgmt | Ports for managing, installing and developing FreeBSD ports and packages. | |
portuguese | Portuguese language support. | |
print | Printing software. | Desktop publishing tools (previewers, etc.) belong here too. |
python
* | Software related to the Python language. | |
ruby
* | Software related to the Ruby language. | |
rubygems
* | Ports of RubyGems packages. | |
russian | Russian language support. | |
scheme
* | Software related to the Scheme language. | |
science | Scientific ports that do not fit into other
categories such as astro ,
biology and
math . | |
security | Security utilities. | |
shells | Command line shells. | |
spanish
* | Spanish language support. | |
sysutils | System utilities. | |
tcl
* | Ports that use Tcl to run. | |
textproc | Text processing utilities. | It does not include desktop publishing tools,
which go to print . |
tk
* | Ports that use Tk to run. | |
ukrainian | Ukrainian language support. | |
vietnamese | Vietnamese language support. | |
wayland
* | Ports to support the Wayland display server. | |
windowmaker
* | Ports to support the WindowMaker window manager. | |
www | Software related to the World Wide Web. | HTML language support belongs here too. |
x11 | The X Window System and friends. | This category is only for software that directly
supports the window system. Do not put regular X
applications here. Most of them go into other
x11-* categories (see
below). |
x11-clocks | X11 clocks. | |
x11-drivers | X11 drivers. | |
x11-fm | X11 file managers. | |
x11-fonts | X11 fonts and font utilities. | |
x11-servers | X11 servers. | |
x11-themes | X11 themes. | |
x11-toolkits | X11 toolkits. | |
x11-wm | X11 window managers. | |
xfce
* | Ports related to the Xfce desktop environment. | |
zope
* | Zope support. |
As many of the categories overlap, choosing which of the categories will be the primary category of the port can be tedious. There are several rules that govern this issue. Here is the list of priorities, in decreasing order of precedence:
The first category must be a physical category (see above). This is necessary to make the packaging work. Virtual categories and physical categories may be intermixed after that.
Language specific categories always come first. For
example, if the port installs Japanese X11 fonts, then
the CATEGORIES
line would read
japanese x11-fonts
.
Specific categories are listed before less-specific
ones. For instance, an HTML editor is listed as
www editors
, not the other way
around. Also, do not list
net
when the port belongs to any of
irc
, mail
,
news
, security
,
or www
, as net
is included implicitly.
x11
is used as a secondary
category only when the primary category is a natural
language. In particular, do not put
x11
in the category line for X
applications.
Emacs modes are
placed in the same ports category as the application
supported by the mode, not in
editors
. For example, an
Emacs mode to edit source files
of some programming language goes into
lang
.
Ports installing loadable kernel modules also
have the virtual category kld
in
their CATEGORIES
line. This is one of
the things handled automatically by adding
USES=kmod
.
misc
does not appear with any
other non-virtual category. If there is
misc
with something else in
CATEGORIES
, that means
misc
can safely be deleted and the port
placed only in the other subdirectory.
If the port truly does not belong anywhere else,
put it in misc
.
If the category is not clearly defined, please put a comment to that effect in the port submission in the bug database so we can discuss it before we import it. As a committer, send a note to the FreeBSD ports mailing list so we can discuss it first. Too often, new ports are imported to the wrong category only to be moved right away.
As the Ports Collection has grown over time, various new categories have been introduced. New categories can either be virtual categories—those that do not have a corresponding subdirectory in the ports tree— or physical categories—those that do. This section discusses the issues involved in creating a new physical category. Read it thoroughly before proposing a new one.
Our existing practice has been to avoid creating a new physical category unless either a large number of ports would logically belong to it, or the ports that would belong to it are a logically distinct group that is of limited general interest (for instance, categories related to spoken human languages), or preferably both.
The rationale for this is that such a change creates a fair amount of work for both the committers and also for all users who track changes to the Ports Collection. In addition, proposed category changes just naturally seem to attract controversy. (Perhaps this is because there is no clear consensus on when a category is “too big”, nor whether categories should lend themselves to browsing (and thus what number of categories would be an ideal number), and so forth.)
Here is the procedure:
Propose the new category on FreeBSD ports mailing list. Include a detailed rationale for the new category, including why the existing categories are not sufficient, and the list of existing ports proposed to move. (If there are new ports pending in Bugzilla that would fit this category, list them too.) If you are the maintainer and/or submitter, respectively, mention that as it may help the case.
Participate in the discussion.
If it seems that there is support for the idea, file a PR which includes both the rationale and the list of existing ports that need to be moved. Ideally, this PR would also include these patches:
Makefile
s for the new ports
once they are repocopied
Makefile
for the new
category
Makefile
for the old ports'
categories
Makefile
s for ports that
depend on the old ports
(for extra credit, include the other files that have to change, as per the procedure in the Committer's Guide.)
Since it affects the ports infrastructure and involves
moving and patching many ports but also possibly running
regression tests on the build cluster, assign the PR to
the Ports Management Team <portmgr@FreeBSD.org>
.
If that PR is approved, a committer will need to follow the rest of the procedure that is outlined in the Committer's Guide.
Proposing a new virtual category is similar to the
above but much less involved, since no ports will actually
have to move. In this case, the only patches to include in
the PR would be those to add the new category to
CATEGORIES
of the affected ports.
Occasionally someone proposes reorganizing the categories with either a 2-level structure, or some other kind of keyword structure. To date, nothing has come of any of these proposals because, while they are very easy to make, the effort involved to retrofit the entire existing ports collection with any kind of reorganization is daunting to say the very least. Please read the history of these proposals in the mailing list archives before posting this idea. Furthermore, be prepared to be challenged to offer a working prototype.
The second part of the Makefile
describes the files that must be downloaded to build
the port, and where they can be downloaded.
DISTNAME
is the name of the port as
called by the authors of the software.
DISTNAME
defaults to
${PORTNAME}-${DISTVERSIONPREFIX}${DISTVERSION}${DISTVERSIONSUFFIX}
,
and if not set, DISTVERSION
defaults to
${PORTVERSION}
so override
DISTNAME
only if necessary. DISTNAME
is only used
in two places. First, the distribution file list
(DISTFILES
) defaults to
${DISTNAME}
${EXTRACT_SUFX}
.
Second, the distribution file is expected to extract into a
subdirectory named WRKSRC
, which defaults
to work/${DISTNAME}
.
Some vendor's distribution names which do not fit into the
${PORTNAME}-${PORTVERSION}
-scheme can be
handled automatically by setting
DISTVERSIONPREFIX
,
DISTVERSION
, and
DISTVERSIONSUFFIX
.
PORTVERSION
will be derived from
DISTVERSION
automatically.
Only one of PORTVERSION
and
DISTVERSION
can be set at a time. If
DISTVERSION
does not derive a correct
PORTVERSION
, do not use
DISTVERSION
.
If the upstream version scheme can be derived into a
ports-compatible version scheme, set some variable to the
upstream version, do not use
DISTVERSION
as the variable name. Set
PORTVERSION
to the computed version based
on the variable you
created, and set DISTNAME
accordingly.
If the upstream version scheme cannot easily be coerced
into a ports-compatible value, set
PORTVERSION
to a sensible value, and set
DISTNAME
with PORTNAME
with the verbatim upstream version.
PORTVERSION
ManuallyBIND9 uses a version scheme
that is not compatible with the ports versions (it has
-
in its versions) and cannot be derived
using DISTVERSION
because after the 9.9.9
release, it will release a “patchlevels” in the
form of 9.9.9-P1
. DISTVERSION would
translate that into 9.9.9.p1
, which, in
the ports versioning scheme means 9.9.9 pre-release 1, which
is before 9.9.9 and not after. So
PORTVERSION
is manually derived from an
ISCVERSION
variable to output
9.9.9p1
.
The order into which the ports framework, and pkg, will
sort versions is checked using the -t
argument of pkg-version(8):
%
pkg version -t 9.9.9 9.9.9.p1
>![]()
%
pkg version -t 9.9.9 9.9.9p1
<
The | |
The |
In the port Makefile
, for example
dns/bind99, it is achieved
by:
PORTNAME= bind PORTVERSION= ${ISCVERSION:S/-P/P/:S/b/.b/:S/a/.a/:S/rc/.rc/}CATEGORIES= dns net MASTER_SITES= ISC/bind9/${ISCVERSION}
PKGNAMESUFFIX= 99 DISTNAME= ${PORTNAME}-${ISCVERSION}
MAINTAINER= mat@FreeBSD.org COMMENT= BIND DNS suite with updated DNSSEC and DNS64 LICENSE= ISCL # ISC releases things like 9.8.0-P1 or 9.8.1rc1, which our versioning does not like ISCVERSION= 9.9.9-P6
DISTNAME
from
PORTVERSION
From time to time, the distribution file name has little or no relation to the version of the software.
In comms/kermit, only the last element of the version is present in the distribution file:
PORTNAME= kermit PORTVERSION= 9.0.304 CATEGORIES= comms ftp net MASTER_SITES= ftp://ftp.kermitproject.org/kermit/test/tar/ DISTNAME= cku${PORTVERSION:E}-dev20
The |
Sometimes, there is no relation between the software name, its version, and the distribution file it is distributed in.
From audio/libworkman:
PORTNAME= libworkman PORTVERSION= 1.4 CATEGORIES= audio MASTER_SITES= LOCAL/jim DISTNAME= ${PORTNAME}-1999-06-20
In comms/librs232, the
distribution file is not versioned, so using DIST_SUBDIR
is needed:
PORTNAME= librs232 PORTVERSION= 20160710 CATEGORIES= comms MASTER_SITES= http://www.teuniz.net/RS-232/ DISTNAME= RS-232 DIST_SUBDIR= ${PORTNAME}-${PORTVERSION}
PKGNAMEPREFIX
and
PKGNAMESUFFIX
do not affect
DISTNAME
. Also note that if
WRKSRC
is equal to
${WRKDIR}/${DISTNAME}
while
the original source archive is named something other than
${PORTNAME}-${PORTVERSION}${EXTRACT_SUFX}
,
leave DISTNAME
alone— defining only
DISTFILES
is easier than both
DISTNAME
and WRKSRC
(and possibly EXTRACT_SUFX
).
Record the directory part of the FTP/HTTP-URL pointing at
the original tarball in MASTER_SITES
. Do
not forget the trailing slash (/
)!
The make
macros will try to use this
specification for grabbing the distribution file with
FETCH
if they cannot find it already on the
system.
It is recommended that multiple sites are included on this list, preferably from different continents. This will safeguard against wide-area network problems.
MASTER_SITES
must not be blank. It
must point to the actual site hosting the distribution
files. It cannot point to web archives, or the FreeBSD
distribution files cache sites. The only exception to this
rule is ports that do not have any distribution files. For
example, meta-ports do not have any distribution files, so
MASTER_SITES
does not need to be
set.
Shortcut abbreviations are available for popular
archives like SourceForge (SOURCEFORGE
),
GNU (GNU
), or Perl CPAN
(PERL_CPAN
).
MASTER_SITES
can use them
directly:
MASTER_SITES= GNU/make
The older expanded format still works, but all ports have been converted to the compact format. The expanded format looks like this:
MASTER_SITES= ${MASTER_SITE_GNU} MASTER_SITE_SUBDIR= make
These values and variables are defined in Mk/bsd.sites.mk
.
New entries are added often, so make sure to check the
latest version of this file before submitting a port.
For any
MASTER_SITE_
variable, the shorthand
FOO
can be
used. For example, use:FOO
MASTER_SITES= FOO
If MASTER_SITE_SUBDIR
is needed,
use this:
MASTER_SITES=FOO
/bar
Several “magic” macros exist for
popular sites with a predictable directory structure. For
these, just use the abbreviation and the system will choose
a subdirectory automatically. For a port
named Stardict
, of version
1.2.3
, and hosted on SourceForge, adding
this line:
MASTER_SITES= SF
infers a subdirectory named
/project/stardict/stardict/1.2.3
. If the
inferred directory is incorrect, it can be
overridden:
MASTER_SITES= SF/stardict/WyabdcRealPeopleTTS/${PORTVERSION}
This can also be written as
MASTER_SITES= SF MASTER_SITE_SUBDIR= stardict/WyabdcRealPeopleTTS/${PORTVERSION}
MASTER_SITES
MacrosMacro | Assumed subdirectory |
---|---|
APACHE_COMMONS_BINARIES | ${PORTNAME:S,commons-,,} |
APACHE_COMMONS_SOURCE | ${PORTNAME:S,commons-,,} |
APACHE_JAKARTA | ${PORTNAME:S,-,/,}/source |
BERLIOS | ${PORTNAME:tl}.berlios |
CHEESESHOP | source/${DISTNAME:C/(.).*/\1/}/${DISTNAME:C/(.*)-[0-9].*/\1/} |
CPAN | ${PORTNAME:C/-.*//} |
DEBIAN | pool/main/${PORTNAME:C/^((lib)?.).*$/\1/}/${PORTNAME} |
FARSIGHT | ${PORTNAME} |
FESTIVAL | ${PORTREVISION} |
GCC | releases/${DISTNAME} |
GENTOO | distfiles |
GIMP | ${PORTNAME}/${PORTVERSION:R}/ |
GH | ${GH_ACCOUNT}/${GH_PROJECT}/tar.gz/${GH_TAGNAME}?dummy=/ |
GHC | ${GH_ACCOUNT}/${GH_PROJECT}/ |
GNOME | sources/${PORTNAME}/${PORTVERSION:C/^([0-9]+\.[0-9]+).*/\1/} |
GNU | ${PORTNAME} |
GNUPG | ${PORTNAME} |
GNU_ALPHA | ${PORTNAME} |
HORDE | ${PORTNAME} |
LODEV | ${PORTNAME} |
MATE | ${PORTVERSION:C/^([0-9]+\.[0-9]+).*/\1/} |
MOZDEV | ${PORTNAME:tl} |
NL | ${PORTNAME} |
QT | archive/qt/${PORTVERSION:R} |
SAMBA | ${PORTNAME} |
SAVANNAH | ${PORTNAME:tl} |
SF | ${PORTNAME:tl}/${PORTNAME:tl}/${PORTVERSION} |
If the distribution file comes from a specific commit or
tag on GitHub
for which there is no officially released file, there is an
easy way to set the right DISTNAME
and
MASTER_SITES
automatically. These
variables are available:
USE_GITHUB
DescriptionVariable | Description | Default |
---|---|---|
GH_ACCOUNT | Account name of the GitHub user hosting the project | ${PORTNAME} |
GH_PROJECT | Name of the project on GitHub | ${PORTNAME} |
GH_TAGNAME | Name of the tag to download (2.0.1, hash, ...) Using the name of a branch here is incorrect. It is also possible to use the hash of a commit id to do a snapshot. | ${DISTVERSIONPREFIX}${DISTVERSION}${DISTVERSIONSUFFIX} |
GH_SUBDIR | When the software needs an additional
distribution file to be extracted within
${WRKSRC} , this variable can be
used. See the examples in Section 5.4.3.1, “Fetching Multiple Files from GitHub”
for more information. | (none) |
GH_TUPLE | GH_TUPLE allows putting
GH_ACCOUNT ,
GH_PROJECT ,
GH_TAGNAME , and
GH_SUBDIR into a single variable.
The format is
account : project : tagname : group / subdir .
The
/ subdir
part is optional. It is helpful when there is more
than one GitHub project from which to fetch. |
Do not use GH_TUPLE
for the default
distribution file, as it has no default.
USE_GITHUB
While trying to make a port for version
1.2.7
of pkg
from the FreeBSD user on github, at https://github.com/freebsd/pkg, The
Makefile
would end up looking like
this (slightly stripped for the example):
PORTNAME= pkg DISTVERSION= 1.2.7 USE_GITHUB= yes GH_ACCOUNT= freebsd
It will automatically have
MASTER_SITES
set to GH
GHC
and WRKSRC
to
${WRKDIR}/pkg-1.2.7
.
USE_GITHUB
While trying to make a port for the bleeding edge
version of pkg from the FreeBSD
user on github, at https://github.com/freebsd/pkg, the
Makefile
ends up looking like
this (slightly stripped for the example):
PORTNAME= pkg-devel DISTVERSION= 1.3.0.a.20140411 USE_GITHUB= yes GH_ACCOUNT= freebsd GH_PROJECT= pkg GH_TAGNAME= 6dbb17b
It will automatically have
MASTER_SITES
set to GH
GHC
and WRKSRC
to
${WRKDIR}/pkg-6dbb17b
.
20140411
is the date of the
commit referenced in GH_TAGNAME
, not
the date the Makefile
is edited, or
the date the commit is made.
USE_GITHUB
with
DISTVERSIONPREFIX
From time to time, GH_TAGNAME
is a
slight variation from DISTVERSION
.
For example, if the version is 1.0.2
,
the tag is v1.0.2
. In those cases, it
is possible to use DISTVERSIONPREFIX
or
DISTVERSIONSUFFIX
:
PORTNAME= foo DISTVERSIONPREFIX= v DISTVERSION= 1.0.2 USE_GITHUB= yes
It will automatically set
GH_TAGNAME
to
v1.0.2
, while WRKSRC
will be kept to
${WRKDIR}/foo-1.0.2
.
USE_GITHUB
When Upstream Does
Not Use VersionsIf there never was a version upstream, do not invent one
like 0.1
or 1.0
.
Create the port with a DISTVERSION
of
g
,
where YYYY
MM
DD
g
is for
Git, and
represents the date the commit referenced in
YYYY
MM
DD
GH_TAGNAME
.
PORTNAME= bar DISTVERSION= g20140411 USE_GITHUB= yes GH_TAGNAME= c472d66b
This creates a versioning scheme that increases over
time, and that is still before version 0
(see Example 5.1, “Using pkg-version(8) to Compare Versions.” for
details on pkg-version(8)):
%
pkg version -t g20140411 0
<
Which means using PORTEPOCH
will not
be needed in case upstream decides to cut versions in the
future.
USE_GITHUB
to Access
a Commit Between Two VersionsIf the current version of the software uses a Git tag, and the port needs to be updated to a newer, intermediate version, without a tag, use git-describe(1) to find out the version to use:
%
git describe --tags
v0.7.3-14-gf0038b1f0038b1
v0.7.3-14-gf0038b1
can be split into
three parts:
v0.7.3
This is the last Git tag that appears in the commit history before the requested commit.
-14
This means that the requested commit,
f0038b1
, is the 14th commit after
the v0.7.3
tag.
-gf0038b1
The -g
means
“Git”, and
the f0038b1
is the commit hash
that this reference points to.
PORTNAME= bar DISTVERSIONPREFIX= v DISTVERSION= 0.7.3-14 DISTVERSIONSUFFIX= -gf0038b1 USE_GITHUB= yes
This creates a versioning scheme that increases over
time (well, over commits), and does not conflict with the
creation of a 0.7.4
version.
(See Example 5.1, “Using pkg-version(8) to Compare Versions.” for
details on pkg-version(8)):
%
pkg version -t 0.7.3 0.7.3.14
<%
pkg version -t 0.7.3.14 0.7.4
<
If the requested commit is the same as a tag, a shorter description is shown by default. The longer version is equivalent:
%
git describe --tags
v0.7.3c66c71d
%
git describe --tags --long
v0.7.3-0-gc66c71dc66c71d
The USE_GITHUB
framework also
supports fetching multiple distribution files from
different places in GitHub. It works in a way very
similar to Section 5.4.9, “Multiple Distribution or Patches Files from Multiple
Locations”.
Multiple values are added to
GH_ACCOUNT
,
GH_PROJECT
, and
GH_TAGNAME
. Each different value is
assigned a group. The main value can either have no group,
or the :DEFAULT
group. A value can be
omitted if it is the same as the default as listed in
Table 5.5, “USE_GITHUB
Description”.
GH_TUPLE
can also be used when there
are a lot of distribution files. It helps keep the account,
project, tagname, and group information at the same
place.
For each group, a
${WRKSRC_
helper variable is created, containing the directory into
which the file has been extracted. The
group
}${WRKSRC_
variables can be used to move directories around during
group
}post-extract
, or add to
CONFIGURE_ARGS
, or whatever is needed
so that the software builds correctly.
The
:
part
must be used for only
one distribution file. It is used as a
unique key and using it more than once will overwrite the
previous values.group
As this is only syntactic sugar above
DISTFILES
and
MASTER_SITES
, the group names must
adhere to the restrictions on group names outlined in
Section 5.4.9, “Multiple Distribution or Patches Files from Multiple
Locations”
When fetching multiple files from GitHub, sometimes the default distribution file is not fetched from GitHub. To disable fetching the default distribution, set:
USE_GITHUB= nodefault
When using USE_GITHUB=nodefault
,
the Makefile
must set
DISTFILES
in its
top block.
The definition should be:
DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
USE_GITHUB
with Multiple
Distribution FilesFrom time to time, there is a need to fetch more
than one distribution file. For example, when the
upstream git repository uses submodules. This can be
done easily using groups in the
GH_
variables:*
PORTNAME= foo DISTVERSION= 1.0.2 USE_GITHUB= yes GH_ACCOUNT= bar:icons,contrib GH_PROJECT= foo-icons:icons foo-contrib:contrib GH_TAGNAME= 1.0:icons fa579bc:contrib GH_SUBDIR= ext/icons:icons CONFIGURE_ARGS= --with-contrib=${WRKSRC_contrib}
This will fetch three distribution files from
github. The default one comes from
foo/foo
and is version
1.0.2
. The second one, with the
icons
group, comes from
bar/foo-icons
and is in version
1.0
. The third one comes from
bar/foo-contrib
and uses the
Git commit
fa579bc
. The distribution files are
named foo-foo-1.0.2_GH0.tar.gz
,
bar-foo-icons-1.0_GH0.tar.gz
, and
bar-foo-contrib-fa579bc_GH0.tar.gz
.
All the distribution files are extracted in
${WRKDIR}
in their respective
subdirectories. The default file is still extracted in
${WRKSRC}
, in this case,
${WRKDIR}/foo-1.0.2
. Each
additional distribution file is extracted in
${WRKSRC_
.
Here, for the group
}icons
group, it is called
${WRKSRC_icons}
and it contains
${WRKDIR}/foo-icons-1.0
. The file
with the contrib
group is called
${WRKSRC_contrib}
and contains
${WRKDIR}/foo-contrib-fa579bc
.
The software's build system expects to find the icons
in a ext/icons
subdirectory in its
sources, so GH_SUBDIR
is used.
GH_SUBDIR
makes sure that
ext
exists, but that
ext/icons
does not already exist.
Then it does this:
post-extract: @${MV} ${WRKSRC_icons} ${WRKSRC}/ext/icons
USE_GITHUB
with Multiple
Distribution Files Using
GH_TUPLE
This is functionally equivalent to Example 5.15, “Use of USE_GITHUB
with Multiple
Distribution Files”, but
using GH_TUPLE
:
PORTNAME= foo DISTVERSION= 1.0.2 USE_GITHUB= yes GH_TUPLE= bar:foo-icons:1.0:icons/ext/icons \ bar:foo-contrib:fa579bc:contrib CONFIGURE_ARGS= --with-contrib=${WRKSRC_contrib}
Grouping was used in the previous example with
bar:icons,contrib
. Some redundant
information is present with GH_TUPLE
because grouping is not possible.
USE_GITHUB
with
Git Submodules?Ports with GitHub as an upstream repository sometimes use submodules. See git-submodule(1) for more information.
The problem with submodules is that each is a separate repository. As such, they each must be fetched separately.
Using finance/moneymanagerex as an
example, its GitHub repository is https://github.com/moneymanagerex/moneymanagerex.
It has a .gitmodules
file at the root. This file describes all the submodules
used in this repository, and lists additional repositories
needed. This file will tell what additional repositories
are needed:
[submodule "lib/wxsqlite3"] path = lib/wxsqlite3 url = https://github.com/utelle/wxsqlite3.git [submodule "3rd/mongoose"] path = 3rd/mongoose url = https://github.com/cesanta/mongoose.git [submodule "3rd/LuaGlue"] path = 3rd/LuaGlue url = https://github.com/moneymanagerex/LuaGlue.git [submodule "3rd/cgitemplate"] path = 3rd/cgitemplate url = https://github.com/moneymanagerex/html-template.git [...]
The only information missing from that file is the commit hash or tag to use as a version. This information is found after cloning the repository:
%
git clone --recurse-submodules https://github.com/moneymanagerex/moneymanagerex.git
Cloning into 'moneymanagerex'... remote: Counting objects: 32387, done. [...] Submodule '3rd/LuaGlue' (https://github.com/moneymanagerex/LuaGlue.git) registered for path '3rd/LuaGlue' Submodule '3rd/cgitemplate' (https://github.com/moneymanagerex/html-template.git) registered for path '3rd/cgitemplate' Submodule '3rd/mongoose' (https://github.com/cesanta/mongoose.git) registered for path '3rd/mongoose' Submodule 'lib/wxsqlite3' (https://github.com/utelle/wxsqlite3.git) registered for path 'lib/wxsqlite3' [...] Cloning into '/home/mat/work/freebsd/ports/finance/moneymanagerex/moneymanagerex/3rd/LuaGlue'... Cloning into '/home/mat/work/freebsd/ports/finance/moneymanagerex/moneymanagerex/3rd/cgitemplate'... Cloning into '/home/mat/work/freebsd/ports/finance/moneymanagerex/moneymanagerex/3rd/mongoose'... Cloning into '/home/mat/work/freebsd/ports/finance/moneymanagerex/moneymanagerex/lib/wxsqlite3'... [...] Submodule path '3rd/LuaGlue': checked out 'c51d11a247ee4d1e9817dfa2a8da8d9e2f97ae3b' Submodule path '3rd/cgitemplate': checked out 'cd434eeeb35904ebcd3d718ba29c281a649b192c' Submodule path '3rd/mongoose': checked out '2140e5992ab9a3a9a34ce9a281abf57f00f95cda' Submodule path 'lib/wxsqlite3': checked out 'fb66eb230d8aed21dec273b38c7c054dcb7d6b51' [...]%
cd moneymanagerex
%
git submodule status
c51d11a247ee4d1e9817dfa2a8da8d9e2f97ae3b 3rd/LuaGlue (heads/master) cd434eeeb35904ebcd3d718ba29c281a649b192c 3rd/cgitemplate (cd434ee) 2140e5992ab9a3a9a34ce9a281abf57f00f95cda 3rd/mongoose (6.2-138-g2140e59) fb66eb230d8aed21dec273b38c7c054dcb7d6b51 lib/wxsqlite3 (v3.4.0) [...]
It can also be found on GitHub. Each subdirectory
that is a submodule is shown as
directory
@
hash
,
for example,
mongoose @ 2140e59
.
While getting the information from GitHub seems more
straightforward, the information found using
git submodule status
will provide
more meaningful information. For example, here,
lib/wxsqlite3
's commit hash
fb66eb2
correspond to
v3.4.0
. Both can be used
interchangeably, but when a tag is available, use
it.
Now that all the required information has been
gathered, the Makefile
can be written
(only GitHub-related lines are shown):
PORTNAME= moneymanagerex DISTVERSIONPREFIX= v DISTVERSION= 1.3.0 USE_GITHUB= yes GH_TUPLE= utelle:wxsqlite3:v3.4.0:wxsqlite3/lib/wxsqlite3 \ moneymanagerex:LuaGlue:c51d11a:lua_glue/3rd/LuaGlue \ moneymanagerex:html-template:cd434ee:html_template/3rd/cgitemplate \ cesanta:mongoose:2140e59:mongoose/3rd/mongoose \ [...]
Similar to GitHub, if the distribution file comes from gitlab.com or is hosting the GitLab software, these variables are available for use and might need to be set.
USE_GITLAB
DescriptionVariable | Description | Default |
---|---|---|
GL_SITE | Site name hosting the GitLab project | https://gitlab.com |
GL_ACCOUNT | Account name of the GitLab user hosting the project | ${PORTNAME} |
GL_PROJECT | Name of the project on GitLab | ${PORTNAME} |
GL_COMMIT | The commit hash to download. Must be the full 160 bit, 40 character hex sha1 hash. This is a required variable for GitLab. | (none) |
GL_SUBDIR | When the software needs an additional
distribution file to be extracted within
${WRKSRC} , this variable can be
used. See the examples in Section 5.4.4.1, “Fetching Multiple Files from GitLab”
for more information. | (none) |
GL_TUPLE | GL_TUPLE allows putting
GL_SITE ,
GL_ACCOUNT ,
GL_PROJECT ,
GL_COMMIT , and
GL_SUBDIR into a single variable.
The format is
site : account : project : commit : group / subdir .
The site : and
/ subdir
part is optional. It is helpful when there are more
than one GitLab project from
which to fetch. |
USE_GITLAB
While trying to make a port for version
1.14
of libsignon-glib
from the accounts-sso user on gitlab.com, at https://gitlab.com/accounts-sso/libsignon-glib, The
Makefile
would end up looking like
this for fetching the distribution files:
PORTNAME= libsignon-glib DISTVERSION= 1.14 USE_GITLAB= yes GL_ACCOUNT= accounts-sso GL_COMMIT= e90302e342bfd27bc8c9132ab9d0ea3d8723fd03
It will automatically have
MASTER_SITES
set to gitlab.com
and WRKSRC
to
${WRKDIR}/libsignon-glib-e90302e342bfd27bc8c9132ab9d0ea3d8723fd03-e90302e342bfd27bc8c9132ab9d0ea3d8723fd03
.
USE_GITLAB
A more complete use of the above if
port had no versioning and foobar
from the foo user on project bar on a self hosted GitLab
site https://gitlab.example.com
, the Makefile
ends up looking like this for fetching distribution files:
PORTNAME= foobar DISTVERSION= g20170906 USE_GITLAB= yes GL_SITE= https://gitlab.example.com GL_ACCOUNT= foo GL_PROJECT= bar GL_COMMIT= 9c1669ce60c3f4f5eb43df874d7314483fb3f8a6
It will have MASTER_SITES
set to
"https://gitlab.example.com
" and WRKSRC
to
${WRKDIR}/bar-9c1669ce60c3f4f5eb43df874d7314483fb3f8a6-9c1669ce60c3f4f5eb43df874d7314483fb3f8a6
.
20170906
is the date of the
commit referenced in GL_COMMIT
, not
the date the Makefile
is edited, or
the date the commit to the FreeBSD ports tree is made.
GL_SITE
's protocol, port and
webroot can all be modified in the same variable.
The USE_GITLAB
framework also
supports fetching multiple distribution files from
different places from GitLab
and GitLab hosted sites. It
works in a way very similar to Section 5.4.9, “Multiple Distribution or Patches Files from Multiple
Locations” and Section 5.4.4.1, “Fetching Multiple Files from GitLab”.
Multiple values are added to
GL_SITE
,
GL_ACCOUNT
,
GL_PROJECT
and
GL_COMMIT
. Each different value is
assigned a group.
Table 5.6, “USE_GITLAB
Description”.
GL_TUPLE
can also be used when there
are a lot of distribution files. It helps keep the site,
account, project, commit, and group information at the same
place.
For each group, a
${WRKSRC_
helper variable is created, containing the directory into
which the file has been extracted. The
group
}${WRKSRC_
variables can be used to move directories around during
group
}post-extract
, or add to
CONFIGURE_ARGS
, or whatever is needed
so that the software builds correctly.
The
:
part
must be used for only
one distribution file. It is used as a
unique key and using it more than once will overwrite the
previous values.group
As this is only syntactic sugar above
DISTFILES
and
MASTER_SITES
, the group names must
adhere to the restrictions on group names outlined in
Section 5.4.9, “Multiple Distribution or Patches Files from Multiple
Locations”
When fetching multiple files using GitLab, sometimes the default distribution file is not fetched from a GitLab site. To disable fetching the default distribution, set:
USE_GITLAB= nodefault
When using USE_GITLAB=nodefault
,
the Makefile
must set
DISTFILES
in its
top block.
The definition should be:
DISTFILES= ${DISTNAME}${EXTRACT_SUFX}
USE_GITLAB
with Multiple
Distribution FilesFrom time to time, there is a need to fetch more
than one distribution file. For example, when the
upstream git repository uses submodules. This can be
done easily using groups in the
GL_
variables:*
PORTNAME= foo DISTVERSION= 1.0.2 USE_GITLAB= yes GL_SITE= https://gitlab.example.com:9434/gitlab:icons GL_ACCOUNT= bar:icons,contrib GL_PROJECT= foo-icons:icons foo-contrib:contrib GL_COMMIT= c189207a55da45305c884fe2b50e086fcad4724b ae7368cab1ca7ca754b38d49da064df87968ffe4:icons 9e4dd76ad9b38f33fdb417a4c01935958d5acd2a:contrib GL_SUBDIR= ext/icons:icons CONFIGURE_ARGS= --with-contrib=${WRKSRC_contrib}
This will fetch two distribution files from
gitlab.com and one from gitlab.example.com
hosting GitLab. The default one comes
from https://gitlab.com/foo/foo
and commit is
c189207a55da45305c884fe2b50e086fcad4724b
. The
second one, with the icons
group, comes from
https://gitlab.example.com:9434/gitlab/bar/foo-icons
and commit is ae7368cab1ca7ca754b38d49da064df87968ffe4
.
The third one comes from https://gitlab.com/bar/foo-contrib
and is commit 9e4dd76ad9b38f33fdb417a4c01935958d5acd2a
.
The distribution files are named foo-foo-c189207a55da45305c884fe2b50e086fcad4724b_GL0.tar.gz
,
bar-foo-icons-ae7368cab1ca7ca754b38d49da064df87968ffe4_GL0.tar.gz
, and
bar-foo-contrib-9e4dd76ad9b38f33fdb417a4c01935958d5acd2a_GL0.tar.gz
.
All the distribution files are extracted in
${WRKDIR}
in their respective
subdirectories. The default file is still extracted in
${WRKSRC}
, in this case,
${WRKDIR}/foo-c189207a55da45305c884fe2b50e086fcad4724b-c189207a55da45305c884fe2b50e086fcad4724b
.
Each additional distribution file is extracted in
${WRKSRC_
.
Here, for the group
}icons
group, it is called
${WRKSRC_icons}
and it contains
${WRKDIR}/foo-icons-ae7368cab1ca7ca754b38d49da064df87968ffe4-ae7368cab1ca7ca754b38d49da064df87968ffe4
.
The file with the contrib
group is
called ${WRKSRC_contrib}
and contains
${WRKDIR}/foo-contrib-9e4dd76ad9b38f33fdb417a4c01935958d5acd2a-9e4dd76ad9b38f33fdb417a4c01935958d5acd2a
.
The software's build system expects to find the icons
in a ext/icons
subdirectory in its
sources, so GL_SUBDIR
is used.
GL_SUBDIR
makes sure that
ext
exists, but that
ext/icons
does not already exist.
Then it does this:
post-extract: @${MV} ${WRKSRC_icons} ${WRKSRC}/ext/icons
USE_GITLAB
with Multiple
Distribution Files Using
GL_TUPLE
This is functionally equivalent to Example 5.20, “Use of USE_GITLAB
with Multiple
Distribution Files”, but
using GL_TUPLE
:
PORTNAME= foo DISTVERSION= 1.0.2 USE_GITLAB= yes GL_COMMIT= c189207a55da45305c884fe2b50e086fcad4724b GL_TUPLE= https://gitlab.example.com:9434/gitlab:bar:foo-icons:ae7368cab1ca7ca754b38d49da064df87968ffe4:icons/ext/icons \ bar:foo-contrib:9e4dd76ad9b38f33fdb417a4c01935958d5acd2a:contrib CONFIGURE_ARGS= --with-contrib=${WRKSRC_contrib}
Grouping was used in the previous example with
bar:icons,contrib
. Some redundant
information is present with GL_TUPLE
because grouping is not possible.
If there is one distribution file, and it uses an odd
suffix to indicate the compression mechanism, set
EXTRACT_SUFX
.
For example, if the distribution file was named
foo.tar.gzip
instead of the more normal
foo.tar.gz
, write:
DISTNAME= foo EXTRACT_SUFX= .tar.gzip
The
USES=tar[:
,
xxx
]USES=lha
or USES=zip
automatically set EXTRACT_SUFX
to the most
common archives extensions as necessary, see Chapter 17, Using USES
Macros for more details. If neither of
these are set then EXTRACT_SUFX
defaults to
.tar.gz
.
As EXTRACT_SUFX
is only used in
DISTFILES
, only set one of them..
Sometimes the names of the files to be downloaded have no
resemblance to the name of the port. For example, it might be
called source.tar.gz
or similar. In
other cases the application's source code might be in several
different archives, all of which must be downloaded.
If this is the case, set DISTFILES
to
be a space separated list of all the files that must be
downloaded.
DISTFILES= source1.tar.gz source2.tar.gz
If not explicitly set, DISTFILES
defaults to
${DISTNAME}${EXTRACT_SUFX}
.
If only some of the DISTFILES
must be
extracted—for example, one of them is the source code,
while another is an uncompressed document—list the
filenames that must be extracted in
EXTRACT_ONLY
.
DISTFILES= source.tar.gz manual.html EXTRACT_ONLY= source.tar.gz
When none of the DISTFILES
need to be
uncompressed, set EXTRACT_ONLY
to the empty
string.
EXTRACT_ONLY=
If the port requires some additional patches that are
available by FTP or
HTTP, set PATCHFILES
to
the names of the files and PATCH_SITES
to
the URL of the directory that contains them (the format is the
same as MASTER_SITES
).
If the patch is not relative to the top of the source tree
(that is, WRKSRC
) because it contains some
extra pathnames, set PATCH_DIST_STRIP
accordingly. For instance, if all the pathnames in the patch
have an extra foozolix-1.0/
in front of the
filenames, then set
PATCH_DIST_STRIP=-p1
.
Do not worry if the patches are compressed; they will be
decompressed automatically if the filenames end with
.Z
, .gz
,
.bz2
or .xz
.
If the patch is distributed with some other files, such as
documentation, in a compressed tarball, using
PATCHFILES
is not possible. If that is the
case, add the name and the location of the patch tarball to
DISTFILES
and
MASTER_SITES
. Then, use
EXTRA_PATCHES
to point to those
files and bsd.port.mk
will automatically
apply them. In particular, do
not copy patch files into
${PATCHDIR}
. That directory may
not be writable.
If there are multiple patches and they need mixed values
for the strip parameter, it can be added alongside the patch
name in PATCHFILES
, e.g:
PATCHFILES= patch1 patch2:-p1
This does not conflict with the master site grouping feature, adding a group also works:
PATCHFILES= patch2:-p1:source2
The tarball will have been extracted alongside the
regular source by then, so there is no need to explicitly
extract it if it is a regular compressed tarball. Take extra
care not to overwrite something that already exists in that
directory if extracting it manually. Also, do not forget to
add a command to remove the copied patch in the
pre-clean
target.
(Consider this to be a somewhat “advanced topic”; those new to this document may wish to skip this section at first).
This section has information on the fetching mechanism
known as both MASTER_SITES:n
and
MASTER_SITES_NN
. We will refer to this
mechanism as MASTER_SITES:n
.
A little background first. OpenBSD has a neat feature
inside DISTFILES
and
PATCHFILES
which allows files and
patches to be postfixed with :n
identifiers. Here, n
can be any word
containing [0-9a-zA-Z_]
and denote a group
designation. For example:
DISTFILES= alpha:0 beta:1
In OpenBSD, distribution file alpha
will be associated with variable
MASTER_SITES0
instead of our common
MASTER_SITES
and
beta
with
MASTER_SITES1
.
This is a very interesting feature which can decrease that endless search for the correct download site.
Just picture 2 files in DISTFILES
and
20 sites in MASTER_SITES
, the sites slow as
hell where beta
is carried by all sites
in MASTER_SITES
, and
alpha
can only be found in the 20th site.
It would be such a waste to check all of them if the
maintainer knew this beforehand, would it not? Not a good
start for that lovely weekend!
Now that you have the idea, just imagine more
DISTFILES
and more
MASTER_SITES
. Surely our
“distfiles survey meister” would appreciate the
relief to network strain that this would bring.
In the next sections, information will follow on the FreeBSD implementation of this idea. We improved a bit on OpenBSD's concept.
The group names cannot have dashes in them
(-
), in fact, they cannot have any
characters out of the [a-zA-Z0-9_]
range.
This is because, while make(1) is ok with variable
names containing dashes, sh(1) is not.
This section explains how to quickly prepare fine
grained fetching of multiple distribution files and patches
from different sites and subdirectories. We describe here a
case of simplified MASTER_SITES:n
usage.
This will be sufficient for most scenarios. More detailed
information are available in Section 5.4.9.2, “Detailed Information”.
Some applications consist of multiple distribution files that must be downloaded from a number of different sites. For example, Ghostscript consists of the core of the program, and then a large number of driver files that are used depending on the user's printer. Some of these driver files are supplied with the core, but many others must be downloaded from a variety of different sites.
To support this, each entry in
DISTFILES
may be followed by a colon and
a “group name”. Each site listed in
MASTER_SITES
is then followed by a colon,
and the group that indicates which distribution files are
downloaded from this site.
For example, consider an application with the source
split in two parts, source1.tar.gz
and
source2.tar.gz
, which must be
downloaded from two different sites. The port's
Makefile
would include lines like Example 5.22, “Simplified Use of MASTER_SITES:n
with One File Per Site”.
MASTER_SITES:n
with One File Per SiteMASTER_SITES= ftp://ftp1.example.com/:source1 \ http://www.example.com/:source2 DISTFILES= source1.tar.gz:source1 \ source2.tar.gz:source2
Multiple distribution files can have the same group.
Continuing the previous example, suppose that there was a
third distfile, source3.tar.gz
, that
is downloaded from
ftp.example2.com
. The
Makefile
would then be written like
Example 5.23, “Simplified Use of MASTER_SITES:n
with More Than One File Per Site”.
MASTER_SITES:n
with More Than One File Per SiteMASTER_SITES= ftp://ftp.example.com/:source1 \ http://www.example.com/:source2 DISTFILES= source1.tar.gz:source1 \ source2.tar.gz:source2 \ source3.tar.gz:source2
Okay, so the previous example did not reflect the new
port's needs? In this section we will explain in detail how
the fine grained fetching mechanism
MASTER_SITES:n
works and how it can
be used.
Elements can be postfixed with
:
where
n
n
is
[^:,]+
, that is,
n
could conceptually be any
alphanumeric string but we will limit it to
[a-zA-Z_][0-9a-zA-Z_]+
for
now.
Moreover, string matching is case sensitive; that
is, n
is different from
N
.
However, these words cannot be used for
postfixing purposes since they yield special meaning:
default
, all
and
ALL
(they are used internally in
item ii).
Furthermore, DEFAULT
is a special
purpose word (check item 3).
Elements postfixed with :n
belong to the group n
,
:m
belong to group
m
and so forth.
Elements without a postfix are groupless, they
all belong to the special group
DEFAULT
. Any elements postfixed
with DEFAULT
, is just being
redundant unless an element belongs
to both DEFAULT
and other groups at
the same time (check item 5).
These examples are equivalent but the first one is preferred:
MASTER_SITES= alpha
MASTER_SITES= alpha:DEFAULT
Groups are not exclusive, an element may belong to several different groups at the same time and a group can either have either several different elements or none at all.
When an element belongs to several groups
at the same time, use the comma operator
(,
).
Instead of repeating it several times, each time
with a different postfix, we can list several groups at
once in a single postfix. For instance,
:m,n,o
marks an element that belongs
to group m
, n
and
o
.
All these examples are equivalent but the last one is preferred:
MASTER_SITES= alpha alpha:SOME_SITE
MASTER_SITES= alpha:DEFAULT alpha:SOME_SITE
MASTER_SITES= alpha:SOME_SITE,DEFAULT
MASTER_SITES= alpha:DEFAULT,SOME_SITE
All sites within a given group are sorted according
to MASTER_SORT_AWK
. All groups
within MASTER_SITES
and
PATCH_SITES
are sorted as
well.
Group semantics can be used in any of the
variables MASTER_SITES
,
PATCH_SITES
,
MASTER_SITE_SUBDIR
,
PATCH_SITE_SUBDIR
,
DISTFILES
, and
PATCHFILES
according to this
syntax:
All MASTER_SITES
,
PATCH_SITES
,
MASTER_SITE_SUBDIR
and
PATCH_SITE_SUBDIR
elements must
be terminated with the forward slash
/
character. If any elements
belong to any groups, the group postfix
:
must come right after the terminator
n
/
. The
MASTER_SITES:n
mechanism relies
on the existence of the terminator
/
to avoid confusing elements
where a :n
is a valid part of the
element with occurrences where :n
denotes group n
. For
compatibility purposes, since the
/
terminator was not required
before in both MASTER_SITE_SUBDIR
and PATCH_SITE_SUBDIR
elements,
if the postfix immediate preceding character is not
a /
then :n
will be considered a valid part of the element
instead of a group postfix even if an element is
postfixed with :n
. See both
Example 5.24, “Detailed Use of
MASTER_SITES:n
in
MASTER_SITE_SUBDIR
”
and Example 5.25, “Detailed Use of
MASTER_SITES:n
with Comma
Operator, Multiple Files, Multiple Sites and
Multiple Subdirectories”.
MASTER_SITES:n
in
MASTER_SITE_SUBDIR
MASTER_SITE_SUBDIR= old:n new/:NEW
Directories within group
DEFAULT
->
old:n
Directories within group
NEW
-> new
MASTER_SITES:n
with Comma
Operator, Multiple Files, Multiple Sites and
Multiple SubdirectoriesMASTER_SITES= http://site1/%SUBDIR%/ http://site2/:DEFAULT \ http://site3/:group3 http://site4/:group4 \ http://site5/:group5 http://site6/:group6 \ http://site7/:DEFAULT,group6 \ http://site8/%SUBDIR%/:group6,group7 \ http://site9/:group8 DISTFILES= file1 file2:DEFAULT file3:group3 \ file4:group4,group5,group6 file5:grouping \ file6:group7 MASTER_SITE_SUBDIR= directory-trial:1 directory-n/:groupn \ directory-one/:group6,DEFAULT \ directory
The previous example results in this fine grained fetching. Sites are listed in the exact order they will be used.
file1
will be
fetched from
MASTER_SITE_OVERRIDE
http://site1/directory-trial:1/
http://site1/directory-one/
http://site1/directory/
http://site2/
http://site7/
MASTER_SITE_BACKUP
file2
will be fetched
exactly as file1
since
they both belong to the same group
MASTER_SITE_OVERRIDE
http://site1/directory-trial:1/
http://site1/directory-one/
http://site1/directory/
http://site2/
http://site7/
MASTER_SITE_BACKUP
file3
will be fetched
from
MASTER_SITE_OVERRIDE
http://site3/
MASTER_SITE_BACKUP
file4
will be
fetched from
MASTER_SITE_OVERRIDE
http://site4/
http://site5/
http://site6/
http://site7/
http://site8/directory-one/
MASTER_SITE_BACKUP
file5
will be fetched
from
MASTER_SITE_OVERRIDE
MASTER_SITE_BACKUP
file6
will be fetched
from
MASTER_SITE_OVERRIDE
http://site8/
MASTER_SITE_BACKUP
How do I group one of the special macros from
bsd.sites.mk
, for example,
SourceForge (SF
)?
This has been simplified as much as possible. See
Example 5.26, “Detailed Use of MASTER_SITES:n
with SourceForge (SF
)”.
MASTER_SITES:n
with SourceForge (SF
)MASTER_SITES= http://site1/ SF/something/1.0:sourceforge,TEST DISTFILES= something.tar.gz:sourceforge
something.tar.gz
will be
fetched from all sites within SourceForge.
How do I use this with
PATCH
?*
All examples were done with
MASTER
but they work exactly the same for
*
PATCH
ones as can be seen in Example 5.27, “Simplified Use of
*
MASTER_SITES:n
with
PATCH_SITES
”.
MASTER_SITES:n
with
PATCH_SITES
PATCH_SITES= http://site1/ http://site2/:test PATCHFILES= patch1:test
All current ports remain the same. The
MASTER_SITES:n
feature code is only
activated if there are elements postfixed with
:
like
elements according to the aforementioned syntax rules,
especially as shown in item 7.n
The port targets remain the same:
checksum
,
makesum
,
patch
,
configure
,
build
, etc. With the obvious
exceptions of do-fetch
,
fetch-list
,
master-sites
and
patch-sites
.
do-fetch
: deploys
the new grouping postfixed
DISTFILES
and
PATCHFILES
with their matching
group elements within both
MASTER_SITES
and
PATCH_SITES
which use matching
group elements within both
MASTER_SITE_SUBDIR
and
PATCH_SITE_SUBDIR
. Check Example 5.25, “Detailed Use of
MASTER_SITES:n
with Comma
Operator, Multiple Files, Multiple Sites and
Multiple Subdirectories”.
fetch-list
: works
like old fetch-list
with
the exception that it groups just like
do-fetch
.
master-sites
and
patch-sites
:
(incompatible with older versions) only return the
elements of group DEFAULT
; in
fact, they execute targets
master-sites-default
and
patch-sites-default
respectively.
Furthermore, using target either
master-sites-all
or
patch-sites-all
is
preferred to directly checking either
MASTER_SITES
or
PATCH_SITES
. Also,
directly checking is not guaranteed to work in any
future versions. Check item B
for more information on these new port
targets.
New port targets
There are
master-sites-
and
n
patch-sites-
targets which will list the elements of the
respective group n
n
within MASTER_SITES
and
PATCH_SITES
respectively. For
instance, both
master-sites-DEFAULT
and patch-sites-DEFAULT
will return the elements of group
DEFAULT
,
master-sites-test
and
patch-sites-test
of
group test
, and thereon.
There are new targets
master-sites-all
and
patch-sites-all
which do
the work of the old
master-sites
and
patch-sites
ones. They
return the elements of all groups as if they all
belonged to the same group with the caveat that it
lists as many MASTER_SITE_BACKUP
and MASTER_SITE_OVERRIDE
as there
are groups defined within either
DISTFILES
or
PATCHFILES
; respectively for
master-sites-all
and
patch-sites-all
.
Do not let the port clutter
/usr/ports/distfiles
. If the port
requires a lot of files to be fetched, or contains a file that
has a name that might conflict with other ports (for example,
Makefile
), set
DIST_SUBDIR
to the name of the port
(${PORTNAME}
or
${PKGNAMEPREFIX}${PORTNAME}
are
fine). This will change DISTDIR
from the
default /usr/ports/distfiles
to
/usr/ports/distfiles/${DIST_SUBDIR}
, and
in effect puts everything that is required for the port into
that subdirectory.
It will also look at the subdirectory with the same name
on the backup master site at http://distcache.FreeBSD.org
(Setting
DISTDIR
explicitly in
Makefile
will not accomplish this, so
please use DIST_SUBDIR
.)
This does not affect
MASTER_SITES
defined in the
Makefile
.
Set your mail-address here. Please. :-)
Only a single address without the comment part is
allowed as a MAINTAINER
value. The format
used is user@hostname.domain
. Please
do not include any descriptive text such as a real name in
this entry. That merely confuses the Ports infrastructure
and most tools using it.
The maintainer is responsible for keeping the port up to date and making sure that it works correctly. For a detailed description of the responsibilities of a port maintainer, refer to The challenge for port maintainers.
A maintainer volunteers to keep a port in good working order. Maintainers have the primary responsibility for their ports, but not exclusive ownership. Ports exist for the benefit of the community and, in reality, belong to the community. What this means is that people other than the maintainer can make changes to a port. Large changes to the Ports Collection might require changes to many ports. The FreeBSD Ports Management Team or members of other teams might modify ports to fix dependency issues or other problems, like a version bump for a shared library update.
Some types of fixes have “blanket approval”
from the Ports Management Team <portmgr@FreeBSD.org>
, allowing any committer to fix those
categories of problems on any port. These fixes do not need
approval from the maintainer.
Blanket approval for most ports applies to fixes like infrastructure changes, or trivial and tested build and runtime fixes. The current list is available in Ports section of the Committer's Guide.
Other changes to the port will be sent to the maintainer
for review and approval before being committed. If the
maintainer does not respond to an update request after two weeks
(excluding major public holidays), then that is considered a
maintainer timeout, and the update can be made without explicit
maintainer approval. If the maintainer does not respond within
three months, or if there have been three consecutive timeouts,
then that maintainer is considered absent without
leave, and all of their ports can be assigned back to the pool.
Exceptions to this are anything maintained by
the Ports Management Team <portmgr@FreeBSD.org>
, or the Security Officer Team <security-officer@FreeBSD.org>
. No unauthorized
commits may ever be made to ports maintained by those
groups.
We reserve the right to modify the maintainer's submission to better match existing policies and style of the Ports Collection without explicit blessing from the submitter or the maintainer. Also, large infrastructural changes can result in a port being modified without the maintainer's consent. These kinds of changes will never affect the port's functionality.
The Ports Management Team <portmgr@FreeBSD.org>
reserves the right to revoke or override
anyone's maintainership for any reason, and the
Security Officer Team <security-officer@FreeBSD.org>
reserves the right to revoke or override
maintainership for security reasons.
The comment is a one-line description of a port shown by
pkg info
. Please follow these rules when
composing it:
The COMMENT string should be 70 characters or less.
Do not include the package name or version number of software.
The comment must begin with a capital and end without a period.
Do not start with an indefinite article (that is, A or An).
Capitalize names such as Apache, JavaScript, or Perl.
Use a serial comma for lists of words: "green, red, and blue."
Check for spelling errors.
Here is an example:
COMMENT= Cat chasing a mouse all over the screen
The COMMENT variable immediately follows the
MAINTAINER variable in the Makefile
.
Each port must document the license under which it is available. If it is not an OSI approved license it must also document any restrictions on redistribution.
A short name for the license or licenses if more than one license apply.
If it is one of the licenses listed in Table 5.7, “Predefined License List”, only
LICENSE_FILE
and
LICENSE_DISTFILES
variables can be
set.
If this is a license that has not been defined in the
ports framework (see Table 5.7, “Predefined License List”),
the LICENSE_PERMS
and
LICENSE_NAME
must be set, along with either
LICENSE_FILE
or
LICENSE_TEXT
.
LICENSE_DISTFILES
and
LICENSE_GROUPS
can also be set, but are not
required.
The predefined licenses are shown in
Table 5.7, “Predefined License List”. The current list is
always available in
Mk/bsd.licenses.db.mk
.
When the README
of some software
says “This software is under the terms of the GNU
Lesser General Public License as published by the Free
Software Foundation; either version 2.1 of the License, or
(at your option) any later version.” but does not
provide the license file, use this:
LICENSE= LGPL21+
When the software provides the license file, use this:
LICENSE= LGPL21+ LICENSE_FILE= ${WRKSRC}/COPYING
For the predefined licenses, the default permissions are
dist-mirror dist-sell pkg-mirror pkg-sell
auto-accept
.
Permissions. use none
if empty.
dist-mirror
Redistribution of the distribution files is
permitted. The distribution files will be added to the
FreeBSD MASTER_SITE_BACKUP
CDN.
no-dist-mirror
Redistribution of the distribution files is
prohibited. This is equivalent to setting RESTRICTED
.
The distribution files will not be
added to the FreeBSD MASTER_SITE_BACKUP
CDN.
dist-sell
Selling of distribution files is permitted. The distribution files will be present on the installer images.
no-dist-sell
Selling of distribution files is prohibited. This
is equivalent to setting NO_CDROM
.
pkg-mirror
Free redistribution of package is permitted. The package will be distributed on the FreeBSD package CDN https://pkg.freebsd.org/.
no-pkg-mirror
Free redistribution of package is prohibited.
Equivalent to setting NO_PACKAGE
.
The package will not be distributed
from the FreeBSD package
CDN https://pkg.freebsd.org/.
pkg-sell
Selling of package is permitted. The package will be present on the installer images.
no-pkg-sell
Selling of package is prohibited. This is
equivalent to setting NO_CDROM
.
The package will not be present on
the installer images.
auto-accept
License is accepted by default. Prompts to accept a
license are not displayed unless the user has defined
LICENSES_ASK
. Use this unless the
license states the user must accept the terms of the
license.
no-auto-accept
License is not accepted by default. The user will always be asked to confirm the acceptance of this license. This must be used if the license states that the user must accept its terms.
When both
and
permission
no-
is
present the
permission
no-
will cancel
permission
.permission
When
is
not present, it is considered to be a
permission
no-
.permission
Some missing permissions will prevent a port (and all ports depending on it) from being usable by package users:
A port without the auto-accept
permission will never be be built and all the ports
depending on it will be ignored.
A port without the pkg-mirror
permission will be removed, as well as all the ports
depending on it, after the build and they will ever end up
being distributed.
Read the terms of the license and translate those using the available permissions.
LICENSE= UNKNOWN LICENSE_NAME= unknown LICENSE_TEXT= This program is NOT in public domain.\ It can be freely distributed for non-commercial purposes only. LICENSE_PERMS= dist-mirror no-dist-sell pkg-mirror no-pkg-sell auto-accept
Read the terms of the license and express those using the available permissions. In case of doubt, please ask for guidance on the FreeBSD ports mailing list.
LICENSE= WARSOW GPLv2 LICENSE_COMB= multi LICENSE_NAME_WARSOW= Warsow Content License LICENSE_FILE_WARSOW= ${WRKSRC}/docs/license.txt LICENSE_PERMS_WARSOW= dist-mirror pkg-mirror auto-accept
When the permissions of the GPLv2 and the UNKNOWN
licenses are mixed, the port ends up with
dist-mirror dist-sell pkg-mirror pkg-sell
auto-accept dist-mirror no-dist-sell pkg-mirror
no-pkg-sell auto-accept
. The
no-
cancel the permissions
permissions
. The
resulting list of permissions are dist-mirror
pkg-mirror auto-accept
. The distribution
files and the packages will not be available on the
installer images.
Groups the license belongs.
FSF
Free Software Foundation Approved, see the FSF Licensing & Compliance Team.
GPL
GPL Compatible
OSI
OSI Approved, see the Open Source Initiative Open Source Licenses page.
COPYFREE
Comply with Copyfree Standard Definition, see the Copyfree Licenses page.
FONTS
Font licenses
Full name of the license.
LICENSE_NAME
LICENSE= UNRAR LICENSE_NAME= UnRAR License LICENSE_FILE= ${WRKSRC}/license.txt LICENSE_PERMS= dist-mirror dist-sell pkg-mirror pkg-sell auto-accept
Full path to the file containing the license text, usually
${WRKSRC}/some/file
. If the file is not
in the distfile, and its content is too long to be put in
LICENSE_TEXT
,
put it in a new file in
${FILESDIR}
.
Text to use as a license. Useful when the license is not in the distribution files and its text is short.
LICENSE_TEXT
LICENSE= UNKNOWN LICENSE_NAME= unknown LICENSE_TEXT= This program is NOT in public domain.\ It can be freely distributed for non-commercial purposes only,\ and THERE IS NO WARRANTY FOR THIS PROGRAM. LICENSE_PERMS= dist-mirror no-dist-sell pkg-mirror no-pkg-sell auto-accept
The distribution files to which the licenses apply. Defaults to all the distribution files.
LICENSE_DISTFILES
Used when the distribution files do not all have the same license. For example, one has a code license, and another has some artwork that cannot be redistributed:
MASTER_SITES= SF/some-game DISTFILES= ${DISTNAME}${EXTRACT_SUFX} artwork.zip LICENSE= BSD3CLAUSE ARTWORK LICENSE_COMB= dual LICENSE_NAME_ARTWORK= The game artwork license LICENSE_TEXT_ARTWORK= The README says that the files cannot be redistributed LICENSE_PERMS_ARTWORK= pkg-mirror pkg-sell auto-accept LICENSE_DISTFILES_BSD3CLAUSE= ${DISTNAME}${EXTRACT_SUFX} LICENSE_DISTFILES_ARTWORK= artwork.zip
Set to multi
if all licenses apply.
Set to dual
if any license applies.
Defaults to single
.
When a port says “This software may be distributed under the GNU General Public License or the Artistic License”, it means that either license can be used. Use this:
LICENSE= ART10 GPLv1 LICENSE_COMB= dual
If license files are provided, use this:
LICENSE= ART10 GPLv1 LICENSE_COMB= dual LICENSE_FILE_ART10= ${WRKSRC}/Artistic LICENSE_FILE_GPLv1= ${WRKSRC}/Copying
When part of a port has one license, and another part
has a different license, use
multi
:
LICENSE= GPLv2 LGPL21+ LICENSE_COMB= multi
Portscout is an automated distfile check utility for the FreeBSD Ports Collection, described in detail in Section 16.5, “Portscout: the FreeBSD Ports Distfile Scanner”.
PORTSCOUT
defines special
conditions within which the Portscout
distfile scanner is restricted.
Situations where PORTSCOUT
is set include:
When distfiles have to be ignored, whether for specific
versions, or specific minor revisions. For example, to
exclude version 8.2
from distfile
version checks because it is known to be broken, add:
PORTSCOUT= ignore:8.2
When specific versions or specific major and minor
revisions of a distfile must be checked. For example, if
only version 0.6.4
must be
monitored because newer versions have compatibility issues
with FreeBSD, add:
PORTSCOUT= limit:^0\.6\.4
When URLs listing the available versions differ from the download URLs. For example, to limit distfile version checks to the download page for the databases/pgtune port, add:
PORTSCOUT= site:http://pgfoundry.org/frs/?group_id=1000416
Many ports depend on other ports. This is a very convenient feature of most Unix-like operating systems, including FreeBSD. Multiple ports can share a common dependency, rather than bundling that dependency with every port or package that needs it. There are seven variables that can be used to ensure that all the required bits will be on the user's machine. There are also some pre-supported dependency variables for common cases, plus a few more to control the behavior of dependencies.
When software has extra dependencies that provide extra
features, the base dependencies listed in
should
include the extra dependencies that would benefit most users.
The base dependencies should never be a “minimal”
dependency set. The goal is not to include every dependency
possible. Only include those that will benefit most
people.*
_DEPENDS
This variable specifies the shared libraries this port
depends on. It is a list of
lib
:dir
tuples where lib
is the name of
the shared library, dir
is the
directory in which to find it in case it is not available.
For example,
LIB_DEPENDS= libjpeg.so:graphics/jpeg
will check for a shared jpeg library with any version, and
descend into the graphics/jpeg
subdirectory of the ports tree to build and install it if it
is not found.
The dependency is checked twice, once from within the
build
target and then from within
the install
target. Also, the name
of the dependency is put into the package so that
pkg install
(see pkg-install(8)) will
automatically install it if it is not on the user's
system.
This variable specifies executables or files this port
depends on during run-time. It is a list of
path
:dir
[:target
]
tuples where path
is the name of
the executable or file, dir
is the
directory in which to find it in case it is not available, and
target
is the target to call in
that directory. If path
starts
with a slash (/
), it is treated as a file
and its existence is tested with test -e
;
otherwise, it is assumed to be an executable, and
which -s
is used to determine if the
program exists in the search path.
For example,
RUN_DEPENDS= ${LOCALBASE}/news/bin/innd:news/inn \ xmlcatmgr:textproc/xmlcatmgr
will check if the file or directory
/usr/local/news/bin/innd
exists, and
build and install it from the news/inn
subdirectory of the ports tree if it is not found. It will
also see if an executable called xmlcatmgr
is in the search path, and descend into
textproc/xmlcatmgr
to build and install it if it is not found.
In this case, innd
is actually an
executable; if an executable is in a place that is not
expected to be in the search path, use the full
pathname.
The official search PATH
used on the
ports build cluster is
/sbin:/bin:/usr/sbin:/usr/bin:/usr/local/sbin:/usr/local/bin
The dependency is checked from within the
install
target. Also, the name of
the dependency is put into the package so that
pkg install
(see pkg-install(8)) will
automatically install it if it is not on the user's system.
The target
part can be omitted if
it is the same as DEPENDS_TARGET
.
A quite common situation is when
RUN_DEPENDS
is literally the same as
BUILD_DEPENDS
, especially if ported
software is written in a scripted language or if it requires
the same build and run-time environment. In this case, it is
both tempting and intuitive to directly assign one to the
other:
RUN_DEPENDS= ${BUILD_DEPENDS}
However, such assignment can pollute run-time
dependencies with entries not defined in the port's original
BUILD_DEPENDS
. This happens because of
make(1)'s lazy evaluation of variable assignment.
Consider a Makefile
with
USE_
,
which are processed by *
ports/Mk/bsd.*.mk
to augment initial build dependencies. For example,
USES= gmake
adds
devel/gmake to
BUILD_DEPENDS
. To prevent such additional
dependencies from polluting RUN_DEPENDS
,
create another variable with the current content of
BUILD_DEPENDS
and assign it to both
BUILD_DEPENDS
and
RUN_DEPENDS
:
MY_DEPENDS= some:devel/some \ other:lang/other BUILD_DEPENDS= ${MY_DEPENDS} RUN_DEPENDS= ${MY_DEPENDS}
Do not use :=
to assign BUILD_DEPENDS
to
RUN_DEPENDS
or vice-versa. All
variables are expanded immediately, which is exactly the
wrong thing to do and almost always a failure.
This variable specifies executables or files this port
requires to build. Like RUN_DEPENDS
, it
is a list of
path
:dir
[:target
]
tuples. For example,
BUILD_DEPENDS= unzip:archivers/unzip
will check for an executable called
unzip
, and descend into the
archivers/unzip
subdirectory of the
ports tree to build and install it if it is not found.
“build” here means everything from
extraction to compilation. The dependency is checked from
within the extract
target. The
target
part can be omitted if it
is the same as DEPENDS_TARGET
This variable specifies executables or files this port
requires to fetch. Like the previous two, it is a list of
path
:dir
[:target
]
tuples. For example,
FETCH_DEPENDS= ncftp2:net/ncftp2
will check for an executable called
ncftp2
, and descend into the
net/ncftp2
subdirectory of the ports
tree to build and install it if it is not found.
The dependency is checked from within the
fetch
target. The
target
part can be omitted if it is
the same as DEPENDS_TARGET
.
This variable specifies executables or files this port
requires for extraction. Like the previous, it is a list of
path
:dir
[:target
]
tuples. For example,
EXTRACT_DEPENDS= unzip:archivers/unzip
will check for an executable called
unzip
, and descend into the
archivers/unzip
subdirectory of the
ports tree to build and install it if it is not found.
The dependency is checked from within the
extract
target. The
target
part can be omitted if it
is the same as DEPENDS_TARGET
.
Use this variable only if the extraction does not
already work (the default assumes tar
)
and cannot be made to work using
USES=tar
, USES=lha
or
USES=zip
described in Chapter 17, Using USES
Macros.
This variable specifies executables or files this port
requires to patch. Like the previous, it is a list of
path
:dir
[:target
]
tuples. For example,
PATCH_DEPENDS= ${NONEXISTENT}:java/jfc:extract
will descend into the java/jfc
subdirectory of the ports tree to extract it.
The dependency is checked from within the
patch
target. The
target
part can be omitted if it
is the same as DEPENDS_TARGET
.
Parameters can be added to define different features and
dependencies used by the port. They are specified by adding
this line to the Makefile
:
USES= feature[:arguments]
For the complete list of values, please see
Chapter 17, Using USES
Macros.
USES
cannot be assigned after
inclusion of bsd.port.pre.mk
.
Several variables exist to define common dependencies
shared by many ports. Their use is optional, but helps to
reduce the verbosity of the port
Makefile
s. Each of them is styled as
USE_
. These
variables may be used only in the port
*
Makefile
s and
ports/Mk/bsd.*.mk
. They are not meant
for user-settable options — use
PORT_OPTIONS
for that purpose.
It is always incorrect to set any
USE_
in
*
/etc/make.conf
. For instance,
setting
USE_GCC=X.Y
(where X.Y is version number) would add a dependency
on gccXY for every port, including
lang/gccXY
itself!
USE_*
Variable | Means |
---|---|
USE_GCC |
The port requires GCC ( Note:
|
Variables related to gmake and
configure
are described in
Section 6.5, “Building Mechanisms”, while
autoconf,
automake and
libtool are described in
Section 6.6, “Using GNU Autotools”.
Perl related variables are
described in Section 6.8, “Using Perl”. X11 variables are
listed in Section 6.9, “Using X11”.
Section 6.10, “Using GNOME” deals with GNOME and
Section 6.13, “Using KDE” with KDE related variables.
Section 6.15, “Using Java” documents Java variables, while
Section 6.16, “Web Applications, Apache and PHP” contains information on
Apache,
PHP and PEAR modules.
Python is discussed in
Section 6.17, “Using Python”, while
Ruby in
Section 6.19, “Using Ruby”. Section 6.20, “Using SDL”
provides variables used for SDL
applications and finally, Section 6.24, “Using Xfce”
contains information on
Xfce.
A minimal version of a dependency can be specified in any
except *
_DEPENDSLIB_DEPENDS
using this
syntax:
p5-Spiffy>=0.26:devel/p5-Spiffy
The first field contains a dependent package name, which must match the entry in the package database, a comparison sign, and a package version. The dependency is satisfied if p5-Spiffy-0.26 or newer is installed on the machine.
As mentioned above, the default target to call when a
dependency is required is
DEPENDS_TARGET
. It defaults to
install
. This is a user variable; it is
never defined in a port's Makefile
. If
the port needs a special way to handle a dependency, use the
:target
part of
instead of redefining
*
_DEPENDSDEPENDS_TARGET
.
When running make clean
, the port
dependencies are automatically cleaned too. If this is not
desirable, define
NOCLEANDEPENDS
in the environment. This
may be particularly desirable if the port has something that
takes a long time to rebuild in its dependency list, such as
KDE, GNOME or Mozilla.
To depend on another port unconditionally, use the
variable ${NONEXISTENT}
as the first field
of BUILD_DEPENDS
or
RUN_DEPENDS
. Use this only when
the source of the other port is needed. Compilation time can
be saved by specifying the target too. For
instance
BUILD_DEPENDS= ${NONEXISTENT}:graphics/jpeg:extract
will always descend to the jpeg
port
and extract it.
Do not introduce any circular dependencies into the ports tree!
The ports building technology does not tolerate circular
dependencies. If one is introduced, someone, somewhere in the
world, will have their FreeBSD installation broken
almost immediately, with many others quickly to follow. These
can really be hard to detect. If in doubt, before making
that change, make sure to run:
cd /usr/ports; make index
. That process
can be quite slow on older machines, but it may be able to
save a large number of people, including yourself,
a lot of grief in the process.
Dependencies must be declared either explicitly or by using the OPTIONS framework. Using other methods like automatic detection complicates indexing, which causes problems for port and package management.
.include <bsd.port.pre.mk> .if exists(${LOCALBASE}/bin/foo) LIB_DEPENDS= libbar.so:foo/bar .endif
The problem with trying to automatically add dependencies is that files and settings outside an individual port can change at any time. For example: an index is built, then a batch of ports are installed. But one of the ports installs the tested file. The index is now incorrect, because an installed port unexpectedly has a new dependency. The index may still be wrong even after rebuilding if other ports also determine their need for dependencies based on the existence of other files.
OPTIONS_DEFINE= BAR BAR_DESC= Calling cellphones via bar BAR_LIB_DEPENDS= libbar.so:foo/bar
Testing option variables is the correct method. It will not cause inconsistencies in the index of a batch of ports, provided the options were defined prior to the index build. Simple scripts can then be used to automate the building, installation, and updating of these ports and their packages.
If the port needs to build slightly different versions of
packages by having a variable (for instance, resolution, or
paper size) take different values, create one subdirectory per
package to make it easier for users to see what to do, but try
to share as many files as possible between ports. Typically, by
using variables cleverly, only a very short
Makefile
is needed in all but one of the
directories. In the sole Makefile
, use
MASTERDIR
to specify the directory where the
rest of the files are. Also, use a variable as part of PKGNAMESUFFIX
so the packages will have different names.
This will be best demonstrated by an example. This is part
of print/pkfonts300/Makefile
;
PORTNAME= pkfonts${RESOLUTION} PORTVERSION= 1.0 DISTFILES= pk${RESOLUTION}.tar.gz PLIST= ${PKGDIR}/pkg-plist.${RESOLUTION} .if !defined(RESOLUTION) RESOLUTION= 300 .else .if ${RESOLUTION} != 118 && ${RESOLUTION} != 240 && \ ${RESOLUTION} != 300 && ${RESOLUTION} != 360 && \ ${RESOLUTION} != 400 && ${RESOLUTION} != 600 .BEGIN: @${ECHO_MSG} "Error: invalid value for RESOLUTION: \"${RESOLUTION}\"" @${ECHO_MSG} "Possible values are: 118, 240, 300, 360, 400 and 600." @${FALSE} .endif .endif
print/pkfonts300 also has all
the regular patches, package files, etc. Running
make
there, it will take the default value
for the resolution (300) and build the port normally.
As for other resolutions, this is the
entire
print/pkfonts360/Makefile
:
RESOLUTION= 360 MASTERDIR= ${.CURDIR}/../pkfonts300 .include "${MASTERDIR}/Makefile"
(print/pkfonts118/Makefile
,
print/pkfonts600/Makefile
, and all the
other are similar).
MASTERDIR
definition tells
bsd.port.mk
that the regular set of
subdirectories like FILESDIR
and
SCRIPTDIR
are to be found under
pkfonts300
. The
RESOLUTION=360
line will override the
RESOLUTION=300
line in
pkfonts300/Makefile
and the port will be
built with resolution set to 360.
If the port anchors its man tree somewhere other than
PREFIX
, use
MANDIRS
to specify those directories. Note
that the files corresponding to manual pages must be placed in
pkg-plist
along with the rest of the files.
The purpose of MANDIRS
is to enable automatic
compression of manual pages, therefore the file names are
suffixed with .gz
.
If the package needs to install GNU info
files, list them in INFO
(without the
trailing .info
), one entry per document.
These files are assumed to be installed to
PREFIX/INFO_PATH
. Change
INFO_PATH
if the package uses a different
location. However, this is not recommended. These entries
contain just the path relative to
PREFIX/INFO_PATH
. For example,
lang/gcc34 installs info files to
PREFIX/INFO_PATH/gcc34
, and
INFO
will be something like this:
INFO= gcc34/cpp gcc34/cppinternals gcc34/g77 ...
Appropriate installation/de-installation code will be
automatically added to the temporary
pkg-plist
before package
registration.
Many applications can be built with optional or differing configurations. Examples include choice of natural (human) language, GUI versus command-line, or type of database to support. Users may need a different configuration than the default, so the ports system provides hooks the port author can use to control which variant will be built. Supporting these options properly will make users happy, and effectively provide two or more ports for the price of one.
OPTIONS_
give the user installing the port a dialog showing the
available options, and then saves those options to
*
${PORT_DBDIR}/${OPTIONS_NAME}/options
.
The next time the port is built, the options are
reused. PORT_DBDIR
defaults to
/var/db/ports
.
OPTIONS_NAME
is to the port origin with
an underscore as the space separator, for example, for
dns/bind99 it will be
dns_bind99
.
When the user runs make config
(or
runs make build
for the first time), the
framework checks for
${PORT_DBDIR}/${OPTIONS_NAME}/options
.
If that file does not exist, the values of
OPTIONS_
are used, and a dialog box is
displayed where the options can be enabled or disabled.
Then *
options
is saved and the
configured variables are used when building the port.
If a new version of the port adds new
OPTIONS
, the dialog will be presented to
the user with the saved values of old
OPTIONS
prefilled.
make showconfig
shows the saved
configuration. Use make rmconfig
to remove the saved configuration.
OPTIONS_DEFINE
contains a list of
OPTIONS
to be used. These are
independent of each other and are not grouped:
OPTIONS_DEFINE= OPT1 OPT2
Once defined, OPTIONS
are
described (optional, but strongly recommended):
OPT1_DESC= Describe OPT1 OPT2_DESC= Describe OPT2 OPT3_DESC= Describe OPT3 OPT4_DESC= Describe OPT4 OPT5_DESC= Describe OPT5 OPT6_DESC= Describe OPT6
ports/Mk/bsd.options.desc.mk
has descriptions for many common OPTIONS
.
While often useful, override them if the
description is insufficient for the port.
When describing options, view it from the
perspective of the user: “What functionality does it
change?”
and “Why would I want to enable this?”
Do not just repeat the name. For example, describing the
NLS
option as
“include NLS support” does not help the user,
who can already see the option name but may not know what
it means. Describing it as “Native Language Support
via gettext utilities” is much more
helpful.
Option names are always in all uppercase. They cannot use mixed case or lowercase.
OPTIONS
can be grouped as radio
choices, where only one choice from each group is
allowed:
OPTIONS_SINGLE= SG1 OPTIONS_SINGLE_SG1= OPT3 OPT4
There must be one of each
OPTIONS_SINGLE
group selected at all
times for the options to be valid. One option of each
group must be added to
OPTIONS_DEFAULT
.
OPTIONS
can be grouped as radio
choices, where none or only one choice from each group
is allowed:
OPTIONS_RADIO= RG1 OPTIONS_RADIO_RG1= OPT7 OPT8
OPTIONS
can also be grouped as
“multiple-choice” lists, where
at least one option must be
enabled:
OPTIONS_MULTI= MG1 OPTIONS_MULTI_MG1= OPT5 OPT6
OPTIONS
can also be grouped as
“multiple-choice” lists, where none or any
option can be enabled:
OPTIONS_GROUP= GG1 OPTIONS_GROUP_GG1= OPT9 OPT10
OPTIONS
are unset by default,
unless they are listed in
OPTIONS_DEFAULT
:
OPTIONS_DEFAULT= OPT1 OPT3 OPT6
OPTIONS
definitions must appear
before the inclusion of
bsd.port.options.mk
.
PORT_OPTIONS
values can only be tested
after the inclusion of
bsd.port.options.mk
. Inclusion of
bsd.port.pre.mk
can be used instead,
too, and is still widely used in ports written before the
introduction of bsd.port.options.mk
.
But be aware that some variables will not work as expected
after the inclusion of bsd.port.pre.mk
,
typically some
USE_
flags.*
OPTIONS
OPTIONS_DEFINE= FOO BAR OPTIONS_DEFAULT=FOO FOO_DESC= Option foo support BAR_DESC= Feature bar support # Will add --with-foo / --without-foo FOO_CONFIGURE_WITH= foo BAR_RUN_DEPENDS= bar:bar/bar .include <bsd.port.mk>
OPTIONS
.if ! ${PORT_OPTIONS:MEXAMPLES} CONFIGURE_ARGS+=--without-examples .endif
The form shown above is discouraged. The preferred method is using a configure knob to really enable and disable the feature to match the option:
# Will add --with-examples / --without-examples EXAMPLES_CONFIGURE_WITH= examples
OPTIONS
OPTIONS_DEFINE= EXAMPLES OPTIONS_DEFAULT= PGSQL LDAP SSL OPTIONS_SINGLE= BACKEND OPTIONS_SINGLE_BACKEND= MYSQL PGSQL BDB OPTIONS_MULTI= AUTH OPTIONS_MULTI_AUTH= LDAP PAM SSL EXAMPLES_DESC= Install extra examples MYSQL_DESC= Use MySQL as backend PGSQL_DESC= Use PostgreSQL as backend BDB_DESC= Use Berkeley DB as backend LDAP_DESC= Build with LDAP authentication support PAM_DESC= Build with PAM support SSL_DESC= Build with OpenSSL support # Will add USE_PGSQL=yes PGSQL_USE= pgsql=yes # Will add --enable-postgres / --disable-postgres PGSQL_CONFIGURE_ENABLE= postgres ICU_LIB_DEPENDS= libicuuc.so:devel/icu # Will add --with-examples / --without-examples EXAMPLES_CONFIGURE_WITH= examples # Check other OPTIONS .include <bsd.port.mk>
These options are always on by default.
DOCS
— build and install
documentation.
NLS
— Native Language
Support.
EXAMPLES
— build and
install examples.
IPV6
— IPv6 protocol
support.
There is no need to add these to
OPTIONS_DEFAULT
. To have them active,
and show up in the options selection dialog, however, they
must be added to OPTIONS_DEFINE
.
When using a GNU configure script, keep an eye on which
optional features are activated by auto-detection. Explicitly
disable optional features that are not needed by
adding --without-xxx
or
--disable-xxx
in
CONFIGURE_ARGS
.
.if ${PORT_OPTIONS:MFOO} LIB_DEPENDS+= libfoo.so:devel/foo CONFIGURE_ARGS+= --enable-foo .endif
In the example above, imagine a library libfoo is
installed on the system. The user does not want this
application to use libfoo, so he toggled the option off in the
make config
dialog. But the application's
configure script detects the library present in the system and
includes its support in the resulting executable. Now when
the user decides to remove libfoo from the system, the ports
system does not protest (no dependency on libfoo was recorded)
but the application breaks.
FOO_LIB_DEPENDS= libfoo.so:devel/foo # Will add --enable-foo / --disable-foo FOO_CONFIGURE_ENABLE= foo
Under some circumstances, the shorthand conditional
syntax can cause problems with complex constructs. The
errors are usually
Malformed conditional
, an alternative
syntax can be used.
.if !empty(VARIABLE:MVALUE)
as an alternative to
.if ${VARIABLE:MVALUE}
There are some macros to help simplify conditional values which differ based on the options set. For easier access, a comprehensive list is provided:
PLIST_SUB
,
SUB_LIST
For automatic
%%
and
OPT
%%%%NO_
generation, see Section 5.13.3.1, “OPT
%%OPTIONS_SUB
”.
For more complex usage, see Section 5.13.3.11, “Generic Variables Replacement,
and
OPT
_VARIABLE
”.OPT
_VARIABLE
_OFF
CONFIGURE_ARGS
For
--enable-
and
x
--disable-
,
see Section 5.13.3.3.1, “x
”.OPT
_CONFIGURE_ENABLE
For
--with-
and
x
--without-
,
see Section 5.13.3.3.2, “x
”.OPT
_CONFIGURE_WITH
For all other cases, see Section 5.13.3.3.3, “
and
OPT
_CONFIGURE_ON
”.OPT
_CONFIGURE_OFF
CMAKE_ARGS
For arguments that are booleans
(on
, off
,
true
, false
,
0
, 1
) see Section 5.13.3.4.2, “
and
OPT
_CMAKE_BOOL
”.OPT
_CMAKE_BOOL_OFF
For all other cases, see Section 5.13.3.4.1, “
and
OPT
_CMAKE_ON
”.OPT
_CMAKE_OFF
MESON_ARGS
For arguments that take true
or
false
, see Section 5.13.3.5.2, “
and
OPT
_MESON_TRUE
”.OPT
_MESON_FALSE
For arguments that take yes
or
no
, use Section 5.13.3.5.3, “
and
OPT
_MESON_YES
”.OPT
_MESON_NO
For arguments that take enabled
or disabled
, see Section 5.13.3.5.4, “
and
OPT
_MESON_ENABLED
”.OPT
_MESON_DISABLED
For all other cases, use Section 5.13.3.5.1, “
and
OPT
_MESON_ON
”.OPT
_MESON_OFF
QMAKE_ARGS
USE_*
*
_DEPENDS
See Section 5.13.3.10, “Dependencies,
and
OPT
_DEPTYPE
”.OPT
_DEPTYPE
_OFF
*
(Any variable)The most used variables have direct helpers, see
Section 5.13.3.11, “Generic Variables Replacement,
and
OPT
_VARIABLE
”.OPT
_VARIABLE
_OFF
For any variable without a specific helper, see
Section 5.13.3.9, “
and
OPT
_VARS
”.OPT
_VARS_OFF
When an option need another option to work, see
Section 5.13.3.7, “
”.OPT
_IMPLIES
When an option cannot work if another is also
enabled, see Section 5.13.3.8, “
and
OPT
_PREVENTS
”.OPT
_PREVENTS_MSG
When an option need some extra processing, see Section 5.13.3.12, “Additional Build Targets,
and
target
-OPT
-on
”.target
-OPT
-off
If OPTIONS_SUB
is set to
yes
then each of the options added to
OPTIONS_DEFINE
will be added to
PLIST_SUB
and
SUB_LIST
, for example:
OPTIONS_DEFINE= OPT1 OPTIONS_SUB= yes
is equivalent to:
OPTIONS_DEFINE= OPT1 .include <bsd.port.options.mk> .if ${PORT_OPTIONS:MOPT1} PLIST_SUB+= OPT1="" NO_OPT1="@comment " SUB_LIST+= OPT1="" NO_OPT1="@comment " .else PLIST_SUB+= OPT1="@comment " NO_OPT1="" SUB_LIST+= OPT1="@comment " NO_OPT1="" .endif
The value of OPTIONS_SUB
is
ignored. Setting it to any value will add
PLIST_SUB
and
SUB_LIST
entries for
all options.
When option OPT
is selected,
for each
pair in
key
=value
,
OPT
_USEvalue
is appended to the
corresponding
USE_
. If
KEY
value
has spaces in it, replace
them with commas and they will be changed back to spaces
during processing.
works the same way, but when OPT
_USE_OFFOPT
is
not selected. For example:
OPTIONS_DEFINE= OPT1 OPT1_USES= xorg OPT1_USE= mysql=yes xorg=x11,xextproto,xext,xrandr OPT1_USE_OFF= openssl=yes
is equivalent to:
OPTIONS_DEFINE= OPT1 .include <bsd.port.options.mk> .if ${PORT_OPTIONS:MOPT1} USE_MYSQL= yes USES+= xorg USE_XORG= x11 xextproto xext xrandr .else USE_OPENSSL= yes .endif
When option OPT
is
selected, for each entry
in
then
OPT
_CONFIGURE_ENABLE--enable-
is appended to entry
CONFIGURE_ARGS
. When
option OPT
is
not selected,
--disable-
is appended to entry
CONFIGURE_ARGS
. An
optional argument can be specified with an
=
symbol. This argument is only
appended to the
--enable-
configure option. For example:entry
OPTIONS_DEFINE= OPT1 OPT2 OPT1_CONFIGURE_ENABLE= test1 test2 OPT2_CONFIGURE_ENABLE= test2=exhaustive
is equivalent to:
OPTIONS_DEFINE= OPT1 .include <bsd.port.options.mk> .if ${PORT_OPTIONS:MOPT1} CONFIGURE_ARGS+= --enable-test1 --enable-test2 .else CONFIGURE_ARGS+= --disable-test1 --disable-test2 .endif .if ${PORT_OPTIONS:MOPT2} CONFIGURE_ARGS+= --enable-test2=exhaustive .else CONFIGURE_ARGS+= --disable-test2 .endif
When option OPT
is
selected, for each entry
in
then
OPT
_CONFIGURE_WITH--with-
is appended to entry
CONFIGURE_ARGS
. When
option OPT
is
not selected,
--without-
is appended to entry
CONFIGURE_ARGS
. An
optional argument can be specified with an
=
symbol. This argument is only
appended to the
--with-
configure option. For example:entry
OPTIONS_DEFINE= OPT1 OPT2 OPT1_CONFIGURE_WITH= test1 OPT2_CONFIGURE_WITH= test2=exhaustive
is equivalent to:
OPTIONS_DEFINE= OPT1 OPT2 .include <bsd.port.options.mk> .if ${PORT_OPTIONS:MOPT1} CONFIGURE_ARGS+= --with-test1 .else CONFIGURE_ARGS+= --without-test1 .endif .if ${PORT_OPTIONS:MOPT2} CONFIGURE_ARGS+= --with-test2=exhaustive .else CONFIGURE_ARGS+= --without-test2 .endif
When option OPT
is
selected, the value of
,
if defined, is appended to
OPT
_CONFIGURE_ONCONFIGURE_ARGS
.
works the same way, but when OPT
_CONFIGURE_OFFOPT
is
not selected. For example:
OPTIONS_DEFINE= OPT1 OPT1_CONFIGURE_ON= --add-test OPT1_CONFIGURE_OFF= --no-test
is equivalent to:
OPTIONS_DEFINE= OPT1 .include <bsd.port.options.mk> .if ${PORT_OPTIONS:MOPT1} CONFIGURE_ARGS+= --add-test .else CONFIGURE_ARGS+= --no-test .endif
Most of the time, the helpers in Section 5.13.3.3.1, “
” and Section 5.13.3.3.2, “OPT
_CONFIGURE_ENABLE
” provide a shorter
and more comprehensive functionality.OPT
_CONFIGURE_WITH
When option OPT
is
selected, the value of
,
if defined, is appended to OPT
_CMAKE_ONCMAKE_ARGS
.
works the same way, but when OPT
_CMAKE_OFFOPT
is
not selected. For example:
OPTIONS_DEFINE= OPT1 OPT1_CMAKE_ON= -DTEST:BOOL=true -DDEBUG:BOOL=true OPT1_CMAKE_OFF= -DOPTIMIZE:BOOL=true
is equivalent to:
OPTIONS_DEFINE= OPT1 .include <bsd.port.options.mk> .if ${PORT_OPTIONS:MOPT1} CMAKE_ARGS+= -DTEST:BOOL=true -DDEBUG:BOOL=true .else CMAKE_ARGS+= -DOPTIMIZE:BOOL=true .endif
See Section 5.13.3.4.2, “
and
OPT
_CMAKE_BOOL
” for a
shorter helper when the value is boolean.OPT
_CMAKE_BOOL_OFF
When option OPT
is
selected, for each entry
in
then
OPT
_CMAKE_BOOL-D
is appended to entry
:BOOL=trueCMAKE_ARGS
. When option
OPT
is not
selected,
-D
is appended to entry
:BOOL=falseCONFIGURE_ARGS
.
is the opposite,
OPT
_CMAKE_BOOL_OFF-D
is appended to entry
:BOOL=falseCMAKE_ARGS
when the
option is selected, and
-D
when the option is not selected. For
example:entry
:BOOL=true
OPTIONS_DEFINE= OPT1 OPT1_CMAKE_BOOL= TEST DEBUG OPT1_CMAKE_BOOL_OFF= OPTIMIZE
is equivalent to:
OPTIONS_DEFINE= OPT1 .include <bsd.port.options.mk> .if ${PORT_OPTIONS:MOPT1} CMAKE_ARGS+= -DTEST:BOOL=true -DDEBUG:BOOL=true \ -DOPTIMIZE:BOOL=false .else CMAKE_ARGS+= -DTEST:BOOL=false -DDEBUG:BOOL=false \ -DOPTIMIZE:BOOL=true .endif
When option OPT
is
selected, the value of
,
if defined, is appended to OPT
_MESON_ONMESON_ARGS
.
works the same way, but when OPT
_MESON_OFFOPT
is
not selected. For example:
OPTIONS_DEFINE= OPT1 OPT1_MESON_ON= -Dopt=1 OPT1_MESON_OFF= -Dopt=2
is equivalent to:
OPTIONS_DEFINE= OPT1 .include <bsd.port.options.mk> .if ${PORT_OPTIONS:MOPT1} MESON_ARGS+= -Dopt=1 .else MESON_ARGS+= -Dopt=2 .endif
When option OPT
is
selected, for each entry
in
then
OPT
_MESON_TRUE-D
is appended to entry
=trueMESON_ARGS
. When option
OPT
is not
selected,
-D
is appended to entry
=falseMESON_ARGS
.
is the opposite,
OPT
_MESON_FALSE-D
is appended to entry
=falseMESON_ARGS
when the
option is selected, and
-D
when the option is not selected. For
example:entry
=true
OPTIONS_DEFINE= OPT1 OPT1_MESON_TRUE= test debug OPT1_MESON_FALSE= optimize
is equivalent to:
OPTIONS_DEFINE= OPT1 .include <bsd.port.options.mk> .if ${PORT_OPTIONS:MOPT1} MESON_ARGS+= -Dtest=true -Ddebug=true \ -Doptimize=false .else MESON_ARGS+= -Dtest=false -Ddebug=false \ -Doptimize=true .endif
When option OPT
is
selected, for each entry
in
then
OPT
_MESON_YES-D
is appended to entry
=yesMESON_ARGS
. When option
OPT
is not
selected,
-D
is appended to entry
=noMESON_ARGS
.
is the opposite,
OPT
_MESON_NO-D
is appended to entry
=noMESON_ARGS
when the
option is selected, and
-D
when the option is not selected. For
example:entry
=yes
OPTIONS_DEFINE= OPT1 OPT1_MESON_YES= test debug OPT1_MESON_NO= optimize
is equivalent to:
OPTIONS_DEFINE= OPT1 .include <bsd.port.options.mk> .if ${PORT_OPTIONS:MOPT1} MESON_ARGS+= -Dtest=yes -Ddebug=yes \ -Doptimize=no .else MESON_ARGS+= -Dtest=no -Ddebug=no \ -Doptimize=yes .endif
When option OPT
is
selected, for each entry
in
then
OPT
_MESON_ENABLED-D
is appended to entry
=enabledMESON_ARGS
. When option
OPT
is not
selected,
-D
is appended to entry
=disabledMESON_ARGS
.
is the opposite,
OPT
_MESON_DISABLED-D
is appended to entry
=disabledMESON_ARGS
when the
option is selected, and
-D
when the option is not selected. For
example:entry
=enabled
OPTIONS_DEFINE= OPT1 OPT1_MESON_ENABLED= test OPT1_MESON_DISABLED= debug
is equivalent to:
OPTIONS_DEFINE= OPT1 .include <bsd.port.options.mk> .if ${PORT_OPTIONS:MOPT1} MESON_ARGS+= -Dtest=enabled -Ddebug=disabled .else MESON_ARGS+= -Dtest=disabled -Ddebug=enabled .endif
When option OPT
is selected,
the value of
,
if defined, is appended to OPT
_QMAKE_ONQMAKE_ARGS
.
works the same way, but when OPT
_QMAKE_OFFOPT
is
not selected. For example:
OPTIONS_DEFINE= OPT1 OPT1_QMAKE_ON= -DTEST:BOOL=true OPT1_QMAKE_OFF= -DPRODUCTION:BOOL=true
is equivalent to:
OPTIONS_DEFINE= OPT1 .include <bsd.port.options.mk> .if ${PORT_OPTIONS:MOPT1} QMAKE_ARGS+= -DTEST:BOOL=true .else QMAKE_ARGS+= -DPRODUCTION:BOOL=true .endif
Provides a way to add dependencies between options.
When OPT
is selected, all the
options listed in this variable will be selected too. Using
the
described earlier to illustrate:OPT
_CONFIGURE_ENABLE
OPTIONS_DEFINE= OPT1 OPT2 OPT1_IMPLIES= OPT2 OPT1_CONFIGURE_ENABLE= opt1 OPT2_CONFIGURE_ENABLE= opt2
Is equivalent to:
OPTIONS_DEFINE= OPT1 OPT2 .include <bsd.port.options.mk> .if ${PORT_OPTIONS:MOPT1} CONFIGURE_ARGS+= --enable-opt1 .else CONFIGURE_ARGS+= --disable-opt1 .endif .if ${PORT_OPTIONS:MOPT2} || ${PORT_OPTIONS:MOPT1} CONFIGURE_ARGS+= --enable-opt2 .else CONFIGURE_ARGS+= --disable-opt2 .endif
OPT
_IMPLIES
This port has a X11
option, and a
GNOME
option that needs the
X11
option to be selected to
build.
OPTIONS_DEFINE= X11 GNOME OPTIONS_DEFAULT= X11 X11_USES= xorg X11_USE= xorg=xi,xextproto GNOME_USE= gnome=gtk30 GNOME_IMPLIES= X11
Provides a way to add conflicts between options.
When OPT
is selected, all the
options listed in
must be un-selected. If OPT
_PREVENTS
is set and a conflict is triggered, its content will be shown explaining
why they conflict. For example:OPT
_PREVENTS_MSG
OPTIONS_DEFINE= OPT1 OPT2 OPT1_PREVENTS= OPT2 OPT1_PREVENTS_MSG= OPT1 and OPT2 enable conflicting options
Is roughly equivalent to:
OPTIONS_DEFINE= OPT1 OPT2 .include <bsd.port.options.mk> .if ${PORT_OPTIONS:MOPT2} && ${PORT_OPTIONS:MOPT1} BROKEN= Option OPT1 conflicts with OPT2 (select only one) .endif
The only difference is that the first one will write an
error after running make config
,
suggesting changing the selected options.
OPT
_PREVENTS
This port has X509
and
SCTP
options. Both options add
patches, but the patches conflict with each other, so they
cannot be selected at the same time.
OPTIONS_DEFINE= X509 SCTP SCTP_PATCHFILES= ${PORTNAME}-6.8p1-sctp-2573.patch.gz:-p1 SCTP_CONFIGURE_WITH= sctp X509_PATCH_SITES= http://www.roumenpetrov.info/openssh/x509/:x509 X509_PATCHFILES= ${PORTNAME}-7.0p1+x509-8.5.diff.gz:-p1:x509 X509_PREVENTS= SCTP X509_PREVENTS_MSG= X509 and SCTP patches conflict
Provides a generic way to set and append to variables.
Before using
and
OPT
_VARS
,
see if there is already a more specific helper available in
Section 5.13.3.11, “Generic Variables Replacement,
OPT
_VARS_OFF
and
OPT
_VARIABLE
”.OPT
_VARIABLE
_OFF
When option OPT
is selected,
and
defined,
OPT
_VARS
and
key
=value
pairs are evaluated from
key
+=value
. An
OPT
_VARS=
cause the existing value of
KEY
to be overwritten, an
+=
appends to the value.
works the same way, but when OPT
_VARS_OFFOPT
is
not selected.
OPTIONS_DEFINE= OPT1 OPT2 OPT3 OPT1_VARS= also_build+=bin1 OPT2_VARS= also_build+=bin2 OPT3_VARS= bin3_build=yes OPT3_VARS_OFF= bin3_build=no MAKE_ARGS= ALSO_BUILD="${ALSO_BUILD}" BIN3_BUILD="${BIN3_BUILD}"
is equivalent to:
OPTIONS_DEFINE= OPT1 OPT2 MAKE_ARGS= ALSO_BUILD="${ALSO_BUILD}" BIN3_BUILD="${BIN3_BUILD}" .include <bsd.port.options.mk> .if ${PORT_OPTIONS:MOPT1} ALSO_BUILD+= bin1 .endif .if ${PORT_OPTIONS:MOPT2} ALSO_BUILD+= bin2 .endif .if ${PORT_OPTIONS:MOPT2} BIN3_BUILD= yes .else BIN3_BUILD= no .endif
Values containing whitespace must be enclosed in quotes:
OPT_VARS= foo="bar baz"
This is due to the way make(1) variable expansion
deals with whitespace. When OPT_VARS= foo=bar
baz
is expanded, the variable ends up
containing two strings, foo=bar
and
baz
. But the submitter probably
intended there to be only one string, foo=bar
baz
. Quoting the value prevents whitespace
from being used as a delimiter.
Also, do not add extra spaces
after the
sign
and before the value, it would also be split into two
strings. This will not work:var
=
OPT_VARS= foo= bar
For any of these dependency types:
PKG_DEPENDS
EXTRACT_DEPENDS
PATCH_DEPENDS
FETCH_DEPENDS
BUILD_DEPENDS
LIB_DEPENDS
RUN_DEPENDS
When option OPT
is
selected, the value of
,
if defined, is appended to
OPT
_DEPTYPE
.
DEPTYPE
works the same, but when OPT
_DEPTYPE
_OFFOPT
is
not
selected. For example:
OPTIONS_DEFINE= OPT1 OPT1_LIB_DEPENDS= liba.so:devel/a OPT1_LIB_DEPENDS_OFF= libb.so:devel/b
is equivalent to:
OPTIONS_DEFINE= OPT1 .include <bsd.port.options.mk> .if ${PORT_OPTIONS:MOPT1} LIB_DEPENDS+= liba.so:devel/a .else LIB_DEPENDS+= libb.so:devel/b .endif
For any of these variables:
ALL_TARGET
BINARY_ALIAS
BROKEN
CATEGORIES
CFLAGS
CONFIGURE_ENV
CONFLICTS
CONFLICTS_BUILD
CONFLICTS_INSTALL
CPPFLAGS
CXXFLAGS
DESKTOP_ENTRIES
DISTFILES
EXTRACT_ONLY
EXTRA_PATCHES
GH_ACCOUNT
GH_PROJECT
GH_SUBDIR
GH_TAGNAME
GH_TUPLE
GL_ACCOUNT
GL_COMMIT
GL_PROJECT
GL_SITE
GL_SUBDIR
GL_TUPLE
IGNORE
INFO
INSTALL_TARGET
LDFLAGS
LIBS
MAKE_ARGS
MAKE_ENV
MASTER_SITES
PATCHFILES
PATCH_SITES
PLIST_DIRS
PLIST_FILES
PLIST_SUB
PORTDOCS
PORTEXAMPLES
SUB_FILES
SUB_LIST
TEST_TARGET
USES
When option OPT
is
selected, the value of
,
if defined, is appended to
OPT
_ABOVEVARIABLE
.
ABOVEVARIABLE
works the same way, but when OPT
_ABOVEVARIABLE
_OFFOPT
is
not
selected. For example:
OPTIONS_DEFINE= OPT1 OPT1_USES= gmake OPT1_CFLAGS_OFF= -DTEST
is equivalent to:
OPTIONS_DEFINE= OPT1 .include <bsd.port.options.mk> .if ${PORT_OPTIONS:MOPT1} USES+= gmake .else CFLAGS+= -DTEST .endif
Some variables are not in this list, in particular
PKGNAMEPREFIX
and
PKGNAMESUFFIX
. This is intentional. A
port must not change its name when
its option set changes.
Some of these variables, at least
ALL_TARGET
,
DISTFILES
and
INSTALL_TARGET
, have their default
values set after the options are
processed.
With these lines in the
Makefile
:
ALL_TARGET= all DOCS_ALL_TARGET= doc
If the DOCS
option is enabled,
ALL_TARGET
will have a final value of
all doc
; if the option is disabled, it
would have a value of all
.
With only the options helper line in the
Makefile
:
DOCS_ALL_TARGET= doc
If the DOCS
option is enabled,
ALL_TARGET
will have a final value of
doc
; if the option is disabled, it
would have a value of all
.
These Makefile
targets can accept
optional extra build targets:
pre-fetch
do-fetch
post-fetch
pre-extract
do-extract
post-extract
pre-patch
do-patch
post-patch
pre-configure
do-configure
post-configure
pre-build
do-build
post-build
pre-install
do-install
post-install
post-stage
pre-package
do-package
post-package
When option OPT
is
selected, the target
,
if defined, is executed after
TARGET
-OPT
-on
.
TARGET
works the same way, but when TARGET
-OPT
-offOPT
is
not selected. For example:
OPTIONS_DEFINE= OPT1 post-patch-OPT1-on: @${REINPLACE_CMD} -e '/opt1/s|/usr/bin/|${EXAMPLESDIR}/|' ${WRKSRC}/Makefile post-patch-OPT1-off: @${REINPLACE_CMD} -e '/opt1/s|/usr/bin/|${PREFIX}/bin/|' ${WRKSRC}/Makefile
is equivalent to:
OPTIONS_DEFINE= OPT1 .include <bsd.port.options.mk> post-patch: .if ${PORT_OPTIONS:MOPT1} @${REINPLACE_CMD} -e '/opt1/s|/usr/bin/|${EXAMPLESDIR}/|' ${WRKSRC}/Makefile .else @${REINPLACE_CMD} -e '/opt1/s|/usr/bin/|${PREFIX}/bin/|' ${WRKSRC}/Makefile .endif
Each port is extracted into a working directory, which must
be writable. The ports system defaults to having
DISTFILES
unpack in to a directory called
${DISTNAME}
. In other words, if the
Makefile
has:
PORTNAME= foo DISTVERSION= 1.0
then the port's distribution files contain a top-level
directory, foo-1.0
, and the rest of the
files are located under that directory.
A number of variables can be overridden if that is not the case.
The variable lists the name of the directory that is
created when the application's distfiles are extracted. If
our previous example extracted into a directory called
foo
(and not
foo-1.0
) write:
WRKSRC= ${WRKDIR}/foo
or possibly
WRKSRC= ${WRKDIR}/${PORTNAME}
If the source files needed for the port are in a
subdirectory of the extracted distribution file, set
WRKSRC_SUBDIR
to that directory.
WRKSRC_SUBDIR= src
If the port does not extract in to a subdirectory at all,
then set NO_WRKSUBDIR
to
indicate that.
NO_WRKSUBDIR= yes
Because WRKDIR
is the only directory
that is supposed to be writable during the build, and is
used to store many files recording the status of the build,
the port's extraction will be forced into a
subdirectory.
There are three different variables to register a conflict
between packages and ports: CONFLICTS
,
CONFLICTS_INSTALL
and
CONFLICTS_BUILD
.
The conflict variables automatically set the variable
IGNORE
, which is more fully documented in
Section 13.13, “Marking a Port Not Installable with
BROKEN
, FORBIDDEN
, or
IGNORE
”.
When removing one of several conflicting ports, it is
advisable to retain CONFLICTS
in
those other ports for a few months to cater for users who only
update once in a while.
CONFLICTS_INSTALL
If the package cannot coexist with other
packages (because of file conflicts, runtime
incompatibilities, etc.).
CONFLICTS_INSTALL
check is done after the
build stage and prior to the install stage.
CONFLICTS_BUILD
If the port cannot be built when other specific ports are already installed. Build conflicts are not recorded in the resulting package.
CONFLICTS
If the port cannot be built if a certain port is
already installed and the resulting package cannot coexist
with the other package. CONFLICTS
check is done prior to the build stage and prior to the
install stage.
The most common content of one of these variable is the
package base of another port. The package base is the package
name without the appended version, it can be obtained by running
make -V PKGBASE
.
CONFLICTS*
dns/bind99 cannot be installed if dns/bind910 is present because they install same files. First gather the package base to use:
%
make -C dns/bind99 -V PKGBASE
bind99%
make -C dns/bind910 -V PKGBASE
bind910
Then add to the Makefile
of dns/bind99:
CONFLICTS_INSTALL= bind910
And add to the Makefile
of dns/bind910:
CONFLICTS_INSTALL= bind99
Sometime, only some version of another port is incompatible,
in this case, use the full package name, with the version, and
use shell globs, like *
and
?
to make sure all possible versions are
matched.
CONFLICTS*
With Globs.From versions from 2.0 and up-to 2.4.1_2, deskutils/gnotime used to install a bundled version of databases/qof.
To reflect this past, the Makefile
of
databases/qof contains:
CONFLICTS_INSTALL= gnotime-2.[0-3]* \ gnotime-2.4.0* gnotime-2.4.1 \ gnotime-2.4.1_[12]
The first entry match versions 2.0
through 2.3
, the second all the revisions
of 2.4.0
, the third the exact
2.4.1
version, and the last the first and
second revisions of the 2.4.1
version.
deskutils/gnotime does not have any conflicts line because its current version does not conflict with anything else.
The install
phase is very
important to the end user because it
adds files to their system. All the additional commands run
in the port Makefile
's
*-install
targets should be
echoed to the screen. Do not silence
these commands with
@
or .SILENT
.
Use the macros provided in
bsd.port.mk
to ensure correct modes of
files in the port's *-install
targets. Set ownership directly in
pkg-plist
with the corresponding entries,
such as
@(
,
owner
,group
,)@owner
,
and owner
@group
.
These operators work until overridden, or until the end
of group
pkg-plist
, so remember to reset
them after they are no longer needed. The default ownership
is root:wheel
. See Section 8.6.13, “Base Keywords” for more information.
INSTALL_PROGRAM
is a command to
install binary executables.
INSTALL_SCRIPT
is a command to
install executable scripts.
INSTALL_LIB
is a command to install
shared libraries (but not static libraries).
INSTALL_KLD
is a command to
install kernel loadable modules. Some architectures
do not like having the modules stripped, so
use this command instead of
INSTALL_PROGRAM
.
INSTALL_DATA
is a command to
install sharable data, including static libraries.
INSTALL_MAN
is a command to
install manpages and other documentation (it does not
compress anything).
These variables are set to the install(1) command with the appropriate flags for each situation.
Do not use INSTALL_LIB
to install
static libraries, because stripping them renders them
useless. Use INSTALL_DATA
instead.
Installed binaries should be stripped. Do not strip
binaries manually unless absolutely required. The
INSTALL_PROGRAM
macro installs and
strips a binary at the same time. The
INSTALL_LIB
macro does the same thing to
shared libraries.
When a file must be stripped, but neither
INSTALL_PROGRAM
nor
INSTALL_LIB
macros are desirable,
${STRIP_CMD}
strips the program or
shared library. This is typically done within the
post-install
target. For
example:
post-install: ${STRIP_CMD} ${STAGEDIR}${PREFIX}/bin/xdl
When multiple files need to be stripped:
post-install: .for l in geometry media body track world ${STRIP_CMD} ${STAGEDIR}${PREFIX}/lib/lib${PORTNAME}-${l}.so.0 .endfor
Use file(1) on a file to determine if it has been
stripped. Binaries are reported by file(1) as
stripped
, or
not stripped
. Additionally, strip(1)
will detect programs that have already been stripped and exit
cleanly.
When WITH_DEBUG
is defined, elf files
must not be stripped.
The variables (STRIP_CMD
,
INSTALL_PROGRAM
,
INSTALL_LIB
, ...) and USES
provided by the framework
handle this automatically.
Some software, add -s
to their
LDFLAGS
, in this case, either remove
-s
if WITH_DEBUG
is
set, or remove it unconditionally and use
STRIP_CMD
in
post-install
.
Sometimes, a large number of files must be installed while
preserving their hierarchical organization. For example,
copying over a whole directory tree from
WRKSRC
to a target directory under
PREFIX
. Note that
PREFIX
, EXAMPLESDIR
,
DATADIR
, and other path variables must
always be prepended with STAGEDIR
to
respect staging (see Section 6.1, “Staging”).
Two macros exist for this situation. The advantage of
using these macros instead of cp
is that
they guarantee proper file ownership and permissions on target
files. The first macro, COPYTREE_BIN
, will
set all the installed files to be executable, thus being
suitable for installing into PREFIX/bin
.
The second macro, COPYTREE_SHARE
, does not
set executable permissions on files, and is therefore suitable
for installing files under PREFIX/share
target.
post-install: ${MKDIR} ${STAGEDIR}${EXAMPLESDIR} (cd ${WRKSRC}/examples && ${COPYTREE_SHARE} . ${STAGEDIR}${EXAMPLESDIR})
This example will install the contents of the
examples
directory in the vendor distfile
to the proper examples location of the port.
post-install: ${MKDIR} ${STAGEDIR}${DATADIR}/summer (cd ${WRKSRC}/temperatures && ${COPYTREE_SHARE} "June July August" ${STAGEDIR}${DATADIR}/summer)
And this example will install the data of summer months to
the summer
subdirectory of a
DATADIR
.
Additional find
arguments can be
passed via the third argument to
COPYTREE_
macros. For example, to install
all files from the first example except Makefiles, one can use
these commands.*
post-install: ${MKDIR} ${STAGEDIR}${EXAMPLESDIR} (cd ${WRKSRC}/examples && \ ${COPYTREE_SHARE} . ${STAGEDIR}${EXAMPLESDIR} "! -name Makefile")
These macros do not add the installed files to
pkg-plist
. They must be added manually.
For optional documentation (PORTDOCS
, see
Section 5.16.4, “Install Additional Documentation”) and examples
(PORTEXAMPLES
), the
%%PORTDOCS%%
or
%%PORTEXAMPLES%%
prefixes must be prepended
in pkg-plist
.
If the software has some documentation other than the
standard man and info pages that is useful for the
user, install it under DOCSDIR
This can be done, like the previous item, in the
post-install
target.
Create a new directory for the port. The directory name
is DOCSDIR
. This usually equals
PORTNAME
. However, if the user
might want different versions of the port to be installed at
the same time, the whole
PKGNAME
can be used.
Since only the files listed in
pkg-plist
are installed, it is safe to
always install documentation to STAGEDIR
(see Section 6.1, “Staging”). Hence .if
blocks are only needed when the installed files are large
enough to cause significant I/O overhead.
post-install: ${MKDIR} ${STAGEDIR}${DOCSDIR} ${INSTALL_MAN} ${WRKSRC}/docs/xvdocs.ps ${STAGEDIR}${DOCSDIR}
On the other hand, if there is a DOCS option in the port,
install the documentation in a
post-install-DOCS-on
target. These
targets are described in Section 5.13.3.12, “Additional Build Targets,
and
target
-OPT
-on
”.target
-OPT
-off
Here are some handy variables and how they are expanded by
default when used in the Makefile
:
DATADIR
gets expanded to
PREFIX/share/PORTNAME
.
DATADIR_REL
gets expanded to
share/PORTNAME
.
DOCSDIR
gets expanded to
PREFIX/share/doc/PORTNAME
.
DOCSDIR_REL
gets expanded to
share/doc/PORTNAME
.
EXAMPLESDIR
gets expanded to
PREFIX/share/examples/PORTNAME
.
EXAMPLESDIR_REL
gets expanded to
share/examples/PORTNAME
.
The DOCS
option only controls
additional documentation installed in
DOCSDIR
. It does not apply to standard
man pages and info pages. Things installed in
EXAMPLESDIR
are controlled by
the EXAMPLES
option.
These variables are exported to
PLIST_SUB
. Their values will appear there
as pathnames relative to PREFIX
if
possible. That is, share/doc/PORTNAME
will be substituted for %%DOCSDIR%%
in the
packing list by default, and so on. (See more on
pkg-plist
substitution
here.)
All conditionally installed documentation files and
directories are included in
pkg-plist
with the
%%PORTDOCS%%
prefix, for example:
%%PORTDOCS%%%%DOCSDIR%%/AUTHORS %%PORTDOCS%%%%DOCSDIR%%/CONTACT
As an alternative to enumerating the documentation files
in pkg-plist
, a port can set the variable
PORTDOCS
to a list of file names and shell
glob patterns to add to the final packing list. The names
will be relative to DOCSDIR
. Therefore, a
port that utilizes PORTDOCS
, and uses a
non-default location for its documentation, must set
DOCSDIR
accordingly. If a directory is
listed in PORTDOCS
or matched by a glob
pattern from this variable, the entire subtree of contained
files and directories will be registered in the final packing
list. If the DOCS
option has been unset
then files and directories listed in
PORTDOCS
would not be installed or added to
port packing list. Installing the documentation at
PORTDOCS
as shown above remains up to the
port itself. A typical example of utilizing
PORTDOCS
:
PORTDOCS= README.* ChangeLog docs/*
The equivalents of PORTDOCS
for files
installed under DATADIR
and
EXAMPLESDIR
are
PORTDATA
and
PORTEXAMPLES
, respectively.
The contents of pkg-message
are
displayed upon installation. See
the section on using
pkg-message
for details.
pkg-message
does not need to be added
to pkg-plist
.
Try to let the port put things in the right subdirectories
of PREFIX
. Some ports lump everything and
put it in the subdirectory with the port's name, which is
incorrect. Also, many ports put everything except binaries,
header files and manual pages in a subdirectory of
lib
, which does not work well with the
BSD paradigm. Many of the files must be moved to one of these
directories: etc
(setup/configuration
files), libexec
(executables started
internally), sbin
(executables for
superusers/managers), info
(documentation
for info browser) or share
(architecture
independent files). See hier(7) for details; the rules
governing /usr
pretty much apply to
/usr/local
too. The exception are ports
dealing with USENET “news”. They may use
PREFIX/news
as a destination for their
files.
When BINARY_ALIAS
is defined it will
create symlinks of the given commands in a directory which
will be prepended to PATH
.
Use it to substitute hardcoded commands the build phase relies on without having to patch any build files.
BINARY_ALIAS
to Make
gsed
Available as
sed
Some ports expect sed
to behave like
GNU sed and use features that
sed(1) does not provide.
GNU sed is available from
textproc/gsed on FreeBSD.
Use BINARY_ALIAS
to substitute
sed
with gsed
for the duration of the build:
BUILD_DEPENDS= gsed:textproc/gsed ... BINARY_ALIAS= sed=gsed
BINARY_ALIAS
to Provide Aliases
for Hardcoded python3
CommandsA port that has a hardcoded reference to
python3
in its build scripts will need
to have it available in PATH
at build
time. Use BINARY_ALIAS
to create an alias
that points to the right Python 3 binary:
USES= python:3.4+,build ... BINARY_ALIAS= python3=${PYTHON_CMD}
See Section 6.17, “Using Python” for more information
about USES=python
.
Binary aliases are created after the dependencies
provided via BUILD_DEPENDS
and
LIB_DEPENDS
are processed and before the
configure
target. This leads
to various limitations. For example, programs installed via
TEST_DEPENDS
cannot be used to create
a binary alias as test dependencies specified this way
are processed after binary aliases are created.
gettext
iconv
rc
Scripts)This section explains the most common things to consider when creating a port.
bsd.port.mk
expects ports to work
with a “stage directory”. This means that a port
must not install files directly to the regular destination
directories (that is, under PREFIX
, for
example) but instead into a separate directory from which the
package is then built. In many cases, this does not require
root privileges, making it possible to build packages as an
unprivileged user. With staging, the port is built and
installed into the stage directory,
STAGEDIR
. A package is created from the
stage directory and then installed on the system. Automake
tools refer to this concept as DESTDIR
, but
in FreeBSD, DESTDIR
has a different meaning
(see Section 10.4, “PREFIX
and
DESTDIR
”).
No port really needs to be root. It
can mostly be avoided by using USES=uidfix
.
If the port still runs commands like chown(8),
chgrp(1), or forces owner or group with install(1)
then use USES=fakeroot
to fake those calls. Some patching of the port's
Makefiles
will be needed.
Meta ports, or ports that do not install files themselves but only depend on other ports, must avoid needlessly extracting the mtree(8) to the stage directory. This is the basic directory layout of the package, and these empty directories will be seen as orphans. To prevent mtree(8) extraction, add this line:
NO_MTREE= yes
Metaports should use USES=metaport
.
It sets up defaults for ports that do not fetch, build, or
install anything.
Staging is enabled by prepending
STAGEDIR
to paths used in the
pre-install
,
do-install
, and
post-install
targets (see the
examples through the book). Typically, this includes
PREFIX
, ETCDIR
,
DATADIR
, EXAMPLESDIR
,
MANPREFIX
, DOCSDIR
, and
so on. Directories should be created as part of the
post-install
target. Avoid using
absolute paths whenever possible.
Ports that install kernel modules must prepend
STAGEDIR
to their destination, by default
/boot/modules
.
When creating a symbolic link, relative ones are strongly
recommended. Use ${RLN}
to create relative
symbolic links. It uses install(1) under the hood to
automatically figure out the relative link to create.
${RLN}
uses install(1)'s
relative symbolic feature which frees the porter of
computing the relative path.
${RLN} ${STAGEDIR}${PREFIX}/lib/libfoo.so.42
${STAGEDIR}${PREFIX}/lib/libfoo.so
${RLN} ${STAGEDIR}${PREFIX}/libexec/foo/bar
${STAGEDIR}${PREFIX}/bin/bar
${RLN} ${STAGEDIR}/var/cache/foo
${STAGEDIR}${PREFIX}/share/foo
Will generate:
%
ls -lF ${STAGEDIR}${PREFIX}/lib
lrwxr-xr-x 1 nobody nobody 181 Aug 3 11:27 libfoo.so@ -> libfoo.so.42 -rwxr-xr-x 1 nobody nobody 15 Aug 3 11:24 libfoo.so.42*%
ls -lF ${STAGEDIR}${PREFIX}/bin
lrwxr-xr-x 1 nobody nobody 181 Aug 3 11:27 bar@ -> ../libexec/foo/bar%
ls -lF ${STAGEDIRDIR}${PREFIX}/share
lrwxr-xr-x 1 nobody nobody 181 Aug 3 11:27 foo@ -> ../../../var/cache/foo
This section explains why bundled dependencies are considered bad and what to do about them.
Some software requires the porter to locate third-party libraries and add the required dependencies to the port. Other software bundles all necessary libraries into the distribution file. The second approach seems easier at first, but there are some serious drawbacks:
This list is loosely based on the Fedora and Gentoo wikis, both licensed under the CC-BY-SA 3.0 license.
If vulnerabilities are found in the upstream library and fixed there, they might not be fixed in the library bundled with the port. One reason could be that the author is not aware of the problem. This means that the porter must fix them, or upgrade to a non-vulnerable version, and send a patch to the author. This all takes time, which results in software being vulnerable longer than necessary. This in turn makes it harder to coordinate a fix without unnecessarily leaking information about the vulnerability.
This problem is similar to the problem with security in the last paragraph, but generally less severe.
It is easier for the author to fork the upstream library once it is bundled. While convenient on first sight, it means that the code diverges from upstream making it harder to address security or other problems with the software. A reason for this is that patching becomes harder.
Another problem of forking is that because code diverges from upstream, bugs get solved over and over again instead of just once at a central location. This defeats the idea of open source software in the first place.
When a library is installed on the system, it might collide with the bundled version. This can cause immediate errors at compile or link time. It can also cause errors when running the program which might be harder to track down. The latter problem could be caused because the versions of the two libraries are incompatible.
When bundling projects from different sources, license issues can arise more easily, especially when licenses are incompatible.
Bundled libraries waste resources on several levels. It takes longer to build the actual application, especially if these libraries are already present on the system. At run-time, they can take up unnecessary memory when the system-wide library is already loaded by one program and the bundled library is loaded by another program.
When a library needs patches for FreeBSD, these patches have to be duplicated again in the bundled library. This wastes developer time because the patches might not apply cleanly. It can also be hard to notice that these patches are required in the first place.
Whenever possible, use the unbundled version of the
library by adding a LIB_DEPENDS
to the
port. If such a port does not exist yet, consider creating
it.
Only use bundled libraries if the upstream has a good track record on security and using unbundled versions leads to overly complex patches.
In some very special cases, for example emulators, like
Wine, a port has to bundle
libraries, because they are in a different architecture, or
they have been modified to fit the software's use. In that
case, those libraries should not be exposed to other ports
for linking. Add BUNDLE_LIBS=yes
to the
port's Makefile
. This will tell
pkg(8) to not compute provided libraries. Always ask
the Ports Management Team <portmgr@FreeBSD.org>
before adding this to a port.
If the port installs one or more shared libraries, define
a USE_LDCONFIG
make variable, which will
instruct a bsd.port.mk
to run
${LDCONFIG} -m
on the directory
where the new library is installed (usually
PREFIX/lib
) during
post-install
target to register it
into the shared library cache. This variable, when defined,
will also facilitate addition of an appropriate
@exec /sbin/ldconfig -m
and
@unexec /sbin/ldconfig -R
pair into
pkg-plist
, so that a user who
installed the package can start using the shared library
immediately and de-installation will not cause the system to
still believe the library is there.
USE_LDCONFIG= yes
The default directory can be overridden by
setting USE_LDCONFIG
to a list of
directories into which shared libraries are to be installed.
For example, if the port installs shared libraries into
PREFIX/lib/foo
and
PREFIX/lib/bar
use this in
Makefile
:
USE_LDCONFIG= ${PREFIX}/lib/foo ${PREFIX}/lib/bar
Please double-check, often this is not necessary at all or
can be avoided through -rpath
or setting
LD_RUN_PATH
during linking (see
lang/mosml for an
example), or through a shell-wrapper which sets
LD_LIBRARY_PATH
before invoking the binary,
like www/seamonkey
does.
When installing 32-bit libraries on 64-bit system, use
USE_LDCONFIG32
instead.
If the software uses autotools, and specifically
libtool
, add USES=libtool
.
When the major library version number increments in the
update to the new port version, all other ports that link to
the affected library must have their
PORTREVISION
incremented, to force
recompilation with the new library version.
Licenses vary, and some of them place restrictions on how the application can be packaged, whether it can be sold for profit, and so on.
It is the responsibility of a porter to read the licensing terms of the software and make sure that the FreeBSD project will not be held accountable for violating them by redistributing the source or compiled binaries either via FTP/HTTP or CD-ROM. If in doubt, please contact the FreeBSD ports mailing list.
In situations like this, the variables described in the next sections can be set.
This variable indicates that we may not generate a binary package of the application. For instance, the license may disallow binary redistribution, or it may prohibit distribution of packages created from patched sources.
However, the port's DISTFILES
may be
freely mirrored on FTP/HTTP. They may also be distributed
on a CD-ROM (or similar media) unless
NO_CDROM
is set as well.
If the
binary package is not generally useful, and the application
must always be compiled from the source code, use
NO_PACKAGE
. For
example, if the application has configuration information
that is site specific hard coded into it at compile time,
set NO_PACKAGE
.
Set NO_PACKAGE
to a string
describing the reason why the package cannot be
generated.
This variable alone indicates that, although we are
allowed to generate binary packages, we may put neither
those packages nor the port's DISTFILES
onto a CD-ROM (or similar media) for resale. However, the
binary packages and the port's DISTFILES
will still be available via FTP/HTTP.
If this variable is set along with
NO_PACKAGE
, then only the port's
DISTFILES
will be available, and only via
FTP/HTTP.
Set NO_CDROM
to a string
describing the reason why the port cannot be redistributed
on CD-ROM. For instance, use this if the port's
license is for “non-commercial” use
only.
Files defined in NOFETCHFILES
are not fetchable from any of
MASTER_SITES
. An example of such a file
is when the file is supplied on CD-ROM by the vendor.
Tools which check for the availability of these files
on MASTER_SITES
have to ignore these
files and not report about them.
Set this variable alone if the application's license
permits neither mirroring the application's
DISTFILES
nor distributing the binary
package in any way.
Do not set NO_CDROM
or
NO_PACKAGE
along with
RESTRICTED
, since the latter variable
implies the former ones.
Set RESTRICTED
to a string
describing the reason why the port cannot be redistributed.
Typically, this indicates that the port contains proprietary
software and that the user will need to manually download
the DISTFILES
, possibly after registering
for the software or agreeing to accept the terms of an
EULA.
When RESTRICTED
or
NO_CDROM
is set, this variable defaults
to ${DISTFILES} ${PATCHFILES}
, otherwise
it is empty. If only some of the distribution files are
restricted, then set this variable to list them.
If the port has legal concerns not addressed by the
above variables, set LEGAL_TEXT
to a string explaining the concern. For
example, if special permission was obtained for FreeBSD to
redistribute the binary, this variable must indicate
so.
A port which sets any of the above variables must also
be added to /usr/ports/LEGAL
. The
first column is a glob which matches the restricted
distfiles. The second column is the port's origin. The
third column is the output of
make -VLEGAL
.
The preferred way to state "the distfiles for this port must be fetched manually" is as follows:
.if !exists(${DISTDIR}/${DISTNAME}${EXTRACT_SUFX})
IGNORE= may not be redistributed because of licensing reasons. Please visit some-website
to accept their license and download ${DISTFILES} into ${DISTDIR}
.endif
This both informs the user, and sets the proper metadata on the user's machine for use by automated programs.
Note that this stanza must be preceded by an inclusion
of bsd.port.pre.mk
.
The FreeBSD ports framework supports parallel building
using multiple make
sub-processes, which
allows SMP systems to utilize all of
their available CPU power, allowing port
builds to be faster and more effective.
This is achieved by passing -jX
flag
to make(1) running on vendor code. This is the default
build behavior of ports. Unfortunately, not all ports
handle parallel building well and it may be required to
explicitly disable this feature by adding the
MAKE_JOBS_UNSAFE=yes
variable. It is
used when a port is known to be broken with
-jX
due to race conditions causing
intermittent build failures.
When setting MAKE_JOBS_UNSAFE
, it
is very important to explain either with a comment in the
Makefile
, or at least in the commit
message, why the port does not build
when enabling. Otherwise, it is almost impossible to
either fix the problem, or test if it has been fixed when
committing an update at a later date.
Several differing make
implementations exist. Ported software often requires a
particular implementation, like GNU
make
, known in FreeBSD as
gmake
.
If the port uses GNU make,
add gmake
to
USES
.
MAKE_CMD
can be used to reference the
specific command configured by the USES
setting in the port's Makefile
.
Only use MAKE_CMD
within the
application Makefile
s in
WRKSRC
to call the
make
implementation expected by the
ported software.
If the port is an X application that uses
imake to create
Makefile
s from
Imakefile
s, set USES=
imake
.. See the USES=imake
section of Chapter 17, Using USES
Macros for more details.
If the port's source Makefile
has
something other than all
as the
main build target, set ALL_TARGET
accordingly. The same goes for
install
and
INSTALL_TARGET
.
If the port uses the configure
script to generate Makefile
from
Makefile.in
, set
GNU_CONFIGURE=yes
. To give
extra arguments to the configure
script
(the default argument is --prefix=${PREFIX}
--infodir=${PREFIX}/${INFO_PATH}
--mandir=${MANPREFIX}/man
--build=${CONFIGURE_TARGET}
), set those
extra arguments in CONFIGURE_ARGS
. Extra
environment variables can be passed using
CONFIGURE_ENV
.
configure
Variable | Means |
---|---|
GNU_CONFIGURE | The port uses configure
script to prepare build. |
HAS_CONFIGURE | Same as GNU_CONFIGURE ,
except default configure target is not added to
CONFIGURE_ARGS . |
CONFIGURE_ARGS | Additional arguments passed to
configure script. |
CONFIGURE_ENV | Additional environment variables to be set
for configure script run. |
CONFIGURE_TARGET | Override default configure target. Default
value is
${MACHINE_ARCH}-portbld-freebsd${OSREL} . |
For ports that use CMake,
define USES= cmake
.
cmake
Variable | Means |
---|---|
CMAKE_ARGS | Port specific CMake
flags to be passed to the cmake
binary. |
CMAKE_ON | For each entry in CMAKE_ON , an
enabled boolean value is added to
CMAKE_ARGS . See Example 6.3, “CMAKE_ON and
CMAKE_OFF ”. |
CMAKE_OFF | For each entry in CMAKE_OFF , a
disabled boolean value is added to
CMAKE_ARGS . See Example 6.3, “CMAKE_ON and
CMAKE_OFF ”. |
CMAKE_BUILD_TYPE | Type of build (CMake
predefined build profiles). Default is
Release , or
Debug if
WITH_DEBUG is set. |
CMAKE_SOURCE_PATH | Path to the source directory. Default is
${WRKSRC} . |
CONFIGURE_ENV | Additional environment variables to be set for
the cmake binary. |
cmake
BuildsVariable | Means |
---|---|
CMAKE_NOCOLOR | Disables color build output. Default not set,
unless BATCH or
PACKAGE_BUILDING are set. |
CMake supports these
build profiles: Debug
,
Release
,
RelWithDebInfo
and
MinSizeRel
. Debug
and
Release
profiles respect system
*FLAGS
, RelWithDebInfo
and MinSizeRel
will set
CFLAGS
to -O2 -g
and
-Os -DNDEBUG
correspondingly. The
lower-cased value of CMAKE_BUILD_TYPE
is
exported to PLIST_SUB
and must be
used if the port installs
depending on the build type (see
devel/kf5-kcrash for an
example). Please note that some projects may define their own
build profiles and/or force particular build type by setting
*
.cmakeCMAKE_BUILD_TYPE
in
CMakeLists.txt
. To make a port for such
a project respect CFLAGS
and
WITH_DEBUG
, the
CMAKE_BUILD_TYPE
definitions must be
removed from those files.
Most CMake-based projects
support an out-of-source method of building. The
out-of-source build for a port is the default setting.
An in-source build can be requested by using the
:insource
suffix. With out-of-source
builds, CONFIGURE_WRKSRC
,
BUILD_WRKSRC
and
INSTALL_WRKSRC
will be set to
${WRKDIR}/.build
and this
directory will be used to keep all files generated during
configuration and build stages, leaving the source directory
intact.
USES= cmake
ExampleThis snippet demonstrates the use of
CMake for a port.
CMAKE_SOURCE_PATH
is not usually
required, but can be set when the sources are not located
in the top directory, or if only a subset of the project
is intended to be built by the port.
USES= cmake CMAKE_SOURCE_PATH= ${WRKSRC}/subproject
CMAKE_ON
and
CMAKE_OFF
When adding boolean values to
CMAKE_ARGS
, it is easier to use the
CMAKE_ON
and CMAKE_OFF
variables instead. This:
CMAKE_ON= VAR1 VAR2 CMAKE_OFF= VAR3
Is equivalent to:
CMAKE_ARGS= -DVAR1:BOOL=TRUE -DVAR2:BOOL=TRUE -DVAR3:BOOL=FALSE
This is only for the default values off
CMAKE_ARGS
. The helpers described in
Section 5.13.3.4.2, “
and
OPT
_CMAKE_BOOL
” use the same
semantics, but for optional values.OPT
_CMAKE_BOOL_OFF
If the port uses SCons,
define USES=scons
.
To make third party SConstruct
respect everything that is passed to SCons in
the environment (that is, most importantly,
CC/CXX/CFLAGS/CXXFLAGS
), patch
SConstruct
so build
Environment
is constructed like
this:
env = Environment(**ARGUMENTS)
It may be then modified with
env.Append
and
env.Replace
.
For ports that use Cargo,
define USES=cargo
.
cargo
BuildsVariable | Default | Description |
---|---|---|
CARGO_CRATES | List of crates the port depends on. Each entry
needs to have a format like
cratename-semver for example,
libc-0.2.40 . Port maintainers can
generate this list from
Cargo.lock using
make cargo-crates . Manually
bumping crate versions is possible but be mindful of
transitive dependencies. | |
CARGO_FEATURES | List of application features to build (space
separated list). To deactivate all default
features add the special token
--no-default-features
to CARGO_FEATURES . Manually
passing it to CARGO_BUILD_ARGS ,
CARGO_INSTALL_ARGS , and
CARGO_TEST_ARGS is not
needed. | |
CARGO_CARGOTOML | ${WRKSRC}/Cargo.toml | The path to the Cargo.toml
to use. |
CARGO_CARGOLOCK | ${WRKSRC}/Cargo.lock | The path to the Cargo.lock
to use for make cargo-crates . It
is possible to specify more than one lock file when
necessary. |
CARGO_ENV | A list of environment variables to pass to Cargo
similar to MAKE_ENV . | |
RUSTFLAGS | Flags to pass to the Rust compiler. | |
CARGO_CONFIGURE | yes | Use the default
do-configure . |
CARGO_UPDATE_ARGS | Extra arguments to pass to Cargo during the
configure phase. Valid arguments can be looked up
with cargo update --help . | |
CARGO_BUILDDEP | yes | Add a build dependency on lang/rust. |
CARGO_CARGO_BIN | ${LOCALBASE}/bin/cargo | Location of the cargo
binary. |
CARGO_BUILD | yes | Use the default
do-build . |
CARGO_BUILD_ARGS | Extra arguments to pass to Cargo during the
build phase. Valid arguments can be looked up with
cargo build --help . | |
CARGO_INSTALL | yes | Use the default
do-install . |
CARGO_INSTALL_ARGS | Extra arguments to pass to Cargo during the
install phase. Valid arguments can be looked up with
cargo install --help . | |
CARGO_INSTALL_PATH | . | Path to the crate to install. This is passed
to cargo install via its
--path argument. When multiple
paths are specified cargo install
is run multiple times. |
CARGO_TEST | yes | Use the default
do-test . |
CARGO_TEST_ARGS | Extra arguments to pass to Cargo during the test
phase. Valid arguments can be looked up with
cargo test --help . | |
CARGO_TARGET_DIR | ${WRKDIR}/target | Location of the cargo output directory. |
CARGO_DIST_SUBDIR | rust/crates | Directory relative to DISTDIR
where the crate distribution files will be
stored. |
CARGO_VENDOR_DIR | ${WRKSRC}/cargo-crates | Location of the vendor directory where
all crates will be extracted to. Try to keep this
under PATCH_WRKSRC , so that
patches can be applied easily. |
CARGO_USE_GITHUB | no | Enable fetching of crates locked to specific Git
commits on GitHub via GH_TUPLE .
This will try to patch all
Cargo.toml under
WRKDIR to point to the
offline sources instead of fetching them from a
Git repository during the build. |
CARGO_USE_GITLAB | no | Same as CARGO_USE_GITHUB
but for GitLab instances and
GL_TUPLE . |
Creating a Cargo based port is a three stage process. First we need to provide a ports template that fetches the application distribution file:
PORTNAME= tokei DISTVERSIONPREFIX= v DISTVERSION= 7.0.2 CATEGORIES= devel MAINTAINER= tobik@FreeBSD.org COMMENT= Display statistics about your code USES= cargo USE_GITHUB= yes GH_ACCOUNT= Aaronepower .include <bsd.port.mk>
Generate an initial
distinfo
:
%
make makesum
=> Aaronepower-tokei-v7.0.2_GH0.tar.gz doesn't seem to exist in /usr/ports/distfiles/. => Attempting to fetch https://codeload.github.com/Aaronepower/tokei/tar.gz/v7.0.2?dummy=/Aaronepower-tokei-v7.0.2_GH0.tar.gz fetch: https://codeload.github.com/Aaronepower/tokei/tar.gz/v7.0.2?dummy=/Aaronepower-tokei-v7.0.2_GH0.tar.gz: size of remote file is not known Aaronepower-tokei-v7.0.2_GH0.tar.gz 45 kB 239 kBps 00m00s
Now the distribution file is ready to use and we can go
ahead and extract crate dependencies from the bundled
Cargo.lock
:
%
make cargo-crates
CARGO_CRATES= aho-corasick-0.6.4 \ ansi_term-0.11.0 \ arrayvec-0.4.7 \ atty-0.2.9 \ bitflags-1.0.1 \ byteorder-1.2.2 \ [...]
The output of this command needs to be pasted directly into the Makefile:
PORTNAME= tokei DISTVERSIONPREFIX= v DISTVERSION= 7.0.2 CATEGORIES= devel MAINTAINER= tobik@FreeBSD.org COMMENT= Display statistics about your code USES= cargo USE_GITHUB= yes GH_ACCOUNT= Aaronepower CARGO_CRATES= aho-corasick-0.6.4 \ ansi_term-0.11.0 \ arrayvec-0.4.7 \ atty-0.2.9 \ bitflags-1.0.1 \ byteorder-1.2.2 \ [...] .include <bsd.port.mk>
distinfo
needs to be regenerated to
contain all the crate distribution files:
%
make makesum
=> rust/crates/aho-corasick-0.6.4.tar.gz doesn't seem to exist in /usr/ports/distfiles/. => Attempting to fetch https://crates.io/api/v1/crates/aho-corasick/0.6.4/download?dummy=/rust/crates/aho-corasick-0.6.4.tar.gz rust/crates/aho-corasick-0.6.4.tar.gz 100% of 24 kB 6139 kBps 00m00s => rust/crates/ansi_term-0.11.0.tar.gz doesn't seem to exist in /usr/ports/distfiles/. => Attempting to fetch https://crates.io/api/v1/crates/ansi_term/0.11.0/download?dummy=/rust/crates/ansi_term-0.11.0.tar.gz rust/crates/ansi_term-0.11.0.tar.gz 100% of 16 kB 21 MBps 00m00s => rust/crates/arrayvec-0.4.7.tar.gz doesn't seem to exist in /usr/ports/distfiles/. => Attempting to fetch https://crates.io/api/v1/crates/arrayvec/0.4.7/download?dummy=/rust/crates/arrayvec-0.4.7.tar.gz rust/crates/arrayvec-0.4.7.tar.gz 100% of 22 kB 3237 kBps 00m00s => rust/crates/atty-0.2.9.tar.gz doesn't seem to exist in /usr/ports/distfiles/. => Attempting to fetch https://crates.io/api/v1/crates/atty/0.2.9/download?dummy=/rust/crates/atty-0.2.9.tar.gz rust/crates/atty-0.2.9.tar.gz 100% of 5898 B 81 MBps 00m00s => rust/crates/bitflags-1.0.1.tar.gz doesn't seem to exist in /usr/ports/distfiles/. [...]
The port is now ready for a test build and further adjustments like creating a plist, writing a description, adding license information, options, etc. as normal.
If you are not testing your port in a clean environment
like with Poudriere, remember to
run make clean
before any testing.
Some applications define additional features in their
Cargo.toml
. They can be compiled in
by setting CARGO_FEATURES
in the
port.
Here we enable Tokei's json
and
yaml
features:
CARGO_FEATURES= json yaml
An example [features]
section
in Cargo.toml
could look like
this:
[features] pulseaudio_backend = ["librespot-playback/pulseaudio-backend"] portaudio_backend = ["librespot-playback/portaudio-backend"] default = ["pulseaudio_backend"]
pulseaudio_backend
is a default
feature. It is always enabled unless we explicitly turn
off default features by adding
--no-default-features
to
CARGO_FEATURES
. Here we turn the
portaudio_backend
and pulseaudio_backend
features into
port options:
CARGO_FEATURES= --no-default-features OPTIONS_DEFINE= PORTAUDIO PULSEAUDIO PORTAUDIO_VARS= CARGO_FEATURES+=portaudio_backend PULSEAUDIO_VARS= CARGO_FEATURES+=pulseaudio_backend
Crates have their own licenses. It is important to
know what they are when adding a LICENSE
block to the port (see Section 5.7, “Licenses”). The
helper target
cargo-crates-licenses
will try
to list all the licenses of all crates defined in
CARGO_CRATES
.
%
make cargo-crates-licenses
aho-corasick-0.6.4 Unlicense/MIT ansi_term-0.11.0 MIT arrayvec-0.4.7 MIT/Apache-2.0 atty-0.2.9 MIT bitflags-1.0.1 MIT/Apache-2.0 byteorder-1.2.2 Unlicense/MIT [...]
The license names
make cargo-crates-licenses
outputs are
SPDX 2.1 licenses expression which do not match the
license names defined in the ports framework. They need
to be translated to the names from
Table 5.7, “Predefined License List”.
For ports that use Meson,
define USES=meson
.
meson
Variable | Description |
---|---|
MESON_ARGS | Port specific Meson
flags to be passed to the meson
binary. |
MESON_BUILD_DIR | Path to the build directory relative to
WRKSRC . Default is
_build . |
USES=meson
ExampleThis snippet demonstrates the use of Meson for a port.
USES= meson MESON_ARGS= -Dfoo=enabled
For ports that use Go,
define USES=go
. Refer to Section 17.35, “go
” for a list of variables that can be
set to control the build process.
Creating a Go based port is a five stage process. First we need to provide a ports template that fetches the application distribution file:
PORTNAME= ghq DISTVERSIONPREFIX= v DISTVERSION= 0.12.5 CATEGORIES= devel MAINTAINER= tobik@FreeBSD.org COMMENT= Remote repository management made easy USES= go:modules USE_GITHUB= yes GH_ACCOUNT= motemen .include <bsd.port.mk>
Generate an initial
distinfo
:
%
make makesum
===> License MIT accepted by the user => motemen-ghq-v0.12.5_GH0.tar.gz doesn't seem to exist in /usr/ports/distfiles/. => Attempting to fetch https://codeload.github.com/motemen/ghq/tar.gz/v0.12.5?dummy=/motemen-ghq-v0.12.5_GH0.tar.gz fetch: https://codeload.github.com/motemen/ghq/tar.gz/v0.12.5?dummy=/motemen-ghq-v0.12.5_GH0.tar.gz: size of remote file is not known motemen-ghq-v0.12.5_GH0.tar.gz 32 kB 177 kBps 00s
Now the distribution file is ready to use and we can extract the required Go module dependencies. This step requires having ports-mgmt/modules2tuple installed:
%
make gomod-vendor
[...] GH_TUPLE= \ Songmu:gitconfig:v0.0.2:songmu_gitconfig/vendor/github.com/Songmu/gitconfig \ daviddengcn:go-colortext:186a3d44e920:daviddengcn_go_colortext/vendor/github.com/daviddengcn/go-colortext \ go-yaml:yaml:v2.2.2:go_yaml_yaml/vendor/gopkg.in/yaml.v2 \ golang:net:3ec191127204:golang_net/vendor/golang.org/x/net \ golang:sync:112230192c58:golang_sync/vendor/golang.org/x/sync \ golang:xerrors:3ee3066db522:golang_xerrors/vendor/golang.org/x/xerrors \ motemen:go-colorine:45d19169413a:motemen_go_colorine/vendor/github.com/motemen/go-colorine \ urfave:cli:v1.20.0:urfave_cli/vendor/github.com/urfave/cli
The output of this command needs to be pasted directly into the Makefile:
PORTNAME= ghq DISTVERSIONPREFIX= v DISTVERSION= 0.12.5 CATEGORIES= devel MAINTAINER= tobik@FreeBSD.org COMMENT= Remote repository management made easy USES= go:modules USE_GITHUB= yes GH_ACCOUNT= motemen GH_TUPLE= Songmu:gitconfig:v0.0.2:songmu_gitconfig/vendor/github.com/Songmu/gitconfig \ daviddengcn:go-colortext:186a3d44e920:daviddengcn_go_colortext/vendor/github.com/daviddengcn/go-colortext \ go-yaml:yaml:v2.2.2:go_yaml_yaml/vendor/gopkg.in/yaml.v2 \ golang:net:3ec191127204:golang_net/vendor/golang.org/x/net \ golang:sync:112230192c58:golang_sync/vendor/golang.org/x/sync \ golang:xerrors:3ee3066db522:golang_xerrors/vendor/golang.org/x/xerrors \ motemen:go-colorine:45d19169413a:motemen_go_colorine/vendor/github.com/motemen/go-colorine \ urfave:cli:v1.20.0:urfave_cli/vendor/github.com/urfave/cli .include <bsd.port.mk>
distinfo
needs to be regenerated to
contain all the distribution files:
%
make makesum
=> Songmu-gitconfig-v0.0.2_GH0.tar.gz doesn't seem to exist in /usr/ports/distfiles/. => Attempting to fetch https://codeload.github.com/Songmu/gitconfig/tar.gz/v0.0.2?dummy=/Songmu-gitconfig-v0.0.2_GH0.tar.gz fetch: https://codeload.github.com/Songmu/gitconfig/tar.gz/v0.0.2?dummy=/Songmu-gitconfig-v0.0.2_GH0.tar.gz: size of remote file is not known Songmu-gitconfig-v0.0.2_GH0.tar.gz 5662 B 936 kBps 00s => daviddengcn-go-colortext-186a3d44e920_GH0.tar.gz doesn't seem to exist in /usr/ports/distfiles/. => Attempting to fetch https://codeload.github.com/daviddengcn/go-colortext/tar.gz/186a3d44e920?dummy=/daviddengcn-go-colortext-186a3d44e920_GH0.tar.gz fetch: https://codeload.github.com/daviddengcn/go-colortext/tar.gz/186a3d44e920?dummy=/daviddengcn-go-colortext-186a3d44e920_GH0.tar.gz: size of remote file is not known daviddengcn-go-colortext-186a3d44e920_GH0.tar. 4534 B 1098 kBps 00s [...]
The port is now ready for a test build and further adjustments like creating a plist, writing a description, adding license information, options, etc. as normal.
If you are not testing your port in a clean environment
like with Poudriere, remember to
run make clean
before any testing.
Some ports need to install the resulting binary under a
different name or to a path other than
the default ${PREFIX}/bin
. This can be
done by using GO_TARGET
tuple syntax,
for example:
GO_TARGET= ./cmd/ipfs:ipfs-go
will install ipfs
binary as
${PREFIX}/bin/ipfs-go
and
GO_TARGET= ./dnscrypt-proxy:${PREFIX}/sbin/dnscrypt-proxy
will install dnscrypt-proxy
to
${PREFIX}/sbin
.
For ports that use Cabal,
build system defines USES=cabal
. Refer to Section 17.8, “cabal
” for a list of variables that can be
set to control the build process.
When preparing a Haskell Cabal port, the devel/hs-cabal-install program is required, so make sure it is installed beforehand. First we need to define common ports variables that allows cabal-install to fetch the package distribution file:
PORTNAME= ShellCheck DISTVERSION= 0.6.0 CATEGORIES= devel MAINTAINER= haskell@FreeBSD.org COMMENT= Shell script analysis tool USES= cabal .include <bsd.port.mk>
This minimal Makefile allows us to fetch the distribution file:
%
make cabal-extract
[...] Downloading the latest package list from hackage.haskell.org cabal get ShellCheck-0.6.0 Downloading ShellCheck-0.6.0 Downloaded ShellCheck-0.6.0 Unpacking to ShellCheck-0.6.0/
Now we have ShellCheck.cabal package description file, which allows us to fetch all package's dependencies, including transitive ones:
%
make cabal-extract-deps
[...] Resolving dependencies... Downloading base-orphans-0.8.2 Downloaded base-orphans-0.8.2 Downloading primitive-0.7.0.0 Starting base-orphans-0.8.2 (lib) Building base-orphans-0.8.2 (lib) Downloaded primitive-0.7.0.0 Downloading dlist-0.8.0.7 [...]
As a side effect, the package's dependencies are also compiled, so the command may take some time. Once done, a list of required dependencies can generated:
%
make make-use-cabal
USE_CABAL=QuickCheck-2.12.6.1 \ hashable-1.3.0.0 \ integer-logarithms-1.0.3 \ [...]
Haskell packages may contain revisions, just like
FreeBSD ports. Revisions can affect only .cabal
files, but it is still important to pull them in.
To check USE_CABAL
items for available
revision updates, run following command:
%
make make-use-cabal-revs
USE_CABAL=QuickCheck-2.12.6.1_1 \ hashable-1.3.0.0 \ integer-logarithms-1.0.3_2 \ [...]
Note additional version numbers after _
symbol. Put newly generated USE_CABAL
list
instead of an old one.
Finally, distinfo
needs to be regenerated to
contain all the distribution files:
%
make makesum
=> ShellCheck-0.6.0.tar.gz doesn't seem to exist in /usr/local/poudriere/ports/git/distfiles/cabal. => Attempting to fetch https://hackage.haskell.org/package/ShellCheck-0.6.0/ShellCheck-0.6.0.tar.gz ShellCheck-0.6.0.tar.gz 136 kB 642 kBps 00s => QuickCheck-2.12.6.1/QuickCheck-2.12.6.1.tar.gz doesn't seem to exist in /usr/local/poudriere/ports/git/distfiles/cabal. => Attempting to fetch https://hackage.haskell.org/package/QuickCheck-2.12.6.1/QuickCheck-2.12.6.1.tar.gz QuickCheck-2.12.6.1/QuickCheck-2.12.6.1.tar.gz 65 kB 361 kBps 00s [...]
The port is now ready for a test build and further adjustments like creating a plist, writing a description, adding license information, options, etc. as normal.
If you are not testing your port in a clean environment
like with Poudriere, remember to
run make clean
before any testing.
If a port needs any of the GNU Autotools software, add
USES=autoreconf
. See Section 17.4, “autoreconf
” for more information.
If the port requires gettext
, set
USES= gettext
, and the port will inherit
a dependency on libintl.so
from
devel/gettext. Other
values for gettext
usage are listed in
USES=gettext
.
A rather common case is a port using
gettext
and configure
.
Generally, GNU configure
should be able
to locate gettext
automatically.
USES= gettext GNU_CONFIGURE= yes
If it ever fails to, hints at the location of
gettext
can be passed in
CPPFLAGS
and LDFLAGS
using
localbase
as follows:
USES= gettext localbase:ldflags GNU_CONFIGURE= yes
Some software products allow for disabling
NLS. For example, through passing
--disable-nls
to
configure
. In that case, the port must use
gettext
conditionally, depending on the
status of the NLS
option. For ports of low
to medium complexity, use this idiom:
GNU_CONFIGURE= yes OPTIONS_DEFINE= NLS OPTIONS_SUB= yes NLS_USES= gettext NLS_CONFIGURE_ENABLE= nls .include <bsd.port.mk>
Or using the older way of using options:
GNU_CONFIGURE= yes OPTIONS_DEFINE= NLS .include <bsd.port.options.mk> .if ${PORT_OPTIONS:MNLS} USES+= gettext PLIST_SUB+= NLS="" .else CONFIGURE_ARGS+= --disable-nls PLIST_SUB+= NLS="@comment " .endif .include <bsd.port.mk>
The next item on the to-do list is to arrange so that
the message catalog files are included in the packing list
conditionally. The Makefile
part of
this task is already provided by the idiom. It is explained
in the section on advanced
pkg-plist
practices. In a
nutshell, each occurrence of %%NLS%%
in
pkg-plist
will be replaced by
“@comment
” if NLS is
disabled, or by a null string if NLS is enabled.
Consequently, the lines prefixed by
%%NLS%%
will become mere comments in the
final packing list if NLS is off; otherwise the prefix will
be just left out. Then insert
%%NLS%%
before each path to a message
catalog file in pkg-plist
. For
example:
%%NLS%%share/locale/fr/LC_MESSAGES/foobar.mo %%NLS%%share/locale/no/LC_MESSAGES/foobar.mo
In high complexity cases, more advanced techniques may be needed, such as dynamic packing list generation.
There is a point to note about installing message
catalog files. The target directories for them, which
reside under
LOCALBASE/share/locale
,
must not be created and removed by a port. The most
popular languages have their respective directories listed
in
PORTSDIR/Templates/BSD.local.dist
.
The directories for many other languages are governed by the
devel/gettext port.
Consult its pkg-plist
and see whether
the port is going to install a message catalog file for a
unique language.
If MASTER_SITES
is set to
CPAN
, the correct subdirectory is usually
selected automatically. If the default subdirectory is wrong,
CPAN/Module
can be used to change it.
MASTER_SITES
can also be set to the old
MASTER_SITE_PERL_CPAN
, then the preferred
value of MASTER_SITE_SUBDIR
is the
top-level hierarchy name. For example, the recommended value
for p5-Module-Name
is
Module
. The top-level hierarchy can be
examined at cpan.org.
This keeps the port working when the author of the module
changes.
The exception to this rule is when the relevant directory
does not exist or the distfile does not exist in that
directory. In such case, using author's id as
MASTER_SITE_SUBDIR
is allowed.
The CPAN:AUTHOR
macro can be used, which will
be translated to the hashed author directory. For example,
CPAN:AUTHOR
will be converted to
authors/id/A/AU/AUTHOR
.
When a port needs Perl support,
it must set USES=perl5
with the optional
USE_PERL5
described in the perl5 USES description.
Read only variables | Means |
---|---|
PERL | The full path of the Perl 5 interpreter,
either in the system or installed from a port, but
without the version number. Use this when the software
needs the path to the Perl
interpreter. To replace
“#! ”lines in scripts,
use USES=shebangfix. |
PERL_VERSION | The full version of Perl installed (for example,
5.8.9 ). |
PERL_LEVEL | The installed Perl version as
an integer of the form MNNNPP
(for example, 500809 ). |
PERL_ARCH | Where Perl stores architecture
dependent libraries. Defaults to
${ARCH}-freebsd . |
PERL_PORT | Name of the Perl port that is installed (for
example, perl5 ). |
SITE_PERL | Directory name where site specific
Perl packages go. This value is
added to PLIST_SUB . |
Ports of Perl modules which do not have an official
website must link to cpan.org
in
the WWW line of pkg-descr
. The
preferred URL form is
http://search.cpan.org/dist/Module-Name/
(including the trailing slash).
Do not use ${SITE_PERL}
in dependency
declarations. Doing so assumes that
perl5.mk
has been included, which is
not always true. Ports depending on this port will have
incorrect dependencies if this port's files move later in an
upgrade. The right way to declare Perl module dependencies
is shown in the example below.
For Perl ports that install manual pages, the macro
PERL5_MAN3
and PERL5_MAN1
can be used
inside pkg-plist
. For example,
lib/perl5/5.14/man/man1/event.1.gz lib/perl5/5.14/man/man3/AnyEvent::I3.3.gz
can be replaced with
%%PERL5_MAN1%%/event.1.gz %%PERL5_MAN3%%/AnyEvent::I3.3.gz
There are no
PERL5_MAN
macros for the
other sections (x
x
in
2
and
4
to 9
) because those
get installed in the regular directories.
As the default USE_PERL5 value is build and run, set it to:
USES= perl5 USE_PERL5= build
ExtUtils::MakeMaker
to BuildMost Perl modules come with a
Makefile.PL
configure script. In this
case, set:
USES= perl5 USE_PERL5= configure
Module::Build
to BuildWhen a Perl module comes with a
Build.PL
configure script, it can require
Module::Build, in which case,
set
USES= perl5 USE_PERL5= modbuild
If it instead requires Module::Build::Tiny, set
USES= perl5 USE_PERL5= modbuildtiny
The X11 implementation available in The Ports Collection
is X.Org. If the application depends on X components, add
USES= xorg
and set
USE_XORG
to the list of required
components. A full list can be found in Section 17.94, “xorg
”.
The Mesa Project is an effort to provide free OpenGL
implementation. To specify a dependency on various
components of this project, use USES= gl
and USE_GL
. See
Section 17.32, “gl
” for a full list of available
components. For backwards compatibility, the value of
yes
maps to glu
.
USES= imake | The port uses imake . |
XMKMF | Set to the path of xmkmf if
not in the PATH . Defaults to
xmkmf -a . |
If the port requires a Motif library, define
USES= motif
in the
Makefile
. Default Motif implementation
is
x11-toolkits/open-motif.
Users can choose
x11-toolkits/lesstif
instead by setting WANT_LESSTIF
in their make.conf
.
MOTIFLIB
will be set by
motif.mk
to reference the
appropriate Motif library. Please patch the source of the
port to use ${MOTIFLIB}
wherever
the Motif library is referenced in the original
Makefile
or
Imakefile
.
There are two common cases:
If the port refers to the Motif library as
-lXm
in its
Makefile
or
Imakefile
, substitute
${MOTIFLIB}
for it.
If the port uses XmClientLibs
in
its Imakefile
, change it to
${MOTIFLIB} ${XTOOLLIB}
${XLIB}
.
Note that MOTIFLIB
(usually) expands
to -L/usr/local/lib -lXm -lXp
or
/usr/local/lib/libXm.a
, so there is no
need to add -L
or -l
in front.
If the port installs fonts for the X Window System, put
them in
LOCALBASE/lib/X11/fonts/local
.
Some applications require a working X11 display for
compilation to succeed. This poses a problem for machines
that operate headless. When this variable is used,
the build infrastructure will start the virtual framebuffer
X server. The working DISPLAY
is then passed
to the build. See USES=display
for the possible arguments.
USES= display
Desktop entries (a Freedesktop standard) provide a way to automatically adjust desktop features when a new program is installed, without requiring user intervention. For example, newly-installed programs automatically appear in the application menus of compatible desktop environments. Desktop entries originated in the GNOME desktop environment, but are now a standard and also work with KDE and Xfce. This bit of automation provides a real benefit to the user, and desktop entries are encouraged for applications which can be used in a desktop environment.
Ports that include predefined
must include those files in *
.desktoppkg-plist
and install them in the
$LOCALBASE/share/applications
directory. The INSTALL_DATA
macro is useful for installing these
files.
If a port has a MimeType entry in its
,
the desktop database must be updated after install and
deinstall. To do this, define portname
.desktopUSES
=
desktop-file-utils.
Desktop entries can be easily created for applications
by using DESKTOP_ENTRIES
. A
file named
will be created, installed, and added to
name
.desktoppkg-plist
automatically. Syntax
is:
DESKTOP_ENTRIES= "NAME" "COMMENT" "ICON" "COMMAND" "CATEGORY" StartupNotify
The list of possible categories is available on the
Freedesktop
website. StartupNotify
indicates whether the application is compatible with
startup notifications. These are
typically a graphic indicator like a clock that appear at
the mouse pointer, menu, or panel to give the user an
indication when a program is starting. A program that is
compatible with startup notifications clears the indicator
after it has started. Programs that are not compatible
with startup notifications would never clear the indicator
(potentially confusing and infuriating the user), and
must have StartupNotify
set to
false
so the indicator is not shown at
all.
Example:
DESKTOP_ENTRIES= "ToME" "Roguelike game based on JRR Tolkien's work" \ "${DATADIR}/xtra/graf/tome-128.png" \ "tome -v -g" "Application;Game;RolePlaying;" \ false
This chapter explains the GNOME framework as used by ports. The framework can be loosely divided into the base components, GNOME desktop components, and a few special macros that simplify the work of port maintainers.
Adding this variable to the port allows the use of
the macros and components defined in
bsd.gnome.mk
. The code in
bsd.gnome.mk
adds the needed
build-time, run-time or library dependencies
or the handling of special files.
GNOME applications under FreeBSD use the
USE_GNOME
infrastructure. Include all the
needed components as a space-separated list. The
USE_GNOME
components are divided into
these virtual lists: basic components, GNOME 3 components
and legacy components. If the port needs only GTK3 libraries,
this is the shortest way to define it:
USE_GNOME= gtk30
USE_GNOME
components automatically
add the dependencies they need. Please see
Section 6.11, “GNOME Components” for an exhaustive
list of all USE_GNOME
components and which
other components they imply and their dependencies.
Here is an example Makefile
for a
GNOME port that uses many of the techniques outlined in this
document. Please use it as a guide for creating new
ports.
# $FreeBSD$ PORTNAME= regexxer DISTVERSION= 0.10 CATEGORIES= devel textproc gnome MASTER_SITES= GNOME MAINTAINER= kwm@FreeBSD.org COMMENT= Interactive tool for performing search and replace operations USES= gettext gmake localbase:ldflags pathfix pkgconfig tar:xz GNU_CONFIGURE= yes USE_GNOME= gnomeprefix intlhack gtksourceviewmm3 INSTALLS_ICONS= yes GLIB_SCHEMAS= org.regexxer.gschema.xml .include <bsd.port.mk>
The USE_GNOME
macro without any
arguments does not add any dependencies to the port.
USE_GNOME
cannot be set after
bsd.port.pre.mk
.
This section explains which macros are available and how
they are used. Like they are used in the above example. The
Section 6.11, “GNOME Components” has a more in-depth
explanation. USE_GNOME
has to be set for
these macros to be of use.
INSTALLS_ICONS
GTK+ ports which install
Freedesktop-style icons to
${LOCALBASE}/share/icons
should use
this macro to ensure that the icons are cached and will
display correctly. The cache file is named
icon-theme.cache
. Do not include
that file in pkg-plist
. This macro
handles that automatically. This macro is not needed
for Qt, which uses an
internal method.
GLIB_SCHEMAS
List of all the glib schema files the port installs. The macro will add the files to the port plist and handle the registration of these files on install and deinstall.
The glib schema files are written in
XML and end with the
gschema.xml
extension. They are
installed in the
share/glib-2.0/schemas/
directory.
These schema files contain all application config values
with their default settings. The actual database used
by the applications is built by
glib-compile-schema, which is
run by the GLIB_SCHEMAS
macro.
GLIB_SCHEMAS=foo.gschema.xml
Do not add glib schemas to the
pkg-plist
. If they are listed in
pkg-plist
, they will not be
registered and the applications might not work
properly.
GCONF_SCHEMAS
List all the gconf schema files. The macro will add the schema files to the port plist and will handle their registration on install and deinstall.
GConf is the XML-based database
that virtually all GNOME applications use for storing
their settings. These files are installed into the
etc/gconf/schemas
directory. This
database is defined by installed schema files that are
used to generate %gconf.xml
key
files. For each schema file installed by the port,
there must be an entry in the
Makefile
:
GCONF_SCHEMAS=my_app.schemas my_app2.schemas my_app3.schemas
Gconf schemas are listed in the
GCONF_SCHEMAS
macro rather than
pkg-plist
. If they are listed in
pkg-plist
, they will not be
registered and the applications might not work
properly.
INSTALLS_OMF
Open Source Metadata Framework
(OMF) files are commonly used by
GNOME 2 applications. These files contain the
application help file information, and require special
processing by ScrollKeeper/rarian. To properly register
OMF files when installing GNOME
applications from packages, make sure that
omf
files are listed in
pkg-plist
and that the port
Makefile
has
INSTALLS_OMF
defined:
INSTALLS_OMF=yes
When set, bsd.gnome.mk
automatically scans pkg-plist
and
adds appropriate @exec
and
@unexec
directives for each
.omf
to track in the
OMF registration database.
For further help with a GNOME port, look at some of the existing ports for examples. The FreeBSD GNOME page has contact information if more help is needed. The components are divided into GNOME components that are currently in use and legacy components. If the component supports argument, they are listed between parenthesis in the description. The first is the default. "Both" is shown if the component defaults to adding to both build and run dependencies.
Component | Associated program | Description |
---|---|---|
atk | accessibility/atk | Accessibility toolkit (ATK) |
atkmm | accessibility/atkmm | c++ bindings for atk |
cairo | graphics/cairo | Vector graphics library with cross-device output support |
cairomm | graphics/cairomm | c++ bindings for cairo |
dconf | devel/dconf | Configuration database system (both, build, run) |
evolutiondataserver3 | databases/evolution-data-server | Data backends for the Evolution integrated mail/PIM suite |
gdkpixbuf2 | graphics/gdk-pixbuf2 | Graphics library for GTK+ |
glib20 | devel/glib20 | GNOME core library
glib20 |
glibmm | devel/glibmm | c++ bindings for glib20 |
gnomecontrolcenter3 | sysutils/gnome-control-center | GNOME 3 Control Center |
gnomedesktop3 | x11/gnome-desktop | GNOME 3 desktop UI library |
gsound | audio/gsound | GObject library for playing system sounds (both, build, run) |
gtk-update-icon-cache | graphics/gtk-update-icon-cache | Gtk-update-icon-cache utility from the Gtk+ toolkit |
gtk20 | x11-toolkits/gtk20 | Gtk+ 2 toolkit |
gtk30 | x11-toolkits/gtk30 | Gtk+ 3 toolkit |
gtkmm20 | x11-toolkits/gtkmm20 | c++ bindings 2.0 for the gtk20 toolkit |
gtkmm24 | x11-toolkits/gtkmm24 | c++ bindings 2.4 for the gtk20 toolkit |
gtkmm30 | x11-toolkits/gtkmm30 | c++ bindings 3.0 for the gtk30 toolkit |
gtksourceview2 | x11-toolkits/gtksourceview2 | Widget that adds syntax highlighting to GtkTextView |
gtksourceview3 | x11-toolkits/gtksourceview3 | Text widget that adds syntax highlighting to the GtkTextView widget |
gtksourceviewmm3 | x11-toolkits/gtksourceviewmm3 | c++ bindings for the gtksourceview3 library |
gvfs | devel/gvfs | GNOME virtual file system |
intltool | textproc/intltool | Tool for internationalization (also see intlhack) |
introspection | devel/gobject-introspection | Basic introspection bindings and tools to generate introspection bindings. Most of the time :build is enough, :both/:run is only need for applications that use introspection bindings. (both, build, run) |
libgda5 | databases/libgda5 | Provides uniform access to different kinds of data sources |
libgda5-ui | databases/libgda5-ui | UI library from the libgda5 library |
libgdamm5 | databases/libgdamm5 | c++ bindings for the libgda5 library |
libgsf | devel/libgsf | Extensible I/O abstraction for dealing with structured file formats |
librsvg2 | graphics/librsvg2 | Library for parsing and rendering SVG vector-graphic files |
libsigc++20 | devel/libsigc++20 | Callback Framework for C++ |
libxml++26 | textproc/libxml++26 | c++ bindings for the libxml2 library |
libxml2 | textproc/libxml2 | XML parser library (both, build, run) |
libxslt | textproc/libxslt | XSLT C library (both, build, run) |
metacity | x11-wm/metacity | Window manager from GNOME |
nautilus3 | x11-fm/nautilus | GNOME file manager |
pango | x11-toolkits/pango | Open-source framework for the layout and rendering of i18n text |
pangomm | x11-toolkits/pangomm | c++ bindings for the pango library |
py3gobject3 | devel/py3-gobject3 | Python 3, GObject 3.0 bindings |
pygobject3 | devel/py-gobject3 | Python 2, GObject 3.0 bindings |
vte3 | x11-toolkits/vte3 | Terminal widget with improved accessibility and I18N support |
Component | Description |
---|---|
gnomeprefix | Supply configure with
some default locations. |
intlhack | Same as intltool, but patches to make sure
share/locale/ is used. Please
only use when intltool alone is
not enough. |
referencehack | This macro is there to help splitting of the API or reference documentation into its own port. |
Component | Associated program | Description |
---|---|---|
atspi | accessibility/at-spi | Assistive Technology Service Provider Interface |
esound | audio/esound | Enlightenment sound package |
gal2 | x11-toolkits/gal2 | Collection of widgets taken from GNOME 2 gnumeric |
gconf2 | devel/gconf2 | Configuration database system for GNOME 2 |
gconfmm26 | devel/gconfmm26 | c++ bindings for gconf2 |
gdkpixbuf | graphics/gdk-pixbuf | Graphics library for GTK+ |
glib12 | devel/glib12 | glib 1.2 core library |
gnomedocutils | textproc/gnome-doc-utils | GNOME doc utils |
gnomemimedata | misc/gnome-mime-data | MIME and Application database for GNOME 2 |
gnomesharp20 | x11-toolkits/gnome-sharp20 | GNOME 2 interfaces for the .NET runtime |
gnomespeech | accessibility/gnome-speech | GNOME 2 text-to-speech API |
gnomevfs2 | devel/gnome-vfs | GNOME 2 Virtual File System |
gtk12 | x11-toolkits/gtk12 | Gtk+ 1.2 toolkit |
gtkhtml3 | www/gtkhtml3 | Lightweight HTML rendering/printing/editing engine |
gtkhtml4 | www/gtkhtml4 | Lightweight HTML rendering/printing/editing engine |
gtksharp20 | x11-toolkits/gtk-sharp20 | GTK+ and GNOME 2 interfaces for the .NET runtime |
gtksourceview | x11-toolkits/gtksourceview | Widget that adds syntax highlighting to GtkTextView |
libartgpl2 | graphics/libart_lgpl | Library for high-performance 2D graphics |
libbonobo | devel/libbonobo | Component and compound document system for GNOME 2 |
libbonoboui | x11-toolkits/libbonoboui | GUI frontend to the libbonobo component of GNOME 2 |
libgda4 | databases/libgda4 | Provides uniform access to different kinds of data sources |
libglade2 | devel/libglade2 | GNOME 2 glade library |
libgnome | x11/libgnome | Libraries for GNOME 2, a GNU desktop environment |
libgnomecanvas | graphics/libgnomecanvas | Graphics library for GNOME 2 |
libgnomekbd | x11/libgnomekbd | GNOME 2 keyboard shared library |
libgnomeprint | print/libgnomeprint | Gnome 2 print support library |
libgnomeprintui | x11-toolkits/libgnomeprintui | Gnome 2 print support library |
libgnomeui | x11-toolkits/libgnomeui | Libraries for the GNOME 2 GUI, a GNU desktop environment |
libgtkhtml | www/libgtkhtml | Lightweight HTML rendering/printing/editing engine |
libgtksourceviewmm | x11-toolkits/libgtksourceviewmm | c++ binding of GtkSourceView |
libidl | devel/libIDL | Library for creating trees of CORBA IDL file |
libsigc++12 | devel/libsigc++12 | Callback Framework for C++ |
libwnck | x11-toolkits/libwnck | Library used for writing pagers and taskslists |
libwnck3 | x11-toolkits/libwnck3 | Library used for writing pagers and taskslists |
orbit2 | devel/ORBit2 | High-performance CORBA ORB with support for the C language |
pygnome2 | x11-toolkits/py-gnome2 | Python bindings for GNOME 2 |
pygobject | devel/py-gobject | Python 2, GObject 2.0 bindings |
pygtk2 | x11-toolkits/py-gtk2 | Set of Python bindings for GTK+ |
pygtksourceview | x11-toolkits/py-gtksourceview | Python bindings for GtkSourceView 2 |
vte | x11-toolkits/vte | Terminal widget with improved accessibility and I18N support |
Component | Description |
---|---|
pangox-compat | pangox-compat has been deprecated and split off from the pango package. |
For ports that are part of Qt itself, see Section 17.77, “qt-dist
”.
The Ports Collection provides support for Qt 5 with
USES+=qt:5
. Set USE_QT
to the list of required Qt components (libraries, tools,
plugins).
The Qt framework exports a number of variables which can be used by ports, some of them listed below:
QMAKE | Full path to qmake
binary. |
LRELEASE | Full path to lrelease
utility. |
MOC | Full path to moc . |
RCC | Full path to rcc . |
UIC | Full path to uic . |
QT_INCDIR | Qt include directory. |
QT_LIBDIR | Qt libraries path. |
QT_PLUGINDIR | Qt plugins path. |
Individual Qt tool and library dependencies must be
specified in USE_QT
.
Every component can be suffixed with
_build
or _run
, the
suffix indicating whether the dependency on the component is
at buildtime or runtime. If unsuffixed, the component will be
depended on at both build- and runtime. Usually, library
components are specified unsuffixed, tool components
are mostly specified with the _build
suffix
and plugin components are specified with the
_run
suffix. The most commonly used
components are listed below (all available components are
listed in _USE_QT_ALL
, and
_USE_QT5_ONLY
in
/usr/ports/Mk/Uses/qt.mk
):
Name | Description |
---|---|
3d | Qt3D module |
assistant | Qt 5 documentation browser |
canvas3d | Qt canvas3d module |
charts | Qt 5 charts module |
concurrent | Qt multi-threading module |
connectivity | Qt connectivity (Bluetooth/NFC) module |
core | Qt core non-graphical module |
datavis3d | Qt 5 3D data visualization module |
dbus | Qt D-Bus inter-process communication module |
declarative | Qt declarative framework for dynamic user interfaces |
designer | Qt 5 graphical user interface designer |
diag | Tool for reporting diagnostic information about Qt and its environment |
doc | Qt 5 documentation |
examples | Qt 5 examples sourcecode |
gamepad | Qt 5 Gamepad Module |
graphicaleffects | Qt Quick graphical effects |
gui | Qt graphical user interface module |
help | Qt online help integration module |
l10n | Qt localized messages |
linguist | Qt 5 translation tool |
location | Qt location module |
multimedia | Qt audio, video, radio and camera support module |
network | Qt network module |
networkauth | Qt network auth module |
opengl | Qt 5-compatible OpenGL support module |
paths | Command line client to QStandardPaths |
phonon4 | KDE multimedia framework |
pixeltool | Qt 5 screen magnifier |
plugininfo | Qt5 plugin metadata dumper |
printsupport | Qt print support module |
qdbus | Qt command-line interface to D-Bus |
qdbusviewer | Qt 5 graphical interface to D-Bus |
qdoc | Qt documentation generator |
qdoc-data | QDoc configuration files |
qev | Qt QWidget events introspection tool |
qmake | Qt Makefile generator |
quickcontrols | Set of controls for building complete interfaces in Qt Quick |
quickcontrols2 | Set of controls for building complete interfaces in Qt Quick |
remoteobjects | Qt5 SXCML module |
script | Qt 4-compatible scripting module |
scripttools | Qt Script additional components |
scxml | Qt5 SXCML module |
sensors | Qt sensors module |
serialbus | Qt functions to access industrial bus systems |
serialport | Qt functions to access serial ports |
speech | Accessibilty features for Qt5 |
sql | Qt SQL database integration module |
sql-ibase | Qt InterBase/Firebird database plugin |
sql-mysql | Qt MySQL database plugin |
sql-odbc | Qt Open Database Connectivity plugin |
sql-pgsql | Qt PostgreSQL database plugin |
sql-sqlite2 | Qt SQLite 2 database plugin |
sql-sqlite3 | Qt SQLite 3 database plugin |
sql-tds | Qt TDS Database Connectivity database plugin |
svg | Qt SVG support module |
testlib | Qt unit testing module |
uiplugin | Custom Qt widget plugin interface for Qt Designer |
uitools | Qt Designer UI forms support module |
virtualkeyboard | Qt 5 Virtual Keyboard Module |
wayland | Qt5 wrapper for Wayland |
webchannel | Qt 5 library for integration of C++/QML with HTML/js clients |
webengine | Qt 5 library to render web content |
webkit | QtWebKit with a more modern WebKit code base |
websockets | Qt implementation of WebSocket protocol |
websockets-qml | Qt implementation of WebSocket protocol (QML bindings) |
webview | Qt component for displaying web content |
widgets | Qt C++ widgets module |
x11extras | Qt platform-specific features for X11-based systems |
xml | Qt SAX and DOM implementations |
xmlpatterns | Qt support for XPath, XQuery, XSLT and XML Schema |
To determine the libraries an application
depends on, run ldd
on the main
executable after a successful compilation.
Name | Description |
---|---|
buildtools | build tools (moc ,
rcc ), needed for almost every
Qt application. |
linguisttools | localization tools: lrelease ,
lupdate |
qmake | Makefile generator/build utility |
Name | Description |
---|---|
imageformats | plugins for TGA, TIFF, and MNG image formats |
In this example, the ported application uses the Qt 5
graphical user interface library, the Qt 5 core library,
all of the Qt 5 code generation tools and Qt 5's Makefile
generator. Since the gui
library
implies a dependency on the core library,
core
does not need to be specified.
The Qt 5 code generation tools moc
,
uic
and rcc
, as well
as the Makefile generator qmake
are
only needed at buildtime, thus they are specified with the
_build
suffix:
USES= qt:5 USE_QT= gui buildtools_build qmake_build
If the application provides a
qmake project file
(*.pro
), define
USES= qmake
along with
USE_QT
. USES= qmake
already implies a build dependency on qmake, therefore the
qmake component can be omitted from
USE_QT
. Similar to CMake,
qmake supports out-of-source
builds, which can be enabled by specifying the
outsource
argument (see USES= qmake
example). Also see Table 6.16, “Possible Arguments for
USES= qmake
”.
USES= qmake
Variable | Description |
---|---|
no_configure | Do not add the configure target. This is
implied by HAS_CONFIGURE=yes
and GNU_CONFIGURE=yes .
It is required when the build only needs the
environment setup from
USES= qmake , but otherwise runs
qmake on its own. |
no_env | Suppress modification of the configure and make
environments. It is only required when
qmake is used to configure the
software and the build fails to understand the
environment setup by
USES= qmake . |
norecursive | Do not pass the -recursive
argument to qmake . |
outsource | Perform an out-of-source build. |
qmake
Variable | Description |
---|---|
QMAKE_ARGS | Port specific qmake
flags to be passed to the qmake
binary. |
QMAKE_ENV | Environment variables to be set for the
qmake binary. The default is
${CONFIGURE_ENV} . |
QMAKE_SOURCE_PATH | Path to qmake project files
(.pro ). The default is
${WRKSRC} if an
out-of-source build is requested, empty
otherwise. |
When using USES= qmake
, these
settings are deployed:
CONFIGURE_ARGS+= --with-qt-includes=${QT_INCDIR} \ --with-qt-libraries=${QT_LIBDIR} \ --with-extra-libs=${LOCALBASE}/lib \ --with-extra-includes=${LOCALBASE}/include CONFIGURE_ENV+= QTDIR="${QT_PREFIX}" QMAKE="${QMAKE}" \ MOC="${MOC}" RCC="${RCC}" UIC="${UIC}" \ QMAKESPEC="${QMAKESPEC}" PLIST_SUB+= QT_INCDIR=${QT_INCDIR_REL} \ QT_LIBDIR=${QT_LIBDIR_REL} \ QT_PLUGINDIR=${QT_PLUGINDIR_REL}
Some configure scripts do not support the arguments above.
To suppress modification of CONFIGURE_ENV
and CONFIGURE_ARGS
, set
USES= qmake:no_env
.
USES= qmake
ExampleThis snippet demonstrates the use of qmake for a Qt 5 port:
USES= qmake:outsource qt:5 USE_QT= buildtools_build
Qt applications are often written to be cross-platform and often X11/Unix is not the platform they are developed on, which in turn leads to certain loose ends, like:
Missing additional include
paths. Many applications come with
system tray icon support, but neglect to look for
includes and/or libraries in the X11 directories. To add
directories to qmake
's
include and library search paths via the command
line, use:
QMAKE_ARGS+= INCLUDEPATH+=${LOCALBASE}/include \ LIBS+=-L${LOCALBASE}/lib
Bogus installation paths.
Sometimes data such as icons or .desktop files are by
default installed into directories which are not scanned
by XDG-compatible applications.
editors/texmaker is
an example for this - look at
patch-texmaker.pro
in the
files
directory of that port for a
template on how to remedy this directly in the
qmake
project file.
If the application depends on KDE, set
USES+=kde:5
and
USE_KDE
to the list of required
components. _build
and
_run
suffixes can be used to force
components dependency type (for example,
baseapps_run
). If no suffix is set, a
default dependency type will be used. To force both types,
add the component twice with both suffixes (for example,
ecm_build ecm_run
). Available components
are listed below (up-to-date components are also listed in
/usr/ports/Mk/Uses/kde.mk
):
Name | Description |
---|---|
activities | KF5 runtime and library to organize work in separate activities |
activities-stats | KF5 statistics for activities |
activitymanagerd | System service to manage user's activities, track the usage patterns |
akonadi | Storage server for KDE-Pim |
akonadicalendar | Akonadi Calendar Integration |
akonadiconsole | Akonadi management and debugging console |
akonadicontacts | Libraries and daemons to implement Contact Management in Akonadi |
akonadiimportwizard | Import data from other mail clients to KMail |
akonadimime | Libraries and daemons to implement basic email handling |
akonadinotes | KDE library for accessing mail storages in MBox format |
akonadisearch | Libraries and daemons to implement searching in Akonadi |
akregator | A Feed Reader by KDE |
alarmcalendar | KDE API for KAlarm alarms |
apidox | KF5 API Documentation Tools |
archive | KF5 library that provides classes for handling archive formats |
attica | Open Collaboration Services API library KDE5 version |
attica5 | Open Collaboration Services API library KDE5 version |
auth | KF5 abstraction to system policy and authentication features |
baloo | KF5 Framework for searching and managing user metadata |
baloo-widgets | BalooWidgets library |
baloo5 | KF5 Framework for searching and managing user metadata |
blog | KDE API for weblogging access |
bookmarks | KF5 library for bookmarks and the XBEL format |
breeze | Plasma5 artwork, styles and assets for the Breeze visual style |
breeze-gtk | Plasma5 Breeze visual style for Gtk |
breeze-icons | Breeze icon theme for KDE |
calendarcore | KDE calendar access library |
calendarsupport | Calendar support libraries for KDEPim |
calendarutils | KDE utility and user interface functions for accessing calendar |
codecs | KF5 library for string manipulation |
completion | KF5 text completion helpers and widgets |
config | KF5 widgets for configuration dialogs |
configwidgets | KF5 widgets for configuration dialogs |
contacts | KDE api to manage contact information |
coreaddons | KF5 addons to QtCore |
crash | KF5 library to handle crash analysis and bug report from apps |
dbusaddons | KF5 addons to QtDBus |
decoration | Plasma5 library to create window decorations |
designerplugin | KF5 integration of Frameworks widgets in Qt Designer/Creator |
discover | Plasma5 package management tools |
dnssd | KF5 abstraction to system DNSSD features |
doctools | KF5 documentation generation from docbook |
drkonqi | Plasma5 crash handler |
ecm | Extra modules and scripts for CMake |
emoticons | KF5 library to convert emoticons |
eventviews | Event view libriares for KDEPim |
filemetadata | KF5 library for extracting file metadata |
frameworkintegration | KF5 workspace and cross-framework integration plugins |
gapi | KDE based library to access google services |
globalaccel | KF5 library to add support for global workspace shortcuts |
grantlee-editor | Editor for Grantlee themes |
grantleetheme | KDE PIM grantleetheme |
gravatar | Library for gravatar support |
guiaddons | KF5 addons to QtGui |
holidays | KDE library for calendar holidays |
hotkeys | Plasma5 library for hotkeys |
i18n | KF5 advanced internationalization framework |
iconthemes | KF5 library for handling icons in applications |
identitymanagement | KDE pim identities |
idletime | KF5 library for monitoring user activity |
imap | KDE API for IMAP support |
incidenceeditor | Incidence editor libriares for KDEPim |
infocenter | Plasma5 utility providing system information |
init | KF5 process launcher to speed up launching KDE applications |
itemmodels | KF5 models for Qt Model/View system |
itemviews | KF5 widget addons for Qt Model/View |
jobwidgets | KF5 widgets for tracking KJob instance |
js | KF5 library providing an ECMAScript interpreter |
jsembed | KF5 library for binding JavaScript objects to QObjects |
kaddressbook | KDE contact manager |
kalarm | Personal alarm scheduler |
kalarm | Personal alarm scheduler |
kate | Basic editor framework for the KDE system |
kcmutils | KF5 utilities for working with KCModules |
kde-cli-tools | Plasma5 non-interactive system tools |
kde-gtk-config | Plasma5 GTK2 and GTK3 configurator |
kdeclarative | KF5 library providing integration of QML and KDE Frameworks |
kded | KF5 extensible daemon for providing system level services |
kdelibs4support | KF5 porting aid from KDELibs4 |
kdepim-addons | KDE PIM addons |
kdepim-apps-libs | KDE PIM mail related libraries |
kdepim-runtime5 | KDE PIM tools and services |
kdeplasma-addons | Plasma5 addons to improve the Plasma experience |
kdesu | KF5 integration with su for elevated privileges |
kdewebkit | KF5 library providing integration of QtWebKit |
kgamma5 | Plasma5 monitor's gamma settings |
khtml | KF5 KTHML rendering engine |
kimageformats | KF5 library providing support for additional image formats |
kio | KF5 resource and network access abstraction |
kirigami2 | QtQuick based components set |
kitinerary | Data Model and Extraction System for Travel Reservation information |
kmail | KDE mail client |
kmail | KDE mail client |
kmail-account-wizard | KDE mail account wizard |
kmenuedit | Plasma5 menu editor |
knotes | Popup notes |
kontact | KDE Personal Information Manager |
kontact | KDE Personal Information Manager |
kontactinterface | KDE glue for embedding KParts into Kontact |
korganizer | Calendar and scheduling Program |
kpimdav | A DAV protocol implementation with KJobs |
kpkpass | Library to deal with Apple Wallet pass files |
kross | KF5 multi-language application scripting |
kscreen | Plasma5 screen management library |
kscreenlocker | Plasma5 secure lock screen architecture |
ksmtp | Job-based library to send email through an SMTP server |
ksshaskpass | Plasma5 ssh-add frontend |
ksysguard | Plasma5 utility to track and control the running processes |
kwallet-pam | Plasma5 KWallet PAM Integration |
kwayland-integration | Integration plugins for a Wayland-based desktop |
kwin | Plasma5 window manager |
kwrited | Plasma5 daemon listening for wall and write messages |
ldap | LDAP access API for KDE |
libkcddb | KDE CDDB library |
libkcompactdisc | KDE library for interfacing with audio CDs |
libkdcraw | LibRaw interface for KDE |
libkdegames | Libraries used by KDE games |
libkdepim | KDE PIM Libraries |
libkeduvocdocument | Library for reading and writing vocabulary files |
libkexiv2 | Exiv2 library interface for KDE |
libkipi | KDE Image Plugin Interface |
libkleo | Certificate manager for KDE |
libksane | SANE library interface for KDE |
libkscreen | Plasma5 screen management library |
libksieve | Sieve libriares for KDEPim |
libksysguard | Plasma5 library to track and control running processes |
mailcommon | Common libriares for KDEPim |
mailimporter | Import mbox files to KMail |
mailtransport | KDE library to managing mail transport |
marble | Virtual globe and world atlas for KDE |
mbox | KDE library for accessing mail storages in MBox format |
mbox-importer | Import mbox files to KMail |
mediaplayer | KF5 plugin interface for media player features |
messagelib | Library for handling messages |
milou | Plasma5 Plasmoid for search |
mime | Library for handling MIME data |
newstuff | KF5 library for downloading application assets from the network |
notifications | KF5 abstraction for system notifications |
notifyconfig | KF5 configuration system for KNotify |
okular | KDE universal document viewer |
oxygen | Plasma5 Oxygen style |
oxygen-icons5 | The Oxygen icon theme for KDE |
package | KF5 library to load and install packages |
parts | KF5 document centric plugin system |
people | KF5 library providing access to contacts |
pim-data-exporter | Import and export KDE PIM settings |
pimcommon | Common libriares for KDEPim |
pimtextedit | KDE library for PIM-specific text editing utilities |
plasma-browser-integration | Plasma5 components to integrate browsers into the desktop |
plasma-desktop | Plasma5 plasma desktop |
plasma-framework | KF5 plugin based UI runtime used to write user interfaces |
plasma-integration | Qt Platform Theme integration plugins for the Plasma workspaces |
plasma-pa | Plasma5 Plasma pulse audio mixer |
plasma-sdk | Plasma5 applications useful for Plasma development |
plasma-workspace | Plasma5 Plasma workspace |
plasma-workspace-wallpapers | Plasma5 wallpapers |
plotting | KF5 lightweight plotting framework |
polkit-kde-agent-1 | Plasma5 daemon providing a polkit authentication UI |
powerdevil | Plasma5 tool to manage the power consumption settings |
prison | API to produce barcodes |
pty | KF5 pty abstraction |
purpose | Offers available actions for a specific purpose |
qqc2-desktop-style | Qt QuickControl2 style for KDE |
runner | KF5 parallelized query system |
service | KF5 advanced plugin and service introspection |
solid | KF5 hardware integration and detection |
sonnet | KF5 plugin-based spell checking library |
syndication | KDE RSS feed handling library |
syntaxhighlighting | KF5 syntax highlighting engine for structured text and code |
systemsettings | Plasma5 system settings |
texteditor | KF5 advanced embeddable text editor |
textwidgets | KF5 advanced text editing widgets |
threadweaver | KF5 addons to QtDBus |
tnef | KDE API for the handling of TNEF data |
unitconversion | KF5 library for unit conversion |
user-manager | Plasma5 user manager |
wallet | KF5 secure and unified container for user passwords |
wayland | KF5 Client and Server library wrapper for the Wayland libraries |
widgetsaddons | KF5 addons to QtWidgets |
windowsystem | KF5 library for access to the windowing system |
xmlgui | KF5 user configurable main windows |
xmlrpcclient | KF5 interaction with XMLRPC services |
USE_KDE
ExampleThis is a simple example for a KDE port.
USES= cmake
instructs the
port to utilize CMake, a
configuration tool widely used by KDE projects (see
Section 6.5.4, “Using cmake
” for detailed usage).
USE_KDE
brings dependency on KDE
libraries. Required KDE components and other dependencies
can be determined through the configure log.
USE_KDE
does not imply
USE_QT
. If a port requires some
Qt components, specify them in
USE_QT
.
USES= cmake kde:5 qt:5 USE_KDE= ecm USE_QT= core buildtools_build qmake_build
Applications depending on LXQt should set
USES+= lxqt
and set
USE_LXQT
to the list of required components from the table below
Name | Description |
---|---|
buildtools | Helpers for additional CMake modules |
libfmqt | Libfm Qt bindings |
lxqt | LXQt core library |
qtxdg | Qt implementation of freedesktop.org XDG specifications |
USE_LXQT
ExampleThis is a simple example,
USE_LXQT
adds a dependency on
LXQt libraries. Required LXQt components and
other dependencies can be determined from the
configure log.
USES= cmake lxqt qt:5 tar:xz USE_QT= core dbus widgets buildtools_build qmake_build USE_LXQT= buildtools libfmqt
If the port needs a Java™ Development Kit
(JDK™) to either build, run or even
extract the distfile, then define
USE_JAVA
.
There are several JDKs in the ports
collection, from various vendors, and in several versions. If
the port must use a particular version, specify it using the
JAVA_VERSION
variable.
The most current version is
java/openjdk15, with
java/openjdk14,
java/openjdk13,
java/openjdk12,
java/openjdk11,
java/openjdk8, and
java/openjdk7 also
available.
Variable | Means |
---|---|
USE_JAVA | Define for the remaining variables to have any effect. |
JAVA_VERSION | List of space-separated suitable Java versions
for the port. An optional "+"
allows specifying a range of versions (allowed
values: 7[+] 8[+] 11[+] 12[+] 13[+] 14[+]
15[+] ). |
JAVA_OS | List of space-separated suitable
JDK port operating systems for the
port (allowed values:
native linux ). |
JAVA_VENDOR | List of space-separated suitable
JDK port vendors for the port
(allowed values:
freebsd bsdjava sun
openjdk ). |
JAVA_BUILD | When set, add the selected JDK port to the build dependencies. |
JAVA_RUN | When set, add the selected JDK port to the run dependencies. |
JAVA_EXTRACT | When set, add the selected JDK port to the extract dependencies. |
Below is the list of all settings a port will receive
after setting USE_JAVA
:
Variable | Value |
---|---|
JAVA_PORT | The name of the JDK port (for
example, java/openjdk6 ). |
JAVA_PORT_VERSION | The full version of the JDK
port (for example, 1.6.0 ). Only
the first two digits of this version number are
needed, use
${JAVA_PORT_VERSION:C/^([0-9])\.([0-9])(.*)$/\1.\2/} . |
JAVA_PORT_OS | The operating system used by the
JDK port (for example,
'native' ). |
JAVA_PORT_VENDOR | The vendor of the JDK port
(for example, 'openjdk' ). |
JAVA_PORT_OS_DESCRIPTION | Description of the operating system used by the
JDK port (for example,
'Native' ). |
JAVA_PORT_VENDOR_DESCRIPTION | Description of the vendor of the
JDK port (for example,
'OpenJDK BSD Porting
Team' ). |
JAVA_HOME | Path to the installation directory of the
JDK (for example,
'/usr/local/openjdk6' ). |
JAVAC | Path to the Java compiler to use (for example,
'/usr/local/openjdk6/bin/javac' ). |
JAR | Path to the jar tool to use
(for example,
'/usr/local/openjdk6/bin/jar'
or
'/usr/local/bin/fastjar' ). |
APPLETVIEWER | Path to the appletviewer
utility (for example,
'/usr/local/openjdk6/bin/appletviewer' ). |
JAVA | Path to the java executable.
Use this for executing Java programs (for example,
'/usr/local/openjdk6/bin/java' ). |
JAVADOC | Path to the javadoc utility
program. |
JAVAH | Path to the javah
program. |
JAVAP | Path to the javap
program. |
JAVA_KEYTOOL | Path to the keytool utility
program. |
JAVA_N2A | Path to the native2ascii
tool. |
JAVA_POLICYTOOL | Path to the policytool
program. |
JAVA_SERIALVER | Path to the serialver
utility program. |
RMIC | Path to the RMI stub/skeleton generator,
rmic . |
RMIREGISTRY | Path to the RMI registry program,
rmiregistry . |
RMID | Path to the RMI daemon program
rmid . |
JAVA_CLASSES | Path to the archive that contains the
JDK class files,
${JAVA_HOME}/jre/lib/rt.jar . |
Use the java-debug
make
target to get information for debugging the port. It will
display the value of many of the previously listed
variables.
Additionally, these constants are defined so all Java ports may be installed in a consistent way:
Constant | Value |
---|---|
JAVASHAREDIR | The base directory for everything related to
Java. Default:
${PREFIX}/share/java . |
JAVAJARDIR | The directory where JAR files is
installed. Default:
${JAVASHAREDIR}/classes . |
JAVALIBDIR | The directory where JAR files installed by
other ports are located. Default:
${LOCALBASE}/share/java/classes . |
The related entries are defined in both
PLIST_SUB
(documented in
Section 8.1, “Changing pkg-plist
Based on Make
Variables”) and
SUB_LIST
.
When the port is to be built using Apache Ant, it has to
define USE_ANT
. Ant is thus considered to
be the sub-make command. When no
do-build
target is defined by the
port, a default one will be set that runs Ant according to
MAKE_ENV
, MAKE_ARGS
and
ALL_TARGET
. This is similar to the
USES= gmake
mechanism, which is documented
in Section 6.5, “Building Mechanisms”.
When porting a Java library, the port has to install
the JAR file(s) in ${JAVAJARDIR}
, and
everything else under
${JAVASHAREDIR}/${PORTNAME}
(except for
the documentation, see below). To reduce the packing file
size, reference the JAR file(s) directly in the
Makefile
. Use this statement (where
is
the name of the JAR file installed as part of the
port):myport
.jar
PLIST_FILES+= ${JAVAJARDIR}/myport
.jar
When porting a Java application, the port usually
installs everything under a single directory (including its
JAR dependencies). The use of
${JAVASHAREDIR}/${PORTNAME}
is strongly
encouraged in this regard. It is up the porter to decide
whether the port installs the additional JAR
dependencies under this directory or uses the
already installed ones (from
${JAVAJARDIR}
).
When porting a Java™ application that requires an
application server such as
www/tomcat7 to run the
service, it is quite common for a vendor to distribute a
.war
. A .war
is a Web application ARchive and is extracted when
called by the application. Avoid adding a
.war
to pkg-plist
.
It is not considered best practice. An application server
will expand war archive, but not
clean it up properly if the port is removed. A more
desirable way of working with this file is to extract the
archive, then install the files, and lastly add these files
to pkg-plist
.
TOMCATDIR= ${LOCALBASE}/apache-tomcat-7.0 WEBAPPDIR= myapplication post-extract: @${MKDIR} ${WRKDIR}/${PORTDIRNAME} @${TAR} xf ${WRKDIR}/myapplication.war -C ${WRKDIR}/${PORTDIRNAME} do-install: cd ${WRKDIR} && \ ${INSTALL} -d -o ${WWWOWN} -g ${WWWGRP} ${TOMCATDIR}/webapps/${PORTDIRNAME} cd ${WRKDIR}/${PORTDIRNAME} && ${COPYTREE_SHARE} \* ${WEBAPPDIR}/${PORTDIRNAME}
Regardless of the type of port (library or
application), the additional documentation is installed in the
same location as
for any other port. The Javadoc tool is known to produce a
different set of files depending on the version of the
JDK that is used. For ports that do not
enforce the use of a particular JDK, it is
therefore a complex task to specify the packing list
(pkg-plist
). This is one reason why
porters are strongly encouraged to use
PORTDOCS
. Moreover, even if the set of
files that will be generated by javadoc
can
be predicted, the size of the resulting
pkg-plist
advocates for the use of
PORTDOCS
.
The default value for DATADIR
is
${PREFIX}/share/${PORTNAME}
. It is a
good idea to override DATADIR
to
${JAVASHAREDIR}/${PORTNAME}
for Java
ports. Indeed, DATADIR
is automatically
added to PLIST_SUB
(documented in
Section 8.1, “Changing pkg-plist
Based on Make
Variables”) so use
%%DATADIR%%
directly in
pkg-plist
.
As for the choice of building Java ports from source or directly installing them from a binary distribution, there is no defined policy at the time of writing. However, people from the FreeBSD Java Project encourage porters to have their ports built from source whenever it is a trivial task.
All the features that have been presented in this
section are implemented in bsd.java.mk
.
If the port needs more sophisticated
Java support, please first have a look at the bsd.java.mk
Subversion log as it
usually takes some time to document the latest features.
Then, if the needed support that is lacking would be
beneficial to many other Java ports, feel free to discuss it
on the FreeBSD Java Language mailing list.
Although there is a java
category for
PRs, it refers to the JDK porting effort
from the FreeBSD Java project. Therefore, submit the Java port
in the ports
category as for any other
port, unless the issue is related to either a
JDK implementation or
bsd.java.mk
.
Similarly, there is a defined policy regarding the
CATEGORIES
of a Java port, which is
detailed in Section 5.3, “Categorization”.
USE_APACHE | The port requires Apache. Possible values:
yes (gets any version),
22 , 24 ,
22-24 , 22+ ,
etc. The default APACHE version is
22 . More details are available
in ports/Mk/bsd.apache.mk and
at wiki.freebsd.org/Apache/. |
APXS | Full path to the apxs
binary. Can be overridden in the port. |
HTTPD | Full path to the httpd
binary. Can be overridden in the port. |
APACHE_VERSION | The version of present Apache installation
(read-only variable). This variable is only
available after inclusion of
bsd.port.pre.mk . Possible
values: 22 ,
24 . |
APACHEMODDIR | Directory for Apache modules. This variable is
automatically expanded in
pkg-plist . |
APACHEINCLUDEDIR | Directory for Apache headers. This variable is
automatically expanded in
pkg-plist . |
APACHEETCDIR | Directory for Apache configuration files. This
variable is automatically expanded in
pkg-plist . |
MODULENAME | Name of the module. Default value is
PORTNAME . Example:
mod_hello |
SHORTMODNAME | Short name of the module. Automatically
derived from MODULENAME , but can
be overridden. Example:
hello |
AP_FAST_BUILD | Use apxs to compile and
install the module. |
AP_GENPLIST | Also automatically creates a
pkg-plist . |
AP_INC | Adds a directory to a header search path during compilation. |
AP_LIB | Adds a directory to a library search path during compilation. |
AP_EXTRAS | Additional flags to pass to
apxs . |
Web applications must be installed into
PREFIX/www/
.
This path is available both in
appname
Makefile
and in
pkg-plist
as WWWDIR
,
and the path relative to PREFIX
is
available in Makefile
as
WWWDIR_REL
.
The user and group of web server process are available
as WWWOWN
and WWWGRP
,
in case the ownership of some files needs to be changed. The
default values of both are www
. Use
WWWOWN?= myuser
and WWWGRP?=
mygroup
if the port needs different values. This
allows the user to override them easily.
Use WWWOWN
and
WWWGRP
sparingly. Remember that every
file the web server can write to is a security risk waiting
to happen.
Do not depend on Apache unless the web app explicitly needs Apache. Respect that users may wish to run a web application on a web server other than Apache.
PHP web applications declare
their dependency on it with USES=php
. See
Section 17.69, “php
” for more information.
Porting PEAR modules is a very simple process.
Add USES=pear
to the port's
Makefile
. The framework will install the
relevant files in the right places and automatically generate
the plist at install time.
PORTNAME= Date DISTVERSION= 1.4.3 CATEGORIES= devel www pear MAINTAINER= example@domain.com COMMENT= PEAR Date and Time Zone Classes USES= pear .include <bsd.port.mk>
PEAR modules will automatically be flavorized using PHP flavors.
If a non default PEAR_CHANNEL
is
used, the build and run-time dependencies will automatically
be added.
PEAR modules do not need to defined
PKGNAMESUFFIX
it is automatically filled
in using PEAR_PKGNAMEPREFIX
. If a port
needs to add to PKGNAMEPREFIX
, it must
also use PEAR_PKGNAMEPREFIX
to
differentiate between different flavors.
In the same way, porting Horde modules is a simple process.
Add USES=horde
to the port's
Makefile
. The framework will install
the relevant files in the right places and automatically
generate the plist at install time.
The USE_HORDE_BUILD
and
USE_HORDE_RUN
variables can be used to
add buildtime and runtime dependencies on other
Horde modules. See
Mk/Uses/horde.mk
for a complete list of
available modules.
PORTNAME= Horde_Core DISTVERSION= 2.14.0 CATEGORIES= devel www pear MAINTAINER= horde@FreeBSD.org COMMENT= Horde Core Framework libraries OPTIONS_DEFINE= KOLAB SOCKETS KOLAB_DESC= Enable Kolab server support SOCKETS_DESC= Depend on sockets PHP extension USES= horde USE_PHP= session USE_HORDE_BUILD= Horde_Role USE_HORDE_RUN= Horde_Role Horde_History Horde_Pack \ Horde_Text_Filter Horde_View KOLAB_USE= HORDE_RUN=Horde_Kolab_Server,Horde_Kolab_Session SOCKETS_USE= PHP=sockets .include <bsd.port.mk>
As Horde modules are also PEAR modules they will also automatically be flavorized using PHP flavors.
The Ports Collection supports parallel installation of
multiple Python versions. Ports must use a
correct python
interpreter, according to
the user-settable PYTHON_VERSION
.
Most prominently, this means replacing the path to
python
executable in scripts with the value
of PYTHON_CMD
.
Ports that install files under
PYTHON_SITELIBDIR
must use the
pyXY-
package name prefix, so their package
name embeds the version of Python they are installed
into.
PKGNAMEPREFIX= ${PYTHON_PKGNAMEPREFIX}
USES=python | The port needs Python. The minimal required
version can be specified with values such as
2.7+ . Version ranges can also be
specified by separating two version numbers with a dash:
USES=python:3.2-3.3 |
USE_PYTHON=distutils | Use Python distutils for configuring, compiling,
and installing. This is required when the port comes
with setup.py . This overrides
the do-build and
do-install targets and may
also override do-configure
if GNU_CONFIGURE is not
defined. Additionally, it implies
USE_PYTHON=flavors . |
USE_PYTHON=autoplist | Create the packaging list automatically. This also
requires USE_PYTHON=distutils to be
set. |
USE_PYTHON=concurrent | The port will use an unique prefix, typically
PYTHON_PKGNAMEPREFIX for certain
directories, such as EXAMPLESDIR and
DOCSDIR and also will append a
suffix, the python version from
PYTHON_VER , to binaries and scripts
to be installed. This allows ports to be installed for
different Python versions at the same time, which
otherwise would install conflicting files. |
USE_PYTHON=flavors | The port does not use distutils but still supports
multiple Python versions. FLAVORS
will be set to the supported Python versions. See Section 7.4, “USES=python and Flavors” for more
information. |
USE_PYTHON=optsuffix | If the current Python version is not the default
version, the port will gain
PKGNAMESUFFIX=${PYTHON_PKGNAMESUFFIX} .
Only useful with flavors. |
PYTHON_PKGNAMEPREFIX | Used as a PKGNAMEPREFIX to
distinguish packages for different Python versions.
Example: py27- |
PYTHON_SITELIBDIR | Location of the site-packages tree, that contains
installation path of Python (usually
LOCALBASE ).
PYTHON_SITELIBDIR can be
very useful when installing Python modules. |
PYTHONPREFIX_SITELIBDIR | The PREFIX-clean variant of PYTHON_SITELIBDIR.
Always use %%PYTHON_SITELIBDIR%% in
pkg-plist when possible. The
default value of
%%PYTHON_SITELIBDIR%% is
lib/python%%PYTHON_VERSION%%/site-packages |
PYTHON_CMD | Python interpreter command line, including version number. |
PYNUMERIC | Dependency line for numeric extension. |
PYNUMPY | Dependency line for the new numeric extension, numpy. (PYNUMERIC is deprecated by upstream vendor). |
PYXML | Dependency line for XML extension (not needed for Python 2.0 and higher as it is also in base distribution). |
PY_ENUM34 | Conditional dependency on devel/py-enum34 depending on the Python version. |
PY_ENUM_COMPAT | Conditional dependency on devel/py-enum-compat depending on the Python version. |
PY_PATHLIB | Conditional dependency on devel/py-pathlib depending on the Python version. |
PY_IPADDRESS | Conditional dependency on net/py-ipaddress depending on the Python version. |
PY_FUTURES | Conditional dependency on devel/py-futures depending on the Python version. |
A complete list of available variables can be found in
/usr/ports/Mk/Uses/python.mk
.
All dependencies to Python
ports using Python
flavors (either with
USE_PYTHON=distutils
or
USE_PYTHON=flavors
) must have the Python
flavor appended to their origin using
@${PY_FLAVOR}
. See Example 6.25, “Makefile for a Simple Python
Module”.
PORTNAME= sample DISTVERSION= 1.2.3 CATEGORIES= devel MAINTAINER= john@doe.tld COMMENT= Python sample module RUN_DEPENDS= ${PYTHON_PKGNAMEPREFIX}six>0:devel/py-six@${PY_FLAVOR} USES= python USE_PYTHON= autoplist distutils .include <bsd.port.mk>
Some Python applications claim to have
DESTDIR
support (which would be required
for staging) but it is broken (Mailman up to 2.1.16, for
instance). This can be worked around by recompiling the
scripts. This can be done, for example, in the
post-build
target. Assuming the
Python scripts are supposed to reside in
PYTHONPREFIX_SITELIBDIR
after installation,
this solution can be applied:
(cd ${STAGEDIR}${PREFIX} \ && ${PYTHON_CMD} ${PYTHON_LIBDIR}/compileall.py \ -d ${PREFIX} -f ${PYTHONPREFIX_SITELIBDIR:S;${PREFIX}/;;})
This recompiles the sources with a path relative to the
stage directory, and prepends the value of
PREFIX
to the file name recorded in the
byte-compiled output file by -d
.
-f
is required to force recompilation, and
the :S;${PREFIX}/;;
strips prefixes from
the value of PYTHONPREFIX_SITELIBDIR
to make it relative to
PREFIX
.
The Ports Collection supports parallel installation of
multiple Tcl/Tk versions. Ports
should try to support at least the default
Tcl/Tk version and higher with
USES=tcl
. It is possible to specify the
desired version of tcl
by appending
:
, for example,
xx
USES=tcl:85
.
TCL_VER | chosen major.minor version of Tcl |
TCLSH | full path of the Tcl interpreter |
TCL_LIBDIR | path of the Tcl libraries |
TCL_INCLUDEDIR | path of the Tcl C header files |
TK_VER | chosen major.minor version of Tk |
WISH | full path of the Tk interpreter |
TK_LIBDIR | path of the Tk libraries |
TK_INCLUDEDIR | path of the Tk C header files |
See the USES=tcl
and
USES=tk
of
Chapter 17, Using USES
Macros for a full description of those
variables. A complete list of those variables is available in
/usr/ports/Mk/Uses/tcl.mk
.
Variable | Description |
---|---|
USE_RUBY | Adds build and run dependencies on Ruby. |
USE_RUBY_EXTCONF | The port uses extconf.rb to
configure. |
USE_RUBY_SETUP | The port uses setup.rb to
configure. |
RUBY_SETUP | Override the name of the setup script from
setup.rb . Another common value is
install.rb . |
This table shows the selected variables available
to port authors via the ports infrastructure. These variables
are used to install files into their proper locations.
Use them in pkg-plist
as much as
possible. Do not redefine these variables in the port.
Variable | Description | Example value |
---|---|---|
RUBY_PKGNAMEPREFIX | Used as a PKGNAMEPREFIX to
distinguish packages for different Ruby
versions. | ruby19- |
RUBY_VERSION | Full version of Ruby in the form of
x.y.z[.p] . | 1.9.3.484 |
RUBY_SITELIBDIR | Architecture independent libraries installation path. | /usr/local/lib/ruby/site_ruby/1.9 |
RUBY_SITEARCHLIBDIR | Architecture dependent libraries installation path. | /usr/local/lib/ruby/site_ruby/1.9/amd64-freebsd10 |
RUBY_MODDOCDIR | Module documentation installation path. | /usr/local/share/doc/ruby19/patsy |
RUBY_MODEXAMPLESDIR | Module examples installation path. | /usr/local/share/examples/ruby19/patsy |
A complete list of available variables can be found in
/usr/ports/Mk/bsd.ruby.mk
.
USE_SDL
is used to
autoconfigure the dependencies for ports which use an SDL
based library like devel/sdl12
and graphics/sdl_image.
These SDL libraries for version 1.2 are recognized:
sdl: devel/sdl12
console: devel/sdl_console
gfx: graphics/sdl_gfx
image: graphics/sdl_image
mixer: audio/sdl_mixer
mm: devel/sdlmm
net: net/sdl_net
pango: x11-toolkits/sdl_pango
sound: audio/sdl_sound
ttf: graphics/sdl_ttf
These SDL libraries for version 2.0 are recognized:
sdl: devel/sdl20
gfx: graphics/sdl2_gfx
image: graphics/sdl2_image
mixer: audio/sdl2_mixer
net: net/sdl2_net
ttf: graphics/sdl2_ttf
Therefore, if a port has a dependency on net/sdl_net and audio/sdl_mixer, the syntax will be:
USE_SDL= net mixer
The dependency devel/sdl12, which is required by net/sdl_net and audio/sdl_mixer, is automatically added as well.
Using USE_SDL
with entries for
SDL 1.2, it will automatically:
Add a dependency on
sdl12-config to
BUILD_DEPENDS
Add the variable SDL_CONFIG
to
CONFIGURE_ENV
Add the dependencies of the selected libraries to
LIB_DEPENDS
Using USE_SDL
with entries for
SDL 2.0, it will automatically:
Add a dependency on
sdl2-config to
BUILD_DEPENDS
Add the variable SDL2_CONFIG
to
CONFIGURE_ENV
Add the dependencies of the selected libraries to
LIB_DEPENDS
This section describes the status of the wxWidgets libraries in the ports tree and its integration with the ports system.
There are many versions of the wxWidgets libraries which conflict between them (install files under the same name). In the ports tree this problem has been solved by installing each version under a different name using version number suffixes.
The obvious disadvantage of this is that each
application has to be modified to find the expected version.
Fortunately, most of the applications call the
wx-config
script to determine the
necessary compiler and linker flags. The script is named
differently for every available version. Majority of
applications respect an environment variable, or accept a
configure argument, to specify which
wx-config
script to call. Otherwise they
have to be patched.
To make the port use a specific version of wxWidgets there are two variables available for defining (if only one is defined the other will be set to a default value):
Variable | Description | Default value |
---|---|---|
USE_WX | List of versions the port can use | All available versions |
USE_WX_NOT | List of versions the port cannot use | None |
The available wxWidgets versions and the corresponding ports in the tree are:
The variables in Table 6.30, “Variables to Select wxWidgets Versions” can be set to one or more of these combinations separated by spaces:
Description | Example |
---|---|
Single version | 2.8 |
Ascending range | 2.8+ |
Descending range | 3.0- |
Full range (must be ascending) | 2.8-3.0 |
There are also some variables to select the preferred versions from the available ones. They can be set to a list of versions, the first ones will have higher priority.
Name | Designed for |
---|---|
WANT_WX_VER | the port |
WITH_WX_VER | the user |
There are other applications that, while not being
wxWidgets libraries, are related
to them. These applications can be specified in
WX_COMPS
. These
components are available:
Name | Description | Version restriction |
---|---|---|
wx | main library | none |
contrib | contributed libraries | none |
python | wxPython (Python bindings) | 2.8-3.0 |
The dependency type can be selected for each component by adding a suffix separated by a semicolon. If not present then a default type will be used (see Table 6.36, “Default wxWidgets Dependency Types”). These types are available:
Name | Description |
---|---|
build | Component is required for building, equivalent
to BUILD_DEPENDS |
run | Component is required for running, equivalent
to RUN_DEPENDS |
lib | Component is required for building and running,
equivalent to LIB_DEPENDS |
The default values for the components are detailed in this table:
Component | Dependency type |
---|---|
wx | lib |
contrib | lib |
python | run |
mozilla | lib |
svg | lib |
This fragment corresponds to a port which
uses wxWidgets version
2.4
and its contributed
libraries.
USE_WX= 2.8 WX_COMPS= wx contrib
To detect an installed version, define
WANT_WX
. If it is not set to a
specific version then the components will have a version
suffix. HAVE_WX
will be
filled after detection.
This fragment can be used in a port that uses wxWidgets if it is installed, or an option is selected.
WANT_WX= yes .include <bsd.port.pre.mk> .if defined(WITH_WX) || !empty(PORT_OPTIONS:MWX) || !empty(HAVE_WX:Mwx-2.8) USE_WX= 2.8 CONFIGURE_ARGS+= --enable-wx .endif
This fragment can be used in a port that
enables wxPython support if it
is installed or if an option is selected, in addition to
wxWidgets, both version
2.8
.
USE_WX= 2.8 WX_COMPS= wx WANT_WX= 2.8 .include <bsd.port.pre.mk> .if defined(WITH_WXPYTHON) || !empty(PORT_OPTIONS:MWXPYTHON) || !empty(HAVE_WX:Mpython) WX_COMPS+= python CONFIGURE_ARGS+= --enable-wxpython .endif
These variables are available in the port (after defining one from Table 6.30, “Variables to Select wxWidgets Versions”).
Name | Description |
---|---|
WX_CONFIG | The path to the
wxWidgets
wx-config script (with different
name) |
WXRC_CMD | The path to the
wxWidgets
wxrc program (with different
name) |
WX_VERSION | The wxWidgets
version that is going to be used (for example,
2.6 ) |
Define WX_PREMK
to be able to use the
variables right after including
bsd.port.pre.mk
.
When defining WX_PREMK
, then the
version, dependencies, components and defined variables
will not change if modifying the
wxWidgets port variables
after including
bsd.port.pre.mk
.
This fragment illustrates the use of
WX_PREMK
by running the
wx-config
script to obtain the full
version string, assign it to a variable and pass it to the
program.
USE_WX= 2.8 WX_PREMK= yes .include <bsd.port.pre.mk> .if exists(${WX_CONFIG}) VER_STR!= ${WX_CONFIG} --release PLIST_SUB+= VERSION="${VER_STR}" .endif
The wxWidgets variables can
be safely used in commands when they are inside targets
without the need of WX_PREMK
.
Some GNU configure
scripts cannot
find wxWidgets with just the
WX_CONFIG
environment variable set,
requiring additional arguments.
WX_CONF_ARGS
can be used for
provide them.
WX_CONF_ARGS
Possible value | Resulting argument |
---|---|
absolute | --with-wx-config=${WX_CONFIG} |
relative | --with-wx=${LOCALBASE}
--with-wx-config=${WX_CONFIG:T} |
This section describes the status of the Lua libraries in the ports tree and its integration with the ports system.
There are many versions of the Lua libraries and corresponding interpreters, which conflict between them (install files under the same name). In the ports tree this problem has been solved by installing each version under a different name using version number suffixes.
The obvious disadvantage of this is that each application has to be modified to find the expected version. But it can be solved by adding some additional flags to the compiler and linker.
Applications that use Lua
should normally build for just one version. However, loadable
modules for Lua are built in a separate flavor for each Lua
version that they support, and dependencies on such modules
should specify the flavor using the
@${LUA_FLAVOR}
suffix on the port
origin.
A port using Lua should have a line of this form:
USES= lua
If a specific version of Lua, or range of versions, is
needed, it can be specified as a parameter in the form
XY
(which may be used multiple times),
XY+
, -XY
, or
XY-ZA
. The default version of
Lua as set via
DEFAULT_VERSIONS
will be used if it falls
in the requested range, otherwise the closest requested
version to the default will be used. For example:
USES= lua:52-53
Note that no attempt is made to adjust the version selection based on the presence of any already-installed Lua version.
The XY+
form of version specification
should not be used without careful consideration; the
Lua API changes to some extent in
every version, and configuration tools like
CMake or
Autoconf will often fail to work
on future versions of Lua until
updated to do so.
Software that uses Lua may have been written to auto-detect the Lua version in use. In general ports should override this assumption, and force the use of the specific Lua version selected as described above. Depending on the software being ported, this might require any or all of:
Using LUA_VER
as part of a parameter
to the software's configuration script via
CONFIGURE_ARGS
or
CONFIGURE_ENV
(or equivalent for other
build systems);
Adding -I${LUA_INCDIR}
,
-L${LUA_LIBDIR}
, and
-llua-${LUA_VER}
to CFLAGS
,
LDFLAGS
, LIBS
respectively
as appropriate;
Patch the software's configuration or build files to select the correct version.
A port which installs a Lua
module (rather than an application that simply makes use of
Lua) should build a separate
flavor for each supported Lua
version. This is done by adding the module
parameter:
USES= lua:module
A version number or range of versions can be specified as well; use a comma to separate parameters.
Since each flavor must have a different package name, the
variable LUA_PKGNAMEPREFIX
is provided which
will be set to an appropriate value; the intended usage
is:
PKGNAMEPREFIX= ${LUA_PKGNAMEPREFIX}
Module ports should normally install files only to
LUA_MODLIBDIR
,
LUA_MODSHAREDIR
,
LUA_DOCSDIR
, and
LUA_EXAMPLESDIR
, all of which are set up
to refer to version-specific subdirectories. Installing any
other files must be done with care to avoid conflicts between
versions.
A port (other than a Lua module)
which wishes to build a separate package for each
Lua version should use the
flavors
parameter:
USES= lua:flavors
This operates the same way as the module
parameter described above, but without the assumption that the
package should be documented as a Lua
module (so LUA_DOCSDIR
and
LUA_EXAMPLESDIR
are not defined by
default). However, the port may choose to define
LUA_DOCSUBDIR
as a suitable subdirectory name
(usually the port's PORTNAME
as long as this
does not conflict with the PORTNAME
of any
module), in which case the framework will define both
LUA_DOCSDIR
and
LUA_EXAMPLESDIR
.
As with module ports, a flavored port should avoid installing
files that would conflict between versions. Typically this is done
by adding LUA_VER_STR
as a suffix to program
names (e.g. using
USES=uniquefiles), and
otherwise using either LUA_VER
or
LUA_VER_STR
as part of any other files or
subdirectories used outside of LUA_MODLIBDIR
and LUA_MODSHAREDIR
.
These variables are available in the port.
Name | Description |
---|---|
LUA_VER | The Lua version that
is going to be used (for example,
5.1 ) |
LUA_VER_STR | The Lua version
without the dots (for example,
51 ) |
LUA_FLAVOR | The flavor name corresponding to the selected Lua version, to be used for specifying dependencies |
LUA_BASE | The prefix that should be used to locate Lua (and components) that are already installed |
LUA_PREFIX | The prefix where Lua (and components) are to be installed by this port |
LUA_INCDIR | The directory where Lua header files are installed |
LUA_LIBDIR | The directory where Lua libraries are installed |
LUA_REFMODLIBDIR | The directory where
Lua module libraries
(.so ) that are already
installed are to be found |
LUA_REFMODSHAREDIR | The directory where
Lua modules
(.lua ) that are already
installed are to be found |
LUA_MODLIBDIR | The directory where
Lua module libraries
(.so ) are to be installed
by this port |
LUA_MODSHAREDIR | The directory where
Lua modules
(.lua ) are to be installed
by this port |
LUA_PKGNAMEPREFIX | The package name prefix used by Lua modules |
LUA_CMD | The name of the Lua
interpreter (e.g. lua53 ) |
LUAC_CMD | The name of the Lua
compiler (e.g. luac53 ) |
These additional variables are available for ports that
specified the module
parameter:
Name | Description |
---|---|
LUA_DOCSDIR | the directory to which the module's documentation should be installed. |
LUA_EXAMPLESDIR | the directory to which the module's example files should be installed. |
This example shows how to reference a Lua module required at run time. Notice that the reference must specify a flavor.
PORTNAME= sample DISTVERSION= 1.2.3 CATEGORIES= whatever MAINTAINER= john@doe.tld COMMENT= Sample RUN_DEPENDS= ${LUA_REFMODLIBDIR}/lpeg.so:devel/lua-lpeg@${LUA_FLAVOR} USES= lua .include <bsd.port.mk>
PORTNAME= sample DISTVERSION= 1.2.3 CATEGORIES= whatever PKGNAMEPREFIX= ${LUA_PKGNAMEPREFIX} MAINTAINER= john@doe.tld COMMENT= Sample USES= lua:module DOCSDIR= ${LUA_DOCSDIR} .include <bsd.port.mk>
After 2013-10-08 (254273),
FreeBSD 10-CURRENT and newer versions have a native
iconv
in the operating system. On earlier
versions, converters/libiconv
was used as a dependency.
For software that needs iconv
, define
USES=iconv
. FreeBSD versions before
10-CURRENT on 2013-08-13 (254273) do
not have a native iconv
. On these earlier
versions, a dependency on
converters/libiconv will be
added automatically.
When a port defines USES=iconv
, these
variables will be available:
Variable name | Purpose | Value before FreeBSD 10-CURRENT 254273 (2013-08-13) | Value after FreeBSD 10-CURRENT 254273 (2013-08-13) |
---|---|---|---|
ICONV_CMD | Directory where the iconv
binary resides | ${LOCALBASE}/bin/iconv | /usr/bin/iconv |
ICONV_LIB | ld argument to link to
libiconv (if needed) | -liconv | (empty) |
ICONV_PREFIX | Directory where the iconv
implementation resides (useful for configure
scripts) | ${LOCALBASE} | /usr |
ICONV_CONFIGURE_ARG | Preconstructed configure argument for configure scripts | --with-libiconv-prefix=${LOCALBASE} | (empty) |
ICONV_CONFIGURE_BASE | Preconstructed configure argument for configure scripts | --with-libiconv=${LOCALBASE} | (empty) |
These two examples automatically populate the variables
with the correct value for systems using
converters/libiconv or the
native iconv
respectively:
As shown above, ICONV_LIB
is empty when
a native iconv
is present. This can be
used to detect the native iconv
and respond
appropriately.
Sometimes a program has an ld
argument
or search path hardcoded in a Makefile
or
configure script. This approach can be used to solve that
problem:
-liconv
USES= iconv post-patch: @${REINPLACE_CMD} -e 's/-liconv/${ICONV_LIB}/' ${WRKSRC}/Makefile
In some cases it is necessary to set alternate values or
perform operations depending on whether there is a native
iconv
.
bsd.port.pre.mk
must be included before
testing the value of ICONV_LIB
:
iconv
AvailabilityUSES= iconv .include <bsd.port.pre.mk> post-patch: .if empty(ICONV_LIB) # native iconv detected @${REINPLACE_CMD} -e 's|iconv||' ${WRKSRC}/Config.sh .endif .include <bsd.port.post.mk>
Ports that need Xfce libraries or
applications set USES=xfce
.
Specific Xfce library and
application dependencies are set with values assigned to
USE_XFCE
. They are defined in
/usr/ports/Mk/Uses/xfce.mk
. The possible
values are:
USE_XFCE
In this example, the ported application uses the GTK2-specific widgets x11/libxfce4menu and x11/xfce4-conf.
USES= xfce:gtk2 USE_XFCE= libmenu xfconf
Xfce components included this way will automatically include any dependencies they need. It is no longer necessary to specify the entire list. If the port only needs x11-wm/xfce4-panel, use:
USES= xfce USE_XFCE= panel
There is no need to list the components x11-wm/xfce4-panel needs itself like this:
USES= xfce USE_XFCE= libexo libmenu libutil panel
However, Xfce components and non-Xfce dependencies of the port must be included explicitly. Do not count on an Xfce component to provide a sub-dependency other than itself for the main port.
Use one of the USES
macros from
Table 6.41, “Database USES
Macros” to add a dependency
on a database.
When a port needs the MySQL client library add
USES= mysql
See Section 17.58, “mysql
” for more
information.
When a port needs the PostgreSQL server version 9.6 or later add
USES= pgsql:9.6+ WANT_PGSQL= server
See Section 17.68, “pgsql
” for more
information.
rc.d
scripts are used to start
services on system startup, and to give administrators a
standard way of stopping, starting and restarting the service.
Ports integrate into the system rc.d
framework. Details on its usage can be found in the
rc.d Handbook chapter. Detailed explanation of
the available commands is provided in rc(8) and
rc.subr(8). Finally, there is
an
article on practical aspects of
rc.d
scripting.
With a mythical port called
doorman
, which needs to start a
doormand
daemon. Add the following
to the Makefile
:
USE_RC_SUBR= doormand
Multiple scripts may be listed and will be installed.
Scripts must be placed in the files
subdirectory and a .in
suffix must be added
to their filename. Standard SUB_LIST
expansions will be ran against this file. Use of the
%%PREFIX%%
and
%%LOCALBASE%%
expansions is strongly
encouraged as well. More on SUB_LIST
in
the relevant
section.
As of FreeBSD 6.1-RELEASE, local
rc.d
scripts (including those installed
by ports) are included in the overall rcorder(8) of the
base system.
An example simple rc.d
script to start
the doormand daemon:
#!/bin/sh # $FreeBSD$ # # PROVIDE:doormand
# REQUIRE: LOGIN # KEYWORD: shutdown # # Add these lines to /etc/rc.conf.local or /etc/rc.conf # to enable this service: # #doormand
_enable (bool): Set to NO by default. # Set it to YES to enabledoormand
. #doormand
_config (path): Set to %%PREFIX%%/etc/doormand/doormand.cf
# by default. . /etc/rc.subr name=doormand
rcvar=doormand
_enable load_rc_config $name : ${doormand
_enable:="NO"} : ${doormand
_config="%%PREFIX%%/etc/doormand/doormand.cf
"} command=%%PREFIX%%/sbin/${name} pidfile=/var/run/${name}.pid command_args="-p $pidfile -f $doormand_config
" run_rc_command "$1"
Unless there is a very good reason to start the service earlier, or it runs as a particular user (other than root), all ports scripts must use:
REQUIRE: LOGIN
If the startup script launches a daemon that must be shutdown, the following will trigger a stop of the service on system shutdown:
KEYWORD: shutdown
If the script is not starting a persistent service this is not necessary.
For optional configuration elements the "=" style of default variable assignment is preferable to the ":=" style here, since the former sets a default value only if the variable is unset, and the latter sets one if the variable is unset or null. A user might very well include something like:
doormand
_flags=""
in their rc.conf.local
, and a
variable substitution using ":=" would
inappropriately override the user's intention. The
_enable
variable is not optional,
and must use the ":" for the default.
Ports must not start and stop
their services when installing and deinstalling. Do not abuse
the plist
keywords described in Section 8.6.13.2, “@preexec
command
,
@postexec
command
,
@preunexec
command
,
@postunexec
command
” by running commands
that modify the currently running system, including starting
or stopping services.
Before contributing a port with an
rc.d
script, and more importantly,
before committing one, please consult this
checklist to be sure that it is ready.
The devel/rclint port can check for most of these, but it is not a substitute for proper review.
If this is a new file, does it have a
.sh
extension? If so, that must be
changed to just
since file
.inrc.d
files may not end with
that extension.
Does the file have a
$FreeBSD$
tag?
Do the name of the file (minus
.in
), the
PROVIDE
line, and
$
name
all match? The file name matching
PROVIDE
makes debugging easier,
especially for rcorder(8) issues. Matching the
file name and
$
name
makes it easier to figure out which variables are
relevant in rc.conf[.local]
. It is
also a policy
for all new scripts, including those in the base
system.
Is the REQUIRE
line set to
LOGIN
? This is mandatory for scripts
that run as a non-root user. If it runs as root, is
there a good reason for it to run prior to
LOGIN
? If not, it must run after
so that local scrips can be loosely grouped to a point in
rcorder(8) after most everything in the base is
already running.
Does the script start a persistent service? If so,
it must have KEYWORD:
shutdown
.
Make sure there is no
KEYWORD: FreeBSD
present. This has
not been necessary nor desirable for years. It is also
an indication that the new script was copy/pasted from
an old script, so extra caution must be given to the
review.
If the script uses an interpreted language like
perl
, python
, or
ruby
, make certain that
command_interpreter
is set
appropriately, for example, for
Perl, by adding
PERL=${PERL}
to
SUB_LIST
and using
%%PERL%%
. Otherwise,
#
service
name
stop
will probably not work properly. See service(8) for more information.
Have all occurrences of
/usr/local
been replaced with
%%PREFIX%%
?
Do the default variable assignments come after
load_rc_config
?
Are there default assignments to empty strings? They should be removed, but double-check that the option is documented in the comments at the top of the file.
Are things that are set in variables actually used in the script?
Are options listed in the default
name
_flags
things that are actually mandatory? If so, they must
be in command_args
.
-d
is a red flag (pardon the
pun) here, since it is usually the option to
“daemonize” the process, and therefore is
actually mandatory.
must never be included in
name
_flagscommand_args
(and vice versa,
although that error is less common).
Does the script execute any code unconditionally?
This is frowned on. Usually these things must be
dealt with through a
start_precmd
.
All boolean tests must use the
checkyesno
function. No
hand-rolled tests for [Yy][Ee][Ss]
,
etc.
If there is a loop (for example, waiting for something to start) does it have a counter to terminate the loop? We do not want the boot to be stuck forever if there is an error.
Does the script create files or directories that
need specific permissions, for example, a
pid
that needs to be owned by
the user that runs the process? Rather than the
traditional touch(1)/chown(8)/chmod(1)
routine, consider using install(1) with the proper
command line arguments to do the whole procedure with
one step.
Some ports require a particular user account to be present,
usually for daemons that run as that user. For these ports,
choose a unique UID from 50 to 999 and
register it in ports/UIDs
(for users) and
ports/GIDs
(for groups). The unique
identification should be the same for users and groups.
Please include a patch against these two files when requiring a new user or group to be created for the port.
Then use USERS
and
GROUPS
in
Makefile
, and the user will be
automatically created when installing the port.
USERS= pulse GROUPS= pulse pulse-access pulse-rt
The current list of reserved UIDs and GIDs can be found
in ports/UIDs
and
ports/GIDs
.
Some ports (such as kernel loadable modules) need the kernel source files so that the port can compile. Here is the correct way to determine if the user has them installed:
USES= kmod
Apart from this check, the kmod
feature
takes care of most items that these ports need to take into
account.
Ports must not package or install Go libs or source code. Go ports must fetch the required deps at the normal fetch time and should only install the programs and things users need, not the things Go developers would need.
Ports should (in order of preference):
Use vendored dependencies included with the package source.
Fetch the versions of deps specified by upstream (in the case of go.mod, vendor.json or similar).
As a last resort (deps are not included nor versions specified exactly) fetch versions of dependencies available at the time of upstream development/release.
Just like in case of Go language, Ports must not package or install Haskell libraries. Haskell ports must link statically to their dependencies and fetch all distribution files on fetch stage.
Many modern shells (including bash, tcsh, and zsh) support parameter and/or option tab-completion. This support usually comes from completion files, which contain the definitions for how tab completion will work for a certain command. Ports sometimes ship with their own completion files, or porters may have created them themselves.
When available, completion files should always be
installed. It is not necessary to make an option for it.
If an option is used, though, always enable it in
OPTIONS_DEFAULT
.
bash | ${PREFIX}/etc/bash_completion.d |
zsh | ${PREFIX}/share/zsh/site-functions |
Do not register any dependencies on the shells themselves.
Flavors are a way to have multiple variations of a port. The port is built multiple times, with variations.
For example, a port can have a normal version with many features and quite a few dependencies, and a light “lite” version with only basic features and minimal dependencies.
Another example could be, a port can have a GTK flavor and a QT flavor, depending on which toolkit it uses.
To declare a port having multiple flavors, add
FLAVORS
to its Makefile
.
The first flavor in FLAVORS
is the default
flavor.
It can help simplify the logic of the
Makefile
to also define
FLAVOR
as:
FLAVOR?= ${FLAVORS:[1]}
To distinguish flavors from options, which are always
uppercase letters, flavor names can only
contain lowercase letters, numbers, and the underscore
_
.
If a port has a “lite” slave port, the slave port can be removed, and the port can be converted to flavors with:
FLAVORS= default lite lite_PKGNAMESUFFIX= -lite [...] .if ${FLAVOR:U} != lite [enable non lite features] .endif
The first flavor is the default one, and is called,
here, default
. It is not an obligation,
and if possible, use a more specific flavor name, like in
Example 7.2, “Another Basic Flavors Usage”.
If a port has a -nox11
slave port, the
slave port can be removed, and the port can be converted to
flavors with:
FLAVORS= x11 nox11 FLAVOR?= ${FLAVORS:[1]} nox11_PKGNAMESUFFIX= -nox11 [...] .if ${FLAVOR} == x11 [enable x11 features] .endif
Here is a slightly edited excerpt of what is present in
devel/libpeas, a port that
uses the Python
flavors. With the default
Python 2 and 3 versions being 2.7
and 3.6, it will automatically get FLAVORS=py27
py36
USES= gnome python USE_PYTHON= flavors.if ${FLAVOR:Upy27:Mpy2*}
USE_GNOME= pygobject3
CONFIGURE_ARGS+= --enable-python2 --disable-python3 BUILD_WRKSRC= ${WRKSRC}/loaders/python
INSTALL_WRKSRC= ${WRKSRC}/loaders/python
.else # py3* USE_GNOME+= py3gobject3
CONFIGURE_ARGS+= --disable-python2 --enable-python3 \ ac_cv_path_PYTHON3_CONFIG=${LOCALBASE}/bin/python${PYTHON_VER}-config
BUILD_WRKSRC= ${WRKSRC}/loaders/python3
INSTALL_WRKSRC= ${WRKSRC}/loaders/python3
.endif py34_PLIST= ${.CURDIR}/pkg-plist-py3
py35_PLIST= ${.CURDIR}/pkg-plist-py3
py36_PLIST= ${.CURDIR}/pkg-plist-py3
This port does not use
| |
To guard against | |
The Gnome Python gobject3 bindings have two different names, one for Python 2, pygobject3 and one for Python 3, py3gobject3. | |
The | |
Hint about the correct Python 3 config script path name. | |
The packing list is different when the built with
Python 3. As there are three
possible Python 3 versions, set
|
To make the Makefile
easier to write,
a few flavors helpers exist.
This list of helpers will set their variable:
flavor
_PKGNAMEPREFIX
flavor
_PKGNAMESUFFIX
flavor
_PLIST
flavor
_DESCR
This list of helpers will append to their variable:
flavor
_CONFLICTS
flavor
_CONFLICTS_BUILD
flavor
_CONFLICTS_INSTALL
flavor
_PKG_DEPENDS
flavor
_EXTRACT_DEPENDS
flavor
_PATCH_DEPENDS
flavor
_FETCH_DEPENDS
flavor
_BUILD_DEPENDS
flavor
_LIB_DEPENDS
flavor
_RUN_DEPENDS
flavor
_TEST_DEPENDS
PKGNAME
As all packages must have a different package name,
flavors must change theirs, using
and
flavor
_PKGNAMEPREFIX
makes this easy:flavor
_PKGNAMESUFFIX
FLAVORS= normal lite lite_PKGNAMESUFFIX= -lite
When using USES=php with
one of these arguments, phpize
,
ext
, zend
, or
pecl
, the port will automatically have
FLAVORS
filled in with the
PHP versions it supports.
All the examples assume the currently supported PHP versions are 5.6, 7.0, 7.1, and 7.2.
USES=php
ExtensionThis will generate package for all the supported versions:
PORTNAME= some-ext PORTVERSION= 0.0.1 PKGNAMEPREFIX= ${PHP_PKGNAMEPREFIX} USES= php:ext
This will generate package for all the supported versions but 7.2:
PORTNAME= some-ext PORTVERSION= 0.0.1 PKGNAMEPREFIX= ${PHP_PKGNAMEPREFIX} USES= php:ext IGNORE_WITH_PHP= 72
PHP applications can also be flavorized.
This allows generating packages for all PHP versions, so that users can use them with whatever version they need on their servers.
PHP applications that are flavorized
must append
PHP_PKGNAMESUFFIX
to their package
names.
Adding Flavors support to a PHP application is straightforward:
PKGNAMESUFFIX= ${PHP_PKGNAMESUFFIX} USES= php:flavors
When adding a dependency on a
PHP flavored port, use
@${PHP_FLAVOR}
.
Never use FLAVOR
directly.
When using USES=python
and USE_PYTHON=distutils
, the port will
automatically have FLAVORS
filled in with
the Python versions it
supports.
USES=python
Supposing the current Python supported versions are 2.7, 3.4, 3.5, and 3.6, and the default Python 2 and 3 versions are 2.7 and 3.6, a port with:
USES= python USE_PYTHON= distutils
Will get these flavors: py27
, and
py36
.
USES= python USE_PYTHON= distutils allflavors
Will get these flavors: py27
,
py34
, py35
and
py36
.
USES=python
with Version
RequirementsSupposing the current Python supported versions are 2.7, 3.4, 3.5, and 3.6, and the default Python 2 and 3 versions are 2.7 and 3.6, a port with:
USES= python:-3.5 USE_PYTHON= distutils
Will get this flavor: py27
.
USES= python:-3.5 USE_PYTHON= distutils allflavors
Will get these flavors: py27
,
py34
, and py35
.
USES= python:3.4+ USE_PYTHON= distutils
Will get this flavor: py36
.
USES= python:3.4+ USE_PYTHON= distutils allflavors
Will get these flavors: py34
,
py35
, and py36
.
PY_FLAVOR
is available to depend
on the correct version of Python
modules. All dependencies on flavored Python ports should
use PY_FLAVOR
, and not
FLAVOR
directly..
distutils
If the default Python 3
version is 3.6, the following will set
PY_FLAVOR
to
py36
:
RUN_DEPENDS= ${PYTHON_PKGNAMEPREFIX}mutagen>0:audio/py-mutagen@${PY_FLAVOR} USES= python:3.5+
When using USES=lua:module
or USES=lua:flavors
,
the port will automatically have FLAVORS
filled in with the Lua versions it
supports. However, it is not expected that ordinary
applications (rather than Lua
modules) should use this feature; most applications that embed
or otherwise use Lua should simply
use USES=lua
.
LUA_FLAVOR
is available (and must be
used) to depend on the correct version of dependencies
regardless of whether the port used the
flavors
or module
parameters.
See Section 6.22, “Using Lua” for further information.
Some ports, particularly the p5-
ports,
need to change their pkg-plist
depending on
what options they are configured with (or version of
perl
, in the case of p5-
ports). To make this easy, any instances in
pkg-plist
of %%OSREL%%
,
%%PERL_VER%%
, and
%%PERL_VERSION%%
will be substituted
appropriately. The value of %%OSREL%%
is the
numeric revision of the operating system (for example,
4.9
). %%PERL_VERSION%%
and %%PERL_VER%%
is the full version number
of perl
(for example,
5.8.9
). Several other
%%
related
to port's documentation files are described in the relevant
section.VARS
%%
To make other substitutions, set
PLIST_SUB
with a list of
pairs and instances of
VAR
=VALUE
%%
will be
substituted with VAR
%%VALUE
in
pkg-plist
.
For instance, if a port installs many files
in a version-specific subdirectory, use a placeholder for the
version so that pkg-plist
does not have to
be regenerated every time the port is updated. For
example:
OCTAVE_VERSION= ${PORTREVISION} PLIST_SUB= OCTAVE_VERSION=${OCTAVE_VERSION}
in the Makefile
and use
%%OCTAVE_VERSION%%
wherever the version shows
up in pkg-plist
. When
the port is upgraded, it will not be necessary to edit dozens
(or in some cases, hundreds) of lines in
pkg-plist
.
If files are installed conditionally on the options
set in the port, the usual way of handling it is prefixing
pkg-plist
lines with a
%%OPT%%
for lines needed when the option is
enabled, or %%NO_OPT%%
when the option is
disabled, and adding OPTIONS_SUB=yes
to the
Makefile
. See Section 5.13.3.1, “OPTIONS_SUB
” for more information.
For instance, if there are files that are only installed
when the X11
option is enabled, and
Makefile
has:
OPTIONS_DEFINE= X11 OPTIONS_SUB= yes
In pkg-plist
, put
%%X11%%
in front of the lines only being
installed when the option is enabled, like this :
%%X11%%bin/foo-gui
This substitution will be done between the
pre-install
and
do-install
targets, by reading from
PLIST
and writing to
TMPPLIST
(default:
WRKDIR/.PLIST.mktmp
). So if the port
builds PLIST
on the fly, do so in or before
pre-install
. Also, if the port
needs to edit the resulting file, do so in
post-install
to a file named
TMPPLIST
.
Another way of modifying a port's packing list is based on
setting the variables PLIST_FILES
and
PLIST_DIRS
. The value of each variable is
regarded as a list of pathnames to write to
TMPPLIST
along with
PLIST
contents. While names listed in
PLIST_FILES
and
PLIST_DIRS
are subject to
%%
substitution as described above, it is better to use the
VAR
%%${
directly.
Except for that, names from
VAR
}PLIST_FILES
will appear in the final packing
list unchanged, while @dir
will be prepended to names from
PLIST_DIRS
. To take effect,
PLIST_FILES
and
PLIST_DIRS
must be set before
TMPPLIST
is written, that is, in
pre-install
or earlier.
From time to time, using OPTIONS_SUB
is not enough. In those cases, adding a specific
to
TAG
PLIST_SUB
inside the Makefile
with a special
value of @comment
, makes package tools to
ignore the line. For instance, if some files are only installed
when the X11
option is on and the
architecture is i386
:
.include <bsd.port.pre.mk> .if ${PORT_OPTIONS:MX11} && ${ARCH} == "i386" PLIST_SUB+= X11I386="" .else PLIST_SUB+= X11I386="@comment " .endif
When being de-installed, a port has to remove empty
directories it created. Most of these directories are removed
automatically by pkg(8), but for directories created
outside of ${PREFIX}
, or empty
directories, some more work needs to be done. This is usually
accomplished by adding @dir
lines for those
directories. Subdirectories must be deleted before deleting
parent directories.
[...] @dir /var/games/oneko/saved-games @dir /var/games/oneko
Empty directories created during port installation need
special attention. They must be present when the package
is created. If they are not created by the port code, create
them in the Makefile
:
post-install: ${MKDIR} ${STAGEDIR}${PREFIX}/some/directory
Add the directory to pkg-plist
like any other. For example:
@dir some/directory
If the port installs configuration files to
PREFIX/etc
(or elsewhere) do
not list them in
pkg-plist
. That will cause
pkg delete
to remove files that have been
carefully edited by the user, and a re-installation will wipe
them out.
Instead, install sample files with a
extension. The filename
.sample@sample
macro automates this,
see Section 8.6.9, “@sample
file
[file
]” for what it does
exactly. For each sample file, add a line to
pkg-plist
:
@sample etc/orbit.conf.sample
If there is a very good reason not to install a working
configuration file by default, only list the sample filename in
pkg-plist
, without the
@sample
followed by a space part, and add a
message pointing out that the
user must copy and edit the file before the software will
work.
When a port installs its configuration in a subdirectory
of ${PREFIX}/etc
, use
ETCDIR
, which defaults to
${PREFIX}/etc/${PORTNAME}
, it can be
overridden in the ports Makefile
if there
is a convention for the port to use some other directory. The
%%ETCDIR%%
macro will be used in its
stead in pkg-plist
.
The sample configuration files should always have the
.sample
suffix. If for some historical
reason using the standard suffix is not possible, or if the
sample files come from some other directory, use
this construct:
@sample etc/orbit.conf-dist etc/orbit.conf
or
@sample %%EXAMPLESDIR%%/orbit.conf etc/orbit.conf
The format is @sample
.sample-file
actual-config-file
A static package list is a package
list which is available in the Ports Collection either as
pkg-plist
(with or without variable
substitution), or embedded into the
Makefile
via
PLIST_FILES
and
PLIST_DIRS
. Even if the contents are
auto-generated by a tool or a target in the Makefile
before the inclusion into the Ports
Collection by a committer (for example, using make
makeplist
), this is still considered a static list,
since it is possible to examine it without having to download or
compile the distfile.
A dynamic package list is a package
list which is generated at the time the port is compiled based
upon the files and directories which are installed. It is not
possible to examine it before the source code of the ported
application is downloaded and compiled, or after running a
make clean
.
While the use of dynamic package lists is not forbidden, maintainers should use static package lists wherever possible, as it enables users to grep(1) through available ports to discover, for example, which port installs a certain file. Dynamic lists should be primarily used for complex ports where the package list changes drastically based upon optional features of the port (and thus maintaining a static package list is infeasible), or ports which change the package list based upon the version of dependent software used. For example, ports which generate docs with Javadoc.
First, make sure the port is almost complete, with only
pkg-plist
missing. Running make
makeplist
will show an example for
pkg-plist
. The output of
makeplist
must be double checked for
correctness as it tries to automatically guess a few things, and
can get it wrong.
User configuration files should be installed as
,
as it is described in Section 8.3, “Configuration Files”.
filename
.sampleinfo/dir
must not be listed and
appropriate install-info
lines must be
added as noted in the info
files section. Any libraries installed by the port
must be listed as specified in the shared libraries
section.
Strings to be replaced sometimes need to be very specific to avoid undesired replacements. This is a common problem with shorter values.
To address this problem, for each
,
a
PLACEHOLDER
=value
can be set, with the
PLACEHOLDER
_regex=regex
part
matching regex
value
more
precisely.
Perl ports can install
architecture dependent files in a specific tree. On FreeBSD to
ease porting, this tree is called mach
.
For example, a port that installs a file whose path contains
mach
could have that part of the path
string replaced with the wrong values. Consider this
Makefile
:
PORTNAME= Machine-Build DISTVERSION= 1 CATEGORIES= devel perl5 MASTER_SITES= CPAN PKGNAMEPREFIX= p5- MAINTAINER= perl@FreeBSD.org COMMENT= Building machine USES= perl5 USE_PERL5= configure PLIST_SUB= PERL_ARCH=mach
The files installed by the port are:
/usr/local/bin/machine-build /usr/local/lib/perl5/site_perl/man/man1/machine-build.1.gz /usr/local/lib/perl5/site_perl/man/man3/Machine::Build.3.gz /usr/local/lib/perl5/site_perl/Machine/Build.pm /usr/local/lib/perl5/site_perl/mach/5.20/Machine/Build/Build.so
Running make makeplist
wrongly
generates:
bin/%%PERL_ARCH%%ine-build %%PERL5_MAN1%%/%%PERL_ARCH%%ine-build.1.gz %%PERL5_MAN3%%/Machine::Build.3.gz %%SITE_PERL%%/Machine/Build.pm %%SITE_PERL%%/%%PERL_ARCH%%/%%PERL_VER%%/Machine/Build/Build.so
Change the PLIST_SUB
line from the
Makefile
to:
PLIST_SUB= PERL_ARCH=mach \ PERL_ARCH_regex=\bmach\b
Now make makeplist
correctly
generates:
bin/machine-build %%PERL5_MAN1%%/machine-build.1.gz %%PERL5_MAN3%%/Machine::Build.3.gz %%SITE_PERL%%/Machine/Build.pm %%SITE_PERL%%/%%PERL_ARCH%%/%%PERL_VER%%/Machine/Build/Build.so
All keywords can also take optional arguments in parentheses. The arguments are owner, group, and mode. This argument is used on the file or directory referenced. To change the owner, group, and mode of a configuration file, use:
@sample(games,games,640) etc/config.sample
The arguments are optional. If only the group and mode need to be changed, use:
@sample(,games,660) etc/config.sample
If a keyword is used on an optional entry, it must to be added after the helper:
%%FOO%%@sample etc/orbit.conf.sample
This is because the options plist helpers are used to
comment out the line, so they need to be put first. See Section 5.13.3.1, “OPTIONS_SUB
” for more information.
Will run update-desktop-database -q
after installation and deinstallation.
Never use directly, add USES=desktop-file-utils
to the Makefile
.
Add a @dir
entry for the directory
passed as an argument, and run fc-cache -fs
on that directory after installation and
deinstallation.
Add a @dir
entry for the
directory passed as an argument, and run fc-cache
-fs
, mkfontscale
and
mkfontdir
on that directory after
installation and deinstallation. Additionally, on
deinstallation, it removes the
fonts.scale
and
fonts.dir
cache files if they are
empty. This keyword is equivalent to adding both @fc
directory
and @fontsdir
directory
.
Add a @dir
entry for the
directory passed as an argument, and run
mkfontscale
and
mkfontdir
on that directory after
installation and deinstallation. Additionally, on
deinstallation, it removes the
fonts.scale
and
fonts.dir
cache files if they are
empty.
Add the file passed as argument to the plist, and updates
the info document index on installation and deinstallation.
Additionally, it removes the index if empty on
deinstallation. This should never be used manually, but
always through INFO
. See Section 5.12, “Info Files” for more information.
Runs kldxref
on the directory
on installation and deinstallation. Additionally, on
deinstallation, it will remove the directory if empty.
Will remove the file on deinstallation, and not give an error if the file is not there.
This is used to handle installation of configuration
files, through example files bundled with the package. The
“actual”, non-sample, file is either the second
filename, if present, or the first filename without the
.sample
extension.
This does three things. First, add the first file passed as argument, the sample file, to the plist. Then, on installation, if the actual file is not found, copy the sample file to the actual file. And finally, on deinstallation, remove the actual file if it has not been modified. See Section 8.3, “Configuration Files” for more information.
Runs update-mime-database
on the
directory on installation and deinstallation.
Add the file passed as argument to the plist.
On installation, add the full path to
file
to
/etc/shells
, while making sure it is not
added twice. On deinstallation, remove it from
/etc/shells
.
Do not use by itself. If the port installs
files, add USES=terminfo
to its *
.terminfoMakefile
.
On installation and deinstallation, if
tic
is present, refresh
${PREFIX}/share/misc/terminfo.db
from the
files in *
.terminfo${PREFIX}/share/misc
.
There are a few keywords that are hardcoded, and documented in pkg-create(8). For the sake of completeness, they are also documented here.
The empty keyword is a placeholder to use when the
file's owner, group, or mode need to be changed. For
example, to set the group of the file to
games
and add the setgid bit, add:
@(,games,2755) sbin/daemon
Execute command
as part of
the package installation or deinstallation process.
@preexec
command
Execute command
as part
of the pre-install
scripts.
@postexec
command
Execute command
as part
of the post-install
scripts.
@preunexec
command
Execute command
as part
of the pre-deinstall
scripts.
@postunexec
command
Execute command
as part
of the post-deinstall
scripts.
If command
contains
any of these
sequences somewhere in it, they are expanded
inline. For these examples, assume that
@cwd
is set to
/usr/local
and the last
extracted file was bin/emacs
.
%F
Expand to the last filename extracted (as
specified). In the example case
bin/emacs
.
%D
Expand to the current directory prefix, as set
with @cwd
. In the example case
/usr/local
.
%B
Expand to the basename of the fully qualified
filename, that is, the current directory prefix plus
the last filespec, minus the trailing filename. In
the example case, that would be
/usr/local/bin
.
%f
Expand to the filename part of the fully qualified
name, or the converse of %B
. In
the example case,
emacs
.
These keywords are here to help you set up the package so that it is as ready to use as possible. They must not be abused to start services, stop services, or run any other commands that will modify the currently running system.
Set default permission for all subsequently extracted
files to mode
. Format is the
same as that used by chmod(1). Use without an arg to
set back to default permissions (mode of the file while
being packed).
This must be a numeric mode, like
644
, 4755
, or
600
. It cannot be a relative mode
like u+s
.
Set default ownership for all subsequent files to
user
. Use without an argument to
set back to default ownership (root
).
Set default group ownership for all subsequent files to
group
. Use without an arg to set
back to default group ownership (wheel
).
Declare directory name. By default, directories created
under PREFIX
by a package installation
are automatically removed. Use this when an empty directory
under PREFIX
needs to be created, or when
the directory needs to have non default owner, group, or
mode. Directories outside of PREFIX
need
to be registered. For example,
/var/db/${PORTNAME}
needs to have a
@dir
entry whereas
${PREFIX}/share/${PORTNAME}
does not if
it contains files or uses the default owner, group, and
mode.
Execute command
as part of
the installation or deinstallation process. Please use
Section 8.6.13.2, “@preexec
command
,
@postexec
command
,
@preunexec
command
,
@postunexec
command
” instead.
Declare directory name to be deleted at deinstall time.
By default, directories created under
PREFIX
by a package installation are
deleted when the package is deinstalled.
Package list files can be extended by keywords that are
defined in the ${PORTSDIR}/Keywords
directory. The settings for each keyword are stored in a
UCL file named
.
The file must contain at least one of these sections:keyword
.ucl
attributes
action
pre-install
post-install
pre-deinstall
post-deinstall
pre-upgrade
post-upgrade
Changes the owner, group, or mode used by the keyword.
Contains an associative array where the possible keys are
owner
, group
, and
mode
. The values are, respectively, a
user name, a group name, and a file mode. For
example:
attributes: { owner: "games", group: "games", mode: 0555 }
Defines what happens to the keyword's parameter. Contains an array where the possible values are:
setprefix
Set the prefix for the next plist entries.
dir
Register a directory to be created on install and removed on deinstall.
dirrm
Register a directory to be deleted on deinstall. Deprecated.
dirrmtry
Register a directory to try and deleted on deinstall. Deprecated.
file
Register a file.
setmode
Set the mode for the next plist entries.
setowner
Set the owner for the next plist entries.
setgroup
Set the group for the next plist entries.
comment
Does not do anything, equivalent to not entering
an action
section.
ignore_next
Ignore the next entry in the plist.
If set to true
, adds argument
handling, splitting the whole line, %@
,
into numbered arguments, %1
,
%2
, and so on. For example, for this
line:
@foo some.content other.content
%1
and %2
will
contain:
some.content other.content
It also affects how the action
entry works. When there is more than one argument, the
argument number must be specified. For example:
actions: [file(1)]
These keywords contains a sh(1) script to be
executed before or after installation, deinstallation, or
upgrade of the package. In addition to the usual
@exec
%
placeholders described in Section 8.6.13.2, “foo
@preexec
command
,
@postexec
command
,
@preunexec
command
,
@postunexec
command
”, there is a new one,
%@
, which represents the argument of the
keyword.
@dirrmtryecho
KeywordThis keyword does two things, it adds a
@dirrmtry
line to
the packing list, and echoes the fact that the directory
is removed when deinstalling the package.directory
actions: [dirrmtry] post-deinstall: <<EOD echo "Directory %D/%@ removed." EOD
@sample
is
ImplementedThis keyword does three things. It adds the first
filename
passed as an argument
to @sample
to the packing list, it adds
to the post-install
script instructions
to copy the sample to the actual configuration file if it
does not already exist, and it adds to the
post-deinstall
instructions to remove
the configuration file if it has not been modified.
actions: [file(1)] arguments: true post-install: <<EOD case "%1" in /*) sample_file="%1" ;; *) sample_file="%D/%1" ;; esac target_file="${sample_file%.sample}" set -- %@ if [ $# -eq 2 ]; then target_file=${2} fi case "${target_file}" in /*) target_file="${target_file}" ;; *) target_file="%D/${target_file}" ;; esac if ! [ -f "${target_file}" ]; then /bin/cp -p "${sample_file}" "${target_file}" && \ /bin/chmod u+w "${target_file}" fi EOD pre-deinstall: <<EOD case "%1" in /*) sample_file="%1" ;; *) sample_file="%D/%1" ;; esac target_file="${sample_file%.sample}" set -- %@ if [ $# -eq 2 ]; then set -- %@ target_file=${2} fi case "${target_file}" in /*) target_file="${target_file}" ;; *) target_file="%D/${target_file}" ;; esac if cmp -s "${target_file}" "${sample_file}"; then rm -f "${target_file}" else echo "You may need to manually remove ${target_file} if it is no longer needed." fi EOD
There are some tricks we have not mentioned yet about the
pkg-
files that
come in handy sometimes.*
To display a message when the package is installed, place
the message in pkg-message
. This
capability is often useful to display additional installation
steps to be taken after a pkg install
or
pkg upgrade
.
pkg-message
must contain only
information that is vital to setup and
operation on FreeBSD, and that is unique to the port in
question.
Setup information should only be shown on initial install. Upgrade instructions should be shown only when upgrading from the relevant version.
Do not surround the messages with either whitespace or
lines of symbols (like ----------
,
**********
, or
==========
). Leave the formatting to
pkg(8).
Committers have blanket approval to constrain existing messages to install or upgrade ranges using the UCL format specifications.
pkg-message supports two formats:
A regular plain text file. Its message is only displayed on install.
If the file starts with
“[
” then it is considered
to be a UCL file. The
UCL format is
described on libucl's
GitHub page.
Do not add an entry for pkg-message
in pkg-plist
.
The format is the following. It should be an array of objects. The objects themselves can have these keywords:
message
The actual message to be displayed. This keyword is mandatory.
type
When the message should be displayed.
maximum_version
Only if type
is
upgrade
. Display if upgrading from a
version strictly lower than the version
specified.
minimum_version
Only if type
is
upgrade
. Display if upgrading from a
version stictly greater than the version
specified.
The maximum_version
and
minimum_version
keywords can be
combined.
The type
keyword can have three
values:
install
The message should only be displayed when the package is installed.
remove
The message should only be displayed when the package is removed.
upgrade
the message should only be displayed during an upgrade of the package..
To preserve the compatibility with non
UCL pkg-message
files, the first line of a UCL
pkg-message
MUST
be a single
“[
”, and the last line
MUST be a single
“]
”.
The message is delimited by double quotes
"
, this is used for simple single line
strings:
[ { type: install message: "Simple message" } ]
Multiline strings use the standard here document
notation. The multiline delimiter must
start just after <<
symbols without
any whitespace and it must consist of
capital letters only. To finish a multiline string, add the
delimiter string on a line of its own without any
whitespace. The message from Example 9.1, “UCL Short Strings” can be written
as:
[ { type: install message: <<EOM Simple message EOM } ]
When a message only needs to be displayed on installation or uninstallation, set the type:
[ { type: remove message: "package being removed." } { type: install, message: "package being installed."} ]
When a port is upgraded, the message displayed can be even more tailored to the port's needs.
[ { type: upgrade message: "Package is being upgraded." } { type: upgrade maximum_version: "1.0" message: "Upgrading from before 1.0 need to do this." } { type: upgrade minimum_version: "1.0" message: "Upgrading from after 1.0 should do that." } { type: upgrade maximum_version: "3.0" minimum_version: "1.0" message: "Upgrading from > 1.0 and < 3.0 remove that file." } ]
When displaying a message on upgrade, it is important
to limit when it is being shown to the user. Most of the
time it is by using maximum_version
to
limit its usage to upgrades from before a certain version
when something specific needs to be done.
If the port needs to execute commands when the binary
package is installed with pkg add
or
pkg install
, use
pkg-install
. This script will
automatically be added to the package. It will be run twice by
pkg
, the first time as ${SH}
pkg-install ${PKGNAME} PRE-INSTALL
before the
package is installed, and the second time as
${SH} pkg-install ${PKGNAME}
POST-INSTALL
after it has been installed.
$2
can be tested to determine which
mode the script is being run in. The PKG_PREFIX
environmental variable will be set to the package installation
directory.
This script is here to help you set up the package so that it is as ready to use as possible. It must not be abused to start services, stop services, or run any other commands that will modify the currently running system.
This script executes when a package is removed.
This script will be run twice by pkg
delete
The first time as ${SH}
pkg-deinstall ${PKGNAME} DEINSTALL
before the
port is de-installed and the second time as
${SH} pkg-deinstall ${PKGNAME}
POST-DEINSTALL
after the port has been de-installed.
$2
can be tested to determine which
mode the script is being run in. The PKG_PREFIX
environmental variable will be set to the package installation
directory
This script is here to help you set up the package so that it is as ready to use as possible. It must not be abused to start services, stop services, or run any other commands that will modify the currently running system.
All the names of
pkg-
are
defined using variables that can be changed in the
*
Makefile
if needed. This is especially
useful when sharing the same
pkg-
files
among several ports or when it is necessary to write to one of
these files.
See writing to places other than
*
WRKDIR
for why it is a bad idea to
write directly into
the directory containing the
pkg-
files.*
Here is a list of variable names and their default values.
(PKGDIR
defaults to
${MASTERDIR}
.)
Variable | Default value |
---|---|
DESCR | ${PKGDIR}/pkg-descr |
PLIST | ${PKGDIR}/pkg-plist |
PKGINSTALL | ${PKGDIR}/pkg-install |
PKGDEINSTALL | ${PKGDIR}/pkg-deinstall |
PKGMESSAGE | ${PKGDIR}/pkg-message |
SUB_FILES
and
SUB_LIST
are useful for dynamic
values in port files, such as the installation
PREFIX
in
pkg-message
.
SUB_FILES
specifies a list
of files to be automatically modified. Each
in the
file
SUB_FILES
list must have a corresponding
present
in file
.inFILESDIR
. A modified version will be
created as
${WRKDIR}/
.
Files defined as a value of file
USE_RC_SUBR
are
automatically added to SUB_FILES
. For the files
pkg-message
,
pkg-install
, and
pkg-deinstall
, the corresponding Makefile
variable is automatically set to point to the processed
version.
SUB_LIST
is a list of
VAR=VALUE
pairs. For each pair,
%%VAR%%
will be replaced with
VALUE
in each file listed in
SUB_FILES
. Several common pairs are
automatically defined: PREFIX
,
LOCALBASE
, DATADIR
,
DOCSDIR
, EXAMPLESDIR
,
WWWDIR
, and ETCDIR
. Any
line beginning with @comment
followed by a
space, will be deleted
from resulting files after a variable substitution.
This example replaces
%%ARCH%%
with the system architecture in a
pkg-message
:
SUB_FILES= pkg-message SUB_LIST= ARCH=${ARCH}
Note that for this example,
pkg-message.in
must exist in
FILESDIR
.
Example of a good
pkg-message.in
:
Now it is time to configure this package. Copy %%PREFIX%%/share/examples/putsy/%%ARCH%%.conf into your home directory as .putsy.conf and edit it.
Several of the FreeBSD port maintenance tools, such as
portupgrade(1), rely on a database called
/usr/ports/INDEX
which keeps track of such
items as port dependencies. INDEX
is
created by the top-level ports/Makefile
via
make index
, which descends into each port
subdirectory and executes make describe
there. Thus, if make describe
fails in any
port, no one can generate INDEX
, and many
people will quickly become unhappy.
It is important to be able to generate this file no matter
what options are present in make.conf
, so
please avoid doing things such as using
.error
statements when (for instance) a
dependency is not satisfied. (See
Section 13.16, “Avoid Use of the .error
Construct”.)
If make describe
produces a string rather
than an error message, everything is probably safe. See
bsd.port.mk
for the meaning of the string
produced.
Also note that running a recent version of
portlint
(as specified in the next section)
will cause make describe
to be run
automatically.
Do check the port with portlint
before submitting or committing it. portlint
warns about many common errors, both functional and
stylistic. For a new (or repocopied) port,
portlint -A
is the most thorough; for an
existing port, portlint -C
is
sufficient.
Since portlint
uses heuristics to try to
figure out errors, it can produce false positive warnings. In
addition, occasionally something that is flagged as a problem
really cannot be done in any other way due to limitations in the
ports framework. When in doubt, the best thing to do is ask on
FreeBSD ports mailing list.
The ports-mgmt/porttools program is part of the Ports Collection.
port
is the front-end script, which can
help simplify the testing job. Whenever a new port or an update
to an existing one needs testing, use
port test
to test the port, including the
portlint
checking. This command also detects and lists any files that
are not listed in pkg-plist
. For
example:
#
port test /usr/ports/net/csup
PREFIX
determines where the port will be
installed. It defaults to /usr/local
, but
can be set by the user to a custom path like
/opt
. The port must respect the value of
this variable.
DESTDIR
, if set by the user, determines
the complete alternative environment, usually a jail or an
installed system mounted somewhere other than
/
. A port will actually install into
DESTDIR/PREFIX
, and register with the
package database in DESTDIR/var/db/pkg
. As
DESTDIR
is handled automatically by the ports
infrastructure with chroot(8). There is no need for
modifications or any extra care to write
DESTDIR
-compliant ports.
The value of PREFIX
will be set to
LOCALBASE
(defaulting to
/usr/local
). If
USE_LINUX_PREFIX
is set,
PREFIX
will be LINUXBASE
(defaulting to /compat/linux
).
Avoiding hard-coded /usr/local
paths in
the source makes the port much more flexible and able to cater
to the needs of other sites. Often, this can be accomplished by
replacing occurrences of /usr/local
in the port's various Makefile
s with
${PREFIX}
. This variable is
automatically passed down to every stage of the build and
install processes.
Make sure the application is not installing things in
/usr/local
instead of
PREFIX
. A quick test for such hard-coded
paths is:
%
make clean; make package PREFIX=/var/tmp/`make -V PORTNAME`
If anything is installed outside of
PREFIX
, the package creation process will
complain that it cannot find the files.
In addition, it is worth checking the same with the stage directory support (see Section 6.1, “Staging”):
%
make stage && make check-plist && make stage-qa && make package
check-plist
checks for files
missing from the plist, and files in the plist that are not
installed by the port.
stage-qa
checks for common
problems like bad shebang, symlinks pointing outside the
stage directory, setuid files, and non-stripped
libraries...
These tests will not find hard-coded paths inside the port's
files, nor will it verify that LOCALBASE
is
being used to correctly refer to files from other ports. The
temporarily-installed port in
/var/tmp/`make -V PORTNAME`
must be
tested for proper operation to make sure there are no problems
with paths.
PREFIX
must not be set explicitly in a
port's Makefile
. Users installing the port
may have set PREFIX
to a custom location, and
the port must respect that setting.
Refer to programs and files from other ports with the
variables mentioned above, not explicit pathnames. For
instance, if the port requires a macro PAGER
to have the full pathname of less
, do not use
a literal path of /usr/local/bin/less
.
Instead, use ${LOCALBASE}
:
-DPAGER=\"${LOCALBASE}/bin/less\"
The path with LOCALBASE
is more likely to
still work if the system administrator has moved the whole
/usr/local
tree somewhere else.
All these tests are done automatically when running
poudriere testport
or poudriere
bulk -t
. It is highly recommended that every
ports contributor install and test their ports with it. See
Section 10.5, “Poudriere” for more
information.
For a ports contributor, Poudriere is one of the most important and helpful testing and build tools. Its main features include:
Bulk building of the entire ports tree, specific subsets of the ports tree, or a single port including its dependencies
Automatic packaging of build results
Generation of build log files per port
Providing a signed pkg(8) repository
Testing of port builds before submitting a patch to the FreeBSD bug tracker or committing to the ports tree
Testing for successful ports builds using different options
Because Poudriere performs its building in a clean jail(8) environment and uses zfs(8) features, it has several advantages over traditional testing on the host system:
No pollution of the host environment: No leftover files, no accidental removals, no changes of existing configuration files.
Verify pkg-plist
for missing or
superfluous entries
Ports committers sometimes ask for a Poudriere log alongside a patch submission to assess whether the patch is ready for integration into the ports tree
It is also quite straightforward to set up and use, has no dependencies, and will run on any supported FreeBSD release. This section shows how to install, configure, and run Poudriere as part of the normal workflow of a ports contributor.
The examples in this section show a default file layout, as
standard in FreeBSD. Substitute any local changes accordingly.
The ports tree, represented by ${PORTSDIR}
,
is located in /usr/ports
. Both
${LOCALBASE}
and ${PREFIX}
are /usr/local
by default.
Poudriere is available in the ports tree in ports-mgmt/poudriere. It can be installed using pkg(8) or from ports:
#
pkg install poudriere
or
#
make -C /usr/ports/ports-mgmt/poudriere install clean
There is also a work-in-progress version of Poudriere which will eventually become the next release. It is available in ports-mgmt/poudriere-devel. This development version is used for the official FreeBSD package builds, so it is well tested. It often has newer interesting features. A ports committer will want to use the development version because it is what is used in production, and has all the new features that will make sure everything is exactly right. A contributor will not necessarily need those as the most important fixes are backported to released version. The main reason for the use of the development version to build the official package is because it is faster, in a way that will shorten a full build from 18 hours to 17 hours when using a high end 32 CPU server with 128GB of RAM. Those optimizations will not matter a lot when building ports on a desktop machine.
The port installs a default configuration file,
/usr/local/etc/poudriere.conf
. Each
parameter is documented in the configuration file and in
poudriere(8). Here is a minimal example config
file:
ZPOOL=tank ZROOTFS=/poudriere BASEFS=/poudriere DISTFILES_CACHE=/usr/ports/distfiles RESOLV_CONF=/etc/resolv.conf FREEBSD_HOST=ftp://ftp.freebsd.org SVN_HOST=svn.FreeBSD.org
ZPOOL
The name of the ZFS storage pool
which Poudriere shall use.
Must be listed in the output of zpool
status
.
ZROOTFS
The root of
Poudriere-managed file
systems. This entry will cause
Poudriere to create
zfs(8) file systems under
tank/poudriere
.
BASEFS
The root mount point for
Poudriere file systems. This
entry will cause Poudriere to
mount tank/poudriere
to
/poudriere
.
DISTFILES_CACHE
Defines where distfiles are stored. In this example, Poudriere and the host share the distfiles storage directory. This avoids downloading tarballs which are already present on the system. Please create this directory if it does not already exist so that Poudriere can find it.
RESOLV_CONF
Use the host /etc/resolv.conf
inside jails for DNS. This is needed
so jails can resolve the URLs of
distfiles when downloading. It is not needed when using
a proxy. Refer to the default configuration file for
proxy configuration.
FREEBSD_HOST
The FTP/HTTP
server to use when the jails are installed from FreeBSD
releases and updated with freebsd-update(8).
Choose a server location which is close, for example if
the machine is located in Australia, use
ftp.au.freebsd.org
.
SVN_HOST
The server from where jails are installed and updated when using Subversion. Also used for ports tree when not using portsnap(8). Again, choose a nearby location. A list of official Subversion mirrors can be found in the FreeBSD Handbook Subversion section.
Create the base jails which Poudriere will use for building:
#
poudriere jail -c -j 113Ramd64 -v 11.3-RELEASE -a amd64
Fetch a 11.3-RELEASE
for
amd64
from the FTP
server given by FREEBSD_HOST
in
poudriere.conf
, create the zfs file
system tank/poudriere/jails/113Ramd64
, mount
it on /poudriere/jails/113Ramd64
and
extract the 11.3-RELEASE
tarballs into this
file system.
#
poudriere jail -c -j 11i386 -v stable/11 -a i386 -m svn+https
Create tank/poudriere/jails/11i386
,
mount it on /poudriere/jails/11i386
, then
check out the tip of the Subversion
branch of FreeBSD-11-STABLE
from
SVN_HOST
in
poudriere.conf
into
/poudriere/jails/11i386/usr/src
, then
complete a buildworld
and install
it into /poudriere/jails/11i386
.
If a specific Subversion revision is needed, append it to the version string. For example:
#
poudriere jail -c -j 11i386 -v stable/11@123456 -a i386 -m svn+https
While it is possible to build a newer version of FreeBSD on
an older version, most of the time it will not run. For
example, if a stable/11
jail is needed,
the host will have to run stable/11
too.
Running 11.3-RELEASE
is not
enough.
To create a Poudriere jail
for 13.0-CURRENT
:
#
poudriere jail -c -j 13amd64 -v head -a amd64 -m svn+https
In order to run a 13.0-CURRENT
Poudriere jail you must be
running 13.0-CURRENT
. In general, newer
kernels can build and run older jails. For instance, a
13.0-CURRENT
kernel can build and run a
11.3-STABLE
Poudriere jail if the
COMPAT_FREEBSD11
kernel option was
compiled in (on by default in
13.0-CURRENT
GENERIC
kernel config).
The default svn
protocol works but is
not very secure. Using svn+https
along
with verifying the remote server's SSL
fingerprint is advised. It will ensure that the files used
for building the jail are from a trusted source.
A list of jails currently known to
Poudriere can be shown with
poudriere jail -l
:
#
poudriere jail -l
JAILNAME VERSION ARCH METHOD 113Ramd64 11.3-RELEASE amd64 ftp 11i386 11.3-STABLE i386 svn+https
Managing updates is very straightforward. The command:
#
poudriere jail -u -j
JAILNAME
updates the specified jail to the latest version available. For FreeBSD releases, update to the latest patchlevel with freebsd-update(8). For FreeBSD versions built from source, update to the latest Subversion revision in the branch.
For jails employing a
svn+
method,
it is helpful to add *
-J
to speed up the build by increasing the number of parallel
compile jobs used. For example, if the building machine has
6 CPUs, use:NumberOfParallelBuildJobs
#
poudriere jail -u -J 6 -j
JAILNAME
There are multiple ways to use ports trees in Poudriere. The most straightforward way is to have Poudriere create a default ports tree for itself, using either portsnap(8) (if running FreeBSD 12.1 or 11.4) or Subversion (if running FreeBSD-CURRENT):
#
poudriere ports -c -m portsnap
or
#
poudriere ports -c -m svn+https
These commands create
tank/poudriere/ports/default
, mount it on
/poudriere/ports/default
, and populate it
using either portsnap(8) or
Subversion. Afterward it is
included in the list of known ports trees:
#
poudriere ports -l
PORTSTREE METHOD TIMESTAMP PATH default svn+https 2020-07-20 04:23:56 /poudriere/ports/default
Note that the “default” ports tree is
special. Each of the build commands explained later will
implicitly use this ports tree unless specifically specified
otherwise. To use another tree, add -p
to the
commands.treename
While useful for regular bulk builds, having this default ports tree with the portsnap(8) method may not be the best way to deal with local modifications for a ports contributor. As with the creation of jails, it is possible to use a different method for creating the ports tree. To add an additional ports tree for testing local modifications and ports development, checking out the tree via Subversion (as described above) is preferable.
The http and https
methods need devel/subversion
built with the SERF
option enabled. It
is enabled by default.
The svn
method allows extra
qualifiers to tell Subversion
exactly how to fetch data. This is explained in
poudriere(8). For instance, poudriere ports
-c -m svn+ssh -p subversive
uses
SSH for the checkout.
Depending on the workflow, it can be extremely helpful to
use ports trees which are maintained manually. For instance,
if there is a local copy of the ports tree in
/work/ports
, point
Poudriere to the location:
For Poudriere older than version 3.1.20:
#
poudriere ports -c -F -f none -M /work/ports -p development
For Poudriere version 3.1.20 and later:
#
poudriere ports -c -m null -M /work/ports -p development
This will be listed in the table of known trees:
#
poudriere ports -l
PORTSTREE METHOD TIMESTAMP PATH development null 2020-07-20 05:06:33 /work/ports
The dash or null
in the METHOD
column means
that Poudriere will not update or
change this ports tree, ever. It is completely up to the
user to maintain this tree, including all local
modifications that may be used for testing new ports and
submitting patches.
As straightforward as with jails described earlier:
#
poudriere ports -u -p
PORTSTREE
Will update the given
PORTSTREE
, one tree given by the
output of poudriere -l
, to the latest
revision available on the official servers.
Ports trees without a method, see Section 10.5.6, “Using Manually Managed Ports Trees with Poudriere”, cannot be updated like this. They must be updated manually by the porter.
After jails and ports trees have been set up, the result of a contributor's modifications to the ports tree can be tested.
For example, local modifications to the www/firefox port located in
/work/ports/www/firefox
can be tested in
the previously created 11.3-RELEASE jail:
#
poudriere testport -j 113Ramd64 -p development -o www/firefox
This will build all dependencies of Firefox. If a dependency has been built previously and is still up-to-date, the pre-built package is installed. If a dependency has no up-to-date package, one will be built with default options in a jail. Then Firefox itself is built.
The complete build of every port is logged to
/poudriere/data/logs/bulk/113Ri386-development/
.build-time
/logs
The directory name 113Ri386-development
is derived from the arguments to -j
and
-p
, respectively. For convenience, a
symbolic link
/poudriere/data/logs/bulk/113Ri386-development/latest
is also maintained. The link points to the latest
build-time
directory. Also in this
directory is an index.html
for observing
the build process with a web browser.
By default, Poudriere cleans up
the jails and leaves log files in the directories mentioned
above. To ease investigation, jails can be kept running after
the build by adding -i
to
testport
:
#
poudriere testport -j 113Ramd64 -p development -i -o www/firefox
After the build completes, and regardless of whether it
was successful, a shell is provided within the jail. The
shell is used to investigate further.
Poudriere can be told to leave the
jail running after the build finishes with
-I
. Poudriere
will show the command to run when the jail is no longer
needed. It is then possible to jexec(8) into it:
#
poudriere testport -j 113Ramd64 -p development -I -o www/firefox
[...] ====>> Installing local Pkg repository to /usr/local/etc/pkg/repos ====>> Leaving jail 113Ramd64-development-n running, mounted at /poudriere/data/.m/113Ramd64-development/ref for interactive run testing ====>> To enter jail: jexec 113Ramd64-development-n env -i TERM=$TERM /usr/bin/login -fp root ====>> To stop jail: poudriere jail -k -j 113Ramd64 -p development#
jexec 113Ramd64-development-n env -i TERM=$TERM /usr/bin/login -fp root
#
[do some stuff in the jail]
#
exit
#
poudriere jail -k -j 113Ramd64 -p development
====>> Umounting file systems
An integral part of the FreeBSD ports build infrastructure is
the ability to tweak ports to personal preferences with
options. These can be tested with
Poudriere as well. Adding the
-c
:
#
poudriere testport -c -o www/firefox
Presents the port configuration dialog before the port is
built. The ports given after -o
in the
format
will use the specified options, all dependencies will use the
default options. Testing dependent ports with non-default
options can be accomplished using sets, see Section 10.5.9, “Using Sets”.category
/portname
When testing ports where pkg-plist
is altered during build depending on the selected options,
it is recommended to perform a test run with all options
selected and one with all options
deselected.
For all actions involving builds, a so-called
set can be specified using -z
. A set refers
to a fully independent build. This allows, for instance,
usage of setname
testport
with non-standard options
for the dependent ports.
To use sets, Poudriere expects
an existing directory structure similar to
PORT_DBDIR
, defaults to
/var/db/ports
in its configuration
directory. This directory is then nullfs(5)-mounted into the
jails where the ports and their dependencies are built.
Usually a suitable starting point can be obtained by
recursively copying the existing PORT_DBDIR
to
/usr/local/etc/poudriere.d/
.
This is described in detail in poudriere(8). For
instance, testing www/firefox
in a specific set named jailname
-portname
-setname
-optionsdevset
, add the
-z devset
parameter to the testport
command:
#
poudriere testport -j 113Ramd64 -p development -z devset -o www/firefox
This will look for the existence of these directories in this order:
/usr/local/etc/poudriere.d/113Ramd64-development-devset-options
/usr/local/etc/poudriere.d/113Ramd64-devset-options
/usr/local/etc/poudriere.d/113Ramd64-development-options
/usr/local/etc/poudriere.d/devset-options
/usr/local/etc/poudriere.d/development-options
/usr/local/etc/poudriere.d/113Ramd64-options
/usr/local/etc/poudriere.d/options
From this list, Poudriere
nullfs(5)-mounts the first existing
directory tree into the /var/db/ports
directory of the build jails. Hence, all custom options are
used for all the ports during this run of
testport
.
After the directory structure for a set is provided, the options for a particular port can be altered. For example:
#
poudriere options -c www/firefox -z devset
The configuration dialog for www/firefox is shown, and options can
be edited. The selected options are saved to the
devset
set.
Poudriere is very flexible in the option configuration. They can be set for particular jails, ports trees, and for multiple ports by one command. Refer to poudriere(8) for details.
Similar to using sets,
Poudriere will also use a custom
make.conf
if it is provided. No special
command line argument is necessary. Instead,
Poudriere looks for existing files
matching a name scheme derived from the command line. For
instance:
#
poudriere testport -j 113Ramd64 -p development -z devset -o www/firefox
causes Poudriere to check for the existence of these files in this order:
/usr/local/etc/poudriere.d/make.conf
/usr/local/etc/poudriere.d/devset-make.conf
/usr/local/etc/poudriere.d/development-make.conf
/usr/local/etc/poudriere.d/113Ramd64-make.conf
/usr/local/etc/poudriere.d/113Ramd64-development-make.conf
/usr/local/etc/poudriere.d/113Ramd64-devset-make.conf
/usr/local/etc/poudriere.d/113Ramd64-development-devset-make.conf
Unlike with sets, all of the found files will be appended,
in that order, into one
make.conf
inside the build jails. It is
hence possible to have general make variables, intended to
affect all builds in
/usr/local/etc/poudriere.d/make.conf
.
Special variables, intended to affect only certain jails or
sets can be set in specialised make.conf
files, such as
/usr/local/etc/poudriere.d/113Ramd64-development-devset-make.conf
.
make.conf
to Change Default
PerlTo build a set with a non default
Perl version, for example,
5.20
, using a set named
perl5-20
, create a
perl5-20-make.conf
with this
line:
DEFAULT_VERSIONS+= perl=5.20
Note the use of +=
so that if the
variable is already set in the default
make.conf
its content will not be
overwritten.
Poudriere comes with a built-in mechanism to remove outdated distfiles that are no longer used by any port of a given tree. The command
#
poudriere distclean -p
portstree
will scan the distfiles folder,
DISTFILES_CACHE
in
poudriere.conf
, versus the ports tree
given by the -p
argument and
prompt for removal of those distfiles. To skip the prompt and
remove all unused files unconditionally, the
portstree
-y
argument can be added:
#
poudriere distclean -p
portstree
-y
When a port is not the most recent version available from the
authors, update the local working copy of
/usr/ports
. The port might have already been
updated to the new version.
When working with more than a few ports, it will probably be easier to use Subversion to keep the whole ports collection up-to-date, as described in the Handbook. This will have the added benefit of tracking all the port's dependencies.
The next step is to see if there is an update already pending.
To do this, there are two options. There is a searchable
interface to the FreeBSD Problem
Report (PR) or bug database. Select Ports &
Packages
in the Product
multiple
select menu, and
enter the name of the port in the Summary
field.
However, sometimes people forget to put the name of the port
into the Summary field in an unambiguous fashion. In that
case, try searching in the Comment
field in
the Detailled Bug Information
section, or try
the
FreeBSD Ports Monitoring System
(also known as portsmon
). This system
attempts to classify port PRs by portname. To search for PRs
about a particular port, use the Overview
of One Port.
If there is no pending PR, the next step is to send an email
to the port's maintainer, as shown by
make maintainer
. That person may already be
working on an upgrade, or have a reason to not upgrade the port
right now (because of, for example, stability problems of the
new version), and there is no need to duplicate their work. Note
that unmaintained ports are listed with a maintainer of
ports@FreeBSD.org
, which is just the general
ports mailing list, so sending mail there probably will not help
in this case.
If the maintainer asks you to do the upgrade or there is no maintainer, then help out FreeBSD by preparing the update! Please do this by using the diff(1) command in the base system.
To create a suitable diff
for a single
patch, copy the file that needs patching to
,
save the changes to
something
.orig
and then
create the patch:something
%
diff -u
something
.origsomething
> something.diff
Otherwise, either use the
svn diff
method (Section 11.1, “Using Subversion to Make
Patches”)
or copy the contents of the port to an entire different
directory and use the result of the recursive diff(1)
output of the new and old ports directories (for example, if the
modified port directory is called superedit
and the original is in our tree as
superedit.bak
, then save the result of
diff -ruN superedit.bak superedit
). Either
unified or context diff is fine, but port committers generally
prefer unified diffs. Note the use of the -N
option—this is the accepted way to force diff to properly
deal with the case of new files being added or old files being
deleted. Before sending us the diff, please examine the output
to make sure all the changes make sense. (In particular, make
sure to first clean out the work directories with
make clean
).
If some files have been added, copied, moved, or removed, add this information to the problem report so that the committer picking up the patch will know what svn(1) commands to run.
To simplify common operations with patch files, use
make makepatch
as described in Section 4.4, “Patching”.
Other tools exists, like
/usr/ports/Tools/scripts/patchtool.py
.
Before using it, please read
/usr/ports/Tools/scripts/README.patchtool
.
If the port is unmaintained, and you are actively using it, please consider volunteering to become its maintainer. FreeBSD has over 4000 ports without maintainers, and this is an area where more volunteers are always needed. (For a detailed description of the responsibilities of maintainers, refer to the section in the Developer's Handbook.)
To submit the diff, use the bug submit
form (product Ports & Packages
,
component Individual Port(s)
).
Always include the category
with the port name, followed by colon, and brief descripton of the
issue. Examples:
;
category/portname
:
add FOO option
.
Please mention any added or
deleted files in the message, as they have to be explicitly
specified to svn(1) when doing a commit. Do not compress or
encode the diff.category/portname
:
Update to X.Y
Before submitting the bug, review the Writing the problem report section in the Problem Reports article. It contains far more information about how to write useful problem reports.
If the upgrade is motivated by security concerns or a
serious fault in the currently committed port, please notify
the Ports Management Team <portmgr@FreeBSD.org>
to request immediate rebuilding and
redistribution of the port's package. Unsuspecting users
of pkg
will otherwise continue to install
the old version via pkg install
for several
weeks.
Please use diff(1) or svn diff
to
create updates to existing ports. Other formats include the
whole file and make it impossible to see just what has changed.
When diffs are not included, the entire update might be
ignored.
Now that all of that is done, read about how to keep up-to-date in Chapter 16, Keeping Up.
When possible, please submit a svn(1) diff. They
are easier to handle than diffs between
“new and old” directories. It is easier
to see what has changed, and to update the diff if
something was modified in the Ports Collection since the
work on it began, or if the
committer asks for something to be fixed. Also, a patch
generated with svn diff
can be easily applied
with svn patch
and will save some time to the
committer.
%
cd ~/my_wrkdir
![]()
%
svn co
https://svn.FreeBSD.org
/ports/head/dns/pdnsd![]()
%
cd ~/my_wrkdir/pdnsd
This can be anywhere, of course. Building
ports is not limited to within
| |
svn.FreeBSD.org is the FreeBSD public Subversion server. See Subversion mirror sites for more information. |
While in the port directory, make any changes that are
needed. If adding, copying, moving, or removing a
file, use svn
to track these changes:
%
svn add
new_file
%
svn copy
some_file
file_copy
%
svn move
old_name
new_name
%
svn remove
deleted_file
Make sure to check the port using the checklist in
Section 3.4, “Testing the Port” and
Section 3.5, “Checking the Port with
portlint
”.
%
svn status
%
svn update
This will attempt to merge the differences between the patch and current repository version. Watch the output carefully. The letter in front of each file name indicates what was done with it. See Table 11.1, “Subversion Update File Prefixes” for a complete list. |
U | The file was updated without problems. |
G | The file was updated without problems (only when working against a remote repository). |
M | The file had been modified, and was merged without conflicts. |
C | The file had been modified, and was merged with conflicts. |
If C
is displayed as a result of
svn update
, it means something changed in
the Subversion repository and
svn(1) was not able to merge the local changes with those
from the repository. It is always a good idea to inspect the
changes anyway, since svn(1) does not know anything about
the structure of a port, so it might (and probably will) merge
things that do not make sense.
The last step is to make a unified diff(1) of the changes:
%
svn diff > ../`make -VPKGNAME`.diff
If files have been added, copied, moved, or removed,
include the svn(1) add
,
copy
, move
, and
remove
commands that were used.
svn move
or svn copy
must be run before the patch can be applied. svn
add
or svn remove
must be run
after the patch is applied.
Send the patch following the problem report submission guidelines.
If upgrading the port requires special steps like changing configuration files or running a specific program, it must be documented in this file. The format of an entry in this file is:
YYYYMMDD: AFFECTS: users of portcategory/portname AUTHOR: Your name <Your email address> Special instructions
When including exact portmaster, portupgrade, and/or pkg instructions, please make sure to get the shell escaping right. For example, do not use:
#
pkg delete -g -f docbook-xml* docbook-sk* docbook[2345]??-* docbook-4*
As shown, the command will only work with bourne shells. Instead, use the form shown below, which will work with both bourne shell and c-shell:
#
pkg delete -g -f docbook-xml\* docbook-sk\* docbook\[2345\]\?\?-\* docbook-4\*
It is recommended that the AFFECTS line contains a glob
matching all the ports affected by the entry so that
automated tools can parse it as easily as possible. If an
update concerns all the existing BIND
9 versions the AFFECTS
content must be users of dns/bind9*
, it
must not be users of BIND
9
This file is used to
list moved or removed ports. Each line in the file is made
up of the name of the port, where the port was moved, when,
and why. If the port was removed, the section detailing where
it was moved can be left blank. Each section must be
separated by the |
(pipe) character, like
so:
old name|new name (blank for deleted)|date of move|reason
The date must be entered in the form
YYYY-MM-DD
. New entries are added to
the end of the list to keep it in chronological order,
with the oldest entry at the top of the list.
If a port was removed but has since been restored, delete the line in this file that states that it was removed.
If a port was renamed and then renamed back to its original name, add a new one with the intermediate name to the old name, and remove the old entry as to not create a loop.
Any changes must be validated with
Tools/scripts/MOVEDlint.awk
.
If using a ports directory other than
/usr/ports
, use:
%
cd
/home/user/ports
%
env PORTSDIR=$PWD Tools/scripts/MOVEDlint.awk
Bugs are occasionally introduced to the software. Arguably, the most dangerous of them are those opening security vulnerabilities. From the technical viewpoint, such vulnerabilities are to be closed by exterminating the bugs that caused them. However, the policies for handling mere bugs and security vulnerabilities are very different.
A typical small bug affects only those users who have enabled some combination of options triggering the bug. The developer will eventually release a patch followed by a new version of the software, free of the bug, but the majority of users will not take the trouble of upgrading immediately because the bug has never vexed them. A critical bug that may cause data loss represents a graver issue. Nevertheless, prudent users know that a lot of possible accidents, besides software bugs, are likely to lead to data loss, and so they make backups of important data; in addition, a critical bug will be discovered really soon.
A security vulnerability is all different. First, it may remain unnoticed for years because often it does not cause software malfunction. Second, a malicious party can use it to gain unauthorized access to a vulnerable system, to destroy or alter sensitive data; and in the worst case the user will not even notice the harm caused. Third, exposing a vulnerable system often assists attackers to break into other systems that could not be compromised otherwise. Therefore closing a vulnerability alone is not enough: notify the audience of it in the most clear and comprehensive manner, which will allow them to evaluate the danger and take appropriate action.
While on the subject of ports and packages, a security
vulnerability may initially appear in the original distribution
or in the port files. In the former case, the original software
developer is likely to release a patch or a new version
instantly. Update the port promptly
with respect to the author's fix. If the fix is delayed for
some reason, either
mark the port as
FORBIDDEN
or introduce a patch file
to the port. In the case of a vulnerable port, just
fix the port as soon as possible. In either case, follow
the standard procedure for
submitting changes unless having
rights to commit it directly to the ports tree.
Being a ports committer is not enough to commit to an arbitrary port. Remember that ports usually have maintainers, must be respected.
Please make sure that the port's revision is bumped as soon
as the vulnerability has been closed. That is how the users who
upgrade installed packages on a regular basis will see they need
to run an update. Besides, a new package will be built and
distributed over FTP and WWW mirrors, replacing the vulnerable
one. Bump PORTREVISION
unless
DISTVERSION
has changed in the course of
correcting the vulnerability. That is, bump
PORTREVISION
if adding a patch file
to the port, but do not bump it if updating the port to
the latest software version and thus already touched
DISTVERSION
. Please refer to the
corresponding
section for more information.
A very important and urgent step to take as early after a security vulnerability is discovered as possible is to notify the community of port users about the jeopardy. Such notification serves two purposes. First, if the danger is really severe it will be wise to apply an instant workaround. For example, stop the affected network service or even deinstall the port completely until the vulnerability is closed. Second, a lot of users tend to upgrade installed packages only occasionally. They will know from the notification that they must update the package without delay as soon as a corrected version is available.
Given the huge number of ports in the tree, a security advisory cannot be issued on each incident without creating a flood and losing the attention of the audience when it comes to really serious matters. Therefore security vulnerabilities found in ports are recorded in the FreeBSD VuXML database. The Security Officer Team members also monitor it for issues requiring their intervention.
Committers can update the VuXML database themselves, assisting the Security Officer Team and delivering crucial information to the community more quickly. Those who are not committers or have discovered an exceptionally severe vulnerability should not hesitate to contact the Security Officer Team directly, as described on the FreeBSD Security Information page.
The VuXML database is an XML document.
Its source file vuln.xml
is kept right
inside the port security/vuxml.
Therefore the file's full pathname will be
PORTSDIR/security/vuxml/vuln.xml
. Each
time a security vulnerability is discovered in a port, please
add an entry for it to that file. Until familiar with
VuXML, the best thing to do is to find an existing entry
fitting the case at hand, then copy it and use it as a
template.
The full-blown XML format is complex, and far beyond the scope of this book. However, to gain basic insight on the structure of a VuXML entry only the notion of tags is needed. XML tag names are enclosed in angle brackets. Each opening <tag> must have a matching closing </tag>. Tags may be nested. If nesting, the inner tags must be closed before the outer ones. There is a hierarchy of tags, that is, more complex rules of nesting them. This is similar to HTML. The major difference is that XML is eXtensible, that is, based on defining custom tags. Due to its intrinsic structure XML puts otherwise amorphous data into shape. VuXML is particularly tailored to mark up descriptions of security vulnerabilities.
Now consider a realistic VuXML entry:
<vuln vid="f4bc80f4-da62-11d8-90ea-0004ac98a7b9"><topic>Several vulnerabilities found in Foo</topic>
<affects> <package> <name>foo</name>
<name>foo-devel</name> <name>ja-foo</name> <range><ge>1.6</ge><lt>1.9</lt></range>
<range><ge>2.*</ge><lt>2.4_1</lt></range> <range><eq>3.0b1</eq></range> </package> <package> <name>openfoo</name>
<range><lt>1.10_7</lt></range>
<range><ge>1.2,1</ge><lt>1.3_1,1</lt></range> </package> </affects> <description> <body xmlns="http://www.w3.org/1999/xhtml"> <p>J. Random Hacker reports:</p>
<blockquote cite="http://j.r.hacker.com/advisories/1"> <p>Several issues in the Foo software may be exploited via carefully crafted QUUX requests. These requests will permit the injection of Bar code, mumble theft, and the readability of the Foo administrator account.</p> </blockquote> </body> </description> <references>
<freebsdsa>SA-10:75.foo</freebsdsa>
<freebsdpr>ports/987654</freebsdpr>
<cvename>CAN-2010-0201</cvename>
<cvename>CAN-2010-0466</cvename> <bid>96298</bid>
<certsa>CA-2010-99</certsa>
<certvu>740169</certvu>
<uscertsa>SA10-99A</uscertsa>
<uscertta>SA10-99A</uscertta>
<mlist msgid="201075606@hacker.com">http://marc.theaimsgroup.com/?l=bugtraq&m=203886607825605</mlist>
<url>http://j.r.hacker.com/advisories/1</url>
</references> <dates> <discovery>2010-05-25</discovery>
<entry>2010-07-13</entry>
<modified>2010-09-17</modified>
</dates> </vuln>
The tag names are supposed to be self-explanatory so we shall take a closer look only at fields which needs to be filled in:
This is the top-level tag of a VuXML entry. It has a
mandatory attribute, | |
This is a one-line description of the issue found. | |
The names of packages affected are listed there. Multiple names can be given since several packages may be based on a single master port or software product. This may include stable and development branches, localized versions, and slave ports featuring different choices of important build-time configuration options. Important:It is the submitter's responsibility to find all
such related packages when writing a VuXML entry. Keep
in mind that
| |
Affected versions of the package(s) are specified
there as one or more ranges using a combination of
In a range specification, The above example specifies that affected are versions
| |
Several related package groups (essentially, ports)
can be listed in the | |
The version ranges have to allow for
| |
This is a summary of the issue. XHTML is used in this
field. At least enclosing | |
This section contains references to relevant documents. As many references as apply are encouraged. | |
This is a FreeBSD security advisory. | |
This is a FreeBSD problem report. | |
This is a MITRE CVE identifier. | |
This is a SecurityFocus Bug ID. | |
This is a US-CERT security advisory. | |
This is a US-CERT vulnerability note. | |
This is a US-CERT Cyber Security Alert. | |
This is a US-CERT Technical Cyber Security Alert. | |
This is a URL to an archived posting in a mailing
list. The attribute | |
This is a generic URL. Only it if none of the other reference categories apply. | |
This is the date when the issue was disclosed
( | |
This is the date when the entry was added
( | |
This is the date when any information in the entry was
last modified ( |
This example describes a new entry for a vulnerability in
the package dropbear
that has been fixed in
version dropbear-2013.59
.
As a prerequisite, install a fresh version of security/vuxml port.
First, check whether there already is an entry for this
vulnerability. If there were such an entry, it would match
the previous version of the package,
2013.58
:
%
pkg audit dropbear-2013.58
If there is none found, add a new entry for this vulnerability.
%
cd ${PORTSDIR}/security/vuxml
%
make newentry
Verify its syntax and formatting:
%
make validate
At least one of these packages needs to be installed: textproc/libxml2, textproc/jade.
Verify that the <affected>
section of the entry will match the correct packages:
%
pkg audit -f ${PORTSDIR}/security/vuxml/vuln.xml dropbear-2013.58
Make sure that the entry produces no spurious matches in the output.
Now check whether the right package versions are matched by the entry:
%
pkg audit -f ${PORTSDIR}/security/vuxml/vuln.xml dropbear-2013.58 dropbear-2013.59
dropbear-2012.58 is vulnerable: dropbear -- exposure of sensitive information, DoS CVE: CVE-2013-4434 CVE: CVE-2013-4421 WWW: http://portaudit.FreeBSD.org/8c9b48d1-3715-11e3-a624-00262d8b701d.html 1 problem(s) in the installed packages found.
The former version matches while the latter one does not.
WRKDIR
WRKDIRPREFIX
bsd.port.mk
exec
Statement in Wrapper
ScriptsCC
and
CXX
CFLAGS
README.html
BROKEN
, FORBIDDEN
, or
IGNORE
DEPRECATED
or
EXPIRATION_DATE
.error
Constructsysctl
Here is a list of common dos and don'ts that are encountered during the porting process. Check the port against this list, but also check ports in the PR database that others have submitted. Submit any comments on ports as described in Bug Reports and General Commentary. Checking ports in the PR database will both make it faster for us to commit them, and prove that you know what you are doing.
Do not write anything to files outside
WRKDIR
. WRKDIR
is the
only place that is guaranteed to be writable during the port
build (see
installing ports from a CDROM for an example of
building ports from a read-only tree). The
pkg-
files can
be modified by redefining a
variable rather than overwriting the file.*
Make sure the port honors WRKDIRPREFIX
.
Most ports do not have to worry about this. In particular, when
referring to a WRKDIR
of another
port, note that the correct location is
WRKDIRPREFIXPORTSDIR/
not
subdir
/name
/workPORTSDIR/
or
subdir
/name
/work.CURDIR/../../
or some such.subdir
/name
/work
Also, if defining WRKDIR
,
make sure to prepend
${WRKDIRPREFIX}${.CURDIR}
in
the front.
Some code needs modifications or
conditional compilation based upon what version of FreeBSD Unix it
is running under. The preferred way to tell FreeBSD versions apart
are the __FreeBSD_version
and
__FreeBSD__
macros defined in sys/param.h.
If this file is not included add the code,
#include <sys/param.h>
to the proper place in the .c
file.
__FreeBSD__
is defined in all versions
of FreeBSD as their major version number. For example, in FreeBSD
9.x, __FreeBSD__
is defined to be
9
.
#if __FreeBSD__ >= 9 # if __FreeBSD_version >= 901000 /* 9.1+ release specific code here */ # endif #endif
A complete list of __FreeBSD_version
values is available in Chapter 18, __FreeBSD_version
Values.
Do not write anything after the
.include <bsd.port.mk>
line. It
usually can be avoided by including
bsd.port.pre.mk
somewhere in the middle of
the Makefile
and
bsd.port.post.mk
at the end.
Include either the
bsd.port.pre.mk
/bsd.port.post.mk
pair or bsd.port.mk
only; do not mix
these two usages.
bsd.port.pre.mk
only defines a few
variables, which can be used in tests in the
Makefile
,
bsd.port.post.mk
defines the rest.
Here are some important variables defined in
bsd.port.pre.mk
(this is not the complete
list, please read bsd.port.mk
for the
complete list).
Variable | Description |
---|---|
ARCH | The architecture as returned by
uname -m (for example,
i386 ) |
OPSYS | The operating system type, as returned by
uname -s (for example,
FreeBSD ) |
OSREL | The release version of the operating system
(for example, 2.1.5 or
2.2.7 ) |
OSVERSION | The numeric version of the operating system; the
same as __FreeBSD_version . |
LOCALBASE | The base of the “local” tree (for
example, /usr/local ) |
PREFIX | Where the port installs itself (see
more on
PREFIX ). |
When MASTERDIR
is needed, always define
it before including
bsd.port.pre.mk
.
Here are some examples of things that can be added after
bsd.port.pre.mk
:
# no need to compile lang/perl5 if perl5 is already in system .if ${OSVERSION} > 300003 BROKEN= perl is in system .endif
Always use tab instead of spaces after
BROKEN=
.
If the port installs a shell script whose purpose is to
launch another program, and if launching that program is the
last action performed by the script, make sure to launch the
program using the exec
statement, for
instance:
#!/bin/sh exec %%LOCALBASE%%/bin/java -jar %%DATADIR%%/foo.jar "$@"
The exec
statement replaces the shell
process with the specified program. If
exec
is omitted, the shell process remains
in memory while the program is executing, and needlessly
consumes system resources.
The Makefile
should do things in a
simple and reasonable manner. Making it a couple of lines
shorter or more readable is always better. Examples include
using a make .if
construct instead of a shell
if
construct, not redefining
do-extract
if redefining
EXTRACT*
is enough, and using
GNU_CONFIGURE
instead of
CONFIGURE_ARGS
+= --prefix=${PREFIX}
.
If a lot of new code is needed to do something, there may
already be an implementation of it in
bsd.port.mk
. While hard to read, there are
a great many seemingly-hard problems for which
bsd.port.mk
already provides a shorthand
solution.
The port must respect both CC
and
CXX
. What we mean by this is that
the port must not set the values of these variables absolutely,
overriding existing values; instead, it may append whatever
values it needs to the existing values. This is so that build
options that affect all ports can be set globally.
If the port does not respect these variables,
please add
NO_PACKAGE=ignores either cc or cxx
to the
Makefile
.
Here is an example of a Makefile
respecting both CC
and
CXX
. Note the ?=
:
CC?= gcc
CXX?= g++
Here is an example which respects neither
CC
nor CXX
:
CC= gcc
CXX= g++
Both CC
and CXX
can be defined on FreeBSD systems in
/etc/make.conf
. The first example defines
a value if it was not previously set in
/etc/make.conf
, preserving any system-wide
definitions. The second example clobbers anything previously
defined.
The port must respect CFLAGS
.
What we mean by this is that the port must not set
the value of this variable absolutely, overriding the existing
value. Instead, it may append whatever values it needs to the
existing value. This is so that build options that affect all
ports can be set globally.
If it does not, please add
NO_PACKAGE=ignores cflags
to the
Makefile
.
Here is an example of a Makefile
respecting CFLAGS
. Note the
+=
:
CFLAGS+= -Wall -Werror
Here is an example which does not respect
CFLAGS
:
CFLAGS= -Wall -Werror
CFLAGS
is defined on
FreeBSD systems in /etc/make.conf
. The first
example appends additional flags to
CFLAGS
, preserving any system-wide
definitions. The second example clobbers anything previously
defined.
Remove optimization flags from the third party
Makefile
s. The system
CFLAGS
contains system-wide optimization
flags. An example from an unmodified
Makefile
:
CFLAGS= -O3 -funroll-loops -DHAVE_SOUND
Using system optimization flags, the
Makefile
would look similar to this
example:
CFLAGS+= -DHAVE_SOUND
Make the port build system display all commands executed during the build stage. Complete build logs are crucial to debugging port problems.
Non-informative build log example (bad):
CC source1.o CC source2.o CCLD someprogram
Verbose build log example (good):
cc -O2 -pipe -I/usr/local/include -c -o source1.o source1.c cc -O2 -pipe -I/usr/local/include -c -o source2.o source2.c cc -o someprogram source1.o source2.o -L/usr/local/lib -lsomelib
Some build systems such as CMake, ninja, and GNU configure are set up for verbose logging by the ports framework. In other cases, ports might need individual tweaks.
Do send applicable changes and patches to the upstream maintainer for inclusion in the next release of the code. This makes updating to the next release that much easier.
README.html
is not part of the port,
but generated by make readme
. Do not
include this file in patches or commits.
If make readme
fails, make sure that
the default value of ECHO_MSG
has not
been modified by the port.
In certain cases, users must be prevented from installing
a port. There are several variables that can be used in a
port's Makefile
to tell the user that the
port cannot be installed. The value of
these make variables will be the
reason that is shown to users for why the port refuses to
install itself. Please use the correct make
variable. Each variable conveys radically different
meanings, both to users and to automated systems that depend on
Makefile
s, such as
the ports build cluster,
FreshPorts, and
portsmon.
BROKEN
is reserved for ports that
currently do not compile, install, deinstall, or run
correctly. Use it for ports where the problem
is believed to be temporary.
If instructed, the build cluster will still attempt to try to build them to see if the underlying problem has been resolved. (However, in general, the cluster is run without this.)
For instance, use BROKEN
when a
port:
does not compile
fails its configuration or installation process
installs files outside of
${PREFIX}
does not remove all its files cleanly upon deinstall (however, it may be acceptable, and desirable, for the port to leave user-modified files behind)
has runtime issues on systems where it is supposed to run fine.
FORBIDDEN
is used for ports that
contain a security vulnerability or induce grave concern
regarding the security of a FreeBSD system with a given port
installed (for example, a reputably insecure program or a
program that provides easily exploitable services). Mark
ports as FORBIDDEN
as soon as a
particular piece of software has a vulnerability and there
is no released upgrade. Ideally upgrade ports as soon as
possible when a security vulnerability is discovered so as
to reduce the number of vulnerable FreeBSD hosts (we like
being known for being secure), however sometimes there is
a noticeable time gap between disclosure of a
vulnerability and an updated release of the vulnerable
software. Do not mark a port FORBIDDEN
for any reason other than security.
IGNORE
is reserved for ports that
must not be built for some other reason. Use it
for ports where the problem is believed to be
structural. The build cluster will not, under any
circumstances, build ports marked as
IGNORE
. For instance, use
IGNORE
when a port:
does not work on the installed version of FreeBSD
has a distfile which may not be automatically fetched due to licensing restrictions
does not work with some other currently installed port (for instance, the port depends on www/apache20 but www/apache22 is installed)
If a port would conflict with a currently
installed port (for example, if they install a file in
the same place that performs a different function),
use
CONFLICTS
instead.
CONFLICTS
will set
IGNORE
by itself.
Do not quote the values of BROKEN
,
IGNORE
, and related variables. Due to the
way the information is shown to the user, the wording of
messages for each variable differ:
BROKEN= fails to link with base -lcrypto
IGNORE= unsupported on recent versions
resulting in this output from
make describe
:
===> foobar-0.1 is marked as broken: fails to link with base -lcrypto.
===> foobar-0.1 is unsupported on recent versions.
FreeBSD runs on many more processor architectures than just the well-known x86-based ones. Some ports have constraints which are particular to one or more of these architectures.
For the list of supported architectures, run:
cd ${SRCDIR}; make targets
The values are shown in the form
TARGET
/TARGET_ARCH
.
The ports read-only makevar ARCH
is set
based on the value of TARGET_ARCH
.
Port Makefile
s should test the value
of this Makevar.
Ports that do not have any architecture-dependent files
or requirements are identified by setting
NO_ARCH=yes
.
NO_ARCH
is meant to indicate
that there is no need to build a package for each of the
supported architectures. The goal is to reduce the amount
of resources spent on building and distributing the packages
such as network bandwidth and disk space on mirrors
and on distribution media. Currently, however,
our package infrastructure (e.g., package managers, mirrors,
and package builders) is not set up to fully benefit from
NO_ARCH
.
To mark a port as IGNORE
d
only on certain architectures, there are two other
convenience variables that will automatically set
IGNORE
:
ONLY_FOR_ARCHS
and
NOT_FOR_ARCHS
. Examples:
ONLY_FOR_ARCHS= i386 amd64
NOT_FOR_ARCHS= ia64 sparc64
A custom IGNORE
message can be
set using ONLY_FOR_ARCHS_REASON
and
NOT_FOR_ARCHS_REASON
. Per
architecture entries are possible with
ONLY_FOR_ARCHS_REASON_
and
ARCH
NOT_FOR_ARCHS_REASON_
.ARCH
If a port fetches i386 binaries and installs them,
set IA32_BINARY_PORT
. If this variable
is set, /usr/lib32
must be present
for IA32 versions of libraries and the kernel must support
IA32 compatibility. If one of these two
dependencies is not satisfied, IGNORE
will be set automatically.
Some ports attempt to tune themselves to the
exact machine they are being built on by specifying
-march=native
to the compiler.
This should be avoided: either list it under an
off-by-default option, or delete it entirely.
Otherwise, the default package produced by the
build cluster might not run on every single machine
of that ARCH
.
Do remember that BROKEN
and
FORBIDDEN
are to be used as a temporary
resort if a port is not working. Permanently broken ports
will be removed from the tree entirely.
When it makes sense to do so, users can be warned about
a pending port removal with DEPRECATED
and
EXPIRATION_DATE
. The former is a
string stating why the port is scheduled for removal; the latter
is a string in ISO 8601 format (YYYY-MM-DD). Both will be shown
to the user.
It is possible to set DEPRECATED
without an EXPIRATION_DATE
(for instance,
recommending a newer version of the port), but the converse
does not make any sense.
There is no set policy on how much notice to give. Current practice seems to be one month for security-related issues and two months for build issues. This also gives any interested committers a little time to fix the problems.
The correct way for a Makefile
to
signal that the port cannot be installed due to some external
factor (for instance, the user has specified an illegal
combination of build options) is to set a non-blank value to
IGNORE
. This value will be formatted and
shown to the user by make install
.
It is a common mistake to use .error
for this purpose. The problem with this is that many automated
tools that work with the ports tree will fail in this situation.
The most common occurrence of this is seen when trying to build
/usr/ports/INDEX
(see
Section 10.1, “Running make describe
”). However, even more trivial
commands such as make maintainer
also fail in
this scenario. This is not acceptable.
.error
The first of the
next two Makefile
snippets will cause
make index
to fail, while the second one
will not:
.error "option is not supported"
IGNORE=option is not supported
The usage of sysctl
is discouraged
except in targets. This is because the evaluation of any
makevar
s, such as used during
make index
, then has to run the command,
further slowing down that process.
Only use sysctl(8) through
SYSCTL
, as it contains the fully
qualified path and can be overridden, if one has such a
special need.
Sometimes the authors of software change the content of released distfiles without changing the file's name. Verify that the changes are official and have been performed by the author. It has happened in the past that the distfile was silently altered on the download servers with the intent to cause harm or compromise end user security.
Put the old distfile aside, download the new one, unpack
them and compare the content with diff(1). If there is
nothing suspicious, update
distinfo
.
Be sure to summarize the differences in the PR and commit log, so that other people know that nothing bad has happened.
Contact the authors of the software and confirm the changes with them.
FreeBSD ports generally expect POSIX compliance. Some software and build systems make assumptions based on a particular operating system or environment that can cause problems when used in a port.
Do not use /proc
if there are any
other ways of getting the information. For example,
setprogname(argv[0])
in
main()
and then getprogname(3)
to know the executable name.
Do not rely on behavior that is undocumented by POSIX.
Do not record timestamps in the critical path of the application if it also works without. Getting timestamps may be slow, depending on the accuracy of timestamps in the OS. If timestamps are really needed, determine how precise they have to be and use an API which is documented to just deliver the needed precision.
A number of simple syscalls (for example gettimeofday(2), getpid(2)) are much faster on Linux® than on any other operating system due to caching and the vsyscall performance optimizations. Do not rely on them being cheap in performance-critical applications. In general, try hard to avoid syscalls if possible.
Do not rely on Linux®-specific socket behavior. In
particular, default socket buffer sizes are different (call
setsockopt(2) with SO_SNDBUF
and
SO_RCVBUF
, and while Linux®'s send(2)
blocks when the socket buffer is full, FreeBSD's will fail and
set ENOBUFS
in errno.
If relying on non-standard behavior is required, encapsulate it properly into a generic API, do a check for the behavior in the configure stage, and stop if it is missing.
Check the man pages to see if the function used is a POSIX interface (in the “STANDARDS” section of the man page).
Do not assume that /bin/sh
is
bash. Ensure that a command line
passed to system(3) will work with a
POSIX compliant shell.
A list of common bashisms is available here.
Check that headers are included in the
POSIX or man page recommended way. For
example, sys/types.h
is often forgotten,
which is not as much of a problem for Linux® as it is for
FreeBSD.
Here is a sample Makefile
that can be
used to create a new port. Make sure to remove all the extra
comments (ones between brackets).
The format shown is the recommended one for ordering
variables, empty lines between sections, and so on. This format
is designed so that the most important information is easy to
locate. We recommend using
portlint to check the
Makefile
.
[the header...just to make it easier for us to identify the ports.] # $FreeBSD$ [ ^^^^^^^^^ This will be automatically replaced with RCS ID string by SVN when it is committed to our repository. If upgrading a port, do not alter this line back to "$FreeBSD$". SVN deals with it automatically.] [section to describe the port itself and the master site - PORTNAME and PORTVERSION or the DISTVERSION* variables are always first, followed by CATEGORIES, and then MASTER_SITES, which can be followed by MASTER_SITE_SUBDIR. PKGNAMEPREFIX and PKGNAMESUFFIX, if needed, will be after that. Then comes DISTNAME, EXTRACT_SUFX and/or DISTFILES, and then EXTRACT_ONLY, as necessary.] PORTNAME= xdvi DISTVERSION= 18.2 CATEGORIES= print [do not forget the trailing slash ("/")! if not using MASTER_SITE_* macros] MASTER_SITES= ${MASTER_SITE_XCONTRIB} MASTER_SITE_SUBDIR= applications PKGNAMEPREFIX= ja- DISTNAME= xdvi-pl18 [set this if the source is not in the standard ".tar.gz" form] EXTRACT_SUFX= .tar.Z [section for distributed patches -- can be empty] PATCH_SITES= ftp://ftp.sra.co.jp/pub/X11/japanese/ PATCHFILES= xdvi-18.patch1.gz xdvi-18.patch2.gz [If the distributed patches were not made relative to ${WRKSRC}, this may need to be tweaked] PATCH_DIST_STRIP= -p1 [maintainer; *mandatory*! This is the person who is volunteering to handle port updates, build breakages, and to whom a users can direct questions and bug reports. To keep the quality of the Ports Collection as high as possible, we do not accept new ports that are assigned to "ports@FreeBSD.org".] MAINTAINER= asami@FreeBSD.org COMMENT= DVI Previewer for the X Window System [license -- should not be empty] LICENSE= BSD2CLAUSE LICENSE_FILE= ${WRKSRC}/LICENSE [dependencies -- can be empty] RUN_DEPENDS= gs:print/ghostscript [If it requires GNU make, not /usr/bin/make, to build...] USES= gmake [If it is an X application and requires "xmkmf -a" to be run...] USES= imake [this section is for other standard bsd.port.mk variables that do not] belong to any of the above] [If it asks questions during configure, build, install...] IS_INTERACTIVE= yes [If it extracts to a directory other than ${DISTNAME}...] WRKSRC= ${WRKDIR}/xdvi-new [If it requires a "configure" script generated by GNU autoconf to be run] GNU_CONFIGURE= yes [et cetera.] [If it requires options, this section is for options] OPTIONS_DEFINE= DOCS EXAMPLES FOO OPTIONS_DEFAULT= FOO [If options will change the files in plist] OPTIONS_SUB=yes FOO_DESC= Enable foo support FOO_CONFIGURE_ENABLE= foo [non-standard variables to be used in the rules below] MY_FAVORITE_RESPONSE= "yeah, right" [then the special rules, in the order they are called] pre-fetch: i go fetch something, yeah post-patch: i need to do something after patch, great pre-install: and then some more stuff before installing, wow [and then the epilogue] .include <bsd.port.mk>
PORTNAME
BlockPATCHFILES
BlockMAINTAINER
BlockLICENSE
BlockBROKEN
/IGNORE
/DEPRECATED
MessagesUSES
and
USE_x
bsd.port.mk
VariablesThe first sections of the Makefile
must always come in the same order. This standard makes it so
everyone can easily read any port without having to search for
variables in a random order.
The first line of a Makefile
is always
a comment containing the Subversion
version control ID, followed by an empty line. In new ports, it
looks like this:
# $FreeBSD$
In existing ports, Subversion has expanded it to look like this:
# $FreeBSD: head/ports-mgmt/pkg/Makefile 437007 2017-03-26 21:25:47Z bapt $
The sections and variables described here are mandatory in a ordinary port. In a slave port, many sections and variables can be skipped.
Each following block must be separated from the previous block by a single blank line.
In the following blocks, only set the variables that are required by the port. Define these variables in the order they are shown here.
This block is the most important. It defines the port name, version, distribution file location, and category. The variables must be in this order:
This block is optional. The variables are:
This block is optional, although it is highly recommended. The variables are:
LICENSE_GROUPS
or
LICENSE_GROUPS_
NAME
LICENSE_NAME
or
LICENSE_NAME_
NAME
LICENSE_TEXT
or
LICENSE_TEXT_
NAME
LICENSE_FILE
or
LICENSE_FILE_
NAME
LICENSE_PERMS
or
LICENSE_PERMS_
NAME
LICENSE_DISTFILES
or
LICENSE_DISTFILES_
NAME
If there are multiple licenses, sort the different
LICENSE_VAR
_NAME
variables by license name.
This block is optional. The variables are:
BROKEN_
and *
IGNORE_
can be any generic variables, for example,
*
IGNORE_amd64
,
BROKEN_FreeBSD_10
, etc. With the exception
of variables that depend on a USES
, place those
in Section 15.8, “USES
and
USE_
”. For instance,
x
IGNORE_WITH_PHP
only works if
USES=php
is
set, and BROKEN_SSL
only if USES=ssl
is
set.
If the port is marked BROKEN when some conditions are
met, and such conditions can only be tested after including
bsd.port.options.mk
or
bsd.port.pre.mk
, then those variables
should be set later, in Section 15.11, “The Rest of the Variables”.
This block is optional. The variables are:
This block is optional.
Start this section with defining FLAVORS
.
Continue with the possible Flavors helpers. See Section 7.2, “Using FLAVORS” for more Information.
Constructs setting variables not available as helpers using
.if ${FLAVOR:U} == foo
should go in their
respective sections below.
Start this section with defining USES
,
and then possible
USE_
.x
Keep related variables close together. For example, if
using USE_GITHUB
,
always put the
GH_
variables
right after it.*
This section block is for variables that can be defined in
bsd.port.mk
that do not belong in any
of the previous section blocks.
Order is not important, however try to keep similar
variables together. For example uid and gid variables
USERS
and GROUPS
.
Configuration variables
CONFIGURE_
and
*
. List
of files, and directories *
_CONFIGUREPORTDOCS
and
PORTEXAMPLES
.
If the port uses the options framework, define
OPTIONS_DEFINE
and
OPTIONS_DEFAULT
first, then the other
OPTIONS_
variables first, then the
*
descriptions, then the options helpers. Try and sort all of
those alphabetically.*
_DESC
The FOO
and BAR
options do not have a standard description, so one need to
be written. The other options already have one in
Mk/bsd.options.desc.mk
so writing one
is not needed. The DOCS
and
EXAMPLES
use target helpers to install
their files, they are shown here for completeness, though
they belong in Section 15.12, “The Targets”, so
other variables and targets could be inserted before
them.
OPTIONS_DEFINE= DOCS EXAMPLES FOO BAR OPTIONS_DEFAULT= FOO OPTIONS_RADIO= SSL OPTIONS_RADIO_SSL= OPENSSL GNUTLS OPTIONS_SUB= yes BAR_DESC= Enable bar support FOO_DESC= Enable foo support BAR_CONFIGURE_WITH= bar=${LOCALBASE} FOO_CONFIGURE_ENABLE= foo GNUTLS_CONFIGURE_ON= --with-ssl=gnutls OPENSSL_CONFIGURE_ON= --with-ssl=openssl post-install-DOCS-on: ${MKDIR} ${STAGEDIR}${DOCSDIR} cd ${WRKSRC}/doc && ${COPYTREE_SHARE} . ${STAGEDIR}${DOCSDIR} post-install-EXAMPLES-on: ${MKDIR} ${STAGEDIR}${EXAMPLESDIR} cd ${WRKSRC}/ex && ${COPYTREE_SHARE} . ${STAGEDIR}${EXAMPLESDIR}
And then, the rest of the variables that are not mentioned in the previous blocks.
After all the variables are defined, the optional
make(1) targets can be defined. Keep
pre-
before
*
post-
and in
the same order as the different stages run:*
fetch
extract
patch
configure
build
install
test
When using options helpers target keep them alphabetically
sorted, but keep the
before the
*
-on
. When
also using the main target, keep the main target before the
optional ones:*
-off
post-install: # install generic bits post-install-DOCS-on: # Install documentation post-install-X11-on: # Install X11 related bits post-install-X11-off: # Install bits that should be there if X11 is disabled
The FreeBSD Ports Collection is constantly changing. Here is some information on how to keep up.
One of the easiest ways to learn about updates that have already been committed is by subscribing to FreshPorts. Multiple ports can be monitored. Maintainers are strongly encouraged to subscribe, because they will receive notification of not only their own changes, but also any changes that any other FreeBSD committer has made. (These are often necessary to keep up with changes in the underlying ports framework—although it would be most polite to receive an advance heads-up from those committing such changes, sometimes this is overlooked or impractical. Also, in some cases, the changes are very minor in nature. We expect everyone to use their best judgement in these cases.)
To use FreshPorts, an account is required. Those with
registered email addresses at @FreeBSD.org
will see the opt-in link on the right-hand side of the web
pages. Those who already have a FreshPorts account but are not
using a @FreeBSD.org
email address can change
the email to @FreeBSD.org
, subscribe, then
change it back again.
FreshPorts also has a sanity test feature which automatically tests each commit to the FreeBSD ports tree. If subscribed to this service, a committer will receive notifications of any errors which FreshPorts detects during sanity testing of their commits.
It is possible to browse the files in the source repository by using a web interface. Changes that affect the entire port system are now documented in the CHANGES file. Changes that affect individual ports are now documented in the UPDATING file. However, the definitive answer to any question is undoubtedly to read the source code of bsd.port.mk, and associated files.
As a ports maintainer, consider subscribing to
FreeBSD ports mailing list. Important changes to the way ports work will be
announced there, and then committed to
CHANGES
.
If the volume of messages on this mailing list is too high, consider following FreeBSD ports announce mailing list which contains only announcements.
One of the least-publicized strengths of FreeBSD is that an entire cluster of machines is dedicated to continually building the Ports Collection, for each of the major OS releases and for each Tier-1 architecture.
Individual ports are built unless they are specifically
marked with IGNORE
. Ports that are marked
with BROKEN
will still be attempted, to see
if the underlying problem has been resolved. (This is done by
passing TRYBROKEN
to the port's
Makefile
.)
The build cluster is dedicated to building the latest release of each port with distfiles that have already been fetched. However, as the Internet continually changes, distfiles can quickly go missing. Portscout, the FreeBSD Ports distfile scanner, attempts to query every download site for every port to find out if each distfile is still available. Portscout can generate HTML reports and send emails about newly available ports to those who request them. Unless not otherwise subscribed, maintainers are asked to check periodically for changes, either by hand or using the RSS feed.
Portscout's first page gives the email address of the port maintainer, the number of ports the maintainer is responsible for, the number of those ports with new distfiles, and the percentage of those ports that are out-of-date. The search function allows for searching by email address for a specific maintainer, and for selecting whether only out-of-date ports are shown.
Upon clicking on a maintainer's email address, a list of all of their ports is displayed, along with port category, current version number, whether or not there is a new version, when the port was last updated, and finally when it was last checked. A search function on this page allows the user to search for a specific port.
Clicking on a port name in the list displays the FreshPorts port information.
Another handy resource is the FreeBSD Ports
Monitoring System (also known as
portsmon
). This system comprises a database
that processes information from several sources and allows it to
be browsed via a web interface. Currently, the ports Problem
Reports (PRs), the error logs from the build cluster, and
individual files from the ports collection are used. In the
future, this will be expanded to include the distfile survey, as
well as other sources.
To get started, use the Overview of One Port search page to find all the information about a port.
This is the only resource available that
maps PR entries to portnames. PR submitters do not
always include the portname in their Synopsis, although we would
prefer that they did. So, portsmon
is a
good place to find out whether an existing
port has any PRs filed against it, any build errors, or
if a new port the porter is considering
creating has already been submitted.
USES
7z
ada
autoreconf
blaslapack
bdb
bison
cabal
cargo
charsetfix
cmake
compiler
cpe
cran
desktop-file-utils
desthack
display
dos2unix
drupal
eigen
fakeroot
fam
firebird
fonts
fortran
fuse
gem
gettext
gettext-runtime
gettext-tools
ghostscript
gl
gmake
gnome
go
gperf
grantlee
groff
gssapi
horde
iconv
imake
kde
kmod
lha
libarchive
libedit
libtool
linux
localbase
lua
lxqt
makeinfo
makeself
mate
meson
metaport
mysql
mono
motif
ncurses
ninja
objc
openal
pathfix
pear
perl5
pgsql
php
pkgconfig
pure
pyqt
python
qmail
qmake
qt
qt-dist
readline
samba
scons
shared-mime-info
shebangfix
sqlite
ssl
tar
tcl
terminfo
tk
uidfix
uniquefiles
varnish
webplugin
xfce
xorg
xorg-cat
zip
USES
macros make it easy to declare
requirements and settings for a port. They can add
dependencies, change building behavior, add metadata to
packages, and so on, all by selecting simple, preset
values.
Each section in this chapter describes a possible value for
USES
, along with its possible arguments.
Arguments are appeneded to the value after a colon
(:
). Multiple arguments are separated by
commas (,
).
Possible arguments: (none), p7zip
,
partial
Extract using 7z(1) instead of bsdtar(1) and sets
EXTRACT_SUFX=.7z
. The
p7zip
option forces a dependency on the
7z
from archivers/p7zip if the one from the base
system is not able to extract the files.
EXTRACT_SUFX
is not changed if the
partial
option is used, this can be used if
the main distribution file does not have a
.7z
extension.
Possible arguments: (none),
5
,
6
Depends on an Ada-capable
compiler, and sets CC
accordingly. Defaults
to use gcc 5 from ports. Use the
:
version option
to force building with a different version.X
Possible arguments: (none), build
Runs autoreconf
. It encapsulates the
aclocal
, autoconf
,
autoheader
, automake
,
autopoint
, and libtoolize
commands. Each command applies to
${AUTORECONF_WRKSRC}/configure.ac
or its
old name,
${AUTORECONF_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
. A port can set
AUTORECONF_WRKSRC
if
WRKSRC
does not contain the path to
configure.ac
.
Possible arguments: (none), atlas
,
netlib
(default),
gotoblas
, openblas
Adds dependencies on Blas / Lapack libraries.
Possible arguments: (none), 48
,
5
(default), 6
Add dependency on the Berkeley DB
library. Default to databases/db5. It can also depend on
databases/db48 when using the
:48
argument or databases/db6 with
:6
. It is possible to declare a range of
acceptable values, :48+
finds the highest
installed version, and falls back to 4.8 if nothing else is
installed. INVALID_BDB_VER
can be used to
specify versions which do not work with this port. The
framework exposes the following variables to the port:
BDB_LIB_NAME
The name of the Berkeley DB
library. For example, when using databases/db5, it contains
db-5.3
.
BDB_LIB_CXX_NAME
The name of the Berkeley DB
C++ library. For example, when
using databases/db5, it
contains db_cxx-5.3
.
BDB_INCLUDE_DIR
The location of the Berkeley
DB include directory. For example, when
using databases/db5, it
will contain
${LOCALBASE}/include/db5
.
BDB_LIB_DIR
The location of the Berkeley
DB library directory. For example, when
using databases/db5, it
contains ${LOCALBASE}/lib
.
BDB_VER
The detected Berkeley DB
version. For example, if using
USES=bdb:48+
and Berkeley
DB 5 is installed, it contains
5
.
databases/db48 is deprecated and unsupported. It must not be used by any port.
Possible arguments: (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.
Ports should not be created for Haskell libraries, see Section 6.30, “Haskell Libraries” for more information.
Possible arguments: (none), hpack
Sets default values and targets used to build
Haskell software using Cabal.
A build dependency on the Haskell compiler port (GHC)
is added. If hpack
argument is given,
a build dependency on devel/hs-hpack
is added and hpack
is invoked at
configuration step to generate .cabal file.
The framework provides the following variables:
USE_CABAL
If the software uses Haskell dependencies, list them in
this variable. Each item should be present on Hackage and
be listed in form packagename-
.
Dependencies can have revisions, which are specified after the
0.1.2
_
symbol. Automatic generation of dependency
list is supported, see Section 6.5.9, “Building Haskell
Applications with cabal
”.
CABAL_FLAGS
List of flags to be passed to cabal-install
during the configuring and building stage. The flags are
passed verbatim.
EXECUTABLES
List of executable files installed by the port.
Default value: ${PORTNAME}
.
Items from this list are automatically added to pkg-plist.
SKIP_CABAL_PLIST
If defined, do not add items from
${EXECUTABLES}
to pkg-plist.
opt_USE_CABAL
Adds items to ${USE_CABAL}
depending on opt
option.
opt_EXECUTABLES
Adds items to ${EXECUTABLES}
depending on opt
option.
opt_CABAL_FLAGS
If opt
is enabled, append the value
to ${CABAL_FLAGS}
. Otherwise, append
-value
to disable the flag.
FOO_DATADIR_VARS
For an executable named FOO
list Haskell packages, whose data files
should be accessible by the executable.
Possible arguments: (none)
Uses Cargo for configuring, building, and testing.
It can be used to port Rust applications that use the Cargo
build system. For more information see Section 6.5.6, “Building Rust Applications
with cargo
”.
Possible arguments: (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
.
Possible arguments: (none), insource
,
noninja
, run
Uses CMake for configuring and building.
By default an out-of-source build is performed, leaving the
sources in WRKSRC
free from build artifacts.
With the insource
argument, an in-source
build will be performed instead. Setting it should be the
exception when a regular out-of-source build does not
work.
By default Ninja is used for
the build. In some cases this does not work correctly. With
the noninja
argument, the build will
fallback to using regular make
for builds.
It should only be used if a
Ninja-based build does not
work.
With the run
argument, a run dependency
is registered in addition to a build dependency.
For more information see Section 6.5.4, “Using cmake
”.
Possible arguments: (none), env
(default, implicit), c++17-lang
,
c++14-lang
,
c++11-lang
, gcc-c++11-lib
,
c++11-lib
, c++0x
,
c11
, openmp
,
nestedfct
, features
Determines which compiler to use based on any given wishes.
Use c++17-lang
if the port needs a
C++17-capable compiler,
c++14-lang
if the port needs a
C++14-capable compiler, 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, or c++11-lib
if the port needs
a C++11-ready standard library. If the port needs a compiler
understanding C++0X, C11, OpenMP, or nested functions,
the corresponding parameters should 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:
COMPILER_TYPE
: the default compiler
on the system, either gcc or clang
ALT_COMPILER_TYPE
: the alternative
compiler on the system, either gcc or clang. Only set if
two compilers are present in the base system.
COMPILER_VERSION
: the first two
digits of the version of the default compiler.
ALT_COMPILER_VERSION
: the first two
digits of the version of the alternative compiler, if
present.
CHOSEN_COMPILER_TYPE
: the chosen
compiler, either gcc or clang
COMPILER_FEATURES
: the features
supported by the default compiler. It currently lists the
C++ library.
Possible arguments: (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:
Search for the official CPE entry for the software product either by using the NVD's CPE search engine or in the official CPE dictionary (warning, very large XML file). Do not ever make up CPE data.
Add cpe
to USES
and compare the result of make -V CPE_STR
to the CPE dictionary entry. Continue one
step at a time until make -V CPE_STR
is
correct.
If the product name (second field, defaults to
PORTNAME
) is incorrect, define
CPE_PRODUCT
.
If the vendor name (first field, defaults to
CPE_PRODUCT
) is incorrect, define
CPE_VENDOR
.
If the version field (third field, defaults to
PORTVERSION
) is incorrect, define
CPE_VERSION
.
If the update field (fourth field, defaults to empty) is
incorrect, define CPE_UPDATE
.
If it is still not correct, check
Mk/Uses/cpe.mk
for additional details,
or contact the Ports Security Team <ports-secteam@FreeBSD.org>
.
Derive as much as possible of the CPE
name from existing variables such as
PORTNAME
and
PORTVERSION
. Use variable modifiers to
extract the relevant portions from these variables rather
than hardcoding the name.
Always run make -V
CPE_STR
and check the output before committing
anything that changes PORTNAME
or
PORTVERSION
or any other variable which
is used to derive CPE_STR
.
Possible arguments: (none),
auto-plist
,
compiles
Uses the Comprehensive R Archive Network. Specify
auto-plist
to automatically generate
pkg-plist
. Specify
compiles
if the port has code that need to be
compiled.
Possible arguments: (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.
Possible arguments: (none)
Changes the behavior of GNU configure to properly support
DESTDIR
in case the original software does
not.
Possible arguments: (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.
Possible arguments: (none)
The port has files with line endings in DOS format which need to be converted. Several 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.
DOS2UNIX_REGEX
: match file names
based on a regular expression.
DOS2UNIX_FILES
: match literal file
names.
DOS2UNIX_GLOB
: match file names based
on a glob pattern.
DOS2UNIX_WRKSRC
: the directory from
which to start the conversions. Defaults to
${WRKSRC}
.
Possible arguments:
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:7,module
says that this port
creates a Drupal 6 module. A Drupal 7 theme can be specified
with USES=drupal:7,theme
.
Possible arguments: (none)
Changes some default behavior of build systems to allow
installing as a user. See https://wiki.debian.org/FakeRoot for more
information on fakeroot
.
Possible arguments: (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.
Possible arguments: (none), 25
Add a dependency to the client library of the Firebird database.
Possible arguments: (none), fc
,
fcfontsdir
(default),
fontsdir
, none
Adds a runtime dependency on tools needed to register fonts.
Depending on the argument, add a @fc ${FONTSDIR}
line, @fcfontsdir
${FONTSDIR}
line, @fontsdir
${FONTSDIR}
line, or no line if the argument is
none
, to the plist.
FONTSDIR
defaults to
${PREFIX}/share/fonts/${FONTNAME}
and
FONTNAME
to ${PORTNAME}
.
Add FONTSDIR
to PLIST_SUB
and SUB_LIST
Possible arguments: 2
(default),
3
The port will depend on the FUSE library and handle the dependency on the kernel module depending on the version of FreeBSD.
Possible arguments: (none),
noautoplist
Handle building with RubyGems.
If noautoplist
is used, the packing list is
not generated automatically.
Possible arguments: (none)
Deprecated. Will include both gettext-runtime
and gettext-tools
.
Possible arguments: (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
.
Possible arguments: (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.
Possible arguments: X
,
build
, run
,
nox11
A specific version X
can be used.
Possible versions are 7
,
8
, 9
, and
agpl
(default). nox11
indicates
that the -nox11
version of the port is
required. build
and run
add build- and run-time dependencies on
Ghostscript. The default is both
build- and run-time dependencies.
Possible arguments: (none)
Provides an easy way to depend on
GL components. The components
should be listed in USE_GL
. The available
components are:
egl
add a library dependency on libEGL.so
from graphics/mesa-libs
gbm
Add a library dependency on libgbm.so
from graphics/mesa-libs
gl
Add a library dependency on libGL.so
from graphics/mesa-libs
glesv2
Add a library dependency on libGLESv2.so
from graphics/mesa-libs
glew
Add a library dependency on libGLEW.so
from graphics/glew
glu
Add a library dependency on libGLU.so
from graphics/libGLU
glut
Add a library dependency on libglut.so
from graphics/freeglut
Possible arguments: (none)
Uses devel/gmake as a
build-time dependency and sets up the environment to use
gmake
as the default make
for the build.
Possible arguments: (none)
Provides an easy way to depend on
GNOME components. The components
should be listed in USE_GNOME
. The available
components are:
atk
atkmm
cairo
cairomm
dconf
esound
evolutiondataserver3
gconf2
gconfmm26
gdkpixbuf
gdkpixbuf2
glib12
glib20
glibmm
gnomecontrolcenter3
gnomedesktop3
gnomedocutils
gnomemenus3
gnomemimedata
gnomeprefix
gnomesharp20
gnomevfs2
gsound
gtk-update-icon-cache
gtk12
gtk20
gtk30
gtkhtml3
gtkhtml4
gtkmm20
gtkmm24
gtkmm30
gtksharp20
gtksourceview
gtksourceview2
gtksourceview3
gtksourceviewmm3
gvfs
intlhack
intltool
introspection
libartlgpl2
libbonobo
libbonoboui
libgda5
libgda5-ui
libgdamm5
libglade2
libgnome
libgnomecanvas
libgnomekbd
libgnomeprint
libgnomeprintui
libgnomeui
libgsf
libgtkhtml
libgtksourceviewmm
libidl
librsvg2
libsigc++12
libsigc++20
libwnck
libwnck3
libxml++26
libxml2
libxslt
metacity
nautilus3
orbit2
pango
pangomm
pangox-compat
py3gobject3
pygnome2
pygobject
pygobject3
pygtk2
pygtksourceview
referencehack
vte
vte3
The default dependency is build- and run-time, it can be
changed with :build
or
:run
. For example:
USES= gnome USE_GNOME= gnomemenus3:build intlhack
See Section 6.10, “Using GNOME” for more information.
Ports should not be created for Go libs, see Section 6.29, “Go Libraries” for more information.
Possible arguments: (none), modules
,
no_targets
, run
Sets default values and targets used to build
Go software. A build dependency
on the Go compiler port selected via GO_PORT
is added. By default the build is performed in GOPATH mode.
If Go software uses modules, the modules-aware mode can be
switched on with modules
argument.
no_targets
will setup build environment like
GO_ENV
, GO_BUILDFLAGS
but
skip creating post-extract
and
do-{build,install,test}
targets.
run
will also add a run dependency on
what is in GO_PORT
.
The build process is controlled by several variables:
GO_PKGNAME
The name of the Go package
when building in GOPATH mode. This is the directory that
will be created in ${GOPATH}/src
. If
not set explicitly and GH_SUBDIR
or
GL_SUBDIR
is present,
GO_PKGNAME
will be inferred from it.
It is not needed when building in modules-aware
mode.
GO_TARGET
The packages to build. The default
value is ${GO_PKGNAME}
.
GO_TARGET
can also be a tuple in the
form package:path
where path can be
either a simple filename or a full path starting with
${PREFIX}
.
GO_TESTTARGET
The packages to test. The default
value is ./...
(the current package
and all subpackages).
CGO_CFLAGS
Additional CFLAGS
values to be
passed to the C compiler by
go
.
CGO_LDFLAGS
Additional LDFLAGS
values to be
passed to the C compiler by
go
.
GO_BUILDFLAGS
Additional build arguments to be passed to
go build
.
GO_TESTFLAGS
Additional build arguments to be passed to
go test
.
GO_PORT
The Go compiler port to use. By default this is
lang/go but can be set
to lang/go-devel in
make.conf
for testing with future Go
versions.
This variable must not be set by individual ports!
See Section 6.5.8, “Building Go Applications” for usage examples.
Possible arguments: (none)
Add a buildtime dependency on devel/gperf if gperf
is not present in the base system.
Possible arguments: 5
,
selfbuild
Handle dependency on Grantlee.
Specify 5
to depend on the
Qt5 based version, devel/grantlee5.
selfbuild
is used internally by devel/grantlee5 to get their versions
numbers.
Possible arguments: build
,
run
, both
Registers a dependency on textproc/groff if not present in the base system.
Possible arguments: (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 base
, the
GSS-API library from the base system is used.
Can also be set to heimdal
to use security/heimdal, or
mit
to use security/krb5.
When the local Kerberos
installation is not in LOCALBASE
, set
HEIMDAL_HOME
(for heimdal
)
or KRB5_HOME
(for krb5
) to
the location of the Kerberos
installation.
These variables are exported for the ports to use:
GSSAPIBASEDIR
GSSAPICPPFLAGS
GSSAPIINCDIR
GSSAPILDFLAGS
GSSAPILIBDIR
GSSAPILIBS
GSSAPI_CONFIGURE_ARGS
The flags
option can be given alongside
base
, heimdal
, or
mit
to automatically add
GSSAPICPPFLAGS
,
GSSAPILDFLAGS
, and
GSSAPILIBS
to CFLAGS
,
LDFLAGS
, and LDADD
,
respectively. For example, use
base,flags
.
The bootstrap
option is a special prefix
only for use by security/krb5 and
security/heimdal. For example,
use bootstrap,mit
.
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
Possible arguments: (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.16.4.1, “Horde Modules” for more information.
Possible arguments: (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.23, “Using iconv
”.
Possible arguments: (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.
Possible arguments: 5
Add dependency on KDE components. See Section 6.13, “Using KDE” for more information.
Possible arguments: (none), debug
Fills in the boilerplate for kernel module ports, currently:
Add kld
to
CATEGORIES
.
Set SSP_UNSAFE
.
Set IGNORE
if the kernel sources are
not found in SRC_BASE
.
Define KMODDIR
to
/boot/modules
by default, add it to
PLIST_SUB
and
MAKE_ENV
, and create it upon
installation. If KMODDIR
is set to
/boot/kernel
, it will be rewritten to
/boot/modules
. This prevents breaking
packages when upgrading the kernel due to
/boot/kernel
being renamed to
/boot/kernel.old
in the process.
Handle cross-referencing kernel modules upon installa