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.6 by root, Thu Feb 3 10:24:10 2005 UTC vs.
Revision 1.37 by root, Sat Jan 7 04:19:43 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 4.9, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 6.3, is a colour vt102 terminal emulator intended
10 as an *xterm*(1) replacement for users who do not require features such 10 as an *xterm*(1) replacement for users who do not require features such
11 as Tektronix 4014 emulation and toolkit-style configurability. As a 11 as Tektronix 4014 emulation and toolkit-style configurability. As a
12 result, rxvt-unicode uses much less swap space -- a significant 12 result, rxvt-unicode uses much less swap space -- a significant
13 advantage on a machine serving many X sessions. 13 advantage on a machine serving many X sessions.
14 14
15FREQUENTLY ASKED QUESTIONS 15FREQUENTLY ASKED QUESTIONS
16 See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions 16 See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions
17 and answer to them and some common problems. 17 and answer to them and some common problems. That document is also
18 accessible on the World-Wide-Web at
19 <http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
18 20
19RXVT-UNICODE VS. RXVT 21RXVT-UNICODE VS. RXVT
20 Unlike the original rxvt, rxvt-unicode stores all text in Unicode 22 Unlike the original rxvt, rxvt-unicode stores all text in Unicode
21 internally. That means it can store and display most scripts in the 23 internally. That means it can store and display most scripts in the
22 world. Being a terminal emulator, however, some things are very 24 world. Being a terminal emulator, however, some things are very
… …
91 Turn on/off simulated reverse video; resource reverseVideo. 93 Turn on/off simulated reverse video; resource reverseVideo.
92 94
93 -j|+j 95 -j|+j
94 Turn on/off jump scrolling; resource jumpScroll. 96 Turn on/off jump scrolling; resource jumpScroll.
95 97
96 -ip|+ip 98 -ip|+ip | -tr|+tr
97 Turn on/off inheriting parent window's pixmap. Alternative form is 99 Turn on/off inheriting parent window's pixmap. Alternative form is
98 -tr; resource inheritPixmap. 100 -tr; resource inheritPixmap.
99 101
100 -fade *number* 102 -fade *number*
101 Fade the text by the given percentage when focus is lost. resource 103 Fade the text by the given percentage when focus is lost. Small
102 fading. 104 values fade a little only, 100 completely replaces all colours by
105 the fade colour; resource fading.
106
107 -fadecolor *colour*
108 Fade to this colour when fading is used (see -fade). The default
109 colour is black. resource fadeColor.
103 110
104 -tint *colour* 111 -tint *colour*
105 Tint the transparent background pixmap with the given colour when 112 Tint the transparent background pixmap with the given colour when
106 transparency is enabled with -tr or -ip. See also the -sh option 113 transparency is enabled with -tr or -ip. This only works for
114 non-tiled backgrounds, currently. See also the -sh option that can
107 that can be used to brighten or darken the image in addition to 115 be used to brighten or darken the image in addition to tinting it;
108 tinting it. 116 resource *tintColor*. Example:
117
118 rxvt -tr -tint blue -sh 40
109 119
110 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent 120 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent
111 background image in addition to tinting it (i.e. -tint must be 121 background image in addition to tinting it (i.e. -tint must be
112 specified, too, e.g. "-tint white"). 122 specified, too, e.g. "-tint white").
113 123
… …
153 163
154 See also the question "How does rxvt-unicode choose fonts?" in the 164 See also the question "How does rxvt-unicode choose fonts?" in the
155 FAQ section of rxvt(7). 165 FAQ section of rxvt(7).
156 166
157 -fb *fontlist* 167 -fb *fontlist*
158 Compile font-styles: The bold font list to use when bold characters 168 Compile *font-styles*: The bold font list to use when bold
159 are to be printed. See resource boldFont for details. 169 characters are to be printed. See resource boldFont for details.
160 170
161 -fi *fontlist* 171 -fi *fontlist*
162 Compile font-styles: The italic font list to use when bold 172 Compile *font-styles*: The italic font list to use when *italic*
163 characters are to be printed. See resource italicFont for details. 173 characters are to be printed. See resource italicFont for details.
164 174
165 -fbi *fontlist* 175 -fbi *fontlist*
166 Compile font-styles: The bold italic font list to use when bold 176 Compile *font-styles*: The bold italic font list to use when *bold
167 characters are to be printed. See resource boldItalicFont for 177 italic* characters are to be printed. See resource boldItalicFont
178 for details.
179
180 -is|+is
181 Compile *font-styles*: Bold/Italic font styles imply high intensity
182 foreground/background (default). See resource intensityStyles for
168 details. 183 details.
169 184
170 -name *name* 185 -name *name*
171 Specify the application name under which resources are to be 186 Specify the application name under which resources are to be
172 obtained, rather than the default executable file name. Name should 187 obtained, rather than the default executable file name. Name should
… …
202 217
203 -sr|+sr 218 -sr|+sr
204 Put scrollbar on right/left; resource scrollBar_right. 219 Put scrollbar on right/left; resource scrollBar_right.
205 220
206 -st|+st 221 -st|+st
207 Display normal (non XTerm/NeXT) scrollbar without/with a trough; 222 Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
208 resource scrollBar_floating. 223 resource scrollBar_floating.
209 224
210 -ptab|+ptab 225 -ptab|+ptab
211 If enabled (default), "Horizontal Tab" characters are being stored 226 If enabled (default), "Horizontal Tab" characters are being stored
212 as actual wide characters in the screen buffer, which makes it 227 as actual wide characters in the screen buffer, which makes it
… …
236 externalBorder. 251 externalBorder.
237 252
238 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e. 253 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e.
239 if honoured by the WM, the rxvt-unicode window will not have window 254 if honoured by the WM, the rxvt-unicode window will not have window
240 decorations; resource borderLess. 255 decorations; resource borderLess.
256
257 -sbg
258 Compile *frills*: Disable the usage of the built-in block
259 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
261 block graphic glyphs; resource skipBuiltinGlyphs.
241 262
242 -lsp *number* 263 -lsp *number*
243 Compile *frills*: Lines (pixel height) to insert between each row of 264 Compile *frills*: Lines (pixel height) to insert between each row of
244 the display. Useful to work around font rendering problems; resource 265 the display. Useful to work around font rendering problems; resource
245 linespace. 266 linespace.
… …
257 on the command line. If this option is used, it must be the last on 278 on the command line. If this option is used, it must be the last on
258 the command-line. If there is no -e option then the default is to 279 the command-line. If there is no -e option then the default is to
259 run the program specified by the SHELL environment variable or, 280 run the program specified by the SHELL environment variable or,
260 failing that, *sh(1)*. 281 failing that, *sh(1)*.
261 282
283 Please note that you must specify a program with arguments. If you
284 want to run shell commands, you have to specify the shell, like
285 this:
286
287 rxvt -e sh -c "shell commands"
288
262 -title *text* 289 -title *text*
263 Window title (-T still respected); the default title is the basename 290 Window title (-T still respected); the default title is the basename
264 of the program specified after the -e option, if any, otherwise the 291 of the program specified after the -e option, if any, otherwise the
265 application name; resource title. 292 application name; resource title.
266 293
… …
309 336
310 -ssr|+ssr 337 -ssr|+ssr
311 Turn on/off secondary screen scroll (default enabled); resource 338 Turn on/off secondary screen scroll (default enabled); resource
312 secondaryScroll. 339 secondaryScroll.
313 340
314 -xrm *resourcestring* 341 -hold|+hold
315 No effect on rxvt-unicode. Simply passes through an argument to be 342 Turn on/off hold window after exit support. If enabled, rxvt will
316 made available in the instance's argument list. Appears in 343 not immediately destroy its window when the program executed within
317 *WM_COMMAND* in some window managers. 344 it exits. Instead, it will wait till it is being killed or closed by
345 the user; resource hold.
346
347 -keysym.*sym* *string*
348 Remap a key symbol. See resource keysym.
349
350 -embed *windowid*
351 Tells rxvt to embed it's windows into an already-existing window,
352 which enables applications to easily embed a terminal.
353
354 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
356 a bit, so don't expect it to keep some specific state. It's best to
357 create an extra subwindow for rxvt and leave it alone.
358
359 The window will not be destroyed when rxvt exits.
360
361 It might be useful to know that rxvt will not close file descriptors
362 passed to it (except for stdin/out/err, of course), so you can use
363 file descriptors to communicate with the programs within the
364 terminal. This works regardless of wether the "-embed" option was
365 used or not.
366
367 Here is a short Gtk2-perl snippet that illustrates how this option
368 can be used (a longer example is in doc/embed):
369
370 my $rxvt = new Gtk2::Socket;
371 $rxvt->signal_connect_after (realize => sub {
372 my $xid = $_[0]->window->get_xid;
373 system "rxvt -embed $xid &";
374 });
375
376 -pty-fd *file descriptor*
377 Tells rxvt NOT to execute any commands or create a new pty/tty pair
378 but instead use the given filehandle as the tty master. This is
379 useful if you want to drive rxvt as a generic terminal emulator
380 without having to run a program within it.
381
382 If this switch is given, rxvt will not create any utmp/wtmp entries
383 and will not tinker with pty/tty permissions - you have to do that
384 yourself if you want that.
385
386 As an extremely special case, specifying -1 will completely suppress
387 pty/tty operations.
388
389 Here is a example in perl that illustrates how this option can be
390 used (a longer example is in doc/pty-fd):
391
392 use IO::Pty;
393 use Fcntl;
394
395 my $pty = new IO::Pty;
396 fcntl $pty, F_SETFD, 0; # clear close-on-exec
397 system "rxvt -pty-fd " . (fileno $pty) . "&";
398 close $pty;
399
400 # now communicate with rxvt
401 my $slave = $pty->slave;
402 while (<$slave>) { print $slave "got <$_>\n" }
403
404 -pe *string*
405 Comma-separated list of perl extension scripts to use in this
406 terminal instance. See resource perl-ext.
318 407
319RESOURCES (available also as long-options) 408RESOURCES (available also as long-options)
320 Note: `rxvt --help' gives a list of all resources (long options) 409 Note: `rxvt --help' gives a list of all resources (long options)
321 compiled into your version. 410 compiled into your version.
322 411
323 There are two different methods that rxvt can use to get the Xresource 412 There are two different methods that rxvt can use to get the Xresource
324 data: using the X libraries (Xrm*-functions) or internal Xresources 413 data: using the X libraries (Xrm*-functions) or internal Xresources
325 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists 414 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
326 XGetDefaults), you can set and change the resources using X11 tools like 415 XGetDefaults), you can set and change the resources using X11 tools like
327 xset. Many distribution do also load settings from the ~/.Xresources 416 xrdb. Many distribution do also load settings from the ~/.Xresources
328 file when X starts. 417 file when X starts. rxvt will consult the following files/resources in
418 order, with later settings overwriting earlier ones:
419
420 1. system-wide app-defaults file, either locale-dependent OR global
421 2. app-defaults file in $XAPPLRESDIR
422 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
423 4. SCREEN_RESOURCES for the current screen
424 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
329 425
330 If compiled with internal Xresources support (i.e. rxvt -h lists 426 If compiled with internal Xresources support (i.e. rxvt -h lists
331 .Xdefaults) then rxvt accepts application defaults set in 427 .Xdefaults) then rxvt accepts application defaults set in
332 XAPPLOADDIR/URxvt (compile-time defined: usually 428 XAPPLOADDIR/URxvt (compile-time defined: usually
333 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 429 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or
… …
409 True: make the background inherit the parent windows' pixmap, giving 505 True: make the background inherit the parent windows' pixmap, giving
410 artificial transparency. False: do not inherit the parent windows' 506 artificial transparency. False: do not inherit the parent windows'
411 pixmap. 507 pixmap.
412 508
413 fading: *number* 509 fading: *number*
414 Fade the text by the given percentage when focus is lost. 510 Fade the text by the given percentage when focus is lost; option
511 -fade.
512
513 fadeColor: *colour*
514 Fade to this colour, when fading is used (see fading:). The default
515 colour is black; option -fadecolor.
415 516
416 tintColor: *colour* 517 tintColor: *colour*
417 Tint the transparent background pixmap with the given colour. 518 Tint the transparent background pixmap with the given colour; option
519 -tint.
418 520
419 shading: *number* 521 shading: *number*
420 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 522 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
421 image in addition to tinting it. 523 image in addition to tinting it.
422 524
423 scrollColor: *colour* 525 scrollColor: *colour*
424 Use the specified colour for the scrollbar [default #B2B2B2]. 526 Use the specified colour for the scrollbar [default #B2B2B2].
425 527
426 troughColor: *colour* 528 troughColor: *colour*
427 Use the specified colour for the scrollbar's trough area [default 529 Use the specified colour for the scrollbar's trough area [default
428 #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 530 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
429 531
430 borderColor: *colour* 532 borderColor: *colour*
431 The colour of the border around the text area and between the 533 The colour of the border around the text area and between the
432 scrollbar and the text. 534 scrollbar and the text.
433 535
… …
456 font: *fontlist* 558 font: *fontlist*
457 Select the fonts to be used. This is a comma separated list of font 559 Select the fonts to be used. This is a comma separated list of font
458 names that are used in turn when trying to display Unicode 560 names that are used in turn when trying to display Unicode
459 characters. The first font defines the cell size for characters; 561 characters. The first font defines the cell size for characters;
460 other fonts might be smaller, but not larger. A reasonable default 562 other fonts might be smaller, but not larger. A reasonable default
461 font list is always appended to it. option -fn. 563 font list is always appended to it; option -fn.
462 564
463 Each font can either be a standard X11 core font (XLFD) name, with 565 Each font can either be a standard X11 core font (XLFD) name, with
464 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 566 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
465 "xft:". 567 "xft:".
466 568
… …
512 tried. 614 tried.
513 615
514 If set, but empty, then this specific style is disabled and the 616 If set, but empty, then this specific style is disabled and the
515 normal text font will being used for the given style. 617 normal text font will being used for the given style.
516 618
619 intensityStyles: *boolean*
620 When font styles are not enabled, or this option is enabled (True,
621 option -is, the default), bold and italic font styles imply high
622 intensity foreground/backround colours. Disabling this option
623 (False, option +is) disables this behaviour, the high intensity
624 colours are not reachable.
625
517 selectstyle: *mode* 626 selectstyle: *mode*
518 Set mouse selection style to old which is 2.20, oldword which is 627 Set mouse selection style to old which is 2.20, oldword which is
519 xterm style with 2.20 old word selection, or anything else which 628 xterm style with 2.20 old word selection, or anything else which
520 gives xterm style selection. 629 gives xterm style selection.
521 630
522 scrollstyle: *mode* 631 scrollstyle: *mode*
523 Set scrollbar style to rxvt, plain, next or xterm. plain is the 632 Set scrollbar style to rxvt, plain, next or xterm. plain is the
524 author's favourite.. 633 author's favourite.
525 634
526 title: *string* 635 title: *string*
527 Set window title string, the default title is the command-line 636 Set window title string, the default title is the command-line
528 specified after the -e option, if any, otherwise the application 637 specified after the -e option, if any, otherwise the application
529 name; option -title. 638 name; option -title.
… …
554 print-pipe: *string* 663 print-pipe: *string*
555 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use 664 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use
556 Print to initiate a screen dump to the printer and Ctrl-Print or 665 Print to initiate a screen dump to the printer and Ctrl-Print or
557 Shift-Print to include the scrollback as well. 666 Shift-Print to include the scrollback as well.
558 667
668 The string will be interpreted as if typed into the shell as-is.
669
670 Example:
671
672 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
673
674 This creates a new file in your home directory with the screen
675 contents everytime you hit "Print".
676
559 scrollBar: *boolean* 677 scrollBar: *boolean*
560 True: enable the scrollbar [default]; option -sb. False: disable the 678 True: enable the scrollbar [default]; option -sb. False: disable the
561 scrollbar; option +sb. 679 scrollbar; option +sb.
562 680
563 scrollBar_right: *boolean* 681 scrollBar_right: *boolean*
… …
576 True: scroll to bottom when tty receives output; option -si. False: 694 True: scroll to bottom when tty receives output; option -si. False:
577 do not scroll to bottom when tty receives output; option +si. 695 do not scroll to bottom when tty receives output; option +si.
578 696
579 scrollWithBuffer: *boolean* 697 scrollWithBuffer: *boolean*
580 True: scroll with scrollback buffer when tty receives new lines (and 698 True: scroll with scrollback buffer when tty receives new lines (and
581 scrollTtyOutput is False); option +sw. False: do not scroll with 699 scrollTtyOutput is False); option -sw. False: do not scroll with
582 scrollback buffer when tty recieves new lines; option -sw. 700 scrollback buffer when tty recieves new lines; option +sw.
583 701
584 scrollTtyKeypress: *boolean* 702 scrollTtyKeypress: *boolean*
585 True: scroll to bottom when a non-special key is pressed. Special 703 True: scroll to bottom when a non-special key is pressed. Special
586 keys are those which are intercepted by rxvt-unicode for special 704 keys are those which are intercepted by rxvt-unicode for special
587 handling and are not passed onto the shell; option -sk. False: do 705 handling and are not passed onto the shell; option -sk. False: do
… …
602 borderLess: *boolean* 720 borderLess: *boolean*
603 Set MWM hints to request a borderless window, i.e. if honoured by 721 Set MWM hints to request a borderless window, i.e. if honoured by
604 the WM, the rxvt-unicode window will not have window decorations; 722 the WM, the rxvt-unicode window will not have window decorations;
605 option -bl. 723 option -bl.
606 724
725 skipBuiltinGlyphs: *boolean*
726 Compile *frills*: Disable the usage of the built-in block
727 graphics/line drawing characters and just rely on what the specified
728 fonts provide. Use this if you have a good font and want to use its
729 block graphic glyphs; option -sbg.
730
607 termName: *termname* 731 termName: *termname*
608 Specifies the terminal type name to be set in the TERM environment 732 Specifies the terminal type name to be set in the TERM environment
609 variable; option -tn. 733 variable; option -tn.
610 734
611 linespace: *number* 735 linespace: *number*
… …
639 pointerColor2: *colour* 763 pointerColor2: *colour*
640 Mouse pointer background colour. 764 Mouse pointer background colour.
641 765
642 pointerBlankDelay: *number* 766 pointerBlankDelay: *number*
643 Specifies number of seconds before blanking the pointer [default 2]. 767 Specifies number of seconds before blanking the pointer [default 2].
768 Use a large number (e.g. 987654321) to effectively disable the
769 timeout.
644 770
645 backspacekey: *string* 771 backspacekey: *string*
646 The string to send when the backspace key is pressed. If set to DEC 772 The string to send when the backspace key is pressed. If set to DEC
647 or unset it will send Delete (code 127) or, if shifted, Backspace 773 or unset it will send Delete (code 127) or, if shifted, Backspace
648 (code 8) - which can be reversed with the appropriate DEC private 774 (code 8) - which can be reversed with the appropriate DEC private
… …
667 793
668 imLocale: *name* 794 imLocale: *name*
669 The locale to use for opening the IM. You can use an "LC_CTYPE" of 795 The locale to use for opening the IM. You can use an "LC_CTYPE" of
670 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for 796 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for
671 the input extension to be able to input japanese characters while 797 the input extension to be able to input japanese characters while
672 staying in another locale. option -imlocale. 798 staying in another locale; option -imlocale.
673 799
674 imFont: *fontset* 800 imFont: *fontset*
675 Specify the font-set used for XIM styles "OverTheSpot" or 801 Specify the font-set used for XIM styles "OverTheSpot" or
676 "OffTheSpot". It must be a standard X font set (XLFD patterns 802 "OffTheSpot". It must be a standard X font set (XLFD patterns
677 separated by commas), i.e. it's not in the same format as the other 803 separated by commas), i.e. it's not in the same format as the other
… …
680 to the base font. option -imfont. 806 to the base font. option -imfont.
681 807
682 tripleclickwords: *boolean* 808 tripleclickwords: *boolean*
683 Change the meaning of triple-click selection with the left mouse 809 Change the meaning of triple-click selection with the left mouse
684 button. Instead of selecting a full line it will extend the 810 button. Instead of selecting a full line it will extend the
685 selection to the end of the logical line only. option -tcw. 811 selection to the end of the logical line only; option -tcw.
686 812
687 insecure: *boolean* 813 insecure: *boolean*
688 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 814 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
689 that echo arbitrary strings like the icon name or the locale. This 815 that echo arbitrary strings like the icon name or the locale. This
690 could be abused if somebody gets 8-bit-clean access to your display, 816 could be abused if somebody gets 8-bit-clean access to your display,
691 whether throuh a mail client displaying mail bodies unfiltered or 817 whether through a mail client displaying mail bodies unfiltered or
692 though write(1). Therefore, these sequences are disabled by default. 818 through write(1) or any other means. Therefore, these sequences are
693 (Note that other terminals, including xterm, have these sequences 819 disabled by default. (Note that many other terminals, including
694 enabled by default). You can enable them by setting this boolean 820 xterm, have these sequences enabled by default, which doesn't make
695 resource or specifying -insecure as an option. At the moment, this 821 it safer, though).
696 enabled display-answer, locale, findfont, icon label and window 822
697 title requests as well as dynamic menubar dispatch. 823 You can enable them by setting this boolean resource or specifying
824 -insecure as an option. At the moment, this enables display-answer,
825 locale, findfont, icon label and window title requests as well as
826 dynamic menubar dispatch.
698 827
699 modifier: *modifier* 828 modifier: *modifier*
700 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 829 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
701 super, mod1, mod2, mod3, mod4, mod5; option -mod. 830 super, mod1, mod2, mod3, mod4, mod5; option -mod.
702 831
… …
711 secondaryScroll: *bool* 840 secondaryScroll: *bool*
712 Turn on/off secondary screen scroll (default enabled). If the this 841 Turn on/off secondary screen scroll (default enabled). If the this
713 option is enabled, scrolls on the secondary screen will change the 842 option is enabled, scrolls on the secondary screen will change the
714 scrollback buffer and switching to/from the secondary screen will 843 scrollback buffer and switching to/from the secondary screen will
715 instead scroll the screen up. 844 instead scroll the screen up.
845
846 hold: *bool*
847 Turn on/off hold window after exit support. If enabled, rxvt will
848 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
850 the user.
716 851
717 keysym.*sym*: *string* 852 keysym.*sym*: *string*
718 Compile *frills*: Associate *string* with keysym *sym*. The 853 Compile *frills*: Associate *string* with keysym *sym*. The
719 intervening resource name keysym. cannot be omitted. 854 intervening resource name keysym. cannot be omitted.
720 855
… …
739 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 874 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
740 "\000": octal number) or verbatim control characters ("^?": delete, 875 "\000": octal number) or verbatim control characters ("^?": delete,
741 "^@": null, "^A" ...) and may be enclosed with double quotes so that 876 "^@": null, "^A" ...) and may be enclosed with double quotes so that
742 it can start or end with whitespace. 877 it can start or end with whitespace.
743 878
879 Please note that you need to double the "\" when using
880 "--enable-xgetdefault", as X itself does it's own de-escaping (you
881 can use "\033" instead of "\e" (and so on), which will work with
882 both Xt and rxvt's own processing).
883
744 You can define a range of keysyms in one shot by providing a 884 You can define a range of keysyms in one shot by providing a
745 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 885 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
746 `/' should be a character not used by the strings. 886 `/' should be a character not used by the strings.
747 887
748 Its usage can be demonstrated by an example: 888 Its usage can be demonstrated by an example:
749 889
750 URxvt.keysym.M-C-0x61: list|\e<M-C-|abc|> 890 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
751 891
752 The above line is equivalent to the following three lines: 892 The above line is equivalent to the following three lines:
753 893
754 URxvt.keysym.Meta-Control-0x61: \e<M-C-a> 894 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
755 URxvt.keysym.Meta-Control-0x62: \e<M-C-b> 895 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
756 URxvt.keysym.Meta-Control-0x63: \e<M-C-c> 896 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
757 897
758 If *string* takes the form of "proto:STRING", the specified STRING 898 If *string* takes the form of "command:STRING", the specified STRING
759 is interpreted and executed as rxvt's control sequence. For example 899 is interpreted and executed as rxvt's control sequence. For example
760 the following means "change the current locale to "zh_CN.GBK" when 900 the following means "change the current locale to "zh_CN.GBK" when
761 Control-Meta-c is being pressed": 901 Control-Meta-c is being pressed":
762 902
763 URxvt.keysym.M-C-c: proto:\033]701;zh_CN.GBK\007 903 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
904
905 If *string* takes the form "perl:STRING", then the specified STRING
906 is passed to the "on_keyboard_command" perl handler. See the
907 rxvtperl(3) manpage. For example, the selection extension (activated
908 via "rxvt -pe selection") listens for "selection:rot13" events:
909
910 URxvt.keysym.M-C-c: perl:selection:rot13
911
912 Due the the large number of modifier combinations, a defined key
913 mapping will match if at *at least* the specified identifiers are
914 being set, and no other key mappings with those and more bits are
915 being defined. That means that defining a key map for "a" will
916 automatically provide definitions for "Meta-a", "Shift-a" and so on,
917 unless some of those are defined mappings themselves.
918
919 Unfortunately, this will override built-in key mappings. For example
920 if you overwrite the "Insert" key you will disable rxvt's
921 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
922 the user-defined keymap using the "builtin:" replacement:
923
924 URxvt.keysym.Insert: <my insert key sequence>
925 URxvt.keysym.S-Insert: builtin:
926
927 The first line defines a mapping for "Insert" and *any* combination
928 of modifiers. The second line re-establishes the default mapping for
929 "Shift-Insert".
764 930
765 The following example will map Control-Meta-1 and Control-Meta-2 to 931 The following example will map Control-Meta-1 and Control-Meta-2 to
766 the fonts "suxuseuro" and "9x15bold", so you cna have some limited 932 the fonts "suxuseuro" and "9x15bold", so you can have some limited
767 font-switching at runtime: 933 font-switching at runtime:
768 934
769 URxvt.keysym.M-C-1: proto:\033]50;suxuseuro\007 935 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
770 URxvt.keysym.M-C-2: proto:\033]50;9x15bold\007 936 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
771 937
772 "proto:\033]701;zh_CN.GBK\007" means: change the current locale to 938 Other things are possible, e.g. resizing (see rxvt(7) for more
773 "zh_CN.GBK". 939 info):
940
941 URxvt.keysym.M-C-3: command:\033[8;25;80t
942 URxvt.keysym.M-C-4: command:\033[8;48;110t
943
944 perl-ext-common: *string*
945 perl-ext: *string*
946 Comma-separated list(s) of perl extension scripts to use in this
947 terminal instance. Each extension is looked up in the library
948 directories, loaded if necessary, and bound to the current terminal
949 instance. If this resource is empty or missing, then the perl
950 interpreter will not be initialized. The idea behind two options is
951 that perl-ext-common will be used for extensions that should be
952 available to all instances, while perl-ext is used for specific
953 instances; option -pe.
954
955 perl-eval: *string*
956 Perl code to be evaluated when all extensions have been registered.
957 See the rxvtperl(3) manpage.
958
959 perl-lib: *path*
960 Colon-separated list of additional directories that hold extension
961 scripts. When looking for extensions specified by the "perl"
962 resource, rxvt will first look in these directories and then in
963 /opt/rxvt/lib/urxvt/perl/.
964
965 See the rxvtperl(3) manpage.
774 966
775THE SCROLLBAR 967THE SCROLLBAR
776 Lines of text that scroll off the top of the rxvt window (resource: 968 Lines of text that scroll off the top of the rxvt window (resource:
777 saveLines) and can be scrolled back using the scrollbar or by 969 saveLines) and can be scrolled back using the scrollbar or by
778 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 970 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
… …
788 normal text selection/insertion, hold either the Shift or the Meta (Alt) 980 normal text selection/insertion, hold either the Shift or the Meta (Alt)
789 key while performing the desired mouse action. 981 key while performing the desired mouse action.
790 982
791 If mouse reporting mode is active, the normal scrollbar actions are 983 If mouse reporting mode is active, the normal scrollbar actions are
792 disabled -- on the assumption that we are using a fullscreen 984 disabled -- on the assumption that we are using a fullscreen
793 application. Instead, pressing Button1 and Button3 sends ESC[6~ (Next) 985 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
794 and ESC[5~ (Prior), respectively. Similarly, clicking on the up and down 986 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
795 arrows sends ESC[A (Up) and ESC[B (Down), respectively. 987 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
796 988
797TEXT SELECTION AND INSERTION 989TEXT SELECTION AND INSERTION
798 The behaviour of text selection and insertion mechanism is similar to 990 The behaviour of text selection and insertion mechanism is similar to
799 *xterm*(1). 991 *xterm*(1).
800 992
… …
805 entire logical line (which can span multiple screen lines), unless 997 entire logical line (which can span multiple screen lines), unless
806 modified by resource tripleclickwords. 998 modified by resource tripleclickwords.
807 999
808 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 1000 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
809 (Compile: *frills*) will create a rectangular selection instead of a 1001 (Compile: *frills*) will create a rectangular selection instead of a
810 normal one. 1002 normal one. In this mode, every selected row becomes its own line in
1003 the selection, and trailing whitespace is visually underlined and
1004 removed from the selection.
811 1005
812 Insertion: 1006 Insertion:
813 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1007 Pressing and releasing the Middle mouse button (or Shift-Insert) in
814 an rxvt window causes the current text selection to be inserted as 1008 an rxvt window causes the current text selection to be inserted as
815 if it had been typed on the keyboard. 1009 if it had been typed on the keyboard.
… …
819 supported in rxvt-unicode. Bug me if you need this. 1013 supported in rxvt-unicode. Bug me if you need this.
820 1014
821 You can, however, switch fonts at runtime using escape sequences (and 1015 You can, however, switch fonts at runtime using escape sequences (and
822 therefore using the menubar), e.g.: 1016 therefore using the menubar), e.g.:
823 1017
824 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1018 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
825 1019
826 rxvt-unicode will automatically re-apply these fonts to the output so 1020 rxvt-unicode will automatically re-apply these fonts to the output so
827 far. 1021 far.
828 1022
829ISO 14755 SUPPORT 1023ISO 14755 SUPPORT
… …
929 rxvt -fg Black -bg White -rv 1123 rxvt -fg Black -bg White -rv
930 would yield White on Black, while on *xterm*(1) it would yield Black 1124 would yield White on Black, while on *xterm*(1) it would yield Black
931 on White. 1125 on White.
932 1126
933ENVIRONMENT 1127ENVIRONMENT
934 rxvt sets the environment variables TERM, COLORTERM and COLORFGBG. The 1128 rxvt sets and/or uses the following environment variables:
935 environment variable WINDOWID is set to the X window id number of the 1129
936 rxvt window and it also uses and sets the environment variable DISPLAY 1130 TERM
937 to specify which display terminal to use. rxvt uses the environment 1131 Normally set to "rxvt-unicode", unless overwritten at configure
938 variables RXVTPATH and PATH to find XPM files. 1132 time, via resources or on the commandline.
1133
1134 COLORTERM
1135 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled
1136 with XPM support, and optionally with the added extension "-mono" to
1137 indicate that rxvt-unicode runs on a monochrome screen.
1138
1139 COLORFGBG
1140 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1141 the colour code used as default foreground/text colour (or the
1142 string "default" to indicate that the default-colour escape sequence
1143 is to be used), "bg" is the colour code used as default background
1144 colour (or the string "default"), and "xpm" is the string "default"
1145 if rxvt was compiled with XPM support. Libraries like "ncurses" and
1146 "slang" can (and do) use this information to optimize screen output.
1147
1148 WINDOWID
1149 Set to the (decimal) X Window ID of the rxvt window (the toplevel
1150 window, which usually has subwindows for the scrollbar, the terminal
1151 window and so on).
1152
1153 TERMINFO
1154 Set to the terminfo directory iff rxvt was configured with
1155 "--with-terminfo=PATH".
1156
1157 DISPLAY
1158 Used by rxvt to connect to the display and set to the correct
1159 display in it's child processes.
1160
1161 SHELL
1162 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
1171 RXVT_SOCKET
1172 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1173
1174 Default $HOME/.rxvt-unicode-*<nodename*.
1175
1176 HOME
1177 Used to locate the default directory for the unix domain socket for
1178 daemon communications and to locate various resource files (such as
1179 ".Xdefaults")
1180
1181 XAPPLRESDIR
1182 Directory where various X resource files are being located.
1183
1184 XENVIRONMENT
1185 If set and accessible, gives the name of a X resource file to be
1186 loaded by rxvt.
939 1187
940FILES 1188FILES
941 /usr/lib/X11/rgb.txt 1189 /usr/lib/X11/rgb.txt
942 Color names. 1190 Color names.
943 1191
944SEE ALSO 1192SEE ALSO
945 rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1193 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
946 1194 tty(4), utmp(5)
947BUGS
948 Check the BUGS file for an up-to-date list.
949
950 Cursor change support is not yet implemented.
951
952 Click-and-drag doesn't work with X11 mouse report overriding.
953 1195
954CURRENT PROJECT COORDINATOR 1196CURRENT PROJECT COORDINATOR
955 Project Coordinator 1197 Project Coordinator
956 Marc A. Lehmann rxvt@schmorp.de 1198 Marc A. Lehmann <rxvt-unicode@schmorp.de>
957 1199
958 Web page maintainter
959 Marc A. Lehmann rxvt@schmorp.de
960
961 <http://software.schmorp.de/> 1200 <http://software.schmorp.de/#rxvt-unicode>
962 1201
963AUTHORS 1202AUTHORS
964 John Bovey 1203 John Bovey
965 University of Kent, 1992, wrote the original Xvt. 1204 University of Kent, 1992, wrote the original Xvt.
966 1205
… …
980 1219
981 Geoff Wing <gcw@pobox.com> 1220 Geoff Wing <gcw@pobox.com>
982 Rewrote screen display and text selection routines. Project 1221 Rewrote screen display and text selection routines. Project
983 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1222 Coordinator (changes.txt 2.4.6 - rxvt-unicode)
984 1223
985 Marc Alexander Lehmann <rxvt@schmorp.de> 1224 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
986 Forked rxvt-unicode, rewrote most of the display code and internal 1225 Forked rxvt-unicode, rewrote most of the display code and internal
987 character handling to store text in unicode, improve xterm 1226 character handling to store text in unicode, improve xterm
988 compatibility and apply numerous other bugfixes and extensions. 1227 compatibility and apply numerous other bugfixes and extensions.
989 1228
990 Project Coordinator (Changes 1.0 -) 1229 Project Coordinator (Changes 1.0 -)

Diff Legend

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