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.132 by root, Mon Jun 18 13:38:12 2007 UTC vs.
Revision 1.147 by root, Fri Nov 23 11:18:04 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
… …
114 114
115=item B<-ss>|B<+ss> 115=item B<-ss>|B<+ss>
116 116
117Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. 117Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118 118
119=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 119=item B<-tr>|B<+tr>
120 120
121Turn on/off inheriting parent window's pixmap. Alternative form is 121Turn on/off illusion of a transparent window background. Obsolete form of it is
122B<-tr>; resource B<inheritPixmap>. 122B<-ip> and it should not be used anymore; resource B<transparent>.
123 123
124I<Please note that transparency of any kind if completely unsupported by 124I<Please note that old resource name of B<inheritPixmap> is obsolete and should be
125the author. Don't bug him with installation questions! Read the FAQ (man 7 125changed to B<transparent>. Backwards compatibility support for B<inheritPixmap> will
126@@RXVT_NAME@@)!> 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@@)!>
127 130
128=item B<-fade> I<number> 131=item B<-fade> I<number>
129 132
130Fade 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
131fade a little only, 100 completely replaces all colours by the fade 134fade a little only, 100 completely replaces all colours by the fade
… …
137is opaque black. resource B<fadeColor>. 140is opaque black. resource B<fadeColor>.
138 141
139=item B<-tint> I<colour> 142=item B<-tint> I<colour>
140 143
141Tint the transparent background pixmap with the given colour when 144Tint the transparent background pixmap with the given colour when
142transparency is enabled with B<-tr> or B<-ip>. This only works for 145transparency is enabled with B<-tr>. This only works for
143non-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
144used 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
145I<tintColor>. Example: 152I<tintColor>. Example:
146 153
147 @@RXVT_NAME@@ -tr -tint blue -sh 40 154 @@RXVT_NAME@@ -tr -tint blue -sh 40
148 155
149=item B<-sh> I<number> 156=item B<-sh> I<number>
150 157
151Darken (0 .. 100) or lighten (-1 .. -100) the transparent 158Darken (0 .. 100) or lighten (100 .. 200) the transparent
152background image in addition to (or instead of) tinting it; 159background image in addition to (or instead of) tinting it;
153resource I<shading>. 160resource I<shading>.
154 161
155=item B<-blt> I<string> 162=item B<-blt> I<string>
156 163
157Specify background blending type. If background pixmap is specified 164Specify background blending type. If background pixmap is specified
158at the same time as transparency - such pixmap will be blended over 165at the same time as transparency - such pixmap will be blended over
159transparency image, using method specified. Supported values are : 166transparency image, using method specified. Supported values are :
160B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, 167B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
161B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, 168B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
162B<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
163alpha-blending; resource I<blendType>. 170alpha-blending. Compile I<afterimage>; resource I<blendType>.
164 171
165=item B<-blr> I<number> 172=item B<-blr> I<HxV>
166 173
167Apply Gaussian Blur with the specified radius to the transparent 174Apply Gaussian Blur with the specified radii to the transparent
168background 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>.
169 180
170=item B<-bg> I<colour> 181=item B<-bg> I<colour>
171 182
172Window background colour; resource B<background>. 183Window background colour; resource B<background>.
173 184
174=item B<-fg> I<colour> 185=item B<-fg> I<colour>
175 186
176Window foreground colour; resource B<foreground>. 187Window foreground colour; resource B<foreground>.
177 188
178=item B<-pixmap> I<file[;geom]> 189=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
179 190
180Compile I<afterimage>: Specify image file for the background and also 191Compile I<afterimage>: Specify image file for the background and also
181optionally 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
182add quotes to avoid special shell interpretation of the C<;> in the 193add quotes to avoid special shell interpretation of the C<;> in the
183command-line; for more details see resource B<backgroundPixmap>. 194command-line; for more details see resource B<backgroundPixmap>.
184 195
185=item B<-cr> I<colour> 196=item B<-cr> I<colour>
… …
341 352
342=item B<-lsp> I<number> 353=item B<-lsp> I<number>
343 354
344Compile I<frills>: Lines (pixel height) to insert between each row of 355Compile I<frills>: Lines (pixel height) to insert between each row of
345the display. Useful to work around font rendering problems; resource 356the display. Useful to work around font rendering problems; resource
346B<linespace>. 357B<lineSpace>.
347 358
348=item B<-tn> I<termname> 359=item B<-tn> I<termname>
349 360
350This 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
351B<TERM> environment variable. This terminal type must exist in the 362B<TERM> environment variable. This terminal type must exist in the
… …
438Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 449Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
439will not immediately destroy its window when the program executed within 450will not immediately destroy its window when the program executed within
440it exits. Instead, it will wait till it is being killed or closed by the 451it exits. Instead, it will wait till it is being killed or closed by the
441user; resource B<hold>. 452user; resource B<hold>.
442 453
454=item B<-xrm> I<string>
455
456Works like the X Toolkit option of the same name, by adding the I<string>
457as if it were specified in a resource file. Resource values specified this
458way take precedence over all other resource specifications.
459
460Note that you need to use the I<same> syntax as in the .Xdefaults file,
461e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
462options can be specified as long-options on the commandline, so use
463of B<-xrm> is mostly limited to cases where you want to specify other
464resources (e.g. for input methods) or for compatibility with other
465programs.
466
443=item B<-keysym.>I<sym> I<string> 467=item B<-keysym.>I<sym> I<string>
444 468
445Remap a key symbol. See resource B<keysym>. 469Remap a key symbol. See resource B<keysym>.
446 470
447=item B<-embed> I<windowid> 471=item B<-embed> I<windowid>
… …
520 1. system-wide app-defaults file, either locale-dependent OR global 544 1. system-wide app-defaults file, either locale-dependent OR global
521 2. app-defaults file in $XAPPLRESDIR 545 2. app-defaults file in $XAPPLRESDIR
522 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 546 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
523 4. SCREEN_RESOURCES for the current screen 547 4. SCREEN_RESOURCES for the current screen
524 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 548 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
549 6. resources specified via -xrm on the commandline
525 550
526Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 551Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
527names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 552names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
528common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily 553common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
529configured, while the class name B<URxvt> allows resources unique to 554configured, while the class name B<URxvt> allows resources unique to
… …
665 690
666Specify background blending type; option B<-blt>. 691Specify background blending type; option B<-blt>.
667 692
668=item B<blurRadius:> I<number> 693=item B<blurRadius:> I<number>
669 694
670Apply Gaussian Blurr with the specified radius to the transparent 695Apply Gaussian Blurr with the specified radius to the transparent
671background image; option B<-blr>. 696background image; option B<-blr>.
672 697
673=item B<scrollColor:> I<colour> 698=item B<scrollColor:> I<colour>
674 699
675Use the specified colour for the scrollbar [default #B2B2B2]. 700Use the specified colour for the scrollbar [default #B2B2B2].
… …
682=item B<borderColor:> I<colour> 707=item B<borderColor:> I<colour>
683 708
684The colour of the border around the text area and between the scrollbar 709The colour of the border around the text area and between the scrollbar
685and the text. 710and the text.
686 711
687=item B<backgroundPixmap:> I<file[;geom]> 712=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
688 713
689Use the specified image file for the background and also optionally 714Use the specified image file for the background and also
690specify its scaling with a geometry string B<WxH+X+Y>, 715optionally specify its scaling with a geometry string B<WxH+X+Y>,
691in which B<"W" / "H"> specify the horizontal/vertical scale (percent), 716(default C<0x0+50+50>) in which B<"W" / "H"> specify the
692and B<"X" / "Y"> locate the image centre (percent). 717horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
693A scale of 0 displays the image with tiling. A scale of 1 displays the 718centre (percent). A scale of 0 displays the image with tiling. A scale
694image without any scaling. A scale of 2 to 9 specifies an integer 719of 1 displays the image without any scaling. A scale of 2 to 9 specifies
695number of images in that direction. No image will be magnified beyond 720an integer number of images in that direction. No image will be magnified
69610 times its original size. The maximum permitted scale is 1000. 721beyond 10 times its original size. The maximum permitted scale is 1000.
697Special string of B<"auto"> used as a geometry will cause image to be 722Additional operations can be specified after colon B<:op1:op2...>.
698automatically scaled to match window size. 723Supported operations are:
724
725 tile force background image to be tiled and not scaled. Equivalent to 0x0,
726 propscale will scale image keeping proportions,
727 auto will scale image to match window size. Equivalent to 100x100;
728 hscale will scale image horizontally to the window size;
729 vscale will scale image vertically to the window size;
730 scale will scale image to match window size;
731 root will tile image as if it was a root window background, auto-adjusting
732 whenever terminal window moves.
733
699If used in conjunction with B<-tr> option - specified pixmap will be 734If used in conjunction with B<-tr> option, the specified pixmap will be
700blended over transparency image using either alpha-blending, or any 735blended over transparency image using either alpha-blending, or any
701other blending type, specified with B<-blt "type"> option. 736other blending type, specified with B<-blt "type"> option.
702[default 0x0+50+50]
703 737
704=item B<path:> I<path> 738=item B<path:> I<path>
705 739
706Specify the colon-delimited search path for finding XPM files. 740Specify the colon-delimited search path for finding background image files.
707 741
708=item B<font:> I<fontlist> 742=item B<font:> I<fontlist>
709 743
710Select the fonts to be used. This is a comma separated list of font names 744Select the fonts to be used. This is a comma separated list of font names
711that are checked in order when trying to find glyphs for characters. The 745that are checked in order when trying to find glyphs for characters. The
… …
910=item B<termName:> I<termname> 944=item B<termName:> I<termname>
911 945
912Specifies the terminal type name to be set in the B<TERM> environment 946Specifies the terminal type name to be set in the B<TERM> environment
913variable; option B<-tn>. 947variable; option B<-tn>.
914 948
915=item B<linespace:> I<number> 949=item B<lineSpace:> I<number>
916 950
917Specifies number of lines (pixel height) to insert between each row of 951Specifies number of lines (pixel height) to insert between each row of
918the display [default 0]; option B<-lsp>. 952the display [default 0]; option B<-lsp>.
919 953
920=item B<meta8:> I<boolean> 954=item B<meta8:> I<boolean>
… …
980will be created). In this mode, characters outside ISO-8859-1 can be used. 1014will be created). In this mode, characters outside ISO-8859-1 can be used.
981 1015
982When the selection extension is not used, only ISO-8859-1 characters can 1016When the selection extension is not used, only ISO-8859-1 characters can
983be used. If not specified, the built-in default is used: 1017be used. If not specified, the built-in default is used:
984 1018
985B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1019B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
986 1020
987=item B<preeditType:> I<style> 1021=item B<preeditType:> I<style>
988 1022
989B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1023B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
990 1024
… …
1078searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1112searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1079omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1113omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1080keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1114keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1081performed in an exact manner; however, the closest match is assured. 1115performed in an exact manner; however, the closest match is assured.
1082 1116
1083I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1117I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1084C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1118number), see RESOURCES in C<man 7 X> for futher details.
1085C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1086C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1087can start or end with whitespace. B<This feature is deprecated and will
1088be removed>.
1089
1090Please note that you need to double the C<\> in resource files, as
1091Xlib itself does its own de-escaping (you can use C<\033> instead of
1092C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1093processing).
1094 1119
1095You can define a range of keysyms in one shot by providing a I<string> 1120You can define a range of keysyms in one shot by providing a I<string>
1096with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1121with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1097should be a character not used by the strings. 1122should be a character not used by the strings.
1098 1123
… …
1305 1330
1306=head1 ISO 14755 SUPPORT 1331=head1 ISO 14755 SUPPORT
1307 1332
1308ISO 14755 is a standard for entering and viewing unicode characters 1333ISO 14755 is a standard for entering and viewing unicode characters
1309and character codes using the keyboard. It consists of 4 parts. The 1334and character codes using the keyboard. It consists of 4 parts. The
1310first part is available rxvt-unicode has been compiled with 1335first part is available if rxvt-unicode has been compiled with
1311C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1336C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1312with C<--enable-iso14755>. 1337with C<--enable-iso14755>.
1313 1338
1314=over 4 1339=over 4
1315 1340
… …
1469resources or on the command line. 1494resources or on the command line.
1470 1495
1471=item B<COLORTERM> 1496=item B<COLORTERM>
1472 1497
1473Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was 1498Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1474compiled with XPM support, and optionally with the added extension 1499compiled with background image support, and optionally with the added
1475C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1500extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1501screen.
1476 1502
1477=item B<COLORFGBG> 1503=item B<COLORFGBG>
1478 1504
1479Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1505Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1480the colour code used as default foreground/text colour (or the string 1506the colour code used as default foreground/text colour (or the string
1481C<default> to indicate that the default-colour escape sequence is to be 1507C<default> to indicate that the default-colour escape sequence is to be
1482used), C<bg> is the colour code used as default background colour (or the 1508used), C<bg> is the colour code used as default background colour (or the
1483string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1509string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1484was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1510was compiled with background image support. Libraries like C<ncurses>
1485(and do) use this information to optimize screen output. 1511and C<slang> can (and do) use this information to optimize screen output.
1486 1512
1487=item B<WINDOWID> 1513=item B<WINDOWID>
1488 1514
1489Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1515Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1490window, which usually has subwindows for the scrollbar, the terminal 1516window, which usually has subwindows for the scrollbar, the terminal
… …
1581Project Coordinator (changes.txt 2.21a to 2.4.5) 1607Project Coordinator (changes.txt 2.21a to 2.4.5)
1582 1608
1583=item Geoff Wing L<< <gcw@pobox.com> >> 1609=item Geoff Wing L<< <gcw@pobox.com> >>
1584 1610
1585Rewrote screen display and text selection routines. 1611Rewrote screen display and text selection routines.
1586 1612
1587Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1613Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1588 1614
1589=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1615=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1590 1616
1591Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1617Forked rxvt-unicode, unicode support, rewrote almost all the code, perl

Diff Legend

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