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