1 .TH "EMERGE" "1" "Jul 2013" "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
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.
73 User sets may be created by placing files in the \fB/etc/portage/sets/\fR
74 directory (see \fBportage\fR(5)). Note that a \fIset\fR
75 is generally used in conjunction with \fB\-\-update\fR. When used as
76 arguments to \fBemerge\fR sets have to be prefixed with \fB@\fR to be
77 recognized. Use the \fB\-\-list\-sets\fR action to display a list of
78 available package sets.
81 An \fIatom\fR describes bounds on a package that you wish to install.
82 \fISee ebuild(5) for the details on atom syntax.\fR For example,
83 \fB>=dev\-lang/python\-2.2.1\-r2\fR matches the latest available version of
84 Python greater than or equal to 2.2.1\-r2. Similarly,
85 \fB<dev\-lang/python\-2.0\fR matches the latest available version of Python
86 before 2.0. Note that in many shells you will need to escape characters such
87 as '<' and '='; use single\- or double\-quotes around the \fIatom\fR
88 to get around escaping problems.
92 If no action is specified, the action is to merge in the specified
93 packages, satisfying any dependencies that they may have. The
94 arguments can be \fIatoms\fR, \fIsets\fR, installed \fIfiles\fR,
95 \fIebuilds\fR, or \fItbz2s\fR.
96 \fBNote that you need to use the \-\-usepkg
97 option if you want to install a tbz2\fR. The packages are added
98 to the \fBworld\fR file at the end, so that they are considered for
102 Scan all repositories for relevant unread GLEP 42 news items, and display
103 how many are found. See \fIhttp://www.gentoo.org/proj/en/glep/glep-0042.html\fR.
106 Cleans up the system by examining the installed packages and removing older
107 packages. This is accomplished by looking at each installed package and separating
108 the installed versions by \fBslot\fR. Clean will \fBremove all but the most recently
109 installed version in each \fbslot\fR. Clean should not remove unslotted packages.
110 Note: Most recently installed means most \fBrecent\fR, not highest version.
113 Run package specific actions needed to be executed after the emerge process
114 has completed. This usually entails configuration file setup or other similar
115 setups that the user may wish to run.
117 .BR "\-\-depclean (-c)"
118 Cleans the system by removing packages that are not associated
119 with explicitly merged packages. Depclean works by creating the
120 full dependency tree from the @world set,
121 then comparing it to installed packages. Packages installed, but
122 not part of the dependency tree, will be uninstalled by depclean.
123 See \fB\-\-with\-bdeps\fR for behavior with respect to build time dependencies
124 that are not strictly required. Packages that are part of the world set will
125 always be kept. They can be manually added to this set with \fIemerge
126 \-\-noreplace <atom>\fR. As a safety measure, depclean will not remove any
127 packages unless *all* required dependencies have been resolved. As a
128 consequence, it is often necessary to run \fIemerge \-\-update \-\-newuse
129 \-\-deep @world\fR prior to depclean. Also note that
130 depclean may break link level dependencies, especially when the
131 \fB\-\-depclean\-lib\-check\fR option is disabled. Thus, it is
132 recommended to use a tool such as \fBrevdep-rebuild\fR(1)
133 in order to detect such breakage.
136 Inexperienced users are advised to use \fB\-\-pretend\fR or \fB\-\-ask\fR
137 with this option in order to see a preview of which packages
138 will be uninstalled. Always study the list of packages
139 to be cleaned for any obvious mistakes. Note that packages listed in
140 package.provided (see \fBportage\fR(5)) may be removed by
141 depclean, even if they are part of the world set.
143 Depclean serves as a dependency aware
144 version of \fB\-\-unmerge\fR. When given one or more atoms, it will
145 unmerge matched packages that have no reverse dependencies. Use
146 \fB\-\-depclean\fR together with \fB\-\-verbose\fR to show reverse
149 .BR "\-\-deselect [ y | n ]"
150 Remove atoms and/or sets from the world file. This action is implied
151 by uninstall actions, including \fB-\-depclean\fR,
152 \fB-\-prune\fR and \fB-\-unmerge\fR. Use \fB-\-deselect=n\fR
153 in order to prevent uninstall actions from removing
154 atoms from the world file.
156 .BR "\-\-help " (\fB\-h\fR)
157 Displays help information for emerge. Adding one of the additional
158 arguments listed above will give you more specific help information
159 on that subject. The internal \fBemerge\fR help documentation is
160 updated more frequently than this man page; check it out if you
161 are having problems that this man page does not help resolve.
164 Produces a list of information to include in bug reports which aids the
165 developers when fixing the reported problem. \fBPlease include this
166 information when submitting a bug report.\fR Expanded output can be obtained
167 with the \fI\-\-verbose\fR option.
170 Displays a list of available package sets.
173 Transfers metadata cache from ${PORTDIR}/metadata/md5\-cache/ to
174 /var/cache/edb/dep/ as is normally done on the
175 tail end of an rsync update using \fBemerge \-\-sync\fR. This process
176 populates the cache database that portage uses for pre-parsed lookups of
177 package data. It does not populate cache for the overlays listed in
178 PORTDIR_OVERLAY. In order to generate cache for overlays, use \fB\-\-regen\fR.
179 In versions of portage >=2.1.5 the \-\-metadata action is totally unnecessary
180 unless the user has enabled FEATURES="metadata-transfer" in \fBmake.conf\fR(5).
182 .BR "\-\-prune " (\fB\-P\fR)
183 Removes all but the highest installed version of a package from your
184 system. Use \fB\-\-prune\fR together with \fB\-\-verbose\fR to show
185 reverse dependencies or with \fB\-\-nodeps\fR to ignore all dependencies.
186 \fBWARNING: This action can remove packages from your world file! Check
187 the emerge output of the next \-\-depclean run carefully! Use
188 \-\-depclean to avoid this issue.\fR
191 Causes portage to check and update the dependency cache of all ebuilds in the
192 portage tree. The cache is used to speed up searches and the building of
193 dependency trees. This command is not recommended for rsync users as rsync
194 updates the cache using server\-side caches. If you do not know the
195 differences between a 'rsync user' and some other user, then you are a 'rsync
196 user' :). Rsync users should simply run \fBemerge \-\-sync\fR to regenerate
197 the cache. After a portage update, rsync users may find it convenient to run
198 \fBemerge \-\-metadata\fR to rebuild the cache as portage does at the end of
199 a sync operation. In order to specify parallel \fB\-\-regen\fR behavior, use
200 the \fB\-\-jobs\fR and \fB\-\-load\-average\fR options. If you would like to
201 generate and distribute cache for use by others, use \fBegencache\fR(1).
203 .BR "\-\-resume" (\fB\-r\fR)
204 Resumes the most recent merge list that has been aborted due to an error.
205 This re\-uses the arguments and options that were given with the original
206 command that's being resumed, and the user may also provide
207 additional options when calling \fB\-\-resume\fR. It is an error to provide
208 atoms or sets as arguments to \fB\-\-resume\fR, since the arguments from the
209 resumed command are used instead.
210 Please note that this operation will only return an error on failure. If there
211 is nothing for portage to do, then portage will exit with a message and a
212 success condition. A resume list will persist until it has been completed in
213 entirety or until another aborted merge list replaces it. The resume history
214 is capable of storing two merge lists. After one resume list completes, it is
215 possible to invoke \-\-resume once again in order to resume an older list.
216 The resume lists are stored in \fI/var/cache/edb/mtimedb\fR, and may be
217 explicitly discarded by running `emaint \-\-fix cleanresume` (see
220 .BR "\-\-search " (\fB\-s\fR)
221 Searches for matches of the supplied string in the portage tree.
222 By default emerge uses a case-insensitive simple search, but you can
223 enable a regular expression search by prefixing the search string with %.
224 For example, \fBemerge \-\-search "%^kde"\fR searches for any package whose
225 name starts with "kde"; \fBemerge \-\-search "%gcc$"\fR searches for any
226 package that ends with "gcc"; \fBemerge \-\-search "office"\fR searches for
227 any package that contains the word "office". If you want to include the
228 category into the search string, prepend an @: \fBemerge \-\-search
229 "%@^dev-java.*jdk"\fR. If you want to search the package descriptions as well,
230 use the \fB\-\-searchdesc\fR action.
232 .BR "\-\-searchdesc " (\fB\-S\fR)
233 Matches the search string against the description field as well as
234 the package name. \fBTake caution\fR as the descriptions are also
235 matched as regular expressions.
238 Updates repositories, for which sync\-type and sync\-uri attributes are
239 set in repos.conf. See \fBportage\fR(5) for more information.
240 The \fBPORTAGE_SYNC_STALE\fR variable configures
241 warnings that are shown when emerge \-\-sync has not
242 been executed recently.
245 The emerge \-\-sync action will revert local changes (e.g. modifications or
246 additions of files) inside repositories synchronized using rsync.
249 The \fBemerge\-webrsync\fR program will download the entire
250 portage tree as a tarball, which is much faster than emerge
251 \-\-sync for first time syncs.
254 .BR "\-\-unmerge " (\fB\-C\fR)
255 \fBWARNING: This action can remove important packages!\fR Removes
256 all matching packages. This does no checking of dependencies, so
257 it may remove packages necessary for the proper operation of your
258 system. Its arguments can be \fIatoms\fR or
259 \fIebuilds\fR. For a dependency aware version of \fB\-\-unmerge\fR,
260 use \fB\-\-depclean\fR or \fB\-\-prune\fR.
262 .BR "\-\-version " (\fB\-V\fR)
263 Displays the version number of \fBemerge\fR.
266 .BR \-\-accept\-properties=ACCEPT_PROPERTIES
267 This option temporarily overrides the \fBACCEPT_PROPERTIES\fR
268 variable. The \fBACCEPT_PROPERTIES\fR variable is incremental,
269 which means that the specified setting is appended to the
270 existing value from your configuration. The special \fB-*\fR
271 token can be used to discard the existing configuration
272 value and start fresh. See the \fBMASKED PACKAGES\fR section
273 and \fBmake.conf\fR(5) for more information about
274 ACCEPT_PROPERTIES. A typical usage example for this option
275 would be to use \fI\-\-accept\-properties=\-interactive\fR to
276 temporarily mask interactive packages. With default
277 configuration, this would result in an effective
278 \fBACCEPT_PROPERTIES\fR value of "* -interactive".
280 .BR \-\-accept\-restrict=ACCEPT_RESTRICT
281 This option temporarily overrides the \fBACCEPT_RESTRICT\fR
282 variable. The \fBACCEPT_RESTRICT\fR variable is incremental,
283 which means that the specified setting is appended to the
284 existing value from your configuration. The special \fB-*\fR
285 token can be used to discard the existing configuration
286 value and start fresh. See the \fBMASKED PACKAGES\fR section
287 and \fBmake.conf\fR(5) for more information about
288 ACCEPT_RESTRICT. A typical usage example for this option
289 would be to use \fI\-\-accept\-restrict=\-bindist\fR to
290 temporarily mask packages that are not binary
291 re\-distributable. With default
292 configuration, this would result in an effective
293 \fBACCEPT_RESTRICT\fR value of "* -bindist".
295 .BR "\-\-alphabetical "
296 When displaying USE and other flag output, combines the enabled and
297 disabled lists into one list and sorts the whole list alphabetically.
299 .BR "\-\-ask [ y | n ] (\-a short option)"
300 Before performing the action, display what will take place (server info for
301 \fB\-\-sync\fR, \fB\-\-pretend\fR output for merge, and so forth), then ask
302 whether to proceed with the action or abort. Using \fB\-\-ask\fR is more
303 efficient than using \fB\-\-pretend\fR and then executing the same command
304 without \fB\-\-pretend\fR, as dependencies will only need to be calculated once.
305 \fBWARNING: If the "Enter" key is pressed at the prompt (with no other input),
306 it is interpreted as acceptance of the first choice. Note that the input
307 buffer is not cleared prior to the prompt, so an accidental press of the
308 "Enter" key at any time prior to the prompt will be interpreted as a choice!
309 Use the \-\-ask\-enter\-invalid option if you want a single "Enter" key
310 press to be interpreted as invalid input.\fR
312 .BR "\-\-ask\-enter\-invalid"
313 When used together with the \fB\-\-ask\fR option,
314 interpret a single "Enter" key press as
315 invalid input. This helps prevent accidental
316 acceptance of the first choice. This option is
317 intended to be set in the \fBmake.conf\fR(5)
318 \fBEMERGE_DEFAULT_OPTS\fR variable.
320 .BR "\-\-autounmask [ y | n ]"
321 Automatically unmask packages and generate package.use
322 settings as necessary to satisfy dependencies. This
323 option is enabled by default. If any configuration
324 changes are required, then they will be displayed
325 after the merge list and emerge will immediately
326 abort. If the displayed configuration changes are
327 satisfactory, you should copy and paste them into
328 the specified configuration file(s), or enable the
329 \fB\-\-autounmask\-write\fR option. The
330 \fBEMERGE_DEFAULT_OPTS\fR variable may be used to
331 disable this option by default in \fBmake.conf\fR(5).
333 .BR "\-\-autounmask\-unrestricted\-atoms [ y | n ]"
334 If \-\-autounmask is enabled, keyword and mask changes
335 using the \'=\' operator will be written. With this
336 option, \'>=\' operators will be used whenever possible.
337 USE and license changes always use the latter behavior.
339 .BR "\-\-autounmask\-keep\-masks [ y | n ]"
340 If \-\-autounmask is enabled, no package.unmask or ** keyword changes
341 will be created. This leads to unsatisfied dependencies if
342 no other solution exists.
344 .BR "\-\-autounmask\-write [ y | n ]"
345 If \-\-autounmask is enabled, changes are written
346 to config files, respecting \fBCONFIG_PROTECT\fR and \fB\-\-ask\fR.
347 If the corresponding package.* is a file, the changes are appended to
348 it, if it is a directory, changes are written to the lexicographically
349 last file. This way it is always ensured that the new changes take
350 precedence over existing changes.
352 .BR \-\-backtrack=COUNT
353 Specifies an integer number of times to backtrack if
354 dependency calculation fails due to a conflict or an
355 unsatisfied dependency (default: \'10\').
357 .BR "\-\-binpkg\-respect\-use [ y | n ]"
358 Tells emerge to ignore binary packages if their use flags
359 don't match the current configuration. (default: \'n\')
361 .BR "\-\-buildpkg [ y | n ] (\-b short option)"
362 Tells emerge to build binary packages for all ebuilds processed in
363 addition to actually merging the packages. Useful for maintainers
364 or if you administrate multiple Gentoo Linux systems (build once,
365 emerge tbz2s everywhere) as well as disaster recovery. The package
366 will be created in the \fBPKGDIR\fR directory (see \fBmake.conf\fR(5)).
367 An alternative for already\-merged
368 packages is to use \fBquickpkg\fR(1) which creates a tbz2 from the
371 .BR "\-\-buildpkg\-exclude " ATOMS
372 A space separated list of package atoms for which
373 no binary packages should be built. This option overrides all
374 possible ways to enable building of binary packages.
376 .BR "\-\-buildpkgonly " (\fB\-B\fR)
377 Creates binary packages for all ebuilds processed without actually
378 merging the packages. This comes with the caveat that all build-time
379 dependencies must already be emerged on the system.
381 .BR "\-\-changed\-use"
382 Tells emerge to include installed packages where USE flags have
383 changed since installation. This option also implies the
384 \fB\-\-selective\fR option. Unlike \fB\-\-newuse\fR, the
385 \fB\-\-changed\-use\fR option does not trigger reinstallation when
386 flags that the user has not enabled are added or removed.
388 NOTE: This option ignores the state of the "test" USE flag, since that flag
389 has a special binding to FEATURES="test" (see \fBmake.conf\fR(5) for more
390 information about \fBFEATURES\fR settings).
392 .BR "\-\-changelog " (\fB\-l\fR)
393 Use this in conjunction with the \fB\-\-pretend\fR option. This will
394 show the ChangeLog entries for all the packages that will be upgraded.
396 .BR "\-\-color < y | n >"
397 Enable or disable color output. This option will override \fINOCOLOR\fR
398 (see \fBmake.conf\fR(5)) and may also be used to force color output when stdout
399 is not a tty (by default, color is disabled unless stdout is a tty).
402 Used alongside \fB\-\-pretend\fR to cause the package name, new version,
403 and old version to be displayed in an aligned format for easy cut\-n\-paste.
405 .BR "\-\-complete\-graph [ y | n ]"
406 This causes \fBemerge\fR to consider the deep dependencies of all
407 packages from the world set. With this option enabled,
408 \fBemerge\fR will bail out if it determines that the given operation will
409 break any dependencies of the packages that have been added to the
410 graph. Like the \fB\-\-deep\fR option, the \fB\-\-complete\-graph\fR
411 option will significantly increase the time taken for dependency
412 calculations. Note that, unlike the \fB\-\-deep\fR option, the
413 \fB\-\-complete\-graph\fR option does not cause any more packages to
414 be updated than would have otherwise been updated with the option disabled.
415 Using \fB\-\-with\-bdeps=y\fR together with \fB\-\-complete\-graph\fR makes
416 the graph as complete as possible.
418 .BR "\-\-complete\-graph\-if\-new\-use < y | n >"
419 Trigger the \fB\-\-complete\-graph\fR behavior if USE or IUSE will
420 change for an installed package. This option is enabled by default.
422 .BR "\-\-complete\-graph\-if\-new\-ver < y | n >"
423 Trigger the \fB\-\-complete\-graph\fR behavior if an installed package
424 version will change (upgrade or downgrade). This option is enabled by default.
426 .BR \-\-config\-root=DIR
427 Set the \fBPORTAGE_CONFIGROOT\fR environment variable.
429 .BR "\-\-debug " (\fB\-d\fR)
430 Tells emerge to run the emerge command in \fB\-\-debug\fR mode. In this
431 mode the bash build environment will run with the \-x option, causing
432 it to output verbose debugging information to stdout. This also enables
433 a plethora of other output (mostly dependency resolution messages).
435 .BR "\-\-deep [DEPTH] " (\fB\-D\fR)
437 \fBemerge\fR to consider the entire dependency tree of packages,
438 instead of checking only the immediate dependencies of the packages.
439 As an example, this catches updates in libraries that are not directly
440 listed in the dependencies of a package. Also see \fB\-\-with\-bdeps\fR for
441 behavior with respect to build time dependencies that are not strictly
444 .BR "\-\-depclean\-lib\-check [ y | n ]"
445 Account for library link-level dependencies during
446 \fB\-\-depclean\fR and \fB\-\-prune\fR actions.
447 This option is enabled by default. If FEATURES="preserve\-libs" is
448 enabled in \fBmake.conf\fR(5), and preserve\-libs is not restricted
449 for any of the packages selected for removal, then this option is
450 ignored because any libraries that have consumers will simply be
454 Prevent corruption from being noticed. The `repoman manifest` command is the
455 preferred way to generate manifests and it is capable of doing an entire
456 repository or category at once (see \fBrepoman\fR(1)).
458 .BR "\-\-dynamic\-deps < y | n >"
459 In dependency calculations, substitute the dependencies of installed
460 packages with the dependencies of corresponding unbuilt ebuilds from
461 source repositories. This causes the effective dependencies of
462 installed packages to vary dynamically when source ebuild dependencies
463 are modified. This option is enabled by default.
466 If you want to disable \-\-dynamic\-deps, then it may be necessary to
467 first run \fBfixpackages\fR(1) in order to get the best results. The
468 \fBfixpackages\fR(1) command performs two different operations that can
469 also be performed separately by the `emaint \-\-fix moveinst` and
470 `emaint \-\-fix movebin` commands (see \fBemaint\fR(1)).
472 .BR "\-\-emptytree " (\fB\-e\fR)
473 Reinstalls target atoms and their entire deep
474 dependency tree, as though no packages are currently
475 installed. You should run this with \fB\-\-pretend\fR
476 first to make sure the result is what you expect.
478 .BR "\-\-exclude " ATOMS
479 A space separated list of package names or slot atoms.
480 Emerge won't install any ebuild or binary package that
481 matches any of the given package atoms.
483 .BR "\-\-fail\-clean [ y | n ]"
484 Clean up temporary files after a build failure. This is
485 particularly useful if you have \fBPORTAGE_TMPDIR\fR on
486 tmpfs. If this option is enabled, you probably also want
487 to enable \fBPORT_LOGDIR\fR (see \fBmake.conf\fR(5)) in
488 order to save the build log.
490 .BR "\-\-fetchonly " (\fB\-f\fR)
491 Instead of doing any package building, just perform fetches for all
492 packages (fetch things from SRC_URI based upon USE setting).
494 .BR "\-\-fetch\-all\-uri " (\fB\-F\fR)
495 Instead of doing any package building, just perform fetches for all
496 packages (fetch everything in SRC_URI regardless of USE setting).
498 .BR "\-\-getbinpkg [ y | n ] (\-g short option)"
499 Using the server and location defined in \fIPORTAGE_BINHOST\fR (see
500 \fBmake.conf\fR(5)), portage will download the information from each binary
501 package found and it will use that information to help build the dependency
502 list. This option implies \fB\-k\fR. (Use \fB\-gK\fR for binary\-only
505 .BR "\-\-getbinpkgonly [ y | n ] (\-G short option)"
506 This option is identical to \fB\-g\fR, as above, except binaries from the
507 remote server are preferred over local packages if they are not identical.
509 .BR "\-\-ignore-default-opts"
510 Causes \fIEMERGE_DEFAULT_OPTS\fR (see \fBmake.conf\fR(5)) to be ignored.
512 .BR "\-\-ignore\-built\-slot\-operator\-deps < y | n >"
513 Ignore the slot/sub\-slot := operator parts of dependencies that have
514 been recorded when packages where built. This option is intended
515 only for debugging purposes, and it only affects built packages
516 that specify slot/sub\-slot := operator dependencies which are
517 supported beginning with \fBEAPI 5\fR.
519 .BR "-j [JOBS], \-\-jobs[=JOBS]"
520 Specifies the number of packages to build simultaneously. If this option is
521 given without an argument, emerge will not limit the number of jobs that can
522 run simultaneously. Also see the related \fB\-\-load\-average\fR option.
523 Similarly to the \-\-quiet\-build option, the \-\-jobs option causes all
524 build output to be redirected to logs.
525 Note that interactive packages currently force a setting
526 of \fI\-\-jobs=1\fR. This issue can be temporarily avoided
527 by specifying \fI\-\-accept\-properties=\-interactive\fR.
529 .BR "\-\-keep\-going [ y | n ]"
530 Continue as much as possible after an error. When an error occurs,
531 dependencies are recalculated for remaining packages and any with
532 unsatisfied dependencies are automatically dropped. Also see
533 the related \fB\-\-skipfirst\fR option.
535 .BR "\-\-load\-average [LOAD]"
536 Specifies that no new builds should be started if there are other builds
537 running and the load average is at least LOAD (a floating-point number).
538 With no argument, removes a previous load limit.
539 This option is recommended for use in combination with \fB\-\-jobs\fR in
540 order to avoid excess load. See \fBmake\fR(1) for information about
541 analogous options that should be configured via \fBMAKEOPTS\fR in
544 .BR "\-\-misspell\-suggestions < y | n >"
545 Enable or disable misspell suggestions. By default, emerge will show
546 a list of packages with similar names when a package doesn't exist.
547 The \fIEMERGE_DEFAULT_OPTS\fR variable may be used to disable this
550 .BR "\-\-newuse " (\fB\-N\fR)
551 Tells emerge to include installed packages where USE
552 flags have changed since compilation. This option
553 also implies the \fB\-\-selective\fR option.
554 USE flag changes include:
556 A USE flag was added to a package.
557 A USE flag was removed from a package.
558 A USE flag was turned on for a package.
559 A USE flag was turned off for a package.
561 USE flags may be toggled by your profile as well as your USE and package.use
562 settings. If you would like to skip rebuilds for which disabled flags have
563 been added to or removed from IUSE, see the related
564 \fB\-\-changed\-use\fR option. If you would like to skip rebuilds for
565 specific packages, see the \fB\-\-exclude\fR option.
567 NOTE: This option ignores the state of the "test" USE flag, since that flag
568 has a special binding to FEATURES="test" (see \fBmake.conf\fR(5) for more
569 information about \fBFEATURES\fR settings).
572 Causes portage to disregard merge records indicating that a config file
573 inside of a \fBCONFIG_PROTECT\fR directory has been merged already. Portage
574 will normally merge those files only once to prevent the user from
575 dealing with the same config multiple times. This flag will cause the
576 file to always be merged.
578 .BR "\-\-nodeps " (\fB\-O\fR)
579 Merges specified packages without merging any dependencies. Note that
580 the build may fail if the dependencies aren't satisfied.
582 .BR "\-\-noreplace " (\fB\-n\fR)
583 Skips the packages specified on the command\-line that have already
584 been installed. Without this option, any package atoms or package sets
585 you specify on the command\-line \fBwill\fR cause Portage to remerge
586 the package, even if it is already installed. Note that Portage will
587 not remerge dependencies by default.
590 Disables the spinner for the session. The spinner is active when the
591 terminal device is determined to be a TTY. This flag disables it regardless.
593 .BR "\-\-usepkg\-exclude " ATOMS
594 A space separated list of package names or slot atoms. Emerge will ignore
595 matching binary packages.
597 .BR "\-\-rebuild\-exclude " ATOMS
598 A space separated list of package names or slot atoms. Emerge will not rebuild
599 matching packages due to \fB\-\-rebuild\fR.
601 .BR "\-\-rebuild\-ignore " ATOMS
602 A space separated list of package names or slot atoms. Emerge will not rebuild
603 packages that depend on matching packages due to \fB\-\-rebuild\fR.
605 .BR "\-\-oneshot " (\fB\-1\fR)
606 Emerge as normal, but do not add the packages to the world file
609 .BR "\-\-onlydeps " (\fB\-o\fR)
610 Only merge (or pretend to merge) the dependencies of the packages
611 specified, not the packages themselves.
613 .BR "\-\-package\-moves [ y | n ]"
614 Perform package moves when necessary. This option is enabled
615 by default. Package moves are typically applied immediately
616 after a \fB\-\-sync\fR action. They are applied in an
617 incremental fashion, using only the subset of the history of
618 package moves which have been added or modified since the
619 previous application of package moves.
621 \fBWARNING:\fR This option
622 should remain enabled under normal circumstances.
623 Do not disable it unless you know what you are
626 \fBNOTE:\fR The \fBfixpackages\fR(1) command can be used to
627 exhaustively apply the entire history of package moves,
628 regardless of whether or not any of the package moves have
629 been previously applied.
632 Specify which binary package format will be created as target.
633 Possible choices now are tar and rpm or their combinations.
636 Set the \fBEPREFIX\fR environment variable.
638 .BR "\-\-pretend " (\fB\-p\fR)
639 Instead of actually performing the merge, simply display what *would*
640 have been installed if \fB\-\-pretend\fR weren't used. Using \fB\-\-pretend\fR
641 is strongly recommended before installing an unfamiliar package. In
646 N new (not yet installed)
647 S new SLOT installation (side-by-side versions)
648 U updating (to another version)
649 D downgrading (best version seems lower)
650 r reinstall (forced for some reason, possibly due to slot or sub\-slot)
651 R replacing (remerging same version)
652 F fetch restricted (must be manually downloaded)
653 f fetch restricted (already downloaded)
654 I interactive (requires user input)
655 B blocked by another package (unresolved conflict)
656 b blocked by another package (automatically resolved conflict)
659 .BR "\-\-quiet [ y | n ] (\-q short option)"
660 Results may vary, but the general outcome is a reduced or condensed
661 output from portage's displays.
663 .BR "\-\-quiet\-build [ y | n ]"
664 Redirect all build output to logs alone, and do not display it on
665 stdout. If a build failure occurs for a single package, the build
666 log will be automatically displayed on stdout (unless the
667 \fI\-\-quiet\-fail\fR option is enabled). If there are multiple
668 build failures (due to options like \-\-keep\-going or \-\-jobs),
669 then the content of the log files will not be displayed, and instead
670 the paths of the log files will be displayed together with the
671 corresponding die messages.
672 Note that interactive packages currently force all build output to
673 be displayed on stdout. This issue can be temporarily avoided
674 by specifying \fI\-\-accept\-properties=\-interactive\fR.
676 .BR "\-\-quiet\-fail [ y | n ]"
677 Suppresses display of the build log on stdout when build output is hidden
678 due to options such as \fI\-\-jobs\fR, \fI\-\-quiet\fR, or
679 \fI\-\-quiet\-build\fR. Only the die message and the path of the build log
680 will be displayed on stdout.
682 .BR "\-\-quiet\-repo\-display"
683 In the package merge list display, suppress ::repository output, and
684 instead use numbers to indicate which repositories package come from.
686 .BR \-\-quiet\-unmerge\-warn
687 Disable the warning message that's shown prior to
688 \fB\-\-unmerge\fR actions. This option is intended
689 to be set in the \fBmake.conf\fR(5)
690 \fBEMERGE_DEFAULT_OPTS\fR variable.
692 .BR "\-\-rebuild\-if\-new\-slot [ y | n ]"
693 Automatically rebuild or reinstall packages when slot/sub\-slot :=
694 operator dependencies can be satisfied by a newer slot, so that
695 older packages slots will become eligible for removal by the
696 \-\-depclean action as soon as possible. This option only
697 affects packages that specify slot/sub\-slot := dependencies
698 which are supported beginning with \fBEAPI 5\fR.
699 Since this option requires
700 checking of reverse dependencies, it enables \-\-complete\-graph
701 mode whenever a new slot is installed. This option is enabled by
704 NOTE: If you want to skip all rebuilds involving slot\-operator
705 dependecies (including those that involve sub\-slot changes alone),
706 then \fI\-\-ignore\-built\-slot\-operator\-deps=y\fR is the option
707 that you are looking for, since \fI\-\-rebuild\-if\-new\-slot\fR
708 does not affect rebuilds triggered by sub\-slot changes alone.
710 .BR "\-\-rebuild\-if\-new\-rev [ y | n ]"
711 Rebuild packages when build\-time dependencies are built from source, if the
712 dependency is not already installed with the same version and revision.
714 .BR "\-\-rebuild\-if\-new\-ver [ y | n ]"
715 Rebuild packages when build\-time dependencies are built from source, if the
716 dependency is not already installed with the same version. Revision numbers
719 .BR "\-\-rebuild\-if\-unbuilt [ y | n ]"
720 Rebuild packages when build\-time dependencies are built from source.
722 .BR "\-\-rebuilt\-binaries [ y | n ]"
723 Replace installed packages with binary packages that have
724 been rebuilt. Rebuilds are detected by comparison of
725 BUILD_TIME package metadata. This option is enabled
726 automatically when using binary packages
727 (\fB\-\-usepkgonly\fR or \fB\-\-getbinpkgonly\fR) together with
728 \fB\-\-update\fR and \fB\-\-deep\fR.
730 .BR "\-\-rebuilt\-binaries\-timestamp=TIMESTAMP"
731 This option modifies emerge's behaviour only if
732 \fB\-\-rebuilt\-binaries\fR is given. Only binaries that
733 have a BUILD_TIME that is larger than the given TIMESTAMP
734 and that is larger than that of the installed package will
735 be considered by the rebuilt\-binaries logic.
737 .BR "\-\-reinstall changed\-use"
738 This is an alias for \fB\-\-changed\-use\fR.
740 .BR "\-\-reinstall\-atoms " ATOMS
741 A space separated list of package names or slot atoms. Emerge will treat
742 matching packages as if they are not installed, and reinstall them if
746 Set the \fBROOT\fR environment variable.
748 .BR "\-\-root\-deps[=rdeps]"
749 If no argument is given then build\-time dependencies of packages for
750 \fBROOT\fR are installed to \fBROOT\fR instead of /.
751 If the \fBrdeps\fR argument is given then discard all build\-time dependencies
752 of packages for \fBROOT\fR.
753 This option is only meaningful when used together with \fBROOT\fR and it should
754 not be enabled under normal circumstances!
756 Does not affect EAPIs that support \fBHDEPEND\fR.
757 Experimental \fBEAPI 5-hdepend\fR provides \fBHDEPEND\fR as a new
758 means to adjust installation into "\fI/\fR" and \fBROOT\fR.
759 If ebuilds using EAPIs which \fIdo not\fR support \fBHDEPEND\fR are built in
760 the same \fBemerge\fR run as those using EAPIs which \fIdo\fR support
761 \fBHDEPEND\fR, this option affects only the former.
763 .BR "\-\-select [ y | n ] (\-w short option)"
764 Add specified packages to the world set (inverse of
765 \fB\-\-oneshot\fR). This is useful if you want to
766 use \fBEMERGE_DEFAULT_OPTS\fR to make
767 \fB\-\-oneshot\fR behavior default.
769 .BR "\-\-selective [ y | n ]"
770 This is identical to the \fB\-\-noreplace\fR option.
771 Some options, such as \fB\-\-update\fR, imply \fB\-\-selective\fR.
772 Use \fB\-\-selective=n\fR if you want to forcefully disable
773 \fB\-\-selective\fR, regardless of options like \fB\-\-changed\-use\fR,
774 \fB\-\-newuse\fR, \fB\-\-noreplace\fR, or \fB\-\-update\fR.
777 This option is only valid when used with \fB\-\-resume\fR. It removes the
778 first package in the resume list. Dependencies are recalculated for
779 remaining packages and any that have unsatisfied dependencies or are
780 masked will be automatically dropped. Also see the related
781 \fB\-\-keep\-going\fR option.
783 .BR "\-\-tree " (\fB\-t\fR)
784 Shows the dependency tree for the given target by indenting dependencies.
785 This is only really useful in combination with \fB\-\-emptytree\fR or
786 \fB\-\-update\fR and \fB\-\-deep\fR.
788 .BR "\-\-unordered\-display"
789 By default the displayed merge list is sorted using the
790 order in which the packages will be merged. When
791 \fB\-\-tree\fR is used together with this option, this
792 constraint is removed, hopefully leading to a more
793 readable dependency tree.
795 .BR "\-\-update " (\fB\-u\fR)
796 Updates packages to the best version available, which may
797 not always be the highest version number due to masking
798 for testing and development. Package atoms specified on
799 the command line are greedy, meaning that unspecific
800 atoms may match multiple versions of slotted packages.
802 .BR "\-\-use\-ebuild\-visibility [ y | n ]"
803 Use unbuilt ebuild metadata for visibility
804 checks on built packages.
806 .BR "\-\-useoldpkg\-atoms " ATOMS
807 A space separated list of package names or slot atoms. Emerge will prefer
808 matching binary packages over newer unbuilt packages.
810 .BR "\-\-usepkg [ y | n ] (\-k short option)"
811 Tells emerge to use binary packages (from $PKGDIR) if they are available, thus
812 possibly avoiding some time\-consuming compiles. This option is useful for CD
813 installs; you can export PKGDIR=/mnt/cdrom/packages and then use this option to
814 have emerge "pull" binary packages from the CD in order to satisfy dependencies.
816 .BR "\-\-usepkgonly [ y | n ] (\-K short option)"
817 Tells emerge to only use binary packages (from $PKGDIR). All the binary
818 packages must be available at the time of dependency calculation or emerge
819 will simply abort. Portage does not use $PORTDIR when calculating dependency
820 information so all masking information is ignored.
822 .BR "\-\-verbose [ y | n ] (\-v short option)"
823 Tell emerge to run in verbose mode. Currently this flag causes emerge to print
824 out GNU info errors, if any, and to show the USE flags that will be used for
825 each package when pretending. The following symbols are affixed to USE flags
826 in order to indicate their status:
832 Symbol Location Meaning
834 - prefix not enabled (either disabled or removed)
835 * suffix transition to or from the enabled state
836 % suffix newly added or removed
837 () circumfix forced, masked, or removed
838 {} circumfix state is bound to FEATURES settings
841 .BR "\-\-verbose\-main\-repo\-display"
842 In the package merge list display, print ::repository even for main repository.
844 .BR "\-\-with\-bdeps < y | n >"
845 In dependency calculations, pull in build time dependencies
846 that are not strictly required. This defaults to \'n\' for
847 installation actions, meaning they will not be installed, and
848 \'y\' for the \fB\-\-depclean\fR action, meaning they will not be removed.
849 This setting can be added to
850 \fBEMERGE_DEFAULT_OPTS\fR (see make.conf(5)) and later overridden via the
852 .SH "ENVIRONMENT OPTIONS"
854 \fBEPREFIX\fR = \fI[path]\fR
855 Use \fBEPREFIX\fR to specify the target prefix to be used for merging packages
856 or ebuilds. This variable can be set via the \fB\-\-prefix\fR
857 option or in \fBmake.conf\fR(5) (the command line overrides other settings).
859 Defaults to the prefix where portage is currently installed.
861 \fBROOT\fR = \fI[path]\fR
862 Use \fBROOT\fR to specify the target root filesystem to be used for
863 merging packages or ebuilds. This variable can be set via the \fB\-\-root\fR
864 option or in \fBmake.conf\fR(5) (the command line overrides other settings).
868 \fBPORTAGE_CONFIGROOT\fR = \fI[path]\fR
869 Use \fBPORTAGE_CONFIGROOT\fR to specify the location for various portage
871 (see \fBFILES\fR for a detailed list of configuration files). This variable
872 can be set via the \fB\-\-config\-root\fR option.
876 When utilizing \fBemerge\fR with the \fB\-\-pretend\fR and \fB\-\-verbose\fR
877 flags, the output may be a little hard to understand at first. This section
878 explains the abbreviations.
880 .B [blocks B ] app\-text/dos2unix ("app\-text/dos2unix" is blocking app\-text/hd2u\-0.8.0)
881 Dos2unix is Blocking hd2u from being emerged. Blockers are defined when
882 two packages will clobber each others files, or otherwise cause some form
883 of breakage in your system. However, blockers usually do not need to be
884 simultaneously emerged because they usually provide the same functionality.
886 .B [ebuild N ] app\-games/qstat\-25c
887 Qstat is New to your system, and will be emerged for the first time.
889 .B [ebuild NS ] dev-libs/glib-2.4.7
890 You already have a version of glib installed, but a 'new' version in
891 a different SLOT is available.
893 .B [ebuild R ] sys\-apps/sed\-4.0.5
894 Sed 4.0.5 has already been emerged, but if you run the command, then
895 portage will Re\-emerge the specified package (sed in this case).
897 .B [ebuild F ] media\-video/realplayer\-8\-r6
898 The realplayer package requires that you Fetch the sources manually.
899 When you attempt to emerge the package, if the sources are not found,
900 then portage will halt and you will be provided with instructions on how
901 to download the required files.
903 .B [ebuild f ] media\-video/realplayer\-8\-r6
904 The realplayer package's files are already downloaded.
906 .B [ebuild U ] net\-fs/samba\-2.2.8_pre1 [2.2.7a]
907 Samba 2.2.7a has already been emerged and can be Updated to version
910 .B [ebuild UD] media\-libs/libgd\-1.8.4 [2.0.11]
911 Libgd 2.0.11 is already emerged, but if you run the command, then
912 portage will Downgrade to version 1.8.4 for you.
914 This may occur if a newer version of a package has been masked because it is
915 broken or it creates a security risk on your system and a fix has not been
918 Another reason this may occur is if a package you are trying to emerge requires
919 an older version of a package in order to emerge successfully. In this case,
920 libgd 2.x is incompatible with libgd 1.x. This means that packages that were
921 created with libgd 1.x will not compile with 2.x and must downgrade libgd first
922 before they can emerge.
924 .B [ebuild U ] sys\-devel/distcc\-2.16 [2.13\-r1] USE="ipv6* \-gtk \-qt%"
925 Here we see that the make.conf variable \fBUSE\fR affects how this package is
926 built. In this example, ipv6 optional support is enabled and both gtk and qt
927 support are disabled. The asterisk following ipv6 indicates that ipv6 support
928 was disabled the last time this package was installed. The percent sign
929 following qt indicates that the qt option has been added to the package since
930 it was last installed. For information about all \fBUSE\fR symbols, see the
931 \fB\-\-verbose\fR option documentation above.
933 \fB*Note:\fR Flags that haven't changed since the last install are only
934 displayed when you use the \fB\-\-pretend\fR and \fB\-\-verbose\fR options.
935 Using the \fB\-\-quiet\fR option will prevent all information from being
938 .B [ebuild r U ] dev\-libs/icu\-50.1.1:0/50.1.1 [50.1\-r2:0/50.1]
939 Icu 50.1\-r2 has already been emerged and can be Updated to version
940 50.1.1. The \fBr\fR symbol indicates that a sub\-slot change (from 50.1
941 to 50.1.1 in this case) will force packages having slot\-operator
942 dependencies on it to be rebuilt (as libxml2 will be rebuilt in the next
945 .B [ebuild rR ] dev\-libs/libxml2\-2.9.0\-r1:2 USE="icu"
946 Libxml2 2.9.0\-r1 has already been emerged, but if you run the command,
947 then portage will Re\-emerge it in order to satisfy a slot\-operator
948 dependency which forces it to be rebuilt when the icu sub\-slot changes
949 (as it changed in the previous example).
951 .B [ebuild U *] sys\-apps/portage\-2.2.0_alpha6 [2.1.9.25]
952 Portage 2.1.9.25 is installed, but if you run the command, then
953 portage will upgrade to version 2.2.0_alpha6. In this case,
954 the \fB*\fR symbol is displayed, in order to indicate that version
955 2.2.0_alpha6 is masked by missing keyword. This type of masking
956 display is disabled by the \fB\-\-quiet\fR option if the
957 \fB\-\-verbose\fR option is not enabled simultaneously.
958 The following symbols are used to indicate various types
971 \fBNOTE:\fR The unstable keyword symbol (~) will not be shown in cases
972 in which the corresponding unstable keywords have been accepted
973 globally via \fBACCEPT_KEYWORDS\fR.
978 You should almost always precede any package install or update attempt with a
979 \fB\-\-pretend\fR install or update. This lets you see how much will be
980 done, and shows you any blocking packages that you will have to rectify.
981 This goes doubly so for the \fBsystem\fR and \fBworld\fR sets, which can
982 update a large number of packages if the portage tree has been particularly
985 You also want to typically use \fB\-\-update\fR, which ignores packages that
986 are already fully updated but updates those that are not.
988 When you install a package with uninstalled dependencies and do
989 not explicitly state those dependencies in the list of parameters,
990 they will not be added to the world file. If you want them to be
991 detected for world updates, make sure to explicitly list them as
992 parameters to \fBemerge\fR.
994 \fBUSE variables\fR may be specified on the command line to
995 override those specified in the default locations, letting you
996 avoid using some dependencies you may not want to have. \fBUSE
997 flags specified on the command line are NOT remembered\fR. For
998 example, \fBenv USE="\-X \-gnome" emerge mc\fR will emerge mc with
999 those USE settings (on Bourne-compatible shells you may omit the \fBenv\fR
1000 part). If you want those USE settings to be more
1001 permanent, you can put them in /etc/portage/package.use instead.
1003 If \fBemerge \-\-update @system\fR or \fBemerge \-\-update @world\fR
1004 fails with an error message, it may be that an ebuild uses some
1005 newer feature not present in this version of \fBemerge\fR. You
1006 can use \fBemerge \-\-update portage\fR to upgrade to the lastest
1007 version, which should support any necessary new features.
1008 .SH "MASKED PACKAGES"
1009 \fINOTE: Please use caution when using development packages. Problems
1010 and bugs resulting from misusing masked packages drains Gentoo
1011 developer time. Please be sure you are capable of handling any problems
1014 Masks in \fBportage\fR have many uses: they allow a
1015 testing period where the packages can be used in live machines; they
1016 prevent the use of a package when it will fail; and they mask existing
1017 packages that are broken or could pose a security risk. Read below
1018 to find out how to unmask in various cases. Also note that if you give
1019 \fBemerge\fR an ebuild, then all forms of masking will be ignored and
1020 \fBemerge\fR will attempt to emerge the package.
1023 When packages are masked for \fBbacktracking\fR, it means that the dependency
1024 resolver has temporarily masked them in order to avoid dependency conflicts
1025 and/or unsatisfied dependencies. This type of mask is typically accompanied
1026 by a message about a missed package update which has been skipped in order to
1027 avoid dependency conflicts and/or unsatisfied dependencies.
1030 The \fBpackage.mask\fR file primarily blocks the use of packages that cause
1031 problems or are known to have issues on different systems. It resides in
1032 \fI/usr/portage/profiles\fR.
1035 Use the \fBACCEPT_CHOSTS\fR variable in \fBmake.conf\fR(5) to control
1036 \fBCHOST\fR acceptance.
1039 The \fBEAPI\fR variable in an \fBebuild\fR(5) file is used to mask packages
1040 that are not supported by the current version of portage. Packages masked by
1041 \fBEAPI\fR can only be installed after portage has been upgraded.
1044 The \fBKEYWORDS\fR variable in an \fBebuild\fR file is also used for masking
1045 a package still in testing. There are architecture\-specific keywords for
1046 each package that let \fBportage\fR know which systems are compatible with
1047 the package. Packages which compile on an architecture, but have not been
1048 proven to be "stable", are masked with a tilde (\fB~\fR) in front of the
1049 architecture name. \fBemerge\fR examines the \fBACCEPT_KEYWORDS\fR environment
1050 variable to allow or disallow the emerging of a package masked by
1051 \fBKEYWORDS\fR. To inform \fBemerge\fR that it should build these 'testing'
1052 versions of packages, you should update your
1053 \fI/etc/portage/package.accept_keywords\fR
1054 file to list the packages you want the
1055 \'testing\' version. See \fBportage\fR(5) for more information.
1058 The \fBLICENSE\fR variable in an \fBebuild\fR file can be used to mask
1059 packages based on licensing restrictions. \fBemerge\fR examines the
1060 \fBACCEPT_LICENSE\fR environment variable to allow or disallow the emerging
1061 of a package masked by \fBLICENSE\fR. See \fBmake.conf\fR(5) for information
1062 about \fBACCEPT_LICENSE\fR, and see \fBportage\fR(5) for information about
1063 \fI/etc/portage/package.license\fR.
1066 The \fBPROPERTIES\fR variable in an \fBebuild\fR file can be used to mask
1067 packages based on properties restrictions. \fBemerge\fR examines the
1068 \fBACCEPT_PROPERTIES\fR environment variable to allow or disallow the emerging
1069 of a package masked by \fBPROPERTIES\fR. See \fBmake.conf\fR(5) for information
1070 about \fBACCEPT_PROPERTIES\fR, and see \fBportage\fR(5) for information about
1071 \fI/etc/portage/package.properties\fR. Use the \fB\-\-accept\-properties\fR
1072 option to temporarily override \fBACCEPT_PROPERTIES\fR.
1075 The \fBRESTRICT\fR variable in an \fBebuild\fR file can be used to mask
1076 packages based on RESTRICT tokens. \fBemerge\fR examines the
1077 \fBACCEPT_RESTRICT\fR environment variable to allow or disallow the emerging
1078 of a package masked by \fBRESTRICT\fR. See \fBmake.conf\fR(5) for information
1079 about \fBACCEPT_RESTRICT\fR, and see \fBportage\fR(5) for information about
1080 \fI/etc/portage/package.accept_restrict\fR. Use the \fB\-\-accept\-restrict\fR
1081 option to temporarily override \fBACCEPT_RESTRICT\fR.
1082 .SH "CONFIGURATION FILES"
1083 Portage has a special feature called "config file protection". The purpose of
1084 this feature is to prevent new package installs from clobbering existing
1085 configuration files. By default, config file protection is turned on for /etc
1086 and the KDE configuration dirs; more may be added in the future.
1088 When Portage installs a file into a protected directory tree like /etc, any
1089 existing files will not be overwritten. If a file of the same name already
1090 exists, Portage will change the name of the to\-be\-installed file from 'foo' to
1091 \'._cfg0000_foo\'. If \'._cfg0000_foo\' already exists, this name becomes
1092 \'._cfg0001_foo\', etc. In this way, existing files are not overwritten,
1093 allowing the administrator to manually merge the new config files and avoid any
1096 In addition to protecting overwritten files, Portage will not delete any files
1097 from a protected directory when a package is unmerged. While this may be a
1098 little bit untidy, it does prevent potentially valuable config files from being
1099 deleted, which is of paramount importance.
1101 Protected directories are set using the \fICONFIG_PROTECT\fR variable, normally
1102 defined in make.globals. Directory exceptions to the CONFIG_PROTECTed
1103 directories can be specified using the \fICONFIG_PROTECT_MASK\fR variable. To find
1104 files that need to be updated in /etc, type \fBfind /etc \-iname \'._cfg????_*\'\fR.
1106 You can disable this feature by setting \fICONFIG_PROTECT="\-*"\fR in \fBmake.conf\fR(5).
1107 Then, Portage will mercilessly auto\-update your config files. Alternatively,
1108 you can leave Config File Protection on but tell Portage that it can overwrite
1109 files in certain specific /etc subdirectories. For example, if you wanted
1110 Portage to automatically update your rc scripts and your wget configuration,
1111 but didn't want any other changes made without your explicit approval, you'd
1112 add this to \fBmake.conf\fR(5):
1114 .I CONFIG_PROTECT_MASK="/etc/wget /etc/rc.d"
1116 Tools such as dispatch\-conf, cfg\-update, and etc\-update are also available to
1117 aid in the merging of these files. They provide interactive merging and can
1118 auto\-merge trivial changes.
1119 .SH "REPORTING BUGS"
1120 Please report any bugs you encounter through our website:
1122 \fBhttp://bugs.gentoo.org/\fR
1124 Please include the output of \fBemerge \-\-info\fR when you submit your
1128 Daniel Robbins <drobbins@gentoo.org>
1129 Geert Bevin <gbevin@gentoo.org>
1130 Achim Gottinger <achim@gentoo.org>
1131 Nicholas Jones <carpaski@gentoo.org>
1132 Phil Bordelon <phil@thenexusproject.org>
1133 Mike Frysinger <vapier@gentoo.org>
1134 Marius Mauch <genone@gentoo.org>
1135 Jason Stubbs <jstubbs@gentoo.org>
1136 Brian Harring <ferringb@gmail.com>
1137 Zac Medico <zmedico@gentoo.org>
1138 Arfrever Frehtes Taifersar Arahesis <arfrever@apache.org>
1141 Here is a common list of files you will probably be interested in. For a
1142 complete listing, please refer to the \fBportage\fR(5) man page.
1144 .B /usr/share/portage/config/sets/
1145 Contains the default set configuration.
1147 .B /var/lib/portage/world
1148 Contains a list of all user\-specified packages. You can safely edit
1149 this file, adding packages that you want to be considered in \fBworld\fR
1150 set updates and removing those that you do not want to be considered.
1152 .B /var/lib/portage/world_sets
1153 This is like the world file but instead of package atoms it contains
1154 packages sets which always begin with the \fB@\fR character. Use
1155 \fB/etc/portage/sets/\fR to define user package sets.
1157 .B /etc/portage/make.conf
1158 Contains variables for the build process, overriding those in
1161 .B /etc/portage/color.map
1162 Contains variables customizing colors.
1164 .B /etc/portage/sets/
1165 Contains user package set definitions (see \fBportage\fR(5)).
1167 .B /etc/dispatch\-conf.conf
1168 Contains settings to handle automatic updates/backups of configuration
1171 .B /etc/portage/make.profile/make.defaults
1172 Contains profile\-specific variables for the build process. \fBDo not
1175 .B /usr/portage/profiles/use.desc
1176 Contains the master list of USE flags with descriptions of their
1177 functions. \fBDo not edit this file\fR.
1179 .B /etc/portage/make.profile/virtuals
1180 Contains a list of default packages used to resolve virtual dependencies.
1181 \fBDo not edit this file\fR.
1183 .B /etc/portage/make.profile/packages
1184 Contains a list of packages used for the base system. The \fBsystem\fR
1185 and \fBworld\fR sets consult this file. \fBDo not edit this file\fR.
1187 .B /usr/share/portage/config/make.globals
1188 Contains the default variables for the build process. \fBDo not edit
1191 .BR "emerge \-\-help",
1199 A number of helper applications reside in \fI/usr/lib/portage/bin\fR.
1201 The \fBapp\-portage/gentoolkit\fR package contains useful scripts such as
1202 \fBequery\fR (a package query tool).
projects / portage.git / blob