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.45 by root, Fri Jan 13 12:40:46 2006 UTC vs.
Revision 1.46 by root, Mon Jan 16 15:07:27 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.0, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 7.0, 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
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 it's 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) easier 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.
113 transparency is enabled with -tr or -ip. This only works for 113 transparency is enabled with -tr or -ip. This only works for
114 non-tiled backgrounds, currently. See also the -sh option that can 114 non-tiled backgrounds, currently. See also the -sh option that can
115 be used to brighten or darken the image in addition to tinting it; 115 be used to brighten or darken the image in addition to tinting it;
116 resource *tintColor*. Example: 116 resource *tintColor*. Example:
117 117
118 urxvt -tr -tint blue -sh 40 118 rxvt -tr -tint blue -sh 40
119 119
120 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent 120 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent
121 background image in addition to tinting it (i.e. -tint must be 121 background image in addition to tinting it (i.e. -tint must be
122 specified, too, e.g. "-tint white"). 122 specified, too, e.g. "-tint white").
123 123
156 156
157 In short, to specify an X11 core font, just specify it's name or 157 In short, to specify an X11 core font, just specify it's name or
158 prefix it with "x:". To specify an XFT-font, you need to prefix it 158 prefix it with "x:". To specify an XFT-font, you need to prefix it
159 with "xft:", e.g.: 159 with "xft:", e.g.:
160 160
161 urxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 161 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
162 urxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" 162 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
163 163
164 See also the question "How does rxvt-unicode choose fonts?" in the 164 See also the question "How does rxvt-unicode choose fonts?" in the
165 FAQ section of urxvt(7). 165 FAQ section of rxvt(7).
166 166
167 -fb *fontlist* 167 -fb *fontlist*
168 Compile *font-styles*: The bold font list to use when bold 168 Compile *font-styles*: The bold font list to use when bold
169 characters are to be printed. See resource boldFont for details. 169 characters are to be printed. See resource boldFont for details.
170 170
270 TERM environment variable. This terminal type must exist in the 270 TERM environment variable. This terminal type must exist in the
271 *termcap(5)* database and should have *li#* and *co#* entries; 271 *termcap(5)* database and should have *li#* and *co#* entries;
272 resource termName. 272 resource termName.
273 273
274 -e *command [arguments]* 274 -e *command [arguments]*
275 Run the command with its command-line arguments in the urxvt window; 275 Run the command with its command-line arguments in the rxvt window;
276 also sets the window title and icon name to be the basename of the 276 also sets the window title and icon name to be the basename of the
277 program being executed if neither *-title* (*-T*) nor *-n* are given 277 program being executed if neither *-title* (*-T*) nor *-n* are given
278 on the command line. If this option is used, it must be the last on 278 on the command line. If this option is used, it must be the last on
279 the command-line. If there is no -e option then the default is to 279 the command-line. If there is no -e option then the default is to
280 run the program specified by the SHELL environment variable or, 280 run the program specified by the SHELL environment variable or,
282 282
283 Please note that you must specify a program with arguments. If you 283 Please note that you must specify a program with arguments. If you
284 want to run shell commands, you have to specify the shell, like 284 want to run shell commands, you have to specify the shell, like
285 this: 285 this:
286 286
287 urxvt -e sh -c "shell commands" 287 rxvt -e sh -c "shell commands"
288 288
289 -title *text* 289 -title *text*
290 Window title (-T still respected); the default title is the basename 290 Window title (-T still respected); the default title is the basename
291 of the program specified after the -e option, if any, otherwise the 291 of the program specified after the -e option, if any, otherwise the
292 application name; resource title. 292 application name; resource title.
337 -ssr|+ssr 337 -ssr|+ssr
338 Turn on/off secondary screen scroll (default enabled); resource 338 Turn on/off secondary screen scroll (default enabled); resource
339 secondaryScroll. 339 secondaryScroll.
340 340
341 -hold|+hold 341 -hold|+hold
342 Turn on/off hold window after exit support. If enabled, urxvt will 342 Turn on/off hold window after exit support. If enabled, rxvt will
343 not immediately destroy its window when the program executed within 343 not immediately destroy its window when the program executed within
344 it exits. Instead, it will wait till it is being killed or closed by 344 it exits. Instead, it will wait till it is being killed or closed by
345 the user; resource hold. 345 the user; resource hold.
346 346
347 -keysym.*sym* *string* 347 -keysym.*sym* *string*
348 Remap a key symbol. See resource keysym. 348 Remap a key symbol. See resource keysym.
349 349
350 -embed *windowid* 350 -embed *windowid*
351 Tells urxvt to embed it's windows into an already-existing window, 351 Tells rxvt to embed it's windows into an already-existing window,
352 which enables applications to easily embed a terminal. 352 which enables applications to easily embed a terminal.
353 353
354 Right now, urxvt will first unmap/map the specified window, so it 354 Right now, rxvt will first unmap/map the specified window, so it
355 shouldn't be a top-level window. urxvt will also reconfigure it 355 shouldn't be a top-level window. rxvt will also reconfigure it quite
356 quite a bit, so don't expect it to keep some specific state. It's 356 a bit, so don't expect it to keep some specific state. It's best to
357 best to create an extra subwindow for urxvt and leave it alone. 357 create an extra subwindow for rxvt and leave it alone.
358 358
359 The window will not be destroyed when urxvt exits. 359 The window will not be destroyed when rxvt exits.
360 360
361 It might be useful to know that urxvt will not close file 361 It might be useful to know that rxvt will not close file descriptors
362 descriptors passed to it (except for stdin/out/err, of course), so 362 passed to it (except for stdin/out/err, of course), so you can use
363 you can use file descriptors to communicate with the programs within 363 file descriptors to communicate with the programs within the
364 the terminal. This works regardless of wether the "-embed" option 364 terminal. This works regardless of wether the "-embed" option was
365 was used or not. 365 used or not.
366 366
367 Here is a short Gtk2-perl snippet that illustrates how this option 367 Here is a short Gtk2-perl snippet that illustrates how this option
368 can be used (a longer example is in doc/embed): 368 can be used (a longer example is in doc/embed):
369 369
370 my $rxvt = new Gtk2::Socket; 370 my $rxvt = new Gtk2::Socket;
371 $rxvt->signal_connect_after (realize => sub { 371 $rxvt->signal_connect_after (realize => sub {
372 my $xid = $_[0]->window->get_xid; 372 my $xid = $_[0]->window->get_xid;
373 system "urxvt -embed $xid &"; 373 system "rxvt -embed $xid &";
374 }); 374 });
375 375
376 -pty-fd *file descriptor* 376 -pty-fd *file descriptor*
377 Tells urxvt NOT to execute any commands or create a new pty/tty pair 377 Tells rxvt NOT to execute any commands or create a new pty/tty pair
378 but instead use the given filehandle as the tty master. This is 378 but instead use the given filehandle as the tty master. This is
379 useful if you want to drive urxvt as a generic terminal emulator 379 useful if you want to drive rxvt as a generic terminal emulator
380 without having to run a program within it. 380 without having to run a program within it.
381 381
382 If this switch is given, urxvt will not create any utmp/wtmp entries 382 If this switch is given, rxvt will not create any utmp/wtmp entries
383 and will not tinker with pty/tty permissions - you have to do that 383 and will not tinker with pty/tty permissions - you have to do that
384 yourself if you want that. 384 yourself if you want that.
385 385
386 As an extremely special case, specifying -1 will completely suppress 386 As an extremely special case, specifying -1 will completely suppress
387 pty/tty operations. 387 pty/tty operations.
392 use IO::Pty; 392 use IO::Pty;
393 use Fcntl; 393 use Fcntl;
394 394
395 my $pty = new IO::Pty; 395 my $pty = new IO::Pty;
396 fcntl $pty, F_SETFD, 0; # clear close-on-exec 396 fcntl $pty, F_SETFD, 0; # clear close-on-exec
397 system "urxvt -pty-fd " . (fileno $pty) . "&"; 397 system "rxvt -pty-fd " . (fileno $pty) . "&";
398 close $pty; 398 close $pty;
399 399
400 # now communicate with rxvt 400 # now communicate with rxvt
401 my $slave = $pty->slave; 401 my $slave = $pty->slave;
402 while (<$slave>) { print $slave "got <$_>\n" } 402 while (<$slave>) { print $slave "got <$_>\n" }
404 -pe *string* 404 -pe *string*
405 Comma-separated list of perl extension scripts to use (or not to 405 Comma-separated list of perl extension scripts to use (or not to
406 use) in this terminal instance. See resource perl-ext for details. 406 use) in this terminal instance. See resource perl-ext for details.
407 407
408RESOURCES (available also as long-options) 408RESOURCES (available also as long-options)
409 Note: `urxvt --help' gives a list of all resources (long options) 409 Note: `rxvt --help' gives a list of all resources (long options)
410 compiled into your version. 410 compiled into your version.
411 411
412 You can set and change the resources using X11 tools like xrdb. Many 412 You can set and change the resources using X11 tools like xrdb. Many
413 distribution do also load settings from the ~/.Xresources file when X 413 distribution do also load settings from the ~/.Xresources file when X
414 starts. urxvt will consult the following files/resources in order, with 414 starts. rxvt will consult the following files/resources in order, with
415 later settings overwriting earlier ones: 415 later settings overwriting earlier ones:
416 416
417 1. system-wide app-defaults file, either locale-dependent OR global 417 1. system-wide app-defaults file, either locale-dependent OR global
418 2. app-defaults file in $XAPPLRESDIR 418 2. app-defaults file in $XAPPLRESDIR
419 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 419 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
420 4. SCREEN_RESOURCES for the current screen 420 4. SCREEN_RESOURCES for the current screen
421 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 421 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
422 422
423 Note that when reading X resources, urxvt recognizes two class names: 423 Note that when reading X resources, rxvt recognizes two class names:
424 Rxvt and URxvt. The class name Rxvt allows resources common to both 424 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
425 urxvt and the original *rxvt* to be easily configured, while the class 425 and the original *rxvt* to be easily configured, while the class name
426 name URxvt allows resources unique to urxvt, to be shared between 426 URxvt allows resources unique to rxvt, to be shared between different
427 different urxvt configurations. If no resources are specified, suitable 427 rxvt configurations. If no resources are specified, suitable defaults
428 defaults will be used. Command-line arguments can be used to override 428 will be used. Command-line arguments can be used to override resource
429 resource settings. The following resources are supported (you might want 429 settings. The following resources are supported (you might want to check
430 to check the urxvtperl(3) manpage for additional settings by perl 430 the rxvtperl(3) manpage for additional settings by perl extensions not
431 extensions not documented here): 431 documented here):
432 432
433 geometry: *geom* 433 geometry: *geom*
434 Create the window with the specified X window geometry [default 434 Create the window with the specified X window geometry [default
435 80x24]; option -geometry. 435 80x24]; option -geometry.
436 436
450 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but 450 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but
451 the actual colour names used are listed in the COLORS AND GRAPHICS 451 the actual colour names used are listed in the COLORS AND GRAPHICS
452 section. 452 section.
453 453
454 Colours higher than 15 cannot be set using resources (yet), but can 454 Colours higher than 15 cannot be set using resources (yet), but can
455 be changed using an escape command (see urxvt(7)). 455 be changed using an escape command (see rxvt(7)).
456 456
457 Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm 457 Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm
458 with 88 colour support). Colours 80-87 are evenly spaces grey steps. 458 with 88 colour support). Colours 80-87 are evenly spaces grey steps.
459 459
460 colorBD: *colour* 460 colorBD: *colour*
536 scale of 1 displays the image without any scaling. A scale of 2 to 9 536 scale of 1 displays the image without any scaling. A scale of 2 to 9
537 specifies an integer number of images in that direction. No image 537 specifies an integer number of images in that direction. No image
538 will be magnified beyond 10 times its original size. The maximum 538 will be magnified beyond 10 times its original size. The maximum
539 permitted scale is 1000. [default 0x0+50+50] 539 permitted scale is 1000. [default 0x0+50+50]
540 540
541 menu: *file[;tag]*
542 Read in the specified menu file (note the `.menu' extension is
543 optional) and also optionally specify a starting tag to find. See
544 the reference documentation for details on the syntax for the
545 menuBar.
546
547 path: *path* 541 path: *path*
548 Specify the colon-delimited search path for finding files (XPM and 542 Specify the colon-delimited search path for finding XPM files.
549 menus), in addition to the paths specified by the RXVTPATH and PATH
550 environment variables.
551 543
552 font: *fontlist* 544 font: *fontlist*
553 Select the fonts to be used. This is a comma separated list of font 545 Select the fonts to be used. This is a comma separated list of font
554 names that are checked in order when trying to find glyphs for 546 names that are checked in order when trying to find glyphs for
555 characters. The first font defines the cell size for characters; 547 characters. The first font defines the cell size for characters;
566 available hint currently is "codeset=codeset-name", and this is only 558 available hint currently is "codeset=codeset-name", and this is only
567 used for Xft fonts. 559 used for Xft fonts.
568 560
569 For example, this font resource 561 For example, this font resource
570 562
571 URxvt*font: 9x15bold,\ 563 URxvt.font: 9x15bold,\
572 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 564 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
573 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 565 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
574 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 566 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
575 xft:Code2000:antialias=false 567 xft:Code2000:antialias=false
576 568
662 654
663 The string will be interpreted as if typed into the shell as-is. 655 The string will be interpreted as if typed into the shell as-is.
664 656
665 Example: 657 Example:
666 658
667 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 659 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
668 660
669 This creates a new file in your home directory with the screen 661 This creates a new file in your home directory with the screen
670 contents everytime you hit "Print". 662 contents everytime you hit "Print".
671 663
672 scrollBar: *boolean* 664 scrollBar: *boolean*
794 786
795 imFont: *fontset* 787 imFont: *fontset*
796 Specify the font-set used for XIM styles "OverTheSpot" or 788 Specify the font-set used for XIM styles "OverTheSpot" or
797 "OffTheSpot". It must be a standard X font set (XLFD patterns 789 "OffTheSpot". It must be a standard X font set (XLFD patterns
798 separated by commas), i.e. it's not in the same format as the other 790 separated by commas), i.e. it's not in the same format as the other
799 font lists used in urxvt. The default will be set-up to chose *any* 791 font lists used in rxvt. The default will be set-up to chose *any*
800 suitable found found, preferably one or two pixels differing in size 792 suitable found found, preferably one or two pixels differing in size
801 to the base font. option -imfont. 793 to the base font. option -imfont.
802 794
803 tripleclickwords: *boolean* 795 tripleclickwords: *boolean*
804 Change the meaning of triple-click selection with the left mouse 796 Change the meaning of triple-click selection with the left mouse
815 xterm, have these sequences enabled by default, which doesn't make 807 xterm, have these sequences enabled by default, which doesn't make
816 it safer, though). 808 it safer, though).
817 809
818 You can enable them by setting this boolean resource or specifying 810 You can enable them by setting this boolean resource or specifying
819 -insecure as an option. At the moment, this enables display-answer, 811 -insecure as an option. At the moment, this enables display-answer,
820 locale, findfont, icon label and window title requests as well as 812 locale, findfont, icon label and window title requests.
821 dynamic menubar dispatch.
822 813
823 modifier: *modifier* 814 modifier: *modifier*
824 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 815 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
825 super, mod1, mod2, mod3, mod4, mod5; option -mod. 816 super, mod1, mod2, mod3, mod4, mod5; option -mod.
826 817
837 option is enabled, scrolls on the secondary screen will change the 828 option is enabled, scrolls on the secondary screen will change the
838 scrollback buffer and switching to/from the secondary screen will 829 scrollback buffer and switching to/from the secondary screen will
839 instead scroll the screen up. 830 instead scroll the screen up.
840 831
841 hold: *bool* 832 hold: *bool*
842 Turn on/off hold window after exit support. If enabled, urxvt will 833 Turn on/off hold window after exit support. If enabled, rxvt will
843 not immediately destroy its window when the program executed within 834 not immediately destroy its window when the program executed within
844 it exits. Instead, it will wait till it is being killed or closed by 835 it exits. Instead, it will wait till it is being killed or closed by
845 the user. 836 the user.
846 837
847 keysym.*sym*: *string* 838 keysym.*sym*: *string*
871 "^@": null, "^A" ...) and may be enclosed with double quotes so that 862 "^@": null, "^A" ...) and may be enclosed with double quotes so that
872 it can start or end with whitespace. 863 it can start or end with whitespace.
873 864
874 Please note that you need to double the "\" in resource files, as 865 Please note that you need to double the "\" in resource files, as
875 Xlib itself does it's own de-escaping (you can use "\033" instead of 866 Xlib itself does it's own de-escaping (you can use "\033" instead of
876 "\e" (and so on), which will work with both Xt and urxvt's own 867 "\e" (and so on), which will work with both Xt and rxvt's own
877 processing). 868 processing).
878 869
879 You can define a range of keysyms in one shot by providing a 870 You can define a range of keysyms in one shot by providing a
880 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 871 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
881 `/' should be a character not used by the strings. 872 `/' should be a character not used by the strings.
889 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 880 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
890 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 881 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
891 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 882 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
892 883
893 If *string* takes the form of "command:STRING", the specified STRING 884 If *string* takes the form of "command:STRING", the specified STRING
894 is interpreted and executed as urxvt's control sequence. For example 885 is interpreted and executed as rxvt's control sequence. For example
895 the following means "change the current locale to "zh_CN.GBK" when 886 the following means "change the current locale to "zh_CN.GBK" when
896 Control-Meta-c is being pressed": 887 Control-Meta-c is being pressed":
897 888
898 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 889 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
899 890
900 If *string* takes the form "perl:STRING", then the specified STRING 891 If *string* takes the form "perl:STRING", then the specified STRING
901 is passed to the "on_keyboard_command" perl handler. See the 892 is passed to the "on_keyboard_command" perl handler. See the
902 urxvtperl(3) manpage. For example, the selection extension 893 rxvtperl(3) manpage. For example, the selection extension (activated
903 (activated via "urxvt -pe selection") listens for "selection:rot13" 894 via "rxvt -pe selection") listens for "selection:rot13" events:
904 events:
905 895
906 URxvt.keysym.M-C-c: perl:selection:rot13 896 URxvt.keysym.M-C-c: perl:selection:rot13
907 897
908 Due the the large number of modifier combinations, a defined key 898 Due the the large number of modifier combinations, a defined key
909 mapping will match if at *at least* the specified identifiers are 899 mapping will match if at *at least* the specified identifiers are
911 being defined. That means that defining a key map for "a" will 901 being defined. That means that defining a key map for "a" will
912 automatically provide definitions for "Meta-a", "Shift-a" and so on, 902 automatically provide definitions for "Meta-a", "Shift-a" and so on,
913 unless some of those are defined mappings themselves. 903 unless some of those are defined mappings themselves.
914 904
915 Unfortunately, this will override built-in key mappings. For example 905 Unfortunately, this will override built-in key mappings. For example
916 if you overwrite the "Insert" key you will disable urxvt's 906 if you overwrite the "Insert" key you will disable rxvt's
917 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into 907 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
918 the user-defined keymap using the "builtin:" replacement: 908 the user-defined keymap using the "builtin:" replacement:
919 909
920 URxvt.keysym.Insert: <my insert key sequence> 910 URxvt.keysym.Insert: <my insert key sequence>
921 URxvt.keysym.S-Insert: builtin: 911 URxvt.keysym.S-Insert: builtin:
929 font-switching at runtime: 919 font-switching at runtime:
930 920
931 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 921 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
932 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 922 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
933 923
934 Other things are possible, e.g. resizing (see urxvt(7) for more 924 Other things are possible, e.g. resizing (see rxvt(7) for more
935 info): 925 info):
936 926
937 URxvt.keysym.M-C-3: command:\033[8;25;80t 927 URxvt.keysym.M-C-3: command:\033[8;25;80t
938 URxvt.keysym.M-C-4: command:\033[8;48;110t 928 URxvt.keysym.M-C-4: command:\033[8;48;110t
939 929
963 available to all instances, while perl-ext is used for specific 953 available to all instances, while perl-ext is used for specific
964 instances. 954 instances.
965 955
966 perl-eval: *string* 956 perl-eval: *string*
967 Perl code to be evaluated when all extensions have been registered. 957 Perl code to be evaluated when all extensions have been registered.
968 See the urxvtperl(3) manpage. Due to security reasons, this resource 958 See the rxvtperl(3) manpage. Due to security reasons, this resource
969 will be ignored when running setuid/setgid. 959 will be ignored when running setuid/setgid.
970 960
971 perl-lib: *path* 961 perl-lib: *path*
972 Colon-separated list of additional directories that hold extension 962 Colon-separated list of additional directories that hold extension
973 scripts. When looking for extensions specified by the "perl" 963 scripts. When looking for extensions specified by the "perl"
974 resource, urxvt will first look in these directories and then in 964 resource, rxvt will first look in these directories and then in
975 /usr/local/lib/urxvt/perl/. Due to security reasons, this resource 965 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
976 will be ignored when running setuid/setgid. 966 will be ignored when running setuid/setgid.
977 967
978 See the urxvtperl(3) manpage. 968 See the rxvtperl(3) manpage.
979 969
980 selection.pattern-*idx*: *perl-regex* 970 selection.pattern-*idx*: *perl-regex*
981 Additional selection patterns, see the urxvtperl(3) manpage for 971 Additional selection patterns, see the rxvtperl(3) manpage for
982 details. 972 details.
983 973
984 selection-autotransform.*idx*: *perl-transform* 974 selection-autotransform.*idx*: *perl-transform*
985 Selection auto-transform patterns, see the urxvtperl(3) manpage for 975 Selection auto-transform patterns, see the rxvtperl(3) manpage for
986 details. 976 details.
987 977
988 searchable-scrollback: *keysym* 978 searchable-scrollback: *keysym*
989 Sets the hotkey that starts the incremental scrollback buffer search 979 Sets the hotkey that starts the incremental scrollback buffer search
990 (default: "M-s"). 980 (default: "M-s").
995 985
996 transient-for: *windowid* 986 transient-for: *windowid*
997 Sets the WM_TRANSIENT_FOR property to the given window iw. 987 Sets the WM_TRANSIENT_FOR property to the given window iw.
998 988
999THE SCROLLBAR 989THE SCROLLBAR
1000 Lines of text that scroll off the top of the urxvt window (resource: 990 Lines of text that scroll off the top of the rxvt window (resource:
1001 saveLines) and can be scrolled back using the scrollbar or by 991 saveLines) and can be scrolled back using the scrollbar or by
1002 keystrokes. The normal urxvt scrollbar has arrows and its behaviour is 992 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
1003 fairly intuitive. The xterm-scrollbar is without arrows and its 993 fairly intuitive. The xterm-scrollbar is without arrows and its
1004 behaviour mimics that of *xterm* 994 behaviour mimics that of *xterm*
1005 995
1006 Scroll down with Button1 (xterm-scrollbar) or Shift-Next. Scroll up with 996 Scroll down with Button1 (xterm-scrollbar) or Shift-Next. Scroll up with
1007 Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with 997 Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with
1035 the selection, and trailing whitespace is visually underlined and 1025 the selection, and trailing whitespace is visually underlined and
1036 removed from the selection. 1026 removed from the selection.
1037 1027
1038 Insertion: 1028 Insertion:
1039 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1029 Pressing and releasing the Middle mouse button (or Shift-Insert) in
1040 an urxvt window causes the current text selection to be inserted as 1030 an rxvt window causes the current text selection to be inserted as
1041 if it had been typed on the keyboard. 1031 if it had been typed on the keyboard.
1042 1032
1043CHANGING FONTS 1033CHANGING FONTS
1044 Changing fonts (or font sizes, respectively) via the keypad is not yet 1034 Changing fonts (or font sizes, respectively) via the keypad is not yet
1045 supported in rxvt-unicode. Bug me if you need this. 1035 supported in rxvt-unicode. Bug me if you need this.
1046 1036
1047 You can, however, switch fonts at runtime using escape sequences (and 1037 You can, however, switch fonts at runtime using escape sequences, e.g.:
1048 therefore using the menubar), e.g.:
1049 1038
1050 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1039 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1040
1041 You can use keyboard shortcuts, too:
1042
1043 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1044 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1051 1045
1052 rxvt-unicode will automatically re-apply these fonts to the output so 1046 rxvt-unicode will automatically re-apply these fonts to the output so
1053 far. 1047 far.
1054 1048
1055ISO 14755 SUPPORT 1049ISO 14755 SUPPORT
1110 1104
1111 With respect to conformance, rxvt-unicode is supposed to be compliant to 1105 With respect to conformance, rxvt-unicode is supposed to be compliant to
1112 both scenario A and B of ISO 14755, including part 5.2. 1106 both scenario A and B of ISO 14755, including part 5.2.
1113 1107
1114LOGIN STAMP 1108LOGIN STAMP
1115 urxvt tries to write an entry into the *utmp*(5) file so that it can be 1109 rxvt tries to write an entry into the *utmp*(5) file so that it can be
1116 seen via the *who(1)* command, and can accept messages. To allow this 1110 seen via the *who(1)* command, and can accept messages. To allow this
1117 feature, urxvt may need to be installed setuid root on some systems or 1111 feature, rxvt may need to be installed setuid root on some systems or
1118 setgid to root or to some other group on others. 1112 setgid to root or to some other group on others.
1119 1113
1120COLORS AND GRAPHICS 1114COLORS AND GRAPHICS
1121 In addition to the default foreground and background colours, urxvt can 1115 In addition to the default foreground and background colours, rxvt can
1122 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 1116 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
1123 versions of the same). Here is a list of the colours with their rgb.txt 1117 versions of the same). Here is a list of the colours with their rgb.txt
1124 names. 1118 names.
1125 1119
1126 color0 (black) = Black 1120 color0 (black) = Black
1150 Note that -rv ("reverseVideo: True") simulates reverse video by always 1144 Note that -rv ("reverseVideo: True") simulates reverse video by always
1151 swapping the foreground/background colours. This is in contrast to 1145 swapping the foreground/background colours. This is in contrast to
1152 *xterm*(1) where the colours are only swapped if they have not otherwise 1146 *xterm*(1) where the colours are only swapped if they have not otherwise
1153 been specified. For example, 1147 been specified. For example,
1154 1148
1155 urxvt -fg Black -bg White -rv 1149 rxvt -fg Black -bg White -rv
1156 would yield White on Black, while on *xterm*(1) it would yield Black 1150 would yield White on Black, while on *xterm*(1) it would yield Black
1157 on White. 1151 on White.
1158 1152
1159ENVIRONMENT 1153ENVIRONMENT
1160 urxvt sets and/or uses the following environment variables: 1154 rxvt sets and/or uses the following environment variables:
1161 1155
1162 TERM 1156 TERM
1163 Normally set to "rxvt-unicode", unless overwritten at configure 1157 Normally set to "rxvt-unicode", unless overwritten at configure
1164 time, via resources or on the commandline. 1158 time, via resources or on the commandline.
1165 1159
1166 COLORTERM 1160 COLORTERM
1167 Either "rxvt", "rxvt-xpm", depending on wether urxvt was compiled 1161 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled
1168 with XPM support, and optionally with the added extension "-mono" to 1162 with XPM support, and optionally with the added extension "-mono" to
1169 indicate that rxvt-unicode runs on a monochrome screen. 1163 indicate that rxvt-unicode runs on a monochrome screen.
1170 1164
1171 COLORFGBG 1165 COLORFGBG
1172 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is 1166 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1173 the colour code used as default foreground/text colour (or the 1167 the colour code used as default foreground/text colour (or the
1174 string "default" to indicate that the default-colour escape sequence 1168 string "default" to indicate that the default-colour escape sequence
1175 is to be used), "bg" is the colour code used as default background 1169 is to be used), "bg" is the colour code used as default background
1176 colour (or the string "default"), and "xpm" is the string "default" 1170 colour (or the string "default"), and "xpm" is the string "default"
1177 if urxvt was compiled with XPM support. Libraries like "ncurses" and 1171 if rxvt was compiled with XPM support. Libraries like "ncurses" and
1178 "slang" can (and do) use this information to optimize screen output. 1172 "slang" can (and do) use this information to optimize screen output.
1179 1173
1180 WINDOWID 1174 WINDOWID
1181 Set to the (decimal) X Window ID of the urxvt window (the toplevel 1175 Set to the (decimal) X Window ID of the rxvt window (the toplevel
1182 window, which usually has subwindows for the scrollbar, the terminal 1176 window, which usually has subwindows for the scrollbar, the terminal
1183 window and so on). 1177 window and so on).
1184 1178
1185 TERMINFO 1179 TERMINFO
1186 Set to the terminfo directory iff urxvt was configured with 1180 Set to the terminfo directory iff rxvt was configured with
1187 "--with-terminfo=PATH". 1181 "--with-terminfo=PATH".
1188 1182
1189 DISPLAY 1183 DISPLAY
1190 Used by urxvt to connect to the display and set to the correct 1184 Used by rxvt to connect to the display and set to the correct
1191 display in it's child processes. 1185 display in it's child processes.
1192 1186
1193 SHELL 1187 SHELL
1194 The shell to be used for command execution, defaults to "/bin/sh". 1188 The shell to be used for command execution, defaults to "/bin/sh".
1195 1189
1196 RXVTPATH 1190 RXVTPATH
1197 The path where urxvt looks for support files such as menu and xpm 1191 The path where rxvt looks for support files such as menu and xpm
1198 files. 1192 files.
1199 1193
1200 PATH 1194 PATH
1201 Used in the same way as "RXVTPATH". 1195 Used in the same way as "RXVTPATH".
1202 1196
1203 RXVT_SOCKET 1197 RXVT_SOCKET
1204 The unix domain socket path used by urxvtc(1) and urxvtd(1). 1198 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1205 1199
1206 Default $HOME/.rxvt-unicode-*<nodename*. 1200 Default $HOME/.rxvt-unicode-*<nodename*.
1207 1201
1208 HOME 1202 HOME
1209 Used to locate the default directory for the unix domain socket for 1203 Used to locate the default directory for the unix domain socket for
1213 XAPPLRESDIR 1207 XAPPLRESDIR
1214 Directory where various X resource files are being located. 1208 Directory where various X resource files are being located.
1215 1209
1216 XENVIRONMENT 1210 XENVIRONMENT
1217 If set and accessible, gives the name of a X resource file to be 1211 If set and accessible, gives the name of a X resource file to be
1218 loaded by urxvt. 1212 loaded by rxvt.
1219 1213
1220FILES 1214FILES
1221 /usr/lib/X11/rgb.txt 1215 /usr/lib/X11/rgb.txt
1222 Color names. 1216 Color names.
1223 1217
1224SEE ALSO 1218SEE ALSO
1225 urxvt(7), urxvtc(1), urxvtd(1), xterm(1), sh(1), resize(1), X(1), 1219 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
1226 pty(4), tty(4), utmp(5) 1220 tty(4), utmp(5)
1227 1221
1228CURRENT PROJECT COORDINATOR 1222CURRENT PROJECT COORDINATOR
1229 Project Coordinator 1223 Project Coordinator
1230 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1224 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1231 1225

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines