ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.man.in
Revision: 1.22
Committed: Fri Apr 22 02:09:39 2005 UTC (19 years, 1 month ago) by root
Branch: MAIN
CVS Tags: rel-5_5
Changes since 1.21: +22 -1 lines
Log Message:
*** empty log message ***

File Contents

# User Rev Content
1 root 1.1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
2     .\"
3     .\" Standard preamble:
4     .\" ========================================================================
5     .de Sh \" Subsection heading
6     .br
7     .if t .Sp
8     .ne 5
9     .PP
10     \fB\\$1\fR
11     .PP
12     ..
13     .de Sp \" Vertical space (when we can't use .PP)
14     .if t .sp .5v
15     .if n .sp
16     ..
17     .de Vb \" Begin verbatim text
18     .ft CW
19     .nf
20     .ne \\$1
21     ..
22     .de Ve \" End verbatim text
23     .ft R
24     .fi
25     ..
26     .\" Set up some character translations and predefined strings. \*(-- will
27     .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28     .\" double quote, and \*(R" will give a right double quote. | will give a
29     .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30     .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31     .\" expand to `' in nroff, nothing in troff, for use with C<>.
32     .tr \(*W-|\(bv\*(Tr
33     .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34     .ie n \{\
35     . ds -- \(*W-
36     . ds PI pi
37     . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38     . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39     . ds L" ""
40     . ds R" ""
41 root 1.12 . ds C` ""
42     . ds C' ""
43 root 1.1 'br\}
44     .el\{\
45     . ds -- \|\(em\|
46     . ds PI \(*p
47     . ds L" ``
48     . ds R" ''
49     'br\}
50     .\"
51     .\" If the F register is turned on, we'll generate index entries on stderr for
52     .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53     .\" entries marked with X<> in POD. Of course, you'll have to process the
54     .\" output yourself in some meaningful fashion.
55     .if \nF \{\
56     . de IX
57     . tm Index:\\$1\t\\n%\t"\\$2"
58     ..
59     . nr % 0
60     . rr F
61     .\}
62     .\"
63     .\" For nroff, turn off justification. Always turn off hyphenation; it makes
64     .\" way too many mistakes in technical documents.
65     .hy 0
66     .if n .na
67     .\"
68     .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69     .\" Fear. Run. Save yourself. No user-serviceable parts.
70     . \" fudge factors for nroff and troff
71     .if n \{\
72     . ds #H 0
73     . ds #V .8m
74     . ds #F .3m
75     . ds #[ \f1
76     . ds #] \fP
77     .\}
78     .if t \{\
79     . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80     . ds #V .6m
81     . ds #F 0
82     . ds #[ \&
83     . ds #] \&
84     .\}
85     . \" simple accents for nroff and troff
86     .if n \{\
87     . ds ' \&
88     . ds ` \&
89     . ds ^ \&
90     . ds , \&
91     . ds ~ ~
92     . ds /
93     .\}
94     .if t \{\
95     . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96     . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97     . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98     . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99     . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100     . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101     .\}
102     . \" troff and (daisy-wheel) nroff accents
103     .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104     .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105     .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106     .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107     .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108     .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109     .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110     .ds ae a\h'-(\w'a'u*4/10)'e
111     .ds Ae A\h'-(\w'A'u*4/10)'E
112     . \" corrections for vroff
113     .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114     .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115     . \" for low resolution devices (crt and lpr)
116     .if \n(.H>23 .if \n(.V>19 \
117     \{\
118     . ds : e
119     . ds 8 ss
120     . ds o a
121     . ds d- d\h'-1'\(ga
122     . ds D- D\h'-1'\(hy
123     . ds th \o'bp'
124     . ds Th \o'LP'
125     . ds ae ae
126     . ds Ae AE
127     .\}
128     .rm #[ #] #H #V #F C
129     .\" ========================================================================
130     .\"
131     .IX Title "rxvt 1"
132 root 1.22 .TH rxvt 1 "2005-04-22" "5.5" "RXVT-UNICODE"
133 root 1.1 .SH "NAME"
134     rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system)
135     .SH "SYNOPSIS"
136     .IX Header "SYNOPSIS"
137     \&\fB@@RXVT_NAME@@\fR [options] [\-e command [ args ]]
138     .SH "DESCRIPTION"
139     .IX Header "DESCRIPTION"
140     \&\fBrxvt-unicode\fR, version \fB@@RXVT_VERSION@@\fR, is a colour vt102 terminal
141     emulator intended as an \fIxterm\fR(1) replacement for users who do not
142     require features such as Tektronix 4014 emulation and toolkit-style
143     configurability. As a result, \fBrxvt-unicode\fR uses much less swap space \*(--
144     a significant advantage on a machine serving many X sessions.
145     .SH "FREQUENTLY ASKED QUESTIONS"
146     .IX Header "FREQUENTLY ASKED QUESTIONS"
147 root 1.12 See @@RXVT_NAME@@(7) (try \f(CW\*(C`man 7 @@RXVT_NAME@@\*(C'\fR) for a list of
148     frequently asked questions and answer to them and some common
149     problems. That document is also accessible on the World-Wide-Web at
150     <http://cvs.schmorp.de/browse/*checkout*/rxvt\-unicode/doc/rxvt.7.html>.
151 root 1.1 .SH "RXVT-UNICODE VS. RXVT"
152     .IX Header "RXVT-UNICODE VS. RXVT"
153     Unlike the original rxvt, \fBrxvt-unicode\fR stores all text in Unicode
154     internally. That means it can store and display most scripts in the
155     world. Being a terminal emulator, however, some things are very difficult,
156     especially cursive scripts such as arabic, vertically written scripts
157     like mongolian or scripts requiring extremely complex combining rules,
158     like tibetan or devenagari. Don't expect pretty output when using these
159     scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
160     fine, though. A somewhat difficult case are left-to-right scripts, such
161     as hebrew: \fBrxvt-unicode\fR adopts the view that bidirectional algorithms
162     belong into the application, not the terminal emulator (too many things \*(--
163     such as cursor-movement while editing \*(-- break otherwise), but that might
164     change.
165     .PP
166     If you are looking for a terminal that supports more exotic scripts, let
167     me recommend \f(CW\*(C`mlterm\*(C'\fR, which is a very userfriendly, lean and clean
168     terminal emulator. In fact, the reason rxvt-unicode was born was solely
169     because the author couldn't get \f(CW\*(C`mlterm\*(C'\fR to use one font for latin1 and
170     another for japanese.
171     .PP
172     Therefore another design rationale was the use of multiple fonts to
173     display characters: The idea of a single unicode font which many other
174     programs force onto it's users never made sense to me: You should be able
175     to choose any font for any script freely.
176     .PP
177     Apart from that, rxvt-unicode is also much better internationalised than
178     it's predecessor, supports things such as \s-1XFT\s0 and \s-1ISO\s0 14755 that are handy
179     in i18n\-environments, is faster, and has a lot less bugs than the original
180     rxvt. This all in addition to dozens of other small improvements.
181     .PP
182     It is still faithfully following the original rxvt idea of being lean
183     and nice on resources: for example, you can still configure rxvt-unicode
184     without most of it's features to get a lean binary. It also comes with
185     a client/daemon pair that lets you open any number of terminal windows
186     from within a single process, which makes startup time very fast and
187     drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
188     @@RXVT_NAME@@c(1) (client).
189     .PP
190     It also makes technical information about escape sequences (which have
191     been extended) easier accessible: see @@RXVT_NAME@@(7) for technical
192     reference documentation (escape sequences etc.).
193     .SH "OPTIONS"
194     .IX Header "OPTIONS"
195     The \fB@@RXVT_NAME@@\fR options (mostly a subset of \fIxterm\fR's) are listed
196     below. In keeping with the smaller-is-better philosophy, options may be
197     eliminated or default values chosen at compile\-time, so options and
198     defaults listed may not accurately reflect the version installed on
199     your system. `@@RXVT_NAME@@ \-h' gives a list of major compile-time options on
200     the \fIOptions\fR line. Option descriptions may be prefixed with which
201     compile option each is dependent upon. e.g. `Compile \fI\s-1XIM\s0\fR:' requires
202     \&\fI\s-1XIM\s0\fR on the \fIOptions\fR line. Note: `@@RXVT_NAME@@ \-help' gives a list of all
203     command-line options compiled into your version.
204     .PP
205     Note that \fB@@RXVT_NAME@@\fR permits the resource name to be used as a
206     long-option (\-\-/++ option) so the potential command-line options are
207     far greater than those listed. For example: `@@RXVT_NAME@@ \-\-loginShell \-\-color1
208     Orange'.
209     .PP
210     The following options are available:
211     .IP "\fB\-help\fR, \fB\-\-help\fR" 4
212     .IX Item "-help, --help"
213     Print out a message describing available options.
214     .IP "\fB\-display\fR \fIdisplayname\fR" 4
215     .IX Item "-display displayname"
216     Attempt to open a window on the named X display (\fB\-d\fR still
217     respected). In the absence of this option, the display specified by the
218     \&\fB\s-1DISPLAY\s0\fR environment variable is used.
219     .IP "\fB\-geometry\fR \fIgeom\fR" 4
220     .IX Item "-geometry geom"
221     Window geometry (\fB\-g\fR still respected); resource \fBgeometry\fR.
222     .IP "\fB\-rv\fR|\fB+rv\fR" 4
223     .IX Item "-rv|+rv"
224     Turn on/off simulated reverse video; resource \fBreverseVideo\fR.
225     .IP "\fB\-j\fR|\fB+j\fR" 4
226     .IX Item "-j|+j"
227     Turn on/off jump scrolling; resource \fBjumpScroll\fR.
228     .IP "\fB\-ip\fR|\fB+ip\fR" 4
229     .IX Item "-ip|+ip"
230     Turn on/off inheriting parent window's pixmap. Alternative form is
231     \&\fB\-tr\fR; resource \fBinheritPixmap\fR.
232     .IP "\fB\-fade\fR \fInumber\fR" 4
233     .IX Item "-fade number"
234     Fade the text by the given percentage when focus is lost. resource \fBfading\fR.
235     .IP "\fB\-tint\fR \fIcolour\fR" 4
236     .IX Item "-tint colour"
237     Tint the transparent background pixmap with the given colour when
238     transparency is enabled with \fB\-tr\fR or \fB\-ip\fR. See also the \fB\-sh\fR
239     option that can be used to brighten or darken the image in addition to
240     tinting it.
241     .IP "\fB\-sh\fR" 4
242     .IX Item "-sh"
243     \&\fInumber\fR Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent
244     background image in addition to tinting it (i.e. \fB\-tint\fR must be
245     specified, too, e.g. \f(CW\*(C`\-tint white\*(C'\fR).
246     .IP "\fB\-bg\fR \fIcolour\fR" 4
247     .IX Item "-bg colour"
248     Window background colour; resource \fBbackground\fR.
249     .IP "\fB\-fg\fR \fIcolour\fR" 4
250     .IX Item "-fg colour"
251     Window foreground colour; resource \fBforeground\fR.
252     .IP "\fB\-pixmap\fR \fIfile[;geom]\fR" 4
253     .IX Item "-pixmap file[;geom]"
254     Compile \fI\s-1XPM\s0\fR: Specify \s-1XPM\s0 file for the background and also optionally
255 root 1.3 specify its scaling with a geometry string. Note you may need to
256     add quotes to avoid special shell interpretation of the \f(CW\*(C`;\*(C'\fR in the
257 root 1.1 command\-line; resource \fBbackgroundPixmap\fR.
258     .IP "\fB\-cr\fR \fIcolour\fR" 4
259     .IX Item "-cr colour"
260     The cursor colour; resource \fBcursorColor\fR.
261     .IP "\fB\-pr\fR \fIcolour\fR" 4
262     .IX Item "-pr colour"
263     The mouse pointer foreground colour; resource \fBpointerColor\fR.
264     .IP "\fB\-pr2\fR \fIcolour\fR" 4
265     .IX Item "-pr2 colour"
266     The mouse pointer background colour; resource \fBpointerColor2\fR.
267     .IP "\fB\-bd\fR \fIcolour\fR" 4
268     .IX Item "-bd colour"
269     The colour of the border around the text area and between the scrollbar and the text;
270     resource \fBborderColor\fR.
271     .IP "\fB\-fn\fR \fIfontlist\fR" 4
272     .IX Item "-fn fontlist"
273     Select the fonts to be used. This is a comma separated list of font names
274     that are used in turn when trying to display Unicode characters. The
275     first font defines the cell size for characters; other fonts might be
276     smaller, but not (in general) larger. A (hopefully) reasonable default
277     font list is always appended to it. See resource \fBfont\fR for more details.
278     .Sp
279     In short, to specify an X11 core font, just specify it's name or prefix it
280     with \f(CW\*(C`x:\*(C'\fR. To specify an XFT\-font, you need to prefix it with \f(CW\*(C`xft:\*(C'\fR,
281     e.g.:
282     .Sp
283     .Vb 2
284     \& @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
285     \& @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
286     .Ve
287     .Sp
288     See also the question \*(L"How does rxvt-unicode choose fonts?\*(R" in the \s-1FAQ\s0
289     section of @@RXVT_NAME@@(7).
290     .IP "\fB\-fb\fR \fIfontlist\fR" 4
291     .IX Item "-fb fontlist"
292     Compile font\-styles: The bold font list to use when bold characters are to
293     be printed. See resource \fBboldFont\fR for details.
294     .IP "\fB\-fi\fR \fIfontlist\fR" 4
295     .IX Item "-fi fontlist"
296     Compile font\-styles: The italic font list to use when bold characters are to
297     be printed. See resource \fBitalicFont\fR for details.
298     .IP "\fB\-fbi\fR \fIfontlist\fR" 4
299     .IX Item "-fbi fontlist"
300     Compile font\-styles: The bold italic font list to use when bold characters are to
301     be printed. See resource \fBboldItalicFont\fR for details.
302     .IP "\fB\-name\fR \fIname\fR" 4
303     .IX Item "-name name"
304     Specify the application name under which resources are to be obtained,
305     rather than the default executable file name. Name should not contain
306     `.' or `*' characters. Also sets the icon and title name.
307     .IP "\fB\-ls\fR|\fB+ls\fR" 4
308     .IX Item "-ls|+ls"
309     Start as a login\-shell/sub\-shell; resource \fBloginShell\fR.
310     .IP "\fB\-ut\fR|\fB+ut\fR" 4
311     .IX Item "-ut|+ut"
312     Compile \fIutmp\fR: Inhibit/enable writing a utmp entry; resource
313     \&\fButmpInhibit\fR.
314     .IP "\fB\-vb\fR|\fB+vb\fR" 4
315     .IX Item "-vb|+vb"
316     Turn on/off visual bell on receipt of a bell character; resource
317     \&\fBvisualBell\fR.
318     .IP "\fB\-sb\fR|\fB+sb\fR" 4
319     .IX Item "-sb|+sb"
320     Turn on/off scrollbar; resource \fBscrollBar\fR.
321     .IP "\fB\-si\fR|\fB+si\fR" 4
322     .IX Item "-si|+si"
323     Turn on/off scroll-to-bottom on \s-1TTY\s0 output inhibit; resource
324     \&\fBscrollTtyOutput\fR has opposite effect.
325     .IP "\fB\-sk\fR|\fB+sk\fR" 4
326     .IX Item "-sk|+sk"
327     Turn on/off scroll-to-bottom on keypress; resource
328     \&\fBscrollTtyKeypress\fR.
329     .IP "\fB\-sw\fR|\fB+sw\fR" 4
330     .IX Item "-sw|+sw"
331     Turn on/off scrolling with the scrollback buffer as new lines appear.
332     This only takes effect if \fB\-si\fR is also given; resource
333     \&\fBscrollWithBuffer\fR.
334     .IP "\fB\-sr\fR|\fB+sr\fR" 4
335     .IX Item "-sr|+sr"
336     Put scrollbar on right/left; resource \fBscrollBar_right\fR.
337     .IP "\fB\-st\fR|\fB+st\fR" 4
338     .IX Item "-st|+st"
339     Display normal (non XTerm/NeXT) scrollbar without/with a trough;
340     resource \fBscrollBar_floating\fR.
341     .IP "\fB\-ptab\fR|\fB+ptab\fR" 4
342     .IX Item "-ptab|+ptab"
343     If enabled (default), \*(L"Horizontal Tab\*(R" characters are being stored as
344     actual wide characters in the screen buffer, which makes it possible to
345     select and paste them. Since a horizontal tab is a cursor movement and
346     not an actual glyph, this can sometimes be visually annoying as the cursor
347     on a tab character is displayed as a wide cursor; resource \fBpastableTabs\fR.
348     .IP "\fB\-bc\fR|\fB+bc\fR" 4
349     .IX Item "-bc|+bc"
350     Blink the cursor; resource \fBcursorBlink\fR.
351     .IP "\fB\-iconic\fR" 4
352     .IX Item "-iconic"
353     Start iconified, if the window manager supports that option.
354     Alternative form is \fB\-ic\fR.
355     .IP "\fB\-sl\fR \fInumber\fR" 4
356     .IX Item "-sl number"
357     Save \fInumber\fR lines in the scrollback buffer. See resource entry for
358     limits; resource \fBsaveLines\fR.
359     .IP "\fB\-b\fR \fInumber\fR" 4
360     .IX Item "-b number"
361     Compile \fIfrills\fR: Internal border of \fInumber\fR pixels. See resource
362     entry for limits; resource \fBinternalBorder\fR.
363     .IP "\fB\-w\fR \fInumber\fR" 4
364     .IX Item "-w number"
365     Compile \fIfrills\fR: External border of \fInumber\fR pixels. Also, \fB\-bw\fR
366     and \fB\-borderwidth\fR. See resource entry for limits; resource
367     \&\fBexternalBorder\fR.
368     .IP "\fB\-bl\fR" 4
369     .IX Item "-bl"
370     Compile \fIfrills\fR: Set \s-1MWM\s0 hints to request a borderless window, i.e.
371     if honoured by the \s-1WM\s0, the rxvt-unicode window will not have window
372     decorations; resource \fBborderLess\fR.
373     .IP "\fB\-lsp\fR \fInumber\fR" 4
374     .IX Item "-lsp number"
375     Compile \fIfrills\fR: Lines (pixel height) to insert between each row of
376     the display. Useful to work around font rendering problems; resource
377     \&\fBlinespace\fR.
378     .IP "\fB\-tn\fR \fItermname\fR" 4
379     .IX Item "-tn termname"
380     This option specifies the name of the terminal type to be set in the
381     \&\fB\s-1TERM\s0\fR environment variable. This terminal type must exist in the
382     \&\fI\fItermcap\fI\|(5)\fR database and should have \fIli#\fR and \fIco#\fR entries;
383     resource \fBtermName\fR.
384     .IP "\fB\-e\fR \fIcommand [arguments]\fR" 4
385     .IX Item "-e command [arguments]"
386     Run the command with its command-line arguments in the \fB@@RXVT_NAME@@\fR
387     window; also sets the window title and icon name to be the basename of
388     the program being executed if neither \fI\-title\fR (\fI\-T\fR) nor \fI\-n\fR are
389     given on the command line. If this option is used, it must be the last
390     on the command\-line. If there is no \fB\-e\fR option then the default is to
391     run the program specified by the \fB\s-1SHELL\s0\fR environment variable or,
392     failing that, \fI\fIsh\fI\|(1)\fR.
393     .IP "\fB\-title\fR \fItext\fR" 4
394     .IX Item "-title text"
395     Window title (\fB\-T\fR still respected); the default title is the basename
396     of the program specified after the \fB\-e\fR option, if any, otherwise the
397     application name; resource \fBtitle\fR.
398     .IP "\fB\-n\fR \fItext\fR" 4
399     .IX Item "-n text"
400     Icon name; the default name is the basename of the program specified
401     after the \fB\-e\fR option, if any, otherwise the application name;
402     resource \fBiconName\fR.
403     .IP "\fB\-C\fR" 4
404     .IX Item "-C"
405     Capture system console messages.
406     .IP "\fB\-pt\fR \fIstyle\fR" 4
407     .IX Item "-pt style"
408     Compile \fI\s-1XIM\s0\fR: input style for input method; \fBOverTheSpot\fR,
409     \&\fBOffTheSpot\fR, \fBRoot\fR; resource \fBpreeditType\fR.
410     .IP "\fB\-im\fR \fItext\fR" 4
411     .IX Item "-im text"
412     Compile \fI\s-1XIM\s0\fR: input method name. resource \fBinputMethod\fR.
413     .IP "\fB\-imlocale\fR \fIstring\fR" 4
414     .IX Item "-imlocale string"
415 root 1.7 The locale to use for opening the \s-1IM\s0. You can use an \f(CW\*(C`LC_CTYPE\*(C'\fR of e.g.
416     \&\f(CW\*(C`de_DE.UTF\-8\*(C'\fR for normal text processing but \f(CW\*(C`ja_JP.EUC\-JP\*(C'\fR for the
417     input extension to be able to input japanese characters while staying in
418     another locale. resource \fBimLocale\fR.
419     .IP "\fB\-imfont\fR \fIfontset\fR" 4
420     .IX Item "-imfont fontset"
421     Set the font set to use for the X Input Method, see resource \fBimFont\fR
422     for more info.
423     .IP "\fB\-tcw\fR" 4
424     .IX Item "-tcw"
425     Change the meaning of triple-click selection with the left mouse
426     button. Instead of selecting a full line it will extend the selection the
427     end of the logical line only. resource \fBtripleclickwords\fR.
428 root 1.1 .IP "\fB\-insecure\fR" 4
429     .IX Item "-insecure"
430     Enable \*(L"insecure\*(R" mode, which currently enables most of the escape
431     sequences that echo strings. See the resource \fBinsecure\fR for more
432     info.
433     .IP "\fB\-mod\fR \fImodifier\fR" 4
434     .IX Item "-mod modifier"
435     Override detection of Meta modifier with specified key: \fBalt\fR,
436     \&\fBmeta\fR, \fBhyper\fR, \fBsuper\fR, \fBmod1\fR, \fBmod2\fR, \fBmod3\fR, \fBmod4\fR,
437     \&\fBmod5\fR; resource \fImodifier\fR.
438     .IP "\fB\-ssc\fR|\fB+ssc\fR" 4
439     .IX Item "-ssc|+ssc"
440     Turn on/off secondary screen (default enabled); resource
441     \&\fBsecondaryScreen\fR.
442     .IP "\fB\-ssr\fR|\fB+ssr\fR" 4
443     .IX Item "-ssr|+ssr"
444     Turn on/off secondary screen scroll (default enabled); resource
445     \&\fBsecondaryScroll\fR.
446 root 1.18 .IP "\fB\-keysym.\fR\fIsym\fR \fIstring\fR" 4
447     .IX Item "-keysym.sym string"
448 root 1.12 Remap a key symbol. See resource \fBkeysym\fR.
449 root 1.18 .IP "\fB\-embed\fR \fIwindowid\fR" 4
450     .IX Item "-embed windowid"
451 root 1.15 Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
452     which enables applications to easily embed a terminal.
453     .Sp
454     Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
455     shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
456     quite a bit, so don't expect it to keep some specific state. It's best to
457     create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
458     .Sp
459 root 1.16 The window will not be destroyed when @@RXVT_NAME@@ exits.
460     .Sp
461 root 1.15 It might be useful to know that @@RXVT_NAME@@ will not close file
462     descriptors passed to it (except for stdin/out/err, of course), so you
463     can use file descriptors to communicate with the programs within the
464     terminal. This works regardless of wether the \f(CW\*(C`\-embed\*(C'\fR option was used or
465     not.
466 root 1.18 .Sp
467     Here is a short Gtk2\-perl snippet that illustrates how this option can be
468     used (a longer example is in \fIdoc/embed\fR):
469     .Sp
470 root 1.20 .Vb 5
471     \& my $rxvt = new Gtk2::Socket;
472     \& $rxvt->signal_connect_after (realize => sub {
473     \& my $xid = $_[0]->window->get_xid;
474     \& system "@@RXVT_NAME@@ -embed $xid &";
475     \& });
476 root 1.18 .Ve
477     .IP "\fB\-pty\-fd\fR \fIfileno\fR" 4
478     .IX Item "-pty-fd fileno"
479     Tells @@RXVT_NAME@@ \s-1NOT\s0 to execute any commands or create a new pty/tty
480     pair but instead use the given filehandle as the tty master. This is
481     useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
482     without having to run a program within it.
483     .Sp
484     If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
485     entries and will not tinker with pty/tty permissions \- you have to do that
486     yourself if you want that.
487     .Sp
488     Here is a example in perl that illustrates how this option can be used (a
489     longer example is in \fIdoc/pty\-fd\fR):
490     .Sp
491     .Vb 2
492     \& use IO::Pty;
493     \& use Fcntl;
494     .Ve
495     .Sp
496 root 1.19 .Vb 4
497 root 1.18 \& my $pty = new IO::Pty;
498     \& fcntl $pty, F_SETFD, 0; # clear close-on-exec
499     \& system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
500 root 1.19 \& close $pty;
501 root 1.18 .Ve
502     .Sp
503     .Vb 3
504     \& # now communicate with rxvt
505     \& my $slave = $pty->slave;
506     \& while (<$slave>) { print $slave "got <$_>\en" }
507     .Ve
508 root 1.1 .SH "RESOURCES (available also as long\-options)"
509     .IX Header "RESOURCES (available also as long-options)"
510     Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long
511     options) compiled into your version.
512     .PP
513     There are two different methods that @@RXVT_NAME@@ can use to get the
514     Xresource data: using the X libraries (Xrm*\-functions) or internal
515     Xresources reader (\fB~/.Xdefaults\fR). For the first method (ie.
516     \&\fB@@RXVT_NAME@@ \-h\fR lists \fBXGetDefaults\fR), you can set and change the
517 root 1.12 resources using X11 tools like \fBxrdb\fR. Many distribution do also load
518     settings from the \fB~/.Xresources\fR file when X starts. @@RXVT_NAME@@
519     will consult the following files/resources in order, with later settings
520     overwriting earlier ones:
521     .PP
522     .Vb 5
523     \& 1. system-wide app-defaults file, either locale-dependent OR global
524     \& 2. app-defaults file in $XAPPLRESDIR
525     \& 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
526     \& 4. SCREEN_RESOURCES for the current screen
527     \& 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
528     .Ve
529 root 1.1 .PP
530     If compiled with internal Xresources support (i.e. \fB@@RXVT_NAME@@ \-h\fR
531     lists \fB.Xdefaults\fR) then \fB@@RXVT_NAME@@\fR accepts application defaults
532     set in XAPPLOADDIR/URxvt (compile\-time defined: usually
533     \&\fB/usr/lib/X11/app\-defaults/URxvt\fR) and resources set in
534     \&\fB~/.Xdefaults\fR, or \fB~/.Xresources\fR if \fB~/.Xdefaults\fR does not exist.
535     Note that when reading X resources, \fB@@RXVT_NAME@@\fR recognizes two
536     class names: \fBXTerm\fR and \fBURxvt\fR. The class name \fBRxvt\fR allows
537     resources common to both \fB@@RXVT_NAME@@\fR and the original \fIrxvt\fR to be
538     easily configured, while the class name \fBURxvt\fR allows resources
539     unique to \fB@@RXVT_NAME@@\fR, notably colours and key\-handling, to be
540     shared between different \fB@@RXVT_NAME@@\fR configurations. If no
541     resources are specified, suitable defaults will be used. Command-line
542     arguments can be used to override resource settings. The following
543     resources are allowed:
544     .IP "\fBgeometry:\fR \fIgeom\fR" 4
545     .IX Item "geometry: geom"
546     Create the window with the specified X window geometry [default 80x24];
547     option \fB\-geometry\fR.
548     .IP "\fBbackground:\fR \fIcolour\fR" 4
549     .IX Item "background: colour"
550     Use the specified colour as the window's background colour [default
551     White]; option \fB\-bg\fR.
552     .IP "\fBforeground:\fR \fIcolour\fR" 4
553     .IX Item "foreground: colour"
554     Use the specified colour as the window's foreground colour [default
555     Black]; option \fB\-fg\fR.
556     .IP "\fBcolor\fR\fIn\fR\fB:\fR \fIcolour\fR" 4
557     .IX Item "colorn: colour"
558     Use the specified colour for the colour value \fIn\fR, where 0\-7
559     corresponds to low-intensity (normal) colours and 8\-15 corresponds to
560     high-intensity (bold = bright foreground, blink = bright background)
561     colours. The canonical names are as follows: 0=black, 1=red, 2=green,
562     3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
563     names used are listed in the \fB\s-1COLORS\s0 \s-1AND\s0 \s-1GRAPHICS\s0\fR section.
564     .Sp
565     Colours higher than 15 cannot be set using resources (yet), but can be
566     changed using an escape command (see @@RXVT_NAME@@(7)).
567     .Sp
568     Colours 16\-79 form a standard 4x4x4 colour cube (the same as xterm with
569     88 colour support). Colours 80\-87 are evenly spaces grey steps.
570     .IP "\fBcolorBD:\fR \fIcolour\fR" 4
571     .IX Item "colorBD: colour"
572     .PD 0
573     .IP "\fBcolorIT:\fR \fIcolour\fR" 4
574     .IX Item "colorIT: colour"
575     .PD
576     Use the specified colour to display bold or italic characters when the
577     foreground colour is the default. If font styles are not available
578 root 1.3 (Compile \fIstyles\fR) and this option is unset, reverse video is used instead.
579 root 1.1 .IP "\fBcolorUL:\fR \fIcolour\fR" 4
580     .IX Item "colorUL: colour"
581     Use the specified colour to display underlined characters when the
582     foreground colour is the default.
583     .IP "\fBcolorRV:\fR \fIcolour\fR" 4
584     .IX Item "colorRV: colour"
585     Use the specified colour as the background for reverse video
586     characters.
587     .IP "\fBunderlineColor:\fR \fIcolour\fR" 4
588     .IX Item "underlineColor: colour"
589     If set, use the specified colour as the colour for the underline
590     itself. If unset, use the foreground colour.
591     .IP "\fBcursorColor:\fR \fIcolour\fR" 4
592     .IX Item "cursorColor: colour"
593     Use the specified colour for the cursor. The default is to use the
594     foreground colour; option \fB\-cr\fR.
595     .IP "\fBcursorColor2:\fR \fIcolour\fR" 4
596     .IX Item "cursorColor2: colour"
597     Use the specified colour for the colour of the cursor text. For this to
598     take effect, \fBcursorColor\fR must also be specified. The default is to
599     use the background colour.
600     .IP "\fBreverseVideo:\fR \fIboolean\fR" 4
601     .IX Item "reverseVideo: boolean"
602     \&\fBTrue\fR: simulate reverse video by foreground and background colours;
603     option \fB\-rv\fR. \fBFalse\fR: regular screen colours [default]; option
604     \&\fB+rv\fR. See note in \fB\s-1COLORS\s0 \s-1AND\s0 \s-1GRAPHICS\s0\fR section.
605     .IP "\fBjumpScroll:\fR \fIboolean\fR" 4
606     .IX Item "jumpScroll: boolean"
607     \&\fBTrue\fR: specify that jump scrolling should be used. When scrolling
608     quickly, fewer screen updates are performed [default]; option \fB\-j\fR.
609     \&\fBFalse\fR: specify that smooth scrolling should be used; option \fB+j\fR.
610     .IP "\fBinheritPixmap:\fR \fIboolean\fR" 4
611     .IX Item "inheritPixmap: boolean"
612     \&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving
613     artificial transparency. \fBFalse\fR: do not inherit the parent windows'
614     pixmap.
615     .IP "\fBfading:\fR \fInumber\fR" 4
616     .IX Item "fading: number"
617     Fade the text by the given percentage when focus is lost.
618     .IP "\fBtintColor:\fR \fIcolour\fR" 4
619     .IX Item "tintColor: colour"
620     Tint the transparent background pixmap with the given colour.
621     .IP "\fBshading:\fR \fInumber\fR" 4
622     .IX Item "shading: number"
623     Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background
624     image in addition to tinting it.
625     .IP "\fBscrollColor:\fR \fIcolour\fR" 4
626     .IX Item "scrollColor: colour"
627     Use the specified colour for the scrollbar [default #B2B2B2].
628     .IP "\fBtroughColor:\fR \fIcolour\fR" 4
629     .IX Item "troughColor: colour"
630     Use the specified colour for the scrollbar's trough area [default
631     #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.
632     .IP "\fBborderColor:\fR \fIcolour\fR" 4
633     .IX Item "borderColor: colour"
634     The colour of the border around the text area and between the scrollbar
635     and the text.
636     .IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4
637     .IX Item "backgroundPixmap: file[;geom]"
638     Use the specified \s-1XPM\s0 file (note the `.xpm' extension is optional) for
639     the background and also optionally specify its scaling with a geometry
640     string \fBWxH+X+Y\fR, in which \fB\*(L"W\*(R" / \*(L"H\*(R"\fR specify the
641     horizontal/vertical scale (percent) and \fB\*(L"X\*(R" / \*(L"Y\*(R"\fR locate the image
642     centre (percent). A scale of 0 displays the image with tiling. A scale
643     of 1 displays the image without any scaling. A scale of 2 to 9
644     specifies an integer number of images in that direction. No image will
645     be magnified beyond 10 times its original size. The maximum permitted
646     scale is 1000. [default 0x0+50+50]
647     .IP "\fBmenu:\fR \fIfile[;tag]\fR" 4
648     .IX Item "menu: file[;tag]"
649     Read in the specified menu file (note the `.menu' extension is
650     optional) and also optionally specify a starting tag to find. See the
651     reference documentation for details on the syntax for the menuBar.
652     .IP "\fBpath:\fR \fIpath\fR" 4
653     .IX Item "path: path"
654     Specify the colon-delimited search path for finding files (\s-1XPM\s0 and
655     menus), in addition to the paths specified by the \fB\s-1RXVTPATH\s0\fR and
656     \&\fB\s-1PATH\s0\fR environment variables.
657     .IP "\fBfont:\fR \fIfontlist\fR" 4
658     .IX Item "font: fontlist"
659     Select the fonts to be used. This is a comma separated list of font
660     names that are used in turn when trying to display Unicode characters.
661     The first font defines the cell size for characters; other fonts might
662     be smaller, but not larger. A reasonable default font list is always
663     appended to it. option \fB\-fn\fR.
664     .Sp
665     Each font can either be a standard X11 core font (\s-1XLFD\s0) name, with
666 root 1.3 optional prefix \f(CW\*(C`x:\*(C'\fR or a Xft font (Compile \fIxft\fR), prefixed with \f(CW\*(C`xft:\*(C'\fR.
667 root 1.1 .Sp
668     In addition, each font can be prefixed with additional hints and
669     specifications enclosed in square brackets (\f(CW\*(C`[]\*(C'\fR). The only available
670     hint currently is \f(CW\*(C`codeset=codeset\-name\*(C'\fR, and this is only used for Xft
671     fonts.
672     .Sp
673     For example, this font resource
674     .Sp
675     .Vb 5
676     \& URxvt*font: 9x15bold,\e
677     \& -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\e
678     \& -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \e
679     \& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e
680     \& xft:Code2000:antialias=false
681     .Ve
682     .Sp
683     specifies five fonts to be used. The first one is \f(CW\*(C`9x15bold\*(C'\fR (actually
684     the iso8859\-1 version of the second font), which is the base font (because
685     it is named first) and thus defines the character cell grid to be 9 pixels
686     wide and 15 pixels high.
687     .Sp
688     The second font is just used to add additional unicode characters not in
689     the base font, likewise the third, which is unfortunately non\-bold, but
690     the bold version of the font does contain less characters, so this is a
691     useful supplement.
692     .Sp
693     The third font is an Xft font with aliasing turned off, and the characters
694     are limited to the \fB\s-1JIS\s0 0208\fR codeset (i.e. japanese kanji). The font
695     contains other characters, but we are not interested in them.
696     .Sp
697     The last font is a useful catch-all font that supplies most of the
698     remaining unicode characters.
699     .IP "\fBboldFont:\fR \fIfontlist\fR" 4
700     .IX Item "boldFont: fontlist"
701     .PD 0
702     .IP "\fBitalicFont:\fR \fIfontlist\fR" 4
703     .IX Item "italicFont: fontlist"
704     .IP "\fBboldItalicFont:\fR \fIfontlist\fR" 4
705     .IX Item "boldItalicFont: fontlist"
706     .PD
707     The font list to use for displaying \fBbold\fR, \fIitalic\fR or \fB\f(BIbold
708     italic\fB\fR characters, respectively.
709     .Sp
710     If specified and non\-empty, then the syntax is the same as for the
711     \&\fBfont\fR\-resource, and the given font list will be used as is, which makes
712     it possible to substitute completely different font styles for bold and
713     italic.
714     .Sp
715     If unset (the default), a suitable font list will be synthesized by
716     \&\*(L"morphing\*(R" the normal text font list into the desired shape. If that is
717     not possible, replacement fonts of the desired shape will be tried.
718     .Sp
719     If set, but empty, then this specific style is disabled and the normal
720     text font will being used for the given style.
721     .IP "\fBselectstyle:\fR \fImode\fR" 4
722     .IX Item "selectstyle: mode"
723     Set mouse selection style to \fBold\fR which is 2.20, \fBoldword\fR which is
724     xterm style with 2.20 old word selection, or anything else which gives
725     xterm style selection.
726     .IP "\fBscrollstyle:\fR \fImode\fR" 4
727     .IX Item "scrollstyle: mode"
728     Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is
729     the author's favourite..
730     .IP "\fBtitle:\fR \fIstring\fR" 4
731     .IX Item "title: string"
732     Set window title string, the default title is the command-line
733     specified after the \fB\-e\fR option, if any, otherwise the application
734     name; option \fB\-title\fR.
735     .IP "\fBiconName:\fR \fIstring\fR" 4
736     .IX Item "iconName: string"
737     Set the name used to label the window's icon or displayed in an icon
738     manager window, it also sets the window's title unless it is explicitly
739     set; option \fB\-n\fR.
740     .IP "\fBmapAlert:\fR \fIboolean\fR" 4
741     .IX Item "mapAlert: boolean"
742     \&\fBTrue\fR: de-iconify (map) on receipt of a bell character. \fBFalse\fR: no
743     de-iconify (map) on receipt of a bell character [default].
744     .IP "\fBvisualBell:\fR \fIboolean\fR" 4
745     .IX Item "visualBell: boolean"
746     \&\fBTrue\fR: use visual bell on receipt of a bell character; option \fB\-vb\fR.
747     \&\fBFalse\fR: no visual bell [default]; option \fB+vb\fR.
748     .IP "\fBloginShell:\fR \fIboolean\fR" 4
749     .IX Item "loginShell: boolean"
750     \&\fBTrue\fR: start as a login shell by prepending a `\-' to \fBargv[0]\fR of
751     the shell; option \fB\-ls\fR. \fBFalse\fR: start as a normal sub-shell
752     [default]; option \fB+ls\fR.
753     .IP "\fButmpInhibit:\fR \fIboolean\fR" 4
754     .IX Item "utmpInhibit: boolean"
755     \&\fBTrue\fR: inhibit writing record into the system log file \fButmp\fR;
756     option \fB\-ut\fR. \fBFalse\fR: write record into the system log file \fButmp\fR
757     [default]; option \fB+ut\fR.
758     .IP "\fBprint\-pipe:\fR \fIstring\fR" 4
759     .IX Item "print-pipe: string"
760     Specify a command pipe for vt100 printer [default \fI\fIlpr\fI\|(1)\fR]. Use
761     \&\fBPrint\fR to initiate a screen dump to the printer and \fBCtrl-Print\fR or
762     \&\fBShift-Print\fR to include the scrollback as well.
763     .IP "\fBscrollBar:\fR \fIboolean\fR" 4
764     .IX Item "scrollBar: boolean"
765     \&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR:
766     disable the scrollbar; option \fB+sb\fR.
767     .IP "\fBscrollBar_right:\fR \fIboolean\fR" 4
768     .IX Item "scrollBar_right: boolean"
769     \&\fBTrue\fR: place the scrollbar on the right of the window; option \fB\-sr\fR.
770     \&\fBFalse\fR: place the scrollbar on the left of the window; option \fB+sr\fR.
771     .IP "\fBscrollBar_floating:\fR \fIboolean\fR" 4
772     .IX Item "scrollBar_floating: boolean"
773     \&\fBTrue\fR: display an rxvt scrollbar without a trough; option \fB\-st\fR.
774     \&\fBFalse\fR: display an rxvt scrollbar with a trough; option \fB+st\fR.
775     .IP "\fBscrollBar_align:\fR \fImode\fR" 4
776     .IX Item "scrollBar_align: mode"
777     Align the \fBtop\fR, \fBbottom\fR or \fBcentre\fR [default] of the scrollbar
778     thumb with the pointer on middle button press/drag.
779     .IP "\fBscrollTtyOutput:\fR \fIboolean\fR" 4
780     .IX Item "scrollTtyOutput: boolean"
781     \&\fBTrue\fR: scroll to bottom when tty receives output; option \fB\-si\fR.
782     \&\fBFalse\fR: do not scroll to bottom when tty receives output; option
783     \&\fB+si\fR.
784     .IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4
785     .IX Item "scrollWithBuffer: boolean"
786     \&\fBTrue\fR: scroll with scrollback buffer when tty receives new lines (and
787 root 1.17 \&\fBscrollTtyOutput\fR is False); option \fB\-sw\fR. \fBFalse\fR: do not scroll
788     with scrollback buffer when tty recieves new lines; option \fB+sw\fR.
789 root 1.1 .IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4
790     .IX Item "scrollTtyKeypress: boolean"
791     \&\fBTrue\fR: scroll to bottom when a non-special key is pressed. Special keys
792     are those which are intercepted by rxvt-unicode for special handling and
793     are not passed onto the shell; option \fB\-sk\fR. \fBFalse\fR: do not scroll to
794     bottom when a non-special key is pressed; option \fB+sk\fR.
795     .IP "\fBsaveLines:\fR \fInumber\fR" 4
796     .IX Item "saveLines: number"
797     Save \fInumber\fR lines in the scrollback buffer [default 64]. This
798     resource is limited on most machines to 65535; option \fB\-sl\fR.
799     .IP "\fBinternalBorder:\fR \fInumber\fR" 4
800     .IX Item "internalBorder: number"
801     Internal border of \fInumber\fR pixels. This resource is limited to 100;
802     option \fB\-b\fR.
803     .IP "\fBexternalBorder:\fR \fInumber\fR" 4
804     .IX Item "externalBorder: number"
805     External border of \fInumber\fR pixels. This resource is limited to 100;
806     option \fB\-w\fR, \fB\-bw\fR, \fB\-borderwidth\fR.
807     .IP "\fBborderLess:\fR \fIboolean\fR" 4
808     .IX Item "borderLess: boolean"
809     Set \s-1MWM\s0 hints to request a borderless window, i.e. if honoured by the
810     \&\s-1WM\s0, the rxvt-unicode window will not have window decorations; option \fB\-bl\fR.
811     .IP "\fBtermName:\fR \fItermname\fR" 4
812     .IX Item "termName: termname"
813     Specifies the terminal type name to be set in the \fB\s-1TERM\s0\fR environment
814     variable; option \fB\-tn\fR.
815     .IP "\fBlinespace:\fR \fInumber\fR" 4
816     .IX Item "linespace: number"
817     Specifies number of lines (pixel height) to insert between each row of
818     the display [default 0]; option \fB\-lsp\fR.
819     .IP "\fBmeta8:\fR \fIboolean\fR" 4
820     .IX Item "meta8: boolean"
821     \&\fBTrue\fR: handle Meta (Alt) + keypress to set the 8th bit. \fBFalse\fR:
822     handle Meta (Alt) + keypress as an escape prefix [default].
823     .IP "\fBmouseWheelScrollPage:\fR \fIboolean\fR" 4
824     .IX Item "mouseWheelScrollPage: boolean"
825     \&\fBTrue\fR: the mouse wheel scrolls a page full. \fBFalse\fR: the mouse wheel
826     scrolls five lines [default].
827     .IP "\fBpastableTabs:\fR \fIboolean\fR" 4
828     .IX Item "pastableTabs: boolean"
829     \&\fBTrue\fR: store tabs as wide characters. \fBFalse\fR: interpret tabs as cursor
830     movement only; option \f(CW\*(C`\-ptab\*(C'\fR.
831     .IP "\fBcursorBlink:\fR \fIboolean\fR" 4
832     .IX Item "cursorBlink: boolean"
833     \&\fBTrue\fR: blink the cursor. \fBFalse\fR: do not blink the cursor [default];
834     option \fB\-bc\fR.
835     .IP "\fBpointerBlank:\fR \fIboolean\fR" 4
836     .IX Item "pointerBlank: boolean"
837     \&\fBTrue\fR: blank the pointer when a key is pressed or after a set number
838     of seconds of inactivity. \fBFalse\fR: the pointer is always visible
839     [default].
840     .IP "\fBpointerColor:\fR \fIcolour\fR" 4
841     .IX Item "pointerColor: colour"
842     Mouse pointer foreground colour.
843     .IP "\fBpointerColor2:\fR \fIcolour\fR" 4
844     .IX Item "pointerColor2: colour"
845     Mouse pointer background colour.
846     .IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4
847     .IX Item "pointerBlankDelay: number"
848 root 1.21 Specifies number of seconds before blanking the pointer [default 2]. Use a
849     large number (e.g. \f(CW987654321\fR) to effectively disable the timeout.
850 root 1.1 .IP "\fBbackspacekey:\fR \fIstring\fR" 4
851     .IX Item "backspacekey: string"
852     The string to send when the backspace key is pressed. If set to \fB\s-1DEC\s0\fR
853     or unset it will send \fBDelete\fR (code 127) or, if shifted, \fBBackspace\fR
854     (code 8) \- which can be reversed with the appropriate \s-1DEC\s0 private mode
855     escape sequence.
856     .IP "\fBdeletekey:\fR \fIstring\fR" 4
857     .IX Item "deletekey: string"
858     The string to send when the delete key (not the keypad delete key) is
859     pressed. If unset it will send the sequence traditionally associated
860     with the \fBExecute\fR key.
861     .IP "\fBcutchars:\fR \fIstring\fR" 4
862     .IX Item "cutchars: string"
863     The characters used as delimiters for double-click word selection. The
864     built-in default:
865     .Sp
866     \&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]{|}\fR
867     .IP "\fBpreeditType:\fR \fIstyle\fR" 4
868     .IX Item "preeditType: style"
869     \&\fBOverTheSpot\fR, \fBOffTheSpot\fR, \fBRoot\fR; option \fB\-pt\fR.
870     .IP "\fBinputMethod:\fR \fIname\fR" 4
871     .IX Item "inputMethod: name"
872     \&\fIname\fR of inputMethod to use; option \fB\-im\fR.
873     .IP "\fBimLocale:\fR \fIname\fR" 4
874     .IX Item "imLocale: name"
875 root 1.7 The locale to use for opening the \s-1IM\s0. You can use an \f(CW\*(C`LC_CTYPE\*(C'\fR of e.g.
876     \&\f(CW\*(C`de_DE.UTF\-8\*(C'\fR for normal text processing but \f(CW\*(C`ja_JP.EUC\-JP\*(C'\fR for the
877     input extension to be able to input japanese characters while staying in
878 root 1.1 another locale. option \fB\-imlocale\fR.
879 root 1.7 .IP "\fBimFont:\fR \fIfontset\fR" 4
880     .IX Item "imFont: fontset"
881     Specify the font-set used for \s-1XIM\s0 styles \f(CW\*(C`OverTheSpot\*(C'\fR or
882     \&\f(CW\*(C`OffTheSpot\*(C'\fR. It must be a standard X font set (\s-1XLFD\s0 patterns separated
883     by commas), i.e. it's not in the same format as the other font lists used
884     in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
885     found, preferably one or two pixels differing in size to the base font.
886     option \fB\-imfont\fR.
887     .IP "\fBtripleclickwords:\fR \fIboolean\fR" 4
888     .IX Item "tripleclickwords: boolean"
889     Change the meaning of triple-click selection with the left mouse
890     button. Instead of selecting a full line it will extend the selection to
891     the end of the logical line only. option \fB\-tcw\fR.
892 root 1.1 .IP "\fBinsecure:\fR \fIboolean\fR" 4
893     .IX Item "insecure: boolean"
894     Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that
895     echo arbitrary strings like the icon name or the locale. This could be
896     abused if somebody gets 8\-bit\-clean access to your display, whether
897     throuh a mail client displaying mail bodies unfiltered or though
898     \&\fIwrite\fR\|(1). Therefore, these sequences are disabled by default. (Note
899     that other terminals, including xterm, have these sequences
900     enabled by default). You can enable them by setting this boolean
901     resource or specifying \fB\-insecure\fR as an option. At the moment, this
902     enabled display\-answer, locale, findfont, icon label and window title
903     requests as well as dynamic menubar dispatch.
904     .IP "\fBmodifier:\fR \fImodifier\fR" 4
905     .IX Item "modifier: modifier"
906     Set the key to be interpreted as the Meta key to: \fBalt\fR, \fBmeta\fR,
907     \&\fBhyper\fR, \fBsuper\fR, \fBmod1\fR, \fBmod2\fR, \fBmod3\fR, \fBmod4\fR, \fBmod5\fR; option
908     \&\fB\-mod\fR.
909     .IP "\fBanswerbackString:\fR \fIstring\fR" 4
910     .IX Item "answerbackString: string"
911     Specify the reply rxvt-unicode sends to the shell when an \s-1ENQ\s0 (control\-E)
912     character is passed through. It may contain escape values as described
913     in the entry on \fBkeysym\fR following.
914     .IP "\fBsecondaryScreen:\fR \fIbool\fR" 4
915     .IX Item "secondaryScreen: bool"
916     Turn on/off secondary screen (default enabled).
917     .IP "\fBsecondaryScroll:\fR \fIbool\fR" 4
918     .IX Item "secondaryScroll: bool"
919     Turn on/off secondary screen scroll (default enabled). If the this
920     option is enabled, scrolls on the secondary screen will change the
921     scrollback buffer and switching to/from the secondary screen will
922     instead scroll the screen up.
923     .IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4
924     .IX Item "keysym.sym: string"
925 root 1.3 Compile \fIfrills\fR: Associate \fIstring\fR with keysym \fIsym\fR. The
926     intervening resource name \fBkeysym.\fR cannot be omitted.
927     .Sp
928     The format of \fIsym\fR is "\fI(modifiers\-)key\fR", where \fImodifiers\fR can be
929     any combination of \fBISOLevel3\fR, \fBAppKeypad\fR, \fBControl\fR, \fBNumLock\fR,
930     \&\fBShift\fR, \fBMeta\fR, \fBLock\fR, \fBMod1\fR, \fBMod2\fR, \fBMod3\fR, \fBMod4\fR, \fBMod5\fR,
931     and the abbreviated \fBI\fR, \fBK\fR, \fBC\fR, \fBN\fR, \fBS\fR, \fBM\fR, \fBA\fR, \fBL\fR, \fB1\fR,
932     \&\fB2\fR, \fB3\fR, \fB4\fR, \fB5\fR.
933     .Sp
934     The \fBNumLock\fR, \fBMeta\fR and \fBISOLevel3\fR modifiers are usually aliased to
935     whatever modifier the NumLock key, Meta/Alt keys or \s-1ISO\s0 Level3 Shift/AltGr
936 root 1.7 keys are being mapped. \fBAppKeypad\fR is a synthetic modifier mapped to the
937 root 1.3 current application keymap mode state.
938     .Sp
939     The spellings of \fIkey\fR can be obtained by using \fBxev\fR(1) command or
940     searching keysym macros from \fB/usr/X11R6/include/X11/keysymdef.h\fR and
941     omitting the prefix \fB\s-1XK_\s0\fR. Alternatively you can specify \fIkey\fR by its hex
942     keysym value (\fB0x0000 \- 0xFFFF\fR). Note that the lookup of \fIsym\fRs is not
943     performed in an exact manner; however, the closest match is assured.
944     .Sp
945     \&\fIstring\fR may contain escape values (\f(CW\*(C`\ea\*(C'\fR: bell, \f(CW\*(C`\eb\*(C'\fR: backspace,
946     \&\f(CW\*(C`\ee\*(C'\fR, \f(CW\*(C`\eE\*(C'\fR: escape, \f(CW\*(C`\en\*(C'\fR: newline, \f(CW\*(C`\er\*(C'\fR: carriage return, \f(CW\*(C`\et\*(C'\fR: tab,
947     \&\f(CW\*(C`\e000\*(C'\fR: octal number) or verbatim control characters (\f(CW\*(C`^?\*(C'\fR: delete,
948     \&\f(CW\*(C`^@\*(C'\fR: null, \f(CW\*(C`^A\*(C'\fR ...) and may be enclosed with double quotes so that it
949     can start or end with whitespace.
950 root 1.2 .Sp
951 root 1.12 Please note that you need to double the \f(CW\*(C`\e\*(C'\fR when using
952     \&\f(CW\*(C`\-\-enable\-xgetdefault\*(C'\fR, as X itself does it's own de-escaping (you can
953     use \f(CW\*(C`\e033\*(C'\fR instead of \f(CW\*(C`\ee\*(C'\fR (and so on), which will work with both Xt and
954     @@RXVT_NAME@@'s own processing).
955     .Sp
956 root 1.2 You can define a range of keysyms in one shot by providing a \fIstring\fR
957 root 1.3 with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimeter `/'
958     should be a character not used by the strings.
959 root 1.2 .Sp
960     Its usage can be demonstrated by an example:
961 root 1.3 .Sp
962     .Vb 1
963 root 1.12 \& URxvt.keysym.M-C-0x61: list|\e033<M-C-|abc|>
964 root 1.3 .Ve
965 root 1.2 .Sp
966     The above line is equivalent to the following three lines:
967 root 1.3 .Sp
968     .Vb 3
969 root 1.12 \& URxvt.keysym.Meta-Control-0x61: \e033<M-C-a>
970     \& URxvt.keysym.Meta-Control-0x62: \e033<M-C-b>
971     \& URxvt.keysym.Meta-Control-0x63: \e033<M-C-c>
972 root 1.3 .Ve
973     .Sp
974 root 1.12 If \fIstring\fR takes the form of \f(CW\*(C`command:STRING\*(C'\fR, the specified \fB\s-1STRING\s0\fR
975 root 1.7 is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
976     example the following means "change the current locale to \f(CW\*(C`zh_CN.GBK\*(C'\fR
977     when Control-Meta-c is being pressed":
978     .Sp
979     .Vb 1
980 root 1.12 \& URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007
981 root 1.7 .Ve
982     .Sp
983 root 1.22 Due the the large number of modifier combinations, a defined key mapping
984     will match if at \fIat least\fR the specified identifiers are being set, and
985     no other key mappings with those and more bits are being defined. That
986     means that defining a key map for \f(CW\*(C`a\*(C'\fR will automatically provide
987     definitions for \f(CW\*(C`Meta\-a\*(C'\fR, \f(CW\*(C`Shift\-a\*(C'\fR and so on, unless some of those are defined
988     mappings themselves.
989     .Sp
990     Unfortunately, this will override built-in key mappings. For example
991     if you overwrite the \f(CW\*(C`Insert\*(C'\fR key you will disable @@RXVT_NAME@@'s
992     \&\f(CW\*(C`Shift\-Insert\*(C'\fR mapping. To re-enable that, you can poke \*(L"holes\*(R" into the
993     user-defined keymap using the \f(CW\*(C`builtin:\*(C'\fR replacement:
994     .Sp
995     .Vb 2
996     \& URxvt.keysym.Insert: <my insert key sequence>
997     \& URxvt.keysym.S-Insert: builtin:
998     .Ve
999     .Sp
1000     The first line defines a mapping for \f(CW\*(C`Insert\*(C'\fR and \fIany\fR combination
1001     of modifiers. The second line re-establishes the default mapping for
1002     \&\f(CW\*(C`Shift\-Insert\*(C'\fR.
1003     .Sp
1004 root 1.7 The following example will map Control\-Meta\-1 and Control\-Meta\-2 to
1005 root 1.12 the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited
1006 root 1.7 font-switching at runtime:
1007     .Sp
1008     .Vb 2
1009 root 1.12 \& URxvt.keysym.M-C-1: command:\e033]50;suxuseuro\e007
1010     \& URxvt.keysym.M-C-2: command:\e033]50;9x15bold\e007
1011 root 1.7 .Ve
1012     .Sp
1013 root 1.12 Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1014     info):
1015     .Sp
1016     .Vb 2
1017     \& URxvt.keysym.M-C-3: command:\e033[8;25;80t
1018     \& URxvt.keysym.M-C-4: command:\e033[8;48;110t
1019     .Ve
1020 root 1.1 .SH "THE SCROLLBAR"
1021     .IX Header "THE SCROLLBAR"
1022     Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window
1023     (resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar
1024     or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and
1025     its behaviour is fairly intuitive. The \fBxterm-scrollbar\fR is without
1026     arrows and its behaviour mimics that of \fIxterm\fR
1027     .PP
1028     Scroll down with \fBButton1\fR (\fBxterm-scrollbar\fR) or \fBShift-Next\fR.
1029     Scroll up with \fBButton3\fR (\fBxterm-scrollbar\fR) or \fBShift-Prior\fR.
1030     Continuous scroll with \fBButton2\fR.
1031     .SH "MOUSE REPORTING"
1032     .IX Header "MOUSE REPORTING"
1033     To temporarily override mouse reporting, for either the scrollbar or
1034     the normal text selection/insertion, hold either the Shift or the Meta
1035     (Alt) key while performing the desired mouse action.
1036     .PP
1037     If mouse reporting mode is active, the normal scrollbar actions are
1038     disabled \*(-- on the assumption that we are using a fullscreen
1039 root 1.12 application. Instead, pressing Button1 and Button3 sends \fB\s-1ESC\s0 [ 6 ~\fR
1040     (Next) and \fB\s-1ESC\s0 [ 5 ~\fR (Prior), respectively. Similarly, clicking on the
1041     up and down arrows sends \fB\s-1ESC\s0 [ A\fR (Up) and \fB\s-1ESC\s0 [ B\fR (Down),
1042 root 1.1 respectively.
1043     .SH "TEXT SELECTION AND INSERTION"
1044     .IX Header "TEXT SELECTION AND INSERTION"
1045     The behaviour of text selection and insertion mechanism is similar to
1046     \&\fIxterm\fR(1).
1047     .IP "\fBSelection\fR:" 4
1048     .IX Item "Selection:"
1049 root 1.7 Left click at the beginning of the region, drag to the end of the region
1050     and release; Right click to extend the marked region; Left double-click
1051     to select a word; Left triple-click to select the entire logical line
1052     (which can span multiple screen lines), unless modified by resource
1053     \&\fBtripleclickwords\fR.
1054 root 1.1 .Sp
1055     Starting a selection while pressing the \fBMeta\fR key (or \fBMeta+Ctrl\fR keys)
1056 root 1.3 (Compile: \fIfrills\fR) will create a rectangular selection instead of a normal
1057 root 1.1 one.
1058     .IP "\fBInsertion\fR:" 4
1059     .IX Item "Insertion:"
1060     Pressing and releasing the Middle mouse button (or \fBShift-Insert\fR) in
1061     an \fB@@RXVT_NAME@@\fR window causes the current text selection to be
1062     inserted as if it had been typed on the keyboard.
1063     .SH "CHANGING FONTS"
1064     .IX Header "CHANGING FONTS"
1065     Changing fonts (or font sizes, respectively) via the keypad is not yet
1066     supported in rxvt\-unicode. Bug me if you need this.
1067     .PP
1068     You can, however, switch fonts at runtime using escape sequences (and
1069     therefore using the menubar), e.g.:
1070     .PP
1071     .Vb 1
1072     \& printf '\ee]701;%s\e007' "9x15bold,xft:Kochi Gothic"
1073     .Ve
1074     .PP
1075     rxvt-unicode will automatically re-apply these fonts to the output so far.
1076     .SH "ISO 14755 SUPPORT"
1077     .IX Header "ISO 14755 SUPPORT"
1078     \&\s-1ISO\s0 14755 is a standard for entering and viewing unicode characters
1079     and character codes using the keyboard. It consists of 4 parts. The
1080     first part is available rxvt-unicode has been compiled with
1081     \&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, the rest is available when rxvt-unicode was compiled
1082     with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR.
1083 root 1.7 .IP "* 5.1: Basic method" 4
1084 root 1.1 .IX Item "5.1: Basic method"
1085     This allows you to enter unicode characters using their hexcode.
1086     .Sp
1087     Start by pressing and holding both \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, then enter
1088     hex-digits (between one and six). Releasing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR will
1089     commit the character as if it were typed directly. While holding down
1090     \&\f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR you can also enter multiple characters by pressing
1091     \&\f(CW\*(C`Space\*(C'\fR, which will commit the current character and lets you start a new
1092     one.
1093     .Sp
1094     As an example of use, imagine a business card with a japanese e\-mail
1095     address, which you cannot type. Fortunately, the card has the e\-mail
1096     address printed as hexcodes, e.g. \f(CW\*(C`671d 65e5\*(C'\fR. You can enter this easily
1097     by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, followed by \f(CW\*(C`6\-7\-1\-D\-SPACE\-6\-5\-E\-5\*(C'\fR,
1098     followed by releasing the modifier keys.
1099 root 1.7 .IP "* 5.2: Keyboard symbols entry method" 4
1100 root 1.1 .IX Item "5.2: Keyboard symbols entry method"
1101     This mode lets you input characters representing the keycap symbols of
1102     your keyboard, if representable in the current locale encoding.
1103     .Sp
1104     Start by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then releasing
1105     them. The next special key (cursor keys, home etc.) you enter will not
1106     invoke it's usual function but instead will insert the corresponding
1107     keycap symbol. The symbol will only be entered when the key has been
1108     released, otherwise pressing e.g. \f(CW\*(C`Shift\*(C'\fR would enter the symbol for
1109     \&\f(CW\*(C`ISO Level 2 Switch\*(C'\fR, although your intention might have been to enter a
1110     reverse tab (Shift\-Tab).
1111 root 1.7 .IP "* 5.3: Screen-selection entry method" 4
1112 root 1.1 .IX Item "5.3: Screen-selection entry method"
1113     While this is implemented already (it's basically the selection
1114     mechanism), it could be extended by displaying a unicode character map.
1115 root 1.7 .IP "* 5.4: Feedback method for identifying displayed characters for later input" 4
1116 root 1.1 .IX Item "5.4: Feedback method for identifying displayed characters for later input"
1117     This method lets you display the unicode character code associated with
1118     characters already displayed.
1119     .Sp
1120     You enter this mode by holding down \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then
1121     pressing and holding the left mouse button and moving around. The unicode
1122     hex code(s) (it might be a combining character) of the character under the
1123     pointer is displayed until you release \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR.
1124     .Sp
1125     In addition to the hex codes it will display the font used to draw this
1126     character \- due to implementation reasons, characters combined with
1127     combining characters, line drawing characters and unknown characters will
1128     always be drawn using the built-in support font.
1129     .PP
1130     With respect to conformance, rxvt-unicode is supposed to be compliant to
1131     both scenario A and B of \s-1ISO\s0 14755, including part 5.2.
1132     .SH "LOGIN STAMP"
1133     .IX Header "LOGIN STAMP"
1134 root 1.7 \&\fB@@RXVT_NAME@@\fR tries to write an entry into the \fIutmp\fR(5) file so that
1135     it can be seen via the \fI\fIwho\fI\|(1)\fR command, and can accept messages. To
1136     allow this feature, \fB@@RXVT_NAME@@\fR may need to be installed setuid root
1137     on some systems or setgid to root or to some other group on others.
1138 root 1.1 .SH "COLORS AND GRAPHICS"
1139     .IX Header "COLORS AND GRAPHICS"
1140     In addition to the default foreground and background colours,
1141     \&\fB@@RXVT_NAME@@\fR can display up to 16 colours (8 \s-1ANSI\s0 colours plus
1142     high-intensity bold/blink versions of the same). Here is a list of the
1143     colours with their \fBrgb.txt\fR names.
1144     .TS
1145     l l l .
1146     color0 (black) = Black
1147     color1 (red) = Red3
1148     color2 (green) = Green3
1149     color3 (yellow) = Yellow3
1150     color4 (blue) = Blue3
1151     color5 (magenta) = Magenta3
1152     color6 (cyan) = Cyan3
1153     color7 (white) = AntiqueWhite
1154     color8 (bright black) = Grey25
1155     color9 (bright red) = Red
1156     color10 (bright green) = Green
1157     color11 (bright yellow) = Yellow
1158     color12 (bright blue) = Blue
1159     color13 (bright magenta) = Magenta
1160     color14 (bright cyan) = Cyan
1161     color15 (bright white) = White
1162     foreground = Black
1163     background = White
1164     .TE
1165    
1166     .PP
1167     It is also possible to specify the colour values of \fBforeground\fR,
1168     \&\fBbackground\fR, \fBcursorColor\fR, \fBcursorColor2\fR, \fBcolorBD\fR, \fBcolorUL\fR as
1169     a number 0\-15, as a convenient shorthand to reference the colour name of
1170     color0\-color15.
1171     .PP
1172     Note that \fB\-rv\fR (\fB\*(L"reverseVideo: True\*(R"\fR) simulates reverse video by
1173     always swapping the foreground/background colours. This is in contrast to
1174     \&\fIxterm\fR(1) where the colours are only swapped if they have not otherwise
1175     been specified. For example,
1176     .IP "\fB@@RXVT_NAME@@ \-fg Black \-bg White \-rv\fR" 4
1177     .IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv"
1178     would yield White on Black, while on \fIxterm\fR(1) it would yield Black
1179     on White.
1180     .SH "ENVIRONMENT"
1181     .IX Header "ENVIRONMENT"
1182 root 1.12 \&\fB@@RXVT_NAME@@\fR sets and/or uses the following environment variables:
1183     .IP "\fB\s-1TERM\s0\fR" 4
1184     .IX Item "TERM"
1185     Normally set to \f(CW\*(C`rxvt\-unicode\*(C'\fR, unless overwritten at configure time, via
1186     resources or on the commandline.
1187     .IP "\fB\s-1COLORTERM\s0\fR" 4
1188     .IX Item "COLORTERM"
1189     Either \f(CW\*(C`rxvt\*(C'\fR, \f(CW\*(C`rxvt\-xpm\*(C'\fR, depending on wether @@RXVT_NAME@@ was
1190     compiled with \s-1XPM\s0 support, and optionally with the added extension
1191     \&\f(CW\*(C`\-mono\*(C'\fR to indicate that rxvt-unicode runs on a monochrome screen.
1192     .IP "\fB\s-1COLORFGBG\s0\fR" 4
1193     .IX Item "COLORFGBG"
1194     Set to a string of the form \f(CW\*(C`fg;bg\*(C'\fR or \f(CW\*(C`fg;xpm;bg\*(C'\fR, where \f(CW\*(C`fg\*(C'\fR is
1195     the colour code used as default foreground/text colour (or the string
1196     \&\f(CW\*(C`default\*(C'\fR to indicate that the default-colour escape sequence is to be
1197     used), \f(CW\*(C`bg\*(C'\fR is the colour code used as default background colour (or the
1198     string \f(CW\*(C`default\*(C'\fR), and \f(CW\*(C`xpm\*(C'\fR is the string \f(CW\*(C`default\*(C'\fR if @@RXVT_NAME@@
1199 root 1.13 was compiled with \s-1XPM\s0 support. Libraries like \f(CW\*(C`ncurses\*(C'\fR and \f(CW\*(C`slang\*(C'\fR can
1200     (and do) use this information to optimize screen output.
1201 root 1.12 .IP "\fB\s-1WINDOWID\s0\fR" 4
1202     .IX Item "WINDOWID"
1203     Set to the (decimal) X Window \s-1ID\s0 of the @@RXVT_NAME@@ window (the toplevel
1204     window, which usually has subwindows for the scrollbar, the terminal
1205     window and so on).
1206     .IP "\fB\s-1TERMINFO\s0\fR" 4
1207     .IX Item "TERMINFO"
1208     Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1209     \&\f(CW\*(C`\-\-with\-terminfo=PATH\*(C'\fR.
1210     .IP "\fB\s-1DISPLAY\s0\fR" 4
1211     .IX Item "DISPLAY"
1212     Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1213     display in it's child processes.
1214     .IP "\fB\s-1SHELL\s0\fR" 4
1215     .IX Item "SHELL"
1216     The shell to be used for command execution, defaults to \f(CW\*(C`/bin/sh\*(C'\fR.
1217     .IP "\fB\s-1RXVTPATH\s0\fR" 4
1218     .IX Item "RXVTPATH"
1219     The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1220     files.
1221     .IP "\fB\s-1PATH\s0\fR" 4
1222     .IX Item "PATH"
1223     Used in the same way as \f(CW\*(C`RXVTPATH\*(C'\fR.
1224     .IP "\fB\s-1RXVT_SOCKET\s0\fR" 4
1225     .IX Item "RXVT_SOCKET"
1226     The unix domain socket path used by @@RXVT_NAME@@c(1) and
1227     @@RXVT_NAME@@d(1).
1228     .Sp
1229     Default \f(CW\*(C`$HOME/.rxvt\-unicode\-<nodename\*(C'\fR.
1230     .IP "\fB\s-1HOME\s0\fR" 4
1231     .IX Item "HOME"
1232     Used to locate the default directory for the unix domain socket for
1233     daemon communications and to locate various resource files (such as
1234     \&\f(CW\*(C`.Xdefaults\*(C'\fR)
1235     .IP "\fB\s-1XAPPLRESDIR\s0\fR" 4
1236     .IX Item "XAPPLRESDIR"
1237     Directory where various X resource files are being located.
1238     .IP "\fB\s-1XENVIRONMENT\s0\fR" 4
1239     .IX Item "XENVIRONMENT"
1240     If set and accessible, gives the name of a X resource file to be loaded by
1241     @@RXVT_NAME@@.
1242 root 1.1 .SH "FILES"
1243     .IX Header "FILES"
1244     .IP "\fB/usr/lib/X11/rgb.txt\fR" 4
1245     .IX Item "/usr/lib/X11/rgb.txt"
1246     Color names.
1247     .SH "SEE ALSO"
1248     .IX Header "SEE ALSO"
1249     @@RXVT_NAME@@(7), \fIxterm\fR\|(1), \fIsh\fR\|(1), \fIresize\fR\|(1), X(1), \fIpty\fR\|(4), \fItty\fR\|(4), \fIutmp\fR\|(5)
1250     .SH "BUGS"
1251     .IX Header "BUGS"
1252     Check the \s-1BUGS\s0 file for an up-to-date list.
1253     .PP
1254     Cursor change support is not yet implemented.
1255     .PP
1256     Click-and-drag doesn't work with X11 mouse report overriding.
1257     .SH "CURRENT PROJECT COORDINATOR"
1258     .IX Header "CURRENT PROJECT COORDINATOR"
1259     .IP "Project Coordinator" 4
1260     .IX Item "Project Coordinator"
1261 root 1.14 Marc A. Lehmann <rxvt\-unicode@schmorp.de>
1262 root 1.1 .Sp
1263 root 1.14 <http://software.schmorp.de/#rxvt\-unicode>
1264 root 1.1 .SH "AUTHORS"
1265     .IX Header "AUTHORS"
1266     .IP "John Bovey" 4
1267     .IX Item "John Bovey"
1268     University of Kent, 1992, wrote the original Xvt.
1269     .IP "Rob Nation <nation@rocket.sanders.lockheed.com>" 4
1270     .IX Item "Rob Nation <nation@rocket.sanders.lockheed.com>"
1271     very heavily modified Xvt and came up with Rxvt
1272     .IP "Angelo Haritsis <ah@doc.ic.ac.uk>" 4
1273     .IX Item "Angelo Haritsis <ah@doc.ic.ac.uk>"
1274     wrote the Greek Keyboard Input (no longer in code)
1275     .IP "mj olesen <olesen@me.QueensU.CA>" 4
1276     .IX Item "mj olesen <olesen@me.QueensU.CA>"
1277     Wrote the menu system.
1278     .Sp
1279     Project Coordinator (changes.txt 2.11 to 2.21)
1280     .IP "Oezguer Kesim <kesim@math.fu\-berlin.de>" 4
1281     .IX Item "Oezguer Kesim <kesim@math.fu-berlin.de>"
1282     Project Coordinator (changes.txt 2.21a to 2.4.5)
1283     .IP "Geoff Wing <gcw@pobox.com>" 4
1284     .IX Item "Geoff Wing <gcw@pobox.com>"
1285     Rewrote screen display and text selection routines. Project Coordinator
1286     (changes.txt 2.4.6 \- rxvt\-unicode)
1287 root 1.14 .IP "Marc Alexander Lehmann <rxvt\-unicode@schmorp.de>" 4
1288     .IX Item "Marc Alexander Lehmann <rxvt-unicode@schmorp.de>"
1289 root 1.1 Forked rxvt\-unicode, rewrote most of the display code and internal
1290     character handling to store text in unicode, improve xterm
1291     compatibility and apply numerous other bugfixes and extensions.
1292     .Sp
1293     Project Coordinator (Changes 1.0 \-)