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.16 by root, Fri Jul 30 14:59:12 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-07-26" "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\&.3\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\&.
61.IP "\fB-bg\fP \fIcolour\fP" 63.IP "\fB-bg\fP \fIcolour\fP"
62Window background colour; 64Window background colour;
63resource \fBbackground\fP\&. 65resource \fBbackground\fP\&.
… …
156This option specifies the name of the terminal type to be set in the 158This 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 159\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; 160\fItermcap(5)\fP database and should have \fIli#\fP and \fIco#\fP entries;
159resource \fBtermName\fP\&. 161resource \fBtermName\fP\&.
160.IP "\fB-e\fP \fIcommand [arguments]\fP" 162.IP "\fB-e\fP \fIcommand [arguments]\fP"
161Run the command with its command-line arguments in the \fBurxvt\fP 163Run the command with its command-line arguments in the \fBrxvt\fP
162window; also sets the window title and icon name to be the basename 164window; 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 165of 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 166\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 167must 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 168then the default is to run the program specified by the \fBSHELL\fP
… …
210.SH "RESOURCES (available also as long-options)" 212.SH "RESOURCES (available also as long-options)"
211.PP 213.PP
212Note: `rxvt --help\&' gives a list of all resources (long options) compiled 214Note: `rxvt --help\&' gives a list of all resources (long options) compiled
213into your version\&. 215into your version\&.
214If compiled with internal Xresources support (i\&.e\&. \fBrxvt -h\fP lists 216If compiled with internal Xresources support (i\&.e\&. \fBrxvt -h\fP lists
215\fB\&.Xdefaults\fP) then \fBurxvt\fP accepts application defaults set in 217\fB\&.Xdefaults\fP) then \fBrxvt\fP accepts application defaults set in
216XAPPLOADDIR/Rxvt (compile-time defined: usually 218XAPPLOADDIR/Rxvt (compile-time defined: usually
217\fB/usr/lib/X11/app-defaults/Rxvt\fP) and resources set in \fB~/\&.Xdefaults\fP, 219\fB/usr/lib/X11/app-defaults/Rxvt\fP) and resources set in \fB~/\&.Xdefaults\fP,
218or \fB~/\&.Xresources\fP if \fB~/\&.Xdefaults\fP does not exist\&. Note that when 220or \fB~/\&.Xresources\fP if \fB~/\&.Xdefaults\fP does not exist\&. Note that when
219reading X resources, \fBurxvt\fP recognizes two class names: \fBXTerm\fP and 221reading X resources, \fBrxvt\fP recognizes two class names: \fBXTerm\fP and
220\fBRxvt\fP\&. The class name \fBXTerm\fP allows resources common to both 222\fBRxvt\fP\&. The class name \fBXTerm\fP allows resources common to both
221\fBurxvt\fP and \fIxterm\fP to be easily configured, while the class name 223\fBrxvt\fP and \fIxterm\fP to be easily configured, while the class name
222\fBRxvt\fP allows resources unique to \fBurxvt\fP, notably colours and 224\fBRxvt\fP allows resources unique to \fBrxvt\fP, notably colours and
223key-handling, to be shared between different \fBurxvt\fP configurations\&. 225key-handling, to be shared between different \fBrxvt\fP configurations\&.
224If no resources are specified, suitable defaults will be used\&. 226If no resources are specified, suitable defaults will be used\&.
225Command-line arguments can be used to override resource settings\&. The 227Command-line arguments can be used to override resource settings\&. The
226following resources are allowed: 228following resources are allowed:
227.PP 229.PP
228.IP "\fBgeometry:\fP \fIgeom\fP" 230.IP "\fBgeometry:\fP \fIgeom\fP"
… …
277option \fB+j\fP\&. 279option \fB+j\fP\&.
278.IP "\fBinheritPixmap:\fP \fIboolean\fP" 280.IP "\fBinheritPixmap:\fP \fIboolean\fP"
279\fBTrue\fP: make the background inherit the parent windows\&' pixmap, 281\fBTrue\fP: make the background inherit the parent windows\&' pixmap,
280giving artificial transparency\&. 282giving artificial transparency\&.
281\fBFalse\fP: do not inherit the parent windows\&' pixmap\&. 283\fBFalse\fP: do not inherit the parent windows\&' pixmap\&.
282.IP "\fBtintColor\fP \fIcolour\fP" 284.IP "\fBtintColor:\fP \fIcolour\fP"
283Tint the transparent background pixmap with the given colour\&. 285Tint the transparent background pixmap with the given colour\&.
284.IP "\fBscrollColor:\fP \fIcolour\fP" 286.IP "\fBscrollColor:\fP \fIcolour\fP"
285Use the specified colour for the scrollbar [default #B2B2B2]\&. 287Use the specified colour for the scrollbar [default #B2B2B2]\&.
286.IP "\fBtroughColor:\fP \fIcolour\fP" 288.IP "\fBtroughColor:\fP \fIcolour\fP"
287Use the specified colour for the scrollbar\&'s trough area [default 289Use the specified colour for the scrollbar\&'s trough area [default
… …
326.IP "\fBselectstyle:\fP \fImode\fP" 328.IP "\fBselectstyle:\fP \fImode\fP"
327Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which 329Set 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 330is xterm style with 2\&.20 old word selection, or anything else which
329gives xterm style selection\&. 331gives xterm style selection\&.
330.IP "\fBscrollstyle:\fP \fImode\fP" 332.IP "\fBscrollstyle:\fP \fImode\fP"
331Set scrollbar style to \fBurxvt\fP, \fBrxvt\fP, \fBplain\fP, \fBnext\fP or \fBxterm\fP 333Set scrollbar style to \fBrxvt\fP, \fBrxvt\fP, \fBplain\fP, \fBnext\fP or \fBxterm\fP
332.IP "\fBtitle:\fP \fIstring\fP" 334.IP "\fBtitle:\fP \fIstring\fP"
333Set window title string, the default title is the command-line 335Set window title string, the default title is the command-line
334specified after the \fB-e\fP option, if any, otherwise the application 336specified after the \fB-e\fP option, if any, otherwise the application
335name; 337name;
336option \fB-title\fP\&. 338option \fB-title\fP\&.
… …
507double quotes so that it can start or end with whitespace\&. The 509double quotes so that it can start or end with whitespace\&. The
508intervening resource name \fBkeysym\&.\fP cannot be omitted\&. This 510intervening resource name \fBkeysym\&.\fP cannot be omitted\&. This
509resource is only available when compiled with KEYSYM_RESOURCE\&. 511resource is only available when compiled with KEYSYM_RESOURCE\&.
510.SH "THE SCROLLBAR" 512.SH "THE SCROLLBAR"
511.PP 513.PP
512Lines of text that scroll off the top of the \fBurxvt\fP window (resource: 514Lines 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\&. 515\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 516The normal \fBrxvt\fP scrollbar has arrows and its behaviour is fairly
515intuitive\&. The \fBxterm-scrollbar\fP is without arrows and its behaviour 517intuitive\&. The \fBxterm-scrollbar\fP is without arrows and its behaviour
516mimics that of \fIxterm\fP 518mimics that of \fIxterm\fP
517.PP 519.PP
518Scroll down with \fBButton1\fP (\fBxterm-scrollbar\fP) or \fBShift-Next\fP\&. 520Scroll down with \fBButton1\fP (\fBxterm-scrollbar\fP) or \fBShift-Next\fP\&.
519Scroll up with \fBButton3\fP (\fBxterm-scrollbar\fP) or \fBShift-Prior\fP\&. 521Scroll up with \fBButton3\fP (\fBxterm-scrollbar\fP) or \fBShift-Prior\fP\&.
… …
540region and release; Right click to extend the marked region; 542region and release; Right click to extend the marked region;
541Left double-click to select a word; Left triple-click to select 543Left double-click to select a word; Left triple-click to select
542the entire line\&. 544the entire line\&.
543.IP "\fBInsertion\fP:" 545.IP "\fBInsertion\fP:"
544Pressing and releasing the Middle mouse button (or \fBShift-Insert\fP) 546Pressing and releasing the Middle mouse button (or \fBShift-Insert\fP)
545in an \fBurxvt\fP window causes the current text selection to be inserted 547in an \fBrxvt\fP window causes the current text selection to be inserted
546as if it had been typed on the keyboard\&. 548as if it had been typed on the keyboard\&.
547.SH "CHANGING FONTS" 549.SH "CHANGING FONTS"
548.PP 550.PP
549You can change fonts on-the-fly, which is to say cycle through the default 551You 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 552font and others of various sizes, by using \fBShift-KP_Add\fP and
551\fBShift-KP_Subtract\fP\&. Or, alternatively (if enabled) with 553\fBShift-KP_Subtract\fP\&. Or, alternatively (if enabled) with
552\fBAlt->\fP and \fBAlt-<\fP, where the actual key 554\fBAlt->\fP and \fBAlt-<\fP, where the actual key
553can be selected using resources \fBsmallfont_key\fP/\fBbigfont_key\fP\&. 555can be selected using resources \fBsmallfont_key\fP/\fBbigfont_key\fP\&.
554.SH "LOGIN STAMP" 556.SH "LOGIN STAMP"
555.PP 557.PP
556\fBurxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be 558\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 559seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this
558feature, \fBurxvt\fP must be installed setuid root on some systems\&. 560feature, \fBrxvt\fP must be installed setuid root on some systems\&.
559.SH "COLORS AND GRAPHICS" 561.SH "COLORS AND GRAPHICS"
560.PP 562.PP
561In addition to the default foreground and background colours, \fBurxvt\fP 563In addition to the default foreground and background colours, \fBrxvt\fP
562can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 564can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
563versions of the same)\&. 565versions of the same)\&.
564Here is a list of the colours with their \fBrgb\&.txt\fP names\&. 566Here is a list of the colours with their \fBrgb\&.txt\fP names\&.
565.PP 567.PP
566.TS 568.TS
… …
1047.IP "\fBrxvt -fg Black -bg White -rv\fP" 1049.IP "\fBrxvt -fg Black -bg White -rv\fP"
1048would yield White on Black, while on \fIxterm\fP(1) it would yield 1050would yield White on Black, while on \fIxterm\fP(1) it would yield
1049Black on White\&. 1051Black on White\&.
1050.SH "ENVIRONMENT" 1052.SH "ENVIRONMENT"
1051.PP 1053.PP
1052\fBurxvt\fP sets the environment variables \fBTERM\fP, \fBCOLORTERM\fP and 1054\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 1055\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 1056id 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 1057variable \fBDISPLAY\fP to specify which display terminal to use\&. \fBrxvt\fP uses
1056the environment variables \fBRXVTPATH\fP and \fBPATH\fP to find XPM files\&. 1058the environment variables \fBRXVTPATH\fP and \fBPATH\fP to find XPM files\&.
1057.SH "FILES" 1059.SH "FILES"
1058.PP 1060.PP
1059.IP "\fB/etc/utmp\fP" 1061.IP "\fB/etc/utmp\fP"
1060System file for login records\&. 1062System file for login records\&.
… …
1077.PP 1079.PP
1078Click-and-drag doesn\&'t work with X11 mouse report overriding\&. 1080Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
1079.PP 1081.PP
1080.SH "FTP LOCATION" 1082.SH "FTP LOCATION"
1081.PP 1083.PP
1082rxvt-3\&.1\&.tar\&.gz can be found at the following ftp sites 1084rxvt-3\&.3\&.tar\&.gz can be found at the following ftp sites
1083ftp://ftp\&.rxvt\&.org/pub/rxvt 1085ftp://ftp\&.rxvt\&.org/pub/rxvt
1084.PP 1086.PP
1085.SH "CURRENT PROJECT COORDINATOR" 1087.SH "CURRENT PROJECT COORDINATOR"
1086.PP 1088.PP
1087.IP "Project Coordinator" 1089.IP "Project Coordinator"

Diff Legend

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