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.11 by pcg, Sat May 8 17:18:21 2004 UTC vs.
Revision 1.12 by root, Sat Jul 10 20:59:39 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-04-02" "X Version 11" "X Tools" 4.TH "RXVT" "1" "2004-05-10" "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 \fB2\&.7\fP, is a colour vt102 terminal emulator 14\fBrxvt-unicode\fP, version \fB3\&.1\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:
… …
72resource \fBbackgroundPixmap\fP\&. 72resource \fBbackgroundPixmap\fP\&.
73.IP "\fB-cr\fP \fIcolour\fP" 73.IP "\fB-cr\fP \fIcolour\fP"
74The cursor colour; 74The cursor colour;
75resource \fBcursorColor\fP\&. 75resource \fBcursorColor\fP\&.
76.IP "\fB-pr\fP \fIcolour\fP" 76.IP "\fB-pr\fP \fIcolour\fP"
77The mouse pointer colour; 77The mouse pointer foreground colour;
78resource \fBpointerColor\fP\&. 78resource \fBpointerColor\fP\&.
79.IP "\fB-pr2\fP \fIcolour\fP"
80The mouse pointer background colour;
81resource \fBpointerColor2\fP\&.
79.IP "\fB-bd\fP \fIcolour\fP" 82.IP "\fB-bd\fP \fIcolour\fP"
80The colour of the border between the xterm scrollbar and the text; 83The colour of the border between the xterm scrollbar and the text;
81resource \fBborderColor\fP\&. 84resource \fBborderColor\fP\&.
82.IP "\fB-fn\fP \fIfontname\fP" 85.IP "\fB-fn\fP \fIfontname\fP"
83Select the fonts to be used used\&. This is a comma seperated 86Select the fonts to be used used\&. This is a comma seperated
… …
144This option specifies the name of the terminal type to be set in the 147This option specifies the name of the terminal type to be set in the
145\fBTERM\fP environment variable\&. This terminal type must exist in the 148\fBTERM\fP environment variable\&. This terminal type must exist in the
146\fItermcap(5)\fP database and should have \fIli#\fP and \fIco#\fP entries; 149\fItermcap(5)\fP database and should have \fIli#\fP and \fIco#\fP entries;
147resource \fBtermName\fP\&. 150resource \fBtermName\fP\&.
148.IP "\fB-e\fP \fIcommand [arguments]\fP" 151.IP "\fB-e\fP \fIcommand [arguments]\fP"
149Run the command with its command-line arguments in the \fBurxvt\fP 152Run the command with its command-line arguments in the \fBrxvt\fP
150window; also sets the window title and icon name to be the basename 153window; also sets the window title and icon name to be the basename
151of the program being executed if neither \fI-title\fP (\fI-T\fP) nor 154of the program being executed if neither \fI-title\fP (\fI-T\fP) nor
152\fI-n\fP are given on the command line\&. If this option is used, it 155\fI-n\fP are given on the command line\&. If this option is used, it
153must be the last on the command-line\&. If there is no \fB-e\fP option 156must be the last on the command-line\&. If there is no \fB-e\fP option
154then the default is to run the program specified by the \fBSHELL\fP 157then the default is to run the program specified by the \fBSHELL\fP
… …
198.SH "RESOURCES (available also as long-options)" 201.SH "RESOURCES (available also as long-options)"
199.PP 202.PP
200Note: `rxvt --help\&' gives a list of all resources (long options) compiled 203Note: `rxvt --help\&' gives a list of all resources (long options) compiled
201into your version\&. 204into your version\&.
202If compiled with internal Xresources support (i\&.e\&. \fBrxvt -h\fP lists 205If compiled with internal Xresources support (i\&.e\&. \fBrxvt -h\fP lists
203\fB\&.Xdefaults\fP) then \fBurxvt\fP accepts application defaults set in 206\fB\&.Xdefaults\fP) then \fBrxvt\fP accepts application defaults set in
204XAPPLOADDIR/Rxvt (compile-time defined: usually 207XAPPLOADDIR/Rxvt (compile-time defined: usually
205\fB/usr/lib/X11/app-defaults/Rxvt\fP) and resources set in \fB~/\&.Xdefaults\fP, 208\fB/usr/lib/X11/app-defaults/Rxvt\fP) and resources set in \fB~/\&.Xdefaults\fP,
206or \fB~/\&.Xresources\fP if \fB~/\&.Xdefaults\fP does not exist\&. Note that when 209or \fB~/\&.Xresources\fP if \fB~/\&.Xdefaults\fP does not exist\&. Note that when
207reading X resources, \fBurxvt\fP recognizes two class names: \fBXTerm\fP and 210reading X resources, \fBrxvt\fP recognizes two class names: \fBXTerm\fP and
208\fBRxvt\fP\&. The class name \fBXTerm\fP allows resources common to both 211\fBRxvt\fP\&. The class name \fBXTerm\fP allows resources common to both
209\fBurxvt\fP and \fIxterm\fP to be easily configured, while the class name 212\fBrxvt\fP and \fIxterm\fP to be easily configured, while the class name
210\fBRxvt\fP allows resources unique to \fBurxvt\fP, notably colours and 213\fBRxvt\fP allows resources unique to \fBrxvt\fP, notably colours and
211key-handling, to be shared between different \fBurxvt\fP configurations\&. 214key-handling, to be shared between different \fBrxvt\fP configurations\&.
212If no resources are specified, suitable defaults will be used\&. 215If no resources are specified, suitable defaults will be used\&.
213Command-line arguments can be used to override resource settings\&. The 216Command-line arguments can be used to override resource settings\&. The
214following resources are allowed: 217following resources are allowed:
215.PP 218.PP
216.IP "\fBgeometry:\fP \fIgeom\fP" 219.IP "\fBgeometry:\fP \fIgeom\fP"
… …
301.IP "\fBselectstyle:\fP \fImode\fP" 304.IP "\fBselectstyle:\fP \fImode\fP"
302Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which 305Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which
303is xterm style with 2\&.20 old word selection, or anything else which 306is xterm style with 2\&.20 old word selection, or anything else which
304gives xterm style selection\&. 307gives xterm style selection\&.
305.IP "\fBscrollstyle:\fP \fImode\fP" 308.IP "\fBscrollstyle:\fP \fImode\fP"
306Set scrollbar style to \fBurxvt\fP, \fBnext\fP or \fBxterm\fP 309Set scrollbar style to \fBrxvt\fP, \fBrxvt\fP, \fBplain\fP, \fBnext\fP or \fBxterm\fP
307.IP "\fBtitle:\fP \fIstring\fP" 310.IP "\fBtitle:\fP \fIstring\fP"
308Set window title string, the default title is the command-line 311Set window title string, the default title is the command-line
309specified after the \fB-e\fP option, if any, otherwise the application 312specified after the \fB-e\fP option, if any, otherwise the application
310name; 313name;
311option \fB-title\fP\&. 314option \fB-title\fP\&.
… …
412option \fB-bc\fP\&. 415option \fB-bc\fP\&.
413.IP "\fBpointerBlank:\fP \fIboolean\fP" 416.IP "\fBpointerBlank:\fP \fIboolean\fP"
414\fBTrue\fP: blank the pointer when a key is pressed or after a set number 417\fBTrue\fP: blank the pointer when a key is pressed or after a set number
415of seconds of inactivity\&. 418of seconds of inactivity\&.
416\fBFalse\fP: the pointer is always visible [default]\&. 419\fBFalse\fP: the pointer is always visible [default]\&.
420.IP "\fBpointerColor:\fP \fIcolour\fP"
421Mouse pointer foreground colour\&.
422.IP "\fBpointerColor2:\fP \fIcolour\fP"
423Mouse pointer background colour\&.
417.IP "\fBpointerBlankDelay:\fP \fInumber\fP" 424.IP "\fBpointerBlankDelay:\fP \fInumber\fP"
418Specifies number of seconds before blanking the pointer [default 2]\&. 425Specifies number of seconds before blanking the pointer [default 2]\&.
419.IP "\fBbackspacekey:\fP \fIstring\fP" 426.IP "\fBbackspacekey:\fP \fIstring\fP"
420The string to send when the backspace key is pressed\&. If set to 427The string to send when the backspace key is pressed\&. If set to
421\fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted, 428\fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted,
… …
478double quotes so that it can start or end with whitespace\&. The 485double quotes so that it can start or end with whitespace\&. The
479intervening resource name \fBkeysym\&.\fP cannot be omitted\&. This 486intervening resource name \fBkeysym\&.\fP cannot be omitted\&. This
480resource is only available when compiled with KEYSYM_RESOURCE\&. 487resource is only available when compiled with KEYSYM_RESOURCE\&.
481.SH "THE SCROLLBAR" 488.SH "THE SCROLLBAR"
482.PP 489.PP
483Lines of text that scroll off the top of the \fBurxvt\fP window (resource: 490Lines of text that scroll off the top of the \fBrxvt\fP window (resource:
484\fBsaveLines\fP) and can be scrolled back using the scrollbar or by keystrokes\&. 491\fBsaveLines\fP) and can be scrolled back using the scrollbar or by keystrokes\&.
485The normal \fBurxvt\fP scrollbar has arrows and its behaviour is fairly 492The normal \fBrxvt\fP scrollbar has arrows and its behaviour is fairly
486intuitive\&. The \fBxterm-scrollbar\fP is without arrows and its behaviour 493intuitive\&. The \fBxterm-scrollbar\fP is without arrows and its behaviour
487mimics that of \fIxterm\fP 494mimics that of \fIxterm\fP
488.PP 495.PP
489Scroll down with \fBButton1\fP (\fBxterm-scrollbar\fP) or \fBShift-Next\fP\&. 496Scroll down with \fBButton1\fP (\fBxterm-scrollbar\fP) or \fBShift-Next\fP\&.
490Scroll up with \fBButton3\fP (\fBxterm-scrollbar\fP) or \fBShift-Prior\fP\&. 497Scroll up with \fBButton3\fP (\fBxterm-scrollbar\fP) or \fBShift-Prior\fP\&.
… …
511region and release; Right click to extend the marked region; 518region and release; Right click to extend the marked region;
512Left double-click to select a word; Left triple-click to select 519Left double-click to select a word; Left triple-click to select
513the entire line\&. 520the entire line\&.
514.IP "\fBInsertion\fP:" 521.IP "\fBInsertion\fP:"
515Pressing and releasing the Middle mouse button (or \fBShift-Insert\fP) 522Pressing and releasing the Middle mouse button (or \fBShift-Insert\fP)
516in an \fBurxvt\fP window causes the current text selection to be inserted 523in an \fBrxvt\fP window causes the current text selection to be inserted
517as if it had been typed on the keyboard\&. 524as if it had been typed on the keyboard\&.
518.SH "CHANGING FONTS" 525.SH "CHANGING FONTS"
519.PP 526.PP
520You can change fonts on-the-fly, which is to say cycle through the default 527You can change fonts on-the-fly, which is to say cycle through the default
521font and others of various sizes, by using \fBShift-KP_Add\fP and 528font and others of various sizes, by using \fBShift-KP_Add\fP and
522\fBShift-KP_Subtract\fP\&. Or, alternatively (if enabled) with 529\fBShift-KP_Subtract\fP\&. Or, alternatively (if enabled) with
523\fBAlt->\fP and \fBAlt-<\fP, where the actual key 530\fBAlt->\fP and \fBAlt-<\fP, where the actual key
524can be selected using resources \fBsmallfont_key\fP/\fBbigfont_key\fP\&. 531can be selected using resources \fBsmallfont_key\fP/\fBbigfont_key\fP\&.
525.SH "LOGIN STAMP" 532.SH "LOGIN STAMP"
526.PP 533.PP
527\fBurxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be 534\fBrxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be
528seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this 535seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this
529feature, \fBurxvt\fP must be installed setuid root on some systems\&. 536feature, \fBrxvt\fP must be installed setuid root on some systems\&.
530.SH "COLORS AND GRAPHICS" 537.SH "COLORS AND GRAPHICS"
531.PP 538.PP
532In addition to the default foreground and background colours, \fBurxvt\fP 539In addition to the default foreground and background colours, \fBrxvt\fP
533can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 540can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
534versions of the same)\&. 541versions of the same)\&.
535Here is a list of the colours with their \fBrgb\&.txt\fP names\&. 542Here is a list of the colours with their \fBrgb\&.txt\fP names\&.
536.PP 543.PP
537.TS 544.TS
… …
1018.IP "\fBrxvt -fg Black -bg White -rv\fP" 1025.IP "\fBrxvt -fg Black -bg White -rv\fP"
1019would yield White on Black, while on \fIxterm\fP(1) it would yield 1026would yield White on Black, while on \fIxterm\fP(1) it would yield
1020Black on White\&. 1027Black on White\&.
1021.SH "ENVIRONMENT" 1028.SH "ENVIRONMENT"
1022.PP 1029.PP
1023\fBurxvt\fP sets the environment variables \fBTERM\fP, \fBCOLORTERM\fP and 1030\fBrxvt\fP sets the environment variables \fBTERM\fP, \fBCOLORTERM\fP and
1024\fBCOLORFGBG\fP\&. The environment variable \fBWINDOWID\fP is set to the X window 1031\fBCOLORFGBG\fP\&. The environment variable \fBWINDOWID\fP is set to the X window
1025id number of the \fBurxvt\fP window and it also uses and sets the environment 1032id number of the \fBrxvt\fP window and it also uses and sets the environment
1026variable \fBDISPLAY\fP to specify which display terminal to use\&. \fBurxvt\fP uses 1033variable \fBDISPLAY\fP to specify which display terminal to use\&. \fBrxvt\fP uses
1027the environment variables \fBRXVTPATH\fP and \fBPATH\fP to find XPM files\&. 1034the environment variables \fBRXVTPATH\fP and \fBPATH\fP to find XPM files\&.
1028.SH "FILES" 1035.SH "FILES"
1029.PP 1036.PP
1030.IP "\fB/etc/utmp\fP" 1037.IP "\fB/etc/utmp\fP"
1031System file for login records\&. 1038System file for login records\&.
… …
1048.PP 1055.PP
1049Click-and-drag doesn\&'t work with X11 mouse report overriding\&. 1056Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
1050.PP 1057.PP
1051.SH "FTP LOCATION" 1058.SH "FTP LOCATION"
1052.PP 1059.PP
1053rxvt-2\&.7\&.tar\&.gz can be found at the following ftp sites 1060rxvt-3\&.1\&.tar\&.gz can be found at the following ftp sites
1054ftp://ftp\&.rxvt\&.org/pub/rxvt 1061ftp://ftp\&.rxvt\&.org/pub/rxvt
1055.PP 1062.PP
1056.SH "CURRENT PROJECT COORDINATOR" 1063.SH "CURRENT PROJECT COORDINATOR"
1057.PP 1064.PP
1058.IP "Project Coordinator" 1065.IP "Project Coordinator"
… …
1080Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5) 1087Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5)
1081.IP "Geoff Wing <gcw@pobox\&.com>" 1088.IP "Geoff Wing <gcw@pobox\&.com>"
1082Rewrote screen display and text selection routines\&. 1089Rewrote screen display and text selection routines\&.
1083Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode) 1090Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode)
1084.IP "Marc Alexander Lehmann <rxvt@schmorp\&.de>" 1091.IP "Marc Alexander Lehmann <rxvt@schmorp\&.de>"
1085Forked rxvt-unicode\&. Rewrote most of the display code and 1092Forked rxvt-unicode, rewrote most of the display code and
1086internal character handling to store text in unicode, 1093internal character handling to store text in unicode,
1087improve xterm compatibility and numerous other bugfixes 1094improve xterm compatibility and apply numerous other bugfixes
1088and extensions\&. 1095and extensions\&.
1089.br 1096.br
1090Project Coordinator (Changes 1\&.0 - ) 1097Project Coordinator (Changes 1\&.0 - )
1091.PP 1098.PP

Diff Legend

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