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.140 by sasha, Fri Oct 26 18:27:29 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 114
115=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 115=item B<-ss>|B<+ss>
116 116
117Turn on/off inheriting parent window's pixmap. Alternative form is 117Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118B<-tr>; resource B<inheritPixmap>.
119 118
120I<Please note that transparency of any kind if completely unsupported by 119=item B<-tr>|B<+tr>
121the author. Don't bug him with installation questions! Read the FAQ (man 7 120
122@@RXVT_NAME@@)!> 121Turn on/off illusion of a transparent window background. Obsolete form of it is
122B<-ip> and it should not be used anymore; resource B<transparent>.
123
124I<Please note that old resource name of B<inheritPixmap> is obsolete and should be
125changed to B<transparent>. Backwards compatibility support for B<inheritPixmap> will
126be phased out in future versions of rxvt!>
127
128I<Please address all transparency related issues to Sasha Vasko at
129sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
123 130
124=item B<-fade> I<number> 131=item B<-fade> I<number>
125 132
126Fade the text by the given percentage when focus is lost. Small values 133Fade the text by the given percentage when focus is lost. Small values
127fade a little only, 100 completely replaces all colours by the fade 134fade a little only, 100 completely replaces all colours by the fade
133is opaque black. resource B<fadeColor>. 140is opaque black. resource B<fadeColor>.
134 141
135=item B<-tint> I<colour> 142=item B<-tint> I<colour>
136 143
137Tint the transparent background pixmap with the given colour when 144Tint the transparent background pixmap with the given colour when
138transparency is enabled with B<-tr> or B<-ip>. This only works for 145transparency is enabled with B<-tr>. This only works for
139non-tiled backgrounds, currently. See also the B<-sh> option that can be 146non-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 147used to brighten or darken the image in addition to tinting it.
148Please note that certain tint colours can be applied on the server-side,
149thus yielding performance gain of two orders of magnitude. These colours are:
150blue, red, green, cyan, magenta, yellow, and those close to them; resource
141I<tintColor>. Example: 151I<tintColor>. Example:
142 152
143 @@RXVT_NAME@@ -tr -tint blue -sh 40 153 @@RXVT_NAME@@ -tr -tint blue -sh 40
144 154
145=item B<-sh> 155=item B<-sh> I<number>
146 156
147I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 157Darken (0 .. 100) or lighten (-1 .. -100) the transparent
148background image in addition to tinting it (i.e. B<-tint> must be 158background image in addition to (or instead of) tinting it;
149specified, too, e.g. C<-tint white>); resource I<shading>. 159resource I<shading>.
160
161=item B<-blt> I<string>
162
163Specify background blending type. If background pixmap is specified
164at the same time as transparency - such pixmap will be blended over
165transparency image, using method specified. Supported values are :
166B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
167B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
168B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
169alpha-blending. Compile I<afterimage>; resource I<blendType>.
170
171=item B<-blr> I<HxV>
172
173Apply Gaussian Blur with the specified radii to the transparent
174background image. If single number is specified - both vertical and
175horizontal radii are considered to be the same. Setting one of the
176radii to 1 and another to a large number creates interesting effects
177on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
178resource I<blurRadius>.
150 179
151=item B<-bg> I<colour> 180=item B<-bg> I<colour>
152 181
153Window background colour; resource B<background>. 182Window background colour; resource B<background>.
154 183
156 185
157Window foreground colour; resource B<foreground>. 186Window foreground colour; resource B<foreground>.
158 187
159=item B<-pixmap> I<file[;geom]> 188=item B<-pixmap> I<file[;geom]>
160 189
161Compile I<XPM>: Specify XPM file for the background and also optionally 190Compile I<afterimage>: Specify image file for the background and also
162specify its scaling with a geometry string. Note you may need to 191optionally specify its scaling with a geometry string. Note you may need to
163add quotes to avoid special shell interpretation of the C<;> in the 192add quotes to avoid special shell interpretation of the C<;> in the
164command-line; resource B<backgroundPixmap>. 193command-line; for more details see resource B<backgroundPixmap>.
165 194
166=item B<-cr> I<colour> 195=item B<-cr> I<colour>
167 196
168The cursor colour; resource B<cursorColor>. 197The cursor colour; resource B<cursorColor>.
169 198
322 351
323=item B<-lsp> I<number> 352=item B<-lsp> I<number>
324 353
325Compile I<frills>: Lines (pixel height) to insert between each row of 354Compile I<frills>: Lines (pixel height) to insert between each row of
326the display. Useful to work around font rendering problems; resource 355the display. Useful to work around font rendering problems; resource
327B<linespace>. 356B<lineSpace>.
328 357
329=item B<-tn> I<termname> 358=item B<-tn> I<termname>
330 359
331This option specifies the name of the terminal type to be set in the 360This option specifies the name of the terminal type to be set in the
332B<TERM> environment variable. This terminal type must exist in the 361B<TERM> environment variable. This terminal type must exist in the
386for more info. 415for more info.
387 416
388=item B<-tcw> 417=item B<-tcw>
389 418
390Change the meaning of triple-click selection with the left mouse 419Change the meaning of triple-click selection with the left mouse
420button. Only effective when the original (non-perl) selection code is
391button. Instead of selecting a full line it will extend the selection the 421in-use. Instead of selecting a full line it will extend the selection the
392end of the logical line only. resource B<tripleclickwords>. 422end of the logical line only. resource B<tripleclickwords>.
393 423
394=item B<-insecure> 424=item B<-insecure>
395 425
396Enable "insecure" mode, which currently enables most of the escape 426Enable "insecure" mode, which currently enables most of the escape
591option B<-rv>. B<False>: regular screen colours [default]; option 621option B<-rv>. B<False>: regular screen colours [default]; option
592B<+rv>. See note in B<COLORS AND GRAPHICS> section. 622B<+rv>. See note in B<COLORS AND GRAPHICS> section.
593 623
594=item B<jumpScroll:> I<boolean> 624=item B<jumpScroll:> I<boolean>
595 625
596B<True>: specify that jump scrolling should be used. When scrolling 626B<True>: specify that jump scrolling should be used. When receiving lots
597quickly, fewer screen updates are performed [default]; option B<-j>. 627of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
628has been read, resulting in fewer updates while still displaying every
629received line; option B<-j>.
630
598B<False>: specify that smooth scrolling should be used; option B<+j>. 631B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
632force a screen refresh on each new line it received; option B<+j>.
633
634=item B<skipScroll:> I<boolean>
635
636B<True>: (the default) specify that skip scrolling should be used. When
637receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
638(around 60 times per second), resulting in far fewer updates. This can
639result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
640option B<-ss>.
641
642B<False>: specify that everything is to be displayed, even
643if the refresh is too fast for the human eye to read anything (or the
644monitor to display anything); option B<+ss>.
599 645
600=item B<inheritPixmap:> I<boolean> 646=item B<inheritPixmap:> I<boolean>
601 647
602B<True>: make the background inherit the parent windows' pixmap, giving 648B<True>: make the background inherit the parent windows' pixmap, giving
603artificial transparency. B<False>: do not inherit the parent windows' 649artificial transparency. B<False>: do not inherit the parent windows'
623=item B<shading:> I<number> 669=item B<shading:> I<number>
624 670
625Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image 671Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
626in addition to tinting it; option B<-sh>. 672in addition to tinting it; option B<-sh>.
627 673
674=item B<blendType:> I<string>
675
676Specify background blending type; option B<-blt>.
677
678=item B<blurRadius:> I<number>
679
680Apply Gaussian Blurr with the specified radius to the transparent
681background image; option B<-blr>.
682
628=item B<scrollColor:> I<colour> 683=item B<scrollColor:> I<colour>
629 684
630Use the specified colour for the scrollbar [default #B2B2B2]. 685Use the specified colour for the scrollbar [default #B2B2B2].
631 686
632=item B<troughColor:> I<colour> 687=item B<troughColor:> I<colour>
639The colour of the border around the text area and between the scrollbar 694The colour of the border around the text area and between the scrollbar
640and the text. 695and the text.
641 696
642=item B<backgroundPixmap:> I<file[;geom]> 697=item B<backgroundPixmap:> I<file[;geom]>
643 698
644Use the specified XPM file (note the `.xpm' extension is optional) for 699Use the specified image file for the background and also optionally
645the background and also optionally specify its scaling with a geometry 700specify its scaling with a geometry string B<WxH+X+Y>,
646string B<WxH+X+Y>, in which B<"W" / "H"> specify the 701in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
647horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 702and B<"X" / "Y"> locate the image centre (percent).
648centre (percent). A scale of 0 displays the image with tiling. A scale 703A 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 704image without any scaling. A scale of 2 to 9 specifies an integer
650specifies an integer number of images in that direction. No image will 705number of images in that direction. No image will be magnified beyond
651be magnified beyond 10 times its original size. The maximum permitted 70610 times its original size. The maximum permitted scale is 1000.
652scale is 1000. [default 0x0+50+50] 707Special string of B<"auto"> used as a geometry will cause image to be
708automatically scaled to match window size.
709If used in conjunction with B<-tr> option - specified pixmap will be
710blended over transparency image using either alpha-blending, or any
711other blending type, specified with B<-blt "type"> option.
712[default 0x0+50+50]
653 713
654=item B<path:> I<path> 714=item B<path:> I<path>
655 715
656Specify the colon-delimited search path for finding XPM files. 716Specify the colon-delimited search path for finding background image files.
657 717
658=item B<font:> I<fontlist> 718=item B<font:> I<fontlist>
659 719
660Select the fonts to be used. This is a comma separated list of font names 720Select 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 721that are checked in order when trying to find glyphs for characters. The
725option B<+is>) disables this behaviour, the high intensity colours are not 785option B<+is>) disables this behaviour, the high intensity colours are not
726reachable. 786reachable.
727 787
728=item B<selectstyle:> I<mode> 788=item B<selectstyle:> I<mode>
729 789
730Set mouse selection style to B<old> which is 2.20, B<oldword> which is 790Set 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 791is xterm style with 2.20 old word selection, or anything else which
732xterm style selection. 792gives xterm style selection. Only effective when the original (non-perl)
793selection code is in use.
733 794
734=item B<scrollstyle:> I<mode> 795=item B<scrollstyle:> I<mode>
735 796
736Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 797Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
737the author's favourite. 798the author's favourite.
859=item B<termName:> I<termname> 920=item B<termName:> I<termname>
860 921
861Specifies the terminal type name to be set in the B<TERM> environment 922Specifies the terminal type name to be set in the B<TERM> environment
862variable; option B<-tn>. 923variable; option B<-tn>.
863 924
864=item B<linespace:> I<number> 925=item B<lineSpace:> I<number>
865 926
866Specifies number of lines (pixel height) to insert between each row of 927Specifies number of lines (pixel height) to insert between each row of
867the display [default 0]; option B<-lsp>. 928the display [default 0]; option B<-lsp>.
868 929
869=item B<meta8:> I<boolean> 930=item B<meta8:> I<boolean>
921=item B<cutchars:> I<string> 982=item B<cutchars:> I<string>
922 983
923The characters used as delimiters for double-click word selection 984The characters used as delimiters for double-click word selection
924(whitespace delimiting is added automatically if resource is given). 985(whitespace delimiting is added automatically if resource is given).
925 986
926When the selection extension is in use (the default if compiled in, see 987When the perl selection extension is in use (the default if compiled
927the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters 988in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
928will be created (if the resource exists, otherwise, no regex will be 989characters will be created (if the resource exists, otherwise, no regex
929created). In this mode, characters outside ISO-8859-1 can be used. 990will be created). In this mode, characters outside ISO-8859-1 can be used.
930 991
931When the selection extension is not used, only ISO-8859-1 characters can 992When the selection extension is not used, only ISO-8859-1 characters can
932be used. If not specified, the built-in default is used: 993be used. If not specified, the built-in default is used:
933 994
934B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 995B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
1027searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1088searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1028omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1089omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1029keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1090keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1030performed in an exact manner; however, the closest match is assured. 1091performed in an exact manner; however, the closest match is assured.
1031 1092
1032I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1093I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1033C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1094number), see RESOURCES in C<man 7 X> for futher details.
1034C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1035C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1036can start or end with whitespace. B<This feature is deprecated and will
1037be removed>.
1038
1039Please note that you need to double the C<\> in resource files, as
1040Xlib itself does its own de-escaping (you can use C<\033> instead of
1041C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1042processing).
1043 1095
1044You can define a range of keysyms in one shot by providing a I<string> 1096You can define a range of keysyms in one shot by providing a I<string>
1045with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1097with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1046should be a character not used by the strings. 1098should be a character not used by the strings.
1047 1099
1171=item B<override-redirect>: I<boolean> 1223=item B<override-redirect>: I<boolean>
1172 1224
1173Compile I<frills>: Sets override-redirect for the terminal window, making 1225Compile I<frills>: Sets override-redirect for the terminal window, making
1174it almost invisible to window managers; option B<-override-redirect>. 1226it almost invisible to window managers; option B<-override-redirect>.
1175 1227
1228=item B<iso14755_52:> I<boolean>
1229
1230Turn on/off ISO 14755 5.2 mode (default enabled).
1231
1176=back 1232=back
1177 1233
1178=head1 THE SCROLLBAR 1234=head1 THE SCROLLBAR
1179 1235
1180Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window 1236Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
1198application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1254application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1199(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1255(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), 1256up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1201respectively. 1257respectively.
1202 1258
1203=head1 TEXT SELECTION AND INSERTION 1259=head1 THE SELECTION: SELECTING AND PASTING TEXT
1204 1260
1205The behaviour of text selection and insertion mechanism is similar to 1261The behaviour of text selection and insertion/pasting mechanism is similar
1206I<xterm>(1). 1262to I<xterm>(1).
1207 1263
1208=over 4 1264=over 4
1209 1265
1210=item B<Selection>: 1266=item B<Selecting>:
1211 1267
1212Left click at the beginning of the region, drag to the end of the region 1268Left 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 1269and release; Right click to extend the marked region; Left double-click
1214to select a word; Left triple-click to select the entire logical line 1270to select a word; Left triple-click to select the entire logical line
1215(which can span multiple screen lines), unless modified by resource 1271(which can span multiple screen lines), unless modified by resource
1219(Compile: I<frills>) will create a rectangular selection instead of a 1275(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 1276normal one. In this mode, every selected row becomes its own line in the
1221selection, and trailing whitespace is visually underlined and removed from 1277selection, and trailing whitespace is visually underlined and removed from
1222the selection. 1278the selection.
1223 1279
1224=item B<Insertion>: 1280=item B<Pasting>:
1225 1281
1226Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> 1282Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1227window causes the value of the PRIMARY selection (or CLIPBOARD with the 1283window 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. 1284B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1229 1285
1230Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1286Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1231inserted too. 1287inserted too.
1232 1288
1233=back 1289=back
1250 1306
1251=head1 ISO 14755 SUPPORT 1307=head1 ISO 14755 SUPPORT
1252 1308
1253ISO 14755 is a standard for entering and viewing unicode characters 1309ISO 14755 is a standard for entering and viewing unicode characters
1254and character codes using the keyboard. It consists of 4 parts. The 1310and character codes using the keyboard. It consists of 4 parts. The
1255first part is available rxvt-unicode has been compiled with 1311first part is available if rxvt-unicode has been compiled with
1256C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1312C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1257with C<--enable-iso14755>. 1313with C<--enable-iso14755>.
1258 1314
1259=over 4 1315=over 4
1260 1316
1414resources or on the command line. 1470resources or on the command line.
1415 1471
1416=item B<COLORTERM> 1472=item B<COLORTERM>
1417 1473
1418Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was 1474Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1419compiled with XPM support, and optionally with the added extension 1475compiled with background image support, and optionally with the added
1420C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1476extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1477screen.
1421 1478
1422=item B<COLORFGBG> 1479=item B<COLORFGBG>
1423 1480
1424Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1481Set 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 1482the colour code used as default foreground/text colour (or the string
1426C<default> to indicate that the default-colour escape sequence is to be 1483C<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 1484used), 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@@ 1485string 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 1486was compiled with background image support. Libraries like C<ncurses>
1430(and do) use this information to optimize screen output. 1487and C<slang> can (and do) use this information to optimize screen output.
1431 1488
1432=item B<WINDOWID> 1489=item B<WINDOWID>
1433 1490
1434Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1491Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1435window, which usually has subwindows for the scrollbar, the terminal 1492window, which usually has subwindows for the scrollbar, the terminal

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines