MAKE.CONF(5) Portage MAKE.CONF(5)NAMEmake.conf - custom settings for Portage
SYNOPSIS
/etc/make.conf and /etc/portage/make.conf
DESCRIPTION
This file contains various variables that are used by Portage. The file
has a newline-delimited list of <key>=<value> pairs (see the default
file for examples) which are accessible from the environment of
ebuilds. It supports simple shell-like expansion of the form
var="${var}", the source keyword and variable substitution, but not
some of the more advanced BASH features like arrays and special parame‐
ter expansions. For more details, see the Simple lexical analysis docu‐
mentation: http://docs.python.org/3/library/shlex.html. Note that if
you source files, they need to be in the same shlex syntax for portage
to read them.
Portage will check the currently-defined environment variables first
for any settings. If no environment settings are found, Portage then
checks the make.conf files. Both /etc/make.conf and
/etc/portage/make.conf are checked (if present), and settings from
/etc/portage/make.conf will override settings from /etc/make.conf. If
no setting is found in the make.conf files, Portage checks make.glob‐
als. If no setting is found there, the profile's default setting is
grabbed from /etc/portage/make.profile/make.defaults. Please note that
all user settings should be made in the environment or in the make.conf
files, which are intended to be customized by the user.
Exceptions are incremental variables such as USE, CONFIG_PROTECT*, and
ACCEPT_KEYWORDS. Incremental variables are propagated down from
make.defaults to make.globals to make.conf to the environment settings.
Clearing these variables requires a clear-all as in: export USE="-*"
In order to create per-package environment settings, refer to pack‐
age.env in portage(5).
VARIABLES
ACCEPT_CHOSTS = [space delimited list of CHOST values]
Specifies acceptable CHOST values. Regular expression syntax is
supported, so it is necessary to escape CHOST characters if they
have special meaning in regular expressions.
Defaults to the value of $CHOST.
ACCEPT_KEYWORDS = [space delimited list of KEYWORDS]
Enable testing of ebuilds that have not yet been deemed 'sta‐
ble'. Users of the 'x86' architecture would set this to '~x86'
while ppc users would set this to '~ppc'. This is an incremen‐
tal variable. Only define a ~arch.
Defaults to the value of $ARCH.
ACCEPT_LICENSE = [space delimited list of licenses or groups]
This variable is used to mask packages based on licensing
restrictions. It may contain both license and group names, where
group names are prefixed with the '@' symbol. License groups are
defined in the license_groups file (see portage(5)). In addition
to license and group names, the * and -* wildcard tokens are
also supported. Refer to GLEP 23 for further information:
http://www.gentoo.org/proj/en/glep/glep-0023.html.
Defaults to the value of * -@EULA.
Examples:
# Only accept licenses in the FREE license group (i.e. Free Software)
ACCEPT_LICENSE="-* @FREE"
# As before, but exclude the "Artistic" license
ACCEPT_LICENSE="-* @FREE -Artistic"
# Accept any license except those in the EULA license group (default)
ACCEPT_LICENSE="* -@EULA"
ACCEPT_PROPERTIES = [space delimited list of properties]
This variable is used to mask packages based on PROPERTIES
restrictions. In addition to property names, the * and -* wild‐
card tokens are also supported. This variable can be temporarily
overridden using the --accept-properties option of emerge(1).
See ebuild(5) for more information about PROPERTIES.
Defaults to the value of *.
Examples:
# Accept any properties
ACCEPT_PROPERTIES="*"
# Accept any properties except the "interactive" property
ACCEPT_PROPERTIES="* -interactive"
ACCEPT_RESTRICT = [space delimited list of RESTRICT tokens]
This variable is used to mask packages based on RESTRICT tokens.
In addition to RESTRICT tokens, the * and -* wildcard tokens are
also supported. This variable can be temporarily overridden
using the --accept-restrict option of emerge(1). See ebuild(5)
for more information about RESTRICT.
Defaults to the value of *.
Examples:
# Accept any restrict tokens
ACCEPT_RESTRICT="*"
# Accept any tokens except "bindist"
ACCEPT_RESTRICT="* -bindist"
CBUILD This variable is passed by the ebuild scripts to the configure
as --build=${CBUILD} only if it is defined. Do not set this
yourself unless you know what you are doing.
CCACHE_DIR = [path]
Defines the location of the ccache working directory. See the
ccache(1) man page for more information.
Defaults to /var/tmp/ccache
CCACHE_SIZE = "size"
This controls the space use limitations for ccache. The default
is 2 gigabytes ('2G'). Sizes are specified with 'G', 'M', or
'K'.
CFLAGS CXXFLAGS
Use these variables to set the desired optimization/CPU instruc‐
tion settings for applications that you compile. These two
variables are passed to the C and C++ compilers, respectively.
(CXX is used to refer to the C++ compiler within many buildsys‐
tems.) Nearly all ebuild files will take advantage of your cus‐
tom settings, resulting in a Gentoo Linux that is fully custom‐
ized to your specifications. Please use sane settings as some
packages will fail to compile/run if the optimizations are too
extreme.
For more information, see the Invoking GCC section of the gcc
manual:
http://gcc.gnu.org/onlinedocs/
CHOST This variable is passed by the ebuild scripts to the configure
step as --host=${CHOST}. This way you can force the build-host.
For more information:
http://gcc.gnu.org/onlinedocs/gcc-4.1.1/gcc/Sub‐
model-Options.html
http://gcc.gnu.org/onlinedocs/gcc-3.3/gcc/Submodel-Options.html
http://gcc.gnu.org/onlinedocs/gcc-3.2/gcc/Submodel-Options.html
http://gcc.gnu.org/onlinedocs/gcc-2.95.3/gcc_2.html
CLEAN_DELAY = integer
Determines how long the countdown delay will be after running
`emerge --unmerge`.
Defaults to 5 seconds.
COLLISION_IGNORE = [space delimited list of fnmatch patterns]
This variable allows the user to disable collision-protect and
protect-owned for specific fnmatch(3) patterns. For backward
compatibility, directories that are listed without a fnmatch
pattern will automatically have /* appended to them.
Defaults to "/lib/modules/* *.py[co]".
CONFIG_PROTECT = [space delimited list of files and/or directories]
All files and/or directories that are defined here will have
"config file protection" enabled for them. See the CONFIGURATION
FILES section of emerge(1) for more information.
CONFIG_PROTECT_MASK = [space delimited list of files and/or directo‐
ries]
All files and/or directories that are defined here will have
"config file protection" disabled for them. See the CONFIGURA‐
TION FILES section of emerge(1) for more information.
CTARGET
This variable is passed by the ebuild scripts to the configure
as --target=${CTARGET} only if it is defined.
DISTDIR = [path]
Defines the location of your local source file repository. After
packages are built, it is safe to remove any and all files from
this directory since they will be automatically fetched on
demand for a given build. If you would like to selectively prune
obsolete files from this directory, see eclean(1) from the gen‐
toolkit package.
Use the PORTAGE_RO_DISTDIRS variable to specify one or more
read-only directories containing distfiles.
Note that locations under /usr/portage are not necessarily safe
for data storage. See the PORTDIR documentation for more infor‐
mation.
Defaults to /usr/portage/distfiles.
DCO_SIGNED_OFF_BY
This variable may contain a name and email address which will be
used by repoman(1) to add a Signed-off-by line to each commit
message.
DOC_SYMLINKS_DIR
If this variable contains a directory then symlinks to html doc‐
umentation will be installed into it.
EBEEP_IGNORE
Defines whether or not to ignore audible beeps when displaying
important informational messages. This variable is unset by
default.
EMERGE_DEFAULT_OPTS
Options to append to the end of the emerge(1) command line on
every invocation. These options will not be appended to the com‐
mand line if --ignore-default-opts is specified.
EMERGE_LOG_DIR
Controls the location of emerge.log and emerge-fetch.log.
Defaults to /var/log.
EMERGE_WARNING_DELAY = integer
Determines how long the countdown delay will be after running
`emerge --unmerge` for a system package.
Defaults to 10 seconds.
EPAUSE_IGNORE
Defines whether or not to ignore short pauses that occur when
displaying important informational messages. This variable is
unset by default. If it is set to any value pauses are ignored.
EXTRA_ECONF = [configure options string]
Contains additional options that econf will append to configure
script arguments (see ebuild(5)).
FEATURES = "sandbox"
Defines actions portage takes by default. This is an incremental
variable. Most of these settings are for developer use, but
some are available to non-developers as well. The sandbox fea‐
ture is very important and should not be disabled by default.
assume-digests
When commiting work to cvs with repoman(1), assume that
all existing SRC_URI digests are correct. This feature
also affects digest generation via ebuild(1) and
emerge(1) (emerge generates digests only when the digest
feature is enabled). Existing digests for files that do
not exist in ${DISTDIR} will be automatically assumed
even when assume-digests is not enabled. If a file exists
in ${DISTDIR} but its size does not match the existing
digest, the digest will be regenerated regardless of
whether or not assume-digests is enabled. The ebuild(1)
digest command has a --force option that can be used to
force regeneration of digests.
binpkg-logs
Keep logs from successful binary package merges. This is
relevant only when PORT_LOGDIR is set.
buildpkg
Binary packages will be created for all packages that are
merged. Also see quickpkg(1) and emerge(1)--buildpkg and
--buildpkgonly options.
buildsyspkg
Build binary packages for just packages in the system
set.
candy Enable a special progress indicator when emerge(1) is
calculating dependencies.
ccache Enable portage support for the ccache package. If the
ccache dir is not present in the user's environment, then
portage will default to ${PORTAGE_TMPDIR}/ccache.
Warning: This feature is known to cause numerous compila‐
tion failures. Sometimes ccache will retain stale code
objects or corrupted files, which can lead to packages
that cannot be emerged. If this happens (if you receive
errors like "File not recognized: File truncated"), try
recompiling the application with ccache disabled before
reporting a bug. Unless you are doing development work,
do not enable ccache.
cgroup Use Linux control group to control processes spawned by
ebuilds. This allows emerge to safely kill all subpro‐
cesses when ebuild phase exits.
clean-logs
Enable automatic execution of the command specified by
the PORT_LOGDIR_CLEAN variable. The default
PORT_LOGDIR_CLEAN setting will remove all files from
PORT_LOGDIR that were last modified at least 7 days ago.
collision-protect
A QA-feature to ensure that a package doesn't overwrite
files it doesn't own. The COLLISION_IGNORE variable can
be used to selectively disable this feature. Also see the
related protect-owned feature.
compress-build-logs
The causes all build logs to be compressed while they are
being written. Log file names have an extension that is
appropriate for the compression type. Currently, only
gzip(1) compression is supported, so build logs will have
a '.gz' extension when this feature is enabled.
compressdebug
Compress the debug sections in the split debug files with
zlib to save space. Make sure you have built both binu‐
tils and gdb with USE=zlib support for this to work. See
splitdebug for general split debug information (upon
which this feature depends).
compress-index
If set then a compressed copy of 'Packages' index file
will be written. This feature is intended for Gentoo
binhosts using certain webservers (such as, but not lim‐
ited to, Nginx with gzip_static module) to avoid redun‐
dant on-the-fly compression. The resulting file will be
called 'Packages.gz' and its modification time will match
that of 'Packages'.
config-protect-if-modified
This causes the CONFIG_PROTECT behavior to be skipped for
files that have not been modified since they were
installed. This feature is enabled by default.
digest Autogenerate digests for packages when running the
emerge(1), ebuild(1), or repoman(1) commands. If the
assume-digests feature is also enabled then existing
SRC_URI digests will be reused whenever they are avail‐
able.
distcc Enable portage support for the distcc package.
distcc-pump
Enable portage support for the distcc package with pump
mode.
distlocks
Portage uses lockfiles to ensure competing instances
don't clobber each other's files. This feature is enabled
by default but may cause heartache on less intelligent
remote filesystems like NFSv2 and some strangely config‐
ured Samba server (oplocks off, NFS re-export). A tool
/usr/lib/portage/bin/clean_locks exists to help handle
lock issues when a problem arises (normally due to a
crash or disconnect).
downgrade-backup
When a package is downgraded to a lower version, call
quickpkg(1) in order to create a backup of the installed
version before it is unmerged (if a binary package of the
same version does not already exist). Also see the
related unmerge-backup feature.
ebuild-locks
Use locks to ensure that unsandboxed ebuild phases never
execute concurrently. Also see parallel-install.
fakeroot
Enable fakeroot for the install and package phases when a
non-root user runs the ebuild(1) command.
fail-clean
Clean up temporary files after a build failure. This is
particularly useful if you have PORTAGE_TMPDIR on tmpfs.
If this feature is enabled, you probably also want to
enable PORT_LOGDIR in order to save the build log. Both
the ebuild(1) command and the noclean feature cause the
fail-clean feature to be automatically disabled.
getbinpkg
Force emerges to always try to fetch files from the
PORTAGE_BINHOST. See make.conf(5) for more information.
installsources
Install source code into /usr/src/debug/${CATEGORY}/${PF}
(also see splitdebug). This feature works only if
debugedit is installed and CFLAGS is set to include debug
information (such as with the -ggdb flag).
keeptemp
Do not delete the ${T} directory after the merge process.
keepwork
Do not delete the ${WORKDIR} directory after the merge
process. ${WORKDIR} can then be reused since this feature
disables most of the clean phase that runs prior to each
build. Due to lack of proper cleanup, this feature can
interfere with normal emerge operation and therefore it
should not be left enabled for more than a short period
of time.
fixlafiles
Modifies .la files to not include other .la files and
some other fixes (order of flags, duplicated entries,
...)
force-mirror
Only fetch files from configured mirrors, ignoring
SRC_URI, except when mirror is in the ebuild(5) RESTRICT
variable.
force-prefix
Enable prefix support for all ebuilds, regardless of
EAPI, since older EAPIs would otherwise be useless with
prefix configurations. This brings compatibility with the
prefix branch of portage, which also supports EPREFIX for
all EAPIs (for obvious reasons).
ipc-sandbox
Isolate the ebuild phase functions from host IPC names‐
pace. Supported only on Linux. Requires network namespace
support in kernel.
lmirror
When mirror is enabled in FEATURES, fetch files even when
mirror is also in the ebuild(5) RESTRICT variable. Do
NOT use lmirror for clients that need to override
RESTRICT when fetching from a local mirror, but instead
use a "local" mirror setting in /etc/portage/mirrors, as
described in portage(5).
merge-sync
After a package is merged or unmerged, sync relevant
files to disk in order to avoid data-loss in the event of
a power failure. This feature is enabled by default.
metadata-transfer
Automatically perform a metadata transfer when `emerge
--sync` is run. In versions of portage >=2.1.5, this
feature is disabled by default. When metadata-transfer is
disabled, metadata cache from the ${PORTDIR}/meta‐
data/md5-cache/ directory will be used directly (if
available).
mirror Fetch everything in SRC_URI regardless of USE settings,
except do not fetch anything when mirror is in RESTRICT.
multilib-strict
Many Makefiles assume that their libraries should go to
/usr/lib, or $(prefix)/lib. This assumption can cause a
serious mess if /usr/lib isn't a symlink to /usr/lib64.
To find the bad packages, we have a portage feature
called multilib-strict. It will prevent emerge from
putting 64bit libraries into anything other than
(/usr)/lib64.
network-sandbox
Isolate the ebuild phase functions from host network
interfaces. Supported only on Linux. Requires network
namespace support in kernel.
news Enable GLEP 42 news support. See http://www.gen‐
too.org/proj/en/glep/glep-0042.html.
noauto When utilizing ebuild(1), only run the function
requested. Also, forces the corresponding ebuild and
eclasses to be sourced again for each phase, in order to
account for modifications.
noclean
Do not delete the the source and temporary files after
the merge process.
nodoc Do not install doc files (/usr/share/doc).
noinfo Do not install info pages.
noman Do not install manpages.
nostrip
Prevents the stripping of binaries that are merged to the
live filesystem.
notitles
Disables xterm titlebar updates (which contains status
info).
parallel-fetch
Fetch in the background while compiling. Run `tail -f
/var/log/emerge-fetch.log` in a terminal to view paral‐
lel-fetch progress.
parallel-install
Use finer-grained locks when installing packages, allow‐
ing for greater parallelization. For additional paral‐
lelization, disable ebuild-locks.
prelink-checksums
If prelink(8) is installed then use it to undo any pre‐
links on files before computing checksums for merge and
unmerge. This feature is useful only if prelink(8) is
installed and accurate checksums (despite prelinking) are
needed for some reason such as for checking the integrity
of installed files or because the unmerge-orphans feature
is disabled.
Note that normal emerging of packages from source com‐
putes the checksums before things will be prelinked, so
in such cases, this feature isn't required either. Undo‐
ing prelinking while merging is only required when using
tools like quickpkg(1) which can cause already prelinked
files to be merged.
preserve-libs
Preserve libraries when the sonames change during upgrade
or downgrade. Libraries are preserved only if consumers
of those libraries are detected. Preserved libraries are
automatically removed when there are no remaining con‐
sumers. Run `emerge @preserved-rebuild` in order to
rebuild all consumers of preserved libraries.
protect-owned
This is identical to the collision-protect feature except
that files may be overwritten if they are not explicitly
listed in the contents of a currently installed package.
This is particularly useful on systems that have lots of
orphan files that have been left behind by older versions
of portage that did not support the unmerge-orphans fea‐
ture. Like collision-protect, the COLLISION_IGNORE vari‐
able can be used to selectively disable this feature. It
is recommended to leave either protect-owned or colli‐
sion-protect enabled at all times, since otherwise file
collisions between packages may result in files being
overwritten or uninstalled at inappropriate times. If
collision-protect is enabled then it takes precedence
over protect-owned.
python-trace
Output a verbose trace of python execution to stderr when
a command's --debug option is enabled.
sandbox
Enable sandbox-ing when running emerge(1) and ebuild(1).
sesandbox
Enable SELinux sandbox-ing. Do not toggle this FEATURE
yourself.
sfperms
Stands for Smart Filesystem Permissions. Before merging
packages to the live filesystem, automatically search for
and set permissions on setuid and setgid files. Files
that are setuid have the group and other read bits
removed while files that are setgid have the other read
bit removed. See also suidctl below.
sign When commiting work to cvs with repoman(1), sign the Man‐
ifest with a GPG key. Read about the PORTAGE_GPG_KEY
variable in make.conf(5).
skiprocheck
Skip write access checks on DISTDIR when fetching files.
This is useful when FETCHCOMMAND and RESUMECOMMAND are
used to forward fetch requests to a server that exposes
DISTDIR as a read-only NFS share. A read-only DISTDIR is
not compatible with the distlocks, so it is recommended
to also add "-distlocks" to FEATURES in order to avoid
warning messages that are triggered by this incompatibil‐
ity.
split-elog
Store logs created by PORTAGE_ELOG_SYSTEM="save" in cate‐
gory subdirectories of PORT_LOGDIR/elog, instead of using
PORT_LOGDIR/elog directly.
split-log
Store build logs in category subdirectories of
PORT_LOGDIR/build, instead of using PORT_LOGDIR directly.
splitdebug
Prior to stripping ELF etdyn and etexec files, the debug‐
ging info is stored for later use by various debuggers.
This feature is disabled by nostrip. You should also
consider setting compressdebug so the files don't suck up
a lot of space. For installation of source code, see
installsources.
strict Have portage react strongly to conditions that have the
potential to be dangerous (like missing or incorrect
digests for ebuilds).
stricter
Have portage react strongly to conditions that may con‐
flict with system security provisions (for example tex‐
trels, executable stack). Read about the QA_STRICT_*
variables in make.conf(5).
suidctl
Before merging packages to the live filesystem, automati‐
cally strip setuid bits from any file that is not listed
in /etc/portage/suidctl.conf.
test Run package-specific tests during each merge to help make
sure the package compiled properly. See test in
ebuild(1) and src_test() in ebuild(5). This feature
implies the "test" USE flag if it is a member of IUSE,
either explicitly or implicitly (see ebuild(5) for more
information about IUSE). The "test" USE flag is also
automatically disabled when the "test" feature is dis‐
abled.
test-fail-continue
If "test" is enabled FEATURES and the test phase of an
ebuild fails, continue to execute the remaining phases as
if the failure had not occurred. Note that the test
phase for a specific package may be disabled by masking
the "test" USE flag in package.use.mask (see portage(5)).
unmerge-backup
Call quickpkg(1) to create a backup of each package
before it is unmerged (if a binary package of the same
version does not already exist). Also see the related
downgrade-backup feature.
unmerge-logs
Keep logs from successful unmerge phases. This is rele‐
vant only when PORT_LOGDIR is set.
unmerge-orphans
If a file is not claimed by another package in the same
slot and it is not protected by CONFIG_PROTECT, unmerge
it even if the modification time or checksum differs from
the file that was originally installed.
unknown-features-filter
Filter out any unknown values that the FEATURES variable
contains.
unknown-features-warn
Warn if FEATURES contains one or more unknown values.
userfetch
When portage is run as root, drop privileges to
portage:portage during the fetching of package sources.
userpriv
Allow portage to drop root privileges and compile pack‐
ages as portage:portage without a sandbox (unless user‐
sandbox is also used).
usersandbox
Enable the sandbox in the compile phase, when running
without root privs (userpriv).
usersync
Drop privileges to the owner of PORTDIR for emerge(1)--sync operations. Note that this feature assumes that
all subdirectories of PORTDIR have the same ownership as
PORTDIR itself. It is the user's responsibility to ensure
correct ownership, since otherwise portage would have to
waste time validating ownership for each and every sync
operation.
webrsync-gpg
Enable GPG verification when using emerge-webrsync.
xattr Preserve extended attributes (filesystem-stored metadata)
when installing files (see attr(1)). The
PORTAGE_XATTR_EXCLUDE variable may be used to exclude
specific attributes from being preserved.
FETCHCOMMAND
This variable contains the command used for fetching package
sources from the internet. It must contain the full path to the
executable as well as the place-holders \${DISTDIR}, \${FILE}
and \${URI}. The command should be written to place the fetched
file at \${DISTDIR}/\${FILE}. Also see RESUMECOMMAND.
FFLAGS FCFLAGS
Use these variables to set the desired optimization/CPU instruc‐
tion settings for applications that you compile with a FORTRAN
compiler. FFLAGS is usually passed to the FORTRAN 77 compiler,
and FCFLAGS to any FORTRAN compiler in more modern build sys‐
tems.
For more information, see the Invoking GCC section of the gcc
manual:
http://gcc.gnu.org/onlinedocs/
GENTOO_MIRRORS = [URIs]
Insert your space-separated list of local mirrors here. These
locations are used to download files before the ones listed in
the ebuild scripts. Merging 'mirrorselect' can help. Entries in
this variable that have no protocol and simply start with a '/'
path separator may be used to specify mounted filesystem mir‐
rors.
http_proxy ftp_proxy RSYNC_PROXY = [protocol://host:port]
These variables are used by network clients such as wget(1) and
rsync(1). They are only required if you use a proxy server for
internet access.
INSTALL_MASK = [space delimited list of file names]
Use this variable if you want to selectively prevent certain
files from being copied into your file system tree. This does
not work on symlinks, but only on actual files. Useful if you
wish to filter out files like HACKING.gz and TODO.gz. The
INSTALL_MASK is processed just before a package is merged. Also
supported is a PKG_INSTALL_MASK variable that behaves exactly
like INSTALL_MASK except that it is processed just before cre‐
ation of a binary package.
LDFLAGS
A list of flags to pass to the compiler when the linker will be
called. See ld(1) for linker flags, but don't forget that these
flags will be passed directly to the compiler. Thus, you must
use '-Wl' to escape the flags which only the linker understands
(see gcc(1)).
***warning***
Setting this and other *FLAGS variables arbitrarily may cause
compile or runtime failures. Bug reports submitted when nonstan‐
dard values are enabled for these flags may be closed as
INVALID.
MAKEOPTS
Use this variable if you want to use parallel make. For exam‐
ple, if you have a dual-processor system, set this variable to
"-j2" or "-j3" for enhanced build performance with many pack‐
ages. Suggested settings are between CPUs+1 and 2*CPUs+1. In
order to avoid excess load, the --load-average option is recom‐
mended. For more information, see make(1). Also see emerge(1)
for information about analogous --jobs and --load-average
options.
NOCOLOR = ["true" | "false"]
Defines if color should be disabled by default.
Defaults to false.
PKGDIR = [path]
Defines the location where created .tbz2 binary packages will be
stored when the emerge(1)--buildpkg option is enabled. By
default, a given package is stored in a subdirectory correspond‐
ing to it's category. However, for backward compatibility with
the layout used by older versions of portage, if the
${PKGDIR}/All directory exists then all packages will be stored
inside of it and symlinks to the packages will be created in the
category subdirectories. Note that locations under /usr/portage
are not necessarily safe for data storage. See the PORTDIR doc‐
umentation for more information.
Defaults to /usr/portage/packages.
PORT_LOGDIR
This variable defines the directory in which per-ebuild logs are
kept. Logs are created only when this is set. They are stored
as ${CATEGORY}:${PF}:YYYYMMDD-HHMMSS.log in the directory speci‐
fied. If the directory does not exist, it will be created auto‐
matically and group permissions will be applied to it. If the
directory already exists, portage will not modify it's permis‐
sions.
PORT_LOGDIR_CLEAN
This variable should contain a command for portage to call in
order to clean PORT_LOGDIR. The command string should contain a
\${PORT_LOGDIR} place-holder that will be substituted with the
value of that variable. This variable will have no effect unless
clean-logs is enabled in FEATURES.
PORTAGE_BINHOST = [space delimited URI list]
This is a list of hosts from which portage will grab pre‐
built-binary packages. Each entry in the list must specify the
full address of a directory serving tbz2's for your system (this
directory must contain a 'Packages' index file). This is only
used when running with the get binary pkg options are given to
emerge. Review emerge(1) for more information.
PORTAGE_BINHOST_HEADER_URI = "ftp://login:pass@grp.mir‐
ror.site/pub/grp/i686/athlon-xp/"
This variable only makes sense on a system that will serve as a
binhost and build packages for clients. It defines the URI
header field for the package index file which is located at
${PKGDIR}/Packages. Clients that have PORTAGE_BINHOST properly
configured will be able to fetch the index and use the URI
header field as a base URI for fetching binary packages. If the
URI header field is not defined then the client will use it's
${PORTAGE_BINHOST} setting as the base URI.
PORTAGE_BINPKG_TAR_OPTS
This variable contains options to be passed to the tar command
for creation of binary packages.
PORTAGE_BINPKG_FORMAT
This variable sets default format used for binary packages. Pos‐
sible values are tar and rpm or both.
PORTAGE_BUNZIP2_COMMAND = [bunzip2 command string]
This variable should contain a command that is suitable for
portage to call for bunzip2 extraction operations.
PORTAGE_BZIP2_COMMAND = [bzip2 command string]
This variable should contain a command that is suitable for
portage to call for bzip2 compression operations.
PORTAGE_BZIP2_COMMAND will also be called for extraction opera‐
tion, with -d appended, unless the PORTAGE_BUNZIP2_COMMAND vari‐
able is set.
PORTAGE_CHECKSUM_FILTER = [space delimited list of hash names]
This variable may be used to filter the hash functions that are
used to verify integrity of files. Hash function names are
case-insensitive, and the * and -* wildcard tokens are sup‐
ported.
Defaults to the value of *.
Examples:
# Use all available hash functions
PORTAGE_CHECKSUM_FILTER="*"
# Use any function except whirlpool
PORTAGE_CHECKSUM_FILTER="* -whirlpool"
# Only use sha256
PORTAGE_CHECKSUM_FILTER="-* sha256"
PORTAGE_COMPRESS = "bzip2"
This variable contains the command used to compress documenta‐
tion during the install phase.
PORTAGE_COMPRESS_FLAGS = "-9"
This variable contains flags for the PORTAGE_COMPRESS command.
PORTAGE_COMPRESS_EXCLUDE_SUFFIXES = "gif htm[l]? jp[e]?g pdf
png"
This variable contains a space delimited list of file
suffixes for which matching files are excluded when the
PORTAGE_COMPRESS command is called. Regular expressions
are supported and the match is performed only against the
portion of the file name which follows the last period
character.
PORTAGE_ELOG_CLASSES
PORTAGE_ELOG_SYSTEM
PORTAGE_ELOG_COMMAND
PORTAGE_ELOG_MAILURI
PORTAGE_ELOG_MAILFROM
PORTAGE_ELOG_MAILSUBJECT
Please see /usr/share/portage/config/make.conf.example
for elog documentation.
PORTAGE_FETCH_CHECKSUM_TRY_MIRRORS = 5
Number of mirrors to try when a downloaded file has an
incorrect checksum.
PORTAGE_FETCH_RESUME_MIN_SIZE = 350K
Minimum size of existing file for RESUMECOMMAND to be
called. Files smaller than this size will be removed and
FETCHCOMMAND will be called to download the file from the
beginning. This is useful for helping to ensure that
small garbage files such as html 404 pages are properly
discarded. The variable should contain an integer number
of bytes and may have a suffix such as K, M, or G.
PORTAGE_GPG_DIR
The gpg(1) home directory that is used by repoman(1) when
sign is in FEATURES.
Defaults to $HOME/.gnupg.
PORTAGE_GPG_KEY
The gpg(1) key used by repoman(1) to sign manifests when
sign is in FEATURES. In order to sign commits with
git(1), you will need Git >=1.7.9 and your commit key
will have to be configured by `git config user.signingkey
key_id`.
PORTAGE_GPG_SIGNING_COMMAND
The command used by repoman(1) to sign manifests when
sign is in FEATURES.
PORTAGE_GRPNAME = [group]
Defines the groupname to use when executing in user‐
priv/etc... modes (i.e. non-root).
Defaults to portage.
PORTAGE_INST_GID = [gid]
Defines the group id when installing files via dobin/dos‐
bin. Useful when running ebuild as yourself.
Defaults to 0.
PORTAGE_INST_UID = [uid]
Defines the user id when installing files via dobin/dos‐
bin. Useful when running ebuild as yourself.
Defaults to 0.
PORTAGE_IONICE_COMMAND = [ionice command string]
This variable should contain a command for portage to
call in order to adjust the io priority of portage and
it's subprocesses. The command string should contain a
\${PID} place-holder that will be substituted with an
integer pid. For example, a value of "ionice -c 3 -p
\${PID}" will set idle io priority. For more information
about ionice, see ionice(1). This variable is unset by
default.
PORTAGE_NICENESS = [number]
The value of this variable will be added to the current
nice level that emerge is running at. In other words,
this will not set the nice level, it will increment it.
For more information about nice levels and what are
acceptable ranges, see nice(1).
PORTAGE_RO_DISTDIRS = [space delimited list of directories]
When a given file does not exist in DISTDIR, search for
the file in this list of directories. Search order is
from left to right. Note that the current implementation
works by creating a symlink inside DISTDIR, but that may
change in the future.
PORTAGE_RSYNC_INITIAL_TIMEOUT = integer
Used by emerge --sync as a timeout for the initial con‐
nection to an rsync server.
Defaults to 15 seconds.
PORTAGE_RSYNC_EXTRA_OPTS = [rsync options string]
Additional rsync options to be used by emerge --sync.
Defaults to no value.
PORTAGE_RSYNC_OPTS = [rsync options string]
Default rsync options to be used by emerge --sync.
Don't change this unless you know exactly what you're
doing!
Defaults to "--recursive --links--safe-links --perms
--times--compress --force --whole-file --delete --stats
--timeout=180 --exclude='/distfiles' --exclude='/local'
--exclude='/packages'"
PORTAGE_RSYNC_RETRIES = [NUMBER]
The number of times rsync should retry on failed connec‐
tions before giving up. If set to a negative number, then
retry until all possible addresses are exhausted.
Defaults to -1.
PORTAGE_SSH_OPTS = [list of ssh options]
Additional ssh options to be used when portage executes
ssh or sftp. This variable supports use of embedded
quote characters to quote whitespace or special shell
characters within arguments (embedded quotes must be
escaped in make.conf settings).
Defaults to no value.
PORTAGE_SYNC_STALE = [NUMBER]
Defines the number of days after the last `emerge --sync`
that a warning message should be produced. A value of 0
will disable warnings.
Defaults to 30.
PORTAGE_TMPDIR = [path]
Defines the location of the temporary build directories.
Defaults to /var/tmp.
This should not be set to point anywhere under the direc‐
tory tree specified by PORTDIR (/usr/portage by default).
PORTAGE_USERNAME = [user]
Defines the username to use when executing in user‐
priv/etc... modes (i.e. non-root).
Defaults to portage.
PORTAGE_WORKDIR_MODE = "0700"
This variable controls permissions for WORKDIR (see
ebuild(5)).
PORTAGE_XATTR_EXCLUDE = [space delimited list of fnmatch pat‐
terns]
This variable may be used to exclude specific attributes
from being preserved when xattr is in FEATURES.
Defaults to "security.*" (security labels are special,
see bug #461868).
PORTDIR = [path]
Defines the location of the Portage tree. This is the
repository for all profile information as well as all
ebuilds. If you change this, you must update your
/etc/portage/make.profile symlink accordingly.
Defaults to /usr/portage.
***Warning***
Data stored inside PORTDIR is in peril of being overwrit‐
ten or deleted by the emerge --sync command. The default
value of PORTAGE_RSYNC_OPTS will protect the default
locations of DISTDIR and PKGDIR, but users are warned
that any other locations inside PORTDIR are not necessar‐
ily safe for data storage. You should not put other data
(such as overlays) in your PORTDIR. Portage will walk
directory structures and may arbitrarily add invalid cat‐
egories as packages.
PORTDIR_OVERLAY = "[path] [different-path] [etc...]"
Defines the directories in which user made ebuilds may be
stored and not overwriten when `emerge --sync` is run.
This is a space delimited list of directories.
Defaults to no value.
QA_STRICT_EXECSTACK = "set"
Set this to cause portage to ignore any QA_EXECSTACK
override settings from ebuilds. See also ebuild(5).
QA_STRICT_WX_LOAD = "set"
Set this to cause portage to ignore any QA_WX_LOAD over‐
ride settings from ebuilds. See also ebuild(5).
QA_STRICT_TEXTRELS = "set"
Set this to cause portage to ignore any QA_TEXTREL over‐
ride settings from ebuilds. See also ebuild(5).
QA_STRICT_FLAGS_IGNORED = "set"
Set this to cause portage to ignore any QA_FLAGS_IGNORED
override settings from ebuilds. See also ebuild(5).
QA_STRICT_MULTILIB_PATHS = "set"
Set this to cause portage to ignore any QA_MULTILIB_PATHS
override settings from ebuilds. See also ebuild(5).
QA_STRICT_PRESTRIPPED = "set"
Set this to cause portage to ignore any QA_PRESTRIPPED
override settings from ebuilds. See also ebuild(5).
RESUMECOMMAND
This variable contains the command used for resuming
package sources that have been partially downloaded. It
should be defined using the same format as FETCHCOMMAND,
and must include any additional option(s) that may be
necessary in order to continue a partially downloaded
file located at \${DISTDIR}/\${FILE}.
ROOT = [path]
Use ROOT to specify the target root filesystem to be used
for merging packages or ebuilds. Typically, you should
set this setting in the environment rather than in
make.conf itself. It's commonly used for creating new
build images. Make sure you use an absolute path. Refer
to the Cross-compilation section of ebuild(5) for infor‐
mation about how dependencies are handled for ROOT.
Defaults to /.
RPMDIR = [path]
Defines the location where created RPM packages will be
stored.
Defaults to ${PORTDIR}/rpm.
SYNC = [RSYNC]
Insert your preferred rsync mirror here. This rsync
server is used to sync the local portage tree when
`emerge --sync` is run.
Note that the SYNC variable is now deprecated, and
instead the sync-type and sync-uri attributes in
repos.conf should be used. See portage(5) for more infor‐
mation.
Defaults to rsync://rsync.gentoo.org/gentoo-portage
Usage: (rsync|ssh)://[username@]hostname[:port]/(mod‐
ule|path)
Examples:
rsync://private-mirror.com/portage-module
rsync://rsync-user@private-mirror.com:873/gen‐
too-portage
ssh://ssh-user@192.168.0.1:22/usr/portage
ssh://ssh-user@192.168.0.1:22/\${HOME}/portage-stor‐
age
Note: For the ssh:// scheme, key-based authentication
might be of interest.
UNINSTALL_IGNORE = [space delimited list of fnmatch patterns]
This variable prevents uninstallation of files that match
specific fnmatch(3) patterns. In order to ignore file
collisions with these files at install time, the same
patterns can be added to the COLLISION_IGNORE variable.
Defaults to "/lib/modules/*".
USE = [space delimited list of USE items]
This variable contains options that control the build
behavior of several packages. More information in
ebuild(5). Possible USE values can be found in
/usr/portage/profiles/use.desc.
USE_ORDER = "env:pkg:conf:defaults:pkginternal:repo:env.d"
Determines the precedence of layers in the incremental
stacking of the USE variable. Precedence decreases from
left to right such that env overrides pkg, pkg overrides
conf, and so forth.
***warning***
Do not modify this value unless you're a developer and
you know what you're doing. If you change this and some‐
thing breaks, we will not help you fix it.
env USE from the current environment variables (USE
and those listed in USE_EXPAND)
pkg Per-package USE from /etc/portage/package.use (see
portage(5))
conf USE from make.conf
defaults
USE from make.defaults and package.use in the pro‐
file (e.g. /etc/portage/make.profile/package.use)
(see portage(5))
pkginternal
USE from ebuild(5) IUSE defaults
repo USE from make.defaults and package.use in the
repo's profiles/ top dir (e.g. /usr/portage/pro‐
files/package.use) (see portage(5))
env.d USE from the environment variables, such as LIN‐
GUAS, defined by files in /etc/env.d/
REPORTING BUGS
Please report bugs via http://bugs.gentoo.org/
AUTHORS
Daniel Robbins <drobbins@gentoo.org>
Nicholas Jones <carpaski@gentoo.org>
Mike Frysinger <vapier@gentoo.org>
Saleem Abdulrasool <compnerd@gentoo.org>
Arfrever Frehtes Taifersar Arahesis <arfrever@apache.org>
FILES
/etc/make.conf and /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.
/usr/portage/profiles/use.desc
Contains a list of all global USE flags.
/usr/portage/profiles/use.local.desc
Contains a list of all local USE variables.
SEE ALSOemerge(1), portage(5), ebuild(1), ebuild(5)
The /usr/lib/portage/bin/ebuild.sh script.
The helper apps in /usr/lib/portage/bin.
Portage 2.2.8-r1 Aug 2013 MAKE.CONF(5)