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.8 by pcg, Fri Apr 2 00:51:09 2004 UTC vs.
Revision 1.11 by pcg, Sat May 8 17:18:21 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-03-28" "X Version 11" "X Tools" 4.TH "RXVT" "1" "2004-04-02" "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\fBrxvt\fP [options] [-e command [ args ]] 10\fBurxvt\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\&.6\fP, is a colour vt102 terminal emulator 14\fBrxvt-unicode\fP, version \fB2\&.7\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 \fBrxvt\fP options (mostly a subset of \fIxterm\fP\&'s) are listed below\&. 23The \fBurxvt\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 \fBrxvt\fP permits the resource name to be used as a long-option 33Note that \fBurxvt\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:
… …
144This option specifies the name of the terminal type to be set in the 144This 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 145\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; 146\fItermcap(5)\fP database and should have \fIli#\fP and \fIco#\fP entries;
147resource \fBtermName\fP\&. 147resource \fBtermName\fP\&.
148.IP "\fB-e\fP \fIcommand [arguments]\fP" 148.IP "\fB-e\fP \fIcommand [arguments]\fP"
149Run the command with its command-line arguments in the \fBrxvt\fP 149Run the command with its command-line arguments in the \fBurxvt\fP
150window; also sets the window title and icon name to be the basename 150window; 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 151of 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 152\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 153must 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 154then the default is to run the program specified by the \fBSHELL\fP
… …
183.IP "\fB-mod\fP \fImodifier\fP" 183.IP "\fB-mod\fP \fImodifier\fP"
184Override detection of Meta modifier with specified key: 184Override detection of Meta modifier with specified key:
185\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, 185\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
186\fBmod4\fP, \fBmod5\fP; 186\fBmod4\fP, \fBmod5\fP;
187resource \fImodifier\fP\&. 187resource \fImodifier\fP\&.
188.IP "\fB-ssc\fP|\fB+ssc\fP"
189Turn on/off secondary screen (default enabled);
190resource \fBsecondaryScreen\fP\&.
191.IP "\fB-ssr\fP|\fB+ssr\fP"
192Turn on/off secondary screen scroll (default enabled);
193resource \fBsecondaryScroll\fP\&.
188.IP "\fB-xrm\fP \fIresourcestring\fP" 194.IP "\fB-xrm\fP \fIresourcestring\fP"
189No effect on rxvt\&. Simply passes through an argument to be made 195No effect on rxvt\&. Simply passes through an argument to be made
190available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP 196available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP
191in some window managers\&. 197in some window managers\&.
192.SH "RESOURCES (available also as long-options)" 198.SH "RESOURCES (available also as long-options)"
193.PP 199.PP
194Note: `rxvt --help\&' gives a list of all resources (long options) compiled 200Note: `rxvt --help\&' gives a list of all resources (long options) compiled
195into your version\&. 201into your version\&.
196If compiled with internal Xresources support (i\&.e\&. \fBrxvt -h\fP lists 202If compiled with internal Xresources support (i\&.e\&. \fBrxvt -h\fP lists
197\fB\&.Xdefaults\fP) then \fBrxvt\fP accepts application defaults set in 203\fB\&.Xdefaults\fP) then \fBurxvt\fP accepts application defaults set in
198XAPPLOADDIR/Rxvt (compile-time defined: usually 204XAPPLOADDIR/Rxvt (compile-time defined: usually
199\fB/usr/lib/X11/app-defaults/Rxvt\fP) and resources set in \fB~/\&.Xdefaults\fP, 205\fB/usr/lib/X11/app-defaults/Rxvt\fP) and resources set in \fB~/\&.Xdefaults\fP,
200or \fB~/\&.Xresources\fP if \fB~/\&.Xdefaults\fP does not exist\&. Note that when 206or \fB~/\&.Xresources\fP if \fB~/\&.Xdefaults\fP does not exist\&. Note that when
201reading X resources, \fBrxvt\fP recognizes two class names: \fBXTerm\fP and 207reading X resources, \fBurxvt\fP recognizes two class names: \fBXTerm\fP and
202\fBRxvt\fP\&. The class name \fBXTerm\fP allows resources common to both 208\fBRxvt\fP\&. The class name \fBXTerm\fP allows resources common to both
203\fBrxvt\fP and \fIxterm\fP to be easily configured, while the class name 209\fBurxvt\fP and \fIxterm\fP to be easily configured, while the class name
204\fBRxvt\fP allows resources unique to \fBrxvt\fP, notably colours and 210\fBRxvt\fP allows resources unique to \fBurxvt\fP, notably colours and
205key-handling, to be shared between different \fBrxvt\fP configurations\&. 211key-handling, to be shared between different \fBurxvt\fP configurations\&.
206If no resources are specified, suitable defaults will be used\&. 212If no resources are specified, suitable defaults will be used\&.
207Command-line arguments can be used to override resource settings\&. The 213Command-line arguments can be used to override resource settings\&. The
208following resources are allowed: 214following resources are allowed:
209.PP 215.PP
210.IP "\fBgeometry:\fP \fIgeom\fP" 216.IP "\fBgeometry:\fP \fIgeom\fP"
… …
295.IP "\fBselectstyle:\fP \fImode\fP" 301.IP "\fBselectstyle:\fP \fImode\fP"
296Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which 302Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which
297is xterm style with 2\&.20 old word selection, or anything else which 303is xterm style with 2\&.20 old word selection, or anything else which
298gives xterm style selection\&. 304gives xterm style selection\&.
299.IP "\fBscrollstyle:\fP \fImode\fP" 305.IP "\fBscrollstyle:\fP \fImode\fP"
300Set scrollbar style to \fBrxvt\fP, \fBnext\fP or \fBxterm\fP 306Set scrollbar style to \fBurxvt\fP, \fBnext\fP or \fBxterm\fP
301.IP "\fBtitle:\fP \fIstring\fP" 307.IP "\fBtitle:\fP \fIstring\fP"
302Set window title string, the default title is the command-line 308Set window title string, the default title is the command-line
303specified after the \fB-e\fP option, if any, otherwise the application 309specified after the \fB-e\fP option, if any, otherwise the application
304name; 310name;
305option \fB-title\fP\&. 311option \fB-title\fP\&.
… …
437while staying in another locale\&. 443while staying in another locale\&.
438option \fB-imlocale\fP\&. 444option \fB-imlocale\fP\&.
439.IP "\fBinsecure\fP" 445.IP "\fBinsecure\fP"
440Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences 446Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences
441that echo arbitrary strings like the icon name or the locale\&. This 447that echo arbitrary strings like the icon name or the locale\&. This
442could be abused if somebody gets 8-bit-clean access to your display, 448could be abused if somebody gets 8-bit-clean access to your
443wether throuh a mail client displaying mail bodies unfiltered or 449display, wether throuh a mail client displaying mail bodies
444though write(1)\&. Therefore, these sequences are disabled by default\&. 450unfiltered or though write(1)\&. Therefore, these sequences are
445You can enable them by setting this boolean resource or specifying 451disabled by default\&. (Note that other terminals, including xterm,
452have these sequences enabled by default)\&. You can enable them
453by setting this boolean resource or specifying \fB-insecure\fP as
446\fB-insecure\fP as an option\&. At the moment, this enabled display-answer, 454an option\&. At the moment, this enabled display-answer, locale,
447locale, findfont, icon label and window title requests as well as 455findfont, icon label and window title requests as well as dynamic
448dynamic menubar dispatch\&. 456menubar dispatch\&.
449.IP "\fBmodifier:\fP \fImodifier\fP" 457.IP "\fBmodifier:\fP \fImodifier\fP"
450Set the key to be interpreted as the Meta key to: 458Set the key to be interpreted as the Meta key to:
451\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, 459\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
452\fBmod4\fP, \fBmod5\fP; 460\fBmod4\fP, \fBmod5\fP;
453option \fB-mod\fP\&. 461option \fB-mod\fP\&.
454.IP "\fBanswerbackString:\fP \fIstring\fP" 462.IP "\fBanswerbackString:\fP \fIstring\fP"
455Specify the reply rxvt sends to the shell when an ENQ (control-E) 463Specify the reply rxvt sends to the shell when an ENQ (control-E)
456character is passed through\&. It may contain escape values as 464character is passed through\&. It may contain escape values as
457described in the entry on \fBkeysym\fP following\&. 465described in the entry on \fBkeysym\fP following\&.
466.IP "\fBsecondaryScreen:\fP \fIbool\fP"
467Turn on/off secondary screen (default enabled)\&.
468.IP "\fBsecondaryScroll:\fP \fIbool\fP"
469Turn on/off secondary screen scroll (default enabled)\&. If
470the this option is enabled, scrolls on the secondary screen will
471change the scrollback buffer and switching to/from the secondary screen
472will instead scroll the screen up\&.
458.IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP" 473.IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP"
459Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It 474Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It
460may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape, 475may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape,
461\en: newline, \er: return, \et: tab, \e000: octal number) or control 476\en: newline, \er: return, \et: tab, \e000: octal number) or control
462characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with 477characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with
463double quotes so that it can start or end with whitespace\&. The 478double quotes so that it can start or end with whitespace\&. The
464intervening resource name \fBkeysym\&.\fP cannot be omitted\&. This 479intervening resource name \fBkeysym\&.\fP cannot be omitted\&. This
465resource is only available when compiled with KEYSYM_RESOURCE\&. 480resource is only available when compiled with KEYSYM_RESOURCE\&.
466.SH "THE SCROLLBAR" 481.SH "THE SCROLLBAR"
467.PP 482.PP
468Lines of text that scroll off the top of the \fBrxvt\fP window (resource: 483Lines of text that scroll off the top of the \fBurxvt\fP window (resource:
469\fBsaveLines\fP) and can be scrolled back using the scrollbar or by keystrokes\&. 484\fBsaveLines\fP) and can be scrolled back using the scrollbar or by keystrokes\&.
470The normal \fBrxvt\fP scrollbar has arrows and its behaviour is fairly 485The normal \fBurxvt\fP scrollbar has arrows and its behaviour is fairly
471intuitive\&. The \fBxterm-scrollbar\fP is without arrows and its behaviour 486intuitive\&. The \fBxterm-scrollbar\fP is without arrows and its behaviour
472mimics that of \fIxterm\fP 487mimics that of \fIxterm\fP
473.PP 488.PP
474Scroll down with \fBButton1\fP (\fBxterm-scrollbar\fP) or \fBShift-Next\fP\&. 489Scroll down with \fBButton1\fP (\fBxterm-scrollbar\fP) or \fBShift-Next\fP\&.
475Scroll up with \fBButton3\fP (\fBxterm-scrollbar\fP) or \fBShift-Prior\fP\&. 490Scroll up with \fBButton3\fP (\fBxterm-scrollbar\fP) or \fBShift-Prior\fP\&.
… …
496region and release; Right click to extend the marked region; 511region and release; Right click to extend the marked region;
497Left double-click to select a word; Left triple-click to select 512Left double-click to select a word; Left triple-click to select
498the entire line\&. 513the entire line\&.
499.IP "\fBInsertion\fP:" 514.IP "\fBInsertion\fP:"
500Pressing and releasing the Middle mouse button (or \fBShift-Insert\fP) 515Pressing and releasing the Middle mouse button (or \fBShift-Insert\fP)
501in an \fBrxvt\fP window causes the current text selection to be inserted 516in an \fBurxvt\fP window causes the current text selection to be inserted
502as if it had been typed on the keyboard\&. 517as if it had been typed on the keyboard\&.
503.SH "CHANGING FONTS" 518.SH "CHANGING FONTS"
504.PP 519.PP
505You can change fonts on-the-fly, which is to say cycle through the default 520You can change fonts on-the-fly, which is to say cycle through the default
506font and others of various sizes, by using \fBShift-KP_Add\fP and 521font and others of various sizes, by using \fBShift-KP_Add\fP and
507\fBShift-KP_Subtract\fP\&. Or, alternatively (if enabled) with 522\fBShift-KP_Subtract\fP\&. Or, alternatively (if enabled) with
508\fBAlt->\fP and \fBAlt-<\fP, where the actual key 523\fBAlt->\fP and \fBAlt-<\fP, where the actual key
509can be selected using resources \fBsmallfont_key\fP/\fBbigfont_key\fP\&. 524can be selected using resources \fBsmallfont_key\fP/\fBbigfont_key\fP\&.
510.SH "LOGIN STAMP" 525.SH "LOGIN STAMP"
511.PP 526.PP
512\fBrxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be 527\fBurxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be
513seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this 528seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this
514feature, \fBrxvt\fP must be installed setuid root on some systems\&. 529feature, \fBurxvt\fP must be installed setuid root on some systems\&.
515.SH "COLORS AND GRAPHICS" 530.SH "COLORS AND GRAPHICS"
516.PP 531.PP
517In addition to the default foreground and background colours, \fBrxvt\fP 532In addition to the default foreground and background colours, \fBurxvt\fP
518can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 533can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
519versions of the same)\&. 534versions of the same)\&.
520Here is a list of the colours with their \fBrgb\&.txt\fP names\&. 535Here is a list of the colours with their \fBrgb\&.txt\fP names\&.
521.PP 536.PP
522.TS 537.TS
… …
1003.IP "\fBrxvt -fg Black -bg White -rv\fP" 1018.IP "\fBrxvt -fg Black -bg White -rv\fP"
1004would yield White on Black, while on \fIxterm\fP(1) it would yield 1019would yield White on Black, while on \fIxterm\fP(1) it would yield
1005Black on White\&. 1020Black on White\&.
1006.SH "ENVIRONMENT" 1021.SH "ENVIRONMENT"
1007.PP 1022.PP
1008\fBrxvt\fP sets the environment variables \fBTERM\fP, \fBCOLORTERM\fP and 1023\fBurxvt\fP sets the environment variables \fBTERM\fP, \fBCOLORTERM\fP and
1009\fBCOLORFGBG\fP\&. The environment variable \fBWINDOWID\fP is set to the X window 1024\fBCOLORFGBG\fP\&. The environment variable \fBWINDOWID\fP is set to the X window
1010id number of the \fBrxvt\fP window and it also uses and sets the environment 1025id number of the \fBurxvt\fP window and it also uses and sets the environment
1011variable \fBDISPLAY\fP to specify which display terminal to use\&. \fBrxvt\fP uses 1026variable \fBDISPLAY\fP to specify which display terminal to use\&. \fBurxvt\fP uses
1012the environment variables \fBRXVTPATH\fP and \fBPATH\fP to find XPM files\&. 1027the environment variables \fBRXVTPATH\fP and \fBPATH\fP to find XPM files\&.
1013.SH "FILES" 1028.SH "FILES"
1014.PP 1029.PP
1015.IP "\fB/etc/utmp\fP" 1030.IP "\fB/etc/utmp\fP"
1016System file for login records\&. 1031System file for login records\&.
… …
1033.PP 1048.PP
1034Click-and-drag doesn\&'t work with X11 mouse report overriding\&. 1049Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
1035.PP 1050.PP
1036.SH "FTP LOCATION" 1051.SH "FTP LOCATION"
1037.PP 1052.PP
1038rxvt-2\&.6\&.tar\&.gz can be found at the following ftp sites 1053rxvt-2\&.7\&.tar\&.gz can be found at the following ftp sites
1039ftp://ftp\&.rxvt\&.org/pub/rxvt 1054ftp://ftp\&.rxvt\&.org/pub/rxvt
1040.PP 1055.PP
1041.SH "CURRENT PROJECT COORDINATOR" 1056.SH "CURRENT PROJECT COORDINATOR"
1042.PP 1057.PP
1043.IP "Project Coordinator" 1058.IP "Project Coordinator"
… …
1064.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>" 1079.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>"
1065Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5) 1080Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5)
1066.IP "Geoff Wing <gcw@pobox\&.com>" 1081.IP "Geoff Wing <gcw@pobox\&.com>"
1067Rewrote screen display and text selection routines\&. 1082Rewrote screen display and text selection routines\&.
1068Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode) 1083Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode)
1069.IP "Marc Alexander Lehman <rxvt@schmorp\&.de>" 1084.IP "Marc Alexander Lehmann <rxvt@schmorp\&.de>"
1070Rewrote most of the display code and internal character handling 1085Forked rxvt-unicode\&. Rewrote most of the display code and
1071to store text in unicode\&. Numerous other fixes and extensions\&. 1086internal character handling to store text in unicode,
1087improve xterm compatibility and numerous other bugfixes
1088and extensions\&.
1072.br 1089.br
1073Project Coordinator (Changes 1\&.0 - ) 1090Project Coordinator (Changes 1\&.0 - )
1074.PP 1091.PP

Diff Legend

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