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.37 by root, Sat Jan 7 04:19:43 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.3, 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"
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.
256 267
257 -sbg 268 -sbg
258 Compile *frills*: Disable the usage of the built-in block 269 Compile *frills*: Disable the usage of the built-in block
259 graphics/line drawing characters and just rely on what the specified 270 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 271 fonts provide. Use this if you have a good font and want to use its
346 357
347 -keysym.*sym* *string* 358 -keysym.*sym* *string*
348 Remap a key symbol. See resource keysym. 359 Remap a key symbol. See resource keysym.
349 360
350 -embed *windowid* 361 -embed *windowid*
351 Tells rxvt to embed it's windows into an already-existing window, 362 Tells rxvt to embed its windows into an already-existing window,
352 which enables applications to easily embed a terminal. 363 which enables applications to easily embed a terminal.
353 364
354 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
355 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
356 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
400 # now communicate with rxvt 411 # now communicate with rxvt
401 my $slave = $pty->slave; 412 my $slave = $pty->slave;
402 while (<$slave>) { print $slave "got <$_>\n" } 413 while (<$slave>) { print $slave "got <$_>\n" }
403 414
404 -pe *string* 415 -pe *string*
405 Comma-separated list of perl extension scripts to use in this 416 Comma-separated list of perl extension scripts to use (or not to
406 terminal instance. See resource perl-ext. 417 use) in this terminal instance. See resource perl-ext for details.
407 418
408RESOURCES (available also as long-options) 419RESOURCES (available also as long-options)
409 Note: `rxvt --help' gives a list of all resources (long options) 420 Note: `rxvt --help' gives a list of all resources (long options)
410 compiled into your version. 421 compiled into your version.
411 422
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 423 You can set and change the resources using X11 tools like xrdb. Many
416 xrdb. Many distribution do also load settings from the ~/.Xresources 424 distribution do also load settings from the ~/.Xresources file when X
417 file when X starts. rxvt will consult the following files/resources in 425 starts. rxvt will consult the following files/resources in order, with
418 order, with later settings overwriting earlier ones: 426 later settings overwriting earlier ones:
419 427
420 1. system-wide app-defaults file, either locale-dependent OR global 428 1. system-wide app-defaults file, either locale-dependent OR global
421 2. app-defaults file in $XAPPLRESDIR 429 2. app-defaults file in $XAPPLRESDIR
422 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 430 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
423 4. SCREEN_RESOURCES for the current screen 431 4. SCREEN_RESOURCES for the current screen
424 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 432 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
425 433
426 If compiled with internal Xresources support (i.e. rxvt -h lists 434 Note that when reading X resources, rxvt recognizes two class names:
427 .Xdefaults) then rxvt accepts application defaults set in 435 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
428 XAPPLOADDIR/URxvt (compile-time defined: usually 436 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 437 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 438 rxvt configurations. If no resources are specified, suitable defaults
436 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
437 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.
438 447
439 geometry: *geom* 448 geometry: *geom*
440 Create the window with the specified X window geometry [default 449 Create the window with the specified X window geometry [default
441 80x24]; option -geometry. 450 80x24]; option -geometry.
442 451
503 512
504 inheritPixmap: *boolean* 513 inheritPixmap: *boolean*
505 True: make the background inherit the parent windows' pixmap, giving 514 True: make the background inherit the parent windows' pixmap, giving
506 artificial transparency. False: do not inherit the parent windows' 515 artificial transparency. False: do not inherit the parent windows'
507 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!*
508 520
509 fading: *number* 521 fading: *number*
510 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
511 -fade. 523 -fade.
512 524
542 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
543 specifies an integer number of images in that direction. No image 555 specifies an integer number of images in that direction. No image
544 will be magnified beyond 10 times its original size. The maximum 556 will be magnified beyond 10 times its original size. The maximum
545 permitted scale is 1000. [default 0x0+50+50] 557 permitted scale is 1000. [default 0x0+50+50]
546 558
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* 559 path: *path*
554 Specify the colon-delimited search path for finding files (XPM and 560 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 561
558 font: *fontlist* 562 font: *fontlist*
559 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
560 names that are used in turn when trying to display Unicode 564 names that are checked in order when trying to find glyphs for
561 characters. The first font defines the cell size for characters; 565 characters. The first font defines the cell size for characters;
562 other fonts might be smaller, but not larger. A reasonable default 566 other fonts might be smaller, but not (in general) larger. A
563 font list is always appended to it; option -fn. 567 (hopefully) reasonable default font list is always appended to it;
568 option -fn.
564 569
565 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
566 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 571 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
567 "xft:". 572 "xft:".
568 573
571 available hint currently is "codeset=codeset-name", and this is only 576 available hint currently is "codeset=codeset-name", and this is only
572 used for Xft fonts. 577 used for Xft fonts.
573 578
574 For example, this font resource 579 For example, this font resource
575 580
576 URxvt*font: 9x15bold,\ 581 URxvt.font: 9x15bold,\
577 -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,\
578 -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, \
579 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 584 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
580 xft:Code2000:antialias=false 585 xft:Code2000:antialias=false
581 586
667 672
668 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.
669 674
670 Example: 675 Example:
671 676
672 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 677 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
673 678
674 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
675 contents everytime you hit "Print". 680 contents everytime you hit "Print".
676 681
677 scrollBar: *boolean* 682 scrollBar: *boolean*
778 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)
779 is pressed. If unset it will send the sequence traditionally 784 is pressed. If unset it will send the sequence traditionally
780 associated with the Execute key. 785 associated with the Execute key.
781 786
782 cutchars: *string* 787 cutchars: *string*
783 The characters used as delimiters for double-click word selection. 788 The characters used as delimiters for double-click word selection
784 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:
785 799
786 BACKSLASH `"'&()*,;<=>?@[]{|} 800 BACKSLASH `"'&()*,;<=>?@[]{|}
787 801
788 preeditType: *style* 802 preeditType: *style*
789 OverTheSpot, OffTheSpot, Root; option -pt. 803 OverTheSpot, OffTheSpot, Root; option -pt.
820 xterm, have these sequences enabled by default, which doesn't make 834 xterm, have these sequences enabled by default, which doesn't make
821 it safer, though). 835 it safer, though).
822 836
823 You can enable them by setting this boolean resource or specifying 837 You can enable them by setting this boolean resource or specifying
824 -insecure as an option. At the moment, this enables display-answer, 838 -insecure as an option. At the moment, this enables display-answer,
825 locale, findfont, icon label and window title requests as well as 839 locale, findfont, icon label and window title requests.
826 dynamic menubar dispatch.
827 840
828 modifier: *modifier* 841 modifier: *modifier*
829 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,
830 super, mod1, mod2, mod3, mod4, mod5; option -mod. 843 super, mod1, mod2, mod3, mod4, mod5; option -mod.
831 844
832 answerbackString: *string* 845 answerbackString: *string*
833 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
834 (control-E) character is passed through. It may contain escape 847 (control-E) character is passed through. It may contain escape
835 values as described in the entry on keysym following. 848 values as described in the entry on keysym following.
836 849
837 secondaryScreen: *bool* 850 secondaryScreen: *boolean*
838 Turn on/off secondary screen (default enabled). 851 Turn on/off secondary screen (default enabled).
839 852
840 secondaryScroll: *bool* 853 secondaryScroll: *boolean*
841 Turn on/off secondary screen scroll (default enabled). If the this 854 Turn on/off secondary screen scroll (default enabled). If the this
842 option is enabled, scrolls on the secondary screen will change the 855 option is enabled, scrolls on the secondary screen will change the
843 scrollback buffer and switching to/from the secondary screen will 856 scrollback buffer and switching to/from the secondary screen will
844 instead scroll the screen up. 857 instead scroll the screen up.
845 858
846 hold: *bool* 859 hold: *boolean*
847 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
848 not immediately destroy its window when the program executed within 861 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 862 it exits. Instead, it will wait till it is being killed or closed by
850 the user. 863 the user.
851 864
874 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 887 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
875 "\000": octal number) or verbatim control characters ("^?": delete, 888 "\000": octal number) or verbatim control characters ("^?": delete,
876 "^@": null, "^A" ...) and may be enclosed with double quotes so that 889 "^@": null, "^A" ...) and may be enclosed with double quotes so that
877 it can start or end with whitespace. 890 it can start or end with whitespace.
878 891
879 Please note that you need to double the "\" when using 892 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 893 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 894 "\e" (and so on), which will work with both Xt and rxvt's own
882 both Xt and rxvt's own processing). 895 processing).
883 896
884 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
885 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 898 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
886 `/' should be a character not used by the strings. 899 `/' should be a character not used by the strings.
887 900
941 URxvt.keysym.M-C-3: command:\033[8;25;80t 954 URxvt.keysym.M-C-3: command:\033[8;25;80t
942 URxvt.keysym.M-C-4: command:\033[8;48;110t 955 URxvt.keysym.M-C-4: command:\033[8;48;110t
943 956
944 perl-ext-common: *string* 957 perl-ext-common: *string*
945 perl-ext: *string* 958 perl-ext: *string*
946 Comma-separated list(s) of perl extension scripts to use in this 959 Comma-separated list(s) of perl extension scripts (default:
947 terminal instance. Each extension is looked up in the library 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
948 directories, loaded if necessary, and bound to the current terminal 975 necessary, and bound to the current terminal instance.
949 instance. If this resource is empty or missing, then the perl 976
977 If both of these resources are the empty string, then the perl
950 interpreter will not be initialized. The idea behind two options is 978 interpreter will not be initialized. The idea behind two options is
951 that perl-ext-common will be used for extensions that should be 979 that perl-ext-common will be used for extensions that should be
952 available to all instances, while perl-ext is used for specific 980 available to all instances, while perl-ext is used for specific
953 instances; option -pe. 981 instances.
954 982
955 perl-eval: *string* 983 perl-eval: *string*
956 Perl code to be evaluated when all extensions have been registered. 984 Perl code to be evaluated when all extensions have been registered.
957 See the rxvtperl(3) manpage. 985 See the rxvtperl(3) manpage. Due to security reasons, this resource
986 will be ignored when running setuid/setgid.
958 987
959 perl-lib: *path* 988 perl-lib: *path*
960 Colon-separated list of additional directories that hold extension 989 Colon-separated list of additional directories that hold extension
961 scripts. When looking for extensions specified by the "perl" 990 scripts. When looking for extensions specified by the "perl"
962 resource, rxvt will first look in these directories and then in 991 resource, rxvt will first look in these directories and then in
963 /opt/rxvt/lib/urxvt/perl/. 992 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
993 will be ignored when running setuid/setgid.
964 994
965 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.
966 1021
967THE SCROLLBAR 1022THE SCROLLBAR
968 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:
969 saveLines) and can be scrolled back using the scrollbar or by 1024 saveLines) and can be scrolled back using the scrollbar or by
970 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1025 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
1002 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
1003 the selection, and trailing whitespace is visually underlined and 1058 the selection, and trailing whitespace is visually underlined and
1004 removed from the selection. 1059 removed from the selection.
1005 1060
1006 Insertion: 1061 Insertion:
1007 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1062 Pressing and releasing the Middle mouse button in an rxvt window
1008 an rxvt window causes the current text selection to be inserted as 1063 causes the value of the PRIMARY selection (or CLIPBOARD with the
1009 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.
1010 1069
1011CHANGING FONTS 1070CHANGING FONTS
1012 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
1013 supported in rxvt-unicode. Bug me if you need this. 1072 supported in rxvt-unicode. Bug me if you need this.
1014 1073
1015 You can, however, switch fonts at runtime using escape sequences (and 1074 You can, however, switch fonts at runtime using escape sequences, e.g.:
1016 therefore using the menubar), e.g.:
1017 1075
1018 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
1019 1082
1020 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
1021 far. 1084 far.
1022 1085
1023ISO 14755 SUPPORT 1086ISO 14755 SUPPORT
1025 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
1026 part is available rxvt-unicode has been compiled with "--enable-frills", 1089 part is available rxvt-unicode has been compiled with "--enable-frills",
1027 the rest is available when rxvt-unicode was compiled with 1090 the rest is available when rxvt-unicode was compiled with
1028 "--enable-iso14755". 1091 "--enable-iso14755".
1029 1092
1030 * 5.1: Basic method 1093 * 5.1: Basic method
1094
1031 This allows you to enter unicode characters using their hexcode. 1095 This allows you to enter unicode characters using their hexcode.
1032 1096
1033 Start by pressing and holding both "Control" and "Shift", then enter 1097 Start by pressing and holding both "Control" and "Shift", then enter
1034 hex-digits (between one and six). Releasing "Control" and "Shift" 1098 hex-digits (between one and six). Releasing "Control" and "Shift"
1035 will commit the character as if it were typed directly. While 1099 will commit the character as if it were typed directly. While
1041 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
1042 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
1043 easily by pressing "Control" and "Shift", followed by 1107 easily by pressing "Control" and "Shift", followed by
1044 "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.
1045 1109
1046 * 5.2: Keyboard symbols entry method 1110 * 5.2: Keyboard symbols entry method
1111
1047 This mode lets you input characters representing the keycap symbols 1112 This mode lets you input characters representing the keycap symbols
1048 of your keyboard, if representable in the current locale encoding. 1113 of your keyboard, if representable in the current locale encoding.
1049 1114
1050 Start by pressing "Control" and "Shift" together, then releasing 1115 Start by pressing "Control" and "Shift" together, then releasing
1051 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
1052 not invoke it's usual function but instead will insert the 1117 not invoke its usual function but instead will insert the
1053 corresponding keycap symbol. The symbol will only be entered when 1118 corresponding keycap symbol. The symbol will only be entered when
1054 the key has been released, otherwise pressing e.g. "Shift" would 1119 the key has been released, otherwise pressing e.g. "Shift" would
1055 enter the symbol for "ISO Level 2 Switch", although your intention 1120 enter the symbol for "ISO Level 2 Switch", although your intention
1056 might have been to enter a reverse tab (Shift-Tab). 1121 might have been to enter a reverse tab (Shift-Tab).
1057 1122
1058 * 5.3: Screen-selection entry method 1123 * 5.3: Screen-selection entry method
1124
1059 While this is implemented already (it's basically the selection 1125 While this is implemented already (it's basically the selection
1060 mechanism), it could be extended by displaying a unicode character 1126 mechanism), it could be extended by displaying a unicode character
1061 map. 1127 map.
1062 1128
1063 * 5.4: Feedback method for identifying displayed characters for later 1129 * 5.4: Feedback method for identifying displayed characters for later
1064 input 1130 input
1131
1065 This method lets you display the unicode character code associated 1132 This method lets you display the unicode character code associated
1066 with characters already displayed. 1133 with characters already displayed.
1067 1134
1068 You enter this mode by holding down "Control" and "Shift" together, 1135 You enter this mode by holding down "Control" and "Shift" together,
1069 then pressing and holding the left mouse button and moving around. 1136 then pressing and holding the left mouse button and moving around.
1086 setgid to root or to some other group on others. 1153 setgid to root or to some other group on others.
1087 1154
1088COLORS AND GRAPHICS 1155COLORS AND GRAPHICS
1089 In addition to the default foreground and background colours, rxvt can 1156 In addition to the default foreground and background colours, rxvt can
1090 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
1091 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.
1092 names.
1093 1159
1094 color0 (black) = Black 1160 color0 (black) = Black
1095 color1 (red) = Red3 1161 color1 (red) = Red3
1096 color2 (green) = Green3 1162 color2 (green) = Green3
1097 color3 (yellow) = Yellow3 1163 color3 (yellow) = Yellow3
1098 color4 (blue) = Blue3 1164 color4 (blue) = Blue3
1099 color5 (magenta) = Magenta3 1165 color5 (magenta) = Magenta3
1100 color6 (cyan) = Cyan3 1166 color6 (cyan) = Cyan3
1101 color7 (white) = AntiqueWhite 1167 color7 (white) = AntiqueWhite
1102 color8 (bright black) = Grey25 1168 color8 (bright black) = Grey25
1103 color9 (bright red) = Red 1169 color9 (bright red) = Red
1104 color10 (bright green) = Green 1170 color10 (bright green) = Green
1105 color11 (bright yellow) = Yellow 1171 color11 (bright yellow) = Yellow
1106 color12 (bright blue) = Blue 1172 color12 (bright blue) = Blue
1107 color13 (bright magenta) = Magenta 1173 color13 (bright magenta) = Magenta
1108 color14 (bright cyan) = Cyan 1174 color14 (bright cyan) = Cyan
1109 color15 (bright white) = White 1175 color15 (bright white) = White
1110 foreground = Black 1176 foreground = Black
1111 background = White 1177 background = White
1112
1113 It is also possible to specify the colour values of foreground, 1178 It is also possible to specify the colour values of foreground,
1114 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1179 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1115 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
1116 color0-color15. 1181 color0-color15.
1117 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
1118 Note that -rv ("reverseVideo: True") simulates reverse video by always 1192 Note that -rv ("reverseVideo: True") simulates reverse video by always
1119 swapping the foreground/background colours. This is in contrast to 1193 swapping the foreground/background colours. This is in contrast to
1120 *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
1121 been specified. For example, 1195 been specified. For example,
1122 1196
1123 rxvt -fg Black -bg White -rv 1197 rxvt -fg Black -bg White -rv
1124 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
1125 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!*
1126 1222
1127ENVIRONMENT 1223ENVIRONMENT
1128 rxvt sets and/or uses the following environment variables: 1224 rxvt sets and/or uses the following environment variables:
1129 1225
1130 TERM 1226 TERM
1154 Set to the terminfo directory iff rxvt was configured with 1250 Set to the terminfo directory iff rxvt was configured with
1155 "--with-terminfo=PATH". 1251 "--with-terminfo=PATH".
1156 1252
1157 DISPLAY 1253 DISPLAY
1158 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
1159 display in it's child processes. 1255 display in its child processes.
1160 1256
1161 SHELL 1257 SHELL
1162 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".
1163
1164 RXVTPATH
1165 The path where rxvt looks for support files such as menu and xpm
1166 files.
1167
1168 PATH
1169 Used in the same way as "RXVTPATH".
1170 1259
1171 RXVT_SOCKET 1260 RXVT_SOCKET
1172 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).
1173 1262
1174 Default $HOME/.rxvt-unicode-*<nodename*. 1263 Default $HOME/.rxvt-unicode-*<nodename*.
1195 1284
1196CURRENT PROJECT COORDINATOR 1285CURRENT PROJECT COORDINATOR
1197 Project Coordinator 1286 Project Coordinator
1198 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1287 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1199 1288
1200 <http://software.schmorp.de/#rxvt-unicode> 1289 <http://software.schmorp.de/pkg/rxvt-unicode.html>
1201 1290
1202AUTHORS 1291AUTHORS
1203 John Bovey 1292 John Bovey
1204 University of Kent, 1992, wrote the original Xvt. 1293 University of Kent, 1992, wrote the original Xvt.
1205 1294
1216 1305
1217 Oezguer Kesim <kesim@math.fu-berlin.de> 1306 Oezguer Kesim <kesim@math.fu-berlin.de>
1218 Project Coordinator (changes.txt 2.21a to 2.4.5) 1307 Project Coordinator (changes.txt 2.21a to 2.4.5)
1219 1308
1220 Geoff Wing <gcw@pobox.com> 1309 Geoff Wing <gcw@pobox.com>
1221 Rewrote screen display and text selection routines. Project 1310 Rewrote screen display and text selection routines.
1311
1222 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1312 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1223 1313
1224 Marc Alexander Lehmann <rxvt-unicode@schmorp.de> 1314 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1225 Forked rxvt-unicode, rewrote most of the display code and internal 1315 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1226 character handling to store text in unicode, improve xterm 1316 perl extension, random hacks, numerous bugfixes and extensions.
1227 compatibility and apply numerous other bugfixes and extensions.
1228 1317
1229 Project Coordinator (Changes 1.0 -) 1318 Project Coordinator (Changes 1.0 -)
1230 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