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

Diff Legend

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