Bug 14494

Summary: Add the link of options rule in xorg.conf, keyboard, kbd manuals
Product: xorg Reporter: Shahid <shahid21st>
Component: DocumentationAssignee: Gaetan Nadon <memsize>
Status: RESOLVED FIXED QA Contact: Xorg Project Team <xorg-team>
Severity: normal    
Priority: medium CC: marcoz, peter.hutterer
Version: unspecified   
Hardware: x86 (IA32)   
OS: Linux (All)   
Whiteboard: 2011BRB_Reviewed
i915 platform: i915 features:

Description Shahid 2008-02-13 20:50:15 UTC
In these manuals under InputDevice section the following information is given -

Option "XkbOptions" "options"
              specifies the XKB keyboard option components.  These can be used to enhance the keyboard behaviour.  Default: not set.

But it doesn't link to or say anything about the allowable formats which is located in /usr/share/X11/xkb/rules/xorg.lstq (I'm using Debian Etch, depending upon distribution the location might be different).
Comment 1 Jeremy Huddleston Sequoia 2011-10-03 00:26:10 UTC
Was this done in the recent massive documentation update deluge?
Comment 2 Gaetan Nadon 2011-10-03 10:55:06 UTC
(In reply to comment #1)
> Was this done in the recent massive documentation update deluge?

No content information change on my part, just the titlepage.
Given there are 63 documents, it could seem like a lot. I currently do not have the knowledge to make the suggested improvements.
Comment 3 Alan Coopersmith 2011-10-03 15:31:07 UTC
Actually the most recent improvement I know of here is Peter's recent creation
of an xkeyboard-config man page to list the available options:

http://who-t.blogspot.com/2011/06/man-page-for-xkeyboard-config.html

which is now linked to from the xorg.conf man page:

http://cgit.freedesktop.org/xorg/xserver/commit/?id=47b6ba3204d650393a7255ce2af27b8c018bb586
Comment 4 Alan Coopersmith 2011-10-03 15:39:06 UTC
(In reply to comment #3)
> which is now linked to from the xorg.conf man page:

Err, I guess that's the Xorg man page, not the xorg.conf one, though
since the XKB options are part of the kbd or evdev device options,
it should be in those driver man pages.
Comment 5 Gaetan Nadon 2011-10-03 16:56:32 UTC
(In reply to comment #0)
> In these manuals under InputDevice section the following information is given -
> 
> Option "XkbOptions" "options"
>               specifies the XKB keyboard option components.  These can be used
> to enhance the keyboard behaviour.  Default: not set.
> 
> But it doesn't link to or say anything about the allowable formats which is
> located in /usr/share/X11/xkb/rules/xorg.lstq (I'm using Debian Etch, depending
> upon distribution the location might be different).

The submitted patch should address this issue.

http://lists.x.org/archives/xorg-devel/2011-October/025979.html
Comment 6 Alan Coopersmith 2011-10-03 21:06:28 UTC
kbd driver man page fixed now too, think that's everything so closing the bug.

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.