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

Comparing cvsroot/rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.57 by root, Mon Feb 6 05:55:33 2006 UTC vs.
Revision 1.61 by root, Mon Jul 17 19:20:29 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 rxvt [options] [-e command [ args ]] 6 urxvt [options] [-e command [ args ]]
7 7
8DESCRIPTION 8DESCRIPTION
9 rxvt-unicode, version 7.5, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 7.8, 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 rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions 16 See urxvt(7) (try "man 7 urxvt") for a list of frequently asked
17 and answer to them and some common problems. That document is also 17 questions and answer to them and some common problems. That document is
18 accessible on the World-Wide-Web at 18 also 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
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
42 display characters: The idea of a single unicode font which many other 42 display characters: The idea of a single unicode font which many other
43 programs force onto it's users never made sense to me: You should be 43 programs force onto its users never made sense to me: You should be able
44 able 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 it's 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 less bugs 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 it's 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 rxvtd(1) (daemon) and rxvtc(1) 57 drastically reduces memory usage. See urxvtd(1) (daemon) and urxvtc(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 rxvt(7) for technical reference 61 been extended) easier accessible: see urxvt(7) for technical reference
62 documentation (escape sequences etc.). 62 documentation (escape sequences etc.).
63 63
64OPTIONS 64OPTIONS
65 The rxvt options (mostly a subset of *xterm*'s) are listed below. In 65 The urxvt 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. `rxvt 68 may not accurately reflect the version installed on your system. `urxvt
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: `rxvt -help' gives a list of all command-line options 72 line. Note: `urxvt -help' gives a list of all command-line options
73 compiled into your version. 73 compiled into your version.
74 74
75 Note that rxvt permits the resource name to be used as a long-option 75 Note that urxvt 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: `rxvt --loginShell --color1 Orange'. 77 than those listed. For example: `urxvt --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.
120 transparency is enabled with -tr or -ip. This only works for 120 transparency is enabled with -tr or -ip. This only works for
121 non-tiled backgrounds, currently. See also the -sh option that can 121 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; 122 be used to brighten or darken the image in addition to tinting it;
123 resource *tintColor*. Example: 123 resource *tintColor*. Example:
124 124
125 rxvt -tr -tint blue -sh 40 125 urxvt -tr -tint blue -sh 40
126 126
127 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent 127 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent
128 background image in addition to tinting it (i.e. -tint must be 128 background image in addition to tinting it (i.e. -tint must be
129 specified, too, e.g. "-tint white"). 129 specified, too, e.g. "-tint white").
130 130
159 characters. The first font defines the cell size for characters; 159 characters. The first font defines the cell size for characters;
160 other fonts might be smaller, but not (in general) larger. A 160 other fonts might be smaller, but not (in general) larger. A
161 (hopefully) reasonable default font list is always appended to it. 161 (hopefully) reasonable default font list is always appended to it.
162 See resource font for more details. 162 See resource font for more details.
163 163
164 In short, to specify an X11 core font, just specify it's name or 164 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 165 prefix it with "x:". To specify an XFT-font, you need to prefix it
166 with "xft:", e.g.: 166 with "xft:", e.g.:
167 167
168 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 168 urxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
169 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" 169 urxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
170 170
171 See also the question "How does rxvt-unicode choose fonts?" in the 171 See also the question "How does rxvt-unicode choose fonts?" in the
172 FAQ section of rxvt(7). 172 FAQ section of urxvt(7).
173 173
174 -fb *fontlist* 174 -fb *fontlist*
175 Compile *font-styles*: The bold font list to use when bold 175 Compile *font-styles*: The bold font list to use when bold
176 characters are to be printed. See resource boldFont for details. 176 characters are to be printed. See resource boldFont for details.
177 177
281 TERM environment variable. This terminal type must exist in the 281 TERM environment variable. This terminal type must exist in the
282 *termcap(5)* database and should have *li#* and *co#* entries; 282 *termcap(5)* database and should have *li#* and *co#* entries;
283 resource termName. 283 resource termName.
284 284
285 -e *command [arguments]* 285 -e *command [arguments]*
286 Run the command with its command-line arguments in the rxvt window; 286 Run the command with its command-line arguments in the urxvt window;
287 also sets the window title and icon name to be the basename of the 287 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 288 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 289 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 290 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, 291 run the program specified by the SHELL environment variable or,
293 293
294 Please note that you must specify a program with arguments. If you 294 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 295 want to run shell commands, you have to specify the shell, like
296 this: 296 this:
297 297
298 rxvt -e sh -c "shell commands" 298 urxvt -e sh -c "shell commands"
299 299
300 -title *text* 300 -title *text*
301 Window title (-T still respected); the default title is the basename 301 Window title (-T still respected); the default title is the basename
302 of the program specified after the -e option, if any, otherwise the 302 of the program specified after the -e option, if any, otherwise the
303 application name; resource title. 303 application name; resource title.
348 -ssr|+ssr 348 -ssr|+ssr
349 Turn on/off secondary screen scroll (default enabled); resource 349 Turn on/off secondary screen scroll (default enabled); resource
350 secondaryScroll. 350 secondaryScroll.
351 351
352 -hold|+hold 352 -hold|+hold
353 Turn on/off hold window after exit support. If enabled, rxvt will 353 Turn on/off hold window after exit support. If enabled, urxvt will
354 not immediately destroy its window when the program executed within 354 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 355 it exits. Instead, it will wait till it is being killed or closed by
356 the user; resource hold. 356 the user; resource hold.
357 357
358 -keysym.*sym* *string* 358 -keysym.*sym* *string*
359 Remap a key symbol. See resource keysym. 359 Remap a key symbol. See resource keysym.
360 360
361 -embed *windowid* 361 -embed *windowid*
362 Tells rxvt to embed it's windows into an already-existing window, 362 Tells urxvt to embed its windows into an already-existing window,
363 which enables applications to easily embed a terminal. 363 which enables applications to easily embed a terminal.
364 364
365 Right now, rxvt will first unmap/map the specified window, so it 365 Right now, urxvt will first unmap/map the specified window, so it
366 shouldn't be a top-level window. rxvt will also reconfigure it quite 366 shouldn't be a top-level window. urxvt will also reconfigure it
367 a bit, so don't expect it to keep some specific state. It's best to 367 quite a bit, so don't expect it to keep some specific state. It's
368 create an extra subwindow for rxvt and leave it alone. 368 best to create an extra subwindow for urxvt and leave it alone.
369 369
370 The window will not be destroyed when rxvt exits. 370 The window will not be destroyed when urxvt exits.
371 371
372 It might be useful to know that rxvt will not close file descriptors 372 It might be useful to know that urxvt will not close file
373 passed to it (except for stdin/out/err, of course), so you can use 373 descriptors passed to it (except for stdin/out/err, of course), so
374 file descriptors to communicate with the programs within the 374 you can use file descriptors to communicate with the programs within
375 terminal. This works regardless of wether the "-embed" option was 375 the terminal. This works regardless of wether the "-embed" option
376 used or not. 376 was used or not.
377 377
378 Here is a short Gtk2-perl snippet that illustrates how this option 378 Here is a short Gtk2-perl snippet that illustrates how this option
379 can be used (a longer example is in doc/embed): 379 can be used (a longer example is in doc/embed):
380 380
381 my $rxvt = new Gtk2::Socket; 381 my $rxvt = new Gtk2::Socket;
382 $rxvt->signal_connect_after (realize => sub { 382 $rxvt->signal_connect_after (realize => sub {
383 my $xid = $_[0]->window->get_xid; 383 my $xid = $_[0]->window->get_xid;
384 system "rxvt -embed $xid &"; 384 system "urxvt -embed $xid &";
385 }); 385 });
386 386
387 -pty-fd *file descriptor* 387 -pty-fd *file descriptor*
388 Tells rxvt NOT to execute any commands or create a new pty/tty pair 388 Tells urxvt 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 389 but instead use the given filehandle as the tty master. This is
390 useful if you want to drive rxvt as a generic terminal emulator 390 useful if you want to drive urxvt as a generic terminal emulator
391 without having to run a program within it. 391 without having to run a program within it.
392 392
393 If this switch is given, rxvt will not create any utmp/wtmp entries 393 If this switch is given, urxvt will not create any utmp/wtmp entries
394 and will not tinker with pty/tty permissions - you have to do that 394 and will not tinker with pty/tty permissions - you have to do that
395 yourself if you want that. 395 yourself if you want that.
396 396
397 As an extremely special case, specifying -1 will completely suppress 397 As an extremely special case, specifying -1 will completely suppress
398 pty/tty operations. 398 pty/tty operations.
403 use IO::Pty; 403 use IO::Pty;
404 use Fcntl; 404 use Fcntl;
405 405
406 my $pty = new IO::Pty; 406 my $pty = new IO::Pty;
407 fcntl $pty, F_SETFD, 0; # clear close-on-exec 407 fcntl $pty, F_SETFD, 0; # clear close-on-exec
408 system "rxvt -pty-fd " . (fileno $pty) . "&"; 408 system "urxvt -pty-fd " . (fileno $pty) . "&";
409 close $pty; 409 close $pty;
410 410
411 # now communicate with rxvt 411 # now communicate with rxvt
412 my $slave = $pty->slave; 412 my $slave = $pty->slave;
413 while (<$slave>) { print $slave "got <$_>\n" } 413 while (<$slave>) { print $slave "got <$_>\n" }
415 -pe *string* 415 -pe *string*
416 Comma-separated list of perl extension scripts to use (or not to 416 Comma-separated list of perl extension scripts to use (or not to
417 use) in this terminal instance. See resource perl-ext for details. 417 use) in this terminal instance. See resource perl-ext for details.
418 418
419RESOURCES (available also as long-options) 419RESOURCES (available also as long-options)
420 Note: `rxvt --help' gives a list of all resources (long options) 420 Note: `urxvt --help' gives a list of all resources (long options)
421 compiled into your version. 421 compiled into your version.
422 422
423 You can set and change the resources using X11 tools like xrdb. Many 423 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 424 distribution do also load settings from the ~/.Xresources file when X
425 starts. rxvt will consult the following files/resources in order, with 425 starts. urxvt will consult the following files/resources in order, with
426 later settings overwriting earlier ones: 426 later settings overwriting earlier ones:
427 427
428 1. system-wide app-defaults file, either locale-dependent OR global 428 1. system-wide app-defaults file, either locale-dependent OR global
429 2. app-defaults file in $XAPPLRESDIR 429 2. app-defaults file in $XAPPLRESDIR
430 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 430 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
431 4. SCREEN_RESOURCES for the current screen 431 4. SCREEN_RESOURCES for the current screen
432 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 432 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
433 433
434 Note that when reading X resources, rxvt recognizes two class names: 434 Note that when reading X resources, urxvt recognizes two class names:
435 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt 435 Rxvt and URxvt. The class name Rxvt allows resources common to both
436 and the original *rxvt* to be easily configured, while the class name 436 urxvt and the original *rxvt* to be easily configured, while the class
437 URxvt allows resources unique to rxvt, to be shared between different 437 name URxvt allows resources unique to urxvt, to be shared between
438 rxvt configurations. If no resources are specified, suitable defaults 438 different urxvt configurations. If no resources are specified, suitable
439 will be used. Command-line arguments can be used to override resource 439 defaults will be used. Command-line arguments can be used to override
440 settings. The following resources are supported (you might want to check 440 resource settings. The following resources are supported (you might want
441 the rxvtperl(3) manpage for additional settings by perl extensions not 441 to check the urxvtperl(3) manpage for additional settings by perl
442 documented here): 442 extensions not documented here):
443 443
444 depth: *bitdepth* 444 depth: *bitdepth*
445 Compile *xft*: Attempt to find a visual with the given bit depth; 445 Compile *xft*: Attempt to find a visual with the given bit depth;
446 option -depth. 446 option -depth.
447 447
465 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but 465 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 466 the actual colour names used are listed in the COLORS AND GRAPHICS
467 section. 467 section.
468 468
469 Colours higher than 15 cannot be set using resources (yet), but can 469 Colours higher than 15 cannot be set using resources (yet), but can
470 be changed using an escape command (see rxvt(7)). 470 be changed using an escape command (see urxvt(7)).
471 471
472 Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm 472 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. 473 with 88 colour support). Colours 80-87 are evenly spaces grey steps.
474 474
475 colorBD: *colour* 475 colorBD: *colour*
787 cutchars: *string* 787 cutchars: *string*
788 The characters used as delimiters for double-click word selection 788 The characters used as delimiters for double-click word selection
789 (whitespace delimiting is added automatically if resource is given). 789 (whitespace delimiting is added automatically if resource is given).
790 790
791 When the selection extension is in use (the default if compiled in, 791 When the selection extension is in use (the default if compiled in,
792 see the rxvtperl(3) manpage), a suitable regex using these 792 see the urxvtperl(3) manpage), a suitable regex using these
793 characters will be created (if the resource exists, otherwise, no 793 characters will be created (if the resource exists, otherwise, no
794 regex will be created). In this mode, characters outside ISO-8859-1 794 regex will be created). In this mode, characters outside ISO-8859-1
795 can be used. 795 can be used.
796 796
797 When the selection extension is not used, only ISO-8859-1 characters 797 When the selection extension is not used, only ISO-8859-1 characters
813 813
814 imFont: *fontset* 814 imFont: *fontset*
815 Specify the font-set used for XIM styles "OverTheSpot" or 815 Specify the font-set used for XIM styles "OverTheSpot" or
816 "OffTheSpot". It must be a standard X font set (XLFD patterns 816 "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 817 separated by commas), i.e. it's not in the same format as the other
818 font lists used in rxvt. The default will be set-up to chose *any* 818 font lists used in urxvt. The default will be set-up to chose *any*
819 suitable found found, preferably one or two pixels differing in size 819 suitable found found, preferably one or two pixels differing in size
820 to the base font. option -imfont. 820 to the base font. option -imfont.
821 821
822 tripleclickwords: *boolean* 822 tripleclickwords: *boolean*
823 Change the meaning of triple-click selection with the left mouse 823 Change the meaning of triple-click selection with the left mouse
855 option is enabled, scrolls on the secondary screen will change the 855 option is enabled, scrolls on the secondary screen will change the
856 scrollback buffer and switching to/from the secondary screen will 856 scrollback buffer and switching to/from the secondary screen will
857 instead scroll the screen up. 857 instead scroll the screen up.
858 858
859 hold: *boolean* 859 hold: *boolean*
860 Turn on/off hold window after exit support. If enabled, rxvt will 860 Turn on/off hold window after exit support. If enabled, urxvt will
861 not immediately destroy its window when the program executed within 861 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 862 it exits. Instead, it will wait till it is being killed or closed by
863 the user. 863 the user.
864 864
865 keysym.*sym*: *string* 865 keysym.*sym*: *string*
888 "\000": octal number) or verbatim control characters ("^?": delete, 888 "\000": octal number) or verbatim control characters ("^?": delete,
889 "^@": null, "^A" ...) and may be enclosed with double quotes so that 889 "^@": null, "^A" ...) and may be enclosed with double quotes so that
890 it can start or end with whitespace. 890 it can start or end with whitespace.
891 891
892 Please note that you need to double the "\" in resource files, as 892 Please note that you need to double the "\" in resource files, as
893 Xlib itself does it's own de-escaping (you can use "\033" instead of 893 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 rxvt's own 894 "\e" (and so on), which will work with both Xt and urxvt's own
895 processing). 895 processing).
896 896
897 You can define a range of keysyms in one shot by providing a 897 You can define a range of keysyms in one shot by providing a
898 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 898 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
899 `/' should be a character not used by the strings. 899 `/' should be a character not used by the strings.
907 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 907 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
908 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 908 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
909 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 909 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
910 910
911 If *string* takes the form of "command:STRING", the specified STRING 911 If *string* takes the form of "command:STRING", the specified STRING
912 is interpreted and executed as rxvt's control sequence. For example 912 is interpreted and executed as urxvt's control sequence. For example
913 the following means "change the current locale to "zh_CN.GBK" when 913 the following means "change the current locale to "zh_CN.GBK" when
914 Control-Meta-c is being pressed": 914 Control-Meta-c is being pressed":
915 915
916 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 916 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
917 917
918 If *string* takes the form "perl:STRING", then the specified STRING 918 If *string* takes the form "perl:STRING", then the specified STRING
919 is passed to the "on_keyboard_command" perl handler. See the 919 is passed to the "on_keyboard_command" perl handler. See the
920 rxvtperl(3) manpage. For example, the selection extension (activated 920 urxvtperl(3) manpage. For example, the selection extension
921 via "rxvt -pe selection") listens for "selection:rot13" events: 921 (activated via "urxvt -pe selection") listens for "selection:rot13"
922 events:
922 923
923 URxvt.keysym.M-C-c: perl:selection:rot13 924 URxvt.keysym.M-C-c: perl:selection:rot13
924 925
925 Due the the large number of modifier combinations, a defined key 926 Due the the large number of modifier combinations, a defined key
926 mapping will match if at *at least* the specified identifiers are 927 mapping will match if at *at least* the specified identifiers are
928 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
929 automatically provide definitions for "Meta-a", "Shift-a" and so on, 930 automatically provide definitions for "Meta-a", "Shift-a" and so on,
930 unless some of those are defined mappings themselves. 931 unless some of those are defined mappings themselves.
931 932
932 Unfortunately, this will override built-in key mappings. For example 933 Unfortunately, this will override built-in key mappings. For example
933 if you overwrite the "Insert" key you will disable rxvt's 934 if you overwrite the "Insert" key you will disable urxvt's
934 "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
935 the user-defined keymap using the "builtin:" replacement: 936 the user-defined keymap using the "builtin:" replacement:
936 937
937 URxvt.keysym.Insert: <my insert key sequence> 938 URxvt.keysym.Insert: <my insert key sequence>
938 URxvt.keysym.S-Insert: builtin: 939 URxvt.keysym.S-Insert: builtin:
946 font-switching at runtime: 947 font-switching at runtime:
947 948
948 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 949 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
949 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 950 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
950 951
951 Other things are possible, e.g. resizing (see rxvt(7) for more 952 Other things are possible, e.g. resizing (see urxvt(7) for more
952 info): 953 info):
953 954
954 URxvt.keysym.M-C-3: command:\033[8;25;80t 955 URxvt.keysym.M-C-3: command:\033[8;25;80t
955 URxvt.keysym.M-C-4: command:\033[8;48;110t 956 URxvt.keysym.M-C-4: command:\033[8;48;110t
956 957
980 available to all instances, while perl-ext is used for specific 981 available to all instances, while perl-ext is used for specific
981 instances. 982 instances.
982 983
983 perl-eval: *string* 984 perl-eval: *string*
984 Perl code to be evaluated when all extensions have been registered. 985 Perl code to be evaluated when all extensions have been registered.
985 See the rxvtperl(3) manpage. Due to security reasons, this resource 986 See the urxvtperl(3) manpage. Due to security reasons, this resource
986 will be ignored when running setuid/setgid. 987 will be ignored when running setuid/setgid.
987 988
988 perl-lib: *path* 989 perl-lib: *path*
989 Colon-separated list of additional directories that hold extension 990 Colon-separated list of additional directories that hold extension
990 scripts. When looking for extensions specified by the "perl" 991 scripts. When looking for extensions specified by the "perl"
991 resource, rxvt will first look in these directories and then in 992 resource, urxvt will first look in these directories and then in
992 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource 993 /usr/local/lib/urxvt/perl/. Due to security reasons, this resource
993 will be ignored when running setuid/setgid. 994 will be ignored when running setuid/setgid.
994 995
995 See the rxvtperl(3) manpage. 996 See the urxvtperl(3) manpage.
996 997
997 selection.pattern-*idx*: *perl-regex* 998 selection.pattern-*idx*: *perl-regex*
998 Additional selection patterns, see the rxvtperl(3) manpage for 999 Additional selection patterns, see the urxvtperl(3) manpage for
999 details. 1000 details.
1000 1001
1001 selection-autotransform.*idx*: *perl-transform* 1002 selection-autotransform.*idx*: *perl-transform*
1002 Selection auto-transform patterns, see the rxvtperl(3) manpage for 1003 Selection auto-transform patterns, see the urxvtperl(3) manpage for
1003 details. 1004 details.
1004 1005
1005 searchable-scrollback: *keysym* 1006 searchable-scrollback: *keysym*
1006 Sets the hotkey that starts the incremental scrollback buffer search 1007 Sets the hotkey that starts the incremental scrollback buffer search
1007 (default: "M-s"). 1008 (default: "M-s").
1018 Compile *frills*: Sets override-redirect for the terminal window, 1019 Compile *frills*: Sets override-redirect for the terminal window,
1019 making it almost invisible to window managers; option 1020 making it almost invisible to window managers; option
1020 -override-redirect. 1021 -override-redirect.
1021 1022
1022THE SCROLLBAR 1023THE SCROLLBAR
1023 Lines of text that scroll off the top of the rxvt window (resource: 1024 Lines of text that scroll off the top of the urxvt window (resource:
1024 saveLines) and can be scrolled back using the scrollbar or by 1025 saveLines) and can be scrolled back using the scrollbar or by
1025 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1026 keystrokes. The normal urxvt scrollbar has arrows and its behaviour is
1026 fairly intuitive. The xterm-scrollbar is without arrows and its 1027 fairly intuitive. The xterm-scrollbar is without arrows and its
1027 behaviour mimics that of *xterm* 1028 behaviour mimics that of *xterm*
1028 1029
1029 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
1030 Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with 1031 Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with
1057 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
1058 the selection, and trailing whitespace is visually underlined and 1059 the selection, and trailing whitespace is visually underlined and
1059 removed from the selection. 1060 removed from the selection.
1060 1061
1061 Insertion: 1062 Insertion:
1062 Pressing and releasing the Middle mouse button in an rxvt window 1063 Pressing and releasing the Middle mouse button in an urxvt window
1063 causes the value of the PRIMARY selection (or CLIPBOARD with the 1064 causes the value of the PRIMARY selection (or CLIPBOARD with the
1064 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
1065 keyboard. 1066 keyboard.
1066 1067
1067 Pressing Shift-Insert causes the value of the PRIMARY selection to 1068 Pressing Shift-Insert causes the value of the PRIMARY selection to
1088 character codes using the keyboard. It consists of 4 parts. The first 1089 character codes using the keyboard. It consists of 4 parts. The first
1089 part is available rxvt-unicode has been compiled with "--enable-frills", 1090 part is available rxvt-unicode has been compiled with "--enable-frills",
1090 the rest is available when rxvt-unicode was compiled with 1091 the rest is available when rxvt-unicode was compiled with
1091 "--enable-iso14755". 1092 "--enable-iso14755".
1092 1093
1093 * 5.1: Basic method 1094 * 5.1: Basic method
1095
1094 This allows you to enter unicode characters using their hexcode. 1096 This allows you to enter unicode characters using their hexcode.
1095 1097
1096 Start by pressing and holding both "Control" and "Shift", then enter 1098 Start by pressing and holding both "Control" and "Shift", then enter
1097 hex-digits (between one and six). Releasing "Control" and "Shift" 1099 hex-digits (between one and six). Releasing "Control" and "Shift"
1098 will commit the character as if it were typed directly. While 1100 will commit the character as if it were typed directly. While
1104 address, which you cannot type. Fortunately, the card has the e-mail 1106 address, which you cannot type. Fortunately, the card has the e-mail
1105 address printed as hexcodes, e.g. "671d 65e5". You can enter this 1107 address printed as hexcodes, e.g. "671d 65e5". You can enter this
1106 easily by pressing "Control" and "Shift", followed by 1108 easily by pressing "Control" and "Shift", followed by
1107 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys. 1109 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys.
1108 1110
1109 * 5.2: Keyboard symbols entry method 1111 * 5.2: Keyboard symbols entry method
1112
1110 This mode lets you input characters representing the keycap symbols 1113 This mode lets you input characters representing the keycap symbols
1111 of your keyboard, if representable in the current locale encoding. 1114 of your keyboard, if representable in the current locale encoding.
1112 1115
1113 Start by pressing "Control" and "Shift" together, then releasing 1116 Start by pressing "Control" and "Shift" together, then releasing
1114 them. The next special key (cursor keys, home etc.) you enter will 1117 them. The next special key (cursor keys, home etc.) you enter will
1115 not invoke it's usual function but instead will insert the 1118 not invoke its usual function but instead will insert the
1116 corresponding keycap symbol. The symbol will only be entered when 1119 corresponding keycap symbol. The symbol will only be entered when
1117 the key has been released, otherwise pressing e.g. "Shift" would 1120 the key has been released, otherwise pressing e.g. "Shift" would
1118 enter the symbol for "ISO Level 2 Switch", although your intention 1121 enter the symbol for "ISO Level 2 Switch", although your intention
1119 might have been to enter a reverse tab (Shift-Tab). 1122 might have been to enter a reverse tab (Shift-Tab).
1120 1123
1121 * 5.3: Screen-selection entry method 1124 * 5.3: Screen-selection entry method
1125
1122 While this is implemented already (it's basically the selection 1126 While this is implemented already (it's basically the selection
1123 mechanism), it could be extended by displaying a unicode character 1127 mechanism), it could be extended by displaying a unicode character
1124 map. 1128 map.
1125 1129
1126 * 5.4: Feedback method for identifying displayed characters for later 1130 * 5.4: Feedback method for identifying displayed characters for later
1127 input 1131 input
1132
1128 This method lets you display the unicode character code associated 1133 This method lets you display the unicode character code associated
1129 with characters already displayed. 1134 with characters already displayed.
1130 1135
1131 You enter this mode by holding down "Control" and "Shift" together, 1136 You enter this mode by holding down "Control" and "Shift" together,
1132 then pressing and holding the left mouse button and moving around. 1137 then pressing and holding the left mouse button and moving around.
1141 1146
1142 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
1143 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.
1144 1149
1145LOGIN STAMP 1150LOGIN STAMP
1146 rxvt tries to write an entry into the *utmp*(5) file so that it can be 1151 urxvt tries to write an entry into the *utmp*(5) file so that it can be
1147 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
1148 feature, rxvt may need to be installed setuid root on some systems or 1153 feature, urxvt may need to be installed setuid root on some systems or
1149 setgid to root or to some other group on others. 1154 setgid to root or to some other group on others.
1150 1155
1151COLORS AND GRAPHICS 1156COLORS AND GRAPHICS
1152 In addition to the default foreground and background colours, rxvt can 1157 In addition to the default foreground and background colours, urxvt can
1153 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
1154 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.
1155 1160
1156 color0 (black) = Black 1161 color0 (black) = Black
1157 color1 (red) = Red3 1162 color1 (red) = Red3
1158 color2 (green) = Green3 1163 color2 (green) = Green3
1159 color3 (yellow) = Yellow3 1164 color3 (yellow) = Yellow3
1160 color4 (blue) = Blue3 1165 color4 (blue) = Blue3
1161 color5 (magenta) = Magenta3 1166 color5 (magenta) = Magenta3
1162 color6 (cyan) = Cyan3 1167 color6 (cyan) = Cyan3
1163 color7 (white) = AntiqueWhite 1168 color7 (white) = AntiqueWhite
1164 color8 (bright black) = Grey25 1169 color8 (bright black) = Grey25
1165 color9 (bright red) = Red 1170 color9 (bright red) = Red
1166 color10 (bright green) = Green 1171 color10 (bright green) = Green
1167 color11 (bright yellow) = Yellow 1172 color11 (bright yellow) = Yellow
1168 color12 (bright blue) = Blue 1173 color12 (bright blue) = Blue
1169 color13 (bright magenta) = Magenta 1174 color13 (bright magenta) = Magenta
1170 color14 (bright cyan) = Cyan 1175 color14 (bright cyan) = Cyan
1171 color15 (bright white) = White 1176 color15 (bright white) = White
1172 foreground = Black 1177 foreground = Black
1173 background = White 1178 background = White
1174
1175 It is also possible to specify the colour values of foreground, 1179 It is also possible to specify the colour values of foreground,
1176 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1180 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1177 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
1178 color0-color15. 1182 color0-color15.
1179 1183
1180 In addition to the colours defined above, rxvt offers an additional 72 1184 In addition to the colours defined above, urxvt offers an additional 72
1181 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
1182 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
1183 by 8 additional shades of gray (with indices 80 to 87). 1187 by 8 additional shades of gray (with indices 80 to 87).
1184 1188
1185 Together, all those colours implement the 88 colour xterm colours. Only 1189 Together, all those colours implement the 88 colour xterm colours. Only
1189 Note that -rv ("reverseVideo: True") simulates reverse video by always 1193 Note that -rv ("reverseVideo: True") simulates reverse video by always
1190 swapping the foreground/background colours. This is in contrast to 1194 swapping the foreground/background colours. This is in contrast to
1191 *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
1192 been specified. For example, 1196 been specified. For example,
1193 1197
1194 rxvt -fg Black -bg White -rv 1198 urxvt -fg Black -bg White -rv
1195 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
1196 on White. 1200 on White.
1197 1201
1198 ALPHA CHANNEL SUPPORT 1202 ALPHA CHANNEL SUPPORT
1199 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
1210 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.
1211 1215
1212 For example, the following selects an almost completely transparent red 1216 For example, the following selects an almost completely transparent red
1213 background, and an almost opaque pink foreground: 1217 background, and an almost opaque pink foreground:
1214 1218
1215 rxvt -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink" 1219 urxvt -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
1216 1220
1217 *Please note that transparency of any kind if completely unsupported by 1221 *Please note that transparency of any kind if completely unsupported by
1218 the author. Don't bug him with installation questions!* 1222 the author. Don't bug him with installation questions!*
1219 1223
1220ENVIRONMENT 1224ENVIRONMENT
1221 rxvt sets and/or uses the following environment variables: 1225 urxvt sets and/or uses the following environment variables:
1222 1226
1223 TERM 1227 TERM
1224 Normally set to "rxvt-unicode", unless overwritten at configure 1228 Normally set to "rxvt-unicode", unless overwritten at configure
1225 time, via resources or on the commandline. 1229 time, via resources or on the commandline.
1226 1230
1227 COLORTERM 1231 COLORTERM
1228 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled 1232 Either "rxvt", "rxvt-xpm", depending on wether urxvt was compiled
1229 with XPM support, and optionally with the added extension "-mono" to 1233 with XPM support, and optionally with the added extension "-mono" to
1230 indicate that rxvt-unicode runs on a monochrome screen. 1234 indicate that rxvt-unicode runs on a monochrome screen.
1231 1235
1232 COLORFGBG 1236 COLORFGBG
1233 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
1234 the colour code used as default foreground/text colour (or the 1238 the colour code used as default foreground/text colour (or the
1235 string "default" to indicate that the default-colour escape sequence 1239 string "default" to indicate that the default-colour escape sequence
1236 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
1237 colour (or the string "default"), and "xpm" is the string "default" 1241 colour (or the string "default"), and "xpm" is the string "default"
1238 if rxvt was compiled with XPM support. Libraries like "ncurses" and 1242 if urxvt was compiled with XPM support. Libraries like "ncurses" and
1239 "slang" can (and do) use this information to optimize screen output. 1243 "slang" can (and do) use this information to optimize screen output.
1240 1244
1241 WINDOWID 1245 WINDOWID
1242 Set to the (decimal) X Window ID of the rxvt window (the toplevel 1246 Set to the (decimal) X Window ID of the urxvt window (the toplevel
1243 window, which usually has subwindows for the scrollbar, the terminal 1247 window, which usually has subwindows for the scrollbar, the terminal
1244 window and so on). 1248 window and so on).
1245 1249
1246 TERMINFO 1250 TERMINFO
1247 Set to the terminfo directory iff rxvt was configured with 1251 Set to the terminfo directory iff urxvt was configured with
1248 "--with-terminfo=PATH". 1252 "--with-terminfo=PATH".
1249 1253
1250 DISPLAY 1254 DISPLAY
1251 Used by rxvt to connect to the display and set to the correct 1255 Used by urxvt to connect to the display and set to the correct
1252 display in it's child processes. 1256 display in its child processes.
1253 1257
1254 SHELL 1258 SHELL
1255 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".
1256 1260
1257 RXVT_SOCKET 1261 RXVT_SOCKET
1258 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1262 The unix domain socket path used by urxvtc(1) and urxvtd(1).
1259 1263
1260 Default $HOME/.rxvt-unicode-*<nodename*. 1264 Default $HOME/.rxvt-unicode-*<nodename*.
1261 1265
1262 HOME 1266 HOME
1263 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
1267 XAPPLRESDIR 1271 XAPPLRESDIR
1268 Directory where various X resource files are being located. 1272 Directory where various X resource files are being located.
1269 1273
1270 XENVIRONMENT 1274 XENVIRONMENT
1271 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
1272 loaded by rxvt. 1276 loaded by urxvt.
1273 1277
1274FILES 1278FILES
1275 /usr/lib/X11/rgb.txt 1279 /usr/lib/X11/rgb.txt
1276 Color names. 1280 Color names.
1277 1281
1278SEE ALSO 1282SEE ALSO
1279 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4), 1283 urxvt(7), urxvtc(1), urxvtd(1), xterm(1), sh(1), resize(1), X(1),
1280 tty(4), utmp(5) 1284 pty(4), tty(4), utmp(5)
1281 1285
1282CURRENT PROJECT COORDINATOR 1286CURRENT PROJECT COORDINATOR
1283 Project Coordinator 1287 Project Coordinator
1284 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1288 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1285 1289
1286 <http://software.schmorp.de/#rxvt-unicode> 1290 <http://software.schmorp.de/pkg/rxvt-unicode.html>
1287 1291
1288AUTHORS 1292AUTHORS
1289 John Bovey 1293 John Bovey
1290 University of Kent, 1992, wrote the original Xvt. 1294 University of Kent, 1992, wrote the original Xvt.
1291 1295

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines