1 .TH "MAKE.CONF" "5" "Jun 2007" "Portage 2.1.3" "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. See the \fBCONFIGURATION FILES\fR section
89 of \fBemerge\fR(1) for more information.
91 \fBCONFIG_PROTECT_MASK\fR = \fI[space delimited list of files and/or directories]\fR
92 All files and/or directories that are defined here will have "config file protection"
93 disabled for them. See the \fBCONFIGURATION FILES\fR section
94 of \fBemerge\fR(1) for more information.
97 This variable is passed by the \fIebuild scripts\fR to the \fIconfigure\fR
98 as \fI\-\-target=${CTARGET}\fR only if it is defined.
100 \fBDISTDIR\fR = \fI[path]\fR
101 Defines the location of your local source file repository. Note
102 that locations under /usr/portage are not necessarily safe for data storage.
103 See the \fBPORTDIR\fR documentation for more information.
105 Defaults to /usr/portage/distfiles.
108 If this variable contains a directory then symlinks to html documentation will
109 be installed into it.
112 Defines whether or not to ignore audible beeps when displaying important
113 informational messages. This variable is unset by default.
115 .B EMERGE_DEFAULT_OPTS
116 Options to append to the end of the \fBemerge\fR(1) command line on every invocation.
117 These options will not be appended to the command line if \-\-ignore\-default\-opts
121 Defines whether or not to ignore short pauses that occur when displaying
122 important informational messages. This variable is unset by default.
123 If it is set to any value pauses are ignored.
125 \fBEXTRA_ECONF\fR = \fI[configure options string]\fR
126 Contains additional options that \fBeconf\fR will append to configure
127 script arguments (see \fBebuild\fR(5)).
129 \fBFEATURES\fR = \fI"sandbox ccache"\fR
130 Defines actions portage takes by default. These options should
131 not be changed by anyone but developers and/or maintainers. 'sandbox' is an important
132 part of \fBFEATURES\fR and should not be disabled by default. This is
133 an incremental variable.
137 When commiting work to cvs with \fBrepoman\fR(1), assume that all existing
138 SRC_URI digests are correct. This feature also affects digest generation via
139 \fBebuild\fR(1) and \fBemerge\fR(1) (emerge generates digests only when the
140 \fIdigest\fR feature is enabled). Existing digests for files that do not exist
141 in ${DISTDIR} will be automatically assumed even when \fIassume\-digests\fR is
142 not enabled. If a file exists in ${DISTDIR} but it's size does not match the
143 existing digest, the digest will be regenerated regardless of whether or
144 not \fIassume\-digests\fR is enabled. The \fBebuild\fR(1) \fBdigest\fR command
145 has a \fB\-\-force\fR option that can be used to force regeneration of digests.
148 Binary packages will be created for all packages that are merged. Also see
149 \fBquickpkg\fR(1) and \fBemerge\fR(1) \fB\-\-buildpkg\fR and
150 \fB\-\-buildpkgonly\fR options.
153 Build binary packages for just packages in the system set.
156 Enable portage support for the ccache package. If the ccache dir is not
157 present in the user's environment, then portage will default to
158 ${PORTAGE_TMPDIR}/ccache.
160 .B collision\-protect
161 A QA\-feature to ensure that a package doesn't overwrite files it doesn't own.
162 The \fICOLLISION_IGNORE\fR variable can be used to selectively disable this
166 Autogenerate digests for packages when running the \fBemerge\fR(1) command. If
167 the \fIassume\-digests\fR feature is also enabled then existing SRC_URI digests
168 will be reused whenever they are available.
171 Enable portage support for the distcc package.
174 Portage uses lockfiles to ensure competing instances don't clobber
175 each other's files. This feature is enabled by default but may cause
176 heartache on less intelligent remote filesystems like NFSv2 and some
177 strangely configured Samba server (oplocks off, NFS re\-export). A tool
178 /usr/lib/portage/bin/clean_locks exists to help handle lock issues
179 when a problem arises (normally due to a crash or disconnect).
182 Enable fakeroot for the install and package phases when a non-root user runs
183 the \fBebuild\fR(1) command.
186 Runs the script that will fix the dependencies in all binary packages. This is
187 run whenever packages are moved around in the portage tree. Please note that this
188 can take a lot of time.
191 Force emerges to always try to fetch files from the \fIPORTAGE_BINHOST\fR. See
192 \fBmake.conf\fR(5) for more information.
195 Check the signatures of Manifests and make sure they are correct.
198 Install source code into /usr/src/debug/${CATEGORY}/${PF} (also see
199 \fBsplitdebug\fR). This feature works only if debugedit is installed and CFLAGS
200 is set to include debug information (such as with the \-ggdb flag).
203 Do not delete the ${T} directory after the merge process.
206 Do not delete the ${WORKDIR} directory after the merge process. ${WORKDIR} can
207 then be reused since this feature disables most of the clean phase that runs
208 prior to each build. Due to lack of proper cleanup, this feature can
209 interfere with normal emerge operation and therefore it should not be left
210 enabled for more than a short period of time.
213 When \fImirror\fR is enabled in \fBFEATURES\fR, fetch files even
214 when \fImirror\fR is also in the \fBebuild\fR(5) \fBRESTRICT\fR variable.
216 .B metadata\-transfer
217 Automatically perform a metadata transfer when `emerge \-\-sync` is run.
220 Fetch everything in \fBSRC_URI\fR regardless of \fBUSE\fR settings,
221 except do not fetch anything when \fImirror\fR is in \fBRESTRICT\fR.
224 When utilizing \fBebuild\fR(1), only run the function requested.
227 Do not delete the the source and temporary files after the merge process.
230 Do not install doc files (/usr/share/doc).
233 Do not install info pages.
236 Do not install manpages.
239 Prevents the stripping of binaries that are merged to the live filesystem.
242 Disables xterm titlebar updates (which contains status info).
245 Fetch in the background while compiling.
248 Enable sandbox\-ing when running \fBemerge\fR(1) and \fBebuild\fR(1).
251 Enable SELinux sandbox\-ing. Do not toggle this \fBFEATURE\fR yourself.
254 When checking Manifests, only accept ones that have been signed by a
258 Stands for Smart Filesystem Permissions. Before merging packages to the
259 live filesystem, automatically search for and set permissions on setuid
260 and setgid files. Files that are setuid have the group and other read
261 bits removed while files that are setgid have the other read bit removed.
262 See also \fIsuidctl\fR below.
265 When commiting work to cvs with \fBrepoman\fR(1), sign the Manifest with
266 a GPG key. Read about the \fIPORTAGE_GPG_KEY\fR variable in \fBmake.conf\fR(5).
269 Prior to stripping ELF etdyn and etexec files, the debugging info is
270 stored for later use by various debuggers. This feature is disabled by
271 \fBnostrip\fR. For installation of source code, see \fBinstallsources\fR.
274 Have portage react strongly to conditions that have the potential to be
275 dangerous (like missing or incorrect digests for ebuilds).
278 Have portage react strongly to conditions that may conflict with system
279 security provisions (for example textrels, executable stack). Read about
280 the \fIQA_STRICT_*\fR variables in \fBmake.conf\fR(5).
283 Before merging packages to the live filesystem, automatically strip setuid
284 bits from any file that is not listed in \fI/etc/portage/suidctl.conf\fR.
287 Run package\-specific tests during each merge to help make sure
288 the package compiled properly. See \fItest\fR in \fBebuild\fR(1)
289 and \fIsrc_test()\fR in \fBebuild\fR(5). This feature implies the "test"
293 If a file is not claimed by another package in the same slot and it is not
294 protected by \fICONFIG_PROTECT\fR, unmerge it even if the modification time or
295 checksum differs from the file that was originally installed.
298 When portage is run as root, drop privileges to portage:portage during the
299 fetching of package sources.
302 Allow portage to drop root privileges and compile packages as
303 portage:portage without a sandbox (unless \fIusersandbox\fR is also used).
306 Enable the sandbox in the compile phase, when running without root privs (\fIuserpriv\fR).
309 Enable GPG verification when using \fIemerge\-webrsync\fR.
313 This variable contains the command used for fetching package sources from
314 the internet. It must contain the full path to the executable as well as the
315 place\-holders \\${DISTDIR}, \\${FILE} and \\${URI}. The command should be
316 written to place the fetched file at \\${DISTDIR}/\\${FILE}.
317 Also see \fBRESUMECOMMAND\fR.
319 \fBGENTOO_MIRRORS\fR = \fI[URLs]\fR
320 Insert your space\-seperated list of local mirrors here. These
321 locations are used to download files before the ones listed in
322 the \fIebuild scripts\fR. Merging 'mirrorselect' can help. Entries in this
323 variable that have no protocol and simply start with a '/' path separator may
324 be used to specify mounted filesystem mirrors.
326 \fBhttp_proxy ftp_proxy\fR = \fI[host:port]\fR
327 These vars are used if the sources must be downloaded from the
328 internet by \fBwget\fR(1). They are only required if you use a
329 proxy server for internet access.
331 \fBINSTALL_MASK\fR = \fI[space delimited list of file names]\fR
332 Use this variable if you want to selectively prevent certain files from being
333 copied into your file system tree. This does not work on symlinks, but only on
334 actual files. Useful if you wish to filter out files like HACKING.gz and
335 TODO.gz. The \fBINSTALL_MASK\fR is processed just before a package is merged.
336 Also supported is a \fBPKG_INSTALL_MASK\fR variable that behaves exactly like
337 \fBINSTALL_MASK\fR except that it is processed just before creation of a binary
341 Use this variable if you want to use parallel make. For example, if you
342 have a dual\-processor system, set this variable to "\-j2" or "\-j3" for
343 enhanced build performance with many packages. Suggested settings are
344 between \fICPUs+1\fR and \fI2*CPUs+1\fR.
345 For more information, see \fBmake\fR(1).
347 \fBNOCOLOR\fR = \fI["true" | "false"]\fR
348 Defines if color should be disabled by default.
352 \fBPKGDIR\fR = \fI[path]\fR
353 Defines the location where created .tbz2 binary packages will be stored. Note
354 that locations under /usr/portage are not necessarily safe for data storage.
355 See the \fBPORTDIR\fR documentation for more information.
357 Defaults to /usr/portage/packages.
360 This variable defines the directory in which per\-ebuild logs are kept.
361 Logs are created only when this is set. They are stored as
362 ${CATEGORY}:${PF}:YYYYMMDD\-HHMMSS.log in the directory specified. If the
363 direcory does not exist, it will be created automatically and group permissions
364 will be applied to it. If the directory already exists, portage will not
365 modify it's permissions.
367 \fBPORTAGE_BINHOST\fR = \fI"ftp://login:pass@grp.mirror.site/pub/grp/i686/athlon\-xp/"\fR
368 This is the host from which portage will grab prebuilt\-binary packages.
369 The list is a single entry specifying the full address of the directory
370 serving the tbz2's for your system. This is only used when running with
371 the get binary pkg options are given to \fBemerge\fR. Review \fBemerge\fR(1)
372 for more information. For versions of portage less that 2.2, this variable
373 should point to the 'All' directory on the host that creates the binary
374 packages and not to the root of the \fBPKGDIR\fR. Starting with portage 2.2,
375 it should point to a directory containing a 'Packages' index file. If
376 ${PORTAGE_BINHOST}/Packages does not exist then portage will attempt to use
379 \fBPORTAGE_BINHOST_HEADER_URI\fR = \fI"ftp://login:pass@grp.mirror.site/pub/grp/i686/athlon\-xp/"\fR
380 This variable only makes sense on a system that will serve as a binhost and
381 build packages for clients. It defines the URI header field for the package
382 index file which is located at ${PKGDIR}/Packages. Clients that have
383 \fBPORTAGE_BINHOST\fR properly configured will be able to fetch the index and
384 use the URI header field as a base URI for fetching binary packages. If the URI
385 header field is not defined then the client will use it's ${PORTAGE_BINHOST}
386 setting as the base URI.
388 .B PORTAGE_BINPKG_TAR_OPTS
389 This variable contains options to be passed to the tar command for creation
392 \fBPORTAGE_COMPRESS\fR = \fI"bzip2"\fR
393 This variable contains the command used to compress documentation during the
396 \fBPORTAGE_COMPRESS_FLAGS\fR = \fI"\-9"\fR
397 This variable contains flags for the \fBPORTAGE_COMPRESS\fR command.
399 .B PORTAGE_ELOG_CLASSES
401 .B PORTAGE_ELOG_SYSTEM
403 .B PORTAGE_ELOG_COMMAND
405 .B PORTAGE_ELOG_MAILURI
407 .B PORTAGE_ELOG_MAILFROM
409 .B PORTAGE_ELOG_MAILSUBJECT
410 Please see /etc/make.conf.example for elog documentation.
412 \fBPORTAGE_FETCH_CHECKSUM_TRY_MIRRORS\fR = \fI5\fR
413 Number of mirrors to try when a downloaded file has an incorrect checksum.
415 \fBPORTAGE_NICENESS\fR = \fI[number]\fR
416 The value of this variable will be added to the current nice level that
417 emerge is running at. In other words, this will not set the nice level,
418 it will increment it. For more information about nice levels and what
419 are acceptable ranges, see \fBnice\fR(1).
421 \fBPORTAGE_RSYNC_INITIAL_TIMEOUT\fR = \fIinteger\fR
422 Used by \fBemerge \-\-sync\fR as a timeout for the initial connection to an
425 Defaults to 15 seconds.
427 \fBPORTAGE_RSYNC_EXTRA_OPTS\fR = \fI[rsync options string]\fR
428 Additional rsync options to be used by \fBemerge \-\-sync\fR.
430 Defaults to no value.
432 \fBPORTAGE_RSYNC_OPTS\fR = \fI[rsync options string]\fR
433 Default rsync options to be used by \fBemerge \-\-sync\fR.
435 \fBDon't change this unless you know exactly what you're doing!\fR
437 Defaults to "\-\-recursive \-\-links \-\-safe\-links \-\-perms \-\-times
438 \-\-compress \-\-force \-\-whole\-file \-\-delete \-\-delete\-after \-\-stats
439 \-\-timeout=180 \-\-exclude='/distfiles' \-\-exclude='/local'
440 \-\-exclude='/packages'"
442 \fBPORTAGE_RSYNC_RETRIES\fR = \fI[NUMBER]\fR
443 The number of times rsync should retry on failed connections before
448 \fBPORTAGE_TMPDIR\fR = \fI[path]\fR
449 Defines the location of the temporary build directories.
451 Defaults to /var/tmp.
453 \fBPORTAGE_WORKDIR_MODE\fR = \fI"0700"\fR
454 This variable controls permissions for \fIWORKDIR\fR (see \fBebuild\fR(5)).
456 \fBPORTDIR\fR = \fI[path]\fR
457 Defines the location of the Portage tree. This is the repository for all
458 profile information as well as all ebuilds. If you change this, you must update
459 your /etc/make.profile symlink accordingly.
461 Defaults to /usr/portage.
465 Data stored inside \fBPORTDIR\fR is in peril of being overwritten or deleted by
466 the emerge \-\-sync command. The default value of
467 \fBPORTAGE_RSYNC_OPTS\fR will protect the default locations of
468 \fBDISTDIR\fR and \fBPKGDIR\fR, but users are warned that any other locations
469 inside \fBPORTDIR\fR are not necessarily safe for data storage. You should not
470 put other data (such as overlays) in your \fBPORTDIR\fB. Portage will walk
471 directory structures and may arbitrary add invalid categories as packages.
473 \fBPORTDIR_OVERLAY\fR = \fI"[path] [different\-path] [etc...]"\fR
474 Defines the directories in which user made ebuilds may be stored and not
475 overwriten when `emerge \-\-sync` is run. This is a space delimited list of
478 Defaults to no value.
480 \fBQA_STRICT_EXECSTACK = \fI"set"\fR
481 Set this to cause portage to ignore any \fIQA_EXECSTACK\fR override
482 settings from ebuilds. See also \fBebuild\fR(5).
484 \fBQA_STRICT_WX_LOAD = \fI"set"\fR
485 Set this to cause portage to ignore any \fIQA_WX_LOAD\fR override
486 settings from ebuilds. See also \fBebuild\fR(5).
488 \fBQA_STRICT_TEXTRELS = \fI"set"\fR
489 Set this to cause portage to ignore any \fIQA_TEXTREL\fR override
490 settings from ebuilds. See also \fBebuild\fR(5).
493 This variable contains the command used for resuming package sources that
494 have been partially downloaded. It should be defined using the same format
495 as \fBFETCHCOMMAND\fR, and must include any additional option(s) that may
496 be necessary in order to continue a partially downloaded file located at
497 \\${DISTDIR}/\\${FILE}.
499 \fBROOT\fR = \fI[path]\fR
500 Use \fBROOT\fR to specify the target root filesystem to be used for merging
501 packages or ebuilds. All \fBRDEPEND\fR and \fBPDEPEND\fR will be installed
502 into \fBROOT\fR while all \fBDEPEND\fR will be still be installed into /.
503 Typically, you should set this setting in the environment rather than in
504 \fI/etc/make.conf\fR itself. It's commonly used for creating new build
505 images. Make sure you use an absolute path.
509 \fBRPMDIR\fR = \fI[path]\fR
510 Defines the location where created RPM packages will be stored.
512 Defaults to ${PORTDIR}/rpm.
514 \fBSYNC\fR = \fI[RSYNC]\fR
515 Insert your preferred rsync mirror here. This rsync server
516 is used to sync the local portage tree when `emerge \-\-sync` is run.
518 Defaults to rsync://rsync.gentoo.org/gentoo\-portage
520 \fBUSE\fR = \fI[space delimited list of USE items]\fR
521 This variable contains options that control the build behavior of several
522 packages. More information in \fBebuild\fR(5). Possible USE values
523 can be found in \fI/usr/portage/profiles/use.desc\fR.
525 \fBUSE_EXPAND\fR = \fI[space delimited list of variable names]\fR
526 Any variable listed here will be used to augment USE by inserting a new flag
527 for every value in that variable, so USE_EXPAND="FOO" and FOO="bar bla" results
528 in USE="foo_bar foo_bla".
530 \fBUSE_EXPAND_HIDDEN\fR = \fI[space delimited list of variable names]\fR
531 Names of \fBUSE_EXPAND\fR variables that should not be shown in the verbose merge
532 list output of the \fBemerge\fR(1) command.
534 \fBUSE_ORDER\fR = \fI"env:pkg:conf:defaults:pkginternal:env.d"\fR
535 Determines the precedence of layers in the incremental stacking of the USE
536 variable. Precedence decreases from left to right such that env overrides
537 pkg, pkg overrides conf, and so forth.
541 Do not modify this value unless you're a developer and you know what
542 you're doing. If you change this and something breaks, we will not help
548 USE from the current environment variables (USE and those listed in USE_EXPAND)
551 Per\-package USE from \fB/etc/portage/package.use\fR (see \fBportage\fR(5))
557 USE from make.defaults and package.use in the profile (see \fBportage\fR(5))
560 USE from \fBebuild\fR(5) IUSE defaults
563 USE from the environment variables defined by files in \fI/etc/env.d/\fR
567 Please report bugs via http://bugs.gentoo.org/
570 Daniel Robbins <drobbins@gentoo.org>
571 Nicholas Jones <carpaski@gentoo.org>
572 Mike Frysinger <vapier@gentoo.org>
573 Saleem Abdulrasool <compnerd@gentoo.org>
578 Contains variables for the build\-process and overwrites those in make.defaults.
581 Contains the default variables for the build\-process, you should edit \fI/etc/make.conf\fR instead.
583 .B /etc/portage/color.map
584 Contains variables customizing colors.
586 .B /usr/portage/profiles/use.desc
587 Contains a list of all global USE flags.
589 .B /usr/portage/profiles/use.local.desc
590 Contains a list of all local USE variables.
597 The \fI/usr/sbin/ebuild.sh\fR script.
599 The helper apps in \fI/usr/lib/portage/bin\fR.
projects / portage.git / blob