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.134 by sasha, Tue Jul 31 22:23:56 2007 UTC vs.
Revision 1.150 by root, Fri Dec 7 16:14:26 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 in 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
37change. 37change.
38 38
39If you are looking for a terminal that supports more exotic scripts, let 39If you are looking for a terminal that supports more exotic scripts, let
40me recommend C<mlterm>, which is a very user friendly, lean and clean 40me recommend C<mlterm>, which is a very user friendly, lean and clean
… …
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; resource B<transparent>.
122B<-tr>; resource B<inheritPixmap>.
123 122
124I<Please note that transparency of any kind if completely unsupported by 123B<-ip> is still accepted as an obsolete alias but will be removed in
125the author. Don't bug him with installation questions! Read the FAQ (man 7 124future versions.
126@@RXVT_NAME@@)!> 125
126I<Please address all transparency related issues to Sasha Vasko at
127sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
127 128
128=item B<-fade> I<number> 129=item B<-fade> I<number>
129 130
130Fade 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
131fade a little only, 100 completely replaces all colours by the fade 132fade a little only, 100 completely replaces all colours by the fade
… …
137is opaque black. resource B<fadeColor>. 138is opaque black. resource B<fadeColor>.
138 139
139=item B<-tint> I<colour> 140=item B<-tint> I<colour>
140 141
141Tint the transparent background pixmap with the given colour when 142Tint the transparent background pixmap with the given colour when
142transparency is enabled with B<-tr> or B<-ip>. This only works for 143transparency is enabled with B<-tr>. This only works for
143non-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
144used to brighten or darken the image in addition to tinting it. 145used to brighten or darken the image in addition to tinting it.
145Please note that certain tint colors could be applued on the server-side, 146Please note that certain tint colours can be applied on the server-side,
146thus yeilding performance gain of two orders of magnitude. This colors are: 147thus yielding performance gain of two orders of magnitude. These colours are:
147blue, red, green, cyan, magenta, yellow, and those close to this; resource 148blue, red, green, cyan, magenta, yellow, and those close to them. Also
149pure black and pure white colors essentially mean no tinting; resource
148I<tintColor>. Example: 150I<tintColor>. Example:
149 151
150 @@RXVT_NAME@@ -tr -tint blue -sh 40 152 @@RXVT_NAME@@ -tr -tint blue -sh 40
151 153
152=item B<-sh> I<number> 154=item B<-sh> I<number>
153 155
154Darken (0 .. 100) or lighten (-1 .. -100) the transparent 156Darken (0 .. 100) or lighten (100 .. 200) the transparent
155background image in addition to (or instead of) tinting it; 157background image in addition to (or instead of) tinting it;
156resource I<shading>. 158resource I<shading>.
157 159
158=item B<-blt> I<string> 160=item B<-blt> I<string>
159 161
… …
161at the same time as transparency - such pixmap will be blended over 163at the same time as transparency - such pixmap will be blended over
162transparency image, using method specified. Supported values are : 164transparency image, using method specified. Supported values are :
163B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, 165B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
164B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, 166B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
165B<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
166alpha-blending; resource I<blendType>. 168alpha-blending. Compile I<afterimage>; resource I<blendType>.
167 169
168=item B<-blr> I<HxV> 170=item B<-blr> I<HxV>
169 171
170Apply Gaussian Blur with the specified radii to the transparent 172Apply Gaussian Blur with the specified radii to the transparent
171background image. If single number is specified - both vertical and 173background image. If single number is specified - both vertical and
172horizontal radii are considered to be the same. Setting one of the 174horizontal radii are considered to be the same. Setting one of the
173radii to 1 and another to a large number creates interesting effects 175radii to 1 and another to a large number creates interesting effects
174on some backgrounds. Maximum radius value is 128; resource I<blurRadius>. 176on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
177resource I<blurRadius>.
175 178
176=item B<-bg> I<colour> 179=item B<-bg> I<colour>
177 180
178Window background colour; resource B<background>. 181Window background colour; resource B<background>.
179 182
180=item B<-fg> I<colour> 183=item B<-fg> I<colour>
181 184
182Window foreground colour; resource B<foreground>. 185Window foreground colour; resource B<foreground>.
183 186
184=item B<-pixmap> I<file[;geom]> 187=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
185 188
186Compile I<afterimage>: Specify image file for the background and also 189Compile I<afterimage>: Specify image file for the background and also
187optionally 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
188add quotes to avoid special shell interpretation of the C<;> in the 191add quotes to avoid special shell interpretation of the C<;> in the
189command-line; for more details see resource B<backgroundPixmap>. 192command-line; for more details see resource B<backgroundPixmap>.
190 193
191=item B<-cr> I<colour> 194=item B<-cr> I<colour>
… …
347 350
348=item B<-lsp> I<number> 351=item B<-lsp> I<number>
349 352
350Compile I<frills>: Lines (pixel height) to insert between each row of 353Compile I<frills>: Lines (pixel height) to insert between each row of
351the display. Useful to work around font rendering problems; resource 354the display. Useful to work around font rendering problems; resource
352B<linespace>. 355B<lineSpace>.
353 356
354=item B<-tn> I<termname> 357=item B<-tn> I<termname>
355 358
356This 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
357B<TERM> environment variable. This terminal type must exist in the 360B<TERM> environment variable. This terminal type must exist in the
… …
412 415
413=item B<-tcw> 416=item B<-tcw>
414 417
415Change the meaning of triple-click selection with the left mouse 418Change the meaning of triple-click selection with the left mouse
416button. Only effective when the original (non-perl) selection code is 419button. Only effective when the original (non-perl) selection code is
417in-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
418end of the logical line only. resource B<tripleclickwords>. 421the end of the logical line only. resource B<tripleclickwords>.
419 422
420=item B<-insecure> 423=item B<-insecure>
421 424
422Enable "insecure" mode, which currently enables most of the escape 425Enable "insecure" mode, which currently enables most of the escape
423sequences that echo strings. See the resource B<insecure> for more 426sequences that echo strings. See the resource B<insecure> for more
… …
443 446
444Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 447Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
445will not immediately destroy its window when the program executed within 448will not immediately destroy its window when the program executed within
446it 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
447user; 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.
448 464
449=item B<-keysym.>I<sym> I<string> 465=item B<-keysym.>I<sym> I<string>
450 466
451Remap a key symbol. See resource B<keysym>. 467Remap a key symbol. See resource B<keysym>.
452 468
… …
526 1. system-wide app-defaults file, either locale-dependent OR global 542 1. system-wide app-defaults file, either locale-dependent OR global
527 2. app-defaults file in $XAPPLRESDIR 543 2. app-defaults file in $XAPPLRESDIR
528 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 544 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
529 4. SCREEN_RESOURCES for the current screen 545 4. SCREEN_RESOURCES for the current screen
530 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 546 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
547 6. resources specified via -xrm on the commandline
531 548
532Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 549Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
533names: 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
534common 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
535configured, while the class name B<URxvt> allows resources unique to 552configured, while the class name B<URxvt> allows resources unique to
… …
637 654
638B<False>: specify that everything is to be displayed, even 655B<False>: specify that everything is to be displayed, even
639if the refresh is too fast for the human eye to read anything (or the 656if the refresh is too fast for the human eye to read anything (or the
640monitor to display anything); option B<+ss>. 657monitor to display anything); option B<+ss>.
641 658
642=item B<inheritPixmap:> I<boolean> 659=item B<transparent:> I<boolean>
643 660
644B<True>: make the background inherit the parent windows' pixmap, giving 661Turn on/off illusion of a transparent window background.
645artificial transparency. B<False>: do not inherit the parent windows'
646pixmap.
647 662
648I<Please note that transparency of any kind if completely unsupported by 663B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
649the author. Don't bug him with installation questions!> 664future versions.
665
666I<Please address all transparency related issues to Sasha Vasko at
667sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
650 668
651=item B<fading:> I<number> 669=item B<fading:> I<number>
652 670
653Fade 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>.
654 672
… …
671 689
672Specify background blending type; option B<-blt>. 690Specify background blending type; option B<-blt>.
673 691
674=item B<blurRadius:> I<number> 692=item B<blurRadius:> I<number>
675 693
676Apply Gaussian Blurr with the specified radius to the transparent 694Apply Gaussian Blurr with the specified radius to the transparent
677background image; option B<-blr>. 695background image; option B<-blr>.
678 696
679=item B<scrollColor:> I<colour> 697=item B<scrollColor:> I<colour>
680 698
681Use the specified colour for the scrollbar [default #B2B2B2]. 699Use the specified colour for the scrollbar [default #B2B2B2].
… …
688=item B<borderColor:> I<colour> 706=item B<borderColor:> I<colour>
689 707
690The 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
691and the text. 709and the text.
692 710
693=item B<backgroundPixmap:> I<file[;geom]> 711=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
694 712
695Use the specified image file for the background and also optionally 713Use the specified image file for the background and also
696specify its scaling with a geometry string B<WxH+X+Y>, 714optionally specify its scaling with a geometry string B<WxH+X+Y>,
697in which B<"W" / "H"> specify the horizontal/vertical scale (percent), 715(default C<0x0+50+50>) in which B<"W" / "H"> specify the
698and B<"X" / "Y"> locate the image centre (percent). 716horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
699A 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
700image 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
701number of images in that direction. No image will be magnified beyond 719an integer number of images in that direction. No image will be magnified
70210 times its original size. The maximum permitted scale is 1000. 720beyond 10 times its original size. The maximum permitted scale is 1000.
703Special string of B<"auto"> used as a geometry will cause image to be 721Additional operations can be specified after colon B<:op1:op2...>.
704automatically 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
705If used in conjunction with B<-tr> option - specified pixmap will be 733If used in conjunction with B<-tr> option, the specified pixmap will be
706blended over transparency image using either alpha-blending, or any 734blended over transparency image using either alpha-blending, or any
707other blending type, specified with B<-blt "type"> option. 735other blending type, specified with B<-blt "type"> option.
708[default 0x0+50+50]
709 736
710=item B<path:> I<path> 737=item B<path:> I<path>
711 738
712Specify the colon-delimited search path for finding XPM files. 739Specify the colon-delimited search path for finding background image files.
713 740
714=item B<font:> I<fontlist> 741=item B<font:> I<fontlist>
715 742
716Select 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
717that 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
… …
916=item B<termName:> I<termname> 943=item B<termName:> I<termname>
917 944
918Specifies 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
919variable; option B<-tn>. 946variable; option B<-tn>.
920 947
921=item B<linespace:> I<number> 948=item B<lineSpace:> I<number>
922 949
923Specifies number of lines (pixel height) to insert between each row of 950Specifies number of lines (pixel height) to insert between each row of
924the display [default 0]; option B<-lsp>. 951the display [default 0]; option B<-lsp>.
925 952
926=item B<meta8:> I<boolean> 953=item B<meta8:> I<boolean>
… …
986will 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.
987 1014
988When 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
989be used. If not specified, the built-in default is used: 1016be used. If not specified, the built-in default is used:
990 1017
991B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1018B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
992 1019
993=item B<preeditType:> I<style> 1020=item B<preeditType:> I<style>
994 1021
995B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1022B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
996 1023
… …
1084searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1111searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1085omitting 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
1086keysym 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
1087performed in an exact manner; however, the closest match is assured. 1114performed in an exact manner; however, the closest match is assured.
1088 1115
1089I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1116I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1090C<\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.
1091C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1092C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1093can start or end with whitespace. B<This feature is deprecated and will
1094be removed>.
1095
1096Please note that you need to double the C<\> in resource files, as
1097Xlib itself does its own de-escaping (you can use C<\033> instead of
1098C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1099processing).
1100 1118
1101You 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>
1102with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1120with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1103should be a character not used by the strings. 1121should be a character not used by the strings.
1104 1122
… …
1475resources or on the command line. 1493resources or on the command line.
1476 1494
1477=item B<COLORTERM> 1495=item B<COLORTERM>
1478 1496
1479Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was 1497Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1480compiled with XPM support, and optionally with the added extension 1498compiled with background image support, and optionally with the added
1481C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1499extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1500screen.
1482 1501
1483=item B<COLORFGBG> 1502=item B<COLORFGBG>
1484 1503
1485Set 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
1486the colour code used as default foreground/text colour (or the string 1505the colour code used as default foreground/text colour (or the string
1487C<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
1488used), 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
1489string 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@@
1490was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1509was compiled with background image support. Libraries like C<ncurses>
1491(and do) use this information to optimize screen output. 1510and C<slang> can (and do) use this information to optimize screen output.
1492 1511
1493=item B<WINDOWID> 1512=item B<WINDOWID>
1494 1513
1495Set 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
1496window, which usually has subwindows for the scrollbar, the terminal 1515window, which usually has subwindows for the scrollbar, the terminal
… …
1587Project Coordinator (changes.txt 2.21a to 2.4.5) 1606Project Coordinator (changes.txt 2.21a to 2.4.5)
1588 1607
1589=item Geoff Wing L<< <gcw@pobox.com> >> 1608=item Geoff Wing L<< <gcw@pobox.com> >>
1590 1609
1591Rewrote screen display and text selection routines. 1610Rewrote screen display and text selection routines.
1592 1611
1593Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1612Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1594 1613
1595=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1614=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1596 1615
1597Forked 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