drop support for QA_DT_HASH/QA_STRICT_DT_HASH
[portage.git] / man / make.conf.5
1 .TH "MAKE.CONF" "5" "Sep 2012" "Portage VERSION" "Portage"
2 .SH "NAME"
3 make.conf \- custom settings for Portage
4 .SH "SYNOPSIS"
5 \fB/etc/make.conf\fR and \fB/etc/portage/make.conf\fR
6 .SH "DESCRIPTION"
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
14 make.globals. If no
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.
19 .br
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:
24 export USE="\-*"
25 .br
26 In order to create per\-package environment settings, refer to
27 \fBpackage.env\fR in \fBportage\fR(5).
28 .SH "VARIABLES"
29 .TP
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.
34 .br
35 Defaults to the value of $CHOST.
36 .TP
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 
41 ~arch.
42 .br
43 Defaults to the value of $ARCH.
44 .TP
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.
53 .br
54 Defaults to the value of * -@EULA.
55 .br
56 .I Examples:
57 .nf
58 # Accept any license
59 ACCEPT_LICENSE="*"
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"
64 .fi
65 .TP
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. 
72 .br
73 Defaults to the value of *.
74 .br
75 .I Examples:
76 .nf
77 # Accept any properties
78 ACCEPT_PROPERTIES="*"
79 # Accept any properties except the "interactive" property
80 ACCEPT_PROPERTIES="* -interactive"
81 .fi
82 .TP
83 .B CBUILD
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.
87 .TP
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.
91 .br
92 Defaults to /var/tmp/ccache
93 .TP
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'.
97 .TP
98 .B CFLAGS CXXFLAGS
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.
106
107 For more information, see the \fIInvoking GCC\fR section of the gcc manual:
108 .br
109 http://gcc.gnu.org/onlinedocs/
110 .TP
111 .B CHOST
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.
114
115 For more information:
116 .br
117 http://gcc.gnu.org/onlinedocs/gcc\-4.1.1/gcc/Submodel\-Options.html
118 .br
119 http://gcc.gnu.org/onlinedocs/gcc\-3.3/gcc/Submodel\-Options.html
120 .br
121 http://gcc.gnu.org/onlinedocs/gcc\-3.2/gcc/Submodel\-Options.html
122 .br
123 http://gcc.gnu.org/onlinedocs/gcc\-2.95.3/gcc_2.html
124 .TP
125 \fBCLEAN_DELAY\fR = \fIinteger\fR
126 Determines how long the countdown delay will be after running
127 `emerge --unmerge`.
128 .br
129 Defaults to 5 seconds.
130 .TP
131 \fBCOLLISION_IGNORE\fR = \fI[space delimited list of fnmatch patterns]\fR
132 This variable allows the user to disable \fIcollision\-protect\fR and
133 \fIprotect\-owned\fR for specific \fBfnmatch\fR(3) patterns. For backward
134 compatibility, directories that are listed without a fnmatch pattern will
135 automatically have /* appended to them.
136 .br
137 Defaults to "/lib/modules/* *.py[co]".
138 .TP
139 \fBCONFIG_PROTECT\fR = \fI[space delimited list of files and/or directories]\fR
140 All files and/or directories that are defined here will have "config file protection"
141 enabled for them. See the \fBCONFIGURATION FILES\fR section
142 of \fBemerge\fR(1) for more information.
143 .TP
144 \fBCONFIG_PROTECT_MASK\fR = \fI[space delimited list of files and/or directories]\fR
145 All files and/or directories that are defined here will have "config file protection"
146 disabled for them. See the \fBCONFIGURATION FILES\fR section
147 of \fBemerge\fR(1) for more information.
148 .TP
149 .B CTARGET
150 This variable is passed by the \fIebuild scripts\fR to the \fIconfigure\fR
151 as \fI\-\-target=${CTARGET}\fR only if it is defined.
152 .TP
153 \fBDISTDIR\fR = \fI[path]\fR
154 Defines the location of your local source file repository. After packages
155 are built, it is safe to remove any and all files from this directory since
156 they will be automatically fetched on demand for a given build. If you would
157 like to selectively prune obsolete files from this directory, see
158 \fBeclean\fR(1) from the gentoolkit package.
159
160 Use the \fBPORTAGE_RO_DISTDIRS\fR variable to specify one or
161 more read-only directories containing distfiles.
162
163 Note
164 that locations under /usr/portage are not necessarily safe for data storage.
165 See the \fBPORTDIR\fR documentation for more information.
166 .br
167 Defaults to /usr/portage/distfiles.
168 .TP
169 .B DOC_SYMLINKS_DIR
170 If this variable contains a directory then symlinks to html documentation will
171 be installed into it.
172 .TP
173 .B EBEEP_IGNORE
174 Defines whether or not to ignore audible beeps when displaying important
175 informational messages.  This variable is unset by default.
176 .TP
177 .B EMERGE_DEFAULT_OPTS
178 Options to append to the end of the \fBemerge\fR(1) command line on every invocation.
179 These options will not be appended to the command line if \-\-ignore\-default\-opts
180 is specified.
181 .TP
182 .B EMERGE_LOG_DIR
183 Controls the location of emerge.log and emerge-fetch.log.
184 .br
185 Defaults to /var/log.
186 .TP
187 \fBEMERGE_WARNING_DELAY\fR = \fIinteger\fR
188 Determines how long the countdown delay will be after running
189 `emerge --unmerge` for a system package.
190 .br
191 Defaults to 10 seconds.
192 .TP
193 .B EPAUSE_IGNORE
194 Defines whether or not to ignore short pauses that occur when displaying
195 important informational messages.  This variable is unset by default.
196 If it is set to any value pauses are ignored.
197 .TP
198 \fBEXTRA_ECONF\fR = \fI[configure options string]\fR
199 Contains additional options that \fBeconf\fR will append to configure
200 script arguments (see \fBebuild\fR(5)).
201 .TP
202 \fBFEATURES\fR = \fI"sandbox"\fR
203 Defines actions portage takes by default. This is an incremental variable.
204 Most of these settings are for developer use, but some are available to
205 non-developers as well. The \fBsandbox\fR feature is very important and
206 should not be disabled by default.
207 .RS
208 .TP
209 .B assume\-digests
210 When commiting work to cvs with \fBrepoman\fR(1), assume that all existing 
211 SRC_URI digests are correct.  This feature also affects digest generation via
212 \fBebuild\fR(1) and \fBemerge\fR(1) (emerge generates digests only when the
213 \fIdigest\fR feature is enabled). Existing digests for files that do not exist
214 in ${DISTDIR} will be automatically assumed even when \fIassume\-digests\fR is
215 not enabled. If a file exists in ${DISTDIR} but its size does not match the
216 existing digest, the digest will be regenerated regardless of whether or
217 not \fIassume\-digests\fR is enabled. The \fBebuild\fR(1) \fBdigest\fR command
218 has a \fB\-\-force\fR option that can be used to force regeneration of digests.
219 .TP
220 .B binpkg\-logs
221 Keep logs from successful binary package merges. This is relevant only when
222 \fBPORT_LOGDIR\fR is set.
223 .TP
224 .B buildpkg
225 Binary packages will be created for all packages that are merged. Also see
226 \fBquickpkg\fR(1) and \fBemerge\fR(1) \fB\-\-buildpkg\fR and
227 \fB\-\-buildpkgonly\fR options.
228 .TP
229 .B buildsyspkg
230 Build binary packages for just packages in the system set.
231 .TP
232 .B candy
233 Enable a special progress indicator when \fBemerge\fR(1) is calculating
234 dependencies.
235 .TP
236 .B ccache
237 Enable portage support for the ccache package.  If the ccache dir is not 
238 present in the user's environment, then portage will default to 
239 ${PORTAGE_TMPDIR}/ccache.
240
241 \fBWarning\fR: This feature is known to cause numerous compilation failures.
242 Sometimes ccache will retain stale code objects or corrupted files, which can
243 lead to packages that cannot be emerged. If this happens (if you receive errors
244 like "File not recognized: File truncated"), try recompiling the application
245 with ccache disabled before reporting a bug. Unless you are doing development
246 work, do not enable ccache.
247 .TP
248 .B clean\-logs
249 Enable automatic execution of the command specified by the
250 PORT_LOGDIR_CLEAN variable. The default PORT_LOGDIR_CLEAN setting will
251 remove all files from PORT_LOGDIR that were last modified at least 7
252 days ago.
253 .TP
254 .B collision\-protect
255 A QA\-feature to ensure that a package doesn't overwrite files it doesn't own.
256 The \fICOLLISION_IGNORE\fR variable can be used to selectively disable this
257 feature. Also see the related \fIprotect\-owned\fR feature.
258 .TP
259 .B compress\-build\-logs
260 The causes all build logs to be compressed while they are being written.
261 Log file names have an extension that is appropriate for the compression
262 type. Currently, only \fBgzip\fR(1) compression is supported, so build
263 logs will have a '.gz' extension when this feature is enabled.
264 .TP
265 .B compressdebug
266 Compress the debug sections in the split debug files with zlib to save
267 space.  Make sure you have built both binutils and gdb with USE=zlib
268 support for this to work.  See \fBsplitdebug\fR for general split debug
269 information (upon which this feature depends).
270 .TP
271 .B compress\-index
272 If set then a compressed copy of 'Packages' index file will be written.
273 This feature is intended for Gentoo binhosts using certain webservers
274 (such as, but not limited to, Nginx with gzip_static module) to avoid
275 redundant on\-the\-fly compression.  The resulting file will be called
276 'Packages.gz' and its modification time will match that of 'Packages'.
277 .TP
278 .B config\-protect\-if\-modified
279 This causes the \fBCONFIG_PROTECT\fR behavior to be skipped for files
280 that have not been modified since they were installed. This feature is
281 enabled by default.
282 .TP
283 .B digest
284 Autogenerate digests for packages when running the
285 \fBemerge\fR(1), \fBebuild\fR(1), or \fBrepoman\fR(1) commands. If
286 the \fIassume\-digests\fR feature is also enabled then existing SRC_URI digests
287 will be reused whenever they are available.
288 .TP
289 .B distcc
290 Enable portage support for the distcc package.
291 .TP
292 .B distcc\-pump
293 Enable portage support for the distcc package with pump mode.
294 .TP
295 .B distlocks
296 Portage uses lockfiles to ensure competing instances don't clobber
297 each other's files. This feature is enabled by default but may cause
298 heartache on less intelligent remote filesystems like NFSv2 and some
299 strangely configured Samba server (oplocks off, NFS re\-export). A tool
300 /usr/lib/portage/bin/clean_locks exists to help handle lock issues
301 when a problem arises (normally due to a crash or disconnect).
302 .TP
303 .B downgrade\-backup
304 When a package is downgraded to a lower version, call \fBquickpkg\fR(1)
305 in order to create a backup of the installed version before it is
306 unmerged (if a binary package of the same version does not already
307 exist). Also see the related \fIunmerge\-backup\fR feature.
308 .TP
309 .B ebuild\-locks
310 Use locks to ensure that unsandboxed ebuild phases never execute
311 concurrently. Also see \fIparallel\-install\fR.
312 .TP
313 .B fakeroot
314 Enable fakeroot for the install and package phases when a non-root user runs
315 the \fBebuild\fR(1) command.
316 .TP
317 .B fail\-clean
318 Clean up temporary files after a build failure. This is particularly useful
319 if you have \fBPORTAGE_TMPDIR\fR on tmpfs. If this feature is enabled, you
320 probably also want to enable \fBPORT_LOGDIR\fR in order to save the build log.
321 Both the \fBebuild\fR(1) command and the \fInoclean\fR feature cause the
322 \fIfail\-clean\fR feature to be automatically disabled.
323 .TP
324 .B getbinpkg
325 Force emerges to always try to fetch files from the \fIPORTAGE_BINHOST\fR.  See 
326 \fBmake.conf\fR(5) for more information.
327 .TP
328 .B installsources
329 Install source code into /usr/src/debug/${CATEGORY}/${PF} (also see
330 \fBsplitdebug\fR). This feature works only if debugedit is installed and CFLAGS
331 is set to include debug information (such as with the \-ggdb flag).
332 .TP
333 .B keeptemp
334 Do not delete the ${T} directory after the merge process.
335 .TP
336 .B keepwork
337 Do not delete the ${WORKDIR} directory after the merge process. ${WORKDIR} can
338 then be reused since this feature disables most of the clean phase that runs
339 prior to each build. Due to lack of proper cleanup, this feature can
340 interfere with normal emerge operation and therefore it should not be left
341 enabled for more than a short period of time.
342 .TP
343 .B fixlafiles
344 Modifies .la files to not include other .la files and some other
345 fixes (order of flags, duplicated entries, ...)
346 .TP
347 .B force\-mirror
348 Only fetch files from configured mirrors, ignoring \fBSRC_URI\fR,
349 except when \fImirror\fR is in the \fBebuild\fR(5) \fBRESTRICT\fR variable.
350 .TP
351 .B force\-prefix
352 Enable prefix support for all ebuilds, regardless of EAPI, since older EAPIs
353 would otherwise be useless with prefix configurations. This brings
354 compatibility with the prefix branch of portage, which also supports EPREFIX
355 for all EAPIs (for obvious reasons).
356 .TP
357 .B lmirror
358 When \fImirror\fR is enabled in \fBFEATURES\fR, fetch files even
359 when \fImirror\fR is also in the \fBebuild\fR(5) \fBRESTRICT\fR variable.
360 Do \fBNOT\fR use \fIlmirror\fR for clients that need to override \fBRESTRICT\fR
361 when fetching from a local mirror, but instead use a "local" mirror setting
362 in \fI/etc/portage/mirrors\fR, as described in \fBportage\fR(5).
363 .TP
364 .B metadata\-transfer
365 Automatically perform a metadata transfer when `emerge \-\-sync` is run.
366 In versions of portage >=2.1.5, this feature is disabled by
367 default. When metadata\-transfer is disabled, metadata cache from the
368 ${PORTDIR}/metadata/cache/ directory will be used directly (if available)
369 and eclasses in ${PORTDIR}/eclass/ must not be modified except by
370 `emerge \-\-sync` operations since the cache validation mechanism
371 will not recognize eclass modifications. Normally, this issue only
372 pertains to users of the rsync tree since the cvs tree does not contain
373 a metadata/cache/ directory. Users of the rsync tree who want to modify
374 eclasses should use \fBPORTDIR_OVERLAY\fR in order for the cache
375 validation mechanism to work correctly.
376 .TP
377 .B mirror
378 Fetch everything in \fBSRC_URI\fR regardless of \fBUSE\fR settings,
379 except do not fetch anything when \fImirror\fR is in \fBRESTRICT\fR.
380 .TP
381 .B multilib\-strict
382 Many Makefiles assume that their libraries should go to /usr/lib, or
383 $(prefix)/lib. This assumption can cause a serious mess if /usr/lib
384 isn't a symlink to /usr/lib64. To find the bad packages, we have a
385 portage feature called \fImultilib\-strict\fR. It will prevent emerge
386 from putting 64bit libraries into anything other than (/usr)/lib64.
387 .TP
388 .B news
389 Enable GLEP 42 news support. See
390 \fIhttp://www.gentoo.org/proj/en/glep/glep-0042.html\fR.
391 .TP
392 .B noauto
393 When utilizing \fBebuild\fR(1), only run the function requested.
394 .TP
395 .B noclean
396 Do not delete the the source and temporary files after the merge process.
397 .TP
398 .B nodoc
399 Do not install doc files (/usr/share/doc).
400 .TP
401 .B noinfo
402 Do not install info pages.
403 .TP
404 .B noman
405 Do not install manpages.
406 .TP
407 .B nostrip
408 Prevents the stripping of binaries that are merged to the live filesystem.
409 .TP
410 .B notitles
411 Disables xterm titlebar updates (which contains status info).
412 .TP
413 .B parallel\-fetch
414 Fetch in the background while compiling. Run
415 `tail \-f /var/log/emerge\-fetch.log` in a
416 terminal to view parallel-fetch progress.
417 .TP
418 .B parallel\-install
419 Use finer\-grained locks when installing packages, allowing for greater
420 parallelization. For additional parallelization, disable
421 \fIebuild\-locks\fR.
422 .TP
423 .B prelink\-checksums
424 If \fBprelink\fR(8) is installed then use it to undo any prelinks on files
425 before computing checksums for merge and unmerge. This feature is
426 useful only if \fBprelink\fR(8) is installed and accurate checksums (despite
427 prelinking) are needed for some reason such as for checking the integrity of
428 installed files or because the \fIunmerge\-orphans\fR feature is disabled.
429
430 Note that normal emerging of packages from source computes the
431 checksums before things will be prelinked, so in such cases, this
432 feature isn't required either. Undoing prelinking while merging is
433 only required when using tools like \fBquickpkg\fR(1) which can cause
434 already prelinked files to be merged.
435 .TP
436 .B preserve\-libs
437 Preserve libraries when the sonames change during upgrade or downgrade.
438 Libraries are preserved only if consumers of those libraries are detected.
439 .TP
440 .B protect\-owned
441 This is identical to the \fIcollision\-protect\fR feature except that files
442 may be overwritten if they are not explicitly listed in the contents of a
443 currently installed package. This is particularly useful on systems that
444 have lots of orphan files that have been left behind by older versions
445 of portage that did not support the \fIunmerge\-orphans\fR feature. Like
446 \fIcollision\-protect\fR, the \fICOLLISION_IGNORE\fR variable can be used to
447 selectively disable this feature. It is recommended to leave either
448 \fIprotect\-owned\fR or \fIcollision\-protect\fR enabled at all times,
449 since otherwise file collisions between packages may result in files being
450 overwritten or uninstalled at inappropriate times.
451 If \fIcollision\-protect\fR is enabled then it takes precedence over
452 \fIprotect\-owned\fR. 
453 .TP
454 .B python\-trace
455 Output a verbose trace of python execution to stderr when a command's 
456 \-\-debug option is enabled.
457 .TP
458 .B sandbox
459 Enable sandbox\-ing when running \fBemerge\fR(1) and \fBebuild\fR(1).
460 .TP
461 .B sesandbox
462 Enable SELinux sandbox\-ing.  Do not toggle this \fBFEATURE\fR yourself.
463 .TP
464 .B sfperms
465 Stands for Smart Filesystem Permissions.  Before merging packages to the 
466 live filesystem, automatically search for and set permissions on setuid 
467 and setgid files.  Files that are setuid have the group and other read 
468 bits removed while files that are setgid have the other read bit removed.  
469 See also \fIsuidctl\fR below.
470 .TP
471 .B sign
472 When commiting work to cvs with \fBrepoman\fR(1), sign the Manifest with 
473 a GPG key.  Read about the \fIPORTAGE_GPG_KEY\fR variable in \fBmake.conf\fR(5).
474 .TP
475 .B skiprocheck
476 Skip write access checks on \fBDISTDIR\fR when fetching files. This is
477 useful when \fBFETCHCOMMAND\fR and \fBRESUMECOMMAND\fR are used to
478 forward fetch requests to a server that exposes \fBDISTDIR\fR as
479 a read-only NFS share. A read-only \fBDISTDIR\fR is not compatible with the
480 \fIdistlocks\fR, so it is recommended to also add "-distlocks" to
481 \fBFEATURES\fR in order to avoid warning messages that are triggered by this
482 incompatibility.
483 .TP
484 .B split\-elog
485 Store logs created by \fBPORTAGE_ELOG_SYSTEM="save"\fR in category
486 subdirectories of \fBPORT_LOGDIR/elog\fR, instead of using
487 \fBPORT_LOGDIR/elog\fR directly.
488 .TP 
489 .B split\-log
490 Store build logs in category subdirectories of \fBPORT_LOGDIR/build\fR,
491 instead of using \fBPORT_LOGDIR\fR directly.
492 .TP
493 .B splitdebug
494 Prior to stripping ELF etdyn and etexec files, the debugging info is 
495 stored for later use by various debuggers.  This feature is disabled by
496 \fBnostrip\fR.  You should also consider setting \fBcompressdebug\fR so
497 the files don't suck up a lot of space.  For installation of source code,
498 see \fBinstallsources\fR.
499 .TP
500 .B strict
501 Have portage react strongly to conditions that have the potential to be 
502 dangerous (like missing or incorrect digests for ebuilds).
503 .TP
504 .B stricter
505 Have portage react strongly to conditions that may conflict with system
506 security provisions (for example textrels, executable stack).  Read about
507 the \fIQA_STRICT_*\fR variables in \fBmake.conf\fR(5).
508 .TP
509 .B suidctl
510 Before merging packages to the live filesystem, automatically strip setuid 
511 bits from any file that is not listed in \fI/etc/portage/suidctl.conf\fR.
512 .TP
513 .B test
514 Run package\-specific tests during each merge to help make sure 
515 the package compiled properly.  See \fItest\fR in \fBebuild\fR(1) 
516 and \fIsrc_test()\fR in \fBebuild\fR(5). This feature implies the "test"
517 \fBUSE\fR flag if it is a member of \fBIUSE\fR, either explicitly or
518 implicitly (see \fBebuild\fR(5) for more information about \fBIUSE\fR).
519 The "test" \fBUSE\fR flag is also automatically disabled when the
520 "test" feature is disabled.
521 .TP
522 .B test\-fail\-continue
523 If "test" is enabled \fBFEATURES\fR and the test phase of an ebuild fails,
524 continue to execute the remaining phases as if the failure had not occurred.
525 Note that the test phase for a specific package may be disabled by masking
526 the "test" \fBUSE\fR flag in \fBpackage.use.mask\fR (see \fBportage\fR(5)).
527 .TP
528 .B unmerge\-backup
529 Call \fBquickpkg\fR(1) to create a backup of each package before it is
530 unmerged (if a binary package of the same version does not already exist).
531 Also see the related \fIdowngrade\-backup\fR feature.
532 .TP
533 .B unmerge\-logs
534 Keep logs from successful unmerge phases. This is relevant only when
535 \fBPORT_LOGDIR\fR is set.
536 .TP
537 .B unmerge\-orphans
538 If a file is not claimed by another package in the same slot and it is not
539 protected by \fICONFIG_PROTECT\fR, unmerge it even if the modification time or
540 checksum differs from the file that was originally installed.
541 .TP
542 .B unknown\-features\-filter
543 Filter out any unknown values that the FEATURES variable contains.
544 .TP
545 .B unknown\-features\-warn
546 Warn if FEATURES contains one or more unknown values.
547 .TP
548 .B userfetch
549 When portage is run as root, drop privileges to portage:portage during the
550 fetching of package sources.
551 .TP
552 .B userpriv
553 Allow portage to drop root privileges and compile packages as 
554 portage:portage without a sandbox (unless \fIusersandbox\fR is also used).
555 .TP
556 .B usersandbox
557 Enable the sandbox in the compile phase, when running without root privs (\fIuserpriv\fR).
558 .TP
559 .B usersync
560 Drop privileges to the owner of \fBPORTDIR\fR for \fBemerge(1) --sync\fR
561 operations.
562 .TP
563 .B webrsync-gpg
564 Enable GPG verification when using \fIemerge\-webrsync\fR.
565 .TP
566 .B xattr
567 Preserve extended attributes (filesystem-stored metadata) when installing
568 files (see \fBattr\fR(1)).
569 .RE
570 .TP
571 .B FETCHCOMMAND
572 This variable contains the command used for fetching package sources from
573 the internet.  It must contain the full path to the executable as well as the
574 place\-holders \\${DISTDIR}, \\${FILE} and \\${URI}.  The command should be
575 written to place the fetched file at \\${DISTDIR}/\\${FILE}.
576 Also see \fBRESUMECOMMAND\fR.
577 .TP
578 .B FFLAGS FCFLAGS
579 Use these variables to set the desired optimization/CPU instruction settings
580 for applications that you compile with a FORTRAN compiler. FFLAGS is usually
581 passed to the FORTRAN 77 compiler, and FCFLAGS to any FORTRAN compiler in
582 more modern build systems.
583
584 For more information, see the \fIInvoking GCC\fR section of the gcc manual:
585 .br
586 http://gcc.gnu.org/onlinedocs/
587 .TP
588 \fBGENTOO_MIRRORS\fR = \fI[URIs]\fR
589 Insert your space\-separated list of local mirrors here.  These
590 locations are used to download files before the ones listed in
591 the \fIebuild scripts\fR. Merging 'mirrorselect' can help.  Entries in this
592 variable that have no protocol and simply start with a '/' path separator may
593 be used to specify mounted filesystem mirrors.
594 .TP
595 \fBhttp_proxy ftp_proxy\fR = \fI[protocol://host:port]\fR
596 These vars are used if the sources must be downloaded from the
597 internet by \fBwget\fR(1).  They are only required if you use a
598 proxy server for internet access.
599 .TP
600 \fBINSTALL_MASK\fR = \fI[space delimited list of file names]\fR
601 Use this variable if you want to selectively prevent certain files from being
602 copied into your file system tree.  This does not work on symlinks, but only on
603 actual files.  Useful if you wish to filter out files like HACKING.gz and
604 TODO.gz. The \fBINSTALL_MASK\fR is processed just before a package is merged.
605 Also supported is a \fBPKG_INSTALL_MASK\fR variable that behaves exactly like
606 \fBINSTALL_MASK\fR except that it is processed just before creation of a binary
607 package.
608 .TP
609 .B LDFLAGS
610 A list of flags to pass to the compiler when the linker will be called. See
611 \fBld\fR(1) for linker flags, but don't forget that these flags will be passed
612 directly to the compiler. Thus, you must use '-Wl' to escape the flags
613 which only the linker understands (see \fBgcc\fR(1)).
614
615 \fB***warning***\fR
616 .br
617 Setting this and other *FLAGS variables arbitrarily may cause compile or
618 runtime failures. Bug reports submitted when nonstandard values are
619 enabled for these flags may be closed as INVALID.
620 .TP
621 .B MAKEOPTS
622 Use this variable if you want to use parallel make.  For example, if you
623 have a dual\-processor system, set this variable to "\-j2" or "\-j3" for 
624 enhanced build performance with many packages. Suggested settings are
625 between \fICPUs+1\fR and \fI2*CPUs+1\fR. In order to avoid
626 excess load, the \fB\-\-load\-average\fR option is recommended.
627 For more information, see \fBmake\fR(1). Also see \fBemerge\fR(1) for
628 information about analogous \fB\-\-jobs\fR and \fB\-\-load\-average\fR options.
629 .TP
630 \fBNOCOLOR\fR = \fI["true" | "false"]\fR
631 Defines if color should be disabled by default.
632 .br
633 Defaults to false.
634 .TP
635 \fBPKGDIR\fR = \fI[path]\fR
636 Defines the location where created .tbz2 binary packages will be
637 stored when the \fBemerge\fR(1) \fB\-\-buildpkg\fR option is enabled.
638 By default, a given package is stored in a subdirectory corresponding
639 to it's category. However, for backward compatibility with the layout
640 used by older versions of portage, if the \fI${PKGDIR}/All\fR directory
641 exists then all packages will be stored inside of it and symlinks to
642 the packages will be created in the category subdirectories. Note
643 that locations under /usr/portage are not necessarily safe for data storage.
644 See the \fBPORTDIR\fR documentation for more information.
645 .br
646 Defaults to /usr/portage/packages.
647 .TP
648 .B PORT_LOGDIR
649 This variable defines the directory in which per\-ebuild logs are kept.
650 Logs are created only when this is set. They are stored as
651 ${CATEGORY}:${PF}:YYYYMMDD\-HHMMSS.log in the directory specified. If the
652 directory does not exist, it will be created automatically and group permissions
653 will be applied to it.  If the directory already exists, portage will not
654 modify it's permissions.
655 .TP
656 .B PORT_LOGDIR_CLEAN
657 This variable should contain a command for portage to call in order
658 to clean PORT_LOGDIR. The command string should contain a
659 \\${PORT_LOGDIR} place\-holder that will be substituted
660 with the value of that variable. This variable will have no effect
661 unless \fBclean\-logs\fR is enabled in \fBFEATURES\fR.
662 .TP
663 \fBPORTAGE_BINHOST\fR = \fI[space delimited URI list]\fR
664 This is a list of hosts from which portage will grab prebuilt\-binary packages.
665 Each entry in the list must specify the full address of a directory
666 serving tbz2's for your system. This is only used when running with
667 the get binary pkg options are given to \fBemerge\fR.  Review \fBemerge\fR(1) 
668 for more information.  For versions of portage less that 2.1.6, this variable
669 should point to the 'All' directory on the host that creates the binary
670 packages and not to the root of the \fBPKGDIR\fR.  Starting with portage 2.1.6,
671 it should point to a directory containing a 'Packages' index file.  If
672 ${PORTAGE_BINHOST}/Packages does not exist then portage will attempt to use
673 the older protocol.
674 .TP
675 \fBPORTAGE_BINHOST_HEADER_URI\fR = \fI"ftp://login:pass@grp.mirror.site/pub/grp/i686/athlon\-xp/"\fR
676 This variable only makes sense on a system that will serve as a binhost and
677 build packages for clients.  It defines the URI header field for the package
678 index file which is located at ${PKGDIR}/Packages. Clients that have
679 \fBPORTAGE_BINHOST\fR properly configured will be able to fetch the index and
680 use the URI header field as a base URI for fetching binary packages. If the URI
681 header field is not defined then the client will use it's ${PORTAGE_BINHOST}
682 setting as the base URI.
683 .TP
684 .B PORTAGE_BINPKG_TAR_OPTS
685 This variable contains options to be passed to the tar command for creation
686 of binary packages.
687 .TP
688 \fBPORTAGE_BUNZIP2_COMMAND\fR = \fI[bunzip2 command string]\fR
689 This variable should contain a command that is suitable for portage to call
690 for bunzip2 extraction operations.
691 .TP
692 \fBPORTAGE_BZIP2_COMMAND\fR = \fI[bzip2 command string]\fR
693 This variable should contain a command that is suitable for portage to call
694 for bzip2 compression operations. \fBPORTAGE_BZIP2_COMMAND\fR will also be
695 called for extraction operation, with -d appended, unless the
696 \fBPORTAGE_BUNZIP2_COMMAND\fR variable is set.
697 .TP
698 \fBPORTAGE_CHECKSUM_FILTER\fR = \fI[space delimited list of hash names]\fR
699 This variable may be used to filter the hash functions that are used to
700 verify integrity of files. Hash function names are case\-insensitive, and
701 the \fI*\fR and \fI\-*\fR wildcard tokens are supported.
702 .br
703 Defaults to the value of *.
704 .br
705 .I Examples:
706 .nf
707 # Use all available hash functions
708 PORTAGE_CHECKSUM_FILTER="*"
709 # Use any function except whirlpool
710 PORTAGE_CHECKSUM_FILTER="* \-whirlpool"
711 # Only use sha256
712 PORTAGE_CHECKSUM_FILTER="\-* sha256"
713 .fi
714 .TP
715 \fBPORTAGE_COMPRESS\fR = \fI"bzip2"\fR
716 This variable contains the command used to compress documentation during the
717 install phase.
718 .TP
719 \fBPORTAGE_COMPRESS_FLAGS\fR = \fI"\-9"\fR
720 This variable contains flags for the \fBPORTAGE_COMPRESS\fR command.
721 .TP
722 .TP
723 \fBPORTAGE_COMPRESS_EXCLUDE_SUFFIXES\fR = \fI"gif htm[l]? jp[e]?g pdf png"\fR
724 This variable contains a space delimited list of file suffixes for which
725 matching files are excluded when the \fBPORTAGE_COMPRESS\fR command is
726 called. Regular expressions are supported and the match is performed only
727 against the portion of the file name which follows the last period character.
728 .TP
729 .B PORTAGE_ELOG_CLASSES
730 .TP
731 .B PORTAGE_ELOG_SYSTEM
732 .TP
733 .B PORTAGE_ELOG_COMMAND
734 .TP
735 .B PORTAGE_ELOG_MAILURI
736 .TP
737 .B PORTAGE_ELOG_MAILFROM
738 .TP
739 .B PORTAGE_ELOG_MAILSUBJECT
740 Please see /usr/share/portage/config/make.conf.example for elog documentation.
741 .TP
742 \fBPORTAGE_FETCH_CHECKSUM_TRY_MIRRORS\fR = \fI5\fR
743 Number of mirrors to try when a downloaded file has an incorrect checksum.
744 .TP
745 \fBPORTAGE_FETCH_RESUME_MIN_SIZE\fR = \fI350K\fR
746 Minimum size of existing file for \fBRESUMECOMMAND\fR to be called. Files
747 smaller than this size will be removed and \fBFETCHCOMMAND\fR will be called
748 to download the file from the beginning. This is useful for helping to ensure
749 that small garbage files such as html 404 pages are properly discarded. The
750 variable should contain an integer number of bytes and may have a suffix such
751 as K, M, or G.
752 .TP
753 .B PORTAGE_GPG_DIR
754 The \fBgpg\fR(1) home directory that is used by \fBrepoman\fR(1)
755 when \fBsign\fR is in \fBFEATURES\fR.
756 .br
757 Defaults to $HOME/.gnupg.
758 .TP
759 .B PORTAGE_GPG_KEY
760 The \fBgpg\fR(1) key used by \fBrepoman\fR(1) to sign manifests
761 when \fBsign\fR is in \fBFEATURES\fR. In order to sign commits with
762 \fBgit\fR(1), you will need Git >=1.7.9 and your commit key will have
763 to be configured by \fI`git config user.signingkey key_id`\fR.
764 .TP
765 .B PORTAGE_GPG_SIGNING_COMMAND
766 The command used by \fBrepoman\fR(1) to sign manifests when \fBsign\fR is
767 in \fBFEATURES\fR.
768 .TP
769 \fBPORTAGE_GRPNAME\fR = \fI[group]\fR
770 Defines the groupname to use when executing in userpriv/etc... modes (i.e.
771 non-root).
772 .br
773 Defaults to portage.
774 .TP
775 \fBPORTAGE_INST_GID\fR = \fI[gid]\fR
776 Defines the group id when installing files via dobin/dosbin.  Useful when
777 running ebuild as yourself.
778 .br
779 Defaults to 0.
780 .TP
781 \fBPORTAGE_INST_UID\fR = \fI[uid]\fR
782 Defines the user id when installing files via dobin/dosbin.  Useful when
783 running ebuild as yourself.
784 .br
785 Defaults to 0.
786 .TP
787 \fBPORTAGE_IONICE_COMMAND\fR = \fI[ionice command string]\fR
788 This variable should contain a command for portage to call in order
789 to adjust the io priority of portage and it's subprocesses. The command
790 string should contain a \\${PID} place-holder that will be substituted
791 with an integer pid. For example, a value of "ionice \-c 3 \-p \\${PID}"
792 will set idle io priority. For more information about ionice, see
793 \fBionice\fR(1). This variable is unset by default.
794 .TP
795 \fBPORTAGE_NICENESS\fR = \fI[number]\fR
796 The value of this variable will be added to the current nice level that
797 emerge is running at.  In other words, this will not set the nice level,
798 it will increment it.  For more information about nice levels and what
799 are acceptable ranges, see \fBnice\fR(1).
800 .TP
801 \fBPORTAGE_RO_DISTDIRS\fR = \fI[space delimited list of directories]\fR
802 When a given file does not exist in \fBDISTDIR\fR, search for the file
803 in this list of directories. Search order is from left to right. Note
804 that the current implementation works by creating a symlink inside
805 \fBDISTDIR\fR, but that may change in the future.
806 .TP
807 \fBPORTAGE_RSYNC_INITIAL_TIMEOUT\fR = \fIinteger\fR
808 Used by \fBemerge \-\-sync\fR as a timeout for the initial connection to an
809 rsync server.
810 .br
811 Defaults to 15 seconds.
812 .TP
813 \fBPORTAGE_RSYNC_EXTRA_OPTS\fR = \fI[rsync options string]\fR
814 Additional rsync options to be used by \fBemerge \-\-sync\fR.
815 .br
816 Defaults to no value.
817 .TP
818 \fBPORTAGE_RSYNC_OPTS\fR = \fI[rsync options string]\fR
819 Default rsync options to be used by \fBemerge \-\-sync\fR. 
820 .br
821 \fBDon't change this unless you know exactly what you're doing!\fR
822 .br
823 Defaults to "\-\-recursive \-\-links \-\-safe\-links \-\-perms \-\-times
824 \-\-compress \-\-force \-\-whole\-file \-\-delete \-\-stats
825 \-\-timeout=180 \-\-exclude='/distfiles' \-\-exclude='/local'
826 \-\-exclude='/packages'"
827 .TP
828 \fBPORTAGE_RSYNC_RETRIES\fR = \fI[NUMBER]\fR
829 The number of times rsync should retry on failed connections before
830 giving up. If set to a negative number, then retry until all possible
831 addresses are exhausted.
832 .br
833 Defaults to -1.
834 .TP
835 \fBPORTAGE_SYNC_STALE\fR = \fI[NUMBER]\fR
836 Defines the number of days after the last `emerge \-\-sync` that a warning
837 message should be produced. A value of 0 will disable warnings.
838 .br
839 Defaults to 30.
840 .TP
841 \fBPORTAGE_TMPDIR\fR = \fI[path]\fR
842 Defines the location of the temporary build directories.
843 .br
844 Defaults to /var/tmp.
845
846 This should not be set to point anywhere under the directory tree
847 specified by \fBPORTDIR\fR (/usr/portage by default).
848 .TP
849 \fBPORTAGE_USERNAME\fR = \fI[user]\fR
850 Defines the username to use when executing in userpriv/etc... modes (i.e.
851 non-root).
852 .br
853 Defaults to portage.
854 .TP
855 \fBPORTAGE_WORKDIR_MODE\fR = \fI"0700"\fR
856 This variable controls permissions for \fIWORKDIR\fR (see \fBebuild\fR(5)).
857 .TP
858 \fBPORTDIR\fR = \fI[path]\fR
859 Defines the location of the Portage tree. This is the repository for all
860 profile information as well as all ebuilds. If you change this, you must update
861 your /etc/portage/make.profile symlink accordingly.
862 .br
863 Defaults to /usr/portage. 
864 .br
865 \fB***Warning***\fR
866 .br
867 Data stored inside \fBPORTDIR\fR is in peril of being overwritten or deleted by
868 the emerge \-\-sync command. The default value of
869 \fBPORTAGE_RSYNC_OPTS\fR will protect the default locations of
870 \fBDISTDIR\fR and \fBPKGDIR\fR, but users are warned that any other locations
871 inside \fBPORTDIR\fR are not necessarily safe for data storage.  You should not 
872 put other data (such as overlays) in your \fBPORTDIR\fB.  Portage will walk 
873 directory structures and may arbitrarily add invalid categories as packages.
874 .TP
875 \fBPORTDIR_OVERLAY\fR = \fI"[path] [different\-path] [etc...]"\fR
876 Defines the directories in which user made ebuilds may be stored and not 
877 overwriten when `emerge \-\-sync` is run.  This is a space delimited list of 
878 directories.
879 .br
880 Defaults to no value.
881 .TP
882 \fBQA_STRICT_EXECSTACK = \fI"set"\fR
883 Set this to cause portage to ignore any \fIQA_EXECSTACK\fR override
884 settings from ebuilds.  See also \fBebuild\fR(5).
885 .TP
886 \fBQA_STRICT_WX_LOAD = \fI"set"\fR
887 Set this to cause portage to ignore any \fIQA_WX_LOAD\fR override
888 settings from ebuilds.  See also \fBebuild\fR(5).
889 .TP
890 \fBQA_STRICT_TEXTRELS = \fI"set"\fR
891 Set this to cause portage to ignore any \fIQA_TEXTREL\fR override
892 settings from ebuilds.  See also \fBebuild\fR(5).
893 .TP
894 \fBQA_STRICT_FLAGS_IGNORED = \fI"set"\fR
895 Set this to cause portage to ignore any \fIQA_FLAGS_IGNORED\fR override
896 settings from ebuilds.  See also \fBebuild\fR(5).
897 .TP
898 \fBQA_STRICT_PRESTRIPPED = \fI"set"\fR
899 Set this to cause portage to ignore any \fIQA_PRESTRIPPED\fR override
900 settings from ebuilds.  See also \fBebuild\fR(5).
901 .TP
902 .B RESUMECOMMAND
903 This variable contains the command used for resuming package sources that
904 have been partially downloaded.  It should be defined using the same format
905 as \fBFETCHCOMMAND\fR, and must include any additional option(s) that may
906 be necessary in order to continue a partially downloaded file located at
907 \\${DISTDIR}/\\${FILE}.
908 .TP
909 \fBROOT\fR = \fI[path]\fR
910 Use \fBROOT\fR to specify the target root filesystem to be used for merging 
911 packages or ebuilds.  All \fBRDEPEND\fR and \fBPDEPEND\fR will be installed 
912 into \fBROOT\fR while all \fBDEPEND\fR will be still be installed into /.  
913 Typically, you should set this setting in the environment rather than in 
914 \fI/etc/make.conf\fR itself.  It's commonly used for creating new build 
915 images.  Make sure you use an absolute path.
916 .br
917 Defaults to /.
918 .TP
919 \fBRPMDIR\fR = \fI[path]\fR
920 Defines the location where created RPM packages will be stored.
921 .br
922 Defaults to ${PORTDIR}/rpm.
923 .TP
924 \fBSYNC\fR = \fI[RSYNC]\fR
925 Insert your preferred rsync mirror here.  This rsync server
926 is used to sync the local portage tree when `emerge \-\-sync` is run.
927 .br
928 Defaults to rsync://rsync.gentoo.org/gentoo\-portage
929 .TP
930 \fBUNINSTALL_IGNORE\fR = \fI[space delimited list of fnmatch patterns]\fR
931 This variable prevents uninstallation of files that match
932 specific \fBfnmatch\fR(3) patterns. In order to ignore file
933 collisions with these files at install time, the same patterns
934 can be added to the \fBCOLLISION_IGNORE\fR variable.
935 .br
936 Defaults to "/lib/modules/*".
937 .TP
938 \fBUSE\fR = \fI[space delimited list of USE items]\fR
939 This variable contains options that control the build behavior of several
940 packages.  More information in \fBebuild\fR(5).  Possible USE values
941 can be found in \fI/usr/portage/profiles/use.desc\fR.
942 .TP
943 \fBUSE_ORDER\fR = \fI"env:pkg:conf:defaults:pkginternal:repo:env.d"\fR
944 Determines the precedence of layers in the incremental stacking of the USE
945 variable. Precedence decreases from left to right such that env overrides
946 pkg, pkg overrides conf, and so forth.
947
948 .B ***warning***
949 .br
950 Do not modify this value unless you're a developer and you know what
951 you're doing. If you change this and something breaks, we will not help
952 you fix it.
953 .br
954 .RS
955 .TP
956 .B env
957 USE from the current environment variables (USE and those listed in USE_EXPAND)
958 .TP
959 .B pkg
960 Per\-package USE from \fB/etc/portage/package.use\fR (see \fBportage\fR(5))
961 .TP
962 .B conf
963 USE from make.conf
964 .TP
965 .B defaults
966 USE from make.defaults and package.use in the profile
967 (e.g. /etc/portage/make.profile/package.use) (see \fBportage\fR(5))
968 .TP
969 .B pkginternal
970 USE from \fBebuild\fR(5) IUSE defaults
971 .TP
972 .B repo
973 USE from make.defaults and package.use in the repo's profiles/ top dir
974 (e.g. /usr/portage/profiles/package.use) (see \fBportage\fR(5))
975 .TP
976 .B env.d
977 USE from the environment variables, such as LINGUAS, defined by files in
978 \fI/etc/env.d/\fR
979 .RE
980
981 .SH "REPORTING BUGS"
982 Please report bugs via http://bugs.gentoo.org/
983 .SH "AUTHORS"
984 .nf
985 Daniel Robbins <drobbins@gentoo.org>
986 Nicholas Jones <carpaski@gentoo.org>
987 Mike Frysinger <vapier@gentoo.org>
988 Saleem Abdulrasool <compnerd@gentoo.org>
989 .fi
990 .SH "FILES"
991 .TP
992 \fB/etc/make.conf\fR and \fB/etc/portage/make.conf\fR
993 Contains variables for the build\-process and overwrites those in make.defaults.
994 .TP
995 .B /usr/share/portage/config/make.globals
996 Contains the default variables for the build\-process, you should edit \fI/etc/make.conf\fR instead.
997 .TP
998 .B /etc/portage/color.map
999 Contains variables customizing colors.
1000 .TP
1001 .B /usr/portage/profiles/use.desc
1002 Contains a list of all global USE flags.
1003 .TP
1004 .B /usr/portage/profiles/use.local.desc
1005 Contains a list of all local USE variables.
1006 .SH "SEE ALSO"
1007 .BR emerge (1),
1008 .BR portage (5),
1009 .BR ebuild (1),
1010 .BR ebuild (5)
1011 .TP
1012 The \fI/usr/sbin/ebuild.sh\fR script. 
1013 .TP
1014 The helper apps in \fI/usr/lib/portage/bin\fR.