1 .TH "MAKE.CONF" "5" "Jan 2007" "Portage 2.1.2" "Portage"
3 make.conf \- custom settings for Portage
7 This file contains various variables that are used by Portage.
8 Portage will check the currently\-defined environment variables
9 first for any settings. If no environment settings are found,
10 Portage then checks /etc/make.conf. If no setting is found
11 in /etc/make.conf, Portage checks /etc/make.globals. If no
12 setting is found there, the profile's default setting is grabbed
13 from /etc/make.profile/make.defaults. Please note that all user
14 settings should be made in the environment or in /etc/make.conf,
15 which is intended to be customized by the user.
17 Exceptions are incremental variables such as USE, CONFIG_PROTECT*,
18 and ACCEPT_KEYWORDS. Incremental variables are propagated down from
19 make.defaults to make.globals to make.conf to the environment
20 settings. Clearing these variables requires a clear\-all as in:
24 \fBACCEPT_KEYWORDS\fR = \fI[space delimited list of KEYWORDS]\fR
25 Enable testing of ebuilds that have not yet been deemed 'stable'. Users
26 of the 'x86' architecture would set this to '~x86' while ppc users would
27 set this to '~ppc'. This is an incremental variable. Only define a
30 Defaults to the value of $ARCH.
32 \fBBUILD_PREFIX\fR = \fI[path]\fR
33 Defines the location of the package working directory.
35 Defaults to ${PORTAGE_TMPDIR}/portage
38 This variable is passed by the \fIebuild scripts\fR to the \fIconfigure\fR
39 as \fI\-\-build=${CBUILD}\fR only if it is defined. Do not set this yourself
40 unless you know what you are doing.
42 \fBCCACHE_DIR\fR = \fI[path]\fR
43 Defines the location of the ccache working directory. See the \fBccache\fR(1)
44 man page for more information.
46 Defaults to /var/tmp/ccache
48 \fBCCACHE_SIZE\fR = \fI"size"\fR
49 This controls the space use limitations for ccache. The default is 2 gigabytes
50 ('2G'). Sizes are specified with 'G', 'M', or 'K'.
53 Use these variables to set the desired optimization/CPU instruction settings
54 for applications that you compile. Nearly all ebuild files will take advantage
55 of your custom settings, resulting in a Gentoo Linux that is fully customized
56 to your specifications. Please use sane settings as some packages will fail to
57 compile/run if the optimizations are too extreme.
59 For more information, see the \fIInvoking GCC\fR section of the gcc manual:
61 http://gcc.gnu.org/onlinedocs/
64 This variable is passed by the \fIebuild scripts\fR to the \fIconfigure\fR
65 step as \fI\-\-host=${CHOST}\fR. This way you can force the build\-host.
69 http://gcc.gnu.org/onlinedocs/gcc\-4.1.1/gcc/Submodel\-Options.html
71 http://gcc.gnu.org/onlinedocs/gcc\-3.3/gcc/Submodel\-Options.html
73 http://gcc.gnu.org/onlinedocs/gcc\-3.2/gcc/Submodel\-Options.html
75 http://gcc.gnu.org/onlinedocs/gcc\-2.95.3/gcc_2.html
77 \fBCLEAN_DELAY\fR = \fIinteger\fR
78 Determines how long the countdown delay will be after running `emerge clean`.
80 Defaults to 5 seconds.
82 \fBCOLLISION_IGNORE\fR = \fI[space delimited list of files and/or directories]\fR
83 This variable allows the user to disable \fIcollision\-protect\fR for specific
84 files and/or directories.
86 \fBCONFIG_PROTECT\fR = \fI[space delimited list of files and/or directories]\fR
87 All files and/or directories that are defined here will have "config file protection"
88 enabled for them. For more information, please see `emerge \-\-help config`.
90 \fBCONFIG_PROTECT_MASK\fR = \fI[space delimited list of files and/or directories]\fR
91 All files and/or directories that are defined here will have "config file protection"
92 disabled for them. For more information, please see `emerge \-\-help config`.
95 This variable is passed by the \fIebuild scripts\fR to the \fIconfigure\fR
96 as \fI\-\-target=${CTARGET}\fR only if it is defined.
98 \fBDISTDIR\fR = \fI[path]\fR
99 Defines the location of your local source file repository.
101 Defaults to /usr/portage/distfiles.
104 If this variable contains a directory then symlinks to html documentation will
105 be installed into it.
108 Defines whether or not to ignore audible beeps when displaying important
109 informational messages. This variable is unset by default.
111 .B EMERGE_DEFAULT_OPTS
112 Options to append to the end of the \fBemerge\fR(1) command line on every invocation.
113 These options will not be appended to the command line if \-\-ignore\-default\-opts
117 Defines whether or not to ignore short pauses that occur when displaying
118 important informational messages. This variable is unset by default.
119 If it is set to any value pauses are ignored.
121 \fBEXTRA_ECONF\fR = \fI[configure options string]\fR
122 Contains additional options that \fBeconf\fR will append to configure
123 script arguments (see \fBebuild\fR(5)).
125 \fBFEATURES\fR = \fI"sandbox ccache"\fR
126 Defines actions portage takes by default. These options should
127 not be changed by anyone but developers and/or maintainers. 'sandbox' is an important
128 part of \fBFEATURES\fR and should not be disabled by default. This is
129 an incremental variable.
133 When commiting work to cvs with \fBrepoman\fR(1), assume that all existing
134 SRC_URI digests are correct. This feature also affects digest generation via
135 \fBebuild\fR(1) and \fBemerge\fR(1) (emerge generates digests only when the
136 \fIdigest\fR feature is enabled).
139 Binary packages will be created for all packages that are merged.
142 Build binary packages for just packages in the system set.
145 Enable portage support for the ccache package. If the ccache dir is not
146 present in the user's environment, then portage will default to
147 ${PORTAGE_TMPDIR}/ccache.
149 .B collision\-protect
150 A QA\-feature to ensure that a package doesn't overwrite files it doesn't own.
151 The \fICOLLISION_IGNORE\fR variable can be used to selectively disable this
155 Autogenerate digests for packages when running the \fBemerge\fR(1) command. If
156 the \fIassume\-digests\fR feature is also enabled then existing SRC_URI digests
157 will be reused whenever they are available.
160 Enable portage support for the distcc package.
163 Portage uses lockfiles to ensure competing instances don't clobber
164 each other's files. This feature is enabled by default but may cause
165 heartache on less intelligent remote filesystems like NFSv2 and some
166 strangely configured Samba server (oplocks off, NFS re\-export). A tool
167 /usr/lib/portage/bin/clean_locks exists to help handle lock issues
168 when a problem arises (normally due to a crash or disconnect).
171 Runs the script that will fix the dependencies in all binary packages. This is
172 run whenever packages are moved around in the portage tree. Please note that this
173 can take a lot of time.
176 Force emerges to always try to fetch files from the \fIPORTAGE_BINHOST\fR. See
177 \fBmake.conf\fR(5) for more information.
180 Check the signatures of Manifests and make sure they are correct.
183 Install source code into /usr/src/debug/${CATEGORY}/${PF} (also see
184 \fBsplitdebug\fR). This feature works only if debugedit is installed and CFLAGS
185 is set to include debug information (such as with the \-ggdb flag).
188 Do not delete the ${T} directory after the merge process.
191 Do not delete the ${WORKDIR} directory after the merge process. ${WORKDIR} can
192 then be reused since this feature disables most of the clean phase that runs
193 prior to each build. Due to lack of proper cleanup, this feature can
194 interfere with normal emerge operation and therefore it should not be left
195 enabled for more than a short period of time.
197 .B metadata\-transfer
198 Automatically perform a metadata transfer when `emerge \-\-sync` is run.
201 This will cause \fBFETCHCOMMAND\fR to always be run even if
202 the file already exists in \fBDISTDIR\fR.
205 When utilizing \fBebuild\fR(1), only run the function requested.
208 Do not delete the the source and temporary files after the merge process.
211 Do not install doc files (/usr/share/doc).
214 Do not install info pages.
217 Do not install manpages.
220 Prevents the stripping of binaries that are merged to the live filesystem.
223 Disables xterm titlebar updates (which contains status info).
226 Fetch in the background while compiling.
229 Enable sandbox\-ing when running \fBemerge\fR(1) and \fBebuild\fR(1).
232 Enable SELinux sandbox\-ing. Do not toggle this \fBFEATURE\fR yourself.
235 When checking Manifests, only accept ones that have been signed by a
239 Stands for Smart Filesystem Permissions. Before merging packages to the
240 live filesystem, automatically search for and set permissions on setuid
241 and setgid files. Files that are setuid have the group and other read
242 bits removed while files that are setgid have the other read bit removed.
243 See also \fIsuidctl\fR below.
246 When commiting work to cvs with \fBrepoman\fR(1), sign the Manifest with
247 a GPG key. Read about the \fIPORTAGE_GPG_KEY\fR variable in \fBmake.conf\fR(5).
250 Prior to stripping ELF etdyn and etexec files, the debugging info is
251 stored for later use by various debuggers. This feature is disabled by
252 \fBnostrip\fR. For installation of source code, see \fBinstallsources\fR.
255 Have portage react strongly to conditions that have the potential to be
256 dangerous (like missing or incorrect digests for ebuilds or distfiles).
259 Have portage react strongly to conditions that may conflict with system
260 security provisions (for example textrels, executable stack). Read about
261 the \fIQA_STRICT_*\fR variables in \fBmake.conf\fR(5).
264 Before merging packages to the live filesystem, automatically strip setuid
265 bits from any file that is not listed in \fI/etc/portage/suidctl.conf\fR.
268 Run package\-specific tests during each merge to help make sure
269 the package compiled properly. See \fItest\fR in \fBebuild\fR(1)
270 and \fIsrc_test()\fR in \fBebuild\fR(5). This feature implies the "test"
274 If a file is not claimed by another package in the same slot and it is not
275 protected by \fICONFIG_PROTECT\fR, unmerge it even if the modification time or
276 checksum differs from the file that was originally installed.
279 When portage is run as root, drop privileges to portage:portage during the
280 fetching of package sources.
283 Allow portage to drop root privileges and compile packages as
284 portage:portage without a sandbox (unless \fIusersandbox\fR is also used).
287 Enable the sandbox in the compile phase, when running without root privs (\fIuserpriv\fR).
291 This variable contains the command used for fetching package sources from
292 the internet. It must contain the full path to the executable as well as the
293 place\-holders \\${DISTDIR}, \\${FILE} and \\${URI}. The command should be
294 written to place the fetched file at \\${DISTDIR}/\\${FILE}.
295 Also see \fBRESUMECOMMAND\fR.
297 \fBGENTOO_MIRRORS\fR = \fI[URLs]\fR
298 Insert your space\-seperated list of local mirrors here. These
299 locations are used to download files before the ones listed in
300 the \fIebuild scripts\fR. Merging 'mirrorselect' can help. Entries in this
301 variable that have no protocol and simply start with a '/' path separator may
302 be used to specify mounted filesystem mirrors.
304 \fBhttp_proxy ftp_proxy\fR = \fI[host:port]\fR
305 These vars are used if the sources must be downloaded from the
306 internet by \fBwget\fR(1). They are only required if you use a
307 proxy server for internet access.
309 \fBINSTALL_MASK\fR = \fI[space delimited list of file names]\fR
310 Use this variable if you want to selectively prevent certain files from being
311 copied into your file system tree. This does not work on symlinks, but only on
312 actual files. Useful if you wish to filter out files like HACKING.gz and
316 Use this variable if you want to use parallel make. For example, if you
317 have a dual\-processor system, set this variable to "\-j2" or "\-j3" for
318 enhanced build performance with many packages. Suggested settings are
319 between \fICPUs+1\fR and \fI2*CPUs+1\fR.
320 For more information, see \fBmake\fR(1).
322 \fBNOCOLOR\fR = \fI["true" | "false"]\fR
323 Defines if color should be disabled by default.
327 \fBPKGDIR\fR = \fI[path]\fR
328 Defines the location where created .tbz2 binary packages will be stored.
330 Defaults to /usr/portage/packages.
333 This variable defines the directory in which per\-ebuild logs are kept.
334 Logs are created only when this is set. They are stored as
335 ${CATEGORY}:${PF}:YYYYMMDD\-HHMMSS.log in the directory specified. If the
336 direcory does not exist, it will be created automatically and group permissions
337 will be applied to it. If the directory already exists, portage will not
338 modify it's permissions.
340 \fBPORTAGE_BINHOST\fR = \fI"ftp://login:pass@grp.mirror.site/pub/grp/i686/athlon\-xp/"\fR
341 This is the host from which portage will grab prebuilt\-binary packages.
342 The list is a single entry specifying the full address of the directory
343 serving the tbz2's for your system. This is only used when running with
344 the get binary pkg options are given to \fBemerge\fR. Review \fBemerge\fR(1)
345 for more information. For versions of portage less that 2.2, this variable
346 should point to the 'All' directory on the host that creates the binary
347 packages and not to the root of the \fBPKGDIR\fR. Starting with portage 2.2,
348 it should point to a directory containing a 'Packages' index file. If
349 ${PORTAGE_BINHOST}/Packages does not exist then portage will attempt to use
352 \fBPORTAGE_BINHOST_HEADER_URI\fR = \fI"ftp://login:pass@grp.mirror.site/pub/grp/i686/athlon\-xp/"\fR
353 This variable only makes sense on a system that will serve as a binhost and
354 build packages for clients. It defines the URI header field for the package
355 index file which is located at ${PKGDIR}/Packages. Clients that have
356 \fBPORTAGE_BINHOST\fR properly configured will be able to fetch the index and
357 use the URI header field as a base URI for fetching binary packages. If the URI
358 header field is not defined then the client will use it's ${PORTAGE_BINHOST}
359 setting as the base URI.
361 \fBPORTAGE_COMPRESS\fR = \fI"bzip2"\fR
362 This variable contains the command used to compress documentation during the
365 \fBPORTAGE_COMPRESS_FLAGS\fR = \fI"\-9"\fR
366 This variable contains flags for the \fBPORTAGE_COMPRESS\fR command.
368 .B PORTAGE_ELOG_CLASSES
370 .B PORTAGE_ELOG_SYSTEM
372 .B PORTAGE_ELOG_COMMAND
374 .B PORTAGE_ELOG_MAILURI
376 .B PORTAGE_ELOG_MAILFROM
378 .B PORTAGE_ELOG_MAILSUBJECT
379 Please see /etc/make.conf.example for elog documentation.
381 \fBPORTAGE_NICENESS\fR = \fI[number]\fR
382 The value of this variable will be added to the current nice level that
383 emerge is running at. In other words, this will not set the nice level,
384 it will increment it. For more information about nice levels and what
385 are acceptable ranges, see \fBnice\fR(1).
387 \fBPORTAGE_RSYNC_INITIAL_TIMEOUT\fR = \fIinteger\fR
388 Used by \fBemerge \-\-sync\fR as a timeout for the initial connection to an
391 Defaults to 15 seconds.
393 \fBPORTAGE_RSYNC_EXTRA_OPTS\fR = \fI[rsync options string]\fR
394 Additional rsync options to be used by \fBemerge \-\-sync\fR.
396 Defaults to no value.
398 \fBPORTAGE_RSYNC_OPTS\fR = \fI[rsync options string]\fR
399 Default rsync options to be used by \fBemerge \-\-sync\fR.
401 \fBDon't change this unless you know exactly what you're doing!\fR
403 Defaults to "\-\-recursive \-\-links \-\-safe\-links \-\-perms \-\-times
404 \-\-compress \-\-force \-\-whole\-file \-\-delete \-\-delete\-after \-\-stats
405 \-\-timeout=180 \-\-exclude='/distfiles' \-\-exclude='/local'
406 \-\-exclude='/packages'"
408 \fBPORTAGE_RSYNC_RETRIES\fR = \fI[NUMBER]\fR
409 The number of times rsync should retry on failed connections before
414 \fBPORTAGE_TMPDIR\fR = \fI[path]\fR
415 Defines the location of the temporary build directories.
417 Defaults to /var/tmp.
419 \fBPORTAGE_WORKDIR_MODE\fR = \fI"0700"\fR
420 This variable controls permissions for \fIWORKDIR\fR (see \fBebuild\fR(5)).
422 \fBPORTDIR\fR = \fI[path]\fR
423 Defines the location of your Portage tree.
425 Defaults to /usr/portage.
429 Storing data such as distfiles and binary packages in PORTDIR can
430 be potentially dangerous. The default emerge configuration defaults to this
431 behavior (which will work fine), however if you deviate from the default
432 configuration by changing PKGDIR or DISTDIR, emerge \-\-sync may inadvertedly
433 delete all your distfiles/binary packages. Please make sure to set
434 \fBPORTAGE_EXTRA_RSYNC_OPTS\fR properly to insure the safety of files in PORTDIR.
436 \fBPORTDIR_OVERLAY\fR = \fI"[path] [different\-path] [etc...]"\fR
437 Defines the directories in which user made ebuilds may be stored and not
438 overwriten when `emerge \-\-sync` is run. This is a space delimited list of
441 Defaults to no value.
443 \fBQA_STRICT_EXECSTACK = \fI"set"\fR
444 Set this to cause portage to ignore any \fIQA_EXECSTACK\fR override
445 settings from ebuilds. See also \fBebuild\fR(5).
447 \fBQA_STRICT_WX_LOAD = \fI"set"\fR
448 Set this to cause portage to ignore any \fIQA_WX_LOAD\fR override
449 settings from ebuilds. See also \fBebuild\fR(5).
451 \fBQA_STRICT_TEXTRELS = \fI"set"\fR
452 Set this to cause portage to ignore any \fIQA_TEXTREL\fR override
453 settings from ebuilds. See also \fBebuild\fR(5).
456 This variable contains the command used for resuming package sources that
457 have been partially downloaded. It should be defined using the same format
458 as \fBFETCHCOMMAND\fR, and must include any additional option(s) that may
459 be necessary in order to continue a partially downloaded file located at
460 \\${DISTDIR}/\\${FILE}.
462 \fBROOT\fR = \fI[path]\fR
463 Use \fBROOT\fR to specify the target root filesystem to be used for merging
464 packages or ebuilds. All \fBRDEPEND\fR and \fBPDEPEND\fR will be installed
465 into \fBROOT\fR while all \fBDEPEND\fR will be still be installed into /.
466 Typically, you should set this setting in the environment rather than in
467 \fI/etc/make.conf\fR itself. It's commonly used for creating new build
468 images. Make sure you use an absolute path.
472 \fBRPMDIR\fR = \fI[path]\fR
473 Defines the location where created RPM packages will be stored.
475 Defaults to ${PORTDIR}/rpm.
477 \fBSYNC\fR = \fI[RSYNC]\fR
478 Insert your preferred rsync mirror here. This rsync server
479 is used to sync the local portage tree when `emerge \-\-sync` is run.
481 Defaults to rsync://rsync.gentoo.org/gentoo\-portage
483 \fBUSE\fR = \fI[space delimited list of USE items]\fR
484 This variable contains options that control the build behavior of several
485 packages. More information in \fBebuild\fR(5). Possible USE values
486 can be found in \fI/usr/portage/profiles/use.desc\fR.
488 \fBUSE_EXPAND_HIDDEN\fR = \fI[space delimited list of variable names]\fR
489 Names of \fBUSE_EXPAND\fR variables that should not be shown in the verbose merge
490 list output of the \fBemerge\fR(1) command.
492 \fBUSE_ORDER\fR = \fI"env:pkg:conf:defaults:pkginternal"\fR
493 Determines the precedence of layers in the incremental stacking of the USE
494 variable. Precedence decreases from left to right such that env overrides
495 pkg, pkg overrides conf, and so forth.
499 Do not modify this value unless you're a developer and you know what
500 you're doing. If you change this and something breaks, we will not help
506 USE from the current USE environment variable if it exists
509 Per\-package USE from \fB/etc/portage/package.use\fR (see \fBportage\fR(5))
515 USE from make.defaults and package.use in the profile (see \fBportage\fR(5))
518 USE from ebuild IUSE defaults (flags enabled via a + prefix; see \fBebuild\fR(5))
522 Please report bugs via http://bugs.gentoo.org/
525 Daniel Robbins <drobbins@gentoo.org>
526 Nicholas Jones <carpaski@gentoo.org>
527 Mike Frysinger <vapier@gentoo.org>
528 Saleem Abdulrasool <compnerd@gentoo.org>
533 Contains variables for the build\-process and overwrites those in make.defaults.
535 \fB/etc/make.globals\fR
536 Contains the default variables for the build\-process, you should edit \fI/etc/make.conf\fR instead.
538 \fB/usr/portage/profiles/use.desc\fR
539 Contains a list of all global USE flags.
541 \fB/usr/portage/profiles/use.local.desc\fR
542 Contains a list of all local USE variables.
549 The \fI/usr/sbin/ebuild.sh\fR script.
551 The helper apps in \fI/usr/lib/portage/bin\fR.