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.10 by pcg, Fri Apr 2 19:15:55 2004 UTC vs.
Revision 1.12 by root, Sat Jul 10 20:59:39 2004 UTC

1.TH "RXVT" "1" "2004-04-02" "X Version 11" "X Tools" 1.TH "RXVT" "1" "2004-05-10" "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\fBurxvt\fP [options] [-e command [ args ]] 7\fBrxvt\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\&.7\fP, is a colour vt102 terminal emulator 11\fBrxvt-unicode\fP, version \fB3\&.1\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 \fBurxvt\fP options (mostly a subset of \fIxterm\fP\&'s) are listed below\&. 20The \fBrxvt\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 \fBurxvt\fP permits the resource name to be used as a long-option 30Note that \fBrxvt\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:
… …
69resource \fBbackgroundPixmap\fP\&. 69resource \fBbackgroundPixmap\fP\&.
70.IP "\fB-cr\fP \fIcolour\fP" 70.IP "\fB-cr\fP \fIcolour\fP"
71The cursor colour; 71The cursor colour;
72resource \fBcursorColor\fP\&. 72resource \fBcursorColor\fP\&.
73.IP "\fB-pr\fP \fIcolour\fP" 73.IP "\fB-pr\fP \fIcolour\fP"
74The mouse pointer colour; 74The mouse pointer foreground colour;
75resource \fBpointerColor\fP\&. 75resource \fBpointerColor\fP\&.
76.IP "\fB-pr2\fP \fIcolour\fP"
77The mouse pointer background colour;
78resource \fBpointerColor2\fP\&.
76.IP "\fB-bd\fP \fIcolour\fP" 79.IP "\fB-bd\fP \fIcolour\fP"
77The colour of the border between the xterm scrollbar and the text; 80The colour of the border between the xterm scrollbar and the text;
78resource \fBborderColor\fP\&. 81resource \fBborderColor\fP\&.
79.IP "\fB-fn\fP \fIfontname\fP" 82.IP "\fB-fn\fP \fIfontname\fP"
80Select the fonts to be used used\&. This is a comma seperated 83Select the fonts to be used used\&. This is a comma seperated
… …
141This 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
142\fBTERM\fP environment variable\&. This terminal type must exist in the 145\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; 146\fItermcap(5)\fP database and should have \fIli#\fP and \fIco#\fP entries;
144resource \fBtermName\fP\&. 147resource \fBtermName\fP\&.
145.IP "\fB-e\fP \fIcommand [arguments]\fP" 148.IP "\fB-e\fP \fIcommand [arguments]\fP"
146Run the command with its command-line arguments in the \fBurxvt\fP 149Run the command with its command-line arguments in the \fBrxvt\fP
147window; 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
148of 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
149\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
150must 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
151then 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
… …
195.SH "RESOURCES (available also as long-options)" 198.SH "RESOURCES (available also as long-options)"
196.PP 199.PP
197Note: `rxvt --help\&' gives a list of all resources (long options) compiled 200Note: `rxvt --help\&' gives a list of all resources (long options) compiled
198into your version\&. 201into your version\&.
199If compiled with internal Xresources support (i\&.e\&. \fBrxvt -h\fP lists 202If compiled with internal Xresources support (i\&.e\&. \fBrxvt -h\fP lists
200\fB\&.Xdefaults\fP) then \fBurxvt\fP accepts application defaults set in 203\fB\&.Xdefaults\fP) then \fBrxvt\fP accepts application defaults set in
201XAPPLOADDIR/Rxvt (compile-time defined: usually 204XAPPLOADDIR/Rxvt (compile-time defined: usually
202\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,
203or \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
204reading X resources, \fBurxvt\fP recognizes two class names: \fBXTerm\fP and 207reading X resources, \fBrxvt\fP recognizes two class names: \fBXTerm\fP and
205\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
206\fBurxvt\fP and \fIxterm\fP to be easily configured, while the class name 209\fBrxvt\fP and \fIxterm\fP to be easily configured, while the class name
207\fBRxvt\fP allows resources unique to \fBurxvt\fP, notably colours and 210\fBRxvt\fP allows resources unique to \fBrxvt\fP, notably colours and
208key-handling, to be shared between different \fBurxvt\fP configurations\&. 211key-handling, to be shared between different \fBrxvt\fP configurations\&.
209If no resources are specified, suitable defaults will be used\&. 212If no resources are specified, suitable defaults will be used\&.
210Command-line arguments can be used to override resource settings\&. The 213Command-line arguments can be used to override resource settings\&. The
211following resources are allowed: 214following resources are allowed:
212.PP 215.PP
213.IP "\fBgeometry:\fP \fIgeom\fP" 216.IP "\fBgeometry:\fP \fIgeom\fP"
… …
298.IP "\fBselectstyle:\fP \fImode\fP" 301.IP "\fBselectstyle:\fP \fImode\fP"
299Set 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
300is 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
301gives xterm style selection\&. 304gives xterm style selection\&.
302.IP "\fBscrollstyle:\fP \fImode\fP" 305.IP "\fBscrollstyle:\fP \fImode\fP"
303Set scrollbar style to \fBurxvt\fP, \fBnext\fP or \fBxterm\fP 306Set scrollbar style to \fBrxvt\fP, \fBrxvt\fP, \fBplain\fP, \fBnext\fP or \fBxterm\fP
304.IP "\fBtitle:\fP \fIstring\fP" 307.IP "\fBtitle:\fP \fIstring\fP"
305Set window title string, the default title is the command-line 308Set window title string, the default title is the command-line
306specified after the \fB-e\fP option, if any, otherwise the application 309specified after the \fB-e\fP option, if any, otherwise the application
307name; 310name;
308option \fB-title\fP\&. 311option \fB-title\fP\&.
… …
409option \fB-bc\fP\&. 412option \fB-bc\fP\&.
410.IP "\fBpointerBlank:\fP \fIboolean\fP" 413.IP "\fBpointerBlank:\fP \fIboolean\fP"
411\fBTrue\fP: blank the pointer when a key is pressed or after a set number 414\fBTrue\fP: blank the pointer when a key is pressed or after a set number
412of seconds of inactivity\&. 415of seconds of inactivity\&.
413\fBFalse\fP: the pointer is always visible [default]\&. 416\fBFalse\fP: the pointer is always visible [default]\&.
417.IP "\fBpointerColor:\fP \fIcolour\fP"
418Mouse pointer foreground colour\&.
419.IP "\fBpointerColor2:\fP \fIcolour\fP"
420Mouse pointer background colour\&.
414.IP "\fBpointerBlankDelay:\fP \fInumber\fP" 421.IP "\fBpointerBlankDelay:\fP \fInumber\fP"
415Specifies number of seconds before blanking the pointer [default 2]\&. 422Specifies number of seconds before blanking the pointer [default 2]\&.
416.IP "\fBbackspacekey:\fP \fIstring\fP" 423.IP "\fBbackspacekey:\fP \fIstring\fP"
417The string to send when the backspace key is pressed\&. If set to 424The string to send when the backspace key is pressed\&. If set to
418\fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted, 425\fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted,
… …
475double quotes so that it can start or end with whitespace\&. The 482double quotes so that it can start or end with whitespace\&. The
476intervening resource name \fBkeysym\&.\fP cannot be omitted\&. This 483intervening resource name \fBkeysym\&.\fP cannot be omitted\&. This
477resource is only available when compiled with KEYSYM_RESOURCE\&. 484resource is only available when compiled with KEYSYM_RESOURCE\&.
478.SH "THE SCROLLBAR" 485.SH "THE SCROLLBAR"
479.PP 486.PP
480Lines of text that scroll off the top of the \fBurxvt\fP window (resource: 487Lines of text that scroll off the top of the \fBrxvt\fP window (resource:
481\fBsaveLines\fP) and can be scrolled back using the scrollbar or by keystrokes\&. 488\fBsaveLines\fP) and can be scrolled back using the scrollbar or by keystrokes\&.
482The normal \fBurxvt\fP scrollbar has arrows and its behaviour is fairly 489The normal \fBrxvt\fP scrollbar has arrows and its behaviour is fairly
483intuitive\&. The \fBxterm-scrollbar\fP is without arrows and its behaviour 490intuitive\&. The \fBxterm-scrollbar\fP is without arrows and its behaviour
484mimics that of \fIxterm\fP 491mimics that of \fIxterm\fP
485.PP 492.PP
486Scroll down with \fBButton1\fP (\fBxterm-scrollbar\fP) or \fBShift-Next\fP\&. 493Scroll down with \fBButton1\fP (\fBxterm-scrollbar\fP) or \fBShift-Next\fP\&.
487Scroll up with \fBButton3\fP (\fBxterm-scrollbar\fP) or \fBShift-Prior\fP\&. 494Scroll up with \fBButton3\fP (\fBxterm-scrollbar\fP) or \fBShift-Prior\fP\&.
… …
508region and release; Right click to extend the marked region; 515region and release; Right click to extend the marked region;
509Left double-click to select a word; Left triple-click to select 516Left double-click to select a word; Left triple-click to select
510the entire line\&. 517the entire line\&.
511.IP "\fBInsertion\fP:" 518.IP "\fBInsertion\fP:"
512Pressing and releasing the Middle mouse button (or \fBShift-Insert\fP) 519Pressing and releasing the Middle mouse button (or \fBShift-Insert\fP)
513in an \fBurxvt\fP window causes the current text selection to be inserted 520in an \fBrxvt\fP window causes the current text selection to be inserted
514as if it had been typed on the keyboard\&. 521as if it had been typed on the keyboard\&.
515.SH "CHANGING FONTS" 522.SH "CHANGING FONTS"
516.PP 523.PP
517You can change fonts on-the-fly, which is to say cycle through the default 524You can change fonts on-the-fly, which is to say cycle through the default
518font and others of various sizes, by using \fBShift-KP_Add\fP and 525font and others of various sizes, by using \fBShift-KP_Add\fP and
519\fBShift-KP_Subtract\fP\&. Or, alternatively (if enabled) with 526\fBShift-KP_Subtract\fP\&. Or, alternatively (if enabled) with
520\fBAlt->\fP and \fBAlt-<\fP, where the actual key 527\fBAlt->\fP and \fBAlt-<\fP, where the actual key
521can be selected using resources \fBsmallfont_key\fP/\fBbigfont_key\fP\&. 528can be selected using resources \fBsmallfont_key\fP/\fBbigfont_key\fP\&.
522.SH "LOGIN STAMP" 529.SH "LOGIN STAMP"
523.PP 530.PP
524\fBurxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be 531\fBrxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be
525seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this 532seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this
526feature, \fBurxvt\fP must be installed setuid root on some systems\&. 533feature, \fBrxvt\fP must be installed setuid root on some systems\&.
527.SH "COLORS AND GRAPHICS" 534.SH "COLORS AND GRAPHICS"
528.PP 535.PP
529In addition to the default foreground and background colours, \fBurxvt\fP 536In addition to the default foreground and background colours, \fBrxvt\fP
530can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 537can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
531versions of the same)\&. 538versions of the same)\&.
532Here is a list of the colours with their \fBrgb\&.txt\fP names\&. 539Here is a list of the colours with their \fBrgb\&.txt\fP names\&.
533.PP 540.PP
534.TS 541.TS
… …
568.IP "\fBrxvt -fg Black -bg White -rv\fP" 575.IP "\fBrxvt -fg Black -bg White -rv\fP"
569would yield White on Black, while on \fIxterm\fP(1) it would yield 576would yield White on Black, while on \fIxterm\fP(1) it would yield
570Black on White\&. 577Black on White\&.
571.SH "ENVIRONMENT" 578.SH "ENVIRONMENT"
572.PP 579.PP
573\fBurxvt\fP sets the environment variables \fBTERM\fP, \fBCOLORTERM\fP and 580\fBrxvt\fP sets the environment variables \fBTERM\fP, \fBCOLORTERM\fP and
574\fBCOLORFGBG\fP\&. The environment variable \fBWINDOWID\fP is set to the X window 581\fBCOLORFGBG\fP\&. The environment variable \fBWINDOWID\fP is set to the X window
575id number of the \fBurxvt\fP window and it also uses and sets the environment 582id number of the \fBrxvt\fP window and it also uses and sets the environment
576variable \fBDISPLAY\fP to specify which display terminal to use\&. \fBurxvt\fP uses 583variable \fBDISPLAY\fP to specify which display terminal to use\&. \fBrxvt\fP uses
577the environment variables \fBRXVTPATH\fP and \fBPATH\fP to find XPM files\&. 584the environment variables \fBRXVTPATH\fP and \fBPATH\fP to find XPM files\&.
578.SH "FILES" 585.SH "FILES"
579.PP 586.PP
580.IP "\fB/etc/utmp\fP" 587.IP "\fB/etc/utmp\fP"
581System file for login records\&. 588System file for login records\&.
… …
598.PP 605.PP
599Click-and-drag doesn\&'t work with X11 mouse report overriding\&. 606Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
600.PP 607.PP
601.SH "FTP LOCATION" 608.SH "FTP LOCATION"
602.PP 609.PP
603rxvt-2\&.7\&.tar\&.gz can be found at the following ftp sites 610rxvt-3\&.1\&.tar\&.gz can be found at the following ftp sites
604ftp://ftp\&.rxvt\&.org/pub/rxvt 611ftp://ftp\&.rxvt\&.org/pub/rxvt
605.PP 612.PP
606.SH "CURRENT PROJECT COORDINATOR" 613.SH "CURRENT PROJECT COORDINATOR"
607.PP 614.PP
608.IP "Project Coordinator" 615.IP "Project Coordinator"
… …
630Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5) 637Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5)
631.IP "Geoff Wing <gcw@pobox\&.com>" 638.IP "Geoff Wing <gcw@pobox\&.com>"
632Rewrote screen display and text selection routines\&. 639Rewrote screen display and text selection routines\&.
633Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode) 640Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode)
634.IP "Marc Alexander Lehmann <rxvt@schmorp\&.de>" 641.IP "Marc Alexander Lehmann <rxvt@schmorp\&.de>"
635Forked rxvt-unicode\&. Rewrote most of the display code and 642Forked rxvt-unicode, rewrote most of the display code and
636internal character handling to store text in unicode, 643internal character handling to store text in unicode,
637improve xterm compatibility and numerous other buffixes 644improve xterm compatibility and apply numerous other bugfixes
638and extensions\&. 645and extensions\&.
639.br 646.br
640Project Coordinator (Changes 1\&.0 - ) 647Project Coordinator (Changes 1\&.0 - )
641.PP 648.PP

Diff Legend

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