git.oblomov.eu Git - nouveau/blob - man/nouveau.man

   1 .\" shorthand for double quote that works everywhere.
   2 .ds q \N'34'
   3 .TH NOUVEAU __drivermansuffix__ __vendorversion__
   4 .SH NAME
   5 nouveau \- NVIDIA video driver
   6 .SH SYNOPSIS
   7 .nf
   8 .B "Section \*qDevice\*q"
   9 .BI "  Identifier \*q"  devname \*q
  10 .B  "  Driver \*qnouveau\*q"
  11 \ \ ...
  12 .B EndSection
  13 .fi
  14 .SH DESCRIPTION
  15 .B nouveau
  16 is an __xservername__ driver for NVIDIA video cards.  The driver supports 2D
  17 acceleration and provides support for the following framebuffer depths:
  18 (15,) 16  and 24.  TrueColor visuals are supported for these depths.
  19
  20 .SH SUPPORTED HARDWARE
  21 The
  22 .B nouveau
  23 driver supports PCI, PCI-Express and AGP video cards based on the following NVIDIA chips:
  24 .TP 22
  25 .B RIVA TNT
  26 NV4
  27 .TP 22
  28 .B RIVA TNT2
  29 NV5
  30 .TP 22
  31 .B GeForce 256, QUADRO
  32 NV10
  33 .TP 22
  34 .B GeForce2, QUADRO2
  35 NV11 & NV15
  36 .TP 22
  37 .B GeForce3, QUADRO DCC
  38 NV20
  39 .TP 22
  40 .B nForce, nForce2
  41 NV1A, NV1F
  42 .TP 22
  43 .B GeForce4, QUADRO4
  44 NV17, NV18, NV25, NV28
  45 .TP 22
  46 .B GeForce FX, QUADRO FX
  47 NV30, NV31, NV34, NV35, NV36, NV37, NV38
  48 .TP 22
  49 .B GeForce 6XXX
  50 NV40, NV41, NV43, NV44, NV45, C51
  51 .TP 22
  52 .B GeForce 7XXX
  53 G70, G71, G72, G73
  54
  55 .SH CONFIGURATION DETAILS
  56 Please refer to __xconfigfile__(__filemansuffix__) for general configuration
  57 details.  This section only covers configuration details specific to this
  58 driver.
  59 .PP
  60 The driver auto-detects the chipset type and the amount of video memory
  61 present for all chips.
  62 .PP
  63 The following driver
  64 .B Options
  65 are supported:
  66 .TP
  67 .BI "Option \*qHWCursor\*q \*q" boolean \*q
  68 Enable or disable the HW cursor.  Default: on.
  69 .TP
  70 .BI "Option \*qNoAccel\*q \*q" boolean \*q
  71 Disable or enable acceleration.  Default: acceleration is enabled.
  72 .TP
  73 .BI "Option \*qRandR12\*q \*q" boolean \*q
  74 Disable or enable use of improved mode-setting code.  Default: RandR12 is enabled.
  75 .TP
  76 .BI "Option \*qFlatPanel\*q \*q" boolean \*q
  77 The driver usually can autodetect the presence of a digital flat panel.  In
  78 the case that this fails, this option can be used to force the driver to
  79 treat the attached device as a digital flat panel.  With this
  80 driver, a digital flat panel will work only if it was POSTed by the BIOS,
  81 that is, the computer must have booted to the panel.
  82 Default: autodetected.
  83 .TP
  84 .BI "Option \*qFPDither\*q \*q" boolean \*q
  85 Many digital flat panels (particularly ones on laptops) have only 6 bits
  86 per component color resolution.
  87 This option tells the driver to dither from 8 bits per component to 6 before
  88 the flat panel truncates it.
  89 Default: off.
  90 .TP
  91 .BI "Option \*qFPScale\*q \*q" boolean \*q
  92 Supported only on GeForce4 and newer chips, this option
  93 tells to the driver to scale lower resolutions up to the flat panel's native
  94 resolution.  Default: on.
  95 .TP
  96 .BI "Option \*qScalingMode\*q \*q" string \*q
  97 Only for the randr-1.2 driver, this allows to set the DFP scaling mode.
  98 The options are "fullscreen", "aspect", "noscale" and "panel". Default: "aspect".
  99 .TP
 100 .BI "Option \*qShadowFB\*q \*q" boolean \*q
 101 Enable or disable use of the shadow framebuffer layer.  Default: off.
 102 .TP
 103 .BI "Option \*qPrepareFinishAccess\*q \*q" boolean \*q
 104 Enable or disable use of PrepareFinishAccess hooks in exa, this should only be disabled if
 105 the xserver aborts saying that PrepareAccess failed on a pinned pixmap.
 106 This is bug that has been fixed in more recent xservers.  Default: on.
 107 .SH "SEE ALSO"
 108 __xservername__(__appmansuffix__), __xconfigfile__(__filemansuffix__), Xserver(__appmansuffix__), X(__miscmansuffix__)
 109 .SH AUTHORS
 110 Authors include: David McKay, Jarno Paananen, Chas Inman, Dave Schmenk,
 111 Mark Vojkovich
 112 .SH COPYRIGHT
 113 .LP
 114 NOTICE TO USER:   The source code  is copyrighted under  U.S. and
 115 international laws.  Users and possessors of this source code are
 116 hereby granted a nonexclusive,  royalty-free copyright license to
 117 use this code in individual and commercial software.
 118 .LP
 119 Any use of this source code must include,  in the user documentation and
 120 internal comments to the code,  notices to the end user as follows:
 121 .LP
 122 Copyright 1993-2003 NVIDIA, Corporation.  All rights reserved.
 123 .LP
 124 NVIDIA, CORPORATION MAKES NO REPRESENTATION ABOUT THE SUITABILITY
 125 OF  THIS SOURCE  CODE  FOR ANY PURPOSE.  IT IS  PROVIDED  "AS IS"
 126 WITHOUT EXPRESS OR IMPLIED WARRANTY OF ANY KIND.  NVIDIA, CORPORATION
 127 DISCLAIMS ALL WARRANTIES  WITH REGARD  TO THIS SOURCE CODE,
 128 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT,
 129 AND FITNESS  FOR A PARTICULAR PURPOSE.   IN NO EVENT SHALL
 130 NVIDIA, CORPORATION  BE LIABLE FOR ANY SPECIAL,  INDIRECT,  INCIDENTAL,
 131 OR CONSEQUENTIAL DAMAGES,  OR ANY DAMAGES  WHATSOEVER RESULTING FROM
 132 LOSS OF USE,  DATA OR PROFITS,  WHETHER IN AN ACTION
 133 OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,  ARISING OUT OF
 134 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOURCE CODE.
 135 .LP
 136 U.S. Government  End  Users.   This source code  is a "commercial
 137 item,"  as that  term is  defined at  48 C.F.R. 2.101 (OCT 1995),
 138 consisting  of "commercial  computer  software"  and  "commercial
 139 computer  software  documentation,"  as such  terms  are  used in
 140 48 C.F.R. 12.212 (SEPT 1995)  and is provided to the U.S. Government
 141 only as  a commercial end item.   Consistent with  48 C.F.R.
 142 12.212 and  48 C.F.R. 227.7202-1 through  227.7202-4 (JUNE 1995),
 143 all U.S. Government End Users  acquire the source code  with only
 144 those rights set forth herein.
 145