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