ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.man.in
Revision: 1.33
Committed: Mon Jan 2 21:41:51 2006 UTC (18 years, 5 months ago) by root
Branch: MAIN
Changes since 1.32: +12 -3 lines
Log Message:
*** empty log message ***

File Contents

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