[gentoo-doc-cvs] cvs commit: nvidia-guide.xml

[Josh Saddler]

nightmorph    07/07/22 07:32:10

  Modified:             nvidia-guide.xml
  Log:
  update nvidia references as nvidia-legacy-drivers is deprecated and will be removed. nvidia-drivers now contains every available version. see Cardoe's message to gentoo-dev for more information.

Revision  Changes    Path
1.41                 xml/htdocs/doc/en/nvidia-guide.xml

file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/nvidia-guide.xml?rev=1.41&view=markup
plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/nvidia-guide.xml?rev=1.41&content-type=text/plain
diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/nvidia-guide.xml?r1=1.40&r2=1.41

Index: nvidia-guide.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/nvidia-guide.xml,v
retrieving revision 1.40
retrieving revision 1.41
diff -u -r1.40 -r1.41
--- nvidia-guide.xml	16 Apr 2007 05:39:54 -0000	1.40
+++ nvidia-guide.xml	22 Jul 2007 07:32:10 -0000	1.41
@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding="UTF-8"?>
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/nvidia-guide.xml,v 1.40 2007/04/16 05:39:54 nightmorph Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/nvidia-guide.xml,v 1.41 2007/07/22 07:32:10 nightmorph Exp $ -->
 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
 
 <guide link="/doc/en/nvidia-guide.xml">
@@ -8,11 +8,11 @@
 <author title="Author">
   <mail link="swift@g.o">Sven Vermeulen</mail>
 </author>
-<author title="Editor">
-  <mail link="curtis119@g.o">M Curtis Napier</mail>
+<author title="Author">
+  <mail link="nightmorph@g.o">Joshua Saddler</mail>
 </author>
 <author title="Editor">
-  <mail link="nightmorph@g.o">Joshua Saddler</mail>
+  <mail link="curtis119@g.o">M Curtis Napier</mail>
 </author>
 <author title="Editor">
   <mail link="wolf31o2@g.o">Chris Gianelloni</mail>
@@ -28,8 +28,8 @@
 <!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
 <license/>
 
-<version>1.31</version>
-<date>2007-04-15</date>
+<version>1.32</version>
+<date>2007-07-22</date>
 
 <chapter>
 <title>Introduction</title>
@@ -42,22 +42,29 @@
 to the card. The drivers consist of two parts, a kernel module, and an X11
 driver. Both parts are included in a single package. Due to the way nVidia has
 been packaging their drivers, you will need to make some choices before you
-install the drivers. Currently, there are two driver packages in the tree. The
-first, <c>nvidia-drivers</c>, is the latest drivers from nVidia and includes
-support for the latest cards. The second, <c>nvidia-legacy-drivers</c>, supports
-older cards, from the original TNT through the GeForce 6800. However, this
-driver does not support the latest features of the newer cards. You should only
-use <c>nvidia-legacy-drivers</c> if your cards is not supported in the
-<c>nvidia-drivers</c> package.
+install the drivers.
+</p>
+
+<p>
+Currently, there are two driver packages in the tree, though this will be
+reduced to just one package in the near future. The first,
+<c>nvidia-drivers</c>, contains the latest drivers from nVidia with support for
+<e>all</e> cards, with several versions available depending on how old your
+card is. It uses an eclass to detect what kind of card you're running so that it
+installs the proper version. The second package, <c>nvidia-legacy-drivers</c>,
+supports older cards. It is deprecated in favor of the all-inclusive
+<c>nvidia-drivers</c> package, which contains the same driver version(s). <b>Do
+not install <c>nvidia-legacy-drivers</c></b>; it's only kept in the tree to give
+its current users time to switch over to the new package. You should only use
+<c>nvidia-drivers</c>, as explained in the next chapter.
 </p>
 
 <note>
 Previously, Gentoo provided separate ebuilds for the nVidia kernel module
 (<c>nvidia-kernel</c>) and the X11 GLX libraries (<c>nvidia-glx</c>). These
 ebuilds have since been removed from the Portage tree in favor of
