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.14 by root, Mon Feb 14 18:47:54 2005 UTC vs.
Revision 1.44 by root, Thu Jan 12 12:15:10 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 5.1, 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
… …
93 Turn on/off simulated reverse video; resource reverseVideo. 93 Turn on/off simulated reverse video; resource reverseVideo.
94 94
95 -j|+j 95 -j|+j
96 Turn on/off jump scrolling; resource jumpScroll. 96 Turn on/off jump scrolling; resource jumpScroll.
97 97
98 -ip|+ip 98 -ip|+ip | -tr|+tr
99 Turn on/off inheriting parent window's pixmap. Alternative form is 99 Turn on/off inheriting parent window's pixmap. Alternative form is
100 -tr; resource inheritPixmap. 100 -tr; resource inheritPixmap.
101 101
102 -fade *number* 102 -fade *number*
103 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
104 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.
105 110
106 -tint *colour* 111 -tint *colour*
107 Tint the transparent background pixmap with the given colour when 112 Tint the transparent background pixmap with the given colour when
108 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
109 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;
110 tinting it. 116 resource *tintColor*. Example:
117
118 rxvt -tr -tint blue -sh 40
111 119
112 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent 120 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent
113 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
114 specified, too, e.g. "-tint white"). 122 specified, too, e.g. "-tint white").
115 123
… …
155 163
156 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
157 FAQ section of rxvt(7). 165 FAQ section of rxvt(7).
158 166
159 -fb *fontlist* 167 -fb *fontlist*
160 Compile font-styles: The bold font list to use when bold characters 168 Compile *font-styles*: The bold font list to use when bold
161 are to be printed. See resource boldFont for details. 169 characters are to be printed. See resource boldFont for details.
162 170
163 -fi *fontlist* 171 -fi *fontlist*
164 Compile font-styles: The italic font list to use when bold 172 Compile *font-styles*: The italic font list to use when *italic*
165 characters are to be printed. See resource italicFont for details. 173 characters are to be printed. See resource italicFont for details.
166 174
167 -fbi *fontlist* 175 -fbi *fontlist*
168 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
169 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
170 details. 183 details.
171 184
172 -name *name* 185 -name *name*
173 Specify the application name under which resources are to be 186 Specify the application name under which resources are to be
174 obtained, rather than the default executable file name. Name should 187 obtained, rather than the default executable file name. Name should
… …
204 217
205 -sr|+sr 218 -sr|+sr
206 Put scrollbar on right/left; resource scrollBar_right. 219 Put scrollbar on right/left; resource scrollBar_right.
207 220
208 -st|+st 221 -st|+st
209 Display normal (non XTerm/NeXT) scrollbar without/with a trough; 222 Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
210 resource scrollBar_floating. 223 resource scrollBar_floating.
211 224
212 -ptab|+ptab 225 -ptab|+ptab
213 If enabled (default), "Horizontal Tab" characters are being stored 226 If enabled (default), "Horizontal Tab" characters are being stored
214 as actual wide characters in the screen buffer, which makes it 227 as actual wide characters in the screen buffer, which makes it
… …
238 externalBorder. 251 externalBorder.
239 252
240 -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.
241 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
242 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.
243 262
244 -lsp *number* 263 -lsp *number*
245 Compile *frills*: Lines (pixel height) to insert between each row of 264 Compile *frills*: Lines (pixel height) to insert between each row of
246 the display. Useful to work around font rendering problems; resource 265 the display. Useful to work around font rendering problems; resource
247 linespace. 266 linespace.
… …
259 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
260 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
261 run the program specified by the SHELL environment variable or, 280 run the program specified by the SHELL environment variable or,
262 failing that, *sh(1)*. 281 failing that, *sh(1)*.
263 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
264 -title *text* 289 -title *text*
265 Window title (-T still respected); the default title is the basename 290 Window title (-T still respected); the default title is the basename
266 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
267 application name; resource title. 292 application name; resource title.
268 293
… …
311 336
312 -ssr|+ssr 337 -ssr|+ssr
313 Turn on/off secondary screen scroll (default enabled); resource 338 Turn on/off secondary screen scroll (default enabled); resource
314 secondaryScroll. 339 secondaryScroll.
315 340
341 -hold|+hold
342 Turn on/off hold window after exit support. If enabled, rxvt will
343 not immediately destroy its window when the program executed within
344 it exits. Instead, it will wait till it is being killed or closed by
345 the user; resource hold.
346
316 -keysym.*sym*: *string* 347 -keysym.*sym* *string*
317 Remap a key symbol. See resource keysym. 348 Remap a key symbol. See resource keysym.
318 349
319 -embed: *windowid* 350 -embed *windowid*
320 Tells rxvt to embed it's windows into an already-existing window, 351 Tells rxvt to embed it's windows into an already-existing window,
321 which enables applications to easily embed a terminal. 352 which enables applications to easily embed a terminal.
322 353
323 Right now, rxvt will first unmap/map the specified window, so it 354 Right now, rxvt will first unmap/map the specified window, so it
324 shouldn't be a top-level window. rxvt will also reconfigure it quite 355 shouldn't be a top-level window. rxvt will also reconfigure it quite
325 a bit, so don't expect it to keep some specific state. It's best to 356 a bit, so don't expect it to keep some specific state. It's best to
326 create an extra subwindow for rxvt and leave it alone. 357 create an extra subwindow for rxvt and leave it alone.
358
359 The window will not be destroyed when rxvt exits.
327 360
328 It might be useful to know that rxvt will not close file descriptors 361 It might be useful to know that rxvt will not close file descriptors
329 passed to it (except for stdin/out/err, of course), so you can use 362 passed to it (except for stdin/out/err, of course), so you can use
330 file descriptors to communicate with the programs within the 363 file descriptors to communicate with the programs within the
331 terminal. This works regardless of wether the "-embed" option was 364 terminal. This works regardless of wether the "-embed" option was
332 used or not. 365 used or not.
333 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.
407
334RESOURCES (available also as long-options) 408RESOURCES (available also as long-options)
335 Note: `rxvt --help' gives a list of all resources (long options) 409 Note: `rxvt --help' gives a list of all resources (long options)
336 compiled into your version. 410 compiled into your version.
337 411
338 There are two different methods that rxvt can use to get the Xresource
339 data: using the X libraries (Xrm*-functions) or internal Xresources
340 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
341 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
342 xrdb. Many distribution do also load settings from the ~/.Xresources 413 distribution do also load settings from the ~/.Xresources file when X
343 file when X starts. rxvt will consult the following files/resources in 414 starts. rxvt will consult the following files/resources in order, with
344 order, with later settings overwriting earlier ones: 415 later settings overwriting earlier ones:
345 416
346 1. system-wide app-defaults file, either locale-dependent OR global 417 1. system-wide app-defaults file, either locale-dependent OR global
347 2. app-defaults file in $XAPPLRESDIR 418 2. app-defaults file in $XAPPLRESDIR
348 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 419 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
349 4. SCREEN_RESOURCES for the current screen 420 4. SCREEN_RESOURCES for the current screen
350 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 421 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
351 422
352 If compiled with internal Xresources support (i.e. rxvt -h lists 423 Note that when reading X resources, rxvt recognizes two class names:
353 .Xdefaults) then rxvt accepts application defaults set in 424 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
354 XAPPLOADDIR/URxvt (compile-time defined: usually 425 and the original *rxvt* to be easily configured, while the class name
355 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 426 URxvt allows resources unique to rxvt, to be shared between different
356 ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X
357 resources, rxvt recognizes two class names: XTerm and URxvt. The class
358 name Rxvt allows resources common to both rxvt and the original *rxvt*
359 to be easily configured, while the class name URxvt allows resources
360 unique to rxvt, notably colours and key-handling, to be shared between
361 different rxvt configurations. If no resources are specified, suitable 427 rxvt configurations. If no resources are specified, suitable defaults
362 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
363 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):
364 432
365 geometry: *geom* 433 geometry: *geom*
366 Create the window with the specified X window geometry [default 434 Create the window with the specified X window geometry [default
367 80x24]; option -geometry. 435 80x24]; option -geometry.
368 436
… …
431 True: make the background inherit the parent windows' pixmap, giving 499 True: make the background inherit the parent windows' pixmap, giving
432 artificial transparency. False: do not inherit the parent windows' 500 artificial transparency. False: do not inherit the parent windows'
433 pixmap. 501 pixmap.
434 502
435 fading: *number* 503 fading: *number*
436 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.
437 510
438 tintColor: *colour* 511 tintColor: *colour*
439 Tint the transparent background pixmap with the given colour. 512 Tint the transparent background pixmap with the given colour; option
513 -tint.
440 514
441 shading: *number* 515 shading: *number*
442 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 516 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
443 image in addition to tinting it. 517 image in addition to tinting it.
444 518
445 scrollColor: *colour* 519 scrollColor: *colour*
446 Use the specified colour for the scrollbar [default #B2B2B2]. 520 Use the specified colour for the scrollbar [default #B2B2B2].
447 521
448 troughColor: *colour* 522 troughColor: *colour*
449 Use the specified colour for the scrollbar's trough area [default 523 Use the specified colour for the scrollbar's trough area [default
450 #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 524 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
451 525
452 borderColor: *colour* 526 borderColor: *colour*
453 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
454 scrollbar and the text. 528 scrollbar and the text.
455 529
… …
478 font: *fontlist* 552 font: *fontlist*
479 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
480 names that are used in turn when trying to display Unicode 554 names that are used in turn when trying to display Unicode
481 characters. The first font defines the cell size for characters; 555 characters. The first font defines the cell size for characters;
482 other fonts might be smaller, but not larger. A reasonable default 556 other fonts might be smaller, but not larger. A reasonable default
483 font list is always appended to it. option -fn. 557 font list is always appended to it; option -fn.
484 558
485 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
486 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 560 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
487 "xft:". 561 "xft:".
488 562
… …
534 tried. 608 tried.
535 609
536 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
537 normal text font will being used for the given style. 611 normal text font will being used for the given style.
538 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
539 selectstyle: *mode* 620 selectstyle: *mode*
540 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
541 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
542 gives xterm style selection. 623 gives xterm style selection.
543 624
544 scrollstyle: *mode* 625 scrollstyle: *mode*
545 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
546 author's favourite.. 627 author's favourite.
547 628
548 title: *string* 629 title: *string*
549 Set window title string, the default title is the command-line 630 Set window title string, the default title is the command-line
550 specified after the -e option, if any, otherwise the application 631 specified after the -e option, if any, otherwise the application
551 name; option -title. 632 name; option -title.
… …
576 print-pipe: *string* 657 print-pipe: *string*
577 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use 658 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use
578 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
579 Shift-Print to include the scrollback as well. 660 Shift-Print to include the scrollback as well.
580 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
581 scrollBar: *boolean* 671 scrollBar: *boolean*
582 True: enable the scrollbar [default]; option -sb. False: disable the 672 True: enable the scrollbar [default]; option -sb. False: disable the
583 scrollbar; option +sb. 673 scrollbar; option +sb.
584 674
585 scrollBar_right: *boolean* 675 scrollBar_right: *boolean*
… …
598 True: scroll to bottom when tty receives output; option -si. False: 688 True: scroll to bottom when tty receives output; option -si. False:
599 do not scroll to bottom when tty receives output; option +si. 689 do not scroll to bottom when tty receives output; option +si.
600 690
601 scrollWithBuffer: *boolean* 691 scrollWithBuffer: *boolean*
602 True: scroll with scrollback buffer when tty receives new lines (and 692 True: scroll with scrollback buffer when tty receives new lines (and
603 scrollTtyOutput is False); option +sw. False: do not scroll with 693 scrollTtyOutput is False); option -sw. False: do not scroll with
604 scrollback buffer when tty recieves new lines; option -sw. 694 scrollback buffer when tty recieves new lines; option +sw.
605 695
606 scrollTtyKeypress: *boolean* 696 scrollTtyKeypress: *boolean*
607 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
608 keys are those which are intercepted by rxvt-unicode for special 698 keys are those which are intercepted by rxvt-unicode for special
609 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
… …
624 borderLess: *boolean* 714 borderLess: *boolean*
625 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
626 the WM, the rxvt-unicode window will not have window decorations; 716 the WM, the rxvt-unicode window will not have window decorations;
627 option -bl. 717 option -bl.
628 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
629 termName: *termname* 725 termName: *termname*
630 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
631 variable; option -tn. 727 variable; option -tn.
632 728
633 linespace: *number* 729 linespace: *number*
… …
661 pointerColor2: *colour* 757 pointerColor2: *colour*
662 Mouse pointer background colour. 758 Mouse pointer background colour.
663 759
664 pointerBlankDelay: *number* 760 pointerBlankDelay: *number*
665 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.
666 764
667 backspacekey: *string* 765 backspacekey: *string*
668 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
669 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
670 (code 8) - which can be reversed with the appropriate DEC private 768 (code 8) - which can be reversed with the appropriate DEC private
… …
689 787
690 imLocale: *name* 788 imLocale: *name*
691 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
692 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
693 the input extension to be able to input japanese characters while 791 the input extension to be able to input japanese characters while
694 staying in another locale. option -imlocale. 792 staying in another locale; option -imlocale.
695 793
696 imFont: *fontset* 794 imFont: *fontset*
697 Specify the font-set used for XIM styles "OverTheSpot" or 795 Specify the font-set used for XIM styles "OverTheSpot" or
698 "OffTheSpot". It must be a standard X font set (XLFD patterns 796 "OffTheSpot". It must be a standard X font set (XLFD patterns
699 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
… …
702 to the base font. option -imfont. 800 to the base font. option -imfont.
703 801
704 tripleclickwords: *boolean* 802 tripleclickwords: *boolean*
705 Change the meaning of triple-click selection with the left mouse 803 Change the meaning of triple-click selection with the left mouse
706 button. Instead of selecting a full line it will extend the 804 button. Instead of selecting a full line it will extend the
707 selection to the end of the logical line only. option -tcw. 805 selection to the end of the logical line only; option -tcw.
708 806
709 insecure: *boolean* 807 insecure: *boolean*
710 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 808 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
711 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
712 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,
713 whether throuh a mail client displaying mail bodies unfiltered or 811 whether through a mail client displaying mail bodies unfiltered or
714 though write(1). Therefore, these sequences are disabled by default. 812 through write(1) or any other means. Therefore, these sequences are
715 (Note that other terminals, including xterm, have these sequences 813 disabled by default. (Note that many other terminals, including
716 enabled by default). You can enable them by setting this boolean 814 xterm, have these sequences enabled by default, which doesn't make
717 resource or specifying -insecure as an option. At the moment, this 815 it safer, though).
718 enabled display-answer, locale, findfont, icon label and window 816
719 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.
720 821
721 modifier: *modifier* 822 modifier: *modifier*
722 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,
723 super, mod1, mod2, mod3, mod4, mod5; option -mod. 824 super, mod1, mod2, mod3, mod4, mod5; option -mod.
724 825
… …
733 secondaryScroll: *bool* 834 secondaryScroll: *bool*
734 Turn on/off secondary screen scroll (default enabled). If the this 835 Turn on/off secondary screen scroll (default enabled). If the this
735 option is enabled, scrolls on the secondary screen will change the 836 option is enabled, scrolls on the secondary screen will change the
736 scrollback buffer and switching to/from the secondary screen will 837 scrollback buffer and switching to/from the secondary screen will
737 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.
738 845
739 keysym.*sym*: *string* 846 keysym.*sym*: *string*
740 Compile *frills*: Associate *string* with keysym *sym*. The 847 Compile *frills*: Associate *string* with keysym *sym*. The
741 intervening resource name keysym. cannot be omitted. 848 intervening resource name keysym. cannot be omitted.
742 849
… …
761 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 868 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
762 "\000": octal number) or verbatim control characters ("^?": delete, 869 "\000": octal number) or verbatim control characters ("^?": delete,
763 "^@": null, "^A" ...) and may be enclosed with double quotes so that 870 "^@": null, "^A" ...) and may be enclosed with double quotes so that
764 it can start or end with whitespace. 871 it can start or end with whitespace.
765 872
766 Please note that you need to double the "\" when using 873 Please note that you need to double the "\" in resource files, as
767 "--enable-xgetdefault", as X itself does it's own de-escaping (you 874 Xlib itself does it's own de-escaping (you can use "\033" instead of
768 can use "\033" instead of "\e" (and so on), which will work with 875 "\e" (and so on), which will work with both Xt and rxvt's own
769 both Xt and rxvt's own processing). 876 processing).
770 877
771 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
772 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 879 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
773 `/' should be a character not used by the strings. 880 `/' should be a character not used by the strings.
774 881
… …
787 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
788 Control-Meta-c is being pressed": 895 Control-Meta-c is being pressed":
789 896
790 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 897 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
791 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".
924
792 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
793 the fonts "suxuseuro" and "9x15bold", so you can have some limited 926 the fonts "suxuseuro" and "9x15bold", so you can have some limited
794 font-switching at runtime: 927 font-switching at runtime:
795 928
796 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 929 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
… …
799 Other things are possible, e.g. resizing (see rxvt(7) for more 932 Other things are possible, e.g. resizing (see rxvt(7) for more
800 info): 933 info):
801 934
802 URxvt.keysym.M-C-3: command:\033[8;25;80t 935 URxvt.keysym.M-C-3: command:\033[8;25;80t
803 URxvt.keysym.M-C-4: command:\033[8;48;110t 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 selection.pattern-*idx*: *perl-regex*
979 Additional selection patterns, see the rxvtperl(3) manpage for
980 details.
981
982 selection-autotransform.*idx*: *perl-transform*
983 Selection auto-transform patterns, see the rxvtperl(3) manpage for
984 details.
985
986 searchable-scrollback: *keysym*
987 Sets the hotkey that starts the incremental scrollback buffer search
988 (default: "M-s").
989
990 urlLauncher: *string*
991 Specifies the program to be started with a URL argument. Used by the
992 "selection-popup" and "mark-urls" perl extensions.
993
994 transient-for: *windowid*
995 Sets the WM_TRANSIENT_FOR property to the given window iw.
804 996
805THE SCROLLBAR 997THE SCROLLBAR
806 Lines of text that scroll off the top of the rxvt window (resource: 998 Lines of text that scroll off the top of the rxvt window (resource:
807 saveLines) and can be scrolled back using the scrollbar or by 999 saveLines) and can be scrolled back using the scrollbar or by
808 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1000 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
… …
835 entire logical line (which can span multiple screen lines), unless 1027 entire logical line (which can span multiple screen lines), unless
836 modified by resource tripleclickwords. 1028 modified by resource tripleclickwords.
837 1029
838 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 1030 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
839 (Compile: *frills*) will create a rectangular selection instead of a 1031 (Compile: *frills*) will create a rectangular selection instead of a
840 normal one. 1032 normal one. In this mode, every selected row becomes its own line in
1033 the selection, and trailing whitespace is visually underlined and
1034 removed from the selection.
841 1035
842 Insertion: 1036 Insertion:
843 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1037 Pressing and releasing the Middle mouse button (or Shift-Insert) in
844 an rxvt window causes the current text selection to be inserted as 1038 an rxvt window causes the current text selection to be inserted as
845 if it had been typed on the keyboard. 1039 if it had been typed on the keyboard.
… …
849 supported in rxvt-unicode. Bug me if you need this. 1043 supported in rxvt-unicode. Bug me if you need this.
850 1044
851 You can, however, switch fonts at runtime using escape sequences (and 1045 You can, however, switch fonts at runtime using escape sequences (and
852 therefore using the menubar), e.g.: 1046 therefore using the menubar), e.g.:
853 1047
854 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1048 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
855 1049
856 rxvt-unicode will automatically re-apply these fonts to the output so 1050 rxvt-unicode will automatically re-apply these fonts to the output so
857 far. 1051 far.
858 1052
859ISO 14755 SUPPORT 1053ISO 14755 SUPPORT
… …
1005 Used in the same way as "RXVTPATH". 1199 Used in the same way as "RXVTPATH".
1006 1200
1007 RXVT_SOCKET 1201 RXVT_SOCKET
1008 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1202 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1009 1203
1010 Default "$HOME/.rxvt-unicode-<nodename". 1204 Default $HOME/.rxvt-unicode-*<nodename*.
1011 1205
1012 HOME 1206 HOME
1013 Used to locate the default directory for the unix domain socket for 1207 Used to locate the default directory for the unix domain socket for
1014 daemon communications and to locate various resource files (such as 1208 daemon communications and to locate various resource files (such as
1015 ".Xdefaults") 1209 ".Xdefaults")
… …
1024FILES 1218FILES
1025 /usr/lib/X11/rgb.txt 1219 /usr/lib/X11/rgb.txt
1026 Color names. 1220 Color names.
1027 1221
1028SEE ALSO 1222SEE ALSO
1029 rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1223 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
1030 1224 tty(4), utmp(5)
1031BUGS
1032 Check the BUGS file for an up-to-date list.
1033
1034 Cursor change support is not yet implemented.
1035
1036 Click-and-drag doesn't work with X11 mouse report overriding.
1037 1225
1038CURRENT PROJECT COORDINATOR 1226CURRENT PROJECT COORDINATOR
1039 Project Coordinator 1227 Project Coordinator
1040 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1228 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1041 1229

Diff Legend

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