*** empty log message ***

[dana/urxvt.git] / doc / rxvt.1.txt

diff --git a/doc/rxvt.1.txt b/doc/rxvt.1.txt
index ec855c0..bf2e70c 100644 (file)
--- a/doc/rxvt.1.txt
+++ b/doc/rxvt.1.txt
@@ -692,13 +692,41 @@ RESOURCES (available also as long-options)
         instead scroll the screen up.
 
     keysym.*sym*: *string*
-        Associate *string* with keysym *sym* (0xFF00 - 0xFFFF). It may
-        contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:
-        newline, \r: return, \t: tab, \000: octal number) or control
-        characters (^?: delete, ^@: null, ^A ...) and may enclosed with
-        double quotes so that it can start or end with whitespace. The
-        intervening resource name keysym. cannot be omitted. This resource
-        is only available when compiled with KEYSYM_RESOURCE.
+        Associate *string* with keysym *sym*. The intervening resource name
+        keysym. cannot be omitted. This resource is only available when
+        compiled with KEYSYM_RESOURCE.
+
+        The format of *sym* is "*(mask-)key*", where *mask* can be any
+        combination of Control, NumLock, Shift, Meta, Lock, Mod1, Mod2,
+        Mod3, Mod4, Mod5, and the abbreviated C, N, S, M, A, L, 1, 2, 3, 4,
+        5. The spellings of *key* can be obtained by using xev(1) command or
+        searching keysym macros from /usr/X11R6/include/X11/keysymdef.h and
+        omit the prefix XK_. Alternatively you can specify *key* by its hex
+        keysym value (0x0000 - 0xFFFF). Note that the lookup of *sym*s is
+        not performed in an exact manner; however, the closest match is
+        assured.
+
+        *string* may contain escape values (\a: bell, \b: backspace, \e, \E:
+        escape, \n: newline, \r: return, \t: tab, \000: octal number) or
+        control characters (^?: delete, ^@: null, ^A ...) and may enclosed
+        with double quotes so that it can start or end with whitespace.
+
+        You can define a range of keysyms in one shot by providing a
+        *string* with pattern list/STRING1/STRING2/STRING3, where the
+        delimeter `/' should be a character not used by the STRINGs.
+
+        Its usage can be demonstrated by an example: URxvt.keysym.M-C-0x61:
+        list.abc.\e<M-C-.>
+
+        The above line is equivalent to the following three lines:
+        URxvt.keysym.Meta-Control-0x61: \e<M-C-a>
+        URxvt.keysym.Meta-Control-0x62: \e<M-C-b>
+        URxvt.keysym.Meta-Control-0x63: \e<M-C-c>
+
+        If *string* takes the form of proto:STRING, the specified STRING is
+        interpreted and executed as rxvt's control sequence. For example,
+        "proto:\033]701;zh_CN.GBK\007" means changing the current locale to
+        zh_CN.GBK.
 
 THE SCROLLBAR
     Lines of text that scroll off the top of the rxvt window (resource: