~ubuntu-branches/ubuntu/trusty/xserver-xorg-video-nouveau/trusty

« back to all changes in this revision

Viewing changes to man/nouveau.man

  • Committer: Bazaar Package Importer
  • Author(s): Chris Lamb
  • Date: 2008-07-06 20:26:53 UTC
  • Revision ID: james.westby@ubuntu.com-20080706202653-e99oiii765j3a0qn
Tags: upstream-0.0.10~git+20080706+b1f3169
ImportĀ upstreamĀ versionĀ 0.0.10~git+20080706+b1f3169

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\" $XFree86: xc/programs/Xserver/hw/xfree86/drivers/nv/nv.man,v 1.30 2006/06/16 00:19:32 mvojkovi Exp $ 
 
2
.\" shorthand for double quote that works everywhere.
 
3
.ds q \N'34'
 
4
.TH NV __drivermansuffix__ __vendorversion__
 
5
.SH NAME
 
6
nv \- NVIDIA video driver
 
7
.SH SYNOPSIS
 
8
.nf
 
9
.B "Section \*qDevice\*q"
 
10
.BI "  Identifier \*q"  devname \*q
 
11
.B  "  Driver \*qnv\*q"
 
12
\ \ ...
 
13
.B EndSection
 
14
.fi
 
15
.SH DESCRIPTION
 
16
.B nv 
 
17
is an __xservername__ driver for NVIDIA video cards.  The driver supports 2D 
 
18
acceleration and provides support for the following framebuffer depths:
 
19
8, 15, 16 (except Riva128) and 24.  All
 
20
visual types are supported for depth 8, TrueColor and DirectColor
 
21
visuals are supported for the other depths with the exception of
 
22
the Riva128 which only supports TrueColor in the higher depths. 
 
23
 
 
24
.SH SUPPORTED HARDWARE
 
25
The
 
26
.B nv
 
27
driver supports PCI, PCI-Express and AGP video cards based on the following NVIDIA chips:
 
28
.TP 22
 
29
.B RIVA 128
 
30
NV3
 
31
.TP 22
 
32
.B RIVA TNT
 
33
NV4
 
34
.TP 22
 
35
.B RIVA TNT2
 
36
NV5
 
37
.TP 22
 
38
.B GeForce 256, QUADRO 
 
39
NV10
 
40
.TP 22
 
41
.B GeForce2, QUADRO2
 
42
NV11 & NV15  
 
43
.TP 22
 
44
.B GeForce3, QUADRO DCC
 
45
NV20
 
46
.TP 22
 
47
.B nForce, nForce2
 
48
NV1A, NV1F
 
49
.TP 22
 
50
.B GeForce4, QUADRO4
 
51
NV17, NV18, NV25, NV28
 
52
.TP 22
 
53
.B GeForce FX, QUADRO FX
 
54
NV30, NV31, NV34, NV35, NV36, NV37, NV38 
 
55
.TP 22
 
56
.B GeForce 6XXX
 
57
NV40, NV41, NV43, NV44, NV45, C51
 
58
.TP 22
 
59
.B GeForce 7XXX
 
60
G70, G71, G72, G73
 
61
 
 
62
.SH CONFIGURATION DETAILS
 
63
Please refer to __xconfigfile__(__filemansuffix__) for general configuration
 
64
details.  This section only covers configuration details specific to this
 
65
driver.
 
66
.PP
 
67
The driver auto-detects the chipset type and the amount of video memory
 
68
present for all chips.
 
69
.PP
 
70
The following driver
 
71
.B Options
 
72
are supported:
 
73
.TP
 
74
.BI "Option \*qHWCursor\*q \*q" boolean \*q
 
75
Enable or disable the HW cursor.  Default: on.
 
76
.TP
 
77
.BI "Option \*qNoAccel\*q \*q" boolean \*q
 
78
Disable or enable acceleration.  Default: acceleration is enabled.
 
79
.TP
 
80
.BI "Option \*qUseFBDev\*q \*q" boolean \*q
 
81
Enable or disable use of an OS-specific fb interface (and is not supported
 
82
on all OSs).  See fbdevhw(__drivermansuffix__) for further information.
 
83
Default: off.
 
84
.TP
 
85
.BI "Option \*qCrtcNumber\*q \*q" integer \*q
 
86
Many graphics cards with NVIDIA chips have two video outputs.  
 
87
The driver attempts to autodetect
 
88
which one the monitor is connected to.  In the case that autodetection picks
 
89
the wrong one, this option may be used to force usage of a particular output. 
 
90
The options are "0" or "1".
 
91
Default: autodetected.
 
92
.TP
 
93
.BI "Option \*qFlatPanel\*q \*q" boolean \*q
 
94
The driver usually can autodetect the presence of a digital flat panel.  In
 
95
the case that this fails, this option can be used to force the driver to 
 
96
treat the attached device as a digital flat panel.  With this 
 
