rxvt.html 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856
  1. <a name="versioninfo.yo"></a>
  2. <a name="masonyodl.yo"></a>
  3. <html><head><title>RXVT</title>
  4. <link rev="made" href="mailto:gcw@pobox.com">
  5. </head>
  6. <body>
  7. <hr>
  8. <h1>RXVT</h1>
  9. <h2>X Version 11</h2>
  10. <h2>26 MARCH 2003</h2>
  11. <h2>NAME</h2>
  12. rxvt (ouR XVT) - a VT102 emulator for the X window system
  13. <p>
  14. <h2>SYNOPSIS</h2>
  15. <p><strong>rxvt</strong> [options] [-e command [ args ]]
  16. <p>
  17. <h2>DESCRIPTION</h2>
  18. <p><strong>rxvt</strong>, version <strong>2.7.10</strong>, is a colour vt102 terminal emulator
  19. intended as an <em>xterm</em>(1) replacement for users who do not require
  20. features such as Tektronix 4014 emulation and toolkit-style configurability.
  21. As a result, <strong>rxvt</strong> uses much less swap space -- a significant
  22. advantage on a machine serving many X sessions.
  23. <p>
  24. <p><a name="rxvt-options.yo"></a>
  25. <h2>OPTIONS</h2>
  26. <p>The <strong>rxvt</strong> options (mostly a subset of <em>xterm</em>'s) are listed below.
  27. In keeping with the smaller-is-better philosophy, options may be eliminated
  28. or default values chosen at compile-time, so options and defaults listed
  29. may not accurately reflect the version installed on your system.
  30. `rxvt -h' gives a list of major compile-time options on the <em>Options</em> line.
  31. Option descriptions may be prefixed with which compile option each is
  32. dependent upon. e.g. `Compile <em>XIM</em>:' requires <em>XIM</em> on the <em>Options</em>
  33. line. Note: `rxvt -help' gives a list of all command-line options compiled
  34. into your version.
  35. <p>Note that <strong>rxvt</strong> permits the resource name to be used as a long-option
  36. (--/++ option) so the potential command-line options are far greater than
  37. those listed.
  38. For example: `rxvt --loginShell --color1 Orange'.
  39. <p>Also note that if you do not explictly specify a font (<strong>-fn</strong> and <strong>-fm</strong>)
  40. or a multichar encoding method (<strong>-km</strong>), rxvt will select a font for the
  41. preferable encoding according to your locale. Supported encodings are:
  42. <strong>ISO-8859-</strong>n (n=<strong>1</strong>...<strong>15</strong>), <strong>KOI8-R</strong>, <strong>KOI8-U</strong>, <strong>EUC-JP</strong>,
  43. <strong>Shift_JIS</strong>, <strong>EUC-KR</strong>, <strong>EUC-CN</strong> (aka <strong>GB</strong>), and <strong>Big5</strong>.
  44. <p>The following options are available:
  45. <p><dl>
  46. <p></p><dt><strong><strong>-help</strong>, <strong>--help</strong></strong><dd>
  47. Print out a message describing available options.
  48. <p></p><dt><strong><strong>-display</strong> <em>displayname</em></strong><dd>
  49. Attempt to open a window on the named X display (<strong>-d</strong> still
  50. respected). In the absence of this option, the display specified
  51. by the <strong>DISPLAY</strong> environment variable is used.
  52. <p></p><dt><strong><strong>-geometry</strong> <em>geom</em></strong><dd>
  53. Window geometry (<strong>-g</strong> still respected);
  54. resource <strong>geometry</strong>.
  55. <p></p><dt><strong><strong>-rv</strong>|<strong>+rv</strong></strong><dd>
  56. Turn on/off simulated reverse video;
  57. resource <strong>reverseVideo</strong>.
  58. <p></p><dt><strong><strong>-j</strong>|<strong>+j</strong></strong><dd>
  59. Turn on/off jump scrolling;
  60. resource <strong>jumpScroll</strong>.
  61. <p></p><dt><strong><strong>-ip</strong>|<strong>+ip</strong></strong><dd>
  62. Turn on/off inheriting parent window's pixmap. Alternative form
  63. is <strong>-tr</strong>;
  64. resource <strong>inheritPixmap</strong>.
  65. <p></p><dt><strong><strong>-bg</strong> <em>colour</em></strong><dd>
  66. Window background colour;
  67. resource <strong>background</strong>.
  68. <p></p><dt><strong><strong>-fg</strong> <em>colour</em></strong><dd>
  69. Window foreground colour;
  70. resource <strong>foreground</strong>.
  71. <p></p><dt><strong><strong>-pixmap:</strong> <em>file[;geom]</em></strong><dd>
  72. Compile <em>XPM</em>: Specify XPM file for the background and also
  73. optionally specify its scaling with a geometry string. Note you
  74. may need to add quotes to avoid special shell interpretation of
  75. the `;' in the command-line;
  76. resource <strong>backgroundPixmap</strong>.
  77. <p></p><dt><strong><strong>-cr</strong> <em>colour</em></strong><dd>
  78. The cursor colour;
  79. resource <strong>cursorColor</strong>.
  80. <p></p><dt><strong><strong>-pr</strong> <em>colour</em></strong><dd>
  81. The mouse pointer colour;
  82. resource <strong>pointerColor</strong>.
  83. <p></p><dt><strong><strong>-bd</strong> <em>colour</em></strong><dd>
  84. The colour of the border between the xterm scrollbar and the text;
  85. resource <strong>borderColor</strong>.
  86. <p></p><dt><strong><strong>-fn</strong> <em>fontname</em></strong><dd>
  87. Main normal text font;
  88. resource <strong>font</strong>.
  89. <p></p><dt><strong><strong>-fb</strong> <em>fontname</em></strong><dd>
  90. Main bold text font;
  91. resource <strong>boldFont</strong>.
  92. <p></p><dt><strong><strong>-fm</strong> <em>fontname</em></strong><dd>
  93. Main multicharacter font;
  94. resource <strong>mfont</strong>.
  95. <p></p><dt><strong><strong>-km</strong> <em>mode</em></strong><dd>
  96. Compile <em>multichar_languages</em>:
  97. Multiple-character font-set encoding mode;
  98. <strong>eucj</strong>: EUC Japanese encoding.
  99. <strong>sjis</strong>: Shift JIS encoding.
  100. <strong>big5</strong>: BIG5 encoding.
  101. <strong>gb</strong>: GB encoding.
  102. <strong>kr</strong>: EUC Korean encoding.
  103. <strong>noenc</strong>: no encoding;
  104. resource <strong>multichar_encoding</strong>.
  105. <p></p><dt><strong><strong>-grk</strong> <em>mode</em></strong><dd>
  106. Compile <em>Greek</em>: Greek keyboard translation;
  107. <strong>iso</strong>: ISO-8859 mapping.
  108. <strong>ibm</strong>: IBM-437 mapping;
  109. resource <strong>greek_keyboard</strong>.
  110. <p></p><dt><strong><strong>-name</strong> <em>name</em></strong><dd>
  111. Specify the application name under which resources
  112. are to be obtained, rather than the default executable file name.
  113. Name should not contain `.' or `*' characters.
  114. Also sets the icon and title name.
  115. <p></p><dt><strong><strong>-ls</strong>|<strong>+ls</strong></strong><dd>
  116. Start as a login-shell/sub-shell;
  117. resource <strong>loginShell</strong>.
  118. <p></p><dt><strong><strong>-ut</strong>|<strong>+ut</strong></strong><dd>
  119. Compile <em>utmp</em>: Inhibit/enable writing a utmp entry;
  120. resource <strong>utmpInhibit</strong>.
  121. <p></p><dt><strong><strong>-vb</strong>|<strong>+vb</strong></strong><dd>
  122. Turn on/off visual bell on receipt of a bell character;
  123. resource <strong>visualBell</strong>.
  124. <p></p><dt><strong><strong>-sb</strong>|<strong>+sb</strong></strong><dd>
  125. Turn on/off scrollbar;
  126. resource <strong>scrollBar</strong>.
  127. <p></p><dt><strong><strong>-si</strong>|<strong>+si</strong></strong><dd>
  128. Turn on/off scroll-to-bottom on TTY output inhibit;
  129. resource <strong>scrollTtyOutput</strong> has opposite effect.
  130. <p></p><dt><strong><strong>-sk</strong>|<strong>+sk</strong></strong><dd>
  131. Turn on/off scroll-to-bottom on keypress;
  132. resource <strong>scrollTtyKeypress</strong>.
  133. <p></p><dt><strong><strong>-sw</strong>|<strong>+sw</strong></strong><dd>
  134. Turn on/off scrolling with the scrollback buffer as new
  135. lines appear. This only takes effect if <strong>-si</strong> is also given;
  136. resource <strong>scrollWithBuffer</strong>.
  137. <p></p><dt><strong><strong>-sr</strong>|<strong>+sr</strong></strong><dd>
  138. Put scrollbar on right/left;
  139. resource <strong>scrollBar_right</strong>.
  140. <p></p><dt><strong><strong>-st</strong>|<strong>+st</strong></strong><dd>
  141. Display normal (non XTerm/NeXT) scrollbar without/with a trough;
  142. resource <strong>scrollBar_floating</strong>.
  143. <p></p><dt><strong><strong>-mcc</strong>|<strong>+mcc</strong></strong><dd>
  144. Compile <em>multichar_languages</em>: treat multibyte glyphs as single
  145. character for backspace, delete and cursor movement keys;
  146. resource <strong>multibyte_cursor</strong>.
  147. <p></p><dt><strong><strong>-iconic</strong></strong><dd>
  148. Start iconified, if the window manager supports that option.
  149. Alternative form is <strong>-ic</strong>.
  150. <p></p><dt><strong><strong>-sl</strong> <em>number</em></strong><dd>
  151. Save <em>number</em> lines in the scrollback buffer. See resource entry
  152. for limits;
  153. resource <strong>saveLines</strong>.
  154. <p></p><dt><strong><strong>-b</strong> <em>number</em></strong><dd>
  155. Compile <em>frills</em>: Internal border of <em>number</em> pixels. See
  156. resource entry for limits;
  157. resource <strong>internalBorder</strong>.
  158. <p></p><dt><strong><strong>-w</strong> <em>number</em></strong><dd>
  159. Compile <em>frills</em>: External border of <em>number</em> pixels.
  160. Also, <strong>-bw</strong> and <strong>-borderwidth</strong>. See resource entry for limits;
  161. resource <strong>externalBorder</strong>.
  162. <p></p><dt><strong><strong>-lsp</strong> <em>number</em></strong><dd>
  163. Compile <em>linespace</em>: Lines (pixel height) to insert between each
  164. row of the display;
  165. resource <strong>linespace</strong>.
  166. <p></p><dt><strong><strong>-tn</strong> <em>termname</em></strong><dd>
  167. This option specifies the name of the terminal type to be set in the
  168. <strong>TERM</strong> environment variable. This terminal type must exist in the
  169. <em>termcap(5)</em> database and should have <em>li#</em> and <em>co#</em> entries;
  170. resource <strong>termName</strong>.
  171. <p></p><dt><strong><strong>-e</strong> <em>command [arguments]</em></strong><dd>
  172. Run the command with its command-line arguments in the <strong>rxvt</strong>
  173. window; also sets the window title and icon name to be the basename
  174. of the program being executed if neither <em>-title</em> (<em>-T</em>) nor
  175. <em>-n</em> are given on the command line. If this option is used, it
  176. must be the last on the command-line. If there is no <strong>-e</strong> option
  177. then the default is to run the program specified by the <strong>SHELL</strong>
  178. environment variable or, failing that, <em>sh(1)</em>.
  179. <p></p><dt><strong><strong>-title</strong> <em>text</em></strong><dd>
  180. Window title (<strong>-T</strong> still respected); the default title is the
  181. basename of the program specified after the <strong>-e</strong> option, if
  182. any, otherwise the application name;
  183. resource <strong>title</strong>.
  184. <p></p><dt><strong><strong>-n</strong> <em>text</em></strong><dd>
  185. Icon name; the default name is the basename of the program specified
  186. after the <strong>-e</strong> option, if any, otherwise the application name;
  187. resource <strong>iconName</strong>.
  188. <p></p><dt><strong><strong>-C</strong></strong><dd>
  189. Capture system console messages.
  190. <p></p><dt><strong><strong>-pt</strong> <em>style</em></strong><dd>
  191. Compile <em>XIM</em>: input style for input method;
  192. <strong>OverTheSpot</strong>, <strong>OffTheSpot</strong>, <strong>Root</strong>;
  193. resource <strong>preeditType</strong>.
  194. <p></p><dt><strong><strong>-im</strong> <em>text</em></strong><dd>
  195. Compile <em>XIM</em>: input method name.
  196. resource <strong>inputMethod</strong>.
  197. <p></p><dt><strong><strong>-mod</strong> <em>modifier</em></strong><dd>
  198. Override detection of Meta modifier with specified key:
  199. <strong>alt</strong>, <strong>meta</strong>, <strong>hyper</strong>, <strong>super</strong>, <strong>mod1</strong>, <strong>mod2</strong>, <strong>mod3</strong>,
  200. <strong>mod4</strong>, <strong>mod5</strong>;
  201. resource <em>modifier</em>.
  202. <p></p><dt><strong><strong>-xrm</strong> <em>resourcestring</em></strong><dd>
  203. No effect on rxvt. Simply passes through an argument to be made
  204. available in the instance's argument list. Appears in <em>WM_COMMAND</em>
  205. in some window managers.
  206. </dl>
  207. <a name="rxvt-resources.yo"></a>
  208. <h2>RESOURCES (available also as long-options)</h2>
  209. <p>Note: `rxvt --help' gives a list of all resources (long options) compiled
  210. into your version.
  211. If compiled with internal Xresources support (i.e. <strong>rxvt -h</strong> lists
  212. <strong>.Xdefaults</strong>) then <strong>rxvt</strong> accepts application defaults set in
  213. XAPPLOADDIR/Rxvt (compile-time defined: usually
  214. <strong>/usr/lib/X11/app-defaults/Rxvt</strong>) and resources set in <strong>~/.Xdefaults</strong>,
  215. or <strong>~/.Xresources</strong> if <strong>~/.Xdefaults</strong> does not exist. Note that when
  216. reading X resources, <strong>rxvt</strong> recognizes two class names: <strong>XTerm</strong> and
  217. <strong>Rxvt</strong>. The class name <strong>XTerm</strong> allows resources common to both
  218. <strong>rxvt</strong> and <em>xterm</em> to be easily configured, while the class name
  219. <strong>Rxvt</strong> allows resources unique to <strong>rxvt</strong>, notably colours and
  220. key-handling, to be shared between different <strong>rxvt</strong> configurations.
  221. If no resources are specified, suitable defaults will be used.
  222. Command-line arguments can be used to override resource settings. The
  223. following resources are allowed:
  224. <p><dl>
  225. <p></p><dt><strong><strong>geometry:</strong> <em>geom</em></strong><dd>
  226. Create the window with the specified X window geometry [default
  227. 80x24];
  228. option <strong>-geometry</strong>.
  229. <p></p><dt><strong><strong>background:</strong> <em>colour</em></strong><dd>
  230. Use the specified colour as the window's background colour [default
  231. White];
  232. option <strong>-bg</strong>.
  233. <p></p><dt><strong><strong>foreground:</strong> <em>colour</em></strong><dd>
  234. Use the specified colour as the window's foreground colour [default
  235. Black];
  236. option <strong>-fg</strong>.
  237. <p></p><dt><strong><strong>color</strong><em>n</em><strong>:</strong> <em>colour</em></strong><dd>
  238. Use the specified colour for the colour value <em>n</em>, where 0-7
  239. corresponds to low-intensity (normal) colours and 8-15 corresponds to
  240. high-intensity (bold = bright foreground, blink = bright
  241. background) colours. The canonical names are as follows:
  242. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white,
  243. but the actual colour names used are listed in the
  244. <strong>COLORS AND GRAPHICS</strong> section.
  245. <p></p><dt><strong><strong>colorBD:</strong> <em>colour</em></strong><dd>
  246. Use the specified colour to display bold characters when the
  247. foreground colour is the default.
  248. <p></p><dt><strong><strong>colorUL:</strong> <em>colour</em></strong><dd>
  249. Use the specified colour to display underlined characters when the
  250. foreground colour is the default.
  251. <p></p><dt><strong><strong>colorRV:</strong> <em>colour</em></strong><dd>
  252. Use the specified colour as the background for reverse video
  253. characters.
  254. <p></p><dt><strong><strong>cursorColor:</strong> <em>colour</em></strong><dd>
  255. Use the specified colour for the cursor. The default is to use the
  256. foreground colour;
  257. option <strong>-cr</strong>.
  258. <p></p><dt><strong><strong>cursorColor2:</strong> <em>colour</em></strong><dd>
  259. Use the specified colour for the colour of the cursor text. For this
  260. to take effect, <strong>cursorColor</strong> must also be specified. The default
  261. is to use the background colour.
  262. <p></p><dt><strong><strong>reverseVideo:</strong> <em>boolean</em></strong><dd>
  263. <strong>True</strong>: simulate reverse video by foreground and background colours;
  264. option <strong>-rv</strong>.
  265. <strong>False</strong>: regular screen colours [default];
  266. option <strong>+rv</strong>.
  267. See note in <strong>COLORS AND GRAPHICS</strong> section.
  268. <p></p><dt><strong><strong>jumpScroll:</strong> <em>boolean</em></strong><dd>
  269. <strong>True</strong>: specify that jump scrolling should be used. When scrolling
  270. quickly, fewer screen updates are performed [default];
  271. option <strong>-j</strong>.
  272. <strong>False</strong>: specify that smooth scrolling should be used;
  273. option <strong>+j</strong>.
  274. <p></p><dt><strong><strong>inheritPixmap:</strong> <em>boolean</em></strong><dd>
  275. <strong>True</strong>: make the background inherit the parent windows' pixmap,
  276. giving artificial transparency.
  277. <strong>False</strong>: do not inherit the parent windows' pixmap.
  278. <p></p><dt><strong><strong>scrollColor:</strong> <em>colour</em></strong><dd>
  279. Use the specified colour for the scrollbar [default #B2B2B2].
  280. <p></p><dt><strong><strong>troughColor:</strong> <em>colour</em></strong><dd>
  281. Use the specified colour for the scrollbar's trough area [default
  282. #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.
  283. <p></p><dt><strong><strong>backgroundPixmap:</strong> <em>file[;geom]</em></strong><dd>
  284. Use the specified XPM file (note the `.xpm' extension is optional)
  285. for the background and also optionally specify its scaling with a
  286. geometry string <strong>WxH+X+Y</strong>, in which <strong>"W" / "H"</strong> specify the
  287. horizontal/vertical scale (percent) and <strong>"X" / "Y"</strong> locate the
  288. image centre (percent). A scale of 0 displays the image with tiling.
  289. A scale of 1 displays the image without any scaling. A scale of 2 to
  290. 9 specifies an integer number of images in that direction. No image
  291. will be magnified beyond 10 times its original size. The maximum
  292. permitted scale is 1000. [default 0x0+50+50]
  293. <p></p><dt><strong><strong>menu:</strong> <em>file[;tag]</em></strong><dd>
  294. Read in the specified menu file (note the `.menu' extension is
  295. optional) and also optionally specify a starting tag to find. See
  296. the reference documentation for details on the syntax for the menuBar.
  297. <p></p><dt><strong><strong>path:</strong> <em>path</em></strong><dd>
  298. Specify the colon-delimited search path for finding files (XPM and
  299. menus), in addition to the paths specified by the <strong>RXVTPATH</strong> and
  300. <strong>PATH</strong> environment variables.
  301. <p></p><dt><strong><strong>font:</strong> <em>fontname</em></strong><dd>
  302. Select the main text font used [default 7x14];
  303. option <strong>-fn</strong>.
  304. <p></p><dt><strong><strong>font</strong><em>n</em><strong>:</strong> <em>fontname</em></strong><dd>
  305. Specify the alternative font <em>n</em>. The default font values: <br><ul><table>
  306. <tr>
  307. <td> <strong>font</strong>: </td>
  308. <td> 7x14 <br></td>
  309. </tr>
  310. <tr>
  311. <td> <strong>font1</strong>: </td>
  312. <td> 6x10 <br></td>
  313. </tr>
  314. <tr>
  315. <td> <strong>font2</strong>: </td>
  316. <td> 6x13 <br></td>
  317. </tr>
  318. <tr>
  319. <td> <strong>font3</strong>: </td>
  320. <td> 8x13 <br></td>
  321. </tr>
  322. <tr>
  323. <td> <strong>font4</strong>: </td>
  324. <td> 9x15 <br></td>
  325. </tr>
  326. </table> </ul>
  327. <p><p></p><dt><strong><strong>boldFont:</strong> <em>fontname</em></strong><dd>
  328. Specify the name of the bold font to use if <strong>colorBD</strong> has not been
  329. specified and it is not possible to map the default foreground colour
  330. to colour 8-15 [default NONE]. This font must be the same height and
  331. width as the normal font;
  332. option <strong>-fb</strong>.
  333. <p></p><dt><strong><strong>mfont:</strong> <em>fontname</em></strong><dd>
  334. Select the main multiple-character text font used [default k14];
  335. option <strong>-fk</strong>.
  336. <p></p><dt><strong><strong>mfont</strong><em>n</em><strong>:</strong> <em>fontname</em></strong><dd>
  337. Specify the alternative multiple-character font <em>n</em>. If compiled
  338. for multiple-character fonts, the Roman and multiple-character font
  339. sizes should match.
  340. <p></p><dt><strong><strong>multichar_encoding:</strong> <em>mode</em></strong><dd>
  341. Set the encoding mode to be used when multicharacter encoding is
  342. received;
  343. <strong>eucj</strong>: EUC Japanese encoding [default for Kanji].
  344. <strong>sjis</strong>: Shift JIS encoding.
  345. <strong>big5</strong>: BIG5 encoding.
  346. <strong>gb</strong>: GB encoding.
  347. <strong>kr</strong>: EUC Korean encoding.
  348. <strong>noenc</strong>: no encoding;
  349. option <strong>-km</strong>.
  350. <p></p><dt><strong><strong>greek_keyboard:</strong> <em>mode</em></strong><dd>
  351. Set the Greek keyboard translation mode to be used;
  352. <strong>iso</strong>: ISO-8859 mapping (elot-928) [default].
  353. <strong>ibm</strong>: IBM-437 mapping (DOS codepage 737);
  354. option <strong>-grk</strong>.
  355. <p></p><dt><strong><strong>greektoggle_key:</strong> <em>keysym</em></strong><dd>
  356. Set the key to toggle keyboard input between no translation and
  357. Greek translation [default <strong>Mode_switch</strong>].
  358. For more details, see the distributed file <strong>README.greek</strong>.
  359. <p></p><dt><strong><strong>selectstyle:</strong> <em>mode</em></strong><dd>
  360. Set mouse selection style to <strong>old</strong> which is 2.20, <strong>oldword</strong> which
  361. is xterm style with 2.20 old word selection, or anything else which
  362. gives xterm style selection.
  363. <p></p><dt><strong><strong>scrollstyle:</strong> <em>mode</em></strong><dd>
  364. Set scrollbar style to <strong>rxvt</strong>, <strong>next</strong> or <strong>xterm</strong>
  365. <p></p><dt><strong><strong>title:</strong> <em>string</em></strong><dd>
  366. Set window title string, the default title is the command-line
  367. specified after the <strong>-e</strong> option, if any, otherwise the application
  368. name;
  369. option <strong>-title</strong>.
  370. <p></p><dt><strong><strong>iconName:</strong> <em>string</em></strong><dd>
  371. Set the name used to label the window's icon or displayed in an icon
  372. manager window, it also sets the window's title unless it is
  373. explicitly set;
  374. option <strong>-n</strong>.
  375. <p></p><dt><strong><strong>mapAlert:</strong> <em>boolean</em></strong><dd>
  376. <strong>True</strong>: de-iconify (map) on receipt of a bell character.
  377. <strong>False</strong>: no de-iconify (map) on receipt of a bell character
  378. [default].
  379. <p></p><dt><strong><strong>visualBell:</strong> <em>boolean</em></strong><dd>
  380. <strong>True</strong>: use visual bell on receipt of a bell character;
  381. option <strong>-vb</strong>.
  382. <strong>False</strong>: no visual bell [default];
  383. option <strong>+vb</strong>.
  384. <p></p><dt><strong><strong>loginShell:</strong> <em>boolean</em></strong><dd>
  385. <strong>True</strong>: start as a login shell by prepending a `-' to <strong>argv[0]</strong>
  386. of the shell;
  387. option <strong>-ls</strong>.
  388. <strong>False</strong>: start as a normal sub-shell [default];
  389. option <strong>+ls</strong>.
  390. <p></p><dt><strong><strong>utmpInhibit:</strong> <em>boolean</em></strong><dd>
  391. <strong>True</strong>: inhibit writing record into the system log file <strong>utmp</strong>;
  392. option <strong>-ut</strong>.
  393. <strong>False</strong>: write record into the system log file <strong>utmp</strong> [default];
  394. option <strong>+ut</strong>.
  395. <p></p><dt><strong><strong>print-pipe:</strong> <em>string</em></strong><dd>
  396. Specify a command pipe for vt100 printer [default <em>lpr(1)</em>]. Use
  397. <strong>Print</strong> to initiate a screen dump to the printer and <strong>Ctrl-Print</strong>
  398. or <strong>Shift-Print</strong> to include the scrollback as well.
  399. <p></p><dt><strong><strong>scrollBar:</strong> <em>boolean</em></strong><dd>
  400. <strong>True</strong>: enable the scrollbar [default];
  401. option <strong>-sb</strong>.
  402. <strong>False</strong>: disable the scrollbar;
  403. option <strong>+sb</strong>.
  404. <p></p><dt><strong><strong>scrollBar_right:</strong> <em>boolean</em></strong><dd>
  405. <strong>True</strong>: place the scrollbar on the right of the window;
  406. option <strong>-sr</strong>.
  407. <strong>False</strong>: place the scrollbar on the left of the window;
  408. option <strong>+sr</strong>.
  409. <p></p><dt><strong><strong>scrollBar_floating:</strong> <em>boolean</em></strong><dd>
  410. <strong>True</strong>: display an rxvt scrollbar without a trough;
  411. option <strong>-st</strong>.
  412. <strong>False</strong>: display an rxvt scrollbar with a trough;
  413. option <strong>+st</strong>.
  414. <p></p><dt><strong><strong>scrollBar_align:</strong> <em>mode</em></strong><dd>
  415. Align the <strong>top</strong>, <strong>bottom</strong> or <strong>centre</strong> [default] of
  416. the scrollbar thumb with the pointer on middle button
  417. press/drag.
  418. <p></p><dt><strong><strong>scrollTtyOutput:</strong> <em>boolean</em></strong><dd>
  419. <strong>True</strong>: scroll to bottom when tty receives output;
  420. option(+si).
  421. <strong>False</strong>: do not scroll to bottom when tty receives output;
  422. option(-si).
  423. <p></p><dt><strong><strong>scrollWithBuffer:</strong> <em>boolean</em></strong><dd>
  424. <strong>True</strong>: scroll with scrollback buffer when tty recieves
  425. new lines (and <strong>scrollTtyOutput</strong> is False);
  426. option(+sw).
  427. <strong>False</strong>: do not scroll with scrollback buffer when tty
  428. recieves new lines;
  429. option(-sw).
  430. <p></p><dt><strong><strong>scrollTtyKeypress:</strong> <em>boolean</em></strong><dd>
  431. <strong>True</strong>: scroll to bottom when a non-special key is pressed.
  432. Special keys are those which are intercepted by rxvt for special
  433. handling and are not passed onto the shell;
  434. option(-sk).
  435. <strong>False</strong>: do not scroll to bottom when a non-special key is pressed;
  436. option(+sk).
  437. <p></p><dt><strong><strong>smallfont_key:</strong> <em>keysym</em></strong><dd>
  438. If enabled, use <strong>Alt-</strong><em>keysym</em> to toggle to a smaller font
  439. [default <strong>Alt-&lt;</strong>]
  440. <p></p><dt><strong><strong>bigfont_key:</strong> <em>keysym</em></strong><dd>
  441. If enabled, use <strong>Alt-</strong><em>keysym</em> to toggle to a bigger font
  442. [default <strong>Alt-&gt;</strong>]
  443. <p></p><dt><strong><strong>saveLines:</strong> <em>number</em></strong><dd>
  444. Save <em>number</em> lines in the scrollback buffer [default 64]. This
  445. resource is limited on most machines to 65535;
  446. option <strong>-sl</strong>.
  447. <p></p><dt><strong><strong>internalBorder:</strong> <em>number</em></strong><dd>
  448. Internal border of <em>number</em> pixels. This resource is limited to 100;
  449. option <strong>-b</strong>.
  450. <p></p><dt><strong><strong>externalBorder:</strong> <em>number</em></strong><dd>
  451. External border of <em>number</em> pixels. This resource is limited to 100;
  452. option <strong>-w</strong>, <strong>-bw</strong>, <strong>-borderwidth</strong>.
  453. <p></p><dt><strong><strong>termName:</strong> <em>termname</em></strong><dd>
  454. Specifies the terminal type name to be set in the <strong>TERM</strong>
  455. environment variable;
  456. option <strong>-tn</strong>.
  457. <p></p><dt><strong><strong>linespace:</strong> <em>number</em></strong><dd>
  458. Specifies number of lines (pixel height) to insert between each row
  459. of the display [default 0];
  460. option <strong>-lsp</strong>.
  461. <p></p><dt><strong><strong>meta8:</strong> <em>boolean</em></strong><dd>
  462. <strong>True</strong>: handle Meta (Alt) + keypress to set the 8th bit.
  463. <strong>False</strong>: handle Meta (Alt) + keypress as an escape prefix [default].
  464. <p></p><dt><strong><strong>mouseWheelScrollPage:</strong> <em>boolean</em></strong><dd>
  465. <strong>True</strong>: the mouse wheel scrolls a page full.
  466. <strong>False</strong>: the mouse wheel scrolls five lines [default].
  467. <p></p><dt><strong><strong>multibyte_cursor:</strong> <em>boolean</em></strong><dd>
  468. <strong>True</strong>: consider multibyte glyphs as single character for backspace,
  469. delete and cursor movement keys;
  470. option <strong>-mcc</strong>.
  471. <strong>False</strong>: move through all components of all glyphs;
  472. option <strong>+mcc</strong>.
  473. <p></p><dt><strong><strong>backspacekey:</strong> <em>string</em></strong><dd>
  474. The string to send when the backspace key is pressed. If set to
  475. <strong>DEC</strong> or unset it will send <strong>Delete</strong> (code 127) or, if shifted,
  476. <strong>Backspace</strong> (code 8) - which can be reversed with the appropriate
  477. DEC private mode escape sequence.
  478. <p></p><dt><strong><strong>deletekey:</strong> <em>string</em></strong><dd>
  479. The string to send when the delete key (not the keypad delete key) is
  480. pressed. If unset it will send the sequence traditionally associated
  481. with the <strong>Execute</strong> key.
  482. <p></p><dt><strong><strong>cutchars:</strong> <em>string</em></strong><dd>
  483. The characters used as delimiters for double-click word selection.
  484. The built-in default: <br><strong>BACKSLASH `"'&amp;()*,;&lt;=&gt;?@[]{|}</strong>
  485. <p></p><dt><strong><strong>preeditType:</strong> <em>style</em></strong><dd>
  486. <strong>OverTheSpot</strong>, <strong>OffTheSpot</strong>, <strong>Root</strong>;
  487. option <strong>-pt</strong>.
  488. <p></p><dt><strong><strong>inputMethod:</strong> <em>name</em></strong><dd>
  489. <em>name</em> of inputMethod to use;
  490. option <strong>-im</strong>.
  491. <p></p><dt><strong><strong>modifier:</strong> <em>modifier</em></strong><dd>
  492. Set the key to be interpreted as the Meta key to:
  493. <strong>alt</strong>, <strong>meta</strong>, <strong>hyper</strong>, <strong>super</strong>, <strong>mod1</strong>, <strong>mod2</strong>, <strong>mod3</strong>,
  494. <strong>mod4</strong>, <strong>mod5</strong>;
  495. option <strong>-mod</strong>.
  496. <p></p><dt><strong><strong>answerbackString:</strong> <em>string</em></strong><dd>
  497. Specify the reply rxvt sends to the shell when an ENQ (control-E)
  498. character is passed through. It may contain escape values as
  499. described in the entry on <strong>keysym</strong> following.
  500. <p></p><dt><strong><strong>keysym.</strong><em>sym</em>: <em>string</em></strong><dd>
  501. Associate <em>string</em> with keysym <em>sym</em> (<strong>0xFF00 - 0xFFFF</strong>). It
  502. may contain escape values (\a: bell, \b: backspace, \e, \E: escape,
  503. \n: newline, \r: return, \t: tab, \000: octal number) or control
  504. characters (^?: delete, ^@: null, ^A ...) and may enclosed with
  505. double quotes so that it can start or end with whitespace. The
  506. intervening resource name <strong>keysym.</strong> cannot be omitted. This
  507. resource is only available when compiled with KEYSYM_RESOURCE.
  508. </dl>
  509. <a name="rxvt-scrollbar.yo"></a>
  510. <h2>THE SCROLLBAR</h2>
  511. <p>Lines of text that scroll off the top of the <strong>rxvt</strong> window (resource:
  512. <strong>saveLines</strong>) and can be scrolled back using the scrollbar or by keystrokes.
  513. The normal <strong>rxvt</strong> scrollbar has arrows and its behaviour is fairly
  514. intuitive. The <strong>xterm-scrollbar</strong> is without arrows and its behaviour
  515. mimics that of <em>xterm</em>
  516. <p>Scroll down with <strong>Button1</strong> (<strong>xterm-scrollbar</strong>) or <strong>Shift-Next</strong>.
  517. Scroll up with <strong>Button3</strong> (<strong>xterm-scrollbar</strong>) or <strong>Shift-Prior</strong>.
  518. Continuous scroll with <strong>Button2</strong>.
  519. <a name="rxvt-mousereporting.yo"></a>
  520. <h2>MOUSE REPORTING</h2>
  521. <p>To temporarily override mouse reporting, for either the scrollbar or the
  522. normal text selection/insertion, hold either the Shift or the Meta (Alt) key
  523. while performing the desired mouse action.
  524. <p>If mouse reporting mode is active, the normal scrollbar actions are disabled
  525. -- on the assumption that we are using a fullscreen application.
  526. Instead, pressing Button1 and Button3 sends
  527. <strong>ESC[6~</strong> (Next) and <strong>ESC[5~</strong> (Prior), respectively.
  528. Similarly, clicking on the up and down arrows sends <strong>ESC[A</strong> (Up) and
  529. <strong>ESC[B</strong> (Down), respectively.
  530. <a name="rxvt-textselection.yo"></a>
  531. <h2>TEXT SELECTION AND INSERTION</h2>
  532. <p>The behaviour of text selection and insertion mechanism is similar to
  533. <em>xterm</em>(1).
  534. <p><dl>
  535. <p></p><dt><strong><strong>Selection</strong>:</strong><dd>
  536. Left click at the beginning of the region, drag to the end of the
  537. region and release; Right click to extend the marked region;
  538. Left double-click to select a word; Left triple-click to select
  539. the entire line.
  540. <p><p></p><dt><strong><strong>Insertion</strong>:</strong><dd>
  541. Pressing and releasing the Middle mouse button (or <strong>Shift-Insert</strong>)
  542. in an <strong>rxvt</strong> window causes the current text selection to be inserted
  543. as if it had been typed on the keyboard.
  544. </dl>
  545. <a name="rxvt-fonts.yo"></a>
  546. <h2>CHANGING FONTS</h2>
  547. <p>You can change fonts on-the-fly, which is to say cycle through the default
  548. font and others of various sizes, by using <strong>Shift-KP_Add</strong> and
  549. <strong>Shift-KP_Subtract</strong>. Or, alternatively (if enabled) with
  550. <strong>Alt-&gt;</strong> and <strong>Alt-&lt;</strong>, where the actual key
  551. can be selected using resources <strong>smallfont_key</strong>/<strong>bigfont_key</strong>.
  552. <a name="rxvt-login.yo"></a>
  553. <h2>LOGIN STAMP</h2>
  554. <p><strong>rxvt</strong> tries to write an entry into the <em>utmp</em>(5) file so that it can be
  555. seen via the <em>who(1)</em> command, and can accept messages. To allow this
  556. feature, <strong>rxvt</strong> must be installed setuid root on some systems.
  557. <a name="rxvt-colours.yo"></a>
  558. <h2>COLORS AND GRAPHICS</h2>
  559. <p>If graphics support was enabled at compile-time, <strong>rxvt</strong> can be queried
  560. with ANSI escape sequences and can address individual pixels instead of
  561. text characters. Note the graphics support is still considered beta code.
  562. <p>In addition to the default foreground and background colours, <strong>rxvt</strong>
  563. can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
  564. versions of the same).
  565. Here is a list of the colours with their <strong>rgb.txt</strong> names.
  566. <p><table>
  567. <tr>
  568. <td> <strong>color0</strong> </td>
  569. <td> (black) </td>
  570. <td> = Black <br></td>
  571. </tr>
  572. <tr>
  573. <td> <strong>color1</strong> </td>
  574. <td> (red) </td>
  575. <td> = Red3 <br></td>
  576. </tr>
  577. <tr>
  578. <td> <strong>color2</strong> </td>
  579. <td> (green) </td>
  580. <td> = Green3 <br></td>
  581. </tr>
  582. <tr>
  583. <td> <strong>color3</strong> </td>
  584. <td> (yellow) </td>
  585. <td> = Yellow3 <br></td>
  586. </tr>
  587. <tr>
  588. <td> <strong>color4</strong> </td>
  589. <td> (blue) </td>
  590. <td> = Blue3 <br></td>
  591. </tr>
  592. <tr>
  593. <td> <strong>color5</strong> </td>
  594. <td> (magenta) </td>
  595. <td> = Magenta3 <br></td>
  596. </tr>
  597. <tr>
  598. <td> <strong>color6</strong> </td>
  599. <td> (cyan) </td>
  600. <td> = Cyan3 <br></td>
  601. </tr>
  602. <tr>
  603. <td> <strong>color7</strong> </td>
  604. <td> (white) </td>
  605. <td> = AntiqueWhite <br></td>
  606. </tr>
  607. <tr>
  608. <td> <strong>color8</strong> </td>
  609. <td> (bright black) </td>
  610. <td> = Grey25 <br></td>
  611. </tr>
  612. <tr>
  613. <td> <strong>color9</strong> </td>
  614. <td> (bright red) </td>
  615. <td> = Red <br></td>
  616. </tr>
  617. <tr>
  618. <td> <strong>color10</strong> </td>
  619. <td> (bright green) </td>
  620. <td> = Green <br></td>
  621. </tr>
  622. <tr>
  623. <td> <strong>color11</strong> </td>
  624. <td> (bright yellow) </td>
  625. <td> = Yellow <br></td>
  626. </tr>
  627. <tr>
  628. <td> <strong>color12</strong> </td>
  629. <td> (bright blue) </td>
  630. <td> = Blue <br></td>
  631. </tr>
  632. <tr>
  633. <td> <strong>color13</strong> </td>
  634. <td> (bright magenta) </td>
  635. <td> = Magenta <br></td>
  636. </tr>
  637. <tr>
  638. <td> <strong>color14</strong> </td>
  639. <td> (bright cyan) </td>
  640. <td> = Cyan <br></td>
  641. </tr>
  642. <tr>
  643. <td> <strong>color15</strong> </td>
  644. <td> (bright white) </td>
  645. <td> = White <br></td>
  646. </tr>
  647. <tr>
  648. <td> <strong>foreground</strong> </td>
  649. <td> </td>
  650. <td> = Black <br></td>
  651. </tr>
  652. <tr>
  653. <td> <strong>background</strong> </td>
  654. <td> </td>
  655. <td> = White <br></td>
  656. </tr>
  657. </table>
  658. <p>It is also possible to specify the colour values of <strong>foreground</strong>,
  659. <strong>background</strong>, <strong>cursorColor</strong>, <strong>cursorColor2</strong>, <strong>colorBD</strong>, <strong>colorUL</strong>
  660. as a number 0-15, as a convenient shorthand to reference the colour name of
  661. color0-color15.
  662. <p>Note that <strong>-rv</strong> (<strong>"reverseVideo: True"</strong>) simulates reverse video by
  663. always swapping the foreground/background colours. This is in contrast to
  664. <em>xterm</em>(1) where the colours are only swapped if they have not otherwise been
  665. specified.
  666. For example,
  667. <p><dl>
  668. <p></p><dt><strong><strong>rxvt -fg Black -bg White -rv</strong></strong><dd>
  669. would yield White on Black, while on <em>xterm</em>(1) it would yield
  670. Black on White.
  671. </dl>
  672. <a name="rxvt-environment.yo"></a>
  673. <h2>ENVIRONMENT</h2>
  674. <p><strong>rxvt</strong> sets the environment variables <strong>TERM</strong>, <strong>COLORTERM</strong> and
  675. <strong>COLORFGBG</strong>. The environment variable <strong>WINDOWID</strong> is set to the X window
  676. id number of the <strong>rxvt</strong> window and it also uses and sets the environment
  677. variable <strong>DISPLAY</strong> to specify which display terminal to use. <strong>rxvt</strong> uses
  678. the environment variables <strong>RXVTPATH</strong> and <strong>PATH</strong> to find XPM files.
  679. <a name="rxvt-files.yo"></a>
  680. <h2>FILES</h2>
  681. <p><dl>
  682. <p></p><dt><strong><strong>/etc/utmp</strong></strong><dd> System file for login records.
  683. <p></p><dt><strong><strong>/usr/lib/X11/rgb.txt</strong></strong><dd> Color names.
  684. </dl>
  685. <p>
  686. <h2>SEE ALSO</h2>
  687. <p><em>xterm</em>(1), <em>sh</em>(1), <em>resize</em>(1), <em>X</em>(1), <em>pty</em>(4), <em>tty</em>(4),
  688. <em>utmp</em>(5)
  689. <p>See rxvtRef.html rxvtRef.txt for detailed information on recognized escape
  690. sequences and menuBar syntax, etc.
  691. <p>
  692. <h2>BUGS</h2>
  693. <p>Check the BUGS file for an up-to-date list.
  694. <p>Cursor change support is not yet implemented.
  695. <p>Click-and-drag doesn't work with X11 mouse report overriding.
  696. <p>Graphics support is fairly crude.
  697. <p>
  698. <h2>FTP LOCATION</h2>
  699. <p>rxvt-2.7.10.tar.gz can be found at the following ftp sites
  700. <a href="RXVTFTPSITE()">ftp://ftp.rxvt.org/pub/rxvt</a>
  701. <p>
  702. <h2>CURRENT PROJECT COORDINATOR</h2>
  703. <p><dl>
  704. <p></p><dt><strong>Project Coordinator</strong><dd>
  705. Geoff Wing <a href="mailto:RXVTMAINTEMAIL()"><em>&lt;gcw@rxvt.org&gt;</em></a><br><p></p><dt><strong>Web page maintainter</strong><dd>
  706. Oezguer Kesim <a href="mailto:RXVTWEBMAINTEMAIL()"><em>&lt;oec@rxvt.org&gt;</em></a><br><a href="RXVTWEBPAGE()">&lt;http://www.rxvt.org/&gt;</a><br><p></p><dt><strong>Mailing list</strong><dd>
  707. The Rxvt Workers <a href="mailto:<rxvt-workers@rxvt.org>"><em>&lt;rxvt-workers@rxvt.org&gt;</em></a>
  708. mailing list has also been established for rxvt development, to
  709. subscribe, email to
  710. <a href="mailto:<rxvt-workers-subscribe@rxvt.org>"><em>&lt;rxvt-workers-subscribe@rxvt.org&gt;</em></a>.
  711. There is also a mailing list for announcements of new releases of
  712. rxvt. To subscribe, email to
  713. <a href="mailto:<rxvt-announce-subscribe@rxvt.org>"><em>&lt;rxvt-announce-subscribe@rxvt.org&gt;</em></a>.
  714. </dl>
  715. <p>
  716. <h2>AUTHORS</h2>
  717. <p><dl>
  718. <p></p><dt><strong>John Bovey</strong><dd>
  719. University of Kent, 1992, wrote the original Xvt.
  720. <p></p><dt><strong>Rob Nation <a href="mailto:<nation@rocket.sanders.lockheed.com>"><em>&lt;nation@rocket.sanders.lockheed.com&gt;</em></a></strong><dd>
  721. very heavily modified Xvt and came up with Rxvt
  722. <p></p><dt><strong>Angelo Haritsis <a href="mailto:<ah@doc.ic.ac.uk>"><em>&lt;ah@doc.ic.ac.uk&gt;</em></a></strong><dd>
  723. wrote the Greek Keyboard Input
  724. <p></p><dt><strong>mj olesen <a href="mailto:<olesen@me.QueensU.CA>"><em>&lt;olesen@me.QueensU.CA&gt;</em></a></strong><dd>
  725. Wrote the menu system. <br>Project Coordinator (changes.txt 2.11 to 2.21)
  726. <p></p><dt><strong>Oezguer Kesim <a href="mailto:<kesim@math.fu-berlin.de>"><em>&lt;kesim@math.fu-berlin.de&gt;</em></a></strong><dd>
  727. Project Coordinator (changes.txt 2.21a to 2.4.5)
  728. <p></p><dt><strong>Geoff Wing <a href="mailto:<gcw@pobox.com>"><em>&lt;gcw@pobox.com&gt;</em></a></strong><dd>
  729. Rewrote screen display and text selection routines. <br>Project Coordinator (changes.txt 2.4.6 - )
  730. </dl>
  731. </body>
  732. </html>