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.74 by root, Fri Nov 23 13:11:31 2007 UTC vs.
Revision 1.78 by root, Mon Dec 24 08:00:16 2007 UTC

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-11-23" "8.6" "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,
157like mongolian or scripts requiring extremely complex combining rules, 160like mongolian or scripts requiring extremely complex combining rules,
158like tibetan or devanagari. 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
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\-tr\fR|\fB+tr\fR" 4 238.IP "\fB\-tr\fR|\fB+tr\fR" 4
236.IX Item "-tr|+tr" 239.IX Item "-tr|+tr"
237Turn on/off illusion of a transparent window background. Obsolete form of it is 240Turn on/off illusion of a transparent window background; resource \fBtransparent\fR.
238\&\fB\-ip\fR and it should not be used anymore; resource \fBtransparent\fR.
239.Sp 241.Sp
240\&\fIPlease note that old resource name of \f(BIinheritPixmap\fI is obsolete and should be 242\&\fB\-ip\fR is still accepted as an obsolete alias but will be removed in
241changed to \f(BItransparent\fI. Backwards compatibility support for \f(BIinheritPixmap\fI will 243future versions.
242be phased out in future versions of rxvt!\fR
243.Sp 244.Sp
244\&\fIPlease address all transparency related issues to Sasha Vasko at 245\&\fIPlease address all transparency related issues to Sasha Vasko at
245sasha@aftercode.net. Read the \s-1FAQ\s0 (man 7 @@RXVT_NAME@@)!\fR 246sasha@aftercode.net. Read the \s-1FAQ\s0 (man 7 @@RXVT_NAME@@)!\fR
246.IP "\fB\-fade\fR \fInumber\fR" 4 247.IP "\fB\-fade\fR \fInumber\fR" 4
247.IX Item "-fade number" 248.IX Item "-fade number"
346Compile \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
347italic\fB\fR characters are to be printed. See resource \fBboldItalicFont\fR 348italic\fB\fR characters are to be printed. See resource \fBboldItalicFont\fR
348for details. 349for details.
349.IP "\fB\-is\fR|\fB+is\fR" 4 350.IP "\fB\-is\fR|\fB+is\fR" 4
350.IX Item "-is|+is" 351.IX Item "-is|+is"
351Compile \fIfont-styles\fR: Bold/Italic font styles imply high intensity 352Compile \fIfont-styles\fR: Bold/Blink font styles imply high intensity
352foreground/background (default). See resource \fBintensityStyles\fR for 353foreground/background (default). See resource \fBintensityStyles\fR for
353details. 354details.
354.IP "\fB\-name\fR \fIname\fR" 4 355.IP "\fB\-name\fR \fIname\fR" 4
355.IX Item "-name name" 356.IX Item "-name name"
356Specify the application name under which resources are to be obtained, 357Specify the application name under which resources are to be obtained,
491for more info. 492for more info.
492.IP "\fB\-tcw\fR" 4 493.IP "\fB\-tcw\fR" 4
493.IX Item "-tcw" 494.IX Item "-tcw"
494Change the meaning of triple-click selection with the left mouse 495Change the meaning of triple-click selection with the left mouse
495button. Only effective when the original (non\-perl) selection code is 496button. Only effective when the original (non\-perl) selection code is
496in\-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
497end of the logical line only. resource \fBtripleclickwords\fR. 498the end of the logical line only. resource \fBtripleclickwords\fR.
498.IP "\fB\-insecure\fR" 4 499.IP "\fB\-insecure\fR" 4
499.IX Item "-insecure" 500.IX Item "-insecure"
500Enable \*(L"insecure\*(R" mode, which currently enables most of the escape 501Enable \*(L"insecure\*(R" mode, which currently enables most of the escape
501sequences that echo strings. See the resource \fBinsecure\fR for more 502sequences that echo strings. See the resource \fBinsecure\fR for more
502info. 503info.
572If 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
573entries 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
574yourself if you want that. 575yourself if you want that.
575.Sp 576.Sp
576As 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
577pty/tty operations. 578pty/tty operations, which is probably only useful in conjunction with some
579perl extension that manages the terminal.
578.Sp 580.Sp
579Here 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
580longer example is in \fIdoc/pty\-fd\fR): 582longer example is in \fIdoc/pty\-fd\fR):
581.Sp 583.Sp
582.Vb 2 584.Vb 2
598.Ve 600.Ve
599.IP "\fB\-pe\fR \fIstring\fR" 4 601.IP "\fB\-pe\fR \fIstring\fR" 4
600.IX Item "-pe string" 602.IX Item "-pe string"
601Comma-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
602this terminal instance. See resource \fBperl-ext\fR for details. 604this terminal instance. See resource \fBperl-ext\fR for details.
603.SH "RESOURCES (available also as long\-options)" 605.SH "RESOURCES"
604.IX Header "RESOURCES (available also as long-options)" 606.IX Header "RESOURCES"
605Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long 607Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long
606options) compiled into your version. 608options) compiled into your version. All resources are also available as
609long\-options.
607.PP 610.PP
608You 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
609distribution 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
610starts. @@RXVT_NAME@@ will consult the following files/resources in order, 613starts. @@RXVT_NAME@@ will consult the following files/resources in order,
611with later settings overwriting earlier ones: 614with later settings overwriting earlier ones:
712option \fB\-ss\fR. 715option \fB\-ss\fR.
713.Sp 716.Sp
714\&\fBFalse\fR: specify that everything is to be displayed, even 717\&\fBFalse\fR: specify that everything is to be displayed, even
715if 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
716monitor to display anything); option \fB+ss\fR. 719monitor to display anything); option \fB+ss\fR.
717.IP "\fBinheritPixmap:\fR \fIboolean\fR" 4 720.IP "\fBtransparent:\fR \fIboolean\fR" 4
718.IX Item "inheritPixmap: boolean" 721.IX Item "transparent: boolean"
719\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving 722Turn on/off illusion of a transparent window background.
720artificial transparency. \fBFalse\fR: do not inherit the parent windows'
721pixmap.
722.Sp 723.Sp
723\&\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
724the 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
725.IP "\fBfading:\fR \fInumber\fR" 4 729.IP "\fBfading:\fR \fInumber\fR" 4
726.IX Item "fading: number" 730.IX Item "fading: number"
727Fade 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.
728.IP "\fBfadeColor:\fR \fIcolour\fR" 4 732.IP "\fBfadeColor:\fR \fIcolour\fR" 4
729.IX Item "fadeColor: colour" 733.IX Item "fadeColor: colour"
850If 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
851text font will being used for the given style. 855text font will being used for the given style.
852.IP "\fBintensityStyles:\fR \fIboolean\fR" 4 856.IP "\fBintensityStyles:\fR \fIboolean\fR" 4
853.IX Item "intensityStyles: boolean" 857.IX Item "intensityStyles: boolean"
854When 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,
855option \fB\-is\fR, the default), bold and italic font styles imply high 859option \fB\-is\fR, the default), bold/blink font styles imply high
856intensity foreground/background colours. Disabling this option (\fBFalse\fR, 860intensity foreground/background colours. Disabling this option (\fBFalse\fR,
857option \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
858reachable. 862reachable.
859.IP "\fBselectstyle:\fR \fImode\fR" 4
860.IX Item "selectstyle: mode"
861Set mouse selection style to \fBold\fR which is 2.20, \fBoldword\fR which
862is xterm style with 2.20 old word selection, or anything else which
863gives xterm style selection. Only effective when the original (non\-perl)
864selection code is in use.
865.IP "\fBscrollstyle:\fR \fImode\fR" 4 863.IP "\fBscrollstyle:\fR \fImode\fR" 4
866.IX Item "scrollstyle: mode" 864.IX Item "scrollstyle: mode"
867Set 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
868the author's favourite. 866the author's favourite.
869.IP "\fBtitle:\fR \fIstring\fR" 4 867.IP "\fBtitle:\fR \fIstring\fR" 4

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines