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