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

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.39 by root, Mon Jan 9 01:36:56 2006 UTC vs.
Revision 1.62 by root, Mon Aug 7 16:17:30 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 7.9, is a colour vt102 terminal emulator intended
10 as an *xterm*(1) replacement for users who do not require features such 10 as an *xterm*(1) replacement for users who do not require features such
11 as Tektronix 4014 emulation and toolkit-style configurability. As a 11 as Tektronix 4014 emulation and toolkit-style configurability. As a
12 result, rxvt-unicode uses much less swap space -- a significant 12 result, rxvt-unicode uses much less swap space -- a significant
13 advantage on a machine serving many X sessions. 13 advantage on a machine serving many X sessions.
14 14
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
373 system "rxvt -embed $xid &"; 385 system "rxvt -embed $xid &";
374 }); 386 });
375 387
376 -pty-fd *file descriptor* 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
407 419
408RESOURCES (available also as long-options) 420RESOURCES (available also as long-options)
409 Note: `rxvt --help' gives a list of all resources (long options) 421 Note: `rxvt --help' gives a list of all resources (long options)
410 compiled into your version. 422 compiled into your version.
411 423
412 There are two different methods that rxvt can use to get the Xresource
413 data: using the X libraries (Xrm*-functions) or internal Xresources
414 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
415 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
416 xrdb. Many distribution do also load settings from the ~/.Xresources 425 distribution do also load settings from the ~/.Xresources file when X
417 file when X starts. rxvt will consult the following files/resources in 426 starts. rxvt will consult the following files/resources in order, with
418 order, with later settings overwriting earlier ones: 427 later settings overwriting earlier ones:
419 428
420 1. system-wide app-defaults file, either locale-dependent OR global 429 1. system-wide app-defaults file, either locale-dependent OR global
421 2. app-defaults file in $XAPPLRESDIR 430 2. app-defaults file in $XAPPLRESDIR
422 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 431 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
423 4. SCREEN_RESOURCES for the current screen 432 4. SCREEN_RESOURCES for the current screen
424 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 433 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
425 434
426 If compiled with internal Xresources support (i.e. rxvt -h lists 435 Note that when reading X resources, rxvt recognizes two class names:
427 .Xdefaults) then rxvt accepts application defaults set in 436 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
428 XAPPLOADDIR/URxvt (compile-time defined: usually 437 and the original *rxvt* to be easily configured, while the class name
429 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 438 URxvt allows resources unique to rxvt, to be shared between different
430 ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X
431 resources, rxvt recognizes two class names: XTerm and URxvt. The class
432 name Rxvt allows resources common to both rxvt and the original *rxvt*
433 to be easily configured, while the class name URxvt allows resources
434 unique to rxvt, notably colours and key-handling, to be shared between
435 different rxvt configurations. If no resources are specified, suitable 439 rxvt configurations. If no resources are specified, suitable defaults
436 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
437 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.
438 448
439 geometry: *geom* 449 geometry: *geom*
440 Create the window with the specified X window geometry [default 450 Create the window with the specified X window geometry [default
441 80x24]; option -geometry. 451 80x24]; option -geometry.
442 452
503 513
504 inheritPixmap: *boolean* 514 inheritPixmap: *boolean*
505 True: make the background inherit the parent windows' pixmap, giving 515 True: make the background inherit the parent windows' pixmap, giving
506 artificial transparency. False: do not inherit the parent windows' 516 artificial transparency. False: do not inherit the parent windows'
507 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!*
508 521
509 fading: *number* 522 fading: *number*
510 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
511 -fade. 524 -fade.
512 525
542 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
543 specifies an integer number of images in that direction. No image 556 specifies an integer number of images in that direction. No image
544 will be magnified beyond 10 times its original size. The maximum 557 will be magnified beyond 10 times its original size. The maximum
545 permitted scale is 1000. [default 0x0+50+50] 558 permitted scale is 1000. [default 0x0+50+50]
546 559
547 menu: *file[;tag]*
548 Read in the specified menu file (note the `.menu' extension is
549 optional) and also optionally specify a starting tag to find. See
550 the reference documentation for details on the syntax for the
551 menuBar.
552
553 path: *path* 560 path: *path*
554 Specify the colon-delimited search path for finding files (XPM and 561 Specify the colon-delimited search path for finding XPM files.
555 menus), in addition to the paths specified by the RXVTPATH and PATH
556 environment variables.
557 562
558 font: *fontlist* 563 font: *fontlist*
559 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
560 names that are used in turn when trying to display Unicode 565 names that are checked in order when trying to find glyphs for
561 characters. The first font defines the cell size for characters; 566 characters. The first font defines the cell size for characters;
562 other fonts might be smaller, but not larger. A reasonable default 567 other fonts might be smaller, but not (in general) larger. A
563 font list is always appended to it; option -fn. 568 (hopefully) reasonable default font list is always appended to it;
569 option -fn.
564 570
565 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
566 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 572 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
567 "xft:". 573 "xft:".
568 574
571 available hint currently is "codeset=codeset-name", and this is only 577 available hint currently is "codeset=codeset-name", and this is only
572 used for Xft fonts. 578 used for Xft fonts.
573 579
574 For example, this font resource 580 For example, this font resource
575 581
576 URxvt*font: 9x15bold,\ 582 URxvt.font: 9x15bold,\
577 -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,\
578 -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, \
579 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 585 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
580 xft:Code2000:antialias=false 586 xft:Code2000:antialias=false
581 587
617 normal text font will being used for the given style. 623 normal text font will being used for the given style.
618 624
619 intensityStyles: *boolean* 625 intensityStyles: *boolean*
620 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,
621 option -is, the default), bold and italic font styles imply high 627 option -is, the default), bold and italic font styles imply high
622 intensity foreground/backround colours. Disabling this option 628 intensity foreground/background colours. Disabling this option
623 (False, option +is) disables this behaviour, the high intensity 629 (False, option +is) disables this behaviour, the high intensity
624 colours are not reachable. 630 colours are not reachable.
625 631
626 selectstyle: *mode* 632 selectstyle: *mode*
627 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
667 673
668 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.
669 675
670 Example: 676 Example:
671 677
672 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 678 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
673 679
674 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
675 contents everytime you hit "Print". 681 contents every time you hit "Print".
676 682
677 scrollBar: *boolean* 683 scrollBar: *boolean*
678 True: enable the scrollbar [default]; option -sb. False: disable the 684 True: enable the scrollbar [default]; option -sb. False: disable the
679 scrollbar; option +sb. 685 scrollbar; option +sb.
680 686
695 do not scroll to bottom when tty receives output; option +si. 701 do not scroll to bottom when tty receives output; option +si.
696 702
697 scrollWithBuffer: *boolean* 703 scrollWithBuffer: *boolean*
698 True: scroll with scrollback buffer when tty receives new lines (and 704 True: scroll with scrollback buffer when tty receives new lines (and
699 scrollTtyOutput is False); option -sw. False: do not scroll with 705 scrollTtyOutput is False); option -sw. False: do not scroll with
700 scrollback buffer when tty recieves new lines; option +sw. 706 scrollback buffer when tty receives new lines; option +sw.
701 707
702 scrollTtyKeypress: *boolean* 708 scrollTtyKeypress: *boolean*
703 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
704 keys are those which are intercepted by rxvt-unicode for special 710 keys are those which are intercepted by rxvt-unicode for special
705 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
778 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)
779 is pressed. If unset it will send the sequence traditionally 785 is pressed. If unset it will send the sequence traditionally
780 associated with the Execute key. 786 associated with the Execute key.
781 787
782 cutchars: *string* 788 cutchars: *string*
783 The characters used as delimiters for double-click word selection. 789 The characters used as delimiters for double-click word selection
784 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:
785 800
786 BACKSLASH `"'&()*,;<=>?@[]{|} 801 BACKSLASH `"'&()*,;<=>?@[]{|}
787 802
788 preeditType: *style* 803 preeditType: *style*
789 OverTheSpot, OffTheSpot, Root; option -pt. 804 OverTheSpot, OffTheSpot, Root; option -pt.
820 xterm, have these sequences enabled by default, which doesn't make 835 xterm, have these sequences enabled by default, which doesn't make
821 it safer, though). 836 it safer, though).
822 837
823 You can enable them by setting this boolean resource or specifying 838 You can enable them by setting this boolean resource or specifying
824 -insecure as an option. At the moment, this enables display-answer, 839 -insecure as an option. At the moment, this enables display-answer,
825 locale, findfont, icon label and window title requests as well as 840 locale, findfont, icon label and window title requests.
826 dynamic menubar dispatch.
827 841
828 modifier: *modifier* 842 modifier: *modifier*
829 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,
830 super, mod1, mod2, mod3, mod4, mod5; option -mod. 844 super, mod1, mod2, mod3, mod4, mod5; option -mod.
831 845
832 answerbackString: *string* 846 answerbackString: *string*
833 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
834 (control-E) character is passed through. It may contain escape 848 (control-E) character is passed through. It may contain escape
835 values as described in the entry on keysym following. 849 values as described in the entry on keysym following.
836 850
837 secondaryScreen: *bool* 851 secondaryScreen: *boolean*
838 Turn on/off secondary screen (default enabled). 852 Turn on/off secondary screen (default enabled).
839 853
840 secondaryScroll: *bool* 854 secondaryScroll: *boolean*
841 Turn on/off secondary screen scroll (default enabled). If the this 855 Turn on/off secondary screen scroll (default enabled). If the this
842 option is enabled, scrolls on the secondary screen will change the 856 option is enabled, scrolls on the secondary screen will change the
843 scrollback buffer and switching to/from the secondary screen will 857 scrollback buffer and switching to/from the secondary screen will
844 instead scroll the screen up. 858 instead scroll the screen up.
845 859
846 hold: *bool* 860 hold: *boolean*
847 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
848 not immediately destroy its window when the program executed within 862 not immediately destroy its window when the program executed within
849 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
850 the user. 864 the user.
851 865
874 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 888 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
875 "\000": octal number) or verbatim control characters ("^?": delete, 889 "\000": octal number) or verbatim control characters ("^?": delete,
876 "^@": null, "^A" ...) and may be enclosed with double quotes so that 890 "^@": null, "^A" ...) and may be enclosed with double quotes so that
877 it can start or end with whitespace. 891 it can start or end with whitespace.
878 892
879 Please note that you need to double the "\" when using 893 Please note that you need to double the "\" in resource files, as
880 "--enable-xgetdefault", as X itself does it's own de-escaping (you 894 Xlib itself does its own de-escaping (you can use "\033" instead of
881 can use "\033" instead of "\e" (and so on), which will work with 895 "\e" (and so on), which will work with both Xt and rxvt's own
882 both Xt and rxvt's own processing). 896 processing).
883 897
884 You can define a range of keysyms in one shot by providing a 898 You can define a range of keysyms in one shot by providing a
885 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 899 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimiter
886 `/' should be a character not used by the strings. 900 `/' should be a character not used by the strings.
887 901
888 Its usage can be demonstrated by an example: 902 Its usage can be demonstrated by an example:
889 903
890 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 904 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
945 perl-ext: *string* 959 perl-ext: *string*
946 Comma-separated list(s) of perl extension scripts (default: 960 Comma-separated list(s) of perl extension scripts (default:
947 "default") to use in this terminal instance; option -pe. 961 "default") to use in this terminal instance; option -pe.
948 962
949 Extension names can be prefixed with a "-" sign to prohibit using 963 Extension names can be prefixed with a "-" sign to prohibit using
950 it. This can be useful to selectively disable some extensions loaded 964 them. This can be useful to selectively disable some extensions
951 by default, or specified via the "perl-ext-common" resource. For 965 loaded by default, or specified via the "perl-ext-common" resource.
952 example, "default,-selection" will use all the default extension 966 For example, "default,-selection" will use all the default extension
953 except "selection". 967 except "selection".
968
969 Extension names can also be followed by an argument in angle
970 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
971 for searchable scrollback to Alt/Meta-s). Mentioning the same
972 extension multiple times with different arguments will pass multiple
973 arguments to the extension.
954 974
955 Each extension is looked up in the library directories, loaded if 975 Each extension is looked up in the library directories, loaded if
956 necessary, and bound to the current terminal instance. 976 necessary, and bound to the current terminal instance.
957 977
958 If both of these resources are the empty string, then the perl 978 If both of these resources are the empty string, then the perl
973 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource 993 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
974 will be ignored when running setuid/setgid. 994 will be ignored when running setuid/setgid.
975 995
976 See the rxvtperl(3) manpage. 996 See the rxvtperl(3) manpage.
977 997
998 selection.pattern-*idx*: *perl-regex*
999 Additional selection patterns, see the rxvtperl(3) manpage for
1000 details.
1001
1002 selection-autotransform.*idx*: *perl-transform*
1003 Selection auto-transform patterns, see the rxvtperl(3) manpage for
1004 details.
1005
1006 searchable-scrollback: *keysym*
1007 Sets the hotkey that starts the incremental scrollback buffer search
1008 (default: "M-s").
1009
1010 urlLauncher: *string*
1011 Specifies the program to be started with a URL argument. Used by the
1012 "selection-popup" and "mark-urls" perl extensions.
1013
978 transient-for: *windowid* 1014 transient-for: *windowid*
979 Sets the WM_TRANSIENT_FOR property to the given window iw. 1015 Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given
1016 window id.
1017
1018 override-redirect: *boolean*
1019 Compile *frills*: Sets override-redirect for the terminal window,
1020 making it almost invisible to window managers; option
1021 -override-redirect.
980 1022
981THE SCROLLBAR 1023THE SCROLLBAR
982 Lines of text that scroll off the top of the rxvt window (resource: 1024 Lines of text that scroll off the top of the rxvt window (resource:
983 saveLines) and can be scrolled back using the scrollbar or by 1025 saveLines) and can be scrolled back using the scrollbar or by
984 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1026 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
1016 normal one. In this mode, every selected row becomes its own line in 1058 normal one. In this mode, every selected row becomes its own line in
1017 the selection, and trailing whitespace is visually underlined and 1059 the selection, and trailing whitespace is visually underlined and
1018 removed from the selection. 1060 removed from the selection.
1019 1061
1020 Insertion: 1062 Insertion:
1021 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1063 Pressing and releasing the Middle mouse button in an rxvt window
1022 an rxvt window causes the current text selection to be inserted as 1064 causes the value of the PRIMARY selection (or CLIPBOARD with the
1023 if it had been typed on the keyboard. 1065 Meta modifier) to be inserted as if it had been typed on the
1066 keyboard.
1067
1068 Pressing Shift-Insert causes the value of the PRIMARY selection to
1069 be inserted too.
1024 1070
1025CHANGING FONTS 1071CHANGING FONTS
1026 Changing fonts (or font sizes, respectively) via the keypad is not yet 1072 Changing fonts (or font sizes, respectively) via the keypad is not yet
1027 supported in rxvt-unicode. Bug me if you need this. 1073 supported in rxvt-unicode. Bug me if you need this.
1028 1074
1029 You can, however, switch fonts at runtime using escape sequences (and 1075 You can, however, switch fonts at runtime using escape sequences, e.g.:
1030 therefore using the menubar), e.g.:
1031 1076
1032 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1077 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1078
1079 You can use keyboard shortcuts, too:
1080
1081 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1082 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1033 1083
1034 rxvt-unicode will automatically re-apply these fonts to the output so 1084 rxvt-unicode will automatically re-apply these fonts to the output so
1035 far. 1085 far.
1036 1086
1037ISO 14755 SUPPORT 1087ISO 14755 SUPPORT
1039 character codes using the keyboard. It consists of 4 parts. The first 1089 character codes using the keyboard. It consists of 4 parts. The first
1040 part is available rxvt-unicode has been compiled with "--enable-frills", 1090 part is available rxvt-unicode has been compiled with "--enable-frills",
1041 the rest is available when rxvt-unicode was compiled with 1091 the rest is available when rxvt-unicode was compiled with
1042 "--enable-iso14755". 1092 "--enable-iso14755".
1043 1093
1044 * 5.1: Basic method 1094 * 5.1: Basic method
1095
1045 This allows you to enter unicode characters using their hexcode. 1096 This allows you to enter unicode characters using their hexcode.
1046 1097
1047 Start by pressing and holding both "Control" and "Shift", then enter 1098 Start by pressing and holding both "Control" and "Shift", then enter
1048 hex-digits (between one and six). Releasing "Control" and "Shift" 1099 hex-digits (between one and six). Releasing "Control" and "Shift"
1049 will commit the character as if it were typed directly. While 1100 will commit the character as if it were typed directly. While
1055 address, which you cannot type. Fortunately, the card has the e-mail 1106 address, which you cannot type. Fortunately, the card has the e-mail
1056 address printed as hexcodes, e.g. "671d 65e5". You can enter this 1107 address printed as hexcodes, e.g. "671d 65e5". You can enter this
1057 easily by pressing "Control" and "Shift", followed by 1108 easily by pressing "Control" and "Shift", followed by
1058 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys. 1109 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys.
1059 1110
1060 * 5.2: Keyboard symbols entry method 1111 * 5.2: Keyboard symbols entry method
1112
1061 This mode lets you input characters representing the keycap symbols 1113 This mode lets you input characters representing the keycap symbols
1062 of your keyboard, if representable in the current locale encoding. 1114 of your keyboard, if representable in the current locale encoding.
1063 1115
1064 Start by pressing "Control" and "Shift" together, then releasing 1116 Start by pressing "Control" and "Shift" together, then releasing
1065 them. The next special key (cursor keys, home etc.) you enter will 1117 them. The next special key (cursor keys, home etc.) you enter will
1066 not invoke it's usual function but instead will insert the 1118 not invoke its usual function but instead will insert the
1067 corresponding keycap symbol. The symbol will only be entered when 1119 corresponding keycap symbol. The symbol will only be entered when
1068 the key has been released, otherwise pressing e.g. "Shift" would 1120 the key has been released, otherwise pressing e.g. "Shift" would
1069 enter the symbol for "ISO Level 2 Switch", although your intention 1121 enter the symbol for "ISO Level 2 Switch", although your intention
1070 might have been to enter a reverse tab (Shift-Tab). 1122 might have been to enter a reverse tab (Shift-Tab).
1071 1123
1072 * 5.3: Screen-selection entry method 1124 * 5.3: Screen-selection entry method
1125
1073 While this is implemented already (it's basically the selection 1126 While this is implemented already (it's basically the selection
1074 mechanism), it could be extended by displaying a unicode character 1127 mechanism), it could be extended by displaying a unicode character
1075 map. 1128 map.
1076 1129
1077 * 5.4: Feedback method for identifying displayed characters for later 1130 * 5.4: Feedback method for identifying displayed characters for later
1078 input 1131 input
1132
1079 This method lets you display the unicode character code associated 1133 This method lets you display the unicode character code associated
1080 with characters already displayed. 1134 with characters already displayed.
1081 1135
1082 You enter this mode by holding down "Control" and "Shift" together, 1136 You enter this mode by holding down "Control" and "Shift" together,
1083 then pressing and holding the left mouse button and moving around. 1137 then pressing and holding the left mouse button and moving around.
1100 setgid to root or to some other group on others. 1154 setgid to root or to some other group on others.
1101 1155
1102COLORS AND GRAPHICS 1156COLORS AND GRAPHICS
1103 In addition to the default foreground and background colours, rxvt can 1157 In addition to the default foreground and background colours, rxvt can
1104 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 1158 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
1105 versions of the same). Here is a list of the colours with their rgb.txt 1159 versions of the same). Here is a list of the colours with their names.
1106 names.
1107 1160
1108 color0 (black) = Black 1161 color0 (black) = Black
1109 color1 (red) = Red3 1162 color1 (red) = Red3
1110 color2 (green) = Green3 1163 color2 (green) = Green3
1111 color3 (yellow) = Yellow3 1164 color3 (yellow) = Yellow3
1112 color4 (blue) = Blue3 1165 color4 (blue) = Blue3
1113 color5 (magenta) = Magenta3 1166 color5 (magenta) = Magenta3
1114 color6 (cyan) = Cyan3 1167 color6 (cyan) = Cyan3
1115 color7 (white) = AntiqueWhite 1168 color7 (white) = AntiqueWhite
1116 color8 (bright black) = Grey25 1169 color8 (bright black) = Grey25
1117 color9 (bright red) = Red 1170 color9 (bright red) = Red
1118 color10 (bright green) = Green 1171 color10 (bright green) = Green
1119 color11 (bright yellow) = Yellow 1172 color11 (bright yellow) = Yellow
1120 color12 (bright blue) = Blue 1173 color12 (bright blue) = Blue
1121 color13 (bright magenta) = Magenta 1174 color13 (bright magenta) = Magenta
1122 color14 (bright cyan) = Cyan 1175 color14 (bright cyan) = Cyan
1123 color15 (bright white) = White 1176 color15 (bright white) = White
1124 foreground = Black 1177 foreground = Black
1125 background = White 1178 background = White
1126
1127 It is also possible to specify the colour values of foreground, 1179 It is also possible to specify the colour values of foreground,
1128 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1180 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1129 0-15, as a convenient shorthand to reference the colour name of 1181 0-15, as a convenient shorthand to reference the colour name of
1130 color0-color15. 1182 color0-color15.
1131 1183
1184 In addition to the colours defined above, rxvt offers an additional 72
1185 colours. The first 64 of those (with indices 16 to 79) consist of a
1186 4*4*4 RGB colour cube (i.e. *index = r * 16 + g * 4 + b + 16*), followed
1187 by 8 additional shades of gray (with indices 80 to 87).
1188
1189 Together, all those colours implement the 88 colour xterm colours. Only
1190 the first 16 can be changed using resources currently, the rest can only
1191 be changed via command sequences ("escape codes").
1192
1132 Note that -rv ("reverseVideo: True") simulates reverse video by always 1193 Note that -rv ("reverseVideo: True") simulates reverse video by always
1133 swapping the foreground/background colours. This is in contrast to 1194 swapping the foreground/background colours. This is in contrast to
1134 *xterm*(1) where the colours are only swapped if they have not otherwise 1195 *xterm*(1) where the colours are only swapped if they have not otherwise
1135 been specified. For example, 1196 been specified. For example,
1136 1197
1137 rxvt -fg Black -bg White -rv 1198 rxvt -fg Black -bg White -rv
1138 would yield White on Black, while on *xterm*(1) it would yield Black 1199 would yield White on Black, while on *xterm*(1) it would yield Black
1139 on White. 1200 on White.
1140 1201
1202 ALPHA CHANNEL SUPPORT
1203 If Xft support has been compiled in and as long as Xft/Xrender/X don't
1204 get their act together, rxvt-unicode will support
1205 "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4
1206 digits/component) colour specifications, in addition to the ones
1207 provided by X, where the additional A component specifies opacity
1208 (alpha) values. The minimum value of 0 is completely transparent). You
1209 can also prefix any color with "[a]", where "a" is on to four hex digits
1210 specifiying the opacity value.
1211
1212 You probably need to specify "-depth 32", too, and have the luck that
1213 your X-server uses ARGB pixel layout, as X is far from just supporting
1214 ARGB visuals out of the box, and rxvt-unicode just fudges around.
1215
1216 For example, the following selects an almost completely transparent red
1217 background, and an almost opaque pink foreground:
1218
1219 rxvt -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
1220
1221 *Please note that transparency of any kind if completely unsupported by
1222 the author. Don't bug him with installation questions!*
1223
1141ENVIRONMENT 1224ENVIRONMENT
1142 rxvt sets and/or uses the following environment variables: 1225 rxvt sets and/or uses the following environment variables:
1143 1226
1144 TERM 1227 TERM
1145 Normally set to "rxvt-unicode", unless overwritten at configure 1228 Normally set to "rxvt-unicode", unless overwritten at configure
1146 time, via resources or on the commandline. 1229 time, via resources or on the command line.
1147 1230
1148 COLORTERM 1231 COLORTERM
1149 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled 1232 Either "rxvt", "rxvt-xpm", depending on whether rxvt was compiled
1150 with XPM support, and optionally with the added extension "-mono" to 1233 with XPM support, and optionally with the added extension "-mono" to
1151 indicate that rxvt-unicode runs on a monochrome screen. 1234 indicate that rxvt-unicode runs on a monochrome screen.
1152 1235
1153 COLORFGBG 1236 COLORFGBG
1154 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is 1237 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1168 Set to the terminfo directory iff rxvt was configured with 1251 Set to the terminfo directory iff rxvt was configured with
1169 "--with-terminfo=PATH". 1252 "--with-terminfo=PATH".
1170 1253
1171 DISPLAY 1254 DISPLAY
1172 Used by rxvt to connect to the display and set to the correct 1255 Used by rxvt to connect to the display and set to the correct
1173 display in it's child processes. 1256 display in its child processes.
1174 1257
1175 SHELL 1258 SHELL
1176 The shell to be used for command execution, defaults to "/bin/sh". 1259 The shell to be used for command execution, defaults to "/bin/sh".
1177
1178 RXVTPATH
1179 The path where rxvt looks for support files such as menu and xpm
1180 files.
1181
1182 PATH
1183 Used in the same way as "RXVTPATH".
1184 1260
1185 RXVT_SOCKET 1261 RXVT_SOCKET
1186 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1262 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1187 1263
1188 Default $HOME/.rxvt-unicode-*<nodename*. 1264 Default $HOME/.rxvt-unicode-*<nodename*.
1209 1285
1210CURRENT PROJECT COORDINATOR 1286CURRENT PROJECT COORDINATOR
1211 Project Coordinator 1287 Project Coordinator
1212 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1288 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1213 1289
1214 <http://software.schmorp.de/#rxvt-unicode> 1290 <http://software.schmorp.de/pkg/rxvt-unicode.html>
1215 1291
1216AUTHORS 1292AUTHORS
1217 John Bovey 1293 John Bovey
1218 University of Kent, 1992, wrote the original Xvt. 1294 University of Kent, 1992, wrote the original Xvt.
1219 1295
1230 1306
1231 Oezguer Kesim <kesim@math.fu-berlin.de> 1307 Oezguer Kesim <kesim@math.fu-berlin.de>
1232 Project Coordinator (changes.txt 2.21a to 2.4.5) 1308 Project Coordinator (changes.txt 2.21a to 2.4.5)
1233 1309
1234 Geoff Wing <gcw@pobox.com> 1310 Geoff Wing <gcw@pobox.com>
1235 Rewrote screen display and text selection routines. Project 1311 Rewrote screen display and text selection routines.
1312
1236 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1313 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1237 1314
1238 Marc Alexander Lehmann <rxvt-unicode@schmorp.de> 1315 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1239 Forked rxvt-unicode, rewrote most of the display code and internal 1316 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1240 character handling to store text in unicode, improve xterm 1317 perl extension, random hacks, numerous bugfixes and extensions.
1241 compatibility and apply numerous other bugfixes and extensions.
1242 1318
1243 Project Coordinator (Changes 1.0 -) 1319 Project Coordinator (Changes 1.0 -)
1244 1320
1321 Emanuele Giaquinta <e.giaquinta@glauco.it>
1322 Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1323

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines