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