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.7 by pcg, Mon Mar 29 16:52:06 2004 UTC vs.
Revision 1.12 by root, Sat Jul 10 20:59:39 2004 UTC

1.TH "RXVT" "1" "2004-03-28" "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\fBrxvt\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\&.5\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
51resource \fBjumpScroll\fP\&. 51resource \fBjumpScroll\fP\&.
52.IP "\fB-ip\fP|\fB+ip\fP" 52.IP "\fB-ip\fP|\fB+ip\fP"
53Turn on/off inheriting parent window\&'s pixmap\&. Alternative form 53Turn on/off inheriting parent window\&'s pixmap\&. Alternative form
54is \fB-tr\fP; 54is \fB-tr\fP;
55resource \fBinheritPixmap\fP\&. 55resource \fBinheritPixmap\fP\&.
56.IP "\fB-tint\fP \fIcolour\fP"
57Tint the transparent background pixmap with the given colour\&.
56.IP "\fB-bg\fP \fIcolour\fP" 58.IP "\fB-bg\fP \fIcolour\fP"
57Window background colour; 59Window background colour;
58resource \fBbackground\fP\&. 60resource \fBbackground\fP\&.
59.IP "\fB-fg\fP \fIcolour\fP" 61.IP "\fB-fg\fP \fIcolour\fP"
60Window foreground colour; 62Window foreground colour;
67resource \fBbackgroundPixmap\fP\&. 69resource \fBbackgroundPixmap\fP\&.
68.IP "\fB-cr\fP \fIcolour\fP" 70.IP "\fB-cr\fP \fIcolour\fP"
69The cursor colour; 71The cursor colour;
70resource \fBcursorColor\fP\&. 72resource \fBcursorColor\fP\&.
71.IP "\fB-pr\fP \fIcolour\fP" 73.IP "\fB-pr\fP \fIcolour\fP"
72The mouse pointer colour; 74The mouse pointer foreground colour;
73resource \fBpointerColor\fP\&. 75resource \fBpointerColor\fP\&.
76.IP "\fB-pr2\fP \fIcolour\fP"
77The mouse pointer background colour;
78resource \fBpointerColor2\fP\&.
74.IP "\fB-bd\fP \fIcolour\fP" 79.IP "\fB-bd\fP \fIcolour\fP"
75The colour of the border between the xterm scrollbar and the text; 80The colour of the border between the xterm scrollbar and the text;
76resource \fBborderColor\fP\&. 81resource \fBborderColor\fP\&.
77.IP "\fB-fn\fP \fIfontname\fP" 82.IP "\fB-fn\fP \fIfontname\fP"
78Select the fonts to be used used\&. This is a comma seperated 83Select the fonts to be used used\&. This is a comma seperated
178.IP "\fB-mod\fP \fImodifier\fP" 183.IP "\fB-mod\fP \fImodifier\fP"
179Override detection of Meta modifier with specified key: 184Override detection of Meta modifier with specified key:
180\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,
181\fBmod4\fP, \fBmod5\fP; 186\fBmod4\fP, \fBmod5\fP;
182resource \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\&.
183.IP "\fB-xrm\fP \fIresourcestring\fP" 194.IP "\fB-xrm\fP \fIresourcestring\fP"
184No effect on rxvt\&. Simply passes through an argument to be made 195No effect on rxvt\&. Simply passes through an argument to be made
185available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP 196available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP
186in some window managers\&. 197in some window managers\&.
187.SH "RESOURCES (available also as long-options)" 198.SH "RESOURCES (available also as long-options)"
253option \fB+j\fP\&. 264option \fB+j\fP\&.
254.IP "\fBinheritPixmap:\fP \fIboolean\fP" 265.IP "\fBinheritPixmap:\fP \fIboolean\fP"
255\fBTrue\fP: make the background inherit the parent windows\&' pixmap, 266\fBTrue\fP: make the background inherit the parent windows\&' pixmap,
256giving artificial transparency\&. 267giving artificial transparency\&.
257\fBFalse\fP: do not inherit the parent windows\&' pixmap\&. 268\fBFalse\fP: do not inherit the parent windows\&' pixmap\&.
269.IP "\fBtintColor\fP \fIcolour\fP"
270Tint the transparent background pixmap with the given colour\&.
258.IP "\fBscrollColor:\fP \fIcolour\fP" 271.IP "\fBscrollColor:\fP \fIcolour\fP"
259Use the specified colour for the scrollbar [default #B2B2B2]\&. 272Use the specified colour for the scrollbar [default #B2B2B2]\&.
260.IP "\fBtroughColor:\fP \fIcolour\fP" 273.IP "\fBtroughColor:\fP \fIcolour\fP"
261Use the specified colour for the scrollbar\&'s trough area [default 274Use the specified colour for the scrollbar\&'s trough area [default
262#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. 275#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&.
288.IP "\fBselectstyle:\fP \fImode\fP" 301.IP "\fBselectstyle:\fP \fImode\fP"
289Set 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
290is 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
291gives xterm style selection\&. 304gives xterm style selection\&.
292.IP "\fBscrollstyle:\fP \fImode\fP" 305.IP "\fBscrollstyle:\fP \fImode\fP"
293Set scrollbar style to \fBrxvt\fP, \fBnext\fP or \fBxterm\fP 306Set scrollbar style to \fBrxvt\fP, \fBrxvt\fP, \fBplain\fP, \fBnext\fP or \fBxterm\fP
294.IP "\fBtitle:\fP \fIstring\fP" 307.IP "\fBtitle:\fP \fIstring\fP"
295Set window title string, the default title is the command-line 308Set window title string, the default title is the command-line
296specified after the \fB-e\fP option, if any, otherwise the application 309specified after the \fB-e\fP option, if any, otherwise the application
297name; 310name;
298option \fB-title\fP\&. 311option \fB-title\fP\&.
399option \fB-bc\fP\&. 412option \fB-bc\fP\&.
400.IP "\fBpointerBlank:\fP \fIboolean\fP" 413.IP "\fBpointerBlank:\fP \fIboolean\fP"
401\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
402of seconds of inactivity\&. 415of seconds of inactivity\&.
403\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\&.
404.IP "\fBpointerBlankDelay:\fP \fInumber\fP" 421.IP "\fBpointerBlankDelay:\fP \fInumber\fP"
405Specifies number of seconds before blanking the pointer [default 2]\&. 422Specifies number of seconds before blanking the pointer [default 2]\&.
406.IP "\fBbackspacekey:\fP \fIstring\fP" 423.IP "\fBbackspacekey:\fP \fIstring\fP"
407The 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
408\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,
430while staying in another locale\&. 447while staying in another locale\&.
431option \fB-imlocale\fP\&. 448option \fB-imlocale\fP\&.
432.IP "\fBinsecure\fP" 449.IP "\fBinsecure\fP"
433Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences 450Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences
434that echo arbitrary strings like the icon name or the locale\&. This 451that echo arbitrary strings like the icon name or the locale\&. This
435could be abused if somebody gets 8-bit-clean access to your display, 452could be abused if somebody gets 8-bit-clean access to your
436wether throuh a mail client displaying mail bodies unfiltered or 453display, wether throuh a mail client displaying mail bodies
437though write(1)\&. Therefore, these sequences are disabled by default\&. 454unfiltered or though write(1)\&. Therefore, these sequences are
438You can enable them by setting this boolean resource or specifying 455disabled by default\&. (Note that other terminals, including xterm,
456have these sequences enabled by default)\&. You can enable them
457by setting this boolean resource or specifying \fB-insecure\fP as
439\fB-insecure\fP as an option\&. At the moment, this enabled display-answer, 458an option\&. At the moment, this enabled display-answer, locale,
440locale, findfont, icon label and window title requests as well as 459findfont, icon label and window title requests as well as dynamic
441dynamic menubar dispatch\&. 460menubar dispatch\&.
442.IP "\fBmodifier:\fP \fImodifier\fP" 461.IP "\fBmodifier:\fP \fImodifier\fP"
443Set the key to be interpreted as the Meta key to: 462Set the key to be interpreted as the Meta key to:
444\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, 463\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
445\fBmod4\fP, \fBmod5\fP; 464\fBmod4\fP, \fBmod5\fP;
446option \fB-mod\fP\&. 465option \fB-mod\fP\&.
447.IP "\fBanswerbackString:\fP \fIstring\fP" 466.IP "\fBanswerbackString:\fP \fIstring\fP"
448Specify the reply rxvt sends to the shell when an ENQ (control-E) 467Specify the reply rxvt sends to the shell when an ENQ (control-E)
449character is passed through\&. It may contain escape values as 468character is passed through\&. It may contain escape values as
450described in the entry on \fBkeysym\fP following\&. 469described in the entry on \fBkeysym\fP following\&.
470.IP "\fBsecondaryScreen:\fP \fIbool\fP"
471Turn on/off secondary screen (default enabled)\&.
472.IP "\fBsecondaryScroll:\fP \fIbool\fP"
473Turn on/off secondary screen scroll (default enabled)\&. If
474the this option is enabled, scrolls on the secondary screen will
475change the scrollback buffer and switching to/from the secondary screen
476will instead scroll the screen up\&.
451.IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP" 477.IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP"
452Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It 478Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It
453may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape, 479may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape,
454\en: newline, \er: return, \et: tab, \e000: octal number) or control 480\en: newline, \er: return, \et: tab, \e000: octal number) or control
455characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with 481characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with
579.PP 605.PP
580Click-and-drag doesn\&'t work with X11 mouse report overriding\&. 606Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
581.PP 607.PP
582.SH "FTP LOCATION" 608.SH "FTP LOCATION"
583.PP 609.PP
584rxvt-2\&.5\&.tar\&.gz can be found at the following ftp sites 610rxvt-3\&.1\&.tar\&.gz can be found at the following ftp sites
585ftp://ftp\&.rxvt\&.org/pub/rxvt 611ftp://ftp\&.rxvt\&.org/pub/rxvt
586.PP 612.PP
587.SH "CURRENT PROJECT COORDINATOR" 613.SH "CURRENT PROJECT COORDINATOR"
588.PP 614.PP
589.IP "Project Coordinator" 615.IP "Project Coordinator"
610.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>" 636.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>"
611Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5) 637Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5)
612.IP "Geoff Wing <gcw@pobox\&.com>" 638.IP "Geoff Wing <gcw@pobox\&.com>"
613Rewrote screen display and text selection routines\&. 639Rewrote screen display and text selection routines\&.
614Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode) 640Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode)
615.IP "Marc Alexander Lehman <rxvt@schmorp\&.de>" 641.IP "Marc Alexander Lehmann <rxvt@schmorp\&.de>"
616Rewrote most of the display code and internal character handling 642Forked rxvt-unicode, rewrote most of the display code and
617to store text in unicode\&. Numerous other fixes and extensions\&. 643internal character handling to store text in unicode,
644improve xterm compatibility and apply numerous other bugfixes
645and extensions\&.
618.br 646.br
619Project Coordinator (Changes 1\&.0 - ) 647Project Coordinator (Changes 1\&.0 - )
620.PP 648.PP

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines