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

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

Parent Directory | Revision Log | View Patch Patch

Revision 1.54		Revision 1.77
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.54 2005/06/11 12:16:14 swift Exp $ -->	7	<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/handbook/hb-working-portage.xml,v 1.77 2011/10/13 16:58:14 swift Exp $ -->
8		8
9	<sections>	9	<sections>
10		10
		11	<abstract>
		12	This chapter explains the "simple" steps a user definitely needs to know to
		13	maintain the software on his system.
		14	</abstract>
		15
11	<version>1.49</version>	16	<version>3</version>
12	<date>2005-06-11</date>	17	<date>2011-08-12</date>
13		18
14	<section>	19	<section>
15	<title>Welcome to Portage</title>	20	<title>Welcome to Portage</title>
16	<body>	21	<body>
17		22
…		…
191	</p>	196	</p>
192		197
193	<pre caption="Checking the existence of a doc USE flag">	198	<pre caption="Checking the existence of a doc USE flag">
194	<comment>(alsa-lib is just an example, of course.)</comment>	199	<comment>(alsa-lib is just an example, of course.)</comment>
195	# <i>emerge -vp alsa-lib</i>	200	# <i>emerge -vp alsa-lib</i>
196	[ebuild N ] media-libs/alsa-lib-1.0.9_rc3 +doc -jack 674 kB	201	[ebuild N ] media-libs/alsa-lib-1.0.14_rc1 -debug +doc 698 kB
197	</pre>	202	</pre>
198		203
199	<p>	204	<p>
200	You can enable or disable the <c>doc</c> USE flag either globally in the	205	The best way of enabling the <c>doc</c> USE flag is doing it on a per-package
201	<path>/etc/make.conf</path> file or per package in the	206	basis via <path>/etc/portage/package.use</path>, so that you get documentation
202	<path>/etc/portage/package.use</path> file. The <uri	207	only for packages that you are interested in. Enabling this flag globally is
203	link="?part=2&chap=2">USE Flags</uri> chapter covers this aspect in detail.	208	known to cause problems with circular dependencies. For more information, please
		209	read the <uri link="?part=2&chap=2">USE Flags</uri> chapter.
204	</p>	210	</p>
205		211
206	<p>	212	<p>
207	Once the package installed, its documentation is generally found in a	213	Once the package installed, its documentation is generally found in a
208	subdirectory named after the package under the <path>/usr/share/doc</path>	214	subdirectory named after the package under the <path>/usr/share/doc</path>
…		…
210	which is part of the <c>app-portage/gentoolkit</c> <uri	216	which is part of the <c>app-portage/gentoolkit</c> <uri
211	link="/doc/en/gentoolkit.xml">package</uri>.	217	link="/doc/en/gentoolkit.xml">package</uri>.
212	</p>	218	</p>
213		219
214	<pre caption="Locating package documentation">	220	<pre caption="Locating package documentation">
215	# <i>ls -l /usr/share/doc/alsa-lib-1.0.9_rc3</i>	221	# <i>ls -l /usr/share/doc/alsa-lib-1.0.14_rc1</i>
216	total 28	222	total 28
217	-rw-r--r-- 1 root root 669 May 17 21:54 ChangeLog.gz	223	-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	224	-rw-r--r-- 1 root root 9373 May 17 21:54 COPYING.gz
219	drwxr-xr-x 2 root root 8560 May 17 21:54 html	225	drwxr-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	226	-rw-r--r-- 1 root root 196 May 17 21:54 TODO.gz
221		227
222	<comment>(Alternatively, use equery to locate interesting files:)</comment>	228	<comment>(Alternatively, use equery to locate interesting files:)</comment>
223	# <i>equery files alsa-lib \| less</i>	229	# <i>equery files alsa-lib \| less</i>
224	media-libs/alsa-lib-1.0.9_rc3	230	media-libs/alsa-lib-1.0.14_rc1
225	* Contents of media-libs/alsa-lib-1.0.9_rc3:	231	* Contents of media-libs/alsa-lib-1.0.14_rc1:
226	/usr	232	/usr
227	/usr/bin	233	/usr/bin
228	/usr/bin/alsalisp	234	/usr/bin/alsalisp
229	<comment>(Output truncated)</comment>	235	<comment>(Output truncated)</comment>
230	</pre>	236	</pre>
…		…
272	<p>	278	<p>
273	To keep your system in perfect shape (and not to mention install the latest	279	To keep your system in perfect shape (and not to mention install the latest
274	security updates) you need to update your system regularly. Since Portage only	280	security updates) you need to update your system regularly. Since Portage only
275	checks the ebuilds in your Portage tree you first have to update your Portage	281	checks the ebuilds in your Portage tree you first have to update your Portage
276	tree. When your Portage tree is updated, you can update your system with	282	tree. When your Portage tree is updated, you can update your system with
277	<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
		285	wants to upgrade and ask you if you want to continue:
