1 .TH "MAKE.CONF" "5" "May 2013" "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/portage/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.
58 # Only accept licenses in the FREE license group (i.e. Free Software)
59 ACCEPT_LICENSE="-* @FREE"
60 # As before, but exclude the "Artistic" license
61 ACCEPT_LICENSE="-* @FREE -Artistic"
62 # Accept any license except those in the EULA license group (default)
63 ACCEPT_LICENSE="* -@EULA"
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"
83 \fBACCEPT_RESTRICT\fR = \fI[space delimited list of RESTRICT tokens]\fR
84 This variable is used to mask packages based on RESTRICT tokens.
85 In addition to RESTRICT tokens, the \fI*\fR and \fI-*\fR wildcard tokens are
86 also supported. This variable can be temporarily overridden using the
87 \fB\-\-accept\-restrict\fR option of \fBemerge\fR(1).
88 See \fBebuild\fR(5) for more information about RESTRICT.
90 Defaults to the value of *.
94 # Accept any restrict tokens
96 # Accept any tokens except "bindist"
97 ACCEPT_RESTRICT="* -bindist"
101 This variable is passed by the \fIebuild scripts\fR to the \fIconfigure\fR
102 as \fI\-\-build=${CBUILD}\fR only if it is defined. Do not set this yourself
103 unless you know what you are doing.
105 \fBCCACHE_DIR\fR = \fI[path]\fR
106 Defines the location of the ccache working directory. See the \fBccache\fR(1)
107 man page for more information.
109 Defaults to /var/tmp/ccache
111 \fBCCACHE_SIZE\fR = \fI"size"\fR
112 This controls the space use limitations for ccache. The default is 2 gigabytes
113 ('2G'). Sizes are specified with 'G', 'M', or 'K'.
116 Use these variables to set the desired optimization/CPU instruction settings
117 for applications that you compile. These two variables are passed to the C
118 and C++ compilers, respectively. (CXX is used to refer to the C++ compiler
119 within many buildsystems.) Nearly all ebuild files will take advantage
120 of your custom settings, resulting in a Gentoo Linux that is fully customized
121 to your specifications. Please use sane settings as some packages will fail to
122 compile/run if the optimizations are too extreme.
124 For more information, see the \fIInvoking GCC\fR section of the gcc manual:
126 http://gcc.gnu.org/onlinedocs/
129 This variable is passed by the \fIebuild scripts\fR to the \fIconfigure\fR
130 step as \fI\-\-host=${CHOST}\fR. This way you can force the build\-host.
132 For more information:
134 http://gcc.gnu.org/onlinedocs/gcc\-4.1.1/gcc/Submodel\-Options.html
136 http://gcc.gnu.org/onlinedocs/gcc\-3.3/gcc/Submodel\-Options.html
138 http://gcc.gnu.org/onlinedocs/gcc\-3.2/gcc/Submodel\-Options.html
140 http://gcc.gnu.org/onlinedocs/gcc\-2.95.3/gcc_2.html
142 \fBCLEAN_DELAY\fR = \fIinteger\fR
143 Determines how long the countdown delay will be after running
146 Defaults to 5 seconds.
148 \fBCOLLISION_IGNORE\fR = \fI[space delimited list of fnmatch patterns]\fR
149 This variable allows the user to disable \fIcollision\-protect\fR and
150 \fIprotect\-owned\fR for specific \fBfnmatch\fR(3) patterns. For backward
151 compatibility, directories that are listed without a fnmatch pattern will
152 automatically have /* appended to them.
154 Defaults to "/lib/modules/* *.py[co]".
156 \fBCONFIG_PROTECT\fR = \fI[space delimited list of files and/or directories]\fR
157 All files and/or directories that are defined here will have "config file protection"
158 enabled for them. See the \fBCONFIGURATION FILES\fR section
159 of \fBemerge\fR(1) for more information.
161 \fBCONFIG_PROTECT_MASK\fR = \fI[space delimited list of files and/or directories]\fR
162 All files and/or directories that are defined here will have "config file protection"
163 disabled for them. See the \fBCONFIGURATION FILES\fR section
164 of \fBemerge\fR(1) for more information.
167 This variable is passed by the \fIebuild scripts\fR to the \fIconfigure\fR
168 as \fI\-\-target=${CTARGET}\fR only if it is defined.
170 \fBDISTDIR\fR = \fI[path]\fR
171 Defines the location of your local source file repository. After packages
172 are built, it is safe to remove any and all files from this directory since
173 they will be automatically fetched on demand for a given build. If you would
174 like to selectively prune obsolete files from this directory, see
175 \fBeclean\fR(1) from the gentoolkit package.
177 Use the \fBPORTAGE_RO_DISTDIRS\fR variable to specify one or
178 more read-only directories containing distfiles.
181 that locations under /usr/portage are not necessarily safe for data storage.
182 See the \fBPORTDIR\fR documentation for more information.
184 Defaults to /usr/portage/distfiles.
187 This variable may contain a name and email address which will be used by
188 \fBrepoman\fR(1) to add a Signed\-off\-by line to each commit message.
191 If this variable contains a directory then symlinks to html documentation will
192 be installed into it.
195 Defines whether or not to ignore audible beeps when displaying important
196 informational messages. This variable is unset by default.
198 .B EMERGE_DEFAULT_OPTS
199 Options to append to the end of the \fBemerge\fR(1) command line on every invocation.
200 These options will not be appended to the command line if \-\-ignore\-default\-opts
204 Controls the location of emerge.log and emerge-fetch.log.
206 Defaults to /var/log.
208 \fBEMERGE_WARNING_DELAY\fR = \fIinteger\fR
209 Determines how long the countdown delay will be after running
210 `emerge --unmerge` for a system package.
212 Defaults to 10 seconds.
215 Defines whether or not to ignore short pauses that occur when displaying
216 important informational messages. This variable is unset by default.
217 If it is set to any value pauses are ignored.
219 \fBEXTRA_ECONF\fR = \fI[configure options string]\fR
220 Contains additional options that \fBeconf\fR will append to configure
221 script arguments (see \fBebuild\fR(5)).
223 \fBFEATURES\fR = \fI"sandbox"\fR
224 Defines actions portage takes by default. This is an incremental variable.
225 Most of these settings are for developer use, but some are available to
226 non-developers as well. The \fBsandbox\fR feature is very important and
227 should not be disabled by default.
231 When commiting work to cvs with \fBrepoman\fR(1), assume that all existing
232 SRC_URI digests are correct. This feature also affects digest generation via
233 \fBebuild\fR(1) and \fBemerge\fR(1) (emerge generates digests only when the
234 \fIdigest\fR feature is enabled). Existing digests for files that do not exist
235 in ${DISTDIR} will be automatically assumed even when \fIassume\-digests\fR is
236 not enabled. If a file exists in ${DISTDIR} but its size does not match the
237 existing digest, the digest will be regenerated regardless of whether or
238 not \fIassume\-digests\fR is enabled. The \fBebuild\fR(1) \fBdigest\fR command
239 has a \fB\-\-force\fR option that can be used to force regeneration of digests.
242 Keep logs from successful binary package merges. This is relevant only when
243 \fBPORT_LOGDIR\fR is set.
246 Binary packages will be created for all packages that are merged. Also see
247 \fBquickpkg\fR(1) and \fBemerge\fR(1) \fB\-\-buildpkg\fR and
248 \fB\-\-buildpkgonly\fR options.
251 Build binary packages for just packages in the system set.
254 Enable a special progress indicator when \fBemerge\fR(1) is calculating
258 Enable portage support for the ccache package. If the ccache dir is not
259 present in the user's environment, then portage will default to
260 ${PORTAGE_TMPDIR}/ccache.
262 \fBWarning\fR: This feature is known to cause numerous compilation failures.
263 Sometimes ccache will retain stale code objects or corrupted files, which can
264 lead to packages that cannot be emerged. If this happens (if you receive errors
265 like "File not recognized: File truncated"), try recompiling the application
266 with ccache disabled before reporting a bug. Unless you are doing development
267 work, do not enable ccache.
270 Enable automatic execution of the command specified by the
271 PORT_LOGDIR_CLEAN variable. The default PORT_LOGDIR_CLEAN setting will
272 remove all files from PORT_LOGDIR that were last modified at least 7
275 .B collision\-protect
276 A QA\-feature to ensure that a package doesn't overwrite files it doesn't own.
277 The \fICOLLISION_IGNORE\fR variable can be used to selectively disable this
278 feature. Also see the related \fIprotect\-owned\fR feature.
280 .B compress\-build\-logs
281 The causes all build logs to be compressed while they are being written.
282 Log file names have an extension that is appropriate for the compression
283 type. Currently, only \fBgzip\fR(1) compression is supported, so build
284 logs will have a '.gz' extension when this feature is enabled.
287 Compress the debug sections in the split debug files with zlib to save
288 space. Make sure you have built both binutils and gdb with USE=zlib
289 support for this to work. See \fBsplitdebug\fR for general split debug
290 information (upon which this feature depends).
293 If set then a compressed copy of 'Packages' index file will be written.
294 This feature is intended for Gentoo binhosts using certain webservers
295 (such as, but not limited to, Nginx with gzip_static module) to avoid
296 redundant on\-the\-fly compression. The resulting file will be called
297 \[aq]Packages.gz' and its modification time will match that of 'Packages'.
299 .B config\-protect\-if\-modified
300 This causes the \fBCONFIG_PROTECT\fR behavior to be skipped for files
301 that have not been modified since they were installed. This feature is
305 Autogenerate digests for packages when running the
306 \fBemerge\fR(1), \fBebuild\fR(1), or \fBrepoman\fR(1) commands. If
307 the \fIassume\-digests\fR feature is also enabled then existing SRC_URI digests
308 will be reused whenever they are available.
311 Enable portage support for the distcc package.
314 Enable portage support for the distcc package with pump mode.
317 Portage uses lockfiles to ensure competing instances don't clobber
318 each other's files. This feature is enabled by default but may cause
319 heartache on less intelligent remote filesystems like NFSv2 and some
320 strangely configured Samba server (oplocks off, NFS re\-export). A tool
321 /usr/lib/portage/bin/clean_locks exists to help handle lock issues
322 when a problem arises (normally due to a crash or disconnect).
325 When a package is downgraded to a lower version, call \fBquickpkg\fR(1)
326 in order to create a backup of the installed version before it is
327 unmerged (if a binary package of the same version does not already
328 exist). Also see the related \fIunmerge\-backup\fR feature.
331 Use locks to ensure that unsandboxed ebuild phases never execute
332 concurrently. Also see \fIparallel\-install\fR.
335 Enable fakeroot for the install and package phases when a non-root user runs
336 the \fBebuild\fR(1) command.
339 Clean up temporary files after a build failure. This is particularly useful
340 if you have \fBPORTAGE_TMPDIR\fR on tmpfs. If this feature is enabled, you
341 probably also want to enable \fBPORT_LOGDIR\fR in order to save the build log.
342 Both the \fBebuild\fR(1) command and the \fInoclean\fR feature cause the
343 \fIfail\-clean\fR feature to be automatically disabled.
346 Force emerges to always try to fetch files from the \fIPORTAGE_BINHOST\fR. See
347 \fBmake.conf\fR(5) for more information.
350 Install source code into /usr/src/debug/${CATEGORY}/${PF} (also see
351 \fBsplitdebug\fR). This feature works only if debugedit is installed and CFLAGS
352 is set to include debug information (such as with the \-ggdb flag).
355 Do not delete the ${T} directory after the merge process.
358 Do not delete the ${WORKDIR} directory after the merge process. ${WORKDIR} can
359 then be reused since this feature disables most of the clean phase that runs
360 prior to each build. Due to lack of proper cleanup, this feature can
361 interfere with normal emerge operation and therefore it should not be left
362 enabled for more than a short period of time.
365 Modifies .la files to not include other .la files and some other
366 fixes (order of flags, duplicated entries, ...)
369 Only fetch files from configured mirrors, ignoring \fBSRC_URI\fR,
370 except when \fImirror\fR is in the \fBebuild\fR(5) \fBRESTRICT\fR variable.
373 Enable prefix support for all ebuilds, regardless of EAPI, since older EAPIs
374 would otherwise be useless with prefix configurations. This brings
375 compatibility with the prefix branch of portage, which also supports EPREFIX
376 for all EAPIs (for obvious reasons).
379 When \fImirror\fR is enabled in \fBFEATURES\fR, fetch files even
380 when \fImirror\fR is also in the \fBebuild\fR(5) \fBRESTRICT\fR variable.
381 Do \fBNOT\fR use \fIlmirror\fR for clients that need to override \fBRESTRICT\fR
382 when fetching from a local mirror, but instead use a "local" mirror setting
383 in \fI/etc/portage/mirrors\fR, as described in \fBportage\fR(5).
386 After a package is merged or unmerged, sync relevant files to
387 disk in order to avoid data\-loss in the event of a power failure.
388 This feature is enabled by default.
390 .B metadata\-transfer
391 Automatically perform a metadata transfer when `emerge \-\-sync` is run.
392 In versions of portage >=2.1.5, this feature is disabled by
393 default. When metadata\-transfer is disabled, metadata cache from the
394 ${PORTDIR}/metadata/md5\-cache/ directory will be used directly
398 Fetch everything in \fBSRC_URI\fR regardless of \fBUSE\fR settings,
399 except do not fetch anything when \fImirror\fR is in \fBRESTRICT\fR.
402 Many Makefiles assume that their libraries should go to /usr/lib, or
403 $(prefix)/lib. This assumption can cause a serious mess if /usr/lib
404 isn't a symlink to /usr/lib64. To find the bad packages, we have a
405 portage feature called \fImultilib\-strict\fR. It will prevent emerge
406 from putting 64bit libraries into anything other than (/usr)/lib64.
409 Enable GLEP 42 news support. See
410 \fIhttp://www.gentoo.org/proj/en/glep/glep-0042.html\fR.
413 When utilizing \fBebuild\fR(1), only run the function requested. Also, forces
414 the corresponding ebuild and eclasses to be sourced again for each phase, in
415 order to account for modifications.
418 Do not delete the the source and temporary files after the merge process.
421 Do not install doc files (/usr/share/doc).
424 Do not install info pages.
427 Do not install manpages.
430 Prevents the stripping of binaries that are merged to the live filesystem.
433 Disables xterm titlebar updates (which contains status info).
436 Fetch in the background while compiling. Run
437 `tail \-f /var/log/emerge\-fetch.log` in a
438 terminal to view parallel-fetch progress.
441 Use finer\-grained locks when installing packages, allowing for greater
442 parallelization. For additional parallelization, disable
445 .B prelink\-checksums
446 If \fBprelink\fR(8) is installed then use it to undo any prelinks on files
447 before computing checksums for merge and unmerge. This feature is
448 useful only if \fBprelink\fR(8) is installed and accurate checksums (despite
449 prelinking) are needed for some reason such as for checking the integrity of
450 installed files or because the \fIunmerge\-orphans\fR feature is disabled.
452 Note that normal emerging of packages from source computes the
453 checksums before things will be prelinked, so in such cases, this
454 feature isn't required either. Undoing prelinking while merging is
455 only required when using tools like \fBquickpkg\fR(1) which can cause
456 already prelinked files to be merged.
459 Preserve libraries when the sonames change during upgrade or downgrade.
460 Libraries are preserved only if consumers of those libraries are detected.
461 Preserved libraries are automatically removed when there are no remaining
462 consumers. Run `emerge @preserved\-rebuild` in order to rebuild all
463 consumers of preserved libraries.
466 This is identical to the \fIcollision\-protect\fR feature except that files
467 may be overwritten if they are not explicitly listed in the contents of a
468 currently installed package. This is particularly useful on systems that
469 have lots of orphan files that have been left behind by older versions
470 of portage that did not support the \fIunmerge\-orphans\fR feature. Like
471 \fIcollision\-protect\fR, the \fICOLLISION_IGNORE\fR variable can be used to
472 selectively disable this feature. It is recommended to leave either
473 \fIprotect\-owned\fR or \fIcollision\-protect\fR enabled at all times,
474 since otherwise file collisions between packages may result in files being
475 overwritten or uninstalled at inappropriate times.
476 If \fIcollision\-protect\fR is enabled then it takes precedence over
477 \fIprotect\-owned\fR.
480 Output a verbose trace of python execution to stderr when a command's
481 \-\-debug option is enabled.
484 Enable sandbox\-ing when running \fBemerge\fR(1) and \fBebuild\fR(1).
487 Enable SELinux sandbox\-ing. Do not toggle this \fBFEATURE\fR yourself.
490 Stands for Smart Filesystem Permissions. Before merging packages to the
491 live filesystem, automatically search for and set permissions on setuid
492 and setgid files. Files that are setuid have the group and other read
493 bits removed while files that are setgid have the other read bit removed.
494 See also \fIsuidctl\fR below.
497 When commiting work to cvs with \fBrepoman\fR(1), sign the Manifest with
498 a GPG key. Read about the \fIPORTAGE_GPG_KEY\fR variable in \fBmake.conf\fR(5).
501 Skip write access checks on \fBDISTDIR\fR when fetching files. This is
502 useful when \fBFETCHCOMMAND\fR and \fBRESUMECOMMAND\fR are used to
503 forward fetch requests to a server that exposes \fBDISTDIR\fR as
504 a read-only NFS share. A read-only \fBDISTDIR\fR is not compatible with the
505 \fIdistlocks\fR, so it is recommended to also add "-distlocks" to
506 \fBFEATURES\fR in order to avoid warning messages that are triggered by this
510 Store logs created by \fBPORTAGE_ELOG_SYSTEM="save"\fR in category
511 subdirectories of \fBPORT_LOGDIR/elog\fR, instead of using
512 \fBPORT_LOGDIR/elog\fR directly.
515 Store build logs in category subdirectories of \fBPORT_LOGDIR/build\fR,
516 instead of using \fBPORT_LOGDIR\fR directly.
519 Prior to stripping ELF etdyn and etexec files, the debugging info is
520 stored for later use by various debuggers. This feature is disabled by
521 \fBnostrip\fR. You should also consider setting \fBcompressdebug\fR so
522 the files don't suck up a lot of space. For installation of source code,
523 see \fBinstallsources\fR.
526 Have portage react strongly to conditions that have the potential to be
527 dangerous (like missing or incorrect digests for ebuilds).
530 Have portage react strongly to conditions that may conflict with system
531 security provisions (for example textrels, executable stack). Read about
532 the \fIQA_STRICT_*\fR variables in \fBmake.conf\fR(5).
535 Before merging packages to the live filesystem, automatically strip setuid
536 bits from any file that is not listed in \fI/etc/portage/suidctl.conf\fR.
539 Run package\-specific tests during each merge to help make sure
540 the package compiled properly. See \fItest\fR in \fBebuild\fR(1)
541 and \fIsrc_test()\fR in \fBebuild\fR(5). This feature implies the "test"
542 \fBUSE\fR flag if it is a member of \fBIUSE\fR, either explicitly or
543 implicitly (see \fBebuild\fR(5) for more information about \fBIUSE\fR).
544 The "test" \fBUSE\fR flag is also automatically disabled when the
545 "test" feature is disabled.
547 .B test\-fail\-continue
548 If "test" is enabled \fBFEATURES\fR and the test phase of an ebuild fails,
549 continue to execute the remaining phases as if the failure had not occurred.
550 Note that the test phase for a specific package may be disabled by masking
551 the "test" \fBUSE\fR flag in \fBpackage.use.mask\fR (see \fBportage\fR(5)).
554 Call \fBquickpkg\fR(1) to create a backup of each package before it is
555 unmerged (if a binary package of the same version does not already exist).
556 Also see the related \fIdowngrade\-backup\fR feature.
559 Keep logs from successful unmerge phases. This is relevant only when
560 \fBPORT_LOGDIR\fR is set.
563 If a file is not claimed by another package in the same slot and it is not
564 protected by \fICONFIG_PROTECT\fR, unmerge it even if the modification time or
565 checksum differs from the file that was originally installed.
567 .B unknown\-features\-filter
568 Filter out any unknown values that the FEATURES variable contains.
570 .B unknown\-features\-warn
571 Warn if FEATURES contains one or more unknown values.
574 When portage is run as root, drop privileges to portage:portage during the
575 fetching of package sources.
578 Allow portage to drop root privileges and compile packages as
579 portage:portage without a sandbox (unless \fIusersandbox\fR is also used).
582 Enable the sandbox in the compile phase, when running without root privs (\fIuserpriv\fR).
585 Drop privileges to the owner of \fBPORTDIR\fR for \fBemerge(1) --sync\fR
589 Enable GPG verification when using \fIemerge\-webrsync\fR.
592 Preserve extended attributes (filesystem-stored metadata) when installing
593 files (see \fBattr\fR(1)). The \fBPORTAGE_XATTR_EXCLUDE\fR variable may be
594 used to exclude specific attributes from being preserved.
598 This variable contains the command used for fetching package sources from
599 the internet. It must contain the full path to the executable as well as the
600 place\-holders \\${DISTDIR}, \\${FILE} and \\${URI}. The command should be
601 written to place the fetched file at \\${DISTDIR}/\\${FILE}.
602 Also see \fBRESUMECOMMAND\fR.
605 Use these variables to set the desired optimization/CPU instruction settings
606 for applications that you compile with a FORTRAN compiler. FFLAGS is usually
607 passed to the FORTRAN 77 compiler, and FCFLAGS to any FORTRAN compiler in
608 more modern build systems.
610 For more information, see the \fIInvoking GCC\fR section of the gcc manual:
612 http://gcc.gnu.org/onlinedocs/
614 \fBGENTOO_MIRRORS\fR = \fI[URIs]\fR
615 Insert your space\-separated list of local mirrors here. These
616 locations are used to download files before the ones listed in
617 the \fIebuild scripts\fR. Merging 'mirrorselect' can help. Entries in this
618 variable that have no protocol and simply start with a '/' path separator may
619 be used to specify mounted filesystem mirrors.
621 \fBhttp_proxy ftp_proxy\fR = \fI[protocol://host:port]\fR
622 These vars are used if the sources must be downloaded from the
623 internet by \fBwget\fR(1). They are only required if you use a
624 proxy server for internet access.
626 \fBINSTALL_MASK\fR = \fI[space delimited list of file names]\fR
627 Use this variable if you want to selectively prevent certain files from being
628 copied into your file system tree. This does not work on symlinks, but only on
629 actual files. Useful if you wish to filter out files like HACKING.gz and
630 TODO.gz. The \fBINSTALL_MASK\fR is processed just before a package is merged.
631 Also supported is a \fBPKG_INSTALL_MASK\fR variable that behaves exactly like
632 \fBINSTALL_MASK\fR except that it is processed just before creation of a binary
636 A list of flags to pass to the compiler when the linker will be called. See
637 \fBld\fR(1) for linker flags, but don't forget that these flags will be passed
638 directly to the compiler. Thus, you must use '-Wl' to escape the flags
639 which only the linker understands (see \fBgcc\fR(1)).
643 Setting this and other *FLAGS variables arbitrarily may cause compile or
644 runtime failures. Bug reports submitted when nonstandard values are
645 enabled for these flags may be closed as INVALID.
648 Use this variable if you want to use parallel make. For example, if you
649 have a dual\-processor system, set this variable to "\-j2" or "\-j3" for
650 enhanced build performance with many packages. Suggested settings are
651 between \fICPUs+1\fR and \fI2*CPUs+1\fR. In order to avoid
652 excess load, the \fB\-\-load\-average\fR option is recommended.
653 For more information, see \fBmake\fR(1). Also see \fBemerge\fR(1) for
654 information about analogous \fB\-\-jobs\fR and \fB\-\-load\-average\fR options.
656 \fBNOCOLOR\fR = \fI["true" | "false"]\fR
657 Defines if color should be disabled by default.
661 \fBPKGDIR\fR = \fI[path]\fR
662 Defines the location where created .tbz2 binary packages will be
663 stored when the \fBemerge\fR(1) \fB\-\-buildpkg\fR option is enabled.
664 By default, a given package is stored in a subdirectory corresponding
665 to it's category. However, for backward compatibility with the layout
666 used by older versions of portage, if the \fI${PKGDIR}/All\fR directory
667 exists then all packages will be stored inside of it and symlinks to
668 the packages will be created in the category subdirectories. Note
669 that locations under /usr/portage are not necessarily safe for data storage.
670 See the \fBPORTDIR\fR documentation for more information.
672 Defaults to /usr/portage/packages.
675 This variable defines the directory in which per\-ebuild logs are kept.
676 Logs are created only when this is set. They are stored as
677 ${CATEGORY}:${PF}:YYYYMMDD\-HHMMSS.log in the directory specified. If the
678 directory does not exist, it will be created automatically and group permissions
679 will be applied to it. If the directory already exists, portage will not
680 modify it's permissions.
683 This variable should contain a command for portage to call in order
684 to clean PORT_LOGDIR. The command string should contain a
685 \\${PORT_LOGDIR} place\-holder that will be substituted
686 with the value of that variable. This variable will have no effect
687 unless \fBclean\-logs\fR is enabled in \fBFEATURES\fR.
689 \fBPORTAGE_BINHOST\fR = \fI[space delimited URI list]\fR
690 This is a list of hosts from which portage will grab prebuilt\-binary packages.
691 Each entry in the list must specify the full address of a directory
692 serving tbz2's for your system (this directory must contain a 'Packages' index
693 file). This is only used when running with
694 the get binary pkg options are given to \fBemerge\fR. Review \fBemerge\fR(1)
695 for more information.
697 \fBPORTAGE_BINHOST_HEADER_URI\fR = \fI"ftp://login:pass@grp.mirror.site/pub/grp/i686/athlon\-xp/"\fR
698 This variable only makes sense on a system that will serve as a binhost and
699 build packages for clients. It defines the URI header field for the package
700 index file which is located at ${PKGDIR}/Packages. Clients that have
701 \fBPORTAGE_BINHOST\fR properly configured will be able to fetch the index and
702 use the URI header field as a base URI for fetching binary packages. If the URI
703 header field is not defined then the client will use it's ${PORTAGE_BINHOST}
704 setting as the base URI.
706 .B PORTAGE_BINPKG_TAR_OPTS
707 This variable contains options to be passed to the tar command for creation
710 \fBPORTAGE_BUNZIP2_COMMAND\fR = \fI[bunzip2 command string]\fR
711 This variable should contain a command that is suitable for portage to call
712 for bunzip2 extraction operations.
714 \fBPORTAGE_BZIP2_COMMAND\fR = \fI[bzip2 command string]\fR
715 This variable should contain a command that is suitable for portage to call
716 for bzip2 compression operations. \fBPORTAGE_BZIP2_COMMAND\fR will also be
717 called for extraction operation, with -d appended, unless the
718 \fBPORTAGE_BUNZIP2_COMMAND\fR variable is set.
720 \fBPORTAGE_CHECKSUM_FILTER\fR = \fI[space delimited list of hash names]\fR
721 This variable may be used to filter the hash functions that are used to
722 verify integrity of files. Hash function names are case\-insensitive, and
723 the \fI*\fR and \fI\-*\fR wildcard tokens are supported.
725 Defaults to the value of *.
729 # Use all available hash functions
730 PORTAGE_CHECKSUM_FILTER="*"
731 # Use any function except whirlpool
732 PORTAGE_CHECKSUM_FILTER="* \-whirlpool"
734 PORTAGE_CHECKSUM_FILTER="\-* sha256"
737 \fBPORTAGE_COMPRESS\fR = \fI"bzip2"\fR
738 This variable contains the command used to compress documentation during the
741 \fBPORTAGE_COMPRESS_FLAGS\fR = \fI"\-9"\fR
742 This variable contains flags for the \fBPORTAGE_COMPRESS\fR command.
745 \fBPORTAGE_COMPRESS_EXCLUDE_SUFFIXES\fR = \fI"gif htm[l]? jp[e]?g pdf png"\fR
746 This variable contains a space delimited list of file suffixes for which
747 matching files are excluded when the \fBPORTAGE_COMPRESS\fR command is
748 called. Regular expressions are supported and the match is performed only
749 against the portion of the file name which follows the last period character.
751 .B PORTAGE_ELOG_CLASSES
753 .B PORTAGE_ELOG_SYSTEM
755 .B PORTAGE_ELOG_COMMAND
757 .B PORTAGE_ELOG_MAILURI
759 .B PORTAGE_ELOG_MAILFROM
761 .B PORTAGE_ELOG_MAILSUBJECT
762 Please see /usr/share/portage/config/make.conf.example for elog documentation.
764 \fBPORTAGE_FETCH_CHECKSUM_TRY_MIRRORS\fR = \fI5\fR
765 Number of mirrors to try when a downloaded file has an incorrect checksum.
767 \fBPORTAGE_FETCH_RESUME_MIN_SIZE\fR = \fI350K\fR
768 Minimum size of existing file for \fBRESUMECOMMAND\fR to be called. Files
769 smaller than this size will be removed and \fBFETCHCOMMAND\fR will be called
770 to download the file from the beginning. This is useful for helping to ensure
771 that small garbage files such as html 404 pages are properly discarded. The
772 variable should contain an integer number of bytes and may have a suffix such
776 The \fBgpg\fR(1) home directory that is used by \fBrepoman\fR(1)
777 when \fBsign\fR is in \fBFEATURES\fR.
779 Defaults to $HOME/.gnupg.
782 The \fBgpg\fR(1) key used by \fBrepoman\fR(1) to sign manifests
783 when \fBsign\fR is in \fBFEATURES\fR. In order to sign commits with
784 \fBgit\fR(1), you will need Git >=1.7.9 and your commit key will have
785 to be configured by \fI`git config user.signingkey key_id`\fR.
787 .B PORTAGE_GPG_SIGNING_COMMAND
788 The command used by \fBrepoman\fR(1) to sign manifests when \fBsign\fR is
791 \fBPORTAGE_GRPNAME\fR = \fI[group]\fR
792 Defines the groupname to use when executing in userpriv/etc... modes (i.e.
797 \fBPORTAGE_INST_GID\fR = \fI[gid]\fR
798 Defines the group id when installing files via dobin/dosbin. Useful when
799 running ebuild as yourself.
803 \fBPORTAGE_INST_UID\fR = \fI[uid]\fR
804 Defines the user id when installing files via dobin/dosbin. Useful when
805 running ebuild as yourself.
809 \fBPORTAGE_IONICE_COMMAND\fR = \fI[ionice command string]\fR
810 This variable should contain a command for portage to call in order
811 to adjust the io priority of portage and it's subprocesses. The command
812 string should contain a \\${PID} place-holder that will be substituted
813 with an integer pid. For example, a value of "ionice \-c 3 \-p \\${PID}"
814 will set idle io priority. For more information about ionice, see
815 \fBionice\fR(1). This variable is unset by default.
817 \fBPORTAGE_NICENESS\fR = \fI[number]\fR
818 The value of this variable will be added to the current nice level that
819 emerge is running at. In other words, this will not set the nice level,
820 it will increment it. For more information about nice levels and what
821 are acceptable ranges, see \fBnice\fR(1).
823 \fBPORTAGE_RO_DISTDIRS\fR = \fI[space delimited list of directories]\fR
824 When a given file does not exist in \fBDISTDIR\fR, search for the file
825 in this list of directories. Search order is from left to right. Note
826 that the current implementation works by creating a symlink inside
827 \fBDISTDIR\fR, but that may change in the future.
829 \fBPORTAGE_RSYNC_INITIAL_TIMEOUT\fR = \fIinteger\fR
830 Used by \fBemerge \-\-sync\fR as a timeout for the initial connection to an
833 Defaults to 15 seconds.
835 \fBPORTAGE_RSYNC_EXTRA_OPTS\fR = \fI[rsync options string]\fR
836 Additional rsync options to be used by \fBemerge \-\-sync\fR.
838 Defaults to no value.
840 \fBPORTAGE_RSYNC_OPTS\fR = \fI[rsync options string]\fR
841 Default rsync options to be used by \fBemerge \-\-sync\fR.
843 \fBDon't change this unless you know exactly what you're doing!\fR
845 Defaults to "\-\-recursive \-\-links \-\-safe\-links \-\-perms \-\-times
846 \-\-compress \-\-force \-\-whole\-file \-\-delete \-\-stats
847 \-\-timeout=180 \-\-exclude='/distfiles' \-\-exclude='/local'
848 \-\-exclude='/packages'"
850 \fBPORTAGE_RSYNC_RETRIES\fR = \fI[NUMBER]\fR
851 The number of times rsync should retry on failed connections before
852 giving up. If set to a negative number, then retry until all possible
853 addresses are exhausted.
857 \fBPORTAGE_SSH_OPTS\fR = \fI[list of ssh options]\fR
858 Additional ssh options to be used when portage executes ssh or sftp.
859 This variable supports use of embedded quote characters to quote
860 whitespace or special shell characters within arguments (embedded
861 quotes must be escaped in make.conf settings).
863 Defaults to no value.
865 \fBPORTAGE_SYNC_STALE\fR = \fI[NUMBER]\fR
866 Defines the number of days after the last `emerge \-\-sync` that a warning
867 message should be produced. A value of 0 will disable warnings.
871 \fBPORTAGE_TMPDIR\fR = \fI[path]\fR
872 Defines the location of the temporary build directories.
874 Defaults to /var/tmp.
876 This should not be set to point anywhere under the directory tree
877 specified by \fBPORTDIR\fR (/usr/portage by default).
879 \fBPORTAGE_USERNAME\fR = \fI[user]\fR
880 Defines the username to use when executing in userpriv/etc... modes (i.e.
885 \fBPORTAGE_WORKDIR_MODE\fR = \fI"0700"\fR
886 This variable controls permissions for \fIWORKDIR\fR (see \fBebuild\fR(5)).
888 \fBPORTAGE_XATTR_EXCLUDE\fR = \fI[space delimited list of fnmatch patterns]\fR
889 This variable may be used to exclude specific attributes from being preserved
890 when \fBxattr\fR is in \fBFEATURES\fR.
892 Defaults to "security.*" (security labels are special, see bug #461868).
894 \fBPORTDIR\fR = \fI[path]\fR
895 Defines the location of the Portage tree. This is the repository for all
896 profile information as well as all ebuilds. If you change this, you must update
897 your /etc/portage/make.profile symlink accordingly.
899 Defaults to /usr/portage.
903 Data stored inside \fBPORTDIR\fR is in peril of being overwritten or deleted by
904 the emerge \-\-sync command. The default value of
905 \fBPORTAGE_RSYNC_OPTS\fR will protect the default locations of
906 \fBDISTDIR\fR and \fBPKGDIR\fR, but users are warned that any other locations
907 inside \fBPORTDIR\fR are not necessarily safe for data storage. You should not
908 put other data (such as overlays) in your \fBPORTDIR\fB. Portage will walk
909 directory structures and may arbitrarily add invalid categories as packages.
911 \fBPORTDIR_OVERLAY\fR = \fI"[path] [different\-path] [etc...]"\fR
912 Defines the directories in which user made ebuilds may be stored and not
913 overwriten when `emerge \-\-sync` is run. This is a space delimited list of
916 Defaults to no value.
918 \fBQA_STRICT_EXECSTACK = \fI"set"\fR
919 Set this to cause portage to ignore any \fIQA_EXECSTACK\fR override
920 settings from ebuilds. See also \fBebuild\fR(5).
922 \fBQA_STRICT_WX_LOAD = \fI"set"\fR
923 Set this to cause portage to ignore any \fIQA_WX_LOAD\fR override
924 settings from ebuilds. See also \fBebuild\fR(5).
926 \fBQA_STRICT_TEXTRELS = \fI"set"\fR
927 Set this to cause portage to ignore any \fIQA_TEXTREL\fR override
928 settings from ebuilds. See also \fBebuild\fR(5).
930 \fBQA_STRICT_FLAGS_IGNORED = \fI"set"\fR
931 Set this to cause portage to ignore any \fIQA_FLAGS_IGNORED\fR override
932 settings from ebuilds. See also \fBebuild\fR(5).
934 \fBQA_STRICT_MULTILIB_PATHS = \fI"set"\fR
935 Set this to cause portage to ignore any \fIQA_MULTILIB_PATHS\fR override
936 settings from ebuilds. See also \fBebuild\fR(5).
938 \fBQA_STRICT_PRESTRIPPED = \fI"set"\fR
939 Set this to cause portage to ignore any \fIQA_PRESTRIPPED\fR override
940 settings from ebuilds. See also \fBebuild\fR(5).
943 This variable contains the command used for resuming package sources that
944 have been partially downloaded. It should be defined using the same format
945 as \fBFETCHCOMMAND\fR, and must include any additional option(s) that may
946 be necessary in order to continue a partially downloaded file located at
947 \\${DISTDIR}/\\${FILE}.
949 \fBROOT\fR = \fI[path]\fR
950 Use \fBROOT\fR to specify the target root filesystem to be used for merging
952 Typically, you should set this setting in the environment rather than in
953 \fImake.conf\fR itself. It's commonly used for creating new build
954 images. Make sure you use an absolute path. Refer to the
955 \fBCross-compilation\fR section of \fBebuild\fR(5) for information about
956 how dependencies are handled for \fBROOT\fR.
960 \fBRPMDIR\fR = \fI[path]\fR
961 Defines the location where created RPM packages will be stored.
963 Defaults to ${PORTDIR}/rpm.
965 \fBSYNC\fR = \fI[RSYNC]\fR
966 Insert your preferred rsync mirror here. This rsync server
967 is used to sync the local portage tree when `emerge \-\-sync` is run.
969 Defaults to rsync://rsync.gentoo.org/gentoo\-portage
973 (rsync|ssh)://[username@]hostname[:port]/(module|path)
976 rsync://private\-mirror.com/portage\-module
978 rsync://rsync\-user@private\-mirror.com:873/gentoo\-portage
980 ssh://ssh\-user@192.168.0.1:22/usr/portage
982 ssh://ssh\-user@192.168.0.1:22/\\${HOME}/portage\-storage
984 Note: For the ssh:// scheme, key\-based authentication might be of interest.
987 \fBUNINSTALL_IGNORE\fR = \fI[space delimited list of fnmatch patterns]\fR
988 This variable prevents uninstallation of files that match
989 specific \fBfnmatch\fR(3) patterns. In order to ignore file
990 collisions with these files at install time, the same patterns
991 can be added to the \fBCOLLISION_IGNORE\fR variable.
993 Defaults to "/lib/modules/*".
995 \fBUSE\fR = \fI[space delimited list of USE items]\fR
996 This variable contains options that control the build behavior of several
997 packages. More information in \fBebuild\fR(5). Possible USE values
998 can be found in \fI/usr/portage/profiles/use.desc\fR.
1000 \fBUSE_ORDER\fR = \fI"env:pkg:conf:defaults:pkginternal:repo:env.d"\fR
1001 Determines the precedence of layers in the incremental stacking of the USE
1002 variable. Precedence decreases from left to right such that env overrides
1003 pkg, pkg overrides conf, and so forth.
1007 Do not modify this value unless you're a developer and you know what
1008 you're doing. If you change this and something breaks, we will not help
1014 USE from the current environment variables (USE and those listed in USE_EXPAND)
1017 Per\-package USE from \fB/etc/portage/package.use\fR (see \fBportage\fR(5))
1023 USE from make.defaults and package.use in the profile
1024 (e.g. /etc/portage/make.profile/package.use) (see \fBportage\fR(5))
1027 USE from \fBebuild\fR(5) IUSE defaults
1030 USE from make.defaults and package.use in the repo's profiles/ top dir
1031 (e.g. /usr/portage/profiles/package.use) (see \fBportage\fR(5))
1034 USE from the environment variables, such as LINGUAS, defined by files in
1038 .SH "REPORTING BUGS"
1039 Please report bugs via http://bugs.gentoo.org/
1042 Daniel Robbins <drobbins@gentoo.org>
1043 Nicholas Jones <carpaski@gentoo.org>
1044 Mike Frysinger <vapier@gentoo.org>
1045 Saleem Abdulrasool <compnerd@gentoo.org>
1049 \fB/etc/make.conf\fR and \fB/etc/portage/make.conf\fR
1050 Contains variables for the build\-process and overwrites those in make.defaults.
1052 .B /usr/share/portage/config/make.globals
1053 Contains the default variables for the build\-process, you should edit \fI/etc/portage/make.conf\fR instead.
1055 .B /etc/portage/color.map
1056 Contains variables customizing colors.
1058 .B /usr/portage/profiles/use.desc
1059 Contains a list of all global USE flags.
1061 .B /usr/portage/profiles/use.local.desc
1062 Contains a list of all local USE variables.
1069 The \fI/usr/sbin/ebuild.sh\fR script.
1071 The helper apps in \fI/usr/lib/portage/bin\fR.
projects / portage.git / blob