ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/cvsroot/rxvt-unicode/doc/rxvt.1.txt
(Generate patch)

Comparing cvsroot/rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.6 by root, Thu Feb 3 10:24:10 2005 UTC vs.
Revision 1.42 by root, Wed Jan 11 23:08:54 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.9, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 7.0, 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
… …
153 163
154 See also the question "How does rxvt-unicode choose fonts?" in the 164 See also the question "How does rxvt-unicode choose fonts?" in the
155 FAQ section of rxvt(7). 165 FAQ section of rxvt(7).
156 166
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
159 are to be printed. See resource boldFont for details. 169 characters 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
… …
236 externalBorder. 251 externalBorder.
237 252
238 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e. 253 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e.
239 if honoured by the WM, the rxvt-unicode window will not have window 254 if honoured by the WM, the rxvt-unicode window will not have window
240 decorations; resource borderLess. 255 decorations; resource borderLess.
256
257 -sbg
258 Compile *frills*: Disable the usage of the built-in block
259 graphics/line drawing characters and just rely on what the specified
260 fonts provide. Use this if you have a good font and want to use its
261 block graphic glyphs; resource skipBuiltinGlyphs.
241 262
242 -lsp *number* 263 -lsp *number*
243 Compile *frills*: Lines (pixel height) to insert between each row of 264 Compile *frills*: Lines (pixel height) to insert between each row of
244 the display. Useful to work around font rendering problems; resource 265 the display. Useful to work around font rendering problems; resource
245 linespace. 266 linespace.
… …
257 on the command line. If this option is used, it must be the last on 278 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 279 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, 280 run the program specified by the SHELL environment variable or,
260 failing that, *sh(1)*. 281 failing that, *sh(1)*.
261 282
283 Please note that you must specify a program with arguments. If you
284 want to run shell commands, you have to specify the shell, like
285 this:
286
287 rxvt -e sh -c "shell commands"
288
262 -title *text* 289 -title *text*
263 Window title (-T still respected); the default title is the basename 290 Window title (-T still respected); the default title is the basename
264 of the program specified after the -e option, if any, otherwise the 291 of the program specified after the -e option, if any, otherwise the
265 application name; resource title. 292 application name; resource title.
266 293
… …
309 336
310 -ssr|+ssr 337 -ssr|+ssr
311 Turn on/off secondary screen scroll (default enabled); resource 338 Turn on/off secondary screen scroll (default enabled); resource
312 secondaryScroll. 339 secondaryScroll.
313 340
314 -xrm *resourcestring* 341 -hold|+hold
315 No effect on rxvt-unicode. Simply passes through an argument to be 342 Turn on/off hold window after exit support. If enabled, rxvt will
316 made available in the instance's argument list. Appears in 343 not immediately destroy its window when the program executed within
317 *WM_COMMAND* in some window managers. 344 it exits. Instead, it will wait till it is being killed or closed by
345 the user; resource hold.
346
347 -keysym.*sym* *string*
348 Remap a key symbol. See resource keysym.
349
350 -embed *windowid*
351 Tells rxvt to embed it's windows into an already-existing window,
352 which enables applications to easily embed a terminal.
353
354 Right now, rxvt will first unmap/map the specified window, so it
355 shouldn't be a top-level window. rxvt will also reconfigure it quite
356 a bit, so don't expect it to keep some specific state. It's best to
357 create an extra subwindow for rxvt and leave it alone.
358
359 The window will not be destroyed when rxvt exits.
360
361 It might be useful to know that rxvt will not close file descriptors
362 passed to it (except for stdin/out/err, of course), so you can use
363 file descriptors to communicate with the programs within the
364 terminal. This works regardless of wether the "-embed" option was
365 used or not.
366
367 Here is a short Gtk2-perl snippet that illustrates how this option
368 can be used (a longer example is in doc/embed):
369
370 my $rxvt = new Gtk2::Socket;
371 $rxvt->signal_connect_after (realize => sub {
372 my $xid = $_[0]->window->get_xid;
373 system "rxvt -embed $xid &";
374 });
375
376 -pty-fd *file descriptor*
377 Tells rxvt NOT to execute any commands or create a new pty/tty pair
378 but instead use the given filehandle as the tty master. This is
379 useful if you want to drive rxvt as a generic terminal emulator
380 without having to run a program within it.
381
382 If this switch is given, rxvt will not create any utmp/wtmp entries
383 and will not tinker with pty/tty permissions - you have to do that
384 yourself if you want that.
385
386 As an extremely special case, specifying -1 will completely suppress
387 pty/tty operations.
388
389 Here is a example in perl that illustrates how this option can be
390 used (a longer example is in doc/pty-fd):
391
392 use IO::Pty;
393 use Fcntl;
394
395 my $pty = new IO::Pty;
396 fcntl $pty, F_SETFD, 0; # clear close-on-exec
397 system "rxvt -pty-fd " . (fileno $pty) . "&";
398 close $pty;
399
400 # now communicate with rxvt
401 my $slave = $pty->slave;
402 while (<$slave>) { print $slave "got <$_>\n" }
403
404 -pe *string*
405 Comma-separated list of perl extension scripts to use (or not to
406 use) in this terminal instance. See resource perl-ext for details.
318 407
319RESOURCES (available also as long-options) 408RESOURCES (available also as long-options)
320 Note: `rxvt --help' gives a list of all resources (long options) 409 Note: `rxvt --help' gives a list of all resources (long options)
321 compiled into your version. 410 compiled into your version.
322 411
323 There are two different methods that rxvt can use to get the Xresource
324 data: using the X libraries (Xrm*-functions) or internal Xresources
325 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
326 XGetDefaults), you can set and change the resources using X11 tools like 412 You can set and change the resources using X11 tools like xrdb. Many
327 xset. Many distribution do also load settings from the ~/.Xresources 413 distribution do also load settings from the ~/.Xresources file when X
328 file when X starts. 414 starts. rxvt will consult the following files/resources in order, with
415 later settings overwriting earlier ones:
329 416
330 If compiled with internal Xresources support (i.e. rxvt -h lists 417 1. system-wide app-defaults file, either locale-dependent OR global
331 .Xdefaults) then rxvt accepts application defaults set in 418 2. app-defaults file in $XAPPLRESDIR
332 XAPPLOADDIR/URxvt (compile-time defined: usually 419 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
333 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 420 4. SCREEN_RESOURCES for the current screen
334 ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X 421 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
335 resources, rxvt recognizes two class names: XTerm and URxvt. The class 422
336 name Rxvt allows resources common to both rxvt and the original *rxvt* 423 Note that when reading X resources, rxvt recognizes two class names:
337 to be easily configured, while the class name URxvt allows resources 424 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
338 unique to rxvt, notably colours and key-handling, to be shared between 425 and the original *rxvt* to be easily configured, while the class name
426 URxvt allows resources unique to rxvt, to be shared between different
339 different rxvt configurations. If no resources are specified, suitable 427 rxvt configurations. If no resources are specified, suitable defaults
340 defaults will be used. Command-line arguments can be used to override 428 will be used. Command-line arguments can be used to override resource
341 resource settings. The following resources are allowed: 429 settings. The following resources are supported (you might want to check
430 the rxvtperl(3) manpage for additional settings by perl extensions not
431 documented here):
342 432
343 geometry: *geom* 433 geometry: *geom*
344 Create the window with the specified X window geometry [default 434 Create the window with the specified X window geometry [default
345 80x24]; option -geometry. 435 80x24]; option -geometry.
346 436
… …
409 True: make the background inherit the parent windows' pixmap, giving 499 True: make the background inherit the parent windows' pixmap, giving
410 artificial transparency. False: do not inherit the parent windows' 500 artificial transparency. False: do not inherit the parent windows'
411 pixmap. 501 pixmap.
412 502
413 fading: *number* 503 fading: *number*
414 Fade the text by the given percentage when focus is lost. 504 Fade the text by the given percentage when focus is lost; option
505 -fade.
506
507 fadeColor: *colour*
508 Fade to this colour, when fading is used (see fading:). The default
509 colour is black; option -fadecolor.
415 510
416 tintColor: *colour* 511 tintColor: *colour*
417 Tint the transparent background pixmap with the given colour. 512 Tint the transparent background pixmap with the given colour; option
513 -tint.
418 514
419 shading: *number* 515 shading: *number*
420 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 516 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
421 image in addition to tinting it. 517 image in addition to tinting it.
422 518
423 scrollColor: *colour* 519 scrollColor: *colour*
424 Use the specified colour for the scrollbar [default #B2B2B2]. 520 Use the specified colour for the scrollbar [default #B2B2B2].
425 521
426 troughColor: *colour* 522 troughColor: *colour*
427 Use the specified colour for the scrollbar's trough area [default 523 Use the specified colour for the scrollbar's trough area [default
428 #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 524 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
429 525
430 borderColor: *colour* 526 borderColor: *colour*
431 The colour of the border around the text area and between the 527 The colour of the border around the text area and between the
432 scrollbar and the text. 528 scrollbar and the text.
433 529
… …
456 font: *fontlist* 552 font: *fontlist*
457 Select the fonts to be used. This is a comma separated list of font 553 Select the fonts to be used. This is a comma separated list of font
458 names that are used in turn when trying to display Unicode 554 names that are used in turn when trying to display Unicode
459 characters. The first font defines the cell size for characters; 555 characters. The first font defines the cell size for characters;
460 other fonts might be smaller, but not larger. A reasonable default 556 other fonts might be smaller, but not larger. A reasonable default
461 font list is always appended to it. option -fn. 557 font list is always appended to it; option -fn.
462 558
463 Each font can either be a standard X11 core font (XLFD) name, with 559 Each font can either be a standard X11 core font (XLFD) name, with
464 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 560 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
465 "xft:". 561 "xft:".
466 562
… …
512 tried. 608 tried.
513 609
514 If set, but empty, then this specific style is disabled and the 610 If set, but empty, then this specific style is disabled and the
515 normal text font will being used for the given style. 611 normal text font will being used for the given style.
516 612
613 intensityStyles: *boolean*
614 When font styles are not enabled, or this option is enabled (True,
615 option -is, the default), bold and italic font styles imply high
616 intensity foreground/backround colours. Disabling this option
617 (False, option +is) disables this behaviour, the high intensity
618 colours are not reachable.
619
517 selectstyle: *mode* 620 selectstyle: *mode*
518 Set mouse selection style to old which is 2.20, oldword which is 621 Set mouse selection style to old which is 2.20, oldword which is
519 xterm style with 2.20 old word selection, or anything else which 622 xterm style with 2.20 old word selection, or anything else which
520 gives xterm style selection. 623 gives xterm style selection.
521 624
522 scrollstyle: *mode* 625 scrollstyle: *mode*
523 Set scrollbar style to rxvt, plain, next or xterm. plain is the 626 Set scrollbar style to rxvt, plain, next or xterm. plain is the
524 author's favourite.. 627 author's favourite.
525 628
526 title: *string* 629 title: *string*
527 Set window title string, the default title is the command-line 630 Set window title string, the default title is the command-line
528 specified after the -e option, if any, otherwise the application 631 specified after the -e option, if any, otherwise the application
529 name; option -title. 632 name; option -title.
… …
554 print-pipe: *string* 657 print-pipe: *string*
555 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use 658 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use
556 Print to initiate a screen dump to the printer and Ctrl-Print or 659 Print to initiate a screen dump to the printer and Ctrl-Print or
557 Shift-Print to include the scrollback as well. 660 Shift-Print to include the scrollback as well.
558 661
662 The string will be interpreted as if typed into the shell as-is.
663
664 Example:
665
666 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
667
668 This creates a new file in your home directory with the screen
669 contents everytime you hit "Print".
670
559 scrollBar: *boolean* 671 scrollBar: *boolean*
560 True: enable the scrollbar [default]; option -sb. False: disable the 672 True: enable the scrollbar [default]; option -sb. False: disable the
561 scrollbar; option +sb. 673 scrollbar; option +sb.
562 674
563 scrollBar_right: *boolean* 675 scrollBar_right: *boolean*
… …
576 True: scroll to bottom when tty receives output; option -si. False: 688 True: scroll to bottom when tty receives output; option -si. False:
577 do not scroll to bottom when tty receives output; option +si. 689 do not scroll to bottom when tty receives output; option +si.
578 690
579 scrollWithBuffer: *boolean* 691 scrollWithBuffer: *boolean*
580 True: scroll with scrollback buffer when tty receives new lines (and 692 True: scroll with scrollback buffer when tty receives new lines (and
581 scrollTtyOutput is False); option +sw. False: do not scroll with 693 scrollTtyOutput is False); option -sw. False: do not scroll with
582 scrollback buffer when tty recieves new lines; option -sw. 694 scrollback buffer when tty recieves new lines; option +sw.
583 695
584 scrollTtyKeypress: *boolean* 696 scrollTtyKeypress: *boolean*
585 True: scroll to bottom when a non-special key is pressed. Special 697 True: scroll to bottom when a non-special key is pressed. Special
586 keys are those which are intercepted by rxvt-unicode for special 698 keys are those which are intercepted by rxvt-unicode for special
587 handling and are not passed onto the shell; option -sk. False: do 699 handling and are not passed onto the shell; option -sk. False: do
… …
602 borderLess: *boolean* 714 borderLess: *boolean*
603 Set MWM hints to request a borderless window, i.e. if honoured by 715 Set MWM hints to request a borderless window, i.e. if honoured by
604 the WM, the rxvt-unicode window will not have window decorations; 716 the WM, the rxvt-unicode window will not have window decorations;
605 option -bl. 717 option -bl.
606 718
719 skipBuiltinGlyphs: *boolean*
720 Compile *frills*: Disable the usage of the built-in block
721 graphics/line drawing characters and just rely on what the specified
722 fonts provide. Use this if you have a good font and want to use its
723 block graphic glyphs; option -sbg.
724
607 termName: *termname* 725 termName: *termname*
608 Specifies the terminal type name to be set in the TERM environment 726 Specifies the terminal type name to be set in the TERM environment
609 variable; option -tn. 727 variable; option -tn.
610 728
611 linespace: *number* 729 linespace: *number*
… …
639 pointerColor2: *colour* 757 pointerColor2: *colour*
640 Mouse pointer background colour. 758 Mouse pointer background colour.
641 759
642 pointerBlankDelay: *number* 760 pointerBlankDelay: *number*
643 Specifies number of seconds before blanking the pointer [default 2]. 761 Specifies number of seconds before blanking the pointer [default 2].
762 Use a large number (e.g. 987654321) to effectively disable the
763 timeout.
644 764
645 backspacekey: *string* 765 backspacekey: *string*
646 The string to send when the backspace key is pressed. If set to DEC 766 The string to send when the backspace key is pressed. If set to DEC
647 or unset it will send Delete (code 127) or, if shifted, Backspace 767 or unset it will send Delete (code 127) or, if shifted, Backspace
648 (code 8) - which can be reversed with the appropriate DEC private 768 (code 8) - which can be reversed with the appropriate DEC private
… …
667 787
668 imLocale: *name* 788 imLocale: *name*
669 The locale to use for opening the IM. You can use an "LC_CTYPE" of 789 The locale to use for opening the IM. You can use an "LC_CTYPE" of
670 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for 790 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for
671 the input extension to be able to input japanese characters while 791 the input extension to be able to input japanese characters while
672 staying in another locale. option -imlocale. 792 staying in another locale; option -imlocale.
673 793
674 imFont: *fontset* 794 imFont: *fontset*
675 Specify the font-set used for XIM styles "OverTheSpot" or 795 Specify the font-set used for XIM styles "OverTheSpot" or
676 "OffTheSpot". It must be a standard X font set (XLFD patterns 796 "OffTheSpot". It must be a standard X font set (XLFD patterns
677 separated by commas), i.e. it's not in the same format as the other 797 separated by commas), i.e. it's not in the same format as the other
… …
680 to the base font. option -imfont. 800 to the base font. option -imfont.
681 801
682 tripleclickwords: *boolean* 802 tripleclickwords: *boolean*
683 Change the meaning of triple-click selection with the left mouse 803 Change the meaning of triple-click selection with the left mouse
684 button. Instead of selecting a full line it will extend the 804 button. Instead of selecting a full line it will extend the
685 selection to the end of the logical line only. option -tcw. 805 selection to the end of the logical line only; option -tcw.
686 806
687 insecure: *boolean* 807 insecure: *boolean*
688 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 808 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
689 that echo arbitrary strings like the icon name or the locale. This 809 that echo arbitrary strings like the icon name or the locale. This
690 could be abused if somebody gets 8-bit-clean access to your display, 810 could be abused if somebody gets 8-bit-clean access to your display,
691 whether throuh a mail client displaying mail bodies unfiltered or 811 whether through a mail client displaying mail bodies unfiltered or
692 though write(1). Therefore, these sequences are disabled by default. 812 through write(1) or any other means. Therefore, these sequences are
693 (Note that other terminals, including xterm, have these sequences 813 disabled by default. (Note that many other terminals, including
694 enabled by default). You can enable them by setting this boolean 814 xterm, have these sequences enabled by default, which doesn't make
695 resource or specifying -insecure as an option. At the moment, this 815 it safer, though).
696 enabled display-answer, locale, findfont, icon label and window 816
697 title requests as well as dynamic menubar dispatch. 817 You can enable them by setting this boolean resource or specifying
818 -insecure as an option. At the moment, this enables display-answer,
819 locale, findfont, icon label and window title requests as well as
820 dynamic menubar dispatch.
698 821
699 modifier: *modifier* 822 modifier: *modifier*
700 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 823 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
701 super, mod1, mod2, mod3, mod4, mod5; option -mod. 824 super, mod1, mod2, mod3, mod4, mod5; option -mod.
702 825
… …
711 secondaryScroll: *bool* 834 secondaryScroll: *bool*
712 Turn on/off secondary screen scroll (default enabled). If the this 835 Turn on/off secondary screen scroll (default enabled). If the this
713 option is enabled, scrolls on the secondary screen will change the 836 option is enabled, scrolls on the secondary screen will change the
714 scrollback buffer and switching to/from the secondary screen will 837 scrollback buffer and switching to/from the secondary screen will
715 instead scroll the screen up. 838 instead scroll the screen up.
839
840 hold: *bool*
841 Turn on/off hold window after exit support. If enabled, rxvt will
842 not immediately destroy its window when the program executed within
843 it exits. Instead, it will wait till it is being killed or closed by
844 the user.
716 845
717 keysym.*sym*: *string* 846 keysym.*sym*: *string*
718 Compile *frills*: Associate *string* with keysym *sym*. The 847 Compile *frills*: Associate *string* with keysym *sym*. The
719 intervening resource name keysym. cannot be omitted. 848 intervening resource name keysym. cannot be omitted.
720 849
… …
739 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 868 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
740 "\000": octal number) or verbatim control characters ("^?": delete, 869 "\000": octal number) or verbatim control characters ("^?": delete,
741 "^@": null, "^A" ...) and may be enclosed with double quotes so that 870 "^@": null, "^A" ...) and may be enclosed with double quotes so that
742 it can start or end with whitespace. 871 it can start or end with whitespace.
743 872
873 Please note that you need to double the "\" in resource files, as
874 Xlib itself does it's own de-escaping (you can use "\033" instead of
875 "\e" (and so on), which will work with both Xt and rxvt's own
876 processing).
877
744 You can define a range of keysyms in one shot by providing a 878 You can define a range of keysyms in one shot by providing a
745 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 879 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
746 `/' should be a character not used by the strings. 880 `/' should be a character not used by the strings.
747 881
748 Its usage can be demonstrated by an example: 882 Its usage can be demonstrated by an example:
749 883
750 URxvt.keysym.M-C-0x61: list|\e<M-C-|abc|> 884 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
751 885
752 The above line is equivalent to the following three lines: 886 The above line is equivalent to the following three lines:
753 887
754 URxvt.keysym.Meta-Control-0x61: \e<M-C-a> 888 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
755 URxvt.keysym.Meta-Control-0x62: \e<M-C-b> 889 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
756 URxvt.keysym.Meta-Control-0x63: \e<M-C-c> 890 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
757 891
758 If *string* takes the form of "proto:STRING", the specified STRING 892 If *string* takes the form of "command:STRING", the specified STRING
759 is interpreted and executed as rxvt's control sequence. For example 893 is interpreted and executed as rxvt's control sequence. For example
760 the following means "change the current locale to "zh_CN.GBK" when 894 the following means "change the current locale to "zh_CN.GBK" when
761 Control-Meta-c is being pressed": 895 Control-Meta-c is being pressed":
762 896
763 URxvt.keysym.M-C-c: proto:\033]701;zh_CN.GBK\007 897 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
898
899 If *string* takes the form "perl:STRING", then the specified STRING
900 is passed to the "on_keyboard_command" perl handler. See the
901 rxvtperl(3) manpage. For example, the selection extension (activated
902 via "rxvt -pe selection") listens for "selection:rot13" events:
903
904 URxvt.keysym.M-C-c: perl:selection:rot13
905
906 Due the the large number of modifier combinations, a defined key
907 mapping will match if at *at least* the specified identifiers are
908 being set, and no other key mappings with those and more bits are
909 being defined. That means that defining a key map for "a" will
910 automatically provide definitions for "Meta-a", "Shift-a" and so on,
911 unless some of those are defined mappings themselves.
912
913 Unfortunately, this will override built-in key mappings. For example
914 if you overwrite the "Insert" key you will disable rxvt's
915 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
916 the user-defined keymap using the "builtin:" replacement:
917
918 URxvt.keysym.Insert: <my insert key sequence>
919 URxvt.keysym.S-Insert: builtin:
920
921 The first line defines a mapping for "Insert" and *any* combination
922 of modifiers. The second line re-establishes the default mapping for
923 "Shift-Insert".
764 924
765 The following example will map Control-Meta-1 and Control-Meta-2 to 925 The following example will map Control-Meta-1 and Control-Meta-2 to
766 the fonts "suxuseuro" and "9x15bold", so you cna have some limited 926 the fonts "suxuseuro" and "9x15bold", so you can have some limited
767 font-switching at runtime: 927 font-switching at runtime:
768 928
769 URxvt.keysym.M-C-1: proto:\033]50;suxuseuro\007 929 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
770 URxvt.keysym.M-C-2: proto:\033]50;9x15bold\007 930 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
771 931
772 "proto:\033]701;zh_CN.GBK\007" means: change the current locale to 932 Other things are possible, e.g. resizing (see rxvt(7) for more
773 "zh_CN.GBK". 933 info):
934
935 URxvt.keysym.M-C-3: command:\033[8;25;80t
936 URxvt.keysym.M-C-4: command:\033[8;48;110t
937
938 perl-ext-common: *string*
939 perl-ext: *string*
940 Comma-separated list(s) of perl extension scripts (default:
941 "default") to use in this terminal instance; option -pe.
942
943 Extension names can be prefixed with a "-" sign to prohibit using
944 them. This can be useful to selectively disable some extensions
945 loaded by default, or specified via the "perl-ext-common" resource.
946 For example, "default,-selection" will use all the default extension
947 except "selection".
948
949 Extension names can also be followed by an argument in angle
950 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
951 for searchable scorllback to Alt/Meta-s). Mentioning the same
952 extension multiple times with different arguments will pass multiple
953 arguments to the extension.
954
955 Each extension is looked up in the library directories, loaded if
956 necessary, and bound to the current terminal instance.
957
958 If both of these resources are the empty string, then the perl
959 interpreter will not be initialized. The idea behind two options is
960 that perl-ext-common will be used for extensions that should be
961 available to all instances, while perl-ext is used for specific
962 instances.
963
964 perl-eval: *string*
965 Perl code to be evaluated when all extensions have been registered.
966 See the rxvtperl(3) manpage. Due to security reasons, this resource
967 will be ignored when running setuid/setgid.
968
969 perl-lib: *path*
970 Colon-separated list of additional directories that hold extension
971 scripts. When looking for extensions specified by the "perl"
972 resource, rxvt will first look in these directories and then in
973 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
974 will be ignored when running setuid/setgid.
975
976 See the rxvtperl(3) manpage.
977
978 urlLauncher: *string*
979 Specifies the program to be started with a URL argument. Used by the
980 "selection-popup" and "mark-urls" perl extensions.
981
982 transient-for: *windowid*
983 Sets the WM_TRANSIENT_FOR property to the given window iw.
774 984
775THE SCROLLBAR 985THE SCROLLBAR
776 Lines of text that scroll off the top of the rxvt window (resource: 986 Lines of text that scroll off the top of the rxvt window (resource:
777 saveLines) and can be scrolled back using the scrollbar or by 987 saveLines) and can be scrolled back using the scrollbar or by
778 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 988 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
… …
788 normal text selection/insertion, hold either the Shift or the Meta (Alt) 998 normal text selection/insertion, hold either the Shift or the Meta (Alt)
789 key while performing the desired mouse action. 999 key while performing the desired mouse action.
790 1000
791 If mouse reporting mode is active, the normal scrollbar actions are 1001 If mouse reporting mode is active, the normal scrollbar actions are
792 disabled -- on the assumption that we are using a fullscreen 1002 disabled -- on the assumption that we are using a fullscreen
793 application. Instead, pressing Button1 and Button3 sends ESC[6~ (Next) 1003 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
794 and ESC[5~ (Prior), respectively. Similarly, clicking on the up and down 1004 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
795 arrows sends ESC[A (Up) and ESC[B (Down), respectively. 1005 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
796 1006
797TEXT SELECTION AND INSERTION 1007TEXT SELECTION AND INSERTION
798 The behaviour of text selection and insertion mechanism is similar to 1008 The behaviour of text selection and insertion mechanism is similar to
799 *xterm*(1). 1009 *xterm*(1).
800 1010
… …
805 entire logical line (which can span multiple screen lines), unless 1015 entire logical line (which can span multiple screen lines), unless
806 modified by resource tripleclickwords. 1016 modified by resource tripleclickwords.
807 1017
808 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 1018 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
809 (Compile: *frills*) will create a rectangular selection instead of a 1019 (Compile: *frills*) will create a rectangular selection instead of a
810 normal one. 1020 normal one. In this mode, every selected row becomes its own line in
1021 the selection, and trailing whitespace is visually underlined and
1022 removed from the selection.
811 1023
812 Insertion: 1024 Insertion:
813 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1025 Pressing and releasing the Middle mouse button (or Shift-Insert) in
814 an rxvt window causes the current text selection to be inserted as 1026 an rxvt window causes the current text selection to be inserted as
815 if it had been typed on the keyboard. 1027 if it had been typed on the keyboard.
… …
819 supported in rxvt-unicode. Bug me if you need this. 1031 supported in rxvt-unicode. Bug me if you need this.
820 1032
821 You can, however, switch fonts at runtime using escape sequences (and 1033 You can, however, switch fonts at runtime using escape sequences (and
822 therefore using the menubar), e.g.: 1034 therefore using the menubar), e.g.:
823 1035
824 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1036 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
825 1037
826 rxvt-unicode will automatically re-apply these fonts to the output so 1038 rxvt-unicode will automatically re-apply these fonts to the output so
827 far. 1039 far.
828 1040
829ISO 14755 SUPPORT 1041ISO 14755 SUPPORT
… …
929 rxvt -fg Black -bg White -rv 1141 rxvt -fg Black -bg White -rv
930 would yield White on Black, while on *xterm*(1) it would yield Black 1142 would yield White on Black, while on *xterm*(1) it would yield Black
931 on White. 1143 on White.
932 1144
933ENVIRONMENT 1145ENVIRONMENT
934 rxvt sets the environment variables TERM, COLORTERM and COLORFGBG. The 1146 rxvt sets and/or uses the following environment variables:
935 environment variable WINDOWID is set to the X window id number of the 1147
936 rxvt window and it also uses and sets the environment variable DISPLAY 1148 TERM
937 to specify which display terminal to use. rxvt uses the environment 1149 Normally set to "rxvt-unicode", unless overwritten at configure
938 variables RXVTPATH and PATH to find XPM files. 1150 time, via resources or on the commandline.
1151
1152 COLORTERM
1153 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled
1154 with XPM support, and optionally with the added extension "-mono" to
1155 indicate that rxvt-unicode runs on a monochrome screen.
1156
1157 COLORFGBG
1158 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1159 the colour code used as default foreground/text colour (or the
1160 string "default" to indicate that the default-colour escape sequence
1161 is to be used), "bg" is the colour code used as default background
1162 colour (or the string "default"), and "xpm" is the string "default"
1163 if rxvt was compiled with XPM support. Libraries like "ncurses" and
1164 "slang" can (and do) use this information to optimize screen output.
1165
1166 WINDOWID
1167 Set to the (decimal) X Window ID of the rxvt window (the toplevel
1168 window, which usually has subwindows for the scrollbar, the terminal
1169 window and so on).
1170
1171 TERMINFO
1172 Set to the terminfo directory iff rxvt was configured with
1173 "--with-terminfo=PATH".
1174
1175 DISPLAY
1176 Used by rxvt to connect to the display and set to the correct
1177 display in it's child processes.
1178
1179 SHELL
1180 The shell to be used for command execution, defaults to "/bin/sh".
1181
1182 RXVTPATH
1183 The path where rxvt looks for support files such as menu and xpm
1184 files.
1185
1186 PATH
1187 Used in the same way as "RXVTPATH".
1188
1189 RXVT_SOCKET
1190 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1191
1192 Default $HOME/.rxvt-unicode-*<nodename*.
1193
1194 HOME
1195 Used to locate the default directory for the unix domain socket for
1196 daemon communications and to locate various resource files (such as
1197 ".Xdefaults")
1198
1199 XAPPLRESDIR
1200 Directory where various X resource files are being located.
1201
1202 XENVIRONMENT
1203 If set and accessible, gives the name of a X resource file to be
1204 loaded by rxvt.
939 1205
940FILES 1206FILES
941 /usr/lib/X11/rgb.txt 1207 /usr/lib/X11/rgb.txt
942 Color names. 1208 Color names.
943 1209
944SEE ALSO 1210SEE ALSO
945 rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1211 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
946 1212 tty(4), utmp(5)
947BUGS
948 Check the BUGS file for an up-to-date list.
949
950 Cursor change support is not yet implemented.
951
952 Click-and-drag doesn't work with X11 mouse report overriding.
953 1213
954CURRENT PROJECT COORDINATOR 1214CURRENT PROJECT COORDINATOR
955 Project Coordinator 1215 Project Coordinator
956 Marc A. Lehmann rxvt@schmorp.de 1216 Marc A. Lehmann <rxvt-unicode@schmorp.de>
957 1217
958 Web page maintainter
959 Marc A. Lehmann rxvt@schmorp.de
960
961 <http://software.schmorp.de/> 1218 <http://software.schmorp.de/#rxvt-unicode>
962 1219
963AUTHORS 1220AUTHORS
964 John Bovey 1221 John Bovey
965 University of Kent, 1992, wrote the original Xvt. 1222 University of Kent, 1992, wrote the original Xvt.
966 1223
… …
980 1237
981 Geoff Wing <gcw@pobox.com> 1238 Geoff Wing <gcw@pobox.com>
982 Rewrote screen display and text selection routines. Project 1239 Rewrote screen display and text selection routines. Project
983 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1240 Coordinator (changes.txt 2.4.6 - rxvt-unicode)
984 1241
985 Marc Alexander Lehmann <rxvt@schmorp.de> 1242 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
986 Forked rxvt-unicode, rewrote most of the display code and internal 1243 Forked rxvt-unicode, rewrote most of the display code and internal
987 character handling to store text in unicode, improve xterm 1244 character handling to store text in unicode, improve xterm
988 compatibility and apply numerous other bugfixes and extensions. 1245 compatibility and apply numerous other bugfixes and extensions.
989 1246
990 Project Coordinator (Changes 1.0 -) 1247 Project Coordinator (Changes 1.0 -)

Diff Legend

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