278	</p>	286	</p>
279		287
280	<pre caption="Updating your system">	288	<pre caption="Updating your system">
281	# <i>emerge --update world</i>	289	# <i>emerge --update --ask world</i>
282	</pre>	290	</pre>
283		291
284	<p>	292	<p>
285	Portage will then search for newer version of the applications you have	293	Portage will then search for newer version of the applications you have
286	installed. However, it will only verify the versions for the applications you	294	installed. However, it will only verify the versions for the applications you
287	have explicitly installed - not the dependencies. If you want to update every	295	have <e>explicitly</e> installed (the applications listed in
288	single package on your system, add the <c>--deep</c> argument:	296	<path>/var/lib/portage/world</path>) - it does not thoroughly check their
		297	dependencies. If you want to update the dependencies of those packages as well,
		298	add the <c>--deep</c> argument:
		299	</p>
		300
		301	<pre caption="Updating your system with dependencies">
		302	# <i>emerge --update --deep world</i>
		303	</pre>
		304
		305	<p>
		306	Still, this doesn't mean <e>all packages</e>: some packages on your system are
		307	needed during the compile and build process of packages, but once that package
		308	is installed, these dependencies are no longer required. Portage calls those
		309	<e>build dependencies</e>. To include those in an update cycle, add
		310	<c>--with-bdeps=y</c>:
