From dbcea0eb9edfedb5ee576b737098e6e74066f177 Mon Sep 17 00:00:00 2001 From: Hans Ulrich Niedermann Date: Sun, 21 Oct 2007 07:14:28 +0200 Subject: [PATCH] Add a simple cleaned-up radeonhd(4) man page

--- Makefile.am | 2 +- configure.ac | 3 +- man/.gitignore | 1 + man/Makefile.am | 59 +++++++++++++++++++ man/radeonhd.man | 169 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 232 insertions(+), 2 deletions(-) create mode 100644 man/.gitignore create mode 100644 man/Makefile.am create mode 100644 man/radeonhd.man diff --git a/Makefile.am b/Makefile.am index f83dcbb..36f5bf2 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,2 +1,2 @@ AUTOMAKE_OPTIONS = foreign -SUBDIRS = src \ No newline at end of file +SUBDIRS = man src diff --git a/configure.ac b/configure.ac index cceaccc..577671a 100644 --- a/configure.ac +++ b/configure.ac @@ -133,10 +133,11 @@ AC_SUBST([moduledir]) DRIVER_NAME=radeonhd AC_SUBST([DRIVER_NAME]) -# XORG_MANPAGE_SECTIONS +XORG_MANPAGE_SECTIONS XORG_RELEASE_VERSION AC_OUTPUT([ Makefile + man/Makefile src/Makefile ]) diff --git a/man/.gitignore b/man/.gitignore new file mode 100644 index 0000000..181f314 --- /dev/null +++ b/man/.gitignore @@ -0,0 +1 @@ +*.[0-9] diff --git a/man/Makefile.am b/man/Makefile.am new file mode 100644 index 0000000..bf7ec17 --- /dev/null +++ b/man/Makefile.am @@ -0,0 +1,59 @@ +# $Id$ +# +# Copyright 2005 Sun Microsystems, Inc. All rights reserved. +# +# Permission to use, copy, modify, distribute, and sell this software and its +# documentation for any purpose is hereby granted without fee, provided that +# the above copyright notice appear in all copies and that both that +# copyright notice and this permission notice appear in supporting +# documentation. +# +# The above copyright notice and this permission notice shall be included +# in all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +# IN NO EVENT SHALL THE OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR +# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, +# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +# OTHER DEALINGS IN THE SOFTWARE. +# +# Except as contained in this notice, the name of the copyright holders shall +# not be used in advertising or otherwise to promote the sale, use or +# other dealings in this Software without prior written authorization +# from the copyright holders. +# + +drivermandir = $(DRIVER_MAN_DIR) + +driverman_PRE = @DRIVER_NAME@.man + +driverman_DATA = $(driverman_PRE:man=@DRIVER_MAN_SUFFIX@) + +EXTRA_DIST = @DRIVER_NAME@.man + +CLEANFILES = $(driverman_DATA) + +SED = sed + +# Strings to replace in man pages +XORGRELSTRING = @PACKAGE_STRING@ + XORGMANNAME = X Version 11 + +MAN_SUBSTS = \ + -e 's|__vendorversion__|"$(XORGRELSTRING)" "$(XORGMANNAME)"|' \ + -e 's|__xorgversion__|"$(XORGRELSTRING)" "$(XORGMANNAME)"|' \ + -e 's|__xservername__|Xorg|g' \ + -e 's|__xconfigfile__|xorg.conf|g' \ + -e 's|__projectroot__|$(prefix)|g' \ + -e 's|__appmansuffix__|$(APP_MAN_SUFFIX)|g' \ + -e 's|__drivermansuffix__|$(DRIVER_MAN_SUFFIX)|g' \ + -e 's|__adminmansuffix__|$(ADMIN_MAN_SUFFIX)|g' \ + -e 's|__miscmansuffix__|$(MISC_MAN_SUFFIX)|g' \ + -e 's|__filemansuffix__|$(FILE_MAN_SUFFIX)|g' + +SUFFIXES = .$(DRIVER_MAN_SUFFIX) .man + +.man.$(DRIVER_MAN_SUFFIX): + sed $(MAN_SUBSTS) < $< > $@ diff --git a/man/radeonhd.man b/man/radeonhd.man new file mode 100644 index 0000000..528d65d --- /dev/null +++ b/man/radeonhd.man @@ -0,0 +1,169 @@ +.\" radeonhd.man based on formatting used in the xf86-video-{ati,nv} radeon.man, nv.man +.\" shorthand for double quote that works everywhere. +.ds q \N'34' +.\" +.\" +.TH RADEONHD __drivermansuffix__ __vendorversion__ +.\" +.\" +.SH NAME +radeonhd \- AMD GPG (ATI) R5xx/R6xx video driver +.\" +.\" +.SH SYNOPSIS +.nf +.B "Section \*qDevice\*q" +.BI " Identifier \*q" devname \*q +.B " Driver \*qradeonhd\*q" +\ \ ... +.B EndSection +.fi +.\" +.\" +.SH DESCRIPTION +.B radeonhd +is an __xservername__ driver for AMD GPG (ATI) R5xx/R6xx based video cards. + +.B "RADEONHD is still very much a work in progress." + +At the time of this writing, +.B radeonhd +has +.B NO +support for 2D acceleration, Xvideo, 3D acceleration, and many other nice +features. +.SH SUPPORTED HARDWARE +The +.B radeonhd +driver supports video cards based on the following ATI chips: +.\" The following list was generated from "X -logverbose 7" by the following command: +.\" sed -n '/^\t[RM][A-Z0-9]\+ * : /{ s/\.$//; s/^\t\([A-Z0-9]\+\) \+: \(.*\)/.TP 8\n.B \1\n\2/; p};' /var/log/Xorg.0.log +.\" The list replicates the output of RHDIdentify() in src/rhd_id.c. +.TP 8 +.B RV505 +Radeon X1550, X1550 64bit +.TP 8 +.B RV515 +Radeon X1300, X1550, X1600; FireGL V3300, V3350 +.TP 8 +.B RV516 +Radeon X1300, X1550, X1550 64-bit, X1600; FireMV 2250 +.TP 8 +.B R520 +Radeon X1800; FireGL V5300, V7200, V7300, V7350 +.TP 8 +.B RV530 +Radeon X1300 XT, X1600, X1600 Pro, X1650; FireGL V3400, V5200 +.TP 8 +.B RV535 +Radeon X1300, X1650 +.TP 8 +.B RV550 +Radeon X2300 HD +.TP 8 +.B RV560 +Radeon X1650 +.TP 8 +.B RV570 +Radeon X1950, X1950 GT; FireGL V7400 +.TP 8 +.B R580 +Radeon X1900, X1950; AMD Stream Processor +.TP 8 +.B R600 +Radeon HD 2900 GT/Pro/XT; FireGL V7600/V8600/V8650 +.TP 8 +.B RV610 +Radeon HD 2350, HD 2400 Pro/XT, HD 2400 Pro AGP; FireGL V4000 +.TP 8 +.B RV630 +Radeon HD 2600 Pro/XT, HD 2600 Pro/XT AGP; Gemini RV630; FireGL V3600/V5600 +.TP 8 +.B M52 +Mobility Radeon X1300 +.TP 8 +.B M54 +Mobility Radeon X1400; M54-GL +.TP 8 +.B M56 +Mobility Radeon X1600; Mobility FireGL V5200 +.TP 8 +.B M58 +Mobility Radeon X1800, X1800 XT; Mobility FireGL V7100, V7200 +.TP 8 +.B M62 +Mobility Radeon X1350 +.TP 8 +.B M64 +Mobility Radeon X1450, X2300 +.TP 8 +.B M66 +Mobility Radeon X1700, X1700 XT; FireGL V5250 +.TP 8 +.B M68 +Mobility Radeon X1900 +.TP 8 +.B M71 +Mobility Radeon HD 2300 +.TP 8 +.B M72 +Mobility Radeon HD 2400; Radeon E2400 +.TP 8 +.B M74 +Mobility Radeon HD 2400 XT +.TP 8 +.B M76 +Mobility Radeon HD 2600; (Gemini ATI) Mobility Radeon HD 2600 XT +.TP 8 +.B RS690 +Radeon X1200 +.TP 8 +.B RS740 +RS740, RS740M +.\" +.\" +.SH CONFIGURATION DETAILS +Please refer to __xconfigfile__(__filemansuffix__) for general +configuration details. This section only covers configuration details +specific to this driver. +.PP +See the source code ( +.I src/rhd_driver.c +) for now. Sorry. +.\" +.\" +.SH KNOWN BUGS +As the +.B radeonhd +driver is still in the early stages of development. Therefore, many +non-obvious things do not work yet. +.SS No valid modeline found +If the +.I "Section \*qscreen\*q" +in your __xconfigfile__ contains a +.I "Monitor \*qfoobar\*q" +line, +.B radeonhd +often does not find a valid modeline for the attached display and +aborts. +.\" +.\" +.SH SEE ALSO +__xservername__(__appmansuffix__), __xconfigfile__(__filemansuffix__), xorgconfig(__appmansuffix__), Xserver(__appmansuffix__), X(__miscmansuffix__) +.IP " 1." 4 +The radeonhd mailing list +.RS 4 +\%http://lists.opensuse.org/radeonhd/ +.RE +.IP " 2." 4 +Overview about radeonhd development code +.RS 4 +\%http://gitweb.freedesktop.org/?p=xorg/driver/xf86-video-radeonhd +.RE +.\" +.\" +.SH AUTHORS +.nf +Hans Ulrich Niedermann \fIhun@n-dimensional.de\fP +.fi +.\" vim: syntax=nroff -- 1.5.3.4 -- To unsubscribe, e-mail: radeonhd+unsubscribe@opensuse.org For additional commands, e-mail: radeonhd+help@opensuse.org

From 266a6098c6bcdc7d6cc52e7c0918ca335a0eac8b Mon Sep 17 00:00:00 2001 From: Hans Ulrich Niedermann Date: Mon, 22 Oct 2007 07:58:52 +0200 Subject: [PATCH] man page updates: workaround for modeline, brightness keys

--- man/radeonhd.man | 9 ++++++++- 1 files changed, 8 insertions(+), 1 deletions(-) diff --git a/man/radeonhd.man b/man/radeonhd.man index 528d65d..be747b6 100644 --- a/man/radeonhd.man +++ b/man/radeonhd.man @@ -145,7 +145,14 @@ in your __xconfigfile__ contains a line, .B radeonhd often does not find a valid modeline for the attached display and -aborts. +aborts. Workaround: Comment out the \*qMonitor\*q line. +.SS Laptop backlight brightness cannot be changed +While +.B radeonhd +has control over the display, the normal laptop's \*qbrighter\*q and \*qdarker\*q keys are blocked. +Workaround: Until +.B radeonhd +does proper ACPI event handling, you can switch to a VGA text console, adjust the brightness there, and then switch back to X11. .\" .\" .SH SEE ALSO -- 1.5.3.4 -- To unsubscribe, e-mail: radeonhd+unsubscribe@opensuse.org For additional commands, e-mail: radeonhd+help@opensuse.org

