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.36 by root, Wed Jan 4 21:37:55 2006 UTC vs.
Revision 1.63 by root, Thu Nov 2 17:37:47 2006 UTC

… …
4 4
5SYNOPSIS 5SYNOPSIS
6 rxvt [options] [-e command [ args ]] 6 rxvt [options] [-e command [ args ]]
7 7
8DESCRIPTION 8DESCRIPTION
9 rxvt-unicode, version 6.3, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 8.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 rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions 16 See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions
17 and answer to them and some common problems. That document is also 17 and answer to them and some common problems. That document is also
18 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/rxvt-unicode/doc/rxvt.7.html>.
20 20
21RXVT-UNICODE VS. RXVT 21RXVT-UNICODE VS. RXVT
22 Unlike the original rxvt, rxvt-unicode stores all text in Unicode 22 Unlike the original rxvt, rxvt-unicode stores all text in Unicode
23 internally. That means it can store and display most scripts in the 23 internally. That means it can store and display most scripts in the
24 world. Being a terminal emulator, however, some things are very 24 world. Being a terminal emulator, however, some things are very
25 difficult, especially cursive scripts such as arabic, vertically written 25 difficult, especially cursive scripts such as arabic, vertically written
26 scripts like mongolian or scripts requiring extremely complex combining 26 scripts like mongolian or scripts requiring extremely complex combining
27 rules, like tibetan or devenagari. Don't expect pretty output when using 27 rules, like tibetan or devenagari. Don't expect pretty output when using
28 these scripts. Most other scripts, latin, cyrillic, kanji, thai etc. 28 these scripts. Most other scripts, latin, cyrillic, kanji, thai etc.
29 should work fine, though. A somewhat difficult case are left-to-right 29 should work fine, though. A somewhat difficult case are right-to-left
30 scripts, such as hebrew: rxvt-unicode adopts the view that bidirectional 30 scripts, such as hebrew: rxvt-unicode adopts the view that bidirectional
31 algorithms belong into the application, not the terminal emulator (too 31 algorithms belong into the application, not the terminal emulator (too
32 many things -- such as cursor-movement while editing -- break 32 many things -- such as cursor-movement while editing -- break
33 otherwise), but that might change. 33 otherwise), but that might change.
34 34
35 If you are looking for a terminal that supports more exotic scripts, let 35 If you are looking for a terminal that supports more exotic scripts, let
36 me recommend "mlterm", which is a very userfriendly, lean and clean 36 me recommend "mlterm", which is a very user friendly, lean and clean
37 terminal emulator. In fact, the reason rxvt-unicode was born was solely 37 terminal emulator. In fact, the reason rxvt-unicode was born was solely
38 because the author couldn't get "mlterm" to use one font for latin1 and 38 because the author couldn't get "mlterm" to use one font for latin1 and
39 another for japanese. 39 another for japanese.
40 40
41 Therefore another design rationale was the use of multiple fonts to 41 Therefore another design rationale was the use of multiple fonts to
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 bugs less than the
49 original rxvt. This all in addition to dozens of other small 49 original rxvt. This all in addition to dozens of other small
50 improvements. 50 improvements.
51 51
52 It is still faithfully following the original rxvt idea of being lean 52 It is still faithfully following the original rxvt idea of being lean
53 and nice on resources: for example, you can still configure rxvt-unicode 53 and nice on resources: for example, you can still configure rxvt-unicode
54 without most of 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 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 rxvt(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 rxvt 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
… …
84 -display *displayname* 84 -display *displayname*
85 Attempt to open a window on the named X display (-d still 85 Attempt to open a window on the named X display (-d still
86 respected). In the absence of this option, the display specified by 86 respected). In the absence of this option, the display specified by
87 the DISPLAY environment variable is used. 87 the DISPLAY environment variable is used.
88 88
89 -depth *bitdepth*
90 Compile *xft*: Attempt to find a visual with the given bit depth;
91 resource depth.
92
89 -geometry *geom* 93 -geometry *geom*
90 Window geometry (-g still respected); resource geometry. 94 Window geometry (-g still respected); resource geometry.
91 95
92 -rv|+rv 96 -rv|+rv
93 Turn on/off simulated reverse video; resource reverseVideo. 97 Turn on/off simulated reverse video; resource reverseVideo.
… …
96 Turn on/off jump scrolling; resource jumpScroll. 100 Turn on/off jump scrolling; resource jumpScroll.
97 101
98 -ip|+ip | -tr|+tr 102 -ip|+ip | -tr|+tr
99 Turn on/off inheriting parent window's pixmap. Alternative form is 103 Turn on/off inheriting parent window's pixmap. Alternative form is
100 -tr; resource inheritPixmap. 104 -tr; resource inheritPixmap.
105
106 *Please note that transparency of any kind if completely unsupported
107 by the author. Don't bug him with installation questions! Read the
108 FAQ (man 7 rxvt)!*
101 109
102 -fade *number* 110 -fade *number*
103 Fade the text by the given percentage when focus is lost. Small 111 Fade the text by the given percentage when focus is lost. Small
104 values fade a little only, 100 completely replaces all colours by 112 values fade a little only, 100 completely replaces all colours by
105 the fade colour; resource fading. 113 the fade colour; resource fading.
106 114
107 -fadecolor *colour* 115 -fadecolor *colour*
108 Fade to this colour when fading is used (see -fade). The default 116 Fade to this colour when fading is used (see -fade). The default
109 colour is black. resource fadeColor. 117 colour is opaque black. resource fadeColor.
110 118
111 -tint *colour* 119 -tint *colour*
112 Tint the transparent background pixmap with the given colour when 120 Tint the transparent background pixmap with the given colour when
113 transparency is enabled with -tr or -ip. This only works for 121 transparency is enabled with -tr or -ip. This only works for
114 non-tiled backgrounds, currently. See also the -sh option that can 122 non-tiled backgrounds, currently. See also the -sh option that can
… …
146 The colour of the border around the text area and between the 154 The colour of the border around the text area and between the
147 scrollbar and the text; resource borderColor. 155 scrollbar and the text; resource borderColor.
148 156
149 -fn *fontlist* 157 -fn *fontlist*
150 Select the fonts to be used. This is a comma separated list of font 158 Select the fonts to be used. This is a comma separated list of font
151 names that are used in turn when trying to display Unicode 159 names that are checked in order when trying to find glyphs for
152 characters. The first font defines the cell size for characters; 160 characters. The first font defines the cell size for characters;
153 other fonts might be smaller, but not (in general) larger. A 161 other fonts might be smaller, but not (in general) larger. A
154 (hopefully) reasonable default font list is always appended to it. 162 (hopefully) reasonable default font list is always appended to it.
155 See resource font for more details. 163 See resource font for more details.
156 164
157 In short, to specify an X11 core font, just specify it's name or 165 In short, to specify an X11 core font, just specify its name or
158 prefix it with "x:". To specify an XFT-font, you need to prefix it 166 prefix it with "x:". To specify an XFT-font, you need to prefix it
159 with "xft:", e.g.: 167 with "xft:", e.g.:
160 168
161 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 169 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
162 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" 170 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
… …
251 externalBorder. 259 externalBorder.
252 260
253 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e. 261 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e.
254 if honoured by the WM, the rxvt-unicode window will not have window 262 if honoured by the WM, the rxvt-unicode window will not have window
255 decorations; resource borderLess. 263 decorations; resource borderLess.
264
265 -override-redirect
266 Compile *frills*: Sets override-redirect on the window; resource
267 override-redirect.
256 268
257 -sbg 269 -sbg
258 Compile *frills*: Disable the usage of the built-in block 270 Compile *frills*: Disable the usage of the built-in block
259 graphics/line drawing characters and just rely on what the specified 271 graphics/line drawing characters and just rely on what the specified
260 fonts provide. Use this if you have a good font and want to use its 272 fonts provide. Use this if you have a good font and want to use its
… …
346 358
347 -keysym.*sym* *string* 359 -keysym.*sym* *string*
348 Remap a key symbol. See resource keysym. 360 Remap a key symbol. See resource keysym.
349 361
350 -embed *windowid* 362 -embed *windowid*
351 Tells rxvt to embed it's windows into an already-existing window, 363 Tells rxvt to embed its windows into an already-existing window,
352 which enables applications to easily embed a terminal. 364 which enables applications to easily embed a terminal.
353 365
354 Right now, rxvt will first unmap/map the specified window, so it 366 Right now, rxvt will first unmap/map the specified window, so it
355 shouldn't be a top-level window. rxvt will also reconfigure it quite 367 shouldn't be a top-level window. rxvt will also reconfigure it quite
356 a bit, so don't expect it to keep some specific state. It's best to 368 a bit, so don't expect it to keep some specific state. It's best to
… …
359 The window will not be destroyed when rxvt exits. 371 The window will not be destroyed when rxvt exits.
360 372
361 It might be useful to know that rxvt will not close file descriptors 373 It might be useful to know that rxvt will not close file descriptors
362 passed to it (except for stdin/out/err, of course), so you can use 374 passed to it (except for stdin/out/err, of course), so you can use
363 file descriptors to communicate with the programs within the 375 file descriptors to communicate with the programs within the
364 terminal. This works regardless of wether the "-embed" option was 376 terminal. This works regardless of whether the "-embed" option was
365 used or not. 377 used or not.
366 378
367 Here is a short Gtk2-perl snippet that illustrates how this option 379 Here is a short Gtk2-perl snippet that illustrates how this option
368 can be used (a longer example is in doc/embed): 380 can be used (a longer example is in doc/embed):
369 381
… …
371 $rxvt->signal_connect_after (realize => sub { 383 $rxvt->signal_connect_after (realize => sub {
372 my $xid = $_[0]->window->get_xid; 384 my $xid = $_[0]->window->get_xid;
373 system "rxvt -embed $xid &"; 385 system "rxvt -embed $xid &";
374 }); 386 });
375 387
376 -pty-fd *fileno* 388 -pty-fd *file descriptor*
377 Tells rxvt NOT to execute any commands or create a new pty/tty pair 389 Tells rxvt NOT to execute any commands or create a new pty/tty pair
378 but instead use the given filehandle as the tty master. This is 390 but instead use the given file descriptor as the tty master. This is
379 useful if you want to drive rxvt as a generic terminal emulator 391 useful if you want to drive rxvt as a generic terminal emulator
380 without having to run a program within it. 392 without having to run a program within it.
381 393
382 If this switch is given, rxvt will not create any utmp/wtmp entries 394 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 395 and will not tinker with pty/tty permissions - you have to do that
384 yourself if you want that. 396 yourself if you want that.
397
398 As an extremely special case, specifying -1 will completely suppress
399 pty/tty operations.
385 400
386 Here is a example in perl that illustrates how this option can be 401 Here is a example in perl that illustrates how this option can be
387 used (a longer example is in doc/pty-fd): 402 used (a longer example is in doc/pty-fd):
388 403
389 use IO::Pty; 404 use IO::Pty;
… …
397 # now communicate with rxvt 412 # now communicate with rxvt
398 my $slave = $pty->slave; 413 my $slave = $pty->slave;
399 while (<$slave>) { print $slave "got <$_>\n" } 414 while (<$slave>) { print $slave "got <$_>\n" }
400 415
401 -pe *string* 416 -pe *string*
402 Colon-separated list of perl extension scripts to use in this 417 Comma-separated list of perl extension scripts to use (or not to
403 terminal instance. See resource perl-ext. 418 use) in this terminal instance. See resource perl-ext for details.
404 419
405RESOURCES (available also as long-options) 420RESOURCES (available also as long-options)
406 Note: `rxvt --help' gives a list of all resources (long options) 421 Note: `rxvt --help' gives a list of all resources (long options)
407 compiled into your version. 422 compiled into your version.
408 423
409 There are two different methods that rxvt can use to get the Xresource
410 data: using the X libraries (Xrm*-functions) or internal Xresources
411 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
412 XGetDefaults), you can set and change the resources using X11 tools like 424 You can set and change the resources using X11 tools like xrdb. Many
413 xrdb. Many distribution do also load settings from the ~/.Xresources 425 distribution do also load settings from the ~/.Xresources file when X
414 file when X starts. rxvt will consult the following files/resources in 426 starts. rxvt will consult the following files/resources in order, with
415 order, with later settings overwriting earlier ones: 427 later settings overwriting earlier ones:
416 428
417 1. system-wide app-defaults file, either locale-dependent OR global 429 1. system-wide app-defaults file, either locale-dependent OR global
418 2. app-defaults file in $XAPPLRESDIR 430 2. app-defaults file in $XAPPLRESDIR
419 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 431 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
420 4. SCREEN_RESOURCES for the current screen 432 4. SCREEN_RESOURCES for the current screen
421 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 433 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
422 434
423 If compiled with internal Xresources support (i.e. rxvt -h lists 435 Note that when reading X resources, rxvt recognizes two class names:
424 .Xdefaults) then rxvt accepts application defaults set in 436 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
425 XAPPLOADDIR/URxvt (compile-time defined: usually 437 and the original *rxvt* to be easily configured, while the class name
426 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 438 URxvt allows resources unique to rxvt, to be shared between different
427 ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X
428 resources, rxvt recognizes two class names: XTerm and URxvt. The class
429 name Rxvt allows resources common to both rxvt and the original *rxvt*
430 to be easily configured, while the class name URxvt allows resources
431 unique to rxvt, notably colours and key-handling, to be shared between
432 different rxvt configurations. If no resources are specified, suitable 439 rxvt configurations. If no resources are specified, suitable defaults
433 defaults will be used. Command-line arguments can be used to override 440 will be used. Command-line arguments can be used to override resource
434 resource settings. The following resources are allowed: 441 settings. The following resources are supported (you might want to check
442 the rxvtperl(3) manpage for additional settings by perl extensions not
443 documented here):
444
445 depth: *bitdepth*
446 Compile *xft*: Attempt to find a visual with the given bit depth;
447 option -depth.
435 448
436 geometry: *geom* 449 geometry: *geom*
437 Create the window with the specified X window geometry [default 450 Create the window with the specified X window geometry [default
438 80x24]; option -geometry. 451 80x24]; option -geometry.
439 452
… …
500 513
501 inheritPixmap: *boolean* 514 inheritPixmap: *boolean*
502 True: make the background inherit the parent windows' pixmap, giving 515 True: make the background inherit the parent windows' pixmap, giving
503 artificial transparency. False: do not inherit the parent windows' 516 artificial transparency. False: do not inherit the parent windows'
504 pixmap. 517 pixmap.
518
519 *Please note that transparency of any kind if completely unsupported
520 by the author. Don't bug him with installation questions!*
505 521
506 fading: *number* 522 fading: *number*
507 Fade the text by the given percentage when focus is lost; option 523 Fade the text by the given percentage when focus is lost; option
508 -fade. 524 -fade.
509 525
… …
539 scale of 1 displays the image without any scaling. A scale of 2 to 9 555 scale of 1 displays the image without any scaling. A scale of 2 to 9
540 specifies an integer number of images in that direction. No image 556 specifies an integer number of images in that direction. No image
541 will be magnified beyond 10 times its original size. The maximum 557 will be magnified beyond 10 times its original size. The maximum
542 permitted scale is 1000. [default 0x0+50+50] 558 permitted scale is 1000. [default 0x0+50+50]
543 559
544 menu: *file[;tag]*
545 Read in the specified menu file (note the `.menu' extension is
546 optional) and also optionally specify a starting tag to find. See
547 the reference documentation for details on the syntax for the
548 menuBar.
549
550 path: *path* 560 path: *path*
551 Specify the colon-delimited search path for finding files (XPM and 561 Specify the colon-delimited search path for finding XPM files.
552 menus), in addition to the paths specified by the RXVTPATH and PATH
553 environment variables.
554 562
555 font: *fontlist* 563 font: *fontlist*
556 Select the fonts to be used. This is a comma separated list of font 564 Select the fonts to be used. This is a comma separated list of font
557 names that are used in turn when trying to display Unicode 565 names that are checked in order when trying to find glyphs for
558 characters. The first font defines the cell size for characters; 566 characters. The first font defines the cell size for characters;
559 other fonts might be smaller, but not larger. A reasonable default 567 other fonts might be smaller, but not (in general) larger. A
560 font list is always appended to it; option -fn. 568 (hopefully) reasonable default font list is always appended to it;
569 option -fn.
561 570
562 Each font can either be a standard X11 core font (XLFD) name, with 571 Each font can either be a standard X11 core font (XLFD) name, with
563 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 572 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
564 "xft:". 573 "xft:".
565 574
… …
568 available hint currently is "codeset=codeset-name", and this is only 577 available hint currently is "codeset=codeset-name", and this is only
569 used for Xft fonts. 578 used for Xft fonts.
570 579
571 For example, this font resource 580 For example, this font resource
572 581
573 URxvt*font: 9x15bold,\ 582 URxvt.font: 9x15bold,\
574 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 583 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
575 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 584 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
576 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 585 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
577 xft:Code2000:antialias=false 586 xft:Code2000:antialias=false
578 587
… …
614 normal text font will being used for the given style. 623 normal text font will being used for the given style.
615 624
616 intensityStyles: *boolean* 625 intensityStyles: *boolean*
617 When font styles are not enabled, or this option is enabled (True, 626 When font styles are not enabled, or this option is enabled (True,
618 option -is, the default), bold and italic font styles imply high 627 option -is, the default), bold and italic font styles imply high
619 intensity foreground/backround colours. Disabling this option 628 intensity foreground/background colours. Disabling this option
620 (False, option +is) disables this behaviour, the high intensity 629 (False, option +is) disables this behaviour, the high intensity
621 colours are not reachable. 630 colours are not reachable.
622 631
623 selectstyle: *mode* 632 selectstyle: *mode*
624 Set mouse selection style to old which is 2.20, oldword which is 633 Set mouse selection style to old which is 2.20, oldword which is
… …
664 673
665 The string will be interpreted as if typed into the shell as-is. 674 The string will be interpreted as if typed into the shell as-is.
666 675
667 Example: 676 Example:
668 677
669 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 678 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
670 679
671 This creates a new file in your home directory with the screen 680 This creates a new file in your home directory with the screen
672 contents everytime you hit "Print". 681 contents every time you hit "Print".
673 682
674 scrollBar: *boolean* 683 scrollBar: *boolean*
675 True: enable the scrollbar [default]; option -sb. False: disable the 684 True: enable the scrollbar [default]; option -sb. False: disable the
676 scrollbar; option +sb. 685 scrollbar; option +sb.
677 686
… …
692 do not scroll to bottom when tty receives output; option +si. 701 do not scroll to bottom when tty receives output; option +si.
693 702
694 scrollWithBuffer: *boolean* 703 scrollWithBuffer: *boolean*
695 True: scroll with scrollback buffer when tty receives new lines (and 704 True: scroll with scrollback buffer when tty receives new lines (and
696 scrollTtyOutput is False); option -sw. False: do not scroll with 705 scrollTtyOutput is False); option -sw. False: do not scroll with
697 scrollback buffer when tty recieves new lines; option +sw. 706 scrollback buffer when tty receives new lines; option +sw.
698 707
699 scrollTtyKeypress: *boolean* 708 scrollTtyKeypress: *boolean*
700 True: scroll to bottom when a non-special key is pressed. Special 709 True: scroll to bottom when a non-special key is pressed. Special
701 keys are those which are intercepted by rxvt-unicode for special 710 keys are those which are intercepted by rxvt-unicode for special
702 handling and are not passed onto the shell; option -sk. False: do 711 handling and are not passed onto the shell; option -sk. False: do
… …
775 The string to send when the delete key (not the keypad delete key) 784 The string to send when the delete key (not the keypad delete key)
776 is pressed. If unset it will send the sequence traditionally 785 is pressed. If unset it will send the sequence traditionally
777 associated with the Execute key. 786 associated with the Execute key.
778 787
779 cutchars: *string* 788 cutchars: *string*
780 The characters used as delimiters for double-click word selection. 789 The characters used as delimiters for double-click word selection
781 The built-in default: 790 (whitespace delimiting is added automatically if resource is given).
791
792 When the selection extension is in use (the default if compiled in,
793 see the rxvtperl(3) manpage), a suitable regex using these
794 characters will be created (if the resource exists, otherwise, no
795 regex will be created). In this mode, characters outside ISO-8859-1
796 can be used.
797
798 When the selection extension is not used, only ISO-8859-1 characters
799 can be used. If not specified, the built-in default is used:
782 800
783 BACKSLASH `"'&()*,;<=>?@[]{|} 801 BACKSLASH `"'&()*,;<=>?@[]{|}
784 802
785 preeditType: *style* 803 preeditType: *style*
786 OverTheSpot, OffTheSpot, Root; option -pt. 804 OverTheSpot, OffTheSpot, Root; option -pt.
… …
817 xterm, have these sequences enabled by default, which doesn't make 835 xterm, have these sequences enabled by default, which doesn't make
818 it safer, though). 836 it safer, though).
819 837
820 You can enable them by setting this boolean resource or specifying 838 You can enable them by setting this boolean resource or specifying
821 -insecure as an option. At the moment, this enables display-answer, 839 -insecure as an option. At the moment, this enables display-answer,
822 locale, findfont, icon label and window title requests as well as 840 locale, findfont, icon label and window title requests.
823 dynamic menubar dispatch.
824 841
825 modifier: *modifier* 842 modifier: *modifier*
826 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 843 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
827 super, mod1, mod2, mod3, mod4, mod5; option -mod. 844 super, mod1, mod2, mod3, mod4, mod5; option -mod.
828 845
829 answerbackString: *string* 846 answerbackString: *string*
830 Specify the reply rxvt-unicode sends to the shell when an ENQ 847 Specify the reply rxvt-unicode sends to the shell when an ENQ
831 (control-E) character is passed through. It may contain escape 848 (control-E) character is passed through. It may contain escape
832 values as described in the entry on keysym following. 849 values as described in the entry on keysym following.
833 850
834 secondaryScreen: *bool* 851 secondaryScreen: *boolean*
835 Turn on/off secondary screen (default enabled). 852 Turn on/off secondary screen (default enabled).
836 853
837 secondaryScroll: *bool* 854 secondaryScroll: *boolean*
838 Turn on/off secondary screen scroll (default enabled). If the this 855 Turn on/off secondary screen scroll (default enabled). If the this
839 option is enabled, scrolls on the secondary screen will change the 856 option is enabled, scrolls on the secondary screen will change the
840 scrollback buffer and switching to/from the secondary screen will 857 scrollback buffer and switching to/from the secondary screen will
841 instead scroll the screen up. 858 instead scroll the screen up.
842 859
843 hold: *bool* 860 hold: *boolean*
844 Turn on/off hold window after exit support. If enabled, rxvt will 861 Turn on/off hold window after exit support. If enabled, rxvt will
845 not immediately destroy its window when the program executed within 862 not immediately destroy its window when the program executed within
846 it exits. Instead, it will wait till it is being killed or closed by 863 it exits. Instead, it will wait till it is being killed or closed by
847 the user. 864 the user.
848 865
… …
869 886
870 *string* may contain escape values ("\a": bell, "\b": backspace, 887 *string* may contain escape values ("\a": bell, "\b": backspace,
871 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 888 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
872 "\000": octal number) or verbatim control characters ("^?": delete, 889 "\000": octal number) or verbatim control characters ("^?": delete,
873 "^@": null, "^A" ...) and may be enclosed with double quotes so that 890 "^@": null, "^A" ...) and may be enclosed with double quotes so that
874 it can start or end with whitespace. 891 it can start or end with whitespace. This feature is deprecated and
892 will be removed.
875 893
876 Please note that you need to double the "\" when using 894 Please note that you need to double the "\" in resource files, as
877 "--enable-xgetdefault", as X itself does it's own de-escaping (you 895 Xlib itself does its own de-escaping (you can use "\033" instead of
878 can use "\033" instead of "\e" (and so on), which will work with 896 "\e" (and so on), which will work with both Xt and rxvt's own
879 both Xt and rxvt's own processing). 897 processing).
880 898
881 You can define a range of keysyms in one shot by providing a 899 You can define a range of keysyms in one shot by providing a
882 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 900 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimiter
883 `/' should be a character not used by the strings. 901 `/' should be a character not used by the strings.
884 902
885 Its usage can be demonstrated by an example: 903 Its usage can be demonstrated by an example:
886 904
887 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 905 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
… …
938 URxvt.keysym.M-C-3: command:\033[8;25;80t 956 URxvt.keysym.M-C-3: command:\033[8;25;80t
939 URxvt.keysym.M-C-4: command:\033[8;48;110t 957 URxvt.keysym.M-C-4: command:\033[8;48;110t
940 958
941 perl-ext-common: *string* 959 perl-ext-common: *string*
942 perl-ext: *string* 960 perl-ext: *string*
943 Colon-separated list(s) of perl extension scripts to use in this 961 Comma-separated list(s) of perl extension scripts (default:
944 terminal instance. Each extension is looked up in the library 962 "default") to use in this terminal instance; option -pe.
963
964 Extension names can be prefixed with a "-" sign to prohibit using
965 them. This can be useful to selectively disable some extensions
966 loaded by default, or specified via the "perl-ext-common" resource.
967 For example, "default,-selection" will use all the default extension
968 except "selection".
969
970 Extension names can also be followed by an argument in angle
971 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
972 for searchable scrollback to Alt/Meta-s). Mentioning the same
973 extension multiple times with different arguments will pass multiple
974 arguments to the extension.
975
976 Each extension is looked up in the library directories, loaded if
945 directories, loaded if necessary, and bound to the current terminal 977 necessary, and bound to the current terminal instance.
946 instance. If this resource is empty or missing, then the perl 978
979 If both of these resources are the empty string, then the perl
947 interpreter will not be initialized. The idea behind two options is 980 interpreter will not be initialized. The idea behind two options is
948 that perl-ext-common will be used for extensions that should be 981 that perl-ext-common will be used for extensions that should be
949 available to all instances, while perl-ext is used for specific 982 available to all instances, while perl-ext is used for specific
950 instances; option -pe. 983 instances.
951 984
952 perl-eval: *string* 985 perl-eval: *string*
953 Perl code to be evaluated when all extensions have been registered. 986 Perl code to be evaluated when all extensions have been registered.
954 See the rxvtperl(3) manpage. 987 See the rxvtperl(3) manpage. Due to security reasons, this resource
988 will be ignored when running setuid/setgid.
955 989
956 perl-lib: *path* 990 perl-lib: *path*
957 Colon-separated list of additional directories that hold extension 991 Colon-separated list of additional directories that hold extension
958 scripts. When looking for extensions specified by the "perl" 992 scripts. When looking for extensions specified by the "perl"
959 resource, rxvt will first look in these directories and then in 993 resource, rxvt will first look in these directories and then in
960 /opt/rxvt/lib/urxvt/perl/. 994 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
995 will be ignored when running setuid/setgid.
961 996
962 See the rxvtperl(3) manpage. 997 See the rxvtperl(3) manpage.
998
999 selection.pattern-*idx*: *perl-regex*
1000 Additional selection patterns, see the rxvtperl(3) manpage for
1001 details.
1002
1003 selection-autotransform.*idx*: *perl-transform*
1004 Selection auto-transform patterns, see the rxvtperl(3) manpage for
1005 details.
1006
1007 searchable-scrollback: *keysym*
1008 Sets the hotkey that starts the incremental scrollback buffer search
1009 (default: "M-s").
1010
1011 urlLauncher: *string*
1012 Specifies the program to be started with a URL argument. Used by the
1013 "selection-popup" and "mark-urls" perl extensions.
1014
1015 transient-for: *windowid*
1016 Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given
1017 window id.
1018
1019 override-redirect: *boolean*
1020 Compile *frills*: Sets override-redirect for the terminal window,
1021 making it almost invisible to window managers; option
1022 -override-redirect.
963 1023
964THE SCROLLBAR 1024THE SCROLLBAR
965 Lines of text that scroll off the top of the rxvt window (resource: 1025 Lines of text that scroll off the top of the rxvt window (resource:
966 saveLines) and can be scrolled back using the scrollbar or by 1026 saveLines) and can be scrolled back using the scrollbar or by
967 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1027 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
… …
999 normal one. In this mode, every selected row becomes its own line in 1059 normal one. In this mode, every selected row becomes its own line in
1000 the selection, and trailing whitespace is visually underlined and 1060 the selection, and trailing whitespace is visually underlined and
1001 removed from the selection. 1061 removed from the selection.
1002 1062
1003 Insertion: 1063 Insertion:
1004 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1064 Pressing and releasing the Middle mouse button in an rxvt window
1005 an rxvt window causes the current text selection to be inserted as 1065 causes the value of the PRIMARY selection (or CLIPBOARD with the
1006 if it had been typed on the keyboard. 1066 Meta modifier) to be inserted as if it had been typed on the
1067 keyboard.
1068
1069 Pressing Shift-Insert causes the value of the PRIMARY selection to
1070 be inserted too.
1007 1071
1008CHANGING FONTS 1072CHANGING FONTS
1009 Changing fonts (or font sizes, respectively) via the keypad is not yet 1073 Changing fonts (or font sizes, respectively) via the keypad is not yet
1010 supported in rxvt-unicode. Bug me if you need this. 1074 supported in rxvt-unicode. Bug me if you need this.
1011 1075
1012 You can, however, switch fonts at runtime using escape sequences (and 1076 You can, however, switch fonts at runtime using escape sequences, e.g.:
1013 therefore using the menubar), e.g.:
1014 1077
1015 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1078 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1079
1080 You can use keyboard shortcuts, too:
1081
1082 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1083 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1016 1084
1017 rxvt-unicode will automatically re-apply these fonts to the output so 1085 rxvt-unicode will automatically re-apply these fonts to the output so
1018 far. 1086 far.
1019 1087
1020ISO 14755 SUPPORT 1088ISO 14755 SUPPORT
… …
1044 This mode lets you input characters representing the keycap symbols 1112 This mode lets you input characters representing the keycap symbols
1045 of your keyboard, if representable in the current locale encoding. 1113 of your keyboard, if representable in the current locale encoding.
1046 1114
1047 Start by pressing "Control" and "Shift" together, then releasing 1115 Start by pressing "Control" and "Shift" together, then releasing
1048 them. The next special key (cursor keys, home etc.) you enter will 1116 them. The next special key (cursor keys, home etc.) you enter will
1049 not invoke it's usual function but instead will insert the 1117 not invoke its usual function but instead will insert the
1050 corresponding keycap symbol. The symbol will only be entered when 1118 corresponding keycap symbol. The symbol will only be entered when
1051 the key has been released, otherwise pressing e.g. "Shift" would 1119 the key has been released, otherwise pressing e.g. "Shift" would
1052 enter the symbol for "ISO Level 2 Switch", although your intention 1120 enter the symbol for "ISO Level 2 Switch", although your intention
1053 might have been to enter a reverse tab (Shift-Tab). 1121 might have been to enter a reverse tab (Shift-Tab).
1054 1122
… …
1083 setgid to root or to some other group on others. 1151 setgid to root or to some other group on others.
1084 1152
1085COLORS AND GRAPHICS 1153COLORS AND GRAPHICS
1086 In addition to the default foreground and background colours, rxvt can 1154 In addition to the default foreground and background colours, rxvt can
1087 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 1155 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
1088 versions of the same). Here is a list of the colours with their rgb.txt 1156 versions of the same). Here is a list of the colours with their names.
1089 names.
1090 1157
1091 color0 (black) = Black 1158 color0 (black) = Black
1092 color1 (red) = Red3 1159 color1 (red) = Red3
1093 color2 (green) = Green3 1160 color2 (green) = Green3
1094 color3 (yellow) = Yellow3 1161 color3 (yellow) = Yellow3
… …
1110 It is also possible to specify the colour values of foreground, 1177 It is also possible to specify the colour values of foreground,
1111 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1178 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1112 0-15, as a convenient shorthand to reference the colour name of 1179 0-15, as a convenient shorthand to reference the colour name of
1113 color0-color15. 1180 color0-color15.
1114 1181
1182 In addition to the colours defined above, rxvt offers an additional 72
1183 colours. The first 64 of those (with indices 16 to 79) consist of a
1184 4*4*4 RGB colour cube (i.e. *index = r * 16 + g * 4 + b + 16*), followed
1185 by 8 additional shades of gray (with indices 80 to 87).
1186
1187 Together, all those colours implement the 88 colour xterm colours. Only
1188 the first 16 can be changed using resources currently, the rest can only
1189 be changed via command sequences ("escape codes").
1190
1115 Note that -rv ("reverseVideo: True") simulates reverse video by always 1191 Note that -rv ("reverseVideo: True") simulates reverse video by always
1116 swapping the foreground/background colours. This is in contrast to 1192 swapping the foreground/background colours. This is in contrast to
1117 *xterm*(1) where the colours are only swapped if they have not otherwise 1193 *xterm*(1) where the colours are only swapped if they have not otherwise
1118 been specified. For example, 1194 been specified. For example,
1119 1195
1120 rxvt -fg Black -bg White -rv 1196 rxvt -fg Black -bg White -rv
1121 would yield White on Black, while on *xterm*(1) it would yield Black 1197 would yield White on Black, while on *xterm*(1) it would yield Black
1122 on White. 1198 on White.
1123 1199
1200 ALPHA CHANNEL SUPPORT
1201 If Xft support has been compiled in and as long as Xft/Xrender/X don't
1202 get their act together, rxvt-unicode will support
1203 "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4
1204 digits/component) colour specifications, in addition to the ones
1205 provided by X, where the additional A component specifies opacity
1206 (alpha) values. The minimum value of 0 is completely transparent). You
1207 can also prefix any color with "[a]", where "a" is on to four hex digits
1208 specifiying the opacity value.
1209
1210 You probably need to specify "-depth 32", too, and have the luck that
1211 your X-server uses ARGB pixel layout, as X is far from just supporting
1212 ARGB visuals out of the box, and rxvt-unicode just fudges around.
1213
1214 For example, the following selects an almost completely transparent red
1215 background, and an almost opaque pink foreground:
1216
1217 rxvt -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
1218
1219 *Please note that transparency of any kind if completely unsupported by
1220 the author. Don't bug him with installation questions!*
1221
1124ENVIRONMENT 1222ENVIRONMENT
1125 rxvt sets and/or uses the following environment variables: 1223 rxvt sets and/or uses the following environment variables:
1126 1224
1127 TERM 1225 TERM
1128 Normally set to "rxvt-unicode", unless overwritten at configure 1226 Normally set to "rxvt-unicode", unless overwritten at configure
1129 time, via resources or on the commandline. 1227 time, via resources or on the command line.
1130 1228
1131 COLORTERM 1229 COLORTERM
1132 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled 1230 Either "rxvt", "rxvt-xpm", depending on whether rxvt was compiled
1133 with XPM support, and optionally with the added extension "-mono" to 1231 with XPM support, and optionally with the added extension "-mono" to
1134 indicate that rxvt-unicode runs on a monochrome screen. 1232 indicate that rxvt-unicode runs on a monochrome screen.
1135 1233
1136 COLORFGBG 1234 COLORFGBG
1137 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is 1235 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
… …
1151 Set to the terminfo directory iff rxvt was configured with 1249 Set to the terminfo directory iff rxvt was configured with
1152 "--with-terminfo=PATH". 1250 "--with-terminfo=PATH".
1153 1251
1154 DISPLAY 1252 DISPLAY
1155 Used by rxvt to connect to the display and set to the correct 1253 Used by rxvt to connect to the display and set to the correct
1156 display in it's child processes. 1254 display in its child processes.
1157 1255
1158 SHELL 1256 SHELL
1159 The shell to be used for command execution, defaults to "/bin/sh". 1257 The shell to be used for command execution, defaults to "/bin/sh".
1160
1161 RXVTPATH
1162 The path where rxvt looks for support files such as menu and xpm
1163 files.
1164
1165 PATH
1166 Used in the same way as "RXVTPATH".
1167 1258
1168 RXVT_SOCKET 1259 RXVT_SOCKET
1169 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1260 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1170 1261
1171 Default $HOME/.rxvt-unicode-*<nodename*. 1262 Default $HOME/.rxvt-unicode-*<nodename*.
… …
1192 1283
1193CURRENT PROJECT COORDINATOR 1284CURRENT PROJECT COORDINATOR
1194 Project Coordinator 1285 Project Coordinator
1195 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1286 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1196 1287
1197 <http://software.schmorp.de/#rxvt-unicode> 1288 <http://software.schmorp.de/pkg/rxvt-unicode.html>
1198 1289
1199AUTHORS 1290AUTHORS
1200 John Bovey 1291 John Bovey
1201 University of Kent, 1992, wrote the original Xvt. 1292 University of Kent, 1992, wrote the original Xvt.
1202 1293
… …
1213 1304
1214 Oezguer Kesim <kesim@math.fu-berlin.de> 1305 Oezguer Kesim <kesim@math.fu-berlin.de>
1215 Project Coordinator (changes.txt 2.21a to 2.4.5) 1306 Project Coordinator (changes.txt 2.21a to 2.4.5)
1216 1307
1217 Geoff Wing <gcw@pobox.com> 1308 Geoff Wing <gcw@pobox.com>
1218 Rewrote screen display and text selection routines. Project 1309 Rewrote screen display and text selection routines.
1310
1219 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1311 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1220 1312
1221 Marc Alexander Lehmann <rxvt-unicode@schmorp.de> 1313 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1222 Forked rxvt-unicode, rewrote most of the display code and internal 1314 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1223 character handling to store text in unicode, improve xterm 1315 perl extension, random hacks, numerous bugfixes and extensions.
1224 compatibility and apply numerous other bugfixes and extensions.
1225 1316
1226 Project Coordinator (Changes 1.0 -) 1317 Project Coordinator (Changes 1.0 -)
1227 1318
1319 Emanuele Giaquinta <e.giaquinta@glauco.it>
1320 Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1321

Diff Legend

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