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.69 by root, Sat Oct 27 12:09:02 2007 UTC vs.
Revision 1.70 by root, Mon Nov 19 12:02:35 2007 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 8.4, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 8.4, 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/rxvt-unicode/doc/rxvt.7.html>. 19 <http://cvs.schmorp.de/browse/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 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) more 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.
… …
112 *Please note that old resource name of inheritPixmap is obsolete and 112 *Please note that old resource name of inheritPixmap is obsolete and
113 should be changed to transparent. Backwards compatibility support 113 should be changed to transparent. Backwards compatibility support
114 for inheritPixmap will be phased out in future versions of rxvt!* 114 for inheritPixmap will be phased out in future versions of rxvt!*
115 115
116 *Please address all transparency related issues to Sasha Vasko at 116 *Please address all transparency related issues to Sasha Vasko at
117 sasha@aftercode.net. Read the FAQ (man 7 urxvt)!* 117 sasha@aftercode.net. Read the FAQ (man 7 rxvt)!*
118 118
119 -fade *number* 119 -fade *number*
120 Fade the text by the given percentage when focus is lost. Small 120 Fade the text by the given percentage when focus is lost. Small
121 values fade a little only, 100 completely replaces all colours by 121 values fade a little only, 100 completely replaces all colours by
122 the fade colour; resource fading. 122 the fade colour; resource fading.
… …
131 backgrounds, currently. See also the -sh option that can be used to 131 backgrounds, currently. See also the -sh option that can be used to
132 brighten or darken the image in addition to tinting it. Please note 132 brighten or darken the image in addition to tinting it. Please note
133 that certain tint colours can be applied on the server-side, thus 133 that certain tint colours can be applied on the server-side, thus
134 yielding performance gain of two orders of magnitude. These colours 134 yielding performance gain of two orders of magnitude. These colours
135 are: blue, red, green, cyan, magenta, yellow, and those close to 135 are: blue, red, green, cyan, magenta, yellow, and those close to
136 them. Also pure black and pure white colors essentially mean no
136 them; resource *tintColor*. Example: 137 tinting; resource *tintColor*. Example:
137 138
138 urxvt -tr -tint blue -sh 40 139 rxvt -tr -tint blue -sh 40
139 140
140 -sh *number* 141 -sh *number*
141 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 142 Darken (0 .. 100) or lighten (100 .. 200) the transparent background
142 image in addition to (or instead of) tinting it; resource *shading*. 143 image in addition to (or instead of) tinting it; resource *shading*.
143 144
144 -blt *string* 145 -blt *string*
145 Specify background blending type. If background pixmap is specified 146 Specify background blending type. If background pixmap is specified
146 at the same time as transparency - such pixmap will be blended over 147 at the same time as transparency - such pixmap will be blended over
… …
162 Window background colour; resource background. 163 Window background colour; resource background.
163 164
164 -fg *colour* 165 -fg *colour*
165 Window foreground colour; resource foreground. 166 Window foreground colour; resource foreground.
166 167
167 -pixmap *file[;geom]* 168 -pixmap *file[;geom[:op1][:op2][...]]*
168 Compile *afterimage*: Specify image file for the background and also 169 Compile *afterimage*: Specify image file for the background and also
169 optionally specify its scaling with a geometry string. Note you may 170 optionally specify its scaling with a geometry string. Note you may
170 need to add quotes to avoid special shell interpretation of the ";" 171 need to add quotes to avoid special shell interpretation of the ";"
171 in the command-line; for more details see resource backgroundPixmap. 172 in the command-line; for more details see resource backgroundPixmap.
172 173
… …
193 194
194 In short, to specify an X11 core font, just specify its name or 195 In short, to specify an X11 core font, just specify its name or
195 prefix it with "x:". To specify an XFT-font, you need to prefix it 196 prefix it with "x:". To specify an XFT-font, you need to prefix it
196 with "xft:", e.g.: 197 with "xft:", e.g.:
197 198
198 urxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 199 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
199 urxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" 200 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
200 201
201 See also the question "How does rxvt-unicode choose fonts?" in the 202 See also the question "How does rxvt-unicode choose fonts?" in the
202 FAQ section of urxvt(7). 203 FAQ section of rxvt(7).
203 204
204 -fb *fontlist* 205 -fb *fontlist*
205 Compile *font-styles*: The bold font list to use when bold 206 Compile *font-styles*: The bold font list to use when bold
206 characters are to be printed. See resource boldFont for details. 207 characters are to be printed. See resource boldFont for details.
207 208
… …
311 TERM environment variable. This terminal type must exist in the 312 TERM environment variable. This terminal type must exist in the
312 *termcap(5)* database and should have *li#* and *co#* entries; 313 *termcap(5)* database and should have *li#* and *co#* entries;
313 resource termName. 314 resource termName.
314 315
315 -e *command [arguments]* 316 -e *command [arguments]*
316 Run the command with its command-line arguments in the urxvt window; 317 Run the command with its command-line arguments in the rxvt window;
317 also sets the window title and icon name to be the basename of the 318 also sets the window title and icon name to be the basename of the
318 program being executed if neither *-title* (*-T*) nor *-n* are given 319 program being executed if neither *-title* (*-T*) nor *-n* are given
319 on the command line. If this option is used, it must be the last on 320 on the command line. If this option is used, it must be the last on
320 the command-line. If there is no -e option then the default is to 321 the command-line. If there is no -e option then the default is to
321 run the program specified by the SHELL environment variable or, 322 run the program specified by the SHELL environment variable or,
… …
323 324
324 Please note that you must specify a program with arguments. If you 325 Please note that you must specify a program with arguments. If you
325 want to run shell commands, you have to specify the shell, like 326 want to run shell commands, you have to specify the shell, like
326 this: 327 this:
327 328
328 urxvt -e sh -c "shell commands" 329 rxvt -e sh -c "shell commands"
329 330
330 -title *text* 331 -title *text*
331 Window title (-T still respected); the default title is the basename 332 Window title (-T still respected); the default title is the basename
332 of the program specified after the -e option, if any, otherwise the 333 of the program specified after the -e option, if any, otherwise the
333 application name; resource title. 334 application name; resource title.
… …
379 -ssr|+ssr 380 -ssr|+ssr
380 Turn on/off secondary screen scroll (default enabled); resource 381 Turn on/off secondary screen scroll (default enabled); resource
381 secondaryScroll. 382 secondaryScroll.
382 383
383 -hold|+hold 384 -hold|+hold
384 Turn on/off hold window after exit support. If enabled, urxvt will 385 Turn on/off hold window after exit support. If enabled, rxvt will
385 not immediately destroy its window when the program executed within 386 not immediately destroy its window when the program executed within
386 it exits. Instead, it will wait till it is being killed or closed by 387 it exits. Instead, it will wait till it is being killed or closed by
387 the user; resource hold. 388 the user; resource hold.
388 389
389 -keysym.*sym* *string* 390 -keysym.*sym* *string*
390 Remap a key symbol. See resource keysym. 391 Remap a key symbol. See resource keysym.
391 392
392 -embed *windowid* 393 -embed *windowid*
393 Tells urxvt to embed its windows into an already-existing window, 394 Tells rxvt to embed its windows into an already-existing window,
394 which enables applications to easily embed a terminal. 395 which enables applications to easily embed a terminal.
395 396
396 Right now, urxvt will first unmap/map the specified window, so it 397 Right now, rxvt will first unmap/map the specified window, so it
397 shouldn't be a top-level window. urxvt will also reconfigure it 398 shouldn't be a top-level window. rxvt will also reconfigure it quite
398 quite a bit, so don't expect it to keep some specific state. It's 399 a bit, so don't expect it to keep some specific state. It's best to
399 best to create an extra subwindow for urxvt and leave it alone. 400 create an extra subwindow for rxvt and leave it alone.
400 401
401 The window will not be destroyed when urxvt exits. 402 The window will not be destroyed when rxvt exits.
402 403
403 It might be useful to know that urxvt will not close file 404 It might be useful to know that rxvt will not close file descriptors
404 descriptors passed to it (except for stdin/out/err, of course), so 405 passed to it (except for stdin/out/err, of course), so you can use
405 you can use file descriptors to communicate with the programs within 406 file descriptors to communicate with the programs within the
406 the terminal. This works regardless of whether the "-embed" option 407 terminal. This works regardless of whether the "-embed" option was
407 was used or not. 408 used or not.
408 409
409 Here is a short Gtk2-perl snippet that illustrates how this option 410 Here is a short Gtk2-perl snippet that illustrates how this option
410 can be used (a longer example is in doc/embed): 411 can be used (a longer example is in doc/embed):
411 412
412 my $rxvt = new Gtk2::Socket; 413 my $rxvt = new Gtk2::Socket;
413 $rxvt->signal_connect_after (realize => sub { 414 $rxvt->signal_connect_after (realize => sub {
414 my $xid = $_[0]->window->get_xid; 415 my $xid = $_[0]->window->get_xid;
415 system "urxvt -embed $xid &"; 416 system "rxvt -embed $xid &";
416 }); 417 });
417 418
418 -pty-fd *file descriptor* 419 -pty-fd *file descriptor*
419 Tells urxvt NOT to execute any commands or create a new pty/tty pair 420 Tells rxvt NOT to execute any commands or create a new pty/tty pair
420 but instead use the given file descriptor as the tty master. This is 421 but instead use the given file descriptor as the tty master. This is
421 useful if you want to drive urxvt as a generic terminal emulator 422 useful if you want to drive rxvt as a generic terminal emulator
422 without having to run a program within it. 423 without having to run a program within it.
423 424
424 If this switch is given, urxvt will not create any utmp/wtmp entries 425 If this switch is given, rxvt will not create any utmp/wtmp entries
425 and will not tinker with pty/tty permissions - you have to do that 426 and will not tinker with pty/tty permissions - you have to do that
426 yourself if you want that. 427 yourself if you want that.
427 428
428 As an extremely special case, specifying -1 will completely suppress 429 As an extremely special case, specifying -1 will completely suppress
429 pty/tty operations. 430 pty/tty operations.
… …
434 use IO::Pty; 435 use IO::Pty;
435 use Fcntl; 436 use Fcntl;
436 437
437 my $pty = new IO::Pty; 438 my $pty = new IO::Pty;
438 fcntl $pty, F_SETFD, 0; # clear close-on-exec 439 fcntl $pty, F_SETFD, 0; # clear close-on-exec
439 system "urxvt -pty-fd " . (fileno $pty) . "&"; 440 system "rxvt -pty-fd " . (fileno $pty) . "&";
440 close $pty; 441 close $pty;
441 442
442 # now communicate with rxvt 443 # now communicate with rxvt
443 my $slave = $pty->slave; 444 my $slave = $pty->slave;
444 while (<$slave>) { print $slave "got <$_>\n" } 445 while (<$slave>) { print $slave "got <$_>\n" }
… …
446 -pe *string* 447 -pe *string*
447 Comma-separated list of perl extension scripts to use (or not to 448 Comma-separated list of perl extension scripts to use (or not to
448 use) in this terminal instance. See resource perl-ext for details. 449 use) in this terminal instance. See resource perl-ext for details.
449 450
450RESOURCES (available also as long-options) 451RESOURCES (available also as long-options)
451 Note: `urxvt --help' gives a list of all resources (long options) 452 Note: `rxvt --help' gives a list of all resources (long options)
452 compiled into your version. 453 compiled into your version.
453 454
454 You can set and change the resources using X11 tools like xrdb. Many 455 You can set and change the resources using X11 tools like xrdb. Many
455 distribution do also load settings from the ~/.Xresources file when X 456 distribution do also load settings from the ~/.Xresources file when X
456 starts. urxvt will consult the following files/resources in order, with 457 starts. rxvt will consult the following files/resources in order, with
457 later settings overwriting earlier ones: 458 later settings overwriting earlier ones:
458 459
459 1. system-wide app-defaults file, either locale-dependent OR global 460 1. system-wide app-defaults file, either locale-dependent OR global
460 2. app-defaults file in $XAPPLRESDIR 461 2. app-defaults file in $XAPPLRESDIR
461 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 462 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
462 4. SCREEN_RESOURCES for the current screen 463 4. SCREEN_RESOURCES for the current screen
463 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 464 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
464 465
465 Note that when reading X resources, urxvt recognizes two class names: 466 Note that when reading X resources, rxvt recognizes two class names:
466 Rxvt and URxvt. The class name Rxvt allows resources common to both 467 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
467 urxvt and the original *rxvt* to be easily configured, while the class 468 and the original *rxvt* to be easily configured, while the class name
468 name URxvt allows resources unique to urxvt, to be shared between 469 URxvt allows resources unique to rxvt, to be shared between different
469 different urxvt configurations. If no resources are specified, suitable 470 rxvt configurations. If no resources are specified, suitable defaults
470 defaults will be used. Command-line arguments can be used to override 471 will be used. Command-line arguments can be used to override resource
471 resource settings. The following resources are supported (you might want 472 settings. The following resources are supported (you might want to check
472 to check the urxvtperl(3) manpage for additional settings by perl 473 the rxvtperl(3) manpage for additional settings by perl extensions not
473 extensions not documented here): 474 documented here):
474 475
475 depth: *bitdepth* 476 depth: *bitdepth*
476 Compile *xft*: Attempt to find a visual with the given bit depth; 477 Compile *xft*: Attempt to find a visual with the given bit depth;
477 option -depth. 478 option -depth.
478 479
… …
496 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but 497 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but
497 the actual colour names used are listed in the COLORS AND GRAPHICS 498 the actual colour names used are listed in the COLORS AND GRAPHICS
498 section. 499 section.
499 500
500 Colours higher than 15 cannot be set using resources (yet), but can 501 Colours higher than 15 cannot be set using resources (yet), but can
501 be changed using an escape command (see urxvt(7)). 502 be changed using an escape command (see rxvt(7)).
502 503
503 Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm 504 Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm
504 with 88 colour support). Colours 80-87 are evenly spaces grey steps. 505 with 88 colour support). Colours 80-87 are evenly spaces grey steps.
505 506
506 colorBD: *colour* 507 colorBD: *colour*
… …
536 option -rv. False: regular screen colours [default]; option +rv. See 537 option -rv. False: regular screen colours [default]; option +rv. See
537 note in COLORS AND GRAPHICS section. 538 note in COLORS AND GRAPHICS section.
538 539
539 jumpScroll: *boolean* 540 jumpScroll: *boolean*
540 True: specify that jump scrolling should be used. When receiving 541 True: specify that jump scrolling should be used. When receiving
541 lots of lines, urxvt will only scroll once a whole screen height of 542 lots of lines, rxvt will only scroll once a whole screen height of
542 lines has been read, resulting in fewer updates while still 543 lines has been read, resulting in fewer updates while still
543 displaying every received line; option -j. 544 displaying every received line; option -j.
544 545
545 False: specify that smooth scrolling should be used. urxvt will 546 False: specify that smooth scrolling should be used. rxvt will force
546 force a screen refresh on each new line it received; option +j. 547 a screen refresh on each new line it received; option +j.
547 548
548 skipScroll: *boolean* 549 skipScroll: *boolean*
549 True: (the default) specify that skip scrolling should be used. When 550 True: (the default) specify that skip scrolling should be used. When
550 receiving lots of lines, urxvt will only scroll once in a while 551 receiving lots of lines, rxvt will only scroll once in a while
551 (around 60 times per second), resulting in far fewer updates. This 552 (around 60 times per second), resulting in far fewer updates. This
552 can result in urxvt not ever displaying some of the lines it 553 can result in rxvt not ever displaying some of the lines it
553 receives; option -ss. 554 receives; option -ss.
554 555
555 False: specify that everything is to be displayed, even if the 556 False: specify that everything is to be displayed, even if the
556 refresh is too fast for the human eye to read anything (or the 557 refresh is too fast for the human eye to read anything (or the
557 monitor to display anything); option +ss. 558 monitor to display anything); option +ss.
… …
596 597
597 borderColor: *colour* 598 borderColor: *colour*
598 The colour of the border around the text area and between the 599 The colour of the border around the text area and between the
599 scrollbar and the text. 600 scrollbar and the text.
600 601
601 backgroundPixmap: *file[;geom]* 602 backgroundPixmap: *file[;geom[:op1][:op2][...]]*
602 Use the specified image file for the background and also optionally 603 Use the specified image file for the background and also optionally
603 specify its scaling with a geometry string WxH+X+Y, in which "W" / 604 specify its scaling with a geometry string WxH+X+Y, (default
604 "H" specify the horizontal/vertical scale (percent), and "X" / "Y" 605 "0x0+50+50") in which "W" / "H" specify the horizontal/vertical
605 locate the image centre (percent). A scale of 0 displays the image 606 scale (percent), and "X" / "Y" locate the image centre (percent). A
606 with tiling. A scale of 1 displays the image without any scaling. A 607 scale of 0 displays the image with tiling. A scale of 1 displays the
607 scale of 2 to 9 specifies an integer number of images in that 608 image without any scaling. A scale of 2 to 9 specifies an integer
608 direction. No image will be magnified beyond 10 times its original 609 number of images in that direction. No image will be magnified
609 size. The maximum permitted scale is 1000. Special string of "auto" 610 beyond 10 times its original size. The maximum permitted scale is
610 used as a geometry will cause image to be automatically scaled to 611 1000. Additional operations can be specified after colon
611 match window size. If used in conjunction with -tr option - 612 :op1:op2.... Supported operations are:
612 specified pixmap will be blended over transparency image using 613
613 either alpha-blending, or any other blending type, specified with 614 tile force background image to be tiled and not scaled. Equivalent to 0x0,
614 -blt "type" option. [default 0x0+50+50] 615 propscale will scale image keeping proportions,
616 auto will scale image to match window size. Equivalent to 100x100;
617 hscale will scale image horizontally to the window size;
618 vscale will scale image vertically to the window size;
619 scale will scale image to match window size;
620 root will tile image as if it was a root window background, auto-adjusting
621 whenever terminal window moves.
622
623 If used in conjunction with -tr option, the specified pixmap will be
624 blended over transparency image using either alpha-blending, or any
625 other blending type, specified with -blt "type" option.
615 626
616 path: *path* 627 path: *path*
617 Specify the colon-delimited search path for finding background image 628 Specify the colon-delimited search path for finding background image
618 files. 629 files.
619 630
… …
850 cutchars: *string* 861 cutchars: *string*
851 The characters used as delimiters for double-click word selection 862 The characters used as delimiters for double-click word selection
852 (whitespace delimiting is added automatically if resource is given). 863 (whitespace delimiting is added automatically if resource is given).
853 864
854 When the perl selection extension is in use (the default if compiled 865 When the perl selection extension is in use (the default if compiled
855 in, see the urxvtperl(3) manpage), a suitable regex using these 866 in, see the rxvtperl(3) manpage), a suitable regex using these
856 characters will be created (if the resource exists, otherwise, no 867 characters will be created (if the resource exists, otherwise, no
857 regex will be created). In this mode, characters outside ISO-8859-1 868 regex will be created). In this mode, characters outside ISO-8859-1
858 can be used. 869 can be used.
859 870
860 When the selection extension is not used, only ISO-8859-1 characters 871 When the selection extension is not used, only ISO-8859-1 characters
861 can be used. If not specified, the built-in default is used: 872 can be used. If not specified, the built-in default is used:
862 873
863 BACKSLASH `"'&()*,;<=>?@[]{|} 874 BACKSLASH `"'&()*,;<=>?@[]^{|}
864 875
865 preeditType: *style* 876 preeditType: *style*
866 OverTheSpot, OffTheSpot, Root; option -pt. 877 OverTheSpot, OffTheSpot, Root; option -pt.
867 878
868 inputMethod: *name* 879 inputMethod: *name*
… …
876 887
877 imFont: *fontset* 888 imFont: *fontset*
878 Specify the font-set used for XIM styles "OverTheSpot" or 889 Specify the font-set used for XIM styles "OverTheSpot" or
879 "OffTheSpot". It must be a standard X font set (XLFD patterns 890 "OffTheSpot". It must be a standard X font set (XLFD patterns
880 separated by commas), i.e. it's not in the same format as the other 891 separated by commas), i.e. it's not in the same format as the other
881 font lists used in urxvt. The default will be set-up to chose *any* 892 font lists used in rxvt. The default will be set-up to chose *any*
882 suitable found found, preferably one or two pixels differing in size 893 suitable found found, preferably one or two pixels differing in size
883 to the base font. option -imfont. 894 to the base font. option -imfont.
884 895
885 tripleclickwords: *boolean* 896 tripleclickwords: *boolean*
886 Change the meaning of triple-click selection with the left mouse 897 Change the meaning of triple-click selection with the left mouse
… …
918 option is enabled, scrolls on the secondary screen will change the 929 option is enabled, scrolls on the secondary screen will change the
919 scrollback buffer and switching to/from the secondary screen will 930 scrollback buffer and switching to/from the secondary screen will
920 instead scroll the screen up. 931 instead scroll the screen up.
921 932
922 hold: *boolean* 933 hold: *boolean*
923 Turn on/off hold window after exit support. If enabled, urxvt will 934 Turn on/off hold window after exit support. If enabled, rxvt will
924 not immediately destroy its window when the program executed within 935 not immediately destroy its window when the program executed within
925 it exits. Instead, it will wait till it is being killed or closed by 936 it exits. Instead, it will wait till it is being killed or closed by
926 the user. 937 the user.
927 938
928 keysym.*sym*: *string* 939 keysym.*sym*: *string*
… …
962 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 973 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
963 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 974 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
964 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 975 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
965 976
966 If *string* takes the form of "command:STRING", the specified STRING 977 If *string* takes the form of "command:STRING", the specified STRING
967 is interpreted and executed as urxvt's control sequence. For example 978 is interpreted and executed as rxvt's control sequence. For example
968 the following means "change the current locale to "zh_CN.GBK" when 979 the following means "change the current locale to "zh_CN.GBK" when
969 Control-Meta-c is being pressed": 980 Control-Meta-c is being pressed":
970 981
971 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 982 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
972 983
973 If *string* takes the form "perl:STRING", then the specified STRING 984 If *string* takes the form "perl:STRING", then the specified STRING
974 is passed to the "on_keyboard_command" perl handler. See the 985 is passed to the "on_keyboard_command" perl handler. See the
975 urxvtperl(3) manpage. For example, the selection extension 986 rxvtperl(3) manpage. For example, the selection extension (activated
976 (activated via "urxvt -pe selection") listens for "selection:rot13" 987 via "rxvt -pe selection") listens for "selection:rot13" events:
977 events:
978 988
979 URxvt.keysym.M-C-c: perl:selection:rot13 989 URxvt.keysym.M-C-c: perl:selection:rot13
980 990
981 Due the the large number of modifier combinations, a defined key 991 Due the the large number of modifier combinations, a defined key
982 mapping will match if at *at least* the specified identifiers are 992 mapping will match if at *at least* the specified identifiers are
… …
984 being defined. That means that defining a key map for "a" will 994 being defined. That means that defining a key map for "a" will
985 automatically provide definitions for "Meta-a", "Shift-a" and so on, 995 automatically provide definitions for "Meta-a", "Shift-a" and so on,
986 unless some of those are defined mappings themselves. 996 unless some of those are defined mappings themselves.
987 997
988 Unfortunately, this will override built-in key mappings. For example 998 Unfortunately, this will override built-in key mappings. For example
989 if you overwrite the "Insert" key you will disable urxvt's 999 if you overwrite the "Insert" key you will disable rxvt's
990 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into 1000 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
991 the user-defined keymap using the "builtin:" replacement: 1001 the user-defined keymap using the "builtin:" replacement:
992 1002
993 URxvt.keysym.Insert: <my insert key sequence> 1003 URxvt.keysym.Insert: <my insert key sequence>
994 URxvt.keysym.S-Insert: builtin: 1004 URxvt.keysym.S-Insert: builtin:
… …
1002 font-switching at runtime: 1012 font-switching at runtime:
1003 1013
1004 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1014 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1005 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1015 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1006 1016
1007 Other things are possible, e.g. resizing (see urxvt(7) for more 1017 Other things are possible, e.g. resizing (see rxvt(7) for more
1008 info): 1018 info):
1009 1019
1010 URxvt.keysym.M-C-3: command:\033[8;25;80t 1020 URxvt.keysym.M-C-3: command:\033[8;25;80t
1011 URxvt.keysym.M-C-4: command:\033[8;48;110t 1021 URxvt.keysym.M-C-4: command:\033[8;48;110t
1012 1022
… …
1036 available to all instances, while perl-ext is used for specific 1046 available to all instances, while perl-ext is used for specific
1037 instances. 1047 instances.
1038 1048
1039 perl-eval: *string* 1049 perl-eval: *string*
1040 Perl code to be evaluated when all extensions have been registered. 1050 Perl code to be evaluated when all extensions have been registered.
1041 See the urxvtperl(3) manpage. Due to security reasons, this resource 1051 See the rxvtperl(3) manpage. Due to security reasons, this resource
1042 will be ignored when running setuid/setgid. 1052 will be ignored when running setuid/setgid.
1043 1053
1044 perl-lib: *path* 1054 perl-lib: *path*
1045 Colon-separated list of additional directories that hold extension 1055 Colon-separated list of additional directories that hold extension
1046 scripts. When looking for extensions specified by the "perl" 1056 scripts. When looking for extensions specified by the "perl"
1047 resource, urxvt will first look in these directories and then in 1057 resource, rxvt will first look in these directories and then in
1048 /usr/local/lib/urxvt/perl/. Due to security reasons, this resource 1058 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
1049 will be ignored when running setuid/setgid. 1059 will be ignored when running setuid/setgid.
1050 1060
1051 See the urxvtperl(3) manpage. 1061 See the rxvtperl(3) manpage.
1052 1062
1053 selection.pattern-*idx*: *perl-regex* 1063 selection.pattern-*idx*: *perl-regex*
1054 Additional selection patterns, see the urxvtperl(3) manpage for 1064 Additional selection patterns, see the rxvtperl(3) manpage for
1055 details. 1065 details.
1056 1066
1057 selection-autotransform.*idx*: *perl-transform* 1067 selection-autotransform.*idx*: *perl-transform*
1058 Selection auto-transform patterns, see the urxvtperl(3) manpage for 1068 Selection auto-transform patterns, see the rxvtperl(3) manpage for
1059 details. 1069 details.
1060 1070
1061 searchable-scrollback: *keysym* 1071 searchable-scrollback: *keysym*
1062 Sets the hotkey that starts the incremental scrollback buffer search 1072 Sets the hotkey that starts the incremental scrollback buffer search
1063 (default: "M-s"). 1073 (default: "M-s").
… …
1077 1087
1078 iso14755_52: *boolean* 1088 iso14755_52: *boolean*
1079 Turn on/off ISO 14755 5.2 mode (default enabled). 1089 Turn on/off ISO 14755 5.2 mode (default enabled).
1080 1090
1081THE SCROLLBAR 1091THE SCROLLBAR
1082 Lines of text that scroll off the top of the urxvt window (resource: 1092 Lines of text that scroll off the top of the rxvt window (resource:
1083 saveLines) and can be scrolled back using the scrollbar or by 1093 saveLines) and can be scrolled back using the scrollbar or by
1084 keystrokes. The normal urxvt scrollbar has arrows and its behaviour is 1094 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
1085 fairly intuitive. The xterm-scrollbar is without arrows and its 1095 fairly intuitive. The xterm-scrollbar is without arrows and its
1086 behaviour mimics that of *xterm* 1096 behaviour mimics that of *xterm*
1087 1097
1088 Scroll down with Button1 (xterm-scrollbar) or Shift-Next. Scroll up with 1098 Scroll down with Button1 (xterm-scrollbar) or Shift-Next. Scroll up with
1089 Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with 1099 Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with
… …
1116 normal one. In this mode, every selected row becomes its own line in 1126 normal one. In this mode, every selected row becomes its own line in
1117 the selection, and trailing whitespace is visually underlined and 1127 the selection, and trailing whitespace is visually underlined and
1118 removed from the selection. 1128 removed from the selection.
1119 1129
1120 Pasting: 1130 Pasting:
1121 Pressing and releasing the Middle mouse button in an urxvt window 1131 Pressing and releasing the Middle mouse button in an rxvt window
1122 causes the value of the PRIMARY selection (or CLIPBOARD with the 1132 causes the value of the PRIMARY selection (or CLIPBOARD with the
1123 Meta modifier) to be inserted as if it had been typed on the 1133 Meta modifier) to be inserted as if it had been typed on the
1124 keyboard. 1134 keyboard.
1125 1135
1126 Pressing Shift-Insert causes the value of the PRIMARY selection to 1136 Pressing Shift-Insert causes the value of the PRIMARY selection to
… …
1200 1210
1201 With respect to conformance, rxvt-unicode is supposed to be compliant to 1211 With respect to conformance, rxvt-unicode is supposed to be compliant to
1202 both scenario A and B of ISO 14755, including part 5.2. 1212 both scenario A and B of ISO 14755, including part 5.2.
1203 1213
1204LOGIN STAMP 1214LOGIN STAMP
1205 urxvt tries to write an entry into the *utmp*(5) file so that it can be 1215 rxvt tries to write an entry into the *utmp*(5) file so that it can be
1206 seen via the *who(1)* command, and can accept messages. To allow this 1216 seen via the *who(1)* command, and can accept messages. To allow this
1207 feature, urxvt may need to be installed setuid root on some systems or 1217 feature, rxvt may need to be installed setuid root on some systems or
1208 setgid to root or to some other group on others. 1218 setgid to root or to some other group on others.
1209 1219
1210COLORS AND GRAPHICS 1220COLORS AND GRAPHICS
1211 In addition to the default foreground and background colours, urxvt can 1221 In addition to the default foreground and background colours, rxvt can
1212 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 1222 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
1213 versions of the same). Here is a list of the colours with their names. 1223 versions of the same). Here is a list of the colours with their names.
1214 1224
1215 color0 (black) = Black 1225 color0 (black) = Black
1216 color1 (red) = Red3 1226 color1 (red) = Red3
… …
1234 It is also possible to specify the colour values of foreground, 1244 It is also possible to specify the colour values of foreground,
1235 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1245 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1236 0-15, as a convenient shorthand to reference the colour name of 1246 0-15, as a convenient shorthand to reference the colour name of
1237 color0-color15. 1247 color0-color15.
1238 1248
1239 In addition to the colours defined above, urxvt offers an additional 72 1249 In addition to the colours defined above, rxvt offers an additional 72
1240 colours. The first 64 of those (with indices 16 to 79) consist of a 1250 colours. The first 64 of those (with indices 16 to 79) consist of a
1241 4*4*4 RGB colour cube (i.e. *index = r * 16 + g * 4 + b + 16*), followed 1251 4*4*4 RGB colour cube (i.e. *index = r * 16 + g * 4 + b + 16*), followed
1242 by 8 additional shades of gray (with indices 80 to 87). 1252 by 8 additional shades of gray (with indices 80 to 87).
1243 1253
1244 Together, all those colours implement the 88 colour xterm colours. Only 1254 Together, all those colours implement the 88 colour xterm colours. Only
… …
1248 Note that -rv ("reverseVideo: True") simulates reverse video by always 1258 Note that -rv ("reverseVideo: True") simulates reverse video by always
1249 swapping the foreground/background colours. This is in contrast to 1259 swapping the foreground/background colours. This is in contrast to
1250 *xterm*(1) where the colours are only swapped if they have not otherwise 1260 *xterm*(1) where the colours are only swapped if they have not otherwise
1251 been specified. For example, 1261 been specified. For example,
1252 1262
1253 urxvt -fg Black -bg White -rv 1263 rxvt -fg Black -bg White -rv
1254 would yield White on Black, while on *xterm*(1) it would yield Black 1264 would yield White on Black, while on *xterm*(1) it would yield Black
1255 on White. 1265 on White.
1256 1266
1257 ALPHA CHANNEL SUPPORT 1267 ALPHA CHANNEL SUPPORT
1258 If Xft support has been compiled in and as long as Xft/Xrender/X don't 1268 If Xft support has been compiled in and as long as Xft/Xrender/X don't
… …
1270 ARGB visuals out of the box, and rxvt-unicode just fudges around. 1280 ARGB visuals out of the box, and rxvt-unicode just fudges around.
1271 1281
1272 For example, the following selects an almost completely transparent red 1282 For example, the following selects an almost completely transparent red
1273 background, and an almost opaque pink foreground: 1283 background, and an almost opaque pink foreground:
1274 1284
1275 urxvt -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" 1285 rxvt -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1276 1286
1277 *Please note that transparency of any kind if completely unsupported by 1287 *Please note that transparency of any kind if completely unsupported by
1278 the author. Don't bug him with installation questions!* 1288 the author. Don't bug him with installation questions!*
1279 1289
1280ENVIRONMENT 1290ENVIRONMENT
1281 urxvt sets and/or uses the following environment variables: 1291 rxvt sets and/or uses the following environment variables:
1282 1292
1283 TERM 1293 TERM
1284 Normally set to "rxvt-unicode", unless overwritten at configure 1294 Normally set to "rxvt-unicode", unless overwritten at configure
1285 time, via resources or on the command line. 1295 time, via resources or on the command line.
1286 1296
1287 COLORTERM 1297 COLORTERM
1288 Either "rxvt", "rxvt-xpm", depending on whether urxvt was compiled 1298 Either "rxvt", "rxvt-xpm", depending on whether rxvt was compiled
1289 with background image support, and optionally with the added 1299 with background image support, and optionally with the added
1290 extension "-mono" to indicate that rxvt-unicode runs on a monochrome 1300 extension "-mono" to indicate that rxvt-unicode runs on a monochrome
1291 screen. 1301 screen.
1292 1302
1293 COLORFGBG 1303 COLORFGBG
1294 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is 1304 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1295 the colour code used as default foreground/text colour (or the 1305 the colour code used as default foreground/text colour (or the
1296 string "default" to indicate that the default-colour escape sequence 1306 string "default" to indicate that the default-colour escape sequence
1297 is to be used), "bg" is the colour code used as default background 1307 is to be used), "bg" is the colour code used as default background
1298 colour (or the string "default"), and "xpm" is the string "default" 1308 colour (or the string "default"), and "xpm" is the string "default"
1299 if urxvt was compiled with background image support. Libraries like 1309 if rxvt was compiled with background image support. Libraries like
1300 "ncurses" and "slang" can (and do) use this information to optimize 1310 "ncurses" and "slang" can (and do) use this information to optimize
1301 screen output. 1311 screen output.
1302 1312
1303 WINDOWID 1313 WINDOWID
1304 Set to the (decimal) X Window ID of the urxvt window (the toplevel 1314 Set to the (decimal) X Window ID of the rxvt window (the toplevel
1305 window, which usually has subwindows for the scrollbar, the terminal 1315 window, which usually has subwindows for the scrollbar, the terminal
1306 window and so on). 1316 window and so on).
1307 1317
1308 TERMINFO 1318 TERMINFO
1309 Set to the terminfo directory iff urxvt was configured with 1319 Set to the terminfo directory iff rxvt was configured with
1310 "--with-terminfo=PATH". 1320 "--with-terminfo=PATH".
1311 1321
1312 DISPLAY 1322 DISPLAY
1313 Used by urxvt to connect to the display and set to the correct 1323 Used by rxvt to connect to the display and set to the correct
1314 display in its child processes. 1324 display in its child processes.
1315 1325
1316 SHELL 1326 SHELL
1317 The shell to be used for command execution, defaults to "/bin/sh". 1327 The shell to be used for command execution, defaults to "/bin/sh".
1318 1328
1319 RXVT_SOCKET 1329 RXVT_SOCKET
1320 The unix domain socket path used by urxvtc(1) and urxvtd(1). 1330 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1321 1331
1322 Default $HOME/.rxvt-unicode-*<nodename*. 1332 Default $HOME/.rxvt-unicode-*<nodename*.
1323 1333
1324 HOME 1334 HOME
1325 Used to locate the default directory for the unix domain socket for 1335 Used to locate the default directory for the unix domain socket for
… …
1329 XAPPLRESDIR 1339 XAPPLRESDIR
1330 Directory where various X resource files are being located. 1340 Directory where various X resource files are being located.
1331 1341
1332 XENVIRONMENT 1342 XENVIRONMENT
1333 If set and accessible, gives the name of a X resource file to be 1343 If set and accessible, gives the name of a X resource file to be
1334 loaded by urxvt. 1344 loaded by rxvt.
1335 1345
1336FILES 1346FILES
1337 /usr/lib/X11/rgb.txt 1347 /usr/lib/X11/rgb.txt
1338 Color names. 1348 Color names.
1339 1349
1340SEE ALSO 1350SEE ALSO
1341 urxvt(7), urxvtc(1), urxvtd(1), xterm(1), sh(1), resize(1), X(1), 1351 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
1342 pty(4), tty(4), utmp(5) 1352 tty(4), utmp(5)
1343 1353
1344CURRENT PROJECT COORDINATOR 1354CURRENT PROJECT COORDINATOR
1345 Project Coordinator 1355 Project Coordinator
1346 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1356 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1347 1357

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines