ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.txt
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.61 by root, Mon Jul 17 19:20:29 2006 UTC vs.
Revision 1.62 by root, Mon Aug 7 16:17:30 2006 UTC

1NAME 1NAME
2 rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window 2 rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window
3 system) 3 system)
4 4
5SYNOPSIS 5SYNOPSIS
6 urxvt [options] [-e command [ args ]] 6 rxvt [options] [-e command [ args ]]
7 7
8DESCRIPTION 8DESCRIPTION
9 rxvt-unicode, version 7.8, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 7.9, is a colour vt102 terminal emulator intended
10 as an *xterm*(1) replacement for users who do not require features such 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 11 as Tektronix 4014 emulation and toolkit-style configurability. As a
12 result, rxvt-unicode uses much less swap space -- a significant 12 result, rxvt-unicode uses much less swap space -- a significant
13 advantage on a machine serving many X sessions. 13 advantage on a machine serving many X sessions.
14 14
15FREQUENTLY ASKED QUESTIONS 15FREQUENTLY ASKED QUESTIONS
16 See urxvt(7) (try "man 7 urxvt") for a list of frequently asked 16 See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions
17 questions and answer to them and some common problems. That document is 17 and answer to them and some common problems. That document is also
18 also accessible on the World-Wide-Web at 18 accessible on the World-Wide-Web at
19 <http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 19 <http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
20 20
21RXVT-UNICODE VS. RXVT 21RXVT-UNICODE VS. RXVT
22 Unlike the original rxvt, rxvt-unicode stores all text in Unicode 22 Unlike the original rxvt, rxvt-unicode stores all text in Unicode
23 internally. That means it can store and display most scripts in the 23 internally. That means it can store and display most scripts in the
24 world. Being a terminal emulator, however, some things are very 24 world. Being a terminal emulator, however, some things are very
25 difficult, especially cursive scripts such as arabic, vertically written 25 difficult, especially cursive scripts such as arabic, vertically written
26 scripts like mongolian or scripts requiring extremely complex combining 26 scripts like mongolian or scripts requiring extremely complex combining
27 rules, like tibetan or devenagari. Don't expect pretty output when using 27 rules, like tibetan or devenagari. Don't expect pretty output when using
28 these scripts. Most other scripts, latin, cyrillic, kanji, thai etc. 28 these scripts. Most other scripts, latin, cyrillic, kanji, thai etc.
29 should work fine, though. A somewhat difficult case are left-to-right 29 should work fine, though. A somewhat difficult case are right-to-left
30 scripts, such as hebrew: rxvt-unicode adopts the view that bidirectional 30 scripts, such as hebrew: rxvt-unicode adopts the view that bidirectional
31 algorithms belong into the application, not the terminal emulator (too 31 algorithms belong into the application, not the terminal emulator (too
32 many things -- such as cursor-movement while editing -- break 32 many things -- such as cursor-movement while editing -- break
33 otherwise), but that might change. 33 otherwise), but that might change.
34 34
35 If you are looking for a terminal that supports more exotic scripts, let 35 If you are looking for a terminal that supports more exotic scripts, let
36 me recommend "mlterm", which is a very userfriendly, lean and clean 36 me recommend "mlterm", which is a very user friendly, lean and clean
37 terminal emulator. In fact, the reason rxvt-unicode was born was solely 37 terminal emulator. In fact, the reason rxvt-unicode was born was solely
38 because the author couldn't get "mlterm" to use one font for latin1 and 38 because the author couldn't get "mlterm" to use one font for latin1 and
39 another for japanese. 39 another for japanese.
40 40
41 Therefore another design rationale was the use of multiple fonts to 41 Therefore another design rationale was the use of multiple fonts to
43 programs force onto its users never made sense to me: You should be able 43 programs force onto its users never made sense to me: You should be able
44 to choose any font for any script freely. 44 to choose any font for any script freely.
45 45
46 Apart from that, rxvt-unicode is also much better internationalised than 46 Apart from that, rxvt-unicode is also much better internationalised than
47 its predecessor, supports things such as XFT and ISO 14755 that are 47 its predecessor, supports things such as XFT and ISO 14755 that are
48 handy in i18n-environments, is faster, and has a lot less bugs than the 48 handy in i18n-environments, is faster, and has a lot bugs less than the
49 original rxvt. This all in addition to dozens of other small 49 original rxvt. This all in addition to dozens of other small
50 improvements. 50 improvements.
51 51
52 It is still faithfully following the original rxvt idea of being lean 52 It is still faithfully following the original rxvt idea of being lean
53 and nice on resources: for example, you can still configure rxvt-unicode 53 and nice on resources: for example, you can still configure rxvt-unicode
54 without most of its features to get a lean binary. It also comes with a 54 without most of its features to get a lean binary. It also comes with a
55 client/daemon pair that lets you open any number of terminal windows 55 client/daemon pair that lets you open any number of terminal windows
56 from within a single process, which makes startup time very fast and 56 from within a single process, which makes startup time very fast and
57 drastically reduces memory usage. See urxvtd(1) (daemon) and urxvtc(1) 57 drastically reduces memory usage. See rxvtd(1) (daemon) and rxvtc(1)
58 (client). 58 (client).
59 59
60 It also makes technical information about escape sequences (which have 60 It also makes technical information about escape sequences (which have
61 been extended) easier accessible: see urxvt(7) for technical reference 61 been extended) more accessible: see rxvt(7) for technical reference
62 documentation (escape sequences etc.). 62 documentation (escape sequences etc.).
63 63
64OPTIONS 64OPTIONS
65 The urxvt options (mostly a subset of *xterm*'s) are listed below. In 65 The rxvt options (mostly a subset of *xterm*'s) are listed below. In
66 keeping with the smaller-is-better philosophy, options may be eliminated 66 keeping with the smaller-is-better philosophy, options may be eliminated
67 or default values chosen at compile-time, so options and defaults listed 67 or default values chosen at compile-time, so options and defaults listed
68 may not accurately reflect the version installed on your system. `urxvt 68 may not accurately reflect the version installed on your system. `rxvt
69 -h' gives a list of major compile-time options on the *Options* line. 69 -h' gives a list of major compile-time options on the *Options* line.
70 Option descriptions may be prefixed with which compile option each is 70 Option descriptions may be prefixed with which compile option each is
71 dependent upon. e.g. `Compile *XIM*:' requires *XIM* on the *Options* 71 dependent upon. e.g. `Compile *XIM*:' requires *XIM* on the *Options*
72 line. Note: `urxvt -help' gives a list of all command-line options 72 line. Note: `rxvt -help' gives a list of all command-line options
73 compiled into your version. 73 compiled into your version.
74 74
75 Note that urxvt permits the resource name to be used as a long-option 75 Note that rxvt permits the resource name to be used as a long-option
76 (--/++ option) so the potential command-line options are far greater 76 (--/++ option) so the potential command-line options are far greater
77 than those listed. For example: `urxvt --loginShell --color1 Orange'. 77 than those listed. For example: `rxvt --loginShell --color1 Orange'.
78 78
79 The following options are available: 79 The following options are available:
80 80
81 -help, --help 81 -help, --help
82 Print out a message describing available options. 82 Print out a message describing available options.
102 -ip|+ip | -tr|+tr 102 -ip|+ip | -tr|+tr
103 Turn on/off inheriting parent window's pixmap. Alternative form is 103 Turn on/off inheriting parent window's pixmap. Alternative form is
104 -tr; resource inheritPixmap. 104 -tr; resource inheritPixmap.
105 105
106 *Please note that transparency of any kind if completely unsupported 106 *Please note that transparency of any kind if completely unsupported
107 by the author. Don't bug him with installation questions!* 107 by the author. Don't bug him with installation questions! Read the
108 FAQ (man 7 rxvt)!*
108 109
109 -fade *number* 110 -fade *number*
110 Fade the text by the given percentage when focus is lost. Small 111 Fade the text by the given percentage when focus is lost. Small
111 values fade a little only, 100 completely replaces all colours by 112 values fade a little only, 100 completely replaces all colours by
112 the fade colour; resource fading. 113 the fade colour; resource fading.
120 transparency is enabled with -tr or -ip. This only works for 121 transparency is enabled with -tr or -ip. This only works for
121 non-tiled backgrounds, currently. See also the -sh option that can 122 non-tiled backgrounds, currently. See also the -sh option that can
122 be used to brighten or darken the image in addition to tinting it; 123 be used to brighten or darken the image in addition to tinting it;
123 resource *tintColor*. Example: 124 resource *tintColor*. Example:
124 125
125 urxvt -tr -tint blue -sh 40 126 rxvt -tr -tint blue -sh 40
126 127
127 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent 128 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent
128 background image in addition to tinting it (i.e. -tint must be 129 background image in addition to tinting it (i.e. -tint must be
129 specified, too, e.g. "-tint white"). 130 specified, too, e.g. "-tint white").
130 131
163 164
164 In short, to specify an X11 core font, just specify its name or 165 In short, to specify an X11 core font, just specify its name or
165 prefix it with "x:". To specify an XFT-font, you need to prefix it 166 prefix it with "x:". To specify an XFT-font, you need to prefix it
166 with "xft:", e.g.: 167 with "xft:", e.g.:
167 168
168 urxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 169 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
169 urxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" 170 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
170 171
171 See also the question "How does rxvt-unicode choose fonts?" in the 172 See also the question "How does rxvt-unicode choose fonts?" in the
172 FAQ section of urxvt(7). 173 FAQ section of rxvt(7).
173 174
174 -fb *fontlist* 175 -fb *fontlist*
175 Compile *font-styles*: The bold font list to use when bold 176 Compile *font-styles*: The bold font list to use when bold
176 characters are to be printed. See resource boldFont for details. 177 characters are to be printed. See resource boldFont for details.
177 178
281 TERM environment variable. This terminal type must exist in the 282 TERM environment variable. This terminal type must exist in the
282 *termcap(5)* database and should have *li#* and *co#* entries; 283 *termcap(5)* database and should have *li#* and *co#* entries;
283 resource termName. 284 resource termName.
284 285
285 -e *command [arguments]* 286 -e *command [arguments]*
286 Run the command with its command-line arguments in the urxvt window; 287 Run the command with its command-line arguments in the rxvt window;
287 also sets the window title and icon name to be the basename of the 288 also sets the window title and icon name to be the basename of the
288 program being executed if neither *-title* (*-T*) nor *-n* are given 289 program being executed if neither *-title* (*-T*) nor *-n* are given
289 on the command line. If this option is used, it must be the last on 290 on the command line. If this option is used, it must be the last on
290 the command-line. If there is no -e option then the default is to 291 the command-line. If there is no -e option then the default is to
291 run the program specified by the SHELL environment variable or, 292 run the program specified by the SHELL environment variable or,
293 294
294 Please note that you must specify a program with arguments. If you 295 Please note that you must specify a program with arguments. If you
295 want to run shell commands, you have to specify the shell, like 296 want to run shell commands, you have to specify the shell, like
296 this: 297 this:
297 298
298 urxvt -e sh -c "shell commands" 299 rxvt -e sh -c "shell commands"
299 300
300 -title *text* 301 -title *text*
301 Window title (-T still respected); the default title is the basename 302 Window title (-T still respected); the default title is the basename
302 of the program specified after the -e option, if any, otherwise the 303 of the program specified after the -e option, if any, otherwise the
303 application name; resource title. 304 application name; resource title.
348 -ssr|+ssr 349 -ssr|+ssr
349 Turn on/off secondary screen scroll (default enabled); resource 350 Turn on/off secondary screen scroll (default enabled); resource
350 secondaryScroll. 351 secondaryScroll.
351 352
352 -hold|+hold 353 -hold|+hold
353 Turn on/off hold window after exit support. If enabled, urxvt will 354 Turn on/off hold window after exit support. If enabled, rxvt will
354 not immediately destroy its window when the program executed within 355 not immediately destroy its window when the program executed within
355 it exits. Instead, it will wait till it is being killed or closed by 356 it exits. Instead, it will wait till it is being killed or closed by
356 the user; resource hold. 357 the user; resource hold.
357 358
358 -keysym.*sym* *string* 359 -keysym.*sym* *string*
359 Remap a key symbol. See resource keysym. 360 Remap a key symbol. See resource keysym.
360 361
361 -embed *windowid* 362 -embed *windowid*
362 Tells urxvt to embed its windows into an already-existing window, 363 Tells rxvt to embed its windows into an already-existing window,
363 which enables applications to easily embed a terminal. 364 which enables applications to easily embed a terminal.
364 365
365 Right now, urxvt will first unmap/map the specified window, so it 366 Right now, rxvt will first unmap/map the specified window, so it
366 shouldn't be a top-level window. urxvt will also reconfigure it 367 shouldn't be a top-level window. rxvt will also reconfigure it quite
367 quite a bit, so don't expect it to keep some specific state. It's 368 a bit, so don't expect it to keep some specific state. It's best to
368 best to create an extra subwindow for urxvt and leave it alone. 369 create an extra subwindow for rxvt and leave it alone.
369 370
370 The window will not be destroyed when urxvt exits. 371 The window will not be destroyed when rxvt exits.
371 372
372 It might be useful to know that urxvt will not close file 373 It might be useful to know that rxvt will not close file descriptors
373 descriptors passed to it (except for stdin/out/err, of course), so 374 passed to it (except for stdin/out/err, of course), so you can use
374 you can use file descriptors to communicate with the programs within 375 file descriptors to communicate with the programs within the
375 the terminal. This works regardless of wether the "-embed" option 376 terminal. This works regardless of whether the "-embed" option was
376 was used or not. 377 used or not.
377 378
378 Here is a short Gtk2-perl snippet that illustrates how this option 379 Here is a short Gtk2-perl snippet that illustrates how this option
379 can be used (a longer example is in doc/embed): 380 can be used (a longer example is in doc/embed):
380 381
381 my $rxvt = new Gtk2::Socket; 382 my $rxvt = new Gtk2::Socket;
382 $rxvt->signal_connect_after (realize => sub { 383 $rxvt->signal_connect_after (realize => sub {
383 my $xid = $_[0]->window->get_xid; 384 my $xid = $_[0]->window->get_xid;
384 system "urxvt -embed $xid &"; 385 system "rxvt -embed $xid &";
385 }); 386 });
386 387
387 -pty-fd *file descriptor* 388 -pty-fd *file descriptor*
388 Tells urxvt NOT to execute any commands or create a new pty/tty pair 389 Tells rxvt NOT to execute any commands or create a new pty/tty pair
389 but instead use the given filehandle as the tty master. This is 390 but instead use the given file descriptor as the tty master. This is
390 useful if you want to drive urxvt as a generic terminal emulator 391 useful if you want to drive rxvt as a generic terminal emulator
391 without having to run a program within it. 392 without having to run a program within it.
392 393
393 If this switch is given, urxvt will not create any utmp/wtmp entries 394 If this switch is given, rxvt will not create any utmp/wtmp entries
394 and will not tinker with pty/tty permissions - you have to do that 395 and will not tinker with pty/tty permissions - you have to do that
395 yourself if you want that. 396 yourself if you want that.
396 397
397 As an extremely special case, specifying -1 will completely suppress 398 As an extremely special case, specifying -1 will completely suppress
398 pty/tty operations. 399 pty/tty operations.
403 use IO::Pty; 404 use IO::Pty;
404 use Fcntl; 405 use Fcntl;
405 406
406 my $pty = new IO::Pty; 407 my $pty = new IO::Pty;
407 fcntl $pty, F_SETFD, 0; # clear close-on-exec 408 fcntl $pty, F_SETFD, 0; # clear close-on-exec
408 system "urxvt -pty-fd " . (fileno $pty) . "&"; 409 system "rxvt -pty-fd " . (fileno $pty) . "&";
409 close $pty; 410 close $pty;
410 411
411 # now communicate with rxvt 412 # now communicate with rxvt
412 my $slave = $pty->slave; 413 my $slave = $pty->slave;
413 while (<$slave>) { print $slave "got <$_>\n" } 414 while (<$slave>) { print $slave "got <$_>\n" }
415 -pe *string* 416 -pe *string*
416 Comma-separated list of perl extension scripts to use (or not to 417 Comma-separated list of perl extension scripts to use (or not to
417 use) in this terminal instance. See resource perl-ext for details. 418 use) in this terminal instance. See resource perl-ext for details.
418 419
419RESOURCES (available also as long-options) 420RESOURCES (available also as long-options)
420 Note: `urxvt --help' gives a list of all resources (long options) 421 Note: `rxvt --help' gives a list of all resources (long options)
421 compiled into your version. 422 compiled into your version.
422 423
423 You can set and change the resources using X11 tools like xrdb. Many 424 You can set and change the resources using X11 tools like xrdb. Many
424 distribution do also load settings from the ~/.Xresources file when X 425 distribution do also load settings from the ~/.Xresources file when X
425 starts. urxvt will consult the following files/resources in order, with 426 starts. rxvt will consult the following files/resources in order, with
426 later settings overwriting earlier ones: 427 later settings overwriting earlier ones:
427 428
428 1. system-wide app-defaults file, either locale-dependent OR global 429 1. system-wide app-defaults file, either locale-dependent OR global
429 2. app-defaults file in $XAPPLRESDIR 430 2. app-defaults file in $XAPPLRESDIR
430 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 431 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
431 4. SCREEN_RESOURCES for the current screen 432 4. SCREEN_RESOURCES for the current screen
432 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 433 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
433 434
434 Note that when reading X resources, urxvt recognizes two class names: 435 Note that when reading X resources, rxvt recognizes two class names:
435 Rxvt and URxvt. The class name Rxvt allows resources common to both 436 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
436 urxvt and the original *rxvt* to be easily configured, while the class 437 and the original *rxvt* to be easily configured, while the class name
437 name URxvt allows resources unique to urxvt, to be shared between 438 URxvt allows resources unique to rxvt, to be shared between different
438 different urxvt configurations. If no resources are specified, suitable 439 rxvt configurations. If no resources are specified, suitable defaults
439 defaults will be used. Command-line arguments can be used to override 440 will be used. Command-line arguments can be used to override resource
440 resource settings. The following resources are supported (you might want 441 settings. The following resources are supported (you might want to check
441 to check the urxvtperl(3) manpage for additional settings by perl 442 the rxvtperl(3) manpage for additional settings by perl extensions not
442 extensions not documented here): 443 documented here):
443 444
444 depth: *bitdepth* 445 depth: *bitdepth*
445 Compile *xft*: Attempt to find a visual with the given bit depth; 446 Compile *xft*: Attempt to find a visual with the given bit depth;
446 option -depth. 447 option -depth.
447 448
465 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but 466 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but
466 the actual colour names used are listed in the COLORS AND GRAPHICS 467 the actual colour names used are listed in the COLORS AND GRAPHICS
467 section. 468 section.
468 469
469 Colours higher than 15 cannot be set using resources (yet), but can 470 Colours higher than 15 cannot be set using resources (yet), but can
470 be changed using an escape command (see urxvt(7)). 471 be changed using an escape command (see rxvt(7)).
471 472
472 Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm 473 Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm
473 with 88 colour support). Colours 80-87 are evenly spaces grey steps. 474 with 88 colour support). Colours 80-87 are evenly spaces grey steps.
474 475
475 colorBD: *colour* 476 colorBD: *colour*
622 normal text font will being used for the given style. 623 normal text font will being used for the given style.
623 624
624 intensityStyles: *boolean* 625 intensityStyles: *boolean*
625 When font styles are not enabled, or this option is enabled (True, 626 When font styles are not enabled, or this option is enabled (True,
626 option -is, the default), bold and italic font styles imply high 627 option -is, the default), bold and italic font styles imply high
627 intensity foreground/backround colours. Disabling this option 628 intensity foreground/background colours. Disabling this option
628 (False, option +is) disables this behaviour, the high intensity 629 (False, option +is) disables this behaviour, the high intensity
629 colours are not reachable. 630 colours are not reachable.
630 631
631 selectstyle: *mode* 632 selectstyle: *mode*
632 Set mouse selection style to old which is 2.20, oldword which is 633 Set mouse selection style to old which is 2.20, oldword which is
675 Example: 676 Example:
676 677
677 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 678 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
678 679
679 This creates a new file in your home directory with the screen 680 This creates a new file in your home directory with the screen
680 contents everytime you hit "Print". 681 contents every time you hit "Print".
681 682
682 scrollBar: *boolean* 683 scrollBar: *boolean*
683 True: enable the scrollbar [default]; option -sb. False: disable the 684 True: enable the scrollbar [default]; option -sb. False: disable the
684 scrollbar; option +sb. 685 scrollbar; option +sb.
685 686
700 do not scroll to bottom when tty receives output; option +si. 701 do not scroll to bottom when tty receives output; option +si.
701 702
702 scrollWithBuffer: *boolean* 703 scrollWithBuffer: *boolean*
703 True: scroll with scrollback buffer when tty receives new lines (and 704 True: scroll with scrollback buffer when tty receives new lines (and
704 scrollTtyOutput is False); option -sw. False: do not scroll with 705 scrollTtyOutput is False); option -sw. False: do not scroll with
705 scrollback buffer when tty recieves new lines; option +sw. 706 scrollback buffer when tty receives new lines; option +sw.
706 707
707 scrollTtyKeypress: *boolean* 708 scrollTtyKeypress: *boolean*
708 True: scroll to bottom when a non-special key is pressed. Special 709 True: scroll to bottom when a non-special key is pressed. Special
709 keys are those which are intercepted by rxvt-unicode for special 710 keys are those which are intercepted by rxvt-unicode for special
710 handling and are not passed onto the shell; option -sk. False: do 711 handling and are not passed onto the shell; option -sk. False: do
787 cutchars: *string* 788 cutchars: *string*
788 The characters used as delimiters for double-click word selection 789 The characters used as delimiters for double-click word selection
789 (whitespace delimiting is added automatically if resource is given). 790 (whitespace delimiting is added automatically if resource is given).
790 791
791 When the selection extension is in use (the default if compiled in, 792 When the selection extension is in use (the default if compiled in,
792 see the urxvtperl(3) manpage), a suitable regex using these 793 see the rxvtperl(3) manpage), a suitable regex using these
793 characters will be created (if the resource exists, otherwise, no 794 characters will be created (if the resource exists, otherwise, no
794 regex will be created). In this mode, characters outside ISO-8859-1 795 regex will be created). In this mode, characters outside ISO-8859-1
795 can be used. 796 can be used.
796 797
797 When the selection extension is not used, only ISO-8859-1 characters 798 When the selection extension is not used, only ISO-8859-1 characters
813 814
814 imFont: *fontset* 815 imFont: *fontset*
815 Specify the font-set used for XIM styles "OverTheSpot" or 816 Specify the font-set used for XIM styles "OverTheSpot" or
816 "OffTheSpot". It must be a standard X font set (XLFD patterns 817 "OffTheSpot". It must be a standard X font set (XLFD patterns
817 separated by commas), i.e. it's not in the same format as the other 818 separated by commas), i.e. it's not in the same format as the other
818 font lists used in urxvt. The default will be set-up to chose *any* 819 font lists used in rxvt. The default will be set-up to chose *any*
819 suitable found found, preferably one or two pixels differing in size 820 suitable found found, preferably one or two pixels differing in size
820 to the base font. option -imfont. 821 to the base font. option -imfont.
821 822
822 tripleclickwords: *boolean* 823 tripleclickwords: *boolean*
823 Change the meaning of triple-click selection with the left mouse 824 Change the meaning of triple-click selection with the left mouse
855 option is enabled, scrolls on the secondary screen will change the 856 option is enabled, scrolls on the secondary screen will change the
856 scrollback buffer and switching to/from the secondary screen will 857 scrollback buffer and switching to/from the secondary screen will
857 instead scroll the screen up. 858 instead scroll the screen up.
858 859
859 hold: *boolean* 860 hold: *boolean*
860 Turn on/off hold window after exit support. If enabled, urxvt will 861 Turn on/off hold window after exit support. If enabled, rxvt will
861 not immediately destroy its window when the program executed within 862 not immediately destroy its window when the program executed within
862 it exits. Instead, it will wait till it is being killed or closed by 863 it exits. Instead, it will wait till it is being killed or closed by
863 the user. 864 the user.
864 865
865 keysym.*sym*: *string* 866 keysym.*sym*: *string*
889 "^@": null, "^A" ...) and may be enclosed with double quotes so that 890 "^@": null, "^A" ...) and may be enclosed with double quotes so that
890 it can start or end with whitespace. 891 it can start or end with whitespace.
891 892
892 Please note that you need to double the "\" in resource files, as 893 Please note that you need to double the "\" in resource files, as
893 Xlib itself does its own de-escaping (you can use "\033" instead of 894 Xlib itself does its own de-escaping (you can use "\033" instead of
894 "\e" (and so on), which will work with both Xt and urxvt's own 895 "\e" (and so on), which will work with both Xt and rxvt's own
895 processing). 896 processing).
896 897
897 You can define a range of keysyms in one shot by providing a 898 You can define a range of keysyms in one shot by providing a
898 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 899 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimiter
899 `/' should be a character not used by the strings. 900 `/' should be a character not used by the strings.
900 901
901 Its usage can be demonstrated by an example: 902 Its usage can be demonstrated by an example:
902 903
903 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 904 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
907 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 908 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
908 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 909 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
909 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 910 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
910 911
911 If *string* takes the form of "command:STRING", the specified STRING 912 If *string* takes the form of "command:STRING", the specified STRING
912 is interpreted and executed as urxvt's control sequence. For example 913 is interpreted and executed as rxvt's control sequence. For example
913 the following means "change the current locale to "zh_CN.GBK" when 914 the following means "change the current locale to "zh_CN.GBK" when
914 Control-Meta-c is being pressed": 915 Control-Meta-c is being pressed":
915 916
916 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 917 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
917 918
918 If *string* takes the form "perl:STRING", then the specified STRING 919 If *string* takes the form "perl:STRING", then the specified STRING
919 is passed to the "on_keyboard_command" perl handler. See the 920 is passed to the "on_keyboard_command" perl handler. See the
920 urxvtperl(3) manpage. For example, the selection extension 921 rxvtperl(3) manpage. For example, the selection extension (activated
921 (activated via "urxvt -pe selection") listens for "selection:rot13" 922 via "rxvt -pe selection") listens for "selection:rot13" events:
922 events:
923 923
924 URxvt.keysym.M-C-c: perl:selection:rot13 924 URxvt.keysym.M-C-c: perl:selection:rot13
925 925
926 Due the the large number of modifier combinations, a defined key 926 Due the the large number of modifier combinations, a defined key
927 mapping will match if at *at least* the specified identifiers are 927 mapping will match if at *at least* the specified identifiers are
929 being defined. That means that defining a key map for "a" will 929 being defined. That means that defining a key map for "a" will
930 automatically provide definitions for "Meta-a", "Shift-a" and so on, 930 automatically provide definitions for "Meta-a", "Shift-a" and so on,
931 unless some of those are defined mappings themselves. 931 unless some of those are defined mappings themselves.
932 932
933 Unfortunately, this will override built-in key mappings. For example 933 Unfortunately, this will override built-in key mappings. For example
934 if you overwrite the "Insert" key you will disable urxvt's 934 if you overwrite the "Insert" key you will disable rxvt's
935 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into 935 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
936 the user-defined keymap using the "builtin:" replacement: 936 the user-defined keymap using the "builtin:" replacement:
937 937
938 URxvt.keysym.Insert: <my insert key sequence> 938 URxvt.keysym.Insert: <my insert key sequence>
939 URxvt.keysym.S-Insert: builtin: 939 URxvt.keysym.S-Insert: builtin:
947 font-switching at runtime: 947 font-switching at runtime:
948 948
949 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 949 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
950 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 950 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
951 951
952 Other things are possible, e.g. resizing (see urxvt(7) for more 952 Other things are possible, e.g. resizing (see rxvt(7) for more
953 info): 953 info):
954 954
955 URxvt.keysym.M-C-3: command:\033[8;25;80t 955 URxvt.keysym.M-C-3: command:\033[8;25;80t
956 URxvt.keysym.M-C-4: command:\033[8;48;110t 956 URxvt.keysym.M-C-4: command:\033[8;48;110t
957 957
966 For example, "default,-selection" will use all the default extension 966 For example, "default,-selection" will use all the default extension
967 except "selection". 967 except "selection".
968 968
969 Extension names can also be followed by an argument in angle 969 Extension names can also be followed by an argument in angle
970 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey 970 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
971 for searchable scorllback to Alt/Meta-s). Mentioning the same 971 for searchable scrollback to Alt/Meta-s). Mentioning the same
972 extension multiple times with different arguments will pass multiple 972 extension multiple times with different arguments will pass multiple
973 arguments to the extension. 973 arguments to the extension.
974 974
975 Each extension is looked up in the library directories, loaded if 975 Each extension is looked up in the library directories, loaded if
976 necessary, and bound to the current terminal instance. 976 necessary, and bound to the current terminal instance.
981 available to all instances, while perl-ext is used for specific 981 available to all instances, while perl-ext is used for specific
982 instances. 982 instances.
983 983
984 perl-eval: *string* 984 perl-eval: *string*
985 Perl code to be evaluated when all extensions have been registered. 985 Perl code to be evaluated when all extensions have been registered.
986 See the urxvtperl(3) manpage. Due to security reasons, this resource 986 See the rxvtperl(3) manpage. Due to security reasons, this resource
987 will be ignored when running setuid/setgid. 987 will be ignored when running setuid/setgid.
988 988
989 perl-lib: *path* 989 perl-lib: *path*
990 Colon-separated list of additional directories that hold extension 990 Colon-separated list of additional directories that hold extension
991 scripts. When looking for extensions specified by the "perl" 991 scripts. When looking for extensions specified by the "perl"
992 resource, urxvt will first look in these directories and then in 992 resource, rxvt will first look in these directories and then in
993 /usr/local/lib/urxvt/perl/. Due to security reasons, this resource 993 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
994 will be ignored when running setuid/setgid. 994 will be ignored when running setuid/setgid.
995 995
996 See the urxvtperl(3) manpage. 996 See the rxvtperl(3) manpage.
997 997
998 selection.pattern-*idx*: *perl-regex* 998 selection.pattern-*idx*: *perl-regex*
999 Additional selection patterns, see the urxvtperl(3) manpage for 999 Additional selection patterns, see the rxvtperl(3) manpage for
1000 details. 1000 details.
1001 1001
1002 selection-autotransform.*idx*: *perl-transform* 1002 selection-autotransform.*idx*: *perl-transform*
1003 Selection auto-transform patterns, see the urxvtperl(3) manpage for 1003 Selection auto-transform patterns, see the rxvtperl(3) manpage for
1004 details. 1004 details.
1005 1005
1006 searchable-scrollback: *keysym* 1006 searchable-scrollback: *keysym*
1007 Sets the hotkey that starts the incremental scrollback buffer search 1007 Sets the hotkey that starts the incremental scrollback buffer search
1008 (default: "M-s"). 1008 (default: "M-s").
1019 Compile *frills*: Sets override-redirect for the terminal window, 1019 Compile *frills*: Sets override-redirect for the terminal window,
1020 making it almost invisible to window managers; option 1020 making it almost invisible to window managers; option
1021 -override-redirect. 1021 -override-redirect.
1022 1022
1023THE SCROLLBAR 1023THE SCROLLBAR
1024 Lines of text that scroll off the top of the urxvt window (resource: 1024 Lines of text that scroll off the top of the rxvt window (resource:
1025 saveLines) and can be scrolled back using the scrollbar or by 1025 saveLines) and can be scrolled back using the scrollbar or by
1026 keystrokes. The normal urxvt scrollbar has arrows and its behaviour is 1026 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
1027 fairly intuitive. The xterm-scrollbar is without arrows and its 1027 fairly intuitive. The xterm-scrollbar is without arrows and its
1028 behaviour mimics that of *xterm* 1028 behaviour mimics that of *xterm*
1029 1029
1030 Scroll down with Button1 (xterm-scrollbar) or Shift-Next. Scroll up with 1030 Scroll down with Button1 (xterm-scrollbar) or Shift-Next. Scroll up with
1031 Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with 1031 Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with
1058 normal one. In this mode, every selected row becomes its own line in 1058 normal one. In this mode, every selected row becomes its own line in
1059 the selection, and trailing whitespace is visually underlined and 1059 the selection, and trailing whitespace is visually underlined and
1060 removed from the selection. 1060 removed from the selection.
1061 1061
1062 Insertion: 1062 Insertion:
1063 Pressing and releasing the Middle mouse button in an urxvt window 1063 Pressing and releasing the Middle mouse button in an rxvt window
1064 causes the value of the PRIMARY selection (or CLIPBOARD with the 1064 causes the value of the PRIMARY selection (or CLIPBOARD with the
1065 Meta modifier) to be inserted as if it had been typed on the 1065 Meta modifier) to be inserted as if it had been typed on the
1066 keyboard. 1066 keyboard.
1067 1067
1068 Pressing Shift-Insert causes the value of the PRIMARY selection to 1068 Pressing Shift-Insert causes the value of the PRIMARY selection to
1146 1146
1147 With respect to conformance, rxvt-unicode is supposed to be compliant to 1147 With respect to conformance, rxvt-unicode is supposed to be compliant to
1148 both scenario A and B of ISO 14755, including part 5.2. 1148 both scenario A and B of ISO 14755, including part 5.2.
1149 1149
1150LOGIN STAMP 1150LOGIN STAMP
1151 urxvt tries to write an entry into the *utmp*(5) file so that it can be 1151 rxvt tries to write an entry into the *utmp*(5) file so that it can be
1152 seen via the *who(1)* command, and can accept messages. To allow this 1152 seen via the *who(1)* command, and can accept messages. To allow this
1153 feature, urxvt may need to be installed setuid root on some systems or 1153 feature, rxvt may need to be installed setuid root on some systems or
1154 setgid to root or to some other group on others. 1154 setgid to root or to some other group on others.
1155 1155
1156COLORS AND GRAPHICS 1156COLORS AND GRAPHICS
1157 In addition to the default foreground and background colours, urxvt can 1157 In addition to the default foreground and background colours, rxvt can
1158 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 1158 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
1159 versions of the same). Here is a list of the colours with their names. 1159 versions of the same). Here is a list of the colours with their names.
1160 1160
1161 color0 (black) = Black 1161 color0 (black) = Black
1162 color1 (red) = Red3 1162 color1 (red) = Red3
1179 It is also possible to specify the colour values of foreground, 1179 It is also possible to specify the colour values of foreground,
1180 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1180 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1181 0-15, as a convenient shorthand to reference the colour name of 1181 0-15, as a convenient shorthand to reference the colour name of
1182 color0-color15. 1182 color0-color15.
1183 1183
1184 In addition to the colours defined above, urxvt offers an additional 72 1184 In addition to the colours defined above, rxvt offers an additional 72
1185 colours. The first 64 of those (with indices 16 to 79) consist of a 1185 colours. The first 64 of those (with indices 16 to 79) consist of a
1186 4*4*4 RGB colour cube (i.e. *index = r * 16 + g * 4 + b + 16*), followed 1186 4*4*4 RGB colour cube (i.e. *index = r * 16 + g * 4 + b + 16*), followed
1187 by 8 additional shades of gray (with indices 80 to 87). 1187 by 8 additional shades of gray (with indices 80 to 87).
1188 1188
1189 Together, all those colours implement the 88 colour xterm colours. Only 1189 Together, all those colours implement the 88 colour xterm colours. Only
1193 Note that -rv ("reverseVideo: True") simulates reverse video by always 1193 Note that -rv ("reverseVideo: True") simulates reverse video by always
1194 swapping the foreground/background colours. This is in contrast to 1194 swapping the foreground/background colours. This is in contrast to
1195 *xterm*(1) where the colours are only swapped if they have not otherwise 1195 *xterm*(1) where the colours are only swapped if they have not otherwise
1196 been specified. For example, 1196 been specified. For example,
1197 1197
1198 urxvt -fg Black -bg White -rv 1198 rxvt -fg Black -bg White -rv
1199 would yield White on Black, while on *xterm*(1) it would yield Black 1199 would yield White on Black, while on *xterm*(1) it would yield Black
1200 on White. 1200 on White.
1201 1201
1202 ALPHA CHANNEL SUPPORT 1202 ALPHA CHANNEL SUPPORT
1203 If Xft support has been compiled in and as long as Xft/Xrender/X don't 1203 If Xft support has been compiled in and as long as Xft/Xrender/X don't
1214 ARGB visuals out of the box, and rxvt-unicode just fudges around. 1214 ARGB visuals out of the box, and rxvt-unicode just fudges around.
1215 1215
1216 For example, the following selects an almost completely transparent red 1216 For example, the following selects an almost completely transparent red
1217 background, and an almost opaque pink foreground: 1217 background, and an almost opaque pink foreground:
1218 1218
1219 urxvt -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink" 1219 rxvt -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
1220 1220
1221 *Please note that transparency of any kind if completely unsupported by 1221 *Please note that transparency of any kind if completely unsupported by
1222 the author. Don't bug him with installation questions!* 1222 the author. Don't bug him with installation questions!*
1223 1223
1224ENVIRONMENT 1224ENVIRONMENT
1225 urxvt sets and/or uses the following environment variables: 1225 rxvt sets and/or uses the following environment variables:
1226 1226
1227 TERM 1227 TERM
1228 Normally set to "rxvt-unicode", unless overwritten at configure 1228 Normally set to "rxvt-unicode", unless overwritten at configure
1229 time, via resources or on the commandline. 1229 time, via resources or on the command line.
1230 1230
1231 COLORTERM 1231 COLORTERM
1232 Either "rxvt", "rxvt-xpm", depending on wether urxvt was compiled 1232 Either "rxvt", "rxvt-xpm", depending on whether rxvt was compiled
1233 with XPM support, and optionally with the added extension "-mono" to 1233 with XPM support, and optionally with the added extension "-mono" to
1234 indicate that rxvt-unicode runs on a monochrome screen. 1234 indicate that rxvt-unicode runs on a monochrome screen.
1235 1235
1236 COLORFGBG 1236 COLORFGBG
1237 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is 1237 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1238 the colour code used as default foreground/text colour (or the 1238 the colour code used as default foreground/text colour (or the
1239 string "default" to indicate that the default-colour escape sequence 1239 string "default" to indicate that the default-colour escape sequence
1240 is to be used), "bg" is the colour code used as default background 1240 is to be used), "bg" is the colour code used as default background
1241 colour (or the string "default"), and "xpm" is the string "default" 1241 colour (or the string "default"), and "xpm" is the string "default"
1242 if urxvt was compiled with XPM support. Libraries like "ncurses" and 1242 if rxvt was compiled with XPM support. Libraries like "ncurses" and
1243 "slang" can (and do) use this information to optimize screen output. 1243 "slang" can (and do) use this information to optimize screen output.
1244 1244
1245 WINDOWID 1245 WINDOWID
1246 Set to the (decimal) X Window ID of the urxvt window (the toplevel 1246 Set to the (decimal) X Window ID of the rxvt window (the toplevel
1247 window, which usually has subwindows for the scrollbar, the terminal 1247 window, which usually has subwindows for the scrollbar, the terminal
1248 window and so on). 1248 window and so on).
1249 1249
1250 TERMINFO 1250 TERMINFO
1251 Set to the terminfo directory iff urxvt was configured with 1251 Set to the terminfo directory iff rxvt was configured with
1252 "--with-terminfo=PATH". 1252 "--with-terminfo=PATH".
1253 1253
1254 DISPLAY 1254 DISPLAY
1255 Used by urxvt to connect to the display and set to the correct 1255 Used by rxvt to connect to the display and set to the correct
1256 display in its child processes. 1256 display in its child processes.
1257 1257
1258 SHELL 1258 SHELL
1259 The shell to be used for command execution, defaults to "/bin/sh". 1259 The shell to be used for command execution, defaults to "/bin/sh".
1260 1260
1261 RXVT_SOCKET 1261 RXVT_SOCKET
1262 The unix domain socket path used by urxvtc(1) and urxvtd(1). 1262 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1263 1263
1264 Default $HOME/.rxvt-unicode-*<nodename*. 1264 Default $HOME/.rxvt-unicode-*<nodename*.
1265 1265
1266 HOME 1266 HOME
1267 Used to locate the default directory for the unix domain socket for 1267 Used to locate the default directory for the unix domain socket for
1271 XAPPLRESDIR 1271 XAPPLRESDIR
1272 Directory where various X resource files are being located. 1272 Directory where various X resource files are being located.
1273 1273
1274 XENVIRONMENT 1274 XENVIRONMENT
1275 If set and accessible, gives the name of a X resource file to be 1275 If set and accessible, gives the name of a X resource file to be
1276 loaded by urxvt. 1276 loaded by rxvt.
1277 1277
1278FILES 1278FILES
1279 /usr/lib/X11/rgb.txt 1279 /usr/lib/X11/rgb.txt
1280 Color names. 1280 Color names.
1281 1281
1282SEE ALSO 1282SEE ALSO
1283 urxvt(7), urxvtc(1), urxvtd(1), xterm(1), sh(1), resize(1), X(1), 1283 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
1284 pty(4), tty(4), utmp(5) 1284 tty(4), utmp(5)
1285 1285
1286CURRENT PROJECT COORDINATOR 1286CURRENT PROJECT COORDINATOR
1287 Project Coordinator 1287 Project Coordinator
1288 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1288 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1289 1289

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines