ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.man.in
Revision: 1.7
Committed: Thu Feb 3 10:24:10 2005 UTC (19 years, 5 months ago) by root
Branch: MAIN
CVS Tags: rel-4_9
Changes since 1.4: +62 -26 lines
Log Message:
*** empty log message ***

File Contents

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