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.130 by sasha, Fri Jun 8 20:04:12 2007 UTC vs.
Revision 1.144 by sasha, Thu Nov 15 18:40:10 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. Also
151pure black and pure white colors essentially mean no tinting; resource
141I<tintColor>. Example: 152I<tintColor>. Example:
142 153
143 @@RXVT_NAME@@ -tr -tint blue -sh 40 154 @@RXVT_NAME@@ -tr -tint blue -sh 40
144 155
145=item B<-sh> I<number> 156=item B<-sh> I<number>
146 157
147Darken (0 .. 100) or lighten (-1 .. -100) the transparent 158Darken (0 .. 100) or lighten (100 .. 200) the transparent
148background image in addition to (or instead of) tinting it; 159background image in addition to (or instead of) tinting it;
149resource I<shading>. 160resource I<shading>.
150 161
151=item B<-blt> I<string> 162=item B<-blt> I<string>
152 163
153Specify background blending type. If background pixmap is specified 164Specify background blending type. If background pixmap is specified
154at the same time as transparency - such pixmap will be blended over 165at the same time as transparency - such pixmap will be blended over
155transparency image, using method specified. Supported values are : 166transparency image, using method specified. Supported values are :
156B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, 167B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
157B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, 168B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
158B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is 169B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
159alpha-blending; resource I<blendType>. 170alpha-blending. Compile I<afterimage>; resource I<blendType>.
160 171
161=item B<-blr> I<number> 172=item B<-blr> I<HxV>
162 173
163Apply Gaussian Blur with the specified radius to the transparent 174Apply Gaussian Blur with the specified radii to the transparent
164background image; resource I<blurRadius>. 175background image. If single number is specified - both vertical and
176horizontal radii are considered to be the same. Setting one of the
177radii to 1 and another to a large number creates interesting effects
178on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
179resource I<blurRadius>.
165 180
166=item B<-bg> I<colour> 181=item B<-bg> I<colour>
167 182
168Window background colour; resource B<background>. 183Window background colour; resource B<background>.
169 184
170=item B<-fg> I<colour> 185=item B<-fg> I<colour>
171 186
172Window foreground colour; resource B<foreground>. 187Window foreground colour; resource B<foreground>.
173 188
174=item B<-pixmap> I<file[;geom]> 189=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
175 190
176Compile I<afterimage>: Specify image file for the background and also 191Compile I<afterimage>: Specify image file for the background and also
177optionally specify its scaling with a geometry string. Note you may need to 192optionally specify its scaling with a geometry string. Note you may need to
178add quotes to avoid special shell interpretation of the C<;> in the 193add quotes to avoid special shell interpretation of the C<;> in the
179command-line; for more details see resource B<backgroundPixmap>. 194command-line; for more details see resource B<backgroundPixmap>.
180 195
181=item B<-cr> I<colour> 196=item B<-cr> I<colour>
… …
337 352
338=item B<-lsp> I<number> 353=item B<-lsp> I<number>
339 354
340Compile I<frills>: Lines (pixel height) to insert between each row of 355Compile I<frills>: Lines (pixel height) to insert between each row of
341the display. Useful to work around font rendering problems; resource 356the display. Useful to work around font rendering problems; resource
342B<linespace>. 357B<lineSpace>.
343 358
344=item B<-tn> I<termname> 359=item B<-tn> I<termname>
345 360
346This option specifies the name of the terminal type to be set in the 361This option specifies the name of the terminal type to be set in the
347B<TERM> environment variable. This terminal type must exist in the 362B<TERM> environment variable. This terminal type must exist in the
… …
607option B<-rv>. B<False>: regular screen colours [default]; option 622option B<-rv>. B<False>: regular screen colours [default]; option
608B<+rv>. See note in B<COLORS AND GRAPHICS> section. 623B<+rv>. See note in B<COLORS AND GRAPHICS> section.
609 624
610=item B<jumpScroll:> I<boolean> 625=item B<jumpScroll:> I<boolean>
611 626
612B<True>: specify that jump scrolling should be used. When scrolling 627B<True>: specify that jump scrolling should be used. When receiving lots
613quickly, fewer screen updates are performed [default]; option B<-j>. 628of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
629has been read, resulting in fewer updates while still displaying every
630received line; option B<-j>.
631
614B<False>: specify that smooth scrolling should be used; option B<+j>. 632B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
633force a screen refresh on each new line it received; option B<+j>.
634
635=item B<skipScroll:> I<boolean>
636
637B<True>: (the default) specify that skip scrolling should be used. When
638receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
639(around 60 times per second), resulting in far fewer updates. This can
640result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
641option B<-ss>.
642
643B<False>: specify that everything is to be displayed, even
644if the refresh is too fast for the human eye to read anything (or the
645monitor to display anything); option B<+ss>.
615 646
616=item B<inheritPixmap:> I<boolean> 647=item B<inheritPixmap:> I<boolean>
617 648
618B<True>: make the background inherit the parent windows' pixmap, giving 649B<True>: make the background inherit the parent windows' pixmap, giving
619artificial transparency. B<False>: do not inherit the parent windows' 650artificial transparency. B<False>: do not inherit the parent windows'
… …
645 676
646Specify background blending type; option B<-blt>. 677Specify background blending type; option B<-blt>.
647 678
648=item B<blurRadius:> I<number> 679=item B<blurRadius:> I<number>
649 680
650Apply Gaussian Blurr with the specified radius to the transparent 681Apply Gaussian Blurr with the specified radius to the transparent
651background image; option B<-blr>. 682background image; option B<-blr>.
652 683
653=item B<scrollColor:> I<colour> 684=item B<scrollColor:> I<colour>
654 685
655Use the specified colour for the scrollbar [default #B2B2B2]. 686Use the specified colour for the scrollbar [default #B2B2B2].
… …
662=item B<borderColor:> I<colour> 693=item B<borderColor:> I<colour>
663 694
664The colour of the border around the text area and between the scrollbar 695The colour of the border around the text area and between the scrollbar
665and the text. 696and the text.
666 697
667=item B<backgroundPixmap:> I<file[;geom]> 698=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
668 699
669Use the specified image file for the background and also optionally 700Use the specified image file for the background and also optionally
670specify its scaling with a geometry string B<WxH+X+Y>, 701specify its scaling with a geometry string B<WxH+X+Y>,
671in which B<"W" / "H"> specify the horizontal/vertical scale (percent), 702in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
672and B<"X" / "Y"> locate the image centre (percent). 703and B<"X" / "Y"> locate the image centre (percent).
673A scale of 0 displays the image with tiling. A scale of 1 displays the 704A scale of 0 displays the image with tiling. A scale of 1 displays the
674image without any scaling. A scale of 2 to 9 specifies an integer 705image without any scaling. A scale of 2 to 9 specifies an integer
675number of images in that direction. No image will be magnified beyond 706number of images in that direction. No image will be magnified beyond
67610 times its original size. The maximum permitted scale is 1000. 70710 times its original size. The maximum permitted scale is 1000.
677Special string of B<"auto"> used as a geometry will cause image to be 708Additional operations can be specified after colon B<:op1:op2...>.
678automatically scaled to match window size. 709Supported operations are:
710 B<"tile"> - force background image to be tiled and not scaled. Equivalent to 0x0,
711 B<"propscale"> - will scale image keeping proportions,
712 B<"auto"> - will scale image to match window size. Equivalent to 100x100;
713 B<"hscale"> - will scale image horizontally to the window size;
714 B<"vscale"> - will scale image vertically to the window size;
715 B<"scale"> - will scale image to match window size;
716 B<"root"> - will tile image as if it was a root window background, auto-adjusting
717 whenever terminal window moves.
718
679If used in conjunction with B<-tr> option - specified pixmap will be 719If used in conjunction with B<-tr> option - specified pixmap will be
680blended over transparency image using either alpha-blending, or any 720blended over transparency image using either alpha-blending, or any
681other blending type, specified with B<-blt "type"> option. 721other blending type, specified with B<-blt "type"> option.
682[default 0x0+50+50] 722[default 0x0+50+50]
683 723
684=item B<path:> I<path> 724=item B<path:> I<path>
685 725
686Specify the colon-delimited search path for finding XPM files. 726Specify the colon-delimited search path for finding background image files.
687 727
688=item B<font:> I<fontlist> 728=item B<font:> I<fontlist>
689 729
690Select the fonts to be used. This is a comma separated list of font names 730Select the fonts to be used. This is a comma separated list of font names
691that are checked in order when trying to find glyphs for characters. The 731that are checked in order when trying to find glyphs for characters. The
… …
890=item B<termName:> I<termname> 930=item B<termName:> I<termname>
891 931
892Specifies the terminal type name to be set in the B<TERM> environment 932Specifies the terminal type name to be set in the B<TERM> environment
893variable; option B<-tn>. 933variable; option B<-tn>.
894 934
895=item B<linespace:> I<number> 935=item B<lineSpace:> I<number>
896 936
897Specifies number of lines (pixel height) to insert between each row of 937Specifies number of lines (pixel height) to insert between each row of
898the display [default 0]; option B<-lsp>. 938the display [default 0]; option B<-lsp>.
899 939
900=item B<meta8:> I<boolean> 940=item B<meta8:> I<boolean>
… …
1058searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1098searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1059omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1099omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1060keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1100keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1061performed in an exact manner; however, the closest match is assured. 1101performed in an exact manner; however, the closest match is assured.
1062 1102
1063I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1103I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1064C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1104number), see RESOURCES in C<man 7 X> for futher details.
1065C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1066C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1067can start or end with whitespace. B<This feature is deprecated and will
1068be removed>.
1069
1070Please note that you need to double the C<\> in resource files, as
1071Xlib itself does its own de-escaping (you can use C<\033> instead of
1072C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1073processing).
1074 1105
1075You can define a range of keysyms in one shot by providing a I<string> 1106You can define a range of keysyms in one shot by providing a I<string>
1076with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1107with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1077should be a character not used by the strings. 1108should be a character not used by the strings.
1078 1109
… …
1202=item B<override-redirect>: I<boolean> 1233=item B<override-redirect>: I<boolean>
1203 1234
1204Compile I<frills>: Sets override-redirect for the terminal window, making 1235Compile I<frills>: Sets override-redirect for the terminal window, making
1205it almost invisible to window managers; option B<-override-redirect>. 1236it almost invisible to window managers; option B<-override-redirect>.
1206 1237
1238=item B<iso14755_52:> I<boolean>
1239
1240Turn on/off ISO 14755 5.2 mode (default enabled).
1241
1207=back 1242=back
1208 1243
1209=head1 THE SCROLLBAR 1244=head1 THE SCROLLBAR
1210 1245
1211Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window 1246Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
… …
1281 1316
1282=head1 ISO 14755 SUPPORT 1317=head1 ISO 14755 SUPPORT
1283 1318
1284ISO 14755 is a standard for entering and viewing unicode characters 1319ISO 14755 is a standard for entering and viewing unicode characters
1285and character codes using the keyboard. It consists of 4 parts. The 1320and character codes using the keyboard. It consists of 4 parts. The
1286first part is available rxvt-unicode has been compiled with 1321first part is available if rxvt-unicode has been compiled with
1287C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1322C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1288with C<--enable-iso14755>. 1323with C<--enable-iso14755>.
1289 1324
1290=over 4 1325=over 4
1291 1326
… …
1445resources or on the command line. 1480resources or on the command line.
1446 1481
1447=item B<COLORTERM> 1482=item B<COLORTERM>
1448 1483
1449Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was 1484Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1450compiled with XPM support, and optionally with the added extension 1485compiled with background image support, and optionally with the added
1451C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1486extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1487screen.
1452 1488
1453=item B<COLORFGBG> 1489=item B<COLORFGBG>
1454 1490
1455Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1491Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1456the colour code used as default foreground/text colour (or the string 1492the colour code used as default foreground/text colour (or the string
1457C<default> to indicate that the default-colour escape sequence is to be 1493C<default> to indicate that the default-colour escape sequence is to be
1458used), C<bg> is the colour code used as default background colour (or the 1494used), C<bg> is the colour code used as default background colour (or the
1459string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1495string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1460was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1496was compiled with background image support. Libraries like C<ncurses>
1461(and do) use this information to optimize screen output. 1497and C<slang> can (and do) use this information to optimize screen output.
1462 1498
1463=item B<WINDOWID> 1499=item B<WINDOWID>
1464 1500
1465Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1501Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1466window, which usually has subwindows for the scrollbar, the terminal 1502window, which usually has subwindows for the scrollbar, the terminal
… …
1557Project Coordinator (changes.txt 2.21a to 2.4.5) 1593Project Coordinator (changes.txt 2.21a to 2.4.5)
1558 1594
1559=item Geoff Wing L<< <gcw@pobox.com> >> 1595=item Geoff Wing L<< <gcw@pobox.com> >>
1560 1596
1561Rewrote screen display and text selection routines. 1597Rewrote screen display and text selection routines.
1562 1598
1563Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1599Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1564 1600
1565=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1601=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1566 1602
1567Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1603Forked rxvt-unicode, unicode support, rewrote almost all the code, perl

Diff Legend

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