EBUILD

RESTRICT = [strip,mirror,fetch,userpriv]
This should be a space delimited list of portage features to restrict.
You may use conditional syntax to vary restrictions as seen above in DEPEND.

binchecks
Disable all QA checks for binaries.  This should ONLY be used in packages
for which binary checks make no sense (linux-headers and kernel-sources, for
example, can safely be skipped since they have no binaries).  If the binary
checks need to be skipped for other reasons (such as proprietary binaries),
see the QA CONTROL VARIABLES section for more specific exemptions.
bindist
Distribution of built packages is restricted.
fetch
like mirror but the files will not be fetched via SRC_URI either.
installsources
Disables installsources for specific packages. This is for packages with
binaries that are not compatible with debugedit.
mirror
files in SRC_URI will not be downloaded from the GENTOO_MIRRORS.
network-sandbox
Disables the network namespace for specific packages.
Should not be used in the main Gentoo tree.
preserve-libs
Disables preserve-libs for specific packages. Note than when a package is
merged, RESTRICT=preserve-libs applies if either the new instance or the
old instance sets RESTRICT=preserve-libs.
primaryuri
fetch from URIs in SRC_URI before GENTOO_MIRRORS.
splitdebug
Disables splitdebug for specific packages. This is for packages with
binaries that trigger problems with splitdebug, such as file-collisions
between symlinks in /usr/lib/debug/.build-id (triggered by bundled libraries).
strip
final binaries/libraries will not be stripped of debug symbols.
test
do not run src_test even if user has FEATURES=test.
userpriv
Disables userpriv for specific packages.


PROPERTIES = [interactive]
A space delimited list of properties, with conditional syntax support.

interactive
One or more ebuild phases will produce a prompt that requires user interaction.


DOCS
Beginning with EAPI 4, an array or space-delimited list of documentation
files for the default src_install function to install using dodoc. If
undefined, a reasonable default list is used. See the documentation for
src_install below.

QA Control Variables:

Usage Notes

Several QA variables are provided which allow an ebuild to manipulate some of the QA checks performed by portage. Use of these variables in ebuilds should be kept to an absolute minimum otherwise they defeat the purpose of the QA checks, and their use is subject to agreement of the QA team. They are primarily intended for use by ebuilds that install closed-source binary objects that cannot be altered.

Note that objects that violate these rules may fail on some architectures.

QA_PREBUILT

This should contain a list of file paths, relative to the image directory, of files that are pre-built binaries. Paths listed here will be appended to each of the QA_* variables listed below. The paths may contain fnmatch-like patterns which will be internally translated to regular expressions for the QA_* variables that support regular expressions instead of fnmatch patterns. The translation mechanism simply replaces "*" with ".*".

QA_TEXTRELS

This variable can be set to a list of file paths, relative to the image directory, of files that contain text relocations that cannot be eliminated. The paths may contain fnmatch patterns.

This variable is intended to be used on closed-source binary objects that cannot be altered.

QA_EXECSTACK

This should contain a list of file paths, relative to the image directory, of objects that require executable stack in order to run. The paths may contain fnmatch patterns.

This variable is intended to be used on objects that truly need executable stack (i.e. not those marked to need it which in fact do not).

QA_WX_LOAD

This should contain a list of file paths, relative to the image directory, of files that contain writable and executable segments. These are rare. The paths may contain fnmatch patterns.

QA_FLAGS_IGNORED

This should contain a list of file paths, relative to the image directory, of files that do not contain .GCC.command.line sections or contain .hash sections. The paths may contain regular expressions with escape-quoted special characters.

This variable is intended to be used on files of binary packages which ignore CFLAGS, CXXFLAGS, FFLAGS, FCFLAGS, and LDFLAGS variables.

QA_MULTILIB_PATHS

This should contain a list of file paths, relative to the image directory, of files that should be ignored for the multilib-strict checks. The paths may contain regular expressions with escape-quoted special characters.

QA_PRESTRIPPED

This should contain a list of file paths, relative to the image directory, of files that contain pre-stripped binaries. The paths may contain regular expressions with escape-quoted special characters.

QA_SONAME

This should contain a list of file paths, relative to the image directory, of shared libraries that lack SONAMEs. The paths may contain regular expressions with escape-quoted special characters.

