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.21 by root, Fri Apr 22 02:09:39 2005 UTC vs.
Revision 1.54 by root, Sun Jan 29 21:45:47 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.5, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 7.4, 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
… …
84 -display *displayname* 84 -display *displayname*
85 Attempt to open a window on the named X display (-d still 85 Attempt to open a window on the named X display (-d still
86 respected). In the absence of this option, the display specified by 86 respected). In the absence of this option, the display specified by
87 the DISPLAY environment variable is used. 87 the DISPLAY environment variable is used.
88 88
89 -depth *bitdepth*
90 Compile *frills*: Attempt to find a visual with the given bit depth;
91 resource depth.
92
89 -geometry *geom* 93 -geometry *geom*
90 Window geometry (-g still respected); resource geometry. 94 Window geometry (-g still respected); resource geometry.
91 95
92 -rv|+rv 96 -rv|+rv
93 Turn on/off simulated reverse video; resource reverseVideo. 97 Turn on/off simulated reverse video; resource reverseVideo.
94 98
95 -j|+j 99 -j|+j
96 Turn on/off jump scrolling; resource jumpScroll. 100 Turn on/off jump scrolling; resource jumpScroll.
97 101
98 -ip|+ip 102 -ip|+ip | -tr|+tr
99 Turn on/off inheriting parent window's pixmap. Alternative form is 103 Turn on/off inheriting parent window's pixmap. Alternative form is
100 -tr; resource inheritPixmap. 104 -tr; resource inheritPixmap.
101 105
102 -fade *number* 106 -fade *number*
103 Fade the text by the given percentage when focus is lost. resource 107 Fade the text by the given percentage when focus is lost. Small
104 fading. 108 values fade a little only, 100 completely replaces all colours by
109 the fade colour; resource fading.
110
111 -fadecolor *colour*
112 Fade to this colour when fading is used (see -fade). The default
113 colour is black. resource fadeColor.
105 114
106 -tint *colour* 115 -tint *colour*
107 Tint the transparent background pixmap with the given colour when 116 Tint the transparent background pixmap with the given colour when
108 transparency is enabled with -tr or -ip. See also the -sh option 117 transparency is enabled with -tr or -ip. This only works for
118 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 119 be used to brighten or darken the image in addition to tinting it;
110 tinting it. 120 resource *tintColor*. Example:
121
122 rxvt -tr -tint blue -sh 40
111 123
112 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent 124 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent
113 background image in addition to tinting it (i.e. -tint must be 125 background image in addition to tinting it (i.e. -tint must be
114 specified, too, e.g. "-tint white"). 126 specified, too, e.g. "-tint white").
115 127
… …
138 The colour of the border around the text area and between the 150 The colour of the border around the text area and between the
139 scrollbar and the text; resource borderColor. 151 scrollbar and the text; resource borderColor.
140 152
141 -fn *fontlist* 153 -fn *fontlist*
142 Select the fonts to be used. This is a comma separated list of font 154 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 155 names that are checked in order when trying to find glyphs for
144 characters. The first font defines the cell size for characters; 156 characters. The first font defines the cell size for characters;
145 other fonts might be smaller, but not (in general) larger. A 157 other fonts might be smaller, but not (in general) larger. A
146 (hopefully) reasonable default font list is always appended to it. 158 (hopefully) reasonable default font list is always appended to it.
147 See resource font for more details. 159 See resource font for more details.
148 160
… …
155 167
156 See also the question "How does rxvt-unicode choose fonts?" in the 168 See also the question "How does rxvt-unicode choose fonts?" in the
157 FAQ section of rxvt(7). 169 FAQ section of rxvt(7).
158 170
159 -fb *fontlist* 171 -fb *fontlist*
160 Compile font-styles: The bold font list to use when bold characters 172 Compile *font-styles*: The bold font list to use when bold
161 are to be printed. See resource boldFont for details. 173 characters are to be printed. See resource boldFont for details.
162 174
163 -fi *fontlist* 175 -fi *fontlist*
164 Compile font-styles: The italic font list to use when bold 176 Compile *font-styles*: The italic font list to use when *italic*
165 characters are to be printed. See resource italicFont for details. 177 characters are to be printed. See resource italicFont for details.
166 178
167 -fbi *fontlist* 179 -fbi *fontlist*
168 Compile font-styles: The bold italic font list to use when bold 180 Compile *font-styles*: The bold italic font list to use when *bold
169 characters are to be printed. See resource boldItalicFont for 181 italic* characters are to be printed. See resource boldItalicFont
182 for details.
183
184 -is|+is
185 Compile *font-styles*: Bold/Italic font styles imply high intensity
186 foreground/background (default). See resource intensityStyles for
170 details. 187 details.
171 188
172 -name *name* 189 -name *name*
173 Specify the application name under which resources are to be 190 Specify the application name under which resources are to be
174 obtained, rather than the default executable file name. Name should 191 obtained, rather than the default executable file name. Name should
… …
204 221
205 -sr|+sr 222 -sr|+sr
206 Put scrollbar on right/left; resource scrollBar_right. 223 Put scrollbar on right/left; resource scrollBar_right.
207 224
208 -st|+st 225 -st|+st
209 Display normal (non XTerm/NeXT) scrollbar without/with a trough; 226 Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
210 resource scrollBar_floating. 227 resource scrollBar_floating.
211 228
212 -ptab|+ptab 229 -ptab|+ptab
213 If enabled (default), "Horizontal Tab" characters are being stored 230 If enabled (default), "Horizontal Tab" characters are being stored
214 as actual wide characters in the screen buffer, which makes it 231 as actual wide characters in the screen buffer, which makes it
… …
238 externalBorder. 255 externalBorder.
239 256
240 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e. 257 -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 258 if honoured by the WM, the rxvt-unicode window will not have window
242 decorations; resource borderLess. 259 decorations; resource borderLess.
260
261 -override-redirect
262 Compile *frills*: Sets override-redirect on the window; resource
263 override-redirect.
264
265 -sbg
266 Compile *frills*: Disable the usage of the built-in block
267 graphics/line drawing characters and just rely on what the specified
268 fonts provide. Use this if you have a good font and want to use its
269 block graphic glyphs; resource skipBuiltinGlyphs.
243 270
244 -lsp *number* 271 -lsp *number*
245 Compile *frills*: Lines (pixel height) to insert between each row of 272 Compile *frills*: Lines (pixel height) to insert between each row of
246 the display. Useful to work around font rendering problems; resource 273 the display. Useful to work around font rendering problems; resource
247 linespace. 274 linespace.
… …
259 on the command line. If this option is used, it must be the last on 286 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 287 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, 288 run the program specified by the SHELL environment variable or,
262 failing that, *sh(1)*. 289 failing that, *sh(1)*.
263 290
291 Please note that you must specify a program with arguments. If you
292 want to run shell commands, you have to specify the shell, like
293 this:
294
295 rxvt -e sh -c "shell commands"
296
264 -title *text* 297 -title *text*
265 Window title (-T still respected); the default title is the basename 298 Window title (-T still respected); the default title is the basename
266 of the program specified after the -e option, if any, otherwise the 299 of the program specified after the -e option, if any, otherwise the
267 application name; resource title. 300 application name; resource title.
268 301
… …
311 344
312 -ssr|+ssr 345 -ssr|+ssr
313 Turn on/off secondary screen scroll (default enabled); resource 346 Turn on/off secondary screen scroll (default enabled); resource
314 secondaryScroll. 347 secondaryScroll.
315 348
349 -hold|+hold
350 Turn on/off hold window after exit support. If enabled, rxvt will
351 not immediately destroy its window when the program executed within
352 it exits. Instead, it will wait till it is being killed or closed by
353 the user; resource hold.
354
316 -keysym.*sym* *string* 355 -keysym.*sym* *string*
317 Remap a key symbol. See resource keysym. 356 Remap a key symbol. See resource keysym.
318 357
319 -embed *windowid* 358 -embed *windowid*
320 Tells rxvt to embed it's windows into an already-existing window, 359 Tells rxvt to embed it's windows into an already-existing window,
… …
340 $rxvt->signal_connect_after (realize => sub { 379 $rxvt->signal_connect_after (realize => sub {
341 my $xid = $_[0]->window->get_xid; 380 my $xid = $_[0]->window->get_xid;
342 system "rxvt -embed $xid &"; 381 system "rxvt -embed $xid &";
343 }); 382 });
344 383
345 -pty-fd *fileno* 384 -pty-fd *file descriptor*
346 Tells rxvt NOT to execute any commands or create a new pty/tty pair 385 Tells rxvt NOT to execute any commands or create a new pty/tty pair
347 but instead use the given filehandle as the tty master. This is 386 but instead use the given filehandle as the tty master. This is
348 useful if you want to drive rxvt as a generic terminal emulator 387 useful if you want to drive rxvt as a generic terminal emulator
349 without having to run a program within it. 388 without having to run a program within it.
350 389
351 If this switch is given, rxvt will not create any utmp/wtmp entries 390 If this switch is given, rxvt will not create any utmp/wtmp entries
352 and will not tinker with pty/tty permissions - you have to do that 391 and will not tinker with pty/tty permissions - you have to do that
353 yourself if you want that. 392 yourself if you want that.
354 393
394 As an extremely special case, specifying -1 will completely suppress
395 pty/tty operations.
396
355 Here is a example in perl that illustrates how this option can be 397 Here is a example in perl that illustrates how this option can be
356 used (a longer example is in doc/pty-fd): 398 used (a longer example is in doc/pty-fd):
357 399
358 use IO::Pty; 400 use IO::Pty;
359 use Fcntl; 401 use Fcntl;
… …
365 407
366 # now communicate with rxvt 408 # now communicate with rxvt
367 my $slave = $pty->slave; 409 my $slave = $pty->slave;
368 while (<$slave>) { print $slave "got <$_>\n" } 410 while (<$slave>) { print $slave "got <$_>\n" }
369 411
412 -pe *string*
413 Comma-separated list of perl extension scripts to use (or not to
414 use) in this terminal instance. See resource perl-ext for details.
415
370RESOURCES (available also as long-options) 416RESOURCES (available also as long-options)
371 Note: `rxvt --help' gives a list of all resources (long options) 417 Note: `rxvt --help' gives a list of all resources (long options)
372 compiled into your version. 418 compiled into your version.
373 419
374 There are two different methods that rxvt can use to get the Xresource
375 data: using the X libraries (Xrm*-functions) or internal Xresources
376 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
377 XGetDefaults), you can set and change the resources using X11 tools like 420 You can set and change the resources using X11 tools like xrdb. Many
378 xrdb. Many distribution do also load settings from the ~/.Xresources 421 distribution do also load settings from the ~/.Xresources file when X
379 file when X starts. rxvt will consult the following files/resources in 422 starts. rxvt will consult the following files/resources in order, with
380 order, with later settings overwriting earlier ones: 423 later settings overwriting earlier ones:
381 424
382 1. system-wide app-defaults file, either locale-dependent OR global 425 1. system-wide app-defaults file, either locale-dependent OR global
383 2. app-defaults file in $XAPPLRESDIR 426 2. app-defaults file in $XAPPLRESDIR
384 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 427 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
385 4. SCREEN_RESOURCES for the current screen 428 4. SCREEN_RESOURCES for the current screen
386 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 429 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
387 430
388 If compiled with internal Xresources support (i.e. rxvt -h lists 431 Note that when reading X resources, rxvt recognizes two class names:
389 .Xdefaults) then rxvt accepts application defaults set in 432 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
390 XAPPLOADDIR/URxvt (compile-time defined: usually 433 and the original *rxvt* to be easily configured, while the class name
391 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 434 URxvt allows resources unique to rxvt, to be shared between different
392 ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X
393 resources, rxvt recognizes two class names: XTerm and URxvt. The class
394 name Rxvt allows resources common to both rxvt and the original *rxvt*
395 to be easily configured, while the class name URxvt allows resources
396 unique to rxvt, notably colours and key-handling, to be shared between
397 different rxvt configurations. If no resources are specified, suitable 435 rxvt configurations. If no resources are specified, suitable defaults
398 defaults will be used. Command-line arguments can be used to override 436 will be used. Command-line arguments can be used to override resource
399 resource settings. The following resources are allowed: 437 settings. The following resources are supported (you might want to check
438 the rxvtperl(3) manpage for additional settings by perl extensions not
439 documented here):
440
441 depth: *bitdepth*
442 Compile *frills*: Attempt to find a visual with the given bit depth;
443 option -depth.
400 444
401 geometry: *geom* 445 geometry: *geom*
402 Create the window with the specified X window geometry [default 446 Create the window with the specified X window geometry [default
403 80x24]; option -geometry. 447 80x24]; option -geometry.
404 448
… …
467 True: make the background inherit the parent windows' pixmap, giving 511 True: make the background inherit the parent windows' pixmap, giving
468 artificial transparency. False: do not inherit the parent windows' 512 artificial transparency. False: do not inherit the parent windows'
469 pixmap. 513 pixmap.
470 514
471 fading: *number* 515 fading: *number*
472 Fade the text by the given percentage when focus is lost. 516 Fade the text by the given percentage when focus is lost; option
517 -fade.
518
519 fadeColor: *colour*
520 Fade to this colour, when fading is used (see fading:). The default
521 colour is black; option -fadecolor.
473 522
474 tintColor: *colour* 523 tintColor: *colour*
475 Tint the transparent background pixmap with the given colour. 524 Tint the transparent background pixmap with the given colour; option
525 -tint.
476 526
477 shading: *number* 527 shading: *number*
478 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 528 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
479 image in addition to tinting it. 529 image in addition to tinting it.
480 530
481 scrollColor: *colour* 531 scrollColor: *colour*
482 Use the specified colour for the scrollbar [default #B2B2B2]. 532 Use the specified colour for the scrollbar [default #B2B2B2].
483 533
484 troughColor: *colour* 534 troughColor: *colour*
485 Use the specified colour for the scrollbar's trough area [default 535 Use the specified colour for the scrollbar's trough area [default
486 #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 536 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
487 537
488 borderColor: *colour* 538 borderColor: *colour*
489 The colour of the border around the text area and between the 539 The colour of the border around the text area and between the
490 scrollbar and the text. 540 scrollbar and the text.
491 541
… …
498 scale of 1 displays the image without any scaling. A scale of 2 to 9 548 scale of 1 displays the image without any scaling. A scale of 2 to 9
499 specifies an integer number of images in that direction. No image 549 specifies an integer number of images in that direction. No image
500 will be magnified beyond 10 times its original size. The maximum 550 will be magnified beyond 10 times its original size. The maximum
501 permitted scale is 1000. [default 0x0+50+50] 551 permitted scale is 1000. [default 0x0+50+50]
502 552
503 menu: *file[;tag]*
504 Read in the specified menu file (note the `.menu' extension is
505 optional) and also optionally specify a starting tag to find. See
506 the reference documentation for details on the syntax for the
507 menuBar.
508
509 path: *path* 553 path: *path*
510 Specify the colon-delimited search path for finding files (XPM and 554 Specify the colon-delimited search path for finding XPM files.
511 menus), in addition to the paths specified by the RXVTPATH and PATH
512 environment variables.
513 555
514 font: *fontlist* 556 font: *fontlist*
515 Select the fonts to be used. This is a comma separated list of font 557 Select the fonts to be used. This is a comma separated list of font
516 names that are used in turn when trying to display Unicode 558 names that are checked in order when trying to find glyphs for
517 characters. The first font defines the cell size for characters; 559 characters. The first font defines the cell size for characters;
518 other fonts might be smaller, but not larger. A reasonable default 560 other fonts might be smaller, but not (in general) larger. A
519 font list is always appended to it. option -fn. 561 (hopefully) reasonable default font list is always appended to it;
562 option -fn.
520 563
521 Each font can either be a standard X11 core font (XLFD) name, with 564 Each font can either be a standard X11 core font (XLFD) name, with
522 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 565 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
523 "xft:". 566 "xft:".
524 567
… …
527 available hint currently is "codeset=codeset-name", and this is only 570 available hint currently is "codeset=codeset-name", and this is only
528 used for Xft fonts. 571 used for Xft fonts.
529 572
530 For example, this font resource 573 For example, this font resource
531 574
532 URxvt*font: 9x15bold,\ 575 URxvt.font: 9x15bold,\
533 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 576 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
534 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 577 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
535 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 578 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
536 xft:Code2000:antialias=false 579 xft:Code2000:antialias=false
537 580
… …
570 tried. 613 tried.
571 614
572 If set, but empty, then this specific style is disabled and the 615 If set, but empty, then this specific style is disabled and the
573 normal text font will being used for the given style. 616 normal text font will being used for the given style.
574 617
618 intensityStyles: *boolean*
619 When font styles are not enabled, or this option is enabled (True,
620 option -is, the default), bold and italic font styles imply high
621 intensity foreground/backround colours. Disabling this option
622 (False, option +is) disables this behaviour, the high intensity
623 colours are not reachable.
624
575 selectstyle: *mode* 625 selectstyle: *mode*
576 Set mouse selection style to old which is 2.20, oldword which is 626 Set mouse selection style to old which is 2.20, oldword which is
577 xterm style with 2.20 old word selection, or anything else which 627 xterm style with 2.20 old word selection, or anything else which
578 gives xterm style selection. 628 gives xterm style selection.
579 629
580 scrollstyle: *mode* 630 scrollstyle: *mode*
581 Set scrollbar style to rxvt, plain, next or xterm. plain is the 631 Set scrollbar style to rxvt, plain, next or xterm. plain is the
582 author's favourite.. 632 author's favourite.
583 633
584 title: *string* 634 title: *string*
585 Set window title string, the default title is the command-line 635 Set window title string, the default title is the command-line
586 specified after the -e option, if any, otherwise the application 636 specified after the -e option, if any, otherwise the application
587 name; option -title. 637 name; option -title.
… …
611 661
612 print-pipe: *string* 662 print-pipe: *string*
613 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use 663 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use
614 Print to initiate a screen dump to the printer and Ctrl-Print or 664 Print to initiate a screen dump to the printer and Ctrl-Print or
615 Shift-Print to include the scrollback as well. 665 Shift-Print to include the scrollback as well.
666
667 The string will be interpreted as if typed into the shell as-is.
668
669 Example:
670
671 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
672
673 This creates a new file in your home directory with the screen
674 contents everytime you hit "Print".
616 675
617 scrollBar: *boolean* 676 scrollBar: *boolean*
618 True: enable the scrollbar [default]; option -sb. False: disable the 677 True: enable the scrollbar [default]; option -sb. False: disable the
619 scrollbar; option +sb. 678 scrollbar; option +sb.
620 679
… …
660 borderLess: *boolean* 719 borderLess: *boolean*
661 Set MWM hints to request a borderless window, i.e. if honoured by 720 Set MWM hints to request a borderless window, i.e. if honoured by
662 the WM, the rxvt-unicode window will not have window decorations; 721 the WM, the rxvt-unicode window will not have window decorations;
663 option -bl. 722 option -bl.
664 723
724 skipBuiltinGlyphs: *boolean*
725 Compile *frills*: Disable the usage of the built-in block
726 graphics/line drawing characters and just rely on what the specified
727 fonts provide. Use this if you have a good font and want to use its
728 block graphic glyphs; option -sbg.
729
665 termName: *termname* 730 termName: *termname*
666 Specifies the terminal type name to be set in the TERM environment 731 Specifies the terminal type name to be set in the TERM environment
667 variable; option -tn. 732 variable; option -tn.
668 733
669 linespace: *number* 734 linespace: *number*
… …
712 The string to send when the delete key (not the keypad delete key) 777 The string to send when the delete key (not the keypad delete key)
713 is pressed. If unset it will send the sequence traditionally 778 is pressed. If unset it will send the sequence traditionally
714 associated with the Execute key. 779 associated with the Execute key.
715 780
716 cutchars: *string* 781 cutchars: *string*
717 The characters used as delimiters for double-click word selection. 782 The characters used as delimiters for double-click word selection
718 The built-in default: 783 (whitespace delimiting is added automatically if resource is given).
784
785 When the selection extension is in use (the default if compiled in,
786 see the rxvtperl(3) manpage), a suitable regex using these
787 characters will be created (if the resource exists, otherwise, no
788 regex will be created). In this mode, characters outside ISO-8859-1
789 can be used.
790
791 When the selection extension is not used, only ISO-8859-1 characters
792 can be used. If not specified, the built-in default is used:
719 793
720 BACKSLASH `"'&()*,;<=>?@[]{|} 794 BACKSLASH `"'&()*,;<=>?@[]{|}
721 795
722 preeditType: *style* 796 preeditType: *style*
723 OverTheSpot, OffTheSpot, Root; option -pt. 797 OverTheSpot, OffTheSpot, Root; option -pt.
… …
727 801
728 imLocale: *name* 802 imLocale: *name*
729 The locale to use for opening the IM. You can use an "LC_CTYPE" of 803 The locale to use for opening the IM. You can use an "LC_CTYPE" of
730 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for 804 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for
731 the input extension to be able to input japanese characters while 805 the input extension to be able to input japanese characters while
732 staying in another locale. option -imlocale. 806 staying in another locale; option -imlocale.
733 807
734 imFont: *fontset* 808 imFont: *fontset*
735 Specify the font-set used for XIM styles "OverTheSpot" or 809 Specify the font-set used for XIM styles "OverTheSpot" or
736 "OffTheSpot". It must be a standard X font set (XLFD patterns 810 "OffTheSpot". It must be a standard X font set (XLFD patterns
737 separated by commas), i.e. it's not in the same format as the other 811 separated by commas), i.e. it's not in the same format as the other
… …
740 to the base font. option -imfont. 814 to the base font. option -imfont.
741 815
742 tripleclickwords: *boolean* 816 tripleclickwords: *boolean*
743 Change the meaning of triple-click selection with the left mouse 817 Change the meaning of triple-click selection with the left mouse
744 button. Instead of selecting a full line it will extend the 818 button. Instead of selecting a full line it will extend the
745 selection to the end of the logical line only. option -tcw. 819 selection to the end of the logical line only; option -tcw.
746 820
747 insecure: *boolean* 821 insecure: *boolean*
748 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 822 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
749 that echo arbitrary strings like the icon name or the locale. This 823 that echo arbitrary strings like the icon name or the locale. This
750 could be abused if somebody gets 8-bit-clean access to your display, 824 could be abused if somebody gets 8-bit-clean access to your display,
751 whether throuh a mail client displaying mail bodies unfiltered or 825 whether through a mail client displaying mail bodies unfiltered or
752 though write(1). Therefore, these sequences are disabled by default. 826 through write(1) or any other means. Therefore, these sequences are
753 (Note that other terminals, including xterm, have these sequences 827 disabled by default. (Note that many other terminals, including
754 enabled by default). You can enable them by setting this boolean 828 xterm, have these sequences enabled by default, which doesn't make
755 resource or specifying -insecure as an option. At the moment, this 829 it safer, though).
756 enabled display-answer, locale, findfont, icon label and window 830
757 title requests as well as dynamic menubar dispatch. 831 You can enable them by setting this boolean resource or specifying
832 -insecure as an option. At the moment, this enables display-answer,
833 locale, findfont, icon label and window title requests.
758 834
759 modifier: *modifier* 835 modifier: *modifier*
760 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 836 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
761 super, mod1, mod2, mod3, mod4, mod5; option -mod. 837 super, mod1, mod2, mod3, mod4, mod5; option -mod.
762 838
763 answerbackString: *string* 839 answerbackString: *string*
764 Specify the reply rxvt-unicode sends to the shell when an ENQ 840 Specify the reply rxvt-unicode sends to the shell when an ENQ
765 (control-E) character is passed through. It may contain escape 841 (control-E) character is passed through. It may contain escape
766 values as described in the entry on keysym following. 842 values as described in the entry on keysym following.
767 843
768 secondaryScreen: *bool* 844 secondaryScreen: *boolean*
769 Turn on/off secondary screen (default enabled). 845 Turn on/off secondary screen (default enabled).
770 846
771 secondaryScroll: *bool* 847 secondaryScroll: *boolean*
772 Turn on/off secondary screen scroll (default enabled). If the this 848 Turn on/off secondary screen scroll (default enabled). If the this
773 option is enabled, scrolls on the secondary screen will change the 849 option is enabled, scrolls on the secondary screen will change the
774 scrollback buffer and switching to/from the secondary screen will 850 scrollback buffer and switching to/from the secondary screen will
775 instead scroll the screen up. 851 instead scroll the screen up.
852
853 hold: *boolean*
854 Turn on/off hold window after exit support. If enabled, rxvt will
855 not immediately destroy its window when the program executed within
856 it exits. Instead, it will wait till it is being killed or closed by
857 the user.
776 858
777 keysym.*sym*: *string* 859 keysym.*sym*: *string*
778 Compile *frills*: Associate *string* with keysym *sym*. The 860 Compile *frills*: Associate *string* with keysym *sym*. The
779 intervening resource name keysym. cannot be omitted. 861 intervening resource name keysym. cannot be omitted.
780 862
… …
799 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 881 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
800 "\000": octal number) or verbatim control characters ("^?": delete, 882 "\000": octal number) or verbatim control characters ("^?": delete,
801 "^@": null, "^A" ...) and may be enclosed with double quotes so that 883 "^@": null, "^A" ...) and may be enclosed with double quotes so that
802 it can start or end with whitespace. 884 it can start or end with whitespace.
803 885
804 Please note that you need to double the "\" when using 886 Please note that you need to double the "\" in resource files, as
805 "--enable-xgetdefault", as X itself does it's own de-escaping (you 887 Xlib itself does it's own de-escaping (you can use "\033" instead of
806 can use "\033" instead of "\e" (and so on), which will work with 888 "\e" (and so on), which will work with both Xt and rxvt's own
807 both Xt and rxvt's own processing). 889 processing).
808 890
809 You can define a range of keysyms in one shot by providing a 891 You can define a range of keysyms in one shot by providing a
810 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 892 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
811 `/' should be a character not used by the strings. 893 `/' should be a character not used by the strings.
812 894
… …
824 is interpreted and executed as rxvt's control sequence. For example 906 is interpreted and executed as rxvt's control sequence. For example
825 the following means "change the current locale to "zh_CN.GBK" when 907 the following means "change the current locale to "zh_CN.GBK" when
826 Control-Meta-c is being pressed": 908 Control-Meta-c is being pressed":
827 909
828 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 910 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
911
912 If *string* takes the form "perl:STRING", then the specified STRING
913 is passed to the "on_keyboard_command" perl handler. See the
914 rxvtperl(3) manpage. For example, the selection extension (activated
915 via "rxvt -pe selection") listens for "selection:rot13" events:
916
917 URxvt.keysym.M-C-c: perl:selection:rot13
829 918
830 Due the the large number of modifier combinations, a defined key 919 Due the the large number of modifier combinations, a defined key
831 mapping will match if at *at least* the specified identifiers are 920 mapping will match if at *at least* the specified identifiers are
832 being set, and no other key mappings with those and more bits are 921 being set, and no other key mappings with those and more bits are
833 being defined. That means that defining a key map for "a" will 922 being defined. That means that defining a key map for "a" will
… …
857 info): 946 info):
858 947
859 URxvt.keysym.M-C-3: command:\033[8;25;80t 948 URxvt.keysym.M-C-3: command:\033[8;25;80t
860 URxvt.keysym.M-C-4: command:\033[8;48;110t 949 URxvt.keysym.M-C-4: command:\033[8;48;110t
861 950
951 perl-ext-common: *string*
952 perl-ext: *string*
953 Comma-separated list(s) of perl extension scripts (default:
954 "default") to use in this terminal instance; option -pe.
955
956 Extension names can be prefixed with a "-" sign to prohibit using
957 them. This can be useful to selectively disable some extensions
958 loaded by default, or specified via the "perl-ext-common" resource.
959 For example, "default,-selection" will use all the default extension
960 except "selection".
961
962 Extension names can also be followed by an argument in angle
963 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
964 for searchable scorllback to Alt/Meta-s). Mentioning the same
965 extension multiple times with different arguments will pass multiple
966 arguments to the extension.
967
968 Each extension is looked up in the library directories, loaded if
969 necessary, and bound to the current terminal instance.
970
971 If both of these resources are the empty string, then the perl
972 interpreter will not be initialized. The idea behind two options is
973 that perl-ext-common will be used for extensions that should be
974 available to all instances, while perl-ext is used for specific
975 instances.
976
977 perl-eval: *string*
978 Perl code to be evaluated when all extensions have been registered.
979 See the rxvtperl(3) manpage. Due to security reasons, this resource
980 will be ignored when running setuid/setgid.
981
982 perl-lib: *path*
983 Colon-separated list of additional directories that hold extension
984 scripts. When looking for extensions specified by the "perl"
985 resource, rxvt will first look in these directories and then in
986 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
987 will be ignored when running setuid/setgid.
988
989 See the rxvtperl(3) manpage.
990
991 selection.pattern-*idx*: *perl-regex*
992 Additional selection patterns, see the rxvtperl(3) manpage for
993 details.
994
995 selection-autotransform.*idx*: *perl-transform*
996 Selection auto-transform patterns, see the rxvtperl(3) manpage for
997 details.
998
999 searchable-scrollback: *keysym*
1000 Sets the hotkey that starts the incremental scrollback buffer search
1001 (default: "M-s").
1002
1003 urlLauncher: *string*
1004 Specifies the program to be started with a URL argument. Used by the
1005 "selection-popup" and "mark-urls" perl extensions.
1006
1007 transient-for: *windowid*
1008 Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given
1009 window id.
1010
1011 override-redirect: *boolean*
1012 Compile *frills*: Sets override-redirect for the terminal window,
1013 making it almost invisible to window managers; option
1014 -override-redirect.
1015
862THE SCROLLBAR 1016THE SCROLLBAR
863 Lines of text that scroll off the top of the rxvt window (resource: 1017 Lines of text that scroll off the top of the rxvt window (resource:
864 saveLines) and can be scrolled back using the scrollbar or by 1018 saveLines) and can be scrolled back using the scrollbar or by
865 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1019 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
866 fairly intuitive. The xterm-scrollbar is without arrows and its 1020 fairly intuitive. The xterm-scrollbar is without arrows and its
… …
892 entire logical line (which can span multiple screen lines), unless 1046 entire logical line (which can span multiple screen lines), unless
893 modified by resource tripleclickwords. 1047 modified by resource tripleclickwords.
894 1048
895 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 1049 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
896 (Compile: *frills*) will create a rectangular selection instead of a 1050 (Compile: *frills*) will create a rectangular selection instead of a
897 normal one. 1051 normal one. In this mode, every selected row becomes its own line in
1052 the selection, and trailing whitespace is visually underlined and
1053 removed from the selection.
898 1054
899 Insertion: 1055 Insertion:
900 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1056 Pressing and releasing the Middle mouse button in an rxvt window
901 an rxvt window causes the current text selection to be inserted as 1057 causes the value of the PRIMARY selection (or CLIPBOARD with the
902 if it had been typed on the keyboard. 1058 Meta modifier) to be inserted as if it had been typed on the
1059 keyboard.
1060
1061 Pressing Shift-Insert causes the value of the PRIMARY selection to
1062 be inserted too.
903 1063
904CHANGING FONTS 1064CHANGING FONTS
905 Changing fonts (or font sizes, respectively) via the keypad is not yet 1065 Changing fonts (or font sizes, respectively) via the keypad is not yet
906 supported in rxvt-unicode. Bug me if you need this. 1066 supported in rxvt-unicode. Bug me if you need this.
907 1067
908 You can, however, switch fonts at runtime using escape sequences (and 1068 You can, however, switch fonts at runtime using escape sequences, e.g.:
909 therefore using the menubar), e.g.:
910 1069
911 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1070 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1071
1072 You can use keyboard shortcuts, too:
1073
1074 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1075 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
912 1076
913 rxvt-unicode will automatically re-apply these fonts to the output so 1077 rxvt-unicode will automatically re-apply these fonts to the output so
914 far. 1078 far.
915 1079
916ISO 14755 SUPPORT 1080ISO 14755 SUPPORT
… …
979 setgid to root or to some other group on others. 1143 setgid to root or to some other group on others.
980 1144
981COLORS AND GRAPHICS 1145COLORS AND GRAPHICS
982 In addition to the default foreground and background colours, rxvt can 1146 In addition to the default foreground and background colours, rxvt can
983 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 1147 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
984 versions of the same). Here is a list of the colours with their rgb.txt 1148 versions of the same). Here is a list of the colours with their names.
985 names.
986 1149
987 color0 (black) = Black 1150 color0 (black) = Black
988 color1 (red) = Red3 1151 color1 (red) = Red3
989 color2 (green) = Green3 1152 color2 (green) = Green3
990 color3 (yellow) = Yellow3 1153 color3 (yellow) = Yellow3
… …
1006 It is also possible to specify the colour values of foreground, 1169 It is also possible to specify the colour values of foreground,
1007 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1170 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1008 0-15, as a convenient shorthand to reference the colour name of 1171 0-15, as a convenient shorthand to reference the colour name of
1009 color0-color15. 1172 color0-color15.
1010 1173
1174 If Xft support has been compiled in and as long as Xft/Xrender/X don't
1175 get their act together, rxvt-unicode will support
1176 "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4
1177 digits/component), "#ARGB", "#AARRGGBB" and "#AAAARRRRGGGGBBBB" colour
1178 specifications, in addition to the ones provided by X, where the
1179 additional A component specifies alpha (opacity) values (0 is completely
1180 transparent and the maximum is opaque). You probably need to specify
1181 "-depth 32", too, and have the luck that your X-server uses ARGB pixel
1182 layout, as X is far from just supporting ARGB visuals out of the box,
1183 and rxvt-unicode just fudges around.
1184
1011 Note that -rv ("reverseVideo: True") simulates reverse video by always 1185 Note that -rv ("reverseVideo: True") simulates reverse video by always
1012 swapping the foreground/background colours. This is in contrast to 1186 swapping the foreground/background colours. This is in contrast to
1013 *xterm*(1) where the colours are only swapped if they have not otherwise 1187 *xterm*(1) where the colours are only swapped if they have not otherwise
1014 been specified. For example, 1188 been specified. For example,
1015 1189
… …
1052 display in it's child processes. 1226 display in it's child processes.
1053 1227
1054 SHELL 1228 SHELL
1055 The shell to be used for command execution, defaults to "/bin/sh". 1229 The shell to be used for command execution, defaults to "/bin/sh".
1056 1230
1057 RXVTPATH
1058 The path where rxvt looks for support files such as menu and xpm
1059 files.
1060
1061 PATH
1062 Used in the same way as "RXVTPATH".
1063
1064 RXVT_SOCKET 1231 RXVT_SOCKET
1065 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1232 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1066 1233
1067 Default "$HOME/.rxvt-unicode-<nodename". 1234 Default $HOME/.rxvt-unicode-*<nodename*.
1068 1235
1069 HOME 1236 HOME
1070 Used to locate the default directory for the unix domain socket for 1237 Used to locate the default directory for the unix domain socket for
1071 daemon communications and to locate various resource files (such as 1238 daemon communications and to locate various resource files (such as
1072 ".Xdefaults") 1239 ".Xdefaults")
… …
1081FILES 1248FILES
1082 /usr/lib/X11/rgb.txt 1249 /usr/lib/X11/rgb.txt
1083 Color names. 1250 Color names.
1084 1251
1085SEE ALSO 1252SEE ALSO
1086 rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1253 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
1087 1254 tty(4), utmp(5)
1088BUGS
1089 Check the BUGS file for an up-to-date list.
1090
1091 Cursor change support is not yet implemented.
1092
1093 Click-and-drag doesn't work with X11 mouse report overriding.
1094 1255
1095CURRENT PROJECT COORDINATOR 1256CURRENT PROJECT COORDINATOR
1096 Project Coordinator 1257 Project Coordinator
1097 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1258 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1098 1259
… …
1115 1276
1116 Oezguer Kesim <kesim@math.fu-berlin.de> 1277 Oezguer Kesim <kesim@math.fu-berlin.de>
1117 Project Coordinator (changes.txt 2.21a to 2.4.5) 1278 Project Coordinator (changes.txt 2.21a to 2.4.5)
1118 1279
1119 Geoff Wing <gcw@pobox.com> 1280 Geoff Wing <gcw@pobox.com>
1120 Rewrote screen display and text selection routines. Project 1281 Rewrote screen display and text selection routines.
1282
1121 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1283 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1122 1284
1123 Marc Alexander Lehmann <rxvt-unicode@schmorp.de> 1285 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1124 Forked rxvt-unicode, rewrote most of the display code and internal 1286 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1125 character handling to store text in unicode, improve xterm 1287 perl extension, random hacks, numerous bugfixes and extensions.
1126 compatibility and apply numerous other bugfixes and extensions.
1127 1288
1128 Project Coordinator (Changes 1.0 -) 1289 Project Coordinator (Changes 1.0 -)
1129 1290
1291 Emanuele Giaquinta <e.giaquinta@glauco.it>
1292 Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1293

Diff Legend

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