diff options
author | Alan Coopersmith <alan.coopersmith@sun.com> | 2008-12-01 20:02:34 -0800 |
---|---|---|
committer | Alan Coopersmith <alan.coopersmith@sun.com> | 2008-12-01 20:02:34 -0800 |
commit | 8c560422b44e012053612754430d2b87dc44ed59 (patch) | |
tree | 9e59c7eebf8a90b2a88fe94df0f42b4122040fdf | |
parent | 6a1850b8c677e2a2993f6f6b731ee3d35aa55d09 (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.
-rw-r--r-- | hw/xfree86/doc/man/Xorg.man.pre | 78 | ||||
-rw-r--r-- | hw/xfree86/doc/man/xorg.conf.man.pre | 74 | ||||
-rw-r--r-- | hw/xfree86/exa/exa.man.pre | 16 |
3 files changed, 66 insertions, 102 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 @@ -135,4 +135,4 @@ will use. Without this option, 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 @@ -144,9 +144,2 @@ __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 @@ -177,3 +170,10 @@ 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 @@ -197,8 +197,2 @@ Sets the default color depth. Legal values are 1, 4, 8, 15, 16, and .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 @@ -321,2 +315,6 @@ 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" @@ -401,2 +399,12 @@ 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" @@ -418,15 +426,2 @@ 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" @@ -456,6 +451,7 @@ are: .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 @@ -473,18 +469,4 @@ __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, @@ -622,3 +604,3 @@ Web site __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. 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 @@ -493,12 +493,2 @@ 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 @@ -627,26 +617,2 @@ 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 @@ -804,3 +770,4 @@ __projectroot__/lib/modules/extensions .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 @@ -864,5 +831,8 @@ 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 @@ -877,3 +847,3 @@ 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. @@ -2160,3 +2130,3 @@ General: .PP -.B Not all modules or interfaces are available on all platforms. +.B "Not all modules or interfaces are available on all platforms." .PP @@ -2180,2 +2150,3 @@ Display drivers: .BR r128 (__drivermansuffix__), +.BR radeon (__drivermansuffix__), .BR rendition (__drivermansuffix__), @@ -2185,2 +2156,3 @@ Display drivers: .BR sis (__drivermansuffix__), +.BR sisusb (__drivermansuffix__), .BR sunbw2 (__drivermansuffix__), @@ -2193,3 +2165,3 @@ Display drivers: .BR tdfx (__drivermansuffix__), -.BR tga (__drivermansuffix__), +.\" .BR tga (__drivermansuffix__), .BR trident (__drivermansuffix__), @@ -2197,7 +2169,11 @@ Display drivers: .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__), @@ -2206,9 +2182,10 @@ Input drivers: .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__), @@ -2216,4 +2193,6 @@ Input drivers: .BR penmount (__drivermansuffix__), +.BR synaptics (__drivermansuffix__), .BR tek4957 (__drivermansuffix__), -.\" .BR ur98 (__drivermansuffix__), +.BR ur98 (__drivermansuffix__), +.BR vmmouse (__drivermansuffix__), .BR void (__drivermansuffix__), @@ -2222,2 +2201,3 @@ Input drivers: Other modules and interfaces: +.BR exa (__drivermansuffix__), .BR fbdevhw (__drivermansuffix__), diff --git a/hw/xfree86/exa/exa.man.pre b/hw/xfree86/exa/exa.man.pre index 31e1cfe34..5c953e256 100644 --- a/hw/xfree86/exa/exa.man.pre +++ b/hw/xfree86/exa/exa.man.pre @@ -8,6 +8,5 @@ exa \- new 2D acceleration architecture for X.Org provides a simple API for video drivers to implement for 2D acceleration. It -is a module loaded by drivers, and is not intended to be loaded on its own. See -your driver's manual page for how to enable -.B EXA -. +is a module loaded by drivers, and is not intended to be loaded on its own. +See your driver's manual page for how to enable +.BR EXA . .PP @@ -17,4 +16,4 @@ architecture is designed to make accelerating the Render extension simple and efficient, and results in various performance tradeoffs compared to XAA. Some -options are available for debugging performance issues or driver rendering -problems. They are not intended for general use. +__xconfigfile__ options are available for debugging performance issues or +driver rendering problems. They are not intended for general use. .TP @@ -25,3 +24,3 @@ the Render extension. Not related to the Composite extension. Default: No. .BI "Option \*qEXANoUploadToScreen\*q \*q" boolean \*q -Disables acceleration of uploading pixmap data to the freamebuffer. Default: No. +Disables acceleration of uploading pixmap data to the framebuffer. Default: No. .TP @@ -38,2 +37,5 @@ may help with specific use cases. Available options include \*qalways\*q, \*qgreedy\*q, and \*qsmart\*q. Default: always. +.SH "SEE ALSO" +.BR __xservername__ (__appmansuffix__), +.BR __xconfigfile__(__filemansuffix__). .SH AUTHORS |