QA_SONAME_NO_SYMLINK

This should contain a list of file paths, relative to the image directory, of shared libraries that have SONAMEs but should not have a corresponding SONAME symlink in the same directory. The paths may contain regular expressions with escape-quoted special characters.

QA_AM_MAINTAINER_MODE

This should contain a list of lines containing automake missing --run commands. The lines may contain regular expressions with escape-quoted special characters.

QA_CONFIGURE_OPTIONS

This should contain a list of configure options which trigger warnings about unrecognized options. The options may contain regular expressions with escape-quoted special characters.

QA_DT_NEEDED

This should contain a list of file paths, relative to the image directory, of shared libraries that lack NEEDED entries. The paths may contain regular expressions with escape-quoted special characters.

QA_DESKTOP_FILE

This should contain a list of file paths, relative to the image directory, of desktop files which should not be validated. The paths may contain regular expressions with escape-quoted special characters.

PORTAGE DECLARATIONS

inherit

Inherit is portage's maintenance of extra classes of functions that are external to ebuilds and provided as inheritable capabilities and data. They define functions and set data types as drop-in replacements, expanded, and simplified routines for extremely common tasks to streamline the build process. Call to inherit cannot depend on conditions which can vary in given ebuild. Specification of the eclasses contains only their name and not the .eclass extension. Also note that the inherit statement must come before other variable declarations unless these variables are used in global scope of eclasses.

PHASE FUNCTIONS

pkg_pretend

Beginning with EAPI 4, this function can be defined in order to check that miscellaneous requirements are met. It is called as early as possible, before any attempt is made to satisfy dependencies. If the function detects a problem then it should call eerror and die. The environment (variables, functions, temporary directories, etc..) that is used to execute pkg_pretend is not saved and therefore is not available in phases that execute afterwards.

pkg_nofetch

This function will be executed when the files in SRC_URI cannot be fetched for any reason. If you turn on fetch in RESTRICT, this is useful for displaying information to the user on *how* to obtain said files. All you have to do is output a message and let the function return. Do not end the function with a call to die.

pkg_setup

This function can be used if the package needs specific setup actions or checks to be preformed before anything else.
Initial working directory: $PORTAGE_TMPDIR

src_unpack

This function is used to unpack all the sources in A to WORKDIR. If not defined in the ebuild script it calls unpack ${A}. Any patches and other pre configure/compile modifications should be done here.
Initial working directory: $WORKDIR

src_prepare

All preparation of source code, such as application of patches, should be done here. This function is supported beginning with EAPI 2.
Initial working directory: $S

src_configure

All necessary steps for configuration should be done here. This function is supported beginning with EAPI 2.
Initial working directory: $S

src_compile

With less than EAPI 2, all necessary steps for both configuration and compilation should be done here. Beginning with EAPI 2, only compilation steps should be done here.
Initial working directory: $S

src_test

Run all package specific test cases. The default is to run 'emake check' followed 'emake test'. Prior to EAPI 5, the default src_test implementation will automatically pass the -j1 option as the last argument to emake, and beginning with EAPI 5 it will allow the tests to run in parallel.
Initial working directory: $S

src_install

Should contain everything required to install the package in the temporary install directory.
Initial working directory: $S

Beginning with EAPI 4, if src_install is undefined then the following default implementation is used:

src_install() {
    if [[ -f Makefile || -f GNUmakefile || -f makefile ]] ; then
        emake DESTDIR="${D}" install
    fi

    if ! declare -p DOCS &>/dev/null ; then
        local d
        for d in README* ChangeLog AUTHORS NEWS TODO CHANGES \
                THANKS BUGS FAQ CREDITS CHANGELOG ; do
            [[ -s "${d}" ]] && dodoc "${d}"
        done
    elif [[ $(declare -p DOCS) == "declare -a "* ]] ; then
        dodoc "${DOCS[@]}"
    else
        dodoc ${DOCS}
    fi
}

pkg_preinst pkg_postinst

All modifications required on the live-filesystem before and after the package is merged should be placed here. Also commentary for the user should be listed here as it will be displayed last.
Initial working directory: $PWD

pkg_prerm pkg_postrm

