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