For bug #156536, update --resume docs to show that the resume history is capable...
[portage.git] / man / emerge.1
1 .TH "EMERGE" "1" "Dec 2006" "Portage 2.1" "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 | \fIset\fR | \fIatom\fR] ...
8 .TP
9 .BR emerge
10 \fB\-\-sync\fR | \fB\-\-info\fR | \fB\-\-version\fR
11 .TP
12 .BR emerge
13 \fB\-\-search\fR \fIsomestring\fR
14 .TP
15 .BR emerge
16 \fB\-\-help\fR [\fB\-\-system\fR | \fB\-\-config\fR | \fB\-\-sync\fR]
17 .SH "DESCRIPTION"
18 \fBemerge\fR is the definitive command\-line interface to the Portage
19 system.  It is primarily used for installing packages, and \fBemerge\fR
20 can automatically handle any dependencies that the desired package has.
21 \fBemerge\fR can also update the \fBportage tree\fR, making new and
22 updated packages available.  \fBemerge\fR gracefully handles updating
23 installed packages to newer releases as well.  It handles both source
24 and binary packages, and it can be used to create binary packages for
25 distribution.
26 .SH "EBUILDS, TBZ2S, SETS AND ATOMS"
27 \fBemerge\fR primarily installs packages.  You can specify
28 packages to install in one of four main ways: an \fIebuild\fR,
29 a \fItbz2file\fR, a \fIset\fR, or an \fIatom\fR.
30 .LP
31 .TP
32 .BR ebuild
33 An \fIebuild\fR must be, at a minimum, a valid Portage
34 package directory name without a version or category, such as
35 \fBportage\fR or \fBpython\fR.
36 Both categories and version numbers may be used in addition, such
37 as \fBsys\-apps/portage\fR or \fB=python\-2.2.1\-r2\fR.
38 \fBemerge\fR
39 ignores a trailing slash so that filename completion can be used.
40 The \fIebuild\fR may also be an actual filename, such as
41 \fB/usr/portage/app\-admin/python/python\-2.2.1\-r2.ebuild\fR.
42 \fBWARNING:\fR The implementation of \fBemerge /path/to/ebuild\fR is broken and
43 so this syntax shouldn't be used.
44 .TP
45 .BR tbz2file
46 A \fItbz2file\fR must be a valid .tbz2 created with \fBebuild
47 <package>\-<version>.ebuild package\fR or \fBemerge \-\-buildpkg 
48 [category/]<package>\fR or \fBquickpkg /var/db/pkg/<category>/<package>\fR.
49 .TP
50 .BR set
51 A \fIset\fR is a convenient shorthand for a large group of
52 packages.  Two sets are currently supported: \fBsystem\fR
53 and \fBworld\fR.  \fBsystem\fR refers to a set of packages
54 deemed necessary for your system to run properly.  \fBworld\fR
55 contains all the packages in \fBsystem\fR, plus any
56 other packages listed in \fB/var/lib/portage/world\fR.  [See
57 \fBFILES\fR below for more information.]  Note that a \fIset\fR
58 is generally used in conjunction with \fB\-\-update\fR.
59 .TP
60 .BR atom
61 An \fIatom\fR describes bounds on a package that you wish to install.  
62 \fISee portage(5) for the details on atom syntax.\fR  For example, 
63 \fB>=dev\-lang/python\-2.2.1\-r2\fR matches the latest available version of 
64 Python greater than or equal to 2.2.1\-r2.  Similarly, 
65 \fB<dev\-lang/python\-2.0\fR matches the latest available version of Python 
66 before 2.0.  Note that in many shells you will need to escape characters such 
67 as '<' and '='; use single\- or double\-quotes around the \fIatom\fR 
68 to get around escaping problems.
69 .SH "ACTIONS"
70 .TP
71 .BR "No action"
72 If no action is specified, the action is to merge in the specified
73 packages, satisfying any dependencies that they may have.  The
74 arguments can be \fIebuilds\fR, \fItbz2s\fR, \fIsets\fR, or
75 \fIatoms\fR.  \fBNote that you need to use the \-\-usepkg 
76 option if you want to install a tbz2\fR.  The packages are added
77 to the \fBworld\fR file at the end, so that they are considered for
78 later updating.
79 .TP
80 .BR "\-\-clean " (\fB\-c\fR)
81 Cleans up the system by examining the installed packages and removing older
82 packages.  This is accomplished by looking at each installed package and separating
83 the installed versions by \fBslot\fR.  Clean will \fBremove all but the most recently
84 installed version in each \fbslot\fR.  Clean should not remove unslotted packages.
85 Note: Most recently installed means most \fBrecent\fR, not highest version.
86 .TP
87 .BR "\-\-config "
88 Run package specific actions needed to be executed after the emerge process 
89 has completed.  This usually entails configuration file setup or other similar 
90 setups that the user may wish to run.
91 .TP
92 .BR \-\-depclean
93 Determines all packages installed on the system that have no 
94 explicit reason for being there.  \fBemerge\fR generates a list 
95 of packages which it expects to be installed by checking the 
96 \fBsystem\fR package list and the \fBworld\fR file.  It then 
97 compares that list to the list of packages which are actually 
98 installed; the differences are listed as unnecessary packages 
99 and then unmerged after a short timeout.  \fBWARNING: Removing some 
100 packages may cause packages which link to the removed package 
101 to stop working and complain about missing libraries.\fR 
102 Re\-emerge the complaining package to fix this issue.  Also see
103 \fB\-\-with\-bdeps\fR for behavior with respect to build time dependencies that
104 are not strictly required.
105 .TP
106 .BR "\-\-help " (\fB\-h\fR)
107 Displays help information for emerge.  Adding one of the additional
108 arguments listed above will give you more specific help information
109 on that subject.  The internal \fBemerge\fR help documentation is
110 updated more frequently than this man page; check it out if you
111 are having problems that this man page does not help resolve.
112 .TP
113 .BR \-\-info
114 Produces a list of information to include in bug reports which aids the 
115 developers when fixing the reported problem.  \fBPlease include this 
116 information when submitting a bug report.\fR  Expanded output can be obtained 
117 with the \fI\-\-verbose\fR option.
118 .TP
119 .BR \-\-metadata
120 Transfers metadata cache from ${PORTDIR}/metadata/cache/ to
121 /var/cache/edb/dep/ as is normally done on the
122 tail end of an rsync update using \fBemerge \-\-sync\fR.  This process
123 populates the cache database that portage uses for pre-parsed lookups of
124 package data.  It does not populate cache for the overlays listed in
125 PORTDIR_OVERLAY.  In order to generate cache for overlays, use \fB\-\-regen\fR.
126 .TP
127 .BR "\-\-prune " (\fB\-P\fR)
128 \fBWARNING: This action can remove important packages!\fR  Prune looks at each
129 installed package and attempts to \fBremove\fR all but the \fBmost recently 
130 installed version.  \fRPrune ignores \fBslots\fR, if you require a slot\-aware
131 Prune use \fB emerge \-\-clean\fR.  Prune may inadvertently remove important 
132 packages from your system.  Use \fB\-\-clean\fR instead unless you really 
133 know what you're doing.
134 .TP
135 .BR \-\-regen
136 Causes portage to check and update the dependency cache of all ebuilds in the 
137 portage tree.  The cache is used to speed up searches and the building of 
138 dependency trees.  This command is not recommended for rsync users as rsync 
139 updates the cache using server\-side caches.  If you do not know the 
140 differences between a 'rsync user' and some other user, then you are a 'rsync 
141 user' :).  Rsync users should simply run \fBemerge \-\-sync\fR to regenerate 
142 the cache.  After a portage update, rsync users may find it convenient to run 
143 \fBemerge \-\-metadata\fR to rebuild the cache as portage does at the end of 
144 a sync operation.
145 .TP
146 .BR "\-\-resume"
147 Resumes the most recent merge list that has been aborted due to an error.
148 Please note that this operation will only return an error on failure.  If there
149 is nothing for portage to do, then portage will exit with a message and a
150 success condition. A resume list will persist until it has been completed in
151 entirety or until another aborted merge list replaces it.  The resume history
152 is capable of storing two merge lists.  After one resume list completes, it is
153 possible to invoke \-\-resume once again in order to resume an older list.
154 .TP
155 .BR "\-\-search " (\fB\-s\fR)
156 Searches for matches of the supplied string in the portage tree.
157 By default emerge uses a case-insensitive simple search, but you can 
158 enable a regular expression search by prefixing the search string with %.
159 For example, \fBemerge \-\-search "%^kde"\fR searches for any package whose 
160 name starts with "kde"; \fBemerge \-\-search "%gcc$"\fR searches for any 
161 package that ends with "gcc"; \fBemerge \-\-search "office"\fR searches for 
162 any package that contains the word "office".  If you want to include the 
163 category into the search string, prepend an @: \fBemerge --search 
164 "%@^dev-java.*jdk"\fR. If you want to search the package descriptions as well, 
165 use the \fB\-\-searchdesc\fR action.
166 .TP
167 .BR "\-\-searchdesc " (\fB\-S\fR)
168 Matches the search string against the description field as well as
169 the package name.  \fBTake caution\fR as the descriptions are also
170 matched as regular expressions.
171 .TP
172 .BR \-\-sync
173 Initiates a portage tree update with one of the rsync.gentoo.org
174 mirrors.  \fBNote that any changes you have made to the portage
175 tree will be erased\fR.  Except for special circumstances, 
176 this uses \fBrsync\fR to do the update.  See \fBmake.conf\fR(5)'s 
177 description of PORTDIR_OVERLAY for a method to avoid deletions.
178 .TP
179 .BR "\-\-unmerge " (\fB\-C\fR)
180 \fBWARNING: This action can remove important packages!\fR Removes
181 all matching packages.  This does no checking of dependencies, so
182 it may remove packages necessary for the proper operation of your
183 system.  Its arguments can be \fIebuilds\fR, \fIsets\fR, or
184 \fIatoms\fR.
185 .TP
186 .BR "\-\-update " (\fB\-u\fR)
187 Updates packages to the best version available, which may not always be the 
188 highest version number due to masking for testing and development.  This will 
189 also update direct dependencies which may not be what you want.  Package atoms
190 specified on the command line are greedy, meaning that unspecific atoms may
191 match multiple installed versions of slotted packages.
192 .TP
193 .BR "\-\-version " (\fB\-V\fR)
194 Displays the version number of \fBemerge\fR.
195 .SH "OPTIONS"
196 .TP
197 .BR "\-\-alphabetical "
198 When displaying USE and other flag output, combines the enabled and
199 disabled lists into one list and sorts the whole list alphabetically.
200 .TP
201 .BR "\-\-ask " (\fB\-a\fR)
202 Before performing the action, display what will take place (server info for
203 \fB\-\-sync\fR, \fB\-\-pretend\fR output for merge, and so forth), then ask
204 whether to proceed with the action or abort.  Using \fB\-\-ask\fR is more
205 efficient than using \fB\-\-pretend\fR and then executing the same command
206 without \fB\-\-pretend\fR, as dependencies will only need to be calculated once.
207 \fBWARNING: If the "Enter" key is pressed at the prompt (with no other input),
208 it is interpreted as acceptance of the first choice.  Note that the input
209 buffer is not cleared prior to the prompt, so an accidental press of the
210 "Enter" key at any time prior to the prompt will be interpreted as a choice!\fR
211 .TP
212 .BR "\-\-buildpkg " (\fB\-b\fR)
213 Tells emerge to build binary packages for all ebuilds processed in
214 addition to actually merging the packages.  Useful for maintainers
215 or if you administrate multiple Gentoo Linux systems (build once,
216 emerge tbz2s everywhere).  The package will be created in the
217 \fI${PKGDIR}/All\fR directory.  An alternative for already\-merged
218 packages is to use \fBquickpkg\fR which creates a tbz2 from the
219 live filesystem.
220 .TP
221 .BR "\-\-buildpkgonly " (\fB\-B\fR)
222 Creates binary packages for all ebuilds processed without actually
223 merging the packages.  This comes with the caveat that all build-time 
224 dependencies must already be emerged on the system.
225 .TP
226 .BR "\-\-changelog " (\fB\-l\fR)
227 Use this in conjunction with the \fB\-\-pretend\fR option.  This will
228 show the ChangeLog entries for all the packages that will be upgraded.
229 .TP
230 .BR "\-\-color < y | n >"
231 Enable or disable color output.  This option will override \fINOCOLOR\fR
232 (see \fBmake.conf\fR(5)) and may also be used to force color output when stdout
233 is not a tty (by default, color is disabled unless stdout is a tty).
234 .TP
235 .BR "\-\-columns"
236 Used alongside \fB\-\-pretend\fR to cause the package name, new version, 
237 and old version to be displayed in an aligned format for easy cut\-n\-paste.
238 .TP
239 .BR \-\-config\-root=DIR
240 Set the \fBPORTAGE_CONFIGROOT\fR environment variable.
241 .TP
242 .BR "\-\-debug " (\fB\-d\fR)
243 Tells emerge to run the emerge command in \fB\-\-debug\fR mode.  In this
244 mode the bash build environment will run with the \-x option, causing 
245 it to output verbose debugging information to stdout.  This also enables
246 a plethora of other output (mostly dependency resolution messages).
247 .TP
248 .BR "\-\-deep " (\fB\-D\fR)
249 This flag forces
250 \fBemerge\fR to consider the entire dependency tree of packages,
251 instead of checking only the immediate dependencies of the packages.
252 As an example, this catches updates in libraries that are not directly
253 listed in the dependencies of a package.  Also see \fB\-\-with\-bdeps\fR for
254 behavior with respect to build time dependencies that are not strictly
255 required.
256 .TP
257 .BR "\-\-emptytree " (\fB\-e\fR)
258 Reinstalls all world packages and their dependencies to the current USE 
259 specifications while differing from the installed set of packages as 
260 little as possible.  You should run with \fB\-\-pretend\fR first to make 
261 sure the result is what you expect.
262 .TP
263 .BR "\-\-fetchonly " (\fB\-f\fR)
264 Instead of doing any package building, just perform fetches for all
265 packages (the main package as well as all dependencies).
266 .TP
267 .BR "\-\-fetch\-all\-uri " (\fB\-F\fR)
268 Instead of doing any package building, just perform fetches for all
269 packages (the main package as well as all dependencies), grabbing all potential
270 files.
271 .TP
272 .BR "\-\-getbinpkg " (\fB\-g\fR)
273 Using the server and location defined in \fIPORTAGE_BINHOST\fR (see 
274 \fBmake.conf\fR(5)), portage will download the information from each binary 
275 package found and it will use that information to help build the dependency 
276 list.  This option implies \fB\-k\fR.  (Use \fB\-gK\fR for binary\-only 
277 merging.)
278 .TP
279 .BR "\-\-getbinpkgonly " (\fB\-G\fR)
280 This option is identical to \fB\-g\fR, as above, except it will not use ANY 
281 information from the local machine.  All binaries will be downloaded from the 
282 remote server without consulting packages existing in the local packages 
283 directory.
284 .TP
285 .BR "\-\-ignore-default-opts"
286 Causes \fIEMERGE_DEFAULT_OPTS\fR (see \fBmake.conf\fR(5)) to be ignored.
287 .TP
288 .BR "\-\-newuse " (\fB\-N\fR)
289 Tells emerge to include installed packages where USE flags have changed since 
290 compilation.  USE flag changes include:
291
292 A USE flag was added to a package.
293 A USE flag was removed from a package.
294 A USE flag was turned on for a package.
295 A USE flag was turned off for a package.
296
297 USE flags may be toggled by your profile as well as your USE and package.use
298 settings.
299 .TP
300 .BR "\-\-noconfmem"
301 Causes portage to disregard merge records indicating that a config file
302 inside of a \fBCONFIG_PROTECT\fR directory has been merged already.  Portage
303 will normally merge those files only once to prevent the user from
304 dealing with the same config multiple times.  This flag will cause the
305 file to always be merged.
306 .TP
307 .BR "\-\-nodeps " (\fB\-O\fR)
308 Merges specified packages without merging any dependencies.  Note that
309 the build may fail if the dependencies aren't satisfied.
310 .TP
311 .BR "\-\-noreplace " (\fB\-n\fR)
312 Skips the packages specified on the command\-line that have already
313 been installed.  Without this option, any packages, ebuilds, or deps
314 you specify on the command\-line \fBwill\fR cause Portage to remerge
315 the package, even if it is already installed.  Note that Portage will
316 not remerge dependencies by default.
317 .TP
318 .BR "\-\-nospinner"
319 Disables the spinner for the session.  The spinner is active when the
320 terminal device is determined to be a TTY.  This flag disables it regardless.
321 .TP
322 .BR "\-\-oneshot " (\fB\-1\fR)
323 Emerge as normal, but do not add the packages to the world file
324 for later updating.
325 .TP
326 .BR "\-\-onlydeps " (\fB\-o\fR)
327 Only merge (or pretend to merge) the dependencies of the packages
328 specified, not the packages themselves.
329 .TP
330 .BR "\-\-pretend " (\fB\-p\fR)
331 Instead of actually performing the merge, simply display what *would*
332 have been installed if \fB\-\-pretend\fR weren't used.  Using \fB\-\-pretend\fR
333 is strongly recommended before installing an unfamiliar package.  In
334 the printout:
335 .br 
336  
337 .br 
338 \fIN\fR = new (not yet installed)
339 .br 
340 \fIS\fR = new SLOT installation (side-by-side versions) 
341 .br 
342 \fIU\fR = updating (to another version)
343 .br 
344 \fID\fR = downgrading (best version seems lower)
345 .br 
346 \fIR\fR = replacing (remerging same version))
347 .br 
348 \fIF\fR = fetch restricted (must be manually downloaded)
349 .br 
350 \fIf\fR = fetch restricted (already downloaded)
351 .br 
352 \fIB\fR = blocked by an already installed package
353 .TP
354 .BR "\-\-quiet " (\fB\-q\fR)
355 Results may vary, but the general outcome is a reduced or condensed
356 output from portage's displays.
357 .TP
358 .BR "\-\-skipfirst"
359 This option is only valid when used with \fB\-\-resume\fR.  It removes the 
360 first package in the resume list so that a merge may continue in the presence 
361 of an uncorrectable or inconsequential error.  This should only be used in 
362 cases where skipping the package will not result in failed dependencies.
363 .TP
364 .BR "\-\-tree " (\fB\-t\fR)
365 Shows the dependency tree for the given target by indenting dependencies.
366 This is only really useful in combination with \fB\-\-emptytree\fR or 
367 \fB\-\-update\fR and \fB\-\-deep\fR.
368 .TP
369 .BR "\-\-usepkg " (\fB\-k\fR) 
370 Tells emerge to use binary packages (from $PKGDIR) if they are available, thus 
371 possibly avoiding some time\-consuming compiles.  This option is useful for CD 
372 installs; you can export PKGDIR=/mnt/cdrom/packages and then use this option to 
373 have emerge "pull" binary packages from the CD in order to satisfy dependencies.
374 .TP
375 .BR "\-\-usepkgonly " (\fB\-K\fR)
376 Tells emerge to only use binary packages (from $PKGDIR).  All the binary 
377 packages must be available at the time of dependency calculation or emerge 
378 will simply abort.  Portage does not use $PORTDIR when calculating dependency 
379 information so all masking information is ignored.
380 .TP
381 .BR "\-\-verbose " (\fB\-v\fR)
382 Tell emerge to run in verbose mode.  Currently this flag causes emerge to print 
383 out GNU info errors, if any, and to show the USE flags that will be used for 
384 each package when pretending. The following symbols are affixed to USE flags
385 in order to indicate their status:
386 .br
387
388 .br
389 \fI- prefix\fR     = not enabled (either disabled or removed)
390 .br
391 \fI* suffix\fR     = transition to or from the enabled state
392 .br
393 \fI% suffix\fR     = newly added or removed
394 .br
395 \fI() circumfix\fR = forced, masked, or removed
396 .TP
397 .BR "\-\-with\-bdeps < y | n >"
398 In dependency calculations, pull in build time dependencies that are not
399 strictly required.   This defaults to \'n\' for installation actions and
400 \'y\' for the \fB\-\-depclean\fR action.  This setting can be added to
401 \fBEMERGE_DEFAULT_OPTS\fR (see make.conf(5)) and later overridden via the
402 command line.
403 .SH "ENVIRONMENT OPTIONS"
404 .TP
405 \fBROOT\fR = \fI[path]\fR
406 Use \fBROOT\fR to specify the target root filesystem to be used for
407 merging packages or ebuilds.  This variable can be set in \fBmake.conf\fR(5)
408 when \fBPORTAGE_CONFIGROOT\fR has a value other than /.
409 .br
410 Defaults to /.
411 .TP
412 \fBPORTAGE_CONFIGROOT\fR = \fI[path]\fR
413 Use \fBPORTAGE_CONFIGROOT\fR to specify the location for various portage 
414 configuration files
415 (see \fBFILES\fR for a detailed list of configuration files).  This variable
416 can be set via the \fB\-\-config\-root\fR option.
417 .br
418 Defaults to /.
419 .SH "OUTPUT"
420 When utilizing \fBemerge\fR with the \fB\-\-pretend\fR and \fB\-\-verbose\fR 
421 flags, the output may be a little hard to understand at first.  This section
422 explains the abbreviations.
423 .TP
424 .B [blocks B     ] app\-text/dos2unix (from pkg app\-text/hd2u\-0.8.0)
425 Dos2unix is Blocking hd2u from being emerged.  Blockers are defined when
426 two packages will clobber each others files, or otherwise cause some form
427 of breakage in your system.  However, blockers usually do not need to be
428 simultaneously emerged because they usually provide the same functionality.
429 .TP
430 .B [ebuild  N    ] app\-games/qstat\-25c
431 Qstat is New to your system, and will be emerged for the first time.
432 .TP
433 .B [ebuild  NS   ] dev-libs/glib-2.4.7
434 You already have a version of glib installed, but a 'new' version in 
435 a different SLOT is available.
436 .TP
437 .B [ebuild   R   ] sys\-apps/sed\-4.0.5
438 Sed 4.0.5 has already been emerged, but if you run the command, then 
439 portage will Re\-emerge the specified package (sed in this case).
440 .TP
441 .B [ebuild    F  ] media\-video/realplayer\-8\-r6
442 The realplayer package requires that you Fetch the sources manually.  
443 When you attempt to emerge the package, if the sources are not found, 
444 then portage will halt and you will be provided with instructions on how 
445 to download the required files.
446 .TP
447 .B [ebuild    f  ] media\-video/realplayer\-8\-r6
448 The realplayer package's files are already downloaded.
449 .TP
450 .B [ebuild     U ] net\-fs/samba\-2.2.8_pre1 [2.2.7a]
451 Samba 2.2.7a has already been emerged and can be Updated to version 
452 2.2.8_pre1.
453 .TP
454 .B [ebuild     UD] media\-libs/libgd\-1.8.4 [2.0.11]
455 Libgd 2.0.11 is already emerged, but if you run the command, then 
456 portage will Downgrade to version 1.8.4 for you.
457 .br 
458 This may occur if a newer version of a package has been masked because it is
459 broken or it creates a security risk on your system and a fix has not been
460 released yet.
461 .br 
462 Another reason this may occur is if a package you are trying to emerge requires
463 an older version of a package in order to emerge successfully.  In this case,
464 libgd 2.x is incompatible with libgd 1.x.  This means that packages that were
465 created with libgd 1.x will not compile with 2.x and must downgrade libgd first
466 before they can emerge.
467 .TP
468 .B [ebuild     U ] sys\-devel/distcc\-2.16 [2.13\-r1] USE="ipv6* \-gtk \-qt%"
469 Here we see that the make.conf variable \fBUSE\fR affects how this package is
470 built.  In this example, ipv6 optional support is enabled and both gtk and qt
471 support are disabled.  The asterisk following ipv6 indicates that ipv6 support
472 was disabled the last time this packages was installed.  The percent sign
473 following qt indicates that the qt option has been added to the package since
474 it was last installed.  For information about all \fBUSE\fR symbols, see the
475 \fB\-\-verbose\fR option documentation above.
476 .br
477 \fB*Note:\fR Flags that haven't changed since the last install are only
478 displayed when you use the \fB\-\-pretend\fR and \fB\-\-verbose\fR options.
479 Using the \fB\-\-quiet\fR option will prevent all information from being
480 displayed.
481 .SH "NOTES"
482 You should almost always precede any package install or update attempt with a 
483 \fB\-\-pretend\fR install or update.  This lets you see how much will be 
484 done, and shows you any blocking packages that you will have to rectify.  
485 This goes doubly so for the \fBsystem\fR and \fBworld\fR sets, which can 
486 update a large number of packages if the portage tree has been particularly 
487 active.
488 .LP
489 You also want to typically use \fB\-\-update\fR, which ignores packages that 
490 are already fully updated but updates those that are not.
491 .LP
492 When you install a package with uninstalled dependencies and do
493 not explicitly state those dependencies in the list of parameters,
494 they will not be added to the world file.  If you want them to be
495 detected for world updates, make sure to explicitly list them as
496 parameters to \fBemerge\fR.
497 .LP
498 \fBUSE variables\fR may be specified on the command line to
499 override those specified in the default locations, letting you
500 avoid using some dependencies you may not want to have.  \fBUSE
501 flags specified on the command line are NOT remembered\fR.  For
502 example, \fBenv USE="\-X \-gnome" emerge mc\fR will emerge mc with
503 those USE settings (on Bourne-compatible shells you may omit the \fBenv\fR
504 part).  If you want those USE settings to be more 
505 permanent, you can put them in /etc/portage/package.use instead.
506 .LP
507 If \fBemerge \-\-update system\fR or \fBemerge \-\-update world\fR
508 fails with an error message, it may be that an ebuild uses some
509 newer feature not present in this version of \fBemerge\fR.  You
510 can use \fBemerge \-\-update portage\fR to upgrade to the lastest
511 version, which should support any necessary new features.
512 .SH "MASKED PACKAGES"
513 \fINOTE: Please use caution when using development packages.  Problems
514 and bugs resulting from misusing masked packages drains Gentoo
515 developer time.  Please be sure you are capable of handling any problems
516 that may ensue.\fR
517 .LP
518 Masks in \fBportage\fR provide three primary functions: they allow a
519 testing period where the packages can be used in live machines; they
520 prevent the use of a package when it will fail; and they mask existing
521 packages that are broken or could pose a security risk.  Masking can be
522 done by two methods: \fBpackage.mask\fR and \fBKEYWORDS\fR.  Read below
523 to find out how to unmask in either case.  Also note that if you give 
524 \fBemerge\fR an ebuild, then all forms of masking will be ignored and
525 \fBemerge\fR will attempt to emerge the package.
526 .TP
527 .BR package.mask
528 The \fBpackage.mask\fR file primarily blocks the use of packages that cause
529 problems or are known to have issues on different systems.  It resides in
530 \fI/usr/portage/profiles\fR.
531 .TP
532 .BR KEYWORDS
533 The \fBKEYWORDS\fR variable in an \fBebuild\fR file is also used for masking 
534 a package still in testing.  There are architecture\-specific keywords for 
535 each package that let \fBportage\fR know which systems are compatible with 
536 the package.  Packages which compile on an architecture, but have not been 
537 proven to be "stable", are masked with a tilde (\fB~\fR) in front of the 
538 architecture name.  \fBemerge\fR examines the \fBACCEPT_KEYWORDS\fR environment 
539 variable to allow or disallow the emerging of a package masked by 
540 \fBKEYWORDS\fR.  To inform \fBemerge\fR that it should build these 'testing' 
541 versions of packages, you should update your 
542 \fI/etc/portage/package.keywords\fR file to list the packages you want the 
543 \'testing\' version.  See \fBportage\fR(5) for more information.
544 .SH "REPORTING BUGS"
545 Please report any bugs you encounter through our website:
546 .LP
547 \fBhttp://bugs.gentoo.org/\fR
548 .LP
549 Please include the output of \fBemerge \-\-info\fR when you submit your
550 bug report.
551 .SH "AUTHORS"
552 .nf
553 Daniel Robbins <drobbins@gentoo.org>
554 Geert Bevin <gbevin@gentoo.org>
555 Achim Gottinger <achim@gentoo.org>
556 Nicholas Jones <carpaski@gentoo.org>
557 Phil Bordelon <phil@thenexusproject.org>
558 Mike Frysinger <vapier@gentoo.org>
559 Marius Mauch <genone@gentoo.org>
560 .fi
561 .SH "FILES"
562 Here is a common list of files you will probably be interested in.  For a 
563 complete listing, please refer to the \fBportage\fR(5) man page.
564 .TP
565 .B /var/lib/portage/world
566 Contains a list of all user\-specified packages.  You can safely edit
567 this file, adding packages that you want to be considered in \fBworld\fR
568 set updates and removing those that you do not want to be considered.
569 .TP
570 .B /etc/make.conf
571 Contains variables for the build process, overriding those in
572 \fBmake.globals\fR.  \fBYou should edit this file instead of the ones
573 listed below\fR.
574 .TP
575 .B /etc/dispatch\-conf.conf
576 Contains settings to handle automatic updates/backups of configuration 
577 files.
578 .TP
579 .B /etc/make.profile/make.defaults
580 Contains profile\-specific variables for the build process.  \fBDo not
581 edit this file\fR.
582 .TP
583 .B /etc/make.profile/use.defaults
584 Contains a list of packages which, if installed, cause the respective USE 
585 flag to be enabled by default.  \fBDo not edit this file\fR.
586 .TP
587 .B /usr/portage/profiles/use.desc
588 Contains the master list of USE flags with descriptions of their
589 functions.  \fBDo not edit this file\fR.
590 .TP
591 .B /etc/make.profile/virtuals
592 Contains a list of default packages used to resolve virtual dependencies.
593 \fBDo not edit this file\fR.
594 .TP
595 .B /etc/make.profile/packages
596 Contains a list of packages used for the base system.  The \fBsystem\fR
597 and \fBworld\fR sets consult this file.  \fBDo not edit this file\fR.
598 .TP
599 .B /etc/make.globals
600 Contains the default variables for the build process.  \fBDo not edit
601 this file\fR.
602 .SH "SEE ALSO"
603 .BR "emerge \-\-help",
604 .BR ebuild (1),
605 .BR ebuild (5),
606 .BR make.conf (5),
607 .BR portage (5)
608 .LP
609 A number of helper applications reside in \fI/usr/lib/portage/bin\fR.
610 .LP
611 The \fBapp\-portage/gentoolkit\fR package contains useful scripts such as 
612 \fBequery\fR (a package query tool).