man/make.conf.5

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