289	</p>	311	</p>
290		312
291	<pre caption="Updating your entire system">	313	<pre caption="Updating your entire system">
292	# <i>emerge --update --deep world</i>	314	# <i>emerge --update --deep --with-bdeps=y world</i>
293	</pre>	315	</pre>
294		316
295	<p>	317	<p>
296	Since security updates also happen in packages you have not explicitly installed	318	Since security updates also happen in packages you have not explicitly installed
297	on your system (but that are pulled in as dependencies of other programs), it	319	on your system (but that are pulled in as dependencies of other programs), it
…		…
304	if the change requires the installation of new packages or recompilation of	326	if the change requires the installation of new packages or recompilation of
305	existing ones:	327	existing ones:
306	</p>	328	</p>
307		329
308	<pre caption="Performing a full update">	330	<pre caption="Performing a full update">
309	# <i>emerge --update --deep --newuse world</i>	331	# <i>emerge --update --deep --with-bdeps=y --newuse world</i>
310	</pre>	332	</pre>
311		333
312	</body>	334	</body>
313	</subsection>	335	</subsection>
314	<subsection>	336	<subsection>
315	<title>Metapackages</title>	337	<title>Metapackages</title>
316	<body>	338	<body>
317		339
318	<p>	340	<p>
319	Some packages in the Portage tree don't have any real content but are used to	341	Some packages in the Portage tree don't have any real content but are used to
320	install a collection of packages. For instance, the <c>kde</c> package will	342	install a collection of packages. For instance, the <c>kde-meta</c> package will
321	install a complete KDE environment on your system by pulling in various	343	install a complete KDE environment on your system by pulling in various
322	KDE-related packages as dependencies.	344	KDE-related packages as dependencies.
323	</p>	345	</p>
324		346
325	<p>	347	<p>
…		…
358	</pre>	380	</pre>
359		381
360	</body>	382	</body>
361	</subsection>	383	</subsection>
362	</section>	384	</section>
		385	<section id="license">
		386	<title>Licenses</title>
		387	<subsection>
		388	<body>
		389
		390	<p>
		391	Beginning with Portage version 2.1.7, you can accept or reject software
		392	installation based on its license. All packages in the tree contain a
		393	<c>LICENSE</c> entry in their ebuilds. Running <c>emerge --search
		394	packagename</c> will tell you the package's license.
		395	</p>
		396
		397	<p>
		398	By default, Portage permits all licenses, except End User License Agreements
		399	(EULAs) that require reading and signing an acceptance agreement.
		400	</p>
		401
		402	<p>
		403	The variable that controls permitted licenses is <c>ACCEPT_LICENSE</c>, which
		404	can be set in <path>/etc/make.conf</path>:
		405	</p>
		406
		407	<pre caption="Default ACCEPT_LICENSE in /etc/make.conf">
		408	ACCEPT_LICENSE="* -@EULA"
		409	</pre>
		410
		411	<p>
		412	With this configuration, packages that require interaction during installation
		413	to approve their EULA <e>will not</e> be installed. Packages without an EULA
		414	<e>will</e> be installed.
		415	</p>
		416
		417	<p>
		418	You can set <c>ACCEPT_LICENSE</c> globally in <path>/etc/make.conf</path>, or
		419	you can specify it on a per-package basis in
		420	<path>/etc/portage/package.license</path>.
		421	</p>
		422
		423	<p>
		424	For example, if you want to allow the <c>truecrypt-2.7</c> license for
		425	<c>app-crypt/truecrypt</c>, add the following to
		426	<path>/etc/portage/package.license</path>:
		427	</p>
		428
		429	<pre caption="Specifying a truecrypt license in package.license">
		430	app-crypt/truecrypt truecrypt-2.7
		431	</pre>
		432
		433	<p>
		434	This permits installation of truecrypt versions that have the
		435	<c>truecrypt-2.7</c> license, but not versions with the <c>truecrypt-2.8</c>
		436	license.
		437	</p>
		438
		439	<impo>
		440	Licenses are stored in <path>/usr/portage/licenses</path>, and license groups
		441	are kept in <path>/usr/portage/profiles/license_groups</path>. The first entry
		442	of each line in CAPITAL letters is the name of the license group, and every
		443	entry after that is an individual license.
		444	</impo>
		445
		446	<p>
		447	License groups defined in <c>ACCEPT_LICENSE</c> are prefixed with an <b>@</b>
		448	sign. Here's an example of a system that globally permits the GPL-compatible
		449	license group, as well as a few other groups and individual licenses:
		450	</p>
		451
		452	<pre caption="ACCEPT_LICENSE in /etc/make.conf">
		453	ACCEPT_LICENSE="@GPL-COMPATIBLE @OSI-APPROVED @EULA atheros-hal BitstreamVera"
		454	</pre>
		455
		456	<p>
		457	If you want only free software and documentation on your system, you might use
		458	the following setup:
		459	</p>
		460
		461	<pre caption="Use only free licenses">
		462	ACCEPT_LICENSE="-* @FREE"
		463	</pre>
		464
		465	<p>
		466	In this case, "free" is mostly defined by the <uri
		467	link="http://www.gnu.org/philosophy/free-sw.html">FSF</uri> and <uri
		468	link="http://www.opensource.org/docs/osd">OSI</uri>. Any package whose license
		469	does not meet these requirements will not be installed on your system.
		470	</p>
		471
		472	</body>
		473	</subsection>
		474	</section>
363	<section>	475	<section>
364	<title>When Portage is Complaining...</title>	476	<title>When Portage is Complaining...</title>
365	<subsection>	477	<subsection>
366	<title>About SLOTs, Virtuals, Branches, Architectures and Profiles</title>	478	<title>About SLOTs, Virtuals, Branches, Architectures and Profiles</title>
367	<body>	479	<body>
…		…
418	<subsection id="blocked">	530	<subsection id="blocked">
419	<title>Blocked Packages</title>	531	<title>Blocked Packages</title>
420	<body>	532	<body>
421		533
422	<pre caption="Portage warning about blocked packages (with --pretend)">	534	<pre caption="Portage warning about blocked packages (with --pretend)">
423	[blocks B ] gnome-base/bonobo-activation (from pkg gnome-base/libbonobo-2.4.0)	535	[blocks B ] mail-mta/ssmtp (is blocking mail-mta/postfix-2.2.2-r1)
424	</pre>	536	</pre>
425		537
426	<pre caption="Portage warning about blocked packages (without --pretend)">	538	<pre caption="Portage warning about blocked packages (without --pretend)">
427	!!! Error: the gnome-base/bonobo-activation package conflicts with another package.	539	!!! Error: the mail-mta/postfix package conflicts with another package.
428	!!! both can't be installed on the same system together.	540	!!! both can't be installed on the same system together.
429	!!! Please use 'emerge --pretend' to determine blockers.	541	!!! Please use 'emerge --pretend' to determine blockers.
430	</pre>	542	</pre>
431		543
432	<p>	544	<p>
…		…
436	these dependencies explicitly marks a package or virtual as being <e>not</e>	548	these dependencies explicitly marks a package or virtual as being <e>not</e>
437	compatible, it triggers a blockage.	549	compatible, it triggers a blockage.
438	</p>	550	</p>
439		551
440	<p>	552	<p>
		553	While recent versions of Portage are smart enough to work around minor blockages
		554	without user intervention, occasionally you will need to fix it yourself, as
		555	explained below.
		556	</p>
		557
		558	<p>
