doc/rxvt.1.txt

   1 NAME
   2     rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window
   3     system)
   4
   5 SYNOPSIS
   6     rxvt [options] [-e command [ args ]]
   7
   8 DESCRIPTION
   9     rxvt-unicode, version 4.8, is a colour vt102 terminal emulator intended
  10     as an *xterm*(1) replacement for users who do not require features such
  11     as Tektronix 4014 emulation and toolkit-style configurability. As a
  12     result, rxvt-unicode uses much less swap space -- a significant
  13     advantage on a machine serving many X sessions.
  14
  15 FREQUENTLY ASKED QUESTIONS
  16     See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions
  17     and answer to them and some common problems.
  18
  19 RXVT-UNICODE VS. RXVT
  20     Unlike the original rxvt, rxvt-unicode stores all text in Unicode
  21     internally. That means it can store and display most scripts in the
  22     world. Being a terminal emulator, however, some things are very
  23     difficult, especially cursive scripts such as arabic, vertically written
  24     scripts like mongolian or scripts requiring extremely complex combining
  25     rules, like tibetan or devenagari. Don't expect pretty output when using
  26     these scripts. Most other scripts, latin, cyrillic, kanji, thai etc.
  27     should work fine, though. A somewhat difficult case are left-to-right
  28     scripts, such as hebrew: rxvt-unicode adopts the view that bidirectional
  29     algorithms belong into the application, not the terminal emulator (too
  30     many things -- such as cursor-movement while editing -- break
  31     otherwise), but that might change.
  32
  33     If you are looking for a terminal that supports more exotic scripts, let
  34     me recommend "mlterm", which is a very userfriendly, lean and clean
  35     terminal emulator. In fact, the reason rxvt-unicode was born was solely
  36     because the author couldn't get "mlterm" to use one font for latin1 and
  37     another for japanese.
  38
  39     Therefore another design rationale was the use of multiple fonts to
  40     display characters: The idea of a single unicode font which many other
  41     programs force onto it's users never made sense to me: You should be
  42     able to choose any font for any script freely.
  43
  44     Apart from that, rxvt-unicode is also much better internationalised than
  45     it's predecessor, supports things such as XFT and ISO 14755 that are
  46     handy in i18n-environments, is faster, and has a lot less bugs than the
  47     original rxvt. This all in addition to dozens of other small
  48     improvements.
  49
  50     It is still faithfully following the original rxvt idea of being lean
  51     and nice on resources: for example, you can still configure rxvt-unicode
  52     without most of it's features to get a lean binary. It also comes with a
  53     client/daemon pair that lets you open any number of terminal windows
  54     from within a single process, which makes startup time very fast and
  55     drastically reduces memory usage. See rxvtd(1) (daemon) and rxvtc(1)
  56     (client).
  57
  58     It also makes technical information about escape sequences (which have
  59     been extended) easier accessible: see rxvt(7) for technical reference
  60     documentation (escape sequences etc.).
  61
  62 OPTIONS
  63     The rxvt options (mostly a subset of *xterm*'s) are listed below. In
  64     keeping with the smaller-is-better philosophy, options may be eliminated
  65     or default values chosen at compile-time, so options and defaults listed
  66     may not accurately reflect the version installed on your system. `rxvt
  67     -h' gives a list of major compile-time options on the *Options* line.
  68     Option descriptions may be prefixed with which compile option each is
  69     dependent upon. e.g. `Compile *XIM*:' requires *XIM* on the *Options*
  70     line. Note: `rxvt -help' gives a list of all command-line options
  71     compiled into your version.
  72
  73     Note that rxvt permits the resource name to be used as a long-option
  74     (--/++ option) so the potential command-line options are far greater
  75     than those listed. For example: `rxvt --loginShell --color1 Orange'.
  76
  77     The following options are available:
  78
  79     -help, --help
  80         Print out a message describing available options.
  81
  82     -display *displayname*
  83         Attempt to open a window on the named X display (-d still
  84         respected). In the absence of this option, the display specified by
  85         the DISPLAY environment variable is used.
  86
  87     -geometry *geom*
  88         Window geometry (-g still respected); resource geometry.
  89
  90     -rv|+rv
  91         Turn on/off simulated reverse video; resource reverseVideo.
  92
  93     -j|+j
  94         Turn on/off jump scrolling; resource jumpScroll.
  95
  96     -ip|+ip
  97         Turn on/off inheriting parent window's pixmap. Alternative form is
  98         -tr; resource inheritPixmap.
  99
 100     -fade *number*
 101         Fade the text by the given percentage when focus is lost. resource
 102         fading.
 103
 104     -tint *colour*
 105         Tint the transparent background pixmap with the given colour when
 106         transparency is enabled with -tr or -ip. See also the -sh option
 107         that can be used to brighten or darken the image in addition to
 108         tinting it.
 109
 110     -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent
 111         background image in addition to tinting it (i.e. -tint must be
 112         specified, too, e.g. "-tint white").
 113
 114     -bg *colour*
 115         Window background colour; resource background.
 116
 117     -fg *colour*
 118         Window foreground colour; resource foreground.
 119
 120     -pixmap *file[;geom]*
 121         Compile *XPM*: Specify XPM file for the background and also
 122         optionally specify its scaling with a geometry string. Note you may
 123         need to add quotes to avoid special shell interpretation of the ";"
 124         in the command-line; resource backgroundPixmap.
 125
 126     -cr *colour*
 127         The cursor colour; resource cursorColor.
 128
 129     -pr *colour*
 130         The mouse pointer foreground colour; resource pointerColor.
 131
 132     -pr2 *colour*
 133         The mouse pointer background colour; resource pointerColor2.
 134
 135     -bd *colour*
 136         The colour of the border around the text area and between the
 137         scrollbar and the text; resource borderColor.
 138
 139     -fn *fontlist*
 140         Select the fonts to be used. This is a comma separated list of font
 141         names that are used in turn when trying to display Unicode
 142         characters. The first font defines the cell size for characters;
 143         other fonts might be smaller, but not (in general) larger. A
 144         (hopefully) reasonable default font list is always appended to it.
 145         See resource font for more details.
 146
 147         In short, to specify an X11 core font, just specify it's name or
 148         prefix it with "x:". To specify an XFT-font, you need to prefix it
 149         with "xft:", e.g.:
 150
 151            rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
 152            rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
 153
 154         See also the question "How does rxvt-unicode choose fonts?" in the
 155         FAQ section of rxvt(7).
 156
 157     -fb *fontlist*
 158         Compile font-styles: The bold font list to use when bold characters
 159         are to be printed. See resource boldFont for details.
 160
 161     -fi *fontlist*
 162         Compile font-styles: The italic font list to use when bold
 163         characters are to be printed. See resource italicFont for details.
 164
 165     -fbi *fontlist*
 166         Compile font-styles: The bold italic font list to use when bold
 167         characters are to be printed. See resource boldItalicFont for
 168         details.
 169
 170     -name *name*
 171         Specify the application name under which resources are to be
 172         obtained, rather than the default executable file name. Name should
 173         not contain `.' or `*' characters. Also sets the icon and title
 174         name.
 175
 176     -ls|+ls
 177         Start as a login-shell/sub-shell; resource loginShell.
 178
 179     -ut|+ut
 180         Compile *utmp*: Inhibit/enable writing a utmp entry; resource
 181         utmpInhibit.
 182
 183     -vb|+vb
 184         Turn on/off visual bell on receipt of a bell character; resource
 185         visualBell.
 186
 187     -sb|+sb
 188         Turn on/off scrollbar; resource scrollBar.
 189
 190     -si|+si
 191         Turn on/off scroll-to-bottom on TTY output inhibit; resource
 192         scrollTtyOutput has opposite effect.
 193
 194     -sk|+sk
 195         Turn on/off scroll-to-bottom on keypress; resource
 196         scrollTtyKeypress.
 197
 198     -sw|+sw
 199         Turn on/off scrolling with the scrollback buffer as new lines
 200         appear. This only takes effect if -si is also given; resource
 201         scrollWithBuffer.
 202
 203     -sr|+sr
 204         Put scrollbar on right/left; resource scrollBar_right.
 205
 206     -st|+st
 207         Display normal (non XTerm/NeXT) scrollbar without/with a trough;
 208         resource scrollBar_floating.
 209
 210     -ptab|+ptab
 211         If enabled (default), "Horizontal Tab" characters are being stored
 212         as actual wide characters in the screen buffer, which makes it
 213         possible to select and paste them. Since a horizontal tab is a
 214         cursor movement and not an actual glyph, this can sometimes be
 215         visually annoying as the cursor on a tab character is displayed as a
 216         wide cursor; resource pastableTabs.
 217
 218     -bc|+bc
 219         Blink the cursor; resource cursorBlink.
 220
 221     -iconic
 222         Start iconified, if the window manager supports that option.
 223         Alternative form is -ic.
 224
 225     -sl *number*
 226         Save *number* lines in the scrollback buffer. See resource entry for
 227         limits; resource saveLines.
 228
 229     -b *number*
 230         Compile *frills*: Internal border of *number* pixels. See resource
 231         entry for limits; resource internalBorder.
 232
 233     -w *number*
 234         Compile *frills*: External border of *number* pixels. Also, -bw and
 235         -borderwidth. See resource entry for limits; resource
 236         externalBorder.
 237
 238     -bl Compile *frills*: Set MWM hints to request a borderless window, i.e.
 239         if honoured by the WM, the rxvt-unicode window will not have window
 240         decorations; resource borderLess.
 241
 242     -lsp *number*
 243         Compile *frills*: Lines (pixel height) to insert between each row of
 244         the display. Useful to work around font rendering problems; resource
 245         linespace.
 246
 247     -tn *termname*
 248         This option specifies the name of the terminal type to be set in the
 249         TERM environment variable. This terminal type must exist in the
 250         *termcap(5)* database and should have *li#* and *co#* entries;
 251         resource termName.
 252
 253     -e *command [arguments]*
 254         Run the command with its command-line arguments in the rxvt window;
 255         also sets the window title and icon name to be the basename of the
 256         program being executed if neither *-title* (*-T*) nor *-n* are given
 257         on the command line. If this option is used, it must be the last on
 258         the command-line. If there is no -e option then the default is to
 259         run the program specified by the SHELL environment variable or,
 260         failing that, *sh(1)*.
 261
 262     -title *text*
 263         Window title (-T still respected); the default title is the basename
 264         of the program specified after the -e option, if any, otherwise the
 265         application name; resource title.
 266
 267     -n *text*
 268         Icon name; the default name is the basename of the program specified
 269         after the -e option, if any, otherwise the application name;
 270         resource iconName.
 271
 272     -C  Capture system console messages.
 273
 274     -pt *style*
 275         Compile *XIM*: input style for input method; OverTheSpot,
 276         OffTheSpot, Root; resource preeditType.
 277
 278     -im *text*
 279         Compile *XIM*: input method name. resource inputMethod.
 280
 281     -imlocale *string*
 282         The locale to use for opening the IM. You can use an LC_CTYPE of
 283         e.g. de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the
 284         input extension to be able to input japanese characters while
 285         staying in another locale.
 286
 287     -insecure
 288         Enable "insecure" mode, which currently enables most of the escape
 289         sequences that echo strings. See the resource insecure for more
 290         info.
 291
 292     -mod *modifier*
 293         Override detection of Meta modifier with specified key: alt, meta,
 294         hyper, super, mod1, mod2, mod3, mod4, mod5; resource *modifier*.
 295
 296     -ssc|+ssc
 297         Turn on/off secondary screen (default enabled); resource
 298         secondaryScreen.
 299
 300     -ssr|+ssr
 301         Turn on/off secondary screen scroll (default enabled); resource
 302         secondaryScroll.
 303
 304     -xrm *resourcestring*
 305         No effect on rxvt-unicode. Simply passes through an argument to be
 306         made available in the instance's argument list. Appears in
 307         *WM_COMMAND* in some window managers.
 308
 309 RESOURCES (available also as long-options)
 310     Note: `rxvt --help' gives a list of all resources (long options)
 311     compiled into your version.
 312
 313     There are two different methods that rxvt can use to get the Xresource
 314     data: using the X libraries (Xrm*-functions) or internal Xresources
 315     reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
 316     XGetDefaults), you can set and change the resources using X11 tools like
 317     xset. Many distribution do also load settings from the ~/.Xresources
 318     file when X starts.
 319
 320     If compiled with internal Xresources support (i.e. rxvt -h lists
 321     .Xdefaults) then rxvt accepts application defaults set in
 322     XAPPLOADDIR/URxvt (compile-time defined: usually
 323     /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or
 324     ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X
 325     resources, rxvt recognizes two class names: XTerm and URxvt. The class
 326     name Rxvt allows resources common to both rxvt and the original *rxvt*
 327     to be easily configured, while the class name URxvt allows resources
 328     unique to rxvt, notably colours and key-handling, to be shared between
 329     different rxvt configurations. If no resources are specified, suitable
 330     defaults will be used. Command-line arguments can be used to override
 331     resource settings. The following resources are allowed:
 332
 333     geometry: *geom*
 334         Create the window with the specified X window geometry [default
 335         80x24]; option -geometry.
 336
 337     background: *colour*
 338         Use the specified colour as the window's background colour [default
 339         White]; option -bg.
 340
 341     foreground: *colour*
 342         Use the specified colour as the window's foreground colour [default
 343         Black]; option -fg.
 344
 345     color*n*: *colour*
 346         Use the specified colour for the colour value *n*, where 0-7
 347         corresponds to low-intensity (normal) colours and 8-15 corresponds
 348         to high-intensity (bold = bright foreground, blink = bright
 349         background) colours. The canonical names are as follows: 0=black,
 350         1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but
 351         the actual colour names used are listed in the COLORS AND GRAPHICS
 352         section.
 353
 354         Colours higher than 15 cannot be set using resources (yet), but can
 355         be changed using an escape command (see rxvt(7)).
 356
 357         Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm
 358         with 88 colour support). Colours 80-87 are evenly spaces grey steps.
 359
 360     colorBD: *colour*
 361     colorIT: *colour*
 362         Use the specified colour to display bold or italic characters when
 363         the foreground colour is the default. If font styles are not
 364         available (Compile *styles*) and this option is unset, reverse video
 365         is used instead.
 366
 367     colorUL: *colour*
 368         Use the specified colour to display underlined characters when the
 369         foreground colour is the default.
 370
 371     colorRV: *colour*
 372         Use the specified colour as the background for reverse video
 373         characters.
 374
 375     underlineColor: *colour*
 376         If set, use the specified colour as the colour for the underline
 377         itself. If unset, use the foreground colour.
 378
 379     cursorColor: *colour*
 380         Use the specified colour for the cursor. The default is to use the
 381         foreground colour; option -cr.
 382
 383     cursorColor2: *colour*
 384         Use the specified colour for the colour of the cursor text. For this
 385         to take effect, cursorColor must also be specified. The default is
 386         to use the background colour.
 387
 388     reverseVideo: *boolean*
 389         True: simulate reverse video by foreground and background colours;
 390         option -rv. False: regular screen colours [default]; option +rv. See
 391         note in COLORS AND GRAPHICS section.
 392
 393     jumpScroll: *boolean*
 394         True: specify that jump scrolling should be used. When scrolling
 395         quickly, fewer screen updates are performed [default]; option -j.
 396         False: specify that smooth scrolling should be used; option +j.
 397
 398     inheritPixmap: *boolean*
 399         True: make the background inherit the parent windows' pixmap, giving
 400         artificial transparency. False: do not inherit the parent windows'
 401         pixmap.
 402
 403     fading: *number*
 404         Fade the text by the given percentage when focus is lost.
 405
 406     tintColor: *colour*
 407         Tint the transparent background pixmap with the given colour.
 408
 409     shading: *number*
 410         Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
 411         image in addition to tinting it.
 412
 413     scrollColor: *colour*
 414         Use the specified colour for the scrollbar [default #B2B2B2].
 415
 416     troughColor: *colour*
 417         Use the specified colour for the scrollbar's trough area [default
 418         #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.
 419
 420     borderColor: *colour*
 421         The colour of the border around the text area and between the
 422         scrollbar and the text.
 423
 424     backgroundPixmap: *file[;geom]*
 425         Use the specified XPM file (note the `.xpm' extension is optional)
 426         for the background and also optionally specify its scaling with a
 427         geometry string WxH+X+Y, in which "W" / "H" specify the
 428         horizontal/vertical scale (percent) and "X" / "Y" locate the image
 429         centre (percent). A scale of 0 displays the image with tiling. A
 430         scale of 1 displays the image without any scaling. A scale of 2 to 9
 431         specifies an integer number of images in that direction. No image
 432         will be magnified beyond 10 times its original size. The maximum
 433         permitted scale is 1000. [default 0x0+50+50]
 434
 435     menu: *file[;tag]*
 436         Read in the specified menu file (note the `.menu' extension is
 437         optional) and also optionally specify a starting tag to find. See
 438         the reference documentation for details on the syntax for the
 439         menuBar.
 440
 441     path: *path*
 442         Specify the colon-delimited search path for finding files (XPM and
 443         menus), in addition to the paths specified by the RXVTPATH and PATH
 444         environment variables.
 445
 446     font: *fontlist*
 447         Select the fonts to be used. This is a comma separated list of font
 448         names that are used in turn when trying to display Unicode
 449         characters. The first font defines the cell size for characters;
 450         other fonts might be smaller, but not larger. A reasonable default
 451         font list is always appended to it. option -fn.
 452
 453         Each font can either be a standard X11 core font (XLFD) name, with
 454         optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
 455         "xft:".
 456
 457         In addition, each font can be prefixed with additional hints and
 458         specifications enclosed in square brackets ("[]"). The only
 459         available hint currently is "codeset=codeset-name", and this is only
 460         used for Xft fonts.
 461
 462         For example, this font resource
 463
 464            URxvt*font: 9x15bold,\
 465                        -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
 466                        -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
 467                        [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
 468                        xft:Code2000:antialias=false
 469
 470         specifies five fonts to be used. The first one is "9x15bold"
 471         (actually the iso8859-1 version of the second font), which is the
 472         base font (because it is named first) and thus defines the character
 473         cell grid to be 9 pixels wide and 15 pixels high.
 474
 475         The second font is just used to add additional unicode characters
 476         not in the base font, likewise the third, which is unfortunately
 477         non-bold, but the bold version of the font does contain less
 478         characters, so this is a useful supplement.
 479
 480         The third font is an Xft font with aliasing turned off, and the
 481         characters are limited to the JIS 0208 codeset (i.e. japanese
 482         kanji). The font contains other characters, but we are not
 483         interested in them.
 484
 485         The last font is a useful catch-all font that supplies most of the
 486         remaining unicode characters.
 487
 488     boldFont: *fontlist*
 489     italicFont: *fontlist*
 490     boldItalicFont: *fontlist*
 491         The font list to use for displaying bold, *italic* or *bold italic*
 492         characters, respectively.
 493
 494         If specified and non-empty, then the syntax is the same as for the
 495         font-resource, and the given font list will be used as is, which
 496         makes it possible to substitute completely different font styles for
 497         bold and italic.
 498
 499         If unset (the default), a suitable font list will be synthesized by
 500         "morphing" the normal text font list into the desired shape. If that
 501         is not possible, replacement fonts of the desired shape will be
 502         tried.
 503
 504         If set, but empty, then this specific style is disabled and the
 505         normal text font will being used for the given style.
 506
 507     selectstyle: *mode*
 508         Set mouse selection style to old which is 2.20, oldword which is
 509         xterm style with 2.20 old word selection, or anything else which
 510         gives xterm style selection.
 511
 512     scrollstyle: *mode*
 513         Set scrollbar style to rxvt, plain, next or xterm. plain is the
 514         author's favourite..
 515
 516     title: *string*
 517         Set window title string, the default title is the command-line
 518         specified after the -e option, if any, otherwise the application
 519         name; option -title.
 520
 521     iconName: *string*
 522         Set the name used to label the window's icon or displayed in an icon
 523         manager window, it also sets the window's title unless it is
 524         explicitly set; option -n.
 525
 526     mapAlert: *boolean*
 527         True: de-iconify (map) on receipt of a bell character. False: no
 528         de-iconify (map) on receipt of a bell character [default].
 529
 530     visualBell: *boolean*
 531         True: use visual bell on receipt of a bell character; option -vb.
 532         False: no visual bell [default]; option +vb.
 533
 534     loginShell: *boolean*
 535         True: start as a login shell by prepending a `-' to argv[0] of the
 536         shell; option -ls. False: start as a normal sub-shell [default];
 537         option +ls.
 538
 539     utmpInhibit: *boolean*
 540         True: inhibit writing record into the system log file utmp; option
 541         -ut. False: write record into the system log file utmp [default];
 542         option +ut.
 543
 544     print-pipe: *string*
 545         Specify a command pipe for vt100 printer [default *lpr(1)*]. Use
 546         Print to initiate a screen dump to the printer and Ctrl-Print or
 547         Shift-Print to include the scrollback as well.
 548
 549     scrollBar: *boolean*
 550         True: enable the scrollbar [default]; option -sb. False: disable the
 551         scrollbar; option +sb.
 552
 553     scrollBar_right: *boolean*
 554         True: place the scrollbar on the right of the window; option -sr.
 555         False: place the scrollbar on the left of the window; option +sr.
 556
 557     scrollBar_floating: *boolean*
 558         True: display an rxvt scrollbar without a trough; option -st. False:
 559         display an rxvt scrollbar with a trough; option +st.
 560
 561     scrollBar_align: *mode*
 562         Align the top, bottom or centre [default] of the scrollbar thumb
 563         with the pointer on middle button press/drag.
 564
 565     scrollTtyOutput: *boolean*
 566         True: scroll to bottom when tty receives output; option -si. False:
 567         do not scroll to bottom when tty receives output; option +si.
 568
 569     scrollWithBuffer: *boolean*
 570         True: scroll with scrollback buffer when tty receives new lines (and
 571         scrollTtyOutput is False); option +sw. False: do not scroll with
 572         scrollback buffer when tty recieves new lines; option -sw.
 573
 574     scrollTtyKeypress: *boolean*
 575         True: scroll to bottom when a non-special key is pressed. Special
 576         keys are those which are intercepted by rxvt-unicode for special
 577         handling and are not passed onto the shell; option -sk. False: do
 578         not scroll to bottom when a non-special key is pressed; option +sk.
 579
 580     saveLines: *number*
 581         Save *number* lines in the scrollback buffer [default 64]. This
 582         resource is limited on most machines to 65535; option -sl.
 583
 584     internalBorder: *number*
 585         Internal border of *number* pixels. This resource is limited to 100;
 586         option -b.
 587
 588     externalBorder: *number*
 589         External border of *number* pixels. This resource is limited to 100;
 590         option -w, -bw, -borderwidth.
 591
 592     borderLess: *boolean*
 593         Set MWM hints to request a borderless window, i.e. if honoured by
 594         the WM, the rxvt-unicode window will not have window decorations;
 595         option -bl.
 596
 597     termName: *termname*
 598         Specifies the terminal type name to be set in the TERM environment
 599         variable; option -tn.
 600
 601     linespace: *number*
 602         Specifies number of lines (pixel height) to insert between each row
 603         of the display [default 0]; option -lsp.
 604
 605     meta8: *boolean*
 606         True: handle Meta (Alt) + keypress to set the 8th bit. False: handle
 607         Meta (Alt) + keypress as an escape prefix [default].
 608
 609     mouseWheelScrollPage: *boolean*
 610         True: the mouse wheel scrolls a page full. False: the mouse wheel
 611         scrolls five lines [default].
 612
 613     pastableTabs: *boolean*
 614         True: store tabs as wide characters. False: interpret tabs as cursor
 615         movement only; option "-ptab".
 616
 617     cursorBlink: *boolean*
 618         True: blink the cursor. False: do not blink the cursor [default];
 619         option -bc.
 620
 621     pointerBlank: *boolean*
 622         True: blank the pointer when a key is pressed or after a set number
 623         of seconds of inactivity. False: the pointer is always visible
 624         [default].
 625
 626     pointerColor: *colour*
 627         Mouse pointer foreground colour.
 628
 629     pointerColor2: *colour*
 630         Mouse pointer background colour.
 631
 632     pointerBlankDelay: *number*
 633         Specifies number of seconds before blanking the pointer [default 2].
 634
 635     backspacekey: *string*
 636         The string to send when the backspace key is pressed. If set to DEC
 637         or unset it will send Delete (code 127) or, if shifted, Backspace
 638         (code 8) - which can be reversed with the appropriate DEC private
 639         mode escape sequence.
 640
 641     deletekey: *string*
 642         The string to send when the delete key (not the keypad delete key)
 643         is pressed. If unset it will send the sequence traditionally
 644         associated with the Execute key.
 645
 646     cutchars: *string*
 647         The characters used as delimiters for double-click word selection.
 648         The built-in default:
 649
 650         BACKSLASH `"'&()*,;<=>?@[]{|}
 651
 652     preeditType: *style*
 653         OverTheSpot, OffTheSpot, Root; option -pt.
 654
 655     inputMethod: *name*
 656         *name* of inputMethod to use; option -im.
 657
 658     imLocale: *name*
 659         The locale to use for opening the IM. You can use an LC_CTYPE of
 660         e.g. de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the
 661         input extension to be able to input japanese characters while
 662         staying in another locale. option -imlocale.
 663
 664     insecure: *boolean*
 665         Enables "insecure" mode. Rxvt-unicode offers some escape sequences
 666         that echo arbitrary strings like the icon name or the locale. This
 667         could be abused if somebody gets 8-bit-clean access to your display,
 668         whether throuh a mail client displaying mail bodies unfiltered or
 669         though write(1). Therefore, these sequences are disabled by default.
 670         (Note that other terminals, including xterm, have these sequences
 671         enabled by default). You can enable them by setting this boolean
 672         resource or specifying -insecure as an option. At the moment, this
 673         enabled display-answer, locale, findfont, icon label and window
 674         title requests as well as dynamic menubar dispatch.
 675
 676     modifier: *modifier*
 677         Set the key to be interpreted as the Meta key to: alt, meta, hyper,
 678         super, mod1, mod2, mod3, mod4, mod5; option -mod.
 679
 680     answerbackString: *string*
 681         Specify the reply rxvt-unicode sends to the shell when an ENQ
 682         (control-E) character is passed through. It may contain escape
 683         values as described in the entry on keysym following.
 684
 685     secondaryScreen: *bool*
 686         Turn on/off secondary screen (default enabled).
 687
 688     secondaryScroll: *bool*
 689         Turn on/off secondary screen scroll (default enabled). If the this
 690         option is enabled, scrolls on the secondary screen will change the
 691         scrollback buffer and switching to/from the secondary screen will
 692         instead scroll the screen up.
 693
 694     keysym.*sym*: *string*
 695         Compile *frills*: Associate *string* with keysym *sym*. The
 696         intervening resource name keysym. cannot be omitted.
 697
 698         The format of *sym* is "*(modifiers-)key*", where *modifiers* can be
 699         any combination of ISOLevel3, AppKeypad, Control, NumLock, Shift,
 700         Meta, Lock, Mod1, Mod2, Mod3, Mod4, Mod5, and the abbreviated I, K,
 701         C, N, S, M, A, L, 1, 2, 3, 4, 5.
 702
 703         The NumLock, Meta and ISOLevel3 modifiers are usually aliased to
 704         whatever modifier the NumLock key, Meta/Alt keys or ISO Level3
 705         Shift/AltGr keys are being mapped. AppKeypad is a artificial
 706         modifier mapped to the current application keymap mode state.
 707
 708         The spellings of *key* can be obtained by using xev(1) command or
 709         searching keysym macros from /usr/X11R6/include/X11/keysymdef.h and
 710         omitting the prefix XK_. Alternatively you can specify *key* by its
 711         hex keysym value (0x0000 - 0xFFFF). Note that the lookup of *sym*s
 712         is not performed in an exact manner; however, the closest match is
 713         assured.
 714
 715         *string* may contain escape values ("\a": bell, "\b": backspace,
 716         "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
 717         "\000": octal number) or verbatim control characters ("^?": delete,
 718         "^@": null, "^A" ...) and may be enclosed with double quotes so that
 719         it can start or end with whitespace.
 720
 721         You can define a range of keysyms in one shot by providing a
 722         *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
 723         `/' should be a character not used by the strings.
 724
 725         Its usage can be demonstrated by an example:
 726
 727           URxvt.keysym.M-C-0x61:    list|\e<M-C-|abc|>
 728
 729         The above line is equivalent to the following three lines:
 730
 731           URxvt.keysym.Meta-Control-0x61:    \e<M-C-a>
 732           URxvt.keysym.Meta-Control-0x62:    \e<M-C-b>
 733           URxvt.keysym.Meta-Control-0x63:    \e<M-C-c>
 734
 735         If *string* takes the form of "proto:STRING", the specified STRING
 736         is interpreted and executed as rxvt's control sequence. For example,
 737         "proto:\033]701;zh_CN.GBK\007" means: change the current locale to
 738         "zh_CN.GBK".
 739
 740 THE SCROLLBAR
 741     Lines of text that scroll off the top of the rxvt window (resource:
 742     saveLines) and can be scrolled back using the scrollbar or by
 743     keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
 744     fairly intuitive. The xterm-scrollbar is without arrows and its
 745     behaviour mimics that of *xterm*
 746
 747     Scroll down with Button1 (xterm-scrollbar) or Shift-Next. Scroll up with
 748     Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with
 749     Button2.
 750
 751 MOUSE REPORTING
 752     To temporarily override mouse reporting, for either the scrollbar or the
 753     normal text selection/insertion, hold either the Shift or the Meta (Alt)
 754     key while performing the desired mouse action.
 755
 756     If mouse reporting mode is active, the normal scrollbar actions are
 757     disabled -- on the assumption that we are using a fullscreen
 758     application. Instead, pressing Button1 and Button3 sends ESC[6~ (Next)
 759     and ESC[5~ (Prior), respectively. Similarly, clicking on the up and down
 760     arrows sends ESC[A (Up) and ESC[B (Down), respectively.
 761
 762 TEXT SELECTION AND INSERTION
 763     The behaviour of text selection and insertion mechanism is similar to
 764     *xterm*(1).
 765
 766     Selection:
 767         Left click at the beginning of the region, drag to the end of the
 768         region and release; Right click to extend the marked region; Left
 769         double-click to select a word; Left triple-click to select the
 770         entire line.
 771
 772         Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
 773         (Compile: *frills*) will create a rectangular selection instead of a
 774         normal one.
 775
 776     Insertion:
 777         Pressing and releasing the Middle mouse button (or Shift-Insert) in
 778         an rxvt window causes the current text selection to be inserted as
 779         if it had been typed on the keyboard.
 780
 781 CHANGING FONTS
 782     Changing fonts (or font sizes, respectively) via the keypad is not yet
 783     supported in rxvt-unicode. Bug me if you need this.
 784
 785     You can, however, switch fonts at runtime using escape sequences (and
 786     therefore using the menubar), e.g.:
 787
 788        printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"
 789
 790     rxvt-unicode will automatically re-apply these fonts to the output so
 791     far.
 792
 793 ISO 14755 SUPPORT
 794     ISO 14755 is a standard for entering and viewing unicode characters and
 795     character codes using the keyboard. It consists of 4 parts. The first
 796     part is available rxvt-unicode has been compiled with "--enable-frills",
 797     the rest is available when rxvt-unicode was compiled with
 798     "--enable-iso14755".
 799
 800     5.1: Basic method
 801         This allows you to enter unicode characters using their hexcode.
 802
 803         Start by pressing and holding both "Control" and "Shift", then enter
 804         hex-digits (between one and six). Releasing "Control" and "Shift"
 805         will commit the character as if it were typed directly. While
 806         holding down "Control" and "Shift" you can also enter multiple
 807         characters by pressing "Space", which will commit the current
 808         character and lets you start a new one.
 809
 810         As an example of use, imagine a business card with a japanese e-mail
 811         address, which you cannot type. Fortunately, the card has the e-mail
 812         address printed as hexcodes, e.g. "671d 65e5". You can enter this
 813         easily by pressing "Control" and "Shift", followed by
 814         "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys.
 815
 816     5.2: Keyboard symbols entry method
 817         This mode lets you input characters representing the keycap symbols
 818         of your keyboard, if representable in the current locale encoding.
 819
 820         Start by pressing "Control" and "Shift" together, then releasing
 821         them. The next special key (cursor keys, home etc.) you enter will
 822         not invoke it's usual function but instead will insert the
 823         corresponding keycap symbol. The symbol will only be entered when
 824         the key has been released, otherwise pressing e.g. "Shift" would
 825         enter the symbol for "ISO Level 2 Switch", although your intention
 826         might have been to enter a reverse tab (Shift-Tab).
 827
 828     5.3: Screen-selection entry method
 829         While this is implemented already (it's basically the selection
 830         mechanism), it could be extended by displaying a unicode character
 831         map.
 832
 833     5.4: Feedback method for identifying displayed characters for later
 834     input
 835         This method lets you display the unicode character code associated
 836         with characters already displayed.
 837
 838         You enter this mode by holding down "Control" and "Shift" together,
 839         then pressing and holding the left mouse button and moving around.
 840         The unicode hex code(s) (it might be a combining character) of the
 841         character under the pointer is displayed until you release "Control"
 842         and "Shift".
 843
 844         In addition to the hex codes it will display the font used to draw
 845         this character - due to implementation reasons, characters combined
 846         with combining characters, line drawing characters and unknown
 847         characters will always be drawn using the built-in support font.
 848
 849     With respect to conformance, rxvt-unicode is supposed to be compliant to
 850     both scenario A and B of ISO 14755, including part 5.2.
 851
 852 LOGIN STAMP
 853     rxvt tries to write an entry into the *utmp*(5) file so that it can be
 854     seen via the *who(1)* command, and can accept messages. To allow this
 855     feature, rxvt must be installed setuid root on some systems.
 856
 857 COLORS AND GRAPHICS
 858     In addition to the default foreground and background colours, rxvt can
 859     display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
 860     versions of the same). Here is a list of the colours with their rgb.txt
 861     names.
 862
 863        color0          (black)         = Black
 864        color1          (red)           = Red3
 865        color2          (green)         = Green3
 866        color3          (yellow)        = Yellow3
 867        color4          (blue)          = Blue3
 868        color5          (magenta)       = Magenta3
 869        color6          (cyan)          = Cyan3
 870        color7          (white)         = AntiqueWhite
 871        color8          (bright black)  = Grey25
 872        color9          (bright red)    = Red
 873        color10         (bright green)  = Green
 874        color11         (bright yellow) = Yellow
 875        color12         (bright blue)   = Blue
 876        color13         (bright magenta) = Magenta
 877        color14         (bright cyan)   = Cyan
 878        color15         (bright white)  = White
 879        foreground                      = Black
 880        background                      = White
 881
 882     It is also possible to specify the colour values of foreground,
 883     background, cursorColor, cursorColor2, colorBD, colorUL as a number
 884     0-15, as a convenient shorthand to reference the colour name of
 885     color0-color15.
 886
 887     Note that -rv ("reverseVideo: True") simulates reverse video by always
 888     swapping the foreground/background colours. This is in contrast to
 889     *xterm*(1) where the colours are only swapped if they have not otherwise
 890     been specified. For example,
 891
 892     rxvt -fg Black -bg White -rv
 893         would yield White on Black, while on *xterm*(1) it would yield Black
 894         on White.
 895
 896 ENVIRONMENT
 897     rxvt sets the environment variables TERM, COLORTERM and COLORFGBG. The
 898     environment variable WINDOWID is set to the X window id number of the
 899     rxvt window and it also uses and sets the environment variable DISPLAY
 900     to specify which display terminal to use. rxvt uses the environment
 901     variables RXVTPATH and PATH to find XPM files.
 902
 903 FILES
 904     /etc/utmp
 905         System file for login records.
 906
 907     /usr/lib/X11/rgb.txt
 908         Color names.
 909
 910 SEE ALSO
 911     rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
 912
 913 BUGS
 914     Check the BUGS file for an up-to-date list.
 915
 916     Cursor change support is not yet implemented.
 917
 918     Click-and-drag doesn't work with X11 mouse report overriding.
 919
 920 CURRENT PROJECT COORDINATOR
 921     Project Coordinator
 922         Marc A. Lehmann rxvt@schmorp.de
 923
 924     Web page maintainter
 925         Marc A. Lehmann rxvt@schmorp.de
 926
 927         <http://software.schmorp.de/>
 928
 929 AUTHORS
 930     John Bovey
 931         University of Kent, 1992, wrote the original Xvt.
 932
 933     Rob Nation <nation@rocket.sanders.lockheed.com>
 934         very heavily modified Xvt and came up with Rxvt
 935
 936     Angelo Haritsis <ah@doc.ic.ac.uk>
 937         wrote the Greek Keyboard Input (no longer in code)
 938
 939     mj olesen <olesen@me.QueensU.CA>
 940         Wrote the menu system.
 941
 942         Project Coordinator (changes.txt 2.11 to 2.21)
 943
 944     Oezguer Kesim <kesim@math.fu-berlin.de>
 945         Project Coordinator (changes.txt 2.21a to 2.4.5)
 946
 947     Geoff Wing <gcw@pobox.com>
 948         Rewrote screen display and text selection routines. Project
 949         Coordinator (changes.txt 2.4.6 - rxvt-unicode)
 950
 951     Marc Alexander Lehmann <rxvt@schmorp.de>
 952         Forked rxvt-unicode, rewrote most of the display code and internal
 953         character handling to store text in unicode, improve xterm
 954         compatibility and apply numerous other bugfixes and extensions.
 955
 956         Project Coordinator (Changes 1.0 -)
 957