Like the pkg_*inst functions but for unmerge.
Initial working directory: $PWD

pkg_config

This function should contain optional basic configuration steps.
Initial working directory: $PWD

HELPER FUNCTIONS

Phases:

default

Calls the default phase function implementation for the currently executing phase. This function is supported beginning with EAPI 2.

default_*

Beginning with EAPI 2, the default pkg_nofetch and src_* phase functions are accessible via a function having a name that begins with default_ and ends with the respective phase function name. For example, a call to a function with the name default_src_compile is equivalent to a call to the default src_compile implementation.

Default Phase Functions

default_src_unpack

default_src_prepare

default_src_configure

default_src_compile

default_src_test

General:

assert [reason]

Checks the value of the shell's PIPESTATUS array variable, and if any component is non-zero (indicating failure), calls die with reason as a failure message.

die [reason]

Causes the current emerge process to be aborted. The final display will include reason.

Beginning with EAPI 4, all helpers automatically call die whenever some sort of error occurs. Helper calls may be prefixed with the nonfatal helper in order to prevent errors from being fatal.

nonfatal <helper>

Execute helper and do not call die if it fails. The nonfatal helper is available beginning with EAPI 4.

use <USE item>

If USE item is in the USE variable, the function will silently return 0 (aka shell true). If USE item is not in the USE variable, the function will silently return 1 (aka shell false). usev is a verbose version of use.

Example:

if use gnome ; then
        guiconf="--enable-gui=gnome --with-x"
elif use gtk ; then
        guiconf="--enable-gui=gtk --with-x"
elif use X ; then
        guiconf="--enable-gui=athena --with-x"
else
        # No gui version will be built
        guiconf=""
fi

usev <USE item>

Like use, but also echoes USE item when use returns true.

usex <USE flag> [true output] [false output] [true suffix] [false suffix]

If USE flag is set, echo [true output][true suffix] (defaults to "yes"), otherwise echo [false output][false suffix] (defaults to "no"). The usex helper is available beginning with EAPI 5.

use_with <USE item> [configure name] [configure opt]

Useful for creating custom options to pass to a configure script. If USE item is in the USE variable and a configure opt is specified, then the string --with-[configure name]=[configure opt] will be echoed. If configure opt is not specified, then just --with-[configure name] will be echoed. If USE item is not in the USE variable, then the string --without-[configure name] will be echoed. If configure name is not specified, then USE item will be used in its place. Beginning with EAPI 4, an empty configure opt argument is recognized. In EAPI 3 and earlier, an empty configure opt argument is treated as if it weren't provided.

Examples:

USE="opengl"
myconf=$(use_with opengl)
(myconf now has the value "--with-opengl")

USE="jpeg"
myconf=$(use_with jpeg libjpeg)
(myconf now has the value "--with-libjpeg")

USE=""
myconf=$(use_with jpeg libjpeg)
(myconf now has the value "--without-libjpeg")

USE="sdl"
myconf=$(use_with sdl SDL all-plugins)
(myconf now has the value "--with-SDL=all-plugins")

use_enable <USE item> [configure name] [configure opt]

Same as use_with above, except that the configure options are --enable- instead of --with- and --disable- instead of --without-. Beginning with EAPI 4, an empty configure opt argument is recognized. In EAPI 3 and earlier, an empty configure opt argument is treated as if it weren't provided.

has <item> <item list>

If item is in item list, then has returns 0. Otherwise, 1 is returned. There is another version, hasv, that will conditionally echo item.
The item list is delimited by the IFS variable. This variable has a default value of ' ', or a space. It is a bash(1) setting.

hasv <item> <item list>

Like has, but also echoes item when has returns true.

has_version [--host-root] <category/package-version>

Check to see if category/package-version is installed on the system. The parameter accepts all values that are acceptable in the DEPEND variable. The function returns 0 if category/package-version is installed, 1 otherwise. Beginning with EAPI 5, the --host-root option may be used in order to cause the query to apply to the host root instead of ${ROOT}.

best_version [--host-root] <package name>

This function will look up package name in the database of currently installed programs and echo the "best version" of the package that is currently installed. Beginning with EAPI 5, the --host-root option may be used in order to cause the query to apply to the host root instead of ${ROOT}.

