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.15 by root, Thu Jul 29 22:46:41 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-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\fBrxvt\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\&.6\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
… …
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\&.
84list of font names that are used in turn when trying to display 87This is a comma seperated list of font names that are used in turn when
85unicode characters\&. The first font defines the cell size for characters, 88trying to display Unicode characters\&.
86other fonts might be smaller, but not larger\&. A reasonable default font list 89The first font defines the cell size for characters; other fonts might
87is always appended to it\&. 90be smaller, but not larger\&.
91A reasonable default font list is always appended to it\&.
88resource \fBfont\fP\&. 92resource \fBfont\fP\&.
93.IP "\fB-rb\fP|\fB+rb\fP"
94Enable "real bold" support\&.
95When this option is on, bold text will be displayed using the first
96available bold font in the font list\&.
97Bold fonts should thus be specified in the font list after their
98corresponding regular fonts\&.
99If no bold font can be found, a regular font will be used\&.
100resource \fBrealBold\fP\&.
89.IP "\fB-name\fP \fIname\fP" 101.IP "\fB-name\fP \fIname\fP"
90Specify the application name under which resources 102Specify the application name under which resources
91are to be obtained, rather than the default executable file name\&. 103are to be obtained, rather than the default executable file name\&.
92Name should not contain `\&.\&' or `*\&' characters\&. 104Name should not contain `\&.\&' or `*\&' characters\&.
93Also sets the icon and title name\&. 105Also sets the icon and title name\&.
… …
183.IP "\fB-mod\fP \fImodifier\fP" 195.IP "\fB-mod\fP \fImodifier\fP"
184Override detection of Meta modifier with specified key: 196Override detection of Meta modifier with specified key:
185\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, 197\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
186\fBmod4\fP, \fBmod5\fP; 198\fBmod4\fP, \fBmod5\fP;
187resource \fImodifier\fP\&. 199resource \fImodifier\fP\&.
200.IP "\fB-ssc\fP|\fB+ssc\fP"
201Turn on/off secondary screen (default enabled);
202resource \fBsecondaryScreen\fP\&.
203.IP "\fB-ssr\fP|\fB+ssr\fP"
204Turn on/off secondary screen scroll (default enabled);
205resource \fBsecondaryScroll\fP\&.
188.IP "\fB-xrm\fP \fIresourcestring\fP" 206.IP "\fB-xrm\fP \fIresourcestring\fP"
189No effect on rxvt\&. Simply passes through an argument to be made 207No effect on rxvt\&. Simply passes through an argument to be made
190available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP 208available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP
191in some window managers\&. 209in some window managers\&.
192.SH "RESOURCES (available also as long-options)" 210.SH "RESOURCES (available also as long-options)"
… …
228but the actual colour names used are listed in the 246but the actual colour names used are listed in the
229\fBCOLORS AND GRAPHICS\fP section\&. 247\fBCOLORS AND GRAPHICS\fP section\&.
230.IP "\fBcolorBD:\fP \fIcolour\fP" 248.IP "\fBcolorBD:\fP \fIcolour\fP"
231Use the specified colour to display bold characters when the 249Use the specified colour to display bold characters when the
232foreground colour is the default\&. 250foreground colour is the default\&.
251This option will be ignored if \fBrealBold\fP is enabled\&.
233.IP "\fBcolorUL:\fP \fIcolour\fP" 252.IP "\fBcolorUL:\fP \fIcolour\fP"
234Use the specified colour to display underlined characters when the 253Use the specified colour to display underlined characters when the
235foreground colour is the default\&. 254foreground colour is the default\&.
236.IP "\fBcolorRV:\fP \fIcolour\fP" 255.IP "\fBcolorRV:\fP \fIcolour\fP"
237Use the specified colour as the background for reverse video 256Use the specified colour as the background for reverse video
… …
258option \fB+j\fP\&. 277option \fB+j\fP\&.
259.IP "\fBinheritPixmap:\fP \fIboolean\fP" 278.IP "\fBinheritPixmap:\fP \fIboolean\fP"
260\fBTrue\fP: make the background inherit the parent windows\&' pixmap, 279\fBTrue\fP: make the background inherit the parent windows\&' pixmap,
261giving artificial transparency\&. 280giving artificial transparency\&.
262\fBFalse\fP: do not inherit the parent windows\&' pixmap\&. 281\fBFalse\fP: do not inherit the parent windows\&' pixmap\&.
263.IP "\fBtintColor\fP \fIcolour\fP" 282.IP "\fBtintColor:\fP \fIcolour\fP"
264Tint the transparent background pixmap with the given colour\&. 283Tint the transparent background pixmap with the given colour\&.
265.IP "\fBscrollColor:\fP \fIcolour\fP" 284.IP "\fBscrollColor:\fP \fIcolour\fP"
266Use the specified colour for the scrollbar [default #B2B2B2]\&. 285Use the specified colour for the scrollbar [default #B2B2B2]\&.
267.IP "\fBtroughColor:\fP \fIcolour\fP" 286.IP "\fBtroughColor:\fP \fIcolour\fP"
268Use the specified colour for the scrollbar\&'s trough area [default 287Use the specified colour for the scrollbar\&'s trough area [default
… …
284.IP "\fBpath:\fP \fIpath\fP" 303.IP "\fBpath:\fP \fIpath\fP"
285Specify the colon-delimited search path for finding files (XPM and 304Specify the colon-delimited search path for finding files (XPM and
286menus), in addition to the paths specified by the \fBRXVTPATH\fP and 305menus), in addition to the paths specified by the \fBRXVTPATH\fP and
287\fBPATH\fP environment variables\&. 306\fBPATH\fP environment variables\&.
288.IP "\fBfont:\fP \fIfontname\fP" 307.IP "\fBfont:\fP \fIfontname\fP"
289Select the fonts to be used used\&. This is a comma seperated 308Select the fonts to be used\&.
290list of font names that are used in turn when trying to display 309This is a comma seperated list of font names that are used in turn when
291unicode characters\&. The first font defines the cell size for characters, 310trying to display Unicode characters\&.
292other fonts might be smaller, but not larger\&. A reasonable default font list 311The first font defines the cell size for characters; other fonts might
293is always appended to this list\&. 312be smaller, but not larger\&.
313A reasonable default font list is always appended to it\&.
294option \fB-fn\fP\&. 314option \fB-fn\fP\&.
315.IP "\fBrealBold:\fP \fIboolean\fP"
316\fBTrue\fP: Enable "real bold" support\&.
317When this option is on, bold text will be displayed using the first
318available bold font in the font list\&.
319Bold fonts should thus be specified in the font list after their
320corresponding regular fonts\&.
321If no bold font can be found, a regular font will be used\&.
322option \fB-rb\fP\&.
323\fBFalse\fP: Display bold text in a regular font, using the color
324specified with \fBcolorBD\fP;
325option \fB+rb\fP\&.
295.IP "\fBselectstyle:\fP \fImode\fP" 326.IP "\fBselectstyle:\fP \fImode\fP"
296Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which 327Set 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 328is xterm style with 2\&.20 old word selection, or anything else which
298gives xterm style selection\&. 329gives xterm style selection\&.
299.IP "\fBscrollstyle:\fP \fImode\fP" 330.IP "\fBscrollstyle:\fP \fImode\fP"
300Set scrollbar style to \fBrxvt\fP, \fBnext\fP or \fBxterm\fP 331Set scrollbar style to \fBrxvt\fP, \fBrxvt\fP, \fBplain\fP, \fBnext\fP or \fBxterm\fP
301.IP "\fBtitle:\fP \fIstring\fP" 332.IP "\fBtitle:\fP \fIstring\fP"
302Set window title string, the default title is the command-line 333Set window title string, the default title is the command-line
303specified after the \fB-e\fP option, if any, otherwise the application 334specified after the \fB-e\fP option, if any, otherwise the application
304name; 335name;
305option \fB-title\fP\&. 336option \fB-title\fP\&.
… …
406option \fB-bc\fP\&. 437option \fB-bc\fP\&.
407.IP "\fBpointerBlank:\fP \fIboolean\fP" 438.IP "\fBpointerBlank:\fP \fIboolean\fP"
408\fBTrue\fP: blank the pointer when a key is pressed or after a set number 439\fBTrue\fP: blank the pointer when a key is pressed or after a set number
409of seconds of inactivity\&. 440of seconds of inactivity\&.
410\fBFalse\fP: the pointer is always visible [default]\&. 441\fBFalse\fP: the pointer is always visible [default]\&.
442.IP "\fBpointerColor:\fP \fIcolour\fP"
443Mouse pointer foreground colour\&.
444.IP "\fBpointerColor2:\fP \fIcolour\fP"
445Mouse pointer background colour\&.
411.IP "\fBpointerBlankDelay:\fP \fInumber\fP" 446.IP "\fBpointerBlankDelay:\fP \fInumber\fP"
412Specifies number of seconds before blanking the pointer [default 2]\&. 447Specifies number of seconds before blanking the pointer [default 2]\&.
413.IP "\fBbackspacekey:\fP \fIstring\fP" 448.IP "\fBbackspacekey:\fP \fIstring\fP"
414The string to send when the backspace key is pressed\&. If set to 449The string to send when the backspace key is pressed\&. If set to
415\fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted, 450\fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted,
… …
437while staying in another locale\&. 472while staying in another locale\&.
438option \fB-imlocale\fP\&. 473option \fB-imlocale\fP\&.
439.IP "\fBinsecure\fP" 474.IP "\fBinsecure\fP"
440Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences 475Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences
441that echo arbitrary strings like the icon name or the locale\&. This 476that echo arbitrary strings like the icon name or the locale\&. This
442could be abused if somebody gets 8-bit-clean access to your display, 477could be abused if somebody gets 8-bit-clean access to your
443wether throuh a mail client displaying mail bodies unfiltered or 478display, wether throuh a mail client displaying mail bodies
444though write(1)\&. Therefore, these sequences are disabled by default\&. 479unfiltered or though write(1)\&. Therefore, these sequences are
445You can enable them by setting this boolean resource or specifying 480disabled by default\&. (Note that other terminals, including xterm,
481have these sequences enabled by default)\&. You can enable them
482by setting this boolean resource or specifying \fB-insecure\fP as
446\fB-insecure\fP as an option\&. At the moment, this enabled display-answer, 483an option\&. At the moment, this enabled display-answer, locale,
447locale, findfont, icon label and window title requests as well as 484findfont, icon label and window title requests as well as dynamic
448dynamic menubar dispatch\&. 485menubar dispatch\&.
449.IP "\fBmodifier:\fP \fImodifier\fP" 486.IP "\fBmodifier:\fP \fImodifier\fP"
450Set the key to be interpreted as the Meta key to: 487Set 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, 488\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
452\fBmod4\fP, \fBmod5\fP; 489\fBmod4\fP, \fBmod5\fP;
453option \fB-mod\fP\&. 490option \fB-mod\fP\&.
454.IP "\fBanswerbackString:\fP \fIstring\fP" 491.IP "\fBanswerbackString:\fP \fIstring\fP"
455Specify the reply rxvt sends to the shell when an ENQ (control-E) 492Specify the reply rxvt sends to the shell when an ENQ (control-E)
456character is passed through\&. It may contain escape values as 493character is passed through\&. It may contain escape values as
457described in the entry on \fBkeysym\fP following\&. 494described in the entry on \fBkeysym\fP following\&.
495.IP "\fBsecondaryScreen:\fP \fIbool\fP"
496Turn on/off secondary screen (default enabled)\&.
497.IP "\fBsecondaryScroll:\fP \fIbool\fP"
498Turn on/off secondary screen scroll (default enabled)\&. If
499the this option is enabled, scrolls on the secondary screen will
500change the scrollback buffer and switching to/from the secondary screen
501will instead scroll the screen up\&.
458.IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP" 502.IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP"
459Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It 503Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It
460may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape, 504may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape,
461\en: newline, \er: return, \et: tab, \e000: octal number) or control 505\en: newline, \er: return, \et: tab, \e000: octal number) or control
462characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with 506characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with
… …
1033.PP 1077.PP
1034Click-and-drag doesn\&'t work with X11 mouse report overriding\&. 1078Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
1035.PP 1079.PP
1036.SH "FTP LOCATION" 1080.SH "FTP LOCATION"
1037.PP 1081.PP
1038rxvt-2\&.6\&.tar\&.gz can be found at the following ftp sites 1082rxvt-3\&.3\&.tar\&.gz can be found at the following ftp sites
1039ftp://ftp\&.rxvt\&.org/pub/rxvt 1083ftp://ftp\&.rxvt\&.org/pub/rxvt
1040.PP 1084.PP
1041.SH "CURRENT PROJECT COORDINATOR" 1085.SH "CURRENT PROJECT COORDINATOR"
1042.PP 1086.PP
1043.IP "Project Coordinator" 1087.IP "Project Coordinator"
… …
1064.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>" 1108.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>"
1065Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5) 1109Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5)
1066.IP "Geoff Wing <gcw@pobox\&.com>" 1110.IP "Geoff Wing <gcw@pobox\&.com>"
1067Rewrote screen display and text selection routines\&. 1111Rewrote screen display and text selection routines\&.
1068Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode) 1112Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode)
1069.IP "Marc Alexander Lehman <rxvt@schmorp\&.de>" 1113.IP "Marc Alexander Lehmann <rxvt@schmorp\&.de>"
1070Rewrote most of the display code and internal character handling 1114Forked rxvt-unicode, rewrote most of the display code and
1071to store text in unicode\&. Numerous other fixes and extensions\&. 1115internal character handling to store text in unicode,
1116improve xterm compatibility and apply numerous other bugfixes
1117and extensions\&.
1072.br 1118.br
1073Project Coordinator (Changes 1\&.0 - ) 1119Project Coordinator (Changes 1\&.0 - )
1074.PP 1120.PP

Diff Legend

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