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.1 by root, Tue Jan 11 02:24:59 2005 UTC vs.
Revision 1.30 by root, Mon Jan 2 19:36:07 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.8, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 6.2, 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
… …
118 Window foreground colour; resource foreground. 128 Window foreground colour; resource foreground.
119 129
120 -pixmap *file[;geom]* 130 -pixmap *file[;geom]*
121 Compile *XPM*: Specify XPM file for the background and also 131 Compile *XPM*: Specify XPM file for the background and also
122 optionally specify its scaling with a geometry string. Note you may 132 optionally specify its scaling with a geometry string. Note you may
123 need to add quotes to avoid special shell interpretation of the `;' 133 need to add quotes to avoid special shell interpretation of the ";"
124 in the command-line; resource backgroundPixmap. 134 in the command-line; resource backgroundPixmap.
125 135
126 -cr *colour* 136 -cr *colour*
127 The cursor colour; resource cursorColor. 137 The cursor colour; resource cursorColor.
128 138
… …
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 characters are to be printed. See resource boldItalicFont for
168 details. 178 details.
169 179
180 -is|+is
181 Compile font-styles: Bold/Italic font styles imply high intensity
182 foreground/background (default). See resource intensityStyles for
183 details.
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
173 not contain `.' or `*' characters. Also sets the icon and title 188 not contain `.' or `*' characters. Also sets the icon and title
174 name. 189 name.
… …
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
… …
257 on the command line. If this option is used, it must be the last on 272 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 273 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, 274 run the program specified by the SHELL environment variable or,
260 failing that, *sh(1)*. 275 failing that, *sh(1)*.
261 276
277 Please note that you must specify a program with arguments. If you
278 want to run shell commands, you have to specify the shell, like
279 this:
280
281 rxvt -e sh -c "shell commands"
282
262 -title *text* 283 -title *text*
263 Window title (-T still respected); the default title is the basename 284 Window title (-T still respected); the default title is the basename
264 of the program specified after the -e option, if any, otherwise the 285 of the program specified after the -e option, if any, otherwise the
265 application name; resource title. 286 application name; resource title.
266 287
… …
277 298
278 -im *text* 299 -im *text*
279 Compile *XIM*: input method name. resource inputMethod. 300 Compile *XIM*: input method name. resource inputMethod.
280 301
281 -imlocale *string* 302 -imlocale *string*
282 The locale to use for opening the IM. You can use an LC_CTYPE of 303 The locale to use for opening the IM. You can use an "LC_CTYPE" of
283 e.g. de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the 304 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for
284 input extension to be able to input japanese characters while 305 the input extension to be able to input japanese characters while
285 staying in another locale. 306 staying in another locale. resource imLocale.
307
308 -imfont *fontset*
309 Set the font set to use for the X Input Method, see resource imFont
310 for more info.
311
312 -tcw
313 Change the meaning of triple-click selection with the left mouse
314 button. Instead of selecting a full line it will extend the
315 selection the end of the logical line only. resource
316 tripleclickwords.
286 317
287 -insecure 318 -insecure
288 Enable "insecure" mode, which currently enables most of the escape 319 Enable "insecure" mode, which currently enables most of the escape
289 sequences that echo strings. See the resource insecure for more 320 sequences that echo strings. See the resource insecure for more
290 info. 321 info.
… …
299 330
300 -ssr|+ssr 331 -ssr|+ssr
301 Turn on/off secondary screen scroll (default enabled); resource 332 Turn on/off secondary screen scroll (default enabled); resource
302 secondaryScroll. 333 secondaryScroll.
303 334
304 -xrm *resourcestring* 335 -hold|+hold
305 No effect on rxvt-unicode. Simply passes through an argument to be 336 Turn on/off hold window after exit support. If enabled, rxvt will
306 made available in the instance's argument list. Appears in 337 not immediately destroy its window when the program executed within
307 *WM_COMMAND* in some window managers. 338 it exits. Instead, it will wait till it is being killed or closed by
339 the user; resource hold.
340
341 -keysym.*sym* *string*
342 Remap a key symbol. See resource keysym.
343
344 -embed *windowid*
345 Tells rxvt to embed it's windows into an already-existing window,
346 which enables applications to easily embed a terminal.
347
348 Right now, rxvt will first unmap/map the specified window, so it
349 shouldn't be a top-level window. rxvt will also reconfigure it quite
350 a bit, so don't expect it to keep some specific state. It's best to
351 create an extra subwindow for rxvt and leave it alone.
352
353 The window will not be destroyed when rxvt exits.
354
355 It might be useful to know that rxvt will not close file descriptors
356 passed to it (except for stdin/out/err, of course), so you can use
357 file descriptors to communicate with the programs within the
358 terminal. This works regardless of wether the "-embed" option was
359 used or not.
360
361 Here is a short Gtk2-perl snippet that illustrates how this option
362 can be used (a longer example is in doc/embed):
363
364 my $rxvt = new Gtk2::Socket;
365 $rxvt->signal_connect_after (realize => sub {
366 my $xid = $_[0]->window->get_xid;
367 system "rxvt -embed $xid &";
368 });
369
370 -pty-fd *fileno*
371 Tells rxvt NOT to execute any commands or create a new pty/tty pair
372 but instead use the given filehandle as the tty master. This is
373 useful if you want to drive rxvt as a generic terminal emulator
374 without having to run a program within it.
375
376 If this switch is given, rxvt will not create any utmp/wtmp entries
377 and will not tinker with pty/tty permissions - you have to do that
378 yourself if you want that.
379
380 Here is a example in perl that illustrates how this option can be
381 used (a longer example is in doc/pty-fd):
382
383 use IO::Pty;
384 use Fcntl;
385
386 my $pty = new IO::Pty;
387 fcntl $pty, F_SETFD, 0; # clear close-on-exec
388 system "rxvt -pty-fd " . (fileno $pty) . "&";
389 close $pty;
390
391 # now communicate with rxvt
392 my $slave = $pty->slave;
393 while (<$slave>) { print $slave "got <$_>\n" }
394
395 -perl *string*
396 Used by perl extension. See resource perl.
308 397
309RESOURCES (available also as long-options) 398RESOURCES (available also as long-options)
310 Note: `rxvt --help' gives a list of all resources (long options) 399 Note: `rxvt --help' gives a list of all resources (long options)
311 compiled into your version. 400 compiled into your version.
312 401
313 There are two different methods that rxvt can use to get the Xresource 402 There are two different methods that rxvt can use to get the Xresource
314 data: using the X libraries (Xrm*-functions) or internal Xresources 403 data: using the X libraries (Xrm*-functions) or internal Xresources
315 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists 404 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
316 XGetDefaults), you can set and change the resources using X11 tools like 405 XGetDefaults), you can set and change the resources using X11 tools like
317 xset. Many distribution do also load settings from the ~/.Xresources 406 xrdb. Many distribution do also load settings from the ~/.Xresources
318 file when X starts. 407 file when X starts. rxvt will consult the following files/resources in
408 order, with later settings overwriting earlier ones:
409
410 1. system-wide app-defaults file, either locale-dependent OR global
411 2. app-defaults file in $XAPPLRESDIR
412 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
413 4. SCREEN_RESOURCES for the current screen
414 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
319 415
320 If compiled with internal Xresources support (i.e. rxvt -h lists 416 If compiled with internal Xresources support (i.e. rxvt -h lists
321 .Xdefaults) then rxvt accepts application defaults set in 417 .Xdefaults) then rxvt accepts application defaults set in
322 XAPPLOADDIR/URxvt (compile-time defined: usually 418 XAPPLOADDIR/URxvt (compile-time defined: usually
323 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 419 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or
… …
359 455
360 colorBD: *colour* 456 colorBD: *colour*
361 colorIT: *colour* 457 colorIT: *colour*
362 Use the specified colour to display bold or italic characters when 458 Use the specified colour to display bold or italic characters when
363 the foreground colour is the default. If font styles are not 459 the foreground colour is the default. If font styles are not
364 available (Compile styles) and this option is unset, reverse video 460 available (Compile *styles*) and this option is unset, reverse video
365 is used instead. 461 is used instead.
366 462
367 colorUL: *colour* 463 colorUL: *colour*
368 Use the specified colour to display underlined characters when the 464 Use the specified colour to display underlined characters when the
369 foreground colour is the default. 465 foreground colour is the default.
… …
399 True: make the background inherit the parent windows' pixmap, giving 495 True: make the background inherit the parent windows' pixmap, giving
400 artificial transparency. False: do not inherit the parent windows' 496 artificial transparency. False: do not inherit the parent windows'
401 pixmap. 497 pixmap.
402 498
403 fading: *number* 499 fading: *number*
404 Fade the text by the given percentage when focus is lost. 500 Fade the text by the given percentage when focus is lost; option
501 -fade.
502
503 fadeColor: *colour*
504 Fade to this colour, when fading is used (see fading:). The default
505 colour is black; option -fadecolor.
405 506
406 tintColor: *colour* 507 tintColor: *colour*
407 Tint the transparent background pixmap with the given colour. 508 Tint the transparent background pixmap with the given colour; option
509 -tint.
408 510
409 shading: *number* 511 shading: *number*
410 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 512 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
411 image in addition to tinting it. 513 image in addition to tinting it.
412 514
413 scrollColor: *colour* 515 scrollColor: *colour*
414 Use the specified colour for the scrollbar [default #B2B2B2]. 516 Use the specified colour for the scrollbar [default #B2B2B2].
415 517
416 troughColor: *colour* 518 troughColor: *colour*
417 Use the specified colour for the scrollbar's trough area [default 519 Use the specified colour for the scrollbar's trough area [default
418 #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 520 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
419 521
420 borderColor: *colour* 522 borderColor: *colour*
421 The colour of the border around the text area and between the 523 The colour of the border around the text area and between the
422 scrollbar and the text. 524 scrollbar and the text.
423 525
… …
446 font: *fontlist* 548 font: *fontlist*
447 Select the fonts to be used. This is a comma separated list of font 549 Select the fonts to be used. This is a comma separated list of font
448 names that are used in turn when trying to display Unicode 550 names that are used in turn when trying to display Unicode
449 characters. The first font defines the cell size for characters; 551 characters. The first font defines the cell size for characters;
450 other fonts might be smaller, but not larger. A reasonable default 552 other fonts might be smaller, but not larger. A reasonable default
451 font list is always appended to it. option -fn. 553 font list is always appended to it; option -fn.
452 554
453 Each font can either be a standard X11 core font (XLFD) name, with 555 Each font can either be a standard X11 core font (XLFD) name, with
454 optional prefix "x:" or a Xft font (Compile xft), prefixed with 556 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
455 "xft:". 557 "xft:".
456 558
457 In addition, each font can be prefixed with additional hints and 559 In addition, each font can be prefixed with additional hints and
458 specifications enclosed in square brackets ("[]"). The only 560 specifications enclosed in square brackets ("[]"). The only
459 available hint currently is "codeset=codeset-name", and this is only 561 available hint currently is "codeset=codeset-name", and this is only
… …
502 tried. 604 tried.
503 605
504 If set, but empty, then this specific style is disabled and the 606 If set, but empty, then this specific style is disabled and the
505 normal text font will being used for the given style. 607 normal text font will being used for the given style.
506 608
609 intensityStyles: *boolean*
610 When font styles are not enabled, or this option is enabled (True,
611 option -is, the default), bold and italic font styles imply high
612 intensity foreground/backround colours. Disabling this option
613 (False, option +is) disables this behaviour, the high intensity
614 colours are not reachable.
615
507 selectstyle: *mode* 616 selectstyle: *mode*
508 Set mouse selection style to old which is 2.20, oldword which is 617 Set mouse selection style to old which is 2.20, oldword which is
509 xterm style with 2.20 old word selection, or anything else which 618 xterm style with 2.20 old word selection, or anything else which
510 gives xterm style selection. 619 gives xterm style selection.
511 620
512 scrollstyle: *mode* 621 scrollstyle: *mode*
513 Set scrollbar style to rxvt, plain, next or xterm. plain is the 622 Set scrollbar style to rxvt, plain, next or xterm. plain is the
514 author's favourite.. 623 author's favourite.
515 624
516 title: *string* 625 title: *string*
517 Set window title string, the default title is the command-line 626 Set window title string, the default title is the command-line
518 specified after the -e option, if any, otherwise the application 627 specified after the -e option, if any, otherwise the application
519 name; option -title. 628 name; option -title.
… …
544 print-pipe: *string* 653 print-pipe: *string*
545 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use 654 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use
546 Print to initiate a screen dump to the printer and Ctrl-Print or 655 Print to initiate a screen dump to the printer and Ctrl-Print or
547 Shift-Print to include the scrollback as well. 656 Shift-Print to include the scrollback as well.
548 657
658 The string will be interpreted as if typed into the shell as-is.
659
660 Example:
661
662 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
663
664 This creates a new file in your home directory with the screen
665 contents everytime you hit "Print".
666
549 scrollBar: *boolean* 667 scrollBar: *boolean*
550 True: enable the scrollbar [default]; option -sb. False: disable the 668 True: enable the scrollbar [default]; option -sb. False: disable the
551 scrollbar; option +sb. 669 scrollbar; option +sb.
552 670
553 scrollBar_right: *boolean* 671 scrollBar_right: *boolean*
… …
566 True: scroll to bottom when tty receives output; option -si. False: 684 True: scroll to bottom when tty receives output; option -si. False:
567 do not scroll to bottom when tty receives output; option +si. 685 do not scroll to bottom when tty receives output; option +si.
568 686
569 scrollWithBuffer: *boolean* 687 scrollWithBuffer: *boolean*
570 True: scroll with scrollback buffer when tty receives new lines (and 688 True: scroll with scrollback buffer when tty receives new lines (and
571 scrollTtyOutput is False); option +sw. False: do not scroll with 689 scrollTtyOutput is False); option -sw. False: do not scroll with
572 scrollback buffer when tty recieves new lines; option -sw. 690 scrollback buffer when tty recieves new lines; option +sw.
573 691
574 scrollTtyKeypress: *boolean* 692 scrollTtyKeypress: *boolean*
575 True: scroll to bottom when a non-special key is pressed. Special 693 True: scroll to bottom when a non-special key is pressed. Special
576 keys are those which are intercepted by rxvt-unicode for special 694 keys are those which are intercepted by rxvt-unicode for special
577 handling and are not passed onto the shell; option -sk. False: do 695 handling and are not passed onto the shell; option -sk. False: do
… …
629 pointerColor2: *colour* 747 pointerColor2: *colour*
630 Mouse pointer background colour. 748 Mouse pointer background colour.
631 749
632 pointerBlankDelay: *number* 750 pointerBlankDelay: *number*
633 Specifies number of seconds before blanking the pointer [default 2]. 751 Specifies number of seconds before blanking the pointer [default 2].
752 Use a large number (e.g. 987654321) to effectively disable the
753 timeout.
634 754
635 backspacekey: *string* 755 backspacekey: *string*
636 The string to send when the backspace key is pressed. If set to DEC 756 The string to send when the backspace key is pressed. If set to DEC
637 or unset it will send Delete (code 127) or, if shifted, Backspace 757 or unset it will send Delete (code 127) or, if shifted, Backspace
638 (code 8) - which can be reversed with the appropriate DEC private 758 (code 8) - which can be reversed with the appropriate DEC private
… …
654 774
655 inputMethod: *name* 775 inputMethod: *name*
656 *name* of inputMethod to use; option -im. 776 *name* of inputMethod to use; option -im.
657 777
658 imLocale: *name* 778 imLocale: *name*
659 The locale to use for opening the IM. You can use an LC_CTYPE of 779 The locale to use for opening the IM. You can use an "LC_CTYPE" of
660 e.g. de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the 780 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for
661 input extension to be able to input japanese characters while 781 the input extension to be able to input japanese characters while
662 staying in another locale. option -imlocale. 782 staying in another locale; option -imlocale.
783
784 imFont: *fontset*
785 Specify the font-set used for XIM styles "OverTheSpot" or
786 "OffTheSpot". It must be a standard X font set (XLFD patterns
787 separated by commas), i.e. it's not in the same format as the other
788 font lists used in rxvt. The default will be set-up to chose *any*
789 suitable found found, preferably one or two pixels differing in size
790 to the base font. option -imfont.
791
792 tripleclickwords: *boolean*
793 Change the meaning of triple-click selection with the left mouse
794 button. Instead of selecting a full line it will extend the
795 selection to the end of the logical line only; option -tcw.
663 796
664 insecure: *boolean* 797 insecure: *boolean*
665 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 798 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
666 that echo arbitrary strings like the icon name or the locale. This 799 that echo arbitrary strings like the icon name or the locale. This
667 could be abused if somebody gets 8-bit-clean access to your display, 800 could be abused if somebody gets 8-bit-clean access to your display,
668 whether throuh a mail client displaying mail bodies unfiltered or 801 whether through a mail client displaying mail bodies unfiltered or
669 though write(1). Therefore, these sequences are disabled by default. 802 through write(1) or any other means. Therefore, these sequences are
670 (Note that other terminals, including xterm, have these sequences 803 disabled by default. (Note that many other terminals, including
671 enabled by default). You can enable them by setting this boolean 804 xterm, have these sequences enabled by default, which doesn't make
672 resource or specifying -insecure as an option. At the moment, this 805 it safer, though).
673 enabled display-answer, locale, findfont, icon label and window 806
674 title requests as well as dynamic menubar dispatch. 807 You can enable them by setting this boolean resource or specifying
808 -insecure as an option. At the moment, this enables display-answer,
809 locale, findfont, icon label and window title requests as well as
810 dynamic menubar dispatch.
675 811
676 modifier: *modifier* 812 modifier: *modifier*
677 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 813 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
678 super, mod1, mod2, mod3, mod4, mod5; option -mod. 814 super, mod1, mod2, mod3, mod4, mod5; option -mod.
679 815
… …
689 Turn on/off secondary screen scroll (default enabled). If the this 825 Turn on/off secondary screen scroll (default enabled). If the this
690 option is enabled, scrolls on the secondary screen will change the 826 option is enabled, scrolls on the secondary screen will change the
691 scrollback buffer and switching to/from the secondary screen will 827 scrollback buffer and switching to/from the secondary screen will
692 instead scroll the screen up. 828 instead scroll the screen up.
693 829
830 hold: *bool*
831 Turn on/off hold window after exit support. If enabled, rxvt will
832 not immediately destroy its window when the program executed within
833 it exits. Instead, it will wait till it is being killed or closed by
834 the user.
835
694 keysym.*sym*: *string* 836 keysym.*sym*: *string*
695 Associate *string* with keysym *sym* (0xFF00 - 0xFFFF). It may 837 Compile *frills*: Associate *string* with keysym *sym*. The
696 contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:
697 newline, \r: return, \t: tab, \000: octal number) or control
698 characters (^?: delete, ^@: null, ^A ...) and may enclosed with
699 double quotes so that it can start or end with whitespace. The
700 intervening resource name keysym. cannot be omitted. This resource 838 intervening resource name keysym. cannot be omitted.
701 is only available when compiled with KEYSYM_RESOURCE. 839
840 The format of *sym* is "*(modifiers-)key*", where *modifiers* can be
841 any combination of ISOLevel3, AppKeypad, Control, NumLock, Shift,
842 Meta, Lock, Mod1, Mod2, Mod3, Mod4, Mod5, and the abbreviated I, K,
843 C, N, S, M, A, L, 1, 2, 3, 4, 5.
844
845 The NumLock, Meta and ISOLevel3 modifiers are usually aliased to
846 whatever modifier the NumLock key, Meta/Alt keys or ISO Level3
847 Shift/AltGr keys are being mapped. AppKeypad is a synthetic modifier
848 mapped to the current application keymap mode state.
849
850 The spellings of *key* can be obtained by using xev(1) command or
851 searching keysym macros from /usr/X11R6/include/X11/keysymdef.h and
852 omitting the prefix XK_. Alternatively you can specify *key* by its
853 hex keysym value (0x0000 - 0xFFFF). Note that the lookup of *sym*s
854 is not performed in an exact manner; however, the closest match is
855 assured.
856
857 *string* may contain escape values ("\a": bell, "\b": backspace,
858 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
859 "\000": octal number) or verbatim control characters ("^?": delete,
860 "^@": null, "^A" ...) and may be enclosed with double quotes so that
861 it can start or end with whitespace.
862
863 Please note that you need to double the "\" when using
864 "--enable-xgetdefault", as X itself does it's own de-escaping (you
865 can use "\033" instead of "\e" (and so on), which will work with
866 both Xt and rxvt's own processing).
867
868 You can define a range of keysyms in one shot by providing a
869 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
870 `/' should be a character not used by the strings.
871
872 Its usage can be demonstrated by an example:
873
874 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
875
876 The above line is equivalent to the following three lines:
877
878 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
879 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
880 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
881
882 If *string* takes the form of "command:STRING", the specified STRING
883 is interpreted and executed as rxvt's control sequence. For example
884 the following means "change the current locale to "zh_CN.GBK" when
885 Control-Meta-c is being pressed":
886
887 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
888
889 Due the the large number of modifier combinations, a defined key
890 mapping will match if at *at least* the specified identifiers are
891 being set, and no other key mappings with those and more bits are
892 being defined. That means that defining a key map for "a" will
893 automatically provide definitions for "Meta-a", "Shift-a" and so on,
894 unless some of those are defined mappings themselves.
895
896 Unfortunately, this will override built-in key mappings. For example
897 if you overwrite the "Insert" key you will disable rxvt's
898 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
899 the user-defined keymap using the "builtin:" replacement:
900
901 URxvt.keysym.Insert: <my insert key sequence>
902 URxvt.keysym.S-Insert: builtin:
903
904 The first line defines a mapping for "Insert" and *any* combination
905 of modifiers. The second line re-establishes the default mapping for
906 "Shift-Insert".
907
908 The following example will map Control-Meta-1 and Control-Meta-2 to
909 the fonts "suxuseuro" and "9x15bold", so you can have some limited
910 font-switching at runtime:
911
912 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
913 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
914
915 Other things are possible, e.g. resizing (see rxvt(7) for more
916 info):
917
918 URxvt.keysym.M-C-3: command:\033[8;25;80t
919 URxvt.keysym.M-C-4: command:\033[8;48;110t
920
921 perl: *string*
922 Used by perl extension and is free for any use, as it is not
923 interpreted by rxvt-unicode itself; option perl.
924
925 perl-eval: *string*
926 Perl code to be evaluated when all extensions have been loaded. See
927 the rxvtperl(3) manpage.
928
929 perl-lib: *path*
930 Additional directory that holds extension scripts that are loaded
931 and enabled for this terminal instance, in addition to scripts
932 stored in /opt/rxvt/lib/urxvt/perl-ext/, which are global to all
933 terminal instances.
934
935 See the rxvtperl(3) manpage.
702 936
703THE SCROLLBAR 937THE SCROLLBAR
704 Lines of text that scroll off the top of the rxvt window (resource: 938 Lines of text that scroll off the top of the rxvt window (resource:
705 saveLines) and can be scrolled back using the scrollbar or by 939 saveLines) and can be scrolled back using the scrollbar or by
706 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 940 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
… …
716 normal text selection/insertion, hold either the Shift or the Meta (Alt) 950 normal text selection/insertion, hold either the Shift or the Meta (Alt)
717 key while performing the desired mouse action. 951 key while performing the desired mouse action.
718 952
719 If mouse reporting mode is active, the normal scrollbar actions are 953 If mouse reporting mode is active, the normal scrollbar actions are
720 disabled -- on the assumption that we are using a fullscreen 954 disabled -- on the assumption that we are using a fullscreen
721 application. Instead, pressing Button1 and Button3 sends ESC[6~ (Next) 955 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
722 and ESC[5~ (Prior), respectively. Similarly, clicking on the up and down 956 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
723 arrows sends ESC[A (Up) and ESC[B (Down), respectively. 957 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
724 958
725TEXT SELECTION AND INSERTION 959TEXT SELECTION AND INSERTION
726 The behaviour of text selection and insertion mechanism is similar to 960 The behaviour of text selection and insertion mechanism is similar to
727 *xterm*(1). 961 *xterm*(1).
728 962
729 Selection: 963 Selection:
730 Left click at the beginning of the region, drag to the end of the 964 Left click at the beginning of the region, drag to the end of the
731 region and release; Right click to extend the marked region; Left 965 region and release; Right click to extend the marked region; Left
732 double-click to select a word; Left triple-click to select the 966 double-click to select a word; Left triple-click to select the
733 entire line. 967 entire logical line (which can span multiple screen lines), unless
968 modified by resource tripleclickwords.
734 969
735 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 970 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
736 (Compile: frills) will create a rectangular selection instead of a 971 (Compile: *frills*) will create a rectangular selection instead of a
737 normal one. 972 normal one. In this mode, every selected row becomes its own line in
973 the selection, and trailing whitespace is visually underlined and
974 removed from the selection.
738 975
739 Insertion: 976 Insertion:
740 Pressing and releasing the Middle mouse button (or Shift-Insert) in 977 Pressing and releasing the Middle mouse button (or Shift-Insert) in
741 an rxvt window causes the current text selection to be inserted as 978 an rxvt window causes the current text selection to be inserted as
742 if it had been typed on the keyboard. 979 if it had been typed on the keyboard.
… …
746 supported in rxvt-unicode. Bug me if you need this. 983 supported in rxvt-unicode. Bug me if you need this.
747 984
748 You can, however, switch fonts at runtime using escape sequences (and 985 You can, however, switch fonts at runtime using escape sequences (and
749 therefore using the menubar), e.g.: 986 therefore using the menubar), e.g.:
750 987
751 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 988 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
752 989
753 rxvt-unicode will automatically re-apply these fonts to the output so 990 rxvt-unicode will automatically re-apply these fonts to the output so
754 far. 991 far.
755 992
756ISO 14755 SUPPORT 993ISO 14755 SUPPORT
… …
758 character codes using the keyboard. It consists of 4 parts. The first 995 character codes using the keyboard. It consists of 4 parts. The first
759 part is available rxvt-unicode has been compiled with "--enable-frills", 996 part is available rxvt-unicode has been compiled with "--enable-frills",
760 the rest is available when rxvt-unicode was compiled with 997 the rest is available when rxvt-unicode was compiled with
761 "--enable-iso14755". 998 "--enable-iso14755".
762 999
763 5.1: Basic method 1000 * 5.1: Basic method
764 This allows you to enter unicode characters using their hexcode. 1001 This allows you to enter unicode characters using their hexcode.
765 1002
766 Start by pressing and holding both "Control" and "Shift", then enter 1003 Start by pressing and holding both "Control" and "Shift", then enter
767 hex-digits (between one and six). Releasing "Control" and "Shift" 1004 hex-digits (between one and six). Releasing "Control" and "Shift"
768 will commit the character as if it were typed directly. While 1005 will commit the character as if it were typed directly. While
… …
774 address, which you cannot type. Fortunately, the card has the e-mail 1011 address, which you cannot type. Fortunately, the card has the e-mail
775 address printed as hexcodes, e.g. "671d 65e5". You can enter this 1012 address printed as hexcodes, e.g. "671d 65e5". You can enter this
776 easily by pressing "Control" and "Shift", followed by 1013 easily by pressing "Control" and "Shift", followed by
777 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys. 1014 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys.
778 1015
779 5.2: Keyboard symbols entry method 1016 * 5.2: Keyboard symbols entry method
780 This mode lets you input characters representing the keycap symbols 1017 This mode lets you input characters representing the keycap symbols
781 of your keyboard, if representable in the current locale encoding. 1018 of your keyboard, if representable in the current locale encoding.
782 1019
783 Start by pressing "Control" and "Shift" together, then releasing 1020 Start by pressing "Control" and "Shift" together, then releasing
784 them. The next special key (cursor keys, home etc.) you enter will 1021 them. The next special key (cursor keys, home etc.) you enter will
… …
786 corresponding keycap symbol. The symbol will only be entered when 1023 corresponding keycap symbol. The symbol will only be entered when
787 the key has been released, otherwise pressing e.g. "Shift" would 1024 the key has been released, otherwise pressing e.g. "Shift" would
788 enter the symbol for "ISO Level 2 Switch", although your intention 1025 enter the symbol for "ISO Level 2 Switch", although your intention
789 might have been to enter a reverse tab (Shift-Tab). 1026 might have been to enter a reverse tab (Shift-Tab).
790 1027
791 5.3: Screen-selection entry method 1028 * 5.3: Screen-selection entry method
792 While this is implemented already (it's basically the selection 1029 While this is implemented already (it's basically the selection
793 mechanism), it could be extended by displaying a unicode character 1030 mechanism), it could be extended by displaying a unicode character
794 map. 1031 map.
795 1032
796 5.4: Feedback method for identifying displayed characters for later 1033 * 5.4: Feedback method for identifying displayed characters for later
797 input 1034 input
798 This method lets you display the unicode character code associated 1035 This method lets you display the unicode character code associated
799 with characters already displayed. 1036 with characters already displayed.
800 1037
801 You enter this mode by holding down "Control" and "Shift" together, 1038 You enter this mode by holding down "Control" and "Shift" together,
… …
813 both scenario A and B of ISO 14755, including part 5.2. 1050 both scenario A and B of ISO 14755, including part 5.2.
814 1051
815LOGIN STAMP 1052LOGIN STAMP
816 rxvt tries to write an entry into the *utmp*(5) file so that it can be 1053 rxvt tries to write an entry into the *utmp*(5) file so that it can be
817 seen via the *who(1)* command, and can accept messages. To allow this 1054 seen via the *who(1)* command, and can accept messages. To allow this
818 feature, rxvt must be installed setuid root on some systems. 1055 feature, rxvt may need to be installed setuid root on some systems or
1056 setgid to root or to some other group on others.
819 1057
820COLORS AND GRAPHICS 1058COLORS AND GRAPHICS
821 In addition to the default foreground and background colours, rxvt can 1059 In addition to the default foreground and background colours, rxvt can
822 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 1060 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
823 versions of the same). Here is a list of the colours with their rgb.txt 1061 versions of the same). Here is a list of the colours with their rgb.txt
… …
855 rxvt -fg Black -bg White -rv 1093 rxvt -fg Black -bg White -rv
856 would yield White on Black, while on *xterm*(1) it would yield Black 1094 would yield White on Black, while on *xterm*(1) it would yield Black
857 on White. 1095 on White.
858 1096
859ENVIRONMENT 1097ENVIRONMENT
860 rxvt sets the environment variables TERM, COLORTERM and COLORFGBG. The 1098 rxvt sets and/or uses the following environment variables:
861 environment variable WINDOWID is set to the X window id number of the 1099
862 rxvt window and it also uses and sets the environment variable DISPLAY 1100 TERM
863 to specify which display terminal to use. rxvt uses the environment 1101 Normally set to "rxvt-unicode", unless overwritten at configure
864 variables RXVTPATH and PATH to find XPM files. 1102 time, via resources or on the commandline.
1103
1104 COLORTERM
1105 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled
1106 with XPM support, and optionally with the added extension "-mono" to
1107 indicate that rxvt-unicode runs on a monochrome screen.
1108
1109 COLORFGBG
1110 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1111 the colour code used as default foreground/text colour (or the
1112 string "default" to indicate that the default-colour escape sequence
1113 is to be used), "bg" is the colour code used as default background
1114 colour (or the string "default"), and "xpm" is the string "default"
1115 if rxvt was compiled with XPM support. Libraries like "ncurses" and
1116 "slang" can (and do) use this information to optimize screen output.
1117
1118 WINDOWID
1119 Set to the (decimal) X Window ID of the rxvt window (the toplevel
1120 window, which usually has subwindows for the scrollbar, the terminal
1121 window and so on).
1122
1123 TERMINFO
1124 Set to the terminfo directory iff rxvt was configured with
1125 "--with-terminfo=PATH".
1126
1127 DISPLAY
1128 Used by rxvt to connect to the display and set to the correct
1129 display in it's child processes.
1130
1131 SHELL
1132 The shell to be used for command execution, defaults to "/bin/sh".
1133
1134 RXVTPATH
1135 The path where rxvt looks for support files such as menu and xpm
1136 files.
1137
1138 PATH
1139 Used in the same way as "RXVTPATH".
1140
1141 RXVT_SOCKET
1142 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1143
1144 Default $HOME/.rxvt-unicode-*<nodename*.
1145
1146 HOME
1147 Used to locate the default directory for the unix domain socket for
1148 daemon communications and to locate various resource files (such as
1149 ".Xdefaults")
1150
1151 XAPPLRESDIR
1152 Directory where various X resource files are being located.
1153
1154 XENVIRONMENT
1155 If set and accessible, gives the name of a X resource file to be
1156 loaded by rxvt.
865 1157
866FILES 1158FILES
867 /etc/utmp
868 System file for login records.
869
870 /usr/lib/X11/rgb.txt 1159 /usr/lib/X11/rgb.txt
871 Color names. 1160 Color names.
872 1161
873SEE ALSO 1162SEE ALSO
874 rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1163 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
875 1164 tty(4), utmp(5)
876BUGS
877 Check the BUGS file for an up-to-date list.
878
879 Cursor change support is not yet implemented.
880
881 Click-and-drag doesn't work with X11 mouse report overriding.
882 1165
883CURRENT PROJECT COORDINATOR 1166CURRENT PROJECT COORDINATOR
884 Project Coordinator 1167 Project Coordinator
885 Marc A. Lehmann rxvt@schmorp.de 1168 Marc A. Lehmann <rxvt-unicode@schmorp.de>
886 1169
887 Web page maintainter
888 Marc A. Lehmann rxvt@schmorp.de
889
890 <http://software.schmorp.de/> 1170 <http://software.schmorp.de/#rxvt-unicode>
891 1171
892AUTHORS 1172AUTHORS
893 John Bovey 1173 John Bovey
894 University of Kent, 1992, wrote the original Xvt. 1174 University of Kent, 1992, wrote the original Xvt.
895 1175
… …
909 1189
910 Geoff Wing <gcw@pobox.com> 1190 Geoff Wing <gcw@pobox.com>
911 Rewrote screen display and text selection routines. Project 1191 Rewrote screen display and text selection routines. Project
912 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1192 Coordinator (changes.txt 2.4.6 - rxvt-unicode)
913 1193
914 Marc Alexander Lehmann <rxvt@schmorp.de> 1194 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
915 Forked rxvt-unicode, rewrote most of the display code and internal 1195 Forked rxvt-unicode, rewrote most of the display code and internal
916 character handling to store text in unicode, improve xterm 1196 character handling to store text in unicode, improve xterm
917 compatibility and apply numerous other bugfixes and extensions. 1197 compatibility and apply numerous other bugfixes and extensions.
918 1198
919 Project Coordinator (Changes 1.0 -) 1199 Project Coordinator (Changes 1.0 -)

Diff Legend

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