*** empty log message ***

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

diff --git a/doc/rxvt.1.html b/doc/rxvt.1.html
index 97df44a..2d9b0b8 100644 (file)
--- a/doc/rxvt.1.html
+++ b/doc/rxvt.1.html
@@ -1103,14 +1103,52 @@ instead scroll the screen up.
 <dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br />
 </dt>
 <dd>
-Associate <em>string</em> with keysym <em>sym</em> (<strong>0xFF00 - 0xFFFF</strong>). It may
+Associate <em>string</em> with keysym <em>sym</em>.  The intervening resource
+name <strong>keysym.</strong> cannot be omitted. This resource is only available
+when compiled with KEYSYM_RESOURCE.
+</dd>
+<dd>
+<p>The format of <em>sym</em> is ``<em>(mask-)key</em>'',
+where <em>mask</em> can be any combination of <strong>Control</strong>, <strong>NumLock</strong>,
+<strong>Shift</strong>, <strong>Meta</strong>, <strong>Lock</strong>, <strong>Mod1</strong>, <strong>Mod2</strong>, <strong>Mod3</strong>, <strong>Mod4</strong>,
+<strong>Mod5</strong>, and the abbreviated
+<strong>C</strong>, <strong>N</strong>, <strong>S</strong>, <strong>M</strong>, <strong>A</strong>, <strong>L</strong>, <strong>1</strong>, <strong>2</strong>, <strong>3</strong>, <strong>4</strong>, <strong>5</strong>.
+The spellings of <em>key</em> can be obtained by using <strong>xev</strong>(1)
+command or searching keysym macros from
+<strong>/usr/X11R6/include/X11/keysymdef.h</strong> and omit the prefix <strong>XK_</strong>.
+Alternatively you can specify <em>key</em> by its hex keysym value 
+(<strong>0x0000 - 0xFFFF</strong>).
+Note that the lookup of <em>sym</em>s is not performed in an exact manner;
+however, the closest match is assured.</p>
+</dd>
+<dd>
+<p><em>string</em> 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 <strong>keysym.</strong> cannot be
-omitted. This resource is only available when compiled with
-KEYSYM_RESOURCE.
+with whitespace.</p>
+</dd>
+<dd>
+<p>You can define a range of keysyms in one shot by providing a <em>string</em>
+with pattern <strong>list/STRING1/STRING2/STRING3</strong>, where the delimeter `/'
+should be a character not used by the <strong>STRING</strong>s.</p>
+</dd>
+<dd>
+<p>Its usage can be demonstrated by an example:
+        URxvt.keysym.M-C-0x61:    list.abc.\e&lt;M-C-.&gt;</p>
+</dd>
+<dd>
+<p>The above line is equivalent to the following three lines:
+        URxvt.keysym.Meta-Control-0x61:    \e&lt;M-C-a&gt;
+        URxvt.keysym.Meta-Control-0x62:    \e&lt;M-C-b&gt;
+        URxvt.keysym.Meta-Control-0x63:    \e&lt;M-C-c&gt;</p>
+</dd>
+<dd>
+<p>If <em>string</em> takes the form of <strong>proto:STRING</strong>,
+the specified <strong>STRING</strong> is interpreted and executed as <strong>rxvt</strong>'s
+control sequence. For example, <strong>``proto:\033]701;zh_CN.GBK\007''</strong>
+means changing the current locale to zh_CN.GBK.</p>
 </dd>
 <p></p></dl>
 <p>