/[gentoo]/xml/htdocs/doc/en/nvidia-guide.xml
Gentoo

Diff of /xml/htdocs/doc/en/nvidia-guide.xml

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

Revision 1.40 Revision 1.41
1<?xml version='1.0' encoding="UTF-8"?> 1<?xml version='1.0' encoding="UTF-8"?>
2<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/nvidia-guide.xml,v 1.40 2007/04/16 05:39:54 nightmorph Exp $ --> 2<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/nvidia-guide.xml,v 1.41 2007/07/22 07:32:10 nightmorph Exp $ -->
3<!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> 3<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
4 4
5<guide link="/doc/en/nvidia-guide.xml"> 5<guide link="/doc/en/nvidia-guide.xml">
6<title>Gentoo Linux nVidia Guide</title> 6<title>Gentoo Linux nVidia Guide</title>
7 7
8<author title="Author"> 8<author title="Author">
9 <mail link="swift@gentoo.org">Sven Vermeulen</mail> 9 <mail link="swift@gentoo.org">Sven Vermeulen</mail>
10</author>
11<author title="Author">
12 <mail link="nightmorph@gentoo.org">Joshua Saddler</mail>
10</author> 13</author>
11<author title="Editor"> 14<author title="Editor">
12 <mail link="curtis119@gentoo.org">M Curtis Napier</mail> 15 <mail link="curtis119@gentoo.org">M Curtis Napier</mail>
13</author> 16</author>
14<author title="Editor"> 17<author title="Editor">
15 <mail link="nightmorph@gentoo.org">Joshua Saddler</mail>
16</author>
17<author title="Editor">
18 <mail link="wolf31o2@gentoo.org">Chris Gianelloni</mail> 18 <mail link="wolf31o2@gentoo.org">Chris Gianelloni</mail>
19</author> 19</author>
20 20
21<abstract> 21<abstract>
22Many Gentooists have an nVidia chipset on their system. nVidia provides specific 22Many Gentooists have an nVidia chipset on their system. nVidia provides specific
26 26
27<!-- The content of this document is licensed under the CC-BY-SA license --> 27<!-- The content of this document is licensed under the CC-BY-SA license -->
28<!-- See http://creativecommons.org/licenses/by-sa/2.5 --> 28<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
29<license/> 29<license/>
30 30
31<version>1.31</version> 31<version>1.32</version>
32<date>2007-04-15</date> 32<date>2007-07-22</date>
33 33
34<chapter> 34<chapter>
35<title>Introduction</title> 35<title>Introduction</title>
36<section> 36<section>
37<body> 37<body>
40The nVidia drivers in the tree are released by nVidia and are built against the 40The nVidia drivers in the tree are released by nVidia and are built against the
41Linux kernel. They contain a binary blob that does the heavy lifting for talking 41Linux kernel. They contain a binary blob that does the heavy lifting for talking
42to the card. The drivers consist of two parts, a kernel module, and an X11 42to the card. The drivers consist of two parts, a kernel module, and an X11
43driver. Both parts are included in a single package. Due to the way nVidia has 43driver. Both parts are included in a single package. Due to the way nVidia has
44been packaging their drivers, you will need to make some choices before you 44been packaging their drivers, you will need to make some choices before you
45install the drivers. Currently, there are two driver packages in the tree. The 45install the drivers.
46</p>
47
48<p>
49Currently, there are two driver packages in the tree, though this will be
50reduced to just one package in the near future. The first,
46first, <c>nvidia-drivers</c>, is the latest drivers from nVidia and includes 51<c>nvidia-drivers</c>, contains the latest drivers from nVidia with support for
47support for the latest cards. The second, <c>nvidia-legacy-drivers</c>, supports 52<e>all</e> cards, with several versions available depending on how old your
48older cards, from the original TNT through the GeForce 6800. However, this 53card is. It uses an eclass to detect what kind of card you're running so that it
49driver does not support the latest features of the newer cards. You should only 54installs the proper version. The second package, <c>nvidia-legacy-drivers</c>,
50use <c>nvidia-legacy-drivers</c> if your cards is not supported in the 55supports older cards. It is deprecated in favor of the all-inclusive
51<c>nvidia-drivers</c> package. 56<c>nvidia-drivers</c> package, which contains the same driver version(s). <b>Do
57not install <c>nvidia-legacy-drivers</c></b>; it's only kept in the tree to give
58its current users time to switch over to the new package. You should only use
59<c>nvidia-drivers</c>, as explained in the next chapter.
52</p> 60</p>
53 61
54<note> 62<note>
55Previously, Gentoo provided separate ebuilds for the nVidia kernel module 63Previously, Gentoo provided separate ebuilds for the nVidia kernel module
56(<c>nvidia-kernel</c>) and the X11 GLX libraries (<c>nvidia-glx</c>). These 64(<c>nvidia-kernel</c>) and the X11 GLX libraries (<c>nvidia-glx</c>). These
57ebuilds have since been removed from the Portage tree in favor of 65ebuilds have since been removed from the Portage tree in favor of
58<c>nvidia-drivers</c> and <c>nvidia-legacy-drivers</c>. If you use 66<c>nvidia-drivers</c>. If you use <c>nvidia-kernel</c> and <c>nvidia-glx</c>,
59<c>nvidia-kernel</c> and <c>nvidia-glx</c>, then you should migrate to the 67then you should migrate to the newer packages.
60newer packages.
61</note> 68</note>
62 69
63</body> 70</body>
64</section> 71</section>
65</chapter> 72</chapter>
66 73
67<chapter> 74<chapter>
68<title>Driver compatibility</title> 75<title>Driver compatibility</title>
69<section> 76<section>
70<title>nvidia-legacy-drivers</title> 77<title>Which version?</title>
71<body>
72
73<p>
74The <c>nvidia-legacy-drivers</c> branch supports older nVidia cards which are no
75longer supported in the latest driver releases. This branch is based on an older
76code base of the nVidia drivers, and supports the latest kernels and X.Org
77versions. You should use this driver if you have a TNT, TNT2, GeForce, or
78GeForce 2 series card. The driver compatibility information can be found in
79Appendix A of
80<uri>http://download.nvidia.com/XFree86/Linux-x86/1.0-7184/README/readme.txt</uri>.
81</p>
82
83</body> 78<body>
84</section>
85<section>
86<title>nvidia-drivers</title>
87<body>
88 79
80<p>
81The <c>nvidia-drivers</c> package supports the full range of available nVidia
82cards. Multiple versions are available for installation, depending on the
83card(s) you have.
89<p> 84</p>
90The <c>nvidia-drivers</c> branch supports the features in newer nVidia cards. 85
91The latest version of these drivers has dropped support for the NV2x based 86<p>
92cards. If you have a GeForce 3 or GeForce 4 series card, you should mask 87Newer cards such as the GeForce 8, 7, 6, and FX 5 series should use the newer
88drivers from the 100.x series.
89</p>
90
91<p>
92Older cards such as the GeForce 3 or GeForce 4
93series require the 96xx drivers. For these cards, you should mask
93<c>>=x11-drivers/nvidia-drivers-1.0.9700</c> in your 94<c>>=x11-drivers/nvidia-drivers-1.0.9700</c> in your
94<path>/etc/portage/package.mask</path> file. This will prevent newer versions of 95<path>/etc/portage/package.mask</path> file. This will prevent newer versions of
95the driver which are incompatible with your card from being installed. You can 96the driver which are incompatible with your card from being installed.
97</p>
98
99<p>
100Old NV2x-based cards (such as TNT, TNT2, GeForce, and GeForce 2) require the
101older 71xx drivers (such as <c>nvidia-drivers-1.0.7185</c>). For these cards,
102you should mask <c>>=nvidia-drivers-1.0.8700</c> in
103<path>/etc/portage/package.mask</path>.
104</p>
105
106<p>
96check for driver compatibility for your card at to determine if it is supported 107You can check for driver compatibility for your card at to determine which
97on the newer drivers at 108driver supports it at
98<uri>http://us.download.nvidia.com/XFree86/Linux-x86/1.0-9746/README/appendix-a.html</uri>. 109<uri>http://us.download.nvidia.com/XFree86/Linux-x86_64/100.14.11/README/appendix-a.html</uri>.
99</p> 110</p>
111
112<impo>
113The <c>nvidia-legacy-drivers</c> package is deprecated and should not be
114installed on a fresh system. Although it is a 71xx driver, the corresponding
11571xx driver version found in <c>nvidia-drivers</c> should be used instead.
116</impo>
100 117
101</body> 118</body>
102</section> 119</section>
103</chapter> 120</chapter>
104 121
201<section> 218<section>
202<title>Continuing with Kernel Configuration</title> 219<title>Continuing with Kernel Configuration</title>
203<body> 220<body>
204 221
205<p> 222<p>
206The <c>nvidia-drivers</c> and <c>nvidia-legacy-drivers</c> ebuilds automatically 223The <c>nvidia-drivers</c> ebuild automatically discovers your kernel version
207discover your kernel version based on the <path>/usr/src/linux</path> symlink. 224based on the <path>/usr/src/linux</path> symlink. Please ensure that you have
208Please ensure that you have this symlink pointing to the correct sources and 225this symlink pointing to the correct sources and that your kernel is correctly
209that your kernel is correctly configured. Please refer to the "Configuring the 226configured. Please refer to the "Configuring the Kernel" section of the <uri
210Kernel" section of the <uri link="/doc/en/handbook/">Installation Handbook</uri> 227link="/doc/en/handbook/">Installation Handbook</uri> for details on configuring
211for details on configuring your kernel. 228your kernel.
212</p>
213
214<p> 229</p>
215If you are using gentoo-sources-2.6.11-r6, your <path>/usr/src</path> directory 230
231<p>
232First, you'll need to emerge <c>eselect</c> (if you don't already have it). If
233you are using <c>gentoo-sources-2.6.18-r4</c>, your kernel listing might look
216might look something like this: 234something like this:
217</p> 235</p>
218 236
219<pre caption="Check your /usr/src/linux symlink"> 237<pre caption="Check your /usr/src/linux symlink">
220# <i>cd /usr/src</i> 238# <i>eselect kernel list</i>
221# <i>ls -l</i> 239Available kernel symlink targets:
222<comment>(Check that linux points to the right directory)</comment> 240 [1] linux-2.6.18-gentoo-r4 *
223lrwxrwxrwx 1 root root 22 Apr 23 18:33 linux -&gt; linux-2.6.11-gentoo-r6 241 [2] linux-2.6.20-gentoo-r7
224drwxr-xr-x 4 root root 120 Apr 8 18:56 linux-2.4.26-gentoo-r4 242 [3] linux-2.6.20-gentoo-r8
225drwxr-xr-x 18 root root 664 Dec 31 16:09 linux-2.6.10 243<comment>(Verify that the right kernel is marked with an asterisk</comment>
226drwxr-xr-x 18 root root 632 Mar 3 12:27 linux-2.6.11
227drwxr-xr-x 19 root root 4096 Mar 16 22:00 linux-2.6.11-gentoo-r6
228</pre> 244</pre>
229 245
230<p> 246<p>
231In the above output, you'll notice that the <c>linux</c> symlink is pointing 247In the above output, you'll notice that the <c>linux-2.6.18-gentoo-r4</c> kernel
232to the <c>linux-2.6.11-gentoo-r6</c> kernel. 248is marked with an asterisk (<b>*</b>) to show that it is the symlinked kernel.
233</p> 249</p>
234 250
235<p> 251<p>
236If the symlink is not pointing to the correct sources, you must update the link 252If the symlink is not pointing to the correct sources, you must update the link
237like this: 253by selecting the number of your desired kernel sources, as in the example
254above.
238</p> 255</p>
239 256
240<pre caption="Create/Update /usr/src/linux symlink"> 257<pre caption="Create/Update /usr/src/linux symlink">
241# <i>cd /usr/src</i> 258<comment>(Select the correct kernel)</comment>
242# <i>ln -snf linux-2.6.11-gentoo-r6 linux</i> 259# <i>eselect kernel set 1</i>
243</pre> 260</pre>
244 261
245</body> 262</body>
246</section>
247<section> 263</section>
248<title>Optional: Check for Legacy Card Support</title> 264<section>
265<title>Installing the Appropriate Drivers</title>
249<body> 266<body>
267
268<p>
269Now it's time to install the drivers.
270</p>
271
272<pre caption="Installing the nVidia drivers">
273# <i>emerge nvidia-drivers</i>
274</pre>
250 275
251<note> 276<note>
252Unfortunately, certain legacy video cards are not supported by the newer 277The newer 100.x drivers can be installed with the <c>gtk</c> USE flag set. This
253versions of <c>nvidia-drivers</c>. 278will install <c>media-video/nvidia-settings</c>, a handy graphical tool for
254nVidia provides a <uri link="http://www.nvidia.com/object/IO_18897.html">list 279monitoring and configuring several aspects of your nVidia card.
255of supported cards</uri>. Please check the list before installing the drivers.
256</note> 280</note>
257 281
258<p>
259The following is a list of <b>unsupported</b> legacy video cards:
260</p>
261
262<pre caption="Unsupported cards">
263TNT
264TNT2
265TNT2 Pro
266TNT2 Ultra
267TNT2 Model 64 (M64)
268TNT2 Model 64 (M64) Pro
269Vanta
270Vanta LT
271GeForce 256
272GeForce DDR
273GeForce2 GTS
274GeForce2 Pro
275GeForce2 Ti
276GeForce2 Ultra
277GeForce2 MX Integrated graphics
278Quadro
279Quadro2 Pro
280Quadro2 EX
281</pre>
282
283<p>
284If your card is listed in the legacy list, then you will be required to install
285the <c>nvidia-legacy-drivers</c> package to get 3D support.
286</p>
287
288</body>
289</section>
290<section>
291<title>Installing the Appropriate Drivers</title>
292<body>
293
294<p>
295Now it's time to install the drivers.
296</p>
297
298<pre caption="Installing the nVidia drivers">
299<comment>(If you have a card not listed in the legacy list above)</comment>
300# <i>emerge nvidia-drivers</i>
301<comment>(If your card is listed in the legacy list)</comment>
302# <i>emerge nvidia-legacy-drivers</i>
303</pre>
304
305<impo> 282<impo>
306Every time you <uri link="/doc/en/kernel-upgrade.xml">compile a new 283Every time you <uri link="/doc/en/kernel-upgrade.xml">compile a new kernel</uri>
307kernel</uri> or recompile the current one, you will need to run <c>emerge 284or recompile the current one, you will need to run <c>emerge nvidia-drivers</c>
308nvidia-drivers</c> or <c>emerge nvidia-legacy-drivers</c> to reinstall the 285to reinstall the nVidia modules. An easier way to keep track of modules
309nVidia modules. 286installed by ebuilds (such as <c>nvidia-drivers</c>) is to install
287<c>sys-kernel/module-rebuild</c>. Once you've installed it, simply run
288<c>module-rebuild populate</c> to populate its database with a list of packages
289to be rebuilt. Once you've finished compiling or recompiling a kernel, just run
290<c>module-rebuild rebuild</c> to rebuild the drivers for your new kernel.
310</impo> 291</impo>
311 292
312<p> 293<p>
313Once the installation has finished, run <c>modprobe nvidia</c> to load the 294Once the installation has finished, run <c>modprobe nvidia</c> to load the
314kernel module into memory. If this is an upgrade, you should remove the 295kernel module into memory. If this is an upgrade, you should remove the
321</pre> 302</pre>
322 303
323<p> 304<p>
324To prevent you having to manually load the module on every bootup, you probably 305To prevent you having to manually load the module on every bootup, you probably
325want to have this done automatically each time you boot your system, so edit 306want to have this done automatically each time you boot your system, so edit
326<path>/etc/modules.autoload.d/kernel-2.6</path> (or <path>kernel-2.4</path>, 307<path>/etc/modules.autoload.d/kernel-2.6</path> and add <c>nvidia</c> to it.
327depending on which kernel version you use) and add <c>nvidia</c> to it. Don't
328forget to run <c>update-modules</c> afterwards. 308Don't forget to run <c>update-modules</c> afterwards.
329</p> 309</p>
330 310
331<impo> 311<impo>
332If you compiled <c>agpgart</c> as a module, you will need to add it to 312If you compiled <c>agpgart</c> as a module, you will need to add it to
333<path>/etc/modules.autoload.d/kernel-2.6</path> (or <path>kernel-2.4</path> 313<path>/etc/modules.autoload.d/kernel-2.6</path>.
334depending on your kernel version).
335</impo> 314</impo>
336 315
337<pre caption="Running update-modules"> 316<pre caption="Running update-modules">
338# <i>update-modules</i> 317# <i>update-modules</i>
339</pre> 318</pre>
407<title>Adding your Users to the video Group</title> 386<title>Adding your Users to the video Group</title>
408<body> 387<body>
409 388
410<p> 389<p>
411You have to add your user to the <c>video</c> group so he has access to the 390You have to add your user to the <c>video</c> group so he has access to the
412nvidia device files: 391nVidia device files:
413</p> 392</p>
414 393
415<pre caption="Adding your user to the video group"> 394<pre caption="Adding your user to the video group">
416# <i>gpasswd -a youruser video</i> 395# <i>gpasswd -a youruser video</i>
417</pre> 396</pre>
447<title>Enabling nvidia Support</title> 426<title>Enabling nvidia Support</title>
448<body> 427<body>
449 428
450<p> 429<p>
451Some tools, such as <c>mplayer</c> and <c>xine-lib</c>, use a local USE flag 430Some tools, such as <c>mplayer</c> and <c>xine-lib</c>, use a local USE flag
452called "nvidia" which enables XvMCNVIDIA support, useful when watching high 431called <c>xvmc</c> which enables XvMCNVIDIA support, useful when watching high
453resolution movies. Add in "nvidia" in your USE variable in 432resolution movies. Add in <c>xvmc</c> in your USE variable in
454<path>/etc/make.conf</path> or add it as USE flag to <c>media-video/mplayer</c> 433<path>/etc/make.conf</path> or add it as USE flag to <c>media-video/mplayer</c>
455and/or <c>media-libs/xine-lib</c> in <path>/etc/portage/package.use</path>. 434and/or <c>media-libs/xine-lib</c> in <path>/etc/portage/package.use</path>.
456</p> 435</p>
457 436
458<p> 437<p>
438There are also some applications that use the <c>nvidia</c> USE flag, so you
439may want to add it to <path>/etc/make.conf</path>.
440</p>
441
442<p>
459Then, run <c>emerge -uD --newuse world</c> to rebuild the applications that 443Then, run <c>emerge -uD --newuse world</c> to rebuild the applications that
460benefit from the USE flag change. 444benefit from the USE flag change.
461</p> 445</p>
462 446
463</body> 447</body>
465<section> 449<section>
466<title>Using NVidia Settings Tool</title> 450<title>Using NVidia Settings Tool</title>
467<body> 451<body>
468 452
469<p> 453<p>
470Since nVidia released version 1.0.6106 it also provides you with a settings 454nVidia also provides you with a settings tool. This tool allows you to monitor
471tool. This tool allows you to change graphical settings without restarting the 455and change graphical settings without restarting the X server and is available
472X server and is available through Portage as 456through Portage as <c>media-video/nvidia-settings</c>. As mentioned earlier, it
473<c>media-video/nvidia-settings</c>. 457will be pulled in automatically if you install
458<c>>=media-video/nvidia-drivers-100.14.09</c> with the <c>gtk</c> USE flag set
459in <path>/etc/make.conf</path> or in <path>/etc/portage/package.use</path>.
474</p> 460</p>
475 461
476</body> 462</body>
477</section> 463</section>
478</chapter> 464</chapter>
539installed into <c>/usr/share/doc</c> and can be viewed with the following 525installed into <c>/usr/share/doc</c> and can be viewed with the following
540command: 526command:
541</p> 527</p>
542 528
543<pre caption="Viewing the NVIDIA documentation"> 529<pre caption="Viewing the NVIDIA documentation">
544<comment>(for nvidia-drivers)</comment>
545$ <i>less /usr/share/doc/nvidia-drivers-*/README.gz</i> 530$ <i>less /usr/share/doc/nvidia-drivers-*/README.gz</i>
546<comment>(for nvidia-legacy-drivers)</comment>
547$ <i>less /usr/share/doc/nvidia-legacy-drivers-*/README.gz</i>
548</pre> 531</pre>
549 532
550</body> 533</body>
551</section> 534</section>
552<section> 535<section>
601</pre> 584</pre>
602 585
603</body> 586</body>
604</section> 587</section>
605</chapter> 588</chapter>
606
607</guide> 589</guide>

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

  ViewVC Help
Powered by ViewVC 1.1.20