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