/[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.4 Revision 1.54
1<?xml version='1.0' encoding='UTF-8'?>
2<!DOCTYPE sections SYSTEM "/dtd/book.dtd">
3
1<!-- 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 -->
2<!-- See http://creativecommons.org/licenses/by-sa/1.0 --> 5<!-- See http://creativecommons.org/licenses/by-sa/2.0 -->
3 6
4<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/handbook/hb-working-portage.xml,v 1.4 2003/11/27 11:08:00 swift Exp $ --> 7<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/handbook/hb-working-portage.xml,v 1.54 2005/06/11 12:16:14 swift Exp $ -->
5 8
6<sections> 9<sections>
10
11<version>1.49</version>
12<date>2005-06-11</date>
13
7<section> 14<section>
8<title>Obtaining Package Information</title> 15<title>Welcome to Portage</title>
9<subsection>
10<title>The Lord of All Tools: emerge</title>
11<body> 16<body>
12 17
13<p>
14We have briefly encountered <c>emerge</c> in the previous chapter, but not to
15the extent that you are now able to work with it to its fullest potential. We
16will fix that right now ;-)
17</p> 18<p>
18 19Portage is probably Gentoo's most notable innovation in software management.
20With its high flexibility and enormous amount of features it is frequently seen
21as the best software management tool available for Linux.
19<p> 22</p>
20<c>emerge</c> is the command used to install, remove, query and maintain 23
21software packages. It is a front-end for <c>ebuild</c>; people interested in
22becoming Gentoo professionals will learn how to use <c>ebuild</c> later on. For
23now, we will focus on <c>emerge</c> as it has functionality that <c>ebuild</c>
24lacks (such as resolving dependencies, searching the Portage tree, etc.).
25</p> 24<p>
26 25Portage is completely written in <uri link="http://www.python.org">Python</uri>
26and <uri link="http://www.gnu.org/software/bash">Bash</uri> and therefore fully
27visible to the users as both are scripting languages.
27<p> 28</p>
28Since <c>emerge</c> is the most important tool for Gentoo users, it has an 29
29extensive manpage you can read by issuing <c>man emerge</c>. You can also view
30the in-command help by running <c>emerge --help</c>.
31</p> 30<p>
31Most users will work with Portage through the <c>emerge</c> tool. This chapter
32is not meant to duplicate the information available from the emerge man page.
33For a complete rundown of emerge's options, please consult the man page:
34</p>
32 35
33<pre caption="Retrieving help for emerge"> 36<pre caption="Reading the emerge man page">
34# <i>man emerge</i> 37$ <i>man emerge</i>
35# <i>emerge --help</i>
36</pre> 38</pre>
37 39
38</body>
39</subsection>
40<subsection>
41<title>The Portage Tree</title>
42<body> 40</body>
43
44<p>
45Before we continue describing <c>emerge</c>, let us first take a look at the
46Portage Tree. Go to <path>/usr/portage</path> and do a listing of the available
47directories.
48</p>
49
50<pre caption="Viewing the Portage Tree">
51# <i>cd /usr/portage; ls --classify</i>
52<comment>(The --classify will append a special character to note the filetype)</comment>
53app-admin/ dev-ml/ gnome-libs/ net-print/
54app-arch/ dev-perl/ gnome-office/ net-wireless/
55app-benchmarks/ dev-php/ header.txt net-www/
56app-cdr/ dev-python/ incoming/ net-zope/
57app-crypt/ dev-ruby/ jython/ packages/
58app-dicts/ dev-tcltk/ kde-apps/ profiles/
59app-doc/ dev-tex/ kde-base/ releases/
60app-editors/ dev-util/ kde-i18n/ scripts/
61app-emacs/ distfiles/ kde-libs/ sec-policy/
62app-emulation/ eclass/ licenses/ skel.ChangeLog
63app-games/ experimental/ media-fonts/ skel.ebuild
64app-gnustep/ files/ media-gfx/ skel.metadata.xml
65app-i18n/ fresco-base/ media-libs/ snapshots/
66app-misc/ games-action/ media-plugins/ sys-apps/
67app-office/ games-arcade/ media-radio/ sys-build/
68app-pda/ games-board/ media-sound/ sys-cluster/
69app-portage/ games-emulation/ media-tv/ sys-devel/
70app-sci/ games-engines/ media-video/ sys-fs/
71app-shells/ games-fps/ metadata/ sys-kernel/
72app-text/ games-kids/ net-analyzer/ sys-kmods/
73app-vim/ games-misc/ net-apache/ sys-libs/
74app-xemacs/ games-mud/ net-dialup/ unix2tcp/
75berlin-base/ games-puzzle/ net-dns/ x11-base/
76dev-ada/ games-roguelike/ net-firewall/ x11-libs/
77dev-cpp/ games-rpg/ net-fs/ x11-misc/
78dev-db/ games-server/ net-ftp/ x11-plugins/
79dev-dotnet/ games-simulation/ net-im/ x11-terms/
80dev-embedded/ games-sports/ net-irc/ x11-themes/
81dev-games/ games-strategy/ net-libs/ x11-wm/
82dev-haskell/ games-util/ net-mail/ xfce-base/
83dev-java/ glep/ net-misc/ xfce-extra/
84dev-lang/ gnome-apps/ net-nds/
85dev-libs/ gnome-base/ net-news/
86dev-lisp/ gnome-extra/ net-p2p/
87</pre>
88
89<p>
90As you can see, the Portage tree has several subdirectories. Most of them are
91the <e>categories</e> in which the Gentoo packages, called <e>ebuilds</e>,
92reside. Take a look at, for instance, <path>app-office</path>:
93</p>
94
95<pre caption="Viewing a category">
96# <i>cd app-office; ls --classify</i>
97abiword/ gnotime/ kmymoney2/ ooodi/ plan/ timestamp.x
98dia/ gnucash/ koffice/ oooqs/ qhacc/
99dia2code/ gnumeric/ lxbank/ openoffice/ sc/
100facturalux/ ical/ lyx/ openoffice-bin/ scribus/
101gaby/ kbudget/ mdbtools/ openoffice-ximian/ siag/
102gnofin/ khacc/ mrproject/ phprojekt/ texmacs/
103</pre>
104
105<p>
106Inside a category you will find the packages belonging to that category, with a
107seperate directory for each package. Let us take a look at the <c>openoffice</c>
108package:
109</p>
110
111<pre caption="Viewing a package">
112# <i>cd openoffice; ls --classify</i>
113ChangeLog files/ openoffice-1.0.3-r1.ebuild openoffice-1.1.0-r2.ebuild
114Manifest metadata.xml openoffice-1.1.0-r1.ebuild openoffice-1.1.0.ebuild
115</pre>
116
117<p>
118Remember that we told you that a Gentoo package is called an ebuild? Well, in
119the example directory four of such ebuilds are stored. Their naming is
120almost identical: they only differ in the version name.
121You are free to view the contents of such a package: they are plain scripts. We
122will not discuss it right now as it isn't important to know if you plan on just
123using Gentoo.
124</p>
125
126<p>
127The other files are the <path>ChangeLog</path> (which contains a listing of all
128the changes done to the ebuilds), <path>Manifest</path> (which contains the
129checksums and permissions of all the files in the directory) and
130<path>metadata.xml</path> (which contains more information about the package,
131such as the responsible development group -- called <e>herd</e> and a more
132extensive description).
133</p>
134
135<p>
136Inside the <path>files</path> directory you will find extra files, needed by
137Portage: digests (checksums and permissions of the files needed by a single
138version of the package), patches, example configuration files, etc.
139</p>
140
141<pre caption="Viewing the extra files">
142# <i>cd files; ls --classify</i>
1431.0.3/ digest-openoffice-1.0.3-r1 digest-openoffice-1.1.0-r1
1441.1.0/ digest-openoffice-1.1.0 digest-openoffice-1.1.0-r2
145# <i>cd 1.1.0; ls --classify</i>
146fixed-gcc.patch ooffice-wrapper-1.3
147newstlportfix.patch openoffice-1.1.0-linux-2.6-fix.patch
148no-mozab.patch openoffice-1.1.0-sparc64-fix.patch
149nptl.patch
150</pre>
151
152<p>
153If you go back to the root of the Portage tree (<path>/usr/portage</path>) you
154will notice that there are other, non-category directories too. We will discuss
155those later in this chapter.
156</p>
157
158</body>
159</subsection>
160<subsection>
161<title>Search for a Package</title>
162<body>
163
164<p>
165If you are new to Linux or Gentoo, you might not know what tool you need for
166what job. To facilitate searching, <c>emerge</c> provides you with a way to
167search through the available packages on your system. There are two ways you can
168search through packages: by <e>name</e>, or by <e>name</e> and
169<e>description</e>.
170</p>
171
172<p>
173To search through the Portage tree by name, use <c>emerge search</c>. For
174instance, to find out more about <c>mozilla</c>:
175</p>
176
177<pre caption="Showing information about mozilla">
178# <i>emerge search mozilla</i>
179Searching...
180[ Results for search key : mozilla ]
181[ Applications found : 5 ]
182<comment>(Some output removed to improve readability)</comment>
183* net-www/mozilla
184 Latest version available: 1.5-r1
185 Latest version installed: 1.4-r3
186 Size of downloaded files: 29,153 kB
187 Homepage: http://www.mozilla.org
188 Description: The Mozilla Web Browser
189
190* net-www/mozilla-firebird
191 Latest version available: 0.7
192 Latest version installed: [ Not Installed ]
193 Size of downloaded files: 37,850 kB
194 Homepage: http://www.mozilla.org/projects/firebird/
195 Description: The Mozilla Firebird Web Browser
196<comment>(...)</comment>
197</pre>
198
199<p>
200If you want to include a search through the descriptions too, use the
201<c>--searchdesc</c> argument:
202</p>
203
204<pre caption="Search through the descriptions too">
205# <i>emerge --searchdesc mozilla</i>
206Searching...
207[ Results for search key : mozilla ]
208[ Applications found : 10 ]
209<comment>(Some output removed to improve readability)</comment>
210* dev-libs/nss-3.8
211 Latest version available: 3.8
212 Latest version installed: 3.8
213 Size of downloaded files: 2,782 kB
214 Homepage: http://www.mozilla.org/projects/security/pki/nss/
215 Description: Mozilla's Netscape Security Services Library that implements PKI support
216</pre>
217
218<p>
219As you can see, the output of <c>emerge</c> informs you about the category and
220name of the package, the available version, the currently installed version,
221the size of the downloaded files, the homepage and the small description.
222</p>
223
224<p>
225You see something new? Yes, <e>downloaded files</e>. When you tell Portage to
226install a package, it of course needs to have the necessary sources (or
227precompiled packages) available. It therefor checks the contents of
228<path>/usr/portage/distfiles</path> (for sourcecode) or
229<path>/usr/portage/packages/All</path> (for precompiled packages) to see if the
230necessary files are already available. If not, it downloads the necessary files
231and places them in those directories.
232</p>
233
234<note>
235Searching the Portage Tree, especially when using <c>--searchdesc</c>, is very
236time consuming. There are other, more performant tools available. We will
237describe those in the chapter on <uri link="?part=2&amp;chap=7">Gentoolkit and
238Other Tools</uri>.
239</note>
240
241</body>
242</subsection>
243<subsection>
244<title>Viewing the ChangeLog</title>
245<body>
246
247<p>
248While browsing through the Portage Tree, you saw that there was a ChangeLog for
249each package. You can view this ChangeLog with <c>emerge</c> too. Use the
250<c>--pretend --changelog</c> (<c>-pl</c> in short) options. As an example we
251will view the ChangeLog entries for <c>gnumeric</c>:
252</p>
253
254<pre caption="Viewing the ChangeLog entries for gnumeric">
255# <i>emerge --pretend --changelog gnumeric</i>
256</pre>
257
258</body>
259</subsection>
260</section> 41</section>
261<section> 42<section>
262<title>Updating Portage</title> 43<title>The Portage Tree</title>
263<subsection>
264<title>Introduction</title>
265<body>
266
267<p>
268Searching through Portage is nice, but if you don't update your Portage Tree
269regularly, you will be stuck with the packages and versions available on your
270system. This means that your system will get outdated pretty soon, and that
271packages with possible security problems will remain on your system.
272</p>
273
274<p>
275There are several ways to update your Portage Tree. The most popular method is
276by using one of our <uri link="/main/en/mirrors.xml">rsync mirrors</uri>.
277Another one is by using a Portage snapshot (in case a firewall or unavailability
278of a network prohibits the use of the rsync server).
279</p>
280
281</body>
282</subsection> 44<subsection>
45<title>Ebuilds</title>
46<body>
47
48<p>
49When we talk about packages, we often mean software titles that are available to
50the Gentoo users through the Portage tree. The Portage tree is a collection of
51<e>ebuilds</e>, files that contain all information Portage needs to maintain
52software (install, search, query, ...). These ebuilds reside in
53<path>/usr/portage</path> by default.
54</p>
55
56<p>
57Whenever you ask Portage to perform some action regarding software titles, it
58will use the ebuilds on your system as a base. It is therefore important that
59you regularly update the ebuilds on your system so Portage knows about new
60software, security updates, etc.
61</p>
62
63</body>
283<subsection> 64</subsection>
284<title>Selecting a Mirror for rsync</title>
285<body>
286
287<p>
288It is adviseable to first select a fast <uri
289link="/main/en/mirrors.xml">mirror</uri> close to you. You can do this manually
290(by setting the <c>SYNC</c> variable in <path>/etc/make.conf</path>) or use
291<c>mirrorselect</c> to do this for you automatically. As the <c>SYNC</c>
292variable will be discussed later on, we will focus on using <c>mirrorselect</c>.
293First install <c>mirrorselect</c> by emerging it:
294</p>
295
296<pre caption="Installing mirrorselect">
297# <i>emerge --usepkg mirrorselect</i>
298</pre>
299
300<p>
301Now run <c>mirrorselect</c> to automatically select mirrors for you (it will
302also setup Portage to use a mirror for the sourcecode):
303</p>
304
305<pre caption="Running mirrorselect">
306# <i>mirrorselect -a -s3</i>
307</pre>
308
309</body>
310</subsection> 65<subsection>
311<subsection>
312<title>Updating Portage</title> 66<title>Updating the Portage Tree</title>
313<body> 67<body>
314 68
315<p>
316To update Portage using rsync, simply run <c>emerge sync</c>:
317</p> 69<p>
70The Portage tree is usually updated with <uri
71link="http://rsync.samba.org/">rsync</uri>, a fast incremental file transfer
72utility. Updating is fairly simple as the <c>emerge</c> command provides a
73front-end for rsync:
74</p>
318 75
319<pre caption="Updating Portage using emerge sync"> 76<pre caption="Updating the Portage tree">
320# <i>emerge sync</i> 77# <i>emerge --sync</i>
321</pre> 78</pre>
322 79
323<p>
324If this fails (due to network problems, or a firewall), you can try using
325<c>emerge-webrsync</c> which will download a Portage Tree snapshot using
326<c>wget</c>. This also means that you can use proxies if you want. We discussed
327how to setup your system to use proxies during the Gentoo installation.
328</p> 80<p>
81If you are unable to rsync due to firewall restrictions you can still update
82your Portage tree by using our daily generated Portage tree snapshots. The
83<c>emerge-webrsync</c> tool automatically fetches and installs the latest
84snapshot on your system:
85</p>
329 86
330<pre caption="Updating Portage using emerge-webrsync"> 87<pre caption="Running emerge-webrsync">
331# <i>emerge-webrsync</i> 88# <i>emerge-webrsync</i>
332</pre> 89</pre>
333 90
334</body> 91</body>
335</subsection> 92</subsection>
336</section> 93</section>
337<section> 94<section>
338<title>Maintaining Software</title> 95<title>Maintaining Software</title>
339<subsection> 96<subsection>
340<title>Building or Prebuild?</title> 97<title>Searching for Software</title>
341<body>
342
343<p>
344Gentoo provides ebuilds, the Gentoo packages if you like. But when you want to
345install such an ebuild, you can choose between <e>building</e> the package, or
346using a <e>prebuild</e> package. But what are the advantages/disadvantages of
347both approaches, and can they be used next to each other?
348</p>
349
350<p>
351As you probably have guessed, building packages takes a lot of time (especially
352if you have little resources or want to build big packages, such as <uri
353link="http://www.kde.org">KDE</uri>, <uri
354link="http://www.openoffice.org">OpenOffice.org</uri>, etc.). By building the
355package, you can use the <c>USE</c> setting to tweak the package to your system.
356Of course, you can also define high optimization options (in the <c>CFLAGS</c>
357and <c>CXXFLAGS</c> variables) to compile the package with.
358</p>
359
360<p>
361Using prebuild packages improves the installation time (as no more compilation
362is needed), but you will lose the advantages of the <c>USE</c> setting and the
363<c>CFLAGS</c> &amp; <c>CXXFLAGS</c> variables.
364</p>
365
366<p>
367As previously stated, prebuild packages are stored in the
368<path>/usr/portage/packages/All</path> directory, while the sourcecode of the
369packages are placed in <path>/usr/portage/distfiles</path>. If you have finished
370installing a package you can remove the package or sourcecode from the
371respective directory. However, you might want to keep the package/sourcecode of
372the latest version, just in case you want to reinstall the package (so you don't
373have to redownload it).
374</p>
375
376</body> 98<body>
377</subsection> 99
100<p>
101To search through the Portage tree after software titles, you can use
102<c>emerge</c> built-in search capabilities. By default, <c>emerge --search</c>
103returns the names of packages whose title matches (either fully or partially)
104the given search term.
105</p>
106
107<p>
108For instance, to search for all packages who have "pdf" in their name:
109</p>
110
111<pre caption="Searching for pdf-named packages">
112$ <i>emerge --search pdf</i>
113</pre>
114
115<p>
116If you want to search through the descriptions as well you can use the
117<c>--searchdesc</c> (or <c>-S</c>) switch:
118</p>
119
120<pre caption="Searching for pdf-related packages">
121$ <i>emerge --searchdesc pdf</i>
122</pre>
123
124<p>
125When you take a look at the output, you'll notice that it gives you a lot of
126information. The fields are clearly labelled so we won't go further into their
127meanings:
128</p>
129
130<pre caption="Example 'emerge --search' output">
131* net-print/cups-pdf
132 Latest version available: 1.5.2
133 Latest version installed: [ Not Installed ]
134 Size of downloaded files: 15 kB
135 Homepage: http://cip.physik.uni-wuerzburg.de/~vrbehr/cups-pdf/
136 Description: Provides a virtual printer for CUPS to produce PDF files.
137 License: GPL-2
138</pre>
139
140</body>
378<subsection> 141</subsection>
142<subsection>
379<title>Installing Software from Sources</title> 143<title>Installing Software</title>
380<body> 144<body>
381 145
382<p> 146<p>
383Okay, enough talking, let's cut to the chase. To install a package, you will use 147Once you've found a software title to your liking, you can easily install it
384the <c>emerge</c> command. If you don't want to use any prebuild packages, you 148with <c>emerge</c>: just add the package name. For instance, to install
385can just use <c>emerge &lt;package-name&gt;</c> or <c>emerge
386&lt;category&gt;/&lt;package-name&gt;</c>. As an example we'll install
387<c>gnumeric</c>: 149<c>gnumeric</c>:
388</p> 150</p>
389 151
390<pre caption="Building gnumeric"> 152<pre caption="Installing gnumeric">
391# <i>emerge gnumeric</i> 153# <i>emerge gnumeric</i>
392</pre> 154</pre>
393 155
394<p> 156<p>
395This will download the sourcecode for you and unpacks, compiles and installs the 157Since many applications depend on each other, any attempt to install a certain
396package on your system. It will also do the same for all the dependencies. If 158software package might result in the installation of several dependencies as
397you want to see what dependencies will be installed with it, use the 159well. Don't worry, Portage handles dependencies well. If you want to find out
398<c>--pretend</c> option (<c>-p</c> in short): 160what Portage <e>would</e> install when you ask it to install a certain package,
161add the <c>--pretend</c> switch. For instance:
399</p> 162</p>
400 163
401<pre caption="Pretending to build gnumeric"> 164<pre caption="Pretend to install gnumeric">
402# <i>emerge --pretend gnumeric</i> 165# <i>emerge --pretend gnumeric</i>
403</pre> 166</pre>
404 167
405<p> 168<p>
406If you want to download the sourcecode of the package and its dependencies, 169When you ask Portage to install a package, it will download the necessary source
407but don't want to build the package, use the <c>--fetchonly</c> option 170code from the internet (if necessary) and store it by default in
408(<c>-f</c> in short): 171<path>/usr/portage/distfiles</path>. After this it will unpack, compile and
172install the package. If you want Portage to only download the sources without
173installing them, add the <c>--fetchonly</c> option to the <c>emerge</c> command:
409</p> 174</p>
410 175
411<pre caption="Fetching sources for gnumeric"> 176<pre caption="Download the sourcecode for gnumeric">
412# <i>emerge --fetchonly gnumeric</i> 177# <i>emerge --fetchonly gnumeric</i>
413</pre> 178</pre>
414 179
415<p>
416If you want to see where <c>emerge</c> downloads the sources from, combine the
417<c>--fetchonly</c> and <c>--pretend</c> options:
418</p>
419
420<pre caption="Showing URLs of the sources for gnumeric">
421# <i>emerge --fetchonly --pretend gnumeric</i>
422</pre>
423
424<p>
425You can also opt to install a specific version of a package.
426For instance, if you want to install a gnumeric version older than 1.2 -- for
427any reason whatsoever :) you would type:
428</p>
429
430<pre caption="Installing a specific gnumeric version">
431# <i>emerge "&lt;gnumeric-1.2"</i>
432</pre>
433
434<p>
435Other possibilities are of course "&gt;" (later version) and "=" (the exact
436version).
437</p>
438
439</body> 180</body>
440</subsection>
441<subsection> 181</subsection>
442<title>Installing Prebuild Packages</title> 182<subsection>
183<title>Finding Installed Package Documentation</title>
184<body>
185
186<p>
187Many packages come with their own documentation. Sometimes, the <c>doc</c> USE
188flag determines whether the package documentation should be installed or not.
189You can check the existence of a <c>doc</c> USE flag with the <c>emerge -vp
190&lt;package name&gt;</c> command.
191</p>
192
193<pre caption="Checking the existence of a doc USE flag">
194<comment>(alsa-lib is just an example, of course.)</comment>
195# <i>emerge -vp alsa-lib</i>
196[ebuild N ] media-libs/alsa-lib-1.0.9_rc3 +doc -jack 674 kB
197</pre>
198
199<p>
200You can enable or disable the <c>doc</c> USE flag either globally in the
201<path>/etc/make.conf</path> file or per package in the
202<path>/etc/portage/package.use</path> file. The <uri
203link="?part=2&amp;chap=2">USE Flags</uri> chapter covers this aspect in detail.
204</p>
205
206<p>
207Once the package installed, its documentation is generally found in a
208subdirectory named after the package under the <path>/usr/share/doc</path>
209directory. You can also list all installed files with the <c>equery</c> tool
210which is part of the <c>app-portage/gentoolkit</c> <uri
211link="/doc/en/gentoolkit.xml">package</uri>.
212</p>
213
214<pre caption="Locating package documentation">
215# <i>ls -l /usr/share/doc/alsa-lib-1.0.9_rc3</i>
216total 28
217-rw-r--r-- 1 root root 669 May 17 21:54 ChangeLog.gz
218-rw-r--r-- 1 root root 9373 May 17 21:54 COPYING.gz
219drwxr-xr-x 2 root root 8560 May 17 21:54 html
220-rw-r--r-- 1 root root 196 May 17 21:54 TODO.gz
221
222<comment>(Alternatively, use equery to locate interesting files:)</comment>
223# <i>equery files alsa-lib | less</i>
224media-libs/alsa-lib-1.0.9_rc3
225* Contents of media-libs/alsa-lib-1.0.9_rc3:
226/usr
227/usr/bin
228/usr/bin/alsalisp
229<comment>(Output truncated)</comment>
230</pre>
231
443<body> 232</body>
233</subsection>
234<subsection>
235<title>Removing Software</title>
236<body>
444 237
445<p>
446When you want to install a prebuild package, you should use the <c>--usepkg</c>
447option (<c>-k</c> in short). This will use the binary package available in
448<path>/usr/portage/packages/All</path> <e>if</e> the package and the version of
449the application you want to install match.
450</p> 238<p>
239When you want to remove a software package from your system, use <c>emerge
240--unmerge</c>. This will tell Portage to remove all files installed by that
241package from your system <e>except</e> the configuration files of that
242application if you have altered those after the installation. Leaving the
243configuration files allows you to continue working with the package if you ever
244decide to install it again.
245</p>
451 246
452<pre caption="Installing a prebuild package for gnumeric"> 247<p>
248However, a <brite>big warning</brite> applies: Portage will <e>not</e> check if
249the package you want to remove is required by another package. It will however
250warn you when you want to remove an important package that breaks your system
251if you unmerge it.
252</p>
253
254<pre caption="Removing gnumeric from the system">
453# <i>emerge --usepkg gnumeric</i> 255# <i>emerge --unmerge gnumeric</i>
454</pre> 256</pre>
455 257
456<p>
457If you want to use the binary package, even if the versions don't match, use
458<c>--usepkgonly</c> (<c>-K</c> in short).
459</p> 258<p>
460 259When you remove a package from your system, the dependencies of that package
461<pre caption="Installing the prebuild package for gnumeric"> 260that were installed automatically when you installed the software are left. To
462# <i>emerge --usepkgonly gnumeric</i> 261have Portage locate all dependencies that can now be removed, use
463</pre> 262<c>emerge</c>'s <c>--depclean</c> functionality. We will talk about this later
464 263on.
465<!-- TODO When handbook goes life, comment out this parts until the mirrors have
466 been updated with online GRP packages. -->
467<p> 264</p>
468If you don't have the prebuild package on your system yet, you can have
469<c>emerge</c> download it from a mirror, defined in the <c>PORTAGE_BINHOST</c>
470variable declared in <path>/etc/make.conf</path>.
471</p>
472
473<p>
474To download the binary package in case this package doesn't exist on
475your system already, use <c>--getbinpkg</c> (<c>-g</c> in short):
476</p>
477
478<pre caption="Downloading and installing a prebuild package for gnumeric">
479# <i>emerge --getbinpkg gnumeric</i>
480</pre>
481
482<p>
483This will download the package and the package-related information for you and
484install it on your system, together with the dependencies. If you want to see
485what dependencies will be installed with it, use the <c>--pretend</c> option
486(<c>-p</c> in short):
487</p>
488
489<pre caption="Pretending to download the prebuild packages for gnumeric">
490# <i>emerge --ginbinpkg --pretend gnumeric</i>
491</pre>
492
493<p>
494You can also opt to download the prebuild package (and the package-related
495information) <e>without</e> checking the information on your local system and
496<e>without</e> using the prebuild package already on your system (if
497applicable), use the <c>--getbinpkgonly</c> option (<c>-G</c> in short):
498</p>
499
500<pre caption="Installing a prebuild package without using local information">
501# <i>emerge --getbinpkgonly gnumeric</i>
502</pre>
503
504<!-- TODO Up until here -->
505
506<p>
507You can also opt to install a specific version of a package.
508For instance, if you want to install a gnumeric version older than 1.2 -- for
509any reason whatsoever :) you would type:
510</p>
511
512<pre caption="Installing a specific gnumeric version">
513# <i>emerge --usepkg "&lt;gnumeric-1.2"</i>
514</pre>
515
516<p>
517Other possibilities are of course "&gt;" (later version) and "=" (the exact
518version).
519</p>
520
521 265
522</body> 266</body>
523</subsection> 267</subsection>
524<subsection> 268<subsection>
525<title>Updating your System</title> 269<title>Updating your System</title>
526<body> 270<body>
527 271
528<p> 272<p>
529Portage knows two special tags to denote a set of software packages: 273To keep your system in perfect shape (and not to mention install the latest
530<e>system</e> and <e>world</e>. You have already seen the former while 274security updates) you need to update your system regularly. Since Portage only
531installing Gentoo if you didn't use a <e>stage3</e> installation. To refresh 275checks the ebuilds in your Portage tree you first have to update your Portage
532things: <e>system</e> is the collection of <e>core</e> packages, necessary to 276tree. When your Portage tree is updated, you can update your system with
533have a working Gentoo system. 277<c>emerge --update world</c>:
534</p>
535
536<p> 278</p>
537The <e>world</e> tag consists of all software you have installed yourself on 279
538your system plus the <e>system</e> information. In other words, every time you 280<pre caption="Updating your system">
539emerge a package using <c>emerge &lt;package-name&gt;</c>, the 281# <i>emerge --update world</i>
540<c>&lt;package-name&gt;</c> is registered in the <e>world</e> file 282</pre>
541(<path>/var/cache/edb/world</path>). Dependencies are <e>not</e> part of the 283
542<e>world</e> file, but we will get to that later.
543</p> 284<p>
544 285Portage will then search for newer version of the applications you have
545<p> 286installed. However, it will only verify the versions for the applications you
546If you want to update the system packages, use the <c>--update</c> option 287have explicitly installed - not the dependencies. If you want to update every
547(<c>-u</c> in short): 288single package on your system, add the <c>--deep</c> argument:
548</p>
549
550<pre caption="Updating the system packages">
551# <i>emerge --update system</i>
552</pre>
553
554<p>
555An identical approach can be used for the world packages:
556</p> 289</p>
557 290
558<pre caption="Updating your entire system"> 291<pre caption="Updating your entire system">
559# <i>emerge --update world</i> 292# <i>emerge --update --deep world</i>
560</pre> 293</pre>
561 294
562<p>
563Again, if you want to see what <c>emerge</c> wants to update, use the
564<c>--pretend</c> option together with the <c>--update</c> option:
565</p> 295<p>
566 296Since security updates also happen in packages you have not explicitly installed
567<pre caption="Pretending to update your entire system"> 297on your system (but that are pulled in as dependencies of other programs), it
568# <i>emerge --pretend --update world</i> 298is recommended to run this command once in a while.
569<comment>(Some output removed to improve readability)</comment>
570[ebuild U ] net-misc/wget-1.9-r1 [1.9]
571[ebuild UD] media-video/dvdauthor-0.5.0 [0.5.3]
572[ebuild U ] net-analyzer/ethereal-0.9.16 [0.9.14]
573</pre>
574
575<p> 299</p>
576Right next to the word "ebuild" you will notice a letter (or combination of 300
577letters) which gives you more information about the package: 301<p>
302If you have altered any of your <uri link="?part=2&amp;chap=2">USE flags</uri>
303lately you might want to add <c>--newuse</c> as well. Portage will then verify
304if the change requires the installation of new packages or recompilation of
305existing ones:
306</p>
307
308<pre caption="Performing a full update">
309# <i>emerge --update --deep --newuse world</i>
310</pre>
311
312</body>
313</subsection>
314<subsection>
315<title>Metapackages</title>
316<body>
317
318<p>
319Some packages in the Portage tree don't have any real content but are used to
320install a collection of packages. For instance, the <c>kde</c> package will
321install a complete KDE environment on your system by pulling in various
322KDE-related packages as dependencies.
323</p>
324
325<p>
326If you ever want to remove such a package from your system, running <c>emerge
327--unmerge</c> on the package won't have much effect as the dependencies remain
328on the system.
329</p>
330
331<p>
332Portage has the functionality to remove orphaned dependencies as well, but since
333the availability of software is dynamically dependent you first need to update
334your entire system fully, including the new changes you applied when changing
335USE flags. After this you can run <c>emerge --depclean</c> to remove the
336orphaned dependencies. When this is done, you need to rebuild the applications
337that were dynamically linked to the now-removed software titles but don't
338require them anymore.
339</p>
340
341<p>
342All this is handled with the following three commands:
343</p>
344
345<pre caption="Removing orphaned dependencies">
346# <i>emerge --update --deep --newuse world</i>
347# <i>emerge --depclean</i>
348# <i>revdep-rebuild</i>
349</pre>
350
351<p>
352<c>revdep-rebuild</c> is provided by the <c>gentoolkit</c> package; don't forget
353to emerge it first:
354</p>
355
356<pre caption="Installing the gentoolkit package">
357# <i>emerge gentoolkit</i>
358</pre>
359
360</body>
361</subsection>
362</section>
363<section>
364<title>When Portage is Complaining...</title>
365<subsection>
366<title>About SLOTs, Virtuals, Branches, Architectures and Profiles</title>
367<body>
368
369<p>
370As we stated before, Portage is extremely powerful and supports many features
371that other software management tools lack. To understand this, we explain a few
372aspects of Portage without going into too much detail.
373</p>
374
375<p>
376With Portage different versions of a single package can coexist on a system.
377While other distributions tend to name their package to those versions (like
378<c>freetype</c> and <c>freetype2</c>) Portage uses a technology called
379<e>SLOT</e>s. An ebuild declares a certain SLOT for its version. Ebuilds with
380different SLOTs can coexist on the same system. For instance, the
381<c>freetype</c> package has ebuilds with <c>SLOT="1"</c> and <c>SLOT="2"</c>.
382</p>
383
384<p>
385There are also packages that provide the same functionality but are implemented
386differently. For instance, <c>metalogd</c>, <c>sysklogd</c> and <c>syslog-ng</c>
387are all system loggers. Applications that rely on the availability of "a system
388logger" cannot depend on, for instance, <c>metalogd</c>, as the other system
389loggers are as good a choice as any. Portage allows for <e>virtuals</e>: each
390system logger provides <c>virtual/syslog</c> so that applications can depend on
391<c>virtual/syslog</c>.
392</p>
393
394<p>
395Software in the Portage tree can reside in different branches. By default your
396system only accepts packages that Gentoo deems stable. Most new software titles,
397when committed, are added to the testing branch, meaning more testing needs to
398be done before it is marked as stable. Although you will see the ebuilds for
399those software in the Portage tree, Portage will not update them before they are
400placed in the stable branch.
401</p>
402
403<p>
404Some software is only available for a few architectures. Or the software doesn't
405work on the other architectures, or it needs more testing, or the developer that
406committed the software to the Portage tree is unable to verify if the package
407works on different architectures.
408</p>
409
410<p>
411Each Gentoo installation adheres to a certain <c>profile</c> which contains,
412amongst other information, the list of packages that are required for a system
413to function normally.
414</p>
415
416</body>
417</subsection>
418<subsection id="blocked">
419<title>Blocked Packages</title>
420<body>
421
422<pre caption="Portage warning about blocked packages (with --pretend)">
423[blocks B ] gnome-base/bonobo-activation (from pkg gnome-base/libbonobo-2.4.0)
424</pre>
425
426<pre caption="Portage warning about blocked packages (without --pretend)">
427!!! Error: the gnome-base/bonobo-activation package conflicts with another package.
428!!! both can't be installed on the same system together.
429!!! Please use 'emerge --pretend' to determine blockers.
430</pre>
431
432<p>
433Ebuilds contain specific fields that inform Portage about its dependencies.
434There are two possible dependencies: build dependencies, declared in
435<c>DEPEND</c> and run-time dependencies, declared in <c>RDEPEND</c>. When one of
436these dependencies explicitly marks a package or virtual as being <e>not</e>
437compatible, it triggers a blockage.
438</p>
439
440<p>
441To fix a blockage, you can choose to not install the package or unmerge the
442conflicting package first. In the given example, you can opt not to install
443<c>libbonobo</c> or to remove <c>bonobo-activation</c> first.
444</p>
445
446</body>
447</subsection>
448<subsection id="masked">
449<title>Masked Packages</title>
450<body>
451
452<pre caption="Portage warning about masked packages">
453!!! all ebuilds that could satisfy "bootsplash" have been masked.
454</pre>
455
456<pre caption="Portage warning about masked packages - reason">
457!!! possible candidates are:
458
459- gnome-base/gnome-2.8.0_pre1 (masked by: <i>~x86 keyword</i>)
460- lm-sensors/lm-sensors-2.8.7 (masked by: <i>-sparc keyword</i>)
461- sys-libs/glibc-2.3.4.20040808 (masked by: <i>-* keyword</i>)
462- dev-util/cvsd-1.0.2 (masked by: <i>missing keyword</i>)
463- media-video/ati-gatos-4.3.0 (masked by: <i>package.mask</i>)
464- sys-libs/glibc-2.3.2-r11 (masked by: <i>profile</i>)
465</pre>
466
467<p>
468When you want to install a package that isn't available for your system, you
469will receive this masking error. You should try installing a different
470application that is available for your system or wait until the package is put
471available. There is always a reason why a package is masked:
578</p> 472</p>
579 473
580<ul> 474<ul>
581 <li> 475 <li>
582 <e>B</e> (blocks) The package listed to the left is blocking the emerge of 476 <b>~arch keyword</b> means that the application is not tested sufficiently
583 the package listed to the right 477 to be put in the stable branch. Wait a few days or weeks and try again.
584 </li> 478 </li>
585 <li> 479 <li>
586 <e>N</e> (new) The package is new to your system and will be emerged for the 480 <b>-arch keyword</b> or <b>-* keyword</b> means that the application does
587 first time 481 not work on your architecture. If you believe the package does work file
482 a bug at our <uri link="http://bugs.gentoo.org">bugzilla</uri> website.
588 </li> 483 </li>
589 <li> 484 <li>
590 <e>R</e> (reemerge) The package isn't new, but needs to be reemerged 485 <b>missing keyword</b> means that the application has not been tested on
486 your architecture yet. Ask the architecture porting team to test the package
487 or test it for them and report your findings on our <uri
488 link="http://bugs.gentoo.org">bugzilla</uri> website.
591 </li> 489 </li>
592 <li> 490 <li>
593 <e>F</e> (fetch) The package requires that you download the sourcecode 491 <b>package.mask</b> means that the package has been found corrupt, unstable
594 manually (for instance due to licencing issues) 492 or worse and has been deliberately marked as do-not-use.
595 </li> 493 </li>
596 <li> 494 <li>
597 <e>U</e> (update) The package already exists on your system but will be 495 <b>profile</b> means that the package has been found not suitable for your
598 upgraded 496 profile. The application might break your system if you installed it or is
599 </li> 497 just not compatible with the profile you use.
600 <li>
601 <e>UD</e> (downgrade) The package already exists on your system but will be
602 downgraded
603 </li>
604 <li>
605 <e>U-</e> (slot warning) The package you have installed on your system
606 is listed as a package that can not coexist with a different version, but
607 your update does. The update will be installed and the older version will be
608 removed.
609 </li> 498 </li>
610</ul> 499</ul>
611 500
612<p>
613In certain cases, an update may mean a downgrade (i.e. install an older version
614instead of a newer version). If you don't want this to happen, use the
615<c>--upgradeonly</c> option (<c>-U</c> in short):
616</p>
617
618<pre caption="Upgrading your entire system">
619# <i>emerge --update --upgradeonly world</i>
620</pre>
621
622<p>
623Of course, we are talking here about <e>system</e> and <e>world</e>, but you can
624perform the same actions for individual software packages.
625</p>
626
627</body> 501</body>
628</subsection>
629<subsection> 502</subsection>
630<title>Removing Software</title> 503<subsection id="missingdependencies">
631<body> 504<title>Missing Dependencies</title>
632
633<p>
634If you want to remove software from your system, you can use the <c>unmerge</c>
635option (<c>-C</c> - capital C - in short):
636</p>
637
638<pre caption="Uninstalling software">
639# <i>emerge unmerge gnumeric</i>
640</pre>
641
642<p>
643If you want to test a removal (but not perform it), you can use <c>--pretend</c>
644again:
645</p>
646
647<pre caption="Pretending to uninstall software">
648# <i>emerge --pretend unmerge gnumeric</i>
649</pre>
650
651<warn>
652Portage doesn't verify if a package is a dependency for another
653installed package. It also doesn't warn you if the package is part of
654<e>system</e>, i.e. a core application necessary for the correct functioning of
655your system!
656</warn>
657
658</body> 505<body>
659</subsection> 506
660</section> 507<pre caption="Portage warning about missing dependency">
661<section> 508emerge: there are no ebuilds to satisfy "&gt;=sys-devel/gcc-3.4.2-r4".
662<title>Software Availability</title> 509
510!!! Problem with ebuild sys-devel/gcc-3.4.2-r2
511!!! Possibly a DEPEND/*DEPEND problem.
512</pre>
513
514<p>
515The application you are trying to install depends on another package that is not
516available for your system. Please check <uri
517link="http://bugs.gentoo.org">bugzilla</uri> if the issue is known and if not,
518please report it. Unless you are mixing branches this should not occur and is
519therefore a bug.
520</p>
521
522</body>
663<subsection> 523</subsection>
664<title>ARCH or not?</title> 524<subsection id="ambiguousebuild">
665<body> 525<title>Ambiguous Ebuild Name</title>
666
667<p>
668Gentoo places its packages in two possible stadia called <e>ARCH</e> and
669<e>~ARCH</e>. Don't take this literally: the stadia depend on the architecture
670you are using. In other words, for x86-based systems you have <e>x86</e> and
671<e>~x86</e>, for ppc-based systems you have <e>ppc</e> and <e>~ppc</e> etc.
672</p>
673
674<p>
675The <e>~ARCH</e> stadium means that the package works for the developer in
676charge of the package, but that the package hasn't been tested thoroughly enough
677by the community to be placed in <e>ARCH</e>. <e>~ARCH</e> packages usually go
678to <e>ARCH</e> after being bugfree for a sufficient amount of time.
679</p>
680
681<p>
682Your system will use <e>ARCH</e> packages per default. If you want to live on
683the edge, don't mind having a broken package once in a while, and you like
684submitting bugreports to <uri
685link="http://bugs.gentoo.org">bugs.gentoo.org</uri>, then you can opt to use
686<e>~ARCH</e> packages. To "move" your system to a <e>~ARCH</e>-using system,
687edit the <c>ACCEPT_KEYWORDS</c> variable in <path>/etc/make.conf</path> so that
688it reads <e>~ARCH</e> (again: for x86-based systems: <e>~x86</e>, etc.).
689</p>
690
691<p>
692If you want to update your system now, you will notice that <e>a lot</e> of
693packages will be updated!
694</p>
695
696</body> 526<body>
697</subsection> 527
528<pre caption="Portage warning about ambiguous ebuild names">
529!!! The short ebuild name "aterm" is ambiguous. Please specify
530!!! one of the following fully-qualified ebuild names instead:
531
532 dev-libs/aterm
533 x11-terms/aterm
534</pre>
535
536<p>
537The application you want to install has a name that corresponds with more than
538one package. You need to supply the category name as well. Portage will inform
539you of possible matches to choose from.
540</p>
541
542</body>
698<subsection> 543</subsection>
699<title>Masked Packages</title> 544<subsection id="circulardependencies">
700<body> 545<title>Circular Dependencies</title>
701
702<p>
703When you want to install a package, you might come across the following message:
704</p>
705
706<pre caption="Message about masked packages">
707Calculating dependencies
708!!! <comment>all ebuilds that could satisfy </comment>&lt;your package&gt;<comment> have been masked.</comment>
709</pre>
710
711<p>
712A package can be masked due to two reasons:
713</p>
714
715<ol>
716 <li>The package is in <e>~ARCH</e> while you use <e>ARCH</e></li>
717 <li>The package is hard-masked explicitly</li>
718</ol>
719
720<p>
721If the package is masked because of the first reason, and you <e>really</e> want
722to install it (knowing that there <e>is</e> a reason why it isn't available in
723<e>ARCH</e>), you can temporarily accept <e>~ARCH</e> packages:
724</p>
725
726<pre caption="Temporarily accepting ~ARCH packages">
727# <i>ACCEPT_KEYWORDS="~x86" emerge gnumeric</i>
728</pre>
729
730<p>
731A package is hardmasked if it is listed in
732<path>/usr/portage/profiles/package.mask</path>. If you read this file, you
733will also read the reason why the package is hardmasked (it is usually added as
734a comment). If you want to install the package nevertheless (despite all the
735possible warnings we could ever throw at your head about "breaking your system",
736"breaks other packages", or "badly needs testing"), create the
737<path>/etc/portage/package.unmask</path> file and list the package in it (use
738the same format as is used in <path>/usr/portage/profiles/package.mask</path>).
739</p>
740
741<p>
742Do <e>not</e> alter the <path>/usr/portage/profiles/package.mask</path> file as
743all changes are undone the next time you update your Portage tree.
744</p>
745
746<p>
747Another trick to circumvent the "masked package" problem is to install the
748package using the full path. This will ignore both the <c>ACCEPT_KEYWORD</c>
749settings and the <path>package.mask</path> listing.
750</p>
751
752<pre caption="Installing a package without checking for stadium / masking">
753# <i>emerge /usr/portage/app-office/gnumeric/gnumeric-1.2.0.ebuild</i>
754</pre>
755
756</body> 546<body>
757</subsection> 547
548<pre caption="Portage warning about circular dependencies">
549!!! Error: circular dependencies:
550
551ebuild / net-print/cups-1.1.15-r2 depends on ebuild / app-text/ghostscript-7.05.3-r1
552ebuild / app-text/ghostscript-7.05.3-r1 depends on ebuild / net-print/cups-1.1.15-r2
553</pre>
554
555<p>
556Two (or more) packages you want to install depend on each other and can
557therefore not be installed. This is most likely a bug in the Portage tree.
558Please resync after a while and try again. You can also check <uri
559link="http://bugs.gentoo.org">bugzilla</uri> if the issue is known and if not,
560report it.
561</p>
562
563</body>
758<subsection> 564</subsection>
759<title>Blocked Packages</title> 565<subsection id="fetchfailed">
566<title>Fetch failed</title>
567<body>
568
569<pre caption="Portage warning about fetch failed">
570!!! Fetch failed for sys-libs/ncurses-5.4-r5, continuing...
571<comment>(...)</comment>
572!!! Some fetch errors were encountered. Please see above for details.
573</pre>
574
575<p>
576Portage was unable to download the sources for the given application and will
577try to continue installing the other applications (if applicable). This failure
578can be due to a mirror that has not synchronised correctly or because the ebuild
579points to an incorrect location. The server where the sources reside can also be
580down for some reason.
581</p>
582
583<p>
584Retry after one hour to see if the issue still persists.
585</p>
586
760<body> 587</body>
588</subsection>
589<subsection id="profileprotect">
590<title>System Profile Protection</title>
591<body>
761 592
762<p> 593<pre caption="Portage warning about profile-protected package">
763You have a situation when you receive the following error on your screen: 594!!! Trying to unmerge package(s) in system profile. 'sys-apps/portage'
595!!! This could be damaging to your system.
596</pre>
597
764</p> 598<p>
765 599You have asked to remove a package that is part of your system's core packages.
766<pre caption="Blocking package"> 600It is listed in your profile as required and should therefore not be removed
767[blocks B ] gnome-base/bonobo-activation (from pkg gnome-base/libbonobo-2.4.0) 601from the system.
768</pre>
769
770<p> 602</p>
771In the above example, the package <c>bonobo-activation</c> is blocking the
772emerge of <c>libbonobo</c>. To resolve this issue, remove the
773<c>bonobo-activation</c> package and continue:
774</p>
775
776<pre caption="Resolving a blocking situation">
777# <i>emerge unmerge bonobo-activation</i>
778</pre>
779 603
780</body> 604</body>
781</subsection> 605</subsection>
782</section> 606</section>
783</sections> 607</sections>

Legend:
Removed from v.1.4  
changed lines
  Added in v.1.54

  ViewVC Help
Powered by ViewVC 1.1.20