Enable FEATURES=news by default and document it.
[portage.git] / man / make.conf.5
1 .TH "MAKE.CONF" "5" "Aug 2008" "Portage 2.2" "Portage"
2 .SH "NAME"
3 make.conf \- custom settings for Portage
4 .SH "SYNOPSIS"
5 .B /etc/make.conf
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 /etc/make.conf.  If no setting is found
11 in /etc/make.conf, Portage checks /etc/make.globals. If no
12 setting is found there, the profile's default setting is grabbed
13 from /etc/make.profile/make.defaults. Please note that all user
14 settings should be made in the environment or in /etc/make.conf,
15 which is intended to be customized by the user.
16 .br
17 Exceptions are incremental variables such as USE, CONFIG_PROTECT*,
18 and ACCEPT_KEYWORDS.  Incremental variables are propagated down from
19 make.defaults to make.globals to make.conf to the environment
20 settings.  Clearing these variables requires a clear\-all as in:
21 export USE="\-*"
22 .SH "VARIABLES"
23 .TP
24 \fBACCEPT_CHOSTS\fR = \fI[space delimited list of CHOST values]\fR
25 Specifies acceptable \fBCHOST\fR values. Regular
26 expression syntax is supported, so it is necessary to escape
27 \fBCHOST\fR characters if they have special meaning in regular expressions.
28 .br
29 Defaults to the value of $CHOST.
30 .TP
31 \fBACCEPT_KEYWORDS\fR = \fI[space delimited list of KEYWORDS]\fR
32 Enable testing of ebuilds that have not yet been deemed 'stable'.  Users
33 of the 'x86' architecture would set this to '~x86' while ppc users would
34 set this to '~ppc'.  This is an incremental variable.  Only define a 
35 ~arch.
36 .br
37 Defaults to the value of $ARCH.
38 .TP
39 \fBACCEPT_LICENSE\fR = \fI[space delimited list of licenses or groups]\fR
40 This variable is used to mask packages based on licensing restrictions.
41 .br
42 Defaults to the value of * -@EULA.
43 .TP
44 \fBACCEPT_PROPERTIES\fR = \fI[space delimited list of properties]\fR
45 This variable is used to mask packages based on PROPERTIES restrictions.
46 See \fBebuild\fR(5) for more information about PROPERTIES.
47 .br
48 Defaults to the value of *.
49 .TP
50 .B CBUILD
51 This variable is passed by the \fIebuild scripts\fR to the \fIconfigure\fR
52 as \fI\-\-build=${CBUILD}\fR only if it is defined.  Do not set this yourself
53 unless you know what you are doing.
54 .TP
55 \fBCCACHE_DIR\fR = \fI[path]\fR
56 Defines the location of the ccache working directory.  See the \fBccache\fR(1)
57 man page for more information.
58 .br
59 Defaults to /var/tmp/ccache
60 .TP
61 \fBCCACHE_SIZE\fR = \fI"size"\fR
62 This controls the space use limitations for ccache.  The default is 2 gigabytes 
63 ('2G').  Sizes are specified with 'G', 'M', or 'K'.
64 .TP
65 .B CFLAGS CXXFLAGS
66 Use these variables to set the desired optimization/CPU instruction settings
67 for applications that you compile.  Nearly all ebuild files will take advantage
68 of your custom settings, resulting in a Gentoo Linux that is fully customized
69 to your specifications.  Please use sane settings as some packages will fail to
70 compile/run if the optimizations are too extreme.
71
72 For more information, see the \fIInvoking GCC\fR section of the gcc manual:
73 .br
74 http://gcc.gnu.org/onlinedocs/
75 .TP
76 .B CHOST
77 This variable is passed by the \fIebuild scripts\fR to the \fIconfigure\fR
78 step as \fI\-\-host=${CHOST}\fR.  This way you can force the build\-host.
79
80 For more information:
81 .br
82 http://gcc.gnu.org/onlinedocs/gcc\-4.1.1/gcc/Submodel\-Options.html
83 .br
84 http://gcc.gnu.org/onlinedocs/gcc\-3.3/gcc/Submodel\-Options.html
85 .br
86 http://gcc.gnu.org/onlinedocs/gcc\-3.2/gcc/Submodel\-Options.html
87 .br
88 http://gcc.gnu.org/onlinedocs/gcc\-2.95.3/gcc_2.html
89 .TP
90 \fBCLEAN_DELAY\fR = \fIinteger\fR
91 Determines how long the countdown delay will be after running `emerge clean`.
92 .br
93 Defaults to 5 seconds.
94 .TP
95 \fBCOLLISION_IGNORE\fR = \fI[space delimited list of files and/or directories]\fR
96 This variable allows the user to disable \fIcollision\-protect\fR and
97 \fIprotect\-owned\fR for specific files and/or directories.
98 .br
99 Defaults to /lib/modules.
100 .TP
101 \fBCONFIG_PROTECT\fR = \fI[space delimited list of files and/or directories]\fR
102 All files and/or directories that are defined here will have "config file protection"
103 enabled for them. See the \fBCONFIGURATION FILES\fR section
104 of \fBemerge\fR(1) for more information.
105 .TP
106 \fBCONFIG_PROTECT_MASK\fR = \fI[space delimited list of files and/or directories]\fR
107 All files and/or directories that are defined here will have "config file protection"
108 disabled for them. See the \fBCONFIGURATION FILES\fR section
109 of \fBemerge\fR(1) for more information.
110 .TP
111 .B CTARGET
112 This variable is passed by the \fIebuild scripts\fR to the \fIconfigure\fR
113 as \fI\-\-target=${CTARGET}\fR only if it is defined.
114 .TP
115 \fBDISTDIR\fR = \fI[path]\fR
116 Defines the location of your local source file repository. After packages
117 are built, it is safe to remove any and all files from this directory since
118 they will be automatically fetched on demand for a given build. If you would
119 like to selectively prune obsolete files from this directory, see
120 \fBeclean\fR(1) from the gentoolkit package.
121
122 Use the \fBPORTAGE_RO_DISTDIRS\fR variable to specify one or
123 more read-only directories containing distfiles.
124
125 Note
126 that locations under /usr/portage are not necessarily safe for data storage.
127 See the \fBPORTDIR\fR documentation for more information.
128 .br
129 Defaults to /usr/portage/distfiles.
130 .TP
131 .B DOC_SYMLINKS_DIR
132 If this variable contains a directory then symlinks to html documentation will
133 be installed into it.
134 .TP
135 .B EBEEP_IGNORE
136 Defines whether or not to ignore audible beeps when displaying important
137 informational messages.  This variable is unset by default.
138 .TP
139 .B EMERGE_DEFAULT_OPTS
140 Options to append to the end of the \fBemerge\fR(1) command line on every invocation.
141 These options will not be appended to the command line if \-\-ignore\-default\-opts
142 is specified.
143 .TP
144 .B EMERGE_LOG_DIR
145 Controls the location of emerge.log and emerge-fetch.log.
146 .br
147 Defaults to /var/log.
148 .TP
149 .B EPAUSE_IGNORE
150 Defines whether or not to ignore short pauses that occur when displaying
151 important informational messages.  This variable is unset by default.
152 If it is set to any value pauses are ignored.
153 .TP
154 \fBEXTRA_ECONF\fR = \fI[configure options string]\fR
155 Contains additional options that \fBeconf\fR will append to configure
156 script arguments (see \fBebuild\fR(5)).
157 .TP
158 \fBFEATURES\fR = \fI"sandbox ccache"\fR
159 Defines actions portage takes by default. This is an incremental variable.
160 Most of these settings are for developer use, but some are available to
161 non-developers as well. The \fBsandbox\fR feature is very important and
162 should not be disabled by default.
163 .RS
164 .TP
165 .B assume\-digests
166 When commiting work to cvs with \fBrepoman\fR(1), assume that all existing 
167 SRC_URI digests are correct.  This feature also affects digest generation via
168 \fBebuild\fR(1) and \fBemerge\fR(1) (emerge generates digests only when the
169 \fIdigest\fR feature is enabled). Existing digests for files that do not exist
170 in ${DISTDIR} will be automatically assumed even when \fIassume\-digests\fR is
171 not enabled. If a file exists in ${DISTDIR} but it's size does not match the
172 existing digest, the digest will be regenerated regardless of whether or
173 not \fIassume\-digests\fR is enabled. The \fBebuild\fR(1) \fBdigest\fR command
174 has a \fB\-\-force\fR option that can be used to force regeneration of digests.
175 .TP
176 .B buildpkg
177 Binary packages will be created for all packages that are merged. Also see
178 \fBquickpkg\fR(1) and \fBemerge\fR(1) \fB\-\-buildpkg\fR and
179 \fB\-\-buildpkgonly\fR options.
180 .TP
181 .B buildsyspkg
182 Build binary packages for just packages in the system set.
183 .TP
184 .B ccache
185 Enable portage support for the ccache package.  If the ccache dir is not 
186 present in the user's environment, then portage will default to 
187 ${PORTAGE_TMPDIR}/ccache.
188 .TP
189 .B collision\-protect
190 A QA\-feature to ensure that a package doesn't overwrite files it doesn't own.
191 The \fICOLLISION_IGNORE\fR variable can be used to selectively disable this
192 feature. Also see the related \fIprotect\-owned\fR feature.
193 .TP
194 .B digest
195 Autogenerate digests for packages when running the \fBemerge\fR(1) command.  If
196 the \fIassume\-digests\fR feature is also enabled then existing SRC_URI digests
197 will be reused whenever they are available.
198 .TP
199 .B distcc
200 Enable portage support for the distcc package.
201 .TP
202 .B distlocks
203 Portage uses lockfiles to ensure competing instances don't clobber
204 each other's files. This feature is enabled by default but may cause
205 heartache on less intelligent remote filesystems like NFSv2 and some
206 strangely configured Samba server (oplocks off, NFS re\-export). A tool
207 /usr/lib/portage/bin/clean_locks exists to help handle lock issues
208 when a problem arises (normally due to a crash or disconnect).
209 .TP
210 .B fakeroot
211 Enable fakeroot for the install and package phases when a non-root user runs
212 the \fBebuild\fR(1) command.
213 .TP
214 .B fixpackages
215 Runs the script that will fix the dependencies in all binary packages.  This is 
216 run whenever packages are moved around in the portage tree.  Please note that this 
217 can take a lot of time.
218 .TP
219 .B getbinpkg
220 Force emerges to always try to fetch files from the \fIPORTAGE_BINHOST\fR.  See 
221 \fBmake.conf\fR(5) for more information.
222 .TP
223 .B installsources
224 Install source code into /usr/src/debug/${CATEGORY}/${PF} (also see
225 \fBsplitdebug\fR). This feature works only if debugedit is installed and CFLAGS
226 is set to include debug information (such as with the \-ggdb flag).
227 .TP
228 .B keeptemp
229 Do not delete the ${T} directory after the merge process.
230 .TP
231 .B keepwork
232 Do not delete the ${WORKDIR} directory after the merge process. ${WORKDIR} can
233 then be reused since this feature disables most of the clean phase that runs
234 prior to each build. Due to lack of proper cleanup, this feature can
235 interfere with normal emerge operation and therefore it should not be left
236 enabled for more than a short period of time.
237 .TP
238 .B lmirror
239 When \fImirror\fR is enabled in \fBFEATURES\fR, fetch files even
240 when \fImirror\fR is also in the \fBebuild\fR(5) \fBRESTRICT\fR variable.
241 Do \fBNOT\fR use \fIlmirror\fR for clients that need to override \fBRESTRICT\fR
242 when fetching from a local mirror, but instead use a "local" mirror setting
243 in \fI/etc/portage/mirrors\fR, as described in \fBportage\fR(5).
244 .TP
245 .B metadata\-transfer
246 Automatically perform a metadata transfer when `emerge \-\-sync` is run.
247 In versions of portage >=2.1.5, this feature is disabled by
248 default. When metadata\-transfer is disabled, metadata cache from the
249 ${PORTDIR}/metadata/cache/ directory will be used directly (if available)
250 and eclasses in ${PORTDIR}/eclass/ must not be modified except by
251 `emerge \-\-sync` operations since the cache validation mechanism
252 will not recognize eclass modifications. Normally, this issue only
253 pertains to users of the rsync tree since the cvs tree does not contain
254 a metadata/cache/ directory. Users of the rsync tree who want to modify
255 eclasses should use \fBPORTDIR_OVERLAY\fR in order for the cache
256 validation mechanism to work correctly.
257 .TP
258 .B mirror
259 Fetch everything in \fBSRC_URI\fR regardless of \fBUSE\fR settings,
260 except do not fetch anything when \fImirror\fR is in \fBRESTRICT\fR.
261 .TP
262 .B multilib\-strict
263 Many Makefiles assume that their libraries should go to /usr/lib, or
264 $(prefix)/lib. This assumption can cause a serious mess if /usr/lib
265 isn't a symlink to /usr/lib64. To find the bad packages, we have a
266 portage feature called \fImultilib\-strict\fR. It will prevent emerge
267 from putting 64bit libraries into anything other than (/usr)/lib64.
268 .TP
269 .B news
270 Enable GLEP 42 new support. See
271 \fIhttp://www.gentoo.org/proj/en/glep/glep-0042.html\fR.
272 .TP
273 .B noauto
274 When utilizing \fBebuild\fR(1), only run the function requested.
275 .TP
276 .B noclean
277 Do not delete the the source and temporary files after the merge process.
278 .TP
279 .B nodoc
280 Do not install doc files (/usr/share/doc).
281 .TP
282 .B noinfo
283 Do not install info pages.
284 .TP
285 .B noman
286 Do not install manpages.
287 .TP
288 .B nostrip
289 Prevents the stripping of binaries that are merged to the live filesystem.
290 .TP
291 .B notitles
292 Disables xterm titlebar updates (which contains status info).
293 .TP
294 .B parallel\-fetch
295 Fetch in the background while compiling. Run
296 `tail \-f /var/log/emerge\-fetch.log` in a
297 terminal to view parallel-fetch progress.
298 .TP
299 .B parse\-eapi\-ebuild\-head
300 Parse \fBEAPI\fR from the head of the ebuild (first 30 lines). This feature
301 is only intended for experimental purposes and should not be enabled under
302 normal circumstances.
303 .TP
304 .B parse\-eapi\-glep\-55
305 Parse \fBEAPI\fR from the file extension of the ebuild. This feature
306 is only intended for experimental purposes and should not be enabled under
307 normal circumstances.
308 .TP
309 .B preserve\-libs
310 Preserve libraries when the sonames change during upgrade or downgrade.
311 Libraries are preserved only if consumers of those libraries are detected.
312 .TP
313 .B protect\-owned
314 This is identical to the \fIcollision\-protect\fR feature except that files
315 may be overwritten if they are not explicitly listed in the contents of a
316 currently installed package. This is particularly useful on systems that
317 have lots of orphan files that have been left behind by older versions
318 of portage that did not support the \fIunmerge\-orphans\fR feature. Like
319 \fIcollision\-protect\fR, the \fICOLLISION_IGNORE\fR variable can be used to
320 selectively disable this feature. It is recommended to leave either
321 \fIprotect\-owned\fR or \fIcollision\-protect\fR enabled at all times,
322 since otherwise file collisions between packages may result in files being
323 overwritten or uninstalled at inappropriate times.
324 If \fIcollision\-protect\fR is enabled then it takes precedence over
325 \fIprotect\-owned\fR. 
326 .TP
327 .B python\-trace
328 Output a verbose trace of python execution to stderr when a command's 
329 \-\-debug option is enabled.
330 .TP
331 .B sandbox
332 Enable sandbox\-ing when running \fBemerge\fR(1) and \fBebuild\fR(1).
333 .TP
334 .B sesandbox
335 Enable SELinux sandbox\-ing.  Do not toggle this \fBFEATURE\fR yourself.
336 .TP
337 .B severe
338 When checking Manifests, only accept ones that have been signed by a
339 key which you trust.
340 .TP
341 .B sfperms
342 Stands for Smart Filesystem Permissions.  Before merging packages to the 
343 live filesystem, automatically search for and set permissions on setuid 
344 and setgid files.  Files that are setuid have the group and other read 
345 bits removed while files that are setgid have the other read bit removed.  
346 See also \fIsuidctl\fR below.
347 .TP
348 .B sign
349 When commiting work to cvs with \fBrepoman\fR(1), sign the Manifest with 
350 a GPG key.  Read about the \fIPORTAGE_GPG_KEY\fR variable in \fBmake.conf\fR(5).
351 .TP
352 .B skiprocheck
353 Skip write access checks on \fBDISTDIR\fR when fetching files. This is
354 useful when \fBFETCHCOMMAND\fR and \fBRESUMECOMMAND\fR are used to
355 forward fetch requests to a server that exposes \fBDISTDIR\fR as
356 a read-only NFS share. A read-only \fBDISTDIR\fR is not compatible with the
357 \fIdistlocks\fR, so it is recommended to also add "-distlocks" to
358 \fBFEATURES\fR in order to avoid warning messages that are triggered by this
359 incompatibility.
360 .TP
361 .B splitdebug
362 Prior to stripping ELF etdyn and etexec files, the debugging info is 
363 stored for later use by various debuggers.  This feature is disabled by
364 \fBnostrip\fR.  For installation of source code, see \fBinstallsources\fR.
365 .TP
366 .B strict
367 Have portage react strongly to conditions that have the potential to be 
368 dangerous (like missing or incorrect digests for ebuilds).
369 .TP
370 .B stricter
371 Have portage react strongly to conditions that may conflict with system
372 security provisions (for example textrels, executable stack).  Read about
373 the \fIQA_STRICT_*\fR variables in \fBmake.conf\fR(5).
374 .TP
375 .B suidctl
376 Before merging packages to the live filesystem, automatically strip setuid 
377 bits from any file that is not listed in \fI/etc/portage/suidctl.conf\fR.
378 .TP
379 .B test
380 Run package\-specific tests during each merge to help make sure 
381 the package compiled properly.  See \fItest\fR in \fBebuild\fR(1) 
382 and \fIsrc_test()\fR in \fBebuild\fR(5). This feature implies the "test"
383 \fBUSE\fR flag.
384 .TP
385 .B test\-fail\-continue
386 If "test" is enabled \fBFEATURES\fR and the test phase of an ebuild fails,
387 continue to execute the remaining phases as if the failure had not occurred.
388 Note that the test phase for a specific package may be disabled by masking
389 the "test" \fBUSE\fR flag in \fBpackage.use.mask\fR (see \fBportage\fR(5)).
390 .TP
391 .B unmerge\-logs
392 Keep logs from successful unmerge phases. This is relevant only when
393 \fBPORT_LOGDIR\fR is set.
394 .TP
395 .B unmerge\-orphans
396 If a file is not claimed by another package in the same slot and it is not
397 protected by \fICONFIG_PROTECT\fR, unmerge it even if the modification time or
398 checksum differs from the file that was originally installed.
399 .TP
400 .B userfetch
401 When portage is run as root, drop privileges to portage:portage during the
402 fetching of package sources.
403 .TP
404 .B userpriv
405 Allow portage to drop root privileges and compile packages as 
406 portage:portage without a sandbox (unless \fIusersandbox\fR is also used).
407 .TP
408 .B usersandbox
409 Enable the sandbox in the compile phase, when running without root privs (\fIuserpriv\fR).
410 .TP
411 .B usersync
412 Drop privileges to the owner of \fBPORTDIR\fR for \fBemerge(1) --sync\fR
413 operations.
414 .TP
415 .B webrsync-gpg
416 Enable GPG verification when using \fIemerge\-webrsync\fR.
417 .RE
418 .TP
419 .B FETCHCOMMAND
420 This variable contains the command used for fetching package sources from
421 the internet.  It must contain the full path to the executable as well as the
422 place\-holders \\${DISTDIR}, \\${FILE} and \\${URI}.  The command should be
423 written to place the fetched file at \\${DISTDIR}/\\${FILE}.
424 Also see \fBRESUMECOMMAND\fR.
425 .TP
426 \fBGENTOO_MIRRORS\fR = \fI[URLs]\fR
427 Insert your space\-seperated list of local mirrors here.  These
428 locations are used to download files before the ones listed in
429 the \fIebuild scripts\fR. Merging 'mirrorselect' can help.  Entries in this
430 variable that have no protocol and simply start with a '/' path separator may
431 be used to specify mounted filesystem mirrors.
432 .TP
433 \fBhttp_proxy ftp_proxy\fR = \fI[protocol://host:port]\fR
434 These vars are used if the sources must be downloaded from the
435 internet by \fBwget\fR(1).  They are only required if you use a
436 proxy server for internet access.
437 .TP
438 \fBINSTALL_MASK\fR = \fI[space delimited list of file names]\fR
439 Use this variable if you want to selectively prevent certain files from being
440 copied into your file system tree.  This does not work on symlinks, but only on
441 actual files.  Useful if you wish to filter out files like HACKING.gz and
442 TODO.gz. The \fBINSTALL_MASK\fR is processed just before a package is merged.
443 Also supported is a \fBPKG_INSTALL_MASK\fR variable that behaves exactly like
444 \fBINSTALL_MASK\fR except that it is processed just before creation of a binary
445 package.
446 .TP
447 .B MAKEOPTS
448 Use this variable if you want to use parallel make.  For example, if you
449 have a dual\-processor system, set this variable to "\-j2" or "\-j3" for 
450 enhanced build performance with many packages. Suggested settings are
451 between \fICPUs+1\fR and \fI2*CPUs+1\fR. In order to avoid
452 excess load, the \fB\-\-load\-average\fR option is recommended.
453 For more information, see \fBmake\fR(1). Also see \fBemerge\fR(1) for
454 information about analogous \fB\-\-jobs\fR and \fB\-\-load\-average\fR options.
455 .TP
456 \fBNOCOLOR\fR = \fI["true" | "false"]\fR
457 Defines if color should be disabled by default.
458 .br
459 Defaults to false.
460 .TP
461 \fBPKGDIR\fR = \fI[path]\fR
462 Defines the location where created .tbz2 binary packages will be
463 stored when the \fBemerge\fR(1) \fB\-\-buildpkg\fR option is enabled.
464 By default, a given package is stored in a subdirectory corresponding
465 to it's category. However, for backward compatibility with the layout
466 used by older versions of portage, if the \fI${PKGDIR}/All\fR directory
467 exists then all packages will be stored inside of it and symlinks to
468 the packages will be created in the category subdirectories. Note
469 that locations under /usr/portage are not necessarily safe for data storage.
470 See the \fBPORTDIR\fR documentation for more information.
471 .br
472 Defaults to /usr/portage/packages.
473 .TP
474 .B PORT_LOGDIR
475 This variable defines the directory in which per\-ebuild logs are kept.
476 Logs are created only when this is set. They are stored as
477 ${CATEGORY}:${PF}:YYYYMMDD\-HHMMSS.log in the directory specified. If the
478 direcory does not exist, it will be created automatically and group permissions
479 will be applied to it.  If the directory already exists, portage will not
480 modify it's permissions.
481 .TP
482 \fBPORTAGE_BINHOST\fR = \fI"ftp://login:pass@grp.mirror.site/pub/grp/i686/athlon\-xp/"\fR
483 This is the host from which portage will grab prebuilt\-binary packages.  
484 The list is a single entry specifying the full address of the directory 
485 serving the tbz2's for your system.  This is only used when running with 
486 the get binary pkg options are given to \fBemerge\fR.  Review \fBemerge\fR(1) 
487 for more information.  For versions of portage less that 2.1.6, this variable
488 should point to the 'All' directory on the host that creates the binary
489 packages and not to the root of the \fBPKGDIR\fR.  Starting with portage 2.1.6,
490 it should point to a directory containing a 'Packages' index file.  If
491 ${PORTAGE_BINHOST}/Packages does not exist then portage will attempt to use
492 the older protocol.
493 .TP
494 \fBPORTAGE_BINHOST_HEADER_URI\fR = \fI"ftp://login:pass@grp.mirror.site/pub/grp/i686/athlon\-xp/"\fR
495 This variable only makes sense on a system that will serve as a binhost and
496 build packages for clients.  It defines the URI header field for the package
497 index file which is located at ${PKGDIR}/Packages. Clients that have
498 \fBPORTAGE_BINHOST\fR properly configured will be able to fetch the index and
499 use the URI header field as a base URI for fetching binary packages. If the URI
500 header field is not defined then the client will use it's ${PORTAGE_BINHOST}
501 setting as the base URI.
502 .TP
503 .B PORTAGE_BINPKG_TAR_OPTS
504 This variable contains options to be passed to the tar command for creation
505 of binary packages.
506 .TP
507 \fBPORTAGE_COMPRESS\fR = \fI"bzip2"\fR
508 This variable contains the command used to compress documentation during the
509 install phase.
510 .TP
511 \fBPORTAGE_COMPRESS_FLAGS\fR = \fI"\-9"\fR
512 This variable contains flags for the \fBPORTAGE_COMPRESS\fR command.
513 .TP
514 .TP
515 \fBPORTAGE_COMPRESS_EXCLUDE_SUFFIXES\fR = \fI"gif htm[l]? jp[e]?g pdf png"\fR
516 This variable contains a space delimited list of file suffixes for which
517 matching files are excluded when the \fBPORTAGE_COMPRESS\fR command is
518 called. Regular expressions are supported and the match is performed only
519 against the portion of the file name which follows the last period character.
520 .TP
521 .B PORTAGE_ELOG_CLASSES
522 .TP
523 .B PORTAGE_ELOG_SYSTEM
524 .TP
525 .B PORTAGE_ELOG_COMMAND
526 .TP
527 .B PORTAGE_ELOG_MAILURI
528 .TP
529 .B PORTAGE_ELOG_MAILFROM
530 .TP
531 .B PORTAGE_ELOG_MAILSUBJECT
532 Please see /usr/share/portage/config/make.conf.example for elog documentation.
533 .TP
534 \fBPORTAGE_FETCH_CHECKSUM_TRY_MIRRORS\fR = \fI5\fR
535 Number of mirrors to try when a downloaded file has an incorrect checksum.
536 .TP
537 \fBPORTAGE_FETCH_RESUME_MIN_SIZE\fR = \fI350K\fR
538 Minimum size of existing file for \fBRESUMECOMMAND\fR to be called. Files
539 smaller than this size will be removed and \fBFETCHCOMMAND\fR will be called
540 to download the file from the beginning. This is useful for helping to ensure
541 that small garbage files such as html 404 pages are properly discarded. The
542 variable should contain an integer number of bytes and may have a suffix such
543 as K, M, or G.
544 .TP
545 .B PORTAGE_GPG_DIR
546 The \fBgpg\fR(1) home directory that is used by \fBrepoman\fR(1)
547 when \fBsign\fR is in \fBFEATURES\fR.
548 .br
549 Defaults to $HOME/.gnupg.
550 .TP
551 .B PORTAGE_GPG_KEY
552 The \fBgpg\fR(1) key used by \fBrepoman\fR(1) to sign manifests
553 when \fBsign\fR is in \fBFEATURES\fR.
554 .TP
555 \fBPORTAGE_IONICE_COMMAND\fR = \fI[ionice command string]\fR
556 This variable should contain a command for portage to call in order
557 to adjust the io priority of portage and it's subprocesses. The command
558 string should contain a \\${PID} place-holder that will be substituted
559 with an integer pid. For example, a value of "ionice \-c 3 \-p \\${PID}"
560 will set idle io priority. For more information about ionice, see
561 \fBionice\fR(1). This variable is unset by default.
562 .TP
563 \fBPORTAGE_NICENESS\fR = \fI[number]\fR
564 The value of this variable will be added to the current nice level that
565 emerge is running at.  In other words, this will not set the nice level,
566 it will increment it.  For more information about nice levels and what
567 are acceptable ranges, see \fBnice\fR(1).
568 .TP
569 \fBPORTAGE_RO_DISTDIRS\fR = \fI[space delimited list of directories]\fR
570 When a given file does not exist in \fBDISTDIR\fR, search for the file
571 in this list of directories. Search order is from left to right. Note
572 that the current implementation works by creating a symlink inside
573 \fBDISTDIR\fR, but that may change in the future.
574 .TP
575 \fBPORTAGE_RSYNC_INITIAL_TIMEOUT\fR = \fIinteger\fR
576 Used by \fBemerge \-\-sync\fR as a timeout for the initial connection to an
577 rsync server.
578 .br
579 Defaults to 15 seconds.
580 .TP
581 \fBPORTAGE_RSYNC_EXTRA_OPTS\fR = \fI[rsync options string]\fR
582 Additional rsync options to be used by \fBemerge \-\-sync\fR.
583 .br
584 Defaults to no value.
585 .TP
586 \fBPORTAGE_RSYNC_OPTS\fR = \fI[rsync options string]\fR
587 Default rsync options to be used by \fBemerge \-\-sync\fR. 
588 .br
589 \fBDon't change this unless you know exactly what you're doing!\fR
590 .br
591 Defaults to "\-\-recursive \-\-links \-\-safe\-links \-\-perms \-\-times
592 \-\-compress \-\-force \-\-whole\-file \-\-delete \-\-stats
593 \-\-timeout=180 \-\-exclude='/distfiles' \-\-exclude='/local'
594 \-\-exclude='/packages'"
595 .TP
596 \fBPORTAGE_RSYNC_RETRIES\fR = \fI[NUMBER]\fR
597 The number of times rsync should retry on failed connections before
598 giving up.
599 .br
600 Defaults to 3.
601 .TP
602 \fBPORTAGE_TMPDIR\fR = \fI[path]\fR
603 Defines the location of the temporary build directories.
604 .br
605 Defaults to /var/tmp.
606 .TP
607 \fBPORTAGE_WORKDIR_MODE\fR = \fI"0700"\fR
608 This variable controls permissions for \fIWORKDIR\fR (see \fBebuild\fR(5)).
609 .TP
610 \fBPORTDIR\fR = \fI[path]\fR
611 Defines the location of the Portage tree. This is the repository for all
612 profile information as well as all ebuilds. If you change this, you must update
613 your /etc/make.profile symlink accordingly.
614 .br
615 Defaults to /usr/portage. 
616 .br
617 \fB***Warning***\fR
618 .br
619 Data stored inside \fBPORTDIR\fR is in peril of being overwritten or deleted by
620 the emerge \-\-sync command. The default value of
621 \fBPORTAGE_RSYNC_OPTS\fR will protect the default locations of
622 \fBDISTDIR\fR and \fBPKGDIR\fR, but users are warned that any other locations
623 inside \fBPORTDIR\fR are not necessarily safe for data storage.  You should not 
624 put other data (such as overlays) in your \fBPORTDIR\fB.  Portage will walk 
625 directory structures and may arbitrary add invalid categories as packages.
626 .TP
627 \fBPORTDIR_OVERLAY\fR = \fI"[path] [different\-path] [etc...]"\fR
628 Defines the directories in which user made ebuilds may be stored and not 
629 overwriten when `emerge \-\-sync` is run.  This is a space delimited list of 
630 directories.
631 .br
632 Defaults to no value.
633 .TP
634 \fBQA_STRICT_EXECSTACK = \fI"set"\fR
635 Set this to cause portage to ignore any \fIQA_EXECSTACK\fR override
636 settings from ebuilds.  See also \fBebuild\fR(5).
637 .TP
638 \fBQA_STRICT_WX_LOAD = \fI"set"\fR
639 Set this to cause portage to ignore any \fIQA_WX_LOAD\fR override
640 settings from ebuilds.  See also \fBebuild\fR(5).
641 .TP
642 \fBQA_STRICT_TEXTRELS = \fI"set"\fR
643 Set this to cause portage to ignore any \fIQA_TEXTREL\fR override
644 settings from ebuilds.  See also \fBebuild\fR(5).
645 .TP
646 \fBQA_STRICT_DT_HASH = \fI"set"\fR
647 Set this to cause portage to ignore any \fIQA_DT_HASH\fR override
648 settings from ebuilds.  See also \fBebuild\fR(5).
649 .TP
650 \fBQA_STRICT_PRESTRIPPED = \fI"set"\fR
651 Set this to cause portage to ignore any \fIQA_PRESTRIPPED\fR override
652 settings from ebuilds.  See also \fBebuild\fR(5).
653 .TP
654 .B RESUMECOMMAND
655 This variable contains the command used for resuming package sources that
656 have been partially downloaded.  It should be defined using the same format
657 as \fBFETCHCOMMAND\fR, and must include any additional option(s) that may
658 be necessary in order to continue a partially downloaded file located at
659 \\${DISTDIR}/\\${FILE}.
660 .TP
661 \fBROOT\fR = \fI[path]\fR
662 Use \fBROOT\fR to specify the target root filesystem to be used for merging 
663 packages or ebuilds.  All \fBRDEPEND\fR and \fBPDEPEND\fR will be installed 
664 into \fBROOT\fR while all \fBDEPEND\fR will be still be installed into /.  
665 Typically, you should set this setting in the environment rather than in 
666 \fI/etc/make.conf\fR itself.  It's commonly used for creating new build 
667 images.  Make sure you use an absolute path.
668 .br
669 Defaults to /.
670 .TP
671 \fBRPMDIR\fR = \fI[path]\fR
672 Defines the location where created RPM packages will be stored.
673 .br
674 Defaults to ${PORTDIR}/rpm.
675 .TP
676 \fBSYNC\fR = \fI[RSYNC]\fR
677 Insert your preferred rsync mirror here.  This rsync server
678 is used to sync the local portage tree when `emerge \-\-sync` is run.
679 .br
680 Defaults to rsync://rsync.gentoo.org/gentoo\-portage
681 .TP
682 \fBUSE\fR = \fI[space delimited list of USE items]\fR
683 This variable contains options that control the build behavior of several
684 packages.  More information in \fBebuild\fR(5).  Possible USE values
685 can be found in \fI/usr/portage/profiles/use.desc\fR.
686 .TP
687 \fBUSE_EXPAND\fR = \fI[space delimited list of variable names]\fR
688 Any variable listed here will be used to augment USE by inserting a new flag
689 for every value in that variable, so USE_EXPAND="FOO" and FOO="bar bla" results
690 in USE="foo_bar foo_bla".
691 .TP
692 \fBUSE_EXPAND_HIDDEN\fR = \fI[space delimited list of variable names]\fR
693 Names of \fBUSE_EXPAND\fR variables that should not be shown in the verbose merge
694 list output of the \fBemerge\fR(1) command.
695 .TP
696 \fBUSE_ORDER\fR = \fI"env:pkg:conf:defaults:pkginternal:env.d"\fR
697 Determines the precedence of layers in the incremental stacking of the USE
698 variable. Precedence decreases from left to right such that env overrides
699 pkg, pkg overrides conf, and so forth.
700
701 .B ***warning***
702 .br
703 Do not modify this value unless you're a developer and you know what
704 you're doing. If you change this and something breaks, we will not help
705 you fix it.
706 .br
707 .RS
708 .TP
709 .B env
710 USE from the current environment variables (USE and those listed in USE_EXPAND)
711 .TP
712 .B pkg
713 Per\-package USE from \fB/etc/portage/package.use\fR (see \fBportage\fR(5))
714 .TP
715 .B conf
716 USE from make.conf
717 .TP
718 .B defaults
719 USE from make.defaults and package.use in the profile (see \fBportage\fR(5))
720 .TP
721 .B pkginternal
722 USE from \fBebuild\fR(5) IUSE defaults
723 .TP
724 .B env.d
725 USE from the environment variables defined by files in \fI/etc/env.d/\fR
726 .RE
727
728 .SH "REPORTING BUGS"
729 Please report bugs via http://bugs.gentoo.org/
730 .SH "AUTHORS"
731 .nf
732 Daniel Robbins <drobbins@gentoo.org>
733 Nicholas Jones <carpaski@gentoo.org>
734 Mike Frysinger <vapier@gentoo.org>
735 Saleem Abdulrasool <compnerd@gentoo.org>
736 .fi
737 .SH "FILES"
738 .TP
739 .B /etc/make.conf
740 Contains variables for the build\-process and overwrites those in make.defaults.
741 .TP
742 .B /etc/make.globals
743 Contains the default variables for the build\-process, you should edit \fI/etc/make.conf\fR instead.
744 .TP
745 .B /etc/portage/color.map
746 Contains variables customizing colors.
747 .TP
748 .B /usr/portage/profiles/use.desc
749 Contains a list of all global USE flags.
750 .TP
751 .B /usr/portage/profiles/use.local.desc
752 Contains a list of all local USE variables.
753 .SH "SEE ALSO"
754 .BR emerge (1),
755 .BR portage (5),
756 .BR ebuild (1),
757 .BR ebuild (5)
758 .TP
759 The \fI/usr/sbin/ebuild.sh\fR script. 
760 .TP
761 The helper apps in \fI/usr/lib/portage/bin\fR.