make.conf.5: warn about PORTAGE_TMPDIR in PORTDIR
[portage.git] / man / make.conf.5
1 .TH "MAKE.CONF" "5" "Jul 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/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 parse\-eapi\-ebuild\-head
424 Parse \fBEAPI\fR from the head of the ebuild as specified in PMS section
425 7.3.1, and treat non\-conformant ebuilds as invalid. This feature is
426 enabled by default, and will soon become enabled unconditionally.
427 .TP
428 .B prelink\-checksums
429 If \fBprelink\fR(8) is installed then use it to undo any prelinks on files
430 before computing checksums for merge and unmerge. This feature is
431 useful only if \fBprelink\fR(8) is installed and accurate checksums (despite
432 prelinking) are needed for some reason such as for checking the integrity of
433 installed files or because the \fIunmerge\-orphans\fR feature is disabled.
434
435 Note that normal emerging of packages from source computes the
436 checksums before things will be prelinked, so in such cases, this
437 feature isn't required either. Undoing prelinking while merging is
438 only required when using tools like \fBquickpkg\fR(1) which can cause
439 already prelinked files to be merged.
440 .TP
441 .B preserve\-libs
442 Preserve libraries when the sonames change during upgrade or downgrade.
443 Libraries are preserved only if consumers of those libraries are detected.
444 .TP
445 .B protect\-owned
446 This is identical to the \fIcollision\-protect\fR feature except that files
447 may be overwritten if they are not explicitly listed in the contents of a
448 currently installed package. This is particularly useful on systems that
449 have lots of orphan files that have been left behind by older versions
450 of portage that did not support the \fIunmerge\-orphans\fR feature. Like
451 \fIcollision\-protect\fR, the \fICOLLISION_IGNORE\fR variable can be used to
452 selectively disable this feature. It is recommended to leave either
453 \fIprotect\-owned\fR or \fIcollision\-protect\fR enabled at all times,
454 since otherwise file collisions between packages may result in files being
455 overwritten or uninstalled at inappropriate times.
456 If \fIcollision\-protect\fR is enabled then it takes precedence over
457 \fIprotect\-owned\fR. 
458 .TP
459 .B python\-trace
460 Output a verbose trace of python execution to stderr when a command's 
461 \-\-debug option is enabled.
462 .TP
463 .B sandbox
464 Enable sandbox\-ing when running \fBemerge\fR(1) and \fBebuild\fR(1).
465 .TP
466 .B sesandbox
467 Enable SELinux sandbox\-ing.  Do not toggle this \fBFEATURE\fR yourself.
468 .TP
469 .B sfperms
470 Stands for Smart Filesystem Permissions.  Before merging packages to the 
471 live filesystem, automatically search for and set permissions on setuid 
472 and setgid files.  Files that are setuid have the group and other read 
473 bits removed while files that are setgid have the other read bit removed.  
474 See also \fIsuidctl\fR below.
475 .TP
476 .B sign
477 When commiting work to cvs with \fBrepoman\fR(1), sign the Manifest with 
478 a GPG key.  Read about the \fIPORTAGE_GPG_KEY\fR variable in \fBmake.conf\fR(5).
479 .TP
480 .B skiprocheck
481 Skip write access checks on \fBDISTDIR\fR when fetching files. This is
482 useful when \fBFETCHCOMMAND\fR and \fBRESUMECOMMAND\fR are used to
483 forward fetch requests to a server that exposes \fBDISTDIR\fR as
484 a read-only NFS share. A read-only \fBDISTDIR\fR is not compatible with the
485 \fIdistlocks\fR, so it is recommended to also add "-distlocks" to
486 \fBFEATURES\fR in order to avoid warning messages that are triggered by this
487 incompatibility.
488 .TP
489 .B split\-elog
490 Store logs created by \fBPORTAGE_ELOG_SYSTEM="save"\fR in category
491 subdirectories of \fBPORT_LOGDIR/elog\fR, instead of using
492 \fBPORT_LOGDIR/elog\fR directly.
493 .TP 
494 .B split\-log
495 Store build logs in category subdirectories of \fBPORT_LOGDIR/build\fR,
496 instead of using \fBPORT_LOGDIR\fR directly.
497 .TP
498 .B splitdebug
499 Prior to stripping ELF etdyn and etexec files, the debugging info is 
500 stored for later use by various debuggers.  This feature is disabled by
501 \fBnostrip\fR.  You should also consider setting \fBcompressdebug\fR so
502 the files don't suck up a lot of space.  For installation of source code,
503 see \fBinstallsources\fR.
504 .TP
505 .B strict
506 Have portage react strongly to conditions that have the potential to be 
507 dangerous (like missing or incorrect digests for ebuilds).
508 .TP
509 .B stricter
510 Have portage react strongly to conditions that may conflict with system
511 security provisions (for example textrels, executable stack).  Read about
512 the \fIQA_STRICT_*\fR variables in \fBmake.conf\fR(5).
513 .TP
514 .B suidctl
515 Before merging packages to the live filesystem, automatically strip setuid 
516 bits from any file that is not listed in \fI/etc/portage/suidctl.conf\fR.
517 .TP
518 .B test
519 Run package\-specific tests during each merge to help make sure 
520 the package compiled properly.  See \fItest\fR in \fBebuild\fR(1) 
521 and \fIsrc_test()\fR in \fBebuild\fR(5). This feature implies the "test"
522 \fBUSE\fR flag.
523 .TP
524 .B test\-fail\-continue
525 If "test" is enabled \fBFEATURES\fR and the test phase of an ebuild fails,
526 continue to execute the remaining phases as if the failure had not occurred.
527 Note that the test phase for a specific package may be disabled by masking
528 the "test" \fBUSE\fR flag in \fBpackage.use.mask\fR (see \fBportage\fR(5)).
529 .TP
530 .B unmerge\-backup
531 Call \fBquickpkg\fR(1) to create a backup of each package before it is
532 unmerged (if a binary package of the same version does not already exist).
533 Also see the related \fIdowngrade\-backup\fR feature.
534 .TP
535 .B unmerge\-logs
536 Keep logs from successful unmerge phases. This is relevant only when
537 \fBPORT_LOGDIR\fR is set.
538 .TP
539 .B unmerge\-orphans
540 If a file is not claimed by another package in the same slot and it is not
541 protected by \fICONFIG_PROTECT\fR, unmerge it even if the modification time or
542 checksum differs from the file that was originally installed.
543 .TP
544 .B unknown\-features\-filter
545 Filter out any unknown values that the FEATURES variable contains.
546 .TP
547 .B unknown\-features\-warn
548 Warn if FEATURES contains one or more unknown values.
549 .TP
550 .B userfetch
551 When portage is run as root, drop privileges to portage:portage during the
552 fetching of package sources.
553 .TP
554 .B userpriv
555 Allow portage to drop root privileges and compile packages as 
556 portage:portage without a sandbox (unless \fIusersandbox\fR is also used).
557 .TP
558 .B usersandbox
559 Enable the sandbox in the compile phase, when running without root privs (\fIuserpriv\fR).
560 .TP
561 .B usersync
562 Drop privileges to the owner of \fBPORTDIR\fR for \fBemerge(1) --sync\fR
563 operations.
564 .TP
565 .B webrsync-gpg
566 Enable GPG verification when using \fIemerge\-webrsync\fR.
567 .TP
568 .B xattr
569 Preserve extended attributes (filesystem-stored metadata) when installing
570 files (see \fBattr\fR(1)).
571 .RE
572 .TP
573 .B FETCHCOMMAND
574 This variable contains the command used for fetching package sources from
575 the internet.  It must contain the full path to the executable as well as the
576 place\-holders \\${DISTDIR}, \\${FILE} and \\${URI}.  The command should be
577 written to place the fetched file at \\${DISTDIR}/\\${FILE}.
578 Also see \fBRESUMECOMMAND\fR.
579 .TP
580 .B FFLAGS FCFLAGS
581 Use these variables to set the desired optimization/CPU instruction settings
582 for applications that you compile with a FORTRAN compiler. FFLAGS is usually
583 passed to the FORTRAN 77 compiler, and FCFLAGS to any FORTRAN compiler in
584 more modern build systems.
585
586 For more information, see the \fIInvoking GCC\fR section of the gcc manual:
587 .br
588 http://gcc.gnu.org/onlinedocs/
589 .TP
590 \fBGENTOO_MIRRORS\fR = \fI[URIs]\fR
591 Insert your space\-separated list of local mirrors here.  These
592 locations are used to download files before the ones listed in
593 the \fIebuild scripts\fR. Merging 'mirrorselect' can help.  Entries in this
594 variable that have no protocol and simply start with a '/' path separator may
595 be used to specify mounted filesystem mirrors.
596 .TP
597 \fBhttp_proxy ftp_proxy\fR = \fI[protocol://host:port]\fR
598 These vars are used if the sources must be downloaded from the
599 internet by \fBwget\fR(1).  They are only required if you use a
600 proxy server for internet access.
601 .TP
602 \fBINSTALL_MASK\fR = \fI[space delimited list of file names]\fR
603 Use this variable if you want to selectively prevent certain files from being
604 copied into your file system tree.  This does not work on symlinks, but only on
605 actual files.  Useful if you wish to filter out files like HACKING.gz and
606 TODO.gz. The \fBINSTALL_MASK\fR is processed just before a package is merged.
607 Also supported is a \fBPKG_INSTALL_MASK\fR variable that behaves exactly like
608 \fBINSTALL_MASK\fR except that it is processed just before creation of a binary
609 package.
610 .TP
611 .B LDFLAGS
612 A list of flags to pass to the compiler when the linker will be called. See
613 \fBld\fR(1) for linker flags, but don't forget that these flags will be passed
614 directly to the compiler. Thus, you must use '-Wl' to escape the flags
615 which only the linker understands (see \fBgcc\fR(1)).
616
617 \fB***warning***\fR
618 .br
619 Setting this and other *FLAGS variables arbitrarily may cause compile or
620 runtime failures. Bug reports submitted when nonstandard values are
621 enabled for these flags may be closed as INVALID.
622 .TP
623 .B MAKEOPTS
624 Use this variable if you want to use parallel make.  For example, if you
625 have a dual\-processor system, set this variable to "\-j2" or "\-j3" for 
626 enhanced build performance with many packages. Suggested settings are
627 between \fICPUs+1\fR and \fI2*CPUs+1\fR. In order to avoid
628 excess load, the \fB\-\-load\-average\fR option is recommended.
629 For more information, see \fBmake\fR(1). Also see \fBemerge\fR(1) for
630 information about analogous \fB\-\-jobs\fR and \fB\-\-load\-average\fR options.
631 .TP
632 \fBNOCOLOR\fR = \fI["true" | "false"]\fR
633 Defines if color should be disabled by default.
634 .br
635 Defaults to false.
636 .TP
637 \fBPKGDIR\fR = \fI[path]\fR
638 Defines the location where created .tbz2 binary packages will be
639 stored when the \fBemerge\fR(1) \fB\-\-buildpkg\fR option is enabled.
640 By default, a given package is stored in a subdirectory corresponding
641 to it's category. However, for backward compatibility with the layout
642 used by older versions of portage, if the \fI${PKGDIR}/All\fR directory
643 exists then all packages will be stored inside of it and symlinks to
644 the packages will be created in the category subdirectories. Note
645 that locations under /usr/portage are not necessarily safe for data storage.
646 See the \fBPORTDIR\fR documentation for more information.
647 .br
648 Defaults to /usr/portage/packages.
649 .TP
650 .B PORT_LOGDIR
651 This variable defines the directory in which per\-ebuild logs are kept.
652 Logs are created only when this is set. They are stored as
653 ${CATEGORY}:${PF}:YYYYMMDD\-HHMMSS.log in the directory specified. If the
654 directory does not exist, it will be created automatically and group permissions
655 will be applied to it.  If the directory already exists, portage will not
656 modify it's permissions.
657 .TP
658 .B PORT_LOGDIR_CLEAN
659 This variable should contain a command for portage to call in order
660 to clean PORT_LOGDIR. The command string should contain a
661 \\${PORT_LOGDIR} place\-holder that will be substituted
662 with the value of that variable. This variable will have no effect
663 unless \fBclean\-logs\fR is enabled in \fBFEATURES\fR.
664 .TP
665 \fBPORTAGE_BINHOST\fR = \fI[space delimited URI list]\fR
666 This is a list of hosts from which portage will grab prebuilt\-binary packages.
667 Each entry in the list must specify the full address of a directory
668 serving tbz2's for your system. This is only used when running with
669 the get binary pkg options are given to \fBemerge\fR.  Review \fBemerge\fR(1) 
670 for more information.  For versions of portage less that 2.1.6, this variable
671 should point to the 'All' directory on the host that creates the binary
672 packages and not to the root of the \fBPKGDIR\fR.  Starting with portage 2.1.6,
673 it should point to a directory containing a 'Packages' index file.  If
674 ${PORTAGE_BINHOST}/Packages does not exist then portage will attempt to use
675 the older protocol.
676 .TP
677 \fBPORTAGE_BINHOST_HEADER_URI\fR = \fI"ftp://login:pass@grp.mirror.site/pub/grp/i686/athlon\-xp/"\fR
678 This variable only makes sense on a system that will serve as a binhost and
679 build packages for clients.  It defines the URI header field for the package
680 index file which is located at ${PKGDIR}/Packages. Clients that have
681 \fBPORTAGE_BINHOST\fR properly configured will be able to fetch the index and
682 use the URI header field as a base URI for fetching binary packages. If the URI
683 header field is not defined then the client will use it's ${PORTAGE_BINHOST}
684 setting as the base URI.
685 .TP
686 .B PORTAGE_BINPKG_TAR_OPTS
687 This variable contains options to be passed to the tar command for creation
688 of binary packages.
689 .TP
690 \fBPORTAGE_BUNZIP2_COMMAND\fR = \fI[bunzip2 command string]\fR
691 This variable should contain a command that is suitable for portage to call
692 for bunzip2 extraction operations.
693 .TP
694 \fBPORTAGE_BZIP2_COMMAND\fR = \fI[bzip2 command string]\fR
695 This variable should contain a command that is suitable for portage to call
696 for bzip2 compression operations. \fBPORTAGE_BZIP2_COMMAND\fR will also be
697 called for extraction operation, with -d appended, unless the
698 \fBPORTAGE_BUNZIP2_COMMAND\fR variable is set.
699 .TP
700 \fBPORTAGE_COMPRESS\fR = \fI"bzip2"\fR
701 This variable contains the command used to compress documentation during the
702 install phase.
703 .TP
704 \fBPORTAGE_COMPRESS_FLAGS\fR = \fI"\-9"\fR
705 This variable contains flags for the \fBPORTAGE_COMPRESS\fR command.
706 .TP
707 .TP
708 \fBPORTAGE_COMPRESS_EXCLUDE_SUFFIXES\fR = \fI"gif htm[l]? jp[e]?g pdf png"\fR
709 This variable contains a space delimited list of file suffixes for which
710 matching files are excluded when the \fBPORTAGE_COMPRESS\fR command is
711 called. Regular expressions are supported and the match is performed only
712 against the portion of the file name which follows the last period character.
713 .TP
714 .B PORTAGE_ELOG_CLASSES
715 .TP
716 .B PORTAGE_ELOG_SYSTEM
717 .TP
718 .B PORTAGE_ELOG_COMMAND
719 .TP
720 .B PORTAGE_ELOG_MAILURI
721 .TP
722 .B PORTAGE_ELOG_MAILFROM
723 .TP
724 .B PORTAGE_ELOG_MAILSUBJECT
725 Please see /usr/share/portage/config/make.conf.example for elog documentation.
726 .TP
727 \fBPORTAGE_FETCH_CHECKSUM_TRY_MIRRORS\fR = \fI5\fR
728 Number of mirrors to try when a downloaded file has an incorrect checksum.
729 .TP
730 \fBPORTAGE_FETCH_RESUME_MIN_SIZE\fR = \fI350K\fR
731 Minimum size of existing file for \fBRESUMECOMMAND\fR to be called. Files
732 smaller than this size will be removed and \fBFETCHCOMMAND\fR will be called
733 to download the file from the beginning. This is useful for helping to ensure
734 that small garbage files such as html 404 pages are properly discarded. The
735 variable should contain an integer number of bytes and may have a suffix such
736 as K, M, or G.
737 .TP
738 .B PORTAGE_GPG_DIR
739 The \fBgpg\fR(1) home directory that is used by \fBrepoman\fR(1)
740 when \fBsign\fR is in \fBFEATURES\fR.
741 .br
742 Defaults to $HOME/.gnupg.
743 .TP
744 .B PORTAGE_GPG_KEY
745 The \fBgpg\fR(1) key used by \fBrepoman\fR(1) to sign manifests
746 when \fBsign\fR is in \fBFEATURES\fR. In order to sign commits with
747 \fBgit\fR(1), you will need Git >=1.7.9 and your commit key will have
748 to be configured by \fI`git config user.signingkey key_id`\fR.
749 .TP
750 .B PORTAGE_GPG_SIGNING_COMMAND
751 The command used by \fBrepoman\fR(1) to sign manifests when \fBsign\fR is
752 in \fBFEATURES\fR.
753 .TP
754 \fBPORTAGE_GRPNAME\fR = \fI[group]\fR
755 Defines the groupname to use when executing in userpriv/etc... modes (i.e.
756 non-root).
757 .br
758 Defaults to portage.
759 .TP
760 \fBPORTAGE_INST_GID\fR = \fI[gid]\fR
761 Defines the group id when installing files via dobin/dosbin.  Useful when
762 running ebuild as yourself.
763 .br
764 Defaults to 0.
765 .TP
766 \fBPORTAGE_INST_UID\fR = \fI[uid]\fR
767 Defines the user id when installing files via dobin/dosbin.  Useful when
768 running ebuild as yourself.
769 .br
770 Defaults to 0.
771 .TP
772 \fBPORTAGE_IONICE_COMMAND\fR = \fI[ionice command string]\fR
773 This variable should contain a command for portage to call in order
774 to adjust the io priority of portage and it's subprocesses. The command
775 string should contain a \\${PID} place-holder that will be substituted
776 with an integer pid. For example, a value of "ionice \-c 3 \-p \\${PID}"
777 will set idle io priority. For more information about ionice, see
778 \fBionice\fR(1). This variable is unset by default.
779 .TP
780 \fBPORTAGE_NICENESS\fR = \fI[number]\fR
781 The value of this variable will be added to the current nice level that
782 emerge is running at.  In other words, this will not set the nice level,
783 it will increment it.  For more information about nice levels and what
784 are acceptable ranges, see \fBnice\fR(1).
785 .TP
786 \fBPORTAGE_RO_DISTDIRS\fR = \fI[space delimited list of directories]\fR
787 When a given file does not exist in \fBDISTDIR\fR, search for the file
788 in this list of directories. Search order is from left to right. Note
789 that the current implementation works by creating a symlink inside
790 \fBDISTDIR\fR, but that may change in the future.
791 .TP
792 \fBPORTAGE_RSYNC_INITIAL_TIMEOUT\fR = \fIinteger\fR
793 Used by \fBemerge \-\-sync\fR as a timeout for the initial connection to an
794 rsync server.
795 .br
796 Defaults to 15 seconds.
797 .TP
798 \fBPORTAGE_RSYNC_EXTRA_OPTS\fR = \fI[rsync options string]\fR
799 Additional rsync options to be used by \fBemerge \-\-sync\fR.
800 .br
801 Defaults to no value.
802 .TP
803 \fBPORTAGE_RSYNC_OPTS\fR = \fI[rsync options string]\fR
804 Default rsync options to be used by \fBemerge \-\-sync\fR. 
805 .br
806 \fBDon't change this unless you know exactly what you're doing!\fR
807 .br
808 Defaults to "\-\-recursive \-\-links \-\-safe\-links \-\-perms \-\-times
809 \-\-compress \-\-force \-\-whole\-file \-\-delete \-\-stats
810 \-\-timeout=180 \-\-exclude='/distfiles' \-\-exclude='/local'
811 \-\-exclude='/packages'"
812 .TP
813 \fBPORTAGE_RSYNC_RETRIES\fR = \fI[NUMBER]\fR
814 The number of times rsync should retry on failed connections before
815 giving up. If set to a negative number, then retry until all possible
816 addresses are exhausted.
817 .br
818 Defaults to -1.
819 .TP
820 \fBPORTAGE_SYNC_STALE\fR = \fI[NUMBER]\fR
821 Defines the number of days after the last `emerge \-\-sync` that a warning
822 message should be produced. A value of 0 will disable warnings.
823 .br
824 Defaults to 30.
825 .TP
826 \fBPORTAGE_TMPDIR\fR = \fI[path]\fR
827 Defines the location of the temporary build directories.
828 .br
829 Defaults to /var/tmp.
830
831 This should not be set to point anywhere under the directory tree
832 specified by \fBPORTDIR\fR (/usr/portage by default).
833 .TP
834 \fBPORTAGE_USERNAME\fR = \fI[user]\fR
835 Defines the username to use when executing in userpriv/etc... modes (i.e.
836 non-root).
837 .br
838 Defaults to portage.
839 .TP
840 \fBPORTAGE_WORKDIR_MODE\fR = \fI"0700"\fR
841 This variable controls permissions for \fIWORKDIR\fR (see \fBebuild\fR(5)).
842 .TP
843 \fBPORTDIR\fR = \fI[path]\fR
844 Defines the location of the Portage tree. This is the repository for all
845 profile information as well as all ebuilds. If you change this, you must update
846 your /etc/make.profile symlink accordingly.
847 .br
848 Defaults to /usr/portage. 
849 .br
850 \fB***Warning***\fR
851 .br
852 Data stored inside \fBPORTDIR\fR is in peril of being overwritten or deleted by
853 the emerge \-\-sync command. The default value of
854 \fBPORTAGE_RSYNC_OPTS\fR will protect the default locations of
855 \fBDISTDIR\fR and \fBPKGDIR\fR, but users are warned that any other locations
856 inside \fBPORTDIR\fR are not necessarily safe for data storage.  You should not 
857 put other data (such as overlays) in your \fBPORTDIR\fB.  Portage will walk 
858 directory structures and may arbitrarily add invalid categories as packages.
859 .TP
860 \fBPORTDIR_OVERLAY\fR = \fI"[path] [different\-path] [etc...]"\fR
861 Defines the directories in which user made ebuilds may be stored and not 
862 overwriten when `emerge \-\-sync` is run.  This is a space delimited list of 
863 directories.
864 .br
865 Defaults to no value.
866 .TP
867 \fBQA_STRICT_EXECSTACK = \fI"set"\fR
868 Set this to cause portage to ignore any \fIQA_EXECSTACK\fR override
869 settings from ebuilds.  See also \fBebuild\fR(5).
870 .TP
871 \fBQA_STRICT_WX_LOAD = \fI"set"\fR
872 Set this to cause portage to ignore any \fIQA_WX_LOAD\fR override
873 settings from ebuilds.  See also \fBebuild\fR(5).
874 .TP
875 \fBQA_STRICT_TEXTRELS = \fI"set"\fR
876 Set this to cause portage to ignore any \fIQA_TEXTREL\fR override
877 settings from ebuilds.  See also \fBebuild\fR(5).
878 .TP
879 \fBQA_STRICT_FLAGS_IGNORED = \fI"set"\fR
880 Set this to cause portage to ignore any \fIQA_FLAGS_IGNORED\fR override
881 settings from ebuilds.  See also \fBebuild\fR(5).
882 .TP
883 \fBQA_STRICT_DT_HASH = \fI"set"\fR
884 Set this to cause portage to ignore any \fIQA_DT_HASH\fR override
885 settings from ebuilds. This variable is deprecated. Use
886 \fIQA_STRICT_FLAGS_IGNORED\fR instead.
887 .TP
888 \fBQA_STRICT_PRESTRIPPED = \fI"set"\fR
889 Set this to cause portage to ignore any \fIQA_PRESTRIPPED\fR override
890 settings from ebuilds.  See also \fBebuild\fR(5).
891 .TP
892 .B RESUMECOMMAND
893 This variable contains the command used for resuming package sources that
894 have been partially downloaded.  It should be defined using the same format
895 as \fBFETCHCOMMAND\fR, and must include any additional option(s) that may
896 be necessary in order to continue a partially downloaded file located at
897 \\${DISTDIR}/\\${FILE}.
898 .TP
899 \fBROOT\fR = \fI[path]\fR
900 Use \fBROOT\fR to specify the target root filesystem to be used for merging 
901 packages or ebuilds.  All \fBRDEPEND\fR and \fBPDEPEND\fR will be installed 
902 into \fBROOT\fR while all \fBDEPEND\fR will be still be installed into /.  
903 Typically, you should set this setting in the environment rather than in 
904 \fI/etc/make.conf\fR itself.  It's commonly used for creating new build 
905 images.  Make sure you use an absolute path.
906 .br
907 Defaults to /.
908 .TP
909 \fBRPMDIR\fR = \fI[path]\fR
910 Defines the location where created RPM packages will be stored.
911 .br
912 Defaults to ${PORTDIR}/rpm.
913 .TP
914 \fBSYNC\fR = \fI[RSYNC]\fR
915 Insert your preferred rsync mirror here.  This rsync server
916 is used to sync the local portage tree when `emerge \-\-sync` is run.
917 .br
918 Defaults to rsync://rsync.gentoo.org/gentoo\-portage
919 .TP
920 \fBUNINSTALL_IGNORE\fR = \fI[space delimited list of fnmatch patterns]\fR
921 This variable prevents uninstallation of files that match
922 specific \fBfnmatch\fR(3) patterns. In order to ignore file
923 collisions with these files at install time, the same patterns
924 can be added to the \fBCOLLISION_IGNORE\fR variable.
925 .br
926 Defaults to "/lib/modules/*".
927 .TP
928 \fBUSE\fR = \fI[space delimited list of USE items]\fR
929 This variable contains options that control the build behavior of several
930 packages.  More information in \fBebuild\fR(5).  Possible USE values
931 can be found in \fI/usr/portage/profiles/use.desc\fR.
932 .TP
933 \fBUSE_EXPAND\fR = \fI[space delimited list of variable names]\fR
934 Any variable listed here will be used to augment USE by inserting a new flag
935 for every value in that variable, so USE_EXPAND="FOO" and FOO="bar bla" results
936 in USE="foo_bar foo_bla".
937 .TP
938 \fBUSE_EXPAND_HIDDEN\fR = \fI[space delimited list of variable names]\fR
939 Names of \fBUSE_EXPAND\fR variables that should not be shown in the verbose merge
940 list output of the \fBemerge\fR(1) command.
941 .TP
942 \fBUSE_ORDER\fR = \fI"env:pkg:conf:defaults:pkginternal:repo:env.d"\fR
943 Determines the precedence of layers in the incremental stacking of the USE
944 variable. Precedence decreases from left to right such that env overrides
945 pkg, pkg overrides conf, and so forth.
946
947 .B ***warning***
948 .br
949 Do not modify this value unless you're a developer and you know what
950 you're doing. If you change this and something breaks, we will not help
951 you fix it.
952 .br
953 .RS
954 .TP
955 .B env
956 USE from the current environment variables (USE and those listed in USE_EXPAND)
957 .TP
958 .B pkg
959 Per\-package USE from \fB/etc/portage/package.use\fR (see \fBportage\fR(5))
960 .TP
961 .B conf
962 USE from make.conf
963 .TP
964 .B defaults
965 USE from make.defaults and package.use in the profile
966 (e.g. /etc/portage/make.profile/package.use) (see \fBportage\fR(5))
967 .TP
968 .B pkginternal
969 USE from \fBebuild\fR(5) IUSE defaults
970 .TP
971 .B repo
972 USE from make.defaults and package.use in the repo's profiles/ top dir
973 (e.g. /usr/portage/profiles/package.use) (see \fBportage\fR(5))
974 .TP
975 .B env.d
976 USE from the environment variables, such as LINGUAS, defined by files in
977 \fI/etc/env.d/\fR
978 .RE
979
980 .SH "REPORTING BUGS"
981 Please report bugs via http://bugs.gentoo.org/
982 .SH "AUTHORS"
983 .nf
984 Daniel Robbins <drobbins@gentoo.org>
985 Nicholas Jones <carpaski@gentoo.org>
986 Mike Frysinger <vapier@gentoo.org>
987 Saleem Abdulrasool <compnerd@gentoo.org>
988 .fi
989 .SH "FILES"
990 .TP
991 \fB/etc/make.conf\fR and \fB/etc/portage/make.conf\fR
992 Contains variables for the build\-process and overwrites those in make.defaults.
993 .TP
994 .B /usr/share/portage/config/make.globals
995 Contains the default variables for the build\-process, you should edit \fI/etc/make.conf\fR instead.
996 .TP
997 .B /etc/portage/color.map
998 Contains variables customizing colors.
999 .TP
1000 .B /usr/portage/profiles/use.desc
1001 Contains a list of all global USE flags.
1002 .TP
1003 .B /usr/portage/profiles/use.local.desc
1004 Contains a list of all local USE variables.
1005 .SH "SEE ALSO"
1006 .BR emerge (1),
1007 .BR portage (5),
1008 .BR ebuild (1),
1009 .BR ebuild (5)
1010 .TP
1011 The \fI/usr/sbin/ebuild.sh\fR script. 
1012 .TP
1013 The helper apps in \fI/usr/lib/portage/bin\fR.