ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1 (file contents):
Revision 1.13 by root, Mon Jul 26 14:57:11 2004 UTC vs.
Revision 1.23 by root, Sun Aug 8 16:43:55 2004 UTC

1.if !\n(.g .ab GNU tbl requires GNU troff. 1.if !\n(.g .ab GNU tbl requires GNU troff.
2.if !dTS .ds TS 2.if !dTS .ds TS
3.if !dTE .ds TE 3.if !dTE .ds TE
4.TH "RXVT" "1" "2004-06-26" "X Version 11" "X Tools" 4.TH "RXVT" "1" "2004-08-06" "X Version 11" "X Tools"
5.SH "NAME" 5.SH "NAME"
6rxvt-unicode (ouR XVT, unicode) \- a VT102 emulator for the X window system 6rxvt-unicode (ouR XVT, unicode) \- a VT102 emulator for the X window system
7.PP 7.PP
8.SH "SYNOPSIS" 8.SH "SYNOPSIS"
9.PP 9.PP
10\fBurxvt\fP [options] [-e command [ args ]] 10\fBrxvt\fP [options] [-e command [ args ]]
11.PP 11.PP
12.SH "DESCRIPTION" 12.SH "DESCRIPTION"
13.PP 13.PP
14\fBrxvt-unicode\fP, version \fB3\&.1\fP, is a colour vt102 terminal emulator 14\fBrxvt-unicode\fP, version \fB3\&.4\fP, is a colour vt102 terminal emulator
15intended as an \fIxterm\fP(1) replacement for users who do not require 15intended as an \fIxterm\fP(1) replacement for users who do not require
16features such as Tektronix 4014 emulation and toolkit-style configurability\&. 16features such as Tektronix 4014 emulation and toolkit-style configurability\&.
17As a result, \fBrxvt-unicode\fP uses much less swap space -- a significant 17As a result, \fBrxvt-unicode\fP uses much less swap space -- a significant
18advantage on a machine serving many X sessions\&. 18advantage on a machine serving many X sessions\&.
19.PP 19.PP
20.PP 20.PP
21.SH "OPTIONS" 21.SH "OPTIONS"
22.PP 22.PP
23The \fBurxvt\fP options (mostly a subset of \fIxterm\fP\&'s) are listed below\&. 23The \fBrxvt\fP options (mostly a subset of \fIxterm\fP\&'s) are listed below\&.
24In keeping with the smaller-is-better philosophy, options may be eliminated 24In keeping with the smaller-is-better philosophy, options may be eliminated
25or default values chosen at compile-time, so options and defaults listed 25or default values chosen at compile-time, so options and defaults listed
26may not accurately reflect the version installed on your system\&. 26may not accurately reflect the version installed on your system\&.
27`rxvt -h\&' gives a list of major compile-time options on the \fIOptions\fP line\&. 27`rxvt -h\&' gives a list of major compile-time options on the \fIOptions\fP line\&.
28Option descriptions may be prefixed with which compile option each is 28Option descriptions may be prefixed with which compile option each is
29dependent upon\&. e\&.g\&. `Compile \fIXIM\fP:\&' requires \fIXIM\fP on the \fIOptions\fP 29dependent upon\&. e\&.g\&. `Compile \fIXIM\fP:\&' requires \fIXIM\fP on the \fIOptions\fP
30line\&. Note: `rxvt -help\&' gives a list of all command-line options compiled 30line\&. Note: `rxvt -help\&' gives a list of all command-line options compiled
31into your version\&. 31into your version\&.
32.PP 32.PP
33Note that \fBurxvt\fP permits the resource name to be used as a long-option 33Note that \fBrxvt\fP permits the resource name to be used as a long-option
34(--/++ option) so the potential command-line options are far greater than 34(--/++ option) so the potential command-line options are far greater than
35those listed\&. 35those listed\&.
36For example: `rxvt --loginShell --color1 Orange\&'\&. 36For example: `rxvt --loginShell --color1 Orange\&'\&.
37.PP 37.PP
38The following options are available: 38The following options are available:
… …
54resource \fBjumpScroll\fP\&. 54resource \fBjumpScroll\fP\&.
55.IP "\fB-ip\fP|\fB+ip\fP" 55.IP "\fB-ip\fP|\fB+ip\fP"
56Turn on/off inheriting parent window\&'s pixmap\&. Alternative form 56Turn on/off inheriting parent window\&'s pixmap\&. Alternative form
57is \fB-tr\fP; 57is \fB-tr\fP;
58resource \fBinheritPixmap\fP\&. 58resource \fBinheritPixmap\fP\&.
59.IP "\fB-fade\fP \fInumber\fP"
60Fade the text by the given percentage when focus is lost\&.
59.IP "\fB-tint\fP \fIcolour\fP" 61.IP "\fB-tint\fP \fIcolour\fP"
60Tint the transparent background pixmap with the given colour\&. 62Tint the transparent background pixmap with the given colour when
63transparency is enabled with \fB-tr\fP or \fB-ip\fP\&. See also
64the \fB-sh\fP option that can be used to brighten or darken
65the image in addition to tinting it\&.
66.IP "\fB-sh\fP"
67\fInumber\fP
68Darken (0 \&.\&. 100) or lighten (-1 \&.\&. -100) the transparent background
69image in addition to tinting it (i\&.e\&. \fB-tint\fP must be specified, too)\&.
61.IP "\fB-bg\fP \fIcolour\fP" 70.IP "\fB-bg\fP \fIcolour\fP"
62Window background colour; 71Window background colour;
63resource \fBbackground\fP\&. 72resource \fBbackground\fP\&.
64.IP "\fB-fg\fP \fIcolour\fP" 73.IP "\fB-fg\fP \fIcolour\fP"
65Window foreground colour; 74Window foreground colour;
66resource \fBforeground\fP\&. 75resource \fBforeground\fP\&.
67.IP "\fB-pixmap:\fP \fIfile[;geom]\fP" 76.IP "\fB-pixmap\fP \fIfile[;geom]\fP"
68Compile \fIXPM\fP: Specify XPM file for the background and also 77Compile \fIXPM\fP: Specify XPM file for the background and also
69optionally specify its scaling with a geometry string\&. Note you 78optionally specify its scaling with a geometry string\&. Note you
70may need to add quotes to avoid special shell interpretation of 79may need to add quotes to avoid special shell interpretation of
71the `;\&' in the command-line; 80the `;\&' in the command-line;
72resource \fBbackgroundPixmap\fP\&. 81resource \fBbackgroundPixmap\fP\&.
… …
146resource \fBinternalBorder\fP\&. 155resource \fBinternalBorder\fP\&.
147.IP "\fB-w\fP \fInumber\fP" 156.IP "\fB-w\fP \fInumber\fP"
148Compile \fIfrills\fP: External border of \fInumber\fP pixels\&. 157Compile \fIfrills\fP: External border of \fInumber\fP pixels\&.
149Also, \fB-bw\fP and \fB-borderwidth\fP\&. See resource entry for limits; 158Also, \fB-bw\fP and \fB-borderwidth\fP\&. See resource entry for limits;
150resource \fBexternalBorder\fP\&. 159resource \fBexternalBorder\fP\&.
160.IP "\fB-bl\fP"
161Compile \fIfrills\fP: Set MWM hints to request a borderless window,
162i\&.e\&. if honoured by the WM, the rxvt window will not have window
163decorations; resource \fBborderLess\fP\&.
151.IP "\fB-lsp\fP \fInumber\fP" 164.IP "\fB-lsp\fP \fInumber\fP"
152Compile \fIlinespace\fP: Lines (pixel height) to insert between each 165Compile \fIlinespace\fP: Lines (pixel height) to insert between each
153row of the display; 166row of the display;
154resource \fBlinespace\fP\&. 167resource \fBlinespace\fP\&.
155.IP "\fB-tn\fP \fItermname\fP" 168.IP "\fB-tn\fP \fItermname\fP"
156This option specifies the name of the terminal type to be set in the 169This option specifies the name of the terminal type to be set in the
157\fBTERM\fP environment variable\&. This terminal type must exist in the 170\fBTERM\fP environment variable\&. This terminal type must exist in the
158\fItermcap(5)\fP database and should have \fIli#\fP and \fIco#\fP entries; 171\fItermcap(5)\fP database and should have \fIli#\fP and \fIco#\fP entries;
159resource \fBtermName\fP\&. 172resource \fBtermName\fP\&.
160.IP "\fB-e\fP \fIcommand [arguments]\fP" 173.IP "\fB-e\fP \fIcommand [arguments]\fP"
161Run the command with its command-line arguments in the \fBurxvt\fP 174Run the command with its command-line arguments in the \fBrxvt\fP
162window; also sets the window title and icon name to be the basename 175window; also sets the window title and icon name to be the basename
163of the program being executed if neither \fI-title\fP (\fI-T\fP) nor 176of the program being executed if neither \fI-title\fP (\fI-T\fP) nor
164\fI-n\fP are given on the command line\&. If this option is used, it 177\fI-n\fP are given on the command line\&. If this option is used, it
165must be the last on the command-line\&. If there is no \fB-e\fP option 178must be the last on the command-line\&. If there is no \fB-e\fP option
166then the default is to run the program specified by the \fBSHELL\fP 179then the default is to run the program specified by the \fBSHELL\fP
… …
209in some window managers\&. 222in some window managers\&.
210.SH "RESOURCES (available also as long-options)" 223.SH "RESOURCES (available also as long-options)"
211.PP 224.PP
212Note: `rxvt --help\&' gives a list of all resources (long options) compiled 225Note: `rxvt --help\&' gives a list of all resources (long options) compiled
213into your version\&. 226into your version\&.
227.PP
228There are two different methods that rxvt can use to get the
229Xresource data: using the X libraries (Xrm*-functions) or internal Xresources
230reader (\fB~/\&.Xdefaults\fP)\&. For the first method (ie\&. \fBrxvt -h\fP lists
231\fBXGetDefaults\fP), you can set and change the resources using X11
232tools like \fBxset\fP\&. Many distribution do also load settings from the
233\fB~/\&.Xresources\fP file when X starts\&.
234.PP
214If compiled with internal Xresources support (i\&.e\&. \fBrxvt -h\fP lists 235If compiled with internal Xresources support (i\&.e\&. \fBrxvt
215\fB\&.Xdefaults\fP) then \fBurxvt\fP accepts application defaults set in 236-h\fP lists \fB\&.Xdefaults\fP) then \fBrxvt\fP accepts application
216XAPPLOADDIR/Rxvt (compile-time defined: usually 237defaults set in XAPPLOADDIR/URxvt (compile-time defined: usually
217\fB/usr/lib/X11/app-defaults/Rxvt\fP) and resources set in \fB~/\&.Xdefaults\fP, 238\fB/usr/lib/X11/app-defaults/URxvt\fP) and resources set in
218or \fB~/\&.Xresources\fP if \fB~/\&.Xdefaults\fP does not exist\&. Note that when 239\fB~/\&.Xdefaults\fP, or \fB~/\&.Xresources\fP if \fB~/\&.Xdefaults\fP does not exist\&.
219reading X resources, \fBurxvt\fP recognizes two class names: \fBXTerm\fP and 240Note that when reading X resources, \fBrxvt\fP recognizes two class
220\fBRxvt\fP\&. The class name \fBXTerm\fP allows resources common to both 241names: \fBXTerm\fP and \fBURxvt\fP\&. The class name \fBRxvt\fP allows resources
221\fBurxvt\fP and \fIxterm\fP to be easily configured, while the class name 242common to both \fBrxvt\fP and the original \fIrxvt\fP to be easily configured,
222\fBRxvt\fP allows resources unique to \fBurxvt\fP, notably colours and 243while the class name \fBURxvt\fP allows resources unique to \fBrxvt\fP,
223key-handling, to be shared between different \fBurxvt\fP configurations\&. 244notably colours and key-handling, to be shared between different
224If no resources are specified, suitable defaults will be used\&. 245\fBrxvt\fP configurations\&. If no resources are specified, suitable
225Command-line arguments can be used to override resource settings\&. The 246defaults will be used\&. Command-line arguments can be used to override
226following resources are allowed: 247resource settings\&. The following resources are allowed:
227.PP 248.PP
228.IP "\fBgeometry:\fP \fIgeom\fP" 249.IP "\fBgeometry:\fP \fIgeom\fP"
229Create the window with the specified X window geometry [default 250Create the window with the specified X window geometry [default
23080x24]; 25180x24];
231option \fB-geometry\fP\&. 252option \fB-geometry\fP\&.
… …
277option \fB+j\fP\&. 298option \fB+j\fP\&.
278.IP "\fBinheritPixmap:\fP \fIboolean\fP" 299.IP "\fBinheritPixmap:\fP \fIboolean\fP"
279\fBTrue\fP: make the background inherit the parent windows\&' pixmap, 300\fBTrue\fP: make the background inherit the parent windows\&' pixmap,
280giving artificial transparency\&. 301giving artificial transparency\&.
281\fBFalse\fP: do not inherit the parent windows\&' pixmap\&. 302\fBFalse\fP: do not inherit the parent windows\&' pixmap\&.
303.IP "\fBfading:\fP \fInumber\fP"
304Fade the text by the given percentage when focus is lost\&.
282.IP "\fBtintColor\fP \fIcolour\fP" 305.IP "\fBtintColor:\fP \fIcolour\fP"
283Tint the transparent background pixmap with the given colour\&. 306Tint the transparent background pixmap with the given colour\&.
307.IP "\fBshading:\fP \fInumber\fP"
308Darken (0 \&.\&. 100) or lighten (-1 \&.\&. -100) the transparent background
309image in addition to tinting it\&.
310.IP "\fBfading:\fP \fInumber\fP"
311Scale the tint colour by the given percentage\&.
284.IP "\fBscrollColor:\fP \fIcolour\fP" 312.IP "\fBscrollColor:\fP \fIcolour\fP"
285Use the specified colour for the scrollbar [default #B2B2B2]\&. 313Use the specified colour for the scrollbar [default #B2B2B2]\&.
286.IP "\fBtroughColor:\fP \fIcolour\fP" 314.IP "\fBtroughColor:\fP \fIcolour\fP"
287Use the specified colour for the scrollbar\&'s trough area [default 315Use the specified colour for the scrollbar\&'s trough area [default
288#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. 316#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&.
… …
326.IP "\fBselectstyle:\fP \fImode\fP" 354.IP "\fBselectstyle:\fP \fImode\fP"
327Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which 355Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which
328is xterm style with 2\&.20 old word selection, or anything else which 356is xterm style with 2\&.20 old word selection, or anything else which
329gives xterm style selection\&. 357gives xterm style selection\&.
330.IP "\fBscrollstyle:\fP \fImode\fP" 358.IP "\fBscrollstyle:\fP \fImode\fP"
331Set scrollbar style to \fBurxvt\fP, \fBrxvt\fP, \fBplain\fP, \fBnext\fP or \fBxterm\fP 359Set scrollbar style to \fBrxvt\fP, \fBrxvt\fP, \fBplain\fP, \fBnext\fP or \fBxterm\fP
332.IP "\fBtitle:\fP \fIstring\fP" 360.IP "\fBtitle:\fP \fIstring\fP"
333Set window title string, the default title is the command-line 361Set window title string, the default title is the command-line
334specified after the \fB-e\fP option, if any, otherwise the application 362specified after the \fB-e\fP option, if any, otherwise the application
335name; 363name;
336option \fB-title\fP\&. 364option \fB-title\fP\&.
… …
415Internal border of \fInumber\fP pixels\&. This resource is limited to 100; 443Internal border of \fInumber\fP pixels\&. This resource is limited to 100;
416option \fB-b\fP\&. 444option \fB-b\fP\&.
417.IP "\fBexternalBorder:\fP \fInumber\fP" 445.IP "\fBexternalBorder:\fP \fInumber\fP"
418External border of \fInumber\fP pixels\&. This resource is limited to 100; 446External border of \fInumber\fP pixels\&. This resource is limited to 100;
419option \fB-w\fP, \fB-bw\fP, \fB-borderwidth\fP\&. 447option \fB-w\fP, \fB-bw\fP, \fB-borderwidth\fP\&.
448.IP "\fBborderLess:\fP \fIboolean\fP"
449Set MWM hints to request a borderless window,
450i\&.e\&. if honoured by the WM, the rxvt window will not have window
451decorations; option \fB-bl\fP\&.
420.IP "\fBtermName:\fP \fItermname\fP" 452.IP "\fBtermName:\fP \fItermname\fP"
421Specifies the terminal type name to be set in the \fBTERM\fP 453Specifies the terminal type name to be set in the \fBTERM\fP
422environment variable; 454environment variable;
423option \fB-tn\fP\&. 455option \fB-tn\fP\&.
424.IP "\fBlinespace:\fP \fInumber\fP" 456.IP "\fBlinespace:\fP \fInumber\fP"
… …
507double quotes so that it can start or end with whitespace\&. The 539double quotes so that it can start or end with whitespace\&. The
508intervening resource name \fBkeysym\&.\fP cannot be omitted\&. This 540intervening resource name \fBkeysym\&.\fP cannot be omitted\&. This
509resource is only available when compiled with KEYSYM_RESOURCE\&. 541resource is only available when compiled with KEYSYM_RESOURCE\&.
510.SH "THE SCROLLBAR" 542.SH "THE SCROLLBAR"
511.PP 543.PP
512Lines of text that scroll off the top of the \fBurxvt\fP window (resource: 544Lines of text that scroll off the top of the \fBrxvt\fP window (resource:
513\fBsaveLines\fP) and can be scrolled back using the scrollbar or by keystrokes\&. 545\fBsaveLines\fP) and can be scrolled back using the scrollbar or by keystrokes\&.
514The normal \fBurxvt\fP scrollbar has arrows and its behaviour is fairly 546The normal \fBrxvt\fP scrollbar has arrows and its behaviour is fairly
515intuitive\&. The \fBxterm-scrollbar\fP is without arrows and its behaviour 547intuitive\&. The \fBxterm-scrollbar\fP is without arrows and its behaviour
516mimics that of \fIxterm\fP 548mimics that of \fIxterm\fP
517.PP 549.PP
518Scroll down with \fBButton1\fP (\fBxterm-scrollbar\fP) or \fBShift-Next\fP\&. 550Scroll down with \fBButton1\fP (\fBxterm-scrollbar\fP) or \fBShift-Next\fP\&.
519Scroll up with \fBButton3\fP (\fBxterm-scrollbar\fP) or \fBShift-Prior\fP\&. 551Scroll up with \fBButton3\fP (\fBxterm-scrollbar\fP) or \fBShift-Prior\fP\&.
… …
540region and release; Right click to extend the marked region; 572region and release; Right click to extend the marked region;
541Left double-click to select a word; Left triple-click to select 573Left double-click to select a word; Left triple-click to select
542the entire line\&. 574the entire line\&.
543.IP "\fBInsertion\fP:" 575.IP "\fBInsertion\fP:"
544Pressing and releasing the Middle mouse button (or \fBShift-Insert\fP) 576Pressing and releasing the Middle mouse button (or \fBShift-Insert\fP)
545in an \fBurxvt\fP window causes the current text selection to be inserted 577in an \fBrxvt\fP window causes the current text selection to be inserted
546as if it had been typed on the keyboard\&. 578as if it had been typed on the keyboard\&.
547.SH "CHANGING FONTS" 579.SH "CHANGING FONTS"
548.PP 580.PP
549You can change fonts on-the-fly, which is to say cycle through the default 581You can change fonts on-the-fly, which is to say cycle through the default
550font and others of various sizes, by using \fBShift-KP_Add\fP and 582font and others of various sizes, by using \fBShift-KP_Add\fP and
551\fBShift-KP_Subtract\fP\&. Or, alternatively (if enabled) with 583\fBShift-KP_Subtract\fP\&. Or, alternatively (if enabled) with
552\fBAlt->\fP and \fBAlt-<\fP, where the actual key 584\fBAlt->\fP and \fBAlt-<\fP, where the actual key
553can be selected using resources \fBsmallfont_key\fP/\fBbigfont_key\fP\&. 585can be selected using resources \fBsmallfont_key\fP/\fBbigfont_key\fP\&.
554.SH "LOGIN STAMP" 586.SH "LOGIN STAMP"
555.PP 587.PP
556\fBurxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be 588\fBrxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be
557seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this 589seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this
558feature, \fBurxvt\fP must be installed setuid root on some systems\&. 590feature, \fBrxvt\fP must be installed setuid root on some systems\&.
559.SH "COLORS AND GRAPHICS" 591.SH "COLORS AND GRAPHICS"
560.PP 592.PP
561In addition to the default foreground and background colours, \fBurxvt\fP 593In addition to the default foreground and background colours, \fBrxvt\fP
562can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 594can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
563versions of the same)\&. 595versions of the same)\&.
564Here is a list of the colours with their \fBrgb\&.txt\fP names\&. 596Here is a list of the colours with their \fBrgb\&.txt\fP names\&.
565.PP 597.PP
566.TS 598.TS
… …
1047.IP "\fBrxvt -fg Black -bg White -rv\fP" 1079.IP "\fBrxvt -fg Black -bg White -rv\fP"
1048would yield White on Black, while on \fIxterm\fP(1) it would yield 1080would yield White on Black, while on \fIxterm\fP(1) it would yield
1049Black on White\&. 1081Black on White\&.
1050.SH "ENVIRONMENT" 1082.SH "ENVIRONMENT"
1051.PP 1083.PP
1052\fBurxvt\fP sets the environment variables \fBTERM\fP, \fBCOLORTERM\fP and 1084\fBrxvt\fP sets the environment variables \fBTERM\fP, \fBCOLORTERM\fP and
1053\fBCOLORFGBG\fP\&. The environment variable \fBWINDOWID\fP is set to the X window 1085\fBCOLORFGBG\fP\&. The environment variable \fBWINDOWID\fP is set to the X window
1054id number of the \fBurxvt\fP window and it also uses and sets the environment 1086id number of the \fBrxvt\fP window and it also uses and sets the environment
1055variable \fBDISPLAY\fP to specify which display terminal to use\&. \fBurxvt\fP uses 1087variable \fBDISPLAY\fP to specify which display terminal to use\&. \fBrxvt\fP uses
1056the environment variables \fBRXVTPATH\fP and \fBPATH\fP to find XPM files\&. 1088the environment variables \fBRXVTPATH\fP and \fBPATH\fP to find XPM files\&.
1057.SH "FILES" 1089.SH "FILES"
1058.PP 1090.PP
1059.IP "\fB/etc/utmp\fP" 1091.IP "\fB/etc/utmp\fP"
1060System file for login records\&. 1092System file for login records\&.
… …
1077.PP 1109.PP
1078Click-and-drag doesn\&'t work with X11 mouse report overriding\&. 1110Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
1079.PP 1111.PP
1080.SH "FTP LOCATION" 1112.SH "FTP LOCATION"
1081.PP 1113.PP
1082rxvt-3\&.1\&.tar\&.gz can be found at the following ftp sites 1114rxvt-3\&.4\&.tar\&.gz can be found at the following ftp sites
1083ftp://ftp\&.rxvt\&.org/pub/rxvt 1115ftp://ftp\&.rxvt\&.org/pub/rxvt
1084.PP 1116.PP
1085.SH "CURRENT PROJECT COORDINATOR" 1117.SH "CURRENT PROJECT COORDINATOR"
1086.PP 1118.PP
1087.IP "Project Coordinator" 1119.IP "Project Coordinator"

Diff Legend

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