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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.127 by ayin, Wed May 2 23:06:32 2007 UTC vs.
Revision 1.138 by sasha, Thu Sep 20 15:56:41 2007 UTC

… …
26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27internally. That means it can store and display most scripts in the 27internally. That means it can store and display most scripts in the
28world. Being a terminal emulator, however, some things are very difficult, 28world. Being a terminal emulator, however, some things are very difficult,
29especially cursive scripts such as arabic, vertically written scripts 29especially cursive scripts such as arabic, vertically written scripts
30like mongolian or scripts requiring extremely complex combining rules, 30like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devenagari. Don't expect pretty output when using these 31like tibetan or devanagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are right-to-left scripts, such 33fine, though. A somewhat difficult case are right-to-left scripts, such
34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35belong into the application, not the terminal emulator (too many things -- 35belong into the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 36such as cursor-movement while editing -- break otherwise), but that might
… …
108 108
109Turn on/off simulated reverse video; resource B<reverseVideo>. 109Turn on/off simulated reverse video; resource B<reverseVideo>.
110 110
111=item B<-j>|B<+j> 111=item B<-j>|B<+j>
112 112
113Turn on/off jump scrolling; resource B<jumpScroll>. 113Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114
115=item B<-ss>|B<+ss>
116
117Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
114 118
115=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 119=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
116 120
117Turn on/off inheriting parent window's pixmap. Alternative form is 121Turn on/off inheriting parent window's pixmap. Alternative form is
118B<-tr>; resource B<inheritPixmap>. 122B<-tr>; resource B<inheritPixmap>.
119 123
120I<Please note that transparency of any kind if completely unsupported by 124I<Please address all transparency related issues to Sasha Vasko at
121the author. Don't bug him with installation questions! Read the FAQ (man 7 125sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
122@@RXVT_NAME@@)!>
123 126
124=item B<-fade> I<number> 127=item B<-fade> I<number>
125 128
126Fade the text by the given percentage when focus is lost. Small values 129Fade the text by the given percentage when focus is lost. Small values
127fade a little only, 100 completely replaces all colours by the fade 130fade a little only, 100 completely replaces all colours by the fade
… …
135=item B<-tint> I<colour> 138=item B<-tint> I<colour>
136 139
137Tint the transparent background pixmap with the given colour when 140Tint the transparent background pixmap with the given colour when
138transparency is enabled with B<-tr> or B<-ip>. This only works for 141transparency is enabled with B<-tr> or B<-ip>. This only works for
139non-tiled backgrounds, currently. See also the B<-sh> option that can be 142non-tiled backgrounds, currently. See also the B<-sh> option that can be
140used to brighten or darken the image in addition to tinting it; resource 143used to brighten or darken the image in addition to tinting it.
144Please note that certain tint colours can be applied on the server-side,
145thus yielding performance gain of two orders of magnitude. These colours are:
146blue, red, green, cyan, magenta, yellow, and those close to them; resource
141I<tintColor>. Example: 147I<tintColor>. Example:
142 148
143 @@RXVT_NAME@@ -tr -tint blue -sh 40 149 @@RXVT_NAME@@ -tr -tint blue -sh 40
144 150
145=item B<-sh> 151=item B<-sh> I<number>
146 152
147I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 153Darken (0 .. 100) or lighten (-1 .. -100) the transparent
148background image in addition to tinting it (i.e. B<-tint> must be 154background image in addition to (or instead of) tinting it;
149specified, too, e.g. C<-tint white>); resource I<shading>. 155resource I<shading>.
156
157=item B<-blt> I<string>
158
159Specify background blending type. If background pixmap is specified
160at the same time as transparency - such pixmap will be blended over
161transparency image, using method specified. Supported values are :
162B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
163B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
164B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
165alpha-blending; resource I<blendType>.
166
167=item B<-blr> I<HxV>
168
169Apply Gaussian Blur with the specified radii to the transparent
170background image. If single number is specified - both vertical and
171horizontal radii are considered to be the same. Setting one of the
172radii to 1 and another to a large number creates interesting effects
173on some backgrounds. Maximum radius value is 128; resource I<blurRadius>.
150 174
151=item B<-bg> I<colour> 175=item B<-bg> I<colour>
152 176
153Window background colour; resource B<background>. 177Window background colour; resource B<background>.
154 178
… …
156 180
157Window foreground colour; resource B<foreground>. 181Window foreground colour; resource B<foreground>.
158 182
159=item B<-pixmap> I<file[;geom]> 183=item B<-pixmap> I<file[;geom]>
160 184
161Compile I<XPM>: Specify XPM file for the background and also optionally 185Compile I<afterimage>: Specify image file for the background and also
162specify its scaling with a geometry string. Note you may need to 186optionally specify its scaling with a geometry string. Note you may need to
163add quotes to avoid special shell interpretation of the C<;> in the 187add quotes to avoid special shell interpretation of the C<;> in the
164command-line; resource B<backgroundPixmap>. 188command-line; for more details see resource B<backgroundPixmap>.
165 189
166=item B<-cr> I<colour> 190=item B<-cr> I<colour>
167 191
168The cursor colour; resource B<cursorColor>. 192The cursor colour; resource B<cursorColor>.
169 193
… …
322 346
323=item B<-lsp> I<number> 347=item B<-lsp> I<number>
324 348
325Compile I<frills>: Lines (pixel height) to insert between each row of 349Compile I<frills>: Lines (pixel height) to insert between each row of
326the display. Useful to work around font rendering problems; resource 350the display. Useful to work around font rendering problems; resource
327B<linespace>. 351B<lineSpace>.
328 352
329=item B<-tn> I<termname> 353=item B<-tn> I<termname>
330 354
331This option specifies the name of the terminal type to be set in the 355This option specifies the name of the terminal type to be set in the
332B<TERM> environment variable. This terminal type must exist in the 356B<TERM> environment variable. This terminal type must exist in the
… …
386for more info. 410for more info.
387 411
388=item B<-tcw> 412=item B<-tcw>
389 413
390Change the meaning of triple-click selection with the left mouse 414Change the meaning of triple-click selection with the left mouse
415button. Only effective when the original (non-perl) selection code is
391button. Instead of selecting a full line it will extend the selection the 416in-use. Instead of selecting a full line it will extend the selection the
392end of the logical line only. resource B<tripleclickwords>. 417end of the logical line only. resource B<tripleclickwords>.
393 418
394=item B<-insecure> 419=item B<-insecure>
395 420
396Enable "insecure" mode, which currently enables most of the escape 421Enable "insecure" mode, which currently enables most of the escape
… …
591option B<-rv>. B<False>: regular screen colours [default]; option 616option B<-rv>. B<False>: regular screen colours [default]; option
592B<+rv>. See note in B<COLORS AND GRAPHICS> section. 617B<+rv>. See note in B<COLORS AND GRAPHICS> section.
593 618
594=item B<jumpScroll:> I<boolean> 619=item B<jumpScroll:> I<boolean>
595 620
596B<True>: specify that jump scrolling should be used. When scrolling 621B<True>: specify that jump scrolling should be used. When receiving lots
597quickly, fewer screen updates are performed [default]; option B<-j>. 622of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
623has been read, resulting in fewer updates while still displaying every
624received line; option B<-j>.
625
598B<False>: specify that smooth scrolling should be used; option B<+j>. 626B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
627force a screen refresh on each new line it received; option B<+j>.
628
629=item B<skipScroll:> I<boolean>
630
631B<True>: (the default) specify that skip scrolling should be used. When
632receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
633(around 60 times per second), resulting in far fewer updates. This can
634result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
635option B<-ss>.
636
637B<False>: specify that everything is to be displayed, even
638if the refresh is too fast for the human eye to read anything (or the
639monitor to display anything); option B<+ss>.
599 640
600=item B<inheritPixmap:> I<boolean> 641=item B<inheritPixmap:> I<boolean>
601 642
602B<True>: make the background inherit the parent windows' pixmap, giving 643B<True>: make the background inherit the parent windows' pixmap, giving
603artificial transparency. B<False>: do not inherit the parent windows' 644artificial transparency. B<False>: do not inherit the parent windows'
… …
623=item B<shading:> I<number> 664=item B<shading:> I<number>
624 665
625Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image 666Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
626in addition to tinting it; option B<-sh>. 667in addition to tinting it; option B<-sh>.
627 668
669=item B<blendType:> I<string>
670
671Specify background blending type; option B<-blt>.
672
673=item B<blurRadius:> I<number>
674
675Apply Gaussian Blurr with the specified radius to the transparent
676background image; option B<-blr>.
677
628=item B<scrollColor:> I<colour> 678=item B<scrollColor:> I<colour>
629 679
630Use the specified colour for the scrollbar [default #B2B2B2]. 680Use the specified colour for the scrollbar [default #B2B2B2].
631 681
632=item B<troughColor:> I<colour> 682=item B<troughColor:> I<colour>
… …
639The colour of the border around the text area and between the scrollbar 689The colour of the border around the text area and between the scrollbar
640and the text. 690and the text.
641 691
642=item B<backgroundPixmap:> I<file[;geom]> 692=item B<backgroundPixmap:> I<file[;geom]>
643 693
644Use the specified XPM file (note the `.xpm' extension is optional) for 694Use the specified image file for the background and also optionally
645the background and also optionally specify its scaling with a geometry 695specify its scaling with a geometry string B<WxH+X+Y>,
646string B<WxH+X+Y>, in which B<"W" / "H"> specify the 696in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
647horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 697and B<"X" / "Y"> locate the image centre (percent).
648centre (percent). A scale of 0 displays the image with tiling. A scale 698A scale of 0 displays the image with tiling. A scale of 1 displays the
649of 1 displays the image without any scaling. A scale of 2 to 9 699image without any scaling. A scale of 2 to 9 specifies an integer
650specifies an integer number of images in that direction. No image will 700number of images in that direction. No image will be magnified beyond
651be magnified beyond 10 times its original size. The maximum permitted 70110 times its original size. The maximum permitted scale is 1000.
652scale is 1000. [default 0x0+50+50] 702Special string of B<"auto"> used as a geometry will cause image to be
703automatically scaled to match window size.
704If used in conjunction with B<-tr> option - specified pixmap will be
705blended over transparency image using either alpha-blending, or any
706other blending type, specified with B<-blt "type"> option.
707[default 0x0+50+50]
653 708
654=item B<path:> I<path> 709=item B<path:> I<path>
655 710
656Specify the colon-delimited search path for finding XPM files. 711Specify the colon-delimited search path for finding background image files.
657 712
658=item B<font:> I<fontlist> 713=item B<font:> I<fontlist>
659 714
660Select the fonts to be used. This is a comma separated list of font names 715Select the fonts to be used. This is a comma separated list of font names
661that are checked in order when trying to find glyphs for characters. The 716that are checked in order when trying to find glyphs for characters. The
… …
725option B<+is>) disables this behaviour, the high intensity colours are not 780option B<+is>) disables this behaviour, the high intensity colours are not
726reachable. 781reachable.
727 782
728=item B<selectstyle:> I<mode> 783=item B<selectstyle:> I<mode>
729 784
730Set mouse selection style to B<old> which is 2.20, B<oldword> which is 785Set mouse selection style to B<old> which is 2.20, B<oldword> which
731xterm style with 2.20 old word selection, or anything else which gives 786is xterm style with 2.20 old word selection, or anything else which
732xterm style selection. 787gives xterm style selection. Only effective when the original (non-perl)
788selection code is in use.
733 789
734=item B<scrollstyle:> I<mode> 790=item B<scrollstyle:> I<mode>
735 791
736Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 792Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
737the author's favourite. 793the author's favourite.
… …
859=item B<termName:> I<termname> 915=item B<termName:> I<termname>
860 916
861Specifies the terminal type name to be set in the B<TERM> environment 917Specifies the terminal type name to be set in the B<TERM> environment
862variable; option B<-tn>. 918variable; option B<-tn>.
863 919
864=item B<linespace:> I<number> 920=item B<lineSpace:> I<number>
865 921
866Specifies number of lines (pixel height) to insert between each row of 922Specifies number of lines (pixel height) to insert between each row of
867the display [default 0]; option B<-lsp>. 923the display [default 0]; option B<-lsp>.
868 924
869=item B<meta8:> I<boolean> 925=item B<meta8:> I<boolean>
… …
921=item B<cutchars:> I<string> 977=item B<cutchars:> I<string>
922 978
923The characters used as delimiters for double-click word selection 979The characters used as delimiters for double-click word selection
924(whitespace delimiting is added automatically if resource is given). 980(whitespace delimiting is added automatically if resource is given).
925 981
926When the selection extension is in use (the default if compiled in, see 982When the perl selection extension is in use (the default if compiled
927the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters 983in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
928will be created (if the resource exists, otherwise, no regex will be 984characters will be created (if the resource exists, otherwise, no regex
929created). In this mode, characters outside ISO-8859-1 can be used. 985will be created). In this mode, characters outside ISO-8859-1 can be used.
930 986
931When the selection extension is not used, only ISO-8859-1 characters can 987When the selection extension is not used, only ISO-8859-1 characters can
932be used. If not specified, the built-in default is used: 988be used. If not specified, the built-in default is used:
933 989
934B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 990B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
… …
1171=item B<override-redirect>: I<boolean> 1227=item B<override-redirect>: I<boolean>
1172 1228
1173Compile I<frills>: Sets override-redirect for the terminal window, making 1229Compile I<frills>: Sets override-redirect for the terminal window, making
1174it almost invisible to window managers; option B<-override-redirect>. 1230it almost invisible to window managers; option B<-override-redirect>.
1175 1231
1232=item B<iso14755_52:> I<boolean>
1233
1234Turn on/off ISO 14755 5.2 mode (default enabled).
1235
1176=back 1236=back
1177 1237
1178=head1 THE SCROLLBAR 1238=head1 THE SCROLLBAR
1179 1239
1180Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window 1240Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
… …
1198application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1258application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1199(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1259(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1200up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1260up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1201respectively. 1261respectively.
1202 1262
1203=head1 TEXT SELECTION AND INSERTION 1263=head1 THE SELECTION: SELECTING AND PASTING TEXT
1204 1264
1205The behaviour of text selection and insertion mechanism is similar to 1265The behaviour of text selection and insertion/pasting mechanism is similar
1206I<xterm>(1). 1266to I<xterm>(1).
1207 1267
1208=over 4 1268=over 4
1209 1269
1210=item B<Selection>: 1270=item B<Selecting>:
1211 1271
1212Left click at the beginning of the region, drag to the end of the region 1272Left click at the beginning of the region, drag to the end of the region
1213and release; Right click to extend the marked region; Left double-click 1273and release; Right click to extend the marked region; Left double-click
1214to select a word; Left triple-click to select the entire logical line 1274to select a word; Left triple-click to select the entire logical line
1215(which can span multiple screen lines), unless modified by resource 1275(which can span multiple screen lines), unless modified by resource
… …
1219(Compile: I<frills>) will create a rectangular selection instead of a 1279(Compile: I<frills>) will create a rectangular selection instead of a
1220normal one. In this mode, every selected row becomes its own line in the 1280normal one. In this mode, every selected row becomes its own line in the
1221selection, and trailing whitespace is visually underlined and removed from 1281selection, and trailing whitespace is visually underlined and removed from
1222the selection. 1282the selection.
1223 1283
1224=item B<Insertion>: 1284=item B<Pasting>:
1225 1285
1226Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> 1286Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1227window causes the value of the PRIMARY selection (or CLIPBOARD with the 1287window causes the value of the PRIMARY selection (or CLIPBOARD with the
1228Meta modifier) to be inserted as if it had been typed on the keyboard. 1288B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1229 1289
1230Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1290Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1231inserted too. 1291inserted too.
1232 1292
1233=back 1293=back
… …
1250 1310
1251=head1 ISO 14755 SUPPORT 1311=head1 ISO 14755 SUPPORT
1252 1312
1253ISO 14755 is a standard for entering and viewing unicode characters 1313ISO 14755 is a standard for entering and viewing unicode characters
1254and character codes using the keyboard. It consists of 4 parts. The 1314and character codes using the keyboard. It consists of 4 parts. The
1255first part is available rxvt-unicode has been compiled with 1315first part is available if rxvt-unicode has been compiled with
1256C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1316C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1257with C<--enable-iso14755>. 1317with C<--enable-iso14755>.
1258 1318
1259=over 4 1319=over 4
1260 1320
… …
1414resources or on the command line. 1474resources or on the command line.
1415 1475
1416=item B<COLORTERM> 1476=item B<COLORTERM>
1417 1477
1418Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was 1478Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1419compiled with XPM support, and optionally with the added extension 1479compiled with background image support, and optionally with the added
1420C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1480extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1481screen.
1421 1482
1422=item B<COLORFGBG> 1483=item B<COLORFGBG>
1423 1484
1424Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1485Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1425the colour code used as default foreground/text colour (or the string 1486the colour code used as default foreground/text colour (or the string
1426C<default> to indicate that the default-colour escape sequence is to be 1487C<default> to indicate that the default-colour escape sequence is to be
1427used), C<bg> is the colour code used as default background colour (or the 1488used), C<bg> is the colour code used as default background colour (or the
1428string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1489string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1429was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1490was compiled with background image support. Libraries like C<ncurses>
1430(and do) use this information to optimize screen output. 1491and C<slang> can (and do) use this information to optimize screen output.
1431 1492
1432=item B<WINDOWID> 1493=item B<WINDOWID>
1433 1494
1434Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1495Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1435window, which usually has subwindows for the scrollbar, the terminal 1496window, which usually has subwindows for the scrollbar, the terminal

Diff Legend

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