ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.man.in
Revision: 1.49
Committed: Thu Jan 19 19:26:30 2006 UTC (18 years, 4 months ago) by root
Branch: MAIN
CVS Tags: rel-7_1
Changes since 1.48: +24 -13 lines
Log Message:
*** empty log message ***

File Contents

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