Differences between revisions 1 and 200 (spanning 199 versions)
Revision 1 as of 2005-11-14 06:49:41
Size: 5161
Comment: just starting
Revision 200 as of 2012-07-03 20:58:29
Size: 31636
Editor: ?ShawnLandden
Comment: this is pretty out of date
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
This document explains how to make use of NVIDIA video hardware for ["Debian"] GNU/Linux users, who are the primary target. However, most (if not all) of Debian derivatives, including Libranet, Mepis, Ubuntu, and Xandros, should work in the same way. The following section shortly describes the ["free"] drivers while the rest of the document covers the non-free but 3D-accelerated drivers. #language en
~-[[DebianWiki/EditorGuide#translation|Translation(s)]]: English - [[es/NvidiaGraphicsDrivers|Español]] - [[fr/NvidiaGraphicsDrivers|Français]] - [[it/NvidiaGraphicsDrivers|Italiano]] - [[ru/NvidiaGraphicsDrivers|Русский]]-~
----
 . This document explains how to make use of NVIDIA video hardware on a [[Debian]] GNU/Linux system. The [[#free|following section]] shortly describes the free drivers while the [[#non-free|rest of the document]] covers the non-free but 3D-accelerated drivers.
<<TableOfContents>>

<<Anchor(free)>>
Line 4: Line 10:
Two free drivers in Debian support NVIDIA cards. You are probably reading this page using one of these drivers. The '''vesa''' driver is a generic video driver. You should get better results with the '''nv''' driver. You can see which one is in use .........................
You can simply [wiki:Self:ConfigureX configure X] to change the free driver to use.

However, both of these drivers do not support 3D acceleration. Only the ["non-free"] '''nvidia''' driver supports this. If you are willing to use this driver despite the fact that it is non-free, read the following section. If you do, keep in mind that using the non-free drivers is considerably more complex and things are much more likely to break. If this happens and you give up trying to get X working again due to the '''nvidia''' driver, remember that simply switching back to one of the free drivers should let you run X again until you find a way to get 3D acceleration working again.
Debian has three free drivers that support NVIDIA cards. You can see which one is in use by running

{{{
$ grep -B2 'Module class: X.Org Video Driver' /var/log/Xorg.0.log
}}}

You can simply [[ConfigureX|configure X]] to change the free driver to use.

None of the free drivers fully support 3D acceleration, though the Nouveau drivers [[http://nouveau.freedesktop.org/wiki/MesaDrivers|have some 3D acceleration]]. Only the non-free ''nvidia'' drivers support full 3D acceleration, but they are more complex and X is more likely to break, you're reliant on nvidia to fix bugs. If X breaks and it seems difficult to get X to work with the non-free ''nvidia'' drivers, remember that switching back to a free driver should get X working again.

== vesa ==

The ''vesa'' driver is a generic video driver.

== nv ==

The ''nv'' driver usually gives better results than ''vesa'', but it is not included on wheezy or newer releases.

== Nouveau ==
In addition to ''vesa'' and ''nv'', Debian contains the Nouveau drivers starting with squeeze. The Nouveau drivers are reverse-engineered from official NVIDIA drivers. These drivers are experimental.

=== Installation ===

To use the nouveau drivers, your kernel drm version and your libdrm version need to match. The installation can basically be done this way:
{{{
# apt-get install xserver-xorg-video-nouveau
}}}
Then [[ConfigureX|configure X]] and set ''nouveau'' as your device driver.

<<Anchor(non-free)>>
Line 10: Line 42:
== Why a Debian-specific method? ==

To install the NVIDIA drivers, you can use either NVIDIA's official installer or the Debian driver packages. Each method has its advantages, as described below. NVIDIA's installer used to be easier to use; but with the advent of module-assistant, the Debian way is probably easier. Even if you choose to build your driver module manually, in the long run you'll probably find that the Debian way will save you work. The Debian way is of course the most reliable.

Unless you had issues with the Debian way, you probably just want to skip to the '''Installation''' section. NVIDIA's installer is already documented at other places (such as [http://www.gmpf.de/index.php/NVidia:Basic_Installation this one]), so the Installation section of this HOWTO is all about the Debian way. Either way, you may find the Troubleshooting section to be of interest.
== Why use a Debian-specific method? ==
NVIDIA drivers can be installed using NVIDIA's official installer or the Debian driver packages. Each method has its advantages, but the Debian way is probably easier. Even when building a driver module manually, the Debian way is more reliable and probably will save labor in the long run.

NVIDIA's installer is documented at other places such as [[NvidiaGraphicsDriversNvidiaWay|this one]].

Whichever installation method, the [[#Troubleshooting|troubleshooting section]] may help.
Line 17: Line 50:
..............
The method described here is "the Debian way": you install Debian packages as usual, for your specific kernel. This method has some advantages, compared to using NVIDIA's official installer:

    * It's more automated once it's set up, so it saves you work if you rebuild your kernel very often, as I do.
    * It uses the Debian package management tools, so it's cleaner.
    * If you're already using make-kpkg to build your kernel, it fits easily into your existing build procedure.
    * It will also save you work if you build other kernel modules (e.g. lm-sensors or fuse) outside of the kernel tree, because all of the driver packages get built at the same time with a single invocation of make-kpkg.
    * module-assistant has now taken much of the grunt work out of this task, making it about as easy as using the official installer.

However, you don't have to build your drivers this way. Many people prefer just to get and run an official installer from nVidia. This method also has advantages:

    * You may get more recent versions of the NVIDIA drivers, since the Debian packages tend to lag by a month or two, which can be needed if the version in Debian didn't support your hardware. You can compare the [http://www.nvidia.com/object/unix.html current version] and the [http://packages.debian.org/nvidia-glx version in your Debian release] to see how much difference there is.
    * The official installer is easy to use, although you will probably get tired of rerunning it if you rebuild your kernel more than a few times. (Every time you rebuild your kernel you have to wait until you reboot, wait for your X server to die, navigate the installer menus, and then restart X. It gets old. That's why this guide was writen :)
    * You won't have to learn about module-assistant, or make-kpkg. Wait, is this an advantage?
    * People have occasionally reported that even after some work, they just couldn't get their drivers to work using the Debian way. Once they used the NVIDIA installer everything worked smoothly.

== Target audience ==
The following method should work with any 2.4 or 2.6 Linux kernel, with either stock or custom kernels, and with ["Sarge"], ["Etch"] and ["Sid"] (assuming Sid works). Although there are Debian packages for the drivers in ["Woody"], if you are looking to make some fun gaming, consider the fun of upgrading to Sarge first.
Advantages of "the Debian way":

 * More automated, which saves work if the kernel is changed.
 * Uses Debian package management tools, so it's cleaner. If your system breaks after using the Debian way, that would be a bug which can be reported in the BTS.
 * Can be done while X is running. (X must be restarted to apply the driver change.)
 * Users of ''make-kpkg'' should find it fits easily into their existing build procedure.
 * No downloading files from ''nvidia.com'', the Debian packages contain all necessary parts.
Advantages of NVIDIA's official installer:

 * Most recent NVIDIA driver versions. Debian packages commonly lag behind a month or more. You can compare the [[http://www.nvidia.com/object/unix.html|current version]] and the [[DebianPkg:nvidia-glx|latest version in your Debian release]] to see if there's a difference.
<<Anchor(Installation)>>
Line 37: Line 63:

How to install the NVIDIA 3D drivers, the Debian way.

=== Overview ===
The NVIDIA 3D drivers consist of two parts: a kernel module, and a collection of user-space libraries and a X video driver. The libraries and the X driver (sometimes called the "binary driver" or GLX libraries) are distributed in binary form by NVIDIA, and are packaged for Debian in the DebianPkg:nvidia-glx packages. Since NVIDIA's 3D drivers are not open source, non-free APT sources are needed to install them. The kernel module (aka the "kernel interface to the binary driver") is distributed in source form (though with one binary component), and packaged for Debian in the DebianPkg:nvidia-kernel-source packages. The version numbers of the kernel module and user-space libraries and X video driver must match. User libraries only need be installed once, but the kernel module must be recompiled every time the kernel is changed. What to do:

 * 0. Make sure APT has ''non-free'' and ''contrib'' sources (consult the [[DebianMan:5/sources.list|sources.list(5)]] man page for help on doing this)
 * 1. Determine which version of the drivers should be installed.
 * 2. Install the kernel module
 * 3. Install the user-space GLX libraries and the X driver
 * 4. Configure X to use the ''nvidia'' driver
Steps 3 and 4 need only be done once, but Step 2 is required every time the kernel is changed.

=== Steps ===
<<Anchor(Legacy)>>

==== Choose a driver version ====
The current drivers do not support some legacy NVIDIA cards. Up to now, the NVIDIA drivers dropped support for some legacy cards 3 times. However, NVIDIA maintains the last driver version released before a legacy cards support drop. This means there are currently 4 drivers series maintained by NVIDIA. The first support drop happened in 2005, so the oldest legacy drivers series (71''xx'') should support cards released before 2005 but not those released after 2005. The second support drop happened in 2006, leading to the 96''xx'' legacy drivers series. The third support drop happened in 2008, leading to the 173.14 legacy drivers series.

No Debian suite contains the 4 available drivers series, but it may be possible to install unofficial packages if your card requires a drivers series not available in your suite. Squeeze and Lenny both contain the newest and second newest legacy series, 173.14 and 96.43. Squeeze also contains the current series. Wheezy only contains the current series. The oldest drivers series, 71xx, is not in any current Debian suite (except unstable, but unusable). It is basically impossible to use the nvidia driver on cards no longer supported after 71xx on a current Debian suite.

The 71xx version is the only one to support RIVA TNT, RIVA TNT2/TNT2 Pro, RIVA TNT2 Ultra, Vanta/Vanta LT, RIVA TNT2 Model 64/Model 64 Pro, Aladdin TNT2, !GeForce 256, !GeForce DDR, Quadro, !GeForce2 GTS / !GeForce2 Pro, !GeForce2 Ti, !GeForce2 Ultra and Quadro2 Pro. Versions newer than 96.43 do not support !GeForce2 and !GeForce4 cards. [[http://www.nvidia.com/object/IO_32667.html|A more detailed list]] of cards only supported by legacy drivers is available.

Debian distributes several versions of the drivers using several packages with different names. For example, the X driver and user-space libraries from the current series are in the ''nvidia-glx'' package. However, with time, the current drivers become legacy drivers, so the ''nvidia-glx'' package in Lenny is not current anymore.

Use current drivers if possible. You can determine which cards are supported by consulting [[http://us.download.nvidia.com/XFree86/Linux-x86/195.36.24/README/supportedchips.html|Appendix A of NVIDIA's 195.36.24 driver README]].

Set a VERSION variable, which the rest of the instructions will refer to, to "-legacy-96xx", "-legacy-173xx" or an empty string. If you want to install the default version from your suite, there is no need to set VERSION to the empty string. To find the name of a card, you can try ''lspci''. To determine which version you should use, you can run [[attachment:nvidia-versions.sh|this script]], which will propose to set VERSION.

==== Install the kernel module ====
===== Stock or custom kernel? =====
Some of the installation methods below depend on whether you're running a stock kernel, i.e. a prebuilt kernel from the Debian distribution. If you know which kind of kernel you have, you can skip to the [[#Methods|following section]].

By default, Debian comes with a stock kernel. If you don't know what kind of kernel you're running, then it's probably a stock kernel. If you're not sure, run

{{{
$ uname -r
}}}
and check if the output looks like 2.*.*-small number-architecture (e.g. or 2.6.18-6-486). If it does, you're most likely running a stock kernel.

<<Anchor(Methods)>>

===== Methods =====
There are five different methods for installing the kernel module.

<<Anchor(Method1)>>

===== Use module-assistant =====
This method is easy, and should work with most stock or custom kernels. For a custom kernel, you need to have its Linux headers installed.

It needs DebianPkg:module-assistant and DebianPkg:nvidia-kernel-common. To install them with apt-get:

{{{
# apt-get install module-assistant nvidia-kernel-common
}}}
Run the following command:

{{{
# m-a auto-install nvidia-kernel${VERSION}-source
}}}
And that's it. If all went well, your ''nvidia'' kernel module is now built and installed; you may [[#Libraries|proceed to step 3]]. If not, read the rest of this section.

You must use the same version of gcc to build your nvidia kernel module as was used to build your kernel. This might be a problem if you are running a stock kernel. If module-assistant fails, read its log output and look for messages suggesting that you need, for example, gcc-4.0 instead of gcc-4.1. Then install the corresponding package and retry ''auto-install''.

The ''auto-install'' step is the biggest step of the procedure, and is the most likely to fail. ''auto-install'' can be divided in smaller module-assistant steps, which can help debugging:

 * ''get''
 * ''build''
 * ''install''
If # m-a get nvidia; fails, try installing the DebianPkg:nvidia-kernel-source package. If APT fails to install nvidia-kernel-source, you should go back to step 0 and make sure you didn't miss something.

If you are unable to install the module using module-assistant, try [[#Method2|installing a pre-built module]] if you use a stock kernel or try to [[#Method4|build manually, with a custom kernel]].

<<Anchor(Method2)>>

===== Install a pre-built module =====
This method is easy if you're running a recent stock kernel for which a pre-built module is available; it will not work at all if you're running a custom kernel or if you're running Debian 6 and need a legacy driver. There are pre-built modules available for all the kernels installed by default by Debian Lenny, and pre-built modules for the current drivers series for all kernels installed by default by Debian Squeeze. If the module-assistant method doesn't work for you and there are pre-built modules available for your kernel, use this method.

If you don't know your kernel version, run

{{{
$ uname -r
}}}
If there is a pre-built module for your kernel, install its package. The name starts with "nvidia-kernel-". This is followed by an indication of the drivers series you want (this string is empty for the default drivers series). The name ends by the identifier of your Linux image. For example, with apt-get:

{{{
# apt-get install nvidia-kernel${VERSION}-$(uname -r)
}}}
If this step succeeds, you may now [[#Libraries|proceed to step 3]]. If there are no pre-built modules for your kernel, and [[#Method1|method 1]] and [[#Method3|method 3]] fail, you may want to try [[#Method5|method 5]].

<<Anchor(Method3)>>

===== Use DKMS =====
This is the easiest method and recommended unless you have some reason to not want to install a compiler.

All you need to do is install the kernel headers package for the Linux image that you're running (usually named '''linux-headers-<version>''' where <version> is whatever version of kernel you're running) and then install '''nvidia-kernel-dkms''' or the nvidia-kernel-legacy-...-dkms package for the legacy version of the drivers that you need.

DKMS will take care of the build and install process automatically.

<<Anchor(Method4)>>

===== Build manually, with a custom kernel =====
Use this method if you're configuring and building a custom kernel. This method is known to be possibly inexact or incomplete.

 1. Install the kernel module source. For example, with apt-get:
 {{{
# apt-get install nvidia-kernel${VERSION}-source
}}}
 This will install a source tarball in ''/usr/src/''. Unpack it in ''/usr/src'':
 {{{
$ cd /usr/src
# tar -xf nvidia-kernel-*.tar.gz
}}}
 This will unpack the kernel module sources into ''/usr/src/modules/nvidia-kernel[something]''.

 1. Configure your kernel. This step isn't documented here; if you need to learn how, see the kernel-package documentation. But in summary, what you have to do is
 {{{
$ cd /usr/src/linux
# make xconfig
}}}
 and then choose the options you want. Note, however, that each of the following kernel options has been reported to cause trouble with the ''nvidia'' driver (the first 2 are gone for Debian 7):
  * Device drivers –> Graphics Support –> nVidia Riva support (FB_RIVA)
  * Device drivers –> Graphics support –> nVidia Framebuffer Support (FB_NVIDIA)
  * Device drivers –> Graphics support –> VESA VGA graphics support (FB_VESA)
  * Processor Type and Features –> Local APIC support on uniprocessors (X86_UP_APIC) (not available if you have an SMP kernel, including hyperthreading)
 It is therefore recommended that you disable all of the above options in your kernel configuration. If for some reason you don't disable them, and then your X display doesn't work properly with the ''nvidia'' driver, you should suspect these options as the likely cause of the trouble. For more details, see the Troubleshooting section.

 1. Build the kernel and the ''nvidia'' kernel module:
 {{{
# make-kpkg clean
# make-kpkg kernel_image modules_image
}}}
 For an introduction to using make-kpkg to build kernel packages, see [[http://newbiedoc.sourceforge.net/system/kernel-pkg.html|Creating custom kernels with Debian's kernel-package system]], or [[http://www.debianuniverse.com/readonline/chapter/21|Compiling Kernels the Debian Way]]. See also the [[DebianMan1/make-kpkg|make-kpkg(1)]] man page, for a description of other options and targets that you can use in this command. The result of the above command will be two Debian package files, linux-image-*.deb and nvidia-kernel-*.deb, both in /usr/src or /usr/src/modules. The first file contains your kernel, and the second contains your '''nvidia''' kernel module. <<BR>>At the same time, if you have sources for any other add-on kernel modules in /usr/src/modules, then the "modules_image" target will cause make-kpkg to build Debian package files for them, too. For example, if you install the fuse-source package you'll get a source archive /usr/src/fuse.tar.gz, which you can unpack to get fuse module sources in /usr/src/modules/fuse. If you've done this, then this same invocation of make-kpkg will also build a fuse module package file, /usr/src/fuse-*.deb, that's specific to your new kernel.

 1. Install the new kernel and kernel module:
 {{{
$ cd /usr/src
# dpkg -i /path/linux-image-*.deb /path/nvidia-kernel-*.deb
}}}
 Use the fileglobs as above if you want, but watch out that you don't have more than one Linux image or nvidia-kernel package file lying around in /usr/src. If you do you'll get a blizzard of error messages. It's probably better to explicitly type all of the version information rendered as * above.
  
 1. Boot your new kernel. Before trying to get the NVIDIA 3D drivers to work, make sure that the new kernel boots and that X starts well using a free X driver.
[[#Libraries|Proceed to step 3]].

<<Anchor(Method5)>>

===== Build manually, with a stock kernel =====
Use this method if you're running a stock kernel and the two first methods failed. module-assistant should automate this process. In other words, if the first method failed but this one works, you should probably submit a bug report against module-assistant.

The following procedure is adapted from the instructions in /usr/share/doc/nvidia-kernel-source/README.Debian and is known to be potentially inexact.

 1. Save the release number of your kernel (e.g. 2.6.18-6-686) in a couple of environment variables:
 {{{
export KVERS=$(uname -r)
export KSRC=/usr/src/linux-headers-$KVERS
export KPKG_DEST_DIR=/usr/src
}}}
 Note that these variables are used by the build commands below, so you really do need to set and export them, as in the above commands.
 1. Install the kernel module source: run
 {{{
apt-get install nvidia-kernel-source nvidia-kernel-common
}}}
 This will give you a source tarball /usr/src/nvidia-kernel-source.tar.gz. Unpack it with
 {{{
cd /usr/src
tar -zxf nvidia-kernel-source.tar.gz
}}}
 This will unpack the kernel module sources into /usr/src/modules/nvidia-kernel.
 In case there is no such tarball, but /usr/src/nvidia-kernel.tar.bz2, unpack it with
 {{{
cd /usr/src
tar -jxf nvidia-kernel.tar.bz2
}}}
 1. Install the header files for your kernel:
 {{{
apt-get install linux-headers-$KVERS
}}}
 This will give you kernel header files in /usr/src/linux-headers-$KVERS. Be sure to check that the installed kernel image and kernel header packages have the same version number: run
 {{{
apt-cache policy linux-image-$KVERS linux-headers-$KVERS
}}}
 and check that the version number listed as Installed is the same for both packages. If it isn't, find the distribution that has the version of linux-headers that you need, e.g. testing, and rerun the above installation command, adding '-t testing' (or whichever).
 1. Build the kernel module package:
 {{{
cd /usr/src/modules/nvidia-kernel
debian/rules binary-modules
}}}
 The result will be a package file /usr/src/nvidia-kernel-*.deb, which contains your kernel module. Note: several users have told me recently that their nvidia package file ends up in /usr/src/modules, instead of /usr/src. I don't know yet why this happens. If this is your case, please adjust the next command appropriately.
 1. Install the kernel module:
 {{{
dpkg -i /usr/src/nvidia-kernel-*.deb
}}}
 Use the fileglob as above if you want, but watch out that you don't have more than one nvidia-kernel package file lying around in /usr/src. If you do you'll get a blizzard of error messages. It's probably better to explicitly type all of the version information that I rendered as * above.
Now [[#Libraries|proceed to step 3]], below. <<Anchor(Libraries)>>

==== Install the NVIDIA X driver and user-space libraries ====
Install the X driver and user-space libraries package. For example, with apt-get:

{{{
# apt-get install nvidia-glx${VERSION}
}}}
Note: The reason this step has to come after step 2 is that nvidia-glx depends on a virtual package called 'nvidia-kernel-$NVVERSION', where $NVVERSION is the upstream part of the version of the nvidia-glx package. This virtual package should be provided by the kernel module package that you installed in step 2; so you have to complete that step first. If the installation of nvidia-glx fails because the 'nvidia-kernel-$NVVERSION' isn't satisfied, you should probably make sure that step 2 went OK.

==== Configure X to use the nvidia driver ====
You can use [[#config-manual|The manual way]] or [[#using-nvidia-xconfig|nvidia-xconfig]], which will create a basic xorg.conf and a final one with your preferred settings.

<<Anchor(config-manual)>>
===== The manual way =====
/etc/X11/xorg.conf can instruct X to use the nvidia driver. If you have one, modify it, otherwise it must be created.

====== Modify an existing xorg.conf ======
Consider backing up your current X configuration file:

{{{
# cp -p /etc/X11/xorg.conf /etc/X11/xorg.conf.bak
}}}
Watch out for typos, and check your X log if things go wrong.

Edit /etc/X11/xorg.conf:

 * If it contains a "Module" section, be sure that it contains a line:
 {{{
Load "glx"
}}}
 and remove or comment out (prepend with a #) any lines that refer to the "dri" or "GLCore" modules.
 * In the "Device" section for your video card, change the driver (normally nv or vesa) to '''nvidia'''. If the driver is not defined, add the line
 {{{
Driver "nvidia"
}}}

====== Create an xorg.conf ======
Create an xorg.conf with the following content:

{{{
Section "Module"
    Load "glx"
EndSection

Section "Device"
    Identifier "Video Card"
    Driver "nvidia"
EndSection
}}}

<<Anchor(using-nvidia-xconfig)>>
===== Using nvidia-xconfig =====
'''Warning''': this method is generally not recommended due to an important X bug (DebianBug:504692).

Install nvidia-xconfig. For example, using apt-get:
{{{
# apt-get install nvidia-xconfig
}}}
Now make a basic xorg.conf to include NVIDIA driver:

{{{
# nvidia-xconfig
}}}

=== Restart X ===
This is the easiest but probably most crucial step. If it doesn't work for some reason, and you want to get back to X before fixing the problem, you'll have to revert step 4 (by choosing a free X driver again). When you think you fixed the problem, you can do step 4 again and retry starting X. Remember that even if it works you'll want to read the [[#Upgrades|next section]] to avoid future trouble. And if it doesn't...check the Troubleshooting section.

If you don't use a display manager, simply close your session. That should bring to a console. If it doesn't, you must be using a display manager (such as gdm, kdm or xdm). First identify which one you're using. If you don't know, it's probably gdm. You can know by checking whether a process ending with "dm" is running. Once you determined which one you use, close your session and go run the appropriate init script in a console. Here's an example for gdm:

{{{
# invoke-rc.d gdm restart
}}}
Alternatively, you can simply press Alt+E at the login screen if you use kdm. If you can't figure out how to restart X with those instructions, you can simply reboot your system. Otherwise, the keyboard shortcut Ctrl+Alt+Backspace should be reliable, despite being somewhat "unfriendly".

==== Check that it worked ====
To check that the acceleration is working, glxinfo can be used. This program is in the mesa-utils package. If

{{{
$ glxinfo |grep rendering
}}}
returns "direct rendering: Yes", acceleration is working. If it returns No, [[#nodri|see section "Hardware acceleration, aka direct rendering, doesn't work"]]. If it returns Yes, 3D acceleration (in games such as !PlanetPenguin Racer or Extreme Tux Racer and Neverball) should work.
<<Anchor(Upgrades)>>

== How to deal with kernel changes and driver upgrades ==
Steps 3 and 4 are done for good. However, you'll have to repeat step 2 in certain situations. If you don't realize such a situation happens, X will fail to start. You can take two approaches with this: either remember when this will happen and try to prevent it, or remember to come back here when your X fails to start. Either way, you're not done for life. If X fails to start because of this, you can again revert step 4 (by choosing a free X driver again) and redo it when you want to retry using the ''nvidia'' driver for X.

=== When ===
Step 2 installs an ''nvidia'' kernel module for a specific kernel and NVIDIA driver version. You'll have to do it for each kernel, and you'll have to redo it for each new driver version. If you don't know what this means, read on.

==== ...will the NVIDIA driver version change ====
If you're using Debian stable, this won't happen until you upgrade to the next Debian release, but it will happen then.

In all cases, this will happen when the nvidia-glx package is upgraded. All versions of nvidia-glx depend on an nvidia-kernel-''version'' virtual package. When you followed step 2, you installed a package providing this virtual package. However, if you upgrade nvidia-glx before doing step 2 again, APT will attempt to satisfy the virtual package, usually by installing nvidia-kernel-dkms. Instead of letting it do, do step 2 again to get an appropriate kernel module. Then, the virtual package will be satisfied and you can upgrade nvidia-glx safely and without installing a useless package.

==== ...will your kernel change ====
If you build other modules using module-assistant, you have to redo step 2 everytime you'd have to run module-assistant for other modules, that is for every new kernel ABI. If you don't know what that means, read on.

If you install a kernel with a new ABI, a new Linux image package will be installed. For example, if the Linux 2.6.18 gets a new ABI and you currently use linux-image-2.6.18-4-486, you will have to install the linux-image-2.6.18-5-486 package to get the new kernel (the "-4" and "-5" part of the package names indicate respectively that these packages contain the fourth and fifth ABI of Debian's 2.6.18 i386 stock kernels). This may happen without your intervention when upgrading your system if the linux-image-2.6-486 meta package is installed. This can also happen if you install a different kernel. For example, you can have both 2.6.26 and 2.6.32 in Lenny. If you did step 2 for 2.6.26 only, you'll need to do it for 2.6.32 too. You'll notice that a new kernel is installed when a new linux-image-''something'' package is installed. X will fail to start after you booted a new kernel until you perform step 2 for that kernel.

= Troubleshooting =
== X doesn't start ==

You'll find log messages in {{{/var/log/Xorg.0.log}}}.

If you're using "nouveau", check "nomodeset" was ''not'' passed to the kernel (edit {{{/etc/default/grub}}}, and if you changed anything run update-grub). Check you don't have the nvidia kernel module loaded ({{{lsmod|grep nvidia}}}, and if necessary {{{rmmod nvidia}}}).

If you're using the "nvidia" driver, make sure the nouveau kernel module isn't loaded ({{{lsmod|grep nouveau}}}, and if necessary {{{rmmod nouveau}}}). If you can't remove the nouveau module and X isn't running, it's usually because the terminal is using it for a better resolution. To prevent this, blacklist the nouveau module (add a line saying "blacklist nouveau" to /etc/modprobe.d/blacklist.conf) and reboot. (Blacklisting the module won't prevent you loading it manually, but will stop it being auto-loaded which is what you want.)

'''Warning: if you switch back to the nouveau driver and don't remove "nomodeset", X won't start.'''

As a last resort, use the "vesa" driver (it nearly always works, but isn't pretty).

== X (or the complete machine when running X) is unstable ==
 * Check whether you use a framebuffer, such as rivafb, nvidiafb and vesafb. The rivafb driver is known to conflict with NVIDIA's drivers. vesafb is known to work in some cases but also to be problematic in other cases. All of these drivers are compiled as modules in stock kernels, except for vesafb. To see if you have one of these modules inserted in your kernel, run
 {{{
$ lsmod|grep 'rivafb\|vesafb\|nvidiafb'
}}}
 If this outputs something, get rid of the module(s) displayed.
 {{{
# rmmod rivafb vesafb nvidiafb
}}}
 will remove the modules temporarily (for this boot). If something causes one of the modules to load automatically at boot, blacklist the modules. If you are using a custom kernel, do not compile these modules in (Device drivers –> Graphics support –> nVidia Riva support (FB_RIVA), Device drivers –> Graphics support –> VESA VGA graphics support (FB_VESA) and Device drivers –> Graphics support –> nVidia Framebuffer Support (FB_NVIDIA)).

<<Anchor(nodri)>>

== Hardware acceleration, aka direct rendering, doesn't work ==
We've covered how to check that the installation worked in section "Check that it worked". If it doesn't, check that you adjusted your X configuration properly. You can do so by checking that

{{{
$ grep Driver /etc/X11/xorg.conf 2>&1|grep nvidia
}}}
returns something. If this is the case but you get an error when trying to use OpenGL apps like glxinfo that looks like this one:

{{{
Error: Could not open /dev/nvidiactl because the permissions
are too resticitive. Please see the FREQUENTLY ASKED QUESTIONS
section of /usr/share/doc/NVIDIA_GLX-1.0/README for steps
to correct.
Fatal signal: Segmentation Fault
}}}
you should make sure that the user running the application is in the ''video'' group.

== Various problems with X ==
Look in your X log file (/var/log/Xorg.0.log). The X server writes a lot of information there about what configuration files it's reading, what display modes it's trying, and errors (EE) it encounters along the way. You can very often find hints there to the source of whatever problem you're having.

== "nvidia license taints kernel" ==
If you get such a warning message on your console or in your syslog, don't worry. Your kernel is fine...or at least as fine as a kernel that can run NVIDIA's 3D driver can be. All this message means is that because your driver isn't open source, you won't get any support from the Linux maintainers if anything goes wrong with your kernel while the module is loaded. See the [[http://www.tux.org/lkml/#s1-18|LKML FAQ]] for more.

== Last resort ==
You can check [[http://www.nvnews.net/vbulletin/forumdisplay.php?f=14|the NVIDIA Linux Forum at nvnews.net]] for issues not related to Debian packaging. For Debian-specific issues, you may look at the bug tracking system or ask a question on Debian help resources, such as the debian-user mailing list and #debian on irc.debian.org.

= More information =
 * For more information about the drivers, see:
  * /usr/share/doc/nvidia-glx/README.Debian
  * /usr/share/doc/nvidia-glx/README.txt.gz
 These files have loads of information about options and for troubleshooting NVIDIA's proprietary drivers. Here's an enticement for you to read them: somewhere in one of them you can find an explanation of how to suppress the NVIDIA splash screen every time you start an X server (hint: search for "No{{{}}}Logo").
 * You can adjust the clock rates of your GPU and video RAM by running nvclock, nvclock_gtk, or nvclock_qt, available respectively in the nvclock, nvclock-gtk, and nvclock-qt packages. Obligatory warning: you can destroy your video hardware with these tools if you're not careful.
 * You can adjust some other, relatively obscure settings of the driver by running nvidia-settings, available in the nvidia-settings package.
Line 41: Line 416:
The Links page has links to nVidia driver packages, support forums, other HOWTOs, and anything else I find that can help you to get your nVidia hardware working under Debian.

For problems, comments, or questions about the information in this HOWTO, you can write to me. I'm no expert, but I'll do my best to make the information useful.
This wiki page was created by [[http://philippecloutier.com|Philippe Cloutier]] to publish an update to ''Andrew's Debian-nVidia HOWTO''. You are free to modify this page as long as you agree to let copyright of your changes to the author. For problems, comments, or questions about the information in this document, you can [[mailto:chealer@gmail.com?subject=Debian-NVIDIA|write to the maintainer]]. He's no expert, but he'll do his best to make the document useful.

== Help wanted to maintain this document ==
This document's maintainer no longer uses an NVIDIA card and would like other people to take over maintainership. If you want to help, please [[mailto:chealer@gmail.com?subject=Debian-NVIDIA|contact him]] and/or go ahead.

== Credits ==
Thanks to Andrew Schulman for publishing his HOWTO, agreeing to share his rights on it, and making the HOWTO link to this page since it stopped being maintained.

== Licensing ==
This document is Copyright 2005, by Andrew E. Schulman. Permission is hereby granted to freely copy, distribute, and/or modify any of the contents of this document in any way and for any purpose.

== See also ==
 * [[GraphicsCard]]

Translation(s): English - Español - Français - Italiano - Русский


  • This document explains how to make use of NVIDIA video hardware on a Debian GNU/Linux system. The following section shortly describes the free drivers while the rest of the document covers the non-free but 3D-accelerated drivers.

free drivers

Debian has three free drivers that support NVIDIA cards. You can see which one is in use by running

$ grep -B2 'Module class: X.Org Video Driver' /var/log/Xorg.0.log

You can simply configure X to change the free driver to use.

None of the free drivers fully support 3D acceleration, though the Nouveau drivers have some 3D acceleration. Only the non-free nvidia drivers support full 3D acceleration, but they are more complex and X is more likely to break, you're reliant on nvidia to fix bugs. If X breaks and it seems difficult to get X to work with the non-free nvidia drivers, remember that switching back to a free driver should get X working again.

vesa

The vesa driver is a generic video driver.

nv

The nv driver usually gives better results than vesa, but it is not included on wheezy or newer releases.

Nouveau

In addition to vesa and nv, Debian contains the Nouveau drivers starting with squeeze. The Nouveau drivers are reverse-engineered from official NVIDIA drivers. These drivers are experimental.

Installation

To use the nouveau drivers, your kernel drm version and your libdrm version need to match. The installation can basically be done this way:

# apt-get install xserver-xorg-video-nouveau

Then configure X and set nouveau as your device driver.

non-free drivers

Why use a Debian-specific method?

NVIDIA drivers can be installed using NVIDIA's official installer or the Debian driver packages. Each method has its advantages, but the Debian way is probably easier. Even when building a driver module manually, the Debian way is more reliable and probably will save labor in the long run.

NVIDIA's installer is documented at other places such as ?this one.

Whichever installation method, the troubleshooting section may help.

Comparison of nvidia-installer and the Debian way

Advantages of "the Debian way":

  • More automated, which saves work if the kernel is changed.
  • Uses Debian package management tools, so it's cleaner. If your system breaks after using the Debian way, that would be a bug which can be reported in the BTS.
  • Can be done while X is running. (X must be restarted to apply the driver change.)
  • Users of make-kpkg should find it fits easily into their existing build procedure.

  • No downloading files from nvidia.com, the Debian packages contain all necessary parts.

Advantages of NVIDIA's official installer:

Installation

How to install the NVIDIA 3D drivers, the Debian way.

Overview

The NVIDIA 3D drivers consist of two parts: a kernel module, and a collection of user-space libraries and a X video driver. The libraries and the X driver (sometimes called the "binary driver" or GLX libraries) are distributed in binary form by NVIDIA, and are packaged for Debian in the nvidia-glx packages. Since NVIDIA's 3D drivers are not open source, non-free APT sources are needed to install them. The kernel module (aka the "kernel interface to the binary driver") is distributed in source form (though with one binary component), and packaged for Debian in the nvidia-kernel-source packages. The version numbers of the kernel module and user-space libraries and X video driver must match. User libraries only need be installed once, but the kernel module must be recompiled every time the kernel is changed. What to do:

  • 0. Make sure APT has non-free and contrib sources (consult the sources.list(5) man page for help on doing this)

  • 1. Determine which version of the drivers should be installed.
  • 2. Install the kernel module
  • 3. Install the user-space GLX libraries and the X driver
  • 4. Configure X to use the nvidia driver

Steps 3 and 4 need only be done once, but Step 2 is required every time the kernel is changed.

Steps

Choose a driver version

The current drivers do not support some legacy NVIDIA cards. Up to now, the NVIDIA drivers dropped support for some legacy cards 3 times. However, NVIDIA maintains the last driver version released before a legacy cards support drop. This means there are currently 4 drivers series maintained by NVIDIA. The first support drop happened in 2005, so the oldest legacy drivers series (71xx) should support cards released before 2005 but not those released after 2005. The second support drop happened in 2006, leading to the 96xx legacy drivers series. The third support drop happened in 2008, leading to the 173.14 legacy drivers series.

No Debian suite contains the 4 available drivers series, but it may be possible to install unofficial packages if your card requires a drivers series not available in your suite. Squeeze and Lenny both contain the newest and second newest legacy series, 173.14 and 96.43. Squeeze also contains the current series. Wheezy only contains the current series. The oldest drivers series, 71xx, is not in any current Debian suite (except unstable, but unusable). It is basically impossible to use the nvidia driver on cards no longer supported after 71xx on a current Debian suite.

The 71xx version is the only one to support RIVA TNT, RIVA TNT2/TNT2 Pro, RIVA TNT2 Ultra, Vanta/Vanta LT, RIVA TNT2 Model 64/Model 64 Pro, Aladdin TNT2, GeForce 256, GeForce DDR, Quadro, GeForce2 GTS / GeForce2 Pro, GeForce2 Ti, GeForce2 Ultra and Quadro2 Pro. Versions newer than 96.43 do not support GeForce2 and GeForce4 cards. A more detailed list of cards only supported by legacy drivers is available.

Debian distributes several versions of the drivers using several packages with different names. For example, the X driver and user-space libraries from the current series are in the nvidia-glx package. However, with time, the current drivers become legacy drivers, so the nvidia-glx package in Lenny is not current anymore.

Use current drivers if possible. You can determine which cards are supported by consulting Appendix A of NVIDIA's 195.36.24 driver README.

Set a VERSION variable, which the rest of the instructions will refer to, to "-legacy-96xx", "-legacy-173xx" or an empty string. If you want to install the default version from your suite, there is no need to set VERSION to the empty string. To find the name of a card, you can try lspci. To determine which version you should use, you can run this script, which will propose to set VERSION.

Install the kernel module

Stock or custom kernel?

Some of the installation methods below depend on whether you're running a stock kernel, i.e. a prebuilt kernel from the Debian distribution. If you know which kind of kernel you have, you can skip to the following section.

By default, Debian comes with a stock kernel. If you don't know what kind of kernel you're running, then it's probably a stock kernel. If you're not sure, run

$ uname -r

and check if the output looks like 2.*.*-small number-architecture (e.g. or 2.6.18-6-486). If it does, you're most likely running a stock kernel.

Methods

There are five different methods for installing the kernel module.

Use module-assistant

This method is easy, and should work with most stock or custom kernels. For a custom kernel, you need to have its Linux headers installed.

It needs module-assistant and nvidia-kernel-common. To install them with apt-get:

# apt-get install module-assistant nvidia-kernel-common

Run the following command:

# m-a auto-install nvidia-kernel${VERSION}-source

And that's it. If all went well, your nvidia kernel module is now built and installed; you may proceed to step 3. If not, read the rest of this section.

You must use the same version of gcc to build your nvidia kernel module as was used to build your kernel. This might be a problem if you are running a stock kernel. If module-assistant fails, read its log output and look for messages suggesting that you need, for example, gcc-4.0 instead of gcc-4.1. Then install the corresponding package and retry auto-install.

The auto-install step is the biggest step of the procedure, and is the most likely to fail. auto-install can be divided in smaller module-assistant steps, which can help debugging:

  • get

  • build

  • install

If # m-a get nvidia; fails, try installing the nvidia-kernel-source package. If APT fails to install nvidia-kernel-source, you should go back to step 0 and make sure you didn't miss something.

If you are unable to install the module using module-assistant, try installing a pre-built module if you use a stock kernel or try to build manually, with a custom kernel.

Install a pre-built module

This method is easy if you're running a recent stock kernel for which a pre-built module is available; it will not work at all if you're running a custom kernel or if you're running Debian 6 and need a legacy driver. There are pre-built modules available for all the kernels installed by default by Debian Lenny, and pre-built modules for the current drivers series for all kernels installed by default by Debian Squeeze. If the module-assistant method doesn't work for you and there are pre-built modules available for your kernel, use this method.

If you don't know your kernel version, run

$ uname -r

If there is a pre-built module for your kernel, install its package. The name starts with "nvidia-kernel-". This is followed by an indication of the drivers series you want (this string is empty for the default drivers series). The name ends by the identifier of your Linux image. For example, with apt-get:

# apt-get install nvidia-kernel${VERSION}-$(uname -r)

If this step succeeds, you may now proceed to step 3. If there are no pre-built modules for your kernel, and method 1 and method 3 fail, you may want to try method 5.

Use DKMS

This is the easiest method and recommended unless you have some reason to not want to install a compiler.

All you need to do is install the kernel headers package for the Linux image that you're running (usually named linux-headers-<version> where <version> is whatever version of kernel you're running) and then install nvidia-kernel-dkms or the nvidia-kernel-legacy-...-dkms package for the legacy version of the drivers that you need.

DKMS will take care of the build and install process automatically.

Build manually, with a custom kernel

Use this method if you're configuring and building a custom kernel. This method is known to be possibly inexact or incomplete.

  1. Install the kernel module source. For example, with apt-get:
    # apt-get install nvidia-kernel${VERSION}-source

    This will install a source tarball in /usr/src/. Unpack it in /usr/src:

    $ cd /usr/src
    # tar -xf nvidia-kernel-*.tar.gz

    This will unpack the kernel module sources into /usr/src/modules/nvidia-kernel[something].

  2. Configure your kernel. This step isn't documented here; if you need to learn how, see the kernel-package documentation. But in summary, what you have to do is
    $ cd /usr/src/linux
    # make xconfig

    and then choose the options you want. Note, however, that each of the following kernel options has been reported to cause trouble with the nvidia driver (the first 2 are gone for Debian 7):

    • Device drivers –> Graphics Support –> nVidia Riva support (FB_RIVA)

    • Device drivers –> Graphics support –> nVidia Framebuffer Support (FB_NVIDIA)

    • Device drivers –> Graphics support –> VESA VGA graphics support (FB_VESA)

    • Processor Type and Features –> Local APIC support on uniprocessors (X86_UP_APIC) (not available if you have an SMP kernel, including hyperthreading)

    It is therefore recommended that you disable all of the above options in your kernel configuration. If for some reason you don't disable them, and then your X display doesn't work properly with the nvidia driver, you should suspect these options as the likely cause of the trouble. For more details, see the Troubleshooting section.

  3. Build the kernel and the nvidia kernel module:

    # make-kpkg clean
    # make-kpkg kernel_image modules_image

    For an introduction to using make-kpkg to build kernel packages, see Creating custom kernels with Debian's kernel-package system, or Compiling Kernels the Debian Way. See also the ?make-kpkg(1) man page, for a description of other options and targets that you can use in this command. The result of the above command will be two Debian package files, linux-image-*.deb and nvidia-kernel-*.deb, both in /usr/src or /usr/src/modules. The first file contains your kernel, and the second contains your nvidia kernel module.
    At the same time, if you have sources for any other add-on kernel modules in /usr/src/modules, then the "modules_image" target will cause make-kpkg to build Debian package files for them, too. For example, if you install the fuse-source package you'll get a source archive /usr/src/fuse.tar.gz, which you can unpack to get fuse module sources in /usr/src/modules/fuse. If you've done this, then this same invocation of make-kpkg will also build a fuse module package file, /usr/src/fuse-*.deb, that's specific to your new kernel.

  4. Install the new kernel and kernel module:
    $ cd /usr/src
    # dpkg -i /path/linux-image-*.deb /path/nvidia-kernel-*.deb
    Use the fileglobs as above if you want, but watch out that you don't have more than one Linux image or nvidia-kernel package file lying around in /usr/src. If you do you'll get a blizzard of error messages. It's probably better to explicitly type all of the version information rendered as * above.
  5. Boot your new kernel. Before trying to get the NVIDIA 3D drivers to work, make sure that the new kernel boots and that X starts well using a free X driver.

Proceed to step 3.

Build manually, with a stock kernel

Use this method if you're running a stock kernel and the two first methods failed. module-assistant should automate this process. In other words, if the first method failed but this one works, you should probably submit a bug report against module-assistant.

The following procedure is adapted from the instructions in /usr/share/doc/nvidia-kernel-source/README.Debian and is known to be potentially inexact.

  1. Save the release number of your kernel (e.g. 2.6.18-6-686) in a couple of environment variables:
    export KVERS=$(uname -r)
    export KSRC=/usr/src/linux-headers-$KVERS
    export KPKG_DEST_DIR=/usr/src
    Note that these variables are used by the build commands below, so you really do need to set and export them, as in the above commands.
  2. Install the kernel module source: run
    apt-get install nvidia-kernel-source nvidia-kernel-common
    This will give you a source tarball /usr/src/nvidia-kernel-source.tar.gz. Unpack it with
    cd /usr/src
    tar -zxf nvidia-kernel-source.tar.gz
    This will unpack the kernel module sources into /usr/src/modules/nvidia-kernel. In case there is no such tarball, but /usr/src/nvidia-kernel.tar.bz2, unpack it with
    cd /usr/src
    tar -jxf nvidia-kernel.tar.bz2
  3. Install the header files for your kernel:
    apt-get install linux-headers-$KVERS
    This will give you kernel header files in /usr/src/linux-headers-$KVERS. Be sure to check that the installed kernel image and kernel header packages have the same version number: run
    apt-cache policy linux-image-$KVERS linux-headers-$KVERS
    and check that the version number listed as Installed is the same for both packages. If it isn't, find the distribution that has the version of linux-headers that you need, e.g. testing, and rerun the above installation command, adding '-t testing' (or whichever).
  4. Build the kernel module package:
    cd /usr/src/modules/nvidia-kernel
    debian/rules binary-modules
    The result will be a package file /usr/src/nvidia-kernel-*.deb, which contains your kernel module. Note: several users have told me recently that their nvidia package file ends up in /usr/src/modules, instead of /usr/src. I don't know yet why this happens. If this is your case, please adjust the next command appropriately.
  5. Install the kernel module:
    dpkg -i /usr/src/nvidia-kernel-*.deb
    Use the fileglob as above if you want, but watch out that you don't have more than one nvidia-kernel package file lying around in /usr/src. If you do you'll get a blizzard of error messages. It's probably better to explicitly type all of the version information that I rendered as * above.

Now proceed to step 3, below.

Install the NVIDIA X driver and user-space libraries

Install the X driver and user-space libraries package. For example, with apt-get:

# apt-get install nvidia-glx${VERSION}

Note: The reason this step has to come after step 2 is that nvidia-glx depends on a virtual package called 'nvidia-kernel-$NVVERSION', where $NVVERSION is the upstream part of the version of the nvidia-glx package. This virtual package should be provided by the kernel module package that you installed in step 2; so you have to complete that step first. If the installation of nvidia-glx fails because the 'nvidia-kernel-$NVVERSION' isn't satisfied, you should probably make sure that step 2 went OK.

Configure X to use the nvidia driver

You can use The manual way or nvidia-xconfig, which will create a basic xorg.conf and a final one with your preferred settings.

The manual way

/etc/X11/xorg.conf can instruct X to use the nvidia driver. If you have one, modify it, otherwise it must be created.

Modify an existing xorg.conf

Consider backing up your current X configuration file:

# cp -p /etc/X11/xorg.conf /etc/X11/xorg.conf.bak

Watch out for typos, and check your X log if things go wrong.

Edit /etc/X11/xorg.conf:

  • If it contains a "Module" section, be sure that it contains a line:
    Load "glx"
    and remove or comment out (prepend with a #) any lines that refer to the "dri" or "GLCore" modules.
  • In the "Device" section for your video card, change the driver (normally nv or vesa) to nvidia. If the driver is not defined, add the line

    Driver "nvidia"

Create an xorg.conf

Create an xorg.conf with the following content:

Section "Module"
    Load        "glx"
EndSection

Section "Device"
    Identifier  "Video Card"
    Driver              "nvidia"
EndSection

Using nvidia-xconfig

Warning: this method is generally not recommended due to an important X bug (504692).

Install nvidia-xconfig. For example, using apt-get:

# apt-get install nvidia-xconfig

Now make a basic xorg.conf to include NVIDIA driver:

# nvidia-xconfig

Restart X

This is the easiest but probably most crucial step. If it doesn't work for some reason, and you want to get back to X before fixing the problem, you'll have to revert step 4 (by choosing a free X driver again). When you think you fixed the problem, you can do step 4 again and retry starting X. Remember that even if it works you'll want to read the next section to avoid future trouble. And if it doesn't...check the Troubleshooting section.

If you don't use a display manager, simply close your session. That should bring to a console. If it doesn't, you must be using a display manager (such as gdm, kdm or xdm). First identify which one you're using. If you don't know, it's probably gdm. You can know by checking whether a process ending with "dm" is running. Once you determined which one you use, close your session and go run the appropriate init script in a console. Here's an example for gdm:

# invoke-rc.d gdm restart

Alternatively, you can simply press Alt+E at the login screen if you use kdm. If you can't figure out how to restart X with those instructions, you can simply reboot your system. Otherwise, the keyboard shortcut Ctrl+Alt+Backspace should be reliable, despite being somewhat "unfriendly".

Check that it worked

To check that the acceleration is working, glxinfo can be used. This program is in the mesa-utils package. If

$ glxinfo |grep rendering

returns "direct rendering: Yes", acceleration is working. If it returns No, see section "Hardware acceleration, aka direct rendering, doesn't work". If it returns Yes, 3D acceleration (in games such as PlanetPenguin Racer or Extreme Tux Racer and Neverball) should work.

How to deal with kernel changes and driver upgrades

Steps 3 and 4 are done for good. However, you'll have to repeat step 2 in certain situations. If you don't realize such a situation happens, X will fail to start. You can take two approaches with this: either remember when this will happen and try to prevent it, or remember to come back here when your X fails to start. Either way, you're not done for life. If X fails to start because of this, you can again revert step 4 (by choosing a free X driver again) and redo it when you want to retry using the nvidia driver for X.

When

Step 2 installs an nvidia kernel module for a specific kernel and NVIDIA driver version. You'll have to do it for each kernel, and you'll have to redo it for each new driver version. If you don't know what this means, read on.

...will the NVIDIA driver version change

If you're using Debian stable, this won't happen until you upgrade to the next Debian release, but it will happen then.

In all cases, this will happen when the nvidia-glx package is upgraded. All versions of nvidia-glx depend on an nvidia-kernel-version virtual package. When you followed step 2, you installed a package providing this virtual package. However, if you upgrade nvidia-glx before doing step 2 again, APT will attempt to satisfy the virtual package, usually by installing nvidia-kernel-dkms. Instead of letting it do, do step 2 again to get an appropriate kernel module. Then, the virtual package will be satisfied and you can upgrade nvidia-glx safely and without installing a useless package.

...will your kernel change

If you build other modules using module-assistant, you have to redo step 2 everytime you'd have to run module-assistant for other modules, that is for every new kernel ABI. If you don't know what that means, read on.

If you install a kernel with a new ABI, a new Linux image package will be installed. For example, if the Linux 2.6.18 gets a new ABI and you currently use linux-image-2.6.18-4-486, you will have to install the linux-image-2.6.18-5-486 package to get the new kernel (the "-4" and "-5" part of the package names indicate respectively that these packages contain the fourth and fifth ABI of Debian's 2.6.18 i386 stock kernels). This may happen without your intervention when upgrading your system if the linux-image-2.6-486 meta package is installed. This can also happen if you install a different kernel. For example, you can have both 2.6.26 and 2.6.32 in Lenny. If you did step 2 for 2.6.26 only, you'll need to do it for 2.6.32 too. You'll notice that a new kernel is installed when a new linux-image-something package is installed. X will fail to start after you booted a new kernel until you perform step 2 for that kernel.

Troubleshooting

X doesn't start

You'll find log messages in /var/log/Xorg.0.log.

If you're using "nouveau", check "nomodeset" was not passed to the kernel (edit /etc/default/grub, and if you changed anything run update-grub). Check you don't have the nvidia kernel module loaded (lsmod|grep nvidia, and if necessary rmmod nvidia).

If you're using the "nvidia" driver, make sure the nouveau kernel module isn't loaded (lsmod|grep nouveau, and if necessary rmmod nouveau). If you can't remove the nouveau module and X isn't running, it's usually because the terminal is using it for a better resolution. To prevent this, blacklist the nouveau module (add a line saying "blacklist nouveau" to /etc/modprobe.d/blacklist.conf) and reboot. (Blacklisting the module won't prevent you loading it manually, but will stop it being auto-loaded which is what you want.)

Warning: if you switch back to the nouveau driver and don't remove "nomodeset", X won't start.

As a last resort, use the "vesa" driver (it nearly always works, but isn't pretty).

X (or the complete machine when running X) is unstable

  • Check whether you use a framebuffer, such as rivafb, nvidiafb and vesafb. The rivafb driver is known to conflict with NVIDIA's drivers. vesafb is known to work in some cases but also to be problematic in other cases. All of these drivers are compiled as modules in stock kernels, except for vesafb. To see if you have one of these modules inserted in your kernel, run
    $ lsmod|grep 'rivafb\|vesafb\|nvidiafb'
    If this outputs something, get rid of the module(s) displayed.
    # rmmod rivafb vesafb nvidiafb

    will remove the modules temporarily (for this boot). If something causes one of the modules to load automatically at boot, blacklist the modules. If you are using a custom kernel, do not compile these modules in (Device drivers –> Graphics support –> nVidia Riva support (FB_RIVA), Device drivers –> Graphics support –> VESA VGA graphics support (FB_VESA) and Device drivers –> Graphics support –> nVidia Framebuffer Support (FB_NVIDIA)).

Hardware acceleration, aka direct rendering, doesn't work

We've covered how to check that the installation worked in section "Check that it worked". If it doesn't, check that you adjusted your X configuration properly. You can do so by checking that

$ grep Driver /etc/X11/xorg.conf 2>&1|grep nvidia

returns something. If this is the case but you get an error when trying to use OpenGL apps like glxinfo that looks like this one:

Error: Could not open /dev/nvidiactl because the permissions
are too resticitive.  Please see the FREQUENTLY ASKED QUESTIONS
section of /usr/share/doc/NVIDIA_GLX-1.0/README for steps
to correct.
Fatal signal: Segmentation Fault

you should make sure that the user running the application is in the video group.

Various problems with X

Look in your X log file (/var/log/Xorg.0.log). The X server writes a lot of information there about what configuration files it's reading, what display modes it's trying, and errors (EE) it encounters along the way. You can very often find hints there to the source of whatever problem you're having.

"nvidia license taints kernel"

If you get such a warning message on your console or in your syslog, don't worry. Your kernel is fine...or at least as fine as a kernel that can run NVIDIA's 3D driver can be. All this message means is that because your driver isn't open source, you won't get any support from the Linux maintainers if anything goes wrong with your kernel while the module is loaded. See the LKML FAQ for more.

Last resort

You can check the NVIDIA Linux Forum at nvnews.net for issues not related to Debian packaging. For Debian-specific issues, you may look at the bug tracking system or ask a question on Debian help resources, such as the debian-user mailing list and #debian on irc.debian.org.

More information

  • For more information about the drivers, see:
    • /usr/share/doc/nvidia-glx/README.Debian
    • /usr/share/doc/nvidia-glx/README.txt.gz

    These files have loads of information about options and for troubleshooting NVIDIA's proprietary drivers. Here's an enticement for you to read them: somewhere in one of them you can find an explanation of how to suppress the NVIDIA splash screen every time you start an X server (hint: search for "NoLogo").

  • You can adjust the clock rates of your GPU and video RAM by running nvclock, nvclock_gtk, or nvclock_qt, available respectively in the nvclock, nvclock-gtk, and nvclock-qt packages. Obligatory warning: you can destroy your video hardware with these tools if you're not careful.
  • You can adjust some other, relatively obscure settings of the driver by running nvidia-settings, available in the nvidia-settings package.

About this document

This wiki page was created by Philippe Cloutier to publish an update to Andrew's Debian-nVidia HOWTO. You are free to modify this page as long as you agree to let copyright of your changes to the author. For problems, comments, or questions about the information in this document, you can write to the maintainer. He's no expert, but he'll do his best to make the document useful.

Help wanted to maintain this document

This document's maintainer no longer uses an NVIDIA card and would like other people to take over maintainership. If you want to help, please contact him and/or go ahead.

Credits

Thanks to Andrew Schulman for publishing his HOWTO, agreeing to share his rights on it, and making the HOWTO link to this page since it stopped being maintained.

Licensing

This document is Copyright 2005, by Andrew E. Schulman. Permission is hereby granted to freely copy, distribute, and/or modify any of the contents of this document in any way and for any purpose.

See also