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.2 by root, Sun Jan 16 15:59:45 2005 UTC vs.
Revision 1.29 by root, Mon Jan 2 15:11:05 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" }
308 394
309RESOURCES (available also as long-options) 395RESOURCES (available also as long-options)
310 Note: `rxvt --help' gives a list of all resources (long options) 396 Note: `rxvt --help' gives a list of all resources (long options)
311 compiled into your version. 397 compiled into your version.
312 398
313 There are two different methods that rxvt can use to get the Xresource 399 There are two different methods that rxvt can use to get the Xresource
314 data: using the X libraries (Xrm*-functions) or internal Xresources 400 data: using the X libraries (Xrm*-functions) or internal Xresources
315 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists 401 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
316 XGetDefaults), you can set and change the resources using X11 tools like 402 XGetDefaults), you can set and change the resources using X11 tools like
317 xset. Many distribution do also load settings from the ~/.Xresources 403 xrdb. Many distribution do also load settings from the ~/.Xresources
318 file when X starts. 404 file when X starts. rxvt will consult the following files/resources in
405 order, with later settings overwriting earlier ones:
406
407 1. system-wide app-defaults file, either locale-dependent OR global
408 2. app-defaults file in $XAPPLRESDIR
409 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
410 4. SCREEN_RESOURCES for the current screen
411 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
319 412
320 If compiled with internal Xresources support (i.e. rxvt -h lists 413 If compiled with internal Xresources support (i.e. rxvt -h lists
321 .Xdefaults) then rxvt accepts application defaults set in 414 .Xdefaults) then rxvt accepts application defaults set in
322 XAPPLOADDIR/URxvt (compile-time defined: usually 415 XAPPLOADDIR/URxvt (compile-time defined: usually
323 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 416 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or
… …
359 452
360 colorBD: *colour* 453 colorBD: *colour*
361 colorIT: *colour* 454 colorIT: *colour*
362 Use the specified colour to display bold or italic characters when 455 Use the specified colour to display bold or italic characters when
363 the foreground colour is the default. If font styles are not 456 the foreground colour is the default. If font styles are not
364 available (Compile styles) and this option is unset, reverse video 457 available (Compile *styles*) and this option is unset, reverse video
365 is used instead. 458 is used instead.
366 459
367 colorUL: *colour* 460 colorUL: *colour*
368 Use the specified colour to display underlined characters when the 461 Use the specified colour to display underlined characters when the
369 foreground colour is the default. 462 foreground colour is the default.
… …
399 True: make the background inherit the parent windows' pixmap, giving 492 True: make the background inherit the parent windows' pixmap, giving
400 artificial transparency. False: do not inherit the parent windows' 493 artificial transparency. False: do not inherit the parent windows'
401 pixmap. 494 pixmap.
402 495
403 fading: *number* 496 fading: *number*
404 Fade the text by the given percentage when focus is lost. 497 Fade the text by the given percentage when focus is lost; option
498 -fade.
499
500 fadeColor: *colour*
501 Fade to this colour, when fading is used (see fading:). The default
502 colour is black; option -fadecolor.
405 503
406 tintColor: *colour* 504 tintColor: *colour*
407 Tint the transparent background pixmap with the given colour. 505 Tint the transparent background pixmap with the given colour; option
506 -tint.
408 507
409 shading: *number* 508 shading: *number*
410 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 509 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
411 image in addition to tinting it. 510 image in addition to tinting it.
412 511
413 scrollColor: *colour* 512 scrollColor: *colour*
414 Use the specified colour for the scrollbar [default #B2B2B2]. 513 Use the specified colour for the scrollbar [default #B2B2B2].
415 514
416 troughColor: *colour* 515 troughColor: *colour*
417 Use the specified colour for the scrollbar's trough area [default 516 Use the specified colour for the scrollbar's trough area [default
418 #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 517 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
419 518
420 borderColor: *colour* 519 borderColor: *colour*
421 The colour of the border around the text area and between the 520 The colour of the border around the text area and between the
422 scrollbar and the text. 521 scrollbar and the text.
423 522
… …
449 characters. The first font defines the cell size for characters; 548 characters. The first font defines the cell size for characters;
450 other fonts might be smaller, but not larger. A reasonable default 549 other fonts might be smaller, but not larger. A reasonable default
451 font list is always appended to it. option -fn. 550 font list is always appended to it. option -fn.
452 551
453 Each font can either be a standard X11 core font (XLFD) name, with 552 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 553 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
455 "xft:". 554 "xft:".
456 555
457 In addition, each font can be prefixed with additional hints and 556 In addition, each font can be prefixed with additional hints and
458 specifications enclosed in square brackets ("[]"). The only 557 specifications enclosed in square brackets ("[]"). The only
459 available hint currently is "codeset=codeset-name", and this is only 558 available hint currently is "codeset=codeset-name", and this is only
… …
502 tried. 601 tried.
503 602
504 If set, but empty, then this specific style is disabled and the 603 If set, but empty, then this specific style is disabled and the
505 normal text font will being used for the given style. 604 normal text font will being used for the given style.
506 605
606 intensityStyles: *boolean*
607 When font styles are not enabled, or this option is enabled (True,
608 option -is, the default), bold and italic font styles imply high
609 intensity foreground/backround colours. Disabling this option
610 (False, option +is) disables this behaviour, the high intensity
611 colours are not reachable.
612
507 selectstyle: *mode* 613 selectstyle: *mode*
508 Set mouse selection style to old which is 2.20, oldword which is 614 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 615 xterm style with 2.20 old word selection, or anything else which
510 gives xterm style selection. 616 gives xterm style selection.
511 617
512 scrollstyle: *mode* 618 scrollstyle: *mode*
513 Set scrollbar style to rxvt, plain, next or xterm. plain is the 619 Set scrollbar style to rxvt, plain, next or xterm. plain is the
514 author's favourite.. 620 author's favourite.
515 621
516 title: *string* 622 title: *string*
517 Set window title string, the default title is the command-line 623 Set window title string, the default title is the command-line
518 specified after the -e option, if any, otherwise the application 624 specified after the -e option, if any, otherwise the application
519 name; option -title. 625 name; option -title.
… …
544 print-pipe: *string* 650 print-pipe: *string*
545 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use 651 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 652 Print to initiate a screen dump to the printer and Ctrl-Print or
547 Shift-Print to include the scrollback as well. 653 Shift-Print to include the scrollback as well.
548 654
655 The string will be interpreted as if typed into the shell as-is.
656
657 Example:
658
659 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
660
661 This creates a new file in your home directory with the screen
662 contents everytime you hit "Print".
663
549 scrollBar: *boolean* 664 scrollBar: *boolean*
550 True: enable the scrollbar [default]; option -sb. False: disable the 665 True: enable the scrollbar [default]; option -sb. False: disable the
551 scrollbar; option +sb. 666 scrollbar; option +sb.
552 667
553 scrollBar_right: *boolean* 668 scrollBar_right: *boolean*
… …
566 True: scroll to bottom when tty receives output; option -si. False: 681 True: scroll to bottom when tty receives output; option -si. False:
567 do not scroll to bottom when tty receives output; option +si. 682 do not scroll to bottom when tty receives output; option +si.
568 683
569 scrollWithBuffer: *boolean* 684 scrollWithBuffer: *boolean*
570 True: scroll with scrollback buffer when tty receives new lines (and 685 True: scroll with scrollback buffer when tty receives new lines (and
571 scrollTtyOutput is False); option +sw. False: do not scroll with 686 scrollTtyOutput is False); option -sw. False: do not scroll with
572 scrollback buffer when tty recieves new lines; option -sw. 687 scrollback buffer when tty recieves new lines; option +sw.
573 688
574 scrollTtyKeypress: *boolean* 689 scrollTtyKeypress: *boolean*
575 True: scroll to bottom when a non-special key is pressed. Special 690 True: scroll to bottom when a non-special key is pressed. Special
576 keys are those which are intercepted by rxvt-unicode for special 691 keys are those which are intercepted by rxvt-unicode for special
577 handling and are not passed onto the shell; option -sk. False: do 692 handling and are not passed onto the shell; option -sk. False: do
… …
629 pointerColor2: *colour* 744 pointerColor2: *colour*
630 Mouse pointer background colour. 745 Mouse pointer background colour.
631 746
632 pointerBlankDelay: *number* 747 pointerBlankDelay: *number*
633 Specifies number of seconds before blanking the pointer [default 2]. 748 Specifies number of seconds before blanking the pointer [default 2].
749 Use a large number (e.g. 987654321) to effectively disable the
750 timeout.
634 751
635 backspacekey: *string* 752 backspacekey: *string*
636 The string to send when the backspace key is pressed. If set to DEC 753 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 754 or unset it will send Delete (code 127) or, if shifted, Backspace
638 (code 8) - which can be reversed with the appropriate DEC private 755 (code 8) - which can be reversed with the appropriate DEC private
… …
654 771
655 inputMethod: *name* 772 inputMethod: *name*
656 *name* of inputMethod to use; option -im. 773 *name* of inputMethod to use; option -im.
657 774
658 imLocale: *name* 775 imLocale: *name*
659 The locale to use for opening the IM. You can use an LC_CTYPE of 776 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 777 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 778 the input extension to be able to input japanese characters while
662 staying in another locale. option -imlocale. 779 staying in another locale. option -imlocale.
780
781 imFont: *fontset*
782 Specify the font-set used for XIM styles "OverTheSpot" or
783 "OffTheSpot". It must be a standard X font set (XLFD patterns
784 separated by commas), i.e. it's not in the same format as the other
785 font lists used in rxvt. The default will be set-up to chose *any*
786 suitable found found, preferably one or two pixels differing in size
787 to the base font. option -imfont.
788
789 tripleclickwords: *boolean*
790 Change the meaning of triple-click selection with the left mouse
791 button. Instead of selecting a full line it will extend the
792 selection to the end of the logical line only. option -tcw.
663 793
664 insecure: *boolean* 794 insecure: *boolean*
665 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 795 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
666 that echo arbitrary strings like the icon name or the locale. This 796 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, 797 could be abused if somebody gets 8-bit-clean access to your display,
668 whether throuh a mail client displaying mail bodies unfiltered or 798 whether through a mail client displaying mail bodies unfiltered or
669 though write(1). Therefore, these sequences are disabled by default. 799 through write(1) or any other means. Therefore, these sequences are
670 (Note that other terminals, including xterm, have these sequences 800 disabled by default. (Note that many other terminals, including
671 enabled by default). You can enable them by setting this boolean 801 xterm, have these sequences enabled by default, which doesn't make
672 resource or specifying -insecure as an option. At the moment, this 802 it safer, though).
673 enabled display-answer, locale, findfont, icon label and window 803
674 title requests as well as dynamic menubar dispatch. 804 You can enable them by setting this boolean resource or specifying
805 -insecure as an option. At the moment, this enables display-answer,
806 locale, findfont, icon label and window title requests as well as
807 dynamic menubar dispatch.
675 808
676 modifier: *modifier* 809 modifier: *modifier*
677 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 810 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
678 super, mod1, mod2, mod3, mod4, mod5; option -mod. 811 super, mod1, mod2, mod3, mod4, mod5; option -mod.
679 812
… …
689 Turn on/off secondary screen scroll (default enabled). If the this 822 Turn on/off secondary screen scroll (default enabled). If the this
690 option is enabled, scrolls on the secondary screen will change the 823 option is enabled, scrolls on the secondary screen will change the
691 scrollback buffer and switching to/from the secondary screen will 824 scrollback buffer and switching to/from the secondary screen will
692 instead scroll the screen up. 825 instead scroll the screen up.
693 826
827 hold: *bool*
828 Turn on/off hold window after exit support. If enabled, rxvt will
829 not immediately destroy its window when the program executed within
830 it exits. Instead, it will wait till it is being killed or closed by
831 the user.
832
694 keysym.*sym*: *string* 833 keysym.*sym*: *string*
695 Associate *string* with keysym *sym*. The intervening resource name 834 Compile *frills*: Associate *string* with keysym *sym*. The
696 keysym. cannot be omitted. This resource is only available when 835 intervening resource name keysym. cannot be omitted.
697 compiled with KEYSYM_RESOURCE.
698 836
699 The format of *sym* is "*(mask-)key*", where *mask* can be any 837 The format of *sym* is "*(modifiers-)key*", where *modifiers* can be
700 combination of Control, NumLock, Shift, Meta, Lock, Mod1, Mod2, 838 any combination of ISOLevel3, AppKeypad, Control, NumLock, Shift,
701 Mod3, Mod4, Mod5, and the abbreviated C, N, S, M, A, L, 1, 2, 3, 4, 839 Meta, Lock, Mod1, Mod2, Mod3, Mod4, Mod5, and the abbreviated I, K,
840 C, N, S, M, A, L, 1, 2, 3, 4, 5.
841
842 The NumLock, Meta and ISOLevel3 modifiers are usually aliased to
843 whatever modifier the NumLock key, Meta/Alt keys or ISO Level3
844 Shift/AltGr keys are being mapped. AppKeypad is a synthetic modifier
845 mapped to the current application keymap mode state.
846
702 5. The spellings of *key* can be obtained by using xev(1) command or 847 The spellings of *key* can be obtained by using xev(1) command or
703 searching keysym macros from /usr/X11R6/include/X11/keysymdef.h and 848 searching keysym macros from /usr/X11R6/include/X11/keysymdef.h and
704 omit the prefix XK_. Alternatively you can specify *key* by its hex 849 omitting the prefix XK_. Alternatively you can specify *key* by its
705 keysym value (0x0000 - 0xFFFF). Note that the lookup of *sym*s is 850 hex keysym value (0x0000 - 0xFFFF). Note that the lookup of *sym*s
706 not performed in an exact manner; however, the closest match is 851 is not performed in an exact manner; however, the closest match is
707 assured. 852 assured.
708 853
709 *string* may contain escape values (\a: bell, \b: backspace, \e, \E: 854 *string* may contain escape values ("\a": bell, "\b": backspace,
710 escape, \n: newline, \r: return, \t: tab, \000: octal number) or 855 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
711 control characters (^?: delete, ^@: null, ^A ...) and may enclosed 856 "\000": octal number) or verbatim control characters ("^?": delete,
857 "^@": null, "^A" ...) and may be enclosed with double quotes so that
712 with double quotes so that it can start or end with whitespace. 858 it can start or end with whitespace.
859
860 Please note that you need to double the "\" when using
861 "--enable-xgetdefault", as X itself does it's own de-escaping (you
862 can use "\033" instead of "\e" (and so on), which will work with
863 both Xt and rxvt's own processing).
713 864
714 You can define a range of keysyms in one shot by providing a 865 You can define a range of keysyms in one shot by providing a
715 *string* with pattern list/STRING1/STRING2/STRING3, where the 866 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
716 delimeter `/' should be a character not used by the STRINGs. 867 `/' should be a character not used by the strings.
717 868
718 Its usage can be demonstrated by an example: URxvt.keysym.M-C-0x61: 869 Its usage can be demonstrated by an example:
719 list.abc.\e<M-C-.> 870
871 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
720 872
721 The above line is equivalent to the following three lines: 873 The above line is equivalent to the following three lines:
874
722 URxvt.keysym.Meta-Control-0x61: \e<M-C-a> 875 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
723 URxvt.keysym.Meta-Control-0x62: \e<M-C-b> 876 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
724 URxvt.keysym.Meta-Control-0x63: \e<M-C-c> 877 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
725 878
726 If *string* takes the form of proto:STRING, the specified STRING is 879 If *string* takes the form of "command:STRING", the specified STRING
727 interpreted and executed as rxvt's control sequence. For example, 880 is interpreted and executed as rxvt's control sequence. For example
728 "proto:\033]701;zh_CN.GBK\007" means changing the current locale to 881 the following means "change the current locale to "zh_CN.GBK" when
729 zh_CN.GBK. 882 Control-Meta-c is being pressed":
883
884 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
885
886 Due the the large number of modifier combinations, a defined key
887 mapping will match if at *at least* the specified identifiers are
888 being set, and no other key mappings with those and more bits are
889 being defined. That means that defining a key map for "a" will
890 automatically provide definitions for "Meta-a", "Shift-a" and so on,
891 unless some of those are defined mappings themselves.
892
893 Unfortunately, this will override built-in key mappings. For example
894 if you overwrite the "Insert" key you will disable rxvt's
895 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
896 the user-defined keymap using the "builtin:" replacement:
897
898 URxvt.keysym.Insert: <my insert key sequence>
899 URxvt.keysym.S-Insert: builtin:
900
901 The first line defines a mapping for "Insert" and *any* combination
902 of modifiers. The second line re-establishes the default mapping for
903 "Shift-Insert".
904
905 The following example will map Control-Meta-1 and Control-Meta-2 to
906 the fonts "suxuseuro" and "9x15bold", so you can have some limited
907 font-switching at runtime:
908
909 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
910 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
911
912 Other things are possible, e.g. resizing (see rxvt(7) for more
913 info):
914
915 URxvt.keysym.M-C-3: command:\033[8;25;80t
916 URxvt.keysym.M-C-4: command:\033[8;48;110t
730 917
731THE SCROLLBAR 918THE SCROLLBAR
732 Lines of text that scroll off the top of the rxvt window (resource: 919 Lines of text that scroll off the top of the rxvt window (resource:
733 saveLines) and can be scrolled back using the scrollbar or by 920 saveLines) and can be scrolled back using the scrollbar or by
734 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 921 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
… …
744 normal text selection/insertion, hold either the Shift or the Meta (Alt) 931 normal text selection/insertion, hold either the Shift or the Meta (Alt)
745 key while performing the desired mouse action. 932 key while performing the desired mouse action.
746 933
747 If mouse reporting mode is active, the normal scrollbar actions are 934 If mouse reporting mode is active, the normal scrollbar actions are
748 disabled -- on the assumption that we are using a fullscreen 935 disabled -- on the assumption that we are using a fullscreen
749 application. Instead, pressing Button1 and Button3 sends ESC[6~ (Next) 936 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
750 and ESC[5~ (Prior), respectively. Similarly, clicking on the up and down 937 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
751 arrows sends ESC[A (Up) and ESC[B (Down), respectively. 938 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
752 939
753TEXT SELECTION AND INSERTION 940TEXT SELECTION AND INSERTION
754 The behaviour of text selection and insertion mechanism is similar to 941 The behaviour of text selection and insertion mechanism is similar to
755 *xterm*(1). 942 *xterm*(1).
756 943
757 Selection: 944 Selection:
758 Left click at the beginning of the region, drag to the end of the 945 Left click at the beginning of the region, drag to the end of the
759 region and release; Right click to extend the marked region; Left 946 region and release; Right click to extend the marked region; Left
760 double-click to select a word; Left triple-click to select the 947 double-click to select a word; Left triple-click to select the
761 entire line. 948 entire logical line (which can span multiple screen lines), unless
949 modified by resource tripleclickwords.
762 950
763 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 951 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
764 (Compile: frills) will create a rectangular selection instead of a 952 (Compile: *frills*) will create a rectangular selection instead of a
765 normal one. 953 normal one. In this mode, every selected row becomes its own line in
954 the selection, and trailing whitespace is visually underlined and
955 removed from the selection.
766 956
767 Insertion: 957 Insertion:
768 Pressing and releasing the Middle mouse button (or Shift-Insert) in 958 Pressing and releasing the Middle mouse button (or Shift-Insert) in
769 an rxvt window causes the current text selection to be inserted as 959 an rxvt window causes the current text selection to be inserted as
770 if it had been typed on the keyboard. 960 if it had been typed on the keyboard.
… …
774 supported in rxvt-unicode. Bug me if you need this. 964 supported in rxvt-unicode. Bug me if you need this.
775 965
776 You can, however, switch fonts at runtime using escape sequences (and 966 You can, however, switch fonts at runtime using escape sequences (and
777 therefore using the menubar), e.g.: 967 therefore using the menubar), e.g.:
778 968
779 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 969 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
780 970
781 rxvt-unicode will automatically re-apply these fonts to the output so 971 rxvt-unicode will automatically re-apply these fonts to the output so
782 far. 972 far.
783 973
784ISO 14755 SUPPORT 974ISO 14755 SUPPORT
… …
786 character codes using the keyboard. It consists of 4 parts. The first 976 character codes using the keyboard. It consists of 4 parts. The first
787 part is available rxvt-unicode has been compiled with "--enable-frills", 977 part is available rxvt-unicode has been compiled with "--enable-frills",
788 the rest is available when rxvt-unicode was compiled with 978 the rest is available when rxvt-unicode was compiled with
789 "--enable-iso14755". 979 "--enable-iso14755".
790 980
791 5.1: Basic method 981 * 5.1: Basic method
792 This allows you to enter unicode characters using their hexcode. 982 This allows you to enter unicode characters using their hexcode.
793 983
794 Start by pressing and holding both "Control" and "Shift", then enter 984 Start by pressing and holding both "Control" and "Shift", then enter
795 hex-digits (between one and six). Releasing "Control" and "Shift" 985 hex-digits (between one and six). Releasing "Control" and "Shift"
796 will commit the character as if it were typed directly. While 986 will commit the character as if it were typed directly. While
… …
802 address, which you cannot type. Fortunately, the card has the e-mail 992 address, which you cannot type. Fortunately, the card has the e-mail
803 address printed as hexcodes, e.g. "671d 65e5". You can enter this 993 address printed as hexcodes, e.g. "671d 65e5". You can enter this
804 easily by pressing "Control" and "Shift", followed by 994 easily by pressing "Control" and "Shift", followed by
805 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys. 995 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys.
806 996
807 5.2: Keyboard symbols entry method 997 * 5.2: Keyboard symbols entry method
808 This mode lets you input characters representing the keycap symbols 998 This mode lets you input characters representing the keycap symbols
809 of your keyboard, if representable in the current locale encoding. 999 of your keyboard, if representable in the current locale encoding.
810 1000
811 Start by pressing "Control" and "Shift" together, then releasing 1001 Start by pressing "Control" and "Shift" together, then releasing
812 them. The next special key (cursor keys, home etc.) you enter will 1002 them. The next special key (cursor keys, home etc.) you enter will
… …
814 corresponding keycap symbol. The symbol will only be entered when 1004 corresponding keycap symbol. The symbol will only be entered when
815 the key has been released, otherwise pressing e.g. "Shift" would 1005 the key has been released, otherwise pressing e.g. "Shift" would
816 enter the symbol for "ISO Level 2 Switch", although your intention 1006 enter the symbol for "ISO Level 2 Switch", although your intention
817 might have been to enter a reverse tab (Shift-Tab). 1007 might have been to enter a reverse tab (Shift-Tab).
818 1008
819 5.3: Screen-selection entry method 1009 * 5.3: Screen-selection entry method
820 While this is implemented already (it's basically the selection 1010 While this is implemented already (it's basically the selection
821 mechanism), it could be extended by displaying a unicode character 1011 mechanism), it could be extended by displaying a unicode character
822 map. 1012 map.
823 1013
824 5.4: Feedback method for identifying displayed characters for later 1014 * 5.4: Feedback method for identifying displayed characters for later
825 input 1015 input
826 This method lets you display the unicode character code associated 1016 This method lets you display the unicode character code associated
827 with characters already displayed. 1017 with characters already displayed.
828 1018
829 You enter this mode by holding down "Control" and "Shift" together, 1019 You enter this mode by holding down "Control" and "Shift" together,
… …
841 both scenario A and B of ISO 14755, including part 5.2. 1031 both scenario A and B of ISO 14755, including part 5.2.
842 1032
843LOGIN STAMP 1033LOGIN STAMP
844 rxvt tries to write an entry into the *utmp*(5) file so that it can be 1034 rxvt tries to write an entry into the *utmp*(5) file so that it can be
845 seen via the *who(1)* command, and can accept messages. To allow this 1035 seen via the *who(1)* command, and can accept messages. To allow this
846 feature, rxvt must be installed setuid root on some systems. 1036 feature, rxvt may need to be installed setuid root on some systems or
1037 setgid to root or to some other group on others.
847 1038
848COLORS AND GRAPHICS 1039COLORS AND GRAPHICS
849 In addition to the default foreground and background colours, rxvt can 1040 In addition to the default foreground and background colours, rxvt can
850 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 1041 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
851 versions of the same). Here is a list of the colours with their rgb.txt 1042 versions of the same). Here is a list of the colours with their rgb.txt
… …
883 rxvt -fg Black -bg White -rv 1074 rxvt -fg Black -bg White -rv
884 would yield White on Black, while on *xterm*(1) it would yield Black 1075 would yield White on Black, while on *xterm*(1) it would yield Black
885 on White. 1076 on White.
886 1077
887ENVIRONMENT 1078ENVIRONMENT
888 rxvt sets the environment variables TERM, COLORTERM and COLORFGBG. The 1079 rxvt sets and/or uses the following environment variables:
889 environment variable WINDOWID is set to the X window id number of the 1080
890 rxvt window and it also uses and sets the environment variable DISPLAY 1081 TERM
891 to specify which display terminal to use. rxvt uses the environment 1082 Normally set to "rxvt-unicode", unless overwritten at configure
892 variables RXVTPATH and PATH to find XPM files. 1083 time, via resources or on the commandline.
1084
1085 COLORTERM
1086 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled
1087 with XPM support, and optionally with the added extension "-mono" to
1088 indicate that rxvt-unicode runs on a monochrome screen.
1089
1090 COLORFGBG
1091 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1092 the colour code used as default foreground/text colour (or the
1093 string "default" to indicate that the default-colour escape sequence
1094 is to be used), "bg" is the colour code used as default background
1095 colour (or the string "default"), and "xpm" is the string "default"
1096 if rxvt was compiled with XPM support. Libraries like "ncurses" and
1097 "slang" can (and do) use this information to optimize screen output.
1098
1099 WINDOWID
1100 Set to the (decimal) X Window ID of the rxvt window (the toplevel
1101 window, which usually has subwindows for the scrollbar, the terminal
1102 window and so on).
1103
1104 TERMINFO
1105 Set to the terminfo directory iff rxvt was configured with
1106 "--with-terminfo=PATH".
1107
1108 DISPLAY
1109 Used by rxvt to connect to the display and set to the correct
1110 display in it's child processes.
1111
1112 SHELL
1113 The shell to be used for command execution, defaults to "/bin/sh".
1114
1115 RXVTPATH
1116 The path where rxvt looks for support files such as menu and xpm
1117 files.
1118
1119 PATH
1120 Used in the same way as "RXVTPATH".
1121
1122 RXVT_SOCKET
1123 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1124
1125 Default $HOME/.rxvt-unicode-*<nodename*.
1126
1127 HOME
1128 Used to locate the default directory for the unix domain socket for
1129 daemon communications and to locate various resource files (such as
1130 ".Xdefaults")
1131
1132 XAPPLRESDIR
1133 Directory where various X resource files are being located.
1134
1135 XENVIRONMENT
1136 If set and accessible, gives the name of a X resource file to be
1137 loaded by rxvt.
893 1138
894FILES 1139FILES
895 /etc/utmp
896 System file for login records.
897
898 /usr/lib/X11/rgb.txt 1140 /usr/lib/X11/rgb.txt
899 Color names. 1141 Color names.
900 1142
901SEE ALSO 1143SEE ALSO
902 rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1144 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
903 1145 tty(4), utmp(5)
904BUGS
905 Check the BUGS file for an up-to-date list.
906
907 Cursor change support is not yet implemented.
908
909 Click-and-drag doesn't work with X11 mouse report overriding.
910 1146
911CURRENT PROJECT COORDINATOR 1147CURRENT PROJECT COORDINATOR
912 Project Coordinator 1148 Project Coordinator
913 Marc A. Lehmann rxvt@schmorp.de 1149 Marc A. Lehmann <rxvt-unicode@schmorp.de>
914 1150
915 Web page maintainter
916 Marc A. Lehmann rxvt@schmorp.de
917
918 <http://software.schmorp.de/> 1151 <http://software.schmorp.de/#rxvt-unicode>
919 1152
920AUTHORS 1153AUTHORS
921 John Bovey 1154 John Bovey
922 University of Kent, 1992, wrote the original Xvt. 1155 University of Kent, 1992, wrote the original Xvt.
923 1156
… …
937 1170
938 Geoff Wing <gcw@pobox.com> 1171 Geoff Wing <gcw@pobox.com>
939 Rewrote screen display and text selection routines. Project 1172 Rewrote screen display and text selection routines. Project
940 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1173 Coordinator (changes.txt 2.4.6 - rxvt-unicode)
941 1174
942 Marc Alexander Lehmann <rxvt@schmorp.de> 1175 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
943 Forked rxvt-unicode, rewrote most of the display code and internal 1176 Forked rxvt-unicode, rewrote most of the display code and internal
944 character handling to store text in unicode, improve xterm 1177 character handling to store text in unicode, improve xterm
945 compatibility and apply numerous other bugfixes and extensions. 1178 compatibility and apply numerous other bugfixes and extensions.
946 1179
947 Project Coordinator (Changes 1.0 -) 1180 Project Coordinator (Changes 1.0 -)

Diff Legend

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