97
driver, a digital flat panel will work only if it was POSTed by the BIOS, 
 
98
that is, the computer
 
99
must have booted to the panel.  If you have a dual head card
 
100
you may also need to set the option CrtcNumber described above.
 
101
Default: autodetected.
 
102
.TP
 
103
.BI "Option \*qFPDither\*q \*q" boolean \*q
 
104
Many digital flat panels (particularly ones on laptops) have only 6 bits 
 
105
per component color resolution.
 
106
This option tells the driver to dither from 8 bits per component to 6 before
 
107
the flat panel truncates it. 
 
108
Default: off.
 
109
.TP
 
110
.BI "Option \*qFPScale\*q \*q" boolean \*q 
 
111
Supported only on GeForce4 and newer chips, this option
 
112
tells to the driver to scale lower resolutions up to the flat panel's native
 
113
resolution.  Default: on.
 
114
.TP 
 
115
.BI "Option \*qScalingMode\*q \*q" string \*q 
 
116
Only for the randr-1.2 driver, this allows to set the DFP scaling mode.
 
117
The options are "fullscreen", "aspect", "noscale" and "panel". Default: "aspect".
 
118
.TP 
 
119
.BI "Option \*qRotate\*q \*qCW\*q"
 
120
.TP
 
121
.BI "Option \*qRotate\*q \*qCCW\*q"
 
122
Rotate the display clockwise or counterclockwise.  This mode is unaccelerated.
 
123
Default: no rotation.
 
124
 
 
125
Note: The Resize and Rotate extension will be disabled if the Rotate "CW" or
 
126
Rotate "CCW" options are used.
 
127
.TP
 
128
.BI "Option \*qRotate\*q \*qRandR\*q"
 
129
Enable rotation of the screen using the Resize and Rotate extension.
 
130
This mode is unaccelerated.
 
131
Default: no rotation support.
 
132
.TP
 
133
.BI "Option \*qShadowFB\*q \*q" boolean \*q
 
134
Enable or disable use of the shadow framebuffer layer.  Default: off.
 
135
.SH "SEE ALSO"
 
136
__xservername__(__appmansuffix__), __xconfigfile__(__filemansuffix__), xorgconfig(__appmansuffix__), Xserver(__appmansuffix__), X(__miscmansuffix__)
 
137
.SH AUTHORS
 
138
Authors include: David McKay, Jarno Paananen, Chas Inman, Dave Schmenk, 
 
139
Mark Vojkovich
 
140
.SH COPYRIGHT
 
141
.LP
 
142
NOTICE TO USER:   The source code  is copyrighted under  U.S. and
 
143
international laws.  Users and possessors of this source code are
 
144
hereby granted a nonexclusive,  royalty-free copyright license to
 
145
use this code in individual and commercial software.
 
146
.LP
 
147
Any use of this source code must include,  in the user documentation and
 
148
internal comments to the code,  notices to the end user as follows:
 
149
.LP
 
150
Copyright 1993-2003 NVIDIA, Corporation.  All rights reserved.
 
151
.LP
 
152
NVIDIA, CORPORATION MAKES NO REPRESENTATION ABOUT THE SUITABILITY
 
153
OF  THIS SOURCE  CODE  FOR ANY PURPOSE.  IT IS  PROVIDED  "AS IS"
 
154
WITHOUT EXPRESS OR IMPLIED WARRANTY OF ANY KIND.  NVIDIA, CORPORATION 
 
155
DISCLAIMS ALL WARRANTIES  WITH REGARD  TO THIS SOURCE CODE,
 
156
INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT,  
 
157
AND FITNESS  FOR A PARTICULAR PURPOSE.   IN NO EVENT SHALL
 
158
NVIDIA, CORPORATION  BE LIABLE FOR ANY SPECIAL,  INDIRECT,  INCIDENTAL, 
 
159
OR CONSEQUENTIAL DAMAGES,  OR ANY DAMAGES  WHATSOEVER RESULTING FROM 
 
160
LOSS OF USE,  DATA OR PROFITS,  WHETHER IN AN ACTION
 
161
OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,  ARISING OUT OF
 
162
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOURCE CODE.
 
163
.LP
 
164
U.S. Government  End  Users.   This source code  is a "commercial
 
165
item,"  as that  term is  defined at  48 C.F.R. 2.101 (OCT 1995),
 
166
consisting  of "commercial  computer  software"  and  "commercial
 
167
computer  software  documentation,"  as such  terms  are  used in
 
168
48 C.F.R. 12.212 (SEPT 1995)  and is provided to the U.S. Government 
 
169
only as  a commercial end item.   Consistent with  48 C.F.R.
 
170
12.212 and  48 C.F.R. 227.7202-1 through  227.7202-4 (JUNE 1995),
 
171
all U.S. Government End Users  acquire the source code  with only
 
172
those rights set forth herein.                                   
 
173