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

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

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

Revision 1.24 Revision 1.43
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/1.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-use.xml,v 1.24 2004/11/20 22:23:30 neysx Exp $ --> 7<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/handbook/hb-working-use.xml,v 1.43 2006/10/08 19:38:11 nightmorph Exp $ -->
8 8
9<sections> 9<sections>
10 10
11<version>1.21</version> 11<version>1.35</version>
12<date>2004-10-21</date> 12<date>2006-10-08</date>
13 13
14<section> 14<section>
15<title>What are USE-flags?</title> 15<title>What are USE-flags?</title>
16<subsection> 16<subsection>
17<title>The ideas behind USE-flags</title> 17<title>The ideas behind USE-flags</title>
34 34
35<p> 35<p>
36To help users in deciding what to install/activate and what not, we wanted the 36To help users in deciding what to install/activate and what not, we wanted the
37user to specify his/her environment in an easy way. This forces the user into 37user to specify his/her environment in an easy way. This forces the user into
38deciding what they really want and eases the process for Portage, our package 38deciding what they really want and eases the process for Portage, our package
39managment system, to make useful decisions. 39management system, to make useful decisions.
40</p> 40</p>
41 41
42</body> 42</body>
43</subsection> 43</subsection>
44<subsection> 44<subsection>
89</ul> 89</ul>
90 90
91<p> 91<p>
92A list of available global USE-flags can be found <uri 92A list of available global USE-flags can be found <uri
93link="/dyn/use-index.xml">online</uri> or locally in 93link="/dyn/use-index.xml">online</uri> or locally in
94<path>/usr/portage/profiles/use.desc</path>. A short (<e>very</e> incomplete) 94<path>/usr/portage/profiles/use.desc</path>.
95snippet:
96</p>
97
98<pre caption="A short snippet of available USE-flags">
99gtk - Adds support for x11-libs/gtk+ (The GIMP Toolkit)
100gtk2 - Use gtk+-2.0.0 over gtk+-1.2 in cases where a program supports both.
101gtkhtml - Adds support for gnome-extra/gtkhtml
102guile - Adds support for dev-util/guile (interpreter for Scheme)
103icc - Use the Intel C++ Compiler if the package supports it
104icc-pgo - Enable PGO data generation or use when use icc.
105imap - Adds support for IMAP
106</pre> 95</p>
107 96
108<p> 97<p>
109A list of available local USE-flags can be found locally in 98A list of available local USE-flags can be found locally in
110<path>/usr/portage/profiles/use.local.desc</path>. 99<path>/usr/portage/profiles/use.local.desc</path>.
111</p> 100</p>
127<p> 116<p>
128As previously mentioned, all USE-flags are declared inside the <c>USE</c> 117As previously mentioned, all USE-flags are declared inside the <c>USE</c>
129variable. To make it easy for users to search and pick USE-flags, we already 118variable. To make it easy for users to search and pick USE-flags, we already
130provide a <e>default</e> USE setting. This setting is a collection of USE-flags 119provide a <e>default</e> USE setting. This setting is a collection of USE-flags
131we think are commonly used by the Gentoo users. This default setting is declared 120we think are commonly used by the Gentoo users. This default setting is declared
132in the <path>/etc/make.profile/make.defaults</path> file. Let us take a look at 121in the <path>make.defaults</path> files part of your profile.
133this default setting: 122</p>
123
134</p> 124<p>
125The profile your system listens to is pointed to by the
126<path>/etc/make.profile</path> symlink. Each profile works on top of another,
127larger profile, the end result is therefore the sum of all profiles. The top
128profile is the <path>base</path> profile
129(<path>/usr/portage/profiles/base</path>).
130</p>
135 131
136<pre caption="/etc/make.profile/make.defaults USE variable on an x86 system"> 132<p>
137USE="x86 oss apm arts avi berkdb crypt cups encode foomaticdb gdbm gif gpm 133Let us take a look at this default setting for the 2004.3 profile:
138 gtk gtk2 imlib jpeg kde gnome libg++ libwww mad mikmod motif mpeg ncurses 134</p>
139 nls oggvorbis opengl pam pdflib png python qt quicktime readline sdl 135
136<pre caption="Cumulative make.defaults USE variable for the 2004.3 profile">
137<comment>(This example is the sum of the settings in base, default-linux,
138 default-linux/x86 and default-linux/x86/2004.3)</comment>
139USE="x86 oss apm arts avi berkdb bitmap-fonts crypt cups encode fortran f77
140 foomaticdb gdbm gif gpm gtk imlib jpeg kde gnome libg++ libwww mad
141 mikmod motif mpeg ncurses nls oggvorbis opengl pam pdflib png python qt
140 slang spell ssl svga tcpd truetype X xml2 xmms xv zlib" 142 quicktime readline sdl spell ssl svga tcpd truetype X xml2 xmms xv zlib"
141</pre> 143</pre>
142 144
143<p> 145<p>
144As you can see, this variable already contains quite a lot of keywords. Do 146As you can see, this variable already contains quite a lot of keywords. Do
145<b>not</b> alter the <path>/etc/make.profile/make.defaults</path> file to tailor 147<b>not</b> alter any <path>make.defaults</path> file to tailor
146the <c>USE</c> variable to your needs: changes in this file will be undone when 148the <c>USE</c> variable to your needs: changes in this file will be undone when
147you update Portage! 149you update Portage!
148</p> 150</p>
149 151
150<p> 152<p>
159For instance, to remove support for KDE and QT but add support for ldap, the 161For instance, to remove support for KDE and QT but add support for ldap, the
160following <c>USE</c> can be defined in <path>/etc/make.conf</path>: 162following <c>USE</c> can be defined in <path>/etc/make.conf</path>:
161</p> 163</p>
162 164
163<pre caption="An example USE setting in /etc/make.conf"> 165<pre caption="An example USE setting in /etc/make.conf">
164USE="-kde -qt ldap" 166USE="-kde -qt3 -qt4 ldap"
165</pre> 167</pre>
166 168
167</body> 169</body>
168</subsection> 170</subsection>
169<subsection> 171<subsection>
219</pre> 221</pre>
220 222
221</body> 223</body>
222</subsection> 224</subsection>
223<subsection> 225<subsection>
224<title>Inheriting USE-flags</title>
225<body>
226
227<p>
228Some packages don't only listen to USE-flags, but also provide USE-flags. When
229you install such a package, the USE-flag they provide is added to your USE
230setting. To view the list of packages that provide a USE-flag, check
231<path>/etc/make.profile/use.defaults</path>:
232</p>
233
234<pre caption="A snippet from /etc/make.profile/use.defaults">
235gnome gnome-base/gnome
236gtk x11-libs/gtk+
237qt x11-libs/qt
238kde kde-base/kdebase
239motif x11-libs/openmotif
240</pre>
241
242</body>
243</subsection>
244<subsection>
245<title>Precedence</title> 226<title>Precedence</title>
246<body> 227<body>
247 228
248<p> 229<p>
249Of course there is a certain precedence on what setting has priority over the 230Of course there is a certain precedence on what setting has priority over the
250USE setting. You don't want to declare <c>USE="-java"</c> only to see that 231USE setting. You don't want to declare <c>USE="-java"</c> only to see that
251<c>java</c> is declared anyway. The precedence for the USE setting is, ordered 232<c>java</c> is still used due to a setting that has a higher priority.
233The precedence for the USE setting is, ordered
252by priority (first has lowest priority): 234by priority (first has lowest priority):
253</p> 235</p>
254 236
255<ol> 237<ol>
256 <li> 238 <li>
257 Default USE setting declared in <path>/etc/make.profile/make.defaults</path> 239 Default USE setting declared in the <path>make.defaults</path> files part of
258 </li> 240 your profile
259 <li>
260 Inherited USE setting if a package from
261 <path>/etc/make.profile/use.defaults</path> is installed
262 </li> 241 </li>
263 <li> 242 <li>
264 User-defined USE setting in <path>/etc/make.conf</path> 243 User-defined USE setting in <path>/etc/make.conf</path>
265 </li> 244 </li>
266 <li> 245 <li>
270 User-defined USE setting as environment variable 249 User-defined USE setting as environment variable
271 </li> 250 </li>
272</ol> 251</ol>
273 252
274<p> 253<p>
275To view the final <c>USE</c> setting as seen by Portage, run <c>emerge info</c>. 254To view the final <c>USE</c> setting as seen by Portage, run <c>emerge
276This will list all relevant variables (including the <c>USE</c> variable) with 255--info</c>. This will list all relevant variables (including the <c>USE</c>
277the content used by Portage. 256variable) with the content used by Portage.
278</p> 257</p>
279 258
280<pre caption="Running emerge info"> 259<pre caption="Running emerge --info">
281# <i>emerge info</i> 260# <i>emerge --info</i>
282</pre> 261</pre>
283 262
284</body> 263</body>
285</subsection> 264</subsection>
286<subsection> 265<subsection>
301were emerged on your "old" system but that have been obsoleted by the new USE 280were emerged on your "old" system but that have been obsoleted by the new USE
302flags. 281flags.
303</p> 282</p>
304 283
305<warn> 284<warn>
306Running <c>emerge depclean</c> is a dangerous operation and should be handled 285Running <c>emerge --depclean</c> is a dangerous operation and should be handled
307with care. Double-check the provided list of "obsoleted" packages to make sure 286with care. Double-check the provided list of "obsoleted" packages to make sure
308it doesn't remove packages you need. In the following example we add the 287it doesn't remove packages you need. In the following example we add the
309<c>-p</c> switch to have depclean only list the packages without removing them. 288<c>-p</c> switch to have depclean only list the packages without removing them.
310</warn> 289</warn>
311 290
312<pre caption="Removing obsoleted packages"> 291<pre caption="Removing obsoleted packages">
313# <i>emerge -p depclean</i> 292# <i>emerge -p --depclean</i>
314</pre> 293</pre>
315 294
316<p> 295<p>
317When depclean has finished, run <c>revdep-rebuild</c> to rebuild the 296When depclean has finished, run <c>revdep-rebuild</c> to rebuild the
318applications that are dynamically linked against shared objects provided by 297applications that are dynamically linked against shared objects provided by
346<pre caption="Viewing the used USE-flags"> 325<pre caption="Viewing the used USE-flags">
347# <i>emerge --pretend --verbose mozilla</i> 326# <i>emerge --pretend --verbose mozilla</i>
348These are the packages that I would merge, in order: 327These are the packages that I would merge, in order:
349 328
350Calculating dependencies ...done! 329Calculating dependencies ...done!
351[ebuild N ] net-www/mozilla-1.5-r1 +java +crypt -ipv6 -gtk2 +ssl +ldap 330[ebuild R ] www-client/mozilla-1.7.12-r2 USE="crypt gnome java mozsvg ssl
352+gnome -debug +mozcalendar -mozaccess -mozxmlterm -moznoirc -moznomail 331truetype xprint -debug -ipv6 -ldap -mozcalendar -mozdevelop -moznocompose
353-moznocompose -moznoxft 332-moznoirc -moznomail -moznoxft -postgres -xinerama" 0 kB
354</pre> 333</pre>
355 334
356<p> 335<p>
357<c>emerge</c> isn't the only tool for this job. In fact, we have a tool 336<c>emerge</c> isn't the only tool for this job. In fact, we have a tool
358dedicated to package information called <c>etcat</c> which resides in the 337dedicated to package information called <c>equery</c> which resides in the
359<c>gentoolkit</c> package. First, install <c>gentoolkit</c>: 338<c>gentoolkit</c> package. First, install <c>gentoolkit</c>:
360</p> 339</p>
361 340
362<pre caption="Installing gentoolkit"> 341<pre caption="Installing gentoolkit">
363# <i>emerge gentoolkit</i> 342# <i>emerge gentoolkit</i>
364</pre> 343</pre>
365 344
366<p> 345<p>
367Now run <c>etcat</c> with the <c>uses</c> argument to view the USE-flags of a 346Now run <c>equery</c> with the <c>uses</c> argument to view the USE-flags of a
368certain package. For instance, for the <c>gnumeric</c> package: 347certain package. For instance, for the <c>gnumeric</c> package:
369</p> 348</p>
370 349
371<pre caption="Using etcat to view used USE-flags"> 350<pre caption="Using equery to view used USE-flags">
372# <i>etcat uses gnumeric</i> 351# <i>equery uses =gnumeric-1.6.3 -a</i>
352[ Searching for packages matching =gnumeric-1.6.3... ]
373[ Colour Code : <i>set</i> <comment>unset</comment> ] 353[ Colour Code : <comment>set</comment> <i>unset</i> ]
374[ Legend : (U) Col 1 - Current USE flags ] 354[ Legend : Left column (U) - USE flags from make.conf ]
375[ : (I) Col 2 - Installed With USE flags ] 355[ : Right column (I) - USE flags packages was installed with ]
376
377 U I [ Found these USE variables in : app-office/gnumeric-1.2.0 ] 356[ Found these USE variables for app-office/gnumeric-1.6.3 ]
378 - - <comment>libgda</comment> : Adds GNU Data Access (CORBA wrapper) support for gnumeric 357 U I
379 - - <comment>gnomedb</comment> : unknown 358- - <i>debug</i> : Tells configure and the makefiles to build for debugging.
359 Effects vary across packages, but generally it will at
360 least add -g to CFLAGS. Remember to set FEATURES=nostrip too
361- - <i>gnome</i> : Adds GNOME support
380 + + <i>python</i> : Adds support/bindings for the Python language 362+ + <comment>python</comment> : Adds support/bindings for the Python language
381 + + <i>bonobo</i> : Adds support for gnome-base/bonobo (Gnome CORBA interfaces) 363- - <i>static</i> : !!do not set this during bootstrap!! Causes binaries to be
364 statically linked instead of dynamically
382</pre> 365</pre>
383 366
384</body> 367</body>
385</subsection> 368</subsection>
386</section> 369</section>

Legend:
Removed from v.1.24  
changed lines
  Added in v.1.43

  ViewVC Help
Powered by ViewVC 1.1.20