man/make.conf.5

   1 .TH "MAKE.CONF" "5" "Jan 2007" "Portage 2.1.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_KEYWORDS\fR = \fI[space delimited list of KEYWORDS]\fR
  25 Enable testing of ebuilds that have not yet been deemed 'stable'.  Users
  26 of the 'x86' architecture would set this to '~x86' while ppc users would
  27 set this to '~ppc'.  This is an incremental variable.  Only define a
  28 ~arch.
  29 .br
  30 Defaults to the value of $ARCH.
  31 .TP
  32 \fBBUILD_PREFIX\fR = \fI[path]\fR
  33 Defines the location of the package working directory.
  34 .br
  35 Defaults to ${PORTAGE_TMPDIR}/portage
  36 .TP
  37 .B CBUILD
  38 This variable is passed by the \fIebuild scripts\fR to the \fIconfigure\fR
  39 as \fI\-\-build=${CBUILD}\fR only if it is defined.  Do not set this yourself
  40 unless you know what you are doing.
  41 .TP
  42 \fBCCACHE_DIR\fR = \fI[path]\fR
  43 Defines the location of the ccache working directory.  See the \fBccache\fR(1)
  44 man page for more information.
  45 .br
  46 Defaults to /var/tmp/ccache
  47 .TP
  48 \fBCCACHE_SIZE\fR = \fI"size"\fR
  49 This controls the space use limitations for ccache.  The default is 2 gigabytes
  50 ('2G').  Sizes are specified with 'G', 'M', or 'K'.
  51 .TP
  52 .B CFLAGS CXXFLAGS
  53 Use these variables to set the desired optimization/CPU instruction settings
  54 for applications that you compile.  Nearly all ebuild files will take advantage
  55 of your custom settings, resulting in a Gentoo Linux that is fully customized
  56 to your specifications.  Please use sane settings as some packages will fail to
  57 compile/run if the optimizations are too extreme.
  58
  59 For more information, see the \fIInvoking GCC\fR section of the gcc manual:
  60 .br
  61 http://gcc.gnu.org/onlinedocs/
  62 .TP
  63 .B CHOST
  64 This variable is passed by the \fIebuild scripts\fR to the \fIconfigure\fR
  65 step as \fI\-\-host=${CHOST}\fR.  This way you can force the build\-host.
  66
  67 For more information:
  68 .br
  69 http://gcc.gnu.org/onlinedocs/gcc\-4.1.1/gcc/Submodel\-Options.html
  70 .br
  71 http://gcc.gnu.org/onlinedocs/gcc\-3.3/gcc/Submodel\-Options.html
  72 .br
  73 http://gcc.gnu.org/onlinedocs/gcc\-3.2/gcc/Submodel\-Options.html
  74 .br
  75 http://gcc.gnu.org/onlinedocs/gcc\-2.95.3/gcc_2.html
  76 .TP
  77 \fBCLEAN_DELAY\fR = \fIinteger\fR
  78 Determines how long the countdown delay will be after running `emerge clean`.
  79 .br
  80 Defaults to 5 seconds.
  81 .TP
  82 \fBCOLLISION_IGNORE\fR = \fI[space delimited list of files and/or directories]\fR
  83 This variable allows the user to disable \fIcollision\-protect\fR for specific
  84 files and/or directories.
  85 .TP
  86 \fBCONFIG_PROTECT\fR = \fI[space delimited list of files and/or directories]\fR
  87 All files and/or directories that are defined here will have "config file protection"
  88 enabled for them.  For more information, please see `emerge \-\-help config`.
  89 .TP
  90 \fBCONFIG_PROTECT_MASK\fR = \fI[space delimited list of files and/or directories]\fR
  91 All files and/or directories that are defined here will have "config file protection"
  92 disabled for them.  For more information, please see `emerge \-\-help config`.
  93 .TP
  94 .B CTARGET
  95 This variable is passed by the \fIebuild scripts\fR to the \fIconfigure\fR
  96 as \fI\-\-target=${CTARGET}\fR only if it is defined.
  97 .TP
  98 .B DOC_SYMLINKS_DIR
  99 If this variable contains a directory then symlinks to html documentation will
 100 be installed into it.
 101 .TP
 102 \fBDISTDIR\fR = \fI[path]\fR
 103 Defines the location of your local source file repository.
 104 .br
 105 Defaults to ${PORTDIR}/distfiles.
 106 .TP
 107 .B EBEEP_IGNORE
 108 Defines whether or not to ignore audible beeps when displaying important
 109 informational messages.  This variable is unset by default.
 110 .TP
 111 .B EMERGE_DEFAULT_OPTS
 112 Options to append to the end of the \fBemerge\fR(1) command line on every invocation.
 113 These options will not be appended to the command line if \-\-ignore\-default\-opts
 114 is specified.
 115 .TP
 116 .B EPAUSE_IGNORE
 117 Defines whether or not to ignore short pauses that occur when displaying
 118 important informational messages.  This variable is unset by default.
 119 If it is set to any value pauses are ignored.
 120 .TP
 121 \fBFEATURES\fR = \fI"sandbox ccache"\fR
 122 Defines actions portage takes by default.  These options should
 123 not be changed by anyone but developers and/or maintainers.  'sandbox' is an important
 124 part of \fBFEATURES\fR and should not be disabled by default.  This is
 125 an incremental variable.
 126 .RS
 127 .TP
 128 .B assume\-digests
 129 When commiting work to cvs with \fBrepoman\fR(1), assume that all existing
 130 SRC_URI digests are correct.  This feature also affects digest generation via
 131 \fBebuild\fR(1) and \fBemerge\fR(1) (emerge generates digests only when the
 132 \fIdigest\fR feature is enabled).
 133 .TP
 134 .B buildpkg
 135 Binary packages will be created for all packages that are merged.
 136 .TP
 137 .B buildsyspkg
 138 Build binary packages for just packages in the system set.
 139 .TP
 140 .B ccache
 141 Enable portage support for the ccache package.  If the ccache dir is not
 142 present in the user's environment, then portage will default to
 143 ${PORTAGE_TMPDIR}/ccache.
 144 .TP
 145 .B confcache
 146 Enable confcache support; global configure caching, speeds up autotool based configure
 147 calls via the econf helper function. See \fBebuild\fR(5) for more information.
 148 .TP
 149 .B collision\-protect
 150 A QA\-feature to ensure that a package doesn't overwrite files it doesn't own.
 151 The \fICOLLISION_IGNORE\fR variable can be used to selectively disable this
 152 feature.
 153 .TP
 154 .B digest
 155 Autogenerate digests for packages when running the \fBemerge\fR(1) command.  If
 156 the \fIassume\-digests\fR feature is also enabled then existing SRC_URI digests
 157 will be reused whenever they are available.
 158 .TP
 159 .B distcc
 160 Enable portage support for the distcc package.
 161 .TP
 162 .B distlocks
 163 Portage uses lockfiles to ensure competing instances don't clobber
 164 each other's files. This feature is enabled by default but may cause
 165 heartache on less intelligent remote filesystems like NFSv2 and some
 166 strangely configured Samba server (oplocks off, NFS re\-export). A tool
 167 /usr/lib/portage/bin/clean_locks exists to help handle lock issues
 168 when a problem arises (normally due to a crash or disconnect).
 169 .TP
 170 .B fixpackages
 171 Runs the script that will fix the dependencies in all binary packages.  This is
 172 run whenever packages are moved around in the portage tree.  Please note that this
 173 can take a lot of time.
 174 .TP
 175 .B getbinpkg
 176 Force emerges to always try to fetch files from the \fIPORTAGE_BINHOST\fR.  See
 177 \fBmake.conf\fR(5) for more information.
 178 .TP
 179 .B gpg
 180 Check the signatures of Manifests and make sure they are correct.
 181 .TP
 182 .B installsources
 183 Install source code into /usr/src/debug/${CATEGORY}/${PF} (also see
 184 \fBsplitdebug\fR). This feature works only if debugedit is installed.
 185 .TP
 186 .B keeptemp
 187 Do not delete the ${T} directory after the merge process.
 188 .TP
 189 .B keepwork
 190 Do not delete the ${WORKDIR} directory after the merge process.
 191 .TP
 192 .B metadata\-transfer
 193 Automatically perform a metadata transfer when `emerge \-\-sync` is run.
 194 .TP
 195 .B mirror
 196 This will cause \fBFETCHCOMMAND\fR to always be run even if
 197 the file already exists in \fBDISTDIR\fR.
 198 .TP
 199 .B noauto
 200 When utilizing \fBebuild\fR(1), only run the function requested.
 201 .TP
 202 .B noclean
 203 Do not delete the the source and temporary files after the merge process.
 204 .TP
 205 .B nodoc
 206 Do not install doc files (/usr/share/doc).
 207 .TP
 208 .B noinfo
 209 Do not install info pages.
 210 .TP
 211 .B noman
 212 Do not install manpages.
 213 .TP
 214 .B nostrip
 215 Prevents the stripping of binaries that are merged to the live filesystem.
 216 .TP
 217 .B notitles
 218 Disables xterm titlebar updates (which contains status info).
 219 .TP
 220 .B parallel\-fetch
 221 Fetch in the background while compiling.
 222 .TP
 223 .B sandbox
 224 Enable sandbox\-ing when running \fBemerge\fR(1) and \fBebuild\fR(1).
 225 .TP
 226 .B severe
 227 When checking Manifests, only accept ones that have been signed by a
 228 key which you trust.
 229 .TP
 230 .B sfperms
 231 Stands for Smart Filesystem Permissions.  Before merging packages to the
 232 live filesystem, automatically search for and set permissions on setuid
 233 and setgid files.  Files that are setuid have the group and other read
 234 bits removed while files that are setgid have the other read bit removed.
 235 See also \fIsuidctl\fR below.
 236 .TP
 237 .B sign
 238 When commiting work to cvs with \fBrepoman\fR(1), sign the Manifest with
 239 a GPG key.  Read about the \fIPORTAGE_GPG_KEY\fR variable in \fBmake.conf\fR(5).
 240 .TP
 241 .B splitdebug
 242 Prior to stripping ELF etdyn and etexec files, the debugging info is
 243 stored for later use by various debuggers.  This feature is disabled by
 244 \fBnostrip\fR.  For installation of source code, see \fBinstallsources\fR.
 245 .TP
 246 .B strict
 247 Have portage react strongly to conditions that have the potential to be
 248 dangerous (like missing or incorrect Manifests).
 249 .TP
 250 .B stricter
 251 Have portage react strongly to conditions that may conflict with system
 252 security provisions (for example textrels, executable stack).  Read about
 253 the \fIQA_STRICT_*\fR variables in \fBmake.conf\fR(5).
 254 .TP
 255 .B suidctl
 256 Before merging packages to the live filesystem, automatically strip setuid
 257 bits from any file that is not listed in \fI/etc/portage/suidctl.conf\fR.
 258 .TP
 259 .B test
 260 Run package\-specific tests during each merge to help make sure
 261 the package compiled properly.  See \fItest\fR in \fBebuild\fR(1)
 262 and \fIsrc_test()\fR in \fBebuild\fR(5). This feature implies the "test"
 263 \fBUSE\fR flag.
 264 .TP
 265 .B userfetch
 266 When portage is run as root, drop privileges to portage:portage during the
 267 fetching of package sources.
 268 .TP
 269 .B userpriv
 270 Allow portage to drop root privileges and compile packages as
 271 portage:portage without a sandbox (unless \fIusersandbox\fR is also used).
 272 .TP
 273 .B usersandbox
 274 Enable the sandbox in the compile phase, when running without root privs (\fIuserpriv\fR).
 275 .RE
 276 .TP
 277 .B FETCHCOMMAND
 278 This variable contains the command used for fetching package sources from
 279 the internet.  It must contain the full path to the executable as well as the
 280 place\-holders \\${DISTDIR} and \\${URI}.
 281 .TP
 282 \fBGENTOO_MIRRORS\fR = \fI[URLs]\fR
 283 Insert your space\-seperated list of local mirrors here.  These
 284 locations are used to download files before the ones listed in
 285 the \fIebuild scripts\fR. Merging 'mirrorselect' can help.  Entries in this
 286 variable that have no protocol and simply start with a '/' path separator may
 287 be used to specify mounted filesystem mirrors.
 288 .TP
 289 \fBhttp_proxy ftp_proxy\fR = \fI[host:port]\fR
 290 These vars are used if the sources must be downloaded from the
 291 internet by \fBwget\fR(1).  They are only required if you use a
 292 proxy server for internet access.
 293 .TP
 294 \fBINSTALL_MASK\fR = \fI[space delimited list of file names]\fR
 295 Use this variable if you want to selectively prevent certain files from being
 296 copied into your file system tree.  This does not work on symlinks, but only on
 297 actual files.  Useful if you wish to filter out files like HACKING.gz and
 298 TODO.gz.
 299 .TP
 300 .B MAKEOPTS
 301 Use this variable if you want to use parallel make.  For example, if you
 302 have a dual\-processor system, set this variable to "\-j2" or "\-j3" for
 303 enhanced build performance with many packages. Suggested settings are
 304 between \fICPUs+1\fR and \fI2*CPUs+1\fR.
 305 For more information, see \fBmake\fR(1).
 306 .TP
 307 \fBNOCOLOR\fR = \fI["true" | "false"]\fR
 308 Defines if color should be disabled by default.
 309 .br
 310 Defaults to false.
 311 .TP
 312 \fBPKGDIR\fR = \fI[path]\fR
 313 Defines the location where created .tbz2 binary packages will be stored.
 314 .br
 315 Defaults to ${PORTDIR}/packages.
 316 .TP
 317 .B PORT_LOGDIR
 318 This variable defines the directory in which per\-ebuild logs are kept.
 319 Logs are created only when this is set and writable.
 320 .TP
 321 \fBPORTAGE_BINHOST\fR = \fI"ftp://login:pass@grp.mirror.site/pub/grp/i686/athlon\-xp"\fR
 322 This is the host from which portage will grab prebuilt\-binary packages.
 323 The list is a single entry specifying the full address of the directory
 324 serving the tbz2's for your system.  This is only used when running with
 325 the get binary pkg options are given to \fBemerge\fR.  Review \fBemerge\fR(1)
 326 for more information.  Note that it should point to the 'All' directory on
 327 the host that creates the binary packages and not to the root of the \fBPKGDIR\fR.
 328 .TP
 329 \fBPORTAGE_COMPRESS\fR = \fI"bzip2"\fR
 330 This variable contains the command used to compress documentation during the
 331 install phase.
 332 .TP
 333 \fBPORTAGE_COMPRESS_FLAGS\fR = \fI"\-9"\fR
 334 This variable contains flags for the \fBPORTAGE_COMPRESS\fR command.
 335 .TP
 336 .B PORTAGE_ELOG_CLASSES
 337 .TP
 338 .B PORTAGE_ELOG_SYSTEM
 339 .TP
 340 .B PORTAGE_ELOG_COMMAND
 341 .TP
 342 .B PORTAGE_ELOG_MAILURI
 343 .TP
 344 .B PORTAGE_ELOG_MAILFROM
 345 .TP
 346 .B PORTAGE_ELOG_MAILSUBJECT
 347 Please see /etc/make.conf.example for elog documentation.
 348 .TP
 349 \fBPORTAGE_NICENESS\fR = \fI[number]\fR
 350 The value of this variable will be added to the current nice level that
 351 emerge is running at.  In other words, this will not set the nice level,
 352 it will increment it.  For more information about nice levels and what
 353 are acceptable ranges, see \fBnice\fR(1).
 354 .TP
 355 \fBPORTAGE_RSYNC_EXTRA_OPTS\fR = \fI[rsync options string]\fR
 356 Additional rsync options to be used by \fBemerge \-\-sync\fR.
 357 .br
 358 Defaults to no value.
 359 .TP
 360 \fBPORTAGE_RSYNC_OPTS\fR = \fI[rsync options string]\fR
 361 Default rsync options to be used by \fBemerge \-\-sync\fR.
 362 .br
 363 \fBDon't change this unless you know exactly what you're doing!\fR
 364 .br
 365 Defaults to "\-\-recursive \-\-links \-\-safe\-links \-\-perms \-\-times
 366 \-\-compress \-\-force \-\-whole\-file \-\-delete \-\-delete\-after \-\-stats
 367 \-\-timeout=180 \-\-exclude='/distfiles' \-\-exclude='/local'
 368 \-\-exclude='/packages'"
 369 .TP
 370 \fBPORTAGE_RSYNC_RETRIES\fR = \fI[NUMBER]\fR
 371 The number of times rsync should retry on failed connections before
 372 giving up.
 373 .br
 374 Defaults to 3.
 375 .TP
 376 \fBPORTAGE_TMPDIR\fR = \fI[path]\fR
 377 Defines the location of the temporary build directories.
 378 .br
 379 Defaults to /var/tmp.
 380 .TP
 381 \fBPORTDIR\fR = \fI[path]\fR
 382 Defines the location of your Portage tree.
 383 .br
 384 Defaults to /usr/portage.
 385 .TP
 386 \fBPORTDIR_OVERLAY\fR = \fI"[path] [different\-path] [etc...]"\fR
 387 Defines the directories in which user made ebuilds may be stored and not
 388 overwriten when `emerge \-\-sync` is run.  This is a space delimited list of
 389 directories.
 390 .br
 391 Defaults to no value.
 392 .TP
 393 \fBQA_STRICT_EXECSTACK = \fI"set"\fR
 394 Set this to cause portage to ignore any \fIQA_EXECSTACK\fR override
 395 settings from ebuilds.  See also \fBebuild\fR(5).
 396 .TP
 397 \fBQA_STRICT_WX_LOAD = \fI"set"\fR
 398 Set this to cause portage to ignore any \fIQA_WX_LOAD\fR override
 399 settings from ebuilds.  See also \fBebuild\fR(5).
 400 .TP
 401 \fBQA_STRICT_TEXTRELS = \fI"set"\fR
 402 Set this to cause portage to ignore any \fIQA_TEXTREL\fR override
 403 settings from ebuilds.  See also \fBebuild\fR(5).
 404 .TP
 405 .B RESUMECOMMAND
 406 This variable contains the command used for resuming package sources that
 407 have been partially downloaded.  It should be defined using the same format
 408 as \fBFETCHCOMMAND\fR.
 409 .TP
 410 \fBROOT\fR = \fI[path]\fR
 411 Use \fBROOT\fR to specify the target root filesystem to be used for merging
 412 packages or ebuilds.  All \fBRDEPEND\fR and \fBPDEPEND\fR will be installed
 413 into \fBROOT\fR while all \fBDEPEND\fR will be still be installed into /.
 414 Typically, you should set this setting in the environment rather than in
 415 \fI/etc/make.conf\fR itself.  It's commonly used for creating new build
 416 images.  Make sure you use an absolute path.
 417 .br
 418 Defaults to /.
 419 .TP
 420 \fBRPMDIR\fR = \fI[path]\fR
 421 Defines the location where created RPM packages will be stored.
 422 .br
 423 Defaults to ${PORTDIR}/rpm.
 424 .TP
 425 \fBSYNC\fR = \fI[RSYNC]\fR
 426 Insert your preferred rsync mirror here.  This rsync server
 427 is used to sync the local portage tree when `emerge \-\-sync` is run.
 428 .br
 429 Defaults to rsync://rsync.gentoo.org/gentoo\-portage
 430 .TP
 431 \fBUSE\fR = \fI[space delimited list of USE items]\fR
 432 This variable contains options that control the build behavior of several
 433 packages.  More information in \fBebuild\fR(5).  Possible USE values
 434 can be found in \fI/usr/portage/profiles/use.desc\fR.
 435 .TP
 436 \fBUSE_EXPAND_HIDDEN\fR = \fI[space delimited list of variable names]\fR
 437 Names of \fBUSE_EXPAND\fR variables that should not be shown in the verbose merge
 438 list output of the \fBemerge\fR(1) command.
 439 .TP
 440 \fBUSE_ORDER\fR = \fI"env:pkg:conf:defaults:pkginternal"\fR
 441 Determines the precedence of layers in the incremental stacking of the USE
 442 variable. Precedence decreases from left to right such that env overrides
 443 pkg, pkg overrides conf, and so forth.
 444
 445 .B ***warning***
 446 .br
 447 Do not modify this value unless you're a developer and you know what
 448 you're doing. If you change this and something breaks, we will not help
 449 you fix it.
 450 .br
 451 .RS
 452 .TP
 453 .B env
 454 USE from the current USE environment variable if it exists
 455 .TP
 456 .B pkg
 457 Per\-package USE from \fB/etc/portage/package.use\fR (see \fBportage\fR(5))
 458 .TP
 459 .B conf
 460 USE from make.conf
 461 .TP
 462 .B defaults
 463 USE from make.defaults and package.use in the profile (see \fBportage\fR(5))
 464 .TP
 465 .B pkginternal
 466 USE from ebuild IUSE defaults (flags enabled via a + prefix; see \fBebuild\fR(5))
 467 .RE
 468
 469 .SH "REPORTING BUGS"
 470 Please report bugs via http://bugs.gentoo.org/
 471 .SH "AUTHORS"
 472 .nf
 473 Daniel Robbins <drobbins@gentoo.org>
 474 Nicholas Jones <carpaski@gentoo.org>
 475 Mike Frysinger <vapier@gentoo.org>
 476 Saleem Abdulrasool <compnerd@gentoo.org>
 477 .fi
 478 .SH "FILES"
 479 .TP
 480 \fB/etc/make.conf\fR
 481 Contains variables for the build\-process and overwrites those in make.defaults.
 482 .TP
 483 \fB/etc/make.globals\fR
 484 Contains the default variables for the build\-process, you should edit \fI/etc/make.conf\fR instead.
 485 .TP
 486 \fB/usr/portage/profiles/use.desc\fR
 487 Contains a list of all global USE flags.
 488 .TP
 489 \fB/usr/portage/profiles/use.local.desc\fR
 490 Contains a list of all local USE variables.
 491 .SH "SEE ALSO"
 492 .BR emerge (1),
 493 .BR portage (5),
 494 .BR ebuild (1),
 495 .BR ebuild (5)
 496 .TP
 497 The \fI/usr/sbin/ebuild.sh\fR script.
 498 .TP
 499 The helper apps in \fI/usr/lib/portage/bin\fR.