Example:

        VERINS="$(best_version net-ftp/glftpd)"
        (VERINS now has the value "net-ftp/glftpd-1.27" if glftpd-1.27 is       installed)

Output:

einfo disposable message

Same as elog, but should be used when the message isn't important to the user (like progress or status messages during the build process).

elog informative message

If you need to display a message that you wish the user to read and take notice of, then use elog. It works just like echo(1), but adds a little more to the output so as to catch the user's eye. The message will also be logged by portage for later review.

ewarn warning message

Same as einfo, but should be used when showing a warning to the user.

eqawarn QA warning message

Same as einfo, but should be used when showing a QA warning to the user.

eerror error message

Same as einfo, but should be used when showing an error to the user.

ebegin helpful message

Like einfo, we output a helpful message and then hint that the following operation may take some time to complete. Once the task is finished, you need to call eend.

eend <status> [error message]

Followup the ebegin message with an appropriate "OK" or "!!" (for errors) marker. If status is non-zero, then the additional error message is displayed.

Unpack:

unpack <source> [list of more sources]

This function uncompresses and/or untars a list of sources into the current directory. The function will append source to the DISTDIR variable.

Compile:

econf [configure options]

This is used as a replacement for configure. Performs:

${ECONF_SOURCE:-.}/configure \
        ${CBUILD:+--build=${CBUILD}} \
        --datadir="${EPREFIX}"/usr/share \
        --host=${CHOST} \
        --infodir="${EPREFIX}"/usr/share/info \
        --localstatedir="${EPREFIX}"/var/lib \
        --prefix="${EPREFIX}"/usr \
        --mandir="${EPREFIX}"/usr/share/man \
        --sysconfdir="${EPREFIX}"/etc \
        ${CTARGET:+--target=${CTARGET}} \
        --disable-dependency-tracking \
        ${EXTRA_ECONF} \
        configure options || die "econf failed"

Note that the EXTRA_ECONF is for users only, not for ebuild writers. If you wish to pass more options to configure, just pass the extra arguments to econf. Also note that econf automatically calls die if the configure script fails. Beginning with EAPI 3, econf uses the ${EPREFIX} variable which is disregarded for prior EAPI values. Beginning with EAPI 4, econf adds --disable-dependency-tracking to the arguments if the string disable-dependency-tracking occurs in the output of configure --help. Beginning with EAPI 5, econf adds disable-silent-rules to the arguments if the string disable-silent-rules occurs in the output of configure --help.

emake [make options]

This must be used in place of `make` in ebuilds. Performs `${MAKE:-make} ${MAKEOPTS} make options ${EXTRA_EMAKE}`, and calls `die` automatically starting with EAPI 4.

The MAKEOPTS variable is set by the user so they can enable features such as parallel builds; see make.conf(5) for more details.

The EXTRA_EMAKE knob is portage feature so developers can override things while debugging ebuilds; it is not part of any EAPI specification.

***WARNING***
You must make sure your build is happy with parallel makes (make -j2). It should be tested thoroughly as parallel makes are notorious for failing _sometimes_ but not always. If you determine that your package fails to build in parallel, and you are unable to resolve the issue, then you should run `emake -j1` explicitly. This is a last resort however as it can significantly slow down builds on systems with lots of processors.

Install:

einstall [make options]

This is used as a replacement for make install. Performs:

make \
        prefix=${ED}/usr \
        datadir=${ED}/usr/share \
        infodir=${ED}/usr/share/info \
        localstatedir=${ED}/var/lib \
        mandir=${ED}/usr/share/man \
        sysconfdir=${ED}/etc \
        ${EXTRA_EINSTALL} \
        make options \
        install

Please do not use this in place of 'emake install DESTDIR=${D}'. That is the preferred way of installing make-based packages. Also, do not utilize the EXTRA_EINSTALL variable since it is for users.

docompress [-x] <path> [list of more paths]

Beginning with EAPI 4, the docompress helper is used to manage lists of files to be included or excluded from optional compression. If the first argument is -x, add each of its subsequent arguments to the exclusion list. Otherwise, add each argument to the inclusion list. The inclusion list initially contains /usr/share/doc, /usr/share/info, and /usr/share/man. The exclusion list initially contains /usr/share/doc/${PF}/html.

