summaryrefslogtreecommitdiff
path: root/hw/xfree86/doc
diff options
context:
space:
mode:
authorAlan Coopersmith <alan.coopersmith@sun.com>2008-12-01 20:02:34 -0800
committerAlan Coopersmith <alan.coopersmith@sun.com>2008-12-01 20:02:34 -0800
commit8c560422b44e012053612754430d2b87dc44ed59 (patch)
tree9e59c7eebf8a90b2a88fe94df0f42b4122040fdf /hw/xfree86/doc
parent6a1850b8c677e2a2993f6f6b731ee3d35aa55d09 (diff)
More man page updates for 1.6 release for Xorg, xorg.conf & exa man pages.
- Remove remaining references to XFree86-Misc options AllowNonLocalModInDev and DisableModInDev. - Remove remaining references to grab-breaking keys & associated options. - Update description of Ctrl-Alt-Backspace to new -retro/DontZap defaults. - Add description of new options -modalias and -showopts. - Update list of modules loaded by default. - Update input driver references from keyboard to evdev & kbd. - Update list of driver man pages to match xf86-*-* drivers with man pages. - Add See Also section to exa man page. and various formatting/typo/etc. fixes. The Xorg/xorg.conf sections on input device selection could use further updates to better match the current state of HAL-enabled configuration.
Diffstat (limited to 'hw/xfree86/doc')
-rw-r--r--hw/xfree86/doc/man/Xorg.man.pre78
-rw-r--r--hw/xfree86/doc/man/xorg.conf.man.pre74
2 files changed, 57 insertions, 95 deletions
diff --git a/hw/xfree86/doc/man/Xorg.man.pre b/hw/xfree86/doc/man/Xorg.man.pre
index 95f631152..bf29fcbde 100644
--- a/hw/xfree86/doc/man/Xorg.man.pre
+++ b/hw/xfree86/doc/man/Xorg.man.pre
@@ -133,8 +133,8 @@ specifies the Virtual Terminal device number which
will use. Without this option,
.B __xservername__
will pick the first available Virtual Terminal that it can locate. This
-option applies only to platforms such as Linux, BSD, SVR3 and SVR4, that
-have virtual terminal support.
+option applies only to platforms that have virtual terminal support, such
+as Linux, BSD, SVR3, and SVR4.
.TP
.B \-allowMouseOpenFail
Allow the server to start up even if the mouse device can't be opened
@@ -142,13 +142,6 @@ or initialised. This is equivalent to the
.B AllowMouseOpenFail
__xconfigfile__(__filemansuffix__) file option.
.TP 8
-.B \-allowNonLocalModInDev
-Allow changes to keyboard and mouse settings from non-local clients.
-By default, connections from non-local clients are not allowed to do
-this. This is equivalent to the
-.B AllowNonLocalModInDev
-__xconfigfile__(__filemansuffix__) file option.
-.TP 8
.B \-allowNonLocalXvidtune
Make the VidMode extension available to remote clients. This allows
the xvidtune client to connect from another host. This is equivalent
@@ -175,7 +168,14 @@ to set the color depth, and use
.B \-fbbpp
if you really need to force a non-default framebuffer (hardware) pixel
format.
-.TP
+.TP 8
+.BI \-config " file"
+Read the server configuration from
+.IR file .
+This option will work for any file when the server is run as root (i.e,
+with real-uid 0), or for files relative to a directory in the config
+search path for all other users.
+.TP 8
.B \-configure
When this option is specified, the
.B __xservername__
@@ -195,12 +195,6 @@ option, and is provided for compatibility with the native SCO X server.
Sets the default color depth. Legal values are 1, 4, 8, 15, 16, and
24. Not all drivers support all values.
.TP 8
-.B \-disableModInDev
-Disable dynamic modification of input device settings. This is equivalent
-to the
-.B DisableModInDev
-__xconfigfile__(__filemansuffix__) file option.
-.TP 8
.B \-disableVidMode
Disable the parts of the VidMode extension (used by the xvidtune
client) that can be used to change the video modes. This is equivalent
@@ -319,6 +313,10 @@ file verbosity level. When the
value is supplied, the log file verbosity level is set to that value.
The default log file verbosity level is 3.
.TP 8
+.B \-modalias
+Print a list of device ids each installed driver module claims to support,
+in a format similar to Linux modalias.
+.TP 8
.BI \-modulepath " searchpath"
Set the module search path to
.IR searchpath .
@@ -399,6 +397,16 @@ in a future release, so the
.B \-version
option should be used instead.
.TP 8
+.B \-showDefaultModulePath
+Print out the default module path the server was compiled with.
+.TP 8
+.B \-showDefaultLibPath
+Print out the path libraries should be installed to.
+.TP 8
+.B \-showopts
+For each driver module installed, print out the list of options and their
+argument types.
+.TP 8
.BI \-weight " nnn"
Set RGB weighting at 16 bpp. The default is 565. This applies only to
those drivers which support 16 bpp.
@@ -416,19 +424,6 @@ verbosity level is 0.
Print out the server version, patchlevel, release date, the operating
system/platform it was built on, and whether it includes module loader
support.
-.TP 8
-.B \-showDefaultModulePath
-Print out the default module path the server was compiled with.
-.TP 8
-.B \-showDefaultLibPath
-Print out the path libraries should be installed to.
-.TP 8
-.BI \-config " file"
-Read the server configuration from
-.IR file .
-This option will work for any file when the server is run as root (i.e,
-with real-uid 0), or for files relative to a directory in the config
-search path for all other users.
.SH "KEYBOARD"
.PP
The
@@ -454,10 +449,11 @@ by
are:
.TP 8
.B Ctrl+Alt+Backspace
-Immediately kills the server -- no questions asked. This can be disabled
-with the
+Immediately kills the server -- no questions asked. This is disabled by
+default. It can be enabled with the -retro command line flag or by setting
+the
.B DontZap
-__xconfigfile__(__filemansuffix__) file option.
+__xconfigfile__(__filemansuffix__) file option to a FALSE value.
.TP 8
.B Ctrl+Alt+Keypad-Plus
Change video mode to next one specified in the configuration file.
@@ -471,22 +467,8 @@ This can be disabled with the
.B DontZoom
__xconfigfile__(__filemansuffix__) file option.
.TP 8
-.B Ctrl+Alt+Keypad-Multiply
-Not treated specially by default. If the
-.B AllowClosedownGrabs
-__xconfigfile__(__filemansuffix__) file option is specified, this key sequence
-kills clients with an active keyboard or mouse grab as well as killing any
-application that may have locked the server, normally using the
-XGrabServer(__libmansuffix__) Xlib function.
-.TP 8
-.B Ctrl+Alt+Keypad-Divide
-Not treated specially by default. If the
-.B AllowDeactivateGrabs
-__xconfigfile__(__filemansuffix__) file option is specified, this key sequence
-deactivates any active keyboard and mouse grabs.
-.TP 8
.B Ctrl+Alt+F1...F12
-For BSD and Linux systems with virtual terminal support, these keystroke
+For systems with virtual terminal support, these keystroke
combinations are used to switch to virtual terminals 1 through 12,
respectively. This can be disabled with the
.B DontVTSwitch
@@ -620,7 +602,7 @@ Web site
.SH AUTHORS
__xservername__ has many contributors world wide. The names of most of them
-can be found in the documentation, CHANGELOG files in the source tree,
+can be found in the documentation, ChangeLog files in the source tree,
and in the actual source code.
.PP
__xservername__ was originally based on XFree86 4.4rc2.
diff --git a/hw/xfree86/doc/man/xorg.conf.man.pre b/hw/xfree86/doc/man/xorg.conf.man.pre
index d1a92d9ee..4f1ba003b 100644
--- a/hw/xfree86/doc/man/xorg.conf.man.pre
+++ b/hw/xfree86/doc/man/xorg.conf.man.pre
@@ -491,16 +491,6 @@ This allows the xvidtune client (and other clients that use the VidMode
extension) to connect from another host.
Default: off.
.TP 7
-.BI "Option \*qDisableModInDev\*q \*q" boolean \*q
-This disables the parts of the XFree86\-Misc extension that can be used to
-modify the input device settings dynamically.
-Default: that functionality is enabled.
-.TP 7
-.BI "Option \*qAllowNonLocalModInDev\*q \*q" boolean \*q
-This allows a client to connect from another host and change keyboard
-and mouse settings in the running server.
-Default: off.
-.TP 7
.BI "Option \*qAllowMouseOpenFail\*q \*q" boolean \*q
This allows the server to start up even if the mouse device can't be
opened/initialised.
@@ -625,30 +615,6 @@ Default: PM enabled on platforms that support it.
enable or disable XINERAMA extension.
Default is disabled.
.TP 7
-.BI "Option \*qAllowDeactivateGrabs\*q \*q" boolean \*q
-This option enables the use of the
-.B Ctrl+Alt+Keypad\-Divide
-key sequence to deactivate any active keyboard and mouse grabs.
-Default: off.
-.TP 7
-.BI "Option \*qAllowClosedownGrabs\*q \*q" boolean \*q
-This option enables the use of the
-.B Ctrl+Alt+Keypad\-Multiply
-key sequence to kill clients with an active keyboard or mouse grab as well
-as killing any application that may have locked the server, normally using
-the
-.BR XGrabServer(__libmansuffix__)
-Xlib function.
-Default: off.
-.br
-Note that the options
-.B AllowDeactivateGrabs
-and
-.B AllowClosedownGrabs
-will allow users to remove the grab used by screen saver/locker programs.
-Do not use them if you rely on the screen saver for security.
-Default: off.
-.TP 7
.BI "Option \*qHandleSpecialKeys\*q \*q" when \*q
This option controls when the server uses the builtin handler to process
special key combinations (such as
@@ -802,7 +768,8 @@ __projectroot__/lib/modules/extensions
.fi
.RE
.PP
-The \(lqbitmap\(rq font module is loaded automatically.
+The \(lqextmod\(rq, \(lqdbe\(rq, \(lqglx\(rq, and \(lqdri\(rq extension
+modules are loaded automatically, unless disabled with \*qDisable\*q entries.
It is recommended
that at very least the \(lqextmod\(rq extension module be loaded.
If it isn't, some commonly used server extensions (like the SHAPE
@@ -862,9 +829,12 @@ or
command line options, or if it is selected implicitly as the core pointer
or keyboard device in the absence of such explicit references.
The most commonly used input drivers are
-.BR keyboard (__drivermansuffix__)
+.BR evdev (__drivermansuffix__)
+on Linux systems, and
+.BR kbd (__drivermansuffix__)
and
-.BR mouse (__drivermansuffix__).
+.BR mouse (__drivermansuffix__)
+on other platforms.
.PP
In the absence of an explicitly specified core input device, the first
.B InputDevice
@@ -875,7 +845,7 @@ marked as
is used.
If there is no match there, the first
.B InputDevice
-that uses the \(lqmouse\(rq (or \(lqkeyboard\(rq or \(lqkbd\(rq) driver is used.
+that uses the \(lqmouse\(rq (or \(lqkbd\(rq) driver is used.
The final fallback is to use built\-in default configurations.
.PP
.B InputDevice
@@ -2158,7 +2128,7 @@ General:
.BR cvt (__appmansuffix__),
.BR gtf (__appmansuffix__).
.PP
-.B Not all modules or interfaces are available on all platforms.
+.B "Not all modules or interfaces are available on all platforms."
.PP
Display drivers:
.BR apm (__drivermansuffix__),
@@ -2178,11 +2148,13 @@ Display drivers:
.BR nv (__drivermansuffix__),
.BR openchrome (__drivermansuffix__),
.BR r128 (__drivermansuffix__),
+.BR radeon (__drivermansuffix__),
.BR rendition (__drivermansuffix__),
.BR savage (__drivermansuffix__),
.BR s3virge (__drivermansuffix__),
.BR siliconmotion (__drivermansuffix__),
.BR sis (__drivermansuffix__),
+.BR sisusb (__drivermansuffix__),
.BR sunbw2 (__drivermansuffix__),
.BR suncg14 (__drivermansuffix__),
.BR suncg3 (__drivermansuffix__),
@@ -2191,35 +2163,43 @@ Display drivers:
.BR sunleo (__drivermansuffix__),
.BR suntcx (__drivermansuffix__),
.BR tdfx (__drivermansuffix__),
-.BR tga (__drivermansuffix__),
+.\" .BR tga (__drivermansuffix__),
.BR trident (__drivermansuffix__),
.BR tseng (__drivermansuffix__),
.BR vesa (__drivermansuffix__),
-.BR vmware (__drivermansuffix__).
+.BR vmware (__drivermansuffix__),
+.BR voodoo (__drivermansuffix__),
+.BR wsfb (__drivermansuffix__),
+.BR xgi (__drivermansuffix__),
+.BR xgixp (__drivermansuffix__).
.PP
Input drivers:
-.\" .BR acecad (__drivermansuffix__),
-.\" .BR calcomp (__drivermansuffix__),
+.BR acecad (__drivermansuffix__),
+.BR calcomp (__drivermansuffix__),
.BR citron (__drivermansuffix__),
.BR dmc (__drivermansuffix__),
.BR dynapro (__drivermansuffix__),
.BR elographics (__drivermansuffix__),
+.BR evdev (__drivermansuffix__),
.BR fpit (__drivermansuffix__),
.BR js_x (__drivermansuffix__),
+.BR joystick (__drivermansuffix__),
.BR kbd (__drivermansuffix__),
-.BR keyboard (__drivermansuffix__),
-.\" .BR magictouch (__drivermansuffix__),
+.BR magictouch (__drivermansuffix__),
.BR microtouch (__drivermansuffix__),
-.BR mouse (__drivermansuffix__),
+.BR mousedrv (__drivermansuffix__),
.BR mutouch (__drivermansuffix__),
.BR palmax (__drivermansuffix__),
.BR penmount (__drivermansuffix__),
+.BR synaptics (__drivermansuffix__),
.BR tek4957 (__drivermansuffix__),
-.\" .BR ur98 (__drivermansuffix__),
+.BR ur98 (__drivermansuffix__),
+.BR vmmouse (__drivermansuffix__),
.BR void (__drivermansuffix__),
.BR wacom (__drivermansuffix__).
.PP
Other modules and interfaces:
+.BR exa (__drivermansuffix__),
.BR fbdevhw (__drivermansuffix__),
.\" .BR shadowfb (__drivermansuffix__),
.BR v4l (__drivermansuffix__).