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.68 by root, Sun Jun 24 22:12:18 2007 UTC vs.
Revision 1.76 by root, Sat Dec 15 19:10:11 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.35
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-06-25" "8.2" "RXVT-UNICODE" 132.TH @@RXVT_NAME@@ 1 "2007-12-15" "8.7" "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 ]]
… …
140\&\fBrxvt-unicode\fR, version \fB@@RXVT_VERSION@@\fR, is a colour vt102 terminal 140\&\fBrxvt-unicode\fR, version \fB@@RXVT_VERSION@@\fR, is a colour vt102 terminal
141emulator intended as an \fIxterm\fR(1) replacement for users who do not 141emulator intended as an \fIxterm\fR(1) replacement for users who do not
142require features such as Tektronix 4014 emulation and toolkit-style 142require features such as Tektronix 4014 emulation and toolkit-style
143configurability. As a result, \fBrxvt-unicode\fR uses much less swap space \*(-- 143configurability. As a result, \fBrxvt-unicode\fR uses much less swap space \*(--
144a significant advantage on a machine serving many X sessions. 144a significant advantage on a machine serving many X sessions.
145.PP
146This document is also available on the World-Wide-Web at
147<http://pod.tst.eu/http://cvs.schmorp.de/rxvt\-unicode/doc/rxvt.1.pod>.
145.SH "FREQUENTLY ASKED QUESTIONS" 148.SH "FREQUENTLY ASKED QUESTIONS"
146.IX Header "FREQUENTLY ASKED QUESTIONS" 149.IX Header "FREQUENTLY ASKED QUESTIONS"
147See @@RXVT_NAME@@(7) (try \f(CW\*(C`man 7 @@RXVT_NAME@@\*(C'\fR) for a list of 150See @@RXVT_NAME@@(7) (try \f(CW\*(C`man 7 @@RXVT_NAME@@\*(C'\fR) for a list of
148frequently asked questions and answer to them and some common 151frequently asked questions and answer to them and some common
149problems. That document is also accessible on the World-Wide-Web at 152problems. That document is also accessible on the World-Wide-Web at
150<http://cvs.schmorp.de/browse/rxvt\-unicode/doc/rxvt.7.html>. 153<http://pod.tst.eu/http://cvs.schmorp.de/rxvt\-unicode/doc/rxvt.7.pod>.
151.SH "RXVT-UNICODE VS. RXVT" 154.SH "RXVT-UNICODE VS. RXVT"
152.IX Header "RXVT-UNICODE VS. RXVT" 155.IX Header "RXVT-UNICODE VS. RXVT"
153Unlike the original rxvt, \fBrxvt-unicode\fR stores all text in Unicode 156Unlike the original rxvt, \fBrxvt-unicode\fR stores all text in Unicode
154internally. That means it can store and display most scripts in the 157internally. That means it can store and display most scripts in the
155world. Being a terminal emulator, however, some things are very difficult, 158world. Being a terminal emulator, however, some things are very difficult,
156especially cursive scripts such as arabic, vertically written scripts 159especially cursive scripts such as arabic, vertically written scripts
157like mongolian or scripts requiring extremely complex combining rules, 160like mongolian or scripts requiring extremely complex combining rules,
158like tibetan or devenagari. Don't expect pretty output when using these 161like tibetan or devanagari. Don't expect pretty output when using these
159scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 162scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
160fine, though. A somewhat difficult case are right-to-left scripts, such 163fine, though. A somewhat difficult case are right-to-left scripts, such
161as hebrew: \fBrxvt-unicode\fR adopts the view that bidirectional algorithms 164as hebrew: \fBrxvt-unicode\fR adopts the view that bidirectional algorithms
162belong into the application, not the terminal emulator (too many things \*(-- 165belong in the application, not the terminal emulator (too many things \*(--
163such as cursor-movement while editing \*(-- break otherwise), but that might 166such as cursor-movement while editing \*(-- break otherwise), but that might
164change. 167change.
165.PP 168.PP
166If you are looking for a terminal that supports more exotic scripts, let 169If you are looking for a terminal that supports more exotic scripts, let
167me recommend \f(CW\*(C`mlterm\*(C'\fR, which is a very user friendly, lean and clean 170me recommend \f(CW\*(C`mlterm\*(C'\fR, which is a very user friendly, lean and clean
… …
230.IX Item "-j|+j" 233.IX Item "-j|+j"
231Turn on/off jump scrolling (allow multiple lines per refresh); resource \fBjumpScroll\fR. 234Turn on/off jump scrolling (allow multiple lines per refresh); resource \fBjumpScroll\fR.
232.IP "\fB\-ss\fR|\fB+ss\fR" 4 235.IP "\fB\-ss\fR|\fB+ss\fR" 4
233.IX Item "-ss|+ss" 236.IX Item "-ss|+ss"
234Turn on/off skip scrolling (allow multiple screens per refresh); resource \fBskipScroll\fR. 237Turn 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 238.IP "\fB\-tr\fR|\fB+tr\fR" 4
236.IX Item "-ip|+ip | -tr|+tr" 239.IX Item "-tr|+tr"
237Turn on/off inheriting parent window's pixmap. Alternative form is 240Turn on/off illusion of a transparent window background; resource \fBtransparent\fR.
238\&\fB\-tr\fR; resource \fBinheritPixmap\fR.
239.Sp 241.Sp
240\&\fIPlease note that transparency of any kind if completely unsupported by 242\&\fB\-ip\fR is still accepted as an obsolete alias but will be removed in
241the author. Don't bug him with installation questions! Read the \s-1FAQ\s0 (man 7 243future versions.
242@@RXVT_NAME@@)!\fR 244.Sp
245\&\fIPlease address all transparency related issues to Sasha Vasko at
246sasha@aftercode.net. Read the \s-1FAQ\s0 (man 7 @@RXVT_NAME@@)!\fR
243.IP "\fB\-fade\fR \fInumber\fR" 4 247.IP "\fB\-fade\fR \fInumber\fR" 4
244.IX Item "-fade number" 248.IX Item "-fade number"
245Fade the text by the given percentage when focus is lost. Small values 249Fade the text by the given percentage when focus is lost. Small values
246fade a little only, 100 completely replaces all colours by the fade 250fade a little only, 100 completely replaces all colours by the fade
247colour; resource \fBfading\fR. 251colour; resource \fBfading\fR.
… …
250Fade to this colour when fading is used (see \fB\-fade\fR). The default colour 254Fade to this colour when fading is used (see \fB\-fade\fR). The default colour
251is opaque black. resource \fBfadeColor\fR. 255is opaque black. resource \fBfadeColor\fR.
252.IP "\fB\-tint\fR \fIcolour\fR" 4 256.IP "\fB\-tint\fR \fIcolour\fR" 4
253.IX Item "-tint colour" 257.IX Item "-tint colour"
254Tint the transparent background pixmap with the given colour when 258Tint the transparent background pixmap with the given colour when
255transparency is enabled with \fB\-tr\fR or \fB\-ip\fR. This only works for 259transparency is enabled with \fB\-tr\fR. This only works for
256non-tiled backgrounds, currently. See also the \fB\-sh\fR option that can be 260non-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; resource 261used to brighten or darken the image in addition to tinting it.
262Please note that certain tint colours can be applied on the server\-side,
263thus yielding performance gain of two orders of magnitude. These colours are:
264blue, red, green, cyan, magenta, yellow, and those close to them. Also
265pure black and pure white colors essentially mean no tinting; resource
258\&\fItintColor\fR. Example: 266\&\fItintColor\fR. Example:
259.Sp 267.Sp
260.Vb 1 268.Vb 1
261\& @@RXVT_NAME@@ -tr -tint blue -sh 40 269\& @@RXVT_NAME@@ -tr -tint blue -sh 40
262.Ve 270.Ve
263.IP "\fB\-sh\fR \fInumber\fR" 4 271.IP "\fB\-sh\fR \fInumber\fR" 4
264.IX Item "-sh number" 272.IX Item "-sh number"
265Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent 273Darken (0 .. 100) or lighten (100 .. 200) the transparent
266background image in addition to (or instead of) tinting it; 274background image in addition to (or instead of) tinting it;
267resource \fIshading\fR. 275resource \fIshading\fR.
268.IP "\fB\-blt\fR \fIstring\fR" 4 276.IP "\fB\-blt\fR \fIstring\fR" 4
269.IX Item "-blt string" 277.IX Item "-blt string"
270Specify background blending type. If background pixmap is specified 278Specify background blending type. If background pixmap is specified
271at the same time as transparency \- such pixmap will be blended over 279at the same time as transparency \- such pixmap will be blended over
272transparency image, using method specified. Supported values are : 280transparency image, using method specified. Supported values are :
273\&\fBadd\fR, \fBalphablend\fR, \fBallanon\fR \- color values averaging, \fBcolorize\fR, 281\&\fBadd\fR, \fBalphablend\fR, \fBallanon\fR \- color values averaging, \fBcolorize\fR,
274\&\fBdarken\fR, \fBdiff\fR, \fBdissipate\fR, \fBhue\fR, \fBlighten\fR, \fBoverlay\fR, 282\&\fBdarken\fR, \fBdiff\fR, \fBdissipate\fR, \fBhue\fR, \fBlighten\fR, \fBoverlay\fR,
275\&\fBsaturate\fR, \fBscreen\fR, \fBsub\fR, \fBtint\fR, \fBvalue\fR. The default is 283\&\fBsaturate\fR, \fBscreen\fR, \fBsub\fR, \fBtint\fR, \fBvalue\fR. The default is
276alpha\-blending; resource \fIblendType\fR. 284alpha\-blending. Compile \fIafterimage\fR; resource \fIblendType\fR.
277.IP "\fB\-blr\fR \fInumber\fR" 4 285.IP "\fB\-blr\fR \fIHxV\fR" 4
278.IX Item "-blr number" 286.IX Item "-blr HxV"
279Apply Gaussian Blur with the specified radius to the transparent 287Apply Gaussian Blur with the specified radii to the transparent
280background image; resource \fIblurRadius\fR. 288background image. If single number is specified \- both vertical and
289horizontal radii are considered to be the same. Setting one of the
290radii to 1 and another to a large number creates interesting effects
291on some backgrounds. Maximum radius value is 128. Compile \fIafterimage\fR;
292resource \fIblurRadius\fR.
281.IP "\fB\-bg\fR \fIcolour\fR" 4 293.IP "\fB\-bg\fR \fIcolour\fR" 4
282.IX Item "-bg colour" 294.IX Item "-bg colour"
283Window background colour; resource \fBbackground\fR. 295Window background colour; resource \fBbackground\fR.
284.IP "\fB\-fg\fR \fIcolour\fR" 4 296.IP "\fB\-fg\fR \fIcolour\fR" 4
285.IX Item "-fg colour" 297.IX Item "-fg colour"
286Window foreground colour; resource \fBforeground\fR. 298Window foreground colour; resource \fBforeground\fR.
287.IP "\fB\-pixmap\fR \fIfile[;geom]\fR" 4 299.IP "\fB\-pixmap\fR \fIfile[;geom[:op1][:op2][...]]\fR" 4
288.IX Item "-pixmap file[;geom]" 300.IX Item "-pixmap file[;geom[:op1][:op2][...]]"
289Compile \fIafterimage\fR: Specify image file for the background and also 301Compile \fIafterimage\fR: Specify image file for the background and also
290optionally specify its scaling with a geometry string. Note you may need to 302optionally specify its scaling with a geometry string. Note you may need to
291add quotes to avoid special shell interpretation of the \f(CW\*(C`;\*(C'\fR in the 303add quotes to avoid special shell interpretation of the \f(CW\*(C`;\*(C'\fR in the
292command\-line; for more details see resource \fBbackgroundPixmap\fR. 304command\-line; for more details see resource \fBbackgroundPixmap\fR.
293.IP "\fB\-cr\fR \fIcolour\fR" 4 305.IP "\fB\-cr\fR \fIcolour\fR" 4
294.IX Item "-cr colour" 306.IX Item "-cr colour"
… …
335Compile \fIfont-styles\fR: The bold italic font list to use when \fB\f(BIbold 347Compile \fIfont-styles\fR: The bold italic font list to use when \fB\f(BIbold
336italic\fB\fR characters are to be printed. See resource \fBboldItalicFont\fR 348italic\fB\fR characters are to be printed. See resource \fBboldItalicFont\fR
337for details. 349for details.
338.IP "\fB\-is\fR|\fB+is\fR" 4 350.IP "\fB\-is\fR|\fB+is\fR" 4
339.IX Item "-is|+is" 351.IX Item "-is|+is"
340Compile \fIfont-styles\fR: Bold/Italic font styles imply high intensity 352Compile \fIfont-styles\fR: Bold/Blink font styles imply high intensity
341foreground/background (default). See resource \fBintensityStyles\fR for 353foreground/background (default). See resource \fBintensityStyles\fR for
342details. 354details.
343.IP "\fB\-name\fR \fIname\fR" 4 355.IP "\fB\-name\fR \fIname\fR" 4
344.IX Item "-name name" 356.IX Item "-name name"
345Specify the application name under which resources are to be obtained, 357Specify the application name under which resources are to be obtained,
… …
423resource \fBskipBuiltinGlyphs\fR. 435resource \fBskipBuiltinGlyphs\fR.
424.IP "\fB\-lsp\fR \fInumber\fR" 4 436.IP "\fB\-lsp\fR \fInumber\fR" 4
425.IX Item "-lsp number" 437.IX Item "-lsp number"
426Compile \fIfrills\fR: Lines (pixel height) to insert between each row of 438Compile \fIfrills\fR: Lines (pixel height) to insert between each row of
427the display. Useful to work around font rendering problems; resource 439the display. Useful to work around font rendering problems; resource
428\&\fBlinespace\fR. 440\&\fBlineSpace\fR.
429.IP "\fB\-tn\fR \fItermname\fR" 4 441.IP "\fB\-tn\fR \fItermname\fR" 4
430.IX Item "-tn termname" 442.IX Item "-tn termname"
431This option specifies the name of the terminal type to be set in the 443This option specifies the name of the terminal type to be set in the
432\&\fB\s-1TERM\s0\fR environment variable. This terminal type must exist in the 444\&\fB\s-1TERM\s0\fR environment variable. This terminal type must exist in the
433\&\fI\fItermcap\fI\|(5)\fR database and should have \fIli#\fR and \fIco#\fR entries; 445\&\fI\fItermcap\fI\|(5)\fR database and should have \fIli#\fR and \fIco#\fR entries;
… …
480for more info. 492for more info.
481.IP "\fB\-tcw\fR" 4 493.IP "\fB\-tcw\fR" 4
482.IX Item "-tcw" 494.IX Item "-tcw"
483Change the meaning of triple-click selection with the left mouse 495Change the meaning of triple-click selection with the left mouse
484button. Only effective when the original (non\-perl) selection code is 496button. Only effective when the original (non\-perl) selection code is
485in\-use. Instead of selecting a full line it will extend the selection the 497in\-use. Instead of selecting a full line it will extend the selection to
486end of the logical line only. resource \fBtripleclickwords\fR. 498the end of the logical line only. resource \fBtripleclickwords\fR.
487.IP "\fB\-insecure\fR" 4 499.IP "\fB\-insecure\fR" 4
488.IX Item "-insecure" 500.IX Item "-insecure"
489Enable \*(L"insecure\*(R" mode, which currently enables most of the escape 501Enable \*(L"insecure\*(R" mode, which currently enables most of the escape
490sequences that echo strings. See the resource \fBinsecure\fR for more 502sequences that echo strings. See the resource \fBinsecure\fR for more
491info. 503info.
… …
506.IX Item "-hold|+hold" 518.IX Item "-hold|+hold"
507Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 519Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
508will not immediately destroy its window when the program executed within 520will not immediately destroy its window when the program executed within
509it exits. Instead, it will wait till it is being killed or closed by the 521it exits. Instead, it will wait till it is being killed or closed by the
510user; resource \fBhold\fR. 522user; resource \fBhold\fR.
523.IP "\fB\-xrm\fR \fIstring\fR" 4
524.IX Item "-xrm string"
525Works 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
527way take precedence over all other resource specifications.
528.Sp
529Note that you need to use the \fIsame\fR syntax as in the .Xdefaults file,
530e.g. \f(CW\*(C`*.background: black\*(C'\fR. Also note that all @@RXVT_NAME@@\-specific
531options can be specified as long-options on the commandline, so use
532of \fB\-xrm\fR is mostly limited to cases where you want to specify other
533resources (e.g. for input methods) or for compatibility with other
534programs.
511.IP "\fB\-keysym.\fR\fIsym\fR \fIstring\fR" 4 535.IP "\fB\-keysym.\fR\fIsym\fR \fIstring\fR" 4
512.IX Item "-keysym.sym string" 536.IX Item "-keysym.sym string"
513Remap a key symbol. See resource \fBkeysym\fR. 537Remap a key symbol. See resource \fBkeysym\fR.
514.IP "\fB\-embed\fR \fIwindowid\fR" 4 538.IP "\fB\-embed\fR \fIwindowid\fR" 4
515.IX Item "-embed windowid" 539.IX Item "-embed windowid"
… …
549If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 573If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
550entries and will not tinker with pty/tty permissions \- you have to do that 574entries and will not tinker with pty/tty permissions \- you have to do that
551yourself if you want that. 575yourself if you want that.
552.Sp 576.Sp
553As an extremely special case, specifying \f(CW\*(C`\-1\*(C'\fR will completely suppress 577As an extremely special case, specifying \f(CW\*(C`\-1\*(C'\fR will completely suppress
554pty/tty operations. 578pty/tty operations, which is probably only useful in conjunction with some
579perl extension that manages the terminal.
555.Sp 580.Sp
556Here is a example in perl that illustrates how this option can be used (a 581Here is a example in perl that illustrates how this option can be used (a
557longer example is in \fIdoc/pty\-fd\fR): 582longer example is in \fIdoc/pty\-fd\fR):
558.Sp 583.Sp
559.Vb 2 584.Vb 2
… …
575.Ve 600.Ve
576.IP "\fB\-pe\fR \fIstring\fR" 4 601.IP "\fB\-pe\fR \fIstring\fR" 4
577.IX Item "-pe string" 602.IX Item "-pe string"
578Comma-separated list of perl extension scripts to use (or not to use) in 603Comma-separated list of perl extension scripts to use (or not to use) in
579this terminal instance. See resource \fBperl-ext\fR for details. 604this terminal instance. See resource \fBperl-ext\fR for details.
580.SH "RESOURCES (available also as long\-options)" 605.SH "RESOURCES"
581.IX Header "RESOURCES (available also as long-options)" 606.IX Header "RESOURCES"
582Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long 607Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long
583options) compiled into your version. 608options) compiled into your version. All resources are also available as
609long\-options.
584.PP 610.PP
585You can set and change the resources using X11 tools like \fBxrdb\fR. Many 611You can set and change the resources using X11 tools like \fBxrdb\fR. Many
586distribution do also load settings from the \fB~/.Xresources\fR file when X 612distribution do also load settings from the \fB~/.Xresources\fR file when X
587starts. @@RXVT_NAME@@ will consult the following files/resources in order, 613starts. @@RXVT_NAME@@ will consult the following files/resources in order,
588with later settings overwriting earlier ones: 614with later settings overwriting earlier ones:
589.PP 615.PP
590.Vb 5 616.Vb 6
591\& 1. system-wide app-defaults file, either locale-dependent OR global 617\& 1. system-wide app-defaults file, either locale-dependent OR global
592\& 2. app-defaults file in $XAPPLRESDIR 618\& 2. app-defaults file in $XAPPLRESDIR
593\& 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 619\& 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
594\& 4. SCREEN_RESOURCES for the current screen 620\& 4. SCREEN_RESOURCES for the current screen
595\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 621\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
622\& 6. resources specified via -xrm on the commandline
596.Ve 623.Ve
597.PP 624.PP
598Note that when reading X resources, \fB@@RXVT_NAME@@\fR recognizes two class 625Note that when reading X resources, \fB@@RXVT_NAME@@\fR recognizes two class
599names: \fBRxvt\fR and \fBURxvt\fR. The class name \fBRxvt\fR allows resources 626names: \fBRxvt\fR and \fBURxvt\fR. The class name \fBRxvt\fR allows resources
600common to both \fB@@RXVT_NAME@@\fR and the original \fIrxvt\fR to be easily 627common to both \fB@@RXVT_NAME@@\fR and the original \fIrxvt\fR to be easily
… …
688option \fB\-ss\fR. 715option \fB\-ss\fR.
689.Sp 716.Sp
690\&\fBFalse\fR: specify that everything is to be displayed, even 717\&\fBFalse\fR: specify that everything is to be displayed, even
691if the refresh is too fast for the human eye to read anything (or the 718if the refresh is too fast for the human eye to read anything (or the
692monitor to display anything); option \fB+ss\fR. 719monitor to display anything); option \fB+ss\fR.
693.IP "\fBinheritPixmap:\fR \fIboolean\fR" 4 720.IP "\fBtransparent:\fR \fIboolean\fR" 4
694.IX Item "inheritPixmap: boolean" 721.IX Item "transparent: boolean"
695\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving 722Turn on/off illusion of a transparent window background.
696artificial transparency. \fBFalse\fR: do not inherit the parent windows'
697pixmap.
698.Sp 723.Sp
699\&\fIPlease note that transparency of any kind if completely unsupported by 724\&\fBinheritPixmap\fR is still accepted as an obsolete alias but will be removed in
700the author. Don't bug him with installation questions!\fR 725future versions.
726.Sp
727\&\fIPlease address all transparency related issues to Sasha Vasko at
728sasha@aftercode.net. Read the \s-1FAQ\s0 (man 7 @@RXVT_NAME@@)!\fR
701.IP "\fBfading:\fR \fInumber\fR" 4 729.IP "\fBfading:\fR \fInumber\fR" 4
702.IX Item "fading: number" 730.IX Item "fading: number"
703Fade the text by the given percentage when focus is lost; option \fB\-fade\fR. 731Fade the text by the given percentage when focus is lost; option \fB\-fade\fR.
704.IP "\fBfadeColor:\fR \fIcolour\fR" 4 732.IP "\fBfadeColor:\fR \fIcolour\fR" 4
705.IX Item "fadeColor: colour" 733.IX Item "fadeColor: colour"
… …
716.IP "\fBblendType:\fR \fIstring\fR" 4 744.IP "\fBblendType:\fR \fIstring\fR" 4
717.IX Item "blendType: string" 745.IX Item "blendType: string"
718Specify background blending type; option \fB\-blt\fR. 746Specify background blending type; option \fB\-blt\fR.
719.IP "\fBblurRadius:\fR \fInumber\fR" 4 747.IP "\fBblurRadius:\fR \fInumber\fR" 4
720.IX Item "blurRadius: number" 748.IX Item "blurRadius: number"
721Apply Gaussian Blurr with the specified radius to the transparent 749Apply Gaussian Blurr with the specified radius to the transparent
722background image; option \fB\-blr\fR. 750background image; option \fB\-blr\fR.
723.IP "\fBscrollColor:\fR \fIcolour\fR" 4 751.IP "\fBscrollColor:\fR \fIcolour\fR" 4
724.IX Item "scrollColor: colour" 752.IX Item "scrollColor: colour"
725Use the specified colour for the scrollbar [default #B2B2B2]. 753Use the specified colour for the scrollbar [default #B2B2B2].
726.IP "\fBtroughColor:\fR \fIcolour\fR" 4 754.IP "\fBtroughColor:\fR \fIcolour\fR" 4
… …
729#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar. 757#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
730.IP "\fBborderColor:\fR \fIcolour\fR" 4 758.IP "\fBborderColor:\fR \fIcolour\fR" 4
731.IX Item "borderColor: colour" 759.IX Item "borderColor: colour"
732The colour of the border around the text area and between the scrollbar 760The colour of the border around the text area and between the scrollbar
733and the text. 761and the text.
734.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4 762.IP "\fBbackgroundPixmap:\fR \fIfile[;geom[:op1][:op2][...]]\fR" 4
735.IX Item "backgroundPixmap: file[;geom]" 763.IX Item "backgroundPixmap: file[;geom[:op1][:op2][...]]"
736Use the specified image file for the background and also optionally 764Use the specified image file for the background and also
737specify its scaling with a geometry string \fBWxH+X+Y\fR, 765optionally specify its scaling with a geometry string \fBWxH+X+Y\fR,
738in which \fB\*(L"W\*(R" / \*(L"H\*(R"\fR specify the horizontal/vertical scale (percent), 766(default \f(CW\*(C`0x0+50+50\*(C'\fR) in which \fB\*(L"W\*(R" / \*(L"H\*(R"\fR specify the
739and \fB\*(L"X\*(R" / \*(L"Y\*(R"\fR locate the image centre (percent). 767horizontal/vertical scale (percent), and \fB\*(L"X\*(R" / \*(L"Y\*(R"\fR locate the image
740A scale of 0 displays the image with tiling. A scale of 1 displays the 768centre (percent). A scale of 0 displays the image with tiling. A scale
741image without any scaling. A scale of 2 to 9 specifies an integer 769of 1 displays the image without any scaling. A scale of 2 to 9 specifies
742number of images in that direction. No image will be magnified beyond 770an integer number of images in that direction. No image will be magnified
74310 times its original size. The maximum permitted scale is 1000. 771beyond 10 times its original size. The maximum permitted scale is 1000.
744Special string of \fB\*(L"auto\*(R"\fR used as a geometry will cause image to be 772Additional operations can be specified after colon \fB:op1:op2...\fR.
745automatically scaled to match window size. 773Supported operations are:
774.Sp
775.Vb 8
776\& tile force background image to be tiled and not scaled. Equivalent to 0x0,
777\& propscale will scale image keeping proportions,
778\& auto will scale image to match window size. Equivalent to 100x100;
779\& hscale will scale image horizontally to the window size;
780\& vscale will scale image vertically to the window size;
781\& scale will scale image to match window size;
782\& root will tile image as if it was a root window background, auto-adjusting
783\& whenever terminal window moves.
784.Ve
785.Sp
746If used in conjunction with \fB\-tr\fR option \- specified pixmap will be 786If used in conjunction with \fB\-tr\fR option, the specified pixmap will be
747blended over transparency image using either alpha\-blending, or any 787blended over transparency image using either alpha\-blending, or any
748other blending type, specified with \fB\-blt \*(L"type\*(R"\fR option. 788other blending type, specified with \fB\-blt \*(L"type\*(R"\fR option.
749[default 0x0+50+50]
750.IP "\fBpath:\fR \fIpath\fR" 4 789.IP "\fBpath:\fR \fIpath\fR" 4
751.IX Item "path: path" 790.IX Item "path: path"
752Specify the colon-delimited search path for finding \s-1XPM\s0 files. 791Specify the colon-delimited search path for finding background image files.
753.IP "\fBfont:\fR \fIfontlist\fR" 4 792.IP "\fBfont:\fR \fIfontlist\fR" 4
754.IX Item "font: fontlist" 793.IX Item "font: fontlist"
755Select the fonts to be used. This is a comma separated list of font names 794Select the fonts to be used. This is a comma separated list of font names
756that are checked in order when trying to find glyphs for characters. The 795that are checked in order when trying to find glyphs for characters. The
757first font defines the cell size for characters; other fonts might be 796first font defines the cell size for characters; other fonts might be
… …
815If set, but empty, then this specific style is disabled and the normal 854If set, but empty, then this specific style is disabled and the normal
816text font will being used for the given style. 855text font will being used for the given style.
817.IP "\fBintensityStyles:\fR \fIboolean\fR" 4 856.IP "\fBintensityStyles:\fR \fIboolean\fR" 4
818.IX Item "intensityStyles: boolean" 857.IX Item "intensityStyles: boolean"
819When font styles are not enabled, or this option is enabled (\fBTrue\fR, 858When font styles are not enabled, or this option is enabled (\fBTrue\fR,
820option \fB\-is\fR, the default), bold and italic font styles imply high 859option \fB\-is\fR, the default), bold/blink font styles imply high
821intensity foreground/background colours. Disabling this option (\fBFalse\fR, 860intensity foreground/background colours. Disabling this option (\fBFalse\fR,
822option \fB+is\fR) disables this behaviour, the high intensity colours are not 861option \fB+is\fR) disables this behaviour, the high intensity colours are not
823reachable. 862reachable.
824.IP "\fBselectstyle:\fR \fImode\fR" 4 863.IP "\fBselectstyle:\fR \fImode\fR" 4
825.IX Item "selectstyle: mode" 864.IX Item "selectstyle: mode"
… …
935option \fB\-sbg\fR. 974option \fB\-sbg\fR.
936.IP "\fBtermName:\fR \fItermname\fR" 4 975.IP "\fBtermName:\fR \fItermname\fR" 4
937.IX Item "termName: termname" 976.IX Item "termName: termname"
938Specifies the terminal type name to be set in the \fB\s-1TERM\s0\fR environment 977Specifies the terminal type name to be set in the \fB\s-1TERM\s0\fR environment
939variable; option \fB\-tn\fR. 978variable; option \fB\-tn\fR.
940.IP "\fBlinespace:\fR \fInumber\fR" 4 979.IP "\fBlineSpace:\fR \fInumber\fR" 4
941.IX Item "linespace: number" 980.IX Item "lineSpace: number"
942Specifies number of lines (pixel height) to insert between each row of 981Specifies number of lines (pixel height) to insert between each row of
943the display [default 0]; option \fB\-lsp\fR. 982the display [default 0]; option \fB\-lsp\fR.
944.IP "\fBmeta8:\fR \fIboolean\fR" 4 983.IP "\fBmeta8:\fR \fIboolean\fR" 4
945.IX Item "meta8: boolean" 984.IX Item "meta8: boolean"
946\&\fBTrue\fR: handle Meta (Alt) + keypress to set the 8th bit. \fBFalse\fR: 985\&\fBTrue\fR: handle Meta (Alt) + keypress to set the 8th bit. \fBFalse\fR:
… …
994will be created). In this mode, characters outside \s-1ISO\-8859\-1\s0 can be used. 1033will be created). In this mode, characters outside \s-1ISO\-8859\-1\s0 can be used.
995.Sp 1034.Sp
996When the selection extension is not used, only \s-1ISO\-8859\-1\s0 characters can 1035When the selection extension is not used, only \s-1ISO\-8859\-1\s0 characters can
997be used. If not specified, the built-in default is used: 1036be used. If not specified, the built-in default is used:
998.Sp 1037.Sp
999\&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]{|}\fR 1038\&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]^{|}\fR
1000.IP "\fBpreeditType:\fR \fIstyle\fR" 4 1039.IP "\fBpreeditType:\fR \fIstyle\fR" 4
1001.IX Item "preeditType: style" 1040.IX Item "preeditType: style"
1002\&\fBOverTheSpot\fR, \fBOffTheSpot\fR, \fBRoot\fR; option \fB\-pt\fR. 1041\&\fBOverTheSpot\fR, \fBOffTheSpot\fR, \fBRoot\fR; option \fB\-pt\fR.
1003.IP "\fBinputMethod:\fR \fIname\fR" 4 1042.IP "\fBinputMethod:\fR \fIname\fR" 4
1004.IX Item "inputMethod: name" 1043.IX Item "inputMethod: name"
… …
1080searching keysym macros from \fB/usr/X11R6/include/X11/keysymdef.h\fR and 1119searching keysym macros from \fB/usr/X11R6/include/X11/keysymdef.h\fR and
1081omitting the prefix \fB\s-1XK_\s0\fR. Alternatively you can specify \fIkey\fR by its hex 1120omitting the prefix \fB\s-1XK_\s0\fR. Alternatively you can specify \fIkey\fR by its hex
1082keysym value (\fB0x0000 \- 0xFFFF\fR). Note that the lookup of \fIsym\fRs is not 1121keysym value (\fB0x0000 \- 0xFFFF\fR). Note that the lookup of \fIsym\fRs is not
1083performed in an exact manner; however, the closest match is assured. 1122performed in an exact manner; however, the closest match is assured.
1084.Sp 1123.Sp
1085\&\fIstring\fR may contain escape values (\f(CW\*(C`\ea\*(C'\fR: bell, \f(CW\*(C`\eb\*(C'\fR: backspace, 1124\&\fIstring\fR may contain escape values (\f(CW\*(C`\en\*(C'\fR: newline, \f(CW\*(C`\e000\*(C'\fR: octal
1086\&\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, 1125number), see \s-1RESOURCES\s0 in \f(CW\*(C`man 7 X\*(C'\fR for futher details.
1087\&\f(CW\*(C`\e000\*(C'\fR: octal number) or verbatim control characters (\f(CW\*(C`^?\*(C'\fR: delete,
1088\&\f(CW\*(C`^@\*(C'\fR: null, \f(CW\*(C`^A\*(C'\fR ...) and may be enclosed with double quotes so that it
1089can start or end with whitespace. \fBThis feature is deprecated and will
1090be removed\fR.
1091.Sp
1092Please note that you need to double the \f(CW\*(C`\e\*(C'\fR in resource files, as
1093Xlib itself does its own de-escaping (you can use \f(CW\*(C`\e033\*(C'\fR instead of
1094\&\f(CW\*(C`\ee\*(C'\fR (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1095processing).
1096.Sp 1126.Sp
1097You can define a range of keysyms in one shot by providing a \fIstring\fR 1127You can define a range of keysyms in one shot by providing a \fIstring\fR
1098with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimiter `/' 1128with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimiter `/'
1099should be a character not used by the strings. 1129should be a character not used by the strings.
1100.Sp 1130.Sp
… …
1304rxvt-unicode will automatically re-apply these fonts to the output so far. 1334rxvt-unicode will automatically re-apply these fonts to the output so far.
1305.SH "ISO 14755 SUPPORT" 1335.SH "ISO 14755 SUPPORT"
1306.IX Header "ISO 14755 SUPPORT" 1336.IX Header "ISO 14755 SUPPORT"
1307\&\s-1ISO\s0 14755 is a standard for entering and viewing unicode characters 1337\&\s-1ISO\s0 14755 is a standard for entering and viewing unicode characters
1308and character codes using the keyboard. It consists of 4 parts. The 1338and character codes using the keyboard. It consists of 4 parts. The
1309first part is available rxvt-unicode has been compiled with 1339first part is available if rxvt-unicode has been compiled with
1310\&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, the rest is available when rxvt-unicode was compiled 1340\&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, the rest is available when rxvt-unicode was compiled
1311with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR. 1341with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR.
1312.IP "* 5.1: Basic method" 4 1342.IP "* 5.1: Basic method" 4
1313.IX Item "5.1: Basic method" 1343.IX Item "5.1: Basic method"
1314This allows you to enter unicode characters using their hexcode. 1344This allows you to enter unicode characters using their hexcode.
… …
1448Normally set to \f(CW\*(C`rxvt\-unicode\*(C'\fR, unless overwritten at configure time, via 1478Normally set to \f(CW\*(C`rxvt\-unicode\*(C'\fR, unless overwritten at configure time, via
1449resources or on the command line. 1479resources or on the command line.
1450.IP "\fB\s-1COLORTERM\s0\fR" 4 1480.IP "\fB\s-1COLORTERM\s0\fR" 4
1451.IX Item "COLORTERM" 1481.IX Item "COLORTERM"
1452Either \f(CW\*(C`rxvt\*(C'\fR, \f(CW\*(C`rxvt\-xpm\*(C'\fR, depending on whether @@RXVT_NAME@@ was 1482Either \f(CW\*(C`rxvt\*(C'\fR, \f(CW\*(C`rxvt\-xpm\*(C'\fR, depending on whether @@RXVT_NAME@@ was
1453compiled with \s-1XPM\s0 support, and optionally with the added extension 1483compiled with background image support, and optionally with the added
1454\&\f(CW\*(C`\-mono\*(C'\fR to indicate that rxvt-unicode runs on a monochrome screen. 1484extension \f(CW\*(C`\-mono\*(C'\fR to indicate that rxvt-unicode runs on a monochrome
1485screen.
1455.IP "\fB\s-1COLORFGBG\s0\fR" 4 1486.IP "\fB\s-1COLORFGBG\s0\fR" 4
1456.IX Item "COLORFGBG" 1487.IX Item "COLORFGBG"
1457Set 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 1488Set 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
1458the colour code used as default foreground/text colour (or the string 1489the colour code used as default foreground/text colour (or the string
1459\&\f(CW\*(C`default\*(C'\fR to indicate that the default-colour escape sequence is to be 1490\&\f(CW\*(C`default\*(C'\fR to indicate that the default-colour escape sequence is to be
1460used), \f(CW\*(C`bg\*(C'\fR is the colour code used as default background colour (or the 1491used), \f(CW\*(C`bg\*(C'\fR is the colour code used as default background colour (or the
1461string \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@@ 1492string \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@@
1462was compiled with \s-1XPM\s0 support. Libraries like \f(CW\*(C`ncurses\*(C'\fR and \f(CW\*(C`slang\*(C'\fR can 1493was compiled with background image support. Libraries like \f(CW\*(C`ncurses\*(C'\fR
1463(and do) use this information to optimize screen output. 1494and \f(CW\*(C`slang\*(C'\fR can (and do) use this information to optimize screen output.
1464.IP "\fB\s-1WINDOWID\s0\fR" 4 1495.IP "\fB\s-1WINDOWID\s0\fR" 4
1465.IX Item "WINDOWID" 1496.IX Item "WINDOWID"
1466Set to the (decimal) X Window \s-1ID\s0 of the @@RXVT_NAME@@ window (the toplevel 1497Set to the (decimal) X Window \s-1ID\s0 of the @@RXVT_NAME@@ window (the toplevel
1467window, which usually has subwindows for the scrollbar, the terminal 1498window, which usually has subwindows for the scrollbar, the terminal
1468window and so on). 1499window and so on).

Diff Legend

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