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

Comparing rxvt-unicode/doc/rxvt.tbl (file contents):
Revision 1.8 by pcg, Fri Apr 2 00:51:09 2004 UTC vs.
Revision 1.10 by pcg, Fri Apr 2 19:15:55 2004 UTC

1.TH "RXVT" "1" "2004-03-28" "X Version 11" "X Tools" 1.TH "RXVT" "1" "2004-04-02" "X Version 11" "X Tools"
2.SH "NAME" 2.SH "NAME"
3rxvt-unicode (ouR XVT, unicode) \- a VT102 emulator for the X window system 3rxvt-unicode (ouR XVT, unicode) \- a VT102 emulator for the X window system
4.PP 4.PP
5.SH "SYNOPSIS" 5.SH "SYNOPSIS"
6.PP 6.PP
7\fBrxvt\fP [options] [-e command [ args ]] 7\fBurxvt\fP [options] [-e command [ args ]]
8.PP 8.PP
9.SH "DESCRIPTION" 9.SH "DESCRIPTION"
10.PP 10.PP
11\fBrxvt-unicode\fP, version \fB2\&.6\fP, is a colour vt102 terminal emulator 11\fBrxvt-unicode\fP, version \fB2\&.7\fP, is a colour vt102 terminal emulator
12intended as an \fIxterm\fP(1) replacement for users who do not require 12intended as an \fIxterm\fP(1) replacement for users who do not require
13features such as Tektronix 4014 emulation and toolkit-style configurability\&. 13features such as Tektronix 4014 emulation and toolkit-style configurability\&.
14As a result, \fBrxvt-unicode\fP uses much less swap space -- a significant 14As a result, \fBrxvt-unicode\fP uses much less swap space -- a significant
15advantage on a machine serving many X sessions\&. 15advantage on a machine serving many X sessions\&.
16.PP 16.PP
17.PP 17.PP
18.SH "OPTIONS" 18.SH "OPTIONS"
19.PP 19.PP
20The \fBrxvt\fP options (mostly a subset of \fIxterm\fP\&'s) are listed below\&. 20The \fBurxvt\fP options (mostly a subset of \fIxterm\fP\&'s) are listed below\&.
21In keeping with the smaller-is-better philosophy, options may be eliminated 21In keeping with the smaller-is-better philosophy, options may be eliminated
22or default values chosen at compile-time, so options and defaults listed 22or default values chosen at compile-time, so options and defaults listed
23may not accurately reflect the version installed on your system\&. 23may not accurately reflect the version installed on your system\&.
24`rxvt -h\&' gives a list of major compile-time options on the \fIOptions\fP line\&. 24`rxvt -h\&' gives a list of major compile-time options on the \fIOptions\fP line\&.
25Option descriptions may be prefixed with which compile option each is 25Option descriptions may be prefixed with which compile option each is
26dependent upon\&. e\&.g\&. `Compile \fIXIM\fP:\&' requires \fIXIM\fP on the \fIOptions\fP 26dependent upon\&. e\&.g\&. `Compile \fIXIM\fP:\&' requires \fIXIM\fP on the \fIOptions\fP
27line\&. Note: `rxvt -help\&' gives a list of all command-line options compiled 27line\&. Note: `rxvt -help\&' gives a list of all command-line options compiled
28into your version\&. 28into your version\&.
29.PP 29.PP
30Note that \fBrxvt\fP permits the resource name to be used as a long-option 30Note that \fBurxvt\fP permits the resource name to be used as a long-option
31(--/++ option) so the potential command-line options are far greater than 31(--/++ option) so the potential command-line options are far greater than
32those listed\&. 32those listed\&.
33For example: `rxvt --loginShell --color1 Orange\&'\&. 33For example: `rxvt --loginShell --color1 Orange\&'\&.
34.PP 34.PP
35The following options are available: 35The following options are available:
… …
141This option specifies the name of the terminal type to be set in the 141This option specifies the name of the terminal type to be set in the
142\fBTERM\fP environment variable\&. This terminal type must exist in the 142\fBTERM\fP environment variable\&. This terminal type must exist in the
143\fItermcap(5)\fP database and should have \fIli#\fP and \fIco#\fP entries; 143\fItermcap(5)\fP database and should have \fIli#\fP and \fIco#\fP entries;
144resource \fBtermName\fP\&. 144resource \fBtermName\fP\&.
145.IP "\fB-e\fP \fIcommand [arguments]\fP" 145.IP "\fB-e\fP \fIcommand [arguments]\fP"
146Run the command with its command-line arguments in the \fBrxvt\fP 146Run the command with its command-line arguments in the \fBurxvt\fP
147window; also sets the window title and icon name to be the basename 147window; also sets the window title and icon name to be the basename
148of the program being executed if neither \fI-title\fP (\fI-T\fP) nor 148of the program being executed if neither \fI-title\fP (\fI-T\fP) nor
149\fI-n\fP are given on the command line\&. If this option is used, it 149\fI-n\fP are given on the command line\&. If this option is used, it
150must be the last on the command-line\&. If there is no \fB-e\fP option 150must be the last on the command-line\&. If there is no \fB-e\fP option
151then the default is to run the program specified by the \fBSHELL\fP 151then the default is to run the program specified by the \fBSHELL\fP
… …
180.IP "\fB-mod\fP \fImodifier\fP" 180.IP "\fB-mod\fP \fImodifier\fP"
181Override detection of Meta modifier with specified key: 181Override detection of Meta modifier with specified key:
182\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, 182\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
183\fBmod4\fP, \fBmod5\fP; 183\fBmod4\fP, \fBmod5\fP;
184resource \fImodifier\fP\&. 184resource \fImodifier\fP\&.
185.IP "\fB-ssc\fP|\fB+ssc\fP"
186Turn on/off secondary screen (default enabled);
187resource \fBsecondaryScreen\fP\&.
188.IP "\fB-ssr\fP|\fB+ssr\fP"
189Turn on/off secondary screen scroll (default enabled);
190resource \fBsecondaryScroll\fP\&.
185.IP "\fB-xrm\fP \fIresourcestring\fP" 191.IP "\fB-xrm\fP \fIresourcestring\fP"
186No effect on rxvt\&. Simply passes through an argument to be made 192No effect on rxvt\&. Simply passes through an argument to be made
187available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP 193available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP
188in some window managers\&. 194in some window managers\&.
189.SH "RESOURCES (available also as long-options)" 195.SH "RESOURCES (available also as long-options)"
190.PP 196.PP
191Note: `rxvt --help\&' gives a list of all resources (long options) compiled 197Note: `rxvt --help\&' gives a list of all resources (long options) compiled
192into your version\&. 198into your version\&.
193If compiled with internal Xresources support (i\&.e\&. \fBrxvt -h\fP lists 199If compiled with internal Xresources support (i\&.e\&. \fBrxvt -h\fP lists
194\fB\&.Xdefaults\fP) then \fBrxvt\fP accepts application defaults set in 200\fB\&.Xdefaults\fP) then \fBurxvt\fP accepts application defaults set in
195XAPPLOADDIR/Rxvt (compile-time defined: usually 201XAPPLOADDIR/Rxvt (compile-time defined: usually
196\fB/usr/lib/X11/app-defaults/Rxvt\fP) and resources set in \fB~/\&.Xdefaults\fP, 202\fB/usr/lib/X11/app-defaults/Rxvt\fP) and resources set in \fB~/\&.Xdefaults\fP,
197or \fB~/\&.Xresources\fP if \fB~/\&.Xdefaults\fP does not exist\&. Note that when 203or \fB~/\&.Xresources\fP if \fB~/\&.Xdefaults\fP does not exist\&. Note that when
198reading X resources, \fBrxvt\fP recognizes two class names: \fBXTerm\fP and 204reading X resources, \fBurxvt\fP recognizes two class names: \fBXTerm\fP and
199\fBRxvt\fP\&. The class name \fBXTerm\fP allows resources common to both 205\fBRxvt\fP\&. The class name \fBXTerm\fP allows resources common to both
200\fBrxvt\fP and \fIxterm\fP to be easily configured, while the class name 206\fBurxvt\fP and \fIxterm\fP to be easily configured, while the class name
201\fBRxvt\fP allows resources unique to \fBrxvt\fP, notably colours and 207\fBRxvt\fP allows resources unique to \fBurxvt\fP, notably colours and
202key-handling, to be shared between different \fBrxvt\fP configurations\&. 208key-handling, to be shared between different \fBurxvt\fP configurations\&.
203If no resources are specified, suitable defaults will be used\&. 209If no resources are specified, suitable defaults will be used\&.
204Command-line arguments can be used to override resource settings\&. The 210Command-line arguments can be used to override resource settings\&. The
205following resources are allowed: 211following resources are allowed:
206.PP 212.PP
207.IP "\fBgeometry:\fP \fIgeom\fP" 213.IP "\fBgeometry:\fP \fIgeom\fP"
… …
292.IP "\fBselectstyle:\fP \fImode\fP" 298.IP "\fBselectstyle:\fP \fImode\fP"
293Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which 299Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which
294is xterm style with 2\&.20 old word selection, or anything else which 300is xterm style with 2\&.20 old word selection, or anything else which
295gives xterm style selection\&. 301gives xterm style selection\&.
296.IP "\fBscrollstyle:\fP \fImode\fP" 302.IP "\fBscrollstyle:\fP \fImode\fP"
297Set scrollbar style to \fBrxvt\fP, \fBnext\fP or \fBxterm\fP 303Set scrollbar style to \fBurxvt\fP, \fBnext\fP or \fBxterm\fP
298.IP "\fBtitle:\fP \fIstring\fP" 304.IP "\fBtitle:\fP \fIstring\fP"
299Set window title string, the default title is the command-line 305Set window title string, the default title is the command-line
300specified after the \fB-e\fP option, if any, otherwise the application 306specified after the \fB-e\fP option, if any, otherwise the application
301name; 307name;
302option \fB-title\fP\&. 308option \fB-title\fP\&.
… …
434while staying in another locale\&. 440while staying in another locale\&.
435option \fB-imlocale\fP\&. 441option \fB-imlocale\fP\&.
436.IP "\fBinsecure\fP" 442.IP "\fBinsecure\fP"
437Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences 443Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences
438that echo arbitrary strings like the icon name or the locale\&. This 444that echo arbitrary strings like the icon name or the locale\&. This
439could be abused if somebody gets 8-bit-clean access to your display, 445could be abused if somebody gets 8-bit-clean access to your
440wether throuh a mail client displaying mail bodies unfiltered or 446display, wether throuh a mail client displaying mail bodies
441though write(1)\&. Therefore, these sequences are disabled by default\&. 447unfiltered or though write(1)\&. Therefore, these sequences are
442You can enable them by setting this boolean resource or specifying 448disabled by default\&. (Note that other terminals, including xterm,
449have these sequences enabled by default)\&. You can enable them
450by setting this boolean resource or specifying \fB-insecure\fP as
443\fB-insecure\fP as an option\&. At the moment, this enabled display-answer, 451an option\&. At the moment, this enabled display-answer, locale,
444locale, findfont, icon label and window title requests as well as 452findfont, icon label and window title requests as well as dynamic
445dynamic menubar dispatch\&. 453menubar dispatch\&.
446.IP "\fBmodifier:\fP \fImodifier\fP" 454.IP "\fBmodifier:\fP \fImodifier\fP"
447Set the key to be interpreted as the Meta key to: 455Set the key to be interpreted as the Meta key to:
448\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, 456\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
449\fBmod4\fP, \fBmod5\fP; 457\fBmod4\fP, \fBmod5\fP;
450option \fB-mod\fP\&. 458option \fB-mod\fP\&.
451.IP "\fBanswerbackString:\fP \fIstring\fP" 459.IP "\fBanswerbackString:\fP \fIstring\fP"
452Specify the reply rxvt sends to the shell when an ENQ (control-E) 460Specify the reply rxvt sends to the shell when an ENQ (control-E)
453character is passed through\&. It may contain escape values as 461character is passed through\&. It may contain escape values as
454described in the entry on \fBkeysym\fP following\&. 462described in the entry on \fBkeysym\fP following\&.
463.IP "\fBsecondaryScreen:\fP \fIbool\fP"
464Turn on/off secondary screen (default enabled)\&.
465.IP "\fBsecondaryScroll:\fP \fIbool\fP"
466Turn on/off secondary screen scroll (default enabled)\&. If
467the this option is enabled, scrolls on the secondary screen will
468change the scrollback buffer and switching to/from the secondary screen
469will instead scroll the screen up\&.
455.IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP" 470.IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP"
456Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It 471Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It
457may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape, 472may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape,
458\en: newline, \er: return, \et: tab, \e000: octal number) or control 473\en: newline, \er: return, \et: tab, \e000: octal number) or control
459characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with 474characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with
460double quotes so that it can start or end with whitespace\&. The 475double quotes so that it can start or end with whitespace\&. The
461intervening resource name \fBkeysym\&.\fP cannot be omitted\&. This 476intervening resource name \fBkeysym\&.\fP cannot be omitted\&. This
462resource is only available when compiled with KEYSYM_RESOURCE\&. 477resource is only available when compiled with KEYSYM_RESOURCE\&.
463.SH "THE SCROLLBAR" 478.SH "THE SCROLLBAR"
464.PP 479.PP
465Lines of text that scroll off the top of the \fBrxvt\fP window (resource: 480Lines of text that scroll off the top of the \fBurxvt\fP window (resource:
466\fBsaveLines\fP) and can be scrolled back using the scrollbar or by keystrokes\&. 481\fBsaveLines\fP) and can be scrolled back using the scrollbar or by keystrokes\&.
467The normal \fBrxvt\fP scrollbar has arrows and its behaviour is fairly 482The normal \fBurxvt\fP scrollbar has arrows and its behaviour is fairly
468intuitive\&. The \fBxterm-scrollbar\fP is without arrows and its behaviour 483intuitive\&. The \fBxterm-scrollbar\fP is without arrows and its behaviour
469mimics that of \fIxterm\fP 484mimics that of \fIxterm\fP
470.PP 485.PP
471Scroll down with \fBButton1\fP (\fBxterm-scrollbar\fP) or \fBShift-Next\fP\&. 486Scroll down with \fBButton1\fP (\fBxterm-scrollbar\fP) or \fBShift-Next\fP\&.
472Scroll up with \fBButton3\fP (\fBxterm-scrollbar\fP) or \fBShift-Prior\fP\&. 487Scroll up with \fBButton3\fP (\fBxterm-scrollbar\fP) or \fBShift-Prior\fP\&.
… …
493region and release; Right click to extend the marked region; 508region and release; Right click to extend the marked region;
494Left double-click to select a word; Left triple-click to select 509Left double-click to select a word; Left triple-click to select
495the entire line\&. 510the entire line\&.
496.IP "\fBInsertion\fP:" 511.IP "\fBInsertion\fP:"
497Pressing and releasing the Middle mouse button (or \fBShift-Insert\fP) 512Pressing and releasing the Middle mouse button (or \fBShift-Insert\fP)
498in an \fBrxvt\fP window causes the current text selection to be inserted 513in an \fBurxvt\fP window causes the current text selection to be inserted
499as if it had been typed on the keyboard\&. 514as if it had been typed on the keyboard\&.
500.SH "CHANGING FONTS" 515.SH "CHANGING FONTS"
501.PP 516.PP
502You can change fonts on-the-fly, which is to say cycle through the default 517You can change fonts on-the-fly, which is to say cycle through the default
503font and others of various sizes, by using \fBShift-KP_Add\fP and 518font and others of various sizes, by using \fBShift-KP_Add\fP and
504\fBShift-KP_Subtract\fP\&. Or, alternatively (if enabled) with 519\fBShift-KP_Subtract\fP\&. Or, alternatively (if enabled) with
505\fBAlt->\fP and \fBAlt-<\fP, where the actual key 520\fBAlt->\fP and \fBAlt-<\fP, where the actual key
506can be selected using resources \fBsmallfont_key\fP/\fBbigfont_key\fP\&. 521can be selected using resources \fBsmallfont_key\fP/\fBbigfont_key\fP\&.
507.SH "LOGIN STAMP" 522.SH "LOGIN STAMP"
508.PP 523.PP
509\fBrxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be 524\fBurxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be
510seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this 525seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this
511feature, \fBrxvt\fP must be installed setuid root on some systems\&. 526feature, \fBurxvt\fP must be installed setuid root on some systems\&.
512.SH "COLORS AND GRAPHICS" 527.SH "COLORS AND GRAPHICS"
513.PP 528.PP
514In addition to the default foreground and background colours, \fBrxvt\fP 529In addition to the default foreground and background colours, \fBurxvt\fP
515can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 530can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
516versions of the same)\&. 531versions of the same)\&.
517Here is a list of the colours with their \fBrgb\&.txt\fP names\&. 532Here is a list of the colours with their \fBrgb\&.txt\fP names\&.
518.PP 533.PP
519.TS 534.TS
… …
553.IP "\fBrxvt -fg Black -bg White -rv\fP" 568.IP "\fBrxvt -fg Black -bg White -rv\fP"
554would yield White on Black, while on \fIxterm\fP(1) it would yield 569would yield White on Black, while on \fIxterm\fP(1) it would yield
555Black on White\&. 570Black on White\&.
556.SH "ENVIRONMENT" 571.SH "ENVIRONMENT"
557.PP 572.PP
558\fBrxvt\fP sets the environment variables \fBTERM\fP, \fBCOLORTERM\fP and 573\fBurxvt\fP sets the environment variables \fBTERM\fP, \fBCOLORTERM\fP and
559\fBCOLORFGBG\fP\&. The environment variable \fBWINDOWID\fP is set to the X window 574\fBCOLORFGBG\fP\&. The environment variable \fBWINDOWID\fP is set to the X window
560id number of the \fBrxvt\fP window and it also uses and sets the environment 575id number of the \fBurxvt\fP window and it also uses and sets the environment
561variable \fBDISPLAY\fP to specify which display terminal to use\&. \fBrxvt\fP uses 576variable \fBDISPLAY\fP to specify which display terminal to use\&. \fBurxvt\fP uses
562the environment variables \fBRXVTPATH\fP and \fBPATH\fP to find XPM files\&. 577the environment variables \fBRXVTPATH\fP and \fBPATH\fP to find XPM files\&.
563.SH "FILES" 578.SH "FILES"
564.PP 579.PP
565.IP "\fB/etc/utmp\fP" 580.IP "\fB/etc/utmp\fP"
566System file for login records\&. 581System file for login records\&.
… …
583.PP 598.PP
584Click-and-drag doesn\&'t work with X11 mouse report overriding\&. 599Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
585.PP 600.PP
586.SH "FTP LOCATION" 601.SH "FTP LOCATION"
587.PP 602.PP
588rxvt-2\&.6\&.tar\&.gz can be found at the following ftp sites 603rxvt-2\&.7\&.tar\&.gz can be found at the following ftp sites
589ftp://ftp\&.rxvt\&.org/pub/rxvt 604ftp://ftp\&.rxvt\&.org/pub/rxvt
590.PP 605.PP
591.SH "CURRENT PROJECT COORDINATOR" 606.SH "CURRENT PROJECT COORDINATOR"
592.PP 607.PP
593.IP "Project Coordinator" 608.IP "Project Coordinator"
… …
614.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>" 629.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>"
615Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5) 630Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5)
616.IP "Geoff Wing <gcw@pobox\&.com>" 631.IP "Geoff Wing <gcw@pobox\&.com>"
617Rewrote screen display and text selection routines\&. 632Rewrote screen display and text selection routines\&.
618Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode) 633Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode)
619.IP "Marc Alexander Lehman <rxvt@schmorp\&.de>" 634.IP "Marc Alexander Lehmann <rxvt@schmorp\&.de>"
620Rewrote most of the display code and internal character handling 635Forked rxvt-unicode\&. Rewrote most of the display code and
621to store text in unicode\&. Numerous other fixes and extensions\&. 636internal character handling to store text in unicode,
637improve xterm compatibility and numerous other buffixes
638and extensions\&.
622.br 639.br
623Project Coordinator (Changes 1\&.0 - ) 640Project Coordinator (Changes 1\&.0 - )
624.PP 641.PP

Diff Legend

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