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.60 by root, Thu Jul 6 19:43:21 2006 UTC vs.
Revision 1.63 by root, Thu Nov 2 17:37:47 2006 UTC

… …
53<p><strong>rxvt</strong> [options] [-e command [ args ]]</p> 53<p><strong>rxvt</strong> [options] [-e command [ args ]]</p>
54<p> 54<p>
55</p> 55</p>
56<hr /> 56<hr />
57<h1><a name="description">DESCRIPTION</a></h1> 57<h1><a name="description">DESCRIPTION</a></h1>
58<p><strong>rxvt-unicode</strong>, version <strong>7.7</strong>, is a colour vt102 terminal 58<p><strong>rxvt-unicode</strong>, version <strong>8.0</strong>, is a colour vt102 terminal
59emulator intended as an <em>xterm</em>(1) replacement for users who do not 59emulator intended as an <em>xterm</em>(1) replacement for users who do not
60require features such as Tektronix 4014 emulation and toolkit-style 60require features such as Tektronix 4014 emulation and toolkit-style
61configurability. As a result, <strong>rxvt-unicode</strong> uses much less swap space -- 61configurability. As a result, <strong>rxvt-unicode</strong> uses much less swap space --
62a significant advantage on a machine serving many X sessions.</p> 62a significant advantage on a machine serving many X sessions.</p>
63<p> 63<p>
… …
65<hr /> 65<hr />
66<h1><a name="frequently_asked_questions">FREQUENTLY ASKED QUESTIONS</a></h1> 66<h1><a name="frequently_asked_questions">FREQUENTLY ASKED QUESTIONS</a></h1>
67<p>See <code>rxvt(7)</code> (try <code>man 7 rxvt</code>) for a list of 67<p>See <code>rxvt(7)</code> (try <code>man 7 rxvt</code>) for a list of
68frequently asked questions and answer to them and some common 68frequently asked questions and answer to them and some common
69problems. That document is also accessible on the World-Wide-Web at 69problems. That document is also accessible on the World-Wide-Web at
70<a href="http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html">http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html</a>.</p> 70<a href="http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html">http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html</a>.</p>
71<p> 71<p>
72</p> 72</p>
73<hr /> 73<hr />
74<h1><a name="rxvtunicode_vs__rxvt">RXVT-UNICODE VS. RXVT</a></h1> 74<h1><a name="rxvtunicode_vs__rxvt">RXVT-UNICODE VS. RXVT</a></h1>
75<p>Unlike the original rxvt, <strong>rxvt-unicode</strong> stores all text in Unicode 75<p>Unlike the original rxvt, <strong>rxvt-unicode</strong> stores all text in Unicode
… …
77world. Being a terminal emulator, however, some things are very difficult, 77world. Being a terminal emulator, however, some things are very difficult,
78especially cursive scripts such as arabic, vertically written scripts 78especially cursive scripts such as arabic, vertically written scripts
79like mongolian or scripts requiring extremely complex combining rules, 79like mongolian or scripts requiring extremely complex combining rules,
80like tibetan or devenagari. Don't expect pretty output when using these 80like tibetan or devenagari. Don't expect pretty output when using these
81scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 81scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
82fine, though. A somewhat difficult case are left-to-right scripts, such 82fine, though. A somewhat difficult case are right-to-left scripts, such
83as hebrew: <strong>rxvt-unicode</strong> adopts the view that bidirectional algorithms 83as hebrew: <strong>rxvt-unicode</strong> adopts the view that bidirectional algorithms
84belong into the application, not the terminal emulator (too many things -- 84belong into the application, not the terminal emulator (too many things --
85such as cursor-movement while editing -- break otherwise), but that might 85such as cursor-movement while editing -- break otherwise), but that might
86change.</p> 86change.</p>
87<p>If you are looking for a terminal that supports more exotic scripts, let 87<p>If you are looking for a terminal that supports more exotic scripts, let
88me recommend <code>mlterm</code>, which is a very userfriendly, lean and clean 88me recommend <code>mlterm</code>, which is a very user friendly, lean and clean
89terminal emulator. In fact, the reason rxvt-unicode was born was solely 89terminal emulator. In fact, the reason rxvt-unicode was born was solely
90because the author couldn't get <code>mlterm</code> to use one font for latin1 and 90because the author couldn't get <code>mlterm</code> to use one font for latin1 and
91another for japanese.</p> 91another for japanese.</p>
92<p>Therefore another design rationale was the use of multiple fonts to 92<p>Therefore another design rationale was the use of multiple fonts to
93display characters: The idea of a single unicode font which many other 93display characters: The idea of a single unicode font which many other
94programs force onto its users never made sense to me: You should be able 94programs force onto its users never made sense to me: You should be able
95to choose any font for any script freely.</p> 95to choose any font for any script freely.</p>
96<p>Apart from that, rxvt-unicode is also much better internationalised than 96<p>Apart from that, rxvt-unicode is also much better internationalised than
97its predecessor, supports things such as XFT and ISO 14755 that are handy 97its predecessor, supports things such as XFT and ISO 14755 that are handy
98in i18n-environments, is faster, and has a lot less bugs than the original 98in i18n-environments, is faster, and has a lot bugs less than the original
99rxvt. This all in addition to dozens of other small improvements.</p> 99rxvt. This all in addition to dozens of other small improvements.</p>
100<p>It is still faithfully following the original rxvt idea of being lean 100<p>It is still faithfully following the original rxvt idea of being lean
101and nice on resources: for example, you can still configure rxvt-unicode 101and nice on resources: for example, you can still configure rxvt-unicode
102without most of its features to get a lean binary. It also comes with 102without most of its features to get a lean binary. It also comes with
103a client/daemon pair that lets you open any number of terminal windows 103a client/daemon pair that lets you open any number of terminal windows
104from within a single process, which makes startup time very fast and 104from within a single process, which makes startup time very fast and
105drastically reduces memory usage. See <code>rxvtd(1)</code> (daemon) and 105drastically reduces memory usage. See <code>rxvtd(1)</code> (daemon) and
106<code>rxvtc(1)</code> (client).</p> 106<code>rxvtc(1)</code> (client).</p>
107<p>It also makes technical information about escape sequences (which have 107<p>It also makes technical information about escape sequences (which have
108been extended) easier accessible: see <code>rxvt(7)</code> for technical 108been extended) more accessible: see <code>rxvt(7)</code> for technical
109reference documentation (escape sequences etc.).</p> 109reference documentation (escape sequences etc.).</p>
110<p> 110<p>
111</p> 111</p>
112<hr /> 112<hr />
113<h1><a name="options">OPTIONS</a></h1> 113<h1><a name="options">OPTIONS</a></h1>
… …
171<p>Turn on/off inheriting parent window's pixmap. Alternative form is 171<p>Turn on/off inheriting parent window's pixmap. Alternative form is
172<strong>-tr</strong>; resource <strong>inheritPixmap</strong>.</p> 172<strong>-tr</strong>; resource <strong>inheritPixmap</strong>.</p>
173</dd> 173</dd>
174<dd> 174<dd>
175<p><em>Please note that transparency of any kind if completely unsupported by 175<p><em>Please note that transparency of any kind if completely unsupported by
176the author. Don't bug him with installation questions!</em></p> 176the author. Don't bug him with installation questions! Read the FAQ (man 7
177rxvt)!</em></p>
177</dd> 178</dd>
178</li> 179</li>
179<dt><strong><a name="item__2dfade_number"><strong>-fade</strong> <em>number</em></a></strong> 180<dt><strong><a name="item__2dfade_number"><strong>-fade</strong> <em>number</em></a></strong>
180 181
181<dd> 182<dd>
… …
609</dd> 610</dd>
610<dd> 611<dd>
611<p>It might be useful to know that rxvt will not close file 612<p>It might be useful to know that rxvt will not close file
612descriptors passed to it (except for stdin/out/err, of course), so you 613descriptors passed to it (except for stdin/out/err, of course), so you
613can use file descriptors to communicate with the programs within the 614can use file descriptors to communicate with the programs within the
614terminal. This works regardless of wether the <code>-embed</code> option was used or 615terminal. This works regardless of whether the <code>-embed</code> option was used or
615not.</p> 616not.</p>
616</dd> 617</dd>
617<dd> 618<dd>
618<p>Here is a short Gtk2-perl snippet that illustrates how this option can be 619<p>Here is a short Gtk2-perl snippet that illustrates how this option can be
619used (a longer example is in <em>doc/embed</em>):</p> 620used (a longer example is in <em>doc/embed</em>):</p>
… …
629</li> 630</li>
630<dt><strong><a name="item__2dpty_2dfd_file_descriptor"><strong>-pty-fd</strong> <em>file descriptor</em></a></strong> 631<dt><strong><a name="item__2dpty_2dfd_file_descriptor"><strong>-pty-fd</strong> <em>file descriptor</em></a></strong>
631 632
632<dd> 633<dd>
633<p>Tells rxvt NOT to execute any commands or create a new pty/tty 634<p>Tells rxvt NOT to execute any commands or create a new pty/tty
634pair but instead use the given filehandle as the tty master. This is 635pair but instead use the given file descriptor as the tty master. This is
635useful if you want to drive rxvt as a generic terminal emulator 636useful if you want to drive rxvt as a generic terminal emulator
636without having to run a program within it.</p> 637without having to run a program within it.</p>
637</dd> 638</dd>
638<dd> 639<dd>
639<p>If this switch is given, rxvt will not create any utmp/wtmp 640<p>If this switch is given, rxvt will not create any utmp/wtmp
… …
971<dt><strong><a name="item_intensitystyles_3a_boolean"><strong>intensityStyles:</strong> <em>boolean</em></a></strong> 972<dt><strong><a name="item_intensitystyles_3a_boolean"><strong>intensityStyles:</strong> <em>boolean</em></a></strong>
972 973
973<dd> 974<dd>
974<p>When font styles are not enabled, or this option is enabled (<strong>True</strong>, 975<p>When font styles are not enabled, or this option is enabled (<strong>True</strong>,
975option <strong>-is</strong>, the default), bold and italic font styles imply high 976option <strong>-is</strong>, the default), bold and italic font styles imply high
976intensity foreground/backround colours. Disabling this option (<strong>False</strong>, 977intensity foreground/background colours. Disabling this option (<strong>False</strong>,
977option <strong>+is</strong>) disables this behaviour, the high intensity colours are not 978option <strong>+is</strong>) disables this behaviour, the high intensity colours are not
978reachable.</p> 979reachable.</p>
979</dd> 980</dd>
980</li> 981</li>
981<dt><strong><a name="item_selectstyle_3a_mode"><strong>selectstyle:</strong> <em>mode</em></a></strong> 982<dt><strong><a name="item_selectstyle_3a_mode"><strong>selectstyle:</strong> <em>mode</em></a></strong>
… …
1056<pre> 1057<pre>
1057 URxvt.print-pipe: cat &gt; $(TMPDIR=$HOME mktemp urxvt.XXXXXX)</pre> 1058 URxvt.print-pipe: cat &gt; $(TMPDIR=$HOME mktemp urxvt.XXXXXX)</pre>
1058</dd> 1059</dd>
1059<dd> 1060<dd>
1060<p>This creates a new file in your home directory with the screen contents 1061<p>This creates a new file in your home directory with the screen contents
1061everytime you hit <code>Print</code>.</p> 1062every time you hit <code>Print</code>.</p>
1062</dd> 1063</dd>
1063</li> 1064</li>
1064<dt><strong><a name="item_scrollbar_3a_boolean"><strong>scrollBar:</strong> <em>boolean</em></a></strong> 1065<dt><strong><a name="item_scrollbar_3a_boolean"><strong>scrollBar:</strong> <em>boolean</em></a></strong>
1065 1066
1066<dd> 1067<dd>
… …
1100<dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong> 1101<dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong>
1101 1102
1102<dd> 1103<dd>
1103<p><strong>True</strong>: scroll with scrollback buffer when tty receives new lines (and 1104<p><strong>True</strong>: scroll with scrollback buffer when tty receives new lines (and
1104<strong>scrollTtyOutput</strong> is False); option <strong>-sw</strong>. <strong>False</strong>: do not scroll 1105<strong>scrollTtyOutput</strong> is False); option <strong>-sw</strong>. <strong>False</strong>: do not scroll
1105with scrollback buffer when tty recieves new lines; option <strong>+sw</strong>.</p> 1106with scrollback buffer when tty receives new lines; option <strong>+sw</strong>.</p>
1106</dd> 1107</dd>
1107</li> 1108</li>
1108<dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong> 1109<dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong>
1109 1110
1110<dd> 1111<dd>
… …
1383<dd> 1384<dd>
1384<p><em>string</em> may contain escape values (<code>\a</code>: bell, <code>\b</code>: backspace, 1385<p><em>string</em> may contain escape values (<code>\a</code>: bell, <code>\b</code>: backspace,
1385<code>\e</code>, <code>\E</code>: escape, <code>\n</code>: newline, <code>\r</code>: carriage return, <code>\t</code>: tab, 1386<code>\e</code>, <code>\E</code>: escape, <code>\n</code>: newline, <code>\r</code>: carriage return, <code>\t</code>: tab,
1386<code>\000</code>: octal number) or verbatim control characters (<code>^?</code>: delete, 1387<code>\000</code>: octal number) or verbatim control characters (<code>^?</code>: delete,
1387<code>^@</code>: null, <code>^A</code> ...) and may be enclosed with double quotes so that it 1388<code>^@</code>: null, <code>^A</code> ...) and may be enclosed with double quotes so that it
1388can start or end with whitespace.</p> 1389can start or end with whitespace. <strong>This feature is deprecated and will
1390be removed</strong>.</p>
1389</dd> 1391</dd>
1390<dd> 1392<dd>
1391<p>Please note that you need to double the <code>\</code> in resource files, as 1393<p>Please note that you need to double the <code>\</code> in resource files, as
1392Xlib itself does its own de-escaping (you can use <code>\033</code> instead of 1394Xlib itself does its own de-escaping (you can use <code>\033</code> instead of
1393<code>\e</code> (and so on), which will work with both Xt and rxvt's own 1395<code>\e</code> (and so on), which will work with both Xt and rxvt's own
1394processing).</p> 1396processing).</p>
1395</dd> 1397</dd>
1396<dd> 1398<dd>
1397<p>You can define a range of keysyms in one shot by providing a <em>string</em> 1399<p>You can define a range of keysyms in one shot by providing a <em>string</em>
1398with pattern <strong>list/PREFIX/MIDDLE/SUFFIX</strong>, where the delimeter `/' 1400with pattern <strong>list/PREFIX/MIDDLE/SUFFIX</strong>, where the delimiter `/'
1399should be a character not used by the strings.</p> 1401should be a character not used by the strings.</p>
1400</dd> 1402</dd>
1401<dd> 1403<dd>
1402<p>Its usage can be demonstrated by an example:</p> 1404<p>Its usage can be demonstrated by an example:</p>
1403</dd> 1405</dd>
… …
1494<code>selection</code>.</p> 1496<code>selection</code>.</p>
1495</dd> 1497</dd>
1496<dd> 1498<dd>
1497<p>Extension names can also be followed by an argument in angle brackets 1499<p>Extension names can also be followed by an argument in angle brackets
1498(e.g. <code>searchable-scrollback&lt;M-s&gt;</code>, which binds the hotkey for 1500(e.g. <code>searchable-scrollback&lt;M-s&gt;</code>, which binds the hotkey for
1499searchable scorllback to Alt/Meta-s). Mentioning the same extension 1501searchable scrollback to Alt/Meta-s). Mentioning the same extension
1500multiple times with different arguments will pass multiple arguments to 1502multiple times with different arguments will pass multiple arguments to
1501the extension.</p> 1503the extension.</p>
1502</dd> 1504</dd>
1503<dd> 1505<dd>
1504<p>Each extension is looked up in the library directories, loaded if 1506<p>Each extension is looked up in the library directories, loaded if
… …
1794<dl> 1796<dl>
1795<dt><strong><a name="item_term"><strong>TERM</strong></a></strong> 1797<dt><strong><a name="item_term"><strong>TERM</strong></a></strong>
1796 1798
1797<dd> 1799<dd>
1798<p>Normally set to <code>rxvt-unicode</code>, unless overwritten at configure time, via 1800<p>Normally set to <code>rxvt-unicode</code>, unless overwritten at configure time, via
1799resources or on the commandline.</p> 1801resources or on the command line.</p>
1800</dd> 1802</dd>
1801</li> 1803</li>
1802<dt><strong><a name="item_colorterm"><strong>COLORTERM</strong></a></strong> 1804<dt><strong><a name="item_colorterm"><strong>COLORTERM</strong></a></strong>
1803 1805
1804<dd> 1806<dd>
1805<p>Either <code>rxvt</code>, <code>rxvt-xpm</code>, depending on wether rxvt was 1807<p>Either <code>rxvt</code>, <code>rxvt-xpm</code>, depending on whether rxvt was
1806compiled with XPM support, and optionally with the added extension 1808compiled with XPM support, and optionally with the added extension
1807<code>-mono</code> to indicate that rxvt-unicode runs on a monochrome screen.</p> 1809<code>-mono</code> to indicate that rxvt-unicode runs on a monochrome screen.</p>
1808</dd> 1810</dd>
1809</li> 1811</li>
1810<dt><strong><a name="item_colorfgbg"><strong>COLORFGBG</strong></a></strong> 1812<dt><strong><a name="item_colorfgbg"><strong>COLORFGBG</strong></a></strong>

Diff Legend

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