1 .TH "MAKE.CONF" "5" "August 2011" "Portage VERSION" "Portage"
3 make.conf \- custom settings for Portage
5 \fB/etc/make.conf\fR and \fB/etc/portage/make.conf\fR
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 the make.conf files. Both /etc/make.conf and
11 /etc/portage/make.conf are checked (if present), and settings from
12 /etc/portage/make.conf will override settings from /etc/make.conf.
13 If no setting is found in the make.conf files, Portage checks
15 setting is found there, the profile's default setting is grabbed
16 from /etc/make.profile/make.defaults. Please note that all user
17 settings should be made in the environment or in the make.conf
18 files, which are intended to be customized by the user.
20 Exceptions are incremental variables such as USE, CONFIG_PROTECT*,
21 and ACCEPT_KEYWORDS. Incremental variables are propagated down from
22 make.defaults to make.globals to make.conf to the environment
23 settings. Clearing these variables requires a clear\-all as in:
26 In order to create per\-package environment settings, refer to
27 \fBpackage.env\fR in \fBportage\fR(5).
30 \fBACCEPT_CHOSTS\fR = \fI[space delimited list of CHOST values]\fR
31 Specifies acceptable \fBCHOST\fR values. Regular
32 expression syntax is supported, so it is necessary to escape
33 \fBCHOST\fR characters if they have special meaning in regular expressions.
35 Defaults to the value of $CHOST.
37 \fBACCEPT_KEYWORDS\fR = \fI[space delimited list of KEYWORDS]\fR
38 Enable testing of ebuilds that have not yet been deemed 'stable'. Users
39 of the 'x86' architecture would set this to '~x86' while ppc users would
40 set this to '~ppc'. This is an incremental variable. Only define a
43 Defaults to the value of $ARCH.
45 \fBACCEPT_LICENSE\fR = \fI[space delimited list of licenses or groups]\fR
46 This variable is used to mask packages based on licensing restrictions. It
47 may contain both license and group names, where group names are prefixed
48 with the '@' symbol. License groups are defined in the \fIlicense_groups\fR
49 file (see \fBportage\fR(5)). In addition to license and group names, the
50 \fI*\fR and \fI-*\fR wildcard tokens are also supported. Refer to GLEP 23
51 for further information:
52 \fIhttp://www.gentoo.org/proj/en/glep/glep-0023.html\fR.
54 Defaults to the value of * -@EULA.
60 # Accept any license except the "public-domain" license
61 ACCEPT_LICENSE="* -public-domain"
62 # Only accept licenses in the FSF-APPROVED license group
63 ACCEPT_LICENSE="-* @FSF-APPROVED"
66 \fBACCEPT_PROPERTIES\fR = \fI[space delimited list of properties]\fR
67 This variable is used to mask packages based on PROPERTIES restrictions.
68 In addition to property names, the \fI*\fR and \fI-*\fR wildcard tokens are
69 also supported. This variable can be temporarily overridden using the
70 \fB\-\-accept\-properties\fR option of \fBemerge\fR(1).
71 See \fBebuild\fR(5) for more information about PROPERTIES.
73 Defaults to the value of *.
77 # Accept any properties
79 # Accept any properties except the "interactive" property
80 ACCEPT_PROPERTIES="* -interactive"
84 This variable is passed by the \fIebuild scripts\fR to the \fIconfigure\fR
85 as \fI\-\-build=${CBUILD}\fR only if it is defined. Do not set this yourself
86 unless you know what you are doing.
88 \fBCCACHE_DIR\fR = \fI[path]\fR
89 Defines the location of the ccache working directory. See the \fBccache\fR(1)
90 man page for more information.
92 Defaults to /var/tmp/ccache
94 \fBCCACHE_SIZE\fR = \fI"size"\fR
95 This controls the space use limitations for ccache. The default is 2 gigabytes
96 ('2G'). Sizes are specified with 'G', 'M', or 'K'.
99 Use these variables to set the desired optimization/CPU instruction settings
100 for applications that you compile. These two variables are passed to the C
101 and C++ compilers, respectively. (CXX is used to refer to the C++ compiler
102 within many buildsystems.) Nearly all ebuild files will take advantage
103 of your custom settings, resulting in a Gentoo Linux that is fully customized
104 to your specifications. Please use sane settings as some packages will fail to
105 compile/run if the optimizations are too extreme.
107 For more information, see the \fIInvoking GCC\fR section of the gcc manual:
109 http://gcc.gnu.org/onlinedocs/
112 This variable is passed by the \fIebuild scripts\fR to the \fIconfigure\fR
113 step as \fI\-\-host=${CHOST}\fR. This way you can force the build\-host.
115 For more information:
117 http://gcc.gnu.org/onlinedocs/gcc\-4.1.1/gcc/Submodel\-Options.html
119 http://gcc.gnu.org/onlinedocs/gcc\-3.3/gcc/Submodel\-Options.html
121 http://gcc.gnu.org/onlinedocs/gcc\-3.2/gcc/Submodel\-Options.html
123 http://gcc.gnu.org/onlinedocs/gcc\-2.95.3/gcc_2.html
125 \fBCLEAN_DELAY\fR = \fIinteger\fR
126 Determines how long the countdown delay will be after running
129 Defaults to 5 seconds.
131 \fBCOLLISION_IGNORE\fR = \fI[space delimited list of files and/or directories]\fR
132 This variable allows the user to disable \fIcollision\-protect\fR and
133 \fIprotect\-owned\fR for specific files and/or directories.
135 Defaults to /lib/modules.
137 \fBCONFIG_PROTECT\fR = \fI[space delimited list of files and/or directories]\fR
138 All files and/or directories that are defined here will have "config file protection"
139 enabled for them. See the \fBCONFIGURATION FILES\fR section
140 of \fBemerge\fR(1) for more information.
142 \fBCONFIG_PROTECT_MASK\fR = \fI[space delimited list of files and/or directories]\fR
143 All files and/or directories that are defined here will have "config file protection"
144 disabled for them. See the \fBCONFIGURATION FILES\fR section
145 of \fBemerge\fR(1) for more information.
148 This variable is passed by the \fIebuild scripts\fR to the \fIconfigure\fR
149 as \fI\-\-target=${CTARGET}\fR only if it is defined.
151 \fBDISTDIR\fR = \fI[path]\fR
152 Defines the location of your local source file repository. After packages
153 are built, it is safe to remove any and all files from this directory since
154 they will be automatically fetched on demand for a given build. If you would
155 like to selectively prune obsolete files from this directory, see
156 \fBeclean\fR(1) from the gentoolkit package.
158 Use the \fBPORTAGE_RO_DISTDIRS\fR variable to specify one or
159 more read-only directories containing distfiles.
162 that locations under /usr/portage are not necessarily safe for data storage.
163 See the \fBPORTDIR\fR documentation for more information.
165 Defaults to /usr/portage/distfiles.
168 If this variable contains a directory then symlinks to html documentation will
169 be installed into it.
172 Defines whether or not to ignore audible beeps when displaying important
173 informational messages. This variable is unset by default.
175 .B EMERGE_DEFAULT_OPTS
176 Options to append to the end of the \fBemerge\fR(1) command line on every invocation.
177 These options will not be appended to the command line if \-\-ignore\-default\-opts
181 Controls the location of emerge.log and emerge-fetch.log.
183 Defaults to /var/log.
185 \fBEMERGE_WARNING_DELAY\fR = \fIinteger\fR
186 Determines how long the countdown delay will be after running
187 `emerge --unmerge` for a system package.
189 Defaults to 10 seconds.
192 Defines whether or not to ignore short pauses that occur when displaying
193 important informational messages. This variable is unset by default.
194 If it is set to any value pauses are ignored.
196 \fBEXTRA_ECONF\fR = \fI[configure options string]\fR
197 Contains additional options that \fBeconf\fR will append to configure
198 script arguments (see \fBebuild\fR(5)).
200 \fBFEATURES\fR = \fI"sandbox"\fR
201 Defines actions portage takes by default. This is an incremental variable.
202 Most of these settings are for developer use, but some are available to
203 non-developers as well. The \fBsandbox\fR feature is very important and
204 should not be disabled by default.
208 When commiting work to cvs with \fBrepoman\fR(1), assume that all existing
209 SRC_URI digests are correct. This feature also affects digest generation via
210 \fBebuild\fR(1) and \fBemerge\fR(1) (emerge generates digests only when the
211 \fIdigest\fR feature is enabled). Existing digests for files that do not exist
212 in ${DISTDIR} will be automatically assumed even when \fIassume\-digests\fR is
213 not enabled. If a file exists in ${DISTDIR} but it's size does not match the
214 existing digest, the digest will be regenerated regardless of whether or
215 not \fIassume\-digests\fR is enabled. The \fBebuild\fR(1) \fBdigest\fR command
216 has a \fB\-\-force\fR option that can be used to force regeneration of digests.
219 Keep logs from successful binary package merges. This is relevant only when
220 \fBPORT_LOGDIR\fR is set.
223 Binary packages will be created for all packages that are merged. Also see
224 \fBquickpkg\fR(1) and \fBemerge\fR(1) \fB\-\-buildpkg\fR and
225 \fB\-\-buildpkgonly\fR options.
228 Build binary packages for just packages in the system set.
231 Enable a special progress indicator when \fBemerge\fR(1) is calculating
235 Enable portage support for the ccache package. If the ccache dir is not
236 present in the user's environment, then portage will default to
237 ${PORTAGE_TMPDIR}/ccache.
239 \fBWarning\fR: This feature is known to cause numerous compilation failures.
240 Sometimes ccache will retain stale code objects or corrupted files, which can
241 lead to packages that cannot be emerged. If this happens (if you receive errors
242 like "File not recognized: File truncated"), try recompiling the application
243 with ccache disabled before reporting a bug. Unless you are doing development
244 work, do not enable ccache.
247 Enable automatic execution of the command specified by the
248 PORT_LOGDIR_CLEAN variable. The default PORT_LOGDIR_CLEAN setting will
249 remove all files from PORT_LOGDIR that were last modified at least 7
252 .B collision\-protect
253 A QA\-feature to ensure that a package doesn't overwrite files it doesn't own.
254 The \fICOLLISION_IGNORE\fR variable can be used to selectively disable this
255 feature. Also see the related \fIprotect\-owned\fR feature.
257 .B compress\-build\-logs
258 The causes all build logs to be compressed while they are being written.
259 Log file names have an extension that is appropriate for the compression
260 type. Currently, only \fBgzip\fR(1) compression is supported, so build
261 logs will have a '.gz' extension when this feature is enabled.
264 Autogenerate digests for packages when running the
265 \fBemerge\fR(1), \fBebuild\fR(1), or \fBrepoman\fR(1) commands. If
266 the \fIassume\-digests\fR feature is also enabled then existing SRC_URI digests
267 will be reused whenever they are available.
270 Enable portage support for the distcc package.
273 Enable portage support for the distcc package with pump mode.
276 Portage uses lockfiles to ensure competing instances don't clobber
277 each other's files. This feature is enabled by default but may cause
278 heartache on less intelligent remote filesystems like NFSv2 and some
279 strangely configured Samba server (oplocks off, NFS re\-export). A tool
280 /usr/lib/portage/bin/clean_locks exists to help handle lock issues
281 when a problem arises (normally due to a crash or disconnect).
284 Use locks to ensure that unsandboxed ebuild phases never execute
285 concurrently. Also see \fIparallel\-install\fR.
288 Enable fakeroot for the install and package phases when a non-root user runs
289 the \fBebuild\fR(1) command.
292 Clean up temporary files after a build failure. This is particularly useful
293 if you have \fBPORTAGE_TMPDIR\fR on tmpfs. If this feature is enabled, you
294 probably also want to enable \fBPORT_LOGDIR\fR in order to save the build log.
295 Both the \fBebuild\fR(1) command and the \fInoclean\fR feature cause the
296 \fIfail\-clean\fR feature to be automatically disabled.
299 Force emerges to always try to fetch files from the \fIPORTAGE_BINHOST\fR. See
300 \fBmake.conf\fR(5) for more information.
303 Install source code into /usr/src/debug/${CATEGORY}/${PF} (also see
304 \fBsplitdebug\fR). This feature works only if debugedit is installed and CFLAGS
305 is set to include debug information (such as with the \-ggdb flag).
308 Do not delete the ${T} directory after the merge process.
311 Do not delete the ${WORKDIR} directory after the merge process. ${WORKDIR} can
312 then be reused since this feature disables most of the clean phase that runs
313 prior to each build. Due to lack of proper cleanup, this feature can
314 interfere with normal emerge operation and therefore it should not be left
315 enabled for more than a short period of time.
318 Modifies .la files to not include other .la files and some other
319 fixes (order of flags, duplicated entries, ...)
322 Only fetch files from configured mirrors, ignoring \fBSRC_URI\fR,
323 except when \fImirror\fR is in the \fBebuild\fR(5) \fBRESTRICT\fR variable.
326 Enable prefix support for all ebuilds, regardless of EAPI, since older EAPIs
327 would otherwise be useless with prefix configurations. This brings
328 compatibility with the prefix branch of portage, which also supports EPREFIX
329 for all EAPIs (for obvious reasons).
332 When \fImirror\fR is enabled in \fBFEATURES\fR, fetch files even
333 when \fImirror\fR is also in the \fBebuild\fR(5) \fBRESTRICT\fR variable.
334 Do \fBNOT\fR use \fIlmirror\fR for clients that need to override \fBRESTRICT\fR
335 when fetching from a local mirror, but instead use a "local" mirror setting
336 in \fI/etc/portage/mirrors\fR, as described in \fBportage\fR(5).
338 .B metadata\-transfer
339 Automatically perform a metadata transfer when `emerge \-\-sync` is run.
340 In versions of portage >=2.1.5, this feature is disabled by
341 default. When metadata\-transfer is disabled, metadata cache from the
342 ${PORTDIR}/metadata/cache/ directory will be used directly (if available)
343 and eclasses in ${PORTDIR}/eclass/ must not be modified except by
344 `emerge \-\-sync` operations since the cache validation mechanism
345 will not recognize eclass modifications. Normally, this issue only
346 pertains to users of the rsync tree since the cvs tree does not contain
347 a metadata/cache/ directory. Users of the rsync tree who want to modify
348 eclasses should use \fBPORTDIR_OVERLAY\fR in order for the cache
349 validation mechanism to work correctly.
352 Fetch everything in \fBSRC_URI\fR regardless of \fBUSE\fR settings,
353 except do not fetch anything when \fImirror\fR is in \fBRESTRICT\fR.
356 Many Makefiles assume that their libraries should go to /usr/lib, or
357 $(prefix)/lib. This assumption can cause a serious mess if /usr/lib
358 isn't a symlink to /usr/lib64. To find the bad packages, we have a
359 portage feature called \fImultilib\-strict\fR. It will prevent emerge
360 from putting 64bit libraries into anything other than (/usr)/lib64.
363 Enable GLEP 42 news support. See
364 \fIhttp://www.gentoo.org/proj/en/glep/glep-0042.html\fR.
367 When utilizing \fBebuild\fR(1), only run the function requested.
370 Do not delete the the source and temporary files after the merge process.
373 Do not install doc files (/usr/share/doc).
376 Do not install info pages.
379 Do not install manpages.
382 Prevents the stripping of binaries that are merged to the live filesystem.
385 Disables xterm titlebar updates (which contains status info).
388 Fetch in the background while compiling. Run
389 `tail \-f /var/log/emerge\-fetch.log` in a
390 terminal to view parallel-fetch progress.
393 Use finer\-grained locks when installing packages, allowing for greater
394 parallelization. For additional parallelization, disable
397 .B parse\-eapi\-ebuild\-head
398 Parse \fBEAPI\fR from the head of the ebuild (first 30 lines). This feature
399 is only intended for experimental purposes and should not be enabled under
400 normal circumstances.
402 .B prelink\-checksums
403 If \fBprelink\fR(8) is installed then use it to undo any prelinks on files
404 before computing checksums for merge and unmerge. This feature is
405 useful only if \fBprelink\fR(8) is installed and accurate checksums (despite
406 prelinking) are needed for some reason such as for checking the integrity of
407 installed files or because the \fIunmerge\-orphans\fR feature is disabled.
409 Note that normal emerging of packages from source computes the
410 checksums before things will be prelinked, so in such cases, this
411 feature isn't required either. Undoing prelinking while merging is
412 only required when using tools like \fBquickpkg\fR(1) which can cause
413 already prelinked files to be merged.
416 This is identical to the \fIcollision\-protect\fR feature except that files
417 may be overwritten if they are not explicitly listed in the contents of a
418 currently installed package. This is particularly useful on systems that
419 have lots of orphan files that have been left behind by older versions
420 of portage that did not support the \fIunmerge\-orphans\fR feature. Like
421 \fIcollision\-protect\fR, the \fICOLLISION_IGNORE\fR variable can be used to
422 selectively disable this feature. It is recommended to leave either
423 \fIprotect\-owned\fR or \fIcollision\-protect\fR enabled at all times,
424 since otherwise file collisions between packages may result in files being
425 overwritten or uninstalled at inappropriate times.
426 If \fIcollision\-protect\fR is enabled then it takes precedence over
427 \fIprotect\-owned\fR.
430 Output a verbose trace of python execution to stderr when a command's
431 \-\-debug option is enabled.
434 Enable sandbox\-ing when running \fBemerge\fR(1) and \fBebuild\fR(1).
437 Enable SELinux sandbox\-ing. Do not toggle this \fBFEATURE\fR yourself.
440 Stands for Smart Filesystem Permissions. Before merging packages to the
441 live filesystem, automatically search for and set permissions on setuid
442 and setgid files. Files that are setuid have the group and other read
443 bits removed while files that are setgid have the other read bit removed.
444 See also \fIsuidctl\fR below.
447 When commiting work to cvs with \fBrepoman\fR(1), sign the Manifest with
448 a GPG key. Read about the \fIPORTAGE_GPG_KEY\fR variable in \fBmake.conf\fR(5).
451 Skip write access checks on \fBDISTDIR\fR when fetching files. This is
452 useful when \fBFETCHCOMMAND\fR and \fBRESUMECOMMAND\fR are used to
453 forward fetch requests to a server that exposes \fBDISTDIR\fR as
454 a read-only NFS share. A read-only \fBDISTDIR\fR is not compatible with the
455 \fIdistlocks\fR, so it is recommended to also add "-distlocks" to
456 \fBFEATURES\fR in order to avoid warning messages that are triggered by this
460 Store logs created by \fBPORTAGE_ELOG_SYSTEM="save"\fR in category
461 subdirectories of \fBPORT_LOGDIR/elog\fR, instead of using
462 \fBPORT_LOGDIR/elog\fR directly.
465 Store build logs in category subdirectories of \fBPORT_LOGDIR/build\fR,
466 instead of using \fBPORT_LOGDIR\fR directly.
469 Prior to stripping ELF etdyn and etexec files, the debugging info is
470 stored for later use by various debuggers. This feature is disabled by
471 \fBnostrip\fR. For installation of source code, see \fBinstallsources\fR.
474 Have portage react strongly to conditions that have the potential to be
475 dangerous (like missing or incorrect digests for ebuilds).
478 Have portage react strongly to conditions that may conflict with system
479 security provisions (for example textrels, executable stack). Read about
480 the \fIQA_STRICT_*\fR variables in \fBmake.conf\fR(5).
483 Before merging packages to the live filesystem, automatically strip setuid
484 bits from any file that is not listed in \fI/etc/portage/suidctl.conf\fR.
487 Run package\-specific tests during each merge to help make sure
488 the package compiled properly. See \fItest\fR in \fBebuild\fR(1)
489 and \fIsrc_test()\fR in \fBebuild\fR(5). This feature implies the "test"
492 .B test\-fail\-continue
493 If "test" is enabled \fBFEATURES\fR and the test phase of an ebuild fails,
494 continue to execute the remaining phases as if the failure had not occurred.
495 Note that the test phase for a specific package may be disabled by masking
496 the "test" \fBUSE\fR flag in \fBpackage.use.mask\fR (see \fBportage\fR(5)).
499 Keep logs from successful unmerge phases. This is relevant only when
500 \fBPORT_LOGDIR\fR is set.
503 If a file is not claimed by another package in the same slot and it is not
504 protected by \fICONFIG_PROTECT\fR, unmerge it even if the modification time or
505 checksum differs from the file that was originally installed.
507 .B unknown\-features\-filter
508 Filter out any unknown values that the FEATURES variable contains.
510 .B unknown\-features\-warn
511 Warn if FEATURES contains one or more unknown values.
514 When portage is run as root, drop privileges to portage:portage during the
515 fetching of package sources.
518 Allow portage to drop root privileges and compile packages as
519 portage:portage without a sandbox (unless \fIusersandbox\fR is also used).
522 Enable the sandbox in the compile phase, when running without root privs (\fIuserpriv\fR).
525 Drop privileges to the owner of \fBPORTDIR\fR for \fBemerge(1) --sync\fR
529 Enable GPG verification when using \fIemerge\-webrsync\fR.
532 Preserve extended attributes (filesystem-stored metadata) when installing
533 files (see \fBattr\fR(1)).
537 This variable contains the command used for fetching package sources from
538 the internet. It must contain the full path to the executable as well as the
539 place\-holders \\${DISTDIR}, \\${FILE} and \\${URI}. The command should be
540 written to place the fetched file at \\${DISTDIR}/\\${FILE}.
541 Also see \fBRESUMECOMMAND\fR.
544 Use these variables to set the desired optimization/CPU instruction settings
545 for applications that you compile with a FORTRAN compiler. FFLAGS is usually
546 passed to the FORTRAN 77 compiler, and FCFLAGS to any FORTRAN compiler in
547 more modern build systems.
549 For more information, see the \fIInvoking GCC\fR section of the gcc manual:
551 http://gcc.gnu.org/onlinedocs/
553 \fBGENTOO_MIRRORS\fR = \fI[URIs]\fR
554 Insert your space\-separated list of local mirrors here. These
555 locations are used to download files before the ones listed in
556 the \fIebuild scripts\fR. Merging 'mirrorselect' can help. Entries in this
557 variable that have no protocol and simply start with a '/' path separator may
558 be used to specify mounted filesystem mirrors.
560 \fBhttp_proxy ftp_proxy\fR = \fI[protocol://host:port]\fR
561 These vars are used if the sources must be downloaded from the
562 internet by \fBwget\fR(1). They are only required if you use a
563 proxy server for internet access.
565 \fBINSTALL_MASK\fR = \fI[space delimited list of file names]\fR
566 Use this variable if you want to selectively prevent certain files from being
567 copied into your file system tree. This does not work on symlinks, but only on
568 actual files. Useful if you wish to filter out files like HACKING.gz and
569 TODO.gz. The \fBINSTALL_MASK\fR is processed just before a package is merged.
570 Also supported is a \fBPKG_INSTALL_MASK\fR variable that behaves exactly like
571 \fBINSTALL_MASK\fR except that it is processed just before creation of a binary
575 A list of flags to pass to the compiler when the linker will be called. See
576 \fBld\fR(1) for linker flags, but don't forget that these flags will be passed
577 directly to the compiler. Thus, you must use '-Wl' to escape the flags
578 which only the linker understands (see \fBgcc\fR(1)).
582 Setting this and other *FLAGS variables arbitrarily may cause compile or
583 runtime failures. Bug reports submitted when nonstandard values are
584 enabled for these flags may be closed as INVALID.
587 Use this variable if you want to use parallel make. For example, if you
588 have a dual\-processor system, set this variable to "\-j2" or "\-j3" for
589 enhanced build performance with many packages. Suggested settings are
590 between \fICPUs+1\fR and \fI2*CPUs+1\fR. In order to avoid
591 excess load, the \fB\-\-load\-average\fR option is recommended.
592 For more information, see \fBmake\fR(1). Also see \fBemerge\fR(1) for
593 information about analogous \fB\-\-jobs\fR and \fB\-\-load\-average\fR options.
595 \fBNOCOLOR\fR = \fI["true" | "false"]\fR
596 Defines if color should be disabled by default.
600 \fBPKGDIR\fR = \fI[path]\fR
601 Defines the location where created .tbz2 binary packages will be
602 stored when the \fBemerge\fR(1) \fB\-\-buildpkg\fR option is enabled.
603 By default, a given package is stored in a subdirectory corresponding
604 to it's category. However, for backward compatibility with the layout
605 used by older versions of portage, if the \fI${PKGDIR}/All\fR directory
606 exists then all packages will be stored inside of it and symlinks to
607 the packages will be created in the category subdirectories. Note
608 that locations under /usr/portage are not necessarily safe for data storage.
609 See the \fBPORTDIR\fR documentation for more information.
611 Defaults to /usr/portage/packages.
614 This variable defines the directory in which per\-ebuild logs are kept.
615 Logs are created only when this is set. They are stored as
616 ${CATEGORY}:${PF}:YYYYMMDD\-HHMMSS.log in the directory specified. If the
617 directory does not exist, it will be created automatically and group permissions
618 will be applied to it. If the directory already exists, portage will not
619 modify it's permissions.
622 This variable should contain a command for portage to call in order
623 to clean PORT_LOGDIR. The command string should contain a
624 \\${PORT_LOGDIR} place\-holder that will be substituted
625 with the value of that variable. This variable will have no effect
626 unless \fBclean\-logs\fR is enabled in \fBFEATURES\fR.
628 \fBPORTAGE_BINHOST\fR = \fI[space delimited URI list]\fR
629 This is a list of hosts from which portage will grab prebuilt\-binary packages.
630 Each entry in the list must specify the full address of a directory
631 serving tbz2's for your system. This is only used when running with
632 the get binary pkg options are given to \fBemerge\fR. Review \fBemerge\fR(1)
633 for more information. For versions of portage less that 2.1.6, this variable
634 should point to the 'All' directory on the host that creates the binary
635 packages and not to the root of the \fBPKGDIR\fR. Starting with portage 2.1.6,
636 it should point to a directory containing a 'Packages' index file. If
637 ${PORTAGE_BINHOST}/Packages does not exist then portage will attempt to use
640 \fBPORTAGE_BINHOST_HEADER_URI\fR = \fI"ftp://login:pass@grp.mirror.site/pub/grp/i686/athlon\-xp/"\fR
641 This variable only makes sense on a system that will serve as a binhost and
642 build packages for clients. It defines the URI header field for the package
643 index file which is located at ${PKGDIR}/Packages. Clients that have
644 \fBPORTAGE_BINHOST\fR properly configured will be able to fetch the index and
645 use the URI header field as a base URI for fetching binary packages. If the URI
646 header field is not defined then the client will use it's ${PORTAGE_BINHOST}
647 setting as the base URI.
649 .B PORTAGE_BINPKG_TAR_OPTS
650 This variable contains options to be passed to the tar command for creation
653 \fBPORTAGE_BUNZIP2_COMMAND\fR = \fI[bunzip2 command string]\fR
654 This variable should contain a command that is suitable for portage to call
655 for bunzip2 extraction operations.
657 \fBPORTAGE_BZIP2_COMMAND\fR = \fI[bzip2 command string]\fR
658 This variable should contain a command that is suitable for portage to call
659 for bzip2 compression operations. \fBPORTAGE_BZIP2_COMMAND\fR will also be
660 called for extraction operation, with -d appended, unless the
661 \fBPORTAGE_BUNZIP2_COMMAND\fR variable is set.
663 \fBPORTAGE_COMPRESS\fR = \fI"bzip2"\fR
664 This variable contains the command used to compress documentation during the
667 \fBPORTAGE_COMPRESS_FLAGS\fR = \fI"\-9"\fR
668 This variable contains flags for the \fBPORTAGE_COMPRESS\fR command.
671 \fBPORTAGE_COMPRESS_EXCLUDE_SUFFIXES\fR = \fI"gif htm[l]? jp[e]?g pdf png"\fR
672 This variable contains a space delimited list of file suffixes for which
673 matching files are excluded when the \fBPORTAGE_COMPRESS\fR command is
674 called. Regular expressions are supported and the match is performed only
675 against the portion of the file name which follows the last period character.
677 .B PORTAGE_ELOG_CLASSES
679 .B PORTAGE_ELOG_SYSTEM
681 .B PORTAGE_ELOG_COMMAND
683 .B PORTAGE_ELOG_MAILURI
685 .B PORTAGE_ELOG_MAILFROM
687 .B PORTAGE_ELOG_MAILSUBJECT
688 Please see /usr/share/portage/config/make.conf.example for elog documentation.
690 \fBPORTAGE_FETCH_CHECKSUM_TRY_MIRRORS\fR = \fI5\fR
691 Number of mirrors to try when a downloaded file has an incorrect checksum.
693 \fBPORTAGE_FETCH_RESUME_MIN_SIZE\fR = \fI350K\fR
694 Minimum size of existing file for \fBRESUMECOMMAND\fR to be called. Files
695 smaller than this size will be removed and \fBFETCHCOMMAND\fR will be called
696 to download the file from the beginning. This is useful for helping to ensure
697 that small garbage files such as html 404 pages are properly discarded. The
698 variable should contain an integer number of bytes and may have a suffix such
702 The \fBgpg\fR(1) home directory that is used by \fBrepoman\fR(1)
703 when \fBsign\fR is in \fBFEATURES\fR.
705 Defaults to $HOME/.gnupg.
708 The \fBgpg\fR(1) key used by \fBrepoman\fR(1) to sign manifests
709 when \fBsign\fR is in \fBFEATURES\fR.
711 .B PORTAGE_GPG_SIGNING_COMMAND
712 The command used by \fBrepoman\fR(1) to sign manifests when \fBsign\fR is
715 \fBPORTAGE_IONICE_COMMAND\fR = \fI[ionice command string]\fR
716 This variable should contain a command for portage to call in order
717 to adjust the io priority of portage and it's subprocesses. The command
718 string should contain a \\${PID} place-holder that will be substituted
719 with an integer pid. For example, a value of "ionice \-c 3 \-p \\${PID}"
720 will set idle io priority. For more information about ionice, see
721 \fBionice\fR(1). This variable is unset by default.
723 \fBPORTAGE_NICENESS\fR = \fI[number]\fR
724 The value of this variable will be added to the current nice level that
725 emerge is running at. In other words, this will not set the nice level,
726 it will increment it. For more information about nice levels and what
727 are acceptable ranges, see \fBnice\fR(1).
729 \fBPORTAGE_RO_DISTDIRS\fR = \fI[space delimited list of directories]\fR
730 When a given file does not exist in \fBDISTDIR\fR, search for the file
731 in this list of directories. Search order is from left to right. Note
732 that the current implementation works by creating a symlink inside
733 \fBDISTDIR\fR, but that may change in the future.
735 \fBPORTAGE_RSYNC_INITIAL_TIMEOUT\fR = \fIinteger\fR
736 Used by \fBemerge \-\-sync\fR as a timeout for the initial connection to an
739 Defaults to 15 seconds.
741 \fBPORTAGE_RSYNC_EXTRA_OPTS\fR = \fI[rsync options string]\fR
742 Additional rsync options to be used by \fBemerge \-\-sync\fR.
744 Defaults to no value.
746 \fBPORTAGE_RSYNC_OPTS\fR = \fI[rsync options string]\fR
747 Default rsync options to be used by \fBemerge \-\-sync\fR.
749 \fBDon't change this unless you know exactly what you're doing!\fR
751 Defaults to "\-\-recursive \-\-links \-\-safe\-links \-\-perms \-\-times
752 \-\-compress \-\-force \-\-whole\-file \-\-delete \-\-stats
753 \-\-timeout=180 \-\-exclude='/distfiles' \-\-exclude='/local'
754 \-\-exclude='/packages'"
756 \fBPORTAGE_RSYNC_RETRIES\fR = \fI[NUMBER]\fR
757 The number of times rsync should retry on failed connections before
758 giving up. If set to a negative number, then retry until all possible
759 addresses are exhausted.
763 \fBPORTAGE_SYNC_STALE\fR = \fI[NUMBER]\fR
764 Defines the number of days after the last `emerge \-\-sync` that a warning
765 message should be produced. A value of 0 will disable warnings.
769 \fBPORTAGE_TMPDIR\fR = \fI[path]\fR
770 Defines the location of the temporary build directories.
772 Defaults to /var/tmp.
774 \fBPORTAGE_WORKDIR_MODE\fR = \fI"0700"\fR
775 This variable controls permissions for \fIWORKDIR\fR (see \fBebuild\fR(5)).
777 \fBPORTDIR\fR = \fI[path]\fR
778 Defines the location of the Portage tree. This is the repository for all
779 profile information as well as all ebuilds. If you change this, you must update
780 your /etc/make.profile symlink accordingly.
782 Defaults to /usr/portage.
786 Data stored inside \fBPORTDIR\fR is in peril of being overwritten or deleted by
787 the emerge \-\-sync command. The default value of
788 \fBPORTAGE_RSYNC_OPTS\fR will protect the default locations of
789 \fBDISTDIR\fR and \fBPKGDIR\fR, but users are warned that any other locations
790 inside \fBPORTDIR\fR are not necessarily safe for data storage. You should not
791 put other data (such as overlays) in your \fBPORTDIR\fB. Portage will walk
792 directory structures and may arbitrary add invalid categories as packages.
794 \fBPORTDIR_OVERLAY\fR = \fI"[path] [different\-path] [etc...]"\fR
795 Defines the directories in which user made ebuilds may be stored and not
796 overwriten when `emerge \-\-sync` is run. This is a space delimited list of
799 Defaults to no value.
801 \fBQA_STRICT_EXECSTACK = \fI"set"\fR
802 Set this to cause portage to ignore any \fIQA_EXECSTACK\fR override
803 settings from ebuilds. See also \fBebuild\fR(5).
805 \fBQA_STRICT_WX_LOAD = \fI"set"\fR
806 Set this to cause portage to ignore any \fIQA_WX_LOAD\fR override
807 settings from ebuilds. See also \fBebuild\fR(5).
809 \fBQA_STRICT_TEXTRELS = \fI"set"\fR
810 Set this to cause portage to ignore any \fIQA_TEXTREL\fR override
811 settings from ebuilds. See also \fBebuild\fR(5).
813 \fBQA_STRICT_DT_HASH = \fI"set"\fR
814 Set this to cause portage to ignore any \fIQA_DT_HASH\fR override
815 settings from ebuilds. See also \fBebuild\fR(5).
817 \fBQA_STRICT_PRESTRIPPED = \fI"set"\fR
818 Set this to cause portage to ignore any \fIQA_PRESTRIPPED\fR override
819 settings from ebuilds. See also \fBebuild\fR(5).
822 This variable contains the command used for resuming package sources that
823 have been partially downloaded. It should be defined using the same format
824 as \fBFETCHCOMMAND\fR, and must include any additional option(s) that may
825 be necessary in order to continue a partially downloaded file located at
826 \\${DISTDIR}/\\${FILE}.
828 \fBROOT\fR = \fI[path]\fR
829 Use \fBROOT\fR to specify the target root filesystem to be used for merging
830 packages or ebuilds. All \fBRDEPEND\fR and \fBPDEPEND\fR will be installed
831 into \fBROOT\fR while all \fBDEPEND\fR will be still be installed into /.
832 Typically, you should set this setting in the environment rather than in
833 \fI/etc/make.conf\fR itself. It's commonly used for creating new build
834 images. Make sure you use an absolute path.
838 \fBRPMDIR\fR = \fI[path]\fR
839 Defines the location where created RPM packages will be stored.
841 Defaults to ${PORTDIR}/rpm.
843 \fBSYNC\fR = \fI[RSYNC]\fR
844 Insert your preferred rsync mirror here. This rsync server
845 is used to sync the local portage tree when `emerge \-\-sync` is run.
847 Defaults to rsync://rsync.gentoo.org/gentoo\-portage
849 \fBUSE\fR = \fI[space delimited list of USE items]\fR
850 This variable contains options that control the build behavior of several
851 packages. More information in \fBebuild\fR(5). Possible USE values
852 can be found in \fI/usr/portage/profiles/use.desc\fR.
854 \fBUSE_EXPAND\fR = \fI[space delimited list of variable names]\fR
855 Any variable listed here will be used to augment USE by inserting a new flag
856 for every value in that variable, so USE_EXPAND="FOO" and FOO="bar bla" results
857 in USE="foo_bar foo_bla".
859 \fBUSE_EXPAND_HIDDEN\fR = \fI[space delimited list of variable names]\fR
860 Names of \fBUSE_EXPAND\fR variables that should not be shown in the verbose merge
861 list output of the \fBemerge\fR(1) command.
863 \fBUSE_ORDER\fR = \fI"env:pkg:conf:defaults:pkginternal:repo:env.d"\fR
864 Determines the precedence of layers in the incremental stacking of the USE
865 variable. Precedence decreases from left to right such that env overrides
866 pkg, pkg overrides conf, and so forth.
870 Do not modify this value unless you're a developer and you know what
871 you're doing. If you change this and something breaks, we will not help
877 USE from the current environment variables (USE and those listed in USE_EXPAND)
880 Per\-package USE from \fB/etc/portage/package.use\fR (see \fBportage\fR(5))
886 USE from make.defaults and package.use in the profile
887 (e.g. /etc/portage/make.profile/package.use) (see \fBportage\fR(5))
890 USE from \fBebuild\fR(5) IUSE defaults
893 USE from make.defaults and package.use in the repo's profiles/ top dir
894 (e.g. /usr/portage/profiles/package.use) (see \fBportage\fR(5))
897 USE from the environment variables, such as LINGUAS, defined by files in
902 Please report bugs via http://bugs.gentoo.org/
905 Daniel Robbins <drobbins@gentoo.org>
906 Nicholas Jones <carpaski@gentoo.org>
907 Mike Frysinger <vapier@gentoo.org>
908 Saleem Abdulrasool <compnerd@gentoo.org>
912 \fB/etc/make.conf\fR and \fB/etc/portage/make.conf\fR
913 Contains variables for the build\-process and overwrites those in make.defaults.
915 .B /usr/share/portage/config/make.globals
916 Contains the default variables for the build\-process, you should edit \fI/etc/make.conf\fR instead.
918 .B /etc/portage/color.map
919 Contains variables customizing colors.
921 .B /usr/portage/profiles/use.desc
922 Contains a list of all global USE flags.
924 .B /usr/portage/profiles/use.local.desc
925 Contains a list of all local USE variables.
932 The \fI/usr/sbin/ebuild.sh\fR script.
934 The helper apps in \fI/usr/lib/portage/bin\fR.
projects / portage.git / blob