man/emerge.1

   1 .TH "EMERGE" "1" "Aug 2008" "Portage 2.2" "Portage"
   2 .SH "NAME"
   3 emerge \- Command\-line interface to the Portage system
   4 .SH "SYNOPSIS"
   5 .TP
   6 .BR emerge
   7 [\fIoptions\fR] [\fIaction\fR] [\fIebuild\fR | \fItbz2file\fR | \fIfile\fR | \fI@set\fR | \fIatom\fR] ...
   8 .TP
   9 .BR emerge
  10 \fB\-\-sync\fR | \fB\-\-version\fR
  11 .TP
  12 .BR emerge
  13 \fB\-\-info\fR [\fIatom\fR]
  14 .TP
  15 .BR emerge
  16 \fB\-\-search\fR \fIsomestring\fR
  17 .TP
  18 .BR emerge
  19 \fB\-\-help\fR [\fB\-\-sync\fR]
  20 .SH "DESCRIPTION"
  21 \fBemerge\fR is the definitive command\-line interface to the Portage
  22 system.  It is primarily used for installing packages, and \fBemerge\fR
  23 can automatically handle any dependencies that the desired package has.
  24 \fBemerge\fR can also update the \fBportage tree\fR, making new and
  25 updated packages available.  \fBemerge\fR gracefully handles updating
  26 installed packages to newer releases as well.  It handles both source
  27 and binary packages, and it can be used to create binary packages for
  28 distribution.
  29 .SH "EBUILDS, TBZ2S, SETS AND ATOMS"
  30 \fBemerge\fR primarily installs packages.  You can specify
  31 packages to install in one of four main ways: an \fIebuild\fR,
  32 a \fItbz2file\fR, a \fIset\fR, or an \fIatom\fR.
  33 .LP
  34 .TP
  35 .BR ebuild
  36 An \fIebuild\fR must be, at a minimum, a valid Portage
  37 package directory name without a version or category, such as
  38 \fBportage\fR or \fBpython\fR.
  39 Both categories and version numbers may be used in addition, such
  40 as \fBsys\-apps/portage\fR or \fB=python\-2.2.1\-r2\fR.
  41 \fBemerge\fR
  42 ignores a trailing slash so that filename completion can be used.
  43 The \fIebuild\fR may also be an actual filename, such as
  44 \fB/usr/portage/app\-admin/python/python\-2.2.1\-r2.ebuild\fR.
  45 \fBWARNING:\fR The implementation of \fBemerge /path/to/ebuild\fR is broken and
  46 so this syntax shouldn't be used.
  47 .TP
  48 .BR tbz2file
  49 A \fItbz2file\fR must be a valid .tbz2 created with \fBebuild
  50 <package>\-<version>.ebuild package\fR or \fBemerge \-\-buildpkg
  51 [category/]<package>\fR or \fBquickpkg /var/db/pkg/<category>/<package>\fR.
  52 .TP
  53 .BR file
  54 A \fIfile\fR must be a file or directory that has been installed by one or
  55 more packages. For directories that are owned by multiple packages, all
  56 owning packages to be selected. See the portageq(1) owners command if you
  57 would like to query the owners of one or more files or directories.
  58 .TP
  59 .BR set
  60 A \fIset\fR is a convenient shorthand for a large group of
  61 packages.  Two sets are currently always available: \fBsystem\fR
  62 and \fBworld\fR.  \fBsystem\fR refers to a set of packages
  63 deemed necessary for your system to run properly. \fBworld\fR
  64 contains all the packages listed in \fB/var/lib/portage/world\fR.  [See
  65 \fBFILES\fR below for more information.] Other sets can exist depending
  66 on the current configuration. The default set configuration is located
  67 in \fB/usr/share/portage/config/sets.conf\fR. Note that a \fIset\fR
  68 is generally used in conjunction with \fB\-\-update\fR. When used as
  69 arguments to \fBemerge\fR sets have to be prefixed with \fB@\fR to be
  70 recognized. Use the \fB\-\-list\-sets\fR action to display a list of
  71 available package sets.
  72 .TP
  73 .BR atom
  74 An \fIatom\fR describes bounds on a package that you wish to install.
  75 \fISee portage(5) for the details on atom syntax.\fR  For example,
  76 \fB>=dev\-lang/python\-2.2.1\-r2\fR matches the latest available version of
  77 Python greater than or equal to 2.2.1\-r2.  Similarly,
  78 \fB<dev\-lang/python\-2.0\fR matches the latest available version of Python
  79 before 2.0.  Note that in many shells you will need to escape characters such
  80 as '<' and '='; use single\- or double\-quotes around the \fIatom\fR
  81 to get around escaping problems.
  82 .SH "ACTIONS"
  83 .TP
  84 .BR "No action"
  85 If no action is specified, the action is to merge in the specified
  86 packages, satisfying any dependencies that they may have.  The
  87 arguments can be \fIebuilds\fR, \fItbz2s\fR, \fIsets\fR, or
  88 \fIatoms\fR.  \fBNote that you need to use the \-\-usepkg
  89 option if you want to install a tbz2\fR.  The packages are added
  90 to the \fBworld\fR file at the end, so that they are considered for
  91 later updating.
  92 .TP
  93 .BR "\-\-clean " (\fB\-c\fR)
  94 Cleans up the system by examining the installed packages and removing older
  95 packages.  This is accomplished by looking at each installed package and separating
  96 the installed versions by \fBslot\fR.  Clean will \fBremove all but the most recently
  97 installed version in each \fbslot\fR.  Clean should not remove unslotted packages.
  98 Note: Most recently installed means most \fBrecent\fR, not highest version.
  99 .TP
 100 .BR "\-\-config "
 101 Run package specific actions needed to be executed after the emerge process
 102 has completed.  This usually entails configuration file setup or other similar
 103 setups that the user may wish to run.
 104 .TP
 105 .BR \-\-depclean
 106 Cleans the system by removing packages that are not associated
 107 with explicitly merged packages. Depclean works by creating the
 108 full dependency tree from the @system and @world sets,
 109 then comparing it to installed packages. Packages installed, but
 110 not part of the dependency tree, will be uninstalled by depclean.
 111 See \fB\-\-with\-bdeps\fR for behavior with respect to build time dependencies
 112 that are not strictly required. Packages that are part of the world set will
 113 always be kept. They can be manually added to this set with \fIemerge
 114 \-\-noreplace <atom>\fR. As a safety measure, depclean will not remove any
 115 packages unless *all* required dependencies have been resolved. As a
 116 consequence, it is often necessary to run \fIemerge \-\-update \-\-newuse
 117 \-\-deep @system @world\fR prior to depclean.
 118
 119 \fBWARNING:\fR
 120 Inexperienced users are advised to use \fB\-\-pretend\fR with this
 121 option in order to see a preview of which packages
 122 will be uninstalled. Always study the list of packages
 123 to be cleaned for any obvious mistakes. Note that packages listed in
 124 package.provided (see \fBportage\fR(5)) may be removed by
 125 depclean, even if they are part of the world set.
 126
 127 Depclean serves as a dependency aware
 128 version of \fB\-\-unmerge\fR. When given one or more atoms, it will
 129 unmerge matched packages that have no reverse dependencies. Use
 130 \fB\-\-depclean\fR together with \fB\-\-verbose\fR to show reverse
 131 dependencies.
 132 .TP
 133 .BR "\-\-help " (\fB\-h\fR)
 134 Displays help information for emerge.  Adding one of the additional
 135 arguments listed above will give you more specific help information
 136 on that subject.  The internal \fBemerge\fR help documentation is
 137 updated more frequently than this man page; check it out if you
 138 are having problems that this man page does not help resolve.
 139 .TP
 140 .BR \-\-info
 141 Produces a list of information to include in bug reports which aids the
 142 developers when fixing the reported problem.  \fBPlease include this
 143 information when submitting a bug report.\fR  Expanded output can be obtained
 144 with the \fI\-\-verbose\fR option.
 145 .TP
 146 .BR \-\-list\-sets
 147 Displays a list of available package sets.
 148 .TP
 149 .BR \-\-metadata
 150 Transfers metadata cache from ${PORTDIR}/metadata/cache/ to
 151 /var/cache/edb/dep/ as is normally done on the
 152 tail end of an rsync update using \fBemerge \-\-sync\fR.  This process
 153 populates the cache database that portage uses for pre-parsed lookups of
 154 package data.  It does not populate cache for the overlays listed in
 155 PORTDIR_OVERLAY.  In order to generate cache for overlays, use \fB\-\-regen\fR.
 156 In versions of portage >=2.1.5 the \-\-metadata action is totally unnecessary
 157 unless the user has enabled FEATURES="metadata-transfer" in \fBmake.conf\fR(5).
 158 .TP
 159 .BR "\-\-prune " (\fB\-P\fR)
 160 \fBWARNING: This action can remove important packages!\fR  Removes all but the
 161 highest installed version of a package from your system. Use \fB\-\-prune\fR
 162 together with \fB\-\-verbose\fR to show reverse dependencies or with
 163 \fB\-\-nodeps\fR to ignore all dependencies.
 164 .TP
 165 .BR \-\-regen
 166 Causes portage to check and update the dependency cache of all ebuilds in the
 167 portage tree.  The cache is used to speed up searches and the building of
 168 dependency trees.  This command is not recommended for rsync users as rsync
 169 updates the cache using server\-side caches.  If you do not know the
 170 differences between a 'rsync user' and some other user, then you are a 'rsync
 171 user' :).  Rsync users should simply run \fBemerge \-\-sync\fR to regenerate
 172 the cache.  After a portage update, rsync users may find it convenient to run
 173 \fBemerge \-\-metadata\fR to rebuild the cache as portage does at the end of
 174 a sync operation. In order to specify parallel \fB\-\-regen\fR behavior, use
 175 the \fB\-\-jobs\fR and \fB\-\-load\-average\fR options.
 176 .TP
 177 .BR "\-\-resume"
 178 Resumes the most recent merge list that has been aborted due to an error.
 179 Please note that this operation will only return an error on failure.  If there
 180 is nothing for portage to do, then portage will exit with a message and a
 181 success condition. A resume list will persist until it has been completed in
 182 entirety or until another aborted merge list replaces it.  The resume history
 183 is capable of storing two merge lists.  After one resume list completes, it is
 184 possible to invoke \-\-resume once again in order to resume an older list.
 185 .TP
 186 .BR "\-\-search " (\fB\-s\fR)
 187 Searches for matches of the supplied string in the portage tree.
 188 By default emerge uses a case-insensitive simple search, but you can
 189 enable a regular expression search by prefixing the search string with %.
 190 For example, \fBemerge \-\-search "%^kde"\fR searches for any package whose
 191 name starts with "kde"; \fBemerge \-\-search "%gcc$"\fR searches for any
 192 package that ends with "gcc"; \fBemerge \-\-search "office"\fR searches for
 193 any package that contains the word "office".  If you want to include the
 194 category into the search string, prepend an @: \fBemerge --search
 195 "%@^dev-java.*jdk"\fR. If you want to search the package descriptions as well,
 196 use the \fB\-\-searchdesc\fR action.
 197 .TP
 198 .BR "\-\-searchdesc " (\fB\-S\fR)
 199 Matches the search string against the description field as well as
 200 the package name.  \fBTake caution\fR as the descriptions are also
 201 matched as regular expressions.
 202 .TP
 203 .BR \-\-sync
 204 Initiates a portage tree update with one of the rsync.gentoo.org
 205 mirrors.  \fBNote that any changes you have made to the portage
 206 tree will be erased\fR.  Except for special circumstances,
 207 this uses \fBrsync\fR to do the update.  See \fBmake.conf\fR(5)'s
 208 description of PORTDIR_OVERLAY for a method to avoid deletions.
 209 .TP
 210 .BR "\-\-unmerge " (\fB\-C\fR)
 211 \fBWARNING: This action can remove important packages!\fR Removes
 212 all matching packages.  This does no checking of dependencies, so
 213 it may remove packages necessary for the proper operation of your
 214 system.  Its arguments can be \fIatoms\fR or
 215 \fIebuilds\fR. For a dependency aware version of \fB\-\-unmerge\fR,
 216 use \fB\-\-depclean\fR or \fB\-\-prune\fR.
 217 .TP
 218 .BR "\-\-update " (\fB\-u\fR)
 219 Updates packages to the best version available, which may not always be the
 220 highest version number due to masking for testing and development.  This will
 221 also update direct dependencies which may not be what you want.  Package atoms
 222 specified on the command line are greedy, meaning that unspecific atoms may
 223 match multiple installed versions of slotted packages.
 224 .TP
 225 .BR "\-\-version " (\fB\-V\fR)
 226 Displays the version number of \fBemerge\fR.
 227 .SH "OPTIONS"
 228 .TP
 229 .BR "\-\-alphabetical "
 230 When displaying USE and other flag output, combines the enabled and
 231 disabled lists into one list and sorts the whole list alphabetically.
 232 .TP
 233 .BR "\-\-ask " (\fB\-a\fR)
 234 Before performing the action, display what will take place (server info for
 235 \fB\-\-sync\fR, \fB\-\-pretend\fR output for merge, and so forth), then ask
 236 whether to proceed with the action or abort.  Using \fB\-\-ask\fR is more
 237 efficient than using \fB\-\-pretend\fR and then executing the same command
 238 without \fB\-\-pretend\fR, as dependencies will only need to be calculated once.
 239 \fBWARNING: If the "Enter" key is pressed at the prompt (with no other input),
 240 it is interpreted as acceptance of the first choice.  Note that the input
 241 buffer is not cleared prior to the prompt, so an accidental press of the
 242 "Enter" key at any time prior to the prompt will be interpreted as a choice!\fR
 243 .TP
 244 .BR "\-\-buildpkg " (\fB\-b\fR)
 245 Tells emerge to build binary packages for all ebuilds processed in
 246 addition to actually merging the packages.  Useful for maintainers
 247 or if you administrate multiple Gentoo Linux systems (build once,
 248 emerge tbz2s everywhere) as well as disaster recovery. The package
 249 will be created in the \fBPKGDIR\fR directory (see \fBmake.conf\fR(5)).
 250 An alternative for already\-merged
 251 packages is to use \fBquickpkg\fR(1) which creates a tbz2 from the
 252 live filesystem.
 253 .TP
 254 .BR "\-\-buildpkgonly " (\fB\-B\fR)
 255 Creates binary packages for all ebuilds processed without actually
 256 merging the packages.  This comes with the caveat that all build-time
 257 dependencies must already be emerged on the system.
 258 .TP
 259 .BR "\-\-changelog " (\fB\-l\fR)
 260 Use this in conjunction with the \fB\-\-pretend\fR option.  This will
 261 show the ChangeLog entries for all the packages that will be upgraded.
 262 .TP
 263 .BR "\-\-color < y | n >"
 264 Enable or disable color output.  This option will override \fINOCOLOR\fR
 265 (see \fBmake.conf\fR(5)) and may also be used to force color output when stdout
 266 is not a tty (by default, color is disabled unless stdout is a tty).
 267 .TP
 268 .BR "\-\-columns"
 269 Used alongside \fB\-\-pretend\fR to cause the package name, new version,
 270 and old version to be displayed in an aligned format for easy cut\-n\-paste.
 271 .TP
 272 .BR "\-\-complete\-graph"
 273 This causes \fBemerge\fR to consider the deep dependencies of all
 274 packages from the system and world sets. With this option enabled,
 275 \fBemerge\fR will bail out if it determines that the given operation will
 276 break any dependencies of the packages that have been added to the
 277 graph. Like the \fB\-\-deep\fR option, the \fB\-\-complete\-graph\fR
 278 option will significantly increase the time taken for dependency
 279 calculations. Note that, unlike the \fB\-\-deep\fR option, the
 280 \fB\-\-complete\-graph\fR option does not cause any more packages to
 281 be updated than would have otherwise been updated with the option disabled.
 282 .TP
 283 .BR \-\-config\-root=DIR
 284 Set the \fBPORTAGE_CONFIGROOT\fR environment variable.
 285 .TP
 286 .BR "\-\-debug " (\fB\-d\fR)
 287 Tells emerge to run the emerge command in \fB\-\-debug\fR mode.  In this
 288 mode the bash build environment will run with the \-x option, causing
 289 it to output verbose debugging information to stdout.  This also enables
 290 a plethora of other output (mostly dependency resolution messages).
 291 .TP
 292 .BR "\-\-deep " (\fB\-D\fR)
 293 This flag forces
 294 \fBemerge\fR to consider the entire dependency tree of packages,
 295 instead of checking only the immediate dependencies of the packages.
 296 As an example, this catches updates in libraries that are not directly
 297 listed in the dependencies of a package.  Also see \fB\-\-with\-bdeps\fR for
 298 behavior with respect to build time dependencies that are not strictly
 299 required.
 300 .TP
 301 .BR "\-\-emptytree " (\fB\-e\fR)
 302 Reinstalls all world packages and their dependencies to the current USE
 303 specifications while differing from the installed set of packages as
 304 little as possible.  You should run with \fB\-\-pretend\fR first to make
 305 sure the result is what you expect.
 306 .TP
 307 .BR "\-\-fetchonly " (\fB\-f\fR)
 308 Instead of doing any package building, just perform fetches for all
 309 packages (fetch things from SRC_URI based upon USE setting).
 310 .TP
 311 .BR "\-\-fetch\-all\-uri " (\fB\-F\fR)
 312 Instead of doing any package building, just perform fetches for all
 313 packages (fetch everything in SRC_URI regardless of USE setting).
 314 .TP
 315 .BR "\-\-getbinpkg " (\fB\-g\fR)
 316 Using the server and location defined in \fIPORTAGE_BINHOST\fR (see
 317 \fBmake.conf\fR(5)), portage will download the information from each binary
 318 package found and it will use that information to help build the dependency
 319 list.  This option implies \fB\-k\fR.  (Use \fB\-gK\fR for binary\-only
 320 merging.)
 321 .TP
 322 .BR "\-\-getbinpkgonly " (\fB\-G\fR)
 323 This option is identical to \fB\-g\fR, as above, except it will not use ANY
 324 information from the local machine.  All binaries will be downloaded from the
 325 remote server without consulting packages existing in the local packages
 326 directory.
 327 .TP
 328 .BR "\-\-ignore-default-opts"
 329 Causes \fIEMERGE_DEFAULT_OPTS\fR (see \fBmake.conf\fR(5)) to be ignored.
 330 .TP
 331 .BR "-j [JOBS], \-\-jobs[=JOBS]"
 332 Specifies the number of packages to build simultaneously. If this option is
 333 given without an argument, emerge will not limit the number of jobs that can
 334 run simultaneously. Also see the related \fB\-\-load\-average\fR option.
 335 .TP
 336 .BR "\-\-keep\-going"
 337 Continue as much as possible after an error. When an error occurs,
 338 dependencies are recalculated for remaining packages and any with
 339 unsatisfied dependencies are automatically dropped. Also see
 340 the related \fB\-\-skipfirst\fR option.
 341 .TP
 342 .BR \-\-load\-average=LOAD
 343 Specifies that no new builds should be started if there are other builds
 344 running and the load average is at least LOAD (a floating-point number).
 345 This option is recommended for use in combination with \fB\-\-jobs\fR in
 346 order to avoid excess load. See \fBmake\fR(1) for information about
 347 analogous options that should be configured via \fBMAKEOPTS\fR in
 348 \fBmake.conf\fR(5).
 349 .TP
 350 .BR "\-\-newuse " (\fB\-N\fR)
 351 Tells emerge to include installed packages where USE flags have changed since
 352 compilation.  USE flag changes include:
 353
 354 A USE flag was added to a package.
 355 A USE flag was removed from a package.
 356 A USE flag was turned on for a package.
 357 A USE flag was turned off for a package.
 358
 359 USE flags may be toggled by your profile as well as your USE and package.use
 360 settings.
 361 .TP
 362 .BR "\-\-noconfmem"
 363 Causes portage to disregard merge records indicating that a config file
 364 inside of a \fBCONFIG_PROTECT\fR directory has been merged already.  Portage
 365 will normally merge those files only once to prevent the user from
 366 dealing with the same config multiple times.  This flag will cause the
 367 file to always be merged.
 368 .TP
 369 .BR "\-\-nodeps " (\fB\-O\fR)
 370 Merges specified packages without merging any dependencies.  Note that
 371 the build may fail if the dependencies aren't satisfied.
 372 .TP
 373 .BR "\-\-noreplace " (\fB\-n\fR)
 374 Skips the packages specified on the command\-line that have already
 375 been installed.  Without this option, any packages, ebuilds, or deps
 376 you specify on the command\-line \fBwill\fR cause Portage to remerge
 377 the package, even if it is already installed.  Note that Portage will
 378 not remerge dependencies by default.
 379 .TP
 380 .BR "\-\-nospinner"
 381 Disables the spinner for the session.  The spinner is active when the
 382 terminal device is determined to be a TTY.  This flag disables it regardless.
 383 .TP
 384 .BR "\-\-oneshot " (\fB\-1\fR)
 385 Emerge as normal, but do not add the packages to the world file
 386 for later updating.
 387 .TP
 388 .BR "\-\-onlydeps " (\fB\-o\fR)
 389 Only merge (or pretend to merge) the dependencies of the packages
 390 specified, not the packages themselves.
 391 .TP
 392 .BR "\-\-pretend " (\fB\-p\fR)
 393 Instead of actually performing the merge, simply display what *would*
 394 have been installed if \fB\-\-pretend\fR weren't used.  Using \fB\-\-pretend\fR
 395 is strongly recommended before installing an unfamiliar package.  In
 396 the printout:
 397
 398 .TS
 399 lI l.
 400 N       new (not yet installed)
 401 S       new SLOT installation (side-by-side versions)
 402 U       updating (to another version)
 403 D       downgrading (best version seems lower)
 404 R       replacing (remerging same version))
 405 F       fetch restricted (must be manually downloaded)
 406 f       fetch restricted (already downloaded)
 407 I       interactive (requires user input)
 408 B       blocked by an already installed package
 409 .TE
 410 .TP
 411 .BR "\-\-quiet " (\fB\-q\fR)
 412 Results may vary, but the general outcome is a reduced or condensed
 413 output from portage's displays.
 414 .TP
 415 .BR "\-\-reinstall changed\-use"
 416 Tells emerge to include installed packages where USE flags have
 417 changed since installation.  Unlike \fB\-\-newuse\fR, this option does
 418 not trigger reinstallation when flags that the user has not
 419 enabled are added or removed.
 420 .TP
 421 .BR "\-\-skipfirst"
 422 This option is only valid when used with \fB\-\-resume\fR.  It removes the
 423 first package in the resume list. Dependencies are recalculated for
 424 remaining packages and any that have unsatisfied dependencies or are
 425 masked will be automatically dropped. Also see the related
 426 \fB\-\-keep\-going\fR option.
 427 .TP
 428 .BR "\-\-tree " (\fB\-t\fR)
 429 Shows the dependency tree for the given target by indenting dependencies.
 430 This is only really useful in combination with \fB\-\-emptytree\fR or
 431 \fB\-\-update\fR and \fB\-\-deep\fR.
 432 .TP
 433 .BR "\-\-usepkg " (\fB\-k\fR)
 434 Tells emerge to use binary packages (from $PKGDIR) if they are available, thus
 435 possibly avoiding some time\-consuming compiles.  This option is useful for CD
 436 installs; you can export PKGDIR=/mnt/cdrom/packages and then use this option to
 437 have emerge "pull" binary packages from the CD in order to satisfy dependencies.
 438 .TP
 439 .BR "\-\-usepkgonly " (\fB\-K\fR)
 440 Tells emerge to only use binary packages (from $PKGDIR).  All the binary
 441 packages must be available at the time of dependency calculation or emerge
 442 will simply abort.  Portage does not use $PORTDIR when calculating dependency
 443 information so all masking information is ignored.
 444 .TP
 445 .BR "\-\-verbose " (\fB\-v\fR)
 446 Tell emerge to run in verbose mode.  Currently this flag causes emerge to print
 447 out GNU info errors, if any, and to show the USE flags that will be used for
 448 each package when pretending. The following symbols are affixed to USE flags
 449 in order to indicate their status:
 450
 451 .TS
 452 l l l
 453 ___
 454 l l l.
 455 Symbol  Location        Meaning
 456
 457 -       prefix  not enabled (either disabled or removed)
 458 *       suffix  transition to or from the enabled state
 459 %       suffix  newly added or removed
 460 ()      circumfix       forced, masked, or removed
 461 .TE
 462 .TP
 463 .BR "\-\-with\-bdeps < y | n >"
 464 In dependency calculations, pull in build time dependencies
 465 that are not strictly required. This defaults to \'n\' for
 466 installation actions, meaning they will not be installed, and
 467 \'y\' for the \fB\-\-depclean\fR action, meaning they will not be removed.
 468 This setting can be added to
 469 \fBEMERGE_DEFAULT_OPTS\fR (see make.conf(5)) and later overridden via the
 470 command line.
 471 .SH "ENVIRONMENT OPTIONS"
 472 .TP
 473 \fBROOT\fR = \fI[path]\fR
 474 Use \fBROOT\fR to specify the target root filesystem to be used for
 475 merging packages or ebuilds.  This variable can be set in \fBmake.conf\fR(5).
 476 .br
 477 Defaults to /.
 478 .TP
 479 \fBPORTAGE_CONFIGROOT\fR = \fI[path]\fR
 480 Use \fBPORTAGE_CONFIGROOT\fR to specify the location for various portage
 481 configuration files
 482 (see \fBFILES\fR for a detailed list of configuration files).  This variable
 483 can be set via the \fB\-\-config\-root\fR option.
 484 .br
 485 Defaults to /.
 486 .SH "OUTPUT"
 487 When utilizing \fBemerge\fR with the \fB\-\-pretend\fR and \fB\-\-verbose\fR
 488 flags, the output may be a little hard to understand at first.  This section
 489 explains the abbreviations.
 490 .TP
 491 .B [blocks B     ] app\-text/dos2unix (from pkg app\-text/hd2u\-0.8.0)
 492 Dos2unix is Blocking hd2u from being emerged.  Blockers are defined when
 493 two packages will clobber each others files, or otherwise cause some form
 494 of breakage in your system.  However, blockers usually do not need to be
 495 simultaneously emerged because they usually provide the same functionality.
 496 .TP
 497 .B [ebuild  N    ] app\-games/qstat\-25c
 498 Qstat is New to your system, and will be emerged for the first time.
 499 .TP
 500 .B [ebuild  NS   ] dev-libs/glib-2.4.7
 501 You already have a version of glib installed, but a 'new' version in
 502 a different SLOT is available.
 503 .TP
 504 .B [ebuild   R   ] sys\-apps/sed\-4.0.5
 505 Sed 4.0.5 has already been emerged, but if you run the command, then
 506 portage will Re\-emerge the specified package (sed in this case).
 507 .TP
 508 .B [ebuild    F  ] media\-video/realplayer\-8\-r6
 509 The realplayer package requires that you Fetch the sources manually.
 510 When you attempt to emerge the package, if the sources are not found,
 511 then portage will halt and you will be provided with instructions on how
 512 to download the required files.
 513 .TP
 514 .B [ebuild    f  ] media\-video/realplayer\-8\-r6
 515 The realplayer package's files are already downloaded.
 516 .TP
 517 .B [ebuild     U ] net\-fs/samba\-2.2.8_pre1 [2.2.7a]
 518 Samba 2.2.7a has already been emerged and can be Updated to version
 519 2.2.8_pre1.
 520 .TP
 521 .B [ebuild     UD] media\-libs/libgd\-1.8.4 [2.0.11]
 522 Libgd 2.0.11 is already emerged, but if you run the command, then
 523 portage will Downgrade to version 1.8.4 for you.
 524 .br
 525 This may occur if a newer version of a package has been masked because it is
 526 broken or it creates a security risk on your system and a fix has not been
 527 released yet.
 528 .br
 529 Another reason this may occur is if a package you are trying to emerge requires
 530 an older version of a package in order to emerge successfully.  In this case,
 531 libgd 2.x is incompatible with libgd 1.x.  This means that packages that were
 532 created with libgd 1.x will not compile with 2.x and must downgrade libgd first
 533 before they can emerge.
 534 .TP
 535 .B [ebuild     U ] sys\-devel/distcc\-2.16 [2.13\-r1] USE="ipv6* \-gtk \-qt%"
 536 Here we see that the make.conf variable \fBUSE\fR affects how this package is
 537 built.  In this example, ipv6 optional support is enabled and both gtk and qt
 538 support are disabled.  The asterisk following ipv6 indicates that ipv6 support
 539 was disabled the last time this packages was installed.  The percent sign
 540 following qt indicates that the qt option has been added to the package since
 541 it was last installed.  For information about all \fBUSE\fR symbols, see the
 542 \fB\-\-verbose\fR option documentation above.
 543 .br
 544 \fB*Note:\fR Flags that haven't changed since the last install are only
 545 displayed when you use the \fB\-\-pretend\fR and \fB\-\-verbose\fR options.
 546 Using the \fB\-\-quiet\fR option will prevent all information from being
 547 displayed.
 548 .SH "NOTES"
 549 You should almost always precede any package install or update attempt with a
 550 \fB\-\-pretend\fR install or update.  This lets you see how much will be
 551 done, and shows you any blocking packages that you will have to rectify.
 552 This goes doubly so for the \fBsystem\fR and \fBworld\fR sets, which can
 553 update a large number of packages if the portage tree has been particularly
 554 active.
 555 .LP
 556 You also want to typically use \fB\-\-update\fR, which ignores packages that
 557 are already fully updated but updates those that are not.
 558 .LP
 559 When you install a package with uninstalled dependencies and do
 560 not explicitly state those dependencies in the list of parameters,
 561 they will not be added to the world file.  If you want them to be
 562 detected for world updates, make sure to explicitly list them as
 563 parameters to \fBemerge\fR.
 564 .LP
 565 \fBUSE variables\fR may be specified on the command line to
 566 override those specified in the default locations, letting you
 567 avoid using some dependencies you may not want to have.  \fBUSE
 568 flags specified on the command line are NOT remembered\fR.  For
 569 example, \fBenv USE="\-X \-gnome" emerge mc\fR will emerge mc with
 570 those USE settings (on Bourne-compatible shells you may omit the \fBenv\fR
 571 part).  If you want those USE settings to be more
 572 permanent, you can put them in /etc/portage/package.use instead.
 573 .LP
 574 If \fBemerge \-\-update system\fR or \fBemerge \-\-update world\fR
 575 fails with an error message, it may be that an ebuild uses some
 576 newer feature not present in this version of \fBemerge\fR.  You
 577 can use \fBemerge \-\-update portage\fR to upgrade to the lastest
 578 version, which should support any necessary new features.
 579 .SH "MASKED PACKAGES"
 580 \fINOTE: Please use caution when using development packages.  Problems
 581 and bugs resulting from misusing masked packages drains Gentoo
 582 developer time.  Please be sure you are capable of handling any problems
 583 that may ensue.\fR
 584 .LP
 585 Masks in \fBportage\fR have many uses: they allow a
 586 testing period where the packages can be used in live machines; they
 587 prevent the use of a package when it will fail; and they mask existing
 588 packages that are broken or could pose a security risk.  Read below
 589 to find out how to unmask in various cases.  Also note that if you give
 590 \fBemerge\fR an ebuild, then all forms of masking will be ignored and
 591 \fBemerge\fR will attempt to emerge the package.
 592 .TP
 593 .BR package.mask
 594 The \fBpackage.mask\fR file primarily blocks the use of packages that cause
 595 problems or are known to have issues on different systems.  It resides in
 596 \fI/usr/portage/profiles\fR.
 597 .TP
 598 .BR CHOST
 599 Use the \fBACCEPT_CHOSTS\fR variable in \fBmake.conf\fR(5) to control
 600 \fBCHOST\fR acceptance for binary packages.
 601 .TP
 602 .BR EAPI
 603 The \fBEAPI\fR variable in an \fBebuild\fR(5) file is used to mask packages
 604 that are not supported by the current version of portage. Packages masked by
 605 \fBEAPI\fR can only be installed after portage has been upgraded.
 606 .TP
 607 .BR KEYWORDS
 608 The \fBKEYWORDS\fR variable in an \fBebuild\fR file is also used for masking
 609 a package still in testing.  There are architecture\-specific keywords for
 610 each package that let \fBportage\fR know which systems are compatible with
 611 the package.  Packages which compile on an architecture, but have not been
 612 proven to be "stable", are masked with a tilde (\fB~\fR) in front of the
 613 architecture name.  \fBemerge\fR examines the \fBACCEPT_KEYWORDS\fR environment
 614 variable to allow or disallow the emerging of a package masked by
 615 \fBKEYWORDS\fR.  To inform \fBemerge\fR that it should build these 'testing'
 616 versions of packages, you should update your
 617 \fI/etc/portage/package.keywords\fR file to list the packages you want the
 618 \'testing\' version.  See \fBportage\fR(5) for more information.
 619 .SH "CONFIGURATION FILES"
 620 Portage has a special feature called "config file protection". The purpose of
 621 this feature is to prevent new package installs from clobbering existing
 622 configuration files. By default, config file protection is turned on for /etc
 623 and the KDE configuration dirs; more may be added in the future.
 624 .LP
 625 When Portage installs a file into a protected directory tree like /etc, any
 626 existing files will not be overwritten. If a file of the same name already
 627 exists, Portage will change the name of the to\-be\-installed file from 'foo' to
 628 \'._cfg0000_foo\'. If \'._cfg0000_foo\' already exists, this name becomes
 629 \'._cfg0001_foo\', etc. In this way, existing files are not overwritten,
 630 allowing the administrator to manually merge the new config files and avoid any
 631 unexpected changes.
 632 .LP
 633 In addition to protecting overwritten files, Portage will not delete any files
 634 from a protected directory when a package is unmerged. While this may be a
 635 little bit untidy, it does prevent potentially valuable config files from being
 636 deleted, which is of paramount importance.
 637 .LP
 638 Protected directories are set using the \fICONFIG_PROTECT\fR variable, normally
 639 defined in /etc/make.globals. Directory exceptions to the CONFIG_PROTECTed
 640 directories can be specified using the \fICONFIG_PROTECT_MASK\fR variable. To find
 641 files that need to be updated in /etc, type \fBfind /etc \-iname \'._cfg????_*\'\fR.
 642 .LP
 643 You can disable this feature by setting \fICONFIG_PROTECT="\-*"\fR in /etc/make.conf.
 644 Then, Portage will mercilessly auto\-update your config files. Alternatively,
 645 you can leave Config File Protection on but tell Portage that it can overwrite
 646 files in certain specific /etc subdirectories. For example, if you wanted
 647 Portage to automatically update your rc scripts and your wget configuration,
 648 but didn't want any other changes made without your explicit approval, you'd
 649 add this to /etc/make.conf:
 650 .LP
 651 .I CONFIG_PROTECT_MASK="/etc/wget /etc/rc.d"
 652 .LP
 653 Tools such as dispatch\-conf, cfg\-update, and etc\-update are also available to
 654 aid in the merging of these files. They provide interactive merging and can
 655 auto\-merge trivial changes.
 656 .SH "REPORTING BUGS"
 657 Please report any bugs you encounter through our website:
 658 .LP
 659 \fBhttp://bugs.gentoo.org/\fR
 660 .LP
 661 Please include the output of \fBemerge \-\-info\fR when you submit your
 662 bug report.
 663 .SH "AUTHORS"
 664 .nf
 665 Daniel Robbins <drobbins@gentoo.org>
 666 Geert Bevin <gbevin@gentoo.org>
 667 Achim Gottinger <achim@gentoo.org>
 668 Nicholas Jones <carpaski@gentoo.org>
 669 Phil Bordelon <phil@thenexusproject.org>
 670 Mike Frysinger <vapier@gentoo.org>
 671 Marius Mauch <genone@gentoo.org>
 672 Jason Stubbs <jstubbs@gentoo.org>
 673 Brian Harring <ferringb@gmail.com>
 674 Zac Medico <zmedico@gentoo.org>
 675 .fi
 676 .SH "FILES"
 677 Here is a common list of files you will probably be interested in.  For a
 678 complete listing, please refer to the \fBportage\fR(5) man page.
 679 .TP
 680 .B /usr/share/portage/config/sets.conf
 681 Contains the default set configuration.
 682 .TP
 683 .B /var/lib/portage/world
 684 Contains a list of all user\-specified packages.  You can safely edit
 685 this file, adding packages that you want to be considered in \fBworld\fR
 686 set updates and removing those that you do not want to be considered.
 687 .TP
 688 .B /etc/make.conf
 689 Contains variables for the build process, overriding those in
 690 \fBmake.globals\fR.
 691 .TP
 692 .B /etc/portage/color.map
 693 Contains variables customizing colors.
 694 .TP
 695 .B /etc/dispatch\-conf.conf
 696 Contains settings to handle automatic updates/backups of configuration
 697 files.
 698 .TP
 699 .B /etc/make.profile/make.defaults
 700 Contains profile\-specific variables for the build process.  \fBDo not
 701 edit this file\fR.
 702 .TP
 703 .B /usr/portage/profiles/use.desc
 704 Contains the master list of USE flags with descriptions of their
 705 functions.  \fBDo not edit this file\fR.
 706 .TP
 707 .B /etc/make.profile/virtuals
 708 Contains a list of default packages used to resolve virtual dependencies.
 709 \fBDo not edit this file\fR.
 710 .TP
 711 .B /etc/make.profile/packages
 712 Contains a list of packages used for the base system.  The \fBsystem\fR
 713 and \fBworld\fR sets consult this file.  \fBDo not edit this file\fR.
 714 .TP
 715 .B /etc/make.globals
 716 Contains the default variables for the build process.  \fBDo not edit
 717 this file\fR.
 718 .SH "SEE ALSO"
 719 .BR "emerge \-\-help",
 720 .BR quickpkg (1),
 721 .BR ebuild (1),
 722 .BR ebuild (5),
 723 .BR make.conf (5),
 724 .BR color.map (5),
 725 .BR portage (5)
 726 .LP
 727 A number of helper applications reside in \fI/usr/lib/portage/bin\fR.
 728 .LP
 729 The \fBapp\-portage/gentoolkit\fR package contains useful scripts such as
 730 \fBequery\fR (a package query tool).