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.69 by root, Wed Aug 1 18:38:15 2007 UTC vs.
Revision 1.70 by sasha, Fri Oct 26 18:27:29 2007 UTC

1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
2.\" 2.\"
3.\" Standard preamble: 3.\" Standard preamble:
4.\" ======================================================================== 4.\" ========================================================================
5.de Sh \" Subsection heading 5.de Sh \" Subsection heading
6.br 6.br
… …
127.\} 127.\}
128.rm #[ #] #H #V #F C 128.rm #[ #] #H #V #F C
129.\" ======================================================================== 129.\" ========================================================================
130.\" 130.\"
131.IX Title "@@RXVT_NAME@@ 1" 131.IX Title "@@RXVT_NAME@@ 1"
132.TH @@RXVT_NAME@@ 1 "2007-08-01" "8.3" "RXVT-UNICODE" 132.TH @@RXVT_NAME@@ 1 "2007-10-26" "8.3" "RXVT-UNICODE"
133.SH "NAME" 133.SH "NAME"
134rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system) 134rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system)
135.SH "SYNOPSIS" 135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
137\&\fB@@RXVT_NAME@@\fR [options] [\-e command [ args ]] 137\&\fB@@RXVT_NAME@@\fR [options] [\-e command [ args ]]
… …
153Unlike the original rxvt, \fBrxvt-unicode\fR stores all text in Unicode 153Unlike the original rxvt, \fBrxvt-unicode\fR stores all text in Unicode
154internally. That means it can store and display most scripts in the 154internally. That means it can store and display most scripts in the
155world. Being a terminal emulator, however, some things are very difficult, 155world. Being a terminal emulator, however, some things are very difficult,
156especially cursive scripts such as arabic, vertically written scripts 156especially cursive scripts such as arabic, vertically written scripts
157like mongolian or scripts requiring extremely complex combining rules, 157like mongolian or scripts requiring extremely complex combining rules,
158like tibetan or devenagari. Don't expect pretty output when using these 158like tibetan or devanagari. Don't expect pretty output when using these
159scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 159scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
160fine, though. A somewhat difficult case are right-to-left scripts, such 160fine, though. A somewhat difficult case are right-to-left scripts, such
161as hebrew: \fBrxvt-unicode\fR adopts the view that bidirectional algorithms 161as hebrew: \fBrxvt-unicode\fR adopts the view that bidirectional algorithms
162belong into the application, not the terminal emulator (too many things \*(-- 162belong into the application, not the terminal emulator (too many things \*(--
163such as cursor-movement while editing \*(-- break otherwise), but that might 163such as cursor-movement while editing \*(-- break otherwise), but that might
… …
230.IX Item "-j|+j" 230.IX Item "-j|+j"
231Turn on/off jump scrolling (allow multiple lines per refresh); resource \fBjumpScroll\fR. 231Turn on/off jump scrolling (allow multiple lines per refresh); resource \fBjumpScroll\fR.
232.IP "\fB\-ss\fR|\fB+ss\fR" 4 232.IP "\fB\-ss\fR|\fB+ss\fR" 4
233.IX Item "-ss|+ss" 233.IX Item "-ss|+ss"
234Turn on/off skip scrolling (allow multiple screens per refresh); resource \fBskipScroll\fR. 234Turn on/off skip scrolling (allow multiple screens per refresh); resource \fBskipScroll\fR.
235.IP "\fB\-ip\fR|\fB+ip\fR | \fB\-tr\fR|\fB+tr\fR" 4 235.IP "\fB\-tr\fR|\fB+tr\fR" 4
236.IX Item "-ip|+ip | -tr|+tr" 236.IX Item "-tr|+tr"
237Turn on/off inheriting parent window's pixmap. Alternative form is 237Turn on/off illusion of a transparent window background. Obsolete form of it is
238\&\fB\-tr\fR; resource \fBinheritPixmap\fR. 238\&\fB\-ip\fR and it should not be used anymore; resource \fBtransparent\fR.
239.Sp 239.Sp
240\&\fIPlease note that transparency of any kind if completely unsupported by 240\&\fIPlease note that old resource name of \f(BIinheritPixmap\fI is obsolete and should be
241the author. Don't bug him with installation questions! Read the \s-1FAQ\s0 (man 7 241changed to \f(BItransparent\fI. Backwards compatibility support for \f(BIinheritPixmap\fI will
242@@RXVT_NAME@@)!\fR 242be phased out in future versions of rxvt!\fR
243.Sp
244\&\fIPlease address all transparency related issues to Sasha Vasko at
245sasha@aftercode.net. Read the \s-1FAQ\s0 (man 7 @@RXVT_NAME@@)!\fR
243.IP "\fB\-fade\fR \fInumber\fR" 4 246.IP "\fB\-fade\fR \fInumber\fR" 4
244.IX Item "-fade number" 247.IX Item "-fade number"
245Fade the text by the given percentage when focus is lost. Small values 248Fade the text by the given percentage when focus is lost. Small values
246fade a little only, 100 completely replaces all colours by the fade 249fade a little only, 100 completely replaces all colours by the fade
247colour; resource \fBfading\fR. 250colour; resource \fBfading\fR.
… …
250Fade to this colour when fading is used (see \fB\-fade\fR). The default colour 253Fade to this colour when fading is used (see \fB\-fade\fR). The default colour
251is opaque black. resource \fBfadeColor\fR. 254is opaque black. resource \fBfadeColor\fR.
252.IP "\fB\-tint\fR \fIcolour\fR" 4 255.IP "\fB\-tint\fR \fIcolour\fR" 4
253.IX Item "-tint colour" 256.IX Item "-tint colour"
254Tint the transparent background pixmap with the given colour when 257Tint the transparent background pixmap with the given colour when
255transparency is enabled with \fB\-tr\fR or \fB\-ip\fR. This only works for 258transparency is enabled with \fB\-tr\fR. This only works for
256non-tiled backgrounds, currently. See also the \fB\-sh\fR option that can be 259non-tiled backgrounds, currently. See also the \fB\-sh\fR option that can be
257used to brighten or darken the image in addition to tinting it. 260used to brighten or darken the image in addition to tinting it.
258Please note that certain tint colours can be applied on the server\-side, 261Please note that certain tint colours can be applied on the server\-side,
259thus yielding performance gain of two orders of magnitude. These colours are: 262thus yielding performance gain of two orders of magnitude. These colours are:
260blue, red, green, cyan, magenta, yellow, and those close to them; resource 263blue, red, green, cyan, magenta, yellow, and those close to them; resource
261\&\fItintColor\fR. Example: 264\&\fItintColor\fR. Example:
262.Sp 265.Sp
263.Vb 1 266.Vb 1
264\& @@RXVT_NAME@@ -tr -tint blue -sh 40 267\& @@RXVT_NAME@@ \-tr \-tint blue \-sh 40
265.Ve 268.Ve
266.IP "\fB\-sh\fR \fInumber\fR" 4 269.IP "\fB\-sh\fR \fInumber\fR" 4
267.IX Item "-sh number" 270.IX Item "-sh number"
268Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent 271Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent
269background image in addition to (or instead of) tinting it; 272background image in addition to (or instead of) tinting it;
… …
274at the same time as transparency \- such pixmap will be blended over 277at the same time as transparency \- such pixmap will be blended over
275transparency image, using method specified. Supported values are : 278transparency image, using method specified. Supported values are :
276\&\fBadd\fR, \fBalphablend\fR, \fBallanon\fR \- color values averaging, \fBcolorize\fR, 279\&\fBadd\fR, \fBalphablend\fR, \fBallanon\fR \- color values averaging, \fBcolorize\fR,
277\&\fBdarken\fR, \fBdiff\fR, \fBdissipate\fR, \fBhue\fR, \fBlighten\fR, \fBoverlay\fR, 280\&\fBdarken\fR, \fBdiff\fR, \fBdissipate\fR, \fBhue\fR, \fBlighten\fR, \fBoverlay\fR,
278\&\fBsaturate\fR, \fBscreen\fR, \fBsub\fR, \fBtint\fR, \fBvalue\fR. The default is 281\&\fBsaturate\fR, \fBscreen\fR, \fBsub\fR, \fBtint\fR, \fBvalue\fR. The default is
279alpha\-blending; resource \fIblendType\fR. 282alpha\-blending. Compile \fIafterimage\fR; resource \fIblendType\fR.
280.IP "\fB\-blr\fR \fIHxV\fR" 4 283.IP "\fB\-blr\fR \fIHxV\fR" 4
281.IX Item "-blr HxV" 284.IX Item "-blr HxV"
282Apply Gaussian Blur with the specified radii to the transparent 285Apply Gaussian Blur with the specified radii to the transparent
283background image. If single number is specified \- both vertical and 286background image. If single number is specified \- both vertical and
284horizontal radii are considered to be the same. Setting one of the 287horizontal radii are considered to be the same. Setting one of the
285radii to 1 and another to a large number creates interesting effects 288radii to 1 and another to a large number creates interesting effects
286on some backgrounds. Maximum radius value is 128; resource \fIblurRadius\fR. 289on some backgrounds. Maximum radius value is 128. Compile \fIafterimage\fR;
290resource \fIblurRadius\fR.
287.IP "\fB\-bg\fR \fIcolour\fR" 4 291.IP "\fB\-bg\fR \fIcolour\fR" 4
288.IX Item "-bg colour" 292.IX Item "-bg colour"
289Window background colour; resource \fBbackground\fR. 293Window background colour; resource \fBbackground\fR.
290.IP "\fB\-fg\fR \fIcolour\fR" 4 294.IP "\fB\-fg\fR \fIcolour\fR" 4
291.IX Item "-fg colour" 295.IX Item "-fg colour"
… …
320In short, to specify an X11 core font, just specify its name or prefix it 324In short, to specify an X11 core font, just specify its name or prefix it
321with \f(CW\*(C`x:\*(C'\fR. To specify an XFT\-font, you need to prefix it with \f(CW\*(C`xft:\*(C'\fR, 325with \f(CW\*(C`x:\*(C'\fR. To specify an XFT\-font, you need to prefix it with \f(CW\*(C`xft:\*(C'\fR,
322e.g.: 326e.g.:
323.Sp 327.Sp
324.Vb 2 328.Vb 2
325\& @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 329\& @@RXVT_NAME@@ \-fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
326\& @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 330\& @@RXVT_NAME@@ \-fn "9x15bold,xft:Bitstream Vera Sans Mono"
327.Ve 331.Ve
328.Sp 332.Sp
329See also the question \*(L"How does rxvt-unicode choose fonts?\*(R" in the \s-1FAQ\s0 333See also the question \*(L"How does rxvt-unicode choose fonts?\*(R" in the \s-1FAQ\s0
330section of @@RXVT_NAME@@(7). 334section of @@RXVT_NAME@@(7).
331.IP "\fB\-fb\fR \fIfontlist\fR" 4 335.IP "\fB\-fb\fR \fIfontlist\fR" 4
… …
429resource \fBskipBuiltinGlyphs\fR. 433resource \fBskipBuiltinGlyphs\fR.
430.IP "\fB\-lsp\fR \fInumber\fR" 4 434.IP "\fB\-lsp\fR \fInumber\fR" 4
431.IX Item "-lsp number" 435.IX Item "-lsp number"
432Compile \fIfrills\fR: Lines (pixel height) to insert between each row of 436Compile \fIfrills\fR: Lines (pixel height) to insert between each row of
433the display. Useful to work around font rendering problems; resource 437the display. Useful to work around font rendering problems; resource
434\&\fBlinespace\fR. 438\&\fBlineSpace\fR.
435.IP "\fB\-tn\fR \fItermname\fR" 4 439.IP "\fB\-tn\fR \fItermname\fR" 4
436.IX Item "-tn termname" 440.IX Item "-tn termname"
437This option specifies the name of the terminal type to be set in the 441This option specifies the name of the terminal type to be set in the
438\&\fB\s-1TERM\s0\fR environment variable. This terminal type must exist in the 442\&\fB\s-1TERM\s0\fR environment variable. This terminal type must exist in the
439\&\fI\fItermcap\fI\|(5)\fR database and should have \fIli#\fR and \fIco#\fR entries; 443\&\fI\fItermcap\fI\|(5)\fR database and should have \fIli#\fR and \fIco#\fR entries;
… …
450.Sp 454.Sp
451Please note that you must specify a program with arguments. If you want to 455Please note that you must specify a program with arguments. If you want to
452run shell commands, you have to specify the shell, like this: 456run shell commands, you have to specify the shell, like this:
453.Sp 457.Sp
454.Vb 1 458.Vb 1
455\& @@RXVT_NAME@@ -e sh -c "shell commands" 459\& @@RXVT_NAME@@ \-e sh \-c "shell commands"
456.Ve 460.Ve
457.IP "\fB\-title\fR \fItext\fR" 4 461.IP "\fB\-title\fR \fItext\fR" 4
458.IX Item "-title text" 462.IX Item "-title text"
459Window title (\fB\-T\fR still respected); the default title is the basename 463Window title (\fB\-T\fR still respected); the default title is the basename
460of the program specified after the \fB\-e\fR option, if any, otherwise the 464of the program specified after the \fB\-e\fR option, if any, otherwise the
… …
538Here is a short Gtk2\-perl snippet that illustrates how this option can be 542Here is a short Gtk2\-perl snippet that illustrates how this option can be
539used (a longer example is in \fIdoc/embed\fR): 543used (a longer example is in \fIdoc/embed\fR):
540.Sp 544.Sp
541.Vb 5 545.Vb 5
542\& my $rxvt = new Gtk2::Socket; 546\& my $rxvt = new Gtk2::Socket;
543\& $rxvt->signal_connect_after (realize => sub { 547\& $rxvt\->signal_connect_after (realize => sub {
544\& my $xid = $_[0]->window->get_xid; 548\& my $xid = $_[0]\->window\->get_xid;
545\& system "@@RXVT_NAME@@ -embed $xid &"; 549\& system "@@RXVT_NAME@@ \-embed $xid &";
546\& }); 550\& });
547.Ve 551.Ve
548.IP "\fB\-pty\-fd\fR \fIfile descriptor\fR" 4 552.IP "\fB\-pty\-fd\fR \fIfile descriptor\fR" 4
549.IX Item "-pty-fd file descriptor" 553.IX Item "-pty-fd file descriptor"
550Tells @@RXVT_NAME@@ \s-1NOT\s0 to execute any commands or create a new pty/tty 554Tells @@RXVT_NAME@@ \s-1NOT\s0 to execute any commands or create a new pty/tty
… …
567\& use Fcntl; 571\& use Fcntl;
568.Ve 572.Ve
569.Sp 573.Sp
570.Vb 4 574.Vb 4
571\& my $pty = new IO::Pty; 575\& my $pty = new IO::Pty;
572\& fcntl $pty, F_SETFD, 0; # clear close-on-exec 576\& fcntl $pty, F_SETFD, 0; # clear close\-on\-exec
573\& system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&"; 577\& system "@@RXVT_NAME@@ \-pty\-fd " . (fileno $pty) . "&";
574\& close $pty; 578\& close $pty;
575.Ve 579.Ve
576.Sp 580.Sp
577.Vb 3 581.Vb 3
578\& # now communicate with rxvt 582\& # now communicate with rxvt
579\& my $slave = $pty->slave; 583\& my $slave = $pty\->slave;
580\& while (<$slave>) { print $slave "got <$_>\en" } 584\& while (<$slave>) { print $slave "got <$_>\en" }
581.Ve 585.Ve
582.IP "\fB\-pe\fR \fIstring\fR" 4 586.IP "\fB\-pe\fR \fIstring\fR" 4
583.IX Item "-pe string" 587.IX Item "-pe string"
584Comma-separated list of perl extension scripts to use (or not to use) in 588Comma-separated list of perl extension scripts to use (or not to use) in
… …
592distribution do also load settings from the \fB~/.Xresources\fR file when X 596distribution do also load settings from the \fB~/.Xresources\fR file when X
593starts. @@RXVT_NAME@@ will consult the following files/resources in order, 597starts. @@RXVT_NAME@@ will consult the following files/resources in order,
594with later settings overwriting earlier ones: 598with later settings overwriting earlier ones:
595.PP 599.PP
596.Vb 5 600.Vb 5
597\& 1. system-wide app-defaults file, either locale-dependent OR global 601\& 1. system\-wide app\-defaults file, either locale\-dependent OR global
598\& 2. app-defaults file in $XAPPLRESDIR 602\& 2. app\-defaults file in $XAPPLRESDIR
599\& 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 603\& 3. RESOURCE_MANAGER property on root\-window OR $HOME/.Xdefaults
600\& 4. SCREEN_RESOURCES for the current screen 604\& 4. SCREEN_RESOURCES for the current screen
601\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 605\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults\-<nodename>
602.Ve 606.Ve
603.PP 607.PP
604Note that when reading X resources, \fB@@RXVT_NAME@@\fR recognizes two class 608Note that when reading X resources, \fB@@RXVT_NAME@@\fR recognizes two class
605names: \fBRxvt\fR and \fBURxvt\fR. The class name \fBRxvt\fR allows resources 609names: \fBRxvt\fR and \fBURxvt\fR. The class name \fBRxvt\fR allows resources
606common to both \fB@@RXVT_NAME@@\fR and the original \fIrxvt\fR to be easily 610common to both \fB@@RXVT_NAME@@\fR and the original \fIrxvt\fR to be easily
… …
753blended over transparency image using either alpha\-blending, or any 757blended over transparency image using either alpha\-blending, or any
754other blending type, specified with \fB\-blt \*(L"type\*(R"\fR option. 758other blending type, specified with \fB\-blt \*(L"type\*(R"\fR option.
755[default 0x0+50+50] 759[default 0x0+50+50]
756.IP "\fBpath:\fR \fIpath\fR" 4 760.IP "\fBpath:\fR \fIpath\fR" 4
757.IX Item "path: path" 761.IX Item "path: path"
758Specify the colon-delimited search path for finding \s-1XPM\s0 files. 762Specify the colon-delimited search path for finding background image files.
759.IP "\fBfont:\fR \fIfontlist\fR" 4 763.IP "\fBfont:\fR \fIfontlist\fR" 4
760.IX Item "font: fontlist" 764.IX Item "font: fontlist"
761Select the fonts to be used. This is a comma separated list of font names 765Select the fonts to be used. This is a comma separated list of font names
762that are checked in order when trying to find glyphs for characters. The 766that are checked in order when trying to find glyphs for characters. The
763first font defines the cell size for characters; other fonts might be 767first font defines the cell size for characters; other fonts might be
… …
774.Sp 778.Sp
775For example, this font resource 779For example, this font resource
776.Sp 780.Sp
777.Vb 5 781.Vb 5
778\& URxvt.font: 9x15bold,\e 782\& URxvt.font: 9x15bold,\e
779\& -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\e 783\& \-misc\-fixed\-bold\-r\-normal\-\-15\-140\-75\-75\-c\-90\-iso10646\-1,\e
780\& -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \e 784\& \-misc\-fixed\-medium\-r\-normal\-\-15\-140\-75\-75\-c\-90\-iso10646\-1, \e
781\& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e 785\& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e
782\& xft:Code2000:antialias=false 786\& xft:Code2000:antialias=false
783.Ve 787.Ve
784.Sp 788.Sp
785specifies five fonts to be used. The first one is \f(CW\*(C`9x15bold\*(C'\fR (actually 789specifies five fonts to be used. The first one is \f(CW\*(C`9x15bold\*(C'\fR (actually
… …
878The string will be interpreted as if typed into the shell as\-is. 882The string will be interpreted as if typed into the shell as\-is.
879.Sp 883.Sp
880Example: 884Example:
881.Sp 885.Sp
882.Vb 1 886.Vb 1
883\& URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 887\& URxvt.print\-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
884.Ve 888.Ve
885.Sp 889.Sp
886This creates a new file in your home directory with the screen contents 890This creates a new file in your home directory with the screen contents
887every time you hit \f(CW\*(C`Print\*(C'\fR. 891every time you hit \f(CW\*(C`Print\*(C'\fR.
888.IP "\fBscrollBar:\fR \fIboolean\fR" 4 892.IP "\fBscrollBar:\fR \fIboolean\fR" 4
… …
941option \fB\-sbg\fR. 945option \fB\-sbg\fR.
942.IP "\fBtermName:\fR \fItermname\fR" 4 946.IP "\fBtermName:\fR \fItermname\fR" 4
943.IX Item "termName: termname" 947.IX Item "termName: termname"
944Specifies the terminal type name to be set in the \fB\s-1TERM\s0\fR environment 948Specifies the terminal type name to be set in the \fB\s-1TERM\s0\fR environment
945variable; option \fB\-tn\fR. 949variable; option \fB\-tn\fR.
946.IP "\fBlinespace:\fR \fInumber\fR" 4 950.IP "\fBlineSpace:\fR \fInumber\fR" 4
947.IX Item "linespace: number" 951.IX Item "lineSpace: number"
948Specifies number of lines (pixel height) to insert between each row of 952Specifies number of lines (pixel height) to insert between each row of
949the display [default 0]; option \fB\-lsp\fR. 953the display [default 0]; option \fB\-lsp\fR.
950.IP "\fBmeta8:\fR \fIboolean\fR" 4 954.IP "\fBmeta8:\fR \fIboolean\fR" 4
951.IX Item "meta8: boolean" 955.IX Item "meta8: boolean"
952\&\fBTrue\fR: handle Meta (Alt) + keypress to set the 8th bit. \fBFalse\fR: 956\&\fBTrue\fR: handle Meta (Alt) + keypress to set the 8th bit. \fBFalse\fR:
… …
1086searching keysym macros from \fB/usr/X11R6/include/X11/keysymdef.h\fR and 1090searching keysym macros from \fB/usr/X11R6/include/X11/keysymdef.h\fR and
1087omitting the prefix \fB\s-1XK_\s0\fR. Alternatively you can specify \fIkey\fR by its hex 1091omitting the prefix \fB\s-1XK_\s0\fR. Alternatively you can specify \fIkey\fR by its hex
1088keysym value (\fB0x0000 \- 0xFFFF\fR). Note that the lookup of \fIsym\fRs is not 1092keysym value (\fB0x0000 \- 0xFFFF\fR). Note that the lookup of \fIsym\fRs is not
1089performed in an exact manner; however, the closest match is assured. 1093performed in an exact manner; however, the closest match is assured.
1090.Sp 1094.Sp
1091\&\fIstring\fR may contain escape values (\f(CW\*(C`\ea\*(C'\fR: bell, \f(CW\*(C`\eb\*(C'\fR: backspace, 1095\&\fIstring\fR may contain escape values (\f(CW\*(C`\en\*(C'\fR: newline, \f(CW\*(C`\e000\*(C'\fR: octal
1092\&\f(CW\*(C`\ee\*(C'\fR, \f(CW\*(C`\eE\*(C'\fR: escape, \f(CW\*(C`\en\*(C'\fR: newline, \f(CW\*(C`\er\*(C'\fR: carriage return, \f(CW\*(C`\et\*(C'\fR: tab, 1096number), see \s-1RESOURCES\s0 in \f(CW\*(C`man 7 X\*(C'\fR for futher details.
1093\&\f(CW\*(C`\e000\*(C'\fR: octal number) or verbatim control characters (\f(CW\*(C`^?\*(C'\fR: delete,
1094\&\f(CW\*(C`^@\*(C'\fR: null, \f(CW\*(C`^A\*(C'\fR ...) and may be enclosed with double quotes so that it
1095can start or end with whitespace. \fBThis feature is deprecated and will
1096be removed\fR.
1097.Sp
1098Please note that you need to double the \f(CW\*(C`\e\*(C'\fR in resource files, as
1099Xlib itself does its own de-escaping (you can use \f(CW\*(C`\e033\*(C'\fR instead of
1100\&\f(CW\*(C`\ee\*(C'\fR (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1101processing).
1102.Sp 1097.Sp
1103You can define a range of keysyms in one shot by providing a \fIstring\fR 1098You can define a range of keysyms in one shot by providing a \fIstring\fR
1104with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimiter `/' 1099with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimiter `/'
1105should be a character not used by the strings. 1100should be a character not used by the strings.
1106.Sp 1101.Sp
1107Its usage can be demonstrated by an example: 1102Its usage can be demonstrated by an example:
1108.Sp 1103.Sp
1109.Vb 1 1104.Vb 1
1110\& URxvt.keysym.M-C-0x61: list|\e033<M-C-|abc|> 1105\& URxvt.keysym.M\-C\-0x61: list|\e033<M\-C\-|abc|>
1111.Ve 1106.Ve
1112.Sp 1107.Sp
1113The above line is equivalent to the following three lines: 1108The above line is equivalent to the following three lines:
1114.Sp 1109.Sp
1115.Vb 3 1110.Vb 3
1116\& URxvt.keysym.Meta-Control-0x61: \e033<M-C-a> 1111\& URxvt.keysym.Meta\-Control\-0x61: \e033<M\-C\-a>
1117\& URxvt.keysym.Meta-Control-0x62: \e033<M-C-b> 1112\& URxvt.keysym.Meta\-Control\-0x62: \e033<M\-C\-b>
1118\& URxvt.keysym.Meta-Control-0x63: \e033<M-C-c> 1113\& URxvt.keysym.Meta\-Control\-0x63: \e033<M\-C\-c>
1119.Ve 1114.Ve
1120.Sp 1115.Sp
1121If \fIstring\fR takes the form of \f(CW\*(C`command:STRING\*(C'\fR, the specified \fB\s-1STRING\s0\fR 1116If \fIstring\fR takes the form of \f(CW\*(C`command:STRING\*(C'\fR, the specified \fB\s-1STRING\s0\fR
1122is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1117is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1123example the following means "change the current locale to \f(CW\*(C`zh_CN.GBK\*(C'\fR 1118example the following means "change the current locale to \f(CW\*(C`zh_CN.GBK\*(C'\fR
1124when Control-Meta-c is being pressed": 1119when Control-Meta-c is being pressed":
1125.Sp 1120.Sp
1126.Vb 1 1121.Vb 1
1127\& URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007 1122\& URxvt.keysym.M\-C\-c: command:\e033]701;zh_CN.GBK\e007
1128.Ve 1123.Ve
1129.Sp 1124.Sp
1130If \fIstring\fR takes the form \f(CW\*(C`perl:STRING\*(C'\fR, then the specified \fB\s-1STRING\s0\fR 1125If \fIstring\fR takes the form \f(CW\*(C`perl:STRING\*(C'\fR, then the specified \fB\s-1STRING\s0\fR
1131is passed to the \f(CW\*(C`on_keyboard_command\*(C'\fR perl handler. See the @@RXVT_NAME@@\fIperl\fR\|(3) 1126is passed to the \f(CW\*(C`on_keyboard_command\*(C'\fR perl handler. See the @@RXVT_NAME@@\fIperl\fR\|(3)
1132manpage. For example, the \fIselection\fR extension (activated via 1127manpage. For example, the \fIselection\fR extension (activated via
1133\&\f(CW\*(C`@@RXVT_NAME@@ \-pe selection\*(C'\fR) listens for \f(CW\*(C`selection:rot13\*(C'\fR events: 1128\&\f(CW\*(C`@@RXVT_NAME@@ \-pe selection\*(C'\fR) listens for \f(CW\*(C`selection:rot13\*(C'\fR events:
1134.Sp 1129.Sp
1135.Vb 1 1130.Vb 1
1136\& URxvt.keysym.M-C-c: perl:selection:rot13 1131\& URxvt.keysym.M\-C\-c: perl:selection:rot13
1137.Ve 1132.Ve
1138.Sp 1133.Sp
1139Due the the large number of modifier combinations, a defined key mapping 1134Due the the large number of modifier combinations, a defined key mapping
1140will match if at \fIat least\fR the specified identifiers are being set, and 1135will match if at \fIat least\fR the specified identifiers are being set, and
1141no other key mappings with those and more bits are being defined. That 1136no other key mappings with those and more bits are being defined. That
… …
1148\&\f(CW\*(C`Shift\-Insert\*(C'\fR mapping. To re-enable that, you can poke \*(L"holes\*(R" into the 1143\&\f(CW\*(C`Shift\-Insert\*(C'\fR mapping. To re-enable that, you can poke \*(L"holes\*(R" into the
1149user-defined keymap using the \f(CW\*(C`builtin:\*(C'\fR replacement: 1144user-defined keymap using the \f(CW\*(C`builtin:\*(C'\fR replacement:
1150.Sp 1145.Sp
1151.Vb 2 1146.Vb 2
1152\& URxvt.keysym.Insert: <my insert key sequence> 1147\& URxvt.keysym.Insert: <my insert key sequence>
1153\& URxvt.keysym.S-Insert: builtin: 1148\& URxvt.keysym.S\-Insert: builtin:
1154.Ve 1149.Ve
1155.Sp 1150.Sp
1156The first line defines a mapping for \f(CW\*(C`Insert\*(C'\fR and \fIany\fR combination 1151The first line defines a mapping for \f(CW\*(C`Insert\*(C'\fR and \fIany\fR combination
1157of modifiers. The second line re-establishes the default mapping for 1152of modifiers. The second line re-establishes the default mapping for
1158\&\f(CW\*(C`Shift\-Insert\*(C'\fR. 1153\&\f(CW\*(C`Shift\-Insert\*(C'\fR.
… …
1160The following example will map Control\-Meta\-1 and Control\-Meta\-2 to 1155The following example will map Control\-Meta\-1 and Control\-Meta\-2 to
1161the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited 1156the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited
1162font-switching at runtime: 1157font-switching at runtime:
1163.Sp 1158.Sp
1164.Vb 2 1159.Vb 2
1165\& URxvt.keysym.M-C-1: command:\e033]50;suxuseuro\e007 1160\& URxvt.keysym.M\-C\-1: command:\e033]50;suxuseuro\e007
1166\& URxvt.keysym.M-C-2: command:\e033]50;9x15bold\e007 1161\& URxvt.keysym.M\-C\-2: command:\e033]50;9x15bold\e007
1167.Ve 1162.Ve
1168.Sp 1163.Sp
1169Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1164Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1170info): 1165info):
1171.Sp 1166.Sp
1172.Vb 2 1167.Vb 2
1173\& URxvt.keysym.M-C-3: command:\e033[8;25;80t 1168\& URxvt.keysym.M\-C\-3: command:\e033[8;25;80t
1174\& URxvt.keysym.M-C-4: command:\e033[8;48;110t 1169\& URxvt.keysym.M\-C\-4: command:\e033[8;48;110t
1175.Ve 1170.Ve
1176.IP "\fBperl-ext-common\fR: \fIstring\fR" 4 1171.IP "\fBperl-ext-common\fR: \fIstring\fR" 4
1177.IX Item "perl-ext-common: string" 1172.IX Item "perl-ext-common: string"
1178.PD 0 1173.PD 0
1179.IP "\fBperl-ext\fR: \fIstring\fR" 4 1174.IP "\fBperl-ext\fR: \fIstring\fR" 4
… …
1301.Ve 1296.Ve
1302.PP 1297.PP
1303You can use keyboard shortcuts, too: 1298You can use keyboard shortcuts, too:
1304.PP 1299.PP
1305.Vb 2 1300.Vb 2
1306\& URxvt.keysym.M-C-1: command:\e033]710;suxuseuro\e007\e033]711;suxuseuro\e007 1301\& URxvt.keysym.M\-C\-1: command:\e033]710;suxuseuro\e007\e033]711;suxuseuro\e007
1307\& URxvt.keysym.M-C-2: command:\e033]710;9x15bold\e007\e033]711;9x15bold\e007 1302\& URxvt.keysym.M\-C\-2: command:\e033]710;9x15bold\e007\e033]711;9x15bold\e007
1308.Ve 1303.Ve
1309.PP 1304.PP
1310rxvt-unicode will automatically re-apply these fonts to the output so far. 1305rxvt-unicode will automatically re-apply these fonts to the output so far.
1311.SH "ISO 14755 SUPPORT" 1306.SH "ISO 14755 SUPPORT"
1312.IX Header "ISO 14755 SUPPORT" 1307.IX Header "ISO 14755 SUPPORT"
… …
1439.PP 1434.PP
1440For example, the following selects an almost completely transparent red 1435For example, the following selects an almost completely transparent red
1441background, and an almost opaque pink foreground: 1436background, and an almost opaque pink foreground:
1442.PP 1437.PP
1443.Vb 1 1438.Vb 1
1444\& @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" 1439\& @@RXVT_NAME@@ \-depth 32 \-bg rgba:0000/0000/0000/aaaa \-fg "[80]pink"
1445.Ve 1440.Ve
1446.PP 1441.PP
1447\&\fIPlease note that transparency of any kind if completely unsupported by 1442\&\fIPlease note that transparency of any kind if completely unsupported by
1448the author. Don't bug him with installation questions!\fR 1443the author. Don't bug him with installation questions!\fR
1449.SH "ENVIRONMENT" 1444.SH "ENVIRONMENT"
… …
1454Normally set to \f(CW\*(C`rxvt\-unicode\*(C'\fR, unless overwritten at configure time, via 1449Normally set to \f(CW\*(C`rxvt\-unicode\*(C'\fR, unless overwritten at configure time, via
1455resources or on the command line. 1450resources or on the command line.
1456.IP "\fB\s-1COLORTERM\s0\fR" 4 1451.IP "\fB\s-1COLORTERM\s0\fR" 4
1457.IX Item "COLORTERM" 1452.IX Item "COLORTERM"
1458Either \f(CW\*(C`rxvt\*(C'\fR, \f(CW\*(C`rxvt\-xpm\*(C'\fR, depending on whether @@RXVT_NAME@@ was 1453Either \f(CW\*(C`rxvt\*(C'\fR, \f(CW\*(C`rxvt\-xpm\*(C'\fR, depending on whether @@RXVT_NAME@@ was
1459compiled with \s-1XPM\s0 support, and optionally with the added extension 1454compiled with background image support, and optionally with the added
1460\&\f(CW\*(C`\-mono\*(C'\fR to indicate that rxvt-unicode runs on a monochrome screen. 1455extension \f(CW\*(C`\-mono\*(C'\fR to indicate that rxvt-unicode runs on a monochrome
1456screen.
1461.IP "\fB\s-1COLORFGBG\s0\fR" 4 1457.IP "\fB\s-1COLORFGBG\s0\fR" 4
1462.IX Item "COLORFGBG" 1458.IX Item "COLORFGBG"
1463Set to a string of the form \f(CW\*(C`fg;bg\*(C'\fR or \f(CW\*(C`fg;xpm;bg\*(C'\fR, where \f(CW\*(C`fg\*(C'\fR is 1459Set to a string of the form \f(CW\*(C`fg;bg\*(C'\fR or \f(CW\*(C`fg;xpm;bg\*(C'\fR, where \f(CW\*(C`fg\*(C'\fR is
1464the colour code used as default foreground/text colour (or the string 1460the colour code used as default foreground/text colour (or the string
1465\&\f(CW\*(C`default\*(C'\fR to indicate that the default-colour escape sequence is to be 1461\&\f(CW\*(C`default\*(C'\fR to indicate that the default-colour escape sequence is to be
1466used), \f(CW\*(C`bg\*(C'\fR is the colour code used as default background colour (or the 1462used), \f(CW\*(C`bg\*(C'\fR is the colour code used as default background colour (or the
1467string \f(CW\*(C`default\*(C'\fR), and \f(CW\*(C`xpm\*(C'\fR is the string \f(CW\*(C`default\*(C'\fR if @@RXVT_NAME@@ 1463string \f(CW\*(C`default\*(C'\fR), and \f(CW\*(C`xpm\*(C'\fR is the string \f(CW\*(C`default\*(C'\fR if @@RXVT_NAME@@
1468was compiled with \s-1XPM\s0 support. Libraries like \f(CW\*(C`ncurses\*(C'\fR and \f(CW\*(C`slang\*(C'\fR can 1464was compiled with background image support. Libraries like \f(CW\*(C`ncurses\*(C'\fR
1469(and do) use this information to optimize screen output. 1465and \f(CW\*(C`slang\*(C'\fR can (and do) use this information to optimize screen output.
1470.IP "\fB\s-1WINDOWID\s0\fR" 4 1466.IP "\fB\s-1WINDOWID\s0\fR" 4
1471.IX Item "WINDOWID" 1467.IX Item "WINDOWID"
1472Set to the (decimal) X Window \s-1ID\s0 of the @@RXVT_NAME@@ window (the toplevel 1468Set to the (decimal) X Window \s-1ID\s0 of the @@RXVT_NAME@@ window (the toplevel
1473window, which usually has subwindows for the scrollbar, the terminal 1469window, which usually has subwindows for the scrollbar, the terminal
1474window and so on). 1470window and so on).

Diff Legend

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