-<c>nvidia-drivers</c> and <c>nvidia-legacy-drivers</c>. If you use
-<c>nvidia-kernel</c> and <c>nvidia-glx</c>, then you should migrate to the
-newer packages.
+<c>nvidia-drivers</c>. If you use <c>nvidia-kernel</c> and <c>nvidia-glx</c>,
+then you should migrate to the newer packages.
 </note>
 
 </body>
@@ -67,37 +74,47 @@
 <chapter>
 <title>Driver compatibility</title>
 <section>
-<title>nvidia-legacy-drivers</title>
+<title>Which version?</title>
 <body>
 
 <p>
-The <c>nvidia-legacy-drivers</c> branch supports older nVidia cards which are no
-longer supported in the latest driver releases. This branch is based on an older
-code base of the nVidia drivers, and supports the latest kernels and X.Org
-versions. You should use this driver if you have a TNT, TNT2, GeForce, or
-GeForce 2 series card. The driver compatibility information can be found in
-Appendix A of
-<uri>http://download.nvidia.com/XFree86/Linux-x86/1.0-7184/README/readme.txt</uri>.
+The <c>nvidia-drivers</c> package supports the full range of available nVidia
+cards. Multiple versions are available for installation, depending on the
+card(s) you have.
 </p>
 
-</body>
-</section>
-<section>
-<title>nvidia-drivers</title>
-<body>
+<p>
+Newer cards such as the GeForce 8, 7, 6, and FX 5 series should use the newer
+drivers from the 100.x series.
+</p>
 
 <p>
-The <c>nvidia-drivers</c> branch supports the features in newer nVidia cards.
-The latest version of these drivers has dropped support for the NV2x based
-cards. If you have a GeForce 3 or GeForce 4 series card, you should mask
+Older cards such as the GeForce 3 or GeForce 4
+series require the 96xx drivers. For these cards, you should mask
 <c>>=x11-drivers/nvidia-drivers-1.0.9700</c> in your
 <path>/etc/portage/package.mask</path> file. This will prevent newer versions of
-the driver which are incompatible with your card from being installed. You can
-check for driver compatibility for your card at to determine if it is supported
-on the newer drivers at
-<uri>http://us.download.nvidia.com/XFree86/Linux-x86/1.0-9746/README/appendix-a.html</uri>.
+the driver which are incompatible with your card from being installed.
+</p>
+
+<p>
+Old NV2x-based cards (such as TNT, TNT2, GeForce, and GeForce 2) require the
+older 71xx drivers (such as <c>nvidia-drivers-1.0.7185</c>). For these cards,
+you should mask <c>>=nvidia-drivers-1.0.8700</c> in
+<path>/etc/portage/package.mask</path>.
 </p>
 
+<p>
+You can check for driver compatibility for your card at to determine which
+driver supports it at
+<uri>http://us.download.nvidia.com/XFree86/Linux-x86_64/100.14.11/README/appendix-a.html</uri>.
+</p>
+
+<impo>
+The <c>nvidia-legacy-drivers</c> package is deprecated and should not be
+installed on a fresh system.  Although it is a 71xx driver, the corresponding
+71xx driver version found in <c>nvidia-drivers</c> should be used instead.
+</impo>
+
 </body>
 </section>
 </chapter>
@@ -203,91 +220,48 @@
 <body>
 
 <p>
-The <c>nvidia-drivers</c> and <c>nvidia-legacy-drivers</c> ebuilds automatically
-discover your kernel version based on the <path>/usr/src/linux</path> symlink.
-Please ensure that you have this symlink pointing to the correct sources and
-that your kernel is correctly configured.  Please refer to the "Configuring the
-Kernel" section of the <uri link="/doc/en/handbook/">Installation Handbook</uri>
-for details on configuring your kernel.
+The <c>nvidia-drivers</c> ebuild automatically discovers your kernel version
+based on the <path>/usr/src/linux</path> symlink. Please ensure that you have
+this symlink pointing to the correct sources and that your kernel is correctly
+configured. Please refer to the "Configuring the Kernel" section of the <uri
+link="/doc/en/handbook/">Installation Handbook</uri> for details on configuring
+your kernel.
 </p>
 
 <p>
-If you are using gentoo-sources-2.6.11-r6, your <path>/usr/src</path> directory
-might look something like this:
+First, you'll need to emerge <c>eselect</c> (if you don't already have it). If
+you are using <c>gentoo-sources-2.6.18-r4</c>, your kernel listing might look
+something like this:
 </p>
 
 <pre caption="Check your /usr/src/linux symlink">
-# <i>cd /usr/src</i>
-# <i>ls -l</i>
-<comment>(Check that linux points to the right directory)</comment>
-lrwxrwxrwx   1 root root   22 Apr 23 18:33 linux -&gt; linux-2.6.11-gentoo-r6
-drwxr-xr-x   4 root root  120 Apr  8 18:56 linux-2.4.26-gentoo-r4
-drwxr-xr-x  18 root root  664 Dec 31 16:09 linux-2.6.10
-drwxr-xr-x  18 root root  632 Mar  3 12:27 linux-2.6.11
-drwxr-xr-x  19 root root 4096 Mar 16 22:00 linux-2.6.11-gentoo-r6
+# <i>eselect kernel list</i>
+Available kernel symlink targets:
+  [1]   linux-2.6.18-gentoo-r4 *
+  [2]   linux-2.6.20-gentoo-r7
+  [3]   linux-2.6.20-gentoo-r8
+<comment>(Verify that the right kernel is marked with an asterisk</comment>
 </pre>
 
 <p>
-In the above output, you'll notice that the <c>linux</c> symlink is pointing
-to the <c>linux-2.6.11-gentoo-r6</c> kernel.
+In the above output, you'll notice that the <c>linux-2.6.18-gentoo-r4</c> kernel
+is marked with an asterisk (<b>*</b>) to show that it is the symlinked kernel.
 </p>
 
 <p>
 If the symlink is not pointing to the correct sources, you must update the link
-like this:
+by selecting the number of your desired kernel sources, as in the example
+above.
 </p>
 
 <pre caption="Create/Update /usr/src/linux symlink">
-# <i>cd /usr/src</i>
-# <i>ln -snf linux-2.6.11-gentoo-r6 linux</i>
+<comment>(Select the correct kernel)</comment>
+# <i>eselect kernel set 1</i>
 </pre>
 
 </body>
 </section>
 <section>
-<title>Optional: Check for Legacy Card Support</title>
-<body>
-
-<note>
-Unfortunately, certain legacy video cards are not supported by the newer
-versions of <c>nvidia-drivers</c>.
-nVidia provides a <uri link="http://www.nvidia.com/object/IO_18897.html">list
-of supported cards</uri>. Please check the list before installing the drivers.
-</note>
-
-<p>
-The following is a list of <b>unsupported</b> legacy video cards:
-</p>
-
-<pre caption="Unsupported cards">
-TNT
-TNT2
-TNT2 Pro
-TNT2 Ultra
-TNT2 Model 64 (M64)
-TNT2 Model 64 (M64) Pro
-Vanta
-Vanta LT
-GeForce 256
-GeForce DDR
-GeForce2 GTS
-GeForce2 Pro
-GeForce2 Ti
-GeForce2 Ultra
-GeForce2 MX Integrated graphics
-Quadro
-Quadro2 Pro
-Quadro2 EX
-</pre>
-
-<p>
-If your card is listed in the legacy list, then you will be required to install
-the <c>nvidia-legacy-drivers</c> package to get 3D support.
-</p>
-
-</body>
-</section>
-<section>
 <title>Installing the Appropriate Drivers</title>
 <body>
 
@@ -296,17 +270,24 @@
 </p>
 
 <pre caption="Installing the nVidia drivers">
-<comment>(If you have a card not listed in the legacy list above)</comment>
 # <i>emerge nvidia-drivers</i>
-<comment>(If your card is listed in the legacy list)</comment>
-# <i>emerge nvidia-legacy-drivers</i>
 </pre>
 
+<note>
+The newer 100.x drivers can be installed with the <c>gtk</c> USE flag set. This
+will install <c>media-video/nvidia-settings</c>, a handy graphical tool for
+monitoring and configuring several aspects of your nVidia card.
+</note>
+
 <impo>
-Every time you <uri link="/doc/en/kernel-upgrade.xml">compile a new
-kernel</uri> or recompile the current one, you will need to run <c>emerge
-nvidia-drivers</c> or <c>emerge nvidia-legacy-drivers</c> to reinstall the
-nVidia modules.
+Every time you <uri link="/doc/en/kernel-upgrade.xml">compile a new kernel</uri>
+or recompile the current one, you will need to run <c>emerge nvidia-drivers</c>
+to reinstall the nVidia modules. An easier way to keep track of modules
+installed by ebuilds (such as <c>nvidia-drivers</c>) is to install
+<c>sys-kernel/module-rebuild</c>. Once you've installed it, simply run
+<c>module-rebuild populate</c> to populate its database with a list of packages
+to be rebuilt. Once you've finished compiling or recompiling a kernel, just run
+<c>module-rebuild rebuild</c> to rebuild the drivers for your new kernel.
 </impo>
 
 <p>
@@ -323,15 +304,13 @@
 <p>
 To prevent you having to manually load the module on every bootup, you probably
 want to have this done automatically each time you boot your system, so edit
-<path>/etc/modules.autoload.d/kernel-2.6</path> (or <path>kernel-2.4</path>,
-depending on which kernel version you use) and add <c>nvidia</c> to it. Don't
-forget to run <c>update-modules</c> afterwards.
+<path>/etc/modules.autoload.d/kernel-2.6</path> and add <c>nvidia</c> to it.
+Don't forget to run <c>update-modules</c> afterwards.
 </p>
 
 <impo>
 If you compiled <c>agpgart</c> as a module, you will need to add it to
-<path>/etc/modules.autoload.d/kernel-2.6</path> (or <path>kernel-2.4</path>
-depending on your kernel version).
+<path>/etc/modules.autoload.d/kernel-2.6</path>.
 </impo>
 
 <pre caption="Running update-modules">
@@ -409,7 +388,7 @@
 
 <p>
 You have to add your user to the <c>video</c> group so he has access to the
-nvidia device files:
+nVidia device files:
 </p>
 
 <pre caption="Adding your user to the video group">
@@ -449,13 +428,18 @@
 
 <p>
 Some tools, such as <c>mplayer</c> and <c>xine-lib</c>, use a local USE flag
-called "nvidia" which enables XvMCNVIDIA support, useful when watching high
-resolution movies. Add in "nvidia" in your USE variable in
+called <c>xvmc</c> which enables XvMCNVIDIA support, useful when watching high
+resolution movies. Add in <c>xvmc</c> in your USE variable in
 <path>/etc/make.conf</path> or add it as USE flag to <c>media-video/mplayer</c>
 and/or <c>media-libs/xine-lib</c> in <path>/etc/portage/package.use</path>.
 </p>
 
 <p>
+There are also some applications that use the <c>nvidia</c> USE flag, so you
+may want to add it to <path>/etc/make.conf</path>.
+</p>
+
+<p>
 Then, run <c>emerge -uD --newuse world</c> to rebuild the applications that
 benefit from the USE flag change.
 </p>
@@ -467,10 +451,12 @@
 <body>
 
 <p>
-Since nVidia released version 1.0.6106 it also provides you with a settings
-tool. This tool allows you to change graphical settings without restarting the
-X server and is available through Portage as
-<c>media-video/nvidia-settings</c>.
+nVidia also provides you with a settings tool. This tool allows you to monitor
+and change graphical settings without restarting the X server and is available
+through Portage as <c>media-video/nvidia-settings</c>. As mentioned earlier, it
+will be pulled in automatically if you install
+<c>>=media-video/nvidia-drivers-100.14.09</c> with the <c>gtk</c> USE flag set
+in <path>/etc/make.conf</path> or in <path>/etc/portage/package.use</path>.
 </p>
 
 </body>
@@ -541,10 +527,7 @@
 </p>
 
 <pre caption="Viewing the NVIDIA documentation">
-<comment>(for nvidia-drivers)</comment>
 $ <i>less /usr/share/doc/nvidia-drivers-*/README.gz</i>
-<comment>(for nvidia-legacy-drivers)</comment>
-$ <i>less /usr/share/doc/nvidia-legacy-drivers-*/README.gz</i>
 </pre>
 
 </body>
@@ -603,5 +586,4 @@
 </body>
 </section>
 </chapter>
-
 </guide>



-- 
gentoo-doc-cvs@g.o mailing list