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.24 by root, Tue Oct 25 20:04:59 2005 UTC vs.
Revision 1.54 by root, Sun Jan 29 21:45:47 2006 UTC

… …
4 4
5SYNOPSIS 5SYNOPSIS
6 rxvt [options] [-e command [ args ]] 6 rxvt [options] [-e command [ args ]]
7 7
8DESCRIPTION 8DESCRIPTION
9 rxvt-unicode, version 5.8, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 7.4, is a colour vt102 terminal emulator intended
10 as an *xterm*(1) replacement for users who do not require features such 10 as an *xterm*(1) replacement for users who do not require features such
11 as Tektronix 4014 emulation and toolkit-style configurability. As a 11 as Tektronix 4014 emulation and toolkit-style configurability. As a
12 result, rxvt-unicode uses much less swap space -- a significant 12 result, rxvt-unicode uses much less swap space -- a significant
13 advantage on a machine serving many X sessions. 13 advantage on a machine serving many X sessions.
14 14
… …
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 *frills*: 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.
… …
146 The colour of the border around the text area and between the 150 The colour of the border around the text area and between the
147 scrollbar and the text; resource borderColor. 151 scrollbar and the text; resource borderColor.
148 152
149 -fn *fontlist* 153 -fn *fontlist*
150 Select the fonts to be used. This is a comma separated list of font 154 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 155 names that are checked in order when trying to find glyphs for
152 characters. The first font defines the cell size for characters; 156 characters. The first font defines the cell size for characters;
153 other fonts might be smaller, but not (in general) larger. A 157 other fonts might be smaller, but not (in general) larger. A
154 (hopefully) reasonable default font list is always appended to it. 158 (hopefully) reasonable default font list is always appended to it.
155 See resource font for more details. 159 See resource font for more details.
156 160
… …
163 167
164 See also the question "How does rxvt-unicode choose fonts?" in the 168 See also the question "How does rxvt-unicode choose fonts?" in the
165 FAQ section of rxvt(7). 169 FAQ section of rxvt(7).
166 170
167 -fb *fontlist* 171 -fb *fontlist*
168 Compile font-styles: The bold font list to use when bold characters 172 Compile *font-styles*: The bold font list to use when bold
169 are to be printed. See resource boldFont for details. 173 characters are to be printed. See resource boldFont for details.
170 174
171 -fi *fontlist* 175 -fi *fontlist*
172 Compile font-styles: The italic font list to use when bold 176 Compile *font-styles*: The italic font list to use when *italic*
173 characters are to be printed. See resource italicFont for details. 177 characters are to be printed. See resource italicFont for details.
174 178
175 -fbi *fontlist* 179 -fbi *fontlist*
176 Compile font-styles: The bold italic font list to use when bold 180 Compile *font-styles*: The bold italic font list to use when *bold
177 characters are to be printed. See resource boldItalicFont for 181 italic* characters are to be printed. See resource boldItalicFont
182 for details.
183
184 -is|+is
185 Compile *font-styles*: Bold/Italic font styles imply high intensity
186 foreground/background (default). See resource intensityStyles for
178 details. 187 details.
179 188
180 -name *name* 189 -name *name*
181 Specify the application name under which resources are to be 190 Specify the application name under which resources are to be
182 obtained, rather than the default executable file name. Name should 191 obtained, rather than the default executable file name. Name should
… …
246 externalBorder. 255 externalBorder.
247 256
248 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e. 257 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e.
249 if honoured by the WM, the rxvt-unicode window will not have window 258 if honoured by the WM, the rxvt-unicode window will not have window
250 decorations; resource borderLess. 259 decorations; resource borderLess.
260
261 -override-redirect
262 Compile *frills*: Sets override-redirect on the window; resource
263 override-redirect.
264
265 -sbg
266 Compile *frills*: Disable the usage of the built-in block
267 graphics/line drawing characters and just rely on what the specified
268 fonts provide. Use this if you have a good font and want to use its
269 block graphic glyphs; resource skipBuiltinGlyphs.
251 270
252 -lsp *number* 271 -lsp *number*
253 Compile *frills*: Lines (pixel height) to insert between each row of 272 Compile *frills*: Lines (pixel height) to insert between each row of
254 the display. Useful to work around font rendering problems; resource 273 the display. Useful to work around font rendering problems; resource
255 linespace. 274 linespace.
… …
267 on the command line. If this option is used, it must be the last on 286 on the command line. If this option is used, it must be the last on
268 the command-line. If there is no -e option then the default is to 287 the command-line. If there is no -e option then the default is to
269 run the program specified by the SHELL environment variable or, 288 run the program specified by the SHELL environment variable or,
270 failing that, *sh(1)*. 289 failing that, *sh(1)*.
271 290
291 Please note that you must specify a program with arguments. If you
292 want to run shell commands, you have to specify the shell, like
293 this:
294
295 rxvt -e sh -c "shell commands"
296
272 -title *text* 297 -title *text*
273 Window title (-T still respected); the default title is the basename 298 Window title (-T still respected); the default title is the basename
274 of the program specified after the -e option, if any, otherwise the 299 of the program specified after the -e option, if any, otherwise the
275 application name; resource title. 300 application name; resource title.
276 301
… …
319 344
320 -ssr|+ssr 345 -ssr|+ssr
321 Turn on/off secondary screen scroll (default enabled); resource 346 Turn on/off secondary screen scroll (default enabled); resource
322 secondaryScroll. 347 secondaryScroll.
323 348
349 -hold|+hold
350 Turn on/off hold window after exit support. If enabled, rxvt will
351 not immediately destroy its window when the program executed within
352 it exits. Instead, it will wait till it is being killed or closed by
353 the user; resource hold.
354
324 -keysym.*sym* *string* 355 -keysym.*sym* *string*
325 Remap a key symbol. See resource keysym. 356 Remap a key symbol. See resource keysym.
326 357
327 -embed *windowid* 358 -embed *windowid*
328 Tells rxvt to embed it's windows into an already-existing window, 359 Tells rxvt to embed it's windows into an already-existing window,
… …
348 $rxvt->signal_connect_after (realize => sub { 379 $rxvt->signal_connect_after (realize => sub {
349 my $xid = $_[0]->window->get_xid; 380 my $xid = $_[0]->window->get_xid;
350 system "rxvt -embed $xid &"; 381 system "rxvt -embed $xid &";
351 }); 382 });
352 383
353 -pty-fd *fileno* 384 -pty-fd *file descriptor*
354 Tells rxvt NOT to execute any commands or create a new pty/tty pair 385 Tells rxvt NOT to execute any commands or create a new pty/tty pair
355 but instead use the given filehandle as the tty master. This is 386 but instead use the given filehandle as the tty master. This is
356 useful if you want to drive rxvt as a generic terminal emulator 387 useful if you want to drive rxvt as a generic terminal emulator
357 without having to run a program within it. 388 without having to run a program within it.
358 389
359 If this switch is given, rxvt will not create any utmp/wtmp entries 390 If this switch is given, rxvt will not create any utmp/wtmp entries
360 and will not tinker with pty/tty permissions - you have to do that 391 and will not tinker with pty/tty permissions - you have to do that
361 yourself if you want that. 392 yourself if you want that.
362 393
394 As an extremely special case, specifying -1 will completely suppress
395 pty/tty operations.
396
363 Here is a example in perl that illustrates how this option can be 397 Here is a example in perl that illustrates how this option can be
364 used (a longer example is in doc/pty-fd): 398 used (a longer example is in doc/pty-fd):
365 399
366 use IO::Pty; 400 use IO::Pty;
367 use Fcntl; 401 use Fcntl;
… …
373 407
374 # now communicate with rxvt 408 # now communicate with rxvt
375 my $slave = $pty->slave; 409 my $slave = $pty->slave;
376 while (<$slave>) { print $slave "got <$_>\n" } 410 while (<$slave>) { print $slave "got <$_>\n" }
377 411
412 -pe *string*
413 Comma-separated list of perl extension scripts to use (or not to
414 use) in this terminal instance. See resource perl-ext for details.
415
378RESOURCES (available also as long-options) 416RESOURCES (available also as long-options)
379 Note: `rxvt --help' gives a list of all resources (long options) 417 Note: `rxvt --help' gives a list of all resources (long options)
380 compiled into your version. 418 compiled into your version.
381 419
382 There are two different methods that rxvt can use to get the Xresource
383 data: using the X libraries (Xrm*-functions) or internal Xresources
384 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
385 XGetDefaults), you can set and change the resources using X11 tools like 420 You can set and change the resources using X11 tools like xrdb. Many
386 xrdb. Many distribution do also load settings from the ~/.Xresources 421 distribution do also load settings from the ~/.Xresources file when X
387 file when X starts. rxvt will consult the following files/resources in 422 starts. rxvt will consult the following files/resources in order, with
388 order, with later settings overwriting earlier ones: 423 later settings overwriting earlier ones:
389 424
390 1. system-wide app-defaults file, either locale-dependent OR global 425 1. system-wide app-defaults file, either locale-dependent OR global
391 2. app-defaults file in $XAPPLRESDIR 426 2. app-defaults file in $XAPPLRESDIR
392 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 427 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
393 4. SCREEN_RESOURCES for the current screen 428 4. SCREEN_RESOURCES for the current screen
394 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 429 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
395 430
396 If compiled with internal Xresources support (i.e. rxvt -h lists 431 Note that when reading X resources, rxvt recognizes two class names:
397 .Xdefaults) then rxvt accepts application defaults set in 432 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
398 XAPPLOADDIR/URxvt (compile-time defined: usually 433 and the original *rxvt* to be easily configured, while the class name
399 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 434 URxvt allows resources unique to rxvt, to be shared between different
400 ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X
401 resources, rxvt recognizes two class names: XTerm and URxvt. The class
402 name Rxvt allows resources common to both rxvt and the original *rxvt*
403 to be easily configured, while the class name URxvt allows resources
404 unique to rxvt, notably colours and key-handling, to be shared between
405 different rxvt configurations. If no resources are specified, suitable 435 rxvt configurations. If no resources are specified, suitable defaults
406 defaults will be used. Command-line arguments can be used to override 436 will be used. Command-line arguments can be used to override resource
407 resource settings. The following resources are allowed: 437 settings. The following resources are supported (you might want to check
438 the rxvtperl(3) manpage for additional settings by perl extensions not
439 documented here):
440
441 depth: *bitdepth*
442 Compile *frills*: Attempt to find a visual with the given bit depth;
443 option -depth.
408 444
409 geometry: *geom* 445 geometry: *geom*
410 Create the window with the specified X window geometry [default 446 Create the window with the specified X window geometry [default
411 80x24]; option -geometry. 447 80x24]; option -geometry.
412 448
… …
512 scale of 1 displays the image without any scaling. A scale of 2 to 9 548 scale of 1 displays the image without any scaling. A scale of 2 to 9
513 specifies an integer number of images in that direction. No image 549 specifies an integer number of images in that direction. No image
514 will be magnified beyond 10 times its original size. The maximum 550 will be magnified beyond 10 times its original size. The maximum
515 permitted scale is 1000. [default 0x0+50+50] 551 permitted scale is 1000. [default 0x0+50+50]
516 552
517 menu: *file[;tag]*
518 Read in the specified menu file (note the `.menu' extension is
519 optional) and also optionally specify a starting tag to find. See
520 the reference documentation for details on the syntax for the
521 menuBar.
522
523 path: *path* 553 path: *path*
524 Specify the colon-delimited search path for finding files (XPM and 554 Specify the colon-delimited search path for finding XPM files.
525 menus), in addition to the paths specified by the RXVTPATH and PATH
526 environment variables.
527 555
528 font: *fontlist* 556 font: *fontlist*
529 Select the fonts to be used. This is a comma separated list of font 557 Select the fonts to be used. This is a comma separated list of font
530 names that are used in turn when trying to display Unicode 558 names that are checked in order when trying to find glyphs for
531 characters. The first font defines the cell size for characters; 559 characters. The first font defines the cell size for characters;
532 other fonts might be smaller, but not larger. A reasonable default 560 other fonts might be smaller, but not (in general) larger. A
533 font list is always appended to it. option -fn. 561 (hopefully) reasonable default font list is always appended to it;
562 option -fn.
534 563
535 Each font can either be a standard X11 core font (XLFD) name, with 564 Each font can either be a standard X11 core font (XLFD) name, with
536 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 565 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
537 "xft:". 566 "xft:".
538 567
… …
541 available hint currently is "codeset=codeset-name", and this is only 570 available hint currently is "codeset=codeset-name", and this is only
542 used for Xft fonts. 571 used for Xft fonts.
543 572
544 For example, this font resource 573 For example, this font resource
545 574
546 URxvt*font: 9x15bold,\ 575 URxvt.font: 9x15bold,\
547 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 576 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
548 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 577 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
549 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 578 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
550 xft:Code2000:antialias=false 579 xft:Code2000:antialias=false
551 580
… …
584 tried. 613 tried.
585 614
586 If set, but empty, then this specific style is disabled and the 615 If set, but empty, then this specific style is disabled and the
587 normal text font will being used for the given style. 616 normal text font will being used for the given style.
588 617
618 intensityStyles: *boolean*
619 When font styles are not enabled, or this option is enabled (True,
620 option -is, the default), bold and italic font styles imply high
621 intensity foreground/backround colours. Disabling this option
622 (False, option +is) disables this behaviour, the high intensity
623 colours are not reachable.
624
589 selectstyle: *mode* 625 selectstyle: *mode*
590 Set mouse selection style to old which is 2.20, oldword which is 626 Set mouse selection style to old which is 2.20, oldword which is
591 xterm style with 2.20 old word selection, or anything else which 627 xterm style with 2.20 old word selection, or anything else which
592 gives xterm style selection. 628 gives xterm style selection.
593 629
… …
630 666
631 The string will be interpreted as if typed into the shell as-is. 667 The string will be interpreted as if typed into the shell as-is.
632 668
633 Example: 669 Example:
634 670
635 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 671 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
636 672
637 This creates a new file in your home directory with the screen 673 This creates a new file in your home directory with the screen
638 contents everytime you hit "Print". 674 contents everytime you hit "Print".
639 675
640 scrollBar: *boolean* 676 scrollBar: *boolean*
… …
683 borderLess: *boolean* 719 borderLess: *boolean*
684 Set MWM hints to request a borderless window, i.e. if honoured by 720 Set MWM hints to request a borderless window, i.e. if honoured by
685 the WM, the rxvt-unicode window will not have window decorations; 721 the WM, the rxvt-unicode window will not have window decorations;
686 option -bl. 722 option -bl.
687 723
724 skipBuiltinGlyphs: *boolean*
725 Compile *frills*: Disable the usage of the built-in block
726 graphics/line drawing characters and just rely on what the specified
727 fonts provide. Use this if you have a good font and want to use its
728 block graphic glyphs; option -sbg.
729
688 termName: *termname* 730 termName: *termname*
689 Specifies the terminal type name to be set in the TERM environment 731 Specifies the terminal type name to be set in the TERM environment
690 variable; option -tn. 732 variable; option -tn.
691 733
692 linespace: *number* 734 linespace: *number*
… …
735 The string to send when the delete key (not the keypad delete key) 777 The string to send when the delete key (not the keypad delete key)
736 is pressed. If unset it will send the sequence traditionally 778 is pressed. If unset it will send the sequence traditionally
737 associated with the Execute key. 779 associated with the Execute key.
738 780
739 cutchars: *string* 781 cutchars: *string*
740 The characters used as delimiters for double-click word selection. 782 The characters used as delimiters for double-click word selection
741 The built-in default: 783 (whitespace delimiting is added automatically if resource is given).
784
785 When the selection extension is in use (the default if compiled in,
786 see the rxvtperl(3) manpage), a suitable regex using these
787 characters will be created (if the resource exists, otherwise, no
788 regex will be created). In this mode, characters outside ISO-8859-1
789 can be used.
790
791 When the selection extension is not used, only ISO-8859-1 characters
792 can be used. If not specified, the built-in default is used:
742 793
743 BACKSLASH `"'&()*,;<=>?@[]{|} 794 BACKSLASH `"'&()*,;<=>?@[]{|}
744 795
745 preeditType: *style* 796 preeditType: *style*
746 OverTheSpot, OffTheSpot, Root; option -pt. 797 OverTheSpot, OffTheSpot, Root; option -pt.
… …
750 801
751 imLocale: *name* 802 imLocale: *name*
752 The locale to use for opening the IM. You can use an "LC_CTYPE" of 803 The locale to use for opening the IM. You can use an "LC_CTYPE" of
753 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for 804 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for
754 the input extension to be able to input japanese characters while 805 the input extension to be able to input japanese characters while
755 staying in another locale. option -imlocale. 806 staying in another locale; option -imlocale.
756 807
757 imFont: *fontset* 808 imFont: *fontset*
758 Specify the font-set used for XIM styles "OverTheSpot" or 809 Specify the font-set used for XIM styles "OverTheSpot" or
759 "OffTheSpot". It must be a standard X font set (XLFD patterns 810 "OffTheSpot". It must be a standard X font set (XLFD patterns
760 separated by commas), i.e. it's not in the same format as the other 811 separated by commas), i.e. it's not in the same format as the other
… …
763 to the base font. option -imfont. 814 to the base font. option -imfont.
764 815
765 tripleclickwords: *boolean* 816 tripleclickwords: *boolean*
766 Change the meaning of triple-click selection with the left mouse 817 Change the meaning of triple-click selection with the left mouse
767 button. Instead of selecting a full line it will extend the 818 button. Instead of selecting a full line it will extend the
768 selection to the end of the logical line only. option -tcw. 819 selection to the end of the logical line only; option -tcw.
769 820
770 insecure: *boolean* 821 insecure: *boolean*
771 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 822 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
772 that echo arbitrary strings like the icon name or the locale. This 823 that echo arbitrary strings like the icon name or the locale. This
773 could be abused if somebody gets 8-bit-clean access to your display, 824 could be abused if somebody gets 8-bit-clean access to your display,
774 whether throuh a mail client displaying mail bodies unfiltered or 825 whether through a mail client displaying mail bodies unfiltered or
775 though write(1). Therefore, these sequences are disabled by default. 826 through write(1) or any other means. Therefore, these sequences are
776 (Note that other terminals, including xterm, have these sequences 827 disabled by default. (Note that many other terminals, including
777 enabled by default). You can enable them by setting this boolean 828 xterm, have these sequences enabled by default, which doesn't make
778 resource or specifying -insecure as an option. At the moment, this 829 it safer, though).
779 enabled display-answer, locale, findfont, icon label and window 830
780 title requests as well as dynamic menubar dispatch. 831 You can enable them by setting this boolean resource or specifying
832 -insecure as an option. At the moment, this enables display-answer,
833 locale, findfont, icon label and window title requests.
781 834
782 modifier: *modifier* 835 modifier: *modifier*
783 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 836 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
784 super, mod1, mod2, mod3, mod4, mod5; option -mod. 837 super, mod1, mod2, mod3, mod4, mod5; option -mod.
785 838
786 answerbackString: *string* 839 answerbackString: *string*
787 Specify the reply rxvt-unicode sends to the shell when an ENQ 840 Specify the reply rxvt-unicode sends to the shell when an ENQ
788 (control-E) character is passed through. It may contain escape 841 (control-E) character is passed through. It may contain escape
789 values as described in the entry on keysym following. 842 values as described in the entry on keysym following.
790 843
791 secondaryScreen: *bool* 844 secondaryScreen: *boolean*
792 Turn on/off secondary screen (default enabled). 845 Turn on/off secondary screen (default enabled).
793 846
794 secondaryScroll: *bool* 847 secondaryScroll: *boolean*
795 Turn on/off secondary screen scroll (default enabled). If the this 848 Turn on/off secondary screen scroll (default enabled). If the this
796 option is enabled, scrolls on the secondary screen will change the 849 option is enabled, scrolls on the secondary screen will change the
797 scrollback buffer and switching to/from the secondary screen will 850 scrollback buffer and switching to/from the secondary screen will
798 instead scroll the screen up. 851 instead scroll the screen up.
852
853 hold: *boolean*
854 Turn on/off hold window after exit support. If enabled, rxvt will
855 not immediately destroy its window when the program executed within
856 it exits. Instead, it will wait till it is being killed or closed by
857 the user.
799 858
800 keysym.*sym*: *string* 859 keysym.*sym*: *string*
801 Compile *frills*: Associate *string* with keysym *sym*. The 860 Compile *frills*: Associate *string* with keysym *sym*. The
802 intervening resource name keysym. cannot be omitted. 861 intervening resource name keysym. cannot be omitted.
803 862
… …
822 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 881 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
823 "\000": octal number) or verbatim control characters ("^?": delete, 882 "\000": octal number) or verbatim control characters ("^?": delete,
824 "^@": null, "^A" ...) and may be enclosed with double quotes so that 883 "^@": null, "^A" ...) and may be enclosed with double quotes so that
825 it can start or end with whitespace. 884 it can start or end with whitespace.
826 885
827 Please note that you need to double the "\" when using 886 Please note that you need to double the "\" in resource files, as
828 "--enable-xgetdefault", as X itself does it's own de-escaping (you 887 Xlib itself does it's own de-escaping (you can use "\033" instead of
829 can use "\033" instead of "\e" (and so on), which will work with 888 "\e" (and so on), which will work with both Xt and rxvt's own
830 both Xt and rxvt's own processing). 889 processing).
831 890
832 You can define a range of keysyms in one shot by providing a 891 You can define a range of keysyms in one shot by providing a
833 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 892 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
834 `/' should be a character not used by the strings. 893 `/' should be a character not used by the strings.
835 894
… …
847 is interpreted and executed as rxvt's control sequence. For example 906 is interpreted and executed as rxvt's control sequence. For example
848 the following means "change the current locale to "zh_CN.GBK" when 907 the following means "change the current locale to "zh_CN.GBK" when
849 Control-Meta-c is being pressed": 908 Control-Meta-c is being pressed":
850 909
851 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 910 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
911
912 If *string* takes the form "perl:STRING", then the specified STRING
913 is passed to the "on_keyboard_command" perl handler. See the
914 rxvtperl(3) manpage. For example, the selection extension (activated
915 via "rxvt -pe selection") listens for "selection:rot13" events:
916
917 URxvt.keysym.M-C-c: perl:selection:rot13
852 918
853 Due the the large number of modifier combinations, a defined key 919 Due the the large number of modifier combinations, a defined key
854 mapping will match if at *at least* the specified identifiers are 920 mapping will match if at *at least* the specified identifiers are
855 being set, and no other key mappings with those and more bits are 921 being set, and no other key mappings with those and more bits are
856 being defined. That means that defining a key map for "a" will 922 being defined. That means that defining a key map for "a" will
… …
880 info): 946 info):
881 947
882 URxvt.keysym.M-C-3: command:\033[8;25;80t 948 URxvt.keysym.M-C-3: command:\033[8;25;80t
883 URxvt.keysym.M-C-4: command:\033[8;48;110t 949 URxvt.keysym.M-C-4: command:\033[8;48;110t
884 950
951 perl-ext-common: *string*
952 perl-ext: *string*
953 Comma-separated list(s) of perl extension scripts (default:
954 "default") to use in this terminal instance; option -pe.
955
956 Extension names can be prefixed with a "-" sign to prohibit using
957 them. This can be useful to selectively disable some extensions
958 loaded by default, or specified via the "perl-ext-common" resource.
959 For example, "default,-selection" will use all the default extension
960 except "selection".
961
962 Extension names can also be followed by an argument in angle
963 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
964 for searchable scorllback to Alt/Meta-s). Mentioning the same
965 extension multiple times with different arguments will pass multiple
966 arguments to the extension.
967
968 Each extension is looked up in the library directories, loaded if
969 necessary, and bound to the current terminal instance.
970
971 If both of these resources are the empty string, then the perl
972 interpreter will not be initialized. The idea behind two options is
973 that perl-ext-common will be used for extensions that should be
974 available to all instances, while perl-ext is used for specific
975 instances.
976
977 perl-eval: *string*
978 Perl code to be evaluated when all extensions have been registered.
979 See the rxvtperl(3) manpage. Due to security reasons, this resource
980 will be ignored when running setuid/setgid.
981
982 perl-lib: *path*
983 Colon-separated list of additional directories that hold extension
984 scripts. When looking for extensions specified by the "perl"
985 resource, rxvt will first look in these directories and then in
986 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
987 will be ignored when running setuid/setgid.
988
989 See the rxvtperl(3) manpage.
990
991 selection.pattern-*idx*: *perl-regex*
992 Additional selection patterns, see the rxvtperl(3) manpage for
993 details.
994
995 selection-autotransform.*idx*: *perl-transform*
996 Selection auto-transform patterns, see the rxvtperl(3) manpage for
997 details.
998
999 searchable-scrollback: *keysym*
1000 Sets the hotkey that starts the incremental scrollback buffer search
1001 (default: "M-s").
1002
1003 urlLauncher: *string*
1004 Specifies the program to be started with a URL argument. Used by the
1005 "selection-popup" and "mark-urls" perl extensions.
1006
1007 transient-for: *windowid*
1008 Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given
1009 window id.
1010
1011 override-redirect: *boolean*
1012 Compile *frills*: Sets override-redirect for the terminal window,
1013 making it almost invisible to window managers; option
1014 -override-redirect.
1015
885THE SCROLLBAR 1016THE SCROLLBAR
886 Lines of text that scroll off the top of the rxvt window (resource: 1017 Lines of text that scroll off the top of the rxvt window (resource:
887 saveLines) and can be scrolled back using the scrollbar or by 1018 saveLines) and can be scrolled back using the scrollbar or by
888 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1019 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
889 fairly intuitive. The xterm-scrollbar is without arrows and its 1020 fairly intuitive. The xterm-scrollbar is without arrows and its
… …
915 entire logical line (which can span multiple screen lines), unless 1046 entire logical line (which can span multiple screen lines), unless
916 modified by resource tripleclickwords. 1047 modified by resource tripleclickwords.
917 1048
918 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 1049 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
919 (Compile: *frills*) will create a rectangular selection instead of a 1050 (Compile: *frills*) will create a rectangular selection instead of a
920 normal one. 1051 normal one. In this mode, every selected row becomes its own line in
1052 the selection, and trailing whitespace is visually underlined and
1053 removed from the selection.
921 1054
922 Insertion: 1055 Insertion:
923 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1056 Pressing and releasing the Middle mouse button in an rxvt window
924 an rxvt window causes the current text selection to be inserted as 1057 causes the value of the PRIMARY selection (or CLIPBOARD with the
925 if it had been typed on the keyboard. 1058 Meta modifier) to be inserted as if it had been typed on the
1059 keyboard.
1060
1061 Pressing Shift-Insert causes the value of the PRIMARY selection to
1062 be inserted too.
926 1063
927CHANGING FONTS 1064CHANGING FONTS
928 Changing fonts (or font sizes, respectively) via the keypad is not yet 1065 Changing fonts (or font sizes, respectively) via the keypad is not yet
929 supported in rxvt-unicode. Bug me if you need this. 1066 supported in rxvt-unicode. Bug me if you need this.
930 1067
931 You can, however, switch fonts at runtime using escape sequences (and 1068 You can, however, switch fonts at runtime using escape sequences, e.g.:
932 therefore using the menubar), e.g.:
933 1069
934 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1070 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1071
1072 You can use keyboard shortcuts, too:
1073
1074 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1075 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
935 1076
936 rxvt-unicode will automatically re-apply these fonts to the output so 1077 rxvt-unicode will automatically re-apply these fonts to the output so
937 far. 1078 far.
938 1079
939ISO 14755 SUPPORT 1080ISO 14755 SUPPORT
… …
1002 setgid to root or to some other group on others. 1143 setgid to root or to some other group on others.
1003 1144
1004COLORS AND GRAPHICS 1145COLORS AND GRAPHICS
1005 In addition to the default foreground and background colours, rxvt can 1146 In addition to the default foreground and background colours, rxvt can
1006 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 1147 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
1007 versions of the same). Here is a list of the colours with their rgb.txt 1148 versions of the same). Here is a list of the colours with their names.
1008 names.
1009 1149
1010 color0 (black) = Black 1150 color0 (black) = Black
1011 color1 (red) = Red3 1151 color1 (red) = Red3
1012 color2 (green) = Green3 1152 color2 (green) = Green3
1013 color3 (yellow) = Yellow3 1153 color3 (yellow) = Yellow3
… …
1029 It is also possible to specify the colour values of foreground, 1169 It is also possible to specify the colour values of foreground,
1030 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1170 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1031 0-15, as a convenient shorthand to reference the colour name of 1171 0-15, as a convenient shorthand to reference the colour name of
1032 color0-color15. 1172 color0-color15.
1033 1173
1174 If Xft support has been compiled in and as long as Xft/Xrender/X don't
1175 get their act together, rxvt-unicode will support
1176 "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4
1177 digits/component), "#ARGB", "#AARRGGBB" and "#AAAARRRRGGGGBBBB" colour
1178 specifications, in addition to the ones provided by X, where the
1179 additional A component specifies alpha (opacity) values (0 is completely
1180 transparent and the maximum is opaque). You probably need to specify
1181 "-depth 32", too, and have the luck that your X-server uses ARGB pixel
1182 layout, as X is far from just supporting ARGB visuals out of the box,
1183 and rxvt-unicode just fudges around.
1184
1034 Note that -rv ("reverseVideo: True") simulates reverse video by always 1185 Note that -rv ("reverseVideo: True") simulates reverse video by always
1035 swapping the foreground/background colours. This is in contrast to 1186 swapping the foreground/background colours. This is in contrast to
1036 *xterm*(1) where the colours are only swapped if they have not otherwise 1187 *xterm*(1) where the colours are only swapped if they have not otherwise
1037 been specified. For example, 1188 been specified. For example,
1038 1189
… …
1075 display in it's child processes. 1226 display in it's child processes.
1076 1227
1077 SHELL 1228 SHELL
1078 The shell to be used for command execution, defaults to "/bin/sh". 1229 The shell to be used for command execution, defaults to "/bin/sh".
1079 1230
1080 RXVTPATH
1081 The path where rxvt looks for support files such as menu and xpm
1082 files.
1083
1084 PATH
1085 Used in the same way as "RXVTPATH".
1086
1087 RXVT_SOCKET 1231 RXVT_SOCKET
1088 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1232 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1089 1233
1090 Default $HOME/.rxvt-unicode-*<nodename*. 1234 Default $HOME/.rxvt-unicode-*<nodename*.
1091 1235
… …
1107 1251
1108SEE ALSO 1252SEE ALSO
1109 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4), 1253 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
1110 tty(4), utmp(5) 1254 tty(4), utmp(5)
1111 1255
1112BUGS
1113 Check the BUGS file for an up-to-date list.
1114
1115 Cursor change support is not yet implemented.
1116
1117 Click-and-drag doesn't work with X11 mouse report overriding.
1118
1119CURRENT PROJECT COORDINATOR 1256CURRENT PROJECT COORDINATOR
1120 Project Coordinator 1257 Project Coordinator
1121 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1258 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1122 1259
1123 <http://software.schmorp.de/#rxvt-unicode> 1260 <http://software.schmorp.de/#rxvt-unicode>
… …
1139 1276
1140 Oezguer Kesim <kesim@math.fu-berlin.de> 1277 Oezguer Kesim <kesim@math.fu-berlin.de>
1141 Project Coordinator (changes.txt 2.21a to 2.4.5) 1278 Project Coordinator (changes.txt 2.21a to 2.4.5)
1142 1279
1143 Geoff Wing <gcw@pobox.com> 1280 Geoff Wing <gcw@pobox.com>
1144 Rewrote screen display and text selection routines. Project 1281 Rewrote screen display and text selection routines.
1282
1145 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1283 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1146 1284
1147 Marc Alexander Lehmann <rxvt-unicode@schmorp.de> 1285 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1148 Forked rxvt-unicode, rewrote most of the display code and internal 1286 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1149 character handling to store text in unicode, improve xterm 1287 perl extension, random hacks, numerous bugfixes and extensions.
1150 compatibility and apply numerous other bugfixes and extensions.
1151 1288
1152 Project Coordinator (Changes 1.0 -) 1289 Project Coordinator (Changes 1.0 -)
1153 1290
1291 Emanuele Giaquinta <e.giaquinta@glauco.it>
1292 Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1293

Diff Legend

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