ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.man.in
Revision: 1.53
Committed: Wed Jan 25 21:48:47 2006 UTC (18 years, 4 months ago) by root
Branch: MAIN
CVS Tags: rel-7_3
Changes since 1.52: +19 -3 lines
Log Message:
*** empty log message ***

File Contents

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