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