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.67 by root, Sat Jun 2 04:58:58 2007 UTC vs.
Revision 1.78 by root, Mon Dec 24 08:00:16 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-02" "8.2" "RXVT-UNICODE" 132.TH @@RXVT_NAME@@ 1 "2007-12-24" "8.9" "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
… …
226.IP "\fB\-rv\fR|\fB+rv\fR" 4 229.IP "\fB\-rv\fR|\fB+rv\fR" 4
227.IX Item "-rv|+rv" 230.IX Item "-rv|+rv"
228Turn on/off simulated reverse video; resource \fBreverseVideo\fR. 231Turn on/off simulated reverse video; resource \fBreverseVideo\fR.
229.IP "\fB\-j\fR|\fB+j\fR" 4 232.IP "\fB\-j\fR|\fB+j\fR" 4
230.IX Item "-j|+j" 233.IX Item "-j|+j"
231Turn on/off jump scrolling; resource \fBjumpScroll\fR. 234Turn on/off jump scrolling (allow multiple lines per refresh); resource \fBjumpScroll\fR.
232.IP "\fB\-ip\fR|\fB+ip\fR | \fB\-tr\fR|\fB+tr\fR" 4 235.IP "\fB\-ss\fR|\fB+ss\fR" 4
236.IX Item "-ss|+ss"
237Turn on/off skip scrolling (allow multiple screens per refresh); resource \fBskipScroll\fR.
238.IP "\fB\-tr\fR|\fB+tr\fR" 4
233.IX Item "-ip|+ip | -tr|+tr" 239.IX Item "-tr|+tr"
234Turn on/off inheriting parent window's pixmap. Alternative form is 240Turn on/off illusion of a transparent window background; resource \fBtransparent\fR.
235\&\fB\-tr\fR; resource \fBinheritPixmap\fR.
236.Sp 241.Sp
237\&\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
238the author. Don't bug him with installation questions! Read the \s-1FAQ\s0 (man 7 243future versions.
239@@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
240.IP "\fB\-fade\fR \fInumber\fR" 4 247.IP "\fB\-fade\fR \fInumber\fR" 4
241.IX Item "-fade number" 248.IX Item "-fade number"
242Fade 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
243fade a little only, 100 completely replaces all colours by the fade 250fade a little only, 100 completely replaces all colours by the fade
244colour; resource \fBfading\fR. 251colour; resource \fBfading\fR.
… …
247Fade 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
248is opaque black. resource \fBfadeColor\fR. 255is opaque black. resource \fBfadeColor\fR.
249.IP "\fB\-tint\fR \fIcolour\fR" 4 256.IP "\fB\-tint\fR \fIcolour\fR" 4
250.IX Item "-tint colour" 257.IX Item "-tint colour"
251Tint the transparent background pixmap with the given colour when 258Tint the transparent background pixmap with the given colour when
252transparency 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
253non-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
254used 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
255\&\fItintColor\fR. Example: 266\&\fItintColor\fR. Example:
256.Sp 267.Sp
257.Vb 1 268.Vb 1
258\& @@RXVT_NAME@@ -tr -tint blue -sh 40 269\& @@RXVT_NAME@@ -tr -tint blue -sh 40
259.Ve 270.Ve
260.IP "\fB\-sh\fR" 4 271.IP "\fB\-sh\fR \fInumber\fR" 4
261.IX Item "-sh" 272.IX Item "-sh number"
262\&\fInumber\fR Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent 273Darken (0 .. 100) or lighten (100 .. 200) the transparent
263background image in addition to tinting it (i.e. \fB\-tint\fR must be 274background image in addition to (or instead of) tinting it;
264specified, too, e.g. \f(CW\*(C`\-tint white\*(C'\fR); resource \fIshading\fR. 275resource \fIshading\fR.
276.IP "\fB\-blt\fR \fIstring\fR" 4
277.IX Item "-blt string"
278Specify background blending type. If background pixmap is specified
279at the same time as transparency \- such pixmap will be blended over
280transparency image, using method specified. Supported values are :
281\&\fBadd\fR, \fBalphablend\fR, \fBallanon\fR \- color values averaging, \fBcolorize\fR,
282\&\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
284alpha\-blending. Compile \fIafterimage\fR; resource \fIblendType\fR.
285.IP "\fB\-blr\fR \fIHxV\fR" 4
286.IX Item "-blr HxV"
287Apply Gaussian Blur with the specified radii to the transparent
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.
265.IP "\fB\-bg\fR \fIcolour\fR" 4 293.IP "\fB\-bg\fR \fIcolour\fR" 4
266.IX Item "-bg colour" 294.IX Item "-bg colour"
267Window background colour; resource \fBbackground\fR. 295Window background colour; resource \fBbackground\fR.
268.IP "\fB\-fg\fR \fIcolour\fR" 4 296.IP "\fB\-fg\fR \fIcolour\fR" 4
269.IX Item "-fg colour" 297.IX Item "-fg colour"
270Window foreground colour; resource \fBforeground\fR. 298Window foreground colour; resource \fBforeground\fR.
271.IP "\fB\-pixmap\fR \fIfile[;geom]\fR" 4 299.IP "\fB\-pixmap\fR \fIfile[;geom[:op1][:op2][...]]\fR" 4
272.IX Item "-pixmap file[;geom]" 300.IX Item "-pixmap file[;geom[:op1][:op2][...]]"
273Compile \fI\s-1XPM\s0\fR: Specify \s-1XPM\s0 file for the background and also optionally 301Compile \fIafterimage\fR: Specify image file for the background and also
274specify its scaling with a geometry string. Note you may need to 302optionally specify its scaling with a geometry string. Note you may need to
275add 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
276command\-line; resource \fBbackgroundPixmap\fR. 304command\-line; for more details see resource \fBbackgroundPixmap\fR.
277.IP "\fB\-cr\fR \fIcolour\fR" 4 305.IP "\fB\-cr\fR \fIcolour\fR" 4
278.IX Item "-cr colour" 306.IX Item "-cr colour"
279The cursor colour; resource \fBcursorColor\fR. 307The cursor colour; resource \fBcursorColor\fR.
280.IP "\fB\-pr\fR \fIcolour\fR" 4 308.IP "\fB\-pr\fR \fIcolour\fR" 4
281.IX Item "-pr colour" 309.IX Item "-pr colour"
… …
319Compile \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
320italic\fB\fR characters are to be printed. See resource \fBboldItalicFont\fR 348italic\fB\fR characters are to be printed. See resource \fBboldItalicFont\fR
321for details. 349for details.
322.IP "\fB\-is\fR|\fB+is\fR" 4 350.IP "\fB\-is\fR|\fB+is\fR" 4
323.IX Item "-is|+is" 351.IX Item "-is|+is"
324Compile \fIfont-styles\fR: Bold/Italic font styles imply high intensity 352Compile \fIfont-styles\fR: Bold/Blink font styles imply high intensity
325foreground/background (default). See resource \fBintensityStyles\fR for 353foreground/background (default). See resource \fBintensityStyles\fR for
326details. 354details.
327.IP "\fB\-name\fR \fIname\fR" 4 355.IP "\fB\-name\fR \fIname\fR" 4
328.IX Item "-name name" 356.IX Item "-name name"
329Specify the application name under which resources are to be obtained, 357Specify the application name under which resources are to be obtained,
… …
407resource \fBskipBuiltinGlyphs\fR. 435resource \fBskipBuiltinGlyphs\fR.
408.IP "\fB\-lsp\fR \fInumber\fR" 4 436.IP "\fB\-lsp\fR \fInumber\fR" 4
409.IX Item "-lsp number" 437.IX Item "-lsp number"
410Compile \fIfrills\fR: Lines (pixel height) to insert between each row of 438Compile \fIfrills\fR: Lines (pixel height) to insert between each row of
411the display. Useful to work around font rendering problems; resource 439the display. Useful to work around font rendering problems; resource
412\&\fBlinespace\fR. 440\&\fBlineSpace\fR.
413.IP "\fB\-tn\fR \fItermname\fR" 4 441.IP "\fB\-tn\fR \fItermname\fR" 4
414.IX Item "-tn termname" 442.IX Item "-tn termname"
415This 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
416\&\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
417\&\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;
… …
464for more info. 492for more info.
465.IP "\fB\-tcw\fR" 4 493.IP "\fB\-tcw\fR" 4
466.IX Item "-tcw" 494.IX Item "-tcw"
467Change the meaning of triple-click selection with the left mouse 495Change the meaning of triple-click selection with the left mouse
468button. Only effective when the original (non\-perl) selection code is 496button. Only effective when the original (non\-perl) selection code is
469in\-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
470end of the logical line only. resource \fBtripleclickwords\fR. 498the end of the logical line only. resource \fBtripleclickwords\fR.
471.IP "\fB\-insecure\fR" 4 499.IP "\fB\-insecure\fR" 4
472.IX Item "-insecure" 500.IX Item "-insecure"
473Enable \*(L"insecure\*(R" mode, which currently enables most of the escape 501Enable \*(L"insecure\*(R" mode, which currently enables most of the escape
474sequences that echo strings. See the resource \fBinsecure\fR for more 502sequences that echo strings. See the resource \fBinsecure\fR for more
475info. 503info.
… …
490.IX Item "-hold|+hold" 518.IX Item "-hold|+hold"
491Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 519Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
492will not immediately destroy its window when the program executed within 520will not immediately destroy its window when the program executed within
493it 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
494user; 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.
495.IP "\fB\-keysym.\fR\fIsym\fR \fIstring\fR" 4 535.IP "\fB\-keysym.\fR\fIsym\fR \fIstring\fR" 4
496.IX Item "-keysym.sym string" 536.IX Item "-keysym.sym string"
497Remap a key symbol. See resource \fBkeysym\fR. 537Remap a key symbol. See resource \fBkeysym\fR.
498.IP "\fB\-embed\fR \fIwindowid\fR" 4 538.IP "\fB\-embed\fR \fIwindowid\fR" 4
499.IX Item "-embed windowid" 539.IX Item "-embed windowid"
… …
533If 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
534entries 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
535yourself if you want that. 575yourself if you want that.
536.Sp 576.Sp
537As 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
538pty/tty operations. 578pty/tty operations, which is probably only useful in conjunction with some
579perl extension that manages the terminal.
539.Sp 580.Sp
540Here 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
541longer example is in \fIdoc/pty\-fd\fR): 582longer example is in \fIdoc/pty\-fd\fR):
542.Sp 583.Sp
543.Vb 2 584.Vb 2
… …
559.Ve 600.Ve
560.IP "\fB\-pe\fR \fIstring\fR" 4 601.IP "\fB\-pe\fR \fIstring\fR" 4
561.IX Item "-pe string" 602.IX Item "-pe string"
562Comma-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
563this terminal instance. See resource \fBperl-ext\fR for details. 604this terminal instance. See resource \fBperl-ext\fR for details.
564.SH "RESOURCES (available also as long\-options)" 605.SH "RESOURCES"
565.IX Header "RESOURCES (available also as long-options)" 606.IX Header "RESOURCES"
566Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long 607Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long
567options) compiled into your version. 608options) compiled into your version. All resources are also available as
609long\-options.
568.PP 610.PP
569You 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
570distribution 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
571starts. @@RXVT_NAME@@ will consult the following files/resources in order, 613starts. @@RXVT_NAME@@ will consult the following files/resources in order,
572with later settings overwriting earlier ones: 614with later settings overwriting earlier ones:
573.PP 615.PP
574.Vb 5 616.Vb 6
575\& 1. system-wide app-defaults file, either locale-dependent OR global 617\& 1. system-wide app-defaults file, either locale-dependent OR global
576\& 2. app-defaults file in $XAPPLRESDIR 618\& 2. app-defaults file in $XAPPLRESDIR
577\& 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 619\& 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
578\& 4. SCREEN_RESOURCES for the current screen 620\& 4. SCREEN_RESOURCES for the current screen
579\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 621\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
622\& 6. resources specified via -xrm on the commandline
580.Ve 623.Ve
581.PP 624.PP
582Note 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
583names: \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
584common 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
… …
654\&\fBTrue\fR: simulate reverse video by foreground and background colours; 697\&\fBTrue\fR: simulate reverse video by foreground and background colours;
655option \fB\-rv\fR. \fBFalse\fR: regular screen colours [default]; option 698option \fB\-rv\fR. \fBFalse\fR: regular screen colours [default]; option
656\&\fB+rv\fR. See note in \fB\s-1COLORS\s0 \s-1AND\s0 \s-1GRAPHICS\s0\fR section. 699\&\fB+rv\fR. See note in \fB\s-1COLORS\s0 \s-1AND\s0 \s-1GRAPHICS\s0\fR section.
657.IP "\fBjumpScroll:\fR \fIboolean\fR" 4 700.IP "\fBjumpScroll:\fR \fIboolean\fR" 4
658.IX Item "jumpScroll: boolean" 701.IX Item "jumpScroll: boolean"
659\&\fBTrue\fR: specify that jump scrolling should be used. When scrolling 702\&\fBTrue\fR: specify that jump scrolling should be used. When receiving lots
660quickly, fewer screen updates are performed [default]; option \fB\-j\fR. 703of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
704has been read, resulting in fewer updates while still displaying every
705received line; option \fB\-j\fR.
706.Sp
661\&\fBFalse\fR: specify that smooth scrolling should be used; option \fB+j\fR. 707\&\fBFalse\fR: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
708force a screen refresh on each new line it received; option \fB+j\fR.
709.IP "\fBskipScroll:\fR \fIboolean\fR" 4
710.IX Item "skipScroll: boolean"
711\&\fBTrue\fR: (the default) specify that skip scrolling should be used. When
712receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
713(around 60 times per second), resulting in far fewer updates. This can
714result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
715option \fB\-ss\fR.
716.Sp
717\&\fBFalse\fR: specify that everything is to be displayed, even
718if the refresh is too fast for the human eye to read anything (or the
719monitor to display anything); option \fB+ss\fR.
662.IP "\fBinheritPixmap:\fR \fIboolean\fR" 4 720.IP "\fBtransparent:\fR \fIboolean\fR" 4
663.IX Item "inheritPixmap: boolean" 721.IX Item "transparent: boolean"
664\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving 722Turn on/off illusion of a transparent window background.
665artificial transparency. \fBFalse\fR: do not inherit the parent windows'
666pixmap.
667.Sp 723.Sp
668\&\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
669the 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
670.IP "\fBfading:\fR \fInumber\fR" 4 729.IP "\fBfading:\fR \fInumber\fR" 4
671.IX Item "fading: number" 730.IX Item "fading: number"
672Fade 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.
673.IP "\fBfadeColor:\fR \fIcolour\fR" 4 732.IP "\fBfadeColor:\fR \fIcolour\fR" 4
674.IX Item "fadeColor: colour" 733.IX Item "fadeColor: colour"
… …
680\&\fB\-tint\fR. 739\&\fB\-tint\fR.
681.IP "\fBshading:\fR \fInumber\fR" 4 740.IP "\fBshading:\fR \fInumber\fR" 4
682.IX Item "shading: number" 741.IX Item "shading: number"
683Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background image 742Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background image
684in addition to tinting it; option \fB\-sh\fR. 743in addition to tinting it; option \fB\-sh\fR.
744.IP "\fBblendType:\fR \fIstring\fR" 4
745.IX Item "blendType: string"
746Specify background blending type; option \fB\-blt\fR.
747.IP "\fBblurRadius:\fR \fInumber\fR" 4
748.IX Item "blurRadius: number"
749Apply Gaussian Blurr with the specified radius to the transparent
750background image; option \fB\-blr\fR.
685.IP "\fBscrollColor:\fR \fIcolour\fR" 4 751.IP "\fBscrollColor:\fR \fIcolour\fR" 4
686.IX Item "scrollColor: colour" 752.IX Item "scrollColor: colour"
687Use the specified colour for the scrollbar [default #B2B2B2]. 753Use the specified colour for the scrollbar [default #B2B2B2].
688.IP "\fBtroughColor:\fR \fIcolour\fR" 4 754.IP "\fBtroughColor:\fR \fIcolour\fR" 4
689.IX Item "troughColor: colour" 755.IX Item "troughColor: colour"
… …
691#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar. 757#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
692.IP "\fBborderColor:\fR \fIcolour\fR" 4 758.IP "\fBborderColor:\fR \fIcolour\fR" 4
693.IX Item "borderColor: colour" 759.IX Item "borderColor: colour"
694The 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
695and the text. 761and the text.
696.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4 762.IP "\fBbackgroundPixmap:\fR \fIfile[;geom[:op1][:op2][...]]\fR" 4
697.IX Item "backgroundPixmap: file[;geom]" 763.IX Item "backgroundPixmap: file[;geom[:op1][:op2][...]]"
698Use the specified \s-1XPM\s0 file (note the `.xpm' extension is optional) for 764Use the specified image file for the background and also
699the background and also optionally specify its scaling with a geometry 765optionally specify its scaling with a geometry string \fBWxH+X+Y\fR,
700string \fBWxH+X+Y\fR, in which \fB\*(L"W\*(R" / \*(L"H\*(R"\fR specify the 766(default \f(CW\*(C`0x0+50+50\*(C'\fR) in which \fB\*(L"W\*(R" / \*(L"H\*(R"\fR specify the
701horizontal/vertical scale (percent) and \fB\*(L"X\*(R" / \*(L"Y\*(R"\fR locate the image 767horizontal/vertical scale (percent), and \fB\*(L"X\*(R" / \*(L"Y\*(R"\fR locate the image
702centre (percent). A scale of 0 displays the image with tiling. A scale 768centre (percent). A scale of 0 displays the image with tiling. A scale
703of 1 displays the image without any scaling. A scale of 2 to 9 769of 1 displays the image without any scaling. A scale of 2 to 9 specifies
704specifies an integer number of images in that direction. No image will 770an integer number of images in that direction. No image will be magnified
705be magnified beyond 10 times its original size. The maximum permitted 771beyond 10 times its original size. The maximum permitted scale is 1000.
706scale is 1000. [default 0x0+50+50] 772Additional operations can be specified after colon \fB:op1:op2...\fR.
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
786If used in conjunction with \fB\-tr\fR option, the specified pixmap will be
787blended over transparency image using either alpha\-blending, or any
788other blending type, specified with \fB\-blt \*(L"type\*(R"\fR option.
707.IP "\fBpath:\fR \fIpath\fR" 4 789.IP "\fBpath:\fR \fIpath\fR" 4
708.IX Item "path: path" 790.IX Item "path: path"
709Specify the colon-delimited search path for finding \s-1XPM\s0 files. 791Specify the colon-delimited search path for finding background image files.
710.IP "\fBfont:\fR \fIfontlist\fR" 4 792.IP "\fBfont:\fR \fIfontlist\fR" 4
711.IX Item "font: fontlist" 793.IX Item "font: fontlist"
712Select 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
713that 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
714first font defines the cell size for characters; other fonts might be 796first font defines the cell size for characters; other fonts might be
… …
772If 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
773text font will being used for the given style. 855text font will being used for the given style.
774.IP "\fBintensityStyles:\fR \fIboolean\fR" 4 856.IP "\fBintensityStyles:\fR \fIboolean\fR" 4
775.IX Item "intensityStyles: boolean" 857.IX Item "intensityStyles: boolean"
776When 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,
777option \fB\-is\fR, the default), bold and italic font styles imply high 859option \fB\-is\fR, the default), bold/blink font styles imply high
778intensity foreground/background colours. Disabling this option (\fBFalse\fR, 860intensity foreground/background colours. Disabling this option (\fBFalse\fR,
779option \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
780reachable. 862reachable.
781.IP "\fBselectstyle:\fR \fImode\fR" 4
782.IX Item "selectstyle: mode"
783Set mouse selection style to \fBold\fR which is 2.20, \fBoldword\fR which
784is xterm style with 2.20 old word selection, or anything else which
785gives xterm style selection. Only effective when the original (non\-perl)
786selection code is in use.
787.IP "\fBscrollstyle:\fR \fImode\fR" 4 863.IP "\fBscrollstyle:\fR \fImode\fR" 4
788.IX Item "scrollstyle: mode" 864.IX Item "scrollstyle: mode"
789Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is 865Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is
790the author's favourite. 866the author's favourite.
791.IP "\fBtitle:\fR \fIstring\fR" 4 867.IP "\fBtitle:\fR \fIstring\fR" 4
… …
892option \fB\-sbg\fR. 968option \fB\-sbg\fR.
893.IP "\fBtermName:\fR \fItermname\fR" 4 969.IP "\fBtermName:\fR \fItermname\fR" 4
894.IX Item "termName: termname" 970.IX Item "termName: termname"
895Specifies the terminal type name to be set in the \fB\s-1TERM\s0\fR environment 971Specifies the terminal type name to be set in the \fB\s-1TERM\s0\fR environment
896variable; option \fB\-tn\fR. 972variable; option \fB\-tn\fR.
897.IP "\fBlinespace:\fR \fInumber\fR" 4 973.IP "\fBlineSpace:\fR \fInumber\fR" 4
898.IX Item "linespace: number" 974.IX Item "lineSpace: number"
899Specifies number of lines (pixel height) to insert between each row of 975Specifies number of lines (pixel height) to insert between each row of
900the display [default 0]; option \fB\-lsp\fR. 976the display [default 0]; option \fB\-lsp\fR.
901.IP "\fBmeta8:\fR \fIboolean\fR" 4 977.IP "\fBmeta8:\fR \fIboolean\fR" 4
902.IX Item "meta8: boolean" 978.IX Item "meta8: boolean"
903\&\fBTrue\fR: handle Meta (Alt) + keypress to set the 8th bit. \fBFalse\fR: 979\&\fBTrue\fR: handle Meta (Alt) + keypress to set the 8th bit. \fBFalse\fR:
… …
951will be created). In this mode, characters outside \s-1ISO\-8859\-1\s0 can be used. 1027will be created). In this mode, characters outside \s-1ISO\-8859\-1\s0 can be used.
952.Sp 1028.Sp
953When the selection extension is not used, only \s-1ISO\-8859\-1\s0 characters can 1029When the selection extension is not used, only \s-1ISO\-8859\-1\s0 characters can
954be used. If not specified, the built-in default is used: 1030be used. If not specified, the built-in default is used:
955.Sp 1031.Sp
956\&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]{|}\fR 1032\&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]^{|}\fR
957.IP "\fBpreeditType:\fR \fIstyle\fR" 4 1033.IP "\fBpreeditType:\fR \fIstyle\fR" 4
958.IX Item "preeditType: style" 1034.IX Item "preeditType: style"
959\&\fBOverTheSpot\fR, \fBOffTheSpot\fR, \fBRoot\fR; option \fB\-pt\fR. 1035\&\fBOverTheSpot\fR, \fBOffTheSpot\fR, \fBRoot\fR; option \fB\-pt\fR.
960.IP "\fBinputMethod:\fR \fIname\fR" 4 1036.IP "\fBinputMethod:\fR \fIname\fR" 4
961.IX Item "inputMethod: name" 1037.IX Item "inputMethod: name"
… …
1037searching keysym macros from \fB/usr/X11R6/include/X11/keysymdef.h\fR and 1113searching keysym macros from \fB/usr/X11R6/include/X11/keysymdef.h\fR and
1038omitting the prefix \fB\s-1XK_\s0\fR. Alternatively you can specify \fIkey\fR by its hex 1114omitting the prefix \fB\s-1XK_\s0\fR. Alternatively you can specify \fIkey\fR by its hex
1039keysym value (\fB0x0000 \- 0xFFFF\fR). Note that the lookup of \fIsym\fRs is not 1115keysym value (\fB0x0000 \- 0xFFFF\fR). Note that the lookup of \fIsym\fRs is not
1040performed in an exact manner; however, the closest match is assured. 1116performed in an exact manner; however, the closest match is assured.
1041.Sp 1117.Sp
1042\&\fIstring\fR may contain escape values (\f(CW\*(C`\ea\*(C'\fR: bell, \f(CW\*(C`\eb\*(C'\fR: backspace, 1118\&\fIstring\fR may contain escape values (\f(CW\*(C`\en\*(C'\fR: newline, \f(CW\*(C`\e000\*(C'\fR: octal
1043\&\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, 1119number), see \s-1RESOURCES\s0 in \f(CW\*(C`man 7 X\*(C'\fR for futher details.
1044\&\f(CW\*(C`\e000\*(C'\fR: octal number) or verbatim control characters (\f(CW\*(C`^?\*(C'\fR: delete,
1045\&\f(CW\*(C`^@\*(C'\fR: null, \f(CW\*(C`^A\*(C'\fR ...) and may be enclosed with double quotes so that it
1046can start or end with whitespace. \fBThis feature is deprecated and will
1047be removed\fR.
1048.Sp
1049Please note that you need to double the \f(CW\*(C`\e\*(C'\fR in resource files, as
1050Xlib itself does its own de-escaping (you can use \f(CW\*(C`\e033\*(C'\fR instead of
1051\&\f(CW\*(C`\ee\*(C'\fR (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1052processing).
1053.Sp 1120.Sp
1054You can define a range of keysyms in one shot by providing a \fIstring\fR 1121You can define a range of keysyms in one shot by providing a \fIstring\fR
1055with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimiter `/' 1122with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimiter `/'
1056should be a character not used by the strings. 1123should be a character not used by the strings.
1057.Sp 1124.Sp
… …
1187Compile \fIfrills\fR: Sets the \s-1WM_TRANSIENT_FOR\s0 property to the given window id. 1254Compile \fIfrills\fR: Sets the \s-1WM_TRANSIENT_FOR\s0 property to the given window id.
1188.IP "\fBoverride-redirect\fR: \fIboolean\fR" 4 1255.IP "\fBoverride-redirect\fR: \fIboolean\fR" 4
1189.IX Item "override-redirect: boolean" 1256.IX Item "override-redirect: boolean"
1190Compile \fIfrills\fR: Sets override-redirect for the terminal window, making 1257Compile \fIfrills\fR: Sets override-redirect for the terminal window, making
1191it almost invisible to window managers; option \fB\-override\-redirect\fR. 1258it almost invisible to window managers; option \fB\-override\-redirect\fR.
1259.IP "\fBiso14755_52:\fR \fIboolean\fR" 4
1260.IX Item "iso14755_52: boolean"
1261Turn on/off \s-1ISO\s0 14755 5.2 mode (default enabled).
1192.SH "THE SCROLLBAR" 1262.SH "THE SCROLLBAR"
1193.IX Header "THE SCROLLBAR" 1263.IX Header "THE SCROLLBAR"
1194Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window 1264Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window
1195(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar 1265(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar
1196or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and 1266or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and
… …
1258rxvt-unicode will automatically re-apply these fonts to the output so far. 1328rxvt-unicode will automatically re-apply these fonts to the output so far.
1259.SH "ISO 14755 SUPPORT" 1329.SH "ISO 14755 SUPPORT"
1260.IX Header "ISO 14755 SUPPORT" 1330.IX Header "ISO 14755 SUPPORT"
1261\&\s-1ISO\s0 14755 is a standard for entering and viewing unicode characters 1331\&\s-1ISO\s0 14755 is a standard for entering and viewing unicode characters
1262and character codes using the keyboard. It consists of 4 parts. The 1332and character codes using the keyboard. It consists of 4 parts. The
1263first part is available rxvt-unicode has been compiled with 1333first part is available if rxvt-unicode has been compiled with
1264\&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, the rest is available when rxvt-unicode was compiled 1334\&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, the rest is available when rxvt-unicode was compiled
1265with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR. 1335with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR.
1266.IP "* 5.1: Basic method" 4 1336.IP "* 5.1: Basic method" 4
1267.IX Item "5.1: Basic method" 1337.IX Item "5.1: Basic method"
1268This allows you to enter unicode characters using their hexcode. 1338This allows you to enter unicode characters using their hexcode.
… …
1402Normally set to \f(CW\*(C`rxvt\-unicode\*(C'\fR, unless overwritten at configure time, via 1472Normally set to \f(CW\*(C`rxvt\-unicode\*(C'\fR, unless overwritten at configure time, via
1403resources or on the command line. 1473resources or on the command line.
1404.IP "\fB\s-1COLORTERM\s0\fR" 4 1474.IP "\fB\s-1COLORTERM\s0\fR" 4
1405.IX Item "COLORTERM" 1475.IX Item "COLORTERM"
1406Either \f(CW\*(C`rxvt\*(C'\fR, \f(CW\*(C`rxvt\-xpm\*(C'\fR, depending on whether @@RXVT_NAME@@ was 1476Either \f(CW\*(C`rxvt\*(C'\fR, \f(CW\*(C`rxvt\-xpm\*(C'\fR, depending on whether @@RXVT_NAME@@ was
1407compiled with \s-1XPM\s0 support, and optionally with the added extension 1477compiled with background image support, and optionally with the added
1408\&\f(CW\*(C`\-mono\*(C'\fR to indicate that rxvt-unicode runs on a monochrome screen. 1478extension \f(CW\*(C`\-mono\*(C'\fR to indicate that rxvt-unicode runs on a monochrome
1479screen.
1409.IP "\fB\s-1COLORFGBG\s0\fR" 4 1480.IP "\fB\s-1COLORFGBG\s0\fR" 4
1410.IX Item "COLORFGBG" 1481.IX Item "COLORFGBG"
1411Set 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 1482Set 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
1412the colour code used as default foreground/text colour (or the string 1483the colour code used as default foreground/text colour (or the string
1413\&\f(CW\*(C`default\*(C'\fR to indicate that the default-colour escape sequence is to be 1484\&\f(CW\*(C`default\*(C'\fR to indicate that the default-colour escape sequence is to be
1414used), \f(CW\*(C`bg\*(C'\fR is the colour code used as default background colour (or the 1485used), \f(CW\*(C`bg\*(C'\fR is the colour code used as default background colour (or the
1415string \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@@ 1486string \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@@
1416was compiled with \s-1XPM\s0 support. Libraries like \f(CW\*(C`ncurses\*(C'\fR and \f(CW\*(C`slang\*(C'\fR can 1487was compiled with background image support. Libraries like \f(CW\*(C`ncurses\*(C'\fR
1417(and do) use this information to optimize screen output. 1488and \f(CW\*(C`slang\*(C'\fR can (and do) use this information to optimize screen output.
1418.IP "\fB\s-1WINDOWID\s0\fR" 4 1489.IP "\fB\s-1WINDOWID\s0\fR" 4
1419.IX Item "WINDOWID" 1490.IX Item "WINDOWID"
1420Set to the (decimal) X Window \s-1ID\s0 of the @@RXVT_NAME@@ window (the toplevel 1491Set to the (decimal) X Window \s-1ID\s0 of the @@RXVT_NAME@@ window (the toplevel
1421window, which usually has subwindows for the scrollbar, the terminal 1492window, which usually has subwindows for the scrollbar, the terminal
1422window and so on). 1493window and so on).

Diff Legend

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