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

Diff Legend

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