Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
View | Details | Raw Unified | Return to bug 18249 | Differences between
and this patch

Collapse All | Expand All

(-)man/emerge.1~ (-99 / +151 lines)
Lines 1-4 Link Here
1
.TH "EMERGE" "1" "Feb 2003" "Portage 2.0.47" "Portage"
1
.TH "EMERGE" "1" "Feb 2003" "Portage 2.0.48" "Portage"
2
.SH "NAME"
2
.SH "NAME"
3
emerge \- Command\-line interface to the Portage system
3
emerge \- Command\-line interface to the Portage system
4
.SH "SYNOPSIS"
4
.SH "SYNOPSIS"
Lines 7-16 Link Here
7
[\fIoptions\fR] [\fIaction\fR] [\fIebuild\fR | \fItbz2file\fR | \fIclass\fR | \fIdependency\fR] ...
7
[\fIoptions\fR] [\fIaction\fR] [\fIebuild\fR | \fItbz2file\fR | \fIclass\fR | \fIdependency\fR] ...
8
.TP
8
.TP
9
\fBemerge\fR
9
\fBemerge\fR
10
[\fIoptions\fR] [\fIaction\fR] \fBebuildfile\fR
10
\fBsync\fR | \fBinfo\fR
11
.TP
11
.TP
12
\fBemerge\fR
12
\fBemerge\fR
13
\fBsync\fR | \fBrsync\fR
13
\fI\-\-resume\fR [\-\-\fBpretend\fR | \-\-\fBskipfirst\fR]
14
.TP
14
.TP
15
\fBemerge\fR
15
\fBemerge\fR
16
\fI\-\-help \-h\fR [\fBsystem\fR | \fBconfig\fR | \fBsync\fR]
16
\fI\-\-help \-h\fR [\fBsystem\fR | \fBconfig\fR | \fBsync\fR]
Lines 78-106 Link Here
78
later updating.  
78
later updating.  
79
.TP
79
.TP
80
\fBclean\fR (\fB\-c\fR)
80
\fBclean\fR (\fB\-c\fR)
81
Cleans the system by removing packages that will not effect the
81
Cleans the system by removing outdated packages which will not
82
functionality of the system.  The arguments can be \fIebuilds\fR,
82
remove functionalities or prevent your system from working.
83
\fIclasses\fR, or \fIdependencies\fR.  For example, \fBemerge
83
The arguments can be \fIebuilds\fR, \fIclasses\fR, or
84
clean binutils\fR cleans out old versions of binutils;
84
\fIdependencies\fR.  For example, \fBemerge clean binutils\fR
85
\fBemerge clean net\-www/mozilla\-0.9.9\-r2\fR cleans out that
85
cleans out old versions of binutils;
86
specific version of Mozilla.  This is generally safe to use.
86
\fBemerge clean net\-www/mozilla\-0.9.9\-r2\fR cleans out
87
that specific version of Mozilla. This is generally safe to use.
87
\fBNote that\fR clean \fBdoes not remove unslotted packages.\fR
88
\fBNote that\fR clean \fBdoes not remove unslotted packages.\fR
88
.TP
89
.TP
89
\fBdepclean\fR
90
\fBdepclean\fR
90
Determines all packages installed on the system that have no
91
Cleans the system by removing packages that are not associated
91
explicit reason for being there.  \fBemerge\fR generates a list
92
with explicitly merged packages. Depclean works by creating the
92
of packages which it expects to be installed by checking the
93
full dependency tree from the system list and the world file,
93
\fBsystem\fR package list and the \fBworld\fR file.  It then
94
then comparing it to installed packages. Packages installed, but
94
compares that list to the list of packages which are actually
95
not associated with an explicit merge are listed as candidates
95
installed; the differences are listed as unnecessary packages
96
for unmerging. \fBWARNING: This can seriously affect your system by
96
and are suggested for unmerging. \fBWARNING: Removing some
97
removing packages that may have been linked against, but due to
97
packages may cause packages which link to the removed package
98
changes in USE flags may no longer be part of the dep tree. Use
98
to stop working and complain about missing libraries.\fR
99
caution when employing this feature.\fR
99
Re\-emerge the complaining package to fix this issue.
100
\fBNote that changes in USE flags can drastically affect the
101
output of depclean.\fR
102
.TP
100
.TP
103
\fBhelp\fR (\fB\-h\fR)
101
\fB\-\-help\fR (\fB\-h\fR)
104
Displays help information for emerge.  Adding one of the additional
102
Displays help information for emerge.  Adding one of the additional
105
arguments listed above will give you more specific help information
103
arguments listed above will give you more specific help information
106
on that subject.  The internal \fBemerge\fR help documentation is
104
on that subject.  The internal \fBemerge\fR help documentation is
Lines 108-147 Link Here
108
are having problems that this man page does not help resolve.
106
are having problems that this man page does not help resolve.
109
.TP
107
.TP
110
\fBinfo\fR
108
\fBinfo\fR
111
This is a list of information to include in bug reports which aids
109
Displays important portage variables that will be exported to
112
the developers with fixing any problems you may report. \fBPlease
110
ebuild.sh when performing merges. This information is useful
113
include this information when submitting a bug report.\fR Expanded
111
for bug reports and verification of settings. All settings in
114
output can be obtained with the \fI--verbose\fR option.
112
make.{conf,globals,defaults} and the environment show up if
113
run with the '\-\-verbose' flag.
115
.TP
114
.TP
116
\fBinject\fR (\fB\-i\fR)
115
\fBinject\fR (\fB\-i\fR)
117
Injecting a package inserts a 'stub' for that package so that Portage
116
Add a stub entry for a package so that Portage thinks that it's
118
thinks that it is installed. It is handy if you need, say, a binary
117
installed when it really isn't. Handy if you roll your own
119
version of XFree86 for esoteric hardware, or you just like to roll
118
packages.  Example:
120
your own packages.  You \fBmust\fR specify a category and particular
119
\fBemerge inject sys-kernel/gentoo-sources-2.4.19\fR
121
version of a package for injecting.  For example,
122
\fBemerge inject sys\-kernel/gentoo\-sources\-2.4.19\fR.
123
.TP
120
.TP
124
\fBprune\fR (\fB\-P\fR)
121
\fBprune\fR (\fB\-P\fR)
125
\fBWARNING: This action can remove important packages!\fR Removes
122
\fBWARNING: This action can remove important packages!\fR
126
all but the latest versions of matching packages.  If there are
123
Removes all older versions of a package from your system.
127
multiple SLOTs for a package, it leaves the latest version in each
124
This action doesn't always verify the possible binary
128
SLOT. This does no checking of dependencies, so it may remove
125
incompatibility between versions and can thus remove essential
129
packages necessary for the proper operation of your system. \fBUse\fR
126
dependencies from your system.
130
clean \fBinstead unless you really know what you're doing\fR.  Its
127
The argument format is the same as for the \fBclean\fR action.
131
arguments can be \fIebuilds\fR, \fIclasses\fR, or \fIdependencies\fR
128
.TP
132
\-\- see \fBclean\fR above for examples.
129
\fBregen\fR
133
.TP
130
Causes portage to check and update the dependency cache of all
134
\fBrsync\fR
131
ebuilds in the portage tree. This is not recommended for rsync
135
See \fBsync\fR below.
132
users as rsync updates the cache using server-side caches.
133
Rsync users should simply '\fBemerge sync\fR' to regenerate.
136
.TP
134
.TP
137
\fBsearch\fR (\fB\-s\fR)
135
\fBsearch\fR (\fB\-s\fR)
138
Searches for matches of the supplied string in the portage tree.
136
Searches for matches of the supplied string in the current local
139
The search string is a regular expression.  For example, \fBemerge
137
portage tree. The search string is a regular expression.
140
search "^kde"\fR searches for any package that starts with "kde";
138
A few examples:
141
\fBemerge search "gcc$"\fR searches for any package that ends with
139
  \fBemerge search '^kde'\fR
142
"gcc"; \fBemerge search "office"\fR searches for any package that
140
    list all packages starting with kde
143
contains the word "office".  If you want to search the package
141
  \fBemerge search 'gcc$'\fR
144
descriptions as well, use the \fB\-\-searchdesc\fR,\fB-S\fR option.
142
    list all packages ending with gcc
143
  \fBemerge search ''\fR or
144
  \fBemerge search '.*'\fR
145
    list all available packages
145
.TP
146
.TP
146
\fBsync\fR
147
\fBsync\fR
147
Initiates a portage tree update with one of the rsync.gentoo.org
148
Initiates a portage tree update with one of the rsync.gentoo.org
Lines 151-164 Link Here
151
of PORTDIR_OVERLAY for a method to avoid deletions.
152
of PORTDIR_OVERLAY for a method to avoid deletions.
152
.TP
153
.TP
153
\fBunmerge\fR (\fB\-C\fR)
154
\fBunmerge\fR (\fB\-C\fR)
154
\fBWARNING: This action can remove important packages!\fR Removes
155
\fBWARNING: This action can remove important packages!\fR
155
all matching packages.  This does no checking of dependencies, so
156
Removes all matching packages without checking for outdated
156
it may remove packages necessary for the proper operation of your
157
versions, effectively removing a package \fBcompletely\fR from
157
system. Its arguments can be \fIebuilds\fR, \fIclasses\fR, or
158
your system. Specify arguments using the dependency specification
158
\fIdependencies\fR \-\- see \fBclean\fR above for examples.
159
format described in the \fBclean\fR action above.
159
.TP
160
\fB\-\-version\fR
161
Displays the version number of \fBemerge\fR.
162
.SH "OPTIONS "
160
.SH "OPTIONS "
163
.TP
161
.TP
164
\fB\-\-buildpkg\fR (\fB\-b\fR)
162
\fB\-\-buildpkg\fR (\fB\-b\fR)
Lines 170-186 Link Here
170
packages is to use \fBquickpkg\fR which creates a tbz2 from the
168
packages is to use \fBquickpkg\fR which creates a tbz2 from the
171
live filesystem.
169
live filesystem.
172
.TP
170
.TP
171
\fB\-\-buildpkgonly\fR (\fB\-B\fR)
172
Creates a binary package, but does not merge it to the
173
system. This has the restriction that dependencies for the
174
desired package will not be automatically merged, so they
175
must exist on the system.
176
.TP
177
\fB\-\-changelog\fR (\fB\-l\fR)
178
When pretending, also display the ChangeLog entries for packages
179
that will be upgraded.
180
.TP
173
\fB\-\-columns\fR
181
\fB\-\-columns\fR
174
Used along side \fI--pretend\fR to causes the package, new version,
182
Display the pretend output in a tabular form. Versions are
175
and old version to be displayed in an aligned format for easy cut\-n\-paste.
183
aligned vertically.
176
.TP
184
.TP
177
\fB\-\-debug\fR (\fB\-d\fR)
185
\fB\-\-debug\fR (\fB\-d\fR)
178
Tells emerge to run the emerge command in \-\-debug mode.  In this
186
Tells emerge to run the emerge command in \fB\-\-debug\fR mode.  In this
179
mode the bash build environment will run with the \-x option,
187
mode the bash build environment will run with the \-x option,
180
causing it to output verbose debug information to stdout.
188
causing it to output verbose debug information to stdout.
181
\-\-debug is great for finding bash syntax errors.
189
\-\-debug is great for finding bash syntax errors.
182
.TP
190
.TP
183
\fB\-\-deep\fR
191
\fB\-\-deep\fR (\fB\-D\fR)
184
When used in conjunction with \fB\-\-update\fR, this flag forces
192
When used in conjunction with \fB\-\-update\fR, this flag forces
185
\fBemerge\fR to consider the entire dependency tree of packages,
193
\fBemerge\fR to consider the entire dependency tree of packages,
186
instead of checking only the immediate dependencies of the packages.
194
instead of checking only the immediate dependencies of the packages.
Lines 188-212 Link Here
188
listed in the dependencies of a package.
196
listed in the dependencies of a package.
189
.TP
197
.TP
190
\fB\-\-emptytree\fR (\fB\-e\fR)
198
\fB\-\-emptytree\fR (\fB\-e\fR)
191
Virtually tweaks the tree of installed packages to only contain glibc;
199
Virtually tweaks the tree of installed packages to only contain glibc,
192
this is great to use together with \-\-pretend. This allows developers
200
this is great to use together with \fB\-\-pretend\fR. This makes it possible for
193
to get a complete overview of the complete dependency tree of a package,
201
developers to get a complete overview of the complete dependency tree of a package,
194
and it enables complete trees to be rebuilt using the latest libraries.
202
and it enables complete trees to be rebuilt using the latest libraries.
195
.TP
203
.TP
196
\fB\-\-fetchonly\fR (\fB\-f\fR)
204
\fB\-\-fetchonly\fR (\fB\-f\fR)
197
Instead of doing any package building, just perform fetches for all
205
Instead of doing any package building, just perform fetches for all
198
packages (the main package as well as all dependencies.)
206
packages (the main package as well as all dependencies). When
207
used in combination with \fB\-\-pretend\fR all the SRC_URIs will be
208
displayed multiple mirrors per line, one line per file.
199
.TP
209
.TP
200
\fB\-\-noconfmem\fR
210
\fB\-\-noconfmem\fR
201
Causes portage to disregard merge records indicating that a config file
211
Portage keeps track of files that have been placed into
202
inside of a CONFIG_PROTECT directory has been merged already. Portage
212
CONFIG_PROTECT directories, and normally it will not merge the
203
will normally merge those files only once to prevent the user from
213
same file more than once, as that would become annoying. This
204
dealing with the same config multiple times. This flag will cause the
214
can lead to problems when the user wants the file in the case
205
file to always be merged.
215
of accidental deletion. With this option, files will always be
206
.TP
216
merged to the live fs instead of silently dropped.
207
\fB\-\-nodeps\fR
217
.TP
208
Merges specified packages without merging any dependencies.  Note that
218
\fB\-\-nodeps\fR (\fB\-O\fR)
209
the build may fail if the dependencies aren't satisfied.
219
Merges specified packages, but don't merge any dependencies.  Note that
220
the build may fail if deps aren't satisfied.
210
.TP
221
.TP
211
\fB\-\-noreplace\fR (\fB\-n\fR)
222
\fB\-\-noreplace\fR (\fB\-n\fR)
212
Skips the packages specified on the command\-line that have already
223
Skips the packages specified on the command\-line that have already
Lines 221-257 Link Here
221
.TP
232
.TP
222
\fB\-\-oneshot\fR
233
\fB\-\-oneshot\fR
223
Emerge as normal, but do not add the packages to the world profile
234
Emerge as normal, but do not add the packages to the world profile
224
for later updating.
235
for later updating. This prevents consideration of this package
236
unless this package is depended upon by another package.
225
.TP
237
.TP
226
\fB\-\-onlydeps\fR (\fB\-o\fR)
238
\fB\-\-onlydeps\fR (\fB\-o\fR)
227
Only merge (or pretend to merge) the dependencies of the packages
239
Only merge (or pretend to merge) the dependencies of the packages
228
specified, not the packages themselves.
240
specified, not the packages themselves.
229
.TP
241
.TP
230
\fB\-\-pretend\fR (\fB\-p\fR)
242
\fB\-\-pretend\fR (\fB\-p\fR)
231
Instead of actually performing the merge, simply display what *would*
243
Instead of actually performing the merge, simply display what
232
have been installed if \-\-pretend weren't used.  Using \-\-pretend
244
ebuilds and tbz2s *would* have been installed if \-\-pretend
233
is strongly recommended before installing an unfamiliar package. In
245
weren't used.  Using \-\-pretend is strongly recommended before
234
the printout, N = new, U = upgrading, R = replacing, B = blocked by
246
installing an unfamiliar package.  In the printout, N = new,
235
an already installed package.
247
U = updating, R = replacing, B = blocked by an already installed
248
package, D = possible downgrading. \-\-verbose causes affecting
249
use flags to be printed out accompanied by a '\+' for enabled
250
and a '\-' for disabled flags.
251
.TP
252
\fB\-\-quiet\fR (\fB\-q\fR)
253
Effects vary, but the general outcome is a reduced or condensed
254
output from portage's displays.
255
.TP
256
\fB\-\-resume\fR
257
Resumes the last merge operation. Can be treated just like a
258
regular merge as \-\-pretend and other options work along side.
259
'emerge \-\-resume' only returns an error on failure. Nothing to
260
do exits with a message and a success condition.
236
.TP
261
.TP
237
\fB\-\-searchdesc\fR (\fB\-S\fR)
262
\fB\-\-searchdesc\fR (\fB\-S\fR)
238
Matches the search string against the description field as well as
263
Matches the search string against the description field as well as
239
the package name.  \fBTake caution\fR as the descriptions are also
264
the package's name. \fBTake caution\fR as the descriptions are also
240
matched as regular expressions.
265
matched as regular expressions.
266
  emerge -S html
