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.124 by root, Sat Jan 13 15:06:54 2007 UTC vs.
Revision 1.136 by root, Mon Aug 13 10:01:18 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>.
… …
135=item B<-tint> I<colour> 139=item B<-tint> I<colour>
136 140
137Tint the transparent background pixmap with the given colour when 141Tint the transparent background pixmap with the given colour when
138transparency is enabled with B<-tr> or B<-ip>. This only works for 142transparency 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 143non-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 144used to brighten or darken the image in addition to tinting it.
145Please note that certain tint colours can be applied on the server-side,
146thus yielding performance gain of two orders of magnitude. These colours are:
147blue, red, green, cyan, magenta, yellow, and those close to them; resource
141I<tintColor>. Example: 148I<tintColor>. Example:
142 149
143 @@RXVT_NAME@@ -tr -tint blue -sh 40 150 @@RXVT_NAME@@ -tr -tint blue -sh 40
144 151
145=item B<-sh> 152=item B<-sh> I<number>
146 153
147I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 154Darken (0 .. 100) or lighten (-1 .. -100) the transparent
148background image in addition to tinting it (i.e. B<-tint> must be 155background image in addition to (or instead of) tinting it;
149specified, too, e.g. C<-tint white>); resource I<shading>. 156resource I<shading>.
157
158=item B<-blt> I<string>
159
160Specify background blending type. If background pixmap is specified
161at the same time as transparency - such pixmap will be blended over
162transparency image, using method specified. Supported values are :
163B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
164B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
165B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
166alpha-blending; resource I<blendType>.
167
168=item B<-blr> I<HxV>
169
170Apply Gaussian Blur with the specified radii to the transparent
171background image. If single number is specified - both vertical and
172horizontal radii are considered to be the same. Setting one of the
173radii to 1 and another to a large number creates interesting effects
174on some backgrounds. Maximum radius value is 128; resource I<blurRadius>.
150 175
151=item B<-bg> I<colour> 176=item B<-bg> I<colour>
152 177
153Window background colour; resource B<background>. 178Window background colour; resource B<background>.
154 179
… …
156 181
157Window foreground colour; resource B<foreground>. 182Window foreground colour; resource B<foreground>.
158 183
159=item B<-pixmap> I<file[;geom]> 184=item B<-pixmap> I<file[;geom]>
160 185
161Compile I<XPM>: Specify XPM file for the background and also optionally 186Compile I<afterimage>: Specify image file for the background and also
162specify its scaling with a geometry string. Note you may need to 187optionally specify its scaling with a geometry string. Note you may need to
163add quotes to avoid special shell interpretation of the C<;> in the 188add quotes to avoid special shell interpretation of the C<;> in the
164command-line; resource B<backgroundPixmap>. 189command-line; for more details see resource B<backgroundPixmap>.
165 190
166=item B<-cr> I<colour> 191=item B<-cr> I<colour>
167 192
168The cursor colour; resource B<cursorColor>. 193The cursor colour; resource B<cursorColor>.
169 194
… …
386for more info. 411for more info.
387 412
388=item B<-tcw> 413=item B<-tcw>
389 414
390Change the meaning of triple-click selection with the left mouse 415Change the meaning of triple-click selection with the left mouse
416button. Only effective when the original (non-perl) selection code is
391button. Instead of selecting a full line it will extend the selection the 417in-use. Instead of selecting a full line it will extend the selection the
392end of the logical line only. resource B<tripleclickwords>. 418end of the logical line only. resource B<tripleclickwords>.
393 419
394=item B<-insecure> 420=item B<-insecure>
395 421
396Enable "insecure" mode, which currently enables most of the escape 422Enable "insecure" mode, which currently enables most of the escape
… …
564Use the specified colour to display underlined characters when the 590Use the specified colour to display underlined characters when the
565foreground colour is the default. 591foreground colour is the default.
566 592
567=item B<colorRV:> I<colour> 593=item B<colorRV:> I<colour>
568 594
569Use the specified colour as the background for reverse video 595Use the specified colour as the background for reverse video characters
570characters. 596when OPTION_HC is disabled (--disable-frills).
571 597
572=item B<underlineColor:> I<colour> 598=item B<underlineColor:> I<colour>
573 599
574If set, use the specified colour as the colour for the underline 600If set, use the specified colour as the colour for the underline
575itself. If unset, use the foreground colour. 601itself. If unset, use the foreground colour.
… …
591option B<-rv>. B<False>: regular screen colours [default]; option 617option B<-rv>. B<False>: regular screen colours [default]; option
592B<+rv>. See note in B<COLORS AND GRAPHICS> section. 618B<+rv>. See note in B<COLORS AND GRAPHICS> section.
593 619
594=item B<jumpScroll:> I<boolean> 620=item B<jumpScroll:> I<boolean>
595 621
596B<True>: specify that jump scrolling should be used. When scrolling 622B<True>: specify that jump scrolling should be used. When receiving lots
597quickly, fewer screen updates are performed [default]; option B<-j>. 623of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
624has been read, resulting in fewer updates while still displaying every
625received line; option B<-j>.
626
598B<False>: specify that smooth scrolling should be used; option B<+j>. 627B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
628force a screen refresh on each new line it received; option B<+j>.
629
630=item B<skipScroll:> I<boolean>
631
632B<True>: (the default) specify that skip scrolling should be used. When
633receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
634(around 60 times per second), resulting in far fewer updates. This can
635result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
636option B<-ss>.
637
638B<False>: specify that everything is to be displayed, even
639if the refresh is too fast for the human eye to read anything (or the
640monitor to display anything); option B<+ss>.
599 641
600=item B<inheritPixmap:> I<boolean> 642=item B<inheritPixmap:> I<boolean>
601 643
602B<True>: make the background inherit the parent windows' pixmap, giving 644B<True>: make the background inherit the parent windows' pixmap, giving
603artificial transparency. B<False>: do not inherit the parent windows' 645artificial transparency. B<False>: do not inherit the parent windows'
… …
623=item B<shading:> I<number> 665=item B<shading:> I<number>
624 666
625Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image 667Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
626in addition to tinting it; option B<-sh>. 668in addition to tinting it; option B<-sh>.
627 669
670=item B<blendType:> I<string>
671
672Specify background blending type; option B<-blt>.
673
674=item B<blurRadius:> I<number>
675
676Apply Gaussian Blurr with the specified radius to the transparent
677background image; option B<-blr>.
678
628=item B<scrollColor:> I<colour> 679=item B<scrollColor:> I<colour>
629 680
630Use the specified colour for the scrollbar [default #B2B2B2]. 681Use the specified colour for the scrollbar [default #B2B2B2].
631 682
632=item B<troughColor:> I<colour> 683=item B<troughColor:> I<colour>
… …
639The colour of the border around the text area and between the scrollbar 690The colour of the border around the text area and between the scrollbar
640and the text. 691and the text.
641 692
642=item B<backgroundPixmap:> I<file[;geom]> 693=item B<backgroundPixmap:> I<file[;geom]>
643 694
644Use the specified XPM file (note the `.xpm' extension is optional) for 695Use the specified image file for the background and also optionally
645the background and also optionally specify its scaling with a geometry 696specify its scaling with a geometry string B<WxH+X+Y>,
646string B<WxH+X+Y>, in which B<"W" / "H"> specify the 697in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
647horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 698and B<"X" / "Y"> locate the image centre (percent).
648centre (percent). A scale of 0 displays the image with tiling. A scale 699A 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 700image without any scaling. A scale of 2 to 9 specifies an integer
650specifies an integer number of images in that direction. No image will 701number of images in that direction. No image will be magnified beyond
651be magnified beyond 10 times its original size. The maximum permitted 70210 times its original size. The maximum permitted scale is 1000.
652scale is 1000. [default 0x0+50+50] 703Special string of B<"auto"> used as a geometry will cause image to be
704automatically scaled to match window size.
705If used in conjunction with B<-tr> option - specified pixmap will be
706blended over transparency image using either alpha-blending, or any
707other blending type, specified with B<-blt "type"> option.
708[default 0x0+50+50]
653 709
654=item B<path:> I<path> 710=item B<path:> I<path>
655 711
656Specify the colon-delimited search path for finding XPM files. 712Specify the colon-delimited search path for finding XPM files.
657 713
… …
725option B<+is>) disables this behaviour, the high intensity colours are not 781option B<+is>) disables this behaviour, the high intensity colours are not
726reachable. 782reachable.
727 783
728=item B<selectstyle:> I<mode> 784=item B<selectstyle:> I<mode>
729 785
730Set mouse selection style to B<old> which is 2.20, B<oldword> which is 786Set 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 787is xterm style with 2.20 old word selection, or anything else which
732xterm style selection. 788gives xterm style selection. Only effective when the original (non-perl)
789selection code is in use.
733 790
734=item B<scrollstyle:> I<mode> 791=item B<scrollstyle:> I<mode>
735 792
736Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 793Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
737the author's favourite. 794the author's favourite.
… …
750 807
751=item B<mapAlert:> I<boolean> 808=item B<mapAlert:> I<boolean>
752 809
753B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 810B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
754de-iconify (map) on receipt of a bell character [default]. 811de-iconify (map) on receipt of a bell character [default].
812
813=item B<urgentOnBell:> I<boolean>
814
815B<True>: set the urgency hint for the wm on receipt of a bell character.
816B<False>: do not set the urgency hint [default].
755 817
756=item B<visualBell:> I<boolean> 818=item B<visualBell:> I<boolean>
757 819
758B<True>: use visual bell on receipt of a bell character; option B<-vb>. 820B<True>: use visual bell on receipt of a bell character; option B<-vb>.
759B<False>: no visual bell [default]; option B<+vb>. 821B<False>: no visual bell [default]; option B<+vb>.
… …
916=item B<cutchars:> I<string> 978=item B<cutchars:> I<string>
917 979
918The characters used as delimiters for double-click word selection 980The characters used as delimiters for double-click word selection
919(whitespace delimiting is added automatically if resource is given). 981(whitespace delimiting is added automatically if resource is given).
920 982
921When the selection extension is in use (the default if compiled in, see 983When the perl selection extension is in use (the default if compiled
922the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters 984in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
923will be created (if the resource exists, otherwise, no regex will be 985characters will be created (if the resource exists, otherwise, no regex
924created). In this mode, characters outside ISO-8859-1 can be used. 986will be created). In this mode, characters outside ISO-8859-1 can be used.
925 987
926When the selection extension is not used, only ISO-8859-1 characters can 988When the selection extension is not used, only ISO-8859-1 characters can
927be used. If not specified, the built-in default is used: 989be used. If not specified, the built-in default is used:
928 990
929B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 991B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
… …
988 1050
989Turn on/off secondary screen (default enabled). 1051Turn on/off secondary screen (default enabled).
990 1052
991=item B<secondaryScroll:> I<boolean> 1053=item B<secondaryScroll:> I<boolean>
992 1054
993Turn on/off secondary screen scroll (default enabled). If the this 1055Turn on/off secondary screen scroll (default enabled). If this
994option is enabled, scrolls on the secondary screen will change the 1056option is enabled, scrolls on the secondary screen will change the
995scrollback buffer and switching to/from the secondary screen will 1057scrollback buffer and switching to/from the secondary screen will
996instead scroll the screen up. 1058instead scroll the screen up.
997 1059
998=item B<hold>: I<boolean> 1060=item B<hold>: I<boolean>
… …
1166=item B<override-redirect>: I<boolean> 1228=item B<override-redirect>: I<boolean>
1167 1229
1168Compile I<frills>: Sets override-redirect for the terminal window, making 1230Compile I<frills>: Sets override-redirect for the terminal window, making
1169it almost invisible to window managers; option B<-override-redirect>. 1231it almost invisible to window managers; option B<-override-redirect>.
1170 1232
1233=item B<iso14755_52:> I<boolean>
1234
1235Turn on/off ISO 14755 5.2 mode (default enabled).
1236
1171=back 1237=back
1172 1238
1173=head1 THE SCROLLBAR 1239=head1 THE SCROLLBAR
1174 1240
1175Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window 1241Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
… …
1193application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1259application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1194(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1260(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1195up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1261up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1196respectively. 1262respectively.
1197 1263
1198=head1 TEXT SELECTION AND INSERTION 1264=head1 THE SELECTION: SELECTING AND PASTING TEXT
1199 1265
1200The behaviour of text selection and insertion mechanism is similar to 1266The behaviour of text selection and insertion/pasting mechanism is similar
1201I<xterm>(1). 1267to I<xterm>(1).
1202 1268
1203=over 4 1269=over 4
1204 1270
1205=item B<Selection>: 1271=item B<Selecting>:
1206 1272
1207Left click at the beginning of the region, drag to the end of the region 1273Left click at the beginning of the region, drag to the end of the region
1208and release; Right click to extend the marked region; Left double-click 1274and release; Right click to extend the marked region; Left double-click
1209to select a word; Left triple-click to select the entire logical line 1275to select a word; Left triple-click to select the entire logical line
1210(which can span multiple screen lines), unless modified by resource 1276(which can span multiple screen lines), unless modified by resource
… …
1214(Compile: I<frills>) will create a rectangular selection instead of a 1280(Compile: I<frills>) will create a rectangular selection instead of a
1215normal one. In this mode, every selected row becomes its own line in the 1281normal one. In this mode, every selected row becomes its own line in the
1216selection, and trailing whitespace is visually underlined and removed from 1282selection, and trailing whitespace is visually underlined and removed from
1217the selection. 1283the selection.
1218 1284
1219=item B<Insertion>: 1285=item B<Pasting>:
1220 1286
1221Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> 1287Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1222window causes the value of the PRIMARY selection (or CLIPBOARD with the 1288window causes the value of the PRIMARY selection (or CLIPBOARD with the
1223Meta modifier) to be inserted as if it had been typed on the keyboard. 1289B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1224 1290
1225Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1291Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1226inserted too. 1292inserted too.
1227 1293
1228=back 1294=back
… …
1245 1311
1246=head1 ISO 14755 SUPPORT 1312=head1 ISO 14755 SUPPORT
1247 1313
1248ISO 14755 is a standard for entering and viewing unicode characters 1314ISO 14755 is a standard for entering and viewing unicode characters
1249and character codes using the keyboard. It consists of 4 parts. The 1315and character codes using the keyboard. It consists of 4 parts. The
1250first part is available rxvt-unicode has been compiled with 1316first part is available if rxvt-unicode has been compiled with
1251C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1317C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1252with C<--enable-iso14755>. 1318with C<--enable-iso14755>.
1253 1319
1254=over 4 1320=over 4
1255 1321

Diff Legend

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