MAKE.CONF

NAME

make.conf - custom settings for Portage

SYNOPSIS

/etc/make.conf

DESCRIPTION

This file contains various variables that are used by Portage. Portage will check the currently-defined environment variables first for any settings. If no environment settings are found, Portage then checks /etc/make.conf. If no setting is found in /etc/make.conf, Portage checks /etc/make.globals. If no setting is found there, the profile's default setting is grabbed from /etc/make.profile/make.defaults. Please note that all user settings should be made in the environment or in /etc/make.conf, which is 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="-*"

VARIABLES

ACCEPT_KEYWORDS = [space delimited list of KEYWORDS]

Enable testing of ebuilds that have not yet been deemed 'stable'. Users of the 'x86' architecture would set this to '~x86' while ppc users would set this to '~ppc'. This is an incremental variable. Only define a ~arch.
Defaults to the value of $ARCH.

AUTOCLEAN = ["yes" | "no"]

Automatically cleans the system by removing outdated packages which will not remove functionalities or prevent your system from working. On major ABI changes this may need to be set to off to ensure that the system can be rebuilt using the new libs before the old ones are removed. Downgrading with this option turned off may result in missing symlinks and an inoperable system.
Defaults to yes.

BUILD_PREFIX = [path]

Defines the location of the package working directory.
Defaults to ${PORTAGE_TMPDIR}/portage

CBUILD

This variable is passed by the ebuild scripts to the configure as --build=${CBUILD} only if it is defined. Presently HPPA is the only arch to require this.

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 instruction settings for applications that you compile. Nearly all ebuild files will take advantage of your custom settings, resulting in a Gentoo Linux that is fully customized to your specifications. Please use sane settings as some packages will fail to compile/run if the optimizations are too extreme.

For more information:
http://gcc.gnu.org/onlinedocs/gcc-3.2/gcc/Invoking-GCC.html
http://gcc.gnu.org/onlinedocs/gcc-3.3/gcc/Invoking-GCC.html
http://gcc.gnu.org/onlinedocs/gcc-2.95.3/gcc_2.html

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-3.2/gcc/Submodel-Options.html
http://gcc.gnu.org/onlinedocs/gcc-3.3/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 clean`.
Defaults to 5 seconds.

CONFIG_PROTECT = [space delimited list of dirs]

All directories that are defined here will have "config file protection" enabled for them. For more information, please see `emerge --help config`.

CONFIG_PROTECT_MASK = [space delimited list of dirs]

All directories that are defined here will have "config file protection" disabled for them. For more information, please see `emerge --help config`.

DISTDIR = [path]

Defines the location of your local source file repository.
Defaults to ${PORTDIR}/distfiles.

FEATURES = "sandbox ccache autoaddcvs"

Defines actions portage takes by default. These options should not be changed by anyone but developers and/or maintainers. 'sandbox' is an important part of FEATURES and should not be disabled by default. This is an incremental variable.

autoaddcvs: Causes portage to automatically try to add files to cvs that will have to be added later. Done at generation times and only works when cvs is also in FEATURES.
buildpkg: Binary packages will be created for all packages that are merged.
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 (with userpriv) and to /root/.ccache otherwise.
collision-protect: A QA-feature to ensure that a package doesn't overwrite files it doesn't own.
cvs: A feature for developers that causes portage to enable all USE flags in SRC_URI when creating digests.
digest: Autogenerate a digest for packages.
distcc: Enable portage support for the distcc package.
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 configured 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).
fixpackages: Runs the script that will fix the dependencies in all binary packages. This is run whenever packages are moved around in the portage tree. Please note that this can take a lot of time.
getbinpkg: Force emerges to always try to fetch files from the PORTAGE_BINHOST. See make.conf(5) for more information.
gpg: Check the signatures of Manifests and make sure they are correct.
keeptemp: Do not delete the ${T} directory after the merge process.
keepwork: Do not delete the ${WORKDIR} directory after the merge process.
maketest: 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).
mirror: This will cause FETCHCOMMAND to always be run even if the file already exists in DISTDIR.
noauto: When utilizing ebuild(1), only run the function requested.
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).
sandbox: Enable sandbox-ing when running emerge(1) and ebuild(1).
severe: When checking Manifests, only accept ones that have been signed by a key which you trust.
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 Manifest with a GPG key. Read about the PORTAGE_GPG_KEY variable in make.conf(5).
strict: Have portage react strongly to conditions that have the potential to be dangerous (like missing or incorrect Manifests).
suidctl: Before merging packages to the live filesystem, automatically strip setuid bits from any file that is not listed in /etc/portage/suidctl.conf.
userpriv: Allow portage to drop root privledges and compile packages as portage:portage without a sandbox (unless usersandbox is also used).
usersandbox: Enable the sandbox in the compile phase, when running without root privs (userpriv).