441	To fix a blockage, you can choose to not install the package or unmerge the	559	To fix a blockage, you can choose to not install the package or unmerge the
442	conflicting package first. In the given example, you can opt not to install	560	conflicting package first. In the given example, you can opt not to install
443	<c>libbonobo</c> or to remove <c>bonobo-activation</c> first.	561	<c>postfix</c> or to remove <c>ssmtp</c> first.
		562	</p>
		563
		564	<p>
		565	You may also see blocking packages with specific atoms, such as
		566	<b><</b>media-video/mplayer-1.0_rc1-r2. In this case, updating to a more
		567	recent version of the blocking package would remove the block.
		568	</p>
		569
		570	<p>
		571	It is also possible that two packages that are yet to be installed are blocking
		572	each other. In this rare case, you should find out why you need to install both.
		573	In most cases you can do with one of the packages alone. If not, please file a
		574	bug on <uri link="http://bugs.gentoo.org">Gentoo's bugtracking system</uri>.
444	</p>	575	</p>
445		576
446	</body>	577	</body>
447	</subsection>	578	</subsection>
448	<subsection id="masked">	579	<subsection id="masked">
…		…
458		589
459	- gnome-base/gnome-2.8.0_pre1 (masked by: <i>~x86 keyword</i>)	590	- 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>)	591	- 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>)	592	- 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>)	593	- 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>)	594	- games-fps/unreal-tournament-451 (masked by: <i>package.mask</i>)
464	- sys-libs/glibc-2.3.2-r11 (masked by: <i>profile</i>)	595	- sys-libs/glibc-2.3.2-r11 (masked by: <i>profile</i>)
		596	- net-im/skype-2.1.0.81 (masked by: skype-eula <i>license</i>(s))
465	</pre>	597	</pre>
466		598
467	<p>	599	<p>
468	When you want to install a package that isn't available for your system, you	600	When you want to install a package that isn't available for your system, you
469	will receive this masking error. You should try installing a different	601	will receive this masking error. You should try installing a different
…		…
494	<li>	626	<li>
495	<b>profile</b> means that the package has been found not suitable for your	627	<b>profile</b> means that the package has been found not suitable for your
496	profile. The application might break your system if you installed it or is	628	profile. The application might break your system if you installed it or is
497	just not compatible with the profile you use.	629	just not compatible with the profile you use.
498	</li>	630	</li>
		631	<li>
		632	<b>license</b> means that the package's license is not compatible with your
		633	<c>ACCEPT_LICENSE</c> setting. You must explicitly permit its license or
		634	license group by setting it in <path>/etc/make.conf</path> or in
		635	<path>/etc/portage/package.license</path>. Refer to <uri
		636	link="#license">Licenses</uri> to learn how licenses work.
		637	</li>
499	</ul>	638	</ul>
		639
		640	</body>
		641	</subsection>
		642	<subsection id="USEdependency">
		643	<title>Necessary USE Flag Changes</title>
		644	<body>
		645
		646	<pre caption="Portage warning about USE flag change requirement">
		647	The following USE changes are necessary to proceed:
		648	#required by app-text/happypackage-2.0, required by happypackage (argument)
		649	>=app-text/feelings-1.0.0 test
		650	</pre>
		651
		652	<p>
		653	The error message might also be displayed as follows, if <c>--autounmask</c>
		654	isn't set:
		655	</p>
		656
		657	<pre caption="Portage error about USE flag change requirement">
		658	emerge: there are no ebuilds built with USE flags to satisfy "app-text/feelings[test]".
		659	!!! One of the following packages is required to complete your request:
		660	- app-text/feelings-1.0.0 (Change USE: +test)
		661	(dependency required by "app-text/happypackage-2.0" [ebuild])
		662	(dependency required by "happypackage" [argument])
		663	</pre>
		664
		665	<p>
		666	Such warning or error occurs when you want to install a package which not only
		667	depends on another package, but also requires that that package is built with a
		668	particular USE flag (or set of USE flags). In the given example, the package
		669	<c>app-text/feelings</c> needs to be built with <c>USE="test"</c>, but this USE
		670	flag is not set on the system.
		671	</p>
		672
		673	<p>
		674	To resolve this, either add the requested USE flag to your global USE flags in
		675	<path>/etc/make.conf</path>, or set it for the specific package in
		676	<path>/etc/portage/package.use</path>.
		677	</p>