From 266a6098c6bcdc7d6cc52e7c0918ca335a0eac8b Mon Sep 17 00:00:00 2001 From: Hans Ulrich Niedermann Date: Mon, 22 Oct 2007 07:58:52 +0200 Subject: [PATCH] man page updates: workaround for modeline, brightness keys

--- man/radeonhd.man | 9 ++++++++- 1 files changed, 8 insertions(+), 1 deletions(-) diff --git a/man/radeonhd.man b/man/radeonhd.man index 528d65d..be747b6 100644 --- a/man/radeonhd.man +++ b/man/radeonhd.man @@ -145,7 +145,14 @@ in your __xconfigfile__ contains a line, .B radeonhd often does not find a valid modeline for the attached display and -aborts. +aborts. Workaround: Comment out the \*qMonitor\*q line. +.SS Laptop backlight brightness cannot be changed +While +.B radeonhd +has control over the display, the normal laptop's \*qbrighter\*q and \*qdarker\*q keys are blocked. +Workaround: Until +.B radeonhd +does proper ACPI event handling, you can switch to a VGA text console, adjust the brightness there, and then switch back to X11. .\" .\" .SH SEE ALSO -- 1.5.3.4 -- To unsubscribe, e-mail: radeonhd+unsubscribe@opensuse.org For additional commands, e-mail: radeonhd+help@opensuse.org

