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.168 by root, Tue Nov 4 11:03:29 2008 UTC vs.
Revision 1.177 by root, Sun May 23 00:48:53 2010 UTC

… …
152non-tiled backgrounds, currently. See also the B<-sh> option that can be 152non-tiled backgrounds, currently. See also the B<-sh> option that can be
153used to brighten or darken the image in addition to tinting it. 153used to brighten or darken the image in addition to tinting it.
154Please note that certain tint colours can be applied on the server-side, 154Please note that certain tint colours can be applied on the server-side,
155thus yielding performance gain of two orders of magnitude. These colours are: 155thus yielding performance gain of two orders of magnitude. These colours are:
156blue, red, green, cyan, magenta, yellow, and those close to them. Also 156blue, red, green, cyan, magenta, yellow, and those close to them. Also
157pure black and pure white colors essentially mean no tinting; resource 157pure black and pure white colours essentially mean no tinting; resource
158I<tintColor>. Example: 158I<tintColor>. Example:
159 159
160 @@RXVT_NAME@@ -tr -tint blue -sh 40 160 @@RXVT_NAME@@ -tr -tint blue -sh 40
161 161
162=item B<-sh> I<number> 162=item B<-sh> I<number>
… …
168=item B<-blt> I<string> 168=item B<-blt> I<string>
169 169
170Specify background blending type. If background pixmap is specified 170Specify background blending type. If background pixmap is specified
171at the same time as transparency - such pixmap will be blended over 171at the same time as transparency - such pixmap will be blended over
172transparency image, using method specified. Supported values are : 172transparency image, using method specified. Supported values are :
173B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, 173B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
174B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, 174B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
175B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is 175B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
176alpha-blending. Compile I<afterimage>; resource I<blendType>. 176alpha-blending. Compile I<afterimage>; resource I<blendType>.
177 177
178=item B<-blr> I<HxV> 178=item B<-blr> I<HxV>
… …
186 186
187=item B<-icon> I<file> 187=item B<-icon> I<file>
188 188
189Compile I<afterimage>: Use the specified image as application icon. This 189Compile I<afterimage>: Use the specified image as application icon. This
190is used by many window managers, taskbars and pagers to represent the 190is used by many window managers, taskbars and pagers to represent the
191appliation window; resource I<iconFile>. 191application window; resource I<iconFile>.
192 192
193=item B<-bg> I<colour> 193=item B<-bg> I<colour>
194 194
195Window background colour; resource B<background>. 195Window background colour; resource B<background>.
196 196
… …
321 321
322=item B<-bc>|B<+bc> 322=item B<-bc>|B<+bc>
323 323
324Blink the cursor; resource B<cursorBlink>. 324Blink the cursor; resource B<cursorBlink>.
325 325
326=item B<-uc>|B<+uc>
327
328Make the cursor underlined; resource B<cursorUnderline>.
329
326=item B<-iconic> 330=item B<-iconic>
327 331
328Start iconified, if the window manager supports that option. 332Start iconified, if the window manager supports that option.
329Alternative form is B<-ic>. 333Alternative form is B<-ic>.
330 334
… …
366=item B<-lsp> I<number> 370=item B<-lsp> I<number>
367 371
368Compile I<frills>: Lines (pixel height) to insert between each row of 372Compile I<frills>: Lines (pixel height) to insert between each row of
369the display. Useful to work around font rendering problems; resource 373the display. Useful to work around font rendering problems; resource
370B<lineSpace>. 374B<lineSpace>.
375
376=item B<-letsp> I<number>
377
378Compile I<frills>: Amount to adjust the computed character width by
379to control overall letter spacing. Negative values will tighten up the
380letter spacing, positive values will space letters out more. Useful to
381work around odd font metrics; resource B<letterSpace>.
371 382
372=item B<-tn> I<termname> 383=item B<-tn> I<termname>
373 384
374This option specifies the name of the terminal type to be set in the 385This option specifies the name of the terminal type to be set in the
375B<TERM> environment variable. This terminal type must exist in the 386B<TERM> environment variable. This terminal type must exist in the
… …
614Use the specified colour for the colour value I<n>, where 0-7 625Use the specified colour for the colour value I<n>, where 0-7
615corresponds to low-intensity (normal) colours and 8-15 corresponds to 626corresponds to low-intensity (normal) colours and 8-15 corresponds to
616high-intensity (bold = bright foreground, blink = bright background) 627high-intensity (bold = bright foreground, blink = bright background)
617colours. The canonical names are as follows: 0=black, 1=red, 2=green, 628colours. The canonical names are as follows: 0=black, 1=red, 2=green,
6183=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 6293=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
619names used are listed in the B<COLORS AND GRAPHICS> section. 630names used are listed in the B<COLOURS AND GRAPHICS> section.
620 631
621Colours higher than 15 cannot be set using resources (yet), but can be 632Colours higher than 15 cannot be set using resources (yet), but can be
622changed using an escape command (see @@RXVT_NAME@@(7)). 633changed using an escape command (see @@RXVT_NAME@@(7)).
623 634
624Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 635Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
… …
635=item B<colorUL:> I<colour> 646=item B<colorUL:> I<colour>
636 647
637Use the specified colour to display underlined characters when the 648Use the specified colour to display underlined characters when the
638foreground colour is the default. 649foreground colour is the default.
639 650
640=item B<colorRV:> I<colour>
641
642Use the specified colour as the background for reverse video characters
643when OPTION_HC is disabled (--disable-frills).
644
645=item B<underlineColor:> I<colour> 651=item B<underlineColor:> I<colour>
646 652
647If set, use the specified colour as the colour for the underline 653If set, use the specified colour as the colour for the underline
648itself. If unset, use the foreground colour. 654itself. If unset, use the foreground colour.
655
656=item B<highlightColor:> I<colour>
657
658If set, use the specified colour as the background for highlighted
659characters. If unset, use reverse video.
660
661=item B<highlightTextColor:> I<colour>
662
663If set and highlightColor is set, use the specified colour as the
664foreground for highlighted characters.
649 665
650=item B<cursorColor:> I<colour> 666=item B<cursorColor:> I<colour>
651 667
652Use the specified colour for the cursor. The default is to use the 668Use the specified colour for the cursor. The default is to use the
653foreground colour; option B<-cr>. 669foreground colour; option B<-cr>.
… …
660 676
661=item B<reverseVideo:> I<boolean> 677=item B<reverseVideo:> I<boolean>
662 678
663B<True>: simulate reverse video by foreground and background colours; 679B<True>: simulate reverse video by foreground and background colours;
664option B<-rv>. B<False>: regular screen colours [default]; option 680option B<-rv>. B<False>: regular screen colours [default]; option
665B<+rv>. See note in B<COLORS AND GRAPHICS> section. 681B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
666 682
667=item B<jumpScroll:> I<boolean> 683=item B<jumpScroll:> I<boolean>
668 684
669B<True>: specify that jump scrolling should be used. When receiving lots 685B<True>: specify that jump scrolling should be used. When receiving lots
670of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines 686of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
… …
801it is named first) and thus defines the character cell grid to be 9 pixels 817it is named first) and thus defines the character cell grid to be 9 pixels
802wide and 15 pixels high. 818wide and 15 pixels high.
803 819
804The second font is just used to add additional unicode characters not in 820The second font is just used to add additional unicode characters not in
805the base font, likewise the third, which is unfortunately non-bold, but 821the base font, likewise the third, which is unfortunately non-bold, but
806the bold version of the font does contain less characters, so this is a 822the bold version of the font does contain fewer characters, so this is a
807useful supplement. 823useful supplement.
808 824
809The third font is an Xft font with aliasing turned off, and the characters 825The third font is an Xft font with aliasing turned off, and the characters
810are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 826are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
811contains other characters, but we are not interested in them. 827contains other characters, but we are not interested in them.
… …
996 1012
997=item B<cursorBlink:> I<boolean> 1013=item B<cursorBlink:> I<boolean>
998 1014
999B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 1015B<True>: blink the cursor. B<False>: do not blink the cursor [default];
1000option B<-bc>. 1016option B<-bc>.
1017
1018=item B<cursorUnderline:> I<boolean>
1019
1020B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
1021option B<-uc>.
1001 1022
1002=item B<pointerBlank:> I<boolean> 1023=item B<pointerBlank:> I<boolean>
1003 1024
1004B<True>: blank the pointer when a key is pressed or after a set number 1025B<True>: blank the pointer when a key is pressed or after a set number
1005of seconds of inactivity. B<False>: the pointer is always visible 1026of seconds of inactivity. B<False>: the pointer is always visible
… …
1172when Control-Meta-c is being pressed": 1193when Control-Meta-c is being pressed":
1173 1194
1174 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1195 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1175 1196
1176If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1197If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1177is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1198is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1178manpage. For example, the F<selection> extension (activated via 1199manpage. For example, the F<selection> extension (activated via
1179C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1200C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1180 1201
1181 URxvt.keysym.M-C-c: perl:selection:rot13 1202 URxvt.keysym.M-C-c: perl:selection:rot13
1182 1203
… …
1279 1300
1280=item B<override-redirect>: I<boolean> 1301=item B<override-redirect>: I<boolean>
1281 1302
1282Compile I<frills>: Sets override-redirect for the terminal window, making 1303Compile I<frills>: Sets override-redirect for the terminal window, making
1283it almost invisible to window managers; option B<-override-redirect>. 1304it almost invisible to window managers; option B<-override-redirect>.
1305
1306=item B<iso14755:> I<boolean>
1307
1308Turn on/off ISO 14755 (default enabled).
1284 1309
1285=item B<iso14755_52:> I<boolean> 1310=item B<iso14755_52:> I<boolean>
1286 1311
1287Turn on/off ISO 14755 5.2 mode (default enabled). 1312Turn on/off ISO 14755 5.2 mode (default enabled).
1288 1313
… …
1431B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1456B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1432it can be seen via the I<who(1)> command, and can accept messages. To 1457it can be seen via the I<who(1)> command, and can accept messages. To
1433allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1458allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1434on some systems or setgid to root or to some other group on others. 1459on some systems or setgid to root or to some other group on others.
1435 1460
1436=head1 COLORS AND GRAPHICS 1461=head1 COLOURS AND GRAPHICS
1437 1462
1438In addition to the default foreground and background colours, 1463In addition to the default foreground and background colours,
1439B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1464B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1440high-intensity bold/blink versions of the same). Here is a list of the 1465high-intensity bold/blink versions of the same). Here is a list of the
1441colours with their names. 1466colours with their names.
… …
1480Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1505Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1481always swapping the foreground/background colours. This is in contrast to 1506always swapping the foreground/background colours. This is in contrast to
1482I<xterm>(1) where the colours are only swapped if they have not otherwise 1507I<xterm>(1) where the colours are only swapped if they have not otherwise
1483been specified. For example, 1508been specified. For example,
1484 1509
1485=over 4
1486
1487=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1510 @@RXVT_NAME@@ -fg Black -bg White -rv
1488 1511
1489would yield White on Black, while on I<xterm>(1) it would yield Black 1512would yield White on Black, while on I<xterm>(1) it would yield Black on
1490on White. 1513White.
1491
1492=back
1493 1514
1494=head2 ALPHA CHANNEL SUPPORT 1515=head2 ALPHA CHANNEL SUPPORT
1495 1516
1496If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1517If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1497their act together, rxvt-unicode will do it's own alpha channel management: 1518their act together, rxvt-unicode will do it's own alpha channel management:
1498 1519
1499You can prefix any color with an opaquenes percentage enclosed in 1520You can prefix any colour with an opaquenes percentage enclosed in
1500brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1521brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1501(0-100) that specifies the opacity of the color, where C<0> is completely 1522(0-100) that specifies the opacity of the colour, where C<0> is completely
1502transparent and C<100> is completely opaque. For example, C<[50]red> is a 1523transparent and C<100> is completely opaque. For example, C<[50]red> is a
1503half-transparent red, while C<[95]#00ff00> is an almost opaque green. This 1524half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1504is the recommended format to specify transparency values, and works with 1525is the recommended format to specify transparency values, and works with
1505all ways to specify a colour. 1526all ways to specify a colour.
1506 1527
… …
1614 1635
1615=over 4 1636=over 4
1616 1637
1617=item B</usr/lib/X11/rgb.txt> 1638=item B</usr/lib/X11/rgb.txt>
1618 1639
1619Color names. 1640Colour names.
1620 1641
1621=back 1642=back
1622 1643
1623=head1 SEE ALSO 1644=head1 SEE ALSO
1624 1645

Diff Legend

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