The optional compression shall be carried out after src_install has completed, and before the execution of any subsequent phase function. For each item in the inclusion list, pretend it has the value of the D variable prepended, then:

If it is a directory, act as if every file or directory immediately under this directory were in the inclusion list.

If the item is a file, it may be compressed unless it has been excluded as described below.

If the item does not exist, it is ignored.

Whether an item is to be excluded is determined as follows: For each item in the exclusion list, pretend it has the value of the D variable prepended, then:

If it is a directory, act as if every file or directory immediately under this directory were in the exclusion list.

If the item is a file, it shall not be compressed.

If the item does not exist, it is ignored.

dosed s:orig:change:g <filename>

Beginning with EAPI 4, the dosed helper no longer exists. Ebuilds should call sed(1) directly (and assume that it is GNU sed).

Performs sed in place on filename inside ${ED}. If no expression is given then "s:${D}::g" is used as the default expression. Note that this expression does NOT use the offset prefix.
'dosed s:/usr/local:/usr:g /usr/bin/some-script' runs sed on ${ED}/usr/bin/some-script

dodir <path> [more paths]

Creates directories inside of ${ED}.
'dodir /usr/lib/apache' creates ${ED}/usr/lib/apache. Note that the do* functions will run dodir for you. If this directory will be empty when it is merged, then please use keepdir instead.

diropts [options for install(1)]

Can be used to define options for the install function used in dodir. The default is -m0755.

into <path>

Sets the root (DESTTREE) for other functions like dobin, dosbin, doman, doinfo, dolib.
The default root is /usr.

keepdir <path> [more paths]

Similar to dodir, but used to create directories that would otherwise be empty. The treatment of completely-empty directories is undefined by PMS, and using keepdir ensures that they are tracked.

dobin <binary> [list of more binaries]

Installs a binary or a list of binaries into DESTTREE/bin. Creates all necessary dirs.

dosbin <binary> [list of more binaries]

Installs a binary or a list of binaries into DESTTREE/sbin. Creates all necessary dirs.

doinitd <init.d script> [list of more init.d scripts]

Install Gentoo init.d scripts. They will be installed into the correct location for Gentoo init.d scripts (/etc/init.d/). Creates all necessary dirs.

doconfd <conf.d file> [list of more conf.d file]

Install Gentoo conf.d files. They will be installed into the correct location for Gentoo conf.d files (/etc/conf.d/). Creates all necessary dirs.

doenvd <env.d entry> [list of more env.d entries]

Install Gentoo env.d entries. They will be installed into the correct location for Gentoo env.d entries (/etc/env.d/). Creates all necessary dirs.

dolib <library> [list of more libraries]

dolib.a <library> [list of more libraries]

dolib.so <library> [list of more libraries]

Installs a library or a list of libraries into DESTTREE/lib. Creates all necessary dirs.

libopts [options for install(1)]

Can be used to define options for the install function used in the dolib functions. The default is -m0644.

doman [-i18n=<locale>] <man-page> [list of more man-pages]

Installs manual-pages into /usr/share/man/man[0-9n] depending on the manual file ending. The files are compressed if they are not already. You can specify locale-specific manpages with the -i18n option. Then the man-page will be installed into /usr/share/man/<locale>/man[0-9n]. Beginning with EAPI 2, a locale-specific manpage which contains a locale in the file name will be installed in /usr/share/man/<locale>/man[0-9n], with the locale portion of the file name removed, and the -i18n option has no effect. For example, with EAPI 2, a manpage named foo.<locale>.1 will be installed as /usr/share/man/<locale>/man1/foo.1. Beginning with EAPI 4, the -i18n option takes precedence over the locale suffix of the file name.

dohard <filename> <linkname>

Beginning with EAPI 4, the dohard helper no longer exists. Ebuilds should call ln(1) directly.

dosym <filename> <linkname>

Performs the ln command to create a symlink.

doheader [-r] <file> [list of more files]

Installs the given header files into /usr/include/, by default with file mode 0644 (this can be overridden with the insopts function). Setting -r sets recursive. The doheader helper is available beginning with EAPI 5.