From 599ef8098466b2ca3cf11d9df7f201e0b7bfeede Mon Sep 17 00:00:00 2001 From: Hans Ulrich Niedermann Date: Tue, 23 Oct 2007 04:19:14 +0200 Subject: [PATCH] README: Installing, getting source, updating source, feedback

* Installation: automake and imake based. * Getting and updating source code. * How to create patches and feed them back into radeonhd. --- README | 124 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 124 insertions(+), 0 deletions(-) diff --git a/README b/README index 155e57a..b54ec23 100644 --- a/README +++ b/README @@ -1 +1,125 @@ Driver for AMD GPG r5xx/r6xx Chipsets +======================================================================= + +radeonhd is the X.org X11 driver for AMD GPG (ATI) r5xx/r6xx chipsets. + +More detailed notes about + * supported chipsets + * how to configure radeonhd + * known radeonhd bugs +etc. are available in the included radeonhd(4) man page. + + + +More Resources +============== + +The mailing list on radeonhd: + http://lists.opensuse.org/radeonhd/ + +Overview over recent updates to radeonhd: + http://gitweb.freedesktop.org/?p=xorg/driver/xf86-video-radeonhd + +The git repository with the radeonhd source code: + git://anongit.freedesktop.org/git/xorg/driver/xf86-video-radeonhd + +Report bugs at: + https://bugs.freedesktop.org/enter_bug.cgi?product=xorg + (component radeonhd) + + + +Installation +============ + +The simple way: + + $ ./autogen.sh + $ make + $ make install + +This will litter all kinds of compiled files throughout your source tree. + +The ancient way: + + $ xmkmf -a + $ make EXTRA_INCLUDES="-I/usr/include/xorg" all + $ make install + +This uses imake and is for compatibility with antique systems :-) + +The clean way: + + $ mkdir _b && cd _b + $ autogen -vis .. + $ ../configure --enable-maintainer-mode + $ make + $ make install + +Runs the build in _b/ - and if something is completely messed up, you can +safely remove the _b/ directory and create a new one without affecting any +source files. + +Tip: If you happen to have multiple branches in your git source tree, you + can have per-branch _b-BRANCH/ build trees and _i-BRANCH/ install + trees. ("... configure ... --prefix=$PWD/_i-BRANCH") + +Note that neither of these methods will apply to the rhd_conntest tool. +To build the rhd_conntest tool, you need to run + + $ (cd utils/conntest && make) + +from the source tree, regardless of the method chosen above to build the +radeonhd.so driver module itself. + + + +Getting and updating the radeonhd source code +============================================= + +radeonhd is maintained in the git repository found at + + git://anongit.freedesktop.org/git/xorg/driver/xf86-video-radeonhd + +You can find information on using git at the git website http://git.or.cz/ +and a short intro at + http://www.freedesktop.org/wiki/Infrastructure/git/Developers + +You can get a copy of that repository like this: + + $ git clone git://anongit.freedesktop.org/git/xorg/driver/xf86-video-radeonhd + $ git clone git://anongit.freedesktop.org/git/xorg/driver/xf86-video-radeonhd my-radeonhd + +That will create a directory xf86-video-radeonhd in the current directory +by default, or the given directoy my-radeonhd otherwise. + +If you have not made any local changes and want to update you source code +with the newest stuff from the official radeonhd repository, you can run this: + + $ git pull + +If you HAVE made local changes and committed them locally to your master +branch, you will be better off running + + $ git fetch -v + $ git rebase origin + +If you're using more branches, read the git docs. + + + +Feeding back source code +======================== + +You can easily create patches to send to the developers using git. + + $ vi some_file.c + $ git status + $ git diff + $ git add some_file.c + $ git commit + + $ git format-patches origin + +Then you can sift through the 0*.patch files and choose a few to send to +the radeonhd mailing list. -- 1.5.3.4 -- To unsubscribe, e-mail: radeonhd+unsubscribe@opensuse.org For additional commands, e-mail: radeonhd+help@opensuse.org