ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1
Revision: 1.21
Committed: Sat Jul 31 16:05:45 2004 UTC (19 years, 11 months ago) by root
Branch: MAIN
Changes since 1.20: +11 -6 lines
Log Message:
*** empty log message ***

File Contents

# User Rev Content
1 pcg 1.1 .if !\n(.g .ab GNU tbl requires GNU troff.
2     .if !dTS .ds TS
3     .if !dTE .ds TE
4 root 1.20 .TH "RXVT" "1" "2004-07-31" "X Version 11" "X Tools"
5 pcg 1.1 .SH "NAME"
6 pcg 1.6 rxvt-unicode (ouR XVT, unicode) \- a VT102 emulator for the X window system
7 pcg 1.1 .PP
8     .SH "SYNOPSIS"
9     .PP
10 root 1.14 \fBrxvt\fP [options] [-e command [ args ]]
11 pcg 1.1 .PP
12     .SH "DESCRIPTION"
13     .PP
14 root 1.21 \fBrxvt-unicode\fP, version \fB3\&.4\fP, is a colour vt102 terminal emulator
15 pcg 1.1 intended as an \fIxterm\fP(1) replacement for users who do not require
16     features such as Tektronix 4014 emulation and toolkit-style configurability\&.
17 pcg 1.6 As a result, \fBrxvt-unicode\fP uses much less swap space -- a significant
18 pcg 1.1 advantage on a machine serving many X sessions\&.
19     .PP
20     .PP
21     .SH "OPTIONS"
22     .PP
23 root 1.14 The \fBrxvt\fP options (mostly a subset of \fIxterm\fP\&'s) are listed below\&.
24 pcg 1.1 In keeping with the smaller-is-better philosophy, options may be eliminated
25     or default values chosen at compile-time, so options and defaults listed
26     may 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\&.
28     Option descriptions may be prefixed with which compile option each is
29     dependent upon\&. e\&.g\&. `Compile \fIXIM\fP:\&' requires \fIXIM\fP on the \fIOptions\fP
30     line\&. Note: `rxvt -help\&' gives a list of all command-line options compiled
31     into your version\&.
32     .PP
33 root 1.14 Note that \fBrxvt\fP permits the resource name to be used as a long-option
34 pcg 1.1 (--/++ option) so the potential command-line options are far greater than
35     those listed\&.
36     For example: `rxvt --loginShell --color1 Orange\&'\&.
37     .PP
38     The following options are available:
39     .PP
40     .IP "\fB-help\fP, \fB--help\fP"
41     Print out a message describing available options\&.
42     .IP "\fB-display\fP \fIdisplayname\fP"
43     Attempt to open a window on the named X display (\fB-d\fP still
44     respected)\&. In the absence of this option, the display specified
45     by the \fBDISPLAY\fP environment variable is used\&.
46     .IP "\fB-geometry\fP \fIgeom\fP"
47     Window geometry (\fB-g\fP still respected);
48     resource \fBgeometry\fP\&.
49     .IP "\fB-rv\fP|\fB+rv\fP"
50     Turn on/off simulated reverse video;
51     resource \fBreverseVideo\fP\&.
52     .IP "\fB-j\fP|\fB+j\fP"
53     Turn on/off jump scrolling;
54     resource \fBjumpScroll\fP\&.
55     .IP "\fB-ip\fP|\fB+ip\fP"
56     Turn on/off inheriting parent window\&'s pixmap\&. Alternative form
57     is \fB-tr\fP;
58     resource \fBinheritPixmap\fP\&.
59 root 1.16 .IP "\fB-fade\fP \fInumber\fP"
60     Fade the text by the given percentage when focus is lost\&.
61 pcg 1.8 .IP "\fB-tint\fP \fIcolour\fP"
62 root 1.17 Tint the transparent background pixmap with the given colour when
63 root 1.21 transparency is enabled with \fB-tr\fP or \fB-ip\fP\&. See also
64     the \fB-sh\fP option that cna be used to brighten or darken
65     the image in addition to tinting it\&.
66     dot(\fB-sh\fP) \fInumber\fP
67     Darken (0 \&.\&. 100) or lighten (-1 \&.\&. -100) the transparent background
68     image in addition to tinting it\&.
69 pcg 1.1 .IP "\fB-bg\fP \fIcolour\fP"
70     Window background colour;
71     resource \fBbackground\fP\&.
72     .IP "\fB-fg\fP \fIcolour\fP"
73     Window foreground colour;
74     resource \fBforeground\fP\&.
75 root 1.20 .IP "\fB-pixmap\fP \fIfile[;geom]\fP"
76 pcg 1.1 Compile \fIXPM\fP: Specify XPM file for the background and also
77     optionally specify its scaling with a geometry string\&. Note you
78     may need to add quotes to avoid special shell interpretation of
79     the `;\&' in the command-line;
80     resource \fBbackgroundPixmap\fP\&.
81     .IP "\fB-cr\fP \fIcolour\fP"
82     The cursor colour;
83     resource \fBcursorColor\fP\&.
84     .IP "\fB-pr\fP \fIcolour\fP"
85 root 1.12 The mouse pointer foreground colour;
86 pcg 1.1 resource \fBpointerColor\fP\&.
87 root 1.12 .IP "\fB-pr2\fP \fIcolour\fP"
88     The mouse pointer background colour;
89     resource \fBpointerColor2\fP\&.
90 pcg 1.1 .IP "\fB-bd\fP \fIcolour\fP"
91     The colour of the border between the xterm scrollbar and the text;
92     resource \fBborderColor\fP\&.
93     .IP "\fB-fn\fP \fIfontname\fP"
94 root 1.13 Select the fonts to be used\&.
95     This is a comma seperated list of font names that are used in turn when
96     trying to display Unicode characters\&.
97     The first font defines the cell size for characters; other fonts might
98     be smaller, but not larger\&.
99     A reasonable default font list is always appended to it\&.
100 pcg 1.1 resource \fBfont\fP\&.
101 root 1.13 .IP "\fB-rb\fP|\fB+rb\fP"
102     Enable "real bold" support\&.
103     When this option is on, bold text will be displayed using the first
104     available bold font in the font list\&.
105     Bold fonts should thus be specified in the font list after their
106     corresponding regular fonts\&.
107     If no bold font can be found, a regular font will be used\&.
108     resource \fBrealBold\fP\&.
109 pcg 1.1 .IP "\fB-name\fP \fIname\fP"
110     Specify the application name under which resources
111     are to be obtained, rather than the default executable file name\&.
112     Name should not contain `\&.\&' or `*\&' characters\&.
113     Also sets the icon and title name\&.
114     .IP "\fB-ls\fP|\fB+ls\fP"
115     Start as a login-shell/sub-shell;
116     resource \fBloginShell\fP\&.
117     .IP "\fB-ut\fP|\fB+ut\fP"
118     Compile \fIutmp\fP: Inhibit/enable writing a utmp entry;
119     resource \fButmpInhibit\fP\&.
120     .IP "\fB-vb\fP|\fB+vb\fP"
121     Turn on/off visual bell on receipt of a bell character;
122     resource \fBvisualBell\fP\&.
123     .IP "\fB-sb\fP|\fB+sb\fP"
124     Turn on/off scrollbar;
125     resource \fBscrollBar\fP\&.
126     .IP "\fB-si\fP|\fB+si\fP"
127     Turn on/off scroll-to-bottom on TTY output inhibit;
128     resource \fBscrollTtyOutput\fP has opposite effect\&.
129     .IP "\fB-sk\fP|\fB+sk\fP"
130     Turn on/off scroll-to-bottom on keypress;
131     resource \fBscrollTtyKeypress\fP\&.
132     .IP "\fB-sw\fP|\fB+sw\fP"
133     Turn on/off scrolling with the scrollback buffer as new
134     lines appear\&. This only takes effect if \fB-si\fP is also given;
135     resource \fBscrollWithBuffer\fP\&.
136     .IP "\fB-sr\fP|\fB+sr\fP"
137     Put scrollbar on right/left;
138     resource \fBscrollBar_right\fP\&.
139     .IP "\fB-st\fP|\fB+st\fP"
140     Display normal (non XTerm/NeXT) scrollbar without/with a trough;
141     resource \fBscrollBar_floating\fP\&.
142     .IP "\fB-bc\fP|\fB+bc\fP"
143     Blink the cursor; resource \fBcursorBlink\fP\&.
144     .IP "\fB-iconic\fP"
145     Start iconified, if the window manager supports that option\&.
146     Alternative form is \fB-ic\fP\&.
147     .IP "\fB-sl\fP \fInumber\fP"
148     Save \fInumber\fP lines in the scrollback buffer\&. See resource entry
149     for limits;
150     resource \fBsaveLines\fP\&.
151     .IP "\fB-b\fP \fInumber\fP"
152     Compile \fIfrills\fP: Internal border of \fInumber\fP pixels\&. See
153     resource entry for limits;
154     resource \fBinternalBorder\fP\&.
155     .IP "\fB-w\fP \fInumber\fP"
156     Compile \fIfrills\fP: External border of \fInumber\fP pixels\&.
157     Also, \fB-bw\fP and \fB-borderwidth\fP\&. See resource entry for limits;
158     resource \fBexternalBorder\fP\&.
159     .IP "\fB-lsp\fP \fInumber\fP"
160     Compile \fIlinespace\fP: Lines (pixel height) to insert between each
161     row of the display;
162     resource \fBlinespace\fP\&.
163     .IP "\fB-tn\fP \fItermname\fP"
164     This option specifies the name of the terminal type to be set in the
165     \fBTERM\fP environment variable\&. This terminal type must exist in the
166     \fItermcap(5)\fP database and should have \fIli#\fP and \fIco#\fP entries;
167     resource \fBtermName\fP\&.
168     .IP "\fB-e\fP \fIcommand [arguments]\fP"
169 root 1.14 Run the command with its command-line arguments in the \fBrxvt\fP
170 pcg 1.1 window; also sets the window title and icon name to be the basename
171     of the program being executed if neither \fI-title\fP (\fI-T\fP) nor
172     \fI-n\fP are given on the command line\&. If this option is used, it
173     must be the last on the command-line\&. If there is no \fB-e\fP option
174     then the default is to run the program specified by the \fBSHELL\fP
175     environment variable or, failing that, \fIsh(1)\fP\&.
176     .IP "\fB-title\fP \fItext\fP"
177     Window title (\fB-T\fP still respected); the default title is the
178     basename of the program specified after the \fB-e\fP option, if
179     any, otherwise the application name;
180     resource \fBtitle\fP\&.
181     .IP "\fB-n\fP \fItext\fP"
182     Icon name; the default name is the basename of the program specified
183     after the \fB-e\fP option, if any, otherwise the application name;
184     resource \fBiconName\fP\&.
185     .IP "\fB-C\fP"
186     Capture system console messages\&.
187     .IP "\fB-pt\fP \fIstyle\fP"
188     Compile \fIXIM\fP: input style for input method;
189     \fBOverTheSpot\fP, \fBOffTheSpot\fP, \fBRoot\fP;
190     resource \fBpreeditType\fP\&.
191     .IP "\fB-im\fP \fItext\fP"
192     Compile \fIXIM\fP: input method name\&.
193     resource \fBinputMethod\fP\&.
194 pcg 1.2 .IP "\fB-imlocale\fP \fIstring\fP"
195     The locale to use for opening the IM\&. You can use an LC_CTYPE
196     of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP
197     for the input extension to be able to input japanese characters
198     while staying in another locale\&.
199 pcg 1.7 .IP "\fB-insecure\fP"
200     Enable "insecure" mode, which currently enables most of the escape
201     sequences that echo strings\&. See the resource \fBinsecure\fP for
202     more info\&.
203 pcg 1.1 .IP "\fB-mod\fP \fImodifier\fP"
204     Override detection of Meta modifier with specified key:
205     \fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
206     \fBmod4\fP, \fBmod5\fP;
207     resource \fImodifier\fP\&.
208 pcg 1.9 .IP "\fB-ssc\fP|\fB+ssc\fP"
209     Turn on/off secondary screen (default enabled);
210     resource \fBsecondaryScreen\fP\&.
211     .IP "\fB-ssr\fP|\fB+ssr\fP"
212     Turn on/off secondary screen scroll (default enabled);
213     resource \fBsecondaryScroll\fP\&.
214 pcg 1.1 .IP "\fB-xrm\fP \fIresourcestring\fP"
215     No effect on rxvt\&. Simply passes through an argument to be made
216     available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP
217     in some window managers\&.
218     .SH "RESOURCES (available also as long-options)"
219     .PP
220     Note: `rxvt --help\&' gives a list of all resources (long options) compiled
221     into your version\&.
222 root 1.18 .PP
223     There are two different methods that rxvt can use to get the
224     Xresource data: using the X libraries (Xrm*-functions) or internal Xresources
225     reader (\fB~/\&.Xdefaults\fP)\&. For the first method (ie\&. \fBrxvt -h\fP lists
226     \fBXGetDefaults\fP), you can set and change the resources using X11
227     tools like \fBxset\fP\&. Many distribution do also load settings from the
228     \fB~/\&.Xresources\fP file when X starts\&.
229     .PP
230     If compiled with internal Xresources support (i\&.e\&. \fBrxvt
231     -h\fP lists \fB\&.Xdefaults\fP) then \fBrxvt\fP accepts application
232     defaults set in XAPPLOADDIR/URxvt (compile-time defined: usually
233     \fB/usr/lib/X11/app-defaults/URxvt\fP) and resources set in
234     \fB~/\&.Xdefaults\fP, or \fB~/\&.Xresources\fP if \fB~/\&.Xdefaults\fP does not exist\&.
235     Note that when reading X resources, \fBrxvt\fP recognizes two class
236     names: \fBXTerm\fP and \fBURxvt\fP\&. The class name \fBRxvt\fP allows resources
237     common to both \fBrxvt\fP and the original \fIrxvt\fP to be easily configured,
238     while the class name \fBURxvt\fP allows resources unique to \fBrxvt\fP,
239     notably colours and key-handling, to be shared between different
240     \fBrxvt\fP configurations\&. If no resources are specified, suitable
241     defaults will be used\&. Command-line arguments can be used to override
242     resource settings\&. The following resources are allowed:
243 pcg 1.1 .PP
244     .IP "\fBgeometry:\fP \fIgeom\fP"
245     Create the window with the specified X window geometry [default
246     80x24];
247     option \fB-geometry\fP\&.
248     .IP "\fBbackground:\fP \fIcolour\fP"
249     Use the specified colour as the window\&'s background colour [default
250     White];
251     option \fB-bg\fP\&.
252     .IP "\fBforeground:\fP \fIcolour\fP"
253     Use the specified colour as the window\&'s foreground colour [default
254     Black];
255     option \fB-fg\fP\&.
256     .IP "\fBcolor\fP\fIn\fP\fB:\fP \fIcolour\fP"
257     Use the specified colour for the colour value \fIn\fP, where 0-7
258     corresponds to low-intensity (normal) colours and 8-15 corresponds to
259     high-intensity (bold = bright foreground, blink = bright
260     background) colours\&. The canonical names are as follows:
261     0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white,
262     but the actual colour names used are listed in the
263     \fBCOLORS AND GRAPHICS\fP section\&.
264     .IP "\fBcolorBD:\fP \fIcolour\fP"
265     Use the specified colour to display bold characters when the
266     foreground colour is the default\&.
267 root 1.13 This option will be ignored if \fBrealBold\fP is enabled\&.
268 pcg 1.1 .IP "\fBcolorUL:\fP \fIcolour\fP"
269     Use the specified colour to display underlined characters when the
270     foreground colour is the default\&.
271     .IP "\fBcolorRV:\fP \fIcolour\fP"
272     Use the specified colour as the background for reverse video
273     characters\&.
274     .IP "\fBcursorColor:\fP \fIcolour\fP"
275     Use the specified colour for the cursor\&. The default is to use the
276     foreground colour;
277     option \fB-cr\fP\&.
278     .IP "\fBcursorColor2:\fP \fIcolour\fP"
279     Use the specified colour for the colour of the cursor text\&. For this
280     to take effect, \fBcursorColor\fP must also be specified\&. The default
281     is to use the background colour\&.
282     .IP "\fBreverseVideo:\fP \fIboolean\fP"
283     \fBTrue\fP: simulate reverse video by foreground and background colours;
284     option \fB-rv\fP\&.
285     \fBFalse\fP: regular screen colours [default];
286     option \fB+rv\fP\&.
287     See note in \fBCOLORS AND GRAPHICS\fP section\&.
288     .IP "\fBjumpScroll:\fP \fIboolean\fP"
289     \fBTrue\fP: specify that jump scrolling should be used\&. When scrolling
290     quickly, fewer screen updates are performed [default];
291     option \fB-j\fP\&.
292     \fBFalse\fP: specify that smooth scrolling should be used;
293     option \fB+j\fP\&.
294     .IP "\fBinheritPixmap:\fP \fIboolean\fP"
295     \fBTrue\fP: make the background inherit the parent windows\&' pixmap,
296     giving artificial transparency\&.
297     \fBFalse\fP: do not inherit the parent windows\&' pixmap\&.
298 root 1.19 .IP "\fBfading:\fP \fInumber\fP"
299     Fade the text by the given percentage when focus is lost\&.
300 root 1.14 .IP "\fBtintColor:\fP \fIcolour\fP"
301 pcg 1.8 Tint the transparent background pixmap with the given colour\&.
302 root 1.21 .IP "\fBshading:\fP \fInumber\fP"
303     Darken (0 \&.\&. 100) or lighten (-1 \&.\&. -100) the transparent background
304     image in addition to tinting it\&.
305 root 1.19 .IP "\fBfading:\fP \fInumber\fP"
306     Scale the tint colour by the given percentage\&.
307 pcg 1.1 .IP "\fBscrollColor:\fP \fIcolour\fP"
308     Use the specified colour for the scrollbar [default #B2B2B2]\&.
309     .IP "\fBtroughColor:\fP \fIcolour\fP"
310     Use the specified colour for the scrollbar\&'s trough area [default
311     #969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&.
312     .IP "\fBbackgroundPixmap:\fP \fIfile[;geom]\fP"
313     Use the specified XPM file (note the `\&.xpm\&' extension is optional)
314     for the background and also optionally specify its scaling with a
315     geometry string \fBWxH+X+Y\fP, in which \fB"W" / "H"\fP specify the
316     horizontal/vertical scale (percent) and \fB"X" / "Y"\fP locate the
317     image centre (percent)\&. A scale of 0 displays the image with tiling\&.
318     A scale of 1 displays the image without any scaling\&. A scale of 2 to
319     9 specifies an integer number of images in that direction\&. No image
320     will be magnified beyond 10 times its original size\&. The maximum
321     permitted scale is 1000\&. [default 0x0+50+50]
322     .IP "\fBmenu:\fP \fIfile[;tag]\fP"
323     Read in the specified menu file (note the `\&.menu\&' extension is
324     optional) and also optionally specify a starting tag to find\&. See
325     the reference documentation for details on the syntax for the menuBar\&.
326     .IP "\fBpath:\fP \fIpath\fP"
327     Specify the colon-delimited search path for finding files (XPM and
328     menus), in addition to the paths specified by the \fBRXVTPATH\fP and
329     \fBPATH\fP environment variables\&.
330     .IP "\fBfont:\fP \fIfontname\fP"
331 root 1.13 Select the fonts to be used\&.
332     This is a comma seperated list of font names that are used in turn when
333     trying to display Unicode characters\&.
334     The first font defines the cell size for characters; other fonts might
335     be smaller, but not larger\&.
336     A reasonable default font list is always appended to it\&.
337 pcg 1.1 option \fB-fn\fP\&.
338 root 1.13 .IP "\fBrealBold:\fP \fIboolean\fP"
339     \fBTrue\fP: Enable "real bold" support\&.
340     When this option is on, bold text will be displayed using the first
341     available bold font in the font list\&.
342     Bold fonts should thus be specified in the font list after their
343     corresponding regular fonts\&.
344     If no bold font can be found, a regular font will be used\&.
345     option \fB-rb\fP\&.
346     \fBFalse\fP: Display bold text in a regular font, using the color
347     specified with \fBcolorBD\fP;
348     option \fB+rb\fP\&.
349 pcg 1.1 .IP "\fBselectstyle:\fP \fImode\fP"
350     Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which
351     is xterm style with 2\&.20 old word selection, or anything else which
352     gives xterm style selection\&.
353     .IP "\fBscrollstyle:\fP \fImode\fP"
354 root 1.14 Set scrollbar style to \fBrxvt\fP, \fBrxvt\fP, \fBplain\fP, \fBnext\fP or \fBxterm\fP
355 pcg 1.1 .IP "\fBtitle:\fP \fIstring\fP"
356     Set window title string, the default title is the command-line
357     specified after the \fB-e\fP option, if any, otherwise the application
358     name;
359     option \fB-title\fP\&.
360     .IP "\fBiconName:\fP \fIstring\fP"
361     Set the name used to label the window\&'s icon or displayed in an icon
362     manager window, it also sets the window\&'s title unless it is
363     explicitly set;
364     option \fB-n\fP\&.
365     .IP "\fBmapAlert:\fP \fIboolean\fP"
366     \fBTrue\fP: de-iconify (map) on receipt of a bell character\&.
367     \fBFalse\fP: no de-iconify (map) on receipt of a bell character
368     [default]\&.
369     .IP "\fBvisualBell:\fP \fIboolean\fP"
370     \fBTrue\fP: use visual bell on receipt of a bell character;
371     option \fB-vb\fP\&.
372     \fBFalse\fP: no visual bell [default];
373     option \fB+vb\fP\&.
374     .IP "\fBloginShell:\fP \fIboolean\fP"
375     \fBTrue\fP: start as a login shell by prepending a `-\&' to \fBargv[0]\fP
376     of the shell;
377     option \fB-ls\fP\&.
378     \fBFalse\fP: start as a normal sub-shell [default];
379     option \fB+ls\fP\&.
380     .IP "\fButmpInhibit:\fP \fIboolean\fP"
381     \fBTrue\fP: inhibit writing record into the system log file \fButmp\fP;
382     option \fB-ut\fP\&.
383     \fBFalse\fP: write record into the system log file \fButmp\fP [default];
384     option \fB+ut\fP\&.
385     .IP "\fBprint-pipe:\fP \fIstring\fP"
386     Specify a command pipe for vt100 printer [default \fIlpr(1)\fP]\&. Use
387     \fBPrint\fP to initiate a screen dump to the printer and \fBCtrl-Print\fP
388     or \fBShift-Print\fP to include the scrollback as well\&.
389     .IP "\fBscrollBar:\fP \fIboolean\fP"
390     \fBTrue\fP: enable the scrollbar [default];
391     option \fB-sb\fP\&.
392     \fBFalse\fP: disable the scrollbar;
393     option \fB+sb\fP\&.
394     .IP "\fBscrollBar_right:\fP \fIboolean\fP"
395     \fBTrue\fP: place the scrollbar on the right of the window;
396     option \fB-sr\fP\&.
397     \fBFalse\fP: place the scrollbar on the left of the window;
398     option \fB+sr\fP\&.
399     .IP "\fBscrollBar_floating:\fP \fIboolean\fP"
400     \fBTrue\fP: display an rxvt scrollbar without a trough;
401     option \fB-st\fP\&.
402     \fBFalse\fP: display an rxvt scrollbar with a trough;
403     option \fB+st\fP\&.
404     .IP "\fBscrollBar_align:\fP \fImode\fP"
405     Align the \fBtop\fP, \fBbottom\fP or \fBcentre\fP [default] of
406     the scrollbar thumb with the pointer on middle button
407     press/drag\&.
408     .IP "\fBscrollTtyOutput:\fP \fIboolean\fP"
409     \fBTrue\fP: scroll to bottom when tty receives output;
410     option(+si)\&.
411     \fBFalse\fP: do not scroll to bottom when tty receives output;
412     option(-si)\&.
413     .IP "\fBscrollWithBuffer:\fP \fIboolean\fP"
414     \fBTrue\fP: scroll with scrollback buffer when tty recieves
415     new lines (and \fBscrollTtyOutput\fP is False);
416     option(+sw)\&.
417     \fBFalse\fP: do not scroll with scrollback buffer when tty
418     recieves new lines;
419     option(-sw)\&.
420     .IP "\fBscrollTtyKeypress:\fP \fIboolean\fP"
421     \fBTrue\fP: scroll to bottom when a non-special key is pressed\&.
422     Special keys are those which are intercepted by rxvt for special
423     handling and are not passed onto the shell;
424     option(-sk)\&.
425     \fBFalse\fP: do not scroll to bottom when a non-special key is pressed;
426     option(+sk)\&.
427     .IP "\fBsmallfont_key:\fP \fIkeysym\fP"
428     If enabled, use \fBAlt-\fP\fIkeysym\fP to toggle to a smaller font
429     [default \fBAlt-<\fP]
430     .IP "\fBbigfont_key:\fP \fIkeysym\fP"
431     If enabled, use \fBAlt-\fP\fIkeysym\fP to toggle to a bigger font
432     [default \fBAlt->\fP]
433     .IP "\fBsaveLines:\fP \fInumber\fP"
434     Save \fInumber\fP lines in the scrollback buffer [default 64]\&. This
435     resource is limited on most machines to 65535;
436     option \fB-sl\fP\&.
437     .IP "\fBinternalBorder:\fP \fInumber\fP"
438     Internal border of \fInumber\fP pixels\&. This resource is limited to 100;
439     option \fB-b\fP\&.
440     .IP "\fBexternalBorder:\fP \fInumber\fP"
441     External border of \fInumber\fP pixels\&. This resource is limited to 100;
442     option \fB-w\fP, \fB-bw\fP, \fB-borderwidth\fP\&.
443     .IP "\fBtermName:\fP \fItermname\fP"
444     Specifies the terminal type name to be set in the \fBTERM\fP
445     environment variable;
446     option \fB-tn\fP\&.
447     .IP "\fBlinespace:\fP \fInumber\fP"
448     Specifies number of lines (pixel height) to insert between each row
449     of the display [default 0];
450     option \fB-lsp\fP\&.
451     .IP "\fBmeta8:\fP \fIboolean\fP"
452     \fBTrue\fP: handle Meta (Alt) + keypress to set the 8th bit\&.
453     \fBFalse\fP: handle Meta (Alt) + keypress as an escape prefix [default]\&.
454     .IP "\fBmouseWheelScrollPage:\fP \fIboolean\fP"
455     \fBTrue\fP: the mouse wheel scrolls a page full\&.
456     \fBFalse\fP: the mouse wheel scrolls five lines [default]\&.
457     .IP "\fBcursorBlink:\fP \fIboolean\fP"
458     \fBTrue\fP: blink the cursor\&.
459     \fBFalse\fP: do not blink the cursor [default];
460     option \fB-bc\fP\&.
461     .IP "\fBpointerBlank:\fP \fIboolean\fP"
462     \fBTrue\fP: blank the pointer when a key is pressed or after a set number
463     of seconds of inactivity\&.
464     \fBFalse\fP: the pointer is always visible [default]\&.
465 root 1.12 .IP "\fBpointerColor:\fP \fIcolour\fP"
466     Mouse pointer foreground colour\&.
467     .IP "\fBpointerColor2:\fP \fIcolour\fP"
468     Mouse pointer background colour\&.
469 pcg 1.1 .IP "\fBpointerBlankDelay:\fP \fInumber\fP"
470     Specifies number of seconds before blanking the pointer [default 2]\&.
471     .IP "\fBbackspacekey:\fP \fIstring\fP"
472     The string to send when the backspace key is pressed\&. If set to
473     \fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted,
474     \fBBackspace\fP (code 8) - which can be reversed with the appropriate
475     DEC private mode escape sequence\&.
476     .IP "\fBdeletekey:\fP \fIstring\fP"
477     The string to send when the delete key (not the keypad delete key) is
478     pressed\&. If unset it will send the sequence traditionally associated
479     with the \fBExecute\fP key\&.
480     .IP "\fBcutchars:\fP \fIstring\fP"
481     The characters used as delimiters for double-click word selection\&.
482     The built-in default:
483     .br
484     \fBBACKSLASH `"\&'&()*,;<=>?@[]{|}\fP
485     .IP "\fBpreeditType:\fP \fIstyle\fP"
486     \fBOverTheSpot\fP, \fBOffTheSpot\fP, \fBRoot\fP;
487     option \fB-pt\fP\&.
488     .IP "\fBinputMethod:\fP \fIname\fP"
489     \fIname\fP of inputMethod to use;
490     option \fB-im\fP\&.
491 pcg 1.2 .IP "\fBimLocale:\fP \fIname\fP"
492     The locale to use for opening the IM\&. You can use an LC_CTYPE
493     of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP
494     for the input extension to be able to input japanese characters
495     while staying in another locale\&.
496     option \fB-imlocale\fP\&.
497 pcg 1.7 .IP "\fBinsecure\fP"
498     Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences
499     that echo arbitrary strings like the icon name or the locale\&. This
500 pcg 1.9 could be abused if somebody gets 8-bit-clean access to your
501     display, wether throuh a mail client displaying mail bodies
502     unfiltered or though write(1)\&. Therefore, these sequences are
503     disabled by default\&. (Note that other terminals, including xterm,
504     have these sequences enabled by default)\&. You can enable them
505     by setting this boolean resource or specifying \fB-insecure\fP as
506     an option\&. At the moment, this enabled display-answer, locale,
507     findfont, icon label and window title requests as well as dynamic
508     menubar dispatch\&.
509 pcg 1.1 .IP "\fBmodifier:\fP \fImodifier\fP"
510     Set the key to be interpreted as the Meta key to:
511     \fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP,
512     \fBmod4\fP, \fBmod5\fP;
513     option \fB-mod\fP\&.
514     .IP "\fBanswerbackString:\fP \fIstring\fP"
515     Specify the reply rxvt sends to the shell when an ENQ (control-E)
516     character is passed through\&. It may contain escape values as
517     described in the entry on \fBkeysym\fP following\&.
518 pcg 1.9 .IP "\fBsecondaryScreen:\fP \fIbool\fP"
519     Turn on/off secondary screen (default enabled)\&.
520     .IP "\fBsecondaryScroll:\fP \fIbool\fP"
521     Turn on/off secondary screen scroll (default enabled)\&. If
522     the this option is enabled, scrolls on the secondary screen will
523     change the scrollback buffer and switching to/from the secondary screen
524     will instead scroll the screen up\&.
525 pcg 1.1 .IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP"
526     Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It
527     may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape,
528     \en: newline, \er: return, \et: tab, \e000: octal number) or control
529     characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with
530     double quotes so that it can start or end with whitespace\&. The
531     intervening resource name \fBkeysym\&.\fP cannot be omitted\&. This
532     resource is only available when compiled with KEYSYM_RESOURCE\&.
533     .SH "THE SCROLLBAR"
534     .PP
535 root 1.14 Lines of text that scroll off the top of the \fBrxvt\fP window (resource:
536 pcg 1.1 \fBsaveLines\fP) and can be scrolled back using the scrollbar or by keystrokes\&.
537 root 1.14 The normal \fBrxvt\fP scrollbar has arrows and its behaviour is fairly
538 pcg 1.1 intuitive\&. The \fBxterm-scrollbar\fP is without arrows and its behaviour
539     mimics that of \fIxterm\fP
540     .PP
541     Scroll down with \fBButton1\fP (\fBxterm-scrollbar\fP) or \fBShift-Next\fP\&.
542     Scroll up with \fBButton3\fP (\fBxterm-scrollbar\fP) or \fBShift-Prior\fP\&.
543     Continuous scroll with \fBButton2\fP\&.
544     .SH "MOUSE REPORTING"
545     .PP
546     To temporarily override mouse reporting, for either the scrollbar or the
547     normal text selection/insertion, hold either the Shift or the Meta (Alt) key
548     while performing the desired mouse action\&.
549     .PP
550     If mouse reporting mode is active, the normal scrollbar actions are disabled
551     -- on the assumption that we are using a fullscreen application\&.
552     Instead, pressing Button1 and Button3 sends
553     \fBESC[6~\fP (Next) and \fBESC[5~\fP (Prior), respectively\&.
554     Similarly, clicking on the up and down arrows sends \fBESC[A\fP (Up) and
555     \fBESC[B\fP (Down), respectively\&.
556     .SH "TEXT SELECTION AND INSERTION"
557     .PP
558     The behaviour of text selection and insertion mechanism is similar to
559     \fIxterm\fP(1)\&.
560     .PP
561     .IP "\fBSelection\fP:"
562     Left click at the beginning of the region, drag to the end of the
563     region and release; Right click to extend the marked region;
564     Left double-click to select a word; Left triple-click to select
565     the entire line\&.
566     .IP "\fBInsertion\fP:"
567     Pressing and releasing the Middle mouse button (or \fBShift-Insert\fP)
568 root 1.14 in an \fBrxvt\fP window causes the current text selection to be inserted
569 pcg 1.1 as if it had been typed on the keyboard\&.
570     .SH "CHANGING FONTS"
571     .PP
572     You can change fonts on-the-fly, which is to say cycle through the default
573     font and others of various sizes, by using \fBShift-KP_Add\fP and
574     \fBShift-KP_Subtract\fP\&. Or, alternatively (if enabled) with
575     \fBAlt->\fP and \fBAlt-<\fP, where the actual key
576     can be selected using resources \fBsmallfont_key\fP/\fBbigfont_key\fP\&.
577     .SH "LOGIN STAMP"
578     .PP
579 root 1.14 \fBrxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be
580 pcg 1.1 seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this
581 root 1.14 feature, \fBrxvt\fP must be installed setuid root on some systems\&.
582 pcg 1.1 .SH "COLORS AND GRAPHICS"
583     .PP
584 root 1.14 In addition to the default foreground and background colours, \fBrxvt\fP
585 pcg 1.1 can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
586     versions of the same)\&.
587     Here is a list of the colours with their \fBrgb\&.txt\fP names\&.
588     .PP
589     .TS
590     .nr 3c \n(.C
591     .cp 0
592     .nr 3lps \n[.s]
593     .nr 3cent \n[.ce]
594     .de 3init
595     .ft \n[.f]
596     .ps \n[.s]
597     .vs \n[.v]u
598     .in \n[.i]u
599     .ll \n[.l]u
600     .ls \n[.L]
601     .ad \n[.j]
602     .ie \n[.u] .fi
603     .el .nf
604     .ce \n[.ce]
605     ..
606     .nr 3ind \n[.i]
607     .nr 3fnt \n[.f]
608     .nr 3sz \n[.s]
609     .nr 3fll \n[.u]
610     .nr T. 0
611     .nr 3crow 0-1
612     .nr 3passed 0-1
613     .nr 3sflag 0
614     .ds 3trans
615     .ds 3quote
616     .nr 3brule 1
617     .nr 3supbot 0
618     .eo
619     .de 3rmk
620     .mk \$1
621     .if !'\n(.z'' \!.3rmk "\$1"
622     ..
623     .de 3rvpt
624     .vpt \$1
625     .if !'\n(.z'' \!.3rvpt "\$1"
626     ..
627     .de 3keep
628     .if '\n[.z]'' \{.ds 3quote \\
629     .ds 3trans \!
630     .di 3section
631     .nr 3sflag 1
632     .in 0
633     .\}
634     ..
635     .de 3release
636     .if \n[3sflag] \{.di
637     .in \n[3ind]u
638     .nr 3dn \n[dn]
639     .ds 3quote
640     .ds 3trans
641     .nr 3sflag 0
642     .if \n[.t]<=\n[dn] \{.nr T. 1
643     .T#
644     .nr 3supbot 1
645     .sp \n[.t]u
646     .nr 3supbot 0
647     .mk #T
648     .\}
649     .if \n[.t]<=\n[3dn] .tm warning: page \n%: table text block will not fit on one page
650     .nf
651     .ls 1
652     .3section
653     .ls
654     .rm 3section
655     .\}
656     ..
657     .nr 3tflag 0
658     .de 3tkeep
659     .if '\n[.z]'' \{.di 3table
660     .nr 3tflag 1
661     .\}
662     ..
663     .de 3trelease
664     .if \n[3tflag] \{.br
665     .di
666     .nr 3dn \n[dn]
667     .ne \n[dn]u+\n[.V]u
668     .ie \n[.t]<=\n[3dn] .tm error: page \n%: table will not fit on one page; use .TS H/.TH with a supporting macro package
669     .el \{.in 0
670     .ls 1
671     .nf
672     .3table
673     .\}
674     .rm 3table
675     .\}
676     ..
677     .ec
678     .ce 0
679     .nf
680     .nr 3sep 1n
681     .nr 3w0 \n(.H
682     .nr 3aw0 0
683     .nr 3lnw0 0
684     .nr 3rnw0 0
685     .nr 3w1 \n(.H
686     .nr 3aw1 0
687     .nr 3lnw1 0
688     .nr 3rnw1 0
689     .nr 3w2 \n(.H
690     .nr 3aw2 0
691     .nr 3lnw2 0
692     .nr 3rnw2 0
693     .nr 3w0 \n[3w0]>?\w\[tbl]\fBcolor0\fP \[tbl]
694     .nr 3w1 \n[3w1]>?\w\[tbl]\ (black) \[tbl]
695     .nr 3w2 \n[3w2]>?\w\[tbl]\ = Black \[tbl]
696     .nr 3w0 \n[3w0]>?\w\[tbl]\fBcolor1\fP \[tbl]
697     .nr 3w1 \n[3w1]>?\w\[tbl]\ (red) \[tbl]
698     .nr 3w2 \n[3w2]>?\w\[tbl]\ = Red3 \[tbl]
699     .nr 3w0 \n[3w0]>?\w\[tbl]\fBcolor2\fP \[tbl]
700     .nr 3w1 \n[3w1]>?\w\[tbl]\ (green) \[tbl]
701     .nr 3w2 \n[3w2]>?\w\[tbl]\ = Green3 \[tbl]
702     .nr 3w0 \n[3w0]>?\w\[tbl]\fBcolor3\fP \[tbl]
703     .nr 3w1 \n[3w1]>?\w\[tbl]\ (yellow) \[tbl]
704     .nr 3w2 \n[3w2]>?\w\[tbl]\ = Yellow3 \[tbl]
705     .nr 3w0 \n[3w0]>?\w\[tbl]\fBcolor4\fP \[tbl]
706     .nr 3w1 \n[3w1]>?\w\[tbl]\ (blue) \[tbl]
707     .nr 3w2 \n[3w2]>?\w\[tbl]\ = Blue3 \[tbl]
708     .nr 3w0 \n[3w0]>?\w\[tbl]\fBcolor5\fP \[tbl]
709     .nr 3w1 \n[3w1]>?\w\[tbl]\ (magenta) \[tbl]
710     .nr 3w2 \n[3w2]>?\w\[tbl]\ = Magenta3 \[tbl]
711     .nr 3w0 \n[3w0]>?\w\[tbl]\fBcolor6\fP \[tbl]
712     .nr 3w1 \n[3w1]>?\w\[tbl]\ (cyan) \[tbl]
713     .nr 3w2 \n[3w2]>?\w\[tbl]\ = Cyan3 \[tbl]
714     .nr 3w0 \n[3w0]>?\w\[tbl]\fBcolor7\fP \[tbl]
715     .nr 3w1 \n[3w1]>?\w\[tbl]\ (white) \[tbl]
716     .nr 3w2 \n[3w2]>?\w\[tbl]\ = AntiqueWhite \[tbl]
717     .nr 3w0 \n[3w0]>?\w\[tbl]\fBcolor8\fP \[tbl]
718     .nr 3w1 \n[3w1]>?\w\[tbl]\ (bright black) \[tbl]
719     .nr 3w2 \n[3w2]>?\w\[tbl]\ = Grey25 \[tbl]
720     .nr 3w0 \n[3w0]>?\w\[tbl]\fBcolor9\fP \[tbl]
721     .nr 3w1 \n[3w1]>?\w\[tbl]\ (bright red) \[tbl]
722     .nr 3w2 \n[3w2]>?\w\[tbl]\ = Red \[tbl]
723     .nr 3w0 \n[3w0]>?\w\[tbl]\fBcolor10\fP \[tbl]
724     .nr 3w1 \n[3w1]>?\w\[tbl]\ (bright green) \[tbl]
725     .nr 3w2 \n[3w2]>?\w\[tbl]\ = Green \[tbl]
726     .nr 3w0 \n[3w0]>?\w\[tbl]\fBcolor11\fP \[tbl]
727     .nr 3w1 \n[3w1]>?\w\[tbl]\ (bright yellow) \[tbl]
728     .nr 3w2 \n[3w2]>?\w\[tbl]\ = Yellow \[tbl]
729     .nr 3w0 \n[3w0]>?\w\[tbl]\fBcolor12\fP \[tbl]
730     .nr 3w1 \n[3w1]>?\w\[tbl]\ (bright blue) \[tbl]
731     .nr 3w2 \n[3w2]>?\w\[tbl]\ = Blue \[tbl]
732     .nr 3w0 \n[3w0]>?\w\[tbl]\fBcolor13\fP \[tbl]
733     .nr 3w1 \n[3w1]>?\w\[tbl]\ (bright magenta) \[tbl]
734     .nr 3w2 \n[3w2]>?\w\[tbl]\ = Magenta \[tbl]
735     .nr 3w0 \n[3w0]>?\w\[tbl]\fBcolor14\fP \[tbl]
736     .nr 3w1 \n[3w1]>?\w\[tbl]\ (bright cyan) \[tbl]
737     .nr 3w2 \n[3w2]>?\w\[tbl]\ = Cyan \[tbl]
738     .nr 3w0 \n[3w0]>?\w\[tbl]\fBcolor15\fP \[tbl]
739     .nr 3w1 \n[3w1]>?\w\[tbl]\ (bright white) \[tbl]
740     .nr 3w2 \n[3w2]>?\w\[tbl]\ = White \[tbl]
741     .nr 3w0 \n[3w0]>?\w\[tbl]\fBforeground\fP \[tbl]
742     .nr 3w1 \n[3w1]>?\w\[tbl]\ \[tbl]
743     .nr 3w2 \n[3w2]>?\w\[tbl]\ = Black \[tbl]
744     .nr 3w0 \n[3w0]>?\w\[tbl]\fBbackground\fP \[tbl]
745     .nr 3w1 \n[3w1]>?\w\[tbl]\ \[tbl]
746     .nr 3w2 \n[3w2]>?\w\[tbl]\ = White \[tbl]
747     .nr 3w0 \n[3w0]>?(\n[3lnw0]+\n[3rnw0])
748     .if \n[3aw0] .nr 3w0 \n[3w0]>?(\n[3aw0]+2n)
749     .nr 3w1 \n[3w1]>?(\n[3lnw1]+\n[3rnw1])
750     .if \n[3aw1] .nr 3w1 \n[3w1]>?(\n[3aw1]+2n)
751     .nr 3w2 \n[3w2]>?(\n[3lnw2]+\n[3rnw2])
752     .if \n[3aw2] .nr 3w2 \n[3w2]>?(\n[3aw2]+2n)
753     .nr 3cd0 0
754     .nr 3cl0 0*\n[3sep]
755     .nr 3ce0 \n[3cl0]+\n[3w0]
756     .nr 3cl1 \n[3ce0]+(3*\n[3sep])
757     .nr 3cd1 \n[3ce0]+\n[3cl1]/2
758     .nr 3ce1 \n[3cl1]+\n[3w1]
759     .nr 3cl2 \n[3ce1]+(3*\n[3sep])
760     .nr 3cd2 \n[3ce1]+\n[3cl2]/2
761     .nr 3ce2 \n[3cl2]+\n[3w2]
762     .nr 3cd3 \n[3ce2]+(0*\n[3sep])
763     .nr TW \n[3cd3]
764     .if \n[3cent] \{.in +(u;\n[.l]-\n[.i]-\n[TW]/2>?-\n[.i])
765     .nr 3ind \n[.i]
766     .\}
767     .eo
768     .de T#
769     .if !\n[3supbot] \{.3rvpt 0
770     .mk 3vert
771     .ls 1
772     .ls
773     .nr 3passed \n[3crow]
774     .sp |\n[3vert]u
775     .3rvpt 1
776     .\}
777     ..
778     .ec
779     .fc 
780     .3keep
781     .3rmk 3rt0
782     \*[3trans].nr 3crow 0
783     .3keep
784     .mk 3rs0
785     .mk 3bot
786     .3rvpt 0
787     .ta \n[3ce0]u \n[3ce1]u \n[3ce2]u
788     \&\h'|\n[3cl0]u'\fBcolor0\fP \h'|\n[3cl1]u'\ (black) \h'|\n[3cl2]u'\ = Black
789     .nr 3bot \n[3bot]>?\n[.d]
790     .sp |\n[3rs0]u
791     .3rvpt 1
792     .sp |\n[3bot]u
793     \*[3trans].nr 3brule 1
794     .3release
795     .3keep
796     .3rmk 3rt1
797     \*[3trans].nr 3crow 1
798     .3keep
799     .mk 3rs1
800     .mk 3bot
801     .3rvpt 0
802     .ta \n[3ce0]u \n[3ce1]u \n[3ce2]u
803     \&\h'|\n[3cl0]u'\fBcolor1\fP \h'|\n[3cl1]u'\ (red) \h'|\n[3cl2]u'\ = Red3
804     .nr 3bot \n[3bot]>?\n[.d]
805     .sp |\n[3rs1]u
806     .3rvpt 1
807     .sp |\n[3bot]u
808     \*[3trans].nr 3brule 1
809     .3release
810     .3keep
811     .3rmk 3rt2
812     \*[3trans].nr 3crow 2
813     .3keep
814     .mk 3rs2
815     .mk 3bot
816     .3rvpt 0
817     .ta \n[3ce0]u \n[3ce1]u \n[3ce2]u
818     \&\h'|\n[3cl0]u'\fBcolor2\fP \h'|\n[3cl1]u'\ (green) \h'|\n[3cl2]u'\ = Green3
819     .nr 3bot \n[3bot]>?\n[.d]
820     .sp |\n[3rs2]u
821     .3rvpt 1
822     .sp |\n[3bot]u
823     \*[3trans].nr 3brule 1
824     .3release
825     .3keep
826     .3rmk 3rt3
827     \*[3trans].nr 3crow 3
828     .3keep
829     .mk 3rs3
830     .mk 3bot
831     .3rvpt 0
832     .ta \n[3ce0]u \n[3ce1]u \n[3ce2]u
833     \&\h'|\n[3cl0]u'\fBcolor3\fP \h'|\n[3cl1]u'\ (yellow) \h'|\n[3cl2]u'\ = Yellow3
834     .nr 3bot \n[3bot]>?\n[.d]
835     .sp |\n[3rs3]u
836     .3rvpt 1
837     .sp |\n[3bot]u
838     \*[3trans].nr 3brule 1
839     .3release
840     .3keep
841     .3rmk 3rt4
842     \*[3trans].nr 3crow 4
843     .3keep
844     .mk 3rs4
845     .mk 3bot
846     .3rvpt 0
847     .ta \n[3ce0]u \n[3ce1]u \n[3ce2]u
848     \&\h'|\n[3cl0]u'\fBcolor4\fP \h'|\n[3cl1]u'\ (blue) \h'|\n[3cl2]u'\ = Blue3
849     .nr 3bot \n[3bot]>?\n[.d]
850     .sp |\n[3rs4]u
851     .3rvpt 1
852     .sp |\n[3bot]u
853     \*[3trans].nr 3brule 1
854     .3release
855     .3keep
856     .3rmk 3rt5
857     \*[3trans].nr 3crow 5
858     .3keep
859     .mk 3rs5
860     .mk 3bot
861     .3rvpt 0
862     .ta \n[3ce0]u \n[3ce1]u \n[3ce2]u
863     \&\h'|\n[3cl0]u'\fBcolor5\fP \h'|\n[3cl1]u'\ (magenta) \h'|\n[3cl2]u'\ = Magenta3
864     .nr 3bot \n[3bot]>?\n[.d]
865     .sp |\n[3rs5]u
866     .3rvpt 1
867     .sp |\n[3bot]u
868     \*[3trans].nr 3brule 1
869     .3release
870     .3keep
871     .3rmk 3rt6
872     \*[3trans].nr 3crow 6
873     .3keep
874     .mk 3rs6
875     .mk 3bot
876     .3rvpt 0
877     .ta \n[3ce0]u \n[3ce1]u \n[3ce2]u
878     \&\h'|\n[3cl0]u'\fBcolor6\fP \h'|\n[3cl1]u'\ (cyan) \h'|\n[3cl2]u'\ = Cyan3
879     .nr 3bot \n[3bot]>?\n[.d]
880     .sp |\n[3rs6]u
881     .3rvpt 1
882     .sp |\n[3bot]u
883     \*[3trans].nr 3brule 1
884     .3release
885     .3keep
886     .3rmk 3rt7
887     \*[3trans].nr 3crow 7
888     .3keep
889     .mk 3rs7
890     .mk 3bot
891     .3rvpt 0
892     .ta \n[3ce0]u \n[3ce1]u \n[3ce2]u
893     \&\h'|\n[3cl0]u'\fBcolor7\fP \h'|\n[3cl1]u'\ (white) \h'|\n[3cl2]u'\ = AntiqueWhite
894     .nr 3bot \n[3bot]>?\n[.d]
895     .sp |\n[3rs7]u
896     .3rvpt 1
897     .sp |\n[3bot]u
898     \*[3trans].nr 3brule 1
899     .3release
900     .3keep
901     .3rmk 3rt8
902     \*[3trans].nr 3crow 8
903     .3keep
904     .mk 3rs8
905     .mk 3bot
906     .3rvpt 0
907     .ta \n[3ce0]u \n[3ce1]u \n[3ce2]u
908     \&\h'|\n[3cl0]u'\fBcolor8\fP \h'|\n[3cl1]u'\ (bright black) \h'|\n[3cl2]u'\ = Grey25
909     .nr 3bot \n[3bot]>?\n[.d]
910     .sp |\n[3rs8]u
911     .3rvpt 1
912     .sp |\n[3bot]u
913     \*[3trans].nr 3brule 1
914     .3release
915     .3keep
916     .3rmk 3rt9
917     \*[3trans].nr 3crow 9
918     .3keep
919     .mk 3rs9
920     .mk 3bot
921     .3rvpt 0
922     .ta \n[3ce0]u \n[3ce1]u \n[3ce2]u
923     \&\h'|\n[3cl0]u'\fBcolor9\fP \h'|\n[3cl1]u'\ (bright red) \h'|\n[3cl2]u'\ = Red
924     .nr 3bot \n[3bot]>?\n[.d]
925     .sp |\n[3rs9]u
926     .3rvpt 1
927     .sp |\n[3bot]u
928     \*[3trans].nr 3brule 1
929     .3release
930     .3keep
931     .3rmk 3rt10
932     \*[3trans].nr 3crow 10
933     .3keep
934     .mk 3rs10
935     .mk 3bot
936     .3rvpt 0
937     .ta \n[3ce0]u \n[3ce1]u \n[3ce2]u
938     \&\h'|\n[3cl0]u'\fBcolor10\fP \h'|\n[3cl1]u'\ (bright green) \h'|\n[3cl2]u'\ = Green
939     .nr 3bot \n[3bot]>?\n[.d]
940     .sp |\n[3rs10]u
941     .3rvpt 1
942     .sp |\n[3bot]u
943     \*[3trans].nr 3brule 1
944     .3release
945     .3keep
946     .3rmk 3rt11
947     \*[3trans].nr 3crow 11
948     .3keep
949     .mk 3rs11
950     .mk 3bot
951     .3rvpt 0
952     .ta \n[3ce0]u \n[3ce1]u \n[3ce2]u
953     \&\h'|\n[3cl0]u'\fBcolor11\fP \h'|\n[3cl1]u'\ (bright yellow) \h'|\n[3cl2]u'\ = Yellow
954     .nr 3bot \n[3bot]>?\n[.d]
955     .sp |\n[3rs11]u
956     .3rvpt 1
957     .sp |\n[3bot]u
958     \*[3trans].nr 3brule 1
959     .3release
960     .3keep
961     .3rmk 3rt12
962     \*[3trans].nr 3crow 12
963     .3keep
964     .mk 3rs12
965     .mk 3bot
966     .3rvpt 0
967     .ta \n[3ce0]u \n[3ce1]u \n[3ce2]u
968     \&\h'|\n[3cl0]u'\fBcolor12\fP \h'|\n[3cl1]u'\ (bright blue) \h'|\n[3cl2]u'\ = Blue
969     .nr 3bot \n[3bot]>?\n[.d]
970     .sp |\n[3rs12]u
971     .3rvpt 1
972     .sp |\n[3bot]u
973     \*[3trans].nr 3brule 1
974     .3release
975     .3keep
976     .3rmk 3rt13
977     \*[3trans].nr 3crow 13
978     .3keep
979     .mk 3rs13
980     .mk 3bot
981     .3rvpt 0
982     .ta \n[3ce0]u \n[3ce1]u \n[3ce2]u
983     \&\h'|\n[3cl0]u'\fBcolor13\fP \h'|\n[3cl1]u'\ (bright magenta) \h'|\n[3cl2]u'\ = Magenta
984     .nr 3bot \n[3bot]>?\n[.d]
985     .sp |\n[3rs13]u
986     .3rvpt 1
987     .sp |\n[3bot]u
988     \*[3trans].nr 3brule 1
989     .3release
990     .3keep
991     .3rmk 3rt14
992     \*[3trans].nr 3crow 14
993     .3keep
994     .mk 3rs14
995     .mk 3bot
996     .3rvpt 0
997     .ta \n[3ce0]u \n[3ce1]u \n[3ce2]u
998     \&\h'|\n[3cl0]u'\fBcolor14\fP \h'|\n[3cl1]u'\ (bright cyan) \h'|\n[3cl2]u'\ = Cyan
999     .nr 3bot \n[3bot]>?\n[.d]
1000     .sp |\n[3rs14]u
1001     .3rvpt 1
1002     .sp |\n[3bot]u
1003     \*[3trans].nr 3brule 1
1004     .3release
1005     .3keep
1006     .3rmk 3rt15
1007     \*[3trans].nr 3crow 15
1008     .3keep
1009     .mk 3rs15
1010     .mk 3bot
1011     .3rvpt 0
1012     .ta \n[3ce0]u \n[3ce1]u \n[3ce2]u
1013     \&\h'|\n[3cl0]u'\fBcolor15\fP \h'|\n[3cl1]u'\ (bright white) \h'|\n[3cl2]u'\ = White
1014     .nr 3bot \n[3bot]>?\n[.d]
1015     .sp |\n[3rs15]u
1016     .3rvpt 1
1017     .sp |\n[3bot]u
1018     \*[3trans].nr 3brule 1
1019     .3release
1020     .3keep
1021     .3rmk 3rt16
1022     \*[3trans].nr 3crow 16
1023     .3keep
1024     .mk 3rs16
1025     .mk 3bot
1026     .3rvpt 0
1027     .ta \n[3ce0]u \n[3ce1]u \n[3ce2]u
1028     \&\h'|\n[3cl0]u'\fBforeground\fP \h'|\n[3cl1]u'\ \h'|\n[3cl2]u'\ = Black
1029     .nr 3bot \n[3bot]>?\n[.d]
1030     .sp |\n[3rs16]u
1031     .3rvpt 1
1032     .sp |\n[3bot]u
1033     \*[3trans].nr 3brule 1
1034     .3release
1035     .3keep
1036     .3rmk 3rt17
1037     \*[3trans].nr 3crow 17
1038     .3keep
1039     .mk 3rs17
1040     .mk 3bot
1041     .3rvpt 0
1042     .ta \n[3ce0]u \n[3ce1]u \n[3ce2]u
1043     \&\h'|\n[3cl0]u'\fBbackground\fP \h'|\n[3cl1]u'\ \h'|\n[3cl2]u'\ = White
1044     .nr 3bot \n[3bot]>?\n[.d]
1045     .sp |\n[3rs17]u
1046     .3rvpt 1
1047     .sp |\n[3bot]u
1048     \*[3trans].nr 3brule 1
1049     .3release
1050     .mk 3rt18
1051     .nr 3brule 1
1052     .nr T. 1
1053     .T#
1054     .3init
1055     .fc
1056     .cp \n(3c
1057     .TE
1058     .PP
1059     It is also possible to specify the colour values of \fBforeground\fP,
1060     \fBbackground\fP, \fBcursorColor\fP, \fBcursorColor2\fP, \fBcolorBD\fP, \fBcolorUL\fP
1061     as a number 0-15, as a convenient shorthand to reference the colour name of
1062     color0-color15\&.
1063     .PP
1064     Note that \fB-rv\fP (\fB"reverseVideo: True"\fP) simulates reverse video by
1065     always swapping the foreground/background colours\&. This is in contrast to
1066     \fIxterm\fP(1) where the colours are only swapped if they have not otherwise been
1067     specified\&.
1068     For example,
1069     .PP
1070     .IP "\fBrxvt -fg Black -bg White -rv\fP"
1071     would yield White on Black, while on \fIxterm\fP(1) it would yield
1072     Black on White\&.
1073     .SH "ENVIRONMENT"
1074     .PP
1075 root 1.14 \fBrxvt\fP sets the environment variables \fBTERM\fP, \fBCOLORTERM\fP and
1076 pcg 1.1 \fBCOLORFGBG\fP\&. The environment variable \fBWINDOWID\fP is set to the X window
1077 root 1.14 id number of the \fBrxvt\fP window and it also uses and sets the environment
1078     variable \fBDISPLAY\fP to specify which display terminal to use\&. \fBrxvt\fP uses
1079 pcg 1.1 the environment variables \fBRXVTPATH\fP and \fBPATH\fP to find XPM files\&.
1080     .SH "FILES"
1081     .PP
1082     .IP "\fB/etc/utmp\fP"
1083     System file for login records\&.
1084     .IP "\fB/usr/lib/X11/rgb\&.txt\fP"
1085     Color names\&.
1086     .PP
1087     .SH "SEE ALSO"
1088     .PP
1089     \fIxterm\fP(1), \fIsh\fP(1), \fIresize\fP(1), \fIX\fP(1), \fIpty\fP(4), \fItty\fP(4),
1090     \fIutmp\fP(5)
1091     .PP
1092     See rxvtRef\&.html rxvtRef\&.txt for detailed information on recognized escape
1093     sequences and menuBar syntax, etc\&.
1094     .PP
1095     .SH "BUGS"
1096     .PP
1097     Check the BUGS file for an up-to-date list\&.
1098     .PP
1099     Cursor change support is not yet implemented\&.
1100     .PP
1101     Click-and-drag doesn\&'t work with X11 mouse report overriding\&.
1102     .PP
1103     .SH "FTP LOCATION"
1104     .PP
1105 root 1.21 rxvt-3\&.4\&.tar\&.gz can be found at the following ftp sites
1106 pcg 1.6 ftp://ftp\&.rxvt\&.org/pub/rxvt
1107 pcg 1.1 .PP
1108     .SH "CURRENT PROJECT COORDINATOR"
1109     .PP
1110     .IP "Project Coordinator"
1111 pcg 1.6 Marc A\&. Lehmann <rxvt@schmorp\&.de>
1112 pcg 1.1 .br
1113     .IP "Web page maintainter"
1114 pcg 1.6 Marc A\&. Lehmann <rxvt@schmorp\&.de>
1115 pcg 1.1 .br
1116 pcg 1.6 <http://www\&.sourceforge\&.net/projects/rxvt-unicode/>
1117 pcg 1.1 .br
1118     .PP
1119     .SH "AUTHORS"
1120     .PP
1121     .IP "John Bovey"
1122     University of Kent, 1992, wrote the original Xvt\&.
1123     .IP "Rob Nation <nation@rocket\&.sanders\&.lockheed\&.com>"
1124     very heavily modified Xvt and came up with Rxvt
1125     .IP "Angelo Haritsis <ah@doc\&.ic\&.ac\&.uk>"
1126 pcg 1.3 wrote the Greek Keyboard Input (no longer in code)
1127 pcg 1.1 .IP "mj olesen <olesen@me\&.QueensU\&.CA>"
1128     Wrote the menu system\&.
1129     .br
1130     Project Coordinator (changes\&.txt 2\&.11 to 2\&.21)
1131     .IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>"
1132     Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5)
1133     .IP "Geoff Wing <gcw@pobox\&.com>"
1134 pcg 1.3 Rewrote screen display and text selection routines\&.
1135     Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode)
1136 pcg 1.10 .IP "Marc Alexander Lehmann <rxvt@schmorp\&.de>"
1137 root 1.12 Forked rxvt-unicode, rewrote most of the display code and
1138 pcg 1.10 internal character handling to store text in unicode,
1139 root 1.12 improve xterm compatibility and apply numerous other bugfixes
1140 pcg 1.10 and extensions\&.
1141 pcg 1.1 .br
1142 pcg 1.3 Project Coordinator (Changes 1\&.0 - )
1143     .PP