Re: [RP] Request: Documentation change

[Zach White]

On Sun, Sep 11, 2005 at 05:01:57PM +1000, Doug Kearns wrote:
*snip*
> It is documented in places. The first I found is under 'definekey':
> 
>       "Note that you have to describe ":" by "colon", "!" by "exclam"
>          and so on."
>  
> I'd agree it could possibly clearer, though.

Well, I'm bored, so I generated a list of names from keysymdef.h and then
trimmed it to a resonable list. I then wrote a couple of glue paragraphs
that could probably stand to be rewritten by someone who can write and
included a list of keynames for easy reference. It looks to me like this
fits nicely in the Keystrokes section. This diff was made against the
1.4.0-beta4 release. 

I don't know Tex, well, at all really. Hopefully I haven't comitted some
big style error in the way I've done up the list.

> PS. For the unimaginative, what exactly does one do with a car computer?

Mine will mainly be for navigation and communication. Ideally I'll always
have internet access if I'm within wifi range of my car. We'll see how this
works in practice.

-Zach

--- ratpoison.texi.dist Mon Sep 12 09:22:17 2005
+++ ratpoison.texi      Mon Sep 12 09:49:11 2005
@@ -871,6 +871,91 @@
 Super modifier
 @end table
 
+You can specify most keys in the way you'd imagine. Some keys require
+special names to be assigned to, however. These include any key which
+is not a single letter as well as the keys of the keypad on the right
+side of your keyboard.  You can find a comprehensive list of keys and
+what your system calls them in X11/keysymdef.h in your include path.
+
+Here is a list taken from a machine running XFree86:
+
address@hidden keysym_list
address@hidden BackSpace
address@hidden Tab
address@hidden Linefeed
address@hidden Clear
address@hidden Return
address@hidden Pause
address@hidden Scroll_Lock
address@hidden Sys_Req
address@hidden Escape
address@hidden Delete
address@hidden Home
address@hidden Left 
address@hidden Up
address@hidden Right
address@hidden Down
address@hidden Prior
address@hidden Next
address@hidden Page_Up
address@hidden Page_Down
address@hidden End
address@hidden Begin
address@hidden Select
address@hidden Print
address@hidden Execute
address@hidden Insert
address@hidden Undo
address@hidden Redo
address@hidden Menu
address@hidden Find
address@hidden Cancel
address@hidden Help
address@hidden Break
address@hidden Mode_switch
address@hidden Num_Lock
address@hidden table
+
+These all correspond to keys on the keypad:
+
address@hidden keypad_keysyms
address@hidden KP_Space space
address@hidden KP_Tab
address@hidden KP_Enter enter
address@hidden KP_F1
address@hidden KP_F2
address@hidden KP_F3
address@hidden KP_F4
address@hidden KP_Home
address@hidden KP_Left
address@hidden KP_Up
address@hidden KP_Right
address@hidden KP_Down
address@hidden KP_Prior
address@hidden KP_Page_Up
address@hidden KP_Next
address@hidden KP_Page_Down
address@hidden KP_End
address@hidden KP_Begin
address@hidden KP_Insert
address@hidden KP_Delete
address@hidden KP_Equal equals
address@hidden KP_Multiply
address@hidden KP_Add
address@hidden KP_Separator
address@hidden KP_Subtract
address@hidden KP_Decimal
address@hidden KP_Divide
address@hidden KP_0
address@hidden KP_1
address@hidden KP_2
address@hidden KP_3
address@hidden KP_4
address@hidden KP_5
address@hidden KP_6
address@hidden KP_7
address@hidden KP_8
address@hidden KP_9
address@hidden
+
 @menu
 * Key Maps::                    
 * Default Key Bindings::