FETCHCOMMAND

This variable contains the command used for fetching package-sources from the internet.

GENTOO_MIRRORS = [URLs]

Insert your space-seperated list of local mirrors here. These locations are used to download files before the ones listed in the ebuild scripts. Merging 'mirrorselect' can help.

HTTP_PROXY FTP_PROXY = [host:port]

These vars are used if the sources must be downloaded from the internet by wget(1). They are only required if you use a proxy server for internet access. Either define PROXY or PROXY_FTP and PROXY_HTTP.

MAKEOPTS

Use this variable if you want to use parallel make. For example, if you have a dual-processor system, set this variable to "-j2" or "-j3" for enhanced build performance with many packages. Suggested settings are between CPUs+1 and 2*CPUs+1. For more information, see make(1).

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.
Defaults to ${PORTDIR}/packages.

PORT_LOGDIR

This variable defines the directory in which per-ebuild logs are kept. Logs are created only when this is set and writable.

PORTAGE_BINHOST = "ftp://login:pass@grp.mirror.site/pub/grp/i686/athlon-xp"

This is the host from which portage will grab prebuilt-binary packages. The list is a single entry specifying the full address of the directory serving the tbz2's for your system. This is only used when running with the get binary pkg options are given to emerge. Review emerge(1) for more information. Note that it should point to the 'All' directory on the host that creates the binary packages and not to the root of the PKGDIR.

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_TMPDIR = [path]

Defines the location of the temporary build directories.
Defaults to /var/tmp.

PORTDIR = [path]

Defines the location of your Portage tree.
Defaults to /usr/portage.

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.

RESUMECOMMAND

This variable contains the command used for resuming package-sources that have been partially downloaded by the FETCHCOMMAND.

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 /etc/make.conf itself. It's typically used for creating new build images.
Defaults to /.

RSYNC_EXCLUDEFROM = "/etc/portage/rsync_excludes"

This is a file that portage will pass to rsync when it updates the portage tree. Specific chucks of the tree may be excluded from the sync process. This may cause dependency failures if you are not careful. The file format is pattern per line, blanks and ';' or '#' lines are comments. See rsync(1) for more details.

RSYNC_RETRIES = [NUMBER]

The number of times rsync should retry on failed connections before giving up.
Defaults to 3.

RSYNC_TIMEOUT = [SECONDS]

The number of seconds rsync should remain idle before it determines the connection has timed out. Dialup users may need to set this value at or above 300 seconds.
Defaults to 180 seconds.

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.
Defaults to rsync://rsync.gentoo.org/gentoo-portage

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:auto:defaults"

Determines precedence for incrementing the setting of the USE variable. The above setting will cause the environment (env) to override per package (pkg) settings to override make.conf (conf) to override auto generated values from merged packages (auto) to override make.defaults (defaults).
***warning***
Do not modify this value unless you're a developer and you know what you're doing. If you change this and something breaks, we will not help you fix it.
Defaults to "env:pkg:conf:auto:defaults".

REPORTING BUGS

Please report bugs via http://bugs.gentoo.org/

FILES

/etc/make.conf: Contains variables for the build-process and overwrites those in make.defaults.
/etc/make.globals: Contains the default variables for the build-process, you should edit /etc/make.conf instead.
/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.

AUTHORS

Daniel Robbins <drobbins@gentoo.org>
Nicholas Jones <carpaski@gentoo.org>
Mike Frysinger <vapier@gentoo.org>

CVS HEADER

$Header: /var/cvsroot/gentoo-src/portage/man/make.conf.5,v 1.44 2004/10/03 17:56:19 genone Exp $