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