1 .TH "EMERGE" "1" "Sept 2011" "Portage VERSION" "Portage"
3 emerge \- Command\-line interface to the Portage system
7 [\fIoptions\fR] [\fIaction\fR] [\fIebuild\fR | \fItbz2file\fR | \fIfile\fR | \fI@set\fR | \fIatom\fR] ...
10 \fB\-\-sync\fR | \fB\-\-version\fR
13 \fB\-\-info\fR [\fIatom\fR]
16 \fB\-\-search\fR \fIsomestring\fR
19 \fB\-\-help\fR [\fB\-\-verbose\fR]
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
29 .SH "EBUILDS, TBZ2S, SETS AND ATOMS"
30 \fBemerge\fR primarily installs packages. You can specify
31 packages to install in five possible ways: an \fIatom\fR,
32 a \fIset\fR, an installed \fIfile\fR, an \fIebuild\fR, or
37 An \fIebuild\fR must be, at a minimum, a valid Portage
38 package directory name without a version or category, such as
39 \fBportage\fR or \fBpython\fR.
40 Both categories and version numbers may be used in addition, such
41 as \fBsys\-apps/portage\fR or \fB=python\-2.2.1\-r2\fR.
43 ignores a trailing slash so that filename completion can be used.
44 The \fIebuild\fR may also be an actual filename, such as
45 \fB/usr/portage/app\-admin/python/python\-2.2.1\-r2.ebuild\fR.
46 \fBWARNING:\fR The implementation of \fBemerge /path/to/ebuild\fR is broken and
47 so this syntax shouldn't be used.
50 A \fItbz2file\fR must be a valid .tbz2 created with \fBebuild
51 <package>\-<version>.ebuild package\fR or \fBemerge \-\-buildpkg
52 [category/]<package>\fR or \fBquickpkg /var/db/pkg/<category>/<package>\fR.
55 A \fIfile\fR must be a file or directory that has been installed by one or
56 more packages. If an absolute path is not used, then it must begin with
57 either "./" or "../". For directories that are owned by multiple packages, all
58 owning packages will be selected. See the portageq(1) owners command if you
59 would like to query the owners of one or more files or directories.
62 A \fIset\fR is a convenient shorthand for a large group of
63 packages. Three sets are currently always available: \fBselected\fR,
64 \fBsystem\fR and \fBworld\fR. \fBselected\fR contains the user-selected
65 "world" packages that are listed in \fB/var/lib/portage/world\fR,
66 and nested sets that may be listed
67 in \fB/var/lib/portage/world_sets\fR. \fBsystem\fR refers to a set of
68 packages deemed necessary for your system to run properly. \fBworld\fR
69 encompasses both the \fBselected\fR and \fBsystem\fR sets. [See
70 \fBFILES\fR below for more information.] Other sets can exist depending
71 on the current configuration. The default set configuration is located
72 in the \fB/usr/share/portage/config/sets\fR directory. Note that a \fIset\fR
73 is generally used in conjunction with \fB\-\-update\fR. When used as
74 arguments to \fBemerge\fR sets have to be prefixed with \fB@\fR to be
75 recognized. Use the \fB\-\-list\-sets\fR action to display a list of
76 available package sets.
79 An \fIatom\fR describes bounds on a package that you wish to install.
80 \fISee ebuild(5) for the details on atom syntax.\fR For example,
81 \fB>=dev\-lang/python\-2.2.1\-r2\fR matches the latest available version of
82 Python greater than or equal to 2.2.1\-r2. Similarly,
83 \fB<dev\-lang/python\-2.0\fR matches the latest available version of Python
84 before 2.0. Note that in many shells you will need to escape characters such
85 as '<' and '='; use single\- or double\-quotes around the \fIatom\fR
86 to get around escaping problems.
90 If no action is specified, the action is to merge in the specified
91 packages, satisfying any dependencies that they may have. The
92 arguments can be \fIatoms\fR, \fIsets\fR, installed \fIfiles\fR,
93 \fIebuilds\fR, or \fItbz2s\fR.
94 \fBNote that you need to use the \-\-usepkg
95 option if you want to install a tbz2\fR. The packages are added
96 to the \fBworld\fR file at the end, so that they are considered for
100 Cleans up the system by examining the installed packages and removing older
101 packages. This is accomplished by looking at each installed package and separating
102 the installed versions by \fBslot\fR. Clean will \fBremove all but the most recently
103 installed version in each \fbslot\fR. Clean should not remove unslotted packages.
104 Note: Most recently installed means most \fBrecent\fR, not highest version.
107 Run package specific actions needed to be executed after the emerge process
108 has completed. This usually entails configuration file setup or other similar
109 setups that the user may wish to run.
111 .BR "\-\-depclean (-c)"
112 Cleans the system by removing packages that are not associated
113 with explicitly merged packages. Depclean works by creating the
114 full dependency tree from the @world set,
115 then comparing it to installed packages. Packages installed, but
116 not part of the dependency tree, will be uninstalled by depclean.
117 See \fB\-\-with\-bdeps\fR for behavior with respect to build time dependencies
118 that are not strictly required. Packages that are part of the world set will
119 always be kept. They can be manually added to this set with \fIemerge
120 \-\-noreplace <atom>\fR. As a safety measure, depclean will not remove any
121 packages unless *all* required dependencies have been resolved. As a
122 consequence, it is often necessary to run \fIemerge \-\-update \-\-newuse
123 \-\-deep @world\fR prior to depclean. Also note that
124 depclean may break link level dependencies, especially when the
125 \fB\-\-depclean\-lib\-check\fR option is disabled. Thus, it is
126 recommended to use a tool such as \fBrevdep-rebuild\fR(1)
127 in order to detect such breakage.
130 Inexperienced users are advised to use \fB\-\-pretend\fR with this
131 option in order to see a preview of which packages
132 will be uninstalled. Always study the list of packages
133 to be cleaned for any obvious mistakes. Note that packages listed in
134 package.provided (see \fBportage\fR(5)) may be removed by
135 depclean, even if they are part of the world set.
137 Depclean serves as a dependency aware
138 version of \fB\-\-unmerge\fR. When given one or more atoms, it will
139 unmerge matched packages that have no reverse dependencies. Use
140 \fB\-\-depclean\fR together with \fB\-\-verbose\fR to show reverse
143 .BR "\-\-deselect [ y | n ]"
144 Remove atoms and/or sets from the world file. This action is implied
145 by uninstall actions, including \fB-\-depclean\fR,
146 \fB-\-prune\fR and \fB-\-unmerge\fR. Use \fB-\-deselect=n\fR
147 in order to prevent uninstall actions from removing
148 atoms from the world file.
150 .BR "\-\-help " (\fB\-h\fR)
151 Displays help information for emerge. Adding one of the additional
152 arguments listed above will give you more specific help information
153 on that subject. The internal \fBemerge\fR help documentation is
154 updated more frequently than this man page; check it out if you
155 are having problems that this man page does not help resolve.
158 Produces a list of information to include in bug reports which aids the
159 developers when fixing the reported problem. \fBPlease include this
160 information when submitting a bug report.\fR Expanded output can be obtained
161 with the \fI\-\-verbose\fR option.
164 Displays a list of available package sets.
167 Transfers metadata cache from ${PORTDIR}/metadata/cache/ to
168 /var/cache/edb/dep/ as is normally done on the
169 tail end of an rsync update using \fBemerge \-\-sync\fR. This process
170 populates the cache database that portage uses for pre-parsed lookups of
171 package data. It does not populate cache for the overlays listed in
172 PORTDIR_OVERLAY. In order to generate cache for overlays, use \fB\-\-regen\fR.
173 In versions of portage >=2.1.5 the \-\-metadata action is totally unnecessary
174 unless the user has enabled FEATURES="metadata-transfer" in \fBmake.conf\fR(5).
176 .BR "\-\-prune " (\fB\-P\fR)
177 Removes all but the highest installed version of a package from your
178 system. Use \fB\-\-prune\fR together with \fB\-\-verbose\fR to show
179 reverse dependencies or with \fB\-\-nodeps\fR to ignore all dependencies.
180 \fBWARNING: This action can remove packages from your world file! Check
181 the emerge output of the next \-\-depclean run carefully! Use
182 \-\-depclean to avoid this issue.\fR
185 Causes portage to check and update the dependency cache of all ebuilds in the
186 portage tree. The cache is used to speed up searches and the building of
187 dependency trees. This command is not recommended for rsync users as rsync
188 updates the cache using server\-side caches. If you do not know the
189 differences between a 'rsync user' and some other user, then you are a 'rsync
190 user' :). Rsync users should simply run \fBemerge \-\-sync\fR to regenerate
191 the cache. After a portage update, rsync users may find it convenient to run
192 \fBemerge \-\-metadata\fR to rebuild the cache as portage does at the end of
193 a sync operation. In order to specify parallel \fB\-\-regen\fR behavior, use
194 the \fB\-\-jobs\fR and \fB\-\-load\-average\fR options. If you would like to
195 generate and distribute cache for use by others, use \fBegencache\fR(1).
197 .BR "\-\-resume" (\fB\-r\fR)
198 Resumes the most recent merge list that has been aborted due to an error.
199 Please note that this operation will only return an error on failure. If there
200 is nothing for portage to do, then portage will exit with a message and a
201 success condition. A resume list will persist until it has been completed in
202 entirety or until another aborted merge list replaces it. The resume history
203 is capable of storing two merge lists. After one resume list completes, it is
204 possible to invoke \-\-resume once again in order to resume an older list.
206 .BR "\-\-search " (\fB\-s\fR)
207 Searches for matches of the supplied string in the portage tree.
208 By default emerge uses a case-insensitive simple search, but you can
209 enable a regular expression search by prefixing the search string with %.
210 For example, \fBemerge \-\-search "%^kde"\fR searches for any package whose
211 name starts with "kde"; \fBemerge \-\-search "%gcc$"\fR searches for any
212 package that ends with "gcc"; \fBemerge \-\-search "office"\fR searches for
213 any package that contains the word "office". If you want to include the
214 category into the search string, prepend an @: \fBemerge \-\-search
215 "%@^dev-java.*jdk"\fR. If you want to search the package descriptions as well,
216 use the \fB\-\-searchdesc\fR action.
218 .BR "\-\-searchdesc " (\fB\-S\fR)
219 Matches the search string against the description field as well as
220 the package name. \fBTake caution\fR as the descriptions are also
221 matched as regular expressions.
224 This updates the portage tree that is located in the
225 directory that the PORTDIR variable refers to (default
226 location is /usr/portage). The SYNC variable specifies
227 the remote URI from which files will be synchronized.
228 The \fBPORTAGE_SYNC_STALE\fR variable configures
229 warnings that are shown when emerge \-\-sync has not
230 been executed recently.
233 The emerge \-\-sync action will modify and/or delete
234 files located inside the directory that the PORTDIR
235 variable refers to (default location is /usr/portage).
236 For more information, see the PORTDIR documentation in
237 the make.conf(5) man page.
240 The \fBemerge\-webrsync\fR program will download the entire
241 portage tree as a tarball, which is much faster than emerge
242 \-\-sync for first time syncs.
245 .BR "\-\-unmerge " (\fB\-C\fR)
246 \fBWARNING: This action can remove important packages!\fR Removes
247 all matching packages. This does no checking of dependencies, so
248 it may remove packages necessary for the proper operation of your
249 system. Its arguments can be \fIatoms\fR or
250 \fIebuilds\fR. For a dependency aware version of \fB\-\-unmerge\fR,
251 use \fB\-\-depclean\fR or \fB\-\-prune\fR.
253 .BR "\-\-version " (\fB\-V\fR)
254 Displays the version number of \fBemerge\fR.
257 .BR \-\-accept\-properties=ACCEPT_PROPERTIES
258 This option temporarily overrides the \fBACCEPT_PROPERTIES\fR
259 variable. The \fBACCEPT_PROPERTIES\fR variable is incremental,
260 which means that the specified setting is appended to the
261 existing value from your configuration. The special \fB-*\fR
262 token can be used to discard the existing configuration
263 value and start fresh. See the \fBMASKED PACKAGES\fR section
264 and \fBmake.conf\fR(5) for more information about
265 ACCEPT_PROPERTIES. A typical usage example for this option
266 would be to use \fI\-\-accept\-properties=\-interactive\fR to
267 temporarily mask interactive packages. With default
268 configuration, this would result in an effective
269 \fBACCEPT_PROPERTIES\fR value of "* -interactive".
271 .BR "\-\-alphabetical "
272 When displaying USE and other flag output, combines the enabled and
273 disabled lists into one list and sorts the whole list alphabetically.
275 .BR "\-\-ask [ y | n ] (\-a short option)"
276 Before performing the action, display what will take place (server info for
277 \fB\-\-sync\fR, \fB\-\-pretend\fR output for merge, and so forth), then ask
278 whether to proceed with the action or abort. Using \fB\-\-ask\fR is more
279 efficient than using \fB\-\-pretend\fR and then executing the same command
280 without \fB\-\-pretend\fR, as dependencies will only need to be calculated once.
281 \fBWARNING: If the "Enter" key is pressed at the prompt (with no other input),
282 it is interpreted as acceptance of the first choice. Note that the input
283 buffer is not cleared prior to the prompt, so an accidental press of the
284 "Enter" key at any time prior to the prompt will be interpreted as a choice!
285 Use the \-\-ask\-enter\-invalid option if you want a single "Enter" key
286 press to be interpreted as invalid input.\fR
288 .BR "\-\-ask\-enter\-invalid"
289 When used together with the \fB\-\-ask\fR option,
290 interpret a single "Enter" key press as
291 invalid input. This helps prevent accidental
292 acceptance of the first choice. This option is
293 intended to be set in the \fBmake.conf\fR(5)
294 \fBEMERGE_DEFAULT_OPTS\fR variable.
296 .BR "\-\-autounmask [ y | n ]"
297 Automatically unmask packages and generate package.use
298 settings as necessary to satisfy dependencies. This
299 option is enabled by default. If any configuration
300 changes are required, then they will be displayed
301 after the merge list and emerge will immediately
302 abort. If the displayed configuration changes are
303 satisfactory, you should copy and paste them into
304 the specified configuration file(s), or enable the
305 \fB\-\-autounmask\-write\fR option. The
306 \fBEMERGE_DEFAULT_OPTS\fR variable may be used to
307 disable this option by default in \fBmake.conf\fR(5).
309 .BR "\-\-autounmask\-unrestricted\-atoms [ y | n ]"
310 If \-\-autounmask is enabled, keyword and mask changes
311 using the \'=\' operator will be written. With this
312 option, \'>=\' operators will be used whenever possible.
313 USE and license changes always use the latter behavior.
315 .BR "\-\-autounmask\-keep\-masks [ y | n ]"
316 If \-\-autounmask is enabled, no package.unmask or ** keyword changes
317 will be created. This leads to unsatisfied dependencies if
318 no other solution exists.
320 .BR "\-\-autounmask\-write [ y | n ]"
321 If \-\-autounmask is enabled, changes are written
322 to config files, respecting \fBCONFIG_PROTECT\fR and \fB\-\-ask\fR.
323 If the corresponding package.* is a file, the changes are appended to
324 it, if it is a directory, changes are written to the lexicographically
325 last file. This way it is always ensured that the new changes take
326 precedence over existing changes.
328 .BR \-\-backtrack=COUNT
329 Specifies an integer number of times to backtrack if
330 dependency calculation fails due to a conflict or an
331 unsatisfied dependency (default: \'10\').
333 .BR "\-\-binpkg\-respect\-use [ y | n ]"
334 Tells emerge to ignore binary packages if their use flags
335 don't match the current configuration. (default: \'n\')
337 .BR "\-\-buildpkg [ y | n ] (\-b short option)"
338 Tells emerge to build binary packages for all ebuilds processed in
339 addition to actually merging the packages. Useful for maintainers
340 or if you administrate multiple Gentoo Linux systems (build once,
341 emerge tbz2s everywhere) as well as disaster recovery. The package
342 will be created in the \fBPKGDIR\fR directory (see \fBmake.conf\fR(5)).
343 An alternative for already\-merged
344 packages is to use \fBquickpkg\fR(1) which creates a tbz2 from the
347 .BR "\-\-buildpkgonly " (\fB\-B\fR)
348 Creates binary packages for all ebuilds processed without actually
349 merging the packages. This comes with the caveat that all build-time
350 dependencies must already be emerged on the system.
352 .BR "\-\-changed\-use"
353 This is an alias for \fB\-\-reinstall=changed\-use\fR.
355 .BR "\-\-changelog " (\fB\-l\fR)
356 Use this in conjunction with the \fB\-\-pretend\fR option. This will
357 show the ChangeLog entries for all the packages that will be upgraded.
359 .BR "\-\-color < y | n >"
360 Enable or disable color output. This option will override \fINOCOLOR\fR
361 (see \fBmake.conf\fR(5)) and may also be used to force color output when stdout
362 is not a tty (by default, color is disabled unless stdout is a tty).
365 Used alongside \fB\-\-pretend\fR to cause the package name, new version,
366 and old version to be displayed in an aligned format for easy cut\-n\-paste.
368 .BR "\-\-complete\-graph [ y | n ]"
369 This causes \fBemerge\fR to consider the deep dependencies of all
370 packages from the world set. With this option enabled,
371 \fBemerge\fR will bail out if it determines that the given operation will
372 break any dependencies of the packages that have been added to the
373 graph. Like the \fB\-\-deep\fR option, the \fB\-\-complete\-graph\fR
374 option will significantly increase the time taken for dependency
375 calculations. Note that, unlike the \fB\-\-deep\fR option, the
376 \fB\-\-complete\-graph\fR option does not cause any more packages to
377 be updated than would have otherwise been updated with the option disabled.
378 Using \fB\-\-with\-bdeps=y\fR together with \fB\-\-complete\-graph\fR makes
379 the graph as complete as possible.
381 .BR "\-\-complete\-graph\-if\-new\-ver < y | n >"
382 Trigger the \fB\-\-complete\-graph\fR behavior if an installed package
383 version will change (upgrade or downgrade). This option is enabled by default.
385 .BR \-\-config\-root=DIR
386 Set the \fBPORTAGE_CONFIGROOT\fR environment variable.
388 .BR "\-\-debug " (\fB\-d\fR)
389 Tells emerge to run the emerge command in \fB\-\-debug\fR mode. In this
390 mode the bash build environment will run with the \-x option, causing
391 it to output verbose debugging information to stdout. This also enables
392 a plethora of other output (mostly dependency resolution messages).
394 .BR "\-\-deep [DEPTH] " (\fB\-D\fR)
396 \fBemerge\fR to consider the entire dependency tree of packages,
397 instead of checking only the immediate dependencies of the packages.
398 As an example, this catches updates in libraries that are not directly
399 listed in the dependencies of a package. Also see \fB\-\-with\-bdeps\fR for
400 behavior with respect to build time dependencies that are not strictly
403 .BR "\-\-depclean\-lib\-check [ y | n ]"
404 Account for library link-level dependencies during
405 \fB\-\-depclean\fR and \fB\-\-prune\fR actions. This
406 option is enabled by default. In some cases this can
407 be somewhat time\-consuming. This option is ignored
408 when FEATURES="preserve\-libs" is enabled in
409 \fBmake.conf\fR(5), since any libraries that have
410 consumers will simply be preserved.
412 .BR "\-\-dynamic\-deps < y | n >"
413 In dependency calculations, substitute the dependencies of installed
414 packages with the dependencies of corresponding unbuilt ebuilds from
415 source repositories. This causes the effective dependencies of
416 installed packages to vary dynamically when source ebuild dependencies
417 are modified. This option is enabled by default.
420 If you want to disable \-\-dynamic\-deps, then it may be necessary to
421 first run \fBfixpackages\fR in order to get the best results. The
422 \fBfixpackages\fR command performs two different operations that can
423 also be performed separately by the `emaint \-\-fix moveinst` and
424 `emaint \-\-fix movebin` commands (see \fBemaint\fR(1)).
426 .BR "\-\-emptytree " (\fB\-e\fR)
427 Reinstalls target atoms and their entire deep
428 dependency tree, as though no packages are currently
429 installed. You should run this with \fB\-\-pretend\fR
430 first to make sure the result is what you expect.
432 .BR "\-\-exclude " ATOMS
433 A space separated list of package names or slot atoms.
434 Emerge won't install any ebuild or binary package that
435 matches any of the given package atoms.
437 .BR "\-\-fail\-clean [ y | n ]"
438 Clean up temporary files after a build failure. This is
439 particularly useful if you have \fBPORTAGE_TMPDIR\fR on
440 tmpfs. If this option is enabled, you probably also want
441 to enable \fBPORT_LOGDIR\fR (see \fBmake.conf\fR(5)) in
442 order to save the build log.
444 .BR "\-\-fetchonly " (\fB\-f\fR)
445 Instead of doing any package building, just perform fetches for all
446 packages (fetch things from SRC_URI based upon USE setting).
448 .BR "\-\-fetch\-all\-uri " (\fB\-F\fR)
449 Instead of doing any package building, just perform fetches for all
450 packages (fetch everything in SRC_URI regardless of USE setting).
452 .BR "\-\-getbinpkg [ y | n ] (\-g short option)"
453 Using the server and location defined in \fIPORTAGE_BINHOST\fR (see
454 \fBmake.conf\fR(5)), portage will download the information from each binary
455 package found and it will use that information to help build the dependency
456 list. This option implies \fB\-k\fR. (Use \fB\-gK\fR for binary\-only
459 .BR "\-\-getbinpkgonly [ y | n ] (\-G short option)"
460 This option is identical to \fB\-g\fR, as above, except binaries from the
461 remote server are preferred over local packages if they are not identical.
463 .BR "\-\-ignore-default-opts"
464 Causes \fIEMERGE_DEFAULT_OPTS\fR (see \fBmake.conf\fR(5)) to be ignored.
466 .BR "-j [JOBS], \-\-jobs[=JOBS]"
467 Specifies the number of packages to build simultaneously. If this option is
468 given without an argument, emerge will not limit the number of jobs that can
469 run simultaneously. Also see the related \fB\-\-load\-average\fR option.
470 Note that interactive packages currently force a setting
471 of \fI\-\-jobs=1\fR. This issue can be temporarily avoided
472 by specifying \fI\-\-accept\-properties=\-interactive\fR.
474 .BR "\-\-keep\-going [ y | n ]"
475 Continue as much as possible after an error. When an error occurs,
476 dependencies are recalculated for remaining packages and any with
477 unsatisfied dependencies are automatically dropped. Also see
478 the related \fB\-\-skipfirst\fR option.
480 .BR \-\-load\-average=LOAD
481 Specifies that no new builds should be started if there are other builds
482 running and the load average is at least LOAD (a floating-point number).
483 This option is recommended for use in combination with \fB\-\-jobs\fR in
484 order to avoid excess load. See \fBmake\fR(1) for information about
485 analogous options that should be configured via \fBMAKEOPTS\fR in
488 .BR "\-\-misspell\-suggestions < y | n >"
489 Enable or disable misspell suggestions. By default, emerge will show
490 a list of packages with similar names when a package doesn't exist.
491 The \fIEMERGE_DEFAULT_OPTS\fR variable may be used to disable this
494 .BR "\-\-newuse " (\fB\-N\fR)
495 Tells emerge to include installed packages where USE
496 flags have changed since compilation. This option
497 also implies the \fB\-\-selective\fR option.
498 USE flag changes include:
500 A USE flag was added to a package.
501 A USE flag was removed from a package.
502 A USE flag was turned on for a package.
503 A USE flag was turned off for a package.
505 USE flags may be toggled by your profile as well as your USE and package.use
506 settings. If you would like to skip rebuilds for which disabled flags have
507 been added to or removed from IUSE, see the related
508 \-\-reinstall=changed\-use option.
511 Causes portage to disregard merge records indicating that a config file
512 inside of a \fBCONFIG_PROTECT\fR directory has been merged already. Portage
513 will normally merge those files only once to prevent the user from
514 dealing with the same config multiple times. This flag will cause the
515 file to always be merged.
517 .BR "\-\-nodeps " (\fB\-O\fR)
518 Merges specified packages without merging any dependencies. Note that
519 the build may fail if the dependencies aren't satisfied.
521 .BR "\-\-noreplace " (\fB\-n\fR)
522 Skips the packages specified on the command\-line that have already
523 been installed. Without this option, any packages, ebuilds, or deps
524 you specify on the command\-line \fBwill\fR cause Portage to remerge
525 the package, even if it is already installed. Note that Portage will
526 not remerge dependencies by default.
529 Disables the spinner for the session. The spinner is active when the
530 terminal device is determined to be a TTY. This flag disables it regardless.
532 .BR "\-\-usepkg\-exclude " ATOMS
533 A space separated list of package names or slot atoms. Emerge will ignore
534 matching binary packages.
536 .BR "\-\-rebuild\-exclude " ATOMS
537 A space separated list of package names or slot atoms. Emerge will not rebuild
538 matching packages due to \fB\-\-rebuild\fR.
540 .BR "\-\-rebuild\-ignore " ATOMS
541 A space separated list of package names or slot atoms. Emerge will not rebuild
542 packages that depend on matching packages due to \fB\-\-rebuild\fR.
544 .BR "\-\-oneshot " (\fB\-1\fR)
545 Emerge as normal, but do not add the packages to the world file
548 .BR "\-\-onlydeps " (\fB\-o\fR)
549 Only merge (or pretend to merge) the dependencies of the packages
550 specified, not the packages themselves.
552 .BR "\-\-package\-moves [ y | n ]"
553 Perform package moves when necessary. This option
554 is enabled by default. \fBWARNING:\fR This option
555 should remain enabled under normal circumstances.
556 Do not disable it unless you know what you are
559 .BR "\-\-pretend " (\fB\-p\fR)
560 Instead of actually performing the merge, simply display what *would*
561 have been installed if \fB\-\-pretend\fR weren't used. Using \fB\-\-pretend\fR
562 is strongly recommended before installing an unfamiliar package. In
567 N new (not yet installed)
568 S new SLOT installation (side-by-side versions)
569 U updating (to another version)
570 D downgrading (best version seems lower)
571 R replacing (remerging same version))
572 F fetch restricted (must be manually downloaded)
573 f fetch restricted (already downloaded)
574 I interactive (requires user input)
575 B blocked by another package (unresolved conflict)
576 b blocked by another package (automatically resolved conflict)
579 .BR "\-\-quiet [ y | n ] (\-q short option)"
580 Results may vary, but the general outcome is a reduced or condensed
581 output from portage's displays.
583 .BR "\-\-quiet\-build [ y | n ]"
584 Redirect all build output to logs alone, and do not
585 display it on stdout.
587 .BR \-\-quiet\-unmerge\-warn
588 Disable the warning message that's shown prior to
589 \fB\-\-unmerge\fR actions. This option is intended
590 to be set in the \fBmake.conf\fR(5)
591 \fBEMERGE_DEFAULT_OPTS\fR variable.
593 .BR "\-\-rebuild\-if\-new\-rev [ y | n ]"
594 Rebuild packages when build\-time dependencies are built from source, if the
595 dependency is not already installed with the same version and revision.
597 .BR "\-\-rebuild\-if\-new\-ver [ y | n ]"
598 Rebuild packages when build\-time dependencies are built from source, if the
599 dependency is not already installed with the same version. Revision numbers
602 .BR "\-\-rebuild\-if\-unbuilt [ y | n ]"
603 Rebuild packages when build\-time dependencies are built from source.
605 .BR "\-\-rebuilt\-binaries [ y | n ]"
606 Replace installed packages with binary packages that have
607 been rebuilt. Rebuilds are detected by comparison of
608 BUILD_TIME package metadata. This option is enabled
609 automatically when using binary packages
610 (\fB\-\-usepkgonly\fR or \fB\-\-getbinpkgonly\fR) together with
611 \fB\-\-update\fR and \fB\-\-deep\fR.
613 .BR "\-\-rebuilt\-binaries\-timestamp=TIMESTAMP"
614 This option modifies emerge's behaviour only if
615 \fB\-\-rebuilt\-binaries\fR is given. Only binaries that
616 have a BUILD_TIME that is larger than the given TIMESTAMP
617 and that is larger than that of the installed package will
618 be considered by the rebuilt\-binaries logic.
620 .BR "\-\-reinstall changed\-use"
621 Tells emerge to include installed packages where USE flags have
622 changed since installation. Unlike \fB\-\-newuse\fR, this option does
623 not trigger reinstallation when flags that the user has not
624 enabled are added or removed.
626 .BR "\-\-reinstall\-atoms " ATOMS
627 A space separated list of package names or slot atoms. Emerge will treat
628 matching packages as if they are not installed, and reinstall them if
632 Set the \fBROOT\fR environment variable.
634 .BR "\-\-root\-deps[=rdeps]"
635 If no argument is given then build\-time dependencies of packages for
636 \fBROOT\fR are installed to
637 \fBROOT\fR instead of /. If the \fBrdeps\fR argument is given then discard
638 all build\-time dependencies of packages for \fBROOT\fR. This option is
639 only meaningful when used together with \fBROOT\fR and it should not
640 be enabled under normal circumstances. For currently supported
641 \fBEAPI\fR values, the build-time dependencies are specified in the
642 \fBDEPEND\fR variable. However, behavior may change for new
643 \fBEAPI\fRs when related extensions are added in the future.
645 .BR "\-\-select [ y | n ]"
646 Add specified packages to the world set (inverse of
647 \fB\-\-oneshot\fR). This is useful if you want to
648 use \fBEMERGE_DEFAULT_OPTS\fR to make
649 \fB\-\-oneshot\fR behavior default.
651 .BR "\-\-selective [ y | n ]"
652 This is identical to the \fB\-\-noreplace\fR option.
653 Some options, such as \fB\-\-update\fR, imply \fB\-\-selective\fR.
654 Use \fB\-\-selective=n\fR if you want to forcefully disable
655 \fB\-\-selective\fR, regardless of options like \fB\-\-update\fR.
658 This option is only valid when used with \fB\-\-resume\fR. It removes the
659 first package in the resume list. Dependencies are recalculated for
660 remaining packages and any that have unsatisfied dependencies or are
661 masked will be automatically dropped. Also see the related
662 \fB\-\-keep\-going\fR option.
664 .BR "\-\-tree " (\fB\-t\fR)
665 Shows the dependency tree for the given target by indenting dependencies.
666 This is only really useful in combination with \fB\-\-emptytree\fR or
667 \fB\-\-update\fR and \fB\-\-deep\fR.
669 .BR "\-\-unordered\-display"
670 By default the displayed merge list is sorted using the
671 order in which the packages will be merged. When
672 \fB\-\-tree\fR is used together with this option, this
673 constraint is removed, hopefully leading to a more
674 readable dependency tree.
676 .BR "\-\-update " (\fB\-u\fR)
677 Updates packages to the best version available, which may
678 not always be the highest version number due to masking
679 for testing and development. Package atoms specified on
680 the command line are greedy, meaning that unspecific
681 atoms may match multiple versions of slotted packages.
683 .BR "\-\-use\-ebuild\-visibility [ y | n ]"
684 Use unbuilt ebuild metadata for visibility
685 checks on built packages.
687 .BR "\-\-useoldpkg\-atoms " ATOMS
688 A space separated list of package names or slot atoms. Emerge will prefer
689 matching binary packages over newer unbuilt packages.
691 .BR "\-\-usepkg [ y | n ] (\-k short option)"
692 Tells emerge to use binary packages (from $PKGDIR) if they are available, thus
693 possibly avoiding some time\-consuming compiles. This option is useful for CD
694 installs; you can export PKGDIR=/mnt/cdrom/packages and then use this option to
695 have emerge "pull" binary packages from the CD in order to satisfy dependencies.
697 .BR "\-\-usepkgonly [ y | n ] (\-K short option)"
698 Tells emerge to only use binary packages (from $PKGDIR). All the binary
699 packages must be available at the time of dependency calculation or emerge
700 will simply abort. Portage does not use $PORTDIR when calculating dependency
701 information so all masking information is ignored.
703 .BR "\-\-verbose " (\fB\-v\fR)
704 Tell emerge to run in verbose mode. Currently this flag causes emerge to print
705 out GNU info errors, if any, and to show the USE flags that will be used for
706 each package when pretending. The following symbols are affixed to USE flags
707 in order to indicate their status:
713 Symbol Location Meaning
715 - prefix not enabled (either disabled or removed)
716 * suffix transition to or from the enabled state
717 % suffix newly added or removed
718 () circumfix forced, masked, or removed
721 .BR "\-\-with\-bdeps < y | n >"
722 In dependency calculations, pull in build time dependencies
723 that are not strictly required. This defaults to \'n\' for
724 installation actions, meaning they will not be installed, and
725 \'y\' for the \fB\-\-depclean\fR action, meaning they will not be removed.
726 This setting can be added to
727 \fBEMERGE_DEFAULT_OPTS\fR (see make.conf(5)) and later overridden via the
729 .SH "ENVIRONMENT OPTIONS"
731 \fBROOT\fR = \fI[path]\fR
732 Use \fBROOT\fR to specify the target root filesystem to be used for
733 merging packages or ebuilds. This variable can be set via the \fB\-\-root\fR
734 option or in \fBmake.conf\fR(5) (the command line overrides other settings).
738 \fBPORTAGE_CONFIGROOT\fR = \fI[path]\fR
739 Use \fBPORTAGE_CONFIGROOT\fR to specify the location for various portage
741 (see \fBFILES\fR for a detailed list of configuration files). This variable
742 can be set via the \fB\-\-config\-root\fR option.
746 When utilizing \fBemerge\fR with the \fB\-\-pretend\fR and \fB\-\-verbose\fR
747 flags, the output may be a little hard to understand at first. This section
748 explains the abbreviations.
750 .B [blocks B ] app\-text/dos2unix ("app\-text/dos2unix" is blocking app\-text/hd2u\-0.8.0)
751 Dos2unix is Blocking hd2u from being emerged. Blockers are defined when
752 two packages will clobber each others files, or otherwise cause some form
753 of breakage in your system. However, blockers usually do not need to be
754 simultaneously emerged because they usually provide the same functionality.
756 .B [ebuild N ] app\-games/qstat\-25c
757 Qstat is New to your system, and will be emerged for the first time.
759 .B [ebuild NS ] dev-libs/glib-2.4.7
760 You already have a version of glib installed, but a 'new' version in
761 a different SLOT is available.
763 .B [ebuild R ] sys\-apps/sed\-4.0.5
764 Sed 4.0.5 has already been emerged, but if you run the command, then
765 portage will Re\-emerge the specified package (sed in this case).
767 .B [ebuild F ] media\-video/realplayer\-8\-r6
768 The realplayer package requires that you Fetch the sources manually.
769 When you attempt to emerge the package, if the sources are not found,
770 then portage will halt and you will be provided with instructions on how
771 to download the required files.
773 .B [ebuild f ] media\-video/realplayer\-8\-r6
774 The realplayer package's files are already downloaded.
776 .B [ebuild U ] net\-fs/samba\-2.2.8_pre1 [2.2.7a]
777 Samba 2.2.7a has already been emerged and can be Updated to version
780 .B [ebuild UD] media\-libs/libgd\-1.8.4 [2.0.11]
781 Libgd 2.0.11 is already emerged, but if you run the command, then
782 portage will Downgrade to version 1.8.4 for you.
784 This may occur if a newer version of a package has been masked because it is
785 broken or it creates a security risk on your system and a fix has not been
788 Another reason this may occur is if a package you are trying to emerge requires
789 an older version of a package in order to emerge successfully. In this case,
790 libgd 2.x is incompatible with libgd 1.x. This means that packages that were
791 created with libgd 1.x will not compile with 2.x and must downgrade libgd first
792 before they can emerge.
794 .B [ebuild U ] sys\-devel/distcc\-2.16 [2.13\-r1] USE="ipv6* \-gtk \-qt%"
795 Here we see that the make.conf variable \fBUSE\fR affects how this package is
796 built. In this example, ipv6 optional support is enabled and both gtk and qt
797 support are disabled. The asterisk following ipv6 indicates that ipv6 support
798 was disabled the last time this package was installed. The percent sign
799 following qt indicates that the qt option has been added to the package since
800 it was last installed. For information about all \fBUSE\fR symbols, see the
801 \fB\-\-verbose\fR option documentation above.
803 \fB*Note:\fR Flags that haven't changed since the last install are only
804 displayed when you use the \fB\-\-pretend\fR and \fB\-\-verbose\fR options.
805 Using the \fB\-\-quiet\fR option will prevent all information from being
808 .B [ebuild U *] sys\-apps/portage\-2.2.0_alpha6 [2.1.9.25]
809 Portage 2.1.9.25 is installed, but if you run the command, then
810 portage will upgrade to version 2.2.0_alpha6. In this case,
811 the \fB*\fR symbol is displayed, in order to indicate that version
812 2.2.0_alpha6 is masked by missing keyword. This type of masking
813 display is disabled by the \fB\-\-quiet\fR option if the
814 \fB\-\-verbose\fR option is not enabled simultaneously.
815 The following symbols are used to indicate various types
828 \fBNOTE:\fR The unstable keyword symbol (~) will not be shown in cases
829 in which the corresponding unstable keywords have been accepted
830 globally via \fBACCEPT_KEYWORDS\fR.
835 You should almost always precede any package install or update attempt with a
836 \fB\-\-pretend\fR install or update. This lets you see how much will be
837 done, and shows you any blocking packages that you will have to rectify.
838 This goes doubly so for the \fBsystem\fR and \fBworld\fR sets, which can
839 update a large number of packages if the portage tree has been particularly
842 You also want to typically use \fB\-\-update\fR, which ignores packages that
843 are already fully updated but updates those that are not.
845 When you install a package with uninstalled dependencies and do
846 not explicitly state those dependencies in the list of parameters,
847 they will not be added to the world file. If you want them to be
848 detected for world updates, make sure to explicitly list them as
849 parameters to \fBemerge\fR.
851 \fBUSE variables\fR may be specified on the command line to
852 override those specified in the default locations, letting you
853 avoid using some dependencies you may not want to have. \fBUSE
854 flags specified on the command line are NOT remembered\fR. For
855 example, \fBenv USE="\-X \-gnome" emerge mc\fR will emerge mc with
856 those USE settings (on Bourne-compatible shells you may omit the \fBenv\fR
857 part). If you want those USE settings to be more
858 permanent, you can put them in /etc/portage/package.use instead.
860 If \fBemerge \-\-update system\fR or \fBemerge \-\-update world\fR
861 fails with an error message, it may be that an ebuild uses some
862 newer feature not present in this version of \fBemerge\fR. You
863 can use \fBemerge \-\-update portage\fR to upgrade to the lastest
864 version, which should support any necessary new features.
865 .SH "MASKED PACKAGES"
866 \fINOTE: Please use caution when using development packages. Problems
867 and bugs resulting from misusing masked packages drains Gentoo
868 developer time. Please be sure you are capable of handling any problems
871 Masks in \fBportage\fR have many uses: they allow a
872 testing period where the packages can be used in live machines; they
873 prevent the use of a package when it will fail; and they mask existing
874 packages that are broken or could pose a security risk. Read below
875 to find out how to unmask in various cases. Also note that if you give
876 \fBemerge\fR an ebuild, then all forms of masking will be ignored and
877 \fBemerge\fR will attempt to emerge the package.
880 When packages are masked for \fBbacktracking\fR, it means that the dependency
881 resolver has temporarily masked them in order to avoid dependency conflicts
882 and/or unsatisfied dependencies. This type of mask is typically accompanied
883 by a message about a missed package update which has been skipped in order to
884 avoid dependency conflicts and/or unsatisfied dependencies.
887 The \fBpackage.mask\fR file primarily blocks the use of packages that cause
888 problems or are known to have issues on different systems. It resides in
889 \fI/usr/portage/profiles\fR.
892 Use the \fBACCEPT_CHOSTS\fR variable in \fBmake.conf\fR(5) to control
893 \fBCHOST\fR acceptance.
896 The \fBEAPI\fR variable in an \fBebuild\fR(5) file is used to mask packages
897 that are not supported by the current version of portage. Packages masked by
898 \fBEAPI\fR can only be installed after portage has been upgraded.
901 The \fBKEYWORDS\fR variable in an \fBebuild\fR file is also used for masking
902 a package still in testing. There are architecture\-specific keywords for
903 each package that let \fBportage\fR know which systems are compatible with
904 the package. Packages which compile on an architecture, but have not been
905 proven to be "stable", are masked with a tilde (\fB~\fR) in front of the
906 architecture name. \fBemerge\fR examines the \fBACCEPT_KEYWORDS\fR environment
907 variable to allow or disallow the emerging of a package masked by
908 \fBKEYWORDS\fR. To inform \fBemerge\fR that it should build these 'testing'
909 versions of packages, you should update your
910 \fI/etc/portage/package.accept_keywords\fR
911 file to list the packages you want the
912 \'testing\' version. See \fBportage\fR(5) for more information.
915 The \fBLICENSE\fR variable in an \fBebuild\fR file can be used to mask
916 packages based on licensing restrictions. \fBemerge\fR examines the
917 \fBACCEPT_LICENSE\fR environment variable to allow or disallow the emerging
918 of a package masked by \fBLICENSE\fR. See \fBmake.conf\fR(5) for information
919 about \fBACCEPT_LICENSE\fR, and see \fBportage\fR(5) for information about
920 \fI/etc/portage/package.license\fR.
923 The \fBPROPERTIES\fR variable in an \fBebuild\fR file can be used to mask
924 packages based on properties restrictions. \fBemerge\fR examines the
925 \fBACCEPT_PROPERTIES\fR environment variable to allow or disallow the emerging
926 of a package masked by \fBPROPERTIES\fR. See \fBmake.conf\fR(5) for information
927 about \fBACCEPT_PROPERTIES\fR, and see \fBportage\fR(5) for information about
928 \fI/etc/portage/package.properties\fR. Use the \fB\-\-accept\-properties\fR
929 option to temporarily override \fBACCEPT_PROPERTIES\fR.
930 .SH "CONFIGURATION FILES"
931 Portage has a special feature called "config file protection". The purpose of
932 this feature is to prevent new package installs from clobbering existing
933 configuration files. By default, config file protection is turned on for /etc
934 and the KDE configuration dirs; more may be added in the future.
936 When Portage installs a file into a protected directory tree like /etc, any
937 existing files will not be overwritten. If a file of the same name already
938 exists, Portage will change the name of the to\-be\-installed file from 'foo' to
939 \'._cfg0000_foo\'. If \'._cfg0000_foo\' already exists, this name becomes
940 \'._cfg0001_foo\', etc. In this way, existing files are not overwritten,
941 allowing the administrator to manually merge the new config files and avoid any
944 In addition to protecting overwritten files, Portage will not delete any files
945 from a protected directory when a package is unmerged. While this may be a
946 little bit untidy, it does prevent potentially valuable config files from being
947 deleted, which is of paramount importance.
949 Protected directories are set using the \fICONFIG_PROTECT\fR variable, normally
950 defined in make.globals. Directory exceptions to the CONFIG_PROTECTed
951 directories can be specified using the \fICONFIG_PROTECT_MASK\fR variable. To find
952 files that need to be updated in /etc, type \fBfind /etc \-iname \'._cfg????_*\'\fR.
954 You can disable this feature by setting \fICONFIG_PROTECT="\-*"\fR in /etc/make.conf.
955 Then, Portage will mercilessly auto\-update your config files. Alternatively,
956 you can leave Config File Protection on but tell Portage that it can overwrite
957 files in certain specific /etc subdirectories. For example, if you wanted
958 Portage to automatically update your rc scripts and your wget configuration,
959 but didn't want any other changes made without your explicit approval, you'd
960 add this to /etc/make.conf:
962 .I CONFIG_PROTECT_MASK="/etc/wget /etc/rc.d"
964 Tools such as dispatch\-conf, cfg\-update, and etc\-update are also available to
965 aid in the merging of these files. They provide interactive merging and can
966 auto\-merge trivial changes.
968 Please report any bugs you encounter through our website:
970 \fBhttp://bugs.gentoo.org/\fR
972 Please include the output of \fBemerge \-\-info\fR when you submit your
976 Daniel Robbins <drobbins@gentoo.org>
977 Geert Bevin <gbevin@gentoo.org>
978 Achim Gottinger <achim@gentoo.org>
979 Nicholas Jones <carpaski@gentoo.org>
980 Phil Bordelon <phil@thenexusproject.org>
981 Mike Frysinger <vapier@gentoo.org>
982 Marius Mauch <genone@gentoo.org>
983 Jason Stubbs <jstubbs@gentoo.org>
984 Brian Harring <ferringb@gmail.com>
985 Zac Medico <zmedico@gentoo.org>
988 Here is a common list of files you will probably be interested in. For a
989 complete listing, please refer to the \fBportage\fR(5) man page.
991 .B /usr/share/portage/config/sets/
992 Contains the default set configuration.
994 .B /var/lib/portage/world
995 Contains a list of all user\-specified packages. You can safely edit
996 this file, adding packages that you want to be considered in \fBworld\fR
997 set updates and removing those that you do not want to be considered.
1000 Contains variables for the build process, overriding those in
1003 .B /etc/portage/color.map
1004 Contains variables customizing colors.
1006 .B /etc/dispatch\-conf.conf
1007 Contains settings to handle automatic updates/backups of configuration
1010 .B /etc/make.profile/make.defaults
1011 Contains profile\-specific variables for the build process. \fBDo not
1014 .B /usr/portage/profiles/use.desc
1015 Contains the master list of USE flags with descriptions of their
1016 functions. \fBDo not edit this file\fR.
1018 .B /etc/make.profile/virtuals
1019 Contains a list of default packages used to resolve virtual dependencies.
1020 \fBDo not edit this file\fR.
1022 .B /etc/make.profile/packages
1023 Contains a list of packages used for the base system. The \fBsystem\fR
1024 and \fBworld\fR sets consult this file. \fBDo not edit this file\fR.
1026 .B /usr/share/portage/config/make.globals
1027 Contains the default variables for the build process. \fBDo not edit
1030 .BR "emerge \-\-help",
1038 A number of helper applications reside in \fI/usr/lib/portage/bin\fR.
1040 The \fBapp\-portage/gentoolkit\fR package contains useful scripts such as
1041 \fBequery\fR (a package query tool).
projects / portage.git / blob