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