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