dohtml [-a filetypes] [-r] [-x list-of-dirs-to-ignore] [list-of-files-and-dirs]

Installs the files in the list of files (space-separated list) into /usr/share/doc/${PF}/html provided the file ends in .htm, .html, .css, .js, Setting -a limits what types of files will be included, -A appends to the default list, setting -x sets which dirs to exclude (CVS excluded by default), -p sets a document prefix, -r sets recursive.

doinfo <info-file> [list of more info-files]

Installs info-pages into DESTDIR/info. Files are automatically gzipped. Creates all necessary dirs.

domo <locale-file> [list of more locale-files]

Installs locale-files into DESTDIR/usr/share/locale/[LANG] depending on local-file's ending. Creates all necessary dirs.

fowners [-h|-H|-L|-P|-R] [user][:group] <file> [files]

fperms [-R] <permissions> <file> [files]

Performs chown (fowners) or chmod (fperms), applying permissions to files.

insinto [path]

Sets the destination path for the doins function.
The default path is /.

insopts [options for install(1)]

Can be used to define options for the install function used in doins. The default is -m0644.

doins [-r] <file> [list of more files]

Installs files into the path controlled by insinto. This function uses install(1). Creates all necessary dirs. Setting -r sets recursive. Beginning with EAPI 4, both doins and newins preserve symlinks. In EAPI 3 and earlier, symlinks are dereferenced rather than preserved.

exeinto [path]

Sets the destination path for the doexe function.
The default path is /.

exeopts [options for install(1)]

Can be used to define options for the install function used in doexe. The default is -m0755.

doexe <executable> [list of more executables]

Installs executables into the path controlled by exeinto. This function uses install(1). Creates all necessary dirs.

docinto [path]

Sets the subdir used by dodoc and dohtml when installing into the document tree (based in /usr/share/doc/${PF}/). Default is no subdir, or just "".

dodoc [-r] <document> [list of more documents]

Installs a document or a list of documents into /usr/share/doc/${PF}/<docinto path>. Documents are marked for compression. Creates all necessary dirs. Beginning with EAPI 4, there is support for recursion, enabled by the new -r option.

newbin <old file> <new filename>

newsbin <old file> <new filename>

newinitd <old file> <new filename>

newconfd <old file> <new filename>

newenvd <old file> <new filename>

newlib.so <old file> <new filename>

newlib.a <old file> <new filename>

newman <old file> <new filename>

newins <old file> <new filename>

newexe <old file> <new filename>

newdoc <old file> <new filename>

All these functions act like the do* functions, but they only work with one file and the file is installed as [new filename]. Beginning with EAPI 5, standard input is read when the first parameter is - (a hyphen).

EXAMPLES

# Copyright 1999-2013 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: $

EAPI="5"

inherit some_eclass another_eclass

DESCRIPTION="Super-useful stream editor (sed)"
HOMEPAGE="https://www.gnu.org/software/sed/"
SRC_URI="ftp://alpha.gnu.org/pub/gnu/${PN}/${P}.tar.gz"

LICENSE="GPL-2"
SLOT="0"
KEYWORDS="~x86"
IUSE=""

RDEPEND=""
DEPEND="nls? ( sys-devel/gettext )"

src_configure() {
        econf \
                --bindir="${EPREFIX}"/bin
}

src_install() {
        emake DESTDIR="${D}" install
        dodoc NEWS README* THANKS AUTHORS BUGS ChangeLog
}

FILES

The /usr/lib/portage/bin/ebuild.sh script.

The helper apps in /usr/lib/portage/bin.

/etc/portage/make.conf

Contains variables for the build-process and overwrites those in make.defaults.

/usr/share/portage/config/make.globals

Contains the default variables for the build-process, you should edit /etc/portage/make.conf instead.

/etc/portage/color.map

Contains variables customizing colors.

SEE ALSO

REPORTING BUGS

AUTHORS

Achim Gottinger <achim@gentoo.org>
Mark Guertin <gerk@gentoo.org>
Nicholas Jones <carpaski@gentoo.org>
Mike Frysinger <vapier@gentoo.org>
Arfrever Frehtes Taifersar Arahesis <arfrever@apache.org>
Fabian Groffen <grobian@gentoo.org>