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.131 by ayin, Sat Jun 9 09:05:38 2007 UTC vs.
Revision 1.149 by ayin, Fri Dec 7 13:49:43 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; resource B<transparent>.
122
123B<-ip> is still accepted as an obsolete alias but will be removed in
124future versions.
125
126I<Please address all transparency related issues to Sasha Vasko at
127sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
123 128
124=item B<-fade> I<number> 129=item B<-fade> I<number>
125 130
126Fade the text by the given percentage when focus is lost. Small values 131Fade the text by the given percentage when focus is lost. Small values
127fade a little only, 100 completely replaces all colours by the fade 132fade a little only, 100 completely replaces all colours by the fade
… …
133is opaque black. resource B<fadeColor>. 138is opaque black. resource B<fadeColor>.
134 139
135=item B<-tint> I<colour> 140=item B<-tint> I<colour>
136 141
137Tint the transparent background pixmap with the given colour when 142Tint the transparent background pixmap with the given colour when
138transparency is enabled with B<-tr> or B<-ip>. This only works for 143transparency is enabled with B<-tr>. This only works for
139non-tiled backgrounds, currently. See also the B<-sh> option that can be 144non-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 145used to brighten or darken the image in addition to tinting it.
146Please note that certain tint colours can be applied on the server-side,
147thus yielding performance gain of two orders of magnitude. These colours are:
148blue, red, green, cyan, magenta, yellow, and those close to them. Also
149pure black and pure white colors essentially mean no tinting; resource
141I<tintColor>. Example: 150I<tintColor>. Example:
142 151
143 @@RXVT_NAME@@ -tr -tint blue -sh 40 152 @@RXVT_NAME@@ -tr -tint blue -sh 40
144 153
145=item B<-sh> I<number> 154=item B<-sh> I<number>
146 155
147Darken (0 .. 100) or lighten (-1 .. -100) the transparent 156Darken (0 .. 100) or lighten (100 .. 200) the transparent
148background image in addition to (or instead of) tinting it; 157background image in addition to (or instead of) tinting it;
149resource I<shading>. 158resource I<shading>.
150 159
151=item B<-blt> I<string> 160=item B<-blt> I<string>
152 161
153Specify background blending type. If background pixmap is specified 162Specify background blending type. If background pixmap is specified
154at the same time as transparency - such pixmap will be blended over 163at the same time as transparency - such pixmap will be blended over
155transparency image, using method specified. Supported values are : 164transparency image, using method specified. Supported values are :
156B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, 165B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
157B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, 166B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
158B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is 167B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
159alpha-blending; resource I<blendType>. 168alpha-blending. Compile I<afterimage>; resource I<blendType>.
160 169
161=item B<-blr> I<number> 170=item B<-blr> I<HxV>
162 171
163Apply Gaussian Blur with the specified radius to the transparent 172Apply Gaussian Blur with the specified radii to the transparent
164background image; resource I<blurRadius>. 173background image. If single number is specified - both vertical and
174horizontal radii are considered to be the same. Setting one of the
175radii to 1 and another to a large number creates interesting effects
176on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
177resource I<blurRadius>.
165 178
166=item B<-bg> I<colour> 179=item B<-bg> I<colour>
167 180
168Window background colour; resource B<background>. 181Window background colour; resource B<background>.
169 182
170=item B<-fg> I<colour> 183=item B<-fg> I<colour>
171 184
172Window foreground colour; resource B<foreground>. 185Window foreground colour; resource B<foreground>.
173 186
174=item B<-pixmap> I<file[;geom]> 187=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
175 188
176Compile I<afterimage>: Specify image file for the background and also 189Compile I<afterimage>: Specify image file for the background and also
177optionally specify its scaling with a geometry string. Note you may need to 190optionally specify its scaling with a geometry string. Note you may need to
178add quotes to avoid special shell interpretation of the C<;> in the 191add quotes to avoid special shell interpretation of the C<;> in the
179command-line; for more details see resource B<backgroundPixmap>. 192command-line; for more details see resource B<backgroundPixmap>.
180 193
181=item B<-cr> I<colour> 194=item B<-cr> I<colour>
… …
337 350
338=item B<-lsp> I<number> 351=item B<-lsp> I<number>
339 352
340Compile I<frills>: Lines (pixel height) to insert between each row of 353Compile I<frills>: Lines (pixel height) to insert between each row of
341the display. Useful to work around font rendering problems; resource 354the display. Useful to work around font rendering problems; resource
342B<linespace>. 355B<lineSpace>.
343 356
344=item B<-tn> I<termname> 357=item B<-tn> I<termname>
345 358
346This option specifies the name of the terminal type to be set in the 359This option specifies the name of the terminal type to be set in the
347B<TERM> environment variable. This terminal type must exist in the 360B<TERM> environment variable. This terminal type must exist in the
… …
402 415
403=item B<-tcw> 416=item B<-tcw>
404 417
405Change the meaning of triple-click selection with the left mouse 418Change the meaning of triple-click selection with the left mouse
406button. Only effective when the original (non-perl) selection code is 419button. Only effective when the original (non-perl) selection code is
407in-use. Instead of selecting a full line it will extend the selection the 420in-use. Instead of selecting a full line it will extend the selection to
408end of the logical line only. resource B<tripleclickwords>. 421the end of the logical line only. resource B<tripleclickwords>.
409 422
410=item B<-insecure> 423=item B<-insecure>
411 424
412Enable "insecure" mode, which currently enables most of the escape 425Enable "insecure" mode, which currently enables most of the escape
413sequences that echo strings. See the resource B<insecure> for more 426sequences that echo strings. See the resource B<insecure> for more
… …
433 446
434Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 447Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
435will not immediately destroy its window when the program executed within 448will not immediately destroy its window when the program executed within
436it exits. Instead, it will wait till it is being killed or closed by the 449it exits. Instead, it will wait till it is being killed or closed by the
437user; resource B<hold>. 450user; resource B<hold>.
451
452=item B<-xrm> I<string>
453
454Works like the X Toolkit option of the same name, by adding the I<string>
455as if it were specified in a resource file. Resource values specified this
456way take precedence over all other resource specifications.
457
458Note that you need to use the I<same> syntax as in the .Xdefaults file,
459e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
460options can be specified as long-options on the commandline, so use
461of B<-xrm> is mostly limited to cases where you want to specify other
462resources (e.g. for input methods) or for compatibility with other
463programs.
438 464
439=item B<-keysym.>I<sym> I<string> 465=item B<-keysym.>I<sym> I<string>
440 466
441Remap a key symbol. See resource B<keysym>. 467Remap a key symbol. See resource B<keysym>.
442 468
… …
516 1. system-wide app-defaults file, either locale-dependent OR global 542 1. system-wide app-defaults file, either locale-dependent OR global
517 2. app-defaults file in $XAPPLRESDIR 543 2. app-defaults file in $XAPPLRESDIR
518 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 544 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
519 4. SCREEN_RESOURCES for the current screen 545 4. SCREEN_RESOURCES for the current screen
520 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 546 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
547 6. resources specified via -xrm on the commandline
521 548
522Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 549Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
523names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 550names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
524common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily 551common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
525configured, while the class name B<URxvt> allows resources unique to 552configured, while the class name B<URxvt> allows resources unique to
… …
607option B<-rv>. B<False>: regular screen colours [default]; option 634option B<-rv>. B<False>: regular screen colours [default]; option
608B<+rv>. See note in B<COLORS AND GRAPHICS> section. 635B<+rv>. See note in B<COLORS AND GRAPHICS> section.
609 636
610=item B<jumpScroll:> I<boolean> 637=item B<jumpScroll:> I<boolean>
611 638
612B<True>: specify that jump scrolling should be used. When scrolling 639B<True>: specify that jump scrolling should be used. When receiving lots
613quickly, fewer screen updates are performed [default]; option B<-j>. 640of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
641has been read, resulting in fewer updates while still displaying every
642received line; option B<-j>.
643
614B<False>: specify that smooth scrolling should be used; option B<+j>. 644B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
645force a screen refresh on each new line it received; option B<+j>.
615 646
616=item B<inheritPixmap:> I<boolean> 647=item B<skipScroll:> I<boolean>
617 648
618B<True>: make the background inherit the parent windows' pixmap, giving 649B<True>: (the default) specify that skip scrolling should be used. When
619artificial transparency. B<False>: do not inherit the parent windows' 650receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
620pixmap. 651(around 60 times per second), resulting in far fewer updates. This can
652result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
653option B<-ss>.
621 654
622I<Please note that transparency of any kind if completely unsupported by 655B<False>: specify that everything is to be displayed, even
623the author. Don't bug him with installation questions!> 656if the refresh is too fast for the human eye to read anything (or the
657monitor to display anything); option B<+ss>.
658
659=item B<transparent:> I<boolean>
660
661Turn on/off illusion of a transparent window background.
662
663B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
664future versions.
665
666I<Please address all transparency related issues to Sasha Vasko at
667sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
624 668
625=item B<fading:> I<number> 669=item B<fading:> I<number>
626 670
627Fade the text by the given percentage when focus is lost; option B<-fade>. 671Fade the text by the given percentage when focus is lost; option B<-fade>.
628 672
… …
645 689
646Specify background blending type; option B<-blt>. 690Specify background blending type; option B<-blt>.
647 691
648=item B<blurRadius:> I<number> 692=item B<blurRadius:> I<number>
649 693
650Apply Gaussian Blurr with the specified radius to the transparent 694Apply Gaussian Blurr with the specified radius to the transparent
651background image; option B<-blr>. 695background image; option B<-blr>.
652 696
653=item B<scrollColor:> I<colour> 697=item B<scrollColor:> I<colour>
654 698
655Use the specified colour for the scrollbar [default #B2B2B2]. 699Use the specified colour for the scrollbar [default #B2B2B2].
… …
662=item B<borderColor:> I<colour> 706=item B<borderColor:> I<colour>
663 707
664The colour of the border around the text area and between the scrollbar 708The colour of the border around the text area and between the scrollbar
665and the text. 709and the text.
666 710
667=item B<backgroundPixmap:> I<file[;geom]> 711=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
668 712
669Use the specified image file for the background and also optionally 713Use the specified image file for the background and also
670specify its scaling with a geometry string B<WxH+X+Y>, 714optionally specify its scaling with a geometry string B<WxH+X+Y>,
671in which B<"W" / "H"> specify the horizontal/vertical scale (percent), 715(default C<0x0+50+50>) in which B<"W" / "H"> specify the
672and B<"X" / "Y"> locate the image centre (percent). 716horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
673A scale of 0 displays the image with tiling. A scale of 1 displays the 717centre (percent). A scale of 0 displays the image with tiling. A scale
674image without any scaling. A scale of 2 to 9 specifies an integer 718of 1 displays the image without any scaling. A scale of 2 to 9 specifies
675number of images in that direction. No image will be magnified beyond 719an integer number of images in that direction. No image will be magnified
67610 times its original size. The maximum permitted scale is 1000. 720beyond 10 times its original size. The maximum permitted scale is 1000.
677Special string of B<"auto"> used as a geometry will cause image to be 721Additional operations can be specified after colon B<:op1:op2...>.
678automatically scaled to match window size. 722Supported operations are:
723
724 tile force background image to be tiled and not scaled. Equivalent to 0x0,
725 propscale will scale image keeping proportions,
726 auto will scale image to match window size. Equivalent to 100x100;
727 hscale will scale image horizontally to the window size;
728 vscale will scale image vertically to the window size;
729 scale will scale image to match window size;
730 root will tile image as if it was a root window background, auto-adjusting
731 whenever terminal window moves.
732
679If used in conjunction with B<-tr> option - specified pixmap will be 733If used in conjunction with B<-tr> option, the specified pixmap will be
680blended over transparency image using either alpha-blending, or any 734blended over transparency image using either alpha-blending, or any
681other blending type, specified with B<-blt "type"> option. 735other blending type, specified with B<-blt "type"> option.
682[default 0x0+50+50]
683 736
684=item B<path:> I<path> 737=item B<path:> I<path>
685 738
686Specify the colon-delimited search path for finding XPM files. 739Specify the colon-delimited search path for finding background image files.
687 740
688=item B<font:> I<fontlist> 741=item B<font:> I<fontlist>
689 742
690Select the fonts to be used. This is a comma separated list of font names 743Select 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 744that are checked in order when trying to find glyphs for characters. The
… …
890=item B<termName:> I<termname> 943=item B<termName:> I<termname>
891 944
892Specifies the terminal type name to be set in the B<TERM> environment 945Specifies the terminal type name to be set in the B<TERM> environment
893variable; option B<-tn>. 946variable; option B<-tn>.
894 947
895=item B<linespace:> I<number> 948=item B<lineSpace:> I<number>
896 949
897Specifies number of lines (pixel height) to insert between each row of 950Specifies number of lines (pixel height) to insert between each row of
898the display [default 0]; option B<-lsp>. 951the display [default 0]; option B<-lsp>.
899 952
900=item B<meta8:> I<boolean> 953=item B<meta8:> I<boolean>
… …
960will be created). In this mode, characters outside ISO-8859-1 can be used. 1013will be created). In this mode, characters outside ISO-8859-1 can be used.
961 1014
962When the selection extension is not used, only ISO-8859-1 characters can 1015When the selection extension is not used, only ISO-8859-1 characters can
963be used. If not specified, the built-in default is used: 1016be used. If not specified, the built-in default is used:
964 1017
965B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1018B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
966 1019
967=item B<preeditType:> I<style> 1020=item B<preeditType:> I<style>
968 1021
969B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1022B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
970 1023
… …
1058searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1111searching 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 1112omitting 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 1113keysym 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. 1114performed in an exact manner; however, the closest match is assured.
1062 1115
1063I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1116I<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, 1117number), 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 1118
1075You can define a range of keysyms in one shot by providing a I<string> 1119You can define a range of keysyms in one shot by providing a I<string>
1076with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1120with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1077should be a character not used by the strings. 1121should be a character not used by the strings.
1078 1122
… …
1285 1329
1286=head1 ISO 14755 SUPPORT 1330=head1 ISO 14755 SUPPORT
1287 1331
1288ISO 14755 is a standard for entering and viewing unicode characters 1332ISO 14755 is a standard for entering and viewing unicode characters
1289and character codes using the keyboard. It consists of 4 parts. The 1333and character codes using the keyboard. It consists of 4 parts. The
1290first part is available rxvt-unicode has been compiled with 1334first part is available if rxvt-unicode has been compiled with
1291C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1335C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1292with C<--enable-iso14755>. 1336with C<--enable-iso14755>.
1293 1337
1294=over 4 1338=over 4
1295 1339
… …
1449resources or on the command line. 1493resources or on the command line.
1450 1494
1451=item B<COLORTERM> 1495=item B<COLORTERM>
1452 1496
1453Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was 1497Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1454compiled with XPM support, and optionally with the added extension 1498compiled with background image support, and optionally with the added
1455C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1499extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1500screen.
1456 1501
1457=item B<COLORFGBG> 1502=item B<COLORFGBG>
1458 1503
1459Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1504Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1460the colour code used as default foreground/text colour (or the string 1505the colour code used as default foreground/text colour (or the string
1461C<default> to indicate that the default-colour escape sequence is to be 1506C<default> to indicate that the default-colour escape sequence is to be
1462used), C<bg> is the colour code used as default background colour (or the 1507used), C<bg> is the colour code used as default background colour (or the
1463string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1508string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1464was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1509was compiled with background image support. Libraries like C<ncurses>
1465(and do) use this information to optimize screen output. 1510and C<slang> can (and do) use this information to optimize screen output.
1466 1511
1467=item B<WINDOWID> 1512=item B<WINDOWID>
1468 1513
1469Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1514Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1470window, which usually has subwindows for the scrollbar, the terminal 1515window, which usually has subwindows for the scrollbar, the terminal
… …
1561Project Coordinator (changes.txt 2.21a to 2.4.5) 1606Project Coordinator (changes.txt 2.21a to 2.4.5)
1562 1607
1563=item Geoff Wing L<< <gcw@pobox.com> >> 1608=item Geoff Wing L<< <gcw@pobox.com> >>
1564 1609
1565Rewrote screen display and text selection routines. 1610Rewrote screen display and text selection routines.
1566 1611
1567Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1612Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1568 1613
1569=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1614=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1570 1615
1571Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1616Forked rxvt-unicode, unicode support, rewrote almost all the code, perl

Diff Legend

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