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

Diff Legend

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