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.30 by root, Mon Jan 2 19:36:07 2006 UTC vs.
Revision 1.60 by root, Thu Jul 6 19:43:21 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.2, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 7.7, 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
… …
38 because the author couldn't get "mlterm" to use one font for latin1 and 38 because the author couldn't get "mlterm" to use one font for latin1 and
39 another for japanese. 39 another for japanese.
40 40
41 Therefore another design rationale was the use of multiple fonts to 41 Therefore another design rationale was the use of multiple fonts to
42 display characters: The idea of a single unicode font which many other 42 display characters: The idea of a single unicode font which many other
43 programs force onto it's users never made sense to me: You should be 43 programs force onto its users never made sense to me: You should be able
44 able to choose any font for any script freely. 44 to choose any font for any script freely.
45 45
46 Apart from that, rxvt-unicode is also much better internationalised than 46 Apart from that, rxvt-unicode is also much better internationalised than
47 it's predecessor, supports things such as XFT and ISO 14755 that are 47 its predecessor, supports things such as XFT and ISO 14755 that are
48 handy in i18n-environments, is faster, and has a lot less bugs than the 48 handy in i18n-environments, is faster, and has a lot less bugs than the
49 original rxvt. This all in addition to dozens of other small 49 original rxvt. This all in addition to dozens of other small
50 improvements. 50 improvements.
51 51
52 It is still faithfully following the original rxvt idea of being lean 52 It is still faithfully following the original rxvt idea of being lean
53 and nice on resources: for example, you can still configure rxvt-unicode 53 and nice on resources: for example, you can still configure rxvt-unicode
54 without most of it's features to get a lean binary. It also comes with a 54 without most of its features to get a lean binary. It also comes with a
55 client/daemon pair that lets you open any number of terminal windows 55 client/daemon pair that lets you open any number of terminal windows
56 from within a single process, which makes startup time very fast and 56 from within a single process, which makes startup time very fast and
57 drastically reduces memory usage. See rxvtd(1) (daemon) and rxvtc(1) 57 drastically reduces memory usage. See rxvtd(1) (daemon) and rxvtc(1)
58 (client). 58 (client).
59 59
… …
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!*
101 108
102 -fade *number* 109 -fade *number*
103 Fade the text by the given percentage when focus is lost. Small 110 Fade the text by the given percentage when focus is lost. Small
104 values fade a little only, 100 completely replaces all colours by 111 values fade a little only, 100 completely replaces all colours by
105 the fade colour; resource fading. 112 the fade colour; resource fading.
106 113
107 -fadecolor *colour* 114 -fadecolor *colour*
108 Fade to this colour when fading is used (see -fade). The default 115 Fade to this colour when fading is used (see -fade). The default
109 colour is black. resource fadeColor. 116 colour is opaque black. resource fadeColor.
110 117
111 -tint *colour* 118 -tint *colour*
112 Tint the transparent background pixmap with the given colour when 119 Tint the transparent background pixmap with the given colour when
113 transparency is enabled with -tr or -ip. This only works for 120 transparency is enabled with -tr or -ip. This only works for
114 non-tiled backgrounds, currently. See also the -sh option that can 121 non-tiled backgrounds, currently. See also the -sh option that can
… …
146 The colour of the border around the text area and between the 153 The colour of the border around the text area and between the
147 scrollbar and the text; resource borderColor. 154 scrollbar and the text; resource borderColor.
148 155
149 -fn *fontlist* 156 -fn *fontlist*
150 Select the fonts to be used. This is a comma separated list of font 157 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 158 names that are checked in order when trying to find glyphs for
152 characters. The first font defines the cell size for characters; 159 characters. The first font defines the cell size for characters;
153 other fonts might be smaller, but not (in general) larger. A 160 other fonts might be smaller, but not (in general) larger. A
154 (hopefully) reasonable default font list is always appended to it. 161 (hopefully) reasonable default font list is always appended to it.
155 See resource font for more details. 162 See resource font for more details.
156 163
157 In short, to specify an X11 core font, just specify it's name or 164 In short, to specify an X11 core font, just specify its name or
158 prefix it with "x:". To specify an XFT-font, you need to prefix it 165 prefix it with "x:". To specify an XFT-font, you need to prefix it
159 with "xft:", e.g.: 166 with "xft:", e.g.:
160 167
161 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 168 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
162 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" 169 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
163 170
164 See also the question "How does rxvt-unicode choose fonts?" in the 171 See also the question "How does rxvt-unicode choose fonts?" in the
165 FAQ section of rxvt(7). 172 FAQ section of rxvt(7).
166 173
167 -fb *fontlist* 174 -fb *fontlist*
168 Compile font-styles: The bold font list to use when bold characters 175 Compile *font-styles*: The bold font list to use when bold
169 are to be printed. See resource boldFont for details. 176 characters are to be printed. See resource boldFont for details.
170 177
171 -fi *fontlist* 178 -fi *fontlist*
172 Compile font-styles: The italic font list to use when bold 179 Compile *font-styles*: The italic font list to use when *italic*
173 characters are to be printed. See resource italicFont for details. 180 characters are to be printed. See resource italicFont for details.
174 181
175 -fbi *fontlist* 182 -fbi *fontlist*
176 Compile font-styles: The bold italic font list to use when bold 183 Compile *font-styles*: The bold italic font list to use when *bold
177 characters are to be printed. See resource boldItalicFont for 184 italic* characters are to be printed. See resource boldItalicFont
178 details. 185 for details.
179 186
180 -is|+is 187 -is|+is
181 Compile font-styles: Bold/Italic font styles imply high intensity 188 Compile *font-styles*: Bold/Italic font styles imply high intensity
182 foreground/background (default). See resource intensityStyles for 189 foreground/background (default). See resource intensityStyles for
183 details. 190 details.
184 191
185 -name *name* 192 -name *name*
186 Specify the application name under which resources are to be 193 Specify the application name under which resources are to be
… …
251 externalBorder. 258 externalBorder.
252 259
253 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e. 260 -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 261 if honoured by the WM, the rxvt-unicode window will not have window
255 decorations; resource borderLess. 262 decorations; resource borderLess.
263
264 -override-redirect
265 Compile *frills*: Sets override-redirect on the window; resource
266 override-redirect.
267
268 -sbg
269 Compile *frills*: Disable the usage of the built-in block
270 graphics/line drawing characters and just rely on what the specified
271 fonts provide. Use this if you have a good font and want to use its
272 block graphic glyphs; resource skipBuiltinGlyphs.
256 273
257 -lsp *number* 274 -lsp *number*
258 Compile *frills*: Lines (pixel height) to insert between each row of 275 Compile *frills*: Lines (pixel height) to insert between each row of
259 the display. Useful to work around font rendering problems; resource 276 the display. Useful to work around font rendering problems; resource
260 linespace. 277 linespace.
… …
340 357
341 -keysym.*sym* *string* 358 -keysym.*sym* *string*
342 Remap a key symbol. See resource keysym. 359 Remap a key symbol. See resource keysym.
343 360
344 -embed *windowid* 361 -embed *windowid*
345 Tells rxvt to embed it's windows into an already-existing window, 362 Tells rxvt to embed its windows into an already-existing window,
346 which enables applications to easily embed a terminal. 363 which enables applications to easily embed a terminal.
347 364
348 Right now, rxvt will first unmap/map the specified window, so it 365 Right now, rxvt will first unmap/map the specified window, so it
349 shouldn't be a top-level window. rxvt will also reconfigure it quite 366 shouldn't be a top-level window. rxvt will also reconfigure it quite
350 a bit, so don't expect it to keep some specific state. It's best to 367 a bit, so don't expect it to keep some specific state. It's best to
… …
365 $rxvt->signal_connect_after (realize => sub { 382 $rxvt->signal_connect_after (realize => sub {
366 my $xid = $_[0]->window->get_xid; 383 my $xid = $_[0]->window->get_xid;
367 system "rxvt -embed $xid &"; 384 system "rxvt -embed $xid &";
368 }); 385 });
369 386
370 -pty-fd *fileno* 387 -pty-fd *file descriptor*
371 Tells rxvt NOT to execute any commands or create a new pty/tty pair 388 Tells rxvt NOT to execute any commands or create a new pty/tty pair
372 but instead use the given filehandle as the tty master. This is 389 but instead use the given filehandle as the tty master. This is
373 useful if you want to drive rxvt as a generic terminal emulator 390 useful if you want to drive rxvt as a generic terminal emulator
374 without having to run a program within it. 391 without having to run a program within it.
375 392
376 If this switch is given, rxvt will not create any utmp/wtmp entries 393 If this switch is given, rxvt will not create any utmp/wtmp entries
377 and will not tinker with pty/tty permissions - you have to do that 394 and will not tinker with pty/tty permissions - you have to do that
378 yourself if you want that. 395 yourself if you want that.
379 396
397 As an extremely special case, specifying -1 will completely suppress
398 pty/tty operations.
399
380 Here is a example in perl that illustrates how this option can be 400 Here is a example in perl that illustrates how this option can be
381 used (a longer example is in doc/pty-fd): 401 used (a longer example is in doc/pty-fd):
382 402
383 use IO::Pty; 403 use IO::Pty;
384 use Fcntl; 404 use Fcntl;
… …
390 410
391 # now communicate with rxvt 411 # now communicate with rxvt
392 my $slave = $pty->slave; 412 my $slave = $pty->slave;
393 while (<$slave>) { print $slave "got <$_>\n" } 413 while (<$slave>) { print $slave "got <$_>\n" }
394 414
395 -perl *string* 415 -pe *string*
396 Used by perl extension. See resource perl. 416 Comma-separated list of perl extension scripts to use (or not to
417 use) in this terminal instance. See resource perl-ext for details.
397 418
398RESOURCES (available also as long-options) 419RESOURCES (available also as long-options)
399 Note: `rxvt --help' gives a list of all resources (long options) 420 Note: `rxvt --help' gives a list of all resources (long options)
400 compiled into your version. 421 compiled into your version.
401 422
402 There are two different methods that rxvt can use to get the Xresource
403 data: using the X libraries (Xrm*-functions) or internal Xresources
404 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
405 XGetDefaults), you can set and change the resources using X11 tools like 423 You can set and change the resources using X11 tools like xrdb. Many
406 xrdb. Many distribution do also load settings from the ~/.Xresources 424 distribution do also load settings from the ~/.Xresources file when X
407 file when X starts. rxvt will consult the following files/resources in 425 starts. rxvt will consult the following files/resources in order, with
408 order, with later settings overwriting earlier ones: 426 later settings overwriting earlier ones:
409 427
410 1. system-wide app-defaults file, either locale-dependent OR global 428 1. system-wide app-defaults file, either locale-dependent OR global
411 2. app-defaults file in $XAPPLRESDIR 429 2. app-defaults file in $XAPPLRESDIR
412 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 430 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
413 4. SCREEN_RESOURCES for the current screen 431 4. SCREEN_RESOURCES for the current screen
414 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 432 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
415 433
416 If compiled with internal Xresources support (i.e. rxvt -h lists 434 Note that when reading X resources, rxvt recognizes two class names:
417 .Xdefaults) then rxvt accepts application defaults set in 435 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
418 XAPPLOADDIR/URxvt (compile-time defined: usually 436 and the original *rxvt* to be easily configured, while the class name
419 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 437 URxvt allows resources unique to rxvt, to be shared between different
420 ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X
421 resources, rxvt recognizes two class names: XTerm and URxvt. The class
422 name Rxvt allows resources common to both rxvt and the original *rxvt*
423 to be easily configured, while the class name URxvt allows resources
424 unique to rxvt, notably colours and key-handling, to be shared between
425 different rxvt configurations. If no resources are specified, suitable 438 rxvt configurations. If no resources are specified, suitable defaults
426 defaults will be used. Command-line arguments can be used to override 439 will be used. Command-line arguments can be used to override resource
427 resource settings. The following resources are allowed: 440 settings. The following resources are supported (you might want to check
441 the rxvtperl(3) manpage for additional settings by perl extensions not
442 documented here):
443
444 depth: *bitdepth*
445 Compile *xft*: Attempt to find a visual with the given bit depth;
446 option -depth.
428 447
429 geometry: *geom* 448 geometry: *geom*
430 Create the window with the specified X window geometry [default 449 Create the window with the specified X window geometry [default
431 80x24]; option -geometry. 450 80x24]; option -geometry.
432 451
… …
493 512
494 inheritPixmap: *boolean* 513 inheritPixmap: *boolean*
495 True: make the background inherit the parent windows' pixmap, giving 514 True: make the background inherit the parent windows' pixmap, giving
496 artificial transparency. False: do not inherit the parent windows' 515 artificial transparency. False: do not inherit the parent windows'
497 pixmap. 516 pixmap.
517
518 *Please note that transparency of any kind if completely unsupported
519 by the author. Don't bug him with installation questions!*
498 520
499 fading: *number* 521 fading: *number*
500 Fade the text by the given percentage when focus is lost; option 522 Fade the text by the given percentage when focus is lost; option
501 -fade. 523 -fade.
502 524
… …
532 scale of 1 displays the image without any scaling. A scale of 2 to 9 554 scale of 1 displays the image without any scaling. A scale of 2 to 9
533 specifies an integer number of images in that direction. No image 555 specifies an integer number of images in that direction. No image
534 will be magnified beyond 10 times its original size. The maximum 556 will be magnified beyond 10 times its original size. The maximum
535 permitted scale is 1000. [default 0x0+50+50] 557 permitted scale is 1000. [default 0x0+50+50]
536 558
537 menu: *file[;tag]*
538 Read in the specified menu file (note the `.menu' extension is
539 optional) and also optionally specify a starting tag to find. See
540 the reference documentation for details on the syntax for the
541 menuBar.
542
543 path: *path* 559 path: *path*
544 Specify the colon-delimited search path for finding files (XPM and 560 Specify the colon-delimited search path for finding XPM files.
545 menus), in addition to the paths specified by the RXVTPATH and PATH
546 environment variables.
547 561
548 font: *fontlist* 562 font: *fontlist*
549 Select the fonts to be used. This is a comma separated list of font 563 Select the fonts to be used. This is a comma separated list of font
550 names that are used in turn when trying to display Unicode 564 names that are checked in order when trying to find glyphs for
551 characters. The first font defines the cell size for characters; 565 characters. The first font defines the cell size for characters;
552 other fonts might be smaller, but not larger. A reasonable default 566 other fonts might be smaller, but not (in general) larger. A
553 font list is always appended to it; option -fn. 567 (hopefully) reasonable default font list is always appended to it;
568 option -fn.
554 569
555 Each font can either be a standard X11 core font (XLFD) name, with 570 Each font can either be a standard X11 core font (XLFD) name, with
556 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 571 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
557 "xft:". 572 "xft:".
558 573
… …
561 available hint currently is "codeset=codeset-name", and this is only 576 available hint currently is "codeset=codeset-name", and this is only
562 used for Xft fonts. 577 used for Xft fonts.
563 578
564 For example, this font resource 579 For example, this font resource
565 580
566 URxvt*font: 9x15bold,\ 581 URxvt.font: 9x15bold,\
567 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 582 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
568 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 583 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
569 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 584 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
570 xft:Code2000:antialias=false 585 xft:Code2000:antialias=false
571 586
… …
657 672
658 The string will be interpreted as if typed into the shell as-is. 673 The string will be interpreted as if typed into the shell as-is.
659 674
660 Example: 675 Example:
661 676
662 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 677 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
663 678
664 This creates a new file in your home directory with the screen 679 This creates a new file in your home directory with the screen
665 contents everytime you hit "Print". 680 contents everytime you hit "Print".
666 681
667 scrollBar: *boolean* 682 scrollBar: *boolean*
… …
710 borderLess: *boolean* 725 borderLess: *boolean*
711 Set MWM hints to request a borderless window, i.e. if honoured by 726 Set MWM hints to request a borderless window, i.e. if honoured by
712 the WM, the rxvt-unicode window will not have window decorations; 727 the WM, the rxvt-unicode window will not have window decorations;
713 option -bl. 728 option -bl.
714 729
730 skipBuiltinGlyphs: *boolean*
731 Compile *frills*: Disable the usage of the built-in block
732 graphics/line drawing characters and just rely on what the specified
733 fonts provide. Use this if you have a good font and want to use its
734 block graphic glyphs; option -sbg.
735
715 termName: *termname* 736 termName: *termname*
716 Specifies the terminal type name to be set in the TERM environment 737 Specifies the terminal type name to be set in the TERM environment
717 variable; option -tn. 738 variable; option -tn.
718 739
719 linespace: *number* 740 linespace: *number*
… …
762 The string to send when the delete key (not the keypad delete key) 783 The string to send when the delete key (not the keypad delete key)
763 is pressed. If unset it will send the sequence traditionally 784 is pressed. If unset it will send the sequence traditionally
764 associated with the Execute key. 785 associated with the Execute key.
765 786
766 cutchars: *string* 787 cutchars: *string*
767 The characters used as delimiters for double-click word selection. 788 The characters used as delimiters for double-click word selection
768 The built-in default: 789 (whitespace delimiting is added automatically if resource is given).
790
791 When the selection extension is in use (the default if compiled in,
792 see the rxvtperl(3) manpage), a suitable regex using these
793 characters will be created (if the resource exists, otherwise, no
794 regex will be created). In this mode, characters outside ISO-8859-1
795 can be used.
796
797 When the selection extension is not used, only ISO-8859-1 characters
798 can be used. If not specified, the built-in default is used:
769 799
770 BACKSLASH `"'&()*,;<=>?@[]{|} 800 BACKSLASH `"'&()*,;<=>?@[]{|}
771 801
772 preeditType: *style* 802 preeditType: *style*
773 OverTheSpot, OffTheSpot, Root; option -pt. 803 OverTheSpot, OffTheSpot, Root; option -pt.
… …
804 xterm, have these sequences enabled by default, which doesn't make 834 xterm, have these sequences enabled by default, which doesn't make
805 it safer, though). 835 it safer, though).
806 836
807 You can enable them by setting this boolean resource or specifying 837 You can enable them by setting this boolean resource or specifying
808 -insecure as an option. At the moment, this enables display-answer, 838 -insecure as an option. At the moment, this enables display-answer,
809 locale, findfont, icon label and window title requests as well as 839 locale, findfont, icon label and window title requests.
810 dynamic menubar dispatch.
811 840
812 modifier: *modifier* 841 modifier: *modifier*
813 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 842 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
814 super, mod1, mod2, mod3, mod4, mod5; option -mod. 843 super, mod1, mod2, mod3, mod4, mod5; option -mod.
815 844
816 answerbackString: *string* 845 answerbackString: *string*
817 Specify the reply rxvt-unicode sends to the shell when an ENQ 846 Specify the reply rxvt-unicode sends to the shell when an ENQ
818 (control-E) character is passed through. It may contain escape 847 (control-E) character is passed through. It may contain escape
819 values as described in the entry on keysym following. 848 values as described in the entry on keysym following.
820 849
821 secondaryScreen: *bool* 850 secondaryScreen: *boolean*
822 Turn on/off secondary screen (default enabled). 851 Turn on/off secondary screen (default enabled).
823 852
824 secondaryScroll: *bool* 853 secondaryScroll: *boolean*
825 Turn on/off secondary screen scroll (default enabled). If the this 854 Turn on/off secondary screen scroll (default enabled). If the this
826 option is enabled, scrolls on the secondary screen will change the 855 option is enabled, scrolls on the secondary screen will change the
827 scrollback buffer and switching to/from the secondary screen will 856 scrollback buffer and switching to/from the secondary screen will
828 instead scroll the screen up. 857 instead scroll the screen up.
829 858
830 hold: *bool* 859 hold: *boolean*
831 Turn on/off hold window after exit support. If enabled, rxvt will 860 Turn on/off hold window after exit support. If enabled, rxvt will
832 not immediately destroy its window when the program executed within 861 not immediately destroy its window when the program executed within
833 it exits. Instead, it will wait till it is being killed or closed by 862 it exits. Instead, it will wait till it is being killed or closed by
834 the user. 863 the user.
835 864
… …
858 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 887 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
859 "\000": octal number) or verbatim control characters ("^?": delete, 888 "\000": octal number) or verbatim control characters ("^?": delete,
860 "^@": null, "^A" ...) and may be enclosed with double quotes so that 889 "^@": null, "^A" ...) and may be enclosed with double quotes so that
861 it can start or end with whitespace. 890 it can start or end with whitespace.
862 891
863 Please note that you need to double the "\" when using 892 Please note that you need to double the "\" in resource files, as
864 "--enable-xgetdefault", as X itself does it's own de-escaping (you 893 Xlib itself does its own de-escaping (you can use "\033" instead of
865 can use "\033" instead of "\e" (and so on), which will work with 894 "\e" (and so on), which will work with both Xt and rxvt's own
866 both Xt and rxvt's own processing). 895 processing).
867 896
868 You can define a range of keysyms in one shot by providing a 897 You can define a range of keysyms in one shot by providing a
869 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 898 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
870 `/' should be a character not used by the strings. 899 `/' should be a character not used by the strings.
871 900
… …
883 is interpreted and executed as rxvt's control sequence. For example 912 is interpreted and executed as rxvt's control sequence. For example
884 the following means "change the current locale to "zh_CN.GBK" when 913 the following means "change the current locale to "zh_CN.GBK" when
885 Control-Meta-c is being pressed": 914 Control-Meta-c is being pressed":
886 915
887 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 916 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
917
918 If *string* takes the form "perl:STRING", then the specified STRING
919 is passed to the "on_keyboard_command" perl handler. See the
920 rxvtperl(3) manpage. For example, the selection extension (activated
921 via "rxvt -pe selection") listens for "selection:rot13" events:
922
923 URxvt.keysym.M-C-c: perl:selection:rot13
888 924
889 Due the the large number of modifier combinations, a defined key 925 Due the the large number of modifier combinations, a defined key
890 mapping will match if at *at least* the specified identifiers are 926 mapping will match if at *at least* the specified identifiers are
891 being set, and no other key mappings with those and more bits are 927 being set, and no other key mappings with those and more bits are
892 being defined. That means that defining a key map for "a" will 928 being defined. That means that defining a key map for "a" will
… …
916 info): 952 info):
917 953
918 URxvt.keysym.M-C-3: command:\033[8;25;80t 954 URxvt.keysym.M-C-3: command:\033[8;25;80t
919 URxvt.keysym.M-C-4: command:\033[8;48;110t 955 URxvt.keysym.M-C-4: command:\033[8;48;110t
920 956
957 perl-ext-common: *string*
921 perl: *string* 958 perl-ext: *string*
922 Used by perl extension and is free for any use, as it is not 959 Comma-separated list(s) of perl extension scripts (default:
923 interpreted by rxvt-unicode itself; option perl. 960 "default") to use in this terminal instance; option -pe.
961
962 Extension names can be prefixed with a "-" sign to prohibit using
963 them. This can be useful to selectively disable some extensions
964 loaded by default, or specified via the "perl-ext-common" resource.
965 For example, "default,-selection" will use all the default extension
966 except "selection".
967
968 Extension names can also be followed by an argument in angle
969 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
970 for searchable scorllback to Alt/Meta-s). Mentioning the same
971 extension multiple times with different arguments will pass multiple
972 arguments to the extension.
973
974 Each extension is looked up in the library directories, loaded if
975 necessary, and bound to the current terminal instance.
976
977 If both of these resources are the empty string, then the perl
978 interpreter will not be initialized. The idea behind two options is
979 that perl-ext-common will be used for extensions that should be
980 available to all instances, while perl-ext is used for specific
981 instances.
924 982
925 perl-eval: *string* 983 perl-eval: *string*
926 Perl code to be evaluated when all extensions have been loaded. See 984 Perl code to be evaluated when all extensions have been registered.
927 the rxvtperl(3) manpage. 985 See the rxvtperl(3) manpage. Due to security reasons, this resource
986 will be ignored when running setuid/setgid.
928 987
929 perl-lib: *path* 988 perl-lib: *path*
930 Additional directory that holds extension scripts that are loaded 989 Colon-separated list of additional directories that hold extension
931 and enabled for this terminal instance, in addition to scripts 990 scripts. When looking for extensions specified by the "perl"
932 stored in /opt/rxvt/lib/urxvt/perl-ext/, which are global to all 991 resource, rxvt will first look in these directories and then in
933 terminal instances. 992 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
993 will be ignored when running setuid/setgid.
934 994
935 See the rxvtperl(3) manpage. 995 See the rxvtperl(3) manpage.
996
997 selection.pattern-*idx*: *perl-regex*
998 Additional selection patterns, see the rxvtperl(3) manpage for
999 details.
1000
1001 selection-autotransform.*idx*: *perl-transform*
1002 Selection auto-transform patterns, see the rxvtperl(3) manpage for
1003 details.
1004
1005 searchable-scrollback: *keysym*
1006 Sets the hotkey that starts the incremental scrollback buffer search
1007 (default: "M-s").
1008
1009 urlLauncher: *string*
1010 Specifies the program to be started with a URL argument. Used by the
1011 "selection-popup" and "mark-urls" perl extensions.
1012
1013 transient-for: *windowid*
1014 Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given
1015 window id.
1016
1017 override-redirect: *boolean*
1018 Compile *frills*: Sets override-redirect for the terminal window,
1019 making it almost invisible to window managers; option
1020 -override-redirect.
936 1021
937THE SCROLLBAR 1022THE SCROLLBAR
938 Lines of text that scroll off the top of the rxvt window (resource: 1023 Lines of text that scroll off the top of the rxvt window (resource:
939 saveLines) and can be scrolled back using the scrollbar or by 1024 saveLines) and can be scrolled back using the scrollbar or by
940 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1025 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
… …
972 normal one. In this mode, every selected row becomes its own line in 1057 normal one. In this mode, every selected row becomes its own line in
973 the selection, and trailing whitespace is visually underlined and 1058 the selection, and trailing whitespace is visually underlined and
974 removed from the selection. 1059 removed from the selection.
975 1060
976 Insertion: 1061 Insertion:
977 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1062 Pressing and releasing the Middle mouse button in an rxvt window
978 an rxvt window causes the current text selection to be inserted as 1063 causes the value of the PRIMARY selection (or CLIPBOARD with the
979 if it had been typed on the keyboard. 1064 Meta modifier) to be inserted as if it had been typed on the
1065 keyboard.
1066
1067 Pressing Shift-Insert causes the value of the PRIMARY selection to
1068 be inserted too.
980 1069
981CHANGING FONTS 1070CHANGING FONTS
982 Changing fonts (or font sizes, respectively) via the keypad is not yet 1071 Changing fonts (or font sizes, respectively) via the keypad is not yet
983 supported in rxvt-unicode. Bug me if you need this. 1072 supported in rxvt-unicode. Bug me if you need this.
984 1073
985 You can, however, switch fonts at runtime using escape sequences (and 1074 You can, however, switch fonts at runtime using escape sequences, e.g.:
986 therefore using the menubar), e.g.:
987 1075
988 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1076 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1077
1078 You can use keyboard shortcuts, too:
1079
1080 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1081 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
989 1082
990 rxvt-unicode will automatically re-apply these fonts to the output so 1083 rxvt-unicode will automatically re-apply these fonts to the output so
991 far. 1084 far.
992 1085
993ISO 14755 SUPPORT 1086ISO 14755 SUPPORT
… …
995 character codes using the keyboard. It consists of 4 parts. The first 1088 character codes using the keyboard. It consists of 4 parts. The first
996 part is available rxvt-unicode has been compiled with "--enable-frills", 1089 part is available rxvt-unicode has been compiled with "--enable-frills",
997 the rest is available when rxvt-unicode was compiled with 1090 the rest is available when rxvt-unicode was compiled with
998 "--enable-iso14755". 1091 "--enable-iso14755".
999 1092
1000 * 5.1: Basic method 1093 * 5.1: Basic method
1094
1001 This allows you to enter unicode characters using their hexcode. 1095 This allows you to enter unicode characters using their hexcode.
1002 1096
1003 Start by pressing and holding both "Control" and "Shift", then enter 1097 Start by pressing and holding both "Control" and "Shift", then enter
1004 hex-digits (between one and six). Releasing "Control" and "Shift" 1098 hex-digits (between one and six). Releasing "Control" and "Shift"
1005 will commit the character as if it were typed directly. While 1099 will commit the character as if it were typed directly. While
… …
1011 address, which you cannot type. Fortunately, the card has the e-mail 1105 address, which you cannot type. Fortunately, the card has the e-mail
1012 address printed as hexcodes, e.g. "671d 65e5". You can enter this 1106 address printed as hexcodes, e.g. "671d 65e5". You can enter this
1013 easily by pressing "Control" and "Shift", followed by 1107 easily by pressing "Control" and "Shift", followed by
1014 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys. 1108 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys.
1015 1109
1016 * 5.2: Keyboard symbols entry method 1110 * 5.2: Keyboard symbols entry method
1111
1017 This mode lets you input characters representing the keycap symbols 1112 This mode lets you input characters representing the keycap symbols
1018 of your keyboard, if representable in the current locale encoding. 1113 of your keyboard, if representable in the current locale encoding.
1019 1114
1020 Start by pressing "Control" and "Shift" together, then releasing 1115 Start by pressing "Control" and "Shift" together, then releasing
1021 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
1022 not invoke it's usual function but instead will insert the 1117 not invoke its usual function but instead will insert the
1023 corresponding keycap symbol. The symbol will only be entered when 1118 corresponding keycap symbol. The symbol will only be entered when
1024 the key has been released, otherwise pressing e.g. "Shift" would 1119 the key has been released, otherwise pressing e.g. "Shift" would
1025 enter the symbol for "ISO Level 2 Switch", although your intention 1120 enter the symbol for "ISO Level 2 Switch", although your intention
1026 might have been to enter a reverse tab (Shift-Tab). 1121 might have been to enter a reverse tab (Shift-Tab).
1027 1122
1028 * 5.3: Screen-selection entry method 1123 * 5.3: Screen-selection entry method
1124
1029 While this is implemented already (it's basically the selection 1125 While this is implemented already (it's basically the selection
1030 mechanism), it could be extended by displaying a unicode character 1126 mechanism), it could be extended by displaying a unicode character
1031 map. 1127 map.
1032 1128
1033 * 5.4: Feedback method for identifying displayed characters for later 1129 * 5.4: Feedback method for identifying displayed characters for later
1034 input 1130 input
1131
1035 This method lets you display the unicode character code associated 1132 This method lets you display the unicode character code associated
1036 with characters already displayed. 1133 with characters already displayed.
1037 1134
1038 You enter this mode by holding down "Control" and "Shift" together, 1135 You enter this mode by holding down "Control" and "Shift" together,
1039 then pressing and holding the left mouse button and moving around. 1136 then pressing and holding the left mouse button and moving around.
… …
1056 setgid to root or to some other group on others. 1153 setgid to root or to some other group on others.
1057 1154
1058COLORS AND GRAPHICS 1155COLORS AND GRAPHICS
1059 In addition to the default foreground and background colours, rxvt can 1156 In addition to the default foreground and background colours, rxvt can
1060 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 1157 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
1061 versions of the same). Here is a list of the colours with their rgb.txt 1158 versions of the same). Here is a list of the colours with their names.
1062 names.
1063 1159
1064 color0 (black) = Black 1160 color0 (black) = Black
1065 color1 (red) = Red3 1161 color1 (red) = Red3
1066 color2 (green) = Green3 1162 color2 (green) = Green3
1067 color3 (yellow) = Yellow3 1163 color3 (yellow) = Yellow3
1068 color4 (blue) = Blue3 1164 color4 (blue) = Blue3
1069 color5 (magenta) = Magenta3 1165 color5 (magenta) = Magenta3
1070 color6 (cyan) = Cyan3 1166 color6 (cyan) = Cyan3
1071 color7 (white) = AntiqueWhite 1167 color7 (white) = AntiqueWhite
1072 color8 (bright black) = Grey25 1168 color8 (bright black) = Grey25
1073 color9 (bright red) = Red 1169 color9 (bright red) = Red
1074 color10 (bright green) = Green 1170 color10 (bright green) = Green
1075 color11 (bright yellow) = Yellow 1171 color11 (bright yellow) = Yellow
1076 color12 (bright blue) = Blue 1172 color12 (bright blue) = Blue
1077 color13 (bright magenta) = Magenta 1173 color13 (bright magenta) = Magenta
1078 color14 (bright cyan) = Cyan 1174 color14 (bright cyan) = Cyan
1079 color15 (bright white) = White 1175 color15 (bright white) = White
1080 foreground = Black 1176 foreground = Black
1081 background = White 1177 background = White
1082
1083 It is also possible to specify the colour values of foreground, 1178 It is also possible to specify the colour values of foreground,
1084 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1179 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1085 0-15, as a convenient shorthand to reference the colour name of 1180 0-15, as a convenient shorthand to reference the colour name of
1086 color0-color15. 1181 color0-color15.
1087 1182
1183 In addition to the colours defined above, rxvt offers an additional 72
1184 colours. The first 64 of those (with indices 16 to 79) consist of a
1185 4*4*4 RGB colour cube (i.e. *index = r * 16 + g * 4 + b + 16*), followed
1186 by 8 additional shades of gray (with indices 80 to 87).
1187
1188 Together, all those colours implement the 88 colour xterm colours. Only
1189 the first 16 can be changed using resources currently, the rest can only
1190 be changed via command sequences ("escape codes").
1191
1088 Note that -rv ("reverseVideo: True") simulates reverse video by always 1192 Note that -rv ("reverseVideo: True") simulates reverse video by always
1089 swapping the foreground/background colours. This is in contrast to 1193 swapping the foreground/background colours. This is in contrast to
1090 *xterm*(1) where the colours are only swapped if they have not otherwise 1194 *xterm*(1) where the colours are only swapped if they have not otherwise
1091 been specified. For example, 1195 been specified. For example,
1092 1196
1093 rxvt -fg Black -bg White -rv 1197 rxvt -fg Black -bg White -rv
1094 would yield White on Black, while on *xterm*(1) it would yield Black 1198 would yield White on Black, while on *xterm*(1) it would yield Black
1095 on White. 1199 on White.
1200
1201 ALPHA CHANNEL SUPPORT
1202 If Xft support has been compiled in and as long as Xft/Xrender/X don't
1203 get their act together, rxvt-unicode will support
1204 "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4
1205 digits/component) colour specifications, in addition to the ones
1206 provided by X, where the additional A component specifies opacity
1207 (alpha) values. The minimum value of 0 is completely transparent). You
1208 can also prefix any color with "[a]", where "a" is on to four hex digits
1209 specifiying the opacity value.
1210
1211 You probably need to specify "-depth 32", too, and have the luck that
1212 your X-server uses ARGB pixel layout, as X is far from just supporting
1213 ARGB visuals out of the box, and rxvt-unicode just fudges around.
1214
1215 For example, the following selects an almost completely transparent red
1216 background, and an almost opaque pink foreground:
1217
1218 rxvt -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
1219
1220 *Please note that transparency of any kind if completely unsupported by
1221 the author. Don't bug him with installation questions!*
1096 1222
1097ENVIRONMENT 1223ENVIRONMENT
1098 rxvt sets and/or uses the following environment variables: 1224 rxvt sets and/or uses the following environment variables:
1099 1225
1100 TERM 1226 TERM
… …
1124 Set to the terminfo directory iff rxvt was configured with 1250 Set to the terminfo directory iff rxvt was configured with
1125 "--with-terminfo=PATH". 1251 "--with-terminfo=PATH".
1126 1252
1127 DISPLAY 1253 DISPLAY
1128 Used by rxvt to connect to the display and set to the correct 1254 Used by rxvt to connect to the display and set to the correct
1129 display in it's child processes. 1255 display in its child processes.
1130 1256
1131 SHELL 1257 SHELL
1132 The shell to be used for command execution, defaults to "/bin/sh". 1258 The shell to be used for command execution, defaults to "/bin/sh".
1133
1134 RXVTPATH
1135 The path where rxvt looks for support files such as menu and xpm
1136 files.
1137
1138 PATH
1139 Used in the same way as "RXVTPATH".
1140 1259
1141 RXVT_SOCKET 1260 RXVT_SOCKET
1142 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1261 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1143 1262
1144 Default $HOME/.rxvt-unicode-*<nodename*. 1263 Default $HOME/.rxvt-unicode-*<nodename*.
… …
1165 1284
1166CURRENT PROJECT COORDINATOR 1285CURRENT PROJECT COORDINATOR
1167 Project Coordinator 1286 Project Coordinator
1168 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1287 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1169 1288
1170 <http://software.schmorp.de/#rxvt-unicode> 1289 <http://software.schmorp.de/pkg/rxvt-unicode.html>
1171 1290
1172AUTHORS 1291AUTHORS
1173 John Bovey 1292 John Bovey
1174 University of Kent, 1992, wrote the original Xvt. 1293 University of Kent, 1992, wrote the original Xvt.
1175 1294
… …
1186 1305
1187 Oezguer Kesim <kesim@math.fu-berlin.de> 1306 Oezguer Kesim <kesim@math.fu-berlin.de>
1188 Project Coordinator (changes.txt 2.21a to 2.4.5) 1307 Project Coordinator (changes.txt 2.21a to 2.4.5)
1189 1308
1190 Geoff Wing <gcw@pobox.com> 1309 Geoff Wing <gcw@pobox.com>
1191 Rewrote screen display and text selection routines. Project 1310 Rewrote screen display and text selection routines.
1311
1192 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1312 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1193 1313
1194 Marc Alexander Lehmann <rxvt-unicode@schmorp.de> 1314 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1195 Forked rxvt-unicode, rewrote most of the display code and internal 1315 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1196 character handling to store text in unicode, improve xterm 1316 perl extension, random hacks, numerous bugfixes and extensions.
1197 compatibility and apply numerous other bugfixes and extensions.
1198 1317
1199 Project Coordinator (Changes 1.0 -) 1318 Project Coordinator (Changes 1.0 -)
1200 1319
1320 Emanuele Giaquinta <e.giaquinta@glauco.it>
1321 Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1322

Diff Legend

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