3 rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window system)
7 B<@@RXVT_NAME@@> [options] [-e command [ args ]]
11 B<rxvt-unicode>, version B<@@RXVT_VERSION@@>, is a colour vt102 terminal
12 emulator intended as an I<xterm>(1) replacement for users who do not
13 require features such as Tektronix 4014 emulation and toolkit-style
14 configurability. As a result, B<rxvt-unicode> uses much less swap space --
15 a significant advantage on a machine serving many X sessions.
17 =head1 FREQUENTLY ASKED QUESTIONS
19 See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of frequently
20 asked questions and answer to them and some common problems.
22 =head1 RXVT-UNICODE VS. RXVT
24 Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
25 internally. That means it can store and display most scripts in the
26 world. Being a terminal emulator, however, some things are very difficult,
27 especially cursive scripts such as arabic, vertically written scripts
28 like mongolian or scripts requiring extremely complex combining rules,
29 like tibetan or devenagari. Don't expect pretty output when using these
30 scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
31 fine, though. A somewhat difficult case are left-to-right scripts, such
32 as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
33 belong into the application, not the terminal emulator (too many things --
34 such as cursor-movement while editing -- break otherwise), but that might
37 If you are looking for a terminal that supports more exotic scripts, let
38 me recommend C<mlterm>, which is a very userfriendly, lean and clean
39 terminal emulator. In fact, the reason rxvt-unicode was born was solely
40 because the author couldn't get C<mlterm> to use one font for latin1 and
43 Therefore another design rationale was the use of multiple fonts to
44 display characters: The idea of a single unicode font which many other
45 programs force onto it's users never made sense to me: You should be able
46 to choose any font for any script freely.
48 Apart from that, rxvt-unicode is also much better internationalised than
49 it's predecessor, supports things such as XFT and ISO 14755 that are handy
50 in i18n-environments, is faster, and has a lot less bugs than the original
51 rxvt. This all in addition to dozens of other small improvements.
53 It is still faithfully following the original rxvt idea of being lean
54 and nice on resources: for example, you can still configure rxvt-unicode
55 without most of it's features to get a lean binary. It also comes with
56 a client/daemon pair that lets you open any number of terminal windows
57 from within a single process, which makes startup time very fast and
58 drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
59 @@RXVT_NAME@@c(1) (client).
61 It also makes technical information about escape sequences (which have
62 been extended) easier accessible: see @@RXVT_NAME@@(7) for technical
63 reference documentation (escape sequences etc.).
67 The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
68 below. In keeping with the smaller-is-better philosophy, options may be
69 eliminated or default values chosen at compile-time, so options and
70 defaults listed may not accurately reflect the version installed on
71 your system. `@@RXVT_NAME@@ -h' gives a list of major compile-time options on
72 the I<Options> line. Option descriptions may be prefixed with which
73 compile option each is dependent upon. e.g. `Compile I<XIM>:' requires
74 I<XIM> on the I<Options> line. Note: `@@RXVT_NAME@@ -help' gives a list of all
75 command-line options compiled into your version.
77 Note that B<@@RXVT_NAME@@> permits the resource name to be used as a
78 long-option (--/++ option) so the potential command-line options are
79 far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1
82 The following options are available:
86 =item B<-help>, B<--help>
88 Print out a message describing available options.
90 =item B<-display> I<displayname>
92 Attempt to open a window on the named X display (B<-d> still
93 respected). In the absence of this option, the display specified by the
94 B<DISPLAY> environment variable is used.
96 =item B<-geometry> I<geom>
98 Window geometry (B<-g> still respected); resource B<geometry>.
102 Turn on/off simulated reverse video; resource B<reverseVideo>.
106 Turn on/off jump scrolling; resource B<jumpScroll>.
110 Turn on/off inheriting parent window's pixmap. Alternative form is
111 B<-tr>; resource B<inheritPixmap>.
113 =item B<-fade> I<number>
115 Fade the text by the given percentage when focus is lost.
117 =item B<-tint> I<colour>
119 Tint the transparent background pixmap with the given colour when
120 transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>
121 option that can be used to brighten or darken the image in addition to
126 I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
127 background image in addition to tinting it (i.e. B<-tint> must be
130 =item B<-bg> I<colour>
132 Window background colour; resource B<background>.
134 =item B<-fg> I<colour>
136 Window foreground colour; resource B<foreground>.
138 =item B<-pixmap> I<file[;geom]>
140 Compile I<XPM>: Specify XPM file for the background and also optionally
141 specify its scaling with a geometry string. Note you may need to add
142 quotes to avoid special shell interpretation of the `;' in the
143 command-line; resource B<backgroundPixmap>.
145 =item B<-cr> I<colour>
147 The cursor colour; resource B<cursorColor>.
149 =item B<-pr> I<colour>
151 The mouse pointer foreground colour; resource B<pointerColor>.
153 =item B<-pr2> I<colour>
155 The mouse pointer background colour; resource B<pointerColor2>.
157 =item B<-bd> I<colour>
159 The colour of the border around the text area and between the scrollbar and the text;
160 resource B<borderColor>.
162 =item B<-fn> I<fontlist>
164 Select the fonts to be used. This is a comma separated list of font names
165 that are used in turn when trying to display Unicode characters. The
166 first font defines the cell size for characters; other fonts might be
167 smaller, but not (in general) larger. A reasonable default font list is
168 always appended to it. See resource B<font> for details.
170 See also the question "How does rxvt-unicode choose fonts?" in the FAQ
171 section of @@RXVT_NAME@@(7).
173 =item B<-fb> I<fontlist>
175 Compile font-styles: The bold font list to use when bold characters are to
176 be printed. See resource B<boldFont> for details.
178 =item B<-fi> I<fontlist>
180 Compile font-styles: The italic font list to use when bold characters are to
181 be printed. See resource B<italicFont> for details.
183 =item B<-fbi> I<fontlist>
185 Compile font-styles: The bold italic font list to use when bold characters are to
186 be printed. See resource B<boldItalicFont> for details.
188 =item B<-name> I<name>
190 Specify the application name under which resources are to be obtained,
191 rather than the default executable file name. Name should not contain
192 `.' or `*' characters. Also sets the icon and title name.
196 Start as a login-shell/sub-shell; resource B<loginShell>.
200 Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
205 Turn on/off visual bell on receipt of a bell character; resource
210 Turn on/off scrollbar; resource B<scrollBar>.
214 Turn on/off scroll-to-bottom on TTY output inhibit; resource
215 B<scrollTtyOutput> has opposite effect.
219 Turn on/off scroll-to-bottom on keypress; resource
220 B<scrollTtyKeypress>.
224 Turn on/off scrolling with the scrollback buffer as new lines appear.
225 This only takes effect if B<-si> is also given; resource
230 Put scrollbar on right/left; resource B<scrollBar_right>.
234 Display normal (non XTerm/NeXT) scrollbar without/with a trough;
235 resource B<scrollBar_floating>.
239 Blink the cursor; resource B<cursorBlink>.
243 Start iconified, if the window manager supports that option.
244 Alternative form is B<-ic>.
246 =item B<-sl> I<number>
248 Save I<number> lines in the scrollback buffer. See resource entry for
249 limits; resource B<saveLines>.
251 =item B<-b> I<number>
253 Compile I<frills>: Internal border of I<number> pixels. See resource
254 entry for limits; resource B<internalBorder>.
256 =item B<-w> I<number>
258 Compile I<frills>: External border of I<number> pixels. Also, B<-bw>
259 and B<-borderwidth>. See resource entry for limits; resource
264 Compile I<frills>: Set MWM hints to request a borderless window, i.e.
265 if honoured by the WM, the rxvt-unicode window will not have window
266 decorations; resource B<borderLess>.
268 =item B<-lsp> I<number>
270 Compile I<linespace>: Lines (pixel height) to insert between each row
271 of the display; resource B<linespace>.
273 =item B<-tn> I<termname>
275 This option specifies the name of the terminal type to be set in the
276 B<TERM> environment variable. This terminal type must exist in the
277 I<termcap(5)> database and should have I<li#> and I<co#> entries;
278 resource B<termName>.
280 =item B<-e> I<command [arguments]>
282 Run the command with its command-line arguments in the B<@@RXVT_NAME@@>
283 window; also sets the window title and icon name to be the basename of
284 the program being executed if neither I<-title> (I<-T>) nor I<-n> are
285 given on the command line. If this option is used, it must be the last
286 on the command-line. If there is no B<-e> option then the default is to
287 run the program specified by the B<SHELL> environment variable or,
288 failing that, I<sh(1)>.
290 =item B<-title> I<text>
292 Window title (B<-T> still respected); the default title is the basename
293 of the program specified after the B<-e> option, if any, otherwise the
294 application name; resource B<title>.
298 Icon name; the default name is the basename of the program specified
299 after the B<-e> option, if any, otherwise the application name;
300 resource B<iconName>.
304 Capture system console messages.
306 =item B<-pt> I<style>
308 Compile I<XIM>: input style for input method; B<OverTheSpot>,
309 B<OffTheSpot>, B<Root>; resource B<preeditType>.
313 Compile I<XIM>: input method name. resource B<inputMethod>.
315 =item B<-imlocale> I<string>
317 The locale to use for opening the IM. You can use an LC_CTYPE of e.g.
318 de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input
319 extension to be able to input japanese characters while staying in
324 Enable "insecure" mode, which currently enables most of the escape
325 sequences that echo strings. See the resource B<insecure> for more
328 =item B<-mod> I<modifier>
330 Override detection of Meta modifier with specified key: B<alt>,
331 B<meta>, B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>,
332 B<mod5>; resource I<modifier>.
334 =item B<-ssc>|B<+ssc>
336 Turn on/off secondary screen (default enabled); resource
339 =item B<-ssr>|B<+ssr>
341 Turn on/off secondary screen scroll (default enabled); resource
344 =item B<-xrm> I<resourcestring>
346 No effect on rxvt-unicode. Simply passes through an argument to be made
347 available in the instance's argument list. Appears in I<WM_COMMAND> in
348 some window managers.
352 =head1 RESOURCES (available also as long-options)
354 Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
355 options) compiled into your version.
357 There are two different methods that @@RXVT_NAME@@ can use to get the
358 Xresource data: using the X libraries (Xrm*-functions) or internal
359 Xresources reader (B<~/.Xdefaults>). For the first method (ie.
360 B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
361 resources using X11 tools like B<xset>. Many distribution do also load
362 settings from the B<~/.Xresources> file when X starts.
364 If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
365 lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
366 set in XAPPLOADDIR/URxvt (compile-time defined: usually
367 B</usr/lib/X11/app-defaults/URxvt>) and resources set in
368 B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
369 Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two
370 class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows
371 resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be
372 easily configured, while the class name B<URxvt> allows resources
373 unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be
374 shared between different B<@@RXVT_NAME@@> configurations. If no
375 resources are specified, suitable defaults will be used. Command-line
376 arguments can be used to override resource settings. The following
377 resources are allowed:
381 =item B<geometry:> I<geom>
383 Create the window with the specified X window geometry [default 80x24];
386 =item B<background:> I<colour>
388 Use the specified colour as the window's background colour [default
389 White]; option B<-bg>.
391 =item B<foreground:> I<colour>
393 Use the specified colour as the window's foreground colour [default
394 Black]; option B<-fg>.
396 =item B<color>I<n>B<:> I<colour>
398 Use the specified colour for the colour value I<n>, where 0-7
399 corresponds to low-intensity (normal) colours and 8-15 corresponds to
400 high-intensity (bold = bright foreground, blink = bright background)
401 colours. The canonical names are as follows: 0=black, 1=red, 2=green,
402 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
403 names used are listed in the B<COLORS AND GRAPHICS> section.
405 Colours higher than 15 cannot be set using resources (yet), but can be
406 changed using an escape command (see @@RXVT_NAME@@(7)).
408 Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
409 88 colour support). Colours 80-87 are evenly spaces grey steps.
411 =item B<colorBD:> I<colour>
413 =item B<colorIT:> I<colour>
415 Use the specified colour to display bold or italic characters when the
416 foreground colour is the default. If font styles are not available
417 (Compile styles) and this option is unset, reverse video is used instead.
419 =item B<colorUL:> I<colour>
421 Use the specified colour to display underlined characters when the
422 foreground colour is the default.
424 =item B<colorRV:> I<colour>
426 Use the specified colour as the background for reverse video
429 =item B<cursorColor:> I<colour>
431 Use the specified colour for the cursor. The default is to use the
432 foreground colour; option B<-cr>.
434 =item B<cursorColor2:> I<colour>
436 Use the specified colour for the colour of the cursor text. For this to
437 take effect, B<cursorColor> must also be specified. The default is to
438 use the background colour.
440 =item B<reverseVideo:> I<boolean>
442 B<True>: simulate reverse video by foreground and background colours;
443 option B<-rv>. B<False>: regular screen colours [default]; option
444 B<+rv>. See note in B<COLORS AND GRAPHICS> section.
446 =item B<jumpScroll:> I<boolean>
448 B<True>: specify that jump scrolling should be used. When scrolling
449 quickly, fewer screen updates are performed [default]; option B<-j>.
450 B<False>: specify that smooth scrolling should be used; option B<+j>.
452 =item B<inheritPixmap:> I<boolean>
454 B<True>: make the background inherit the parent windows' pixmap, giving
455 artificial transparency. B<False>: do not inherit the parent windows'
458 =item B<fading:> I<number>
460 Fade the text by the given percentage when focus is lost.
462 =item B<tintColor:> I<colour>
464 Tint the transparent background pixmap with the given colour.
466 =item B<shading:> I<number>
468 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
469 image in addition to tinting it.
471 =item B<scrollColor:> I<colour>
473 Use the specified colour for the scrollbar [default #B2B2B2].
475 =item B<troughColor:> I<colour>
477 Use the specified colour for the scrollbar's trough area [default
478 #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.
480 =item B<borderColor:> I<colour>
482 The colour of the border around the text area and between the scrollbar
485 =item B<backgroundPixmap:> I<file[;geom]>
487 Use the specified XPM file (note the `.xpm' extension is optional) for
488 the background and also optionally specify its scaling with a geometry
489 string B<WxH+X+Y>, in which B<"W" / "H"> specify the
490 horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image
491 centre (percent). A scale of 0 displays the image with tiling. A scale
492 of 1 displays the image without any scaling. A scale of 2 to 9
493 specifies an integer number of images in that direction. No image will
494 be magnified beyond 10 times its original size. The maximum permitted
495 scale is 1000. [default 0x0+50+50]
497 =item B<menu:> I<file[;tag]>
499 Read in the specified menu file (note the `.menu' extension is
500 optional) and also optionally specify a starting tag to find. See the
501 reference documentation for details on the syntax for the menuBar.
503 =item B<path:> I<path>
505 Specify the colon-delimited search path for finding files (XPM and
506 menus), in addition to the paths specified by the B<RXVTPATH> and
507 B<PATH> environment variables.
509 =item B<font:> I<fontlist>
511 Select the fonts to be used. This is a comma separated list of font
512 names that are used in turn when trying to display Unicode characters.
513 The first font defines the cell size for characters; other fonts might
514 be smaller, but not larger. A reasonable default font list is always
515 appended to it. option B<-fn>.
517 Each font can either be a standard X11 core font (XLFD) name, with
518 optional prefix C<x:> or a Xft font (Compile xft), prefixed with C<xft:>.
520 In addition, each font can be prefixed with additional hints and
521 specifications enclosed in square brackets (C<[]>). The only available
522 hint currently is C<codeset=codeset-name>, and this is only used for Xft
525 For example, this font resource
527 URxvt*font: 9x15bold,\
528 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
529 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
530 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
531 xft:Code2000:antialias=false
533 specifies five fonts to be used. The first one is C<9x15bold> (actually
534 the iso8859-1 version of the second font), which is the base font (because
535 it is named first) and thus defines the character cell grid to be 9 pixels
536 wide and 15 pixels high.
538 the second font is just used to add additional unicode characters not in
539 the base font, likewise the third, which is unfortunately non-bold, but
540 the bold version of the font does contain less characters, so this is a
543 The third font is an Xft font with aliasing turned off, and the characters
544 are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
545 contains other characters, but we are not interested in them.
547 The last font is a useful catch-all font that supplies most of the
548 remaining unicode characters.
550 =item B<boldFont:> I<fontlist>
552 =item B<italicFont:> I<fontlist>
554 =item B<boldItalicFont:> I<fontlist>
556 The font list to use for displaying B<bold>, I<italic> or B<< I<bold
557 italic> >> characters, respectively.
559 If specified and non-empty, then the syntax is the same as for the
560 B<font>-resource, and the given font list will be used as is, which makes
561 it possible to substitute completely different font styles for bold and
564 If unset (the default), a suitable font list will be synthesized by
565 "morphing" the normal text font list into the desired shape. If that is
566 not possible, replacement fonts of the desired shape will be tried.
568 If set, but empty, then this specific style is disabled and the normal
569 text font will being used for the given style.
571 =item B<selectstyle:> I<mode>
573 Set mouse selection style to B<old> which is 2.20, B<oldword> which is
574 xterm style with 2.20 old word selection, or anything else which gives
575 xterm style selection.
577 =item B<scrollstyle:> I<mode>
579 Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
580 the author's favourite..
582 =item B<title:> I<string>
584 Set window title string, the default title is the command-line
585 specified after the B<-e> option, if any, otherwise the application
586 name; option B<-title>.
588 =item B<iconName:> I<string>
590 Set the name used to label the window's icon or displayed in an icon
591 manager window, it also sets the window's title unless it is explicitly
594 =item B<mapAlert:> I<boolean>
596 B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
597 de-iconify (map) on receipt of a bell character [default].
599 =item B<visualBell:> I<boolean>
601 B<True>: use visual bell on receipt of a bell character; option B<-vb>.
602 B<False>: no visual bell [default]; option B<+vb>.
604 =item B<loginShell:> I<boolean>
606 B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
607 the shell; option B<-ls>. B<False>: start as a normal sub-shell
608 [default]; option B<+ls>.
610 =item B<utmpInhibit:> I<boolean>
612 B<True>: inhibit writing record into the system log file B<utmp>;
613 option B<-ut>. B<False>: write record into the system log file B<utmp>
614 [default]; option B<+ut>.
616 =item B<print-pipe:> I<string>
618 Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
619 B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
620 B<Shift-Print> to include the scrollback as well.
622 =item B<scrollBar:> I<boolean>
624 B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
625 disable the scrollbar; option B<+sb>.
627 =item B<scrollBar_right:> I<boolean>
629 B<True>: place the scrollbar on the right of the window; option B<-sr>.
630 B<False>: place the scrollbar on the left of the window; option B<+sr>.
632 =item B<scrollBar_floating:> I<boolean>
634 B<True>: display an rxvt scrollbar without a trough; option B<-st>.
635 B<False>: display an rxvt scrollbar with a trough; option B<+st>.
637 =item B<scrollBar_align:> I<mode>
639 Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar
640 thumb with the pointer on middle button press/drag.
642 =item B<scrollTtyOutput:> I<boolean>
644 B<True>: scroll to bottom when tty receives output; option B<-si>.
645 B<False>: do not scroll to bottom when tty receives output; option
648 =item B<scrollWithBuffer:> I<boolean>
650 B<True>: scroll with scrollback buffer when tty receives new lines (and
651 B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll
652 with scrollback buffer when tty recieves new lines; option B<-sw>.
654 =item B<scrollTtyKeypress:> I<boolean>
656 B<True>: scroll to bottom when a non-special key is pressed. Special keys
657 are those which are intercepted by rxvt-unicode for special handling and
658 are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
659 bottom when a non-special key is pressed; option B<+sk>.
661 =item B<saveLines:> I<number>
663 Save I<number> lines in the scrollback buffer [default 64]. This
664 resource is limited on most machines to 65535; option B<-sl>.
666 =item B<internalBorder:> I<number>
668 Internal border of I<number> pixels. This resource is limited to 100;
671 =item B<externalBorder:> I<number>
673 External border of I<number> pixels. This resource is limited to 100;
674 option B<-w>, B<-bw>, B<-borderwidth>.
676 =item B<borderLess:> I<boolean>
678 Set MWM hints to request a borderless window, i.e. if honoured by the
679 WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
681 =item B<termName:> I<termname>
683 Specifies the terminal type name to be set in the B<TERM> environment
684 variable; option B<-tn>.
686 =item B<linespace:> I<number>
688 Specifies number of lines (pixel height) to insert between each row of
689 the display [default 0]; option B<-lsp>.
691 =item B<meta8:> I<boolean>
693 B<True>: handle Meta (Alt) + keypress to set the 8th bit. B<False>:
694 handle Meta (Alt) + keypress as an escape prefix [default].
696 =item B<mouseWheelScrollPage:> I<boolean>
698 B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
699 scrolls five lines [default].
701 =item B<cursorBlink:> I<boolean>
703 B<True>: blink the cursor. B<False>: do not blink the cursor [default];
706 =item B<pointerBlank:> I<boolean>
708 B<True>: blank the pointer when a key is pressed or after a set number
709 of seconds of inactivity. B<False>: the pointer is always visible
712 =item B<pointerColor:> I<colour>
714 Mouse pointer foreground colour.
716 =item B<pointerColor2:> I<colour>
718 Mouse pointer background colour.
720 =item B<pointerBlankDelay:> I<number>
722 Specifies number of seconds before blanking the pointer [default 2].
724 =item B<backspacekey:> I<string>
726 The string to send when the backspace key is pressed. If set to B<DEC>
727 or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
728 (code 8) - which can be reversed with the appropriate DEC private mode
731 =item B<deletekey:> I<string>
733 The string to send when the delete key (not the keypad delete key) is
734 pressed. If unset it will send the sequence traditionally associated
735 with the B<Execute> key.
737 =item B<cutchars:> I<string>
739 The characters used as delimiters for double-click word selection. The
742 B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
744 =item B<preeditType:> I<style>
746 B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
748 =item B<inputMethod:> I<name>
750 I<name> of inputMethod to use; option B<-im>.
752 =item B<imLocale:> I<name>
754 The locale to use for opening the IM. You can use an LC_CTYPE of e.g.
755 de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input
756 extension to be able to input japanese characters while staying in
757 another locale. option B<-imlocale>.
759 =item B<insecure:> I<boolean>
761 Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
762 echo arbitrary strings like the icon name or the locale. This could be
763 abused if somebody gets 8-bit-clean access to your display, whether
764 throuh a mail client displaying mail bodies unfiltered or though
765 write(1). Therefore, these sequences are disabled by default. (Note
766 that other terminals, including xterm, have these sequences
767 enabled by default). You can enable them by setting this boolean
768 resource or specifying B<-insecure> as an option. At the moment, this
769 enabled display-answer, locale, findfont, icon label and window title
770 requests as well as dynamic menubar dispatch.
772 =item B<modifier:> I<modifier>
774 Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
775 B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
778 =item B<answerbackString:> I<string>
780 Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
781 character is passed through. It may contain escape values as described
782 in the entry on B<keysym> following.
784 =item B<secondaryScreen:> I<bool>
786 Turn on/off secondary screen (default enabled).
788 =item B<secondaryScroll:> I<bool>
790 Turn on/off secondary screen scroll (default enabled). If the this
791 option is enabled, scrolls on the secondary screen will change the
792 scrollback buffer and switching to/from the secondary screen will
793 instead scroll the screen up.
795 =item B<keysym.>I<sym>: I<string>
797 Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may
798 contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:
799 newline, \r: return, \t:
800 tab, \000: octal number) or control characters (^?: delete, ^@: null,
801 ^A ...) and may enclosed with double quotes so that it can start or end
802 with whitespace. The intervening resource name B<keysym.> cannot be
803 omitted. This resource is only available when compiled with
810 Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
811 (resource: B<saveLines>) and can be scrolled back using the scrollbar
812 or by keystrokes. The normal B<@@RXVT_NAME@@> scrollbar has arrows and
813 its behaviour is fairly intuitive. The B<xterm-scrollbar> is without
814 arrows and its behaviour mimics that of I<xterm>
816 Scroll down with B<Button1> (B<xterm-scrollbar>) or B<Shift-Next>.
817 Scroll up with B<Button3> (B<xterm-scrollbar>) or B<Shift-Prior>.
818 Continuous scroll with B<Button2>.
820 =head1 MOUSE REPORTING
822 To temporarily override mouse reporting, for either the scrollbar or
823 the normal text selection/insertion, hold either the Shift or the Meta
824 (Alt) key while performing the desired mouse action.
826 If mouse reporting mode is active, the normal scrollbar actions are
827 disabled -- on the assumption that we are using a fullscreen
828 application. Instead, pressing Button1 and Button3 sends B<ESC[6~>
829 (Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the
830 up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down),
833 =head1 TEXT SELECTION AND INSERTION
835 The behaviour of text selection and insertion mechanism is similar to
842 Left click at the beginning of the region, drag to the end of the
843 region and release; Right click to extend the marked region; Left
844 double-click to select a word; Left triple-click to select the entire
847 Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
848 (Compile: frills) will create a rectangular selection instead of a normal
853 Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
854 an B<@@RXVT_NAME@@> window causes the current text selection to be
855 inserted as if it had been typed on the keyboard.
859 =head1 CHANGING FONTS
861 Changing fonts (or font sizes, respectively) via the keypad is not yet
862 supported in rxvt-unicode. Bug me if you need this.
864 You can, however, switch fonts at runtime using escape sequences (and
865 therefore using the menubar), e.g.:
867 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"
869 rxvt-unicode will automatically re-apply these fonts to the output so far.
871 =head1 ISO 14755 SUPPORT
873 ISO 14755 is a standard for entering and viewing unicode characters
874 and character codes using the keyboard. It consists of 4 parts. The
875 first part is available rxvt-unicode has been compiled with
876 C<--enable-frills>, the rest is available when rxvt-unicode was compiled
877 with C<--enable-iso14755>.
881 =item 5.1: Basic method
883 This allows you to enter unicode characters using their hexcode.
885 Start by pressing and holding both C<Control> and C<Shift>, then enter
886 hex-digits (between one and six). Releasing C<Control> and C<Shift> will
887 commit the character as if it were typed directly. While holding down
888 C<Control> and C<Shift> you can also enter multiple characters by pressing
889 C<Space>, which will commit the current character and lets you start a new
892 As an example of use, imagine a business card with a japanese e-mail
893 address, which you cannot type. Fortunately, the card has the e-mail
894 address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
895 by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
896 followed by releasing the modifier keys.
898 =item 5.2: Keyboard symbols entry method
900 This mode lets you input characters representing the keycap symbols of
901 your keyboard, if representable in the current locale encoding.
903 Start by pressing C<Control> and C<Shift> together, then releasing
904 them. The next special key (cursor keys, home etc.) you enter will not
905 invoke it's usual function but instead will insert the corresponding
906 keycap symbol. The symbol will only be entered when the key has been
907 released, otherwise pressing e.g. C<Shift> would enter the symbol for
908 C<ISO Level 2 Switch>, although your intention might have been to enter a
909 reverse tab (Shift-Tab).
911 =item 5.3: Screen-selection entry method
913 While this is implemented already (it's basically the selection
914 mechanism), it could be extended by displaying a unicode character map.
916 =item 5.4: Feedback method for identifying displayed characters for later input
918 This method lets you display the unicode character code associated with
919 characters already displayed.
921 You enter this mode by holding down C<Control> and C<Shift> together, then
922 pressing and holding the left mouse button and moving around. The unicode
923 hex code(s) (it might be a combining character) of the character under the
924 pointer is displayed until you release C<Control> and C<Shift>.
926 In addition to the hex codes it will display the font used to draw this
927 character - due to implementation reasons, characters combined with
928 combining characters, line drawing characters and unknown characters will
929 always be drawn using the built-in support font.
933 With respect to conformance, rxvt-unicode is supposed to be compliant to
934 both scenario A and B of ISO 14755, including part 5.2.
938 B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so
939 that it can be seen via the I<who(1)> command, and can accept messages.
940 To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on
943 =head1 COLORS AND GRAPHICS
945 In addition to the default foreground and background colours,
946 B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
947 high-intensity bold/blink versions of the same). Here is a list of the
948 colours with their B<rgb.txt> names.
952 B<color0> (black) = Black
953 B<color1> (red) = Red3
954 B<color2> (green) = Green3
955 B<color3> (yellow) = Yellow3
956 B<color4> (blue) = Blue3
957 B<color5> (magenta) = Magenta3
958 B<color6> (cyan) = Cyan3
959 B<color7> (white) = AntiqueWhite
960 B<color8> (bright black) = Grey25
961 B<color9> (bright red) = Red
962 B<color10> (bright green) = Green
963 B<color11> (bright yellow) = Yellow
964 B<color12> (bright blue) = Blue
965 B<color13> (bright magenta) = Magenta
966 B<color14> (bright cyan) = Cyan
967 B<color15> (bright white) = White
968 B<foreground> = Black
969 B<background> = White
973 It is also possible to specify the colour values of B<foreground>,
974 B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
975 a number 0-15, as a convenient shorthand to reference the colour name of
978 Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
979 always swapping the foreground/background colours. This is in contrast to
980 I<xterm>(1) where the colours are only swapped if they have not otherwise
981 been specified. For example,
985 =item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
987 would yield White on Black, while on I<xterm>(1) it would yield Black
994 B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>
995 and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X
996 window id number of the B<@@RXVT_NAME@@> window and it also uses and
997 sets the environment variable B<DISPLAY> to specify which display
998 terminal to use. B<@@RXVT_NAME@@> uses the environment variables
999 B<RXVTPATH> and B<PATH> to find XPM files.
1007 System file for login records.
1009 =item B</usr/lib/X11/rgb.txt>
1017 @@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1021 Check the BUGS file for an up-to-date list.
1023 Cursor change support is not yet implemented.
1025 Click-and-drag doesn't work with X11 mouse report overriding.
1027 =head1 CURRENT PROJECT COORDINATOR
1031 =item Project Coordinator
1033 @@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>
1035 =item Web page maintainter
1037 @@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1049 University of Kent, 1992, wrote the original Xvt.
1051 =item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>
1053 very heavily modified Xvt and came up with Rxvt
1055 =item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>
1057 wrote the Greek Keyboard Input (no longer in code)
1059 =item mj olesen L<< <olesen@me.QueensU.CA> >>
1061 Wrote the menu system.
1063 Project Coordinator (changes.txt 2.11 to 2.21)
1065 =item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>
1067 Project Coordinator (changes.txt 2.21a to 2.4.5)
1069 =item Geoff Wing L<< <gcw@pobox.com> >>
1071 Rewrote screen display and text selection routines. Project Coordinator
1072 (changes.txt 2.4.6 - rxvt-unicode)
1074 =item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>
1076 Forked rxvt-unicode, rewrote most of the display code and internal
1077 character handling to store text in unicode, improve xterm
1078 compatibility and apply numerous other bugfixes and extensions.
1080 Project Coordinator (Changes 1.0 -)