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