ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.html
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.html (file contents):
Revision 1.1 by root, Tue Jan 11 02:24:59 2005 UTC vs.
Revision 1.6 by root, Thu Feb 3 10:24:10 2005 UTC

… …
47<p><strong>rxvt</strong> [options] [-e command [ args ]]</p> 47<p><strong>rxvt</strong> [options] [-e command [ args ]]</p>
48<p> 48<p>
49</p> 49</p>
50<hr /> 50<hr />
51<h1><a name="description">DESCRIPTION</a></h1> 51<h1><a name="description">DESCRIPTION</a></h1>
52<p><strong>rxvt-unicode</strong>, version <strong>4.8</strong>, is a colour vt102 terminal 52<p><strong>rxvt-unicode</strong>, version <strong>4.9</strong>, is a colour vt102 terminal
53emulator intended as an <em>xterm</em>(1) replacement for users who do not 53emulator intended as an <em>xterm</em>(1) replacement for users who do not
54require features such as Tektronix 4014 emulation and toolkit-style 54require features such as Tektronix 4014 emulation and toolkit-style
55configurability. As a result, <strong>rxvt-unicode</strong> uses much less swap space -- 55configurability. As a result, <strong>rxvt-unicode</strong> uses much less swap space --
56a significant advantage on a machine serving many X sessions.</p> 56a significant advantage on a machine serving many X sessions.</p>
57<p> 57<p>
… …
194<p></p> 194<p></p>
195<dt><strong><a name="item__2dpixmap_file_5b_3bgeom_5d"><strong>-pixmap</strong> <em>file[;geom]</em></a></strong><br /> 195<dt><strong><a name="item__2dpixmap_file_5b_3bgeom_5d"><strong>-pixmap</strong> <em>file[;geom]</em></a></strong><br />
196</dt> 196</dt>
197<dd> 197<dd>
198Compile <em>XPM</em>: Specify XPM file for the background and also optionally 198Compile <em>XPM</em>: Specify XPM file for the background and also optionally
199specify its scaling with a geometry string. Note you may need to add 199specify its scaling with a geometry string. Note you may need to
200quotes to avoid special shell interpretation of the `;' in the 200add quotes to avoid special shell interpretation of the <code>;</code> in the
201command-line; resource <strong>backgroundPixmap</strong>. 201command-line; resource <strong>backgroundPixmap</strong>.
202</dd> 202</dd>
203<p></p> 203<p></p>
204<dt><strong><a name="item__2dcr_colour"><strong>-cr</strong> <em>colour</em></a></strong><br /> 204<dt><strong><a name="item__2dcr_colour"><strong>-cr</strong> <em>colour</em></a></strong><br />
205</dt> 205</dt>
… …
458</dd> 458</dd>
459<p></p> 459<p></p>
460<dt><strong><a name="item__2dimlocale_string"><strong>-imlocale</strong> <em>string</em></a></strong><br /> 460<dt><strong><a name="item__2dimlocale_string"><strong>-imlocale</strong> <em>string</em></a></strong><br />
461</dt> 461</dt>
462<dd> 462<dd>
463The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 463The locale to use for opening the IM. You can use an <code>LC_CTYPE</code> of e.g.
464de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 464<code>de_DE.UTF-8</code> for normal text processing but <code>ja_JP.EUC-JP</code> for the
465extension to be able to input japanese characters while staying in 465input extension to be able to input japanese characters while staying in
466another locale. 466another locale. resource <strong>imLocale</strong>.
467</dd>
468<p></p>
469<dt><strong><a name="item__2dimfont_fontset"><strong>-imfont</strong> <em>fontset</em></a></strong><br />
470</dt>
471<dd>
472Set the font set to use for the X Input Method, see resource <strong>imFont</strong>
473for more info.
474</dd>
475<p></p>
476<dt><strong><a name="item__2dtcw"><strong>-tcw</strong></a></strong><br />
477</dt>
478<dd>
479Change the meaning of triple-click selection with the left mouse
480button. Instead of selecting a full line it will extend the selection the
481end of the logical line only. resource <strong>tripleclickwords</strong>.
467</dd> 482</dd>
468<p></p> 483<p></p>
469<dt><strong><a name="item__2dinsecure"><strong>-insecure</strong></a></strong><br /> 484<dt><strong><a name="item__2dinsecure"><strong>-insecure</strong></a></strong><br />
470</dt> 485</dt>
471<dd> 486<dd>
… …
576<dt><strong><a name="item_colorit_3a_colour"><strong>colorIT:</strong> <em>colour</em></a></strong><br /> 591<dt><strong><a name="item_colorit_3a_colour"><strong>colorIT:</strong> <em>colour</em></a></strong><br />
577</dt> 592</dt>
578<dd> 593<dd>
579Use the specified colour to display bold or italic characters when the 594Use the specified colour to display bold or italic characters when the
580foreground colour is the default. If font styles are not available 595foreground colour is the default. If font styles are not available
581(Compile styles) and this option is unset, reverse video is used instead. 596(Compile <em>styles</em>) and this option is unset, reverse video is used instead.
582</dd> 597</dd>
583<p></p> 598<p></p>
584<dt><strong><a name="item_colorul_3a_colour"><strong>colorUL:</strong> <em>colour</em></a></strong><br /> 599<dt><strong><a name="item_colorul_3a_colour"><strong>colorUL:</strong> <em>colour</em></a></strong><br />
585</dt> 600</dt>
586<dd> 601<dd>
… …
719be smaller, but not larger. A reasonable default font list is always 734be smaller, but not larger. A reasonable default font list is always
720appended to it. option <strong>-fn</strong>. 735appended to it. option <strong>-fn</strong>.
721</dd> 736</dd>
722<dd> 737<dd>
723<p>Each font can either be a standard X11 core font (XLFD) name, with 738<p>Each font can either be a standard X11 core font (XLFD) name, with
724optional prefix <code>x:</code> or a Xft font (Compile xft), prefixed with <code>xft:</code>.</p> 739optional prefix <code>x:</code> or a Xft font (Compile <em>xft</em>), prefixed with <code>xft:</code>.</p>
725</dd> 740</dd>
726<dd> 741<dd>
727<p>In addition, each font can be prefixed with additional hints and 742<p>In addition, each font can be prefixed with additional hints and
728specifications enclosed in square brackets (<code>[]</code>). The only available 743specifications enclosed in square brackets (<code>[]</code>). The only available
729hint currently is <code>codeset=codeset-name</code>, and this is only used for Xft 744hint currently is <code>codeset=codeset-name</code>, and this is only used for Xft
… …
1046</dd> 1061</dd>
1047<p></p> 1062<p></p>
1048<dt><strong><a name="item_imlocale_3a_name"><strong>imLocale:</strong> <em>name</em></a></strong><br /> 1063<dt><strong><a name="item_imlocale_3a_name"><strong>imLocale:</strong> <em>name</em></a></strong><br />
1049</dt> 1064</dt>
1050<dd> 1065<dd>
1051The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 1066The locale to use for opening the IM. You can use an <code>LC_CTYPE</code> of e.g.
1052de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 1067<code>de_DE.UTF-8</code> for normal text processing but <code>ja_JP.EUC-JP</code> for the
1053extension to be able to input japanese characters while staying in 1068input extension to be able to input japanese characters while staying in
1054another locale. option <strong>-imlocale</strong>. 1069another locale. option <strong>-imlocale</strong>.
1070</dd>
1071<p></p>
1072<dt><strong><a name="item_imfont_3a_fontset"><strong>imFont:</strong> <em>fontset</em></a></strong><br />
1073</dt>
1074<dd>
1075Specify the font-set used for XIM styles <code>OverTheSpot</code> or
1076<code>OffTheSpot</code>. It must be a standard X font set (XLFD patterns separated
1077by commas), i.e. it's not in the same format as the other font lists used
1078in rxvt. The default will be set-up to chose *any* suitable found
1079found, preferably one or two pixels differing in size to the base font.
1080option <strong>-imfont</strong>.
1081</dd>
1082<p></p>
1083<dt><strong><a name="item_tripleclickwords_3a_boolean"><strong>tripleclickwords:</strong> <em>boolean</em></a></strong><br />
1084</dt>
1085<dd>
1086Change the meaning of triple-click selection with the left mouse
1087button. Instead of selecting a full line it will extend the selection to
1088the end of the logical line only. option <strong>-tcw</strong>.
1055</dd> 1089</dd>
1056<p></p> 1090<p></p>
1057<dt><strong><a name="item_insecure_3a_boolean"><strong>insecure:</strong> <em>boolean</em></a></strong><br /> 1091<dt><strong><a name="item_insecure_3a_boolean"><strong>insecure:</strong> <em>boolean</em></a></strong><br />
1058</dt> 1092</dt>
1059<dd> 1093<dd>
… …
1101</dd> 1135</dd>
1102<p></p> 1136<p></p>
1103<dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br /> 1137<dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br />
1104</dt> 1138</dt>
1105<dd> 1139<dd>
1106Associate <em>string</em> with keysym <em>sym</em> (<strong>0xFF00 - 0xFFFF</strong>). It may 1140Compile <em>frills</em>: Associate <em>string</em> with keysym <em>sym</em>. The
1107contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:
1108newline, \r: return, \t:
1109tab, \000: octal number) or control characters (^?: delete, ^@: null,
1110^A ...) and may enclosed with double quotes so that it can start or end
1111with whitespace. The intervening resource name <strong>keysym.</strong> cannot be 1141intervening resource name <strong>keysym.</strong> cannot be omitted.
1112omitted. This resource is only available when compiled with 1142</dd>
1113KEYSYM_RESOURCE. 1143<dd>
1144<p>The format of <em>sym</em> is ``<em>(modifiers-)key</em>'', where <em>modifiers</em> can be
1145any combination of <strong>ISOLevel3</strong>, <strong>AppKeypad</strong>, <strong>Control</strong>, <strong>NumLock</strong>,
1146<strong>Shift</strong>, <strong>Meta</strong>, <strong>Lock</strong>, <strong>Mod1</strong>, <strong>Mod2</strong>, <strong>Mod3</strong>, <strong>Mod4</strong>, <strong>Mod5</strong>,
1147and the abbreviated <strong>I</strong>, <strong>K</strong>, <strong>C</strong>, <strong>N</strong>, <strong>S</strong>, <strong>M</strong>, <strong>A</strong>, <strong>L</strong>, <strong>1</strong>,
1148<strong>2</strong>, <strong>3</strong>, <strong>4</strong>, <strong>5</strong>.</p>
1149</dd>
1150<dd>
1151<p>The <strong>NumLock</strong>, <strong>Meta</strong> and <strong>ISOLevel3</strong> modifiers are usually aliased to
1152whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1153keys are being mapped. <strong>AppKeypad</strong> is a synthetic modifier mapped to the
1154current application keymap mode state.</p>
1155</dd>
1156<dd>
1157<p>The spellings of <em>key</em> can be obtained by using <strong>xev</strong>(1) command or
1158searching keysym macros from <strong>/usr/X11R6/include/X11/keysymdef.h</strong> and
1159omitting the prefix <strong>XK_</strong>. Alternatively you can specify <em>key</em> by its hex
1160keysym value (<strong>0x0000 - 0xFFFF</strong>). Note that the lookup of <em>sym</em>s is not
1161performed in an exact manner; however, the closest match is assured.</p>
1162</dd>
1163<dd>
1164<p><em>string</em> may contain escape values (<code>\a</code>: bell, <code>\b</code>: backspace,
1165<code>\e</code>, <code>\E</code>: escape, <code>\n</code>: newline, <code>\r</code>: carriage return, <code>\t</code>: tab,
1166<code>\000</code>: octal number) or verbatim control characters (<code>^?</code>: delete,
1167<code>^@</code>: null, <code>^A</code> ...) and may be enclosed with double quotes so that it
1168can start or end with whitespace.</p>
1169</dd>
1170<dd>
1171<p>You can define a range of keysyms in one shot by providing a <em>string</em>
1172with pattern <strong>list/PREFIX/MIDDLE/SUFFIX</strong>, where the delimeter `/'
1173should be a character not used by the strings.</p>
1174</dd>
1175<dd>
1176<p>Its usage can be demonstrated by an example:</p>
1177</dd>
1178<dd>
1179<pre>
1180 URxvt.keysym.M-C-0x61: list|\e&lt;M-C-|abc|&gt;</pre>
1181</dd>
1182<dd>
1183<p>The above line is equivalent to the following three lines:</p>
1184</dd>
1185<dd>
1186<pre>
1187 URxvt.keysym.Meta-Control-0x61: \e&lt;M-C-a&gt;
1188 URxvt.keysym.Meta-Control-0x62: \e&lt;M-C-b&gt;
1189 URxvt.keysym.Meta-Control-0x63: \e&lt;M-C-c&gt;</pre>
1190</dd>
1191<dd>
1192<p>If <em>string</em> takes the form of <code>proto:STRING</code>, the specified <strong>STRING</strong>
1193is interpreted and executed as rxvt's control sequence. For
1194example the following means ``change the current locale to <code>zh_CN.GBK</code>
1195when Control-Meta-c is being pressed'':</p>
1196</dd>
1197<dd>
1198<pre>
1199 URxvt.keysym.M-C-c: proto:\033]701;zh_CN.GBK\007</pre>
1200</dd>
1201<dd>
1202<p>The following example will map Control-Meta-1 and Control-Meta-2 to
1203the fonts <code>suxuseuro</code> and <code>9x15bold</code>, so you cna have some limited
1204font-switching at runtime:</p>
1205</dd>
1206<dd>
1207<pre>
1208 URxvt.keysym.M-C-1: proto:\033]50;suxuseuro\007
1209 URxvt.keysym.M-C-2: proto:\033]50;9x15bold\007</pre>
1210</dd>
1211<dd>
1212<p><code>proto:\033]701;zh_CN.GBK\007</code> means: change the current locale to
1213<code>zh_CN.GBK</code>.</p>
1114</dd> 1214</dd>
1115<p></p></dl> 1215<p></p></dl>
1116<p> 1216<p>
1117</p> 1217</p>
1118<hr /> 1218<hr />
… …
1146<em>xterm</em>(1).</p> 1246<em>xterm</em>(1).</p>
1147<dl> 1247<dl>
1148<dt><strong><a name="item_selection_3a"><strong>Selection</strong>:</a></strong><br /> 1248<dt><strong><a name="item_selection_3a"><strong>Selection</strong>:</a></strong><br />
1149</dt> 1249</dt>
1150<dd> 1250<dd>
1151Left click at the beginning of the region, drag to the end of the 1251Left click at the beginning of the region, drag to the end of the region
1152region and release; Right click to extend the marked region; Left 1252and release; Right click to extend the marked region; Left double-click
1153double-click to select a word; Left triple-click to select the entire 1253to select a word; Left triple-click to select the entire logical line
1154line. 1254(which can span multiple screen lines), unless modified by resource
1255<strong>tripleclickwords</strong>.
1155</dd> 1256</dd>
1156<dd> 1257<dd>
1157<p>Starting a selection while pressing the <strong>Meta</strong> key (or <strong>Meta+Ctrl</strong> keys) 1258<p>Starting a selection while pressing the <strong>Meta</strong> key (or <strong>Meta+Ctrl</strong> keys)
1158(Compile: frills) will create a rectangular selection instead of a normal 1259(Compile: <em>frills</em>) will create a rectangular selection instead of a normal
1159one.</p> 1260one.</p>
1160</dd> 1261</dd>
1161<p></p> 1262<p></p>
1162<dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br /> 1263<dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br />
1163</dt> 1264</dt>
… …
1185<p>ISO 14755 is a standard for entering and viewing unicode characters 1286<p>ISO 14755 is a standard for entering and viewing unicode characters
1186and character codes using the keyboard. It consists of 4 parts. The 1287and character codes using the keyboard. It consists of 4 parts. The
1187first part is available rxvt-unicode has been compiled with 1288first part is available rxvt-unicode has been compiled with
1188<code>--enable-frills</code>, the rest is available when rxvt-unicode was compiled 1289<code>--enable-frills</code>, the rest is available when rxvt-unicode was compiled
1189with <code>--enable-iso14755</code>.</p> 1290with <code>--enable-iso14755</code>.</p>
1190<ol> 1291<ul>
1191<li><strong><a name="item_1_3a_basic_method">1: Basic method</a></strong><br /> 1292<li><strong><a name="item_5_2e1_3a_basic_method">5.1: Basic method</a></strong><br />
1192</li> 1293</li>
1193This allows you to enter unicode characters using their hexcode. 1294This allows you to enter unicode characters using their hexcode.
1194<p>Start by pressing and holding both <code>Control</code> and <code>Shift</code>, then enter 1295<p>Start by pressing and holding both <code>Control</code> and <code>Shift</code>, then enter
1195hex-digits (between one and six). Releasing <code>Control</code> and <code>Shift</code> will 1296hex-digits (between one and six). Releasing <code>Control</code> and <code>Shift</code> will
1196commit the character as if it were typed directly. While holding down 1297commit the character as if it were typed directly. While holding down
… …
1201address, which you cannot type. Fortunately, the card has the e-mail 1302address, which you cannot type. Fortunately, the card has the e-mail
1202address printed as hexcodes, e.g. <code>671d 65e5</code>. You can enter this easily 1303address printed as hexcodes, e.g. <code>671d 65e5</code>. You can enter this easily
1203by pressing <code>Control</code> and <code>Shift</code>, followed by <code>6-7-1-D-SPACE-6-5-E-5</code>, 1304by pressing <code>Control</code> and <code>Shift</code>, followed by <code>6-7-1-D-SPACE-6-5-E-5</code>,
1204followed by releasing the modifier keys.</p> 1305followed by releasing the modifier keys.</p>
1205<p></p> 1306<p></p>
1206<li><strong><a name="item_2_3a_keyboard_symbols_entry_method">2: Keyboard symbols entry method</a></strong><br /> 1307<li><strong><a name="item_5_2e2_3a_keyboard_symbols_entry_method">5.2: Keyboard symbols entry method</a></strong><br />
1207</li> 1308</li>
1208This mode lets you input characters representing the keycap symbols of 1309This mode lets you input characters representing the keycap symbols of
1209your keyboard, if representable in the current locale encoding. 1310your keyboard, if representable in the current locale encoding.
1210<p>Start by pressing <code>Control</code> and <code>Shift</code> together, then releasing 1311<p>Start by pressing <code>Control</code> and <code>Shift</code> together, then releasing
1211them. The next special key (cursor keys, home etc.) you enter will not 1312them. The next special key (cursor keys, home etc.) you enter will not
… …
1213keycap symbol. The symbol will only be entered when the key has been 1314keycap symbol. The symbol will only be entered when the key has been
1214released, otherwise pressing e.g. <code>Shift</code> would enter the symbol for 1315released, otherwise pressing e.g. <code>Shift</code> would enter the symbol for
1215<code>ISO Level 2 Switch</code>, although your intention might have been to enter a 1316<code>ISO Level 2 Switch</code>, although your intention might have been to enter a
1216reverse tab (Shift-Tab).</p> 1317reverse tab (Shift-Tab).</p>
1217<p></p> 1318<p></p>
1218<li><strong><a name="item_3_3a_screen_2dselection_entry_method">3: Screen-selection entry method</a></strong><br /> 1319<li><strong><a name="item_5_2e3_3a_screen_2dselection_entry_method">5.3: Screen-selection entry method</a></strong><br />
1219</li> 1320</li>
1220While this is implemented already (it's basically the selection 1321While this is implemented already (it's basically the selection
1221mechanism), it could be extended by displaying a unicode character map. 1322mechanism), it could be extended by displaying a unicode character map.
1222<p></p> 1323<p></p>
1223<li><strong><a name="item_4_3a_feedback_method_for_identifying_displayed_cha">4: Feedback method for identifying displayed characters for later input</a></strong><br /> 1324<li><strong><a name="item_5_2e4_3a_feedback_method_for_identifying_displayed">5.4: Feedback method for identifying displayed characters for later input</a></strong><br />
1224</li> 1325</li>
1225This method lets you display the unicode character code associated with 1326This method lets you display the unicode character code associated with
1226characters already displayed. 1327characters already displayed.
1227<p>You enter this mode by holding down <code>Control</code> and <code>Shift</code> together, then 1328<p>You enter this mode by holding down <code>Control</code> and <code>Shift</code> together, then
1228pressing and holding the left mouse button and moving around. The unicode 1329pressing and holding the left mouse button and moving around. The unicode
… …
1230pointer is displayed until you release <code>Control</code> and <code>Shift</code>.</p> 1331pointer is displayed until you release <code>Control</code> and <code>Shift</code>.</p>
1231<p>In addition to the hex codes it will display the font used to draw this 1332<p>In addition to the hex codes it will display the font used to draw this
1232character - due to implementation reasons, characters combined with 1333character - due to implementation reasons, characters combined with
1233combining characters, line drawing characters and unknown characters will 1334combining characters, line drawing characters and unknown characters will
1234always be drawn using the built-in support font.</p> 1335always be drawn using the built-in support font.</p>
1235<p></p></ol> 1336<p></p></ul>
1236<p>With respect to conformance, rxvt-unicode is supposed to be compliant to 1337<p>With respect to conformance, rxvt-unicode is supposed to be compliant to
1237both scenario A and B of ISO 14755, including part 5.2.</p> 1338both scenario A and B of ISO 14755, including part 5.2.</p>
1238<p> 1339<p>
1239</p> 1340</p>
1240<hr /> 1341<hr />
1241<h1><a name="login_stamp">LOGIN STAMP</a></h1> 1342<h1><a name="login_stamp">LOGIN STAMP</a></h1>
1242<p><strong>rxvt</strong> tries to write an entry into the <em>utmp</em>(5) file so 1343<p><strong>rxvt</strong> tries to write an entry into the <em>utmp</em>(5) file so that
1243that it can be seen via the <em>who(1)</em> command, and can accept messages. 1344it can be seen via the <em>who(1)</em> command, and can accept messages. To
1244To allow this feature, <strong>rxvt</strong> must be installed setuid root on 1345allow this feature, <strong>rxvt</strong> may need to be installed setuid root
1245some systems.</p> 1346on some systems or setgid to root or to some other group on others.</p>
1246<p> 1347<p>
1247</p> 1348</p>
1248<hr /> 1349<hr />
1249<h1><a name="colors_and_graphics">COLORS AND GRAPHICS</a></h1> 1350<h1><a name="colors_and_graphics">COLORS AND GRAPHICS</a></h1>
1250<p>In addition to the default foreground and background colours, 1351<p>In addition to the default foreground and background colours,
… …
1299<p> 1400<p>
1300</p> 1401</p>
1301<hr /> 1402<hr />
1302<h1><a name="files">FILES</a></h1> 1403<h1><a name="files">FILES</a></h1>
1303<dl> 1404<dl>
1304<dt><strong><a name="item__2fetc_2futmp"><strong>/etc/utmp</strong></a></strong><br />
1305</dt>
1306<dd>
1307System file for login records.
1308</dd>
1309<p></p>
1310<dt><strong><a name="item__2fusr_2flib_2fx11_2frgb_2etxt"><strong>/usr/lib/X11/rgb.txt</strong></a></strong><br /> 1405<dt><strong><a name="item__2fusr_2flib_2fx11_2frgb_2etxt"><strong>/usr/lib/X11/rgb.txt</strong></a></strong><br />
1311</dt> 1406</dt>
1312<dd> 1407<dd>
1313Color names. 1408Color names.
1314</dd> 1409</dd>

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines