/[gentoo]/xml/htdocs/doc/en/handbook/hb-working-portage.xml
Gentoo

Diff of /xml/htdocs/doc/en/handbook/hb-working-portage.xml

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.40 Revision 1.73
1<?xml version='1.0' encoding='UTF-8'?> 1<?xml version='1.0' encoding='UTF-8'?>
2<!DOCTYPE sections SYSTEM "/dtd/book.dtd"> 2<!DOCTYPE sections SYSTEM "/dtd/book.dtd">
3 3
4<!-- The content of this document is licensed under the CC-BY-SA license --> 4<!-- The content of this document is licensed under the CC-BY-SA license -->
5<!-- See http://creativecommons.org/licenses/by-sa/2.0 --> 5<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
6 6
7<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/handbook/hb-working-portage.xml,v 1.40 2004/10/21 16:34:46 swift Exp $ --> 7<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/handbook/hb-working-portage.xml,v 1.73 2010/02/13 20:54:07 nightmorph Exp $ -->
8 8
9<sections> 9<sections>
10
11<abstract>
12This chapter explains the "simple" steps a user definitely needs to know to
13maintain the software on his system.
14</abstract>
15
16<version>1.66</version>
17<date>2010-02-13</date>
18
10<section> 19<section>
11<title>Welcome to Portage</title> 20<title>Welcome to Portage</title>
12<body> 21<body>
13 22
14<p> 23<p>
62<title>Updating the Portage Tree</title> 71<title>Updating the Portage Tree</title>
63<body> 72<body>
64 73
65<p> 74<p>
66The Portage tree is usually updated with <uri 75The Portage tree is usually updated with <uri
67link="http://rsync.gentoo.org">rsync</uri>, a fast incremental file transfer 76link="http://rsync.samba.org/">rsync</uri>, a fast incremental file transfer
68utility. Updating is fairly simple as the <c>emerge</c> command provides a 77utility. Updating is fairly simple as the <c>emerge</c> command provides a
69front-end for rsync: 78front-end for rsync:
70</p> 79</p>
71 80
72<pre caption="Updating the Portage tree"> 81<pre caption="Updating the Portage tree">
93<title>Searching for Software</title> 102<title>Searching for Software</title>
94<body> 103<body>
95 104
96<p> 105<p>
97To search through the Portage tree after software titles, you can use 106To search through the Portage tree after software titles, you can use
98<c>emerge</c> built-in search capabilities. By default, <c>emerge search</c> 107<c>emerge</c> built-in search capabilities. By default, <c>emerge --search</c>
99returns package names whos title corresponds with (either fully or partially) 108returns the names of packages whose title matches (either fully or partially)
100the given search term. 109the given search term.
101</p> 110</p>
102 111
103<p> 112<p>
104For instance, to search for all packages who have "pdf" in their name: 113For instance, to search for all packages who have "pdf" in their name:
105</p> 114</p>
106 115
107<pre caption="Searching for pdf-named packages"> 116<pre caption="Searching for pdf-named packages">
108$ <i>emerge search pdf</i> 117$ <i>emerge --search pdf</i>
109</pre> 118</pre>
110 119
111<p> 120<p>
112If you want to search through the descriptions as well you can use the 121If you want to search through the descriptions as well you can use the
113<c>--searchdesc</c> (or <c>-S</c>) switch: 122<c>--searchdesc</c> (or <c>-S</c>) switch:
121When you take a look at the output, you'll notice that it gives you a lot of 130When you take a look at the output, you'll notice that it gives you a lot of
122information. The fields are clearly labelled so we won't go further into their 131information. The fields are clearly labelled so we won't go further into their
123meanings: 132meanings:
124</p> 133</p>
125 134
126<pre caption="Example emerge search output"> 135<pre caption="Example 'emerge --search' output">
127* net-print/cups-pdf 136* net-print/cups-pdf
128 Latest version available: 1.5.2 137 Latest version available: 1.5.2
129 Latest version installed: [ Not Installed ] 138 Latest version installed: [ Not Installed ]
130 Size of downloaded files: 15 kB 139 Size of downloaded files: 15 kB
131 Homepage: http://cip.physik.uni-wuerzburg.de/~vrbehr/cups-pdf/ 140 Homepage: http://cip.physik.uni-wuerzburg.de/~vrbehr/cups-pdf/
174</pre> 183</pre>
175 184
176</body> 185</body>
177</subsection> 186</subsection>
178<subsection> 187<subsection>
188<title>Finding Installed Package Documentation</title>
189<body>
190
191<p>
192Many packages come with their own documentation. Sometimes, the <c>doc</c> USE
193flag determines whether the package documentation should be installed or not.
194You can check the existence of a <c>doc</c> USE flag with the <c>emerge -vp
195&lt;package name&gt;</c> command.
196</p>
197
198<pre caption="Checking the existence of a doc USE flag">
199<comment>(alsa-lib is just an example, of course.)</comment>
200# <i>emerge -vp alsa-lib</i>
201[ebuild N ] media-libs/alsa-lib-1.0.14_rc1 -debug +doc 698 kB
202</pre>
203
204<p>
205The best way of enabling the <c>doc</c> USE flag is doing it on a per-package
206basis via <path>/etc/portage/package.use</path>, so that you get documentation
207only for packages that you are interested in. Enabling this flag globally is
208known to cause problems with circular dependencies. For more information, please
209read the <uri link="?part=2&amp;chap=2">USE Flags</uri> chapter.
210</p>
211
212<p>
213Once the package installed, its documentation is generally found in a
214subdirectory named after the package under the <path>/usr/share/doc</path>
215directory. You can also list all installed files with the <c>equery</c> tool
216which is part of the <c>app-portage/gentoolkit</c> <uri
217link="/doc/en/gentoolkit.xml">package</uri>.
218</p>
219
220<pre caption="Locating package documentation">
221# <i>ls -l /usr/share/doc/alsa-lib-1.0.14_rc1</i>
222total 28
223-rw-r--r-- 1 root root 669 May 17 21:54 ChangeLog.gz
224-rw-r--r-- 1 root root 9373 May 17 21:54 COPYING.gz
225drwxr-xr-x 2 root root 8560 May 17 21:54 html
226-rw-r--r-- 1 root root 196 May 17 21:54 TODO.gz
227
228<comment>(Alternatively, use equery to locate interesting files:)</comment>
229# <i>equery files alsa-lib | less</i>
230media-libs/alsa-lib-1.0.14_rc1
231* Contents of media-libs/alsa-lib-1.0.14_rc1:
232/usr
233/usr/bin
234/usr/bin/alsalisp
235<comment>(Output truncated)</comment>
236</pre>
237
238</body>
239</subsection>
240<subsection>
179<title>Removing Software</title> 241<title>Removing Software</title>
180<body> 242<body>
181 243
182<p> 244<p>
183When you want to remove a software package from your system, use <c>emerge 245When you want to remove a software package from your system, use <c>emerge
184unmerge</c>. This will tell Portage to remove all files installed by that 246--unmerge</c>. This will tell Portage to remove all files installed by that
185package from your system <e>except</e> the configuration files of that 247package from your system <e>except</e> the configuration files of that
186application if you have altered those after the installation. Leaving the 248application if you have altered those after the installation. Leaving the
187configuration files allows you to continue working with the package if you ever 249configuration files allows you to continue working with the package if you ever
188decide to install it again. 250decide to install it again.
189</p> 251</p>
194warn you when you want to remove an important package that breaks your system 256warn you when you want to remove an important package that breaks your system
195if you unmerge it. 257if you unmerge it.
196</p> 258</p>
197 259
198<pre caption="Removing gnumeric from the system"> 260<pre caption="Removing gnumeric from the system">
199# <i>emerge unmerge gnumeric</i> 261# <i>emerge --unmerge gnumeric</i>
200</pre> 262</pre>
201 263
202<p> 264<p>
203When you remove a package from your system, the dependencies of that package 265When you remove a package from your system, the dependencies of that package
204that were installed automatically when you installed the software are left. To 266that were installed automatically when you installed the software are left. To
205have Portage locate all dependencies that can now be removed, use 267have Portage locate all dependencies that can now be removed, use
206<c>emerge</c>'s <c>depclean</c> functionality. We will talk about this later on. 268<c>emerge</c>'s <c>--depclean</c> functionality. We will talk about this later
269on.
207</p> 270</p>
208 271
209</body> 272</body>
210</subsection> 273</subsection>
211<subsection> 274<subsection>
215<p> 278<p>
216To keep your system in perfect shape (and not to mention install the latest 279To keep your system in perfect shape (and not to mention install the latest
217security updates) you need to update your system regularly. Since Portage only 280security updates) you need to update your system regularly. Since Portage only
218checks the ebuilds in your Portage tree you first have to update your Portage 281checks the ebuilds in your Portage tree you first have to update your Portage
219tree. When your Portage tree is updated, you can update your system with 282tree. When your Portage tree is updated, you can update your system with
220<c>emerge --update world</c>: 283<c>emerge --update world</c>. In the next example, we'll also use the
284<c>--ask</c> switch which will tell Portage to display the list of packages it
285wants to upgrade and ask you if you want to continue:
221</p> 286</p>
222 287
223<pre caption="Updating your system"> 288<pre caption="Updating your system">
224# <i>emerge --update world</i> 289# <i>emerge --update --ask world</i>
225</pre> 290</pre>
226 291
227<p> 292<p>
228Portage will then search for newer version of the applications you have 293Portage will then search for newer version of the applications you have
229installed. However, it will only verify the versions for the applications you 294installed. However, it will only verify the versions for the applications you
230have explicitly installed - not the dependencies. If you want to update every 295have <e>explicitly</e> installed (the applications listed in
231single package on your system, add the <c>--deep</c> argument: 296<path>/var/lib/portage/world</path>) - it does not thoroughly check their
297dependencies. If you want to update <e>every single package</e> on your system,
298add the <c>--deep</c> argument:
232</p> 299</p>
233 300
234<pre caption="Updating your entire system"> 301<pre caption="Updating your entire system">
235# <i>emerge --update --deep world</i> 302# <i>emerge --update --deep world</i>
236</pre> 303</pre>
304
305<p>
306Since security updates also happen in packages you have not explicitly installed
307on your system (but that are pulled in as dependencies of other programs), it
308is recommended to run this command once in a while.
309</p>
237 310
238<p> 311<p>
239If you have altered any of your <uri link="?part=2&amp;chap=2">USE flags</uri> 312If you have altered any of your <uri link="?part=2&amp;chap=2">USE flags</uri>
240lately you might want to add <c>--newuse</c> as well. Portage will then verify 313lately you might want to add <c>--newuse</c> as well. Portage will then verify
241if the change requires the installation of new packages or recompilation of 314if the change requires the installation of new packages or recompilation of
247</pre> 320</pre>
248 321
249</body> 322</body>
250</subsection> 323</subsection>
251<subsection> 324<subsection>
252<title>Stub Packages</title> 325<title>Metapackages</title>
253<body> 326<body>
254 327
255<p> 328<p>
256Some packages in the Portage tree don't have any real content but are used to 329Some packages in the Portage tree don't have any real content but are used to
257install a collection of packages. For instance, the <c>kde</c> package will 330install a collection of packages. For instance, the <c>kde-meta</c> package will
258install a complete KDE environment on your system by pulling in various 331install a complete KDE environment on your system by pulling in various
259KDE-related packages as dependencies. 332KDE-related packages as dependencies.
260</p> 333</p>
261 334
262<p> 335<p>
263If you ever want to remove such a package from your system, running <c>emerge 336If you ever want to remove such a package from your system, running <c>emerge
264unmerge</c> on the package won't have much effect as the dependencies remain on 337--unmerge</c> on the package won't have much effect as the dependencies remain
265the system. 338on the system.
266</p> 339</p>
267 340
268<p> 341<p>
269Portage has the functionality to remove orphaned dependencies as well, but since 342Portage has the functionality to remove orphaned dependencies as well, but since
270the availability of software is dynamically dependent you first need to update 343the availability of software is dynamically dependent you first need to update
271your entire system fully, including the new changes you applied when changing 344your entire system fully, including the new changes you applied when changing
272USE flags. After this you can run <c>emerge depclean</c> to remove the orphaned 345USE flags. After this you can run <c>emerge --depclean</c> to remove the
273dependencies. When this is done, you need to rebuild the applications that were 346orphaned dependencies. When this is done, you need to rebuild the applications
274dynamically linked to the now-removed software titles but don't require them 347that were dynamically linked to the now-removed software titles but don't
275anymore. 348require them anymore.
276</p> 349</p>
277 350
278<p> 351<p>
279All this is handled with the following three commands: 352All this is handled with the following three commands:
280</p> 353</p>
281 354
282<pre caption="Removing orphaned dependencies"> 355<pre caption="Removing orphaned dependencies">
283# <i>emerge --update --deep --newuse world</i> 356# <i>emerge --update --deep --newuse world</i>
284# <i>emerge depclean</i> 357# <i>emerge --depclean</i>
285# <i>revdep-rebuild</i> 358# <i>revdep-rebuild</i>
286</pre> 359</pre>
287 360
288<p> 361<p>
289<c>revdep-rebuild</c> is provided by the <c>gentoolkit</c> package; don't forget 362<c>revdep-rebuild</c> is provided by the <c>gentoolkit</c> package; don't forget
304<body> 377<body>
305 378
306<p> 379<p>
307As we stated before, Portage is extremely powerful and supports many features 380As we stated before, Portage is extremely powerful and supports many features
308that other software management tools lack. To understand this, we explain a few 381that other software management tools lack. To understand this, we explain a few
309aspects of Portage without going in too much detail. 382aspects of Portage without going into too much detail.
310</p> 383</p>
311 384
312<p> 385<p>
313With Portage different versions of a single package can coexist on a system. 386With Portage different versions of a single package can coexist on a system.
314While other distributions tend to name their package to those versions (like 387While other distributions tend to name their package to those versions (like
355<subsection id="blocked"> 428<subsection id="blocked">
356<title>Blocked Packages</title> 429<title>Blocked Packages</title>
357<body> 430<body>
358 431
359<pre caption="Portage warning about blocked packages (with --pretend)"> 432<pre caption="Portage warning about blocked packages (with --pretend)">
360[blocks B ] gnome-base/bonobo-activation (from pkg gnome-base/libbonobo-2.4.0) 433[blocks B ] mail-mta/ssmtp (is blocking mail-mta/postfix-2.2.2-r1)
361</pre> 434</pre>
362 435
363<pre caption="Portage warning about blocked packages (without --pretend)"> 436<pre caption="Portage warning about blocked packages (without --pretend)">
364!!! Error: the gnome-base/bonobo-activation package conflicts with another package. 437!!! Error: the mail-mta/postfix package conflicts with another package.
365!!! both can't be installed on the same system together. 438!!! both can't be installed on the same system together.
366!!! Please use 'emerge --pretend' to determine blockers. 439!!! Please use 'emerge --pretend' to determine blockers.
367</pre> 440</pre>
368 441
369<p> 442<p>
370Ebuilds contain specific fields that inform Portage about it's dependencies. 443Ebuilds contain specific fields that inform Portage about its dependencies.
371There are two possible dependencies: build dependencies, declared in 444There are two possible dependencies: build dependencies, declared in
372<c>DEPEND</c> and run-time dependencies, declared in <c>RDEPEND</c>. When one of 445<c>DEPEND</c> and run-time dependencies, declared in <c>RDEPEND</c>. When one of
373these dependencies explicitly marks a package or virtual as being <e>not</e> 446these dependencies explicitly marks a package or virtual as being <e>not</e>
374compatible, it triggers a blockage. 447compatible, it triggers a blockage.
375</p> 448</p>
376 449
377<p> 450<p>
451While recent versions of Portage are smart enough to work around minor blockages
452without user intervention, occasionally you will need to fix it yourself, as
453explained below.
454</p>
455
456<p>
378To fix a blockage, you can choose to not install the package or unmerge the 457To fix a blockage, you can choose to not install the package or unmerge the
379conflicting package first. In the given example, you can opt not to install 458conflicting package first. In the given example, you can opt not to install
380<c>libbonobo</c> or to remove <c>bonobo-activation</c> first. 459<c>postfix</c> or to remove <c>ssmtp</c> first.
460</p>
461
462<p>
463You may also see blocking packages with specific atoms, such as
464<b>&lt;</b>media-video/mplayer-1.0_rc1-r2. In this case, updating to a more
465recent version of the blocking package would remove the block.
466</p>
467
468<p>
469It is also possible that two packages that are yet to be installed are blocking
470each other. In this rare case, you should find out why you need to install both.
471In most cases you can do with one of the packages alone. If not, please file a
472bug on <uri link="http://bugs.gentoo.org">Gentoo's bugtracking system</uri>.
381</p> 473</p>
382 474
383</body> 475</body>
384</subsection> 476</subsection>
385<subsection id="masked"> 477<subsection id="masked">
395 487
396- gnome-base/gnome-2.8.0_pre1 (masked by: <i>~x86 keyword</i>) 488- gnome-base/gnome-2.8.0_pre1 (masked by: <i>~x86 keyword</i>)
397- lm-sensors/lm-sensors-2.8.7 (masked by: <i>-sparc keyword</i>) 489- lm-sensors/lm-sensors-2.8.7 (masked by: <i>-sparc keyword</i>)
398- sys-libs/glibc-2.3.4.20040808 (masked by: <i>-* keyword</i>) 490- sys-libs/glibc-2.3.4.20040808 (masked by: <i>-* keyword</i>)
399- dev-util/cvsd-1.0.2 (masked by: <i>missing keyword</i>) 491- dev-util/cvsd-1.0.2 (masked by: <i>missing keyword</i>)
400- media-video/ati-gatos-4.3.0 (masked by: <i>package.mask</i>) 492- games-fps/unreal-tournament-451 (masked by: <i>package.mask</i>)
401- sys-libs/glibc-2.3.2-r11 (masked by: <i>profile</i>) 493- sys-libs/glibc-2.3.2-r11 (masked by: <i>profile</i>)
402</pre> 494</pre>
403 495
404<p> 496<p>
405When you want to install a package that isn't available for your system, you 497When you want to install a package that isn't available for your system, you
440<subsection id="missingdependencies"> 532<subsection id="missingdependencies">
441<title>Missing Dependencies</title> 533<title>Missing Dependencies</title>
442<body> 534<body>
443 535
444<pre caption="Portage warning about missing dependency"> 536<pre caption="Portage warning about missing dependency">
445emerge: there are no ebuilds to satisfy "&gt;=sys-devel/gcc-4.2-r4". 537emerge: there are no ebuilds to satisfy "&gt;=sys-devel/gcc-3.4.2-r4".
446 538
447!!! Problem with ebuild sys-devel/gcc-3.4.2-r2 539!!! Problem with ebuild sys-devel/gcc-3.4.2-r2
448!!! Possibly a DEPEND/*DEPEND problem. 540!!! Possibly a DEPEND/*DEPEND problem.
449</pre> 541</pre>
450 542
461<subsection id="ambiguousebuild"> 553<subsection id="ambiguousebuild">
462<title>Ambiguous Ebuild Name</title> 554<title>Ambiguous Ebuild Name</title>
463<body> 555<body>
464 556
465<pre caption="Portage warning about ambiguous ebuild names"> 557<pre caption="Portage warning about ambiguous ebuild names">
558[ Results for search key : listen ]
559[ Applications found : 2 ]
560
561* dev-tinyos/listen [ Masked ]
562 Latest version available: 1.1.15
563 Latest version installed: [ Not Installed ]
564 Size of files: 10,032 kB
565 Homepage: http://www.tinyos.net/
566 Description: Raw listen for TinyOS
567 License: BSD
568
569* media-sound/listen [ Masked ]
570 Latest version available: 0.6.3
571 Latest version installed: [ Not Installed ]
572 Size of files: 859 kB
573 Homepage: http://www.listen-project.org
574 Description: A Music player and management for GNOME
575 License: GPL-2
576
466!!! The short ebuild name "aterm" is ambiguous. Please specify 577!!! The short ebuild name "listen" is ambiguous. Please specify
467!!! one of the following fully-qualified ebuild names instead: 578!!! one of the above fully-qualified ebuild names instead.
468
469 dev-libs/aterm
470 x11-terms/aterm
471</pre> 579</pre>
472 580
473<p> 581<p>
474The application you want to install has a name that corresponds with more than 582The application you want to install has a name that corresponds with more than
475one package. You need to supply the category name as well. Portage will inform 583one package. You need to supply the category name as well. Portage will inform
538from the system. 646from the system.
539</p> 647</p>
540 648
541</body> 649</body>
542</subsection> 650</subsection>
651<subsection id="digesterror">
652<title>Digest Verification Failures</title>
653<body>
654
655<p>
656Sometimes, when you attempt to emerge a package, it will fail with the message:
657</p>
658
659<pre caption="Digest verification failure">
660&gt;&gt;&gt; checking ebuild checksums
661!!! Digest verification failed:
662</pre>
663
664<p>
665This is a sign that something is wrong with the Portage tree -- often, it is
666because a developer may have made a mistake when committing a package to the
667tree.
668</p>
669
670<p>
671When the digest verification fails, do <e>not</e> try to re-digest the package
672yourself. Running <c>ebuild foo manifest</c> will not fix the problem; it will
673almost certainly make it worse!
674</p>
675
676<p>
677Instead, wait an hour or two for the tree to settle down. It's likely that the
678error was noticed right away, but it can take a little time for the fix to
679trickle down the Portage tree. While you're waiting, check <uri
680link="http://bugs.gentoo.org">Bugzilla</uri> and see if anyone has reported
681the problem yet. If not, go ahead and file a bug for the broken package.
682</p>
683
684<p>
685Once you see that the bug has been fixed, you may want to re-sync to pick up
686the fixed digest.
687</p>
688
689<impo>
690This does <e>not</e> mean that you can re-sync your tree multiple times! As
691stated in the rsync policy (when you run <c>emerge --sync</c>), users who sync
692too often will be banned! In fact, it's better to just wait until your next
693scheduled sync, so that you don't overload the rsync servers.
694</impo>
695
696</body>
697</subsection>
543</section> 698</section>
544</sections> 699</sections>

Legend:
Removed from v.1.40  
changed lines
  Added in v.1.73

  ViewVC Help
Powered by ViewVC 1.1.20