ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.man.in
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.man.in (file contents):
Revision 1.89 by root, Tue Mar 16 00:54:46 2010 UTC vs.
Revision 1.90 by sf-exg, Sat Jul 24 14:20:48 2010 UTC

… …
122.\} 122.\}
123.rm #[ #] #H #V #F C 123.rm #[ #] #H #V #F C
124.\" ======================================================================== 124.\" ========================================================================
125.\" 125.\"
126.IX Title "@@RXVT_NAME@@ 1" 126.IX Title "@@RXVT_NAME@@ 1"
127.TH @@RXVT_NAME@@ 1 "2010-02-06" "@@RXVT_VERSION@@" "RXVT-UNICODE" 127.TH @@RXVT_NAME@@ 1 "2010-07-24" "@@RXVT_VERSION@@" "RXVT-UNICODE"
128.\" For nroff, turn off justification. Always turn off hyphenation; it makes 128.\" For nroff, turn off justification. Always turn off hyphenation; it makes
129.\" way too many mistakes in technical documents. 129.\" way too many mistakes in technical documents.
130.if n .ad l 130.if n .ad l
131.nh 131.nh
132.SH "NAME" 132.SH "NAME"
… …
264non-tiled backgrounds, currently. See also the \fB\-sh\fR option that can be 264non-tiled backgrounds, currently. See also the \fB\-sh\fR option that can be
265used to brighten or darken the image in addition to tinting it. 265used to brighten or darken the image in addition to tinting it.
266Please note that certain tint colours can be applied on the server-side, 266Please note that certain tint colours can be applied on the server-side,
267thus yielding performance gain of two orders of magnitude. These colours are: 267thus yielding performance gain of two orders of magnitude. These colours are:
268blue, red, green, cyan, magenta, yellow, and those close to them. Also 268blue, red, green, cyan, magenta, yellow, and those close to them. Also
269pure black and pure white colors essentially mean no tinting; resource 269pure black and pure white colours essentially mean no tinting; resource
270\&\fItintColor\fR. Example: 270\&\fItintColor\fR. Example:
271.Sp 271.Sp
272.Vb 1 272.Vb 1
273\& @@RXVT_NAME@@ \-tr \-tint blue \-sh 40 273\& @@RXVT_NAME@@ \-tr \-tint blue \-sh 40
274.Ve 274.Ve
… …
280.IP "\fB\-blt\fR \fIstring\fR" 4 280.IP "\fB\-blt\fR \fIstring\fR" 4
281.IX Item "-blt string" 281.IX Item "-blt string"
282Specify background blending type. If background pixmap is specified 282Specify background blending type. If background pixmap is specified
283at the same time as transparency \- such pixmap will be blended over 283at the same time as transparency \- such pixmap will be blended over
284transparency image, using method specified. Supported values are : 284transparency image, using method specified. Supported values are :
285\&\fBadd\fR, \fBalphablend\fR, \fBallanon\fR \- color values averaging, \fBcolorize\fR, 285\&\fBadd\fR, \fBalphablend\fR, \fBallanon\fR \- colour values averaging, \fBcolorize\fR,
286\&\fBdarken\fR, \fBdiff\fR, \fBdissipate\fR, \fBhue\fR, \fBlighten\fR, \fBoverlay\fR, 286\&\fBdarken\fR, \fBdiff\fR, \fBdissipate\fR, \fBhue\fR, \fBlighten\fR, \fBoverlay\fR,
287\&\fBsaturate\fR, \fBscreen\fR, \fBsub\fR, \fBtint\fR, \fBvalue\fR. The default is 287\&\fBsaturate\fR, \fBscreen\fR, \fBsub\fR, \fBtint\fR, \fBvalue\fR. The default is
288alpha-blending. Compile \fIafterimage\fR; resource \fIblendType\fR. 288alpha-blending. Compile \fIafterimage\fR; resource \fIblendType\fR.
289.IP "\fB\-blr\fR \fIHxV\fR" 4 289.IP "\fB\-blr\fR \fIHxV\fR" 4
290.IX Item "-blr HxV" 290.IX Item "-blr HxV"
… …
679Use the specified colour for the colour value \fIn\fR, where 0\-7 679Use the specified colour for the colour value \fIn\fR, where 0\-7
680corresponds to low-intensity (normal) colours and 8\-15 corresponds to 680corresponds to low-intensity (normal) colours and 8\-15 corresponds to
681high-intensity (bold = bright foreground, blink = bright background) 681high-intensity (bold = bright foreground, blink = bright background)
682colours. The canonical names are as follows: 0=black, 1=red, 2=green, 682colours. The canonical names are as follows: 0=black, 1=red, 2=green,
6833=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 6833=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
684names used are listed in the \fB\s-1COLORS\s0 \s-1AND\s0 \s-1GRAPHICS\s0\fR section. 684names used are listed in the \fB\s-1COLOURS\s0 \s-1AND\s0 \s-1GRAPHICS\s0\fR section.
685.Sp 685.Sp
686Colours higher than 15 cannot be set using resources (yet), but can be 686Colours higher than 15 cannot be set using resources (yet), but can be
687changed using an escape command (see @@RXVT_NAME@@(7)). 687changed using an escape command (see @@RXVT_NAME@@(7)).
688.Sp 688.Sp
689Colours 16\-79 form a standard 4x4x4 colour cube (the same as xterm with 689Colours 16\-79 form a standard 4x4x4 colour cube (the same as xterm with
… …
699(Compile \fIstyles\fR) and this option is unset, reverse video is used instead. 699(Compile \fIstyles\fR) and this option is unset, reverse video is used instead.
700.IP "\fBcolorUL:\fR \fIcolour\fR" 4 700.IP "\fBcolorUL:\fR \fIcolour\fR" 4
701.IX Item "colorUL: colour" 701.IX Item "colorUL: colour"
702Use the specified colour to display underlined characters when the 702Use the specified colour to display underlined characters when the
703foreground colour is the default. 703foreground colour is the default.
704.IP "\fBcolorRV:\fR \fIcolour\fR" 4
705.IX Item "colorRV: colour"
706Use the specified colour as the background for reverse video characters
707when \s-1OPTION_HC\s0 is disabled (\-\-disable\-frills).
708.IP "\fBunderlineColor:\fR \fIcolour\fR" 4 704.IP "\fBunderlineColor:\fR \fIcolour\fR" 4
709.IX Item "underlineColor: colour" 705.IX Item "underlineColor: colour"
710If set, use the specified colour as the colour for the underline 706If set, use the specified colour as the colour for the underline
711itself. If unset, use the foreground colour. 707itself. If unset, use the foreground colour.
708.IP "\fBhighlightColor:\fR \fIcolour\fR" 4
709.IX Item "highlightColor: colour"
710If set, use the specified colour as the background for highlighted
711characters. If unset, use reverse video.
712.IP "\fBhighlightTextColor:\fR \fIcolour\fR" 4
713.IX Item "highlightTextColor: colour"
714If set and highlightColor is set, use the specified colour as the
715foreground for highlighted characters.
712.IP "\fBcursorColor:\fR \fIcolour\fR" 4 716.IP "\fBcursorColor:\fR \fIcolour\fR" 4
713.IX Item "cursorColor: colour" 717.IX Item "cursorColor: colour"
714Use the specified colour for the cursor. The default is to use the 718Use the specified colour for the cursor. The default is to use the
715foreground colour; option \fB\-cr\fR. 719foreground colour; option \fB\-cr\fR.
716.IP "\fBcursorColor2:\fR \fIcolour\fR" 4 720.IP "\fBcursorColor2:\fR \fIcolour\fR" 4
… …
720use the background colour. 724use the background colour.
721.IP "\fBreverseVideo:\fR \fIboolean\fR" 4 725.IP "\fBreverseVideo:\fR \fIboolean\fR" 4
722.IX Item "reverseVideo: boolean" 726.IX Item "reverseVideo: boolean"
723\&\fBTrue\fR: simulate reverse video by foreground and background colours; 727\&\fBTrue\fR: simulate reverse video by foreground and background colours;
724option \fB\-rv\fR. \fBFalse\fR: regular screen colours [default]; option 728option \fB\-rv\fR. \fBFalse\fR: regular screen colours [default]; option
725\&\fB+rv\fR. See note in \fB\s-1COLORS\s0 \s-1AND\s0 \s-1GRAPHICS\s0\fR section. 729\&\fB+rv\fR. See note in \fB\s-1COLOURS\s0 \s-1AND\s0 \s-1GRAPHICS\s0\fR section.
726.IP "\fBjumpScroll:\fR \fIboolean\fR" 4 730.IP "\fBjumpScroll:\fR \fIboolean\fR" 4
727.IX Item "jumpScroll: boolean" 731.IX Item "jumpScroll: boolean"
728\&\fBTrue\fR: specify that jump scrolling should be used. When receiving lots 732\&\fBTrue\fR: specify that jump scrolling should be used. When receiving lots
729of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines 733of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
730has been read, resulting in fewer updates while still displaying every 734has been read, resulting in fewer updates while still displaying every
… …
849it is named first) and thus defines the character cell grid to be 9 pixels 853it is named first) and thus defines the character cell grid to be 9 pixels
850wide and 15 pixels high. 854wide and 15 pixels high.
851.Sp 855.Sp
852The second font is just used to add additional unicode characters not in 856The second font is just used to add additional unicode characters not in
853the base font, likewise the third, which is unfortunately non-bold, but 857the base font, likewise the third, which is unfortunately non-bold, but
854the bold version of the font does contain less characters, so this is a 858the bold version of the font does contain fewer characters, so this is a
855useful supplement. 859useful supplement.
856.Sp 860.Sp
857The third font is an Xft font with aliasing turned off, and the characters 861The third font is an Xft font with aliasing turned off, and the characters
858are limited to the \fB\s-1JIS\s0 0208\fR codeset (i.e. japanese kanji). The font 862are limited to the \fB\s-1JIS\s0 0208\fR codeset (i.e. japanese kanji). The font
859contains other characters, but we are not interested in them. 863contains other characters, but we are not interested in them.
… …
1041Specifies number of seconds before blanking the pointer [default 2]. Use a 1045Specifies number of seconds before blanking the pointer [default 2]. Use a
1042large number (e.g. \f(CW987654321\fR) to effectively disable the timeout. 1046large number (e.g. \f(CW987654321\fR) to effectively disable the timeout.
1043.IP "\fBbackspacekey:\fR \fIstring\fR" 4 1047.IP "\fBbackspacekey:\fR \fIstring\fR" 4
1044.IX Item "backspacekey: string" 1048.IX Item "backspacekey: string"
1045The string to send when the backspace key is pressed. If set to \fB\s-1DEC\s0\fR 1049The string to send when the backspace key is pressed. If set to \fB\s-1DEC\s0\fR
1046or unset it will send \fBDelete\fR (code 127) or, if shifted, \fBBackspace\fR 1050or unset it will send \fBDelete\fR (code 127) or, with control, \fBBackspace\fR
1047(code 8) \- which can be reversed with the appropriate \s-1DEC\s0 private mode 1051(code 8) \- which can be reversed with the appropriate \s-1DEC\s0 private mode
1048escape sequence. 1052escape sequence.
1049.IP "\fBdeletekey:\fR \fIstring\fR" 4 1053.IP "\fBdeletekey:\fR \fIstring\fR" 4
1050.IX Item "deletekey: string" 1054.IX Item "deletekey: string"
1051The string to send when the delete key (not the keypad delete key) is 1055The string to send when the delete key (not the keypad delete key) is
… …
1432.IX Header "LOGIN STAMP" 1436.IX Header "LOGIN STAMP"
1433\&\fB@@RXVT_NAME@@\fR tries to write an entry into the \fIutmp\fR(5) file so that 1437\&\fB@@RXVT_NAME@@\fR tries to write an entry into the \fIutmp\fR(5) file so that
1434it can be seen via the \fI\fIwho\fI\|(1)\fR command, and can accept messages. To 1438it can be seen via the \fI\fIwho\fI\|(1)\fR command, and can accept messages. To
1435allow this feature, \fB@@RXVT_NAME@@\fR may need to be installed setuid root 1439allow this feature, \fB@@RXVT_NAME@@\fR may need to be installed setuid root
1436on some systems or setgid to root or to some other group on others. 1440on some systems or setgid to root or to some other group on others.
1437.SH "COLORS AND GRAPHICS" 1441.SH "COLOURS AND GRAPHICS"
1438.IX Header "COLORS AND GRAPHICS" 1442.IX Header "COLOURS AND GRAPHICS"
1439In addition to the default foreground and background colours, 1443In addition to the default foreground and background colours,
1440\&\fB@@RXVT_NAME@@\fR can display up to 16 colours (8 \s-1ANSI\s0 colours plus 1444\&\fB@@RXVT_NAME@@\fR can display up to 88/256 colours: 8 \s-1ANSI\s0 colours plus
1441high-intensity bold/blink versions of the same). Here is a list of the 1445high-intensity (potentially bold/blink) versions of the same, and 72 (or
1442colours with their names. 1446240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour \s-1RGB\s0
1447cube plus a 8 (24) colour greyscale ramp.
1448.PP
1449Here is a list of the \s-1ANSI\s0 colours with their names.
1443.TS 1450.TS
1444l l l . 1451l l l .
1445color0 (black) = Black 1452color0 (black) = Black
1446color1 (red) = Red3 1453color1 (red) = Red3
1447color2 (green) = Green3 1454color2 (green) = Green3
… …
1465It is also possible to specify the colour values of \fBforeground\fR, 1472It is also possible to specify the colour values of \fBforeground\fR,
1466\&\fBbackground\fR, \fBcursorColor\fR, \fBcursorColor2\fR, \fBcolorBD\fR, \fBcolorUL\fR as 1473\&\fBbackground\fR, \fBcursorColor\fR, \fBcursorColor2\fR, \fBcolorBD\fR, \fBcolorUL\fR as
1467a number 0\-15, as a convenient shorthand to reference the colour name of 1474a number 0\-15, as a convenient shorthand to reference the colour name of
1468color0\-color15. 1475color0\-color15.
1469.PP 1476.PP
1470In addition to the colours defined above, @@RXVT_NAME@@ offers an 1477The following text gives values for the standard 88 colour mode (and
1471additional 72 colours. The first 64 of those (with indices 16 to 79) 1478values for the 256 colour mode in parentheses).
1472consist of a 4*4*4 \s-1RGB\s0 colour cube (i.e. \fIindex = r * 16 + g * 4 + b +
147316\fR), followed by 8 additional shades of gray (with indices 80 to 87).
1474.PP 1479.PP
1480The \s-1RGB\s0 cube uses indices 16..79 (16..231) using the following formulas:
1481.PP
1482.Vb 2
1483\& index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1484\& index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1485.Ve
1486.PP
1487The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1488steps (1/26 to 25/26 in 1/26 steps) \- black and white are already part of
1489the \s-1RGB\s0 cube.
1490.PP
1475Together, all those colours implement the 88 colour xterm colours. Only 1491Together, all those colours implement the 88 (256) colour xterm
1476the first 16 can be changed using resources currently, the rest can only 1492colours. Only the first 16 can be changed using resources currently, the
1477be changed via command sequences (\*(L"escape codes\*(R"). 1493rest can only be changed via command sequences (\*(L"escape codes\*(R").
1494.PP
1495Applications are advised to use terminfo or command sequences to discover
1496number and \s-1RGB\s0 values of all colours (yes, you can query this...).
1478.PP 1497.PP
1479Note that \fB\-rv\fR (\fB\*(L"reverseVideo: True\*(R"\fR) simulates reverse video by 1498Note that \fB\-rv\fR (\fB\*(L"reverseVideo: True\*(R"\fR) simulates reverse video by
1480always swapping the foreground/background colours. This is in contrast to 1499always swapping the foreground/background colours. This is in contrast to
1481\&\fIxterm\fR(1) where the colours are only swapped if they have not otherwise 1500\&\fIxterm\fR(1) where the colours are only swapped if they have not otherwise
1482been specified. For example, 1501been specified. For example,
… …
1490.SS "\s-1ALPHA\s0 \s-1CHANNEL\s0 \s-1SUPPORT\s0" 1509.SS "\s-1ALPHA\s0 \s-1CHANNEL\s0 \s-1SUPPORT\s0"
1491.IX Subsection "ALPHA CHANNEL SUPPORT" 1510.IX Subsection "ALPHA CHANNEL SUPPORT"
1492If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1511If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1493their act together, rxvt-unicode will do it's own alpha channel management: 1512their act together, rxvt-unicode will do it's own alpha channel management:
1494.PP 1513.PP
1495You can prefix any color with an opaquenes percentage enclosed in 1514You can prefix any colour with an opaqueness percentage enclosed in
1496brackets, i.e. \f(CW\*(C`[percent]\*(C'\fR, where \f(CW\*(C`percent\*(C'\fR is a decimal percentage 1515brackets, i.e. \f(CW\*(C`[percent]\*(C'\fR, where \f(CW\*(C`percent\*(C'\fR is a decimal percentage
1497(0\-100) that specifies the opacity of the color, where \f(CW0\fR is completely 1516(0\-100) that specifies the opacity of the colour, where \f(CW0\fR is completely
1498transparent and \f(CW100\fR is completely opaque. For example, \f(CW\*(C`[50]red\*(C'\fR is a 1517transparent and \f(CW100\fR is completely opaque. For example, \f(CW\*(C`[50]red\*(C'\fR is a
1499half-transparent red, while \f(CW\*(C`[95]#00ff00\*(C'\fR is an almost opaque green. This 1518half-transparent red, while \f(CW\*(C`[95]#00ff00\*(C'\fR is an almost opaque green. This
1500is the recommended format to specify transparency values, and works with 1519is the recommended format to specify transparency values, and works with
1501all ways to specify a colour. 1520all ways to specify a colour.
1502.PP 1521.PP
… …
1593@@RXVT_NAME@@. 1612@@RXVT_NAME@@.
1594.SH "FILES" 1613.SH "FILES"
1595.IX Header "FILES" 1614.IX Header "FILES"
1596.IP "\fB/usr/lib/X11/rgb.txt\fR" 4 1615.IP "\fB/usr/lib/X11/rgb.txt\fR" 4
1597.IX Item "/usr/lib/X11/rgb.txt" 1616.IX Item "/usr/lib/X11/rgb.txt"
1598Color names. 1617Colour names.
1599.SH "SEE ALSO" 1618.SH "SEE ALSO"
1600.IX Header "SEE ALSO" 1619.IX Header "SEE ALSO"
1601@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), \fIxterm\fR\|(1), \fIsh\fR\|(1), \fIresize\fR\|(1), X(1), \fIpty\fR\|(4), \fItty\fR\|(4), \fIutmp\fR\|(5) 1620@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), \fIxterm\fR\|(1), \fIsh\fR\|(1), \fIresize\fR\|(1), X(1), \fIpty\fR\|(4), \fItty\fR\|(4), \fIutmp\fR\|(5)
1602.SH "CURRENT PROJECT COORDINATOR" 1621.SH "CURRENT PROJECT COORDINATOR"
1603.IX Header "CURRENT PROJECT COORDINATOR" 1622.IX Header "CURRENT PROJECT COORDINATOR"

Diff Legend

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