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