267
  emerge -S applet
268
  emerge -S 'perl.*module'
269
.TP
270
\fB\-\-skipfirst\fR
271
This option is only valid in a resume situation. It removes the
272
first package in the resume list so that a merge may continue in
273
the presence of an uncorrectable or inconsequential error. This
274
should only be used in cases where skipping the package will not
275
result in failed dependencies.
241
.TP
276
.TP
242
\fB\-\-update\fR (\fB\-u\fR)
277
\fB\-\-update\fR (\fB\-u\fR)
243
Updates packages to the most recent version available.  \fBNote that\fR \-\-update \fBdoes not have full functionality yet\fR.  It will not automatically update dependencies of packages in the \fBworld\fR file, unless they too are in the \fBworld\fR file.
278
Updates packages, along with their dependencies, to the best
244
.TP
279
version available, which may not always be the highest version
245
\fB\-\-usepkg\fR (\fB\-k\fR) 
280
number due to masking for testing and development.
246
Tells emerge to use binary packages (from $PKGDIR) if they are available, thus possibly avoiding some time\-consuming compiles. This option is useful for CD installs; you can export PKGDIR=/mnt/cdrom/packages and then use this option to have emerge "pull" binary packages from the CD in order to satisfy dependencies.
281
.TP
282
\fB\-\-upgradeonly\fR (\fB\-U\fR)
283
Updates packages, but excludes updates that would result in a
284
lower version ofthe package being installed. SLOTs are
285
considered at a basic level.
286
.TP
287
\fB\-\-usepkg\fR (\fB\-k\fR)
288
Tell emerge to use binary packages (from $PKGDIR) if they are
289
available, thus possibly avoiding some time-consuming compiles.
290
This option is useful for CD installs; you can export
291
PKGDIR=/mnt/cdrom/packages and then use this option to have
292
emerge "pull" binary packages from the CD in order to satisfy
293
dependencies.
294
.TP
295
\fB\-\-usepkgonly\fR (\fB\-K\fR)
296
Like \-\-usepkg above, except this only allows the use of binary
297
packages, and it will abort the emerge if the package is not
298
available at the time of dependency calculation.
247
.TP
299
.TP
248
\fB\-\-verbose\fR (\fB\-v\fR)
300
\fB\-\-verbose\fR (\fB\-v\fR)
249
Tell emerge to run in verbose mode.  Currently this flag causes emerge to print out GNU info errors, if any.
301
Tell emerge to run in verbose mode.  Currently this flag causes emerge to print out GNU info errors, if any.
250
.TP
302
.TP
251
\fB\-\-version\fR
303
\fB\-\-version\fR (\fB\-V\fR)
252
Displays the version number of \fBemerge\fR.  It cannot be used in
304
Displays the currently installed version of portage along with
253
conjunction with other options; the name and format of the action
305
other information useful for quick reference on a system. See
254
is a convention.
306
\fBemerge\fR info for more advanced information.
255
.SH "OUTPUT"
307
.SH "OUTPUT"
256
While utilizing emerge and the pretend/verbose flags, the output
308
While utilizing emerge and the pretend/verbose flags, the output
257
may be a little hard to understand for the first time.  This section
309
may be a little hard to understand for the first time.  This section
Lines 372-381 Link Here
372
Please include the output of \fBemerge info\fR when you submit your
424
Please include the output of \fBemerge info\fR when you submit your
373
bug report.
425
bug report.
374
.SH "SEE ALSO"
426
.SH "SEE ALSO"
375
.BR emerge --help,
427
\fBemerge \-\-help\fR,
376
.BR ebuild (1),
428
\fBebuild\fR(1),
377
.BR ebuild (5),
429
\fBebuild\fR(5),
378
.BR make.conf (5)
430
\fBmake.conf\fR(5)
379
.LP 
431
.LP 
380
A number of helper applications reside in \fI/usr/lib/portage/bin\fR.
432
A number of helper applications reside in \fI/usr/lib/portage/bin\fR.
381
.LP 
433
.LP 
Lines 398-411 Link Here
398
edit this file\fR.
450
edit this file\fR.
399
.TP
451
.TP
400
\fB/etc/make.profile/use.defaults\fR
452
\fB/etc/make.profile/use.defaults\fR
401
Contains the USE flags that are enabled by default. \fBDo not edit this
453
Contains packages that, if installed, cause respective USE flag to be enabled by default.
402
file\fR.
454
\fBDo not edit this file\fR.
403
.TP
455
.TP
404
\fB/usr/portage/profiles/use.desc\fR 
456
\fB/usr/portage/profiles/use.desc\fR
405
Contains the master list of USE flags with descriptions of their
457
Contains the master list of USE flags with descriptions of their
406
functions. \fBDo not edit this file\fR.
458
functions. \fBDo not edit this file\fR.
407
.TP
459
.TP
408
\fB/etc/make.profile/virtuals\fR 
460
\fB/etc/make.profile/virtuals\fR
409
Contains a list of default packages used to resolve virtual dependencies.
461
Contains a list of default packages used to resolve virtual dependencies.
410
\fBDo not edit this file\fR.
462
\fBDo not edit this file\fR.
411
.TP
463
.TP
Lines 415-421 Link Here
415
corresponding virtual here. The first package listed after the virtual is
467
corresponding virtual here. The first package listed after the virtual is
416
the entry used for matching the virtual.
468
the entry used for matching the virtual.
417
.TP
469
.TP
418
\fB/etc/make.profile/package\fR
470
\fB/etc/make.profile/packages\fR
419
Contains a list of packages used for the base system. The \fBsystem\fR
471
Contains a list of packages used for the base system. The \fBsystem\fR
420
and \fBworld\fR classes consult this file. \fBDo not edit this file\fR.
472
and \fBworld\fR classes consult this file. \fBDo not edit this file\fR.
421
.TP
473
.TP

Return to bug 18249