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.78 by root, Mon Dec 24 08:00:16 2007 UTC vs.
Revision 1.83 by root, Sun Jun 15 18:11:41 2008 UTC

1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.35 1.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
2.\" 2.\"
3.\" Standard preamble: 3.\" Standard preamble:
4.\" ======================================================================== 4.\" ========================================================================
5.de Sh \" Subsection heading 5.de Sh \" Subsection heading
6.br 6.br
… …
23.ft R 23.ft R
24.fi 24.fi
25.. 25..
26.\" Set up some character translations and predefined strings. \*(-- will 26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left 27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28.\" double quote, and \*(R" will give a right double quote. | will give a 28.\" double quote, and \*(R" will give a right double quote. \*(C+ will
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to 29.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' 30.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
31.\" expand to `' in nroff, nothing in troff, for use with C<>. 31.\" nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr 32.tr \(*W-
33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' 33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34.ie n \{\ 34.ie n \{\
35. ds -- \(*W- 35. ds -- \(*W-
36. ds PI pi 36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch 37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
… …
46. ds PI \(*p 46. ds PI \(*p
47. ds L" `` 47. ds L" ``
48. ds R" '' 48. ds R" ''
49'br\} 49'br\}
50.\" 50.\"
51.\" Escape single quotes in literal strings from groff's Unicode transform.
52.ie \n(.g .ds Aq \(aq
53.el .ds Aq '
54.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for 55.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index 56.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the 57.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion. 58.\" output yourself in some meaningful fashion.
55.if \nF \{\ 59.ie \nF \{\
56. de IX 60. de IX
57. tm Index:\\$1\t\\n%\t"\\$2" 61. tm Index:\\$1\t\\n%\t"\\$2"
58.. 62..
59. nr % 0 63. nr % 0
60. rr F 64. rr F
61.\} 65.\}
62.\" 66.el \{\
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes 67. de IX
64.\" way too many mistakes in technical documents. 68..
65.hy 0 69.\}
66.if n .na
67.\" 70.\"
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). 71.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts. 72.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff 73. \" fudge factors for nroff and troff
71.if n \{\ 74.if n \{\
… …
127.\} 130.\}
128.rm #[ #] #H #V #F C 131.rm #[ #] #H #V #F C
129.\" ======================================================================== 132.\" ========================================================================
130.\" 133.\"
131.IX Title "@@RXVT_NAME@@ 1" 134.IX Title "@@RXVT_NAME@@ 1"
132.TH @@RXVT_NAME@@ 1 "2007-12-24" "8.9" "RXVT-UNICODE" 135.TH @@RXVT_NAME@@ 1 "2008-06-15" "@@RXVT_VERSION@@" "RXVT-UNICODE"
136.\" For nroff, turn off justification. Always turn off hyphenation; it makes
137.\" way too many mistakes in technical documents.
138.if n .ad l
139.nh
133.SH "NAME" 140.SH "NAME"
134rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system) 141rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system)
135.SH "SYNOPSIS" 142.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 143.IX Header "SYNOPSIS"
137\&\fB@@RXVT_NAME@@\fR [options] [\-e command [ args ]] 144\&\fB@@RXVT_NAME@@\fR [options] [\-e command [ args ]]
… …
195reference documentation (escape sequences etc.). 202reference documentation (escape sequences etc.).
196.SH "OPTIONS" 203.SH "OPTIONS"
197.IX Header "OPTIONS" 204.IX Header "OPTIONS"
198The \fB@@RXVT_NAME@@\fR options (mostly a subset of \fIxterm\fR's) are listed 205The \fB@@RXVT_NAME@@\fR options (mostly a subset of \fIxterm\fR's) are listed
199below. In keeping with the smaller-is-better philosophy, options may be 206below. In keeping with the smaller-is-better philosophy, options may be
200eliminated or default values chosen at compile\-time, so options and 207eliminated or default values chosen at compile-time, so options and
201defaults listed may not accurately reflect the version installed on 208defaults listed may not accurately reflect the version installed on
202your system. `@@RXVT_NAME@@ \-h' gives a list of major compile-time options on 209your system. `@@RXVT_NAME@@ \-h' gives a list of major compile-time options on
203the \fIOptions\fR line. Option descriptions may be prefixed with which 210the \fIOptions\fR line. Option descriptions may be prefixed with which
204compile option each is dependent upon. e.g. `Compile \fI\s-1XIM\s0\fR:' requires 211compile option each is dependent upon. e.g. `Compile \fI\s-1XIM\s0\fR:' requires
205\&\fI\s-1XIM\s0\fR on the \fIOptions\fR line. Note: `@@RXVT_NAME@@ \-help' gives a list of all 212\&\fI\s-1XIM\s0\fR on the \fIOptions\fR line. Note: `@@RXVT_NAME@@ \-help' gives a list of all
… …
214.IP "\fB\-help\fR, \fB\-\-help\fR" 4 221.IP "\fB\-help\fR, \fB\-\-help\fR" 4
215.IX Item "-help, --help" 222.IX Item "-help, --help"
216Print out a message describing available options. 223Print out a message describing available options.
217.IP "\fB\-display\fR \fIdisplayname\fR" 4 224.IP "\fB\-display\fR \fIdisplayname\fR" 4
218.IX Item "-display displayname" 225.IX Item "-display displayname"
219Attempt to open a window on the named X display (\fB\-d\fR still 226Attempt to open a window on the named X display (the older form \fB\-d\fR
220respected). In the absence of this option, the display specified by the 227is still respected. but deprecated). In the absence of this option, the
221\&\fB\s-1DISPLAY\s0\fR environment variable is used. 228display specified by the \fB\s-1DISPLAY\s0\fR environment variable is used.
222.IP "\fB\-depth\fR \fIbitdepth\fR" 4 229.IP "\fB\-depth\fR \fIbitdepth\fR" 4
223.IX Item "-depth bitdepth" 230.IX Item "-depth bitdepth"
224Compile \fIxft\fR: Attempt to find a visual with the given bit depth; 231Compile \fIxft\fR: Attempt to find a visual with the given bit depth;
225resource \fBdepth\fR. 232resource \fBdepth\fR.
233.Sp
234[Please note that many X servers (and libXft) are buggy with
235respect to \f(CW\*(C`\-depth 32\*(C'\fR and/or alpha channels, and will cause all sorts
236of graphical corruption. This is harmless, but we can't do anything about
237this, so watch out]
226.IP "\fB\-geometry\fR \fIgeom\fR" 4 238.IP "\fB\-geometry\fR \fIgeom\fR" 4
227.IX Item "-geometry geom" 239.IX Item "-geometry geom"
228Window geometry (\fB\-g\fR still respected); resource \fBgeometry\fR. 240Window geometry (\fB\-g\fR still respected); resource \fBgeometry\fR.
229.IP "\fB\-rv\fR|\fB+rv\fR" 4 241.IP "\fB\-rv\fR|\fB+rv\fR" 4
230.IX Item "-rv|+rv" 242.IX Item "-rv|+rv"
… …
257.IX Item "-tint colour" 269.IX Item "-tint colour"
258Tint the transparent background pixmap with the given colour when 270Tint the transparent background pixmap with the given colour when
259transparency is enabled with \fB\-tr\fR. This only works for 271transparency is enabled with \fB\-tr\fR. This only works for
260non-tiled backgrounds, currently. See also the \fB\-sh\fR option that can be 272non-tiled backgrounds, currently. See also the \fB\-sh\fR option that can be
261used to brighten or darken the image in addition to tinting it. 273used to brighten or darken the image in addition to tinting it.
262Please note that certain tint colours can be applied on the server\-side, 274Please note that certain tint colours can be applied on the server-side,
263thus yielding performance gain of two orders of magnitude. These colours are: 275thus yielding performance gain of two orders of magnitude. These colours are:
264blue, red, green, cyan, magenta, yellow, and those close to them. Also 276blue, red, green, cyan, magenta, yellow, and those close to them. Also
265pure black and pure white colors essentially mean no tinting; resource 277pure black and pure white colors essentially mean no tinting; resource
266\&\fItintColor\fR. Example: 278\&\fItintColor\fR. Example:
267.Sp 279.Sp
268.Vb 1 280.Vb 1
269\& @@RXVT_NAME@@ -tr -tint blue -sh 40 281\& @@RXVT_NAME@@ \-tr \-tint blue \-sh 40
270.Ve 282.Ve
271.IP "\fB\-sh\fR \fInumber\fR" 4 283.IP "\fB\-sh\fR \fInumber\fR" 4
272.IX Item "-sh number" 284.IX Item "-sh number"
273Darken (0 .. 100) or lighten (100 .. 200) the transparent 285Darken (0 .. 100) or lighten (100 .. 200) the transparent
274background image in addition to (or instead of) tinting it; 286background image in addition to (or instead of) tinting it;
… …
279at the same time as transparency \- such pixmap will be blended over 291at the same time as transparency \- such pixmap will be blended over
280transparency image, using method specified. Supported values are : 292transparency image, using method specified. Supported values are :
281\&\fBadd\fR, \fBalphablend\fR, \fBallanon\fR \- color values averaging, \fBcolorize\fR, 293\&\fBadd\fR, \fBalphablend\fR, \fBallanon\fR \- color values averaging, \fBcolorize\fR,
282\&\fBdarken\fR, \fBdiff\fR, \fBdissipate\fR, \fBhue\fR, \fBlighten\fR, \fBoverlay\fR, 294\&\fBdarken\fR, \fBdiff\fR, \fBdissipate\fR, \fBhue\fR, \fBlighten\fR, \fBoverlay\fR,
283\&\fBsaturate\fR, \fBscreen\fR, \fBsub\fR, \fBtint\fR, \fBvalue\fR. The default is 295\&\fBsaturate\fR, \fBscreen\fR, \fBsub\fR, \fBtint\fR, \fBvalue\fR. The default is
284alpha\-blending. Compile \fIafterimage\fR; resource \fIblendType\fR. 296alpha-blending. Compile \fIafterimage\fR; resource \fIblendType\fR.
285.IP "\fB\-blr\fR \fIHxV\fR" 4 297.IP "\fB\-blr\fR \fIHxV\fR" 4
286.IX Item "-blr HxV" 298.IX Item "-blr HxV"
287Apply Gaussian Blur with the specified radii to the transparent 299Apply Gaussian Blur with the specified radii to the transparent
288background image. If single number is specified \- both vertical and 300background image. If single number is specified \- both vertical and
289horizontal radii are considered to be the same. Setting one of the 301horizontal radii are considered to be the same. Setting one of the
… …
299.IP "\fB\-pixmap\fR \fIfile[;geom[:op1][:op2][...]]\fR" 4 311.IP "\fB\-pixmap\fR \fIfile[;geom[:op1][:op2][...]]\fR" 4
300.IX Item "-pixmap file[;geom[:op1][:op2][...]]" 312.IX Item "-pixmap file[;geom[:op1][:op2][...]]"
301Compile \fIafterimage\fR: Specify image file for the background and also 313Compile \fIafterimage\fR: Specify image file for the background and also
302optionally specify its scaling with a geometry string. Note you may need to 314optionally specify its scaling with a geometry string. Note you may need to
303add quotes to avoid special shell interpretation of the \f(CW\*(C`;\*(C'\fR in the 315add quotes to avoid special shell interpretation of the \f(CW\*(C`;\*(C'\fR in the
304command\-line; for more details see resource \fBbackgroundPixmap\fR. 316command-line; for more details see resource \fBbackgroundPixmap\fR.
305.IP "\fB\-cr\fR \fIcolour\fR" 4 317.IP "\fB\-cr\fR \fIcolour\fR" 4
306.IX Item "-cr colour" 318.IX Item "-cr colour"
307The cursor colour; resource \fBcursorColor\fR. 319The cursor colour; resource \fBcursorColor\fR.
308.IP "\fB\-pr\fR \fIcolour\fR" 4 320.IP "\fB\-pr\fR \fIcolour\fR" 4
309.IX Item "-pr colour" 321.IX Item "-pr colour"
… …
322first font defines the cell size for characters; other fonts might be 334first font defines the cell size for characters; other fonts might be
323smaller, but not (in general) larger. A (hopefully) reasonable default 335smaller, but not (in general) larger. A (hopefully) reasonable default
324font list is always appended to it. See resource \fBfont\fR for more details. 336font list is always appended to it. See resource \fBfont\fR for more details.
325.Sp 337.Sp
326In short, to specify an X11 core font, just specify its name or prefix it 338In short, to specify an X11 core font, just specify its name or prefix it
327with \f(CW\*(C`x:\*(C'\fR. To specify an XFT\-font, you need to prefix it with \f(CW\*(C`xft:\*(C'\fR, 339with \f(CW\*(C`x:\*(C'\fR. To specify an XFT-font, you need to prefix it with \f(CW\*(C`xft:\*(C'\fR,
328e.g.: 340e.g.:
329.Sp 341.Sp
330.Vb 2 342.Vb 2
331\& @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 343\& @@RXVT_NAME@@ \-fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
332\& @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 344\& @@RXVT_NAME@@ \-fn "9x15bold,xft:Bitstream Vera Sans Mono"
333.Ve 345.Ve
334.Sp 346.Sp
335See also the question \*(L"How does rxvt-unicode choose fonts?\*(R" in the \s-1FAQ\s0 347See also the question \*(L"How does rxvt-unicode choose fonts?\*(R" in the \s-1FAQ\s0
336section of @@RXVT_NAME@@(7). 348section of @@RXVT_NAME@@(7).
337.IP "\fB\-fb\fR \fIfontlist\fR" 4 349.IP "\fB\-fb\fR \fIfontlist\fR" 4
… …
369Turn on/off visual bell on receipt of a bell character; resource 381Turn on/off visual bell on receipt of a bell character; resource
370\&\fBvisualBell\fR. 382\&\fBvisualBell\fR.
371.IP "\fB\-sb\fR|\fB+sb\fR" 4 383.IP "\fB\-sb\fR|\fB+sb\fR" 4
372.IX Item "-sb|+sb" 384.IX Item "-sb|+sb"
373Turn on/off scrollbar; resource \fBscrollBar\fR. 385Turn on/off scrollbar; resource \fBscrollBar\fR.
386.IP "\fB\-sr\fR|\fB+sr\fR" 4
387.IX Item "-sr|+sr"
388Put scrollbar on right/left; resource \fBscrollBar_right\fR.
389.IP "\fB\-st\fR|\fB+st\fR" 4
390.IX Item "-st|+st"
391Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
392resource \fBscrollBar_floating\fR.
374.IP "\fB\-si\fR|\fB+si\fR" 4 393.IP "\fB\-si\fR|\fB+si\fR" 4
375.IX Item "-si|+si" 394.IX Item "-si|+si"
376Turn on/off scroll-to-bottom on \s-1TTY\s0 output inhibit; resource 395Turn on/off scroll-to-bottom on \s-1TTY\s0 output inhibit; resource
377\&\fBscrollTtyOutput\fR has opposite effect. 396\&\fBscrollTtyOutput\fR has opposite effect.
378.IP "\fB\-sk\fR|\fB+sk\fR" 4 397.IP "\fB\-sk\fR|\fB+sk\fR" 4
… …
382.IP "\fB\-sw\fR|\fB+sw\fR" 4 401.IP "\fB\-sw\fR|\fB+sw\fR" 4
383.IX Item "-sw|+sw" 402.IX Item "-sw|+sw"
384Turn on/off scrolling with the scrollback buffer as new lines appear. 403Turn on/off scrolling with the scrollback buffer as new lines appear.
385This only takes effect if \fB\-si\fR is also given; resource 404This only takes effect if \fB\-si\fR is also given; resource
386\&\fBscrollWithBuffer\fR. 405\&\fBscrollWithBuffer\fR.
387.IP "\fB\-sr\fR|\fB+sr\fR" 4
388.IX Item "-sr|+sr"
389Put scrollbar on right/left; resource \fBscrollBar_right\fR.
390.IP "\fB\-st\fR|\fB+st\fR" 4
391.IX Item "-st|+st"
392Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
393resource \fBscrollBar_floating\fR.
394.IP "\fB\-ptab\fR|\fB+ptab\fR" 4 406.IP "\fB\-ptab\fR|\fB+ptab\fR" 4
395.IX Item "-ptab|+ptab" 407.IX Item "-ptab|+ptab"
396If enabled (default), \*(L"Horizontal Tab\*(R" characters are being stored as 408If enabled (default), \*(L"Horizontal Tab\*(R" characters are being stored as
397actual wide characters in the screen buffer, which makes it possible to 409actual wide characters in the screen buffer, which makes it possible to
398select and paste them. Since a horizontal tab is a cursor movement and 410select and paste them. Since a horizontal tab is a cursor movement and
… …
448.IX Item "-e command [arguments]" 460.IX Item "-e command [arguments]"
449Run the command with its command-line arguments in the \fB@@RXVT_NAME@@\fR 461Run the command with its command-line arguments in the \fB@@RXVT_NAME@@\fR
450window; also sets the window title and icon name to be the basename of 462window; also sets the window title and icon name to be the basename of
451the program being executed if neither \fI\-title\fR (\fI\-T\fR) nor \fI\-n\fR are 463the program being executed if neither \fI\-title\fR (\fI\-T\fR) nor \fI\-n\fR are
452given on the command line. If this option is used, it must be the last 464given on the command line. If this option is used, it must be the last
453on the command\-line. If there is no \fB\-e\fR option then the default is to 465on the command-line. If there is no \fB\-e\fR option then the default is to
454run the program specified by the \fB\s-1SHELL\s0\fR environment variable or, 466run the program specified by the \fB\s-1SHELL\s0\fR environment variable or,
455failing that, \fI\fIsh\fI\|(1)\fR. 467failing that, \fI\fIsh\fI\|(1)\fR.
456.Sp 468.Sp
457Please note that you must specify a program with arguments. If you want to 469Please note that you must specify a program with arguments. If you want to
458run shell commands, you have to specify the shell, like this: 470run shell commands, you have to specify the shell, like this:
459.Sp 471.Sp
460.Vb 1 472.Vb 1
461\& @@RXVT_NAME@@ -e sh -c "shell commands" 473\& @@RXVT_NAME@@ \-e sh \-c "shell commands"
462.Ve 474.Ve
463.IP "\fB\-title\fR \fItext\fR" 4 475.IP "\fB\-title\fR \fItext\fR" 4
464.IX Item "-title text" 476.IX Item "-title text"
465Window title (\fB\-T\fR still respected); the default title is the basename 477Window title (\fB\-T\fR still respected); the default title is the basename
466of the program specified after the \fB\-e\fR option, if any, otherwise the 478of the program specified after the \fB\-e\fR option, if any, otherwise the
… …
491Set the font set to use for the X Input Method, see resource \fBimFont\fR 503Set the font set to use for the X Input Method, see resource \fBimFont\fR
492for more info. 504for more info.
493.IP "\fB\-tcw\fR" 4 505.IP "\fB\-tcw\fR" 4
494.IX Item "-tcw" 506.IX Item "-tcw"
495Change the meaning of triple-click selection with the left mouse 507Change the meaning of triple-click selection with the left mouse
496button. Only effective when the original (non\-perl) selection code is 508button. Only effective when the original (non-perl) selection code is
497in\-use. Instead of selecting a full line it will extend the selection to 509in-use. Instead of selecting a full line it will extend the selection to
498the end of the logical line only. resource \fBtripleclickwords\fR. 510the end of the logical line only. resource \fBtripleclickwords\fR.
499.IP "\fB\-insecure\fR" 4 511.IP "\fB\-insecure\fR" 4
500.IX Item "-insecure" 512.IX Item "-insecure"
501Enable \*(L"insecure\*(R" mode, which currently enables most of the escape 513Enable \*(L"insecure\*(R" mode, which currently enables most of the escape
502sequences that echo strings. See the resource \fBinsecure\fR for more 514sequences that echo strings. See the resource \fBinsecure\fR for more
… …
518.IX Item "-hold|+hold" 530.IX Item "-hold|+hold"
519Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 531Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
520will not immediately destroy its window when the program executed within 532will not immediately destroy its window when the program executed within
521it exits. Instead, it will wait till it is being killed or closed by the 533it exits. Instead, it will wait till it is being killed or closed by the
522user; resource \fBhold\fR. 534user; resource \fBhold\fR.
535.IP "\fB\-cd\fR \fIpath\fR" 4
536.IX Item "-cd path"
537Sets the working directory for the shell (or the command specified via
538\&\fB\-e\fR). The \fIpath\fR must be an absolute path and it must exist for
539@@RXVT_NAME@@ to start; resource \fBchdir\fR.
523.IP "\fB\-xrm\fR \fIstring\fR" 4 540.IP "\fB\-xrm\fR \fIstring\fR" 4
524.IX Item "-xrm string" 541.IX Item "-xrm string"
525Works like the X Toolkit option of the same name, by adding the \fIstring\fR 542Works like the X Toolkit option of the same name, by adding the \fIstring\fR
526as if it were specified in a resource file. Resource values specified this 543as if it were specified in a resource file. Resource values specified this
527way take precedence over all other resource specifications. 544way take precedence over all other resource specifications.
… …
556Here is a short Gtk2\-perl snippet that illustrates how this option can be 573Here is a short Gtk2\-perl snippet that illustrates how this option can be
557used (a longer example is in \fIdoc/embed\fR): 574used (a longer example is in \fIdoc/embed\fR):
558.Sp 575.Sp
559.Vb 5 576.Vb 5
560\& my $rxvt = new Gtk2::Socket; 577\& my $rxvt = new Gtk2::Socket;
561\& $rxvt->signal_connect_after (realize => sub { 578\& $rxvt\->signal_connect_after (realize => sub {
562\& my $xid = $_[0]->window->get_xid; 579\& my $xid = $_[0]\->window\->get_xid;
563\& system "@@RXVT_NAME@@ -embed $xid &"; 580\& system "@@RXVT_NAME@@ \-embed $xid &";
564\& }); 581\& });
565.Ve 582.Ve
566.IP "\fB\-pty\-fd\fR \fIfile descriptor\fR" 4 583.IP "\fB\-pty\-fd\fR \fIfile descriptor\fR" 4
567.IX Item "-pty-fd file descriptor" 584.IX Item "-pty-fd file descriptor"
568Tells @@RXVT_NAME@@ \s-1NOT\s0 to execute any commands or create a new pty/tty 585Tells @@RXVT_NAME@@ \s-1NOT\s0 to execute any commands or create a new pty/tty
… …
582longer example is in \fIdoc/pty\-fd\fR): 599longer example is in \fIdoc/pty\-fd\fR):
583.Sp 600.Sp
584.Vb 2 601.Vb 2
585\& use IO::Pty; 602\& use IO::Pty;
586\& use Fcntl; 603\& use Fcntl;
587.Ve 604\&
588.Sp
589.Vb 4
590\& my $pty = new IO::Pty; 605\& my $pty = new IO::Pty;
591\& fcntl $pty, F_SETFD, 0; # clear close-on-exec 606\& fcntl $pty, F_SETFD, 0; # clear close\-on\-exec
592\& system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&"; 607\& system "@@RXVT_NAME@@ \-pty\-fd " . (fileno $pty) . "&";
593\& close $pty; 608\& close $pty;
594.Ve 609\&
595.Sp
596.Vb 3
597\& # now communicate with rxvt 610\& # now communicate with rxvt
598\& my $slave = $pty->slave; 611\& my $slave = $pty\->slave;
599\& while (<$slave>) { print $slave "got <$_>\en" } 612\& while (<$slave>) { print $slave "got <$_>\en" }
600.Ve 613.Ve
601.IP "\fB\-pe\fR \fIstring\fR" 4 614.IP "\fB\-pe\fR \fIstring\fR" 4
602.IX Item "-pe string" 615.IX Item "-pe string"
603Comma-separated list of perl extension scripts to use (or not to use) in 616Comma-separated list of perl extension scripts to use (or not to use) in
604this terminal instance. See resource \fBperl-ext\fR for details. 617this terminal instance. See resource \fBperl-ext\fR for details.
605.SH "RESOURCES" 618.SH "RESOURCES"
606.IX Header "RESOURCES" 619.IX Header "RESOURCES"
607Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long 620Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long
608options) compiled into your version. All resources are also available as 621options) compiled into your version. All resources are also available as
609long\-options. 622long-options.
610.PP 623.PP
611You can set and change the resources using X11 tools like \fBxrdb\fR. Many 624You can set and change the resources using X11 tools like \fBxrdb\fR. Many
612distribution do also load settings from the \fB~/.Xresources\fR file when X 625distribution do also load settings from the \fB~/.Xresources\fR file when X
613starts. @@RXVT_NAME@@ will consult the following files/resources in order, 626starts. @@RXVT_NAME@@ will consult the following files/resources in order,
614with later settings overwriting earlier ones: 627with later settings overwriting earlier ones:
615.PP 628.PP
616.Vb 6 629.Vb 6
617\& 1. system-wide app-defaults file, either locale-dependent OR global 630\& 1. system\-wide app\-defaults file, either locale\-dependent OR global
618\& 2. app-defaults file in $XAPPLRESDIR 631\& 2. app\-defaults file in $XAPPLRESDIR
619\& 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 632\& 3. RESOURCE_MANAGER property on root\-window OR $HOME/.Xdefaults
620\& 4. SCREEN_RESOURCES for the current screen 633\& 4. SCREEN_RESOURCES for the current screen
621\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 634\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults\-<nodename>
622\& 6. resources specified via -xrm on the commandline 635\& 6. resources specified via \-xrm on the commandline
623.Ve 636.Ve
624.PP 637.PP
625Note that when reading X resources, \fB@@RXVT_NAME@@\fR recognizes two class 638Note that when reading X resources, \fB@@RXVT_NAME@@\fR recognizes two class
626names: \fBRxvt\fR and \fBURxvt\fR. The class name \fBRxvt\fR allows resources 639names: \fBRxvt\fR and \fBURxvt\fR. The class name \fBRxvt\fR allows resources
627common to both \fB@@RXVT_NAME@@\fR and the original \fIrxvt\fR to be easily 640common to both \fB@@RXVT_NAME@@\fR and the original \fIrxvt\fR to be easily
… …
634extensions not documented here): 647extensions not documented here):
635.IP "\fBdepth:\fR \fIbitdepth\fR" 4 648.IP "\fBdepth:\fR \fIbitdepth\fR" 4
636.IX Item "depth: bitdepth" 649.IX Item "depth: bitdepth"
637Compile \fIxft\fR: Attempt to find a visual with the given bit depth; 650Compile \fIxft\fR: Attempt to find a visual with the given bit depth;
638option \fB\-depth\fR. 651option \fB\-depth\fR.
652.IP "\fBbuffered:\fR \fIboolean\fR" 4
653.IX Item "buffered: boolean"
654Compile \fIxft\fR: Turn on/off double-buffering for xft (default enabled).
655On some card/driver combination enabling it slightly decreases
656performance, on most it greatly helps it. The slowdown is small, so it
657should normally be enabled.
639.IP "\fBgeometry:\fR \fIgeom\fR" 4 658.IP "\fBgeometry:\fR \fIgeom\fR" 4
640.IX Item "geometry: geom" 659.IX Item "geometry: geom"
641Create the window with the specified X window geometry [default 80x24]; 660Create the window with the specified X window geometry [default 80x24];
642option \fB\-geometry\fR. 661option \fB\-geometry\fR.
643.IP "\fBbackground:\fR \fIcolour\fR" 4 662.IP "\fBbackground:\fR \fIcolour\fR" 4
… …
771beyond 10 times its original size. The maximum permitted scale is 1000. 790beyond 10 times its original size. The maximum permitted scale is 1000.
772Additional operations can be specified after colon \fB:op1:op2...\fR. 791Additional operations can be specified after colon \fB:op1:op2...\fR.
773Supported operations are: 792Supported operations are:
774.Sp 793.Sp
775.Vb 8 794.Vb 8
776\& tile force background image to be tiled and not scaled. Equivalent to 0x0, 795\& tile force background image to be tiled and not scaled. Equivalent to 0x0
777\& propscale will scale image keeping proportions, 796\& propscale will scale image keeping proportions
778\& auto will scale image to match window size. Equivalent to 100x100; 797\& auto will scale image to match window size. Equivalent to 100x100
779\& hscale will scale image horizontally to the window size; 798\& hscale will scale image horizontally to the window size
780\& vscale will scale image vertically to the window size; 799\& vscale will scale image vertically to the window size
781\& scale will scale image to match window size; 800\& scale will scale image to match window size
782\& root will tile image as if it was a root window background, auto-adjusting 801\& root will tile image as if it was a root window background, auto\-adjusting
783\& whenever terminal window moves. 802\& whenever terminal window moves
784.Ve 803.Ve
785.Sp 804.Sp
786If used in conjunction with \fB\-tr\fR option, the specified pixmap will be 805If used in conjunction with \fB\-tr\fR option, the specified pixmap will be
787blended over transparency image using either alpha\-blending, or any 806blended over transparency image using either alpha-blending, or any
788other blending type, specified with \fB\-blt \*(L"type\*(R"\fR option. 807other blending type, specified with \fB\-blt \*(L"type\*(R"\fR option.
789.IP "\fBpath:\fR \fIpath\fR" 4 808.IP "\fBpath:\fR \fIpath\fR" 4
790.IX Item "path: path" 809.IX Item "path: path"
791Specify the colon-delimited search path for finding background image files. 810Specify the colon-delimited search path for finding background image files.
792.IP "\fBfont:\fR \fIfontlist\fR" 4 811.IP "\fBfont:\fR \fIfontlist\fR" 4
… …
807.Sp 826.Sp
808For example, this font resource 827For example, this font resource
809.Sp 828.Sp
810.Vb 5 829.Vb 5
811\& URxvt.font: 9x15bold,\e 830\& URxvt.font: 9x15bold,\e
812\& -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\e 831\& \-misc\-fixed\-bold\-r\-normal\-\-15\-140\-75\-75\-c\-90\-iso10646\-1,\e
813\& -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \e 832\& \-misc\-fixed\-medium\-r\-normal\-\-15\-140\-75\-75\-c\-90\-iso10646\-1, \e
814\& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e 833\& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e
815\& xft:Code2000:antialias=false 834\& xft:Code2000:antialias=false
816.Ve 835.Ve
817.Sp 836.Sp
818specifies five fonts to be used. The first one is \f(CW\*(C`9x15bold\*(C'\fR (actually 837specifies five fonts to be used. The first one is \f(CW\*(C`9x15bold\*(C'\fR (actually
819the iso8859\-1 version of the second font), which is the base font (because 838the iso8859\-1 version of the second font), which is the base font (because
820it is named first) and thus defines the character cell grid to be 9 pixels 839it is named first) and thus defines the character cell grid to be 9 pixels
821wide and 15 pixels high. 840wide and 15 pixels high.
822.Sp 841.Sp
823The second font is just used to add additional unicode characters not in 842The second font is just used to add additional unicode characters not in
824the base font, likewise the third, which is unfortunately non\-bold, but 843the base font, likewise the third, which is unfortunately non-bold, but
825the bold version of the font does contain less characters, so this is a 844the bold version of the font does contain less characters, so this is a
826useful supplement. 845useful supplement.
827.Sp 846.Sp
828The third font is an Xft font with aliasing turned off, and the characters 847The third font is an Xft font with aliasing turned off, and the characters
829are limited to the \fB\s-1JIS\s0 0208\fR codeset (i.e. japanese kanji). The font 848are limited to the \fB\s-1JIS\s0 0208\fR codeset (i.e. japanese kanji). The font
… …
840.IX Item "boldItalicFont: fontlist" 859.IX Item "boldItalicFont: fontlist"
841.PD 860.PD
842The font list to use for displaying \fBbold\fR, \fIitalic\fR or \fB\f(BIbold 861The font list to use for displaying \fBbold\fR, \fIitalic\fR or \fB\f(BIbold
843italic\fB\fR characters, respectively. 862italic\fB\fR characters, respectively.
844.Sp 863.Sp
845If specified and non\-empty, then the syntax is the same as for the 864If specified and non-empty, then the syntax is the same as for the
846\&\fBfont\fR\-resource, and the given font list will be used as is, which makes 865\&\fBfont\fR\-resource, and the given font list will be used as is, which makes
847it possible to substitute completely different font styles for bold and 866it possible to substitute completely different font styles for bold and
848italic. 867italic.
849.Sp 868.Sp
850If unset (the default), a suitable font list will be synthesized by 869If unset (the default), a suitable font list will be synthesized by
… …
858When font styles are not enabled, or this option is enabled (\fBTrue\fR, 877When font styles are not enabled, or this option is enabled (\fBTrue\fR,
859option \fB\-is\fR, the default), bold/blink font styles imply high 878option \fB\-is\fR, the default), bold/blink font styles imply high
860intensity foreground/background colours. Disabling this option (\fBFalse\fR, 879intensity foreground/background colours. Disabling this option (\fBFalse\fR,
861option \fB+is\fR) disables this behaviour, the high intensity colours are not 880option \fB+is\fR) disables this behaviour, the high intensity colours are not
862reachable. 881reachable.
863.IP "\fBscrollstyle:\fR \fImode\fR" 4
864.IX Item "scrollstyle: mode"
865Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is
866the author's favourite.
867.IP "\fBtitle:\fR \fIstring\fR" 4 882.IP "\fBtitle:\fR \fIstring\fR" 4
868.IX Item "title: string" 883.IX Item "title: string"
869Set window title string, the default title is the command-line 884Set window title string, the default title is the command-line
870specified after the \fB\-e\fR option, if any, otherwise the application 885specified after the \fB\-e\fR option, if any, otherwise the application
871name; option \fB\-title\fR. 886name; option \fB\-title\fR.
… …
894.IP "\fButmpInhibit:\fR \fIboolean\fR" 4 909.IP "\fButmpInhibit:\fR \fIboolean\fR" 4
895.IX Item "utmpInhibit: boolean" 910.IX Item "utmpInhibit: boolean"
896\&\fBTrue\fR: inhibit writing record into the system log file \fButmp\fR; 911\&\fBTrue\fR: inhibit writing record into the system log file \fButmp\fR;
897option \fB\-ut\fR. \fBFalse\fR: write record into the system log file \fButmp\fR 912option \fB\-ut\fR. \fBFalse\fR: write record into the system log file \fButmp\fR
898[default]; option \fB+ut\fR. 913[default]; option \fB+ut\fR.
899.IP "\fBprint\-pipe:\fR \fIstring\fR" 4 914.IP "\fBprint-pipe:\fR \fIstring\fR" 4
900.IX Item "print-pipe: string" 915.IX Item "print-pipe: string"
901Specify a command pipe for vt100 printer [default \fI\fIlpr\fI\|(1)\fR]. Use 916Specify a command pipe for vt100 printer [default \fI\fIlpr\fI\|(1)\fR]. Use
902\&\fBPrint\fR to initiate a screen dump to the printer and \fBCtrl-Print\fR or 917\&\fBPrint\fR to initiate a screen dump to the printer and \fBCtrl-Print\fR or
903\&\fBShift-Print\fR to include the scrollback as well. 918\&\fBShift-Print\fR to include the scrollback as well.
904.Sp 919.Sp
905The string will be interpreted as if typed into the shell as\-is. 920The string will be interpreted as if typed into the shell as-is.
906.Sp 921.Sp
907Example: 922Example:
908.Sp 923.Sp
909.Vb 1 924.Vb 1
910\& URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 925\& URxvt.print\-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
911.Ve 926.Ve
912.Sp 927.Sp
913This creates a new file in your home directory with the screen contents 928This creates a new file in your home directory with the screen contents
914every time you hit \f(CW\*(C`Print\*(C'\fR. 929every time you hit \f(CW\*(C`Print\*(C'\fR.
930.IP "\fBscrollstyle:\fR \fImode\fR" 4
931.IX Item "scrollstyle: mode"
932Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is
933the author's favourite.
915.IP "\fBscrollBar:\fR \fIboolean\fR" 4 934.IP "\fBscrollBar:\fR \fIboolean\fR" 4
916.IX Item "scrollBar: boolean" 935.IX Item "scrollBar: boolean"
917\&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR: 936\&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR:
918disable the scrollbar; option \fB+sb\fR. 937disable the scrollbar; option \fB+sb\fR.
919.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4 938.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4
… …
1064\&\fIwrite\fR\|(1) or any other means. Therefore, these sequences are disabled by 1083\&\fIwrite\fR\|(1) or any other means. Therefore, these sequences are disabled by
1065default. (Note that many other terminals, including xterm, have these 1084default. (Note that many other terminals, including xterm, have these
1066sequences enabled by default, which doesn't make it safer, though). 1085sequences enabled by default, which doesn't make it safer, though).
1067.Sp 1086.Sp
1068You can enable them by setting this boolean resource or specifying 1087You can enable them by setting this boolean resource or specifying
1069\&\fB\-insecure\fR as an option. At the moment, this enables display\-answer, 1088\&\fB\-insecure\fR as an option. At the moment, this enables display-answer,
1070locale, findfont, icon label and window title requests. 1089locale, findfont, icon label and window title requests.
1071.IP "\fBmodifier:\fR \fImodifier\fR" 4 1090.IP "\fBmodifier:\fR \fImodifier\fR" 4
1072.IX Item "modifier: modifier" 1091.IX Item "modifier: modifier"
1073Set the key to be interpreted as the Meta key to: \fBalt\fR, \fBmeta\fR, 1092Set the key to be interpreted as the Meta key to: \fBalt\fR, \fBmeta\fR,
1074\&\fBhyper\fR, \fBsuper\fR, \fBmod1\fR, \fBmod2\fR, \fBmod3\fR, \fBmod4\fR, \fBmod5\fR; option 1093\&\fBhyper\fR, \fBsuper\fR, \fBmod1\fR, \fBmod2\fR, \fBmod3\fR, \fBmod4\fR, \fBmod5\fR; option
1075\&\fB\-mod\fR. 1094\&\fB\-mod\fR.
1076.IP "\fBanswerbackString:\fR \fIstring\fR" 4 1095.IP "\fBanswerbackString:\fR \fIstring\fR" 4
1077.IX Item "answerbackString: string" 1096.IX Item "answerbackString: string"
1078Specify the reply rxvt-unicode sends to the shell when an \s-1ENQ\s0 (control\-E) 1097Specify the reply rxvt-unicode sends to the shell when an \s-1ENQ\s0 (control-E)
1079character is passed through. It may contain escape values as described 1098character is passed through. It may contain escape values as described
1080in the entry on \fBkeysym\fR following. 1099in the entry on \fBkeysym\fR following.
1081.IP "\fBsecondaryScreen:\fR \fIboolean\fR" 4 1100.IP "\fBsecondaryScreen:\fR \fIboolean\fR" 4
1082.IX Item "secondaryScreen: boolean" 1101.IX Item "secondaryScreen: boolean"
1083Turn on/off secondary screen (default enabled). 1102Turn on/off secondary screen (default enabled).
1084.IP "\fBsecondaryScroll:\fR \fIboolean\fR" 4 1103.IP "\fBsecondaryScroll:\fR \fIboolean\fR" 4
1085.IX Item "secondaryScroll: boolean" 1104.IX Item "secondaryScroll: boolean"
1086Turn on/off secondary screen scroll (default enabled). If this 1105Turn on/off secondary screen scroll (default enabled). If this
1087option is enabled, scrolls on the secondary screen will change the 1106option is enabled, scrolls on the secondary screen will change the
1088scrollback buffer and switching to/from the secondary screen will 1107scrollback buffer and, when secondaryScreen is off, switching
1089instead scroll the screen up. 1108to/from the secondary screen will instead scroll the screen up.
1090.IP "\fBhold\fR: \fIboolean\fR" 4 1109.IP "\fBhold\fR: \fIboolean\fR" 4
1091.IX Item "hold: boolean" 1110.IX Item "hold: boolean"
1092Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1111Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1093will not immediately destroy its window when the program executed within 1112will not immediately destroy its window when the program executed within
1094it exits. Instead, it will wait till it is being killed or closed by the 1113it exits. Instead, it will wait till it is being killed or closed by the
1095user. 1114user.
1115.IP "\fBchdir\fR: \fIpath\fR" 4
1116.IX Item "chdir: path"
1117Sets the working directory for the shell (or the command specified via
1118\&\fB\-e\fR). The \fIpath\fR must be an absolute path and it must exist for
1119@@RXVT_NAME@@ to start. If it isn't specified then the current working
1120directory will be used; option \fB\-cd\fR.
1096.IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4 1121.IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4
1097.IX Item "keysym.sym: string" 1122.IX Item "keysym.sym: string"
1098Compile \fIfrills\fR: Associate \fIstring\fR with keysym \fIsym\fR. The 1123Compile \fIfrills\fR: Associate \fIstring\fR with keysym \fIsym\fR. The
1099intervening resource name \fBkeysym.\fR cannot be omitted. 1124intervening resource name \fBkeysym.\fR cannot be omitted.
1100.Sp 1125.Sp
… …
1123should be a character not used by the strings. 1148should be a character not used by the strings.
1124.Sp 1149.Sp
1125Its usage can be demonstrated by an example: 1150Its usage can be demonstrated by an example:
1126.Sp 1151.Sp
1127.Vb 1 1152.Vb 1
1128\& URxvt.keysym.M-C-0x61: list|\e033<M-C-|abc|> 1153\& URxvt.keysym.M\-C\-0x61: list|\e033<M\-C\-|abc|>
1129.Ve 1154.Ve
1130.Sp 1155.Sp
1131The above line is equivalent to the following three lines: 1156The above line is equivalent to the following three lines:
1132.Sp 1157.Sp
1133.Vb 3 1158.Vb 3
1134\& URxvt.keysym.Meta-Control-0x61: \e033<M-C-a> 1159\& URxvt.keysym.Meta\-Control\-0x61: \e033<M\-C\-a>
1135\& URxvt.keysym.Meta-Control-0x62: \e033<M-C-b> 1160\& URxvt.keysym.Meta\-Control\-0x62: \e033<M\-C\-b>
1136\& URxvt.keysym.Meta-Control-0x63: \e033<M-C-c> 1161\& URxvt.keysym.Meta\-Control\-0x63: \e033<M\-C\-c>
1137.Ve 1162.Ve
1138.Sp 1163.Sp
1139If \fIstring\fR takes the form of \f(CW\*(C`command:STRING\*(C'\fR, the specified \fB\s-1STRING\s0\fR 1164If \fIstring\fR takes the form of \f(CW\*(C`command:STRING\*(C'\fR, the specified \fB\s-1STRING\s0\fR
1140is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1165is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1141example the following means "change the current locale to \f(CW\*(C`zh_CN.GBK\*(C'\fR 1166example the following means "change the current locale to \f(CW\*(C`zh_CN.GBK\*(C'\fR
1142when Control-Meta-c is being pressed": 1167when Control-Meta-c is being pressed":
1143.Sp 1168.Sp
1144.Vb 1 1169.Vb 1
1145\& URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007 1170\& URxvt.keysym.M\-C\-c: command:\e033]701;zh_CN.GBK\e007
1146.Ve 1171.Ve
1147.Sp 1172.Sp
1148If \fIstring\fR takes the form \f(CW\*(C`perl:STRING\*(C'\fR, then the specified \fB\s-1STRING\s0\fR 1173If \fIstring\fR takes the form \f(CW\*(C`perl:STRING\*(C'\fR, then the specified \fB\s-1STRING\s0\fR
1149is passed to the \f(CW\*(C`on_keyboard_command\*(C'\fR perl handler. See the @@RXVT_NAME@@\fIperl\fR\|(3) 1174is passed to the \f(CW\*(C`on_keyboard_command\*(C'\fR perl handler. See the @@RXVT_NAME@@\fIperl\fR\|(3)
1150manpage. For example, the \fIselection\fR extension (activated via 1175manpage. For example, the \fIselection\fR extension (activated via
1151\&\f(CW\*(C`@@RXVT_NAME@@ \-pe selection\*(C'\fR) listens for \f(CW\*(C`selection:rot13\*(C'\fR events: 1176\&\f(CW\*(C`@@RXVT_NAME@@ \-pe selection\*(C'\fR) listens for \f(CW\*(C`selection:rot13\*(C'\fR events:
1152.Sp 1177.Sp
1153.Vb 1 1178.Vb 1
1154\& URxvt.keysym.M-C-c: perl:selection:rot13 1179\& URxvt.keysym.M\-C\-c: perl:selection:rot13
1155.Ve 1180.Ve
1156.Sp 1181.Sp
1157Due the the large number of modifier combinations, a defined key mapping 1182Due the the large number of modifier combinations, a defined key mapping
1158will match if at \fIat least\fR the specified identifiers are being set, and 1183will match if at \fIat least\fR the specified identifiers are being set, and
1159no other key mappings with those and more bits are being defined. That 1184no other key mappings with those and more bits are being defined. That
… …
1166\&\f(CW\*(C`Shift\-Insert\*(C'\fR mapping. To re-enable that, you can poke \*(L"holes\*(R" into the 1191\&\f(CW\*(C`Shift\-Insert\*(C'\fR mapping. To re-enable that, you can poke \*(L"holes\*(R" into the
1167user-defined keymap using the \f(CW\*(C`builtin:\*(C'\fR replacement: 1192user-defined keymap using the \f(CW\*(C`builtin:\*(C'\fR replacement:
1168.Sp 1193.Sp
1169.Vb 2 1194.Vb 2
1170\& URxvt.keysym.Insert: <my insert key sequence> 1195\& URxvt.keysym.Insert: <my insert key sequence>
1171\& URxvt.keysym.S-Insert: builtin: 1196\& URxvt.keysym.S\-Insert: builtin:
1172.Ve 1197.Ve
1173.Sp 1198.Sp
1174The first line defines a mapping for \f(CW\*(C`Insert\*(C'\fR and \fIany\fR combination 1199The first line defines a mapping for \f(CW\*(C`Insert\*(C'\fR and \fIany\fR combination
1175of modifiers. The second line re-establishes the default mapping for 1200of modifiers. The second line re-establishes the default mapping for
1176\&\f(CW\*(C`Shift\-Insert\*(C'\fR. 1201\&\f(CW\*(C`Shift\-Insert\*(C'\fR.
… …
1178The following example will map Control\-Meta\-1 and Control\-Meta\-2 to 1203The following example will map Control\-Meta\-1 and Control\-Meta\-2 to
1179the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited 1204the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited
1180font-switching at runtime: 1205font-switching at runtime:
1181.Sp 1206.Sp
1182.Vb 2 1207.Vb 2
1183\& URxvt.keysym.M-C-1: command:\e033]50;suxuseuro\e007 1208\& URxvt.keysym.M\-C\-1: command:\e033]50;suxuseuro\e007
1184\& URxvt.keysym.M-C-2: command:\e033]50;9x15bold\e007 1209\& URxvt.keysym.M\-C\-2: command:\e033]50;9x15bold\e007
1185.Ve 1210.Ve
1186.Sp 1211.Sp
1187Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1212Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1188info): 1213info):
1189.Sp 1214.Sp
1190.Vb 2 1215.Vb 2
1191\& URxvt.keysym.M-C-3: command:\e033[8;25;80t 1216\& URxvt.keysym.M\-C\-3: command:\e033[8;25;80t
1192\& URxvt.keysym.M-C-4: command:\e033[8;48;110t 1217\& URxvt.keysym.M\-C\-4: command:\e033[8;48;110t
1193.Ve 1218.Ve
1194.IP "\fBperl-ext-common\fR: \fIstring\fR" 4 1219.IP "\fBperl-ext-common\fR: \fIstring\fR" 4
1195.IX Item "perl-ext-common: string" 1220.IX Item "perl-ext-common: string"
1196.PD 0 1221.PD 0
1197.IP "\fBperl-ext\fR: \fIstring\fR" 4 1222.IP "\fBperl-ext\fR: \fIstring\fR" 4
… …
1235See the @@RXVT_NAME@@\fIperl\fR\|(3) manpage. 1260See the @@RXVT_NAME@@\fIperl\fR\|(3) manpage.
1236.IP "\fBselection.pattern\-\f(BIidx\fB\fR: \fIperl-regex\fR" 4 1261.IP "\fBselection.pattern\-\f(BIidx\fB\fR: \fIperl-regex\fR" 4
1237.IX Item "selection.pattern-idx: perl-regex" 1262.IX Item "selection.pattern-idx: perl-regex"
1238Additional selection patterns, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage for 1263Additional selection patterns, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage for
1239details. 1264details.
1240.IP "\fBselection\-autotransform.\f(BIidx\fB\fR: \fIperl-transform\fR" 4 1265.IP "\fBselection-autotransform.\f(BIidx\fB\fR: \fIperl-transform\fR" 4
1241.IX Item "selection-autotransform.idx: perl-transform" 1266.IX Item "selection-autotransform.idx: perl-transform"
1242Selection auto-transform patterns, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage 1267Selection auto-transform patterns, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage
1243for details. 1268for details.
1244.IP "\fBsearchable\-scrollback:\fR \fIkeysym\fR" 4 1269.IP "\fBsearchable-scrollback:\fR \fIkeysym\fR" 4
1245.IX Item "searchable-scrollback: keysym" 1270.IX Item "searchable-scrollback: keysym"
1246Sets the hotkey that starts the incremental scrollback buffer search 1271Sets the hotkey that starts the incremental scrollback buffer search
1247(default: \f(CW\*(C`M\-s\*(C'\fR). 1272(default: \f(CW\*(C`M\-s\*(C'\fR).
1248.IP "\fBurlLauncher\fR: \fIstring\fR" 4 1273.IP "\fBurlLauncher\fR: \fIstring\fR" 4
1249.IX Item "urlLauncher: string" 1274.IX Item "urlLauncher: string"
… …
1308Pressing \fBShift-Insert\fR causes the value of the \s-1PRIMARY\s0 selection to be 1333Pressing \fBShift-Insert\fR causes the value of the \s-1PRIMARY\s0 selection to be
1309inserted too. 1334inserted too.
1310.SH "CHANGING FONTS" 1335.SH "CHANGING FONTS"
1311.IX Header "CHANGING FONTS" 1336.IX Header "CHANGING FONTS"
1312Changing fonts (or font sizes, respectively) via the keypad is not yet 1337Changing fonts (or font sizes, respectively) via the keypad is not yet
1313supported in rxvt\-unicode. Bug me if you need this. 1338supported in rxvt-unicode. Bug me if you need this.
1314.PP 1339.PP
1315You can, however, switch fonts at runtime using escape sequences, e.g.: 1340You can, however, switch fonts at runtime using escape sequences, e.g.:
1316.PP 1341.PP
1317.Vb 1 1342.Vb 1
1318\& printf '\ee]710;%s\e007' "9x15bold,xft:Kochi Gothic" 1343\& printf \*(Aq\ee]710;%s\e007\*(Aq "9x15bold,xft:Kochi Gothic"
1319.Ve 1344.Ve
1320.PP 1345.PP
1321You can use keyboard shortcuts, too: 1346You can use keyboard shortcuts, too:
1322.PP 1347.PP
1323.Vb 2 1348.Vb 2
1324\& URxvt.keysym.M-C-1: command:\e033]710;suxuseuro\e007\e033]711;suxuseuro\e007 1349\& URxvt.keysym.M\-C\-1: command:\e033]710;suxuseuro\e007\e033]711;suxuseuro\e007
1325\& URxvt.keysym.M-C-2: command:\e033]710;9x15bold\e007\e033]711;9x15bold\e007 1350\& URxvt.keysym.M\-C\-2: command:\e033]710;9x15bold\e007\e033]711;9x15bold\e007
1326.Ve 1351.Ve
1327.PP 1352.PP
1328rxvt-unicode will automatically re-apply these fonts to the output so far. 1353rxvt-unicode will automatically re-apply these fonts to the output so far.
1329.SH "ISO 14755 SUPPORT" 1354.SH "ISO 14755 SUPPORT"
1330.IX Header "ISO 14755 SUPPORT" 1355.IX Header "ISO 14755 SUPPORT"
1331\&\s-1ISO\s0 14755 is a standard for entering and viewing unicode characters 1356\&\s-1ISO\s0 14755 is a standard for entering and viewing unicode characters
1332and character codes using the keyboard. It consists of 4 parts. The 1357and character codes using the keyboard. It consists of 4 parts. The
1333first part is available if rxvt-unicode has been compiled with 1358first part is available if rxvt-unicode has been compiled with
1334\&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, the rest is available when rxvt-unicode was compiled 1359\&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, the rest is available when rxvt-unicode was compiled
1335with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR. 1360with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR.
1361.IP "\(bu" 4
1336.IP "* 5.1: Basic method" 4 13625.1: Basic method
1337.IX Item "5.1: Basic method" 1363.Sp
1338This allows you to enter unicode characters using their hexcode. 1364This allows you to enter unicode characters using their hexcode.
1339.Sp 1365.Sp
1340Start by pressing and holding both \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, then enter 1366Start by pressing and holding both \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, then enter
1341hex-digits (between one and six). Releasing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR will 1367hex-digits (between one and six). Releasing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR will
1342commit the character as if it were typed directly. While holding down 1368commit the character as if it were typed directly. While holding down
… …
1347As an example of use, imagine a business card with a japanese e\-mail 1373As an example of use, imagine a business card with a japanese e\-mail
1348address, which you cannot type. Fortunately, the card has the e\-mail 1374address, which you cannot type. Fortunately, the card has the e\-mail
1349address printed as hexcodes, e.g. \f(CW\*(C`671d 65e5\*(C'\fR. You can enter this easily 1375address printed as hexcodes, e.g. \f(CW\*(C`671d 65e5\*(C'\fR. You can enter this easily
1350by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, followed by \f(CW\*(C`6\-7\-1\-D\-SPACE\-6\-5\-E\-5\*(C'\fR, 1376by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, followed by \f(CW\*(C`6\-7\-1\-D\-SPACE\-6\-5\-E\-5\*(C'\fR,
1351followed by releasing the modifier keys. 1377followed by releasing the modifier keys.
1378.IP "\(bu" 4
1352.IP "* 5.2: Keyboard symbols entry method" 4 13795.2: Keyboard symbols entry method
1353.IX Item "5.2: Keyboard symbols entry method" 1380.Sp
1354This mode lets you input characters representing the keycap symbols of 1381This mode lets you input characters representing the keycap symbols of
1355your keyboard, if representable in the current locale encoding. 1382your keyboard, if representable in the current locale encoding.
1356.Sp 1383.Sp
1357Start by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then releasing 1384Start by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then releasing
1358them. The next special key (cursor keys, home etc.) you enter will not 1385them. The next special key (cursor keys, home etc.) you enter will not
1359invoke its usual function but instead will insert the corresponding 1386invoke its usual function but instead will insert the corresponding
1360keycap symbol. The symbol will only be entered when the key has been 1387keycap symbol. The symbol will only be entered when the key has been
1361released, otherwise pressing e.g. \f(CW\*(C`Shift\*(C'\fR would enter the symbol for 1388released, otherwise pressing e.g. \f(CW\*(C`Shift\*(C'\fR would enter the symbol for
1362\&\f(CW\*(C`ISO Level 2 Switch\*(C'\fR, although your intention might have been to enter a 1389\&\f(CW\*(C`ISO Level 2 Switch\*(C'\fR, although your intention might have been to enter a
1363reverse tab (Shift\-Tab). 1390reverse tab (Shift-Tab).
1391.IP "\(bu" 4
1364.IP "* 5.3: Screen-selection entry method" 4 13925.3: Screen-selection entry method
1365.IX Item "5.3: Screen-selection entry method" 1393.Sp
1366While this is implemented already (it's basically the selection 1394While this is implemented already (it's basically the selection
1367mechanism), it could be extended by displaying a unicode character map. 1395mechanism), it could be extended by displaying a unicode character map.
1396.IP "\(bu" 4
1368.IP "* 5.4: Feedback method for identifying displayed characters for later input" 4 13975.4: Feedback method for identifying displayed characters for later input
1369.IX Item "5.4: Feedback method for identifying displayed characters for later input" 1398.Sp
1370This method lets you display the unicode character code associated with 1399This method lets you display the unicode character code associated with
1371characters already displayed. 1400characters already displayed.
1372.Sp 1401.Sp
1373You enter this mode by holding down \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then 1402You enter this mode by holding down \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then
1374pressing and holding the left mouse button and moving around. The unicode 1403pressing and holding the left mouse button and moving around. The unicode
… …
1413color14 (bright cyan) = Cyan 1442color14 (bright cyan) = Cyan
1414color15 (bright white) = White 1443color15 (bright white) = White
1415foreground = Black 1444foreground = Black
1416background = White 1445background = White
1417.TE 1446.TE
1418
1419.PP 1447.PP
1420It is also possible to specify the colour values of \fBforeground\fR, 1448It is also possible to specify the colour values of \fBforeground\fR,
1421\&\fBbackground\fR, \fBcursorColor\fR, \fBcursorColor2\fR, \fBcolorBD\fR, \fBcolorUL\fR as 1449\&\fBbackground\fR, \fBcursorColor\fR, \fBcursorColor2\fR, \fBcolorBD\fR, \fBcolorUL\fR as
1422a number 0\-15, as a convenient shorthand to reference the colour name of 1450a number 0\-15, as a convenient shorthand to reference the colour name of
1423color0\-color15. 1451color0\-color15.
… …
1440would yield White on Black, while on \fIxterm\fR(1) it would yield Black 1468would yield White on Black, while on \fIxterm\fR(1) it would yield Black
1441on White. 1469on White.
1442.Sh "\s-1ALPHA\s0 \s-1CHANNEL\s0 \s-1SUPPORT\s0" 1470.Sh "\s-1ALPHA\s0 \s-1CHANNEL\s0 \s-1SUPPORT\s0"
1443.IX Subsection "ALPHA CHANNEL SUPPORT" 1471.IX Subsection "ALPHA CHANNEL SUPPORT"
1444If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1472If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1445their act together, rxvt-unicode will support \f(CW\*(C`rgba:rrrr/gggg/bbbb/aaaa\*(C'\fR 1473their act together, rxvt-unicode will do it's own alpha channel management:
1446(recommended, but \fB\s-1MUST\s0\fR have 4 digits/component) colour specifications, 1474.PP
1447in addition to the ones provided by X, where the additional A component 1475You can prefix any color with an opaquenes percentage enclosed in
1476brackets, i.e. \f(CW\*(C`[percent]\*(C'\fR, where \f(CW\*(C`percent\*(C'\fR is a decimal percentage
1477(0\-100) that specifies the opacity of the color, where \f(CW0\fR is completely
1478transparent and \f(CW100\fR is completely opaque. For example, \f(CW\*(C`[50]red\*(C'\fR is a
1479half-transparent red, while \f(CW\*(C`[95]#00ff00\*(C'\fR is an almost opaque green. This
1480is the recommended format to specify transparency values, and works with
1481all ways to specify a colour.
1482.PP
1483For complete control, rxvt-unicode also supports
1484\&\f(CW\*(C`rgba:rrrr/gggg/bbbb/aaaa\*(C'\fR (exactly four hex digits/component) colour
1485specifications, where the additional \f(CW\*(C`aaaa\*(C'\fR component specifies opacity
1448specifies opacity (alpha) values. The minimum value of \f(CW0\fR is completely 1486(alpha) values. The minimum value of \f(CW0000\fR is completely transparent,
1449transparent). You can also prefix any color with \f(CW\*(C`[percent]\*(C'\fR, where 1487while \f(CW\*(C`ffff\*(C'\fR is completely opaque). The two example colours from
1450\&\f(CW\*(C`percent\*(C'\fR is a decimal percentage (0\-100) that specifies the opacity of 1488earlier could also be specified as \f(CW\*(C`rgba:ff00/0000/0000/8000\*(C'\fR and
1451the color, where \f(CW0\fR is completely transparent and \f(CW100\fR is completelxy 1489\&\f(CW\*(C`rgba:0000/ff00/0000/f332\*(C'\fR.
1452opaque.
1453.PP 1490.PP
1454You probably need to specify \fB\*(L"\-depth 32\*(R"\fR, too, and have the luck that 1491You probably need to specify \fB\*(L"\-depth 32\*(R"\fR, too, to force a visual with
1455your X\-server uses \s-1ARGB\s0 pixel layout, as X is far from just supporting 1492alpha channels, and have the luck that your X\-server uses \s-1ARGB\s0 pixel
1456\&\s-1ARGB\s0 visuals out of the box, and rxvt-unicode just fudges around. 1493layout, as X is far from just supporting \s-1ARGB\s0 visuals out of the box, and
1494rxvt-unicode just fudges around.
1457.PP 1495.PP
1458For example, the following selects an almost completely transparent red 1496For example, the following selects an almost completely transparent black
1459background, and an almost opaque pink foreground: 1497background, and an almost opaque pink foreground:
1460.PP 1498.PP
1461.Vb 1 1499.Vb 1
1462\& @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" 1500\& @@RXVT_NAME@@ \-depth 32 \-bg rgba:0000/0000/0000/4444 \-fg "[80]pink"
1463.Ve 1501.Ve
1464.PP 1502.PP
1465\&\fIPlease note that transparency of any kind if completely unsupported by 1503When not using a background image, then the interpretation of the
1466the author. Don't bug him with installation questions!\fR 1504alpha channel is up to your compositing manager (most interpret it as
1505transparency of course).
1506.PP
1507When using a background pixmap or pseudo-transparency, then the background
1508colour will always behave as if it were completely transparent (so the
1509background image shows instead), regardless of how it was specified, while
1510other colours will either be transparent as specified (the background
1511image will show through) on servers supporting the \s-1RENDER\s0 extension, or
1512fully opaque on servers not supporting the \s-1RENDER\s0 \s-1EXTENSION\s0.
1513.PP
1514Please note that due to bugs in Xft, specifying alpha values might result
1515in garbage being displayed when the X\-server does not support the \s-1RENDER\s0
1516extension.
1467.SH "ENVIRONMENT" 1517.SH "ENVIRONMENT"
1468.IX Header "ENVIRONMENT" 1518.IX Header "ENVIRONMENT"
1469\&\fB@@RXVT_NAME@@\fR sets and/or uses the following environment variables: 1519\&\fB@@RXVT_NAME@@\fR sets and/or uses the following environment variables:
1470.IP "\fB\s-1TERM\s0\fR" 4 1520.IP "\fB\s-1TERM\s0\fR" 4
1471.IX Item "TERM" 1521.IX Item "TERM"
… …
1496Set to the terminfo directory iff @@RXVT_NAME@@ was configured with 1546Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1497\&\f(CW\*(C`\-\-with\-terminfo=PATH\*(C'\fR. 1547\&\f(CW\*(C`\-\-with\-terminfo=PATH\*(C'\fR.
1498.IP "\fB\s-1DISPLAY\s0\fR" 4 1548.IP "\fB\s-1DISPLAY\s0\fR" 4
1499.IX Item "DISPLAY" 1549.IX Item "DISPLAY"
1500Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1550Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1501display in its child processes. 1551display in its child processes if \f(CW\*(C`\-display\*(C'\fR isn't used to override. It
1552defaults to \f(CW\*(C`:0\*(C'\fR if it doesn't exist.
1502.IP "\fB\s-1SHELL\s0\fR" 4 1553.IP "\fB\s-1SHELL\s0\fR" 4
1503.IX Item "SHELL" 1554.IX Item "SHELL"
1504The shell to be used for command execution, defaults to \f(CW\*(C`/bin/sh\*(C'\fR. 1555The shell to be used for command execution, defaults to \f(CW\*(C`/bin/sh\*(C'\fR.
1505.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4 1556.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4
1506.IX Item "RXVT_SOCKET" 1557.IX Item "RXVT_SOCKET"
1507The unix domain socket path used by @@RXVT_NAME@@c(1) and 1558The unix domain socket path used by @@RXVT_NAME@@c(1) and
1508@@RXVT_NAME@@d(1). 1559@@RXVT_NAME@@d(1).
1509.Sp 1560.Sp
1510Default \fI$HOME/.rxvt\-unicode\-\fI<nodename\fI\fR. 1561Default \fI\f(CI$HOME\fI/.rxvt\-unicode\-\fI<nodename\fI\fR.
1511.IP "\fB\s-1HOME\s0\fR" 4 1562.IP "\fB\s-1HOME\s0\fR" 4
1512.IX Item "HOME" 1563.IX Item "HOME"
1513Used to locate the default directory for the unix domain socket for 1564Used to locate the default directory for the unix domain socket for
1514daemon communications and to locate various resource files (such as 1565daemon communications and to locate various resource files (such as
1515\&\f(CW\*(C`.Xdefaults\*(C'\fR) 1566\&\f(CW\*(C`.Xdefaults\*(C'\fR)
… …
1556Project Coordinator (changes.txt 2.21a to 2.4.5) 1607Project Coordinator (changes.txt 2.21a to 2.4.5)
1557.IP "Geoff Wing <gcw@pobox.com>" 4 1608.IP "Geoff Wing <gcw@pobox.com>" 4
1558.IX Item "Geoff Wing <gcw@pobox.com>" 1609.IX Item "Geoff Wing <gcw@pobox.com>"
1559Rewrote screen display and text selection routines. 1610Rewrote screen display and text selection routines.
1560.Sp 1611.Sp
1561Project Coordinator (changes.txt 2.4.6 \- rxvt\-unicode) 1612Project Coordinator (changes.txt 2.4.6 \- rxvt-unicode)
1562.IP "Marc Alexander Lehmann <rxvt\-unicode@schmorp.de>" 4 1613.IP "Marc Alexander Lehmann <rxvt\-unicode@schmorp.de>" 4
1563.IX Item "Marc Alexander Lehmann <rxvt-unicode@schmorp.de>" 1614.IX Item "Marc Alexander Lehmann <rxvt-unicode@schmorp.de>"
1564Forked rxvt\-unicode, unicode support, rewrote almost all the code, perl 1615Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1565extension, random hacks, numerous bugfixes and extensions. 1616extension, random hacks, numerous bugfixes and extensions.
1566.Sp 1617.Sp
1567Project Coordinator (Changes 1.0 \-) 1618Project Coordinator (Changes 1.0 \-)
1568.IP "Emanuele Giaquinta <e.giaquinta@glauco.it>" 4 1619.IP "Emanuele Giaquinta <e.giaquinta@glauco.it>" 4
1569.IX Item "Emanuele Giaquinta <e.giaquinta@glauco.it>" 1620.IX Item "Emanuele Giaquinta <e.giaquinta@glauco.it>"

Diff Legend

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