500		678
501	</body>	679	</body>
502	</subsection>	680	</subsection>
503	<subsection id="missingdependencies">	681	<subsection id="missingdependencies">
504	<title>Missing Dependencies</title>	682	<title>Missing Dependencies</title>
…		…
524	<subsection id="ambiguousebuild">	702	<subsection id="ambiguousebuild">
525	<title>Ambiguous Ebuild Name</title>	703	<title>Ambiguous Ebuild Name</title>
526	<body>	704	<body>
527		705
528	<pre caption="Portage warning about ambiguous ebuild names">	706	<pre caption="Portage warning about ambiguous ebuild names">
		707	[ Results for search key : listen ]
		708	[ Applications found : 2 ]
		709
		710	* dev-tinyos/listen [ Masked ]
		711	Latest version available: 1.1.15
		712	Latest version installed: [ Not Installed ]
		713	Size of files: 10,032 kB
		714	Homepage: http://www.tinyos.net/
		715	Description: Raw listen for TinyOS
		716	License: BSD
		717
		718	* media-sound/listen [ Masked ]
		719	Latest version available: 0.6.3
		720	Latest version installed: [ Not Installed ]
		721	Size of files: 859 kB
		722	Homepage: http://www.listen-project.org
		723	Description: A Music player and management for GNOME
		724	License: GPL-2
		725
529	!!! The short ebuild name "aterm" is ambiguous. Please specify	726	!!! The short ebuild name "listen" is ambiguous. Please specify
530	!!! one of the following fully-qualified ebuild names instead:	727	!!! one of the above fully-qualified ebuild names instead.
531
532	dev-libs/aterm
533	x11-terms/aterm
534	</pre>	728	</pre>
535		729
536	<p>	730	<p>
537	The application you want to install has a name that corresponds with more than	731	The application you want to install has a name that corresponds with more than
538	one package. You need to supply the category name as well. Portage will inform	732	one package. You need to supply the category name as well. Portage will inform
…		…
601	from the system.	795	from the system.
602	</p>	796	</p>
603		797
604	</body>	798	</body>
605	</subsection>	799	</subsection>
		800	<subsection id="digesterror">
		801	<title>Digest Verification Failures</title>
		802	<body>
		803
		804	<p>
		805	Sometimes, when you attempt to emerge a package, it will fail with the message:
		806	</p>
		807
		808	<pre caption="Digest verification failure">
		809	>>> checking ebuild checksums
		810	!!! Digest verification failed:
		811	</pre>
		812
		813	<p>
		814	This is a sign that something is wrong with the Portage tree -- often, it is
		815	because a developer may have made a mistake when committing a package to the
		816	tree.
		817	</p>
		818
		819	<p>
		820	When the digest verification fails, do <e>not</e> try to re-digest the package
		821	yourself. Running <c>ebuild foo manifest</c> will not fix the problem; it will
		822	almost certainly make it worse!
		823	</p>
		824
		825	<p>
		826	Instead, wait an hour or two for the tree to settle down. It's likely that the
		827	error was noticed right away, but it can take a little time for the fix to
		828	trickle down the Portage tree. While you're waiting, check <uri
		829	link="http://bugs.gentoo.org">Bugzilla</uri> and see if anyone has reported
		830	the problem yet. If not, go ahead and file a bug for the broken package.
		831	</p>
		832
		833	<p>
		834	Once you see that the bug has been fixed, you may want to re-sync to pick up
		835	the fixed digest.
		836	</p>
		837
		838	<impo>
		839	This does <e>not</e> mean that you can re-sync your tree multiple times! As
		840	stated in the rsync policy (when you run <c>emerge --sync</c>), users who sync
		841	too often will be banned! In fact, it's better to just wait until your next
		842	scheduled sync, so that you don't overload the rsync servers.
		843	</impo>
		844
		845	</body>
		846	</subsection>
606	</section>	847	</section>
607	</sections>	848	</sections>

 Legend:



Removed from v.1.54
 


changed lines


 
Added in v.1.77
 Legend:



Removed from v.1.54
 


changed lines


 
Added in v.1.77
-Removed from v.1.54
+Added in v.1.77

	ViewVC Help
Powered by ViewVC 1.1.17