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.18 by root, Fri Feb 18 12:15:07 2005 UTC vs.
Revision 1.50 by root, Fri Jan 20 22:49:34 2006 UTC

… …
4 4
5SYNOPSIS 5SYNOPSIS
6 rxvt [options] [-e command [ args ]] 6 rxvt [options] [-e command [ args ]]
7 7
8DESCRIPTION 8DESCRIPTION
9 rxvt-unicode, version 5.2, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 7.1, is a colour vt102 terminal emulator intended
10 as an *xterm*(1) replacement for users who do not require features such 10 as an *xterm*(1) replacement for users who do not require features such
11 as Tektronix 4014 emulation and toolkit-style configurability. As a 11 as Tektronix 4014 emulation and toolkit-style configurability. As a
12 result, rxvt-unicode uses much less swap space -- a significant 12 result, rxvt-unicode uses much less swap space -- a significant
13 advantage on a machine serving many X sessions. 13 advantage on a machine serving many X sessions.
14 14
… …
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
… …
138 The colour of the border around the text area and between the 146 The colour of the border around the text area and between the
139 scrollbar and the text; resource borderColor. 147 scrollbar and the text; resource borderColor.
140 148
141 -fn *fontlist* 149 -fn *fontlist*
142 Select the fonts to be used. This is a comma separated list of font 150 Select the fonts to be used. This is a comma separated list of font
143 names that are used in turn when trying to display Unicode 151 names that are checked in order when trying to find glyphs for
144 characters. The first font defines the cell size for characters; 152 characters. The first font defines the cell size for characters;
145 other fonts might be smaller, but not (in general) larger. A 153 other fonts might be smaller, but not (in general) larger. A
146 (hopefully) reasonable default font list is always appended to it. 154 (hopefully) reasonable default font list is always appended to it.
147 See resource font for more details. 155 See resource font for more details.
148 156
… …
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 -override-redirect
258 Compile *frills*: Sets override-redirect on the window; resource
259 override-redirect.
260
261 -sbg
262 Compile *frills*: Disable the usage of the built-in block
263 graphics/line drawing characters and just rely on what the specified
264 fonts provide. Use this if you have a good font and want to use its
265 block graphic glyphs; resource skipBuiltinGlyphs.
243 266
244 -lsp *number* 267 -lsp *number*
245 Compile *frills*: Lines (pixel height) to insert between each row of 268 Compile *frills*: Lines (pixel height) to insert between each row of
246 the display. Useful to work around font rendering problems; resource 269 the display. Useful to work around font rendering problems; resource
247 linespace. 270 linespace.
… …
259 on the command line. If this option is used, it must be the last on 282 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 283 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, 284 run the program specified by the SHELL environment variable or,
262 failing that, *sh(1)*. 285 failing that, *sh(1)*.
263 286
287 Please note that you must specify a program with arguments. If you
288 want to run shell commands, you have to specify the shell, like
289 this:
290
291 rxvt -e sh -c "shell commands"
292
264 -title *text* 293 -title *text*
265 Window title (-T still respected); the default title is the basename 294 Window title (-T still respected); the default title is the basename
266 of the program specified after the -e option, if any, otherwise the 295 of the program specified after the -e option, if any, otherwise the
267 application name; resource title. 296 application name; resource title.
268 297
… …
311 340
312 -ssr|+ssr 341 -ssr|+ssr
313 Turn on/off secondary screen scroll (default enabled); resource 342 Turn on/off secondary screen scroll (default enabled); resource
314 secondaryScroll. 343 secondaryScroll.
315 344
345 -hold|+hold
346 Turn on/off hold window after exit support. If enabled, rxvt will
347 not immediately destroy its window when the program executed within
348 it exits. Instead, it will wait till it is being killed or closed by
349 the user; resource hold.
350
316 -keysym.*sym* *string* 351 -keysym.*sym* *string*
317 Remap a key symbol. See resource keysym. 352 Remap a key symbol. See resource keysym.
318 353
319 -embed *windowid* 354 -embed *windowid*
320 Tells rxvt to embed it's windows into an already-existing window, 355 Tells rxvt to embed it's windows into an already-existing window,
… …
334 used or not. 369 used or not.
335 370
336 Here is a short Gtk2-perl snippet that illustrates how this option 371 Here is a short Gtk2-perl snippet that illustrates how this option
337 can be used (a longer example is in doc/embed): 372 can be used (a longer example is in doc/embed):
338 373
339 my $rxvt = new Gtk2::DrawingArea; 374 my $rxvt = new Gtk2::Socket;
340 $...->add ($rxvt); # important to add it somewhere first 375 $rxvt->signal_connect_after (realize => sub {
341 $rxvt->realize; # now it can be realized
342 my $xid = $rxvt->window->get_xid; 376 my $xid = $_[0]->window->get_xid;
343
344 system "rxvt -embed $xid &"; 377 system "rxvt -embed $xid &";
378 });
345 379
346 -pty-fd *fileno* 380 -pty-fd *file descriptor*
347 Tells rxvt NOT to execute any commands or create a new pty/tty pair 381 Tells rxvt NOT to execute any commands or create a new pty/tty pair
348 but instead use the given filehandle as the tty master. This is 382 but instead use the given filehandle as the tty master. This is
349 useful if you want to drive rxvt as a generic terminal emulator 383 useful if you want to drive rxvt as a generic terminal emulator
350 without having to run a program within it. 384 without having to run a program within it.
351 385
352 If this switch is given, rxvt will not create any utmp/wtmp entries 386 If this switch is given, rxvt will not create any utmp/wtmp entries
353 and will not tinker with pty/tty permissions - you have to do that 387 and will not tinker with pty/tty permissions - you have to do that
354 yourself if you want that. 388 yourself if you want that.
355 389
390 As an extremely special case, specifying -1 will completely suppress
391 pty/tty operations.
392
356 Here is a example in perl that illustrates how this option can be 393 Here is a example in perl that illustrates how this option can be
357 used (a longer example is in doc/pty-fd): 394 used (a longer example is in doc/pty-fd):
358 395
359 use IO::Pty; 396 use IO::Pty;
360 use Fcntl; 397 use Fcntl;
… …
366 403
367 # now communicate with rxvt 404 # now communicate with rxvt
368 my $slave = $pty->slave; 405 my $slave = $pty->slave;
369 while (<$slave>) { print $slave "got <$_>\n" } 406 while (<$slave>) { print $slave "got <$_>\n" }
370 407
408 -pe *string*
409 Comma-separated list of perl extension scripts to use (or not to
410 use) in this terminal instance. See resource perl-ext for details.
411
371RESOURCES (available also as long-options) 412RESOURCES (available also as long-options)
372 Note: `rxvt --help' gives a list of all resources (long options) 413 Note: `rxvt --help' gives a list of all resources (long options)
373 compiled into your version. 414 compiled into your version.
374 415
375 There are two different methods that rxvt can use to get the Xresource
376 data: using the X libraries (Xrm*-functions) or internal Xresources
377 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
378 XGetDefaults), you can set and change the resources using X11 tools like 416 You can set and change the resources using X11 tools like xrdb. Many
379 xrdb. Many distribution do also load settings from the ~/.Xresources 417 distribution do also load settings from the ~/.Xresources file when X
380 file when X starts. rxvt will consult the following files/resources in 418 starts. rxvt will consult the following files/resources in order, with
381 order, with later settings overwriting earlier ones: 419 later settings overwriting earlier ones:
382 420
383 1. system-wide app-defaults file, either locale-dependent OR global 421 1. system-wide app-defaults file, either locale-dependent OR global
384 2. app-defaults file in $XAPPLRESDIR 422 2. app-defaults file in $XAPPLRESDIR
385 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 423 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
386 4. SCREEN_RESOURCES for the current screen 424 4. SCREEN_RESOURCES for the current screen
387 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 425 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
388 426
389 If compiled with internal Xresources support (i.e. rxvt -h lists 427 Note that when reading X resources, rxvt recognizes two class names:
390 .Xdefaults) then rxvt accepts application defaults set in 428 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
391 XAPPLOADDIR/URxvt (compile-time defined: usually 429 and the original *rxvt* to be easily configured, while the class name
392 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 430 URxvt allows resources unique to rxvt, to be shared between different
393 ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X
394 resources, rxvt recognizes two class names: XTerm and URxvt. The class
395 name Rxvt allows resources common to both rxvt and the original *rxvt*
396 to be easily configured, while the class name URxvt allows resources
397 unique to rxvt, notably colours and key-handling, to be shared between
398 different rxvt configurations. If no resources are specified, suitable 431 rxvt configurations. If no resources are specified, suitable defaults
399 defaults will be used. Command-line arguments can be used to override 432 will be used. Command-line arguments can be used to override resource
400 resource settings. The following resources are allowed: 433 settings. The following resources are supported (you might want to check
434 the rxvtperl(3) manpage for additional settings by perl extensions not
435 documented here):
401 436
402 geometry: *geom* 437 geometry: *geom*
403 Create the window with the specified X window geometry [default 438 Create the window with the specified X window geometry [default
404 80x24]; option -geometry. 439 80x24]; option -geometry.
405 440
… …
468 True: make the background inherit the parent windows' pixmap, giving 503 True: make the background inherit the parent windows' pixmap, giving
469 artificial transparency. False: do not inherit the parent windows' 504 artificial transparency. False: do not inherit the parent windows'
470 pixmap. 505 pixmap.
471 506
472 fading: *number* 507 fading: *number*
473 Fade the text by the given percentage when focus is lost. 508 Fade the text by the given percentage when focus is lost; option
509 -fade.
510
511 fadeColor: *colour*
512 Fade to this colour, when fading is used (see fading:). The default
513 colour is black; option -fadecolor.
474 514
475 tintColor: *colour* 515 tintColor: *colour*
476 Tint the transparent background pixmap with the given colour. 516 Tint the transparent background pixmap with the given colour; option
517 -tint.
477 518
478 shading: *number* 519 shading: *number*
479 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 520 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
480 image in addition to tinting it. 521 image in addition to tinting it.
481 522
482 scrollColor: *colour* 523 scrollColor: *colour*
483 Use the specified colour for the scrollbar [default #B2B2B2]. 524 Use the specified colour for the scrollbar [default #B2B2B2].
484 525
485 troughColor: *colour* 526 troughColor: *colour*
486 Use the specified colour for the scrollbar's trough area [default 527 Use the specified colour for the scrollbar's trough area [default
487 #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 528 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
488 529
489 borderColor: *colour* 530 borderColor: *colour*
490 The colour of the border around the text area and between the 531 The colour of the border around the text area and between the
491 scrollbar and the text. 532 scrollbar and the text.
492 533
… …
499 scale of 1 displays the image without any scaling. A scale of 2 to 9 540 scale of 1 displays the image without any scaling. A scale of 2 to 9
500 specifies an integer number of images in that direction. No image 541 specifies an integer number of images in that direction. No image
501 will be magnified beyond 10 times its original size. The maximum 542 will be magnified beyond 10 times its original size. The maximum
502 permitted scale is 1000. [default 0x0+50+50] 543 permitted scale is 1000. [default 0x0+50+50]
503 544
504 menu: *file[;tag]*
505 Read in the specified menu file (note the `.menu' extension is
506 optional) and also optionally specify a starting tag to find. See
507 the reference documentation for details on the syntax for the
508 menuBar.
509
510 path: *path* 545 path: *path*
511 Specify the colon-delimited search path for finding files (XPM and 546 Specify the colon-delimited search path for finding XPM files.
512 menus), in addition to the paths specified by the RXVTPATH and PATH
513 environment variables.
514 547
515 font: *fontlist* 548 font: *fontlist*
516 Select the fonts to be used. This is a comma separated list of font 549 Select the fonts to be used. This is a comma separated list of font
517 names that are used in turn when trying to display Unicode 550 names that are checked in order when trying to find glyphs for
518 characters. The first font defines the cell size for characters; 551 characters. The first font defines the cell size for characters;
519 other fonts might be smaller, but not larger. A reasonable default 552 other fonts might be smaller, but not (in general) larger. A
520 font list is always appended to it. option -fn. 553 (hopefully) reasonable default font list is always appended to it;
554 option -fn.
521 555
522 Each font can either be a standard X11 core font (XLFD) name, with 556 Each font can either be a standard X11 core font (XLFD) name, with
523 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 557 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
524 "xft:". 558 "xft:".
525 559
… …
528 available hint currently is "codeset=codeset-name", and this is only 562 available hint currently is "codeset=codeset-name", and this is only
529 used for Xft fonts. 563 used for Xft fonts.
530 564
531 For example, this font resource 565 For example, this font resource
532 566
533 URxvt*font: 9x15bold,\ 567 URxvt.font: 9x15bold,\
534 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 568 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
535 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 569 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
536 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 570 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
537 xft:Code2000:antialias=false 571 xft:Code2000:antialias=false
538 572
… …
571 tried. 605 tried.
572 606
573 If set, but empty, then this specific style is disabled and the 607 If set, but empty, then this specific style is disabled and the
574 normal text font will being used for the given style. 608 normal text font will being used for the given style.
575 609
610 intensityStyles: *boolean*
611 When font styles are not enabled, or this option is enabled (True,
612 option -is, the default), bold and italic font styles imply high
613 intensity foreground/backround colours. Disabling this option
614 (False, option +is) disables this behaviour, the high intensity
615 colours are not reachable.
616
576 selectstyle: *mode* 617 selectstyle: *mode*
577 Set mouse selection style to old which is 2.20, oldword which is 618 Set mouse selection style to old which is 2.20, oldword which is
578 xterm style with 2.20 old word selection, or anything else which 619 xterm style with 2.20 old word selection, or anything else which
579 gives xterm style selection. 620 gives xterm style selection.
580 621
581 scrollstyle: *mode* 622 scrollstyle: *mode*
582 Set scrollbar style to rxvt, plain, next or xterm. plain is the 623 Set scrollbar style to rxvt, plain, next or xterm. plain is the
583 author's favourite.. 624 author's favourite.
584 625
585 title: *string* 626 title: *string*
586 Set window title string, the default title is the command-line 627 Set window title string, the default title is the command-line
587 specified after the -e option, if any, otherwise the application 628 specified after the -e option, if any, otherwise the application
588 name; option -title. 629 name; option -title.
… …
612 653
613 print-pipe: *string* 654 print-pipe: *string*
614 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use 655 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use
615 Print to initiate a screen dump to the printer and Ctrl-Print or 656 Print to initiate a screen dump to the printer and Ctrl-Print or
616 Shift-Print to include the scrollback as well. 657 Shift-Print to include the scrollback as well.
658
659 The string will be interpreted as if typed into the shell as-is.
660
661 Example:
662
663 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
664
665 This creates a new file in your home directory with the screen
666 contents everytime you hit "Print".
617 667
618 scrollBar: *boolean* 668 scrollBar: *boolean*
619 True: enable the scrollbar [default]; option -sb. False: disable the 669 True: enable the scrollbar [default]; option -sb. False: disable the
620 scrollbar; option +sb. 670 scrollbar; option +sb.
621 671
… …
661 borderLess: *boolean* 711 borderLess: *boolean*
662 Set MWM hints to request a borderless window, i.e. if honoured by 712 Set MWM hints to request a borderless window, i.e. if honoured by
663 the WM, the rxvt-unicode window will not have window decorations; 713 the WM, the rxvt-unicode window will not have window decorations;
664 option -bl. 714 option -bl.
665 715
716 skipBuiltinGlyphs: *boolean*
717 Compile *frills*: Disable the usage of the built-in block
718 graphics/line drawing characters and just rely on what the specified
719 fonts provide. Use this if you have a good font and want to use its
720 block graphic glyphs; option -sbg.
721
666 termName: *termname* 722 termName: *termname*
667 Specifies the terminal type name to be set in the TERM environment 723 Specifies the terminal type name to be set in the TERM environment
668 variable; option -tn. 724 variable; option -tn.
669 725
670 linespace: *number* 726 linespace: *number*
… …
698 pointerColor2: *colour* 754 pointerColor2: *colour*
699 Mouse pointer background colour. 755 Mouse pointer background colour.
700 756
701 pointerBlankDelay: *number* 757 pointerBlankDelay: *number*
702 Specifies number of seconds before blanking the pointer [default 2]. 758 Specifies number of seconds before blanking the pointer [default 2].
759 Use a large number (e.g. 987654321) to effectively disable the
760 timeout.
703 761
704 backspacekey: *string* 762 backspacekey: *string*
705 The string to send when the backspace key is pressed. If set to DEC 763 The string to send when the backspace key is pressed. If set to DEC
706 or unset it will send Delete (code 127) or, if shifted, Backspace 764 or unset it will send Delete (code 127) or, if shifted, Backspace
707 (code 8) - which can be reversed with the appropriate DEC private 765 (code 8) - which can be reversed with the appropriate DEC private
… …
726 784
727 imLocale: *name* 785 imLocale: *name*
728 The locale to use for opening the IM. You can use an "LC_CTYPE" of 786 The locale to use for opening the IM. You can use an "LC_CTYPE" of
729 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for 787 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for
730 the input extension to be able to input japanese characters while 788 the input extension to be able to input japanese characters while
731 staying in another locale. option -imlocale. 789 staying in another locale; option -imlocale.
732 790
733 imFont: *fontset* 791 imFont: *fontset*
734 Specify the font-set used for XIM styles "OverTheSpot" or 792 Specify the font-set used for XIM styles "OverTheSpot" or
735 "OffTheSpot". It must be a standard X font set (XLFD patterns 793 "OffTheSpot". It must be a standard X font set (XLFD patterns
736 separated by commas), i.e. it's not in the same format as the other 794 separated by commas), i.e. it's not in the same format as the other
… …
739 to the base font. option -imfont. 797 to the base font. option -imfont.
740 798
741 tripleclickwords: *boolean* 799 tripleclickwords: *boolean*
742 Change the meaning of triple-click selection with the left mouse 800 Change the meaning of triple-click selection with the left mouse
743 button. Instead of selecting a full line it will extend the 801 button. Instead of selecting a full line it will extend the
744 selection to the end of the logical line only. option -tcw. 802 selection to the end of the logical line only; option -tcw.
745 803
746 insecure: *boolean* 804 insecure: *boolean*
747 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 805 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
748 that echo arbitrary strings like the icon name or the locale. This 806 that echo arbitrary strings like the icon name or the locale. This
749 could be abused if somebody gets 8-bit-clean access to your display, 807 could be abused if somebody gets 8-bit-clean access to your display,
750 whether throuh a mail client displaying mail bodies unfiltered or 808 whether through a mail client displaying mail bodies unfiltered or
751 though write(1). Therefore, these sequences are disabled by default. 809 through write(1) or any other means. Therefore, these sequences are
752 (Note that other terminals, including xterm, have these sequences 810 disabled by default. (Note that many other terminals, including
753 enabled by default). You can enable them by setting this boolean 811 xterm, have these sequences enabled by default, which doesn't make
754 resource or specifying -insecure as an option. At the moment, this 812 it safer, though).
755 enabled display-answer, locale, findfont, icon label and window 813
756 title requests as well as dynamic menubar dispatch. 814 You can enable them by setting this boolean resource or specifying
815 -insecure as an option. At the moment, this enables display-answer,
816 locale, findfont, icon label and window title requests.
757 817
758 modifier: *modifier* 818 modifier: *modifier*
759 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 819 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
760 super, mod1, mod2, mod3, mod4, mod5; option -mod. 820 super, mod1, mod2, mod3, mod4, mod5; option -mod.
761 821
762 answerbackString: *string* 822 answerbackString: *string*
763 Specify the reply rxvt-unicode sends to the shell when an ENQ 823 Specify the reply rxvt-unicode sends to the shell when an ENQ
764 (control-E) character is passed through. It may contain escape 824 (control-E) character is passed through. It may contain escape
765 values as described in the entry on keysym following. 825 values as described in the entry on keysym following.
766 826
767 secondaryScreen: *bool* 827 secondaryScreen: *boolean*
768 Turn on/off secondary screen (default enabled). 828 Turn on/off secondary screen (default enabled).
769 829
770 secondaryScroll: *bool* 830 secondaryScroll: *boolean*
771 Turn on/off secondary screen scroll (default enabled). If the this 831 Turn on/off secondary screen scroll (default enabled). If the this
772 option is enabled, scrolls on the secondary screen will change the 832 option is enabled, scrolls on the secondary screen will change the
773 scrollback buffer and switching to/from the secondary screen will 833 scrollback buffer and switching to/from the secondary screen will
774 instead scroll the screen up. 834 instead scroll the screen up.
835
836 hold: *boolean*
837 Turn on/off hold window after exit support. If enabled, rxvt will
838 not immediately destroy its window when the program executed within
839 it exits. Instead, it will wait till it is being killed or closed by
840 the user.
775 841
776 keysym.*sym*: *string* 842 keysym.*sym*: *string*
777 Compile *frills*: Associate *string* with keysym *sym*. The 843 Compile *frills*: Associate *string* with keysym *sym*. The
778 intervening resource name keysym. cannot be omitted. 844 intervening resource name keysym. cannot be omitted.
779 845
… …
798 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 864 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
799 "\000": octal number) or verbatim control characters ("^?": delete, 865 "\000": octal number) or verbatim control characters ("^?": delete,
800 "^@": null, "^A" ...) and may be enclosed with double quotes so that 866 "^@": null, "^A" ...) and may be enclosed with double quotes so that
801 it can start or end with whitespace. 867 it can start or end with whitespace.
802 868
803 Please note that you need to double the "\" when using 869 Please note that you need to double the "\" in resource files, as
804 "--enable-xgetdefault", as X itself does it's own de-escaping (you 870 Xlib itself does it's own de-escaping (you can use "\033" instead of
805 can use "\033" instead of "\e" (and so on), which will work with 871 "\e" (and so on), which will work with both Xt and rxvt's own
806 both Xt and rxvt's own processing). 872 processing).
807 873
808 You can define a range of keysyms in one shot by providing a 874 You can define a range of keysyms in one shot by providing a
809 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 875 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
810 `/' should be a character not used by the strings. 876 `/' should be a character not used by the strings.
811 877
… …
824 the following means "change the current locale to "zh_CN.GBK" when 890 the following means "change the current locale to "zh_CN.GBK" when
825 Control-Meta-c is being pressed": 891 Control-Meta-c is being pressed":
826 892
827 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 893 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
828 894
895 If *string* takes the form "perl:STRING", then the specified STRING
896 is passed to the "on_keyboard_command" perl handler. See the
897 rxvtperl(3) manpage. For example, the selection extension (activated
898 via "rxvt -pe selection") listens for "selection:rot13" events:
899
900 URxvt.keysym.M-C-c: perl:selection:rot13
901
902 Due the the large number of modifier combinations, a defined key
903 mapping will match if at *at least* the specified identifiers are
904 being set, and no other key mappings with those and more bits are
905 being defined. That means that defining a key map for "a" will
906 automatically provide definitions for "Meta-a", "Shift-a" and so on,
907 unless some of those are defined mappings themselves.
908
909 Unfortunately, this will override built-in key mappings. For example
910 if you overwrite the "Insert" key you will disable rxvt's
911 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
912 the user-defined keymap using the "builtin:" replacement:
913
914 URxvt.keysym.Insert: <my insert key sequence>
915 URxvt.keysym.S-Insert: builtin:
916
917 The first line defines a mapping for "Insert" and *any* combination
918 of modifiers. The second line re-establishes the default mapping for
919 "Shift-Insert".
920
829 The following example will map Control-Meta-1 and Control-Meta-2 to 921 The following example will map Control-Meta-1 and Control-Meta-2 to
830 the fonts "suxuseuro" and "9x15bold", so you can have some limited 922 the fonts "suxuseuro" and "9x15bold", so you can have some limited
831 font-switching at runtime: 923 font-switching at runtime:
832 924
833 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 925 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
… …
836 Other things are possible, e.g. resizing (see rxvt(7) for more 928 Other things are possible, e.g. resizing (see rxvt(7) for more
837 info): 929 info):
838 930
839 URxvt.keysym.M-C-3: command:\033[8;25;80t 931 URxvt.keysym.M-C-3: command:\033[8;25;80t
840 URxvt.keysym.M-C-4: command:\033[8;48;110t 932 URxvt.keysym.M-C-4: command:\033[8;48;110t
933
934 perl-ext-common: *string*
935 perl-ext: *string*
936 Comma-separated list(s) of perl extension scripts (default:
937 "default") to use in this terminal instance; option -pe.
938
939 Extension names can be prefixed with a "-" sign to prohibit using
940 them. This can be useful to selectively disable some extensions
941 loaded by default, or specified via the "perl-ext-common" resource.
942 For example, "default,-selection" will use all the default extension
943 except "selection".
944
945 Extension names can also be followed by an argument in angle
946 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
947 for searchable scorllback to Alt/Meta-s). Mentioning the same
948 extension multiple times with different arguments will pass multiple
949 arguments to the extension.
950
951 Each extension is looked up in the library directories, loaded if
952 necessary, and bound to the current terminal instance.
953
954 If both of these resources are the empty string, then the perl
955 interpreter will not be initialized. The idea behind two options is
956 that perl-ext-common will be used for extensions that should be
957 available to all instances, while perl-ext is used for specific
958 instances.
959
960 perl-eval: *string*
961 Perl code to be evaluated when all extensions have been registered.
962 See the rxvtperl(3) manpage. Due to security reasons, this resource
963 will be ignored when running setuid/setgid.
964
965 perl-lib: *path*
966 Colon-separated list of additional directories that hold extension
967 scripts. When looking for extensions specified by the "perl"
968 resource, rxvt will first look in these directories and then in
969 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
970 will be ignored when running setuid/setgid.
971
972 See the rxvtperl(3) manpage.
973
974 selection.pattern-*idx*: *perl-regex*
975 Additional selection patterns, see the rxvtperl(3) manpage for
976 details.
977
978 selection-autotransform.*idx*: *perl-transform*
979 Selection auto-transform patterns, see the rxvtperl(3) manpage for
980 details.
981
982 searchable-scrollback: *keysym*
983 Sets the hotkey that starts the incremental scrollback buffer search
984 (default: "M-s").
985
986 urlLauncher: *string*
987 Specifies the program to be started with a URL argument. Used by the
988 "selection-popup" and "mark-urls" perl extensions.
989
990 transient-for: *windowid*
991 Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given
992 window id.
993
994 override-redirect: *boolean*
995 Compile *frills*: Sets override-redirect for the terminal window,
996 making it almost invisible to window managers; option
997 -override-redirect.
841 998
842THE SCROLLBAR 999THE SCROLLBAR
843 Lines of text that scroll off the top of the rxvt window (resource: 1000 Lines of text that scroll off the top of the rxvt window (resource:
844 saveLines) and can be scrolled back using the scrollbar or by 1001 saveLines) and can be scrolled back using the scrollbar or by
845 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1002 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
… …
872 entire logical line (which can span multiple screen lines), unless 1029 entire logical line (which can span multiple screen lines), unless
873 modified by resource tripleclickwords. 1030 modified by resource tripleclickwords.
874 1031
875 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 1032 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
876 (Compile: *frills*) will create a rectangular selection instead of a 1033 (Compile: *frills*) will create a rectangular selection instead of a
877 normal one. 1034 normal one. In this mode, every selected row becomes its own line in
1035 the selection, and trailing whitespace is visually underlined and
1036 removed from the selection.
878 1037
879 Insertion: 1038 Insertion:
880 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1039 Pressing and releasing the Middle mouse button in an rxvt window
881 an rxvt window causes the current text selection to be inserted as 1040 causes the value of the PRIMARY selection (Shift for CLIPBOARD) to
882 if it had been typed on the keyboard. 1041 be inserted as if it had been typed on the keyboard. Shift-Insert
1042 causes the value of the PRIMARY selection to be inserted too.
883 1043
884CHANGING FONTS 1044CHANGING FONTS
885 Changing fonts (or font sizes, respectively) via the keypad is not yet 1045 Changing fonts (or font sizes, respectively) via the keypad is not yet
886 supported in rxvt-unicode. Bug me if you need this. 1046 supported in rxvt-unicode. Bug me if you need this.
887 1047
888 You can, however, switch fonts at runtime using escape sequences (and 1048 You can, however, switch fonts at runtime using escape sequences, e.g.:
889 therefore using the menubar), e.g.:
890 1049
891 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1050 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1051
1052 You can use keyboard shortcuts, too:
1053
1054 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1055 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
892 1056
893 rxvt-unicode will automatically re-apply these fonts to the output so 1057 rxvt-unicode will automatically re-apply these fonts to the output so
894 far. 1058 far.
895 1059
896ISO 14755 SUPPORT 1060ISO 14755 SUPPORT
… …
1032 display in it's child processes. 1196 display in it's child processes.
1033 1197
1034 SHELL 1198 SHELL
1035 The shell to be used for command execution, defaults to "/bin/sh". 1199 The shell to be used for command execution, defaults to "/bin/sh".
1036 1200
1037 RXVTPATH
1038 The path where rxvt looks for support files such as menu and xpm
1039 files.
1040
1041 PATH
1042 Used in the same way as "RXVTPATH".
1043
1044 RXVT_SOCKET 1201 RXVT_SOCKET
1045 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).
1046 1203
1047 Default "$HOME/.rxvt-unicode-<nodename". 1204 Default $HOME/.rxvt-unicode-*<nodename*.
1048 1205
1049 HOME 1206 HOME
1050 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
1051 daemon communications and to locate various resource files (such as 1208 daemon communications and to locate various resource files (such as
1052 ".Xdefaults") 1209 ".Xdefaults")
… …
1061FILES 1218FILES
1062 /usr/lib/X11/rgb.txt 1219 /usr/lib/X11/rgb.txt
1063 Color names. 1220 Color names.
1064 1221
1065SEE ALSO 1222SEE ALSO
1066 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),
1067 1224 tty(4), utmp(5)
1068BUGS
1069 Check the BUGS file for an up-to-date list.
1070
1071 Cursor change support is not yet implemented.
1072
1073 Click-and-drag doesn't work with X11 mouse report overriding.
1074 1225
1075CURRENT PROJECT COORDINATOR 1226CURRENT PROJECT COORDINATOR
1076 Project Coordinator 1227 Project Coordinator
1077 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1228 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1078 1229
… …
1095 1246
1096 Oezguer Kesim <kesim@math.fu-berlin.de> 1247 Oezguer Kesim <kesim@math.fu-berlin.de>
1097 Project Coordinator (changes.txt 2.21a to 2.4.5) 1248 Project Coordinator (changes.txt 2.21a to 2.4.5)
1098 1249
1099 Geoff Wing <gcw@pobox.com> 1250 Geoff Wing <gcw@pobox.com>
1100 Rewrote screen display and text selection routines. Project 1251 Rewrote screen display and text selection routines.
1252
1101 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1253 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1102 1254
1103 Marc Alexander Lehmann <rxvt-unicode@schmorp.de> 1255 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1104 Forked rxvt-unicode, rewrote most of the display code and internal 1256 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1105 character handling to store text in unicode, improve xterm 1257 perl extension, random hacks, numerous bugfixes and extensions.
1106 compatibility and apply numerous other bugfixes and extensions.
1107 1258
1108 Project Coordinator (Changes 1.0 -) 1259 Project Coordinator (Changes 1.0 -)
1109 1260
1261 Emanuele Giaquinta <e.giaquinta@glauco.it>
1262 Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1263

Diff Legend

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