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.119 by root, Sat May 14 08:28:25 2016 UTC vs.
Revision 1.120 by root, Fri May 14 13:47:43 2021 UTC

1.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.30) 1.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
2.\" 2.\"
3.\" Standard preamble: 3.\" Standard preamble:
4.\" ======================================================================== 4.\" ========================================================================
5.de Sp \" Vertical space (when we can't use .PP) 5.de Sp \" Vertical space (when we can't use .PP)
6.if t .sp .5v 6.if t .sp .5v
44.\" 44.\"
45.\" Escape single quotes in literal strings from groff's Unicode transform. 45.\" Escape single quotes in literal strings from groff's Unicode transform.
46.ie \n(.g .ds Aq \(aq 46.ie \n(.g .ds Aq \(aq
47.el .ds Aq ' 47.el .ds Aq '
48.\" 48.\"
49.\" If the F register is turned on, we'll generate index entries on stderr for 49.\" If the F register is >0, we'll generate index entries on stderr for
50.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index 50.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51.\" entries marked with X<> in POD. Of course, you'll have to process the 51.\" entries marked with X<> in POD. Of course, you'll have to process the
52.\" output yourself in some meaningful fashion. 52.\" output yourself in some meaningful fashion.
53.\" 53.\"
54.\" Avoid warning from groff about undefined register 'F'. 54.\" Avoid warning from groff about undefined register 'F'.
55.de IX 55.de IX
56.. 56..
57.nr rF 0 57.nr rF 0
58.if \n(.g .if rF .nr rF 1 58.if \n(.g .if rF .nr rF 1
59.if (\n(rF:(\n(.g==0)) \{ 59.if (\n(rF:(\n(.g==0)) \{\
60. if \nF \{ 60. if \nF \{\
61. de IX 61. de IX
62. tm Index:\\$1\t\\n%\t"\\$2" 62. tm Index:\\$1\t\\n%\t"\\$2"
63.. 63..
64. if !\nF==2 \{ 64. if !\nF==2 \{\
65. nr % 0 65. nr % 0
66. nr F 2 66. nr F 2
67. \} 67. \}
68. \} 68. \}
69.\} 69.\}
131.\} 131.\}
132.rm #[ #] #H #V #F C 132.rm #[ #] #H #V #F C
133.\" ======================================================================== 133.\" ========================================================================
134.\" 134.\"
135.IX Title "@@RXVT_NAME@@ 1" 135.IX Title "@@RXVT_NAME@@ 1"
136.TH @@RXVT_NAME@@ 1 "2016-01-23" "@@RXVT_VERSION@@" "RXVT-UNICODE" 136.TH @@RXVT_NAME@@ 1 "2021-05-13" "@@RXVT_VERSION@@" "RXVT-UNICODE"
137.\" For nroff, turn off justification. Always turn off hyphenation; it makes 137.\" For nroff, turn off justification. Always turn off hyphenation; it makes
138.\" way too many mistakes in technical documents. 138.\" way too many mistakes in technical documents.
139.if n .ad l 139.if n .ad l
140.nh 140.nh
141.SH "NAME" 141.SH "NAME"
428work around odd font metrics; resource \fBletterSpace\fR. 428work around odd font metrics; resource \fBletterSpace\fR.
429.IP "\fB\-tn\fR \fItermname\fR" 4 429.IP "\fB\-tn\fR \fItermname\fR" 4
430.IX Item "-tn termname" 430.IX Item "-tn termname"
431This option specifies the name of the terminal type to be set in the 431This option specifies the name of the terminal type to be set in the
432\&\fB\s-1TERM\s0\fR environment variable. This terminal type must exist in the 432\&\fB\s-1TERM\s0\fR environment variable. This terminal type must exist in the
433\&\fI\fItermcap\fI\|(5)\fR database and should have \fIli#\fR and \fIco#\fR entries; 433\&\fI\f(BItermcap\fI\|(5)\fR database and should have \fIli#\fR and \fIco#\fR entries;
434resource \fBtermName\fR. 434resource \fBtermName\fR.
435.IP "\fB\-e\fR \fIcommand [arguments]\fR" 4 435.IP "\fB\-e\fR \fIcommand [arguments]\fR" 4
436.IX Item "-e command [arguments]" 436.IX Item "-e command [arguments]"
437Run the command with its command-line arguments in the \fB@@RXVT_NAME@@\fR 437Run the command with its command-line arguments in the \fB@@RXVT_NAME@@\fR
438window; also sets the window title and icon name to be the basename of 438window; also sets the window title and icon name to be the basename of
439the program being executed if neither \fI\-title\fR (\fI\-T\fR) nor \fI\-n\fR are 439the program being executed if neither \fI\-title\fR (\fI\-T\fR) nor \fI\-n\fR are
440given on the command line. If this option is used, it must be the last 440given on the command line. If this option is used, it must be the last
441on the command-line. If there is no \fB\-e\fR option then the default is to 441on the command-line. If there is no \fB\-e\fR option then the default is to
442run the program specified by the \fB\s-1SHELL\s0\fR environment variable or, 442run the program specified by the \fB\s-1SHELL\s0\fR environment variable or,
443failing that, \fI\fIsh\fI\|(1)\fR. 443failing that, \fI\f(BIsh\fI\|(1)\fR.
444.Sp 444.Sp
445Please note that you must specify a program with arguments. If you want to 445Please note that you must specify a program with arguments. If you want to
446run shell commands, you have to specify the shell, like this: 446run shell commands, you have to specify the shell, like this:
447.Sp 447.Sp
448.Vb 1 448.Vb 1
620configured, while the class name \fBURxvt\fR allows resources unique to 620configured, while the class name \fBURxvt\fR allows resources unique to
621\&\fB@@RXVT_NAME@@\fR, to be shared between different \fB@@RXVT_NAME@@\fR 621\&\fB@@RXVT_NAME@@\fR, to be shared between different \fB@@RXVT_NAME@@\fR
622configurations. If no resources are specified, suitable defaults will 622configurations. If no resources are specified, suitable defaults will
623be used. Command-line arguments can be used to override resource 623be used. Command-line arguments can be used to override resource
624settings. The following resources are supported (you might want to 624settings. The following resources are supported (you might want to
625check the @@RXVT_NAME@@\fIperl\fR\|(3) manpage for additional settings by perl 625check the @@RXVT_NAME@@\fBperl\fR\|(3) manpage for additional settings by perl
626extensions not documented here): 626extensions not documented here):
627.IP "\fBdepth:\fR \fIbitdepth\fR" 4 627.IP "\fBdepth:\fR \fIbitdepth\fR" 4
628.IX Item "depth: bitdepth" 628.IX Item "depth: bitdepth"
629Compile \fIxft\fR: Attempt to find a visual with the given bit depth; 629Compile \fIxft\fR: Attempt to find a visual with the given bit depth;
630option \fB\-depth\fR. 630option \fB\-depth\fR.
849\&\fBTrue\fR: inhibit writing record into the system log file \fButmp\fR; 849\&\fBTrue\fR: inhibit writing record into the system log file \fButmp\fR;
850option \fB\-ut\fR. \fBFalse\fR: write record into the system log file \fButmp\fR 850option \fB\-ut\fR. \fBFalse\fR: write record into the system log file \fButmp\fR
851[default]; option \fB+ut\fR. 851[default]; option \fB+ut\fR.
852.IP "\fBprint-pipe:\fR \fIstring\fR" 4 852.IP "\fBprint-pipe:\fR \fIstring\fR" 4
853.IX Item "print-pipe: string" 853.IX Item "print-pipe: string"
854Specify a command pipe for vt100 printer [default \fI\fIlpr\fI\|(1)\fR]. Use 854Specify a command pipe for vt100 printer [default \fI\f(BIlpr\fI\|(1)\fR]. Use
855\&\fBPrint\fR to initiate a screen dump to the printer and \fBCtrl-Print\fR or 855\&\fBPrint\fR to initiate a screen dump to the printer and \fBCtrl-Print\fR or
856\&\fBShift-Print\fR to include the scrollback as well. 856\&\fBShift-Print\fR to include the scrollback as well.
857.Sp 857.Sp
858The string will be interpreted as if typed into the shell as-is. 858The string will be interpreted as if typed into the shell as-is.
859.Sp 859.Sp
989.IX Item "cutchars: string" 989.IX Item "cutchars: string"
990The characters used as delimiters for double-click word selection 990The characters used as delimiters for double-click word selection
991(whitespace delimiting is added automatically if resource is given). 991(whitespace delimiting is added automatically if resource is given).
992.Sp 992.Sp
993When the perl selection extension is in use (the default if compiled 993When the perl selection extension is in use (the default if compiled
994in, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage), a suitable regex using these 994in, see the @@RXVT_NAME@@\fBperl\fR\|(3) manpage), a suitable regex using these
995characters will be created (if the resource exists, otherwise, no regex 995characters will be created (if the resource exists, otherwise, no regex
996will be created). In this mode, characters outside \s-1ISO\-8859\-1\s0 can be used. 996will be created). In this mode, characters outside \s-1ISO\-8859\-1\s0 can be used.
997.Sp 997.Sp
998When the selection extension is not used, only \s-1ISO\-8859\-1\s0 characters can 998When the selection extension is not used, only \s-1ISO\-8859\-1\s0 characters can
999be used. If not specified, the built-in default is used: 999be used. If not specified, the built-in default is used:
1028.IX Item "insecure: boolean" 1028.IX Item "insecure: boolean"
1029Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that 1029Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that
1030echo arbitrary strings like the icon name or the locale. This could be 1030echo arbitrary strings like the icon name or the locale. This could be
1031abused if somebody gets 8\-bit\-clean access to your display, whether 1031abused if somebody gets 8\-bit\-clean access to your display, whether
1032through a mail client displaying mail bodies unfiltered or through 1032through a mail client displaying mail bodies unfiltered or through
1033\&\fIwrite\fR\|(1) or any other means. Therefore, these sequences are disabled by 1033\&\fBwrite\fR\|(1) or any other means. Therefore, these sequences are disabled by
1034default. (Note that many other terminals, including xterm, have these 1034default. (Note that many other terminals, including xterm, have these
1035sequences enabled by default, which doesn't make it safer, though). 1035sequences enabled by default, which doesn't make it safer, though).
1036.Sp 1036.Sp
1037You can enable them by setting this boolean resource or specifying 1037You can enable them by setting this boolean resource or specifying
1038\&\fB\-insecure\fR as an option. At the moment, this enables display-answer, 1038\&\fB\-insecure\fR as an option. At the moment, this enables display-answer,
1042Set the key to be interpreted as the Meta key to: \fBalt\fR, \fBmeta\fR, 1042Set the key to be interpreted as the Meta key to: \fBalt\fR, \fBmeta\fR,
1043\&\fBhyper\fR, \fBsuper\fR, \fBmod1\fR, \fBmod2\fR, \fBmod3\fR, \fBmod4\fR, \fBmod5\fR; option 1043\&\fBhyper\fR, \fBsuper\fR, \fBmod1\fR, \fBmod2\fR, \fBmod3\fR, \fBmod4\fR, \fBmod5\fR; option
1044\&\fB\-mod\fR. 1044\&\fB\-mod\fR.
1045.IP "\fBanswerbackString:\fR \fIstring\fR" 4 1045.IP "\fBanswerbackString:\fR \fIstring\fR" 4
1046.IX Item "answerbackString: string" 1046.IX Item "answerbackString: string"
1047Specify the reply rxvt-unicode sends to the shell when an \s-1ENQ \s0(control-E) 1047Specify the reply rxvt-unicode sends to the shell when an \s-1ENQ\s0 (control-E)
1048character is passed through. It may contain escape values as described 1048character is passed through. It may contain escape values as described
1049in the entry on \fBkeysym\fR following. 1049in the entry on \fBkeysym\fR following.
1050.IP "\fBsecondaryScreen:\fR \fIboolean\fR" 4 1050.IP "\fBsecondaryScreen:\fR \fIboolean\fR" 4
1051.IX Item "secondaryScreen: boolean" 1051.IX Item "secondaryScreen: boolean"
1052Turn on/off secondary screen (default enabled). 1052Turn on/off secondary screen (default enabled).
1083.Sp 1083.Sp
1084.Vb 1 1084.Vb 1
1085\& (modifiers\-)key 1085\& (modifiers\-)key
1086.Ve 1086.Ve
1087.Sp 1087.Sp
1088Where \fImodifiers\fR can be any combination of \fBISOLevel3\fR, \fBAppKeypad\fR, 1088Where \fImodifiers\fR can be any combination of the following full or
1089\&\fBControl\fR, \fBNumLock\fR, \fBShift\fR, \fBMeta\fR, \fBLock\fR, \fBMod1\fR, \fBMod2\fR, 1089abbreviated modifier names:
1090\&\fBMod3\fR, \fBMod4\fR, \fBMod5\fR, and the abbreviated \fBI\fR, \fBK\fR, \fBC\fR, \fBN\fR, 1090.TS
1091\&\fBS\fR, \fBM\fR, \fBA\fR, \fBL\fR, \fB1\fR, \fB2\fR, \fB3\fR, \fB4\fR, \fB5\fR. 1091l l .
1092ISOLevel3 I
1093AppKeypad K
1094Control C
1095NumLock N
1096Shift S
1097Meta M or A
1098Lock L
1099Mod1 1
1100Mod2 2
1101Mod3 3
1102Mod4 4
1103Mod5 5
1104.TE
1092.Sp 1105.Sp
1093The \fBNumLock\fR, \fBMeta\fR and \fBISOLevel3\fR modifiers are usually aliased to 1106The \fBNumLock\fR, \fBMeta\fR and \fBISOLevel3\fR modifiers are usually aliased to
1094whatever modifier the NumLock key, Meta/Alt keys or \s-1ISO\s0 Level3 Shift/AltGr 1107whatever modifier the NumLock key, Meta/Alt keys or \s-1ISO\s0 Level3 Shift/AltGr
1095keys are being mapped. \fBAppKeypad\fR is a synthetic modifier mapped to the 1108keys are being mapped. \fBAppKeypad\fR is a synthetic modifier mapped to the
1096current application keymap mode state. 1109current application keymap mode state.
1233\& URxvt.keysym.C\-M\-v: builtin\-string: 1246\& URxvt.keysym.C\-M\-v: builtin\-string:
1234.Ve 1247.Ve
1235.IP "\s-1EXTENSION:STRING\s0" 4 1248.IP "\s-1EXTENSION:STRING\s0" 4
1236.IX Item "EXTENSION:STRING" 1249.IX Item "EXTENSION:STRING"
1237An action of this form invokes the action \fB\s-1STRING\s0\fR, if any, provided 1250An action of this form invokes the action \fB\s-1STRING\s0\fR, if any, provided
1238by the @@RXVT_NAME@@\fIperl\fR\|(3) extension \fB\s-1EXTENSION\s0\fR. The extension will 1251by the @@RXVT_NAME@@\fBperl\fR\|(3) extension \fB\s-1EXTENSION\s0\fR. The extension will
1239be loaded automatically if necessary. 1252be loaded automatically if necessary.
1240.Sp 1253.Sp
1241Not all extensions define actions, but popular extensions that do 1254Not all extensions define actions, but popular extensions that do
1242include the \fIselection\fR and \fImatcher\fR extensions (documented in their 1255include the \fIselection\fR and \fImatcher\fR extensions (documented in their
1243own manpages, @@RXVT_NAME@@\-\fIselection\fR\|(1) and @@RXVT_NAME@@\-\fImatcher\fR\|(1), 1256own manpages, @@RXVT_NAME@@\-\fBselection\fR\|(1) and @@RXVT_NAME@@\-\fBmatcher\fR\|(1),
1244respectively). 1257respectively).
1245.Sp 1258.Sp
1246From the silly examples department, this will rot13\-\*(L"encrypt\*(R" 1259From the silly examples department, this will rot13\-\*(L"encrypt\*(R"
1247@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical \s-1PC\s0 1260@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical \s-1PC\s0
1248keyboards: 1261keyboards:
1289\&\fBperl-ext-common\fR will be used for extensions that should be available to 1302\&\fBperl-ext-common\fR will be used for extensions that should be available to
1290all instances, while \fBperl-ext\fR is used for specific instances. 1303all instances, while \fBperl-ext\fR is used for specific instances.
1291.IP "\fBperl-eval\fR: \fIstring\fR" 4 1304.IP "\fBperl-eval\fR: \fIstring\fR" 4
1292.IX Item "perl-eval: string" 1305.IX Item "perl-eval: string"
1293Perl code to be evaluated when all extensions have been registered. See 1306Perl code to be evaluated when all extensions have been registered. See
1294the @@RXVT_NAME@@\fIperl\fR\|(3) manpage. 1307the @@RXVT_NAME@@\fBperl\fR\|(3) manpage.
1295.IP "\fBperl-lib\fR: \fIpath\fR" 4 1308.IP "\fBperl-lib\fR: \fIpath\fR" 4
1296.IX Item "perl-lib: path" 1309.IX Item "perl-lib: path"
1297Colon-separated list of additional directories that hold extension 1310Colon-separated list of additional directories that hold extension
1298scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look 1311scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1299in these directories, then in \f(CW$URXVT_PERL_LIB\fR, \fI\f(CI$HOME\fI/.urxvt/ext\fR and 1312in these directories, then in \f(CW$URXVT_PERL_LIB\fR, \fI\f(CI$HOME\fI/.urxvt/ext\fR and
1300lastly in \fI@@RXVT_LIBDIR@@/urxvt/perl/\fR. 1313lastly in \fI@@RXVT_LIBDIR@@/urxvt/perl/\fR.
1301.Sp 1314.Sp
1302See the @@RXVT_NAME@@\fIperl\fR\|(3) manpage. 1315See the @@RXVT_NAME@@\fBperl\fR\|(3) manpage.
1303.IP "\fBselection.pattern\-\f(BIidx\fB\fR: \fIperl-regex\fR" 4 1316.IP "\fBselection.pattern\-\f(BIidx\fB\fR: \fIperl-regex\fR" 4
1304.IX Item "selection.pattern-idx: perl-regex" 1317.IX Item "selection.pattern-idx: perl-regex"
1305Additional selection patterns, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage for 1318Additional selection patterns, see the @@RXVT_NAME@@\fBperl\fR\|(3) manpage for
1306details. 1319details.
1307.IP "\fBselection-autotransform.\f(BIidx\fB\fR: \fIperl-transform\fR" 4 1320.IP "\fBselection-autotransform.\f(BIidx\fB\fR: \fIperl-transform\fR" 4
1308.IX Item "selection-autotransform.idx: perl-transform" 1321.IX Item "selection-autotransform.idx: perl-transform"
1309Selection auto-transform patterns, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage 1322Selection auto-transform patterns, see the @@RXVT_NAME@@\fBperl\fR\|(3) manpage
1310for details. 1323for details.
1311.IP "\fBsearchable-scrollback:\fR \fIkeysym\fR *DEPRECATED*" 4 1324.IP "\fBsearchable-scrollback:\fR \fIkeysym\fR *DEPRECATED*" 4
1312.IX Item "searchable-scrollback: keysym *DEPRECATED*" 1325.IX Item "searchable-scrollback: keysym *DEPRECATED*"
1313This resource is deprecated and will be removed. Use a \fBkeysym\fR resource 1326This resource is deprecated and will be removed. Use a \fBkeysym\fR resource
1314instead, e.g.: 1327instead, e.g.:
1327.IX Item "override-redirect: boolean" 1340.IX Item "override-redirect: boolean"
1328Compile \fIfrills\fR: Sets override-redirect for the terminal window, making 1341Compile \fIfrills\fR: Sets override-redirect for the terminal window, making
1329it almost invisible to window managers; option \fB\-override\-redirect\fR. 1342it almost invisible to window managers; option \fB\-override\-redirect\fR.
1330.IP "\fBiso14755:\fR \fIboolean\fR" 4 1343.IP "\fBiso14755:\fR \fIboolean\fR" 4
1331.IX Item "iso14755: boolean" 1344.IX Item "iso14755: boolean"
1332Turn on/off \s-1ISO 14755 \s0(default enabled). 1345Turn on/off \s-1ISO 14755\s0 (default enabled).
1333.IP "\fBiso14755_52:\fR \fIboolean\fR" 4 1346.IP "\fBiso14755_52:\fR \fIboolean\fR" 4
1334.IX Item "iso14755_52: boolean" 1347.IX Item "iso14755_52: boolean"
1335Turn on/off \s-1ISO 14755 5.2\s0 mode (default enabled). 1348Turn on/off \s-1ISO 14755 5.2\s0 mode (default enabled).
1336.SH "BACKGROUND IMAGE OPTIONS AND RESOURCES"
1337.IX Header "BACKGROUND IMAGE OPTIONS AND RESOURCES"
1338.IP "\fB\-pixmap\fR \fIfile[;oplist]\fR" 4
1339.IX Item "-pixmap file[;oplist]"
1340.PD 0
1341.IP "\fBbackgroundPixmap:\fR \fIfile[;oplist]\fR" 4
1342.IX Item "backgroundPixmap: file[;oplist]"
1343.PD
1344Compile \fIpixbuf\fR: Use the specified image file as the window's
1345background and also optionally specify a colon separated list of
1346operations to modify it. Note that you may need to quote the \f(CW\*(C`;\*(C'\fR
1347character when using the command line option, as \f(CW\*(C`;\*(C'\fR is usually a
1348metacharacter in shells. Supported operations are:
1349.RS 4
1350.IP "\fBWxH+X+Y\fR" 4
1351.IX Item "WxH+X+Y"
1352sets scale and position. \fB\*(L"W\*(R" / \*(L"H\*(R"\fR specify the horizontal/vertical
1353scale (percent), and \fB\*(L"X\*(R" / \*(L"Y\*(R"\fR locate the image centre (percent). A
1354scale of 0 disables scaling.
1355.IP "\fBop=tile\fR" 4
1356.IX Item "op=tile"
1357enables tiling
1358.IP "\fBop=keep\-aspect\fR" 4
1359.IX Item "op=keep-aspect"
1360maintain the image aspect ratio when scaling
1361.IP "\fBop=root\-align\fR" 4
1362.IX Item "op=root-align"
1363use the position of the terminal window relative to the root window as
1364the image offset, simulating a root window background
1365.RE
1366.RS 4
1367.Sp
1368The default scale and position setting is \f(CW\*(C`100x100+50+50\*(C'\fR.
1369Alternatively, a predefined set of templates can be used to achieve
1370the most common setups:
1371.IP "\fBstyle=tiled\fR" 4
1372.IX Item "style=tiled"
1373the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1374.IP "\fBstyle=aspect\-stretched\fR" 4
1375.IX Item "style=aspect-stretched"
1376the image is scaled to fill the whole window maintaining the aspect
1377ratio and centered. Equivalent to 100x100+50+50:op=keep\-aspect
1378.IP "\fBstyle=stretched\fR" 4
1379.IX Item "style=stretched"
1380the image is scaled to fill the whole window. Equivalent to 100x100
1381.IP "\fBstyle=centered\fR" 4
1382.IX Item "style=centered"
1383the image is centered with no scaling. Equivalent to 0x0+50+50
1384.IP "\fBstyle=root\-tiled\fR" 4
1385.IX Item "style=root-tiled"
1386the image is tiled with no scaling and using 'root' positioning.
1387Equivalent to 0x0:op=tile:op=root\-align
1388.RE
1389.RS 4
1390.Sp
1391If multiple templates are specified the last one wins. Note that a
1392template overrides all the scale, position and operations settings.
1393.Sp
1394If used in conjunction with pseudo-transparency, the specified pixmap
1395will be blended over the transparent background using alpha-blending.
1396.RE
1397.IP "\fB\-tr\fR|\fB+tr\fR" 4
1398.IX Item "-tr|+tr"
1399.PD 0
1400.IP "\fBtransparent:\fR \fIboolean\fR" 4
1401.IX Item "transparent: boolean"
1402.PD
1403Turn on/off pseudo-transparency by using the root pixmap as background.
1404.Sp
1405\&\fB\-ip\fR (\fBinheritPixmap\fR) is still accepted as an obsolete alias but
1406will be removed in future versions.
1407.IP "\fB\-tint\fR \fIcolour\fR" 4
1408.IX Item "-tint colour"
1409.PD 0
1410.IP "\fBtintColor:\fR \fIcolour\fR" 4
1411.IX Item "tintColor: colour"
1412.PD
1413Tint the transparent background with the given colour. Note that a
1414black tint yields a completely black image while a white tint yields
1415the image unchanged.
1416.IP "\fB\-sh\fR \fInumber\fR" 4
1417.IX Item "-sh number"
1418.PD 0
1419.IP "\fBshading:\fR \fInumber\fR" 4
1420.IX Item "shading: number"
1421.PD
1422Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1423A value of 100 means no shading.
1424.IP "\fB\-blr\fR \fIHxV\fR" 4
1425.IX Item "-blr HxV"
1426.PD 0
1427.IP "\fBblurRadius:\fR \fIHxV\fR" 4
1428.IX Item "blurRadius: HxV"
1429.PD
1430Apply gaussian blur with the specified radius to the transparent
1431background. If a single number is specified, the vertical and
1432horizontal radii are considered to be the same. Setting one of the
1433radii to 1 and the other to a large number creates interesting effects
1434on some backgrounds. The maximum radius value is 128. An horizontal or
1435vertical radius of 0 disables blurring.
1436.IP "\fBpath:\fR \fIpath\fR" 4
1437.IX Item "path: path"
1438Specify the colon-delimited search path for finding background image files.
1439.SH "THE SCROLLBAR" 1349.SH "THE SCROLLBAR"
1440.IX Header "THE SCROLLBAR" 1350.IX Header "THE SCROLLBAR"
1441Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window 1351Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window
1442(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar 1352(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar
1443or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and 1353or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and
1570With respect to conformance, rxvt-unicode is supposed to be compliant to 1480With respect to conformance, rxvt-unicode is supposed to be compliant to
1571both scenario A and B of \s-1ISO 14755,\s0 including part 5.2. 1481both scenario A and B of \s-1ISO 14755,\s0 including part 5.2.
1572.SH "LOGIN STAMP" 1482.SH "LOGIN STAMP"
1573.IX Header "LOGIN STAMP" 1483.IX Header "LOGIN STAMP"
1574\&\fB@@RXVT_NAME@@\fR tries to write an entry into the \fIutmp\fR(5) file so that 1484\&\fB@@RXVT_NAME@@\fR tries to write an entry into the \fIutmp\fR(5) file so that
1575it can be seen via the \fI\fIwho\fI\|(1)\fR command, and can accept messages. To 1485it can be seen via the \fI\f(BIwho\fI\|(1)\fR command, and can accept messages. To
1576allow this feature, \fB@@RXVT_NAME@@\fR may need to be installed setuid root 1486allow this feature, \fB@@RXVT_NAME@@\fR may need to be installed setuid root
1577on some systems or setgid to root or to some other group on others. 1487on some systems or setgid to root or to some other group on others.
1578.SH "COLOURS AND GRAPHICS" 1488.SH "COLOURS AND GRAPHICS"
1579.IX Header "COLOURS AND GRAPHICS" 1489.IX Header "COLOURS AND GRAPHICS"
1580In addition to the default foreground and background colours, 1490In addition to the default foreground and background colours,
1581\&\fB@@RXVT_NAME@@\fR can display up to 88/256 colours: 8 \s-1ANSI\s0 colours plus 1491\&\fB@@RXVT_NAME@@\fR can display up to 88/256 colours: 8 \s-1ANSI\s0 colours plus
1582high-intensity (potentially bold/blink) versions of the same, and 72 (or 1492high-intensity (potentially bold/blink) versions of the same, and 72 (or
1583240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour \s-1RGB\s0 1493240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour \s-1RGB\s0
1584cube plus a 8 (24) colour greyscale ramp. 1494cube plus a 8 (24) colour greyscale ramp.
1495.PP
1496\&\fB@@RXVT_NAME@@\fR supports direct 24\-bit fg/bg \s-1RGB\s0 colour escapes
1497\&\f(CW\*(C` ESC [ 38 ; 2 ; R ; G ; Bm \*(C'\fR / \f(CW\*(C` ESC [ 48 ; 2; R ; G ; Bm \*(C'\fR. However the
1498number of 24\-bit colours that can be used is limited: an internal 7x7x5 (256
1499colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
150024\-bit colour space. When indexing collisions happen, the nearest old colour in
1501the cube will be adapted to the new 24\-bit \s-1RGB\s0 colour. That means one cannot
1502use many similar 24\-bit colours. It's typically not a problem in common
1503scenarios.
1585.PP 1504.PP
1586Here is a list of the \s-1ANSI\s0 colours with their names. 1505Here is a list of the \s-1ANSI\s0 colours with their names.
1587.TS 1506.TS
1588l l l . 1507l l l .
1589color0 (black) = Black 1508color0 (black) = Black
1760.IP "\fB/usr/lib/X11/rgb.txt\fR" 4 1679.IP "\fB/usr/lib/X11/rgb.txt\fR" 4
1761.IX Item "/usr/lib/X11/rgb.txt" 1680.IX Item "/usr/lib/X11/rgb.txt"
1762Colour names. 1681Colour names.
1763.SH "SEE ALSO" 1682.SH "SEE ALSO"
1764.IX Header "SEE ALSO" 1683.IX Header "SEE ALSO"
1765@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@\-\fIextensions\fR\|(1), 1684@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@\-\fBextensions\fR\|(1),
1766@@RXVT_NAME@@\fIperl\fR\|(3), \fIxterm\fR\|(1), \fIsh\fR\|(1), \fIresize\fR\|(1), X(1), \fIpty\fR\|(4), \fItty\fR\|(4), \fIutmp\fR\|(5) 1685@@RXVT_NAME@@\fBperl\fR\|(3), \fBxterm\fR\|(1), \fBsh\fR\|(1), \fBresize\fR\|(1), X(1), \fBpty\fR\|(4), \fBtty\fR\|(4), \fButmp\fR\|(5)
1767.SH "CURRENT PROJECT COORDINATOR" 1686.SH "CURRENT PROJECT COORDINATOR"
1768.IX Header "CURRENT PROJECT COORDINATOR" 1687.IX Header "CURRENT PROJECT COORDINATOR"
1769.IP "Project Coordinator" 4 1688.IP "Project Coordinator" 4
1770.IX Item "Project Coordinator" 1689.IX Item "Project Coordinator"
1771Marc A. Lehmann <rxvt\-unicode@schmorp.de>. 1690Marc A. Lehmann <rxvt\-unicode@schmorp.de>.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines