Tizen 2.1 base
[adaptation/xorg/driver/xserver-xorg-video-emulfb.git] / man / emulfb.man
1 .\" $XFree86: xc/programs/Xserver/hw/xfree86/drivers/fbdev/fbdev.man,v 1.2 2001/01/27 18:20:47 dawes Exp $ 
2 .\" shorthand for double quote that works everywhere.
3 .ds q \N'34'
4 .TH FBDEV __drivermansuffix__ __vendorversion__
5 .SH NAME
6 fbdev \- video driver for framebuffer device
7 .SH SYNOPSIS
8 .nf
9 .B "Section \*qDevice\*q"
10 .BI "  Identifier \*q"  devname \*q
11 .B  "  Driver \*qfbdev\*q"
12 .BI "  BusID  \*qpci:" bus : dev : func \*q
13 \ \ ...
14 .B EndSection
15 .fi
16 .SH DESCRIPTION
17 .B fbdev
18 is an __xservername__ driver for framebuffer devices.  This is a non-accelerated
19 driver, the following framebuffer depths are supported: 8, 15, 16, 24.
20 All visual types are supported for depth 8, and TrueColor visual is
21 supported for the other depths.  Multi-head configurations are supported.
22 .SH SUPPORTED HARDWARE
23 The 
24 .B fbdev
25 driver supports all hardware where a framebuffer driver is available.
26 fbdev uses the os-specific submodule fbdevhw(__drivermansuffix__) to talk
27 to the kernel
28 device driver.  Currently a fbdevhw module is available for linux.
29 .SH CONFIGURATION DETAILS
30 Please refer to __xconfigfile__(__filemansuffix__) for general configuration
31 details.  This section only covers configuration details specific to
32 this driver.
33 .PP
34 For this driver it is not required to specify modes in the screen 
35 section of the config file.  The
36 .B fbdev
37 driver can pick up the currently used video mode from the framebuffer 
38 driver and will use it if there are no video modes configured.
39 .PP
40 For PCI boards you might have to add a BusID line to the Device
41 section.  See above for a sample line.  You can use \*q\__xservername__
42 -scanpci\*q
43 to figure out the correct values.
44 .PP
45 The following driver 
46 .B Options
47 are supported:
48 .TP
49 .BI "Option \*qfbdev\*q \*q" string \*q
50 The framebuffer device to use. Default: /dev/fb0.
51 .TP
52 .BI "Option \*qShadowFB\*q \*q" boolean \*q
53 Enable or disable use of the shadow framebuffer layer.  Default: on.
54 .TP
55 .BI "Option \*qRotate\*q \*q" string \*q
56 Enable rotation of the display. The supported values are "CW" (clockwise,
57 90 degrees), "UD" (upside down, 180 degrees) and "CCW" (counter clockwise,
58 270 degrees). Implies use of the shadow framebuffer layer.   Default: off.
59 .SH "SEE ALSO"
60 __xservername__(__appmansuffix__), __xconfigfile__(__filemansuffix__), xorgconfig(__appmansuffix__), Xserver(__appmansuffix__),
61 X(__miscmansuffix__), fbdevhw(__drivermansuffix__)
62 .SH AUTHORS
63 Authors include: Gerd Knorr, Michel D\(:anzer, Geert Uytterhoeven