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