ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.man.in
Revision: 1.59
Committed: Tue Feb 21 01:00:40 2006 UTC (18 years, 3 months ago) by root
Branch: MAIN
CVS Tags: rel-7_7
Changes since 1.58: +2 -2 lines
Log Message:
*** empty log message ***

File Contents

# User Rev Content
1 root 1.59 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
2 root 1.1 .\"
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.59 .TH rxvt 1 "2006-02-21" "7.6" "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 root 1.53 .IP "\fB\-depth\fR \fIbitdepth\fR" 4
220     .IX Item "-depth bitdepth"
221 root 1.56 Compile \fIxft\fR: Attempt to find a visual with the given bit depth;
222 root 1.53 resource \fBdepth\fR.
223 root 1.1 .IP "\fB\-geometry\fR \fIgeom\fR" 4
224     .IX Item "-geometry geom"
225     Window geometry (\fB\-g\fR still respected); resource \fBgeometry\fR.
226     .IP "\fB\-rv\fR|\fB+rv\fR" 4
227     .IX Item "-rv|+rv"
228     Turn on/off simulated reverse video; resource \fBreverseVideo\fR.
229     .IP "\fB\-j\fR|\fB+j\fR" 4
230     .IX Item "-j|+j"
231     Turn on/off jump scrolling; resource \fBjumpScroll\fR.
232 root 1.25 .IP "\fB\-ip\fR|\fB+ip\fR | \fB\-tr\fR|\fB+tr\fR" 4
233     .IX Item "-ip|+ip | -tr|+tr"
234 root 1.1 Turn on/off inheriting parent window's pixmap. Alternative form is
235     \&\fB\-tr\fR; resource \fBinheritPixmap\fR.
236 root 1.56 .Sp
237     \&\fIPlease note that transparency of any kind if completely unsupported by
238     the author. Don't bug him with installation questions!\fR
239 root 1.1 .IP "\fB\-fade\fR \fInumber\fR" 4
240     .IX Item "-fade number"
241 root 1.25 Fade the text by the given percentage when focus is lost. Small values
242     fade a little only, 100 completely replaces all colours by the fade
243     colour; resource \fBfading\fR.
244     .IP "\fB\-fadecolor\fR \fIcolour\fR" 4
245     .IX Item "-fadecolor colour"
246     Fade to this colour when fading is used (see \fB\-fade\fR). The default colour
247 root 1.56 is opaque black. resource \fBfadeColor\fR.
248 root 1.1 .IP "\fB\-tint\fR \fIcolour\fR" 4
249     .IX Item "-tint colour"
250     Tint the transparent background pixmap with the given colour when
251 root 1.25 transparency is enabled with \fB\-tr\fR or \fB\-ip\fR. This only works for
252     non-tiled backgrounds, currently. See also the \fB\-sh\fR option that can be
253     used to brighten or darken the image in addition to tinting it; resource
254     \&\fItintColor\fR. Example:
255     .Sp
256     .Vb 1
257     \& @@RXVT_NAME@@ -tr -tint blue -sh 40
258     .Ve
259 root 1.1 .IP "\fB\-sh\fR" 4
260     .IX Item "-sh"
261     \&\fInumber\fR Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent
262     background image in addition to tinting it (i.e. \fB\-tint\fR must be
263     specified, too, e.g. \f(CW\*(C`\-tint white\*(C'\fR).
264     .IP "\fB\-bg\fR \fIcolour\fR" 4
265     .IX Item "-bg colour"
266     Window background colour; resource \fBbackground\fR.
267     .IP "\fB\-fg\fR \fIcolour\fR" 4
268     .IX Item "-fg colour"
269     Window foreground colour; resource \fBforeground\fR.
270     .IP "\fB\-pixmap\fR \fIfile[;geom]\fR" 4
271     .IX Item "-pixmap file[;geom]"
272     Compile \fI\s-1XPM\s0\fR: Specify \s-1XPM\s0 file for the background and also optionally
273 root 1.3 specify its scaling with a geometry string. Note you may need to
274     add quotes to avoid special shell interpretation of the \f(CW\*(C`;\*(C'\fR in the
275 root 1.1 command\-line; resource \fBbackgroundPixmap\fR.
276     .IP "\fB\-cr\fR \fIcolour\fR" 4
277     .IX Item "-cr colour"
278     The cursor colour; resource \fBcursorColor\fR.
279     .IP "\fB\-pr\fR \fIcolour\fR" 4
280     .IX Item "-pr colour"
281     The mouse pointer foreground colour; resource \fBpointerColor\fR.
282     .IP "\fB\-pr2\fR \fIcolour\fR" 4
283     .IX Item "-pr2 colour"
284     The mouse pointer background colour; resource \fBpointerColor2\fR.
285     .IP "\fB\-bd\fR \fIcolour\fR" 4
286     .IX Item "-bd colour"
287     The colour of the border around the text area and between the scrollbar and the text;
288     resource \fBborderColor\fR.
289     .IP "\fB\-fn\fR \fIfontlist\fR" 4
290     .IX Item "-fn fontlist"
291     Select the fonts to be used. This is a comma separated list of font names
292 root 1.46 that are checked in order when trying to find glyphs for characters. The
293 root 1.1 first font defines the cell size for characters; other fonts might be
294     smaller, but not (in general) larger. A (hopefully) reasonable default
295     font list is always appended to it. See resource \fBfont\fR for more details.
296     .Sp
297     In short, to specify an X11 core font, just specify it's name or prefix it
298     with \f(CW\*(C`x:\*(C'\fR. To specify an XFT\-font, you need to prefix it with \f(CW\*(C`xft:\*(C'\fR,
299     e.g.:
300     .Sp
301     .Vb 2
302     \& @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
303     \& @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
304     .Ve
305     .Sp
306     See also the question \*(L"How does rxvt-unicode choose fonts?\*(R" in the \s-1FAQ\s0
307     section of @@RXVT_NAME@@(7).
308     .IP "\fB\-fb\fR \fIfontlist\fR" 4
309     .IX Item "-fb fontlist"
310 root 1.37 Compile \fIfont-styles\fR: The bold font list to use when \fBbold\fR characters
311     are to be printed. See resource \fBboldFont\fR for details.
312 root 1.1 .IP "\fB\-fi\fR \fIfontlist\fR" 4
313     .IX Item "-fi fontlist"
314 root 1.37 Compile \fIfont-styles\fR: The italic font list to use when \fIitalic\fR
315     characters are to be printed. See resource \fBitalicFont\fR for details.
316 root 1.1 .IP "\fB\-fbi\fR \fIfontlist\fR" 4
317     .IX Item "-fbi fontlist"
318 root 1.37 Compile \fIfont-styles\fR: The bold italic font list to use when \fB\f(BIbold
319 root 1.35 italic\fB\fR characters are to be printed. See resource \fBboldItalicFont\fR
320     for details.
321 root 1.30 .IP "\fB\-is\fR|\fB+is\fR" 4
322     .IX Item "-is|+is"
323 root 1.37 Compile \fIfont-styles\fR: Bold/Italic font styles imply high intensity
324 root 1.30 foreground/background (default). See resource \fBintensityStyles\fR for
325     details.
326 root 1.1 .IP "\fB\-name\fR \fIname\fR" 4
327     .IX Item "-name name"
328     Specify the application name under which resources are to be obtained,
329     rather than the default executable file name. Name should not contain
330     `.' or `*' characters. Also sets the icon and title name.
331     .IP "\fB\-ls\fR|\fB+ls\fR" 4
332     .IX Item "-ls|+ls"
333     Start as a login\-shell/sub\-shell; resource \fBloginShell\fR.
334     .IP "\fB\-ut\fR|\fB+ut\fR" 4
335     .IX Item "-ut|+ut"
336     Compile \fIutmp\fR: Inhibit/enable writing a utmp entry; resource
337     \&\fButmpInhibit\fR.
338     .IP "\fB\-vb\fR|\fB+vb\fR" 4
339     .IX Item "-vb|+vb"
340     Turn on/off visual bell on receipt of a bell character; resource
341     \&\fBvisualBell\fR.
342     .IP "\fB\-sb\fR|\fB+sb\fR" 4
343     .IX Item "-sb|+sb"
344     Turn on/off scrollbar; resource \fBscrollBar\fR.
345     .IP "\fB\-si\fR|\fB+si\fR" 4
346     .IX Item "-si|+si"
347     Turn on/off scroll-to-bottom on \s-1TTY\s0 output inhibit; resource
348     \&\fBscrollTtyOutput\fR has opposite effect.
349     .IP "\fB\-sk\fR|\fB+sk\fR" 4
350     .IX Item "-sk|+sk"
351     Turn on/off scroll-to-bottom on keypress; resource
352     \&\fBscrollTtyKeypress\fR.
353     .IP "\fB\-sw\fR|\fB+sw\fR" 4
354     .IX Item "-sw|+sw"
355     Turn on/off scrolling with the scrollback buffer as new lines appear.
356     This only takes effect if \fB\-si\fR is also given; resource
357     \&\fBscrollWithBuffer\fR.
358     .IP "\fB\-sr\fR|\fB+sr\fR" 4
359     .IX Item "-sr|+sr"
360     Put scrollbar on right/left; resource \fBscrollBar_right\fR.
361     .IP "\fB\-st\fR|\fB+st\fR" 4
362     .IX Item "-st|+st"
363 root 1.23 Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
364 root 1.1 resource \fBscrollBar_floating\fR.
365     .IP "\fB\-ptab\fR|\fB+ptab\fR" 4
366     .IX Item "-ptab|+ptab"
367     If enabled (default), \*(L"Horizontal Tab\*(R" characters are being stored as
368     actual wide characters in the screen buffer, which makes it possible to
369     select and paste them. Since a horizontal tab is a cursor movement and
370     not an actual glyph, this can sometimes be visually annoying as the cursor
371     on a tab character is displayed as a wide cursor; resource \fBpastableTabs\fR.
372     .IP "\fB\-bc\fR|\fB+bc\fR" 4
373     .IX Item "-bc|+bc"
374     Blink the cursor; resource \fBcursorBlink\fR.
375     .IP "\fB\-iconic\fR" 4
376     .IX Item "-iconic"
377     Start iconified, if the window manager supports that option.
378     Alternative form is \fB\-ic\fR.
379     .IP "\fB\-sl\fR \fInumber\fR" 4
380     .IX Item "-sl number"
381     Save \fInumber\fR lines in the scrollback buffer. See resource entry for
382     limits; resource \fBsaveLines\fR.
383     .IP "\fB\-b\fR \fInumber\fR" 4
384     .IX Item "-b number"
385     Compile \fIfrills\fR: Internal border of \fInumber\fR pixels. See resource
386     entry for limits; resource \fBinternalBorder\fR.
387     .IP "\fB\-w\fR \fInumber\fR" 4
388     .IX Item "-w number"
389     Compile \fIfrills\fR: External border of \fInumber\fR pixels. Also, \fB\-bw\fR
390     and \fB\-borderwidth\fR. See resource entry for limits; resource
391     \&\fBexternalBorder\fR.
392     .IP "\fB\-bl\fR" 4
393     .IX Item "-bl"
394     Compile \fIfrills\fR: Set \s-1MWM\s0 hints to request a borderless window, i.e.
395     if honoured by the \s-1WM\s0, the rxvt-unicode window will not have window
396     decorations; resource \fBborderLess\fR.
397 root 1.49 .IP "\fB\-override\-redirect\fR" 4
398     .IX Item "-override-redirect"
399     Compile \fIfrills\fR: Sets override-redirect on the window; resource
400     \&\fBoverride-redirect\fR.
401 root 1.37 .IP "\fB\-sbg\fR" 4
402     .IX Item "-sbg"
403     Compile \fIfrills\fR: Disable the usage of the built-in block graphics/line
404     drawing characters and just rely on what the specified fonts provide. Use
405     this if you have a good font and want to use its block graphic glyphs;
406     resource \fBskipBuiltinGlyphs\fR.
407 root 1.1 .IP "\fB\-lsp\fR \fInumber\fR" 4
408     .IX Item "-lsp number"
409     Compile \fIfrills\fR: Lines (pixel height) to insert between each row of
410     the display. Useful to work around font rendering problems; resource
411     \&\fBlinespace\fR.
412     .IP "\fB\-tn\fR \fItermname\fR" 4
413     .IX Item "-tn termname"
414     This option specifies the name of the terminal type to be set in the
415     \&\fB\s-1TERM\s0\fR environment variable. This terminal type must exist in the
416     \&\fI\fItermcap\fI\|(5)\fR database and should have \fIli#\fR and \fIco#\fR entries;
417     resource \fBtermName\fR.
418     .IP "\fB\-e\fR \fIcommand [arguments]\fR" 4
419     .IX Item "-e command [arguments]"
420     Run the command with its command-line arguments in the \fB@@RXVT_NAME@@\fR
421     window; also sets the window title and icon name to be the basename of
422     the program being executed if neither \fI\-title\fR (\fI\-T\fR) nor \fI\-n\fR are
423     given on the command line. If this option is used, it must be the last
424     on the command\-line. If there is no \fB\-e\fR option then the default is to
425     run the program specified by the \fB\s-1SHELL\s0\fR environment variable or,
426     failing that, \fI\fIsh\fI\|(1)\fR.
427 root 1.28 .Sp
428     Please note that you must specify a program with arguments. If you want to
429     run shell commands, you have to specify the shell, like this:
430     .Sp
431     .Vb 1
432     \& @@RXVT_NAME@@ -e sh -c "shell commands"
433     .Ve
434 root 1.1 .IP "\fB\-title\fR \fItext\fR" 4
435     .IX Item "-title text"
436     Window title (\fB\-T\fR still respected); the default title is the basename
437     of the program specified after the \fB\-e\fR option, if any, otherwise the
438     application name; resource \fBtitle\fR.
439     .IP "\fB\-n\fR \fItext\fR" 4
440     .IX Item "-n text"
441     Icon name; the default name is the basename of the program specified
442     after the \fB\-e\fR option, if any, otherwise the application name;
443     resource \fBiconName\fR.
444     .IP "\fB\-C\fR" 4
445     .IX Item "-C"
446     Capture system console messages.
447     .IP "\fB\-pt\fR \fIstyle\fR" 4
448     .IX Item "-pt style"
449     Compile \fI\s-1XIM\s0\fR: input style for input method; \fBOverTheSpot\fR,
450     \&\fBOffTheSpot\fR, \fBRoot\fR; resource \fBpreeditType\fR.
451     .IP "\fB\-im\fR \fItext\fR" 4
452     .IX Item "-im text"
453     Compile \fI\s-1XIM\s0\fR: input method name. resource \fBinputMethod\fR.
454     .IP "\fB\-imlocale\fR \fIstring\fR" 4
455     .IX Item "-imlocale string"
456 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.
457     \&\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
458     input extension to be able to input japanese characters while staying in
459     another locale. resource \fBimLocale\fR.
460     .IP "\fB\-imfont\fR \fIfontset\fR" 4
461     .IX Item "-imfont fontset"
462     Set the font set to use for the X Input Method, see resource \fBimFont\fR
463     for more info.
464     .IP "\fB\-tcw\fR" 4
465     .IX Item "-tcw"
466     Change the meaning of triple-click selection with the left mouse
467     button. Instead of selecting a full line it will extend the selection the
468     end of the logical line only. resource \fBtripleclickwords\fR.
469 root 1.1 .IP "\fB\-insecure\fR" 4
470     .IX Item "-insecure"
471     Enable \*(L"insecure\*(R" mode, which currently enables most of the escape
472     sequences that echo strings. See the resource \fBinsecure\fR for more
473     info.
474     .IP "\fB\-mod\fR \fImodifier\fR" 4
475     .IX Item "-mod modifier"
476     Override detection of Meta modifier with specified key: \fBalt\fR,
477     \&\fBmeta\fR, \fBhyper\fR, \fBsuper\fR, \fBmod1\fR, \fBmod2\fR, \fBmod3\fR, \fBmod4\fR,
478     \&\fBmod5\fR; resource \fImodifier\fR.
479     .IP "\fB\-ssc\fR|\fB+ssc\fR" 4
480     .IX Item "-ssc|+ssc"
481     Turn on/off secondary screen (default enabled); resource
482     \&\fBsecondaryScreen\fR.
483     .IP "\fB\-ssr\fR|\fB+ssr\fR" 4
484     .IX Item "-ssr|+ssr"
485     Turn on/off secondary screen scroll (default enabled); resource
486     \&\fBsecondaryScroll\fR.
487 root 1.28 .IP "\fB\-hold\fR|\fB+hold\fR" 4
488     .IX Item "-hold|+hold"
489     Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
490     will not immediately destroy its window when the program executed within
491     it exits. Instead, it will wait till it is being killed or closed by the
492     user; resource \fBhold\fR.
493 root 1.18 .IP "\fB\-keysym.\fR\fIsym\fR \fIstring\fR" 4
494     .IX Item "-keysym.sym string"
495 root 1.12 Remap a key symbol. See resource \fBkeysym\fR.
496 root 1.18 .IP "\fB\-embed\fR \fIwindowid\fR" 4
497     .IX Item "-embed windowid"
498 root 1.15 Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
499     which enables applications to easily embed a terminal.
500     .Sp
501     Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
502     shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
503     quite a bit, so don't expect it to keep some specific state. It's best to
504     create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
505     .Sp
506 root 1.16 The window will not be destroyed when @@RXVT_NAME@@ exits.
507     .Sp
508 root 1.15 It might be useful to know that @@RXVT_NAME@@ will not close file
509     descriptors passed to it (except for stdin/out/err, of course), so you
510     can use file descriptors to communicate with the programs within the
511     terminal. This works regardless of wether the \f(CW\*(C`\-embed\*(C'\fR option was used or
512     not.
513 root 1.18 .Sp
514     Here is a short Gtk2\-perl snippet that illustrates how this option can be
515     used (a longer example is in \fIdoc/embed\fR):
516     .Sp
517 root 1.20 .Vb 5
518     \& my $rxvt = new Gtk2::Socket;
519     \& $rxvt->signal_connect_after (realize => sub {
520     \& my $xid = $_[0]->window->get_xid;
521     \& system "@@RXVT_NAME@@ -embed $xid &";
522     \& });
523 root 1.18 .Ve
524 root 1.38 .IP "\fB\-pty\-fd\fR \fIfile descriptor\fR" 4
525     .IX Item "-pty-fd file descriptor"
526 root 1.18 Tells @@RXVT_NAME@@ \s-1NOT\s0 to execute any commands or create a new pty/tty
527     pair but instead use the given filehandle as the tty master. This is
528     useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
529     without having to run a program within it.
530     .Sp
531     If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
532     entries and will not tinker with pty/tty permissions \- you have to do that
533     yourself if you want that.
534     .Sp
535 root 1.38 As an extremely special case, specifying \f(CW\*(C`\-1\*(C'\fR will completely suppress
536     pty/tty operations.
537     .Sp
538 root 1.18 Here is a example in perl that illustrates how this option can be used (a
539     longer example is in \fIdoc/pty\-fd\fR):
540     .Sp
541     .Vb 2
542     \& use IO::Pty;
543     \& use Fcntl;
544     .Ve
545     .Sp
546 root 1.19 .Vb 4
547 root 1.18 \& my $pty = new IO::Pty;
548     \& fcntl $pty, F_SETFD, 0; # clear close-on-exec
549     \& system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
550 root 1.19 \& close $pty;
551 root 1.18 .Ve
552     .Sp
553     .Vb 3
554     \& # now communicate with rxvt
555     \& my $slave = $pty->slave;
556     \& while (<$slave>) { print $slave "got <$_>\en" }
557     .Ve
558 root 1.32 .IP "\fB\-pe\fR \fIstring\fR" 4
559     .IX Item "-pe string"
560 root 1.39 Comma-separated list of perl extension scripts to use (or not to use) in
561     this terminal instance. See resource \fBperl-ext\fR for details.
562 root 1.1 .SH "RESOURCES (available also as long\-options)"
563     .IX Header "RESOURCES (available also as long-options)"
564     Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long
565     options) compiled into your version.
566     .PP
567 root 1.43 You can set and change the resources using X11 tools like \fBxrdb\fR. Many
568     distribution do also load settings from the \fB~/.Xresources\fR file when X
569     starts. @@RXVT_NAME@@ will consult the following files/resources in order,
570     with later settings overwriting earlier ones:
571 root 1.12 .PP
572     .Vb 5
573     \& 1. system-wide app-defaults file, either locale-dependent OR global
574     \& 2. app-defaults file in $XAPPLRESDIR
575     \& 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
576     \& 4. SCREEN_RESOURCES for the current screen
577     \& 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
578     .Ve
579 root 1.1 .PP
580 root 1.43 Note that when reading X resources, \fB@@RXVT_NAME@@\fR recognizes two class
581     names: \fBRxvt\fR and \fBURxvt\fR. The class name \fBRxvt\fR allows resources
582     common to both \fB@@RXVT_NAME@@\fR and the original \fIrxvt\fR to be easily
583     configured, while the class name \fBURxvt\fR allows resources unique to
584     \&\fB@@RXVT_NAME@@\fR, to be shared between different \fB@@RXVT_NAME@@\fR
585     configurations. If no resources are specified, suitable defaults will
586     be used. Command-line arguments can be used to override resource
587     settings. The following resources are supported (you might want to
588     check the @@RXVT_NAME@@\fIperl\fR\|(3) manpage for additional settings by perl
589     extensions not documented here):
590 root 1.53 .IP "\fBdepth:\fR \fIbitdepth\fR" 4
591     .IX Item "depth: bitdepth"
592 root 1.56 Compile \fIxft\fR: Attempt to find a visual with the given bit depth;
593 root 1.53 option \fB\-depth\fR.
594 root 1.1 .IP "\fBgeometry:\fR \fIgeom\fR" 4
595     .IX Item "geometry: geom"
596     Create the window with the specified X window geometry [default 80x24];
597     option \fB\-geometry\fR.
598     .IP "\fBbackground:\fR \fIcolour\fR" 4
599     .IX Item "background: colour"
600     Use the specified colour as the window's background colour [default
601     White]; option \fB\-bg\fR.
602     .IP "\fBforeground:\fR \fIcolour\fR" 4
603     .IX Item "foreground: colour"
604     Use the specified colour as the window's foreground colour [default
605     Black]; option \fB\-fg\fR.
606     .IP "\fBcolor\fR\fIn\fR\fB:\fR \fIcolour\fR" 4
607     .IX Item "colorn: colour"
608     Use the specified colour for the colour value \fIn\fR, where 0\-7
609     corresponds to low-intensity (normal) colours and 8\-15 corresponds to
610     high-intensity (bold = bright foreground, blink = bright background)
611     colours. The canonical names are as follows: 0=black, 1=red, 2=green,
612     3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
613     names used are listed in the \fB\s-1COLORS\s0 \s-1AND\s0 \s-1GRAPHICS\s0\fR section.
614     .Sp
615     Colours higher than 15 cannot be set using resources (yet), but can be
616     changed using an escape command (see @@RXVT_NAME@@(7)).
617     .Sp
618     Colours 16\-79 form a standard 4x4x4 colour cube (the same as xterm with
619     88 colour support). Colours 80\-87 are evenly spaces grey steps.
620     .IP "\fBcolorBD:\fR \fIcolour\fR" 4
621     .IX Item "colorBD: colour"
622     .PD 0
623     .IP "\fBcolorIT:\fR \fIcolour\fR" 4
624     .IX Item "colorIT: colour"
625     .PD
626     Use the specified colour to display bold or italic characters when the
627     foreground colour is the default. If font styles are not available
628 root 1.3 (Compile \fIstyles\fR) and this option is unset, reverse video is used instead.
629 root 1.1 .IP "\fBcolorUL:\fR \fIcolour\fR" 4
630     .IX Item "colorUL: colour"
631     Use the specified colour to display underlined characters when the
632     foreground colour is the default.
633     .IP "\fBcolorRV:\fR \fIcolour\fR" 4
634     .IX Item "colorRV: colour"
635     Use the specified colour as the background for reverse video
636     characters.
637     .IP "\fBunderlineColor:\fR \fIcolour\fR" 4
638     .IX Item "underlineColor: colour"
639     If set, use the specified colour as the colour for the underline
640     itself. If unset, use the foreground colour.
641     .IP "\fBcursorColor:\fR \fIcolour\fR" 4
642     .IX Item "cursorColor: colour"
643     Use the specified colour for the cursor. The default is to use the
644     foreground colour; option \fB\-cr\fR.
645     .IP "\fBcursorColor2:\fR \fIcolour\fR" 4
646     .IX Item "cursorColor2: colour"
647     Use the specified colour for the colour of the cursor text. For this to
648     take effect, \fBcursorColor\fR must also be specified. The default is to
649     use the background colour.
650     .IP "\fBreverseVideo:\fR \fIboolean\fR" 4
651     .IX Item "reverseVideo: boolean"
652     \&\fBTrue\fR: simulate reverse video by foreground and background colours;
653     option \fB\-rv\fR. \fBFalse\fR: regular screen colours [default]; option
654     \&\fB+rv\fR. See note in \fB\s-1COLORS\s0 \s-1AND\s0 \s-1GRAPHICS\s0\fR section.
655     .IP "\fBjumpScroll:\fR \fIboolean\fR" 4
656     .IX Item "jumpScroll: boolean"
657     \&\fBTrue\fR: specify that jump scrolling should be used. When scrolling
658     quickly, fewer screen updates are performed [default]; option \fB\-j\fR.
659     \&\fBFalse\fR: specify that smooth scrolling should be used; option \fB+j\fR.
660     .IP "\fBinheritPixmap:\fR \fIboolean\fR" 4
661     .IX Item "inheritPixmap: boolean"
662     \&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving
663     artificial transparency. \fBFalse\fR: do not inherit the parent windows'
664     pixmap.
665 root 1.56 .Sp
666     \&\fIPlease note that transparency of any kind if completely unsupported by
667     the author. Don't bug him with installation questions!\fR
668 root 1.1 .IP "\fBfading:\fR \fInumber\fR" 4
669     .IX Item "fading: number"
670 root 1.25 Fade the text by the given percentage when focus is lost; option \fB\-fade\fR.
671     .IP "\fBfadeColor:\fR \fIcolour\fR" 4
672     .IX Item "fadeColor: colour"
673     Fade to this colour, when fading is used (see \fBfading:\fR). The default
674     colour is black; option \fB\-fadecolor\fR.
675 root 1.1 .IP "\fBtintColor:\fR \fIcolour\fR" 4
676     .IX Item "tintColor: colour"
677 root 1.25 Tint the transparent background pixmap with the given colour; option
678     \&\fB\-tint\fR.
679 root 1.1 .IP "\fBshading:\fR \fInumber\fR" 4
680     .IX Item "shading: number"
681     Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background
682     image in addition to tinting it.
683     .IP "\fBscrollColor:\fR \fIcolour\fR" 4
684     .IX Item "scrollColor: colour"
685     Use the specified colour for the scrollbar [default #B2B2B2].
686     .IP "\fBtroughColor:\fR \fIcolour\fR" 4
687     .IX Item "troughColor: colour"
688     Use the specified colour for the scrollbar's trough area [default
689 root 1.23 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
690 root 1.1 .IP "\fBborderColor:\fR \fIcolour\fR" 4
691     .IX Item "borderColor: colour"
692     The colour of the border around the text area and between the scrollbar
693     and the text.
694     .IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4
695     .IX Item "backgroundPixmap: file[;geom]"
696     Use the specified \s-1XPM\s0 file (note the `.xpm' extension is optional) for
697     the background and also optionally specify its scaling with a geometry
698     string \fBWxH+X+Y\fR, in which \fB\*(L"W\*(R" / \*(L"H\*(R"\fR specify the
699     horizontal/vertical scale (percent) and \fB\*(L"X\*(R" / \*(L"Y\*(R"\fR locate the image
700     centre (percent). A scale of 0 displays the image with tiling. A scale
701     of 1 displays the image without any scaling. A scale of 2 to 9
702     specifies an integer number of images in that direction. No image will
703     be magnified beyond 10 times its original size. The maximum permitted
704     scale is 1000. [default 0x0+50+50]
705     .IP "\fBpath:\fR \fIpath\fR" 4
706     .IX Item "path: path"
707 root 1.47 Specify the colon-delimited search path for finding \s-1XPM\s0 files.
708 root 1.1 .IP "\fBfont:\fR \fIfontlist\fR" 4
709     .IX Item "font: fontlist"
710 root 1.46 Select the fonts to be used. This is a comma separated list of font names
711     that are checked in order when trying to find glyphs for characters. The
712     first font defines the cell size for characters; other fonts might be
713     smaller, but not (in general) larger. A (hopefully) reasonable default
714     font list is always appended to it; option \fB\-fn\fR.
715 root 1.1 .Sp
716     Each font can either be a standard X11 core font (\s-1XLFD\s0) name, with
717 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.
718 root 1.1 .Sp
719     In addition, each font can be prefixed with additional hints and
720     specifications enclosed in square brackets (\f(CW\*(C`[]\*(C'\fR). The only available
721     hint currently is \f(CW\*(C`codeset=codeset\-name\*(C'\fR, and this is only used for Xft
722     fonts.
723     .Sp
724     For example, this font resource
725     .Sp
726     .Vb 5
727 root 1.47 \& URxvt.font: 9x15bold,\e
728 root 1.1 \& -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\e
729     \& -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \e
730     \& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e
731     \& xft:Code2000:antialias=false
732     .Ve
733     .Sp
734     specifies five fonts to be used. The first one is \f(CW\*(C`9x15bold\*(C'\fR (actually
735     the iso8859\-1 version of the second font), which is the base font (because
736     it is named first) and thus defines the character cell grid to be 9 pixels
737     wide and 15 pixels high.
738     .Sp
739     The second font is just used to add additional unicode characters not in
740     the base font, likewise the third, which is unfortunately non\-bold, but
741     the bold version of the font does contain less characters, so this is a
742     useful supplement.
743     .Sp
744     The third font is an Xft font with aliasing turned off, and the characters
745     are limited to the \fB\s-1JIS\s0 0208\fR codeset (i.e. japanese kanji). The font
746     contains other characters, but we are not interested in them.
747     .Sp
748     The last font is a useful catch-all font that supplies most of the
749     remaining unicode characters.
750     .IP "\fBboldFont:\fR \fIfontlist\fR" 4
751     .IX Item "boldFont: fontlist"
752     .PD 0
753     .IP "\fBitalicFont:\fR \fIfontlist\fR" 4
754     .IX Item "italicFont: fontlist"
755     .IP "\fBboldItalicFont:\fR \fIfontlist\fR" 4
756     .IX Item "boldItalicFont: fontlist"
757     .PD
758     The font list to use for displaying \fBbold\fR, \fIitalic\fR or \fB\f(BIbold
759     italic\fB\fR characters, respectively.
760     .Sp
761     If specified and non\-empty, then the syntax is the same as for the
762     \&\fBfont\fR\-resource, and the given font list will be used as is, which makes
763     it possible to substitute completely different font styles for bold and
764     italic.
765     .Sp
766     If unset (the default), a suitable font list will be synthesized by
767     \&\*(L"morphing\*(R" the normal text font list into the desired shape. If that is
768     not possible, replacement fonts of the desired shape will be tried.
769     .Sp
770     If set, but empty, then this specific style is disabled and the normal
771     text font will being used for the given style.
772 root 1.30 .IP "\fBintensityStyles:\fR \fIboolean\fR" 4
773     .IX Item "intensityStyles: boolean"
774     When font styles are not enabled, or this option is enabled (\fBTrue\fR,
775     option \fB\-is\fR, the default), bold and italic font styles imply high
776     intensity foreground/backround colours. Disabling this option (\fBFalse\fR,
777     option \fB+is\fR) disables this behaviour, the high intensity colours are not
778     reachable.
779 root 1.1 .IP "\fBselectstyle:\fR \fImode\fR" 4
780     .IX Item "selectstyle: mode"
781     Set mouse selection style to \fBold\fR which is 2.20, \fBoldword\fR which is
782     xterm style with 2.20 old word selection, or anything else which gives
783     xterm style selection.
784     .IP "\fBscrollstyle:\fR \fImode\fR" 4
785     .IX Item "scrollstyle: mode"
786     Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is
787 root 1.23 the author's favourite.
788 root 1.1 .IP "\fBtitle:\fR \fIstring\fR" 4
789     .IX Item "title: string"
790     Set window title string, the default title is the command-line
791     specified after the \fB\-e\fR option, if any, otherwise the application
792     name; option \fB\-title\fR.
793     .IP "\fBiconName:\fR \fIstring\fR" 4
794     .IX Item "iconName: string"
795     Set the name used to label the window's icon or displayed in an icon
796     manager window, it also sets the window's title unless it is explicitly
797     set; option \fB\-n\fR.
798     .IP "\fBmapAlert:\fR \fIboolean\fR" 4
799     .IX Item "mapAlert: boolean"
800     \&\fBTrue\fR: de-iconify (map) on receipt of a bell character. \fBFalse\fR: no
801     de-iconify (map) on receipt of a bell character [default].
802     .IP "\fBvisualBell:\fR \fIboolean\fR" 4
803     .IX Item "visualBell: boolean"
804     \&\fBTrue\fR: use visual bell on receipt of a bell character; option \fB\-vb\fR.
805     \&\fBFalse\fR: no visual bell [default]; option \fB+vb\fR.
806     .IP "\fBloginShell:\fR \fIboolean\fR" 4
807     .IX Item "loginShell: boolean"
808     \&\fBTrue\fR: start as a login shell by prepending a `\-' to \fBargv[0]\fR of
809     the shell; option \fB\-ls\fR. \fBFalse\fR: start as a normal sub-shell
810     [default]; option \fB+ls\fR.
811     .IP "\fButmpInhibit:\fR \fIboolean\fR" 4
812     .IX Item "utmpInhibit: boolean"
813     \&\fBTrue\fR: inhibit writing record into the system log file \fButmp\fR;
814     option \fB\-ut\fR. \fBFalse\fR: write record into the system log file \fButmp\fR
815     [default]; option \fB+ut\fR.
816     .IP "\fBprint\-pipe:\fR \fIstring\fR" 4
817     .IX Item "print-pipe: string"
818     Specify a command pipe for vt100 printer [default \fI\fIlpr\fI\|(1)\fR]. Use
819     \&\fBPrint\fR to initiate a screen dump to the printer and \fBCtrl-Print\fR or
820     \&\fBShift-Print\fR to include the scrollback as well.
821 root 1.24 .Sp
822     The string will be interpreted as if typed into the shell as\-is.
823     .Sp
824     Example:
825     .Sp
826     .Vb 1
827 root 1.47 \& URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
828 root 1.24 .Ve
829     .Sp
830     This creates a new file in your home directory with the screen contents
831     everytime you hit \f(CW\*(C`Print\*(C'\fR.
832 root 1.1 .IP "\fBscrollBar:\fR \fIboolean\fR" 4
833     .IX Item "scrollBar: boolean"
834     \&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR:
835     disable the scrollbar; option \fB+sb\fR.
836     .IP "\fBscrollBar_right:\fR \fIboolean\fR" 4
837     .IX Item "scrollBar_right: boolean"
838     \&\fBTrue\fR: place the scrollbar on the right of the window; option \fB\-sr\fR.
839     \&\fBFalse\fR: place the scrollbar on the left of the window; option \fB+sr\fR.
840     .IP "\fBscrollBar_floating:\fR \fIboolean\fR" 4
841     .IX Item "scrollBar_floating: boolean"
842     \&\fBTrue\fR: display an rxvt scrollbar without a trough; option \fB\-st\fR.
843     \&\fBFalse\fR: display an rxvt scrollbar with a trough; option \fB+st\fR.
844     .IP "\fBscrollBar_align:\fR \fImode\fR" 4
845     .IX Item "scrollBar_align: mode"
846     Align the \fBtop\fR, \fBbottom\fR or \fBcentre\fR [default] of the scrollbar
847     thumb with the pointer on middle button press/drag.
848     .IP "\fBscrollTtyOutput:\fR \fIboolean\fR" 4
849     .IX Item "scrollTtyOutput: boolean"
850     \&\fBTrue\fR: scroll to bottom when tty receives output; option \fB\-si\fR.
851     \&\fBFalse\fR: do not scroll to bottom when tty receives output; option
852     \&\fB+si\fR.
853     .IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4
854     .IX Item "scrollWithBuffer: boolean"
855     \&\fBTrue\fR: scroll with scrollback buffer when tty receives new lines (and
856 root 1.17 \&\fBscrollTtyOutput\fR is False); option \fB\-sw\fR. \fBFalse\fR: do not scroll
857     with scrollback buffer when tty recieves new lines; option \fB+sw\fR.
858 root 1.1 .IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4
859     .IX Item "scrollTtyKeypress: boolean"
860     \&\fBTrue\fR: scroll to bottom when a non-special key is pressed. Special keys
861     are those which are intercepted by rxvt-unicode for special handling and
862     are not passed onto the shell; option \fB\-sk\fR. \fBFalse\fR: do not scroll to
863     bottom when a non-special key is pressed; option \fB+sk\fR.
864     .IP "\fBsaveLines:\fR \fInumber\fR" 4
865     .IX Item "saveLines: number"
866     Save \fInumber\fR lines in the scrollback buffer [default 64]. This
867     resource is limited on most machines to 65535; option \fB\-sl\fR.
868     .IP "\fBinternalBorder:\fR \fInumber\fR" 4
869     .IX Item "internalBorder: number"
870     Internal border of \fInumber\fR pixels. This resource is limited to 100;
871     option \fB\-b\fR.
872     .IP "\fBexternalBorder:\fR \fInumber\fR" 4
873     .IX Item "externalBorder: number"
874     External border of \fInumber\fR pixels. This resource is limited to 100;
875     option \fB\-w\fR, \fB\-bw\fR, \fB\-borderwidth\fR.
876     .IP "\fBborderLess:\fR \fIboolean\fR" 4
877     .IX Item "borderLess: boolean"
878     Set \s-1MWM\s0 hints to request a borderless window, i.e. if honoured by the
879     \&\s-1WM\s0, the rxvt-unicode window will not have window decorations; option \fB\-bl\fR.
880 root 1.37 .IP "\fBskipBuiltinGlyphs:\fR \fIboolean\fR" 4
881     .IX Item "skipBuiltinGlyphs: boolean"
882     Compile \fIfrills\fR: Disable the usage of the built-in block graphics/line
883     drawing characters and just rely on what the specified fonts provide. Use
884     this if you have a good font and want to use its block graphic glyphs;
885     option \fB\-sbg\fR.
886 root 1.1 .IP "\fBtermName:\fR \fItermname\fR" 4
887     .IX Item "termName: termname"
888     Specifies the terminal type name to be set in the \fB\s-1TERM\s0\fR environment
889     variable; option \fB\-tn\fR.
890     .IP "\fBlinespace:\fR \fInumber\fR" 4
891     .IX Item "linespace: number"
892     Specifies number of lines (pixel height) to insert between each row of
893     the display [default 0]; option \fB\-lsp\fR.
894     .IP "\fBmeta8:\fR \fIboolean\fR" 4
895     .IX Item "meta8: boolean"
896     \&\fBTrue\fR: handle Meta (Alt) + keypress to set the 8th bit. \fBFalse\fR:
897     handle Meta (Alt) + keypress as an escape prefix [default].
898     .IP "\fBmouseWheelScrollPage:\fR \fIboolean\fR" 4
899     .IX Item "mouseWheelScrollPage: boolean"
900     \&\fBTrue\fR: the mouse wheel scrolls a page full. \fBFalse\fR: the mouse wheel
901     scrolls five lines [default].
902     .IP "\fBpastableTabs:\fR \fIboolean\fR" 4
903     .IX Item "pastableTabs: boolean"
904     \&\fBTrue\fR: store tabs as wide characters. \fBFalse\fR: interpret tabs as cursor
905     movement only; option \f(CW\*(C`\-ptab\*(C'\fR.
906     .IP "\fBcursorBlink:\fR \fIboolean\fR" 4
907     .IX Item "cursorBlink: boolean"
908     \&\fBTrue\fR: blink the cursor. \fBFalse\fR: do not blink the cursor [default];
909     option \fB\-bc\fR.
910     .IP "\fBpointerBlank:\fR \fIboolean\fR" 4
911     .IX Item "pointerBlank: boolean"
912     \&\fBTrue\fR: blank the pointer when a key is pressed or after a set number
913     of seconds of inactivity. \fBFalse\fR: the pointer is always visible
914     [default].
915     .IP "\fBpointerColor:\fR \fIcolour\fR" 4
916     .IX Item "pointerColor: colour"
917     Mouse pointer foreground colour.
918     .IP "\fBpointerColor2:\fR \fIcolour\fR" 4
919     .IX Item "pointerColor2: colour"
920     Mouse pointer background colour.
921     .IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4
922     .IX Item "pointerBlankDelay: number"
923 root 1.21 Specifies number of seconds before blanking the pointer [default 2]. Use a
924     large number (e.g. \f(CW987654321\fR) to effectively disable the timeout.
925 root 1.1 .IP "\fBbackspacekey:\fR \fIstring\fR" 4
926     .IX Item "backspacekey: string"
927     The string to send when the backspace key is pressed. If set to \fB\s-1DEC\s0\fR
928     or unset it will send \fBDelete\fR (code 127) or, if shifted, \fBBackspace\fR
929     (code 8) \- which can be reversed with the appropriate \s-1DEC\s0 private mode
930     escape sequence.
931     .IP "\fBdeletekey:\fR \fIstring\fR" 4
932     .IX Item "deletekey: string"
933     The string to send when the delete key (not the keypad delete key) is
934     pressed. If unset it will send the sequence traditionally associated
935     with the \fBExecute\fR key.
936     .IP "\fBcutchars:\fR \fIstring\fR" 4
937     .IX Item "cutchars: string"
938 root 1.53 The characters used as delimiters for double-click word selection
939     (whitespace delimiting is added automatically if resource is given).
940     .Sp
941     When the selection extension is in use (the default if compiled in, see
942     the @@RXVT_NAME@@\fIperl\fR\|(3) manpage), a suitable regex using these characters
943     will be created (if the resource exists, otherwise, no regex will be
944     created). In this mode, characters outside \s-1ISO\-8859\-1\s0 can be used.
945     .Sp
946     When the selection extension is not used, only \s-1ISO\-8859\-1\s0 characters can
947     be used. If not specified, the built-in default is used:
948 root 1.1 .Sp
949     \&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]{|}\fR
950     .IP "\fBpreeditType:\fR \fIstyle\fR" 4
951     .IX Item "preeditType: style"
952     \&\fBOverTheSpot\fR, \fBOffTheSpot\fR, \fBRoot\fR; option \fB\-pt\fR.
953     .IP "\fBinputMethod:\fR \fIname\fR" 4
954     .IX Item "inputMethod: name"
955     \&\fIname\fR of inputMethod to use; option \fB\-im\fR.
956     .IP "\fBimLocale:\fR \fIname\fR" 4
957     .IX Item "imLocale: name"
958 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.
959     \&\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
960     input extension to be able to input japanese characters while staying in
961 root 1.31 another locale; option \fB\-imlocale\fR.
962 root 1.7 .IP "\fBimFont:\fR \fIfontset\fR" 4
963     .IX Item "imFont: fontset"
964     Specify the font-set used for \s-1XIM\s0 styles \f(CW\*(C`OverTheSpot\*(C'\fR or
965     \&\f(CW\*(C`OffTheSpot\*(C'\fR. It must be a standard X font set (\s-1XLFD\s0 patterns separated
966     by commas), i.e. it's not in the same format as the other font lists used
967     in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
968     found, preferably one or two pixels differing in size to the base font.
969     option \fB\-imfont\fR.
970     .IP "\fBtripleclickwords:\fR \fIboolean\fR" 4
971     .IX Item "tripleclickwords: boolean"
972     Change the meaning of triple-click selection with the left mouse
973     button. Instead of selecting a full line it will extend the selection to
974 root 1.31 the end of the logical line only; option \fB\-tcw\fR.
975 root 1.1 .IP "\fBinsecure:\fR \fIboolean\fR" 4
976     .IX Item "insecure: boolean"
977     Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that
978     echo arbitrary strings like the icon name or the locale. This could be
979     abused if somebody gets 8\-bit\-clean access to your display, whether
980 root 1.27 through a mail client displaying mail bodies unfiltered or through
981     \&\fIwrite\fR\|(1) or any other means. Therefore, these sequences are disabled by
982     default. (Note that many other terminals, including xterm, have these
983     sequences enabled by default, which doesn't make it safer, though).
984     .Sp
985     You can enable them by setting this boolean resource or specifying
986     \&\fB\-insecure\fR as an option. At the moment, this enables display\-answer,
987 root 1.47 locale, findfont, icon label and window title requests.
988 root 1.1 .IP "\fBmodifier:\fR \fImodifier\fR" 4
989     .IX Item "modifier: modifier"
990     Set the key to be interpreted as the Meta key to: \fBalt\fR, \fBmeta\fR,
991     \&\fBhyper\fR, \fBsuper\fR, \fBmod1\fR, \fBmod2\fR, \fBmod3\fR, \fBmod4\fR, \fBmod5\fR; option
992     \&\fB\-mod\fR.
993     .IP "\fBanswerbackString:\fR \fIstring\fR" 4
994     .IX Item "answerbackString: string"
995     Specify the reply rxvt-unicode sends to the shell when an \s-1ENQ\s0 (control\-E)
996     character is passed through. It may contain escape values as described
997     in the entry on \fBkeysym\fR following.
998 root 1.49 .IP "\fBsecondaryScreen:\fR \fIboolean\fR" 4
999     .IX Item "secondaryScreen: boolean"
1000 root 1.1 Turn on/off secondary screen (default enabled).
1001 root 1.49 .IP "\fBsecondaryScroll:\fR \fIboolean\fR" 4
1002     .IX Item "secondaryScroll: boolean"
1003 root 1.1 Turn on/off secondary screen scroll (default enabled). If the this
1004     option is enabled, scrolls on the secondary screen will change the
1005     scrollback buffer and switching to/from the secondary screen will
1006     instead scroll the screen up.
1007 root 1.49 .IP "\fBhold\fR: \fIboolean\fR" 4
1008     .IX Item "hold: boolean"
1009 root 1.28 Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1010     will not immediately destroy its window when the program executed within
1011     it exits. Instead, it will wait till it is being killed or closed by the
1012     user.
1013 root 1.1 .IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4
1014     .IX Item "keysym.sym: string"
1015 root 1.3 Compile \fIfrills\fR: Associate \fIstring\fR with keysym \fIsym\fR. The
1016     intervening resource name \fBkeysym.\fR cannot be omitted.
1017     .Sp
1018     The format of \fIsym\fR is "\fI(modifiers\-)key\fR", where \fImodifiers\fR can be
1019     any combination of \fBISOLevel3\fR, \fBAppKeypad\fR, \fBControl\fR, \fBNumLock\fR,
1020     \&\fBShift\fR, \fBMeta\fR, \fBLock\fR, \fBMod1\fR, \fBMod2\fR, \fBMod3\fR, \fBMod4\fR, \fBMod5\fR,
1021     and the abbreviated \fBI\fR, \fBK\fR, \fBC\fR, \fBN\fR, \fBS\fR, \fBM\fR, \fBA\fR, \fBL\fR, \fB1\fR,
1022     \&\fB2\fR, \fB3\fR, \fB4\fR, \fB5\fR.
1023     .Sp
1024     The \fBNumLock\fR, \fBMeta\fR and \fBISOLevel3\fR modifiers are usually aliased to
1025     whatever modifier the NumLock key, Meta/Alt keys or \s-1ISO\s0 Level3 Shift/AltGr
1026 root 1.7 keys are being mapped. \fBAppKeypad\fR is a synthetic modifier mapped to the
1027 root 1.3 current application keymap mode state.
1028     .Sp
1029     The spellings of \fIkey\fR can be obtained by using \fBxev\fR(1) command or
1030     searching keysym macros from \fB/usr/X11R6/include/X11/keysymdef.h\fR and
1031     omitting the prefix \fB\s-1XK_\s0\fR. Alternatively you can specify \fIkey\fR by its hex
1032     keysym value (\fB0x0000 \- 0xFFFF\fR). Note that the lookup of \fIsym\fRs is not
1033     performed in an exact manner; however, the closest match is assured.
1034     .Sp
1035     \&\fIstring\fR may contain escape values (\f(CW\*(C`\ea\*(C'\fR: bell, \f(CW\*(C`\eb\*(C'\fR: backspace,
1036     \&\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,
1037     \&\f(CW\*(C`\e000\*(C'\fR: octal number) or verbatim control characters (\f(CW\*(C`^?\*(C'\fR: delete,
1038     \&\f(CW\*(C`^@\*(C'\fR: null, \f(CW\*(C`^A\*(C'\fR ...) and may be enclosed with double quotes so that it
1039     can start or end with whitespace.
1040 root 1.2 .Sp
1041 root 1.43 Please note that you need to double the \f(CW\*(C`\e\*(C'\fR in resource files, as
1042     Xlib itself does it's own de-escaping (you can use \f(CW\*(C`\e033\*(C'\fR instead of
1043     \&\f(CW\*(C`\ee\*(C'\fR (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1044     processing).
1045 root 1.12 .Sp
1046 root 1.2 You can define a range of keysyms in one shot by providing a \fIstring\fR
1047 root 1.3 with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimeter `/'
1048     should be a character not used by the strings.
1049 root 1.2 .Sp
1050     Its usage can be demonstrated by an example:
1051 root 1.3 .Sp
1052     .Vb 1
1053 root 1.12 \& URxvt.keysym.M-C-0x61: list|\e033<M-C-|abc|>
1054 root 1.3 .Ve
1055 root 1.2 .Sp
1056     The above line is equivalent to the following three lines:
1057 root 1.3 .Sp
1058     .Vb 3
1059 root 1.12 \& URxvt.keysym.Meta-Control-0x61: \e033<M-C-a>
1060     \& URxvt.keysym.Meta-Control-0x62: \e033<M-C-b>
1061     \& URxvt.keysym.Meta-Control-0x63: \e033<M-C-c>
1062 root 1.3 .Ve
1063     .Sp
1064 root 1.12 If \fIstring\fR takes the form of \f(CW\*(C`command:STRING\*(C'\fR, the specified \fB\s-1STRING\s0\fR
1065 root 1.7 is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1066     example the following means "change the current locale to \f(CW\*(C`zh_CN.GBK\*(C'\fR
1067     when Control-Meta-c is being pressed":
1068     .Sp
1069     .Vb 1
1070 root 1.12 \& URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007
1071 root 1.7 .Ve
1072     .Sp
1073 root 1.33 If \fIstring\fR takes the form \f(CW\*(C`perl:STRING\*(C'\fR, then the specified \fB\s-1STRING\s0\fR
1074     is passed to the \f(CW\*(C`on_keyboard_command\*(C'\fR perl handler. See the @@RXVT_NAME@@\fIperl\fR\|(3)
1075     manpage. For example, the \fIselection\fR extension (activated via
1076     \&\f(CW\*(C`@@RXVT_NAME@@ \-pe selection\*(C'\fR) listens for \f(CW\*(C`selection:rot13\*(C'\fR events:
1077     .Sp
1078     .Vb 1
1079     \& URxvt.keysym.M-C-c: perl:selection:rot13
1080     .Ve
1081     .Sp
1082 root 1.22 Due the the large number of modifier combinations, a defined key mapping
1083     will match if at \fIat least\fR the specified identifiers are being set, and
1084     no other key mappings with those and more bits are being defined. That
1085     means that defining a key map for \f(CW\*(C`a\*(C'\fR will automatically provide
1086     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
1087     mappings themselves.
1088     .Sp
1089     Unfortunately, this will override built-in key mappings. For example
1090     if you overwrite the \f(CW\*(C`Insert\*(C'\fR key you will disable @@RXVT_NAME@@'s
1091     \&\f(CW\*(C`Shift\-Insert\*(C'\fR mapping. To re-enable that, you can poke \*(L"holes\*(R" into the
1092     user-defined keymap using the \f(CW\*(C`builtin:\*(C'\fR replacement:
1093     .Sp
1094     .Vb 2
1095     \& URxvt.keysym.Insert: <my insert key sequence>
1096     \& URxvt.keysym.S-Insert: builtin:
1097     .Ve
1098     .Sp
1099     The first line defines a mapping for \f(CW\*(C`Insert\*(C'\fR and \fIany\fR combination
1100     of modifiers. The second line re-establishes the default mapping for
1101     \&\f(CW\*(C`Shift\-Insert\*(C'\fR.
1102     .Sp
1103 root 1.7 The following example will map Control\-Meta\-1 and Control\-Meta\-2 to
1104 root 1.12 the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited
1105 root 1.7 font-switching at runtime:
1106     .Sp
1107     .Vb 2
1108 root 1.12 \& URxvt.keysym.M-C-1: command:\e033]50;suxuseuro\e007
1109     \& URxvt.keysym.M-C-2: command:\e033]50;9x15bold\e007
1110 root 1.7 .Ve
1111     .Sp
1112 root 1.12 Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1113     info):
1114     .Sp
1115     .Vb 2
1116     \& URxvt.keysym.M-C-3: command:\e033[8;25;80t
1117     \& URxvt.keysym.M-C-4: command:\e033[8;48;110t
1118     .Ve
1119 root 1.36 .IP "\fBperl-ext-common\fR: \fIstring\fR" 4
1120     .IX Item "perl-ext-common: string"
1121     .PD 0
1122 root 1.32 .IP "\fBperl-ext\fR: \fIstring\fR" 4
1123     .IX Item "perl-ext: string"
1124 root 1.36 .PD
1125 root 1.39 Comma-separated list(s) of perl extension scripts (default: \f(CW\*(C`default\*(C'\fR) to
1126     use in this terminal instance; option \fB\-pe\fR.
1127     .Sp
1128     Extension names can be prefixed with a \f(CW\*(C`\-\*(C'\fR sign to prohibit using
1129 root 1.41 them. This can be useful to selectively disable some extensions loaded
1130 root 1.39 by default, or specified via the \f(CW\*(C`perl\-ext\-common\*(C'\fR resource. For
1131     example, \f(CW\*(C`default,\-selection\*(C'\fR will use all the default extension except
1132     \&\f(CW\*(C`selection\*(C'\fR.
1133     .Sp
1134 root 1.41 Extension names can also be followed by an argument in angle brackets
1135     (e.g. \f(CW\*(C`searchable\-scrollback<M\-s>\*(C'\fR, which binds the hotkey for
1136     searchable scorllback to Alt/Meta\-s). Mentioning the same extension
1137     multiple times with different arguments will pass multiple arguments to
1138     the extension.
1139     .Sp
1140 root 1.39 Each extension is looked up in the library directories, loaded if
1141     necessary, and bound to the current terminal instance.
1142     .Sp
1143     If both of these resources are the empty string, then the perl
1144     interpreter will not be initialized. The idea behind two options is that
1145     \&\fBperl-ext-common\fR will be used for extensions that should be available to
1146     all instances, while \fBperl-ext\fR is used for specific instances.
1147 root 1.31 .IP "\fBperl-eval\fR: \fIstring\fR" 4
1148     .IX Item "perl-eval: string"
1149 root 1.40 Perl code to be evaluated when all extensions have been registered. See
1150     the @@RXVT_NAME@@\fIperl\fR\|(3) manpage. Due to security reasons, this resource
1151     will be ignored when running setuid/setgid.
1152 root 1.31 .IP "\fBperl-lib\fR: \fIpath\fR" 4
1153     .IX Item "perl-lib: path"
1154 root 1.32 Colon-separated list of additional directories that hold extension
1155     scripts. When looking for extensions specified by the \f(CW\*(C`perl\*(C'\fR resource,
1156     @@RXVT_NAME@@ will first look in these directories and then in
1157 root 1.40 \&\fI@@RXVT_LIBDIR@@/urxvt/perl/\fR. Due to security reasons, this resource
1158     will be ignored when running setuid/setgid.
1159 root 1.31 .Sp
1160 root 1.33 See the @@RXVT_NAME@@\fIperl\fR\|(3) manpage.
1161 root 1.45 .IP "\fBselection.pattern\-\f(BIidx\fB\fR: \fIperl-regex\fR" 4
1162     .IX Item "selection.pattern-idx: perl-regex"
1163     Additional selection patterns, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage for
1164     details.
1165     .IP "\fBselection\-autotransform.\f(BIidx\fB\fR: \fIperl-transform\fR" 4
1166     .IX Item "selection-autotransform.idx: perl-transform"
1167     Selection auto-transform patterns, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage
1168     for details.
1169 root 1.44 .IP "\fBsearchable\-scrollback:\fR \fIkeysym\fR" 4
1170     .IX Item "searchable-scrollback: keysym"
1171     Sets the hotkey that starts the incremental scrollback buffer search
1172     (default: \f(CW\*(C`M\-s\*(C'\fR).
1173 root 1.42 .IP "\fBurlLauncher\fR: \fIstring\fR" 4
1174     .IX Item "urlLauncher: string"
1175     Specifies the program to be started with a \s-1URL\s0 argument. Used by the
1176     \&\f(CW\*(C`selection\-popup\*(C'\fR and \f(CW\*(C`mark\-urls\*(C'\fR perl extensions.
1177 root 1.40 .IP "\fBtransient-for\fR: \fIwindowid\fR" 4
1178     .IX Item "transient-for: windowid"
1179 root 1.49 Compile \fIfrills\fR: Sets the \s-1WM_TRANSIENT_FOR\s0 property to the given window id.
1180     .IP "\fBoverride-redirect\fR: \fIboolean\fR" 4
1181     .IX Item "override-redirect: boolean"
1182     Compile \fIfrills\fR: Sets override-redirect for the terminal window, making
1183     it almost invisible to window managers; option \fB\-override\-redirect\fR.
1184 root 1.1 .SH "THE SCROLLBAR"
1185     .IX Header "THE SCROLLBAR"
1186     Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window
1187     (resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar
1188     or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and
1189     its behaviour is fairly intuitive. The \fBxterm-scrollbar\fR is without
1190     arrows and its behaviour mimics that of \fIxterm\fR
1191     .PP
1192     Scroll down with \fBButton1\fR (\fBxterm-scrollbar\fR) or \fBShift-Next\fR.
1193     Scroll up with \fBButton3\fR (\fBxterm-scrollbar\fR) or \fBShift-Prior\fR.
1194     Continuous scroll with \fBButton2\fR.
1195     .SH "MOUSE REPORTING"
1196     .IX Header "MOUSE REPORTING"
1197     To temporarily override mouse reporting, for either the scrollbar or
1198     the normal text selection/insertion, hold either the Shift or the Meta
1199     (Alt) key while performing the desired mouse action.
1200     .PP
1201     If mouse reporting mode is active, the normal scrollbar actions are
1202     disabled \*(-- on the assumption that we are using a fullscreen
1203 root 1.12 application. Instead, pressing Button1 and Button3 sends \fB\s-1ESC\s0 [ 6 ~\fR
1204     (Next) and \fB\s-1ESC\s0 [ 5 ~\fR (Prior), respectively. Similarly, clicking on the
1205     up and down arrows sends \fB\s-1ESC\s0 [ A\fR (Up) and \fB\s-1ESC\s0 [ B\fR (Down),
1206 root 1.1 respectively.
1207     .SH "TEXT SELECTION AND INSERTION"
1208     .IX Header "TEXT SELECTION AND INSERTION"
1209     The behaviour of text selection and insertion mechanism is similar to
1210     \&\fIxterm\fR(1).
1211     .IP "\fBSelection\fR:" 4
1212     .IX Item "Selection:"
1213 root 1.7 Left click at the beginning of the region, drag to the end of the region
1214     and release; Right click to extend the marked region; Left double-click
1215     to select a word; Left triple-click to select the entire logical line
1216     (which can span multiple screen lines), unless modified by resource
1217     \&\fBtripleclickwords\fR.
1218 root 1.1 .Sp
1219     Starting a selection while pressing the \fBMeta\fR key (or \fBMeta+Ctrl\fR keys)
1220 root 1.29 (Compile: \fIfrills\fR) will create a rectangular selection instead of a
1221     normal one. In this mode, every selected row becomes its own line in the
1222     selection, and trailing whitespace is visually underlined and removed from
1223     the selection.
1224 root 1.1 .IP "\fBInsertion\fR:" 4
1225     .IX Item "Insertion:"
1226 root 1.52 Pressing and releasing the Middle mouse button in an \fB@@RXVT_NAME@@\fR
1227     window causes the value of the \s-1PRIMARY\s0 selection (or \s-1CLIPBOARD\s0 with the
1228     Meta modifier) to be inserted as if it had been typed on the keyboard.
1229     .Sp
1230     Pressing \fBShift-Insert\fR causes the value of the \s-1PRIMARY\s0 selection to be
1231     inserted too.
1232 root 1.1 .SH "CHANGING FONTS"
1233     .IX Header "CHANGING FONTS"
1234     Changing fonts (or font sizes, respectively) via the keypad is not yet
1235     supported in rxvt\-unicode. Bug me if you need this.
1236     .PP
1237 root 1.47 You can, however, switch fonts at runtime using escape sequences, e.g.:
1238 root 1.1 .PP
1239     .Vb 1
1240 root 1.27 \& printf '\ee]710;%s\e007' "9x15bold,xft:Kochi Gothic"
1241 root 1.1 .Ve
1242     .PP
1243 root 1.47 You can use keyboard shortcuts, too:
1244     .PP
1245     .Vb 2
1246     \& URxvt.keysym.M-C-1: command:\e033]710;suxuseuro\e007\e033]711;suxuseuro\e007
1247     \& URxvt.keysym.M-C-2: command:\e033]710;9x15bold\e007\e033]711;9x15bold\e007
1248     .Ve
1249     .PP
1250 root 1.1 rxvt-unicode will automatically re-apply these fonts to the output so far.
1251     .SH "ISO 14755 SUPPORT"
1252     .IX Header "ISO 14755 SUPPORT"
1253     \&\s-1ISO\s0 14755 is a standard for entering and viewing unicode characters
1254     and character codes using the keyboard. It consists of 4 parts. The
1255     first part is available rxvt-unicode has been compiled with
1256     \&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, the rest is available when rxvt-unicode was compiled
1257     with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR.
1258 root 1.7 .IP "* 5.1: Basic method" 4
1259 root 1.1 .IX Item "5.1: Basic method"
1260     This allows you to enter unicode characters using their hexcode.
1261     .Sp
1262     Start by pressing and holding both \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, then enter
1263     hex-digits (between one and six). Releasing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR will
1264     commit the character as if it were typed directly. While holding down
1265     \&\f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR you can also enter multiple characters by pressing
1266     \&\f(CW\*(C`Space\*(C'\fR, which will commit the current character and lets you start a new
1267     one.
1268     .Sp
1269     As an example of use, imagine a business card with a japanese e\-mail
1270     address, which you cannot type. Fortunately, the card has the e\-mail
1271     address printed as hexcodes, e.g. \f(CW\*(C`671d 65e5\*(C'\fR. You can enter this easily
1272     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,
1273     followed by releasing the modifier keys.
1274 root 1.7 .IP "* 5.2: Keyboard symbols entry method" 4
1275 root 1.1 .IX Item "5.2: Keyboard symbols entry method"
1276     This mode lets you input characters representing the keycap symbols of
1277     your keyboard, if representable in the current locale encoding.
1278     .Sp
1279     Start by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then releasing
1280     them. The next special key (cursor keys, home etc.) you enter will not
1281     invoke it's usual function but instead will insert the corresponding
1282     keycap symbol. The symbol will only be entered when the key has been
1283     released, otherwise pressing e.g. \f(CW\*(C`Shift\*(C'\fR would enter the symbol for
1284     \&\f(CW\*(C`ISO Level 2 Switch\*(C'\fR, although your intention might have been to enter a
1285     reverse tab (Shift\-Tab).
1286 root 1.7 .IP "* 5.3: Screen-selection entry method" 4
1287 root 1.1 .IX Item "5.3: Screen-selection entry method"
1288     While this is implemented already (it's basically the selection
1289     mechanism), it could be extended by displaying a unicode character map.
1290 root 1.7 .IP "* 5.4: Feedback method for identifying displayed characters for later input" 4
1291 root 1.1 .IX Item "5.4: Feedback method for identifying displayed characters for later input"
1292     This method lets you display the unicode character code associated with
1293     characters already displayed.
1294     .Sp
1295     You enter this mode by holding down \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then
1296     pressing and holding the left mouse button and moving around. The unicode
1297     hex code(s) (it might be a combining character) of the character under the
1298     pointer is displayed until you release \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR.
1299     .Sp
1300     In addition to the hex codes it will display the font used to draw this
1301     character \- due to implementation reasons, characters combined with
1302     combining characters, line drawing characters and unknown characters will
1303     always be drawn using the built-in support font.
1304     .PP
1305     With respect to conformance, rxvt-unicode is supposed to be compliant to
1306     both scenario A and B of \s-1ISO\s0 14755, including part 5.2.
1307     .SH "LOGIN STAMP"
1308     .IX Header "LOGIN STAMP"
1309 root 1.7 \&\fB@@RXVT_NAME@@\fR tries to write an entry into the \fIutmp\fR(5) file so that
1310     it can be seen via the \fI\fIwho\fI\|(1)\fR command, and can accept messages. To
1311     allow this feature, \fB@@RXVT_NAME@@\fR may need to be installed setuid root
1312     on some systems or setgid to root or to some other group on others.
1313 root 1.1 .SH "COLORS AND GRAPHICS"
1314     .IX Header "COLORS AND GRAPHICS"
1315     In addition to the default foreground and background colours,
1316     \&\fB@@RXVT_NAME@@\fR can display up to 16 colours (8 \s-1ANSI\s0 colours plus
1317     high-intensity bold/blink versions of the same). Here is a list of the
1318 root 1.55 colours with their names.
1319 root 1.1 .TS
1320     l l l .
1321     color0 (black) = Black
1322     color1 (red) = Red3
1323     color2 (green) = Green3
1324     color3 (yellow) = Yellow3
1325     color4 (blue) = Blue3
1326     color5 (magenta) = Magenta3
1327     color6 (cyan) = Cyan3
1328     color7 (white) = AntiqueWhite
1329     color8 (bright black) = Grey25
1330     color9 (bright red) = Red
1331     color10 (bright green) = Green
1332     color11 (bright yellow) = Yellow
1333     color12 (bright blue) = Blue
1334     color13 (bright magenta) = Magenta
1335     color14 (bright cyan) = Cyan
1336     color15 (bright white) = White
1337     foreground = Black
1338     background = White
1339     .TE
1340    
1341     .PP
1342     It is also possible to specify the colour values of \fBforeground\fR,
1343     \&\fBbackground\fR, \fBcursorColor\fR, \fBcursorColor2\fR, \fBcolorBD\fR, \fBcolorUL\fR as
1344     a number 0\-15, as a convenient shorthand to reference the colour name of
1345     color0\-color15.
1346     .PP
1347 root 1.58 In addition to the colours defined above, @@RXVT_NAME@@ offers an
1348     additional 72 colours. The first 64 of those (with indices 16 to 79)
1349     consist of a 4*4*4 \s-1RGB\s0 colour cube (i.e. \fIindex = r * 16 + g * 4 + b +
1350     16\fR), followed by 8 additional shades of gray (with indices 80 to 87).
1351     .PP
1352     Together, all those colours implement the 88 colour xterm colours. Only
1353     the first 16 can be changed using resources currently, the rest can only
1354     be changed via command sequences (\*(L"escape codes\*(R").
1355     .PP
1356 root 1.1 Note that \fB\-rv\fR (\fB\*(L"reverseVideo: True\*(R"\fR) simulates reverse video by
1357     always swapping the foreground/background colours. This is in contrast to
1358     \&\fIxterm\fR(1) where the colours are only swapped if they have not otherwise
1359     been specified. For example,
1360     .IP "\fB@@RXVT_NAME@@ \-fg Black \-bg White \-rv\fR" 4
1361     .IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv"
1362     would yield White on Black, while on \fIxterm\fR(1) it would yield Black
1363     on White.
1364 root 1.57 .Sh "\s-1ALPHA\s0 \s-1CHANNEL\s0 \s-1SUPPORT\s0"
1365     .IX Subsection "ALPHA CHANNEL SUPPORT"
1366     If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1367     their act together, rxvt-unicode will support \f(CW\*(C`rgba:rrrr/gggg/bbbb/aaaa\*(C'\fR
1368     (recommended, but \fB\s-1MUST\s0\fR have 4 digits/component) colour specifications,
1369     in addition to the ones provided by X, where the additional A component
1370     specifies opacity (alpha) values. The minimum value of \f(CW0\fR is completely
1371     transparent). You can also prefix any color with \f(CW\*(C`[a]\*(C'\fR, where \f(CW\*(C`a\*(C'\fR is on
1372     to four hex digits specifiying the opacity value.
1373     .PP
1374     You probably need to specify \fB\*(L"\-depth 32\*(R"\fR, too, and have the luck that
1375     your X\-server uses \s-1ARGB\s0 pixel layout, as X is far from just supporting
1376     \&\s-1ARGB\s0 visuals out of the box, and rxvt-unicode just fudges around.
1377     .PP
1378     For example, the following selects an almost completely transparent red
1379     background, and an almost opaque pink foreground:
1380     .PP
1381     .Vb 1
1382     \& @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
1383     .Ve
1384     .PP
1385     \&\fIPlease note that transparency of any kind if completely unsupported by
1386     the author. Don't bug him with installation questions!\fR
1387 root 1.1 .SH "ENVIRONMENT"
1388     .IX Header "ENVIRONMENT"
1389 root 1.12 \&\fB@@RXVT_NAME@@\fR sets and/or uses the following environment variables:
1390     .IP "\fB\s-1TERM\s0\fR" 4
1391     .IX Item "TERM"
1392     Normally set to \f(CW\*(C`rxvt\-unicode\*(C'\fR, unless overwritten at configure time, via
1393     resources or on the commandline.
1394     .IP "\fB\s-1COLORTERM\s0\fR" 4
1395     .IX Item "COLORTERM"
1396     Either \f(CW\*(C`rxvt\*(C'\fR, \f(CW\*(C`rxvt\-xpm\*(C'\fR, depending on wether @@RXVT_NAME@@ was
1397     compiled with \s-1XPM\s0 support, and optionally with the added extension
1398     \&\f(CW\*(C`\-mono\*(C'\fR to indicate that rxvt-unicode runs on a monochrome screen.
1399     .IP "\fB\s-1COLORFGBG\s0\fR" 4
1400     .IX Item "COLORFGBG"
1401     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
1402     the colour code used as default foreground/text colour (or the string
1403     \&\f(CW\*(C`default\*(C'\fR to indicate that the default-colour escape sequence is to be
1404     used), \f(CW\*(C`bg\*(C'\fR is the colour code used as default background colour (or the
1405     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@@
1406 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
1407     (and do) use this information to optimize screen output.
1408 root 1.12 .IP "\fB\s-1WINDOWID\s0\fR" 4
1409     .IX Item "WINDOWID"
1410     Set to the (decimal) X Window \s-1ID\s0 of the @@RXVT_NAME@@ window (the toplevel
1411     window, which usually has subwindows for the scrollbar, the terminal
1412     window and so on).
1413     .IP "\fB\s-1TERMINFO\s0\fR" 4
1414     .IX Item "TERMINFO"
1415     Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1416     \&\f(CW\*(C`\-\-with\-terminfo=PATH\*(C'\fR.
1417     .IP "\fB\s-1DISPLAY\s0\fR" 4
1418     .IX Item "DISPLAY"
1419     Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1420     display in it's child processes.
1421     .IP "\fB\s-1SHELL\s0\fR" 4
1422     .IX Item "SHELL"
1423     The shell to be used for command execution, defaults to \f(CW\*(C`/bin/sh\*(C'\fR.
1424     .IP "\fB\s-1RXVT_SOCKET\s0\fR" 4
1425     .IX Item "RXVT_SOCKET"
1426     The unix domain socket path used by @@RXVT_NAME@@c(1) and
1427     @@RXVT_NAME@@d(1).
1428     .Sp
1429 root 1.24 Default \fI$HOME/.rxvt\-unicode\-\fI<nodename\fI\fR.
1430 root 1.12 .IP "\fB\s-1HOME\s0\fR" 4
1431     .IX Item "HOME"
1432     Used to locate the default directory for the unix domain socket for
1433     daemon communications and to locate various resource files (such as
1434     \&\f(CW\*(C`.Xdefaults\*(C'\fR)
1435     .IP "\fB\s-1XAPPLRESDIR\s0\fR" 4
1436     .IX Item "XAPPLRESDIR"
1437     Directory where various X resource files are being located.
1438     .IP "\fB\s-1XENVIRONMENT\s0\fR" 4
1439     .IX Item "XENVIRONMENT"
1440     If set and accessible, gives the name of a X resource file to be loaded by
1441     @@RXVT_NAME@@.
1442 root 1.1 .SH "FILES"
1443     .IX Header "FILES"
1444     .IP "\fB/usr/lib/X11/rgb.txt\fR" 4
1445     .IX Item "/usr/lib/X11/rgb.txt"
1446     Color names.
1447     .SH "SEE ALSO"
1448     .IX Header "SEE ALSO"
1449 root 1.24 @@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), \fIxterm\fR\|(1), \fIsh\fR\|(1), \fIresize\fR\|(1), X(1), \fIpty\fR\|(4), \fItty\fR\|(4), \fIutmp\fR\|(5)
1450 root 1.1 .SH "CURRENT PROJECT COORDINATOR"
1451     .IX Header "CURRENT PROJECT COORDINATOR"
1452     .IP "Project Coordinator" 4
1453     .IX Item "Project Coordinator"
1454 root 1.14 Marc A. Lehmann <rxvt\-unicode@schmorp.de>
1455 root 1.1 .Sp
1456 root 1.14 <http://software.schmorp.de/#rxvt\-unicode>
1457 root 1.1 .SH "AUTHORS"
1458     .IX Header "AUTHORS"
1459     .IP "John Bovey" 4
1460     .IX Item "John Bovey"
1461     University of Kent, 1992, wrote the original Xvt.
1462     .IP "Rob Nation <nation@rocket.sanders.lockheed.com>" 4
1463     .IX Item "Rob Nation <nation@rocket.sanders.lockheed.com>"
1464     very heavily modified Xvt and came up with Rxvt
1465     .IP "Angelo Haritsis <ah@doc.ic.ac.uk>" 4
1466     .IX Item "Angelo Haritsis <ah@doc.ic.ac.uk>"
1467     wrote the Greek Keyboard Input (no longer in code)
1468     .IP "mj olesen <olesen@me.QueensU.CA>" 4
1469     .IX Item "mj olesen <olesen@me.QueensU.CA>"
1470     Wrote the menu system.
1471     .Sp
1472     Project Coordinator (changes.txt 2.11 to 2.21)
1473     .IP "Oezguer Kesim <kesim@math.fu\-berlin.de>" 4
1474     .IX Item "Oezguer Kesim <kesim@math.fu-berlin.de>"
1475     Project Coordinator (changes.txt 2.21a to 2.4.5)
1476     .IP "Geoff Wing <gcw@pobox.com>" 4
1477     .IX Item "Geoff Wing <gcw@pobox.com>"
1478 root 1.49 Rewrote screen display and text selection routines.
1479     .Sp
1480     Project Coordinator (changes.txt 2.4.6 \- rxvt\-unicode)
1481 root 1.14 .IP "Marc Alexander Lehmann <rxvt\-unicode@schmorp.de>" 4
1482     .IX Item "Marc Alexander Lehmann <rxvt-unicode@schmorp.de>"
1483 root 1.49 Forked rxvt\-unicode, unicode support, rewrote almost all the code, perl
1484     extension, random hacks, numerous bugfixes and extensions.
1485 root 1.1 .Sp
1486     Project Coordinator (Changes 1.0 \-)
1487 root 1.49 .IP "Emanuele Giaquinta <e.giaquinta@glauco.it>" 4
1488     .IX Item "Emanuele Giaquinta <e.giaquinta@glauco.it>"
1489 root 1.50 Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.