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