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

Diff Legend

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