Bug #276866 - --binpkg-respect-use < y | n >
[portage.git] / man / emerge.1
1 .TH "EMERGE" "1" "Aug 2008" "Portage 2.2" "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 one of four main ways: an \fIebuild\fR,
32 a \fItbz2file\fR, a \fIset\fR, or an \fIatom\fR.
33 .LP
34 .TP
35 .BR ebuild
36 An \fIebuild\fR must be, at a minimum, a valid Portage
37 package directory name without a version or category, such as
38 \fBportage\fR or \fBpython\fR.
39 Both categories and version numbers may be used in addition, such
40 as \fBsys\-apps/portage\fR or \fB=python\-2.2.1\-r2\fR.
41 \fBemerge\fR
42 ignores a trailing slash so that filename completion can be used.
43 The \fIebuild\fR may also be an actual filename, such as
44 \fB/usr/portage/app\-admin/python/python\-2.2.1\-r2.ebuild\fR.
45 \fBWARNING:\fR The implementation of \fBemerge /path/to/ebuild\fR is broken and
46 so this syntax shouldn't be used.
47 .TP
48 .BR tbz2file
49 A \fItbz2file\fR must be a valid .tbz2 created with \fBebuild
50 <package>\-<version>.ebuild package\fR or \fBemerge \-\-buildpkg 
51 [category/]<package>\fR or \fBquickpkg /var/db/pkg/<category>/<package>\fR.
52 .TP
53 .BR file
54 A \fIfile\fR must be a file or directory that has been installed by one or
55 more packages. For directories that are owned by multiple packages, all
56 owning packages to be selected. See the portageq(1) owners command if you
57 would like to query the owners of one or more files or directories.
58 .TP
59 .BR set
60 A \fIset\fR is a convenient shorthand for a large group of
61 packages.  Two sets are currently always available: \fBsystem\fR
62 and \fBworld\fR.  \fBsystem\fR refers to a set of packages
63 deemed necessary for your system to run properly. \fBworld\fR
64 contains all the packages listed in \fB/var/lib/portage/world\fR.  [See
65 \fBFILES\fR below for more information.] Other sets can exist depending
66 on the current configuration. The default set configuration is located
67 in \fB/usr/share/portage/config/sets.conf\fR. Note that a \fIset\fR
68 is generally used in conjunction with \fB\-\-update\fR. When used as 
69 arguments to \fBemerge\fR sets have to be prefixed with \fB@\fR to be
70 recognized. Use the \fB\-\-list\-sets\fR action to display a list of
71 available package sets.
72 .TP
73 .BR atom
74 An \fIatom\fR describes bounds on a package that you wish to install.  
75 \fISee portage(5) for the details on atom syntax.\fR  For example, 
76 \fB>=dev\-lang/python\-2.2.1\-r2\fR matches the latest available version of 
77 Python greater than or equal to 2.2.1\-r2.  Similarly, 
78 \fB<dev\-lang/python\-2.0\fR matches the latest available version of Python 
79 before 2.0.  Note that in many shells you will need to escape characters such 
80 as '<' and '='; use single\- or double\-quotes around the \fIatom\fR 
81 to get around escaping problems.
82 .SH "ACTIONS"
83 .TP
84 .BR "No action"
85 If no action is specified, the action is to merge in the specified
86 packages, satisfying any dependencies that they may have.  The
87 arguments can be \fIebuilds\fR, \fItbz2s\fR, \fIsets\fR, or
88 \fIatoms\fR.  \fBNote that you need to use the \-\-usepkg 
89 option if you want to install a tbz2\fR.  The packages are added
90 to the \fBworld\fR file at the end, so that they are considered for
91 later updating.
92 .TP
93 .BR "\-\-clean " (\fB\-c\fR)
94 Cleans up the system by examining the installed packages and removing older
95 packages.  This is accomplished by looking at each installed package and separating
96 the installed versions by \fBslot\fR.  Clean will \fBremove all but the most recently
97 installed version in each \fbslot\fR.  Clean should not remove unslotted packages.
98 Note: Most recently installed means most \fBrecent\fR, not highest version.
99 .TP
100 .BR "\-\-config "
101 Run package specific actions needed to be executed after the emerge process 
102 has completed.  This usually entails configuration file setup or other similar 
103 setups that the user may wish to run.
104 .TP
105 .BR \-\-depclean
106 Cleans the system by removing packages that are not associated
107 with explicitly merged packages. Depclean works by creating the
108 full dependency tree from the @system and @world sets,
109 then comparing it to installed packages. Packages installed, but
110 not part of the dependency tree, will be uninstalled by depclean.
111 See \fB\-\-with\-bdeps\fR for behavior with respect to build time dependencies
112 that are not strictly required. Packages that are part of the world set will
113 always be kept. They can be manually added to this set with \fIemerge
114 \-\-noreplace <atom>\fR. As a safety measure, depclean will not remove any
115 packages unless *all* required dependencies have been resolved. As a
116 consequence, it is often necessary to run \fIemerge \-\-update \-\-newuse
117 \-\-deep @system @world\fR prior to depclean. 
118
119 \fBWARNING:\fR
120 Inexperienced users are advised to use \fB\-\-pretend\fR with this
121 option in order to see a preview of which packages
122 will be uninstalled. Always study the list of packages
123 to be cleaned for any obvious mistakes. Note that packages listed in
124 package.provided (see \fBportage\fR(5)) may be removed by
125 depclean, even if they are part of the world set.
126
127 Depclean serves as a dependency aware
128 version of \fB\-\-unmerge\fR. When given one or more atoms, it will
129 unmerge matched packages that have no reverse dependencies. Use
130 \fB\-\-depclean\fR together with \fB\-\-verbose\fR to show reverse
131 dependencies.
132 .TP
133 .BR "\-\-deselect[=n]"
134 Remove atoms from the world file. This action is implied
135 by uninstall actions, including \fB-\-depclean\fR,
136 \fB-\-prune\fR and \fB-\-unmerge\fR. Use \fB-\-deselect=n\fR
137 in order to prevent uninstall actions from removing
138 atoms from the world file.
139 .TP
140 .BR "\-\-help " (\fB\-h\fR)
141 Displays help information for emerge.  Adding one of the additional
142 arguments listed above will give you more specific help information
143 on that subject.  The internal \fBemerge\fR help documentation is
144 updated more frequently than this man page; check it out if you
145 are having problems that this man page does not help resolve.
146 .TP
147 .BR \-\-info
148 Produces a list of information to include in bug reports which aids the 
149 developers when fixing the reported problem.  \fBPlease include this 
150 information when submitting a bug report.\fR  Expanded output can be obtained 
151 with the \fI\-\-verbose\fR option.
152 .TP
153 .BR \-\-list\-sets
154 Displays a list of available package sets.
155 .TP
156 .BR \-\-metadata
157 Transfers metadata cache from ${PORTDIR}/metadata/cache/ to
158 /var/cache/edb/dep/ as is normally done on the
159 tail end of an rsync update using \fBemerge \-\-sync\fR.  This process
160 populates the cache database that portage uses for pre-parsed lookups of
161 package data.  It does not populate cache for the overlays listed in
162 PORTDIR_OVERLAY.  In order to generate cache for overlays, use \fB\-\-regen\fR.
163 In versions of portage >=2.1.5 the \-\-metadata action is totally unnecessary
164 unless the user has enabled FEATURES="metadata-transfer" in \fBmake.conf\fR(5).
165 .TP
166 .BR "\-\-prune " (\fB\-P\fR)
167 \fBWARNING: This action can remove important packages!\fR  Removes all but the
168 highest installed version of a package from your system. Use \fB\-\-prune\fR
169 together with \fB\-\-verbose\fR to show reverse dependencies or with
170 \fB\-\-nodeps\fR to ignore all dependencies.
171 .TP
172 .BR \-\-regen
173 Causes portage to check and update the dependency cache of all ebuilds in the 
174 portage tree.  The cache is used to speed up searches and the building of 
175 dependency trees.  This command is not recommended for rsync users as rsync 
176 updates the cache using server\-side caches.  If you do not know the 
177 differences between a 'rsync user' and some other user, then you are a 'rsync 
178 user' :).  Rsync users should simply run \fBemerge \-\-sync\fR to regenerate 
179 the cache.  After a portage update, rsync users may find it convenient to run 
180 \fBemerge \-\-metadata\fR to rebuild the cache as portage does at the end of 
181 a sync operation. In order to specify parallel \fB\-\-regen\fR behavior, use
182 the \fB\-\-jobs\fR and \fB\-\-load\-average\fR options. If you would like to
183 generate and distribute cache for use by others, use \fBegencache\fR(1).
184 .TP
185 .BR "\-\-resume"
186 Resumes the most recent merge list that has been aborted due to an error.
187 Please note that this operation will only return an error on failure.  If there
188 is nothing for portage to do, then portage will exit with a message and a
189 success condition. A resume list will persist until it has been completed in
190 entirety or until another aborted merge list replaces it.  The resume history
191 is capable of storing two merge lists.  After one resume list completes, it is
192 possible to invoke \-\-resume once again in order to resume an older list.
193 .TP
194 .BR "\-\-search " (\fB\-s\fR)
195 Searches for matches of the supplied string in the portage tree.
196 By default emerge uses a case-insensitive simple search, but you can 
197 enable a regular expression search by prefixing the search string with %.
198 For example, \fBemerge \-\-search "%^kde"\fR searches for any package whose 
199 name starts with "kde"; \fBemerge \-\-search "%gcc$"\fR searches for any 
200 package that ends with "gcc"; \fBemerge \-\-search "office"\fR searches for 
201 any package that contains the word "office".  If you want to include the 
202 category into the search string, prepend an @: \fBemerge --search 
203 "%@^dev-java.*jdk"\fR. If you want to search the package descriptions as well, 
204 use the \fB\-\-searchdesc\fR action.
205 .TP
206 .BR "\-\-searchdesc " (\fB\-S\fR)
207 Matches the search string against the description field as well as
208 the package name.  \fBTake caution\fR as the descriptions are also
209 matched as regular expressions.
210 .TP
211 .BR \-\-sync
212 Initiates a portage tree update with one of the rsync.gentoo.org
213 mirrors.  \fBNote that any changes you have made to the portage
214 tree will be erased\fR.  Except for special circumstances, 
215 this uses \fBrsync\fR to do the update.  See \fBmake.conf\fR(5)'s 
216 description of PORTDIR_OVERLAY for a method to avoid deletions.
217 .TP
218 .BR "\-\-unmerge " (\fB\-C\fR)
219 \fBWARNING: This action can remove important packages!\fR Removes
220 all matching packages.  This does no checking of dependencies, so
221 it may remove packages necessary for the proper operation of your
222 system.  Its arguments can be \fIatoms\fR or
223 \fIebuilds\fR. For a dependency aware version of \fB\-\-unmerge\fR,
224 use \fB\-\-depclean\fR or \fB\-\-prune\fR.
225 .TP
226 .BR "\-\-update " (\fB\-u\fR)
227 Updates packages to the best version available, which may not always be the 
228 highest version number due to masking for testing and development.  This will 
229 also update direct dependencies which may not be what you want.  Package atoms
230 specified on the command line are greedy, meaning that unspecific atoms may
231 match multiple installed versions of slotted packages.
232 .TP
233 .BR "\-\-version " (\fB\-V\fR)
234 Displays the version number of \fBemerge\fR.
235 .SH "OPTIONS"
236 .TP
237 .BR "\-\-alphabetical "
238 When displaying USE and other flag output, combines the enabled and
239 disabled lists into one list and sorts the whole list alphabetically.
240 .TP
241 .BR "\-\-ask " (\fB\-a\fR)
242 Before performing the action, display what will take place (server info for
243 \fB\-\-sync\fR, \fB\-\-pretend\fR output for merge, and so forth), then ask
244 whether to proceed with the action or abort.  Using \fB\-\-ask\fR is more
245 efficient than using \fB\-\-pretend\fR and then executing the same command
246 without \fB\-\-pretend\fR, as dependencies will only need to be calculated once.
247 \fBWARNING: If the "Enter" key is pressed at the prompt (with no other input),
248 it is interpreted as acceptance of the first choice.  Note that the input
249 buffer is not cleared prior to the prompt, so an accidental press of the
250 "Enter" key at any time prior to the prompt will be interpreted as a choice!\fR
251 .TP
252 .BR "\-\-binpkg\-respect\-use < y | n >"
253 Tells emerge to ignore binary packages if their use flags
254 don't match the current configuration. (default: \'n\')
255 .TP
256 .BR "\-\-buildpkg " (\fB\-b\fR)
257 Tells emerge to build binary packages for all ebuilds processed in
258 addition to actually merging the packages.  Useful for maintainers
259 or if you administrate multiple Gentoo Linux systems (build once,
260 emerge tbz2s everywhere) as well as disaster recovery. The package
261 will be created in the \fBPKGDIR\fR directory (see \fBmake.conf\fR(5)).
262 An alternative for already\-merged
263 packages is to use \fBquickpkg\fR(1) which creates a tbz2 from the
264 live filesystem.
265 .TP
266 .BR "\-\-buildpkgonly " (\fB\-B\fR)
267 Creates binary packages for all ebuilds processed without actually
268 merging the packages.  This comes with the caveat that all build-time 
269 dependencies must already be emerged on the system.
270 .TP
271 .BR "\-\-changelog " (\fB\-l\fR)
272 Use this in conjunction with the \fB\-\-pretend\fR option.  This will
273 show the ChangeLog entries for all the packages that will be upgraded.
274 .TP
275 .BR "\-\-color < y | n >"
276 Enable or disable color output.  This option will override \fINOCOLOR\fR
277 (see \fBmake.conf\fR(5)) and may also be used to force color output when stdout
278 is not a tty (by default, color is disabled unless stdout is a tty).
279 .TP
280 .BR "\-\-columns"
281 Used alongside \fB\-\-pretend\fR to cause the package name, new version, 
282 and old version to be displayed in an aligned format for easy cut\-n\-paste.
283 .TP
284 .BR "\-\-complete\-graph"
285 This causes \fBemerge\fR to consider the deep dependencies of all
286 packages from the system and world sets. With this option enabled,
287 \fBemerge\fR will bail out if it determines that the given operation will
288 break any dependencies of the packages that have been added to the
289 graph. Like the \fB\-\-deep\fR option, the \fB\-\-complete\-graph\fR
290 option will significantly increase the time taken for dependency
291 calculations. Note that, unlike the \fB\-\-deep\fR option, the
292 \fB\-\-complete\-graph\fR option does not cause any more packages to
293 be updated than would have otherwise been updated with the option disabled.
294 .TP
295 .BR \-\-config\-root=DIR
296 Set the \fBPORTAGE_CONFIGROOT\fR environment variable.
297 .TP
298 .BR "\-\-debug " (\fB\-d\fR)
299 Tells emerge to run the emerge command in \fB\-\-debug\fR mode.  In this
300 mode the bash build environment will run with the \-x option, causing 
301 it to output verbose debugging information to stdout.  This also enables
302 a plethora of other output (mostly dependency resolution messages).
303 .TP
304 .BR "\-\-deep " (\fB\-D\fR)
305 This flag forces
306 \fBemerge\fR to consider the entire dependency tree of packages,
307 instead of checking only the immediate dependencies of the packages.
308 As an example, this catches updates in libraries that are not directly
309 listed in the dependencies of a package.  Also see \fB\-\-with\-bdeps\fR for
310 behavior with respect to build time dependencies that are not strictly
311 required.
312 .TP
313 .BR "\-\-emptytree " (\fB\-e\fR)
314 Reinstalls all world packages and their dependencies to the current USE 
315 specifications while differing from the installed set of packages as 
316 little as possible.  You should run with \fB\-\-pretend\fR first to make 
317 sure the result is what you expect.
318 .TP
319 .BR "\-\-fetchonly " (\fB\-f\fR)
320 Instead of doing any package building, just perform fetches for all
321 packages (fetch things from SRC_URI based upon USE setting).
322 .TP
323 .BR "\-\-fetch\-all\-uri " (\fB\-F\fR)
324 Instead of doing any package building, just perform fetches for all
325 packages (fetch everything in SRC_URI regardless of USE setting).
326 .TP
327 .BR "\-\-getbinpkg " (\fB\-g\fR)
328 Using the server and location defined in \fIPORTAGE_BINHOST\fR (see 
329 \fBmake.conf\fR(5)), portage will download the information from each binary 
330 package found and it will use that information to help build the dependency 
331 list.  This option implies \fB\-k\fR.  (Use \fB\-gK\fR for binary\-only 
332 merging.)
333 .TP
334 .BR "\-\-getbinpkgonly " (\fB\-G\fR)
335 This option is identical to \fB\-g\fR, as above, except binaries from the
336 remote server are preferred over local packages if they are not identical.
337 .TP
338 .BR "\-\-ignore-default-opts"
339 Causes \fIEMERGE_DEFAULT_OPTS\fR (see \fBmake.conf\fR(5)) to be ignored.
340 .TP
341 .BR "-j [JOBS], \-\-jobs[=JOBS]"
342 Specifies the number of packages to build simultaneously. If this option is
343 given without an argument, emerge will not limit the number of jobs that can
344 run simultaneously. Also see the related \fB\-\-load\-average\fR option.
345 .TP
346 .BR "\-\-keep\-going"
347 Continue as much as possible after an error. When an error occurs,
348 dependencies are recalculated for remaining packages and any with
349 unsatisfied dependencies are automatically dropped. Also see
350 the related \fB\-\-skipfirst\fR option.
351 .TP
352 .BR \-\-load\-average=LOAD
353 Specifies that no new builds should be started if there are other builds
354 running and the load average is at least LOAD (a floating-point number).
355 This option is recommended for use in combination with \fB\-\-jobs\fR in
356 order to avoid excess load. See \fBmake\fR(1) for information about
357 analogous options that should be configured via \fBMAKEOPTS\fR in
358 \fBmake.conf\fR(5).
359 .TP
360 .BR "\-\-newuse " (\fB\-N\fR)
361 Tells emerge to include installed packages where USE flags have changed since 
362 compilation.  USE flag changes include:
363
364 A USE flag was added to a package.
365 A USE flag was removed from a package.
366 A USE flag was turned on for a package.
367 A USE flag was turned off for a package.
368
369 USE flags may be toggled by your profile as well as your USE and package.use
370 settings.
371 .TP
372 .BR "\-\-noconfmem"
373 Causes portage to disregard merge records indicating that a config file
374 inside of a \fBCONFIG_PROTECT\fR directory has been merged already.  Portage
375 will normally merge those files only once to prevent the user from
376 dealing with the same config multiple times.  This flag will cause the
377 file to always be merged.
378 .TP
379 .BR "\-\-nodeps " (\fB\-O\fR)
380 Merges specified packages without merging any dependencies.  Note that
381 the build may fail if the dependencies aren't satisfied.
382 .TP
383 .BR "\-\-noreplace " (\fB\-n\fR)
384 Skips the packages specified on the command\-line that have already
385 been installed.  Without this option, any packages, ebuilds, or deps
386 you specify on the command\-line \fBwill\fR cause Portage to remerge
387 the package, even if it is already installed.  Note that Portage will
388 not remerge dependencies by default. Also note that this option takes
389 precedence over options such as \fB\-\-newuse\fR, preventing a package
390 from being reinstalled even though the corresponding USE flag settings
391 may have changed.
392 .TP
393 .BR "\-\-nospinner"
394 Disables the spinner for the session.  The spinner is active when the
395 terminal device is determined to be a TTY.  This flag disables it regardless.
396 .TP
397 .BR "\-\-oneshot " (\fB\-1\fR)
398 Emerge as normal, but do not add the packages to the world file
399 for later updating.
400 .TP
401 .BR "\-\-onlydeps " (\fB\-o\fR)
402 Only merge (or pretend to merge) the dependencies of the packages
403 specified, not the packages themselves.
404 .TP
405 .BR "\-\-pretend " (\fB\-p\fR)
406 Instead of actually performing the merge, simply display what *would*
407 have been installed if \fB\-\-pretend\fR weren't used.  Using \fB\-\-pretend\fR
408 is strongly recommended before installing an unfamiliar package.  In
409 the printout:
410
411 .TS
412 lI l.
413 N       new (not yet installed)
414 S       new SLOT installation (side-by-side versions) 
415 U       updating (to another version)
416 D       downgrading (best version seems lower)
417 R       replacing (remerging same version))
418 F       fetch restricted (must be manually downloaded)
419 f       fetch restricted (already downloaded)
420 I       interactive (requires user input)
421 B       blocked by another package (unresolved conflict)
422 b       blocked by another package (automatically resolved conflict)
423 .TE
424 .TP
425 .BR "\-\-quiet " (\fB\-q\fR)
426 Results may vary, but the general outcome is a reduced or condensed
427 output from portage's displays.
428 .TP
429 .BR "\-\-reinstall changed\-use"
430 Tells emerge to include installed packages where USE flags have
431 changed since installation.  Unlike \fB\-\-newuse\fR, this option does
432 not trigger reinstallation when flags that the user has not
433 enabled are added or removed.
434 .TP
435 .BR \-\-root=DIR
436 Set the \fBROOT\fR environment variable.
437 .TP
438 .BR "\-\-root\-deps[=rdeps]"
439 If no argument is given then build\-time dependencies of packages for
440 \fBROOT\fR are installed to
441 \fBROOT\fR instead of /. If the \fBrdeps\fR argument is given then discard
442 all build\-time dependencies of packages for \fBROOT\fR. This option is
443 only meaningful when used together with \fBROOT\fR and it should not
444 be enabled under normal circumstances. For currently supported
445 \fBEAPI\fR values, the build-time dependencies are specified in the
446 \fBDEPEND\fR variable. However, behavior may change for new
447 \fBEAPI\fRs when related extensions are added in the future.
448 .TP
449 .BR "\-\-skipfirst"
450 This option is only valid when used with \fB\-\-resume\fR.  It removes the 
451 first package in the resume list. Dependencies are recalculated for
452 remaining packages and any that have unsatisfied dependencies or are
453 masked will be automatically dropped. Also see the related
454 \fB\-\-keep\-going\fR option.
455 .TP
456 .BR "\-\-tree " (\fB\-t\fR)
457 Shows the dependency tree for the given target by indenting dependencies.
458 This is only really useful in combination with \fB\-\-emptytree\fR or 
459 \fB\-\-update\fR and \fB\-\-deep\fR.
460 .TP
461 .BR "\-\-usepkg " (\fB\-k\fR) 
462 Tells emerge to use binary packages (from $PKGDIR) if they are available, thus 
463 possibly avoiding some time\-consuming compiles.  This option is useful for CD 
464 installs; you can export PKGDIR=/mnt/cdrom/packages and then use this option to 
465 have emerge "pull" binary packages from the CD in order to satisfy dependencies.
466 .TP
467 .BR "\-\-usepkgonly " (\fB\-K\fR)
468 Tells emerge to only use binary packages (from $PKGDIR).  All the binary 
469 packages must be available at the time of dependency calculation or emerge 
470 will simply abort.  Portage does not use $PORTDIR when calculating dependency 
471 information so all masking information is ignored.
472 .TP
473 .BR "\-\-verbose " (\fB\-v\fR)
474 Tell emerge to run in verbose mode.  Currently this flag causes emerge to print 
475 out GNU info errors, if any, and to show the USE flags that will be used for 
476 each package when pretending. The following symbols are affixed to USE flags
477 in order to indicate their status:
478
479 .TS
480 l l l
481 ___
482 l l l.
483 Symbol  Location        Meaning
484
485 -       prefix  not enabled (either disabled or removed)
486 *       suffix  transition to or from the enabled state
487 %       suffix  newly added or removed
488 ()      circumfix       forced, masked, or removed
489 .TE
490 .TP
491 .BR "\-\-with\-bdeps < y | n >"
492 In dependency calculations, pull in build time dependencies
493 that are not strictly required. This defaults to \'n\' for
494 installation actions, meaning they will not be installed, and
495 \'y\' for the \fB\-\-depclean\fR action, meaning they will not be removed.
496 This setting can be added to
497 \fBEMERGE_DEFAULT_OPTS\fR (see make.conf(5)) and later overridden via the
498 command line.
499 .SH "ENVIRONMENT OPTIONS"
500 .TP
501 \fBROOT\fR = \fI[path]\fR
502 Use \fBROOT\fR to specify the target root filesystem to be used for
503 merging packages or ebuilds. This variable can be set via the \fB\-\-root\fR
504 option or in \fBmake.conf\fR(5) (the command line overrides other settings).
505 .br
506 Defaults to /.
507 .TP
508 \fBPORTAGE_CONFIGROOT\fR = \fI[path]\fR
509 Use \fBPORTAGE_CONFIGROOT\fR to specify the location for various portage 
510 configuration files
511 (see \fBFILES\fR for a detailed list of configuration files).  This variable
512 can be set via the \fB\-\-config\-root\fR option.
513 .br
514 Defaults to /.
515 .SH "OUTPUT"
516 When utilizing \fBemerge\fR with the \fB\-\-pretend\fR and \fB\-\-verbose\fR 
517 flags, the output may be a little hard to understand at first.  This section
518 explains the abbreviations.
519 .TP
520 .B [blocks B     ] app\-text/dos2unix (from pkg app\-text/hd2u\-0.8.0)
521 Dos2unix is Blocking hd2u from being emerged.  Blockers are defined when
522 two packages will clobber each others files, or otherwise cause some form
523 of breakage in your system.  However, blockers usually do not need to be
524 simultaneously emerged because they usually provide the same functionality.
525 .TP
526 .B [ebuild  N    ] app\-games/qstat\-25c
527 Qstat is New to your system, and will be emerged for the first time.
528 .TP
529 .B [ebuild  NS   ] dev-libs/glib-2.4.7
530 You already have a version of glib installed, but a 'new' version in 
531 a different SLOT is available.
532 .TP
533 .B [ebuild   R   ] sys\-apps/sed\-4.0.5
534 Sed 4.0.5 has already been emerged, but if you run the command, then 
535 portage will Re\-emerge the specified package (sed in this case).
536 .TP
537 .B [ebuild    F  ] media\-video/realplayer\-8\-r6
538 The realplayer package requires that you Fetch the sources manually.  
539 When you attempt to emerge the package, if the sources are not found, 
540 then portage will halt and you will be provided with instructions on how 
541 to download the required files.
542 .TP
543 .B [ebuild    f  ] media\-video/realplayer\-8\-r6
544 The realplayer package's files are already downloaded.
545 .TP
546 .B [ebuild     U ] net\-fs/samba\-2.2.8_pre1 [2.2.7a]
547 Samba 2.2.7a has already been emerged and can be Updated to version 
548 2.2.8_pre1.
549 .TP
550 .B [ebuild     UD] media\-libs/libgd\-1.8.4 [2.0.11]
551 Libgd 2.0.11 is already emerged, but if you run the command, then 
552 portage will Downgrade to version 1.8.4 for you.
553 .br 
554 This may occur if a newer version of a package has been masked because it is
555 broken or it creates a security risk on your system and a fix has not been
556 released yet.
557 .br 
558 Another reason this may occur is if a package you are trying to emerge requires
559 an older version of a package in order to emerge successfully.  In this case,
560 libgd 2.x is incompatible with libgd 1.x.  This means that packages that were
561 created with libgd 1.x will not compile with 2.x and must downgrade libgd first
562 before they can emerge.
563 .TP
564 .B [ebuild     U ] sys\-devel/distcc\-2.16 [2.13\-r1] USE="ipv6* \-gtk \-qt%"
565 Here we see that the make.conf variable \fBUSE\fR affects how this package is
566 built.  In this example, ipv6 optional support is enabled and both gtk and qt
567 support are disabled.  The asterisk following ipv6 indicates that ipv6 support
568 was disabled the last time this packages was installed.  The percent sign
569 following qt indicates that the qt option has been added to the package since
570 it was last installed.  For information about all \fBUSE\fR symbols, see the
571 \fB\-\-verbose\fR option documentation above.
572 .br
573 \fB*Note:\fR Flags that haven't changed since the last install are only
574 displayed when you use the \fB\-\-pretend\fR and \fB\-\-verbose\fR options.
575 Using the \fB\-\-quiet\fR option will prevent all information from being
576 displayed.
577 .SH "NOTES"
578 You should almost always precede any package install or update attempt with a 
579 \fB\-\-pretend\fR install or update.  This lets you see how much will be 
580 done, and shows you any blocking packages that you will have to rectify.  
581 This goes doubly so for the \fBsystem\fR and \fBworld\fR sets, which can 
582 update a large number of packages if the portage tree has been particularly 
583 active.
584 .LP
585 You also want to typically use \fB\-\-update\fR, which ignores packages that 
586 are already fully updated but updates those that are not.
587 .LP
588 When you install a package with uninstalled dependencies and do
589 not explicitly state those dependencies in the list of parameters,
590 they will not be added to the world file.  If you want them to be
591 detected for world updates, make sure to explicitly list them as
592 parameters to \fBemerge\fR.
593 .LP
594 \fBUSE variables\fR may be specified on the command line to
595 override those specified in the default locations, letting you
596 avoid using some dependencies you may not want to have.  \fBUSE
597 flags specified on the command line are NOT remembered\fR.  For
598 example, \fBenv USE="\-X \-gnome" emerge mc\fR will emerge mc with
599 those USE settings (on Bourne-compatible shells you may omit the \fBenv\fR
600 part).  If you want those USE settings to be more 
601 permanent, you can put them in /etc/portage/package.use instead.
602 .LP
603 If \fBemerge \-\-update system\fR or \fBemerge \-\-update world\fR
604 fails with an error message, it may be that an ebuild uses some
605 newer feature not present in this version of \fBemerge\fR.  You
606 can use \fBemerge \-\-update portage\fR to upgrade to the lastest
607 version, which should support any necessary new features.
608 .SH "MASKED PACKAGES"
609 \fINOTE: Please use caution when using development packages.  Problems
610 and bugs resulting from misusing masked packages drains Gentoo
611 developer time.  Please be sure you are capable of handling any problems
612 that may ensue.\fR
613 .LP
614 Masks in \fBportage\fR have many uses: they allow a
615 testing period where the packages can be used in live machines; they
616 prevent the use of a package when it will fail; and they mask existing
617 packages that are broken or could pose a security risk.  Read below
618 to find out how to unmask in various cases.  Also note that if you give 
619 \fBemerge\fR an ebuild, then all forms of masking will be ignored and
620 \fBemerge\fR will attempt to emerge the package.
621 .TP
622 .BR package.mask
623 The \fBpackage.mask\fR file primarily blocks the use of packages that cause
624 problems or are known to have issues on different systems.  It resides in
625 \fI/usr/portage/profiles\fR.
626 .TP
627 .BR CHOST
628 Use the \fBACCEPT_CHOSTS\fR variable in \fBmake.conf\fR(5) to control
629 \fBCHOST\fR acceptance.
630 .TP
631 .BR EAPI
632 The \fBEAPI\fR variable in an \fBebuild\fR(5) file is used to mask packages
633 that are not supported by the current version of portage. Packages masked by
634 \fBEAPI\fR can only be installed after portage has been upgraded.
635 .TP
636 .BR KEYWORDS
637 The \fBKEYWORDS\fR variable in an \fBebuild\fR file is also used for masking 
638 a package still in testing.  There are architecture\-specific keywords for 
639 each package that let \fBportage\fR know which systems are compatible with 
640 the package.  Packages which compile on an architecture, but have not been 
641 proven to be "stable", are masked with a tilde (\fB~\fR) in front of the 
642 architecture name.  \fBemerge\fR examines the \fBACCEPT_KEYWORDS\fR environment 
643 variable to allow or disallow the emerging of a package masked by 
644 \fBKEYWORDS\fR.  To inform \fBemerge\fR that it should build these 'testing' 
645 versions of packages, you should update your 
646 \fI/etc/portage/package.keywords\fR file to list the packages you want the 
647 \'testing\' version.  See \fBportage\fR(5) for more information.
648 .SH "CONFIGURATION FILES"
649 Portage has a special feature called "config file protection". The purpose of
650 this feature is to prevent new package installs from clobbering existing
651 configuration files. By default, config file protection is turned on for /etc
652 and the KDE configuration dirs; more may be added in the future.
653 .LP
654 When Portage installs a file into a protected directory tree like /etc, any
655 existing files will not be overwritten. If a file of the same name already
656 exists, Portage will change the name of the to\-be\-installed file from 'foo' to
657 \'._cfg0000_foo\'. If \'._cfg0000_foo\' already exists, this name becomes
658 \'._cfg0001_foo\', etc. In this way, existing files are not overwritten,
659 allowing the administrator to manually merge the new config files and avoid any
660 unexpected changes.
661 .LP
662 In addition to protecting overwritten files, Portage will not delete any files
663 from a protected directory when a package is unmerged. While this may be a
664 little bit untidy, it does prevent potentially valuable config files from being
665 deleted, which is of paramount importance.
666 .LP
667 Protected directories are set using the \fICONFIG_PROTECT\fR variable, normally
668 defined in /etc/make.globals. Directory exceptions to the CONFIG_PROTECTed
669 directories can be specified using the \fICONFIG_PROTECT_MASK\fR variable. To find
670 files that need to be updated in /etc, type \fBfind /etc \-iname \'._cfg????_*\'\fR.
671 .LP
672 You can disable this feature by setting \fICONFIG_PROTECT="\-*"\fR in /etc/make.conf.
673 Then, Portage will mercilessly auto\-update your config files. Alternatively,
674 you can leave Config File Protection on but tell Portage that it can overwrite
675 files in certain specific /etc subdirectories. For example, if you wanted
676 Portage to automatically update your rc scripts and your wget configuration,
677 but didn't want any other changes made without your explicit approval, you'd
678 add this to /etc/make.conf:
679 .LP
680 .I CONFIG_PROTECT_MASK="/etc/wget /etc/rc.d"
681 .LP
682 Tools such as dispatch\-conf, cfg\-update, and etc\-update are also available to
683 aid in the merging of these files. They provide interactive merging and can
684 auto\-merge trivial changes.
685 .SH "REPORTING BUGS"
686 Please report any bugs you encounter through our website:
687 .LP
688 \fBhttp://bugs.gentoo.org/\fR
689 .LP
690 Please include the output of \fBemerge \-\-info\fR when you submit your
691 bug report.
692 .SH "AUTHORS"
693 .nf
694 Daniel Robbins <drobbins@gentoo.org>
695 Geert Bevin <gbevin@gentoo.org>
696 Achim Gottinger <achim@gentoo.org>
697 Nicholas Jones <carpaski@gentoo.org>
698 Phil Bordelon <phil@thenexusproject.org>
699 Mike Frysinger <vapier@gentoo.org>
700 Marius Mauch <genone@gentoo.org>
701 Jason Stubbs <jstubbs@gentoo.org>
702 Brian Harring <ferringb@gmail.com>
703 Zac Medico <zmedico@gentoo.org>
704 .fi
705 .SH "FILES"
706 Here is a common list of files you will probably be interested in.  For a 
707 complete listing, please refer to the \fBportage\fR(5) man page.
708 .TP
709 .B /usr/share/portage/config/sets.conf
710 Contains the default set configuration.
711 .TP
712 .B /var/lib/portage/world
713 Contains a list of all user\-specified packages.  You can safely edit
714 this file, adding packages that you want to be considered in \fBworld\fR
715 set updates and removing those that you do not want to be considered.
716 .TP
717 .B /etc/make.conf
718 Contains variables for the build process, overriding those in
719 \fBmake.globals\fR.
720 .TP
721 .B /etc/portage/color.map
722 Contains variables customizing colors.
723 .TP
724 .B /etc/dispatch\-conf.conf
725 Contains settings to handle automatic updates/backups of configuration 
726 files.
727 .TP
728 .B /etc/make.profile/make.defaults
729 Contains profile\-specific variables for the build process.  \fBDo not
730 edit this file\fR.
731 .TP
732 .B /usr/portage/profiles/use.desc
733 Contains the master list of USE flags with descriptions of their
734 functions.  \fBDo not edit this file\fR.
735 .TP
736 .B /etc/make.profile/virtuals
737 Contains a list of default packages used to resolve virtual dependencies.
738 \fBDo not edit this file\fR.
739 .TP
740 .B /etc/make.profile/packages
741 Contains a list of packages used for the base system.  The \fBsystem\fR
742 and \fBworld\fR sets consult this file.  \fBDo not edit this file\fR.
743 .TP
744 .B /etc/make.globals
745 Contains the default variables for the build process.  \fBDo not edit
746 this file\fR.
747 .SH "SEE ALSO"
748 .BR "emerge \-\-help",
749 .BR quickpkg (1),
750 .BR ebuild (1),
751 .BR ebuild (5),
752 .BR make.conf (5),
753 .BR color.map (5),
754 .BR portage (5)
755 .LP
756 A number of helper applications reside in \fI/usr/lib/portage/bin\fR.
757 .LP
758 The \fBapp\-portage/gentoolkit\fR package contains useful scripts such as 
759 \fBequery\fR (a package query tool).