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

Comparing cvsroot/rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.13 by root, Mon Feb 14 10:44:50 2005 UTC vs.
Revision 1.55 by root, Sun Jan 29 22:38:43 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 , is a colour vt102 terminal emulator intended as 9 rxvt-unicode, version 7.4, is a colour vt102 terminal emulator intended
10 an *xterm*(1) replacement for users who do not require features such as 10 as an *xterm*(1) replacement for users who do not require features such
11 Tektronix 4014 emulation and toolkit-style configurability. As a result, 11 as Tektronix 4014 emulation and toolkit-style configurability. As a
12 rxvt-unicode uses much less swap space -- a significant advantage on a 12 result, rxvt-unicode uses much less swap space -- a significant
13 machine serving many X sessions. 13 advantage on a machine serving many X sessions.
14 14
15FREQUENTLY ASKED QUESTIONS 15FREQUENTLY ASKED QUESTIONS
16 See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions 16 See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions
17 and answer to them and some common problems. That document is also 17 and answer to them and some common problems. That document is also
18 accessible on the World-Wide-Web at 18 accessible on the World-Wide-Web at
… …
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 -xrm *resourcestring* 361 -embed *windowid*
320 No effect on rxvt-unicode. Simply passes through an argument to be 362 Tells rxvt to embed it's windows into an already-existing window,
321 made available in the instance's argument list. Appears in 363 which enables applications to easily embed a terminal.
322 *WM_COMMAND* in some window managers. 364
365 Right now, rxvt will first unmap/map the specified window, so it
366 shouldn't be a top-level window. rxvt will also reconfigure it quite
367 a bit, so don't expect it to keep some specific state. It's best to
368 create an extra subwindow for rxvt and leave it alone.
369
370 The window will not be destroyed when rxvt exits.
371
372 It might be useful to know that rxvt will not close file descriptors
373 passed to it (except for stdin/out/err, of course), so you can use
374 file descriptors to communicate with the programs within the
375 terminal. This works regardless of wether the "-embed" option was
376 used or not.
377
378 Here is a short Gtk2-perl snippet that illustrates how this option
379 can be used (a longer example is in doc/embed):
380
381 my $rxvt = new Gtk2::Socket;
382 $rxvt->signal_connect_after (realize => sub {
383 my $xid = $_[0]->window->get_xid;
384 system "rxvt -embed $xid &";
385 });
386
387 -pty-fd *file descriptor*
388 Tells rxvt NOT to execute any commands or create a new pty/tty pair
389 but instead use the given filehandle as the tty master. This is
390 useful if you want to drive rxvt as a generic terminal emulator
391 without having to run a program within it.
392
393 If this switch is given, rxvt will not create any utmp/wtmp entries
394 and will not tinker with pty/tty permissions - you have to do that
395 yourself if you want that.
396
397 As an extremely special case, specifying -1 will completely suppress
398 pty/tty operations.
399
400 Here is a example in perl that illustrates how this option can be
401 used (a longer example is in doc/pty-fd):
402
403 use IO::Pty;
404 use Fcntl;
405
406 my $pty = new IO::Pty;
407 fcntl $pty, F_SETFD, 0; # clear close-on-exec
408 system "rxvt -pty-fd " . (fileno $pty) . "&";
409 close $pty;
410
411 # now communicate with rxvt
412 my $slave = $pty->slave;
413 while (<$slave>) { print $slave "got <$_>\n" }
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.
323 418
324RESOURCES (available also as long-options) 419RESOURCES (available also as long-options)
325 Note: `rxvt --help' gives a list of all resources (long options) 420 Note: `rxvt --help' gives a list of all resources (long options)
326 compiled into your version. 421 compiled into your version.
327 422
328 There are two different methods that rxvt can use to get the Xresource
329 data: using the X libraries (Xrm*-functions) or internal Xresources
330 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
331 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
332 xrdb. Many distribution do also load settings from the ~/.Xresources 424 distribution do also load settings from the ~/.Xresources file when X
333 file when X starts. rxvt will consult the following files/resources in 425 starts. rxvt will consult the following files/resources in order, with
334 order, with later settings overwriting earlier ones: 426 later settings overwriting earlier ones:
335 427
336 1. system-wide app-defaults file, either locale-dependent OR global 428 1. system-wide app-defaults file, either locale-dependent OR global
337 2. app-defaults file in $XAPPLRESDIR 429 2. app-defaults file in $XAPPLRESDIR
338 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 430 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
339 4. SCREEN_RESOURCES for the current screen 431 4. SCREEN_RESOURCES for the current screen
340 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 432 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
341 433
342 If compiled with internal Xresources support (i.e. rxvt -h lists 434 Note that when reading X resources, rxvt recognizes two class names:
343 .Xdefaults) then rxvt accepts application defaults set in 435 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
344 XAPPLOADDIR/URxvt (compile-time defined: usually 436 and the original *rxvt* to be easily configured, while the class name
345 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 437 URxvt allows resources unique to rxvt, to be shared between different
346 ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X
347 resources, rxvt recognizes two class names: XTerm and URxvt. The class
348 name Rxvt allows resources common to both rxvt and the original *rxvt*
349 to be easily configured, while the class name URxvt allows resources
350 unique to rxvt, notably colours and key-handling, to be shared between
351 different rxvt configurations. If no resources are specified, suitable 438 rxvt configurations. If no resources are specified, suitable defaults
352 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
353 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.
354 447
355 geometry: *geom* 448 geometry: *geom*
356 Create the window with the specified X window geometry [default 449 Create the window with the specified X window geometry [default
357 80x24]; option -geometry. 450 80x24]; option -geometry.
358 451
… …
420 inheritPixmap: *boolean* 513 inheritPixmap: *boolean*
421 True: make the background inherit the parent windows' pixmap, giving 514 True: make the background inherit the parent windows' pixmap, giving
422 artificial transparency. False: do not inherit the parent windows' 515 artificial transparency. False: do not inherit the parent windows'
423 pixmap. 516 pixmap.
424 517
518 *Please note that transparency of any kind if completely unsupported
519 by the author. Don't bug him with installation questions!*
520
425 fading: *number* 521 fading: *number*
426 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.
427 528
428 tintColor: *colour* 529 tintColor: *colour*
429 Tint the transparent background pixmap with the given colour. 530 Tint the transparent background pixmap with the given colour; option
531 -tint.
430 532
431 shading: *number* 533 shading: *number*
432 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 534 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
433 image in addition to tinting it. 535 image in addition to tinting it.
434 536
435 scrollColor: *colour* 537 scrollColor: *colour*
436 Use the specified colour for the scrollbar [default #B2B2B2]. 538 Use the specified colour for the scrollbar [default #B2B2B2].
437 539
438 troughColor: *colour* 540 troughColor: *colour*
439 Use the specified colour for the scrollbar's trough area [default 541 Use the specified colour for the scrollbar's trough area [default
440 #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 542 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
441 543
442 borderColor: *colour* 544 borderColor: *colour*
443 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
444 scrollbar and the text. 546 scrollbar and the text.
445 547
… …
452 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
453 specifies an integer number of images in that direction. No image 555 specifies an integer number of images in that direction. No image
454 will be magnified beyond 10 times its original size. The maximum 556 will be magnified beyond 10 times its original size. The maximum
455 permitted scale is 1000. [default 0x0+50+50] 557 permitted scale is 1000. [default 0x0+50+50]
456 558
457 menu: *file[;tag]*
458 Read in the specified menu file (note the `.menu' extension is
459 optional) and also optionally specify a starting tag to find. See
460 the reference documentation for details on the syntax for the
461 menuBar.
462
463 path: *path* 559 path: *path*
464 Specify the colon-delimited search path for finding files (XPM and 560 Specify the colon-delimited search path for finding XPM files.
465 menus), in addition to the paths specified by the RXVTPATH and PATH
466 environment variables.
467 561
468 font: *fontlist* 562 font: *fontlist*
469 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
470 names that are used in turn when trying to display Unicode 564 names that are checked in order when trying to find glyphs for
471 characters. The first font defines the cell size for characters; 565 characters. The first font defines the cell size for characters;
472 other fonts might be smaller, but not larger. A reasonable default 566 other fonts might be smaller, but not (in general) larger. A
473 font list is always appended to it. option -fn. 567 (hopefully) reasonable default font list is always appended to it;
568 option -fn.
474 569
475 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
476 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 571 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
477 "xft:". 572 "xft:".
478 573
… …
481 available hint currently is "codeset=codeset-name", and this is only 576 available hint currently is "codeset=codeset-name", and this is only
482 used for Xft fonts. 577 used for Xft fonts.
483 578
484 For example, this font resource 579 For example, this font resource
485 580
486 URxvt*font: 9x15bold,\ 581 URxvt.font: 9x15bold,\
487 -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,\
488 -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, \
489 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 584 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
490 xft:Code2000:antialias=false 585 xft:Code2000:antialias=false
491 586
… …
524 tried. 619 tried.
525 620
526 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
527 normal text font will being used for the given style. 622 normal text font will being used for the given style.
528 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
529 selectstyle: *mode* 631 selectstyle: *mode*
530 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
531 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
532 gives xterm style selection. 634 gives xterm style selection.
533 635
534 scrollstyle: *mode* 636 scrollstyle: *mode*
535 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
536 author's favourite.. 638 author's favourite.
537 639
538 title: *string* 640 title: *string*
539 Set window title string, the default title is the command-line 641 Set window title string, the default title is the command-line
540 specified after the -e option, if any, otherwise the application 642 specified after the -e option, if any, otherwise the application
541 name; option -title. 643 name; option -title.
… …
566 print-pipe: *string* 668 print-pipe: *string*
567 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use 669 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use
568 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
569 Shift-Print to include the scrollback as well. 671 Shift-Print to include the scrollback as well.
570 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".
681
571 scrollBar: *boolean* 682 scrollBar: *boolean*
572 True: enable the scrollbar [default]; option -sb. False: disable the 683 True: enable the scrollbar [default]; option -sb. False: disable the
573 scrollbar; option +sb. 684 scrollbar; option +sb.
574 685
575 scrollBar_right: *boolean* 686 scrollBar_right: *boolean*
… …
588 True: scroll to bottom when tty receives output; option -si. False: 699 True: scroll to bottom when tty receives output; option -si. False:
589 do not scroll to bottom when tty receives output; option +si. 700 do not scroll to bottom when tty receives output; option +si.
590 701
591 scrollWithBuffer: *boolean* 702 scrollWithBuffer: *boolean*
592 True: scroll with scrollback buffer when tty receives new lines (and 703 True: scroll with scrollback buffer when tty receives new lines (and
593 scrollTtyOutput is False); option +sw. False: do not scroll with 704 scrollTtyOutput is False); option -sw. False: do not scroll with
594 scrollback buffer when tty recieves new lines; option -sw. 705 scrollback buffer when tty recieves new lines; option +sw.
595 706
596 scrollTtyKeypress: *boolean* 707 scrollTtyKeypress: *boolean*
597 True: scroll to bottom when a non-special key is pressed. Special 708 True: scroll to bottom when a non-special key is pressed. Special
598 keys are those which are intercepted by rxvt-unicode for special 709 keys are those which are intercepted by rxvt-unicode for special
599 handling and are not passed onto the shell; option -sk. False: do 710 handling and are not passed onto the shell; option -sk. False: do
… …
614 borderLess: *boolean* 725 borderLess: *boolean*
615 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
616 the WM, the rxvt-unicode window will not have window decorations; 727 the WM, the rxvt-unicode window will not have window decorations;
617 option -bl. 728 option -bl.
618 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
619 termName: *termname* 736 termName: *termname*
620 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
621 variable; option -tn. 738 variable; option -tn.
622 739
623 linespace: *number* 740 linespace: *number*
… …
651 pointerColor2: *colour* 768 pointerColor2: *colour*
652 Mouse pointer background colour. 769 Mouse pointer background colour.
653 770
654 pointerBlankDelay: *number* 771 pointerBlankDelay: *number*
655 Specifies number of seconds before blanking the pointer [default 2]. 772 Specifies number of seconds before blanking the pointer [default 2].
773 Use a large number (e.g. 987654321) to effectively disable the
774 timeout.
656 775
657 backspacekey: *string* 776 backspacekey: *string*
658 The string to send when the backspace key is pressed. If set to DEC 777 The string to send when the backspace key is pressed. If set to DEC
659 or unset it will send Delete (code 127) or, if shifted, Backspace 778 or unset it will send Delete (code 127) or, if shifted, Backspace
660 (code 8) - which can be reversed with the appropriate DEC private 779 (code 8) - which can be reversed with the appropriate DEC private
… …
664 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)
665 is pressed. If unset it will send the sequence traditionally 784 is pressed. If unset it will send the sequence traditionally
666 associated with the Execute key. 785 associated with the Execute key.
667 786
668 cutchars: *string* 787 cutchars: *string*
669 The characters used as delimiters for double-click word selection. 788 The characters used as delimiters for double-click word selection
670 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:
671 799
672 BACKSLASH `"'&()*,;<=>?@[]{|} 800 BACKSLASH `"'&()*,;<=>?@[]{|}
673 801
674 preeditType: *style* 802 preeditType: *style*
675 OverTheSpot, OffTheSpot, Root; option -pt. 803 OverTheSpot, OffTheSpot, Root; option -pt.
… …
679 807
680 imLocale: *name* 808 imLocale: *name*
681 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
682 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
683 the input extension to be able to input japanese characters while 811 the input extension to be able to input japanese characters while
684 staying in another locale. option -imlocale. 812 staying in another locale; option -imlocale.
685 813
686 imFont: *fontset* 814 imFont: *fontset*
687 Specify the font-set used for XIM styles "OverTheSpot" or 815 Specify the font-set used for XIM styles "OverTheSpot" or
688 "OffTheSpot". It must be a standard X font set (XLFD patterns 816 "OffTheSpot". It must be a standard X font set (XLFD patterns
689 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
… …
692 to the base font. option -imfont. 820 to the base font. option -imfont.
693 821
694 tripleclickwords: *boolean* 822 tripleclickwords: *boolean*
695 Change the meaning of triple-click selection with the left mouse 823 Change the meaning of triple-click selection with the left mouse
696 button. Instead of selecting a full line it will extend the 824 button. Instead of selecting a full line it will extend the
697 selection to the end of the logical line only. option -tcw. 825 selection to the end of the logical line only; option -tcw.
698 826
699 insecure: *boolean* 827 insecure: *boolean*
700 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 828 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
701 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
702 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,
703 whether throuh a mail client displaying mail bodies unfiltered or 831 whether through a mail client displaying mail bodies unfiltered or
704 though write(1). Therefore, these sequences are disabled by default. 832 through write(1) or any other means. Therefore, these sequences are
705 (Note that other terminals, including xterm, have these sequences 833 disabled by default. (Note that many other terminals, including
706 enabled by default). You can enable them by setting this boolean 834 xterm, have these sequences enabled by default, which doesn't make
707 resource or specifying -insecure as an option. At the moment, this 835 it safer, though).
708 enabled display-answer, locale, findfont, icon label and window 836
709 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.
710 840
711 modifier: *modifier* 841 modifier: *modifier*
712 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,
713 super, mod1, mod2, mod3, mod4, mod5; option -mod. 843 super, mod1, mod2, mod3, mod4, mod5; option -mod.
714 844
715 answerbackString: *string* 845 answerbackString: *string*
716 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
717 (control-E) character is passed through. It may contain escape 847 (control-E) character is passed through. It may contain escape
718 values as described in the entry on keysym following. 848 values as described in the entry on keysym following.
719 849
720 secondaryScreen: *bool* 850 secondaryScreen: *boolean*
721 Turn on/off secondary screen (default enabled). 851 Turn on/off secondary screen (default enabled).
722 852
723 secondaryScroll: *bool* 853 secondaryScroll: *boolean*
724 Turn on/off secondary screen scroll (default enabled). If the this 854 Turn on/off secondary screen scroll (default enabled). If the this
725 option is enabled, scrolls on the secondary screen will change the 855 option is enabled, scrolls on the secondary screen will change the
726 scrollback buffer and switching to/from the secondary screen will 856 scrollback buffer and switching to/from the secondary screen will
727 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.
728 864
729 keysym.*sym*: *string* 865 keysym.*sym*: *string*
730 Compile *frills*: Associate *string* with keysym *sym*. The 866 Compile *frills*: Associate *string* with keysym *sym*. The
731 intervening resource name keysym. cannot be omitted. 867 intervening resource name keysym. cannot be omitted.
732 868
… …
751 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 887 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
752 "\000": octal number) or verbatim control characters ("^?": delete, 888 "\000": octal number) or verbatim control characters ("^?": delete,
753 "^@": null, "^A" ...) and may be enclosed with double quotes so that 889 "^@": null, "^A" ...) and may be enclosed with double quotes so that
754 it can start or end with whitespace. 890 it can start or end with whitespace.
755 891
756 Please note that you need to double the "\" when using 892 Please note that you need to double the "\" in resource files, as
757 "--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
758 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
759 both Xt and rxvt's own processing). 895 processing).
760 896
761 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
762 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 898 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
763 `/' should be a character not used by the strings. 899 `/' should be a character not used by the strings.
764 900
… …
777 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
778 Control-Meta-c is being pressed": 914 Control-Meta-c is being pressed":
779 915
780 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
781 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
924
925 Due the the large number of modifier combinations, a defined key
926 mapping will match if at *at least* the specified identifiers are
927 being set, and no other key mappings with those and more bits are
928 being defined. That means that defining a key map for "a" will
929 automatically provide definitions for "Meta-a", "Shift-a" and so on,
930 unless some of those are defined mappings themselves.
931
932 Unfortunately, this will override built-in key mappings. For example
933 if you overwrite the "Insert" key you will disable rxvt's
934 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
935 the user-defined keymap using the "builtin:" replacement:
936
937 URxvt.keysym.Insert: <my insert key sequence>
938 URxvt.keysym.S-Insert: builtin:
939
940 The first line defines a mapping for "Insert" and *any* combination
941 of modifiers. The second line re-establishes the default mapping for
942 "Shift-Insert".
943
782 The following example will map Control-Meta-1 and Control-Meta-2 to 944 The following example will map Control-Meta-1 and Control-Meta-2 to
783 the fonts "suxuseuro" and "9x15bold", so you can have some limited 945 the fonts "suxuseuro" and "9x15bold", so you can have some limited
784 font-switching at runtime: 946 font-switching at runtime:
785 947
786 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 948 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
… …
789 Other things are possible, e.g. resizing (see rxvt(7) for more 951 Other things are possible, e.g. resizing (see rxvt(7) for more
790 info): 952 info):
791 953
792 URxvt.keysym.M-C-3: command:\033[8;25;80t 954 URxvt.keysym.M-C-3: command:\033[8;25;80t
793 URxvt.keysym.M-C-4: command:\033[8;48;110t 955 URxvt.keysym.M-C-4: command:\033[8;48;110t
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.
794 1021
795THE SCROLLBAR 1022THE SCROLLBAR
796 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:
797 saveLines) and can be scrolled back using the scrollbar or by 1024 saveLines) and can be scrolled back using the scrollbar or by
798 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1025 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
… …
825 entire logical line (which can span multiple screen lines), unless 1052 entire logical line (which can span multiple screen lines), unless
826 modified by resource tripleclickwords. 1053 modified by resource tripleclickwords.
827 1054
828 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)
829 (Compile: *frills*) will create a rectangular selection instead of a 1056 (Compile: *frills*) will create a rectangular selection instead of a
830 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.
831 1060
832 Insertion: 1061 Insertion:
833 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1062 Pressing and releasing the Middle mouse button in an rxvt window
834 an rxvt window causes the current text selection to be inserted as 1063 causes the value of the PRIMARY selection (or CLIPBOARD with the
835 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.
836 1069
837CHANGING FONTS 1070CHANGING FONTS
838 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
839 supported in rxvt-unicode. Bug me if you need this. 1072 supported in rxvt-unicode. Bug me if you need this.
840 1073
841 You can, however, switch fonts at runtime using escape sequences (and 1074 You can, however, switch fonts at runtime using escape sequences, e.g.:
842 therefore using the menubar), e.g.:
843 1075
844 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
845 1082
846 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
847 far. 1084 far.
848 1085
849ISO 14755 SUPPORT 1086ISO 14755 SUPPORT
… …
912 setgid to root or to some other group on others. 1149 setgid to root or to some other group on others.
913 1150
914COLORS AND GRAPHICS 1151COLORS AND GRAPHICS
915 In addition to the default foreground and background colours, rxvt can 1152 In addition to the default foreground and background colours, rxvt can
916 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
917 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.
918 names.
919 1155
920 color0 (black) = Black 1156 color0 (black) = Black
921 color1 (red) = Red3 1157 color1 (red) = Red3
922 color2 (green) = Green3 1158 color2 (green) = Green3
923 color3 (yellow) = Yellow3 1159 color3 (yellow) = Yellow3
… …
939 It is also possible to specify the colour values of foreground, 1175 It is also possible to specify the colour values of foreground,
940 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1176 background, cursorColor, cursorColor2, colorBD, colorUL as a number
941 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
942 color0-color15. 1178 color0-color15.
943 1179
1180 If Xft support has been compiled in and as long as Xft/Xrender/X don't
1181 get their act together, rxvt-unicode will support
1182 "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4
1183 digits/component), "#ARGB", "#AARRGGBB" and "#AAAARRRRGGGGBBBB" colour
1184 specifications, in addition to the ones provided by X, where the
1185 additional A component specifies alpha (opacity) values (0 is completely
1186 transparent and the maximum is opaque). You probably need to specify
1187 "-depth 32", too, and have the luck that your X-server uses ARGB pixel
1188 layout, as X is far from just supporting ARGB visuals out of the box,
1189 and rxvt-unicode just fudges around.
1190
1191 *Please note that transparency of any kind if completely unsupported by
1192 the author. Don't bug him with installation questions!*
1193
944 Note that -rv ("reverseVideo: True") simulates reverse video by always 1194 Note that -rv ("reverseVideo: True") simulates reverse video by always
945 swapping the foreground/background colours. This is in contrast to 1195 swapping the foreground/background colours. This is in contrast to
946 *xterm*(1) where the colours are only swapped if they have not otherwise 1196 *xterm*(1) where the colours are only swapped if they have not otherwise
947 been specified. For example, 1197 been specified. For example,
948 1198
… …
985 display in it's child processes. 1235 display in it's child processes.
986 1236
987 SHELL 1237 SHELL
988 The shell to be used for command execution, defaults to "/bin/sh". 1238 The shell to be used for command execution, defaults to "/bin/sh".
989 1239
990 RXVTPATH
991 The path where rxvt looks for support files such as menu and xpm
992 files.
993
994 PATH
995 Used in the same way as "RXVTPATH".
996
997 RXVT_SOCKET 1240 RXVT_SOCKET
998 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1241 The unix domain socket path used by rxvtc(1) and rxvtd(1).
999 1242
1000 Default "$HOME/.rxvt-unicode-<nodename". 1243 Default $HOME/.rxvt-unicode-*<nodename*.
1001 1244
1002 HOME 1245 HOME
1003 Used to locate the default directory for the unix domain socket for 1246 Used to locate the default directory for the unix domain socket for
1004 daemon communications and to locate various resource files (such as 1247 daemon communications and to locate various resource files (such as
1005 ".Xdefaults") 1248 ".Xdefaults")
… …
1014FILES 1257FILES
1015 /usr/lib/X11/rgb.txt 1258 /usr/lib/X11/rgb.txt
1016 Color names. 1259 Color names.
1017 1260
1018SEE ALSO 1261SEE ALSO
1019 rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1262 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
1020 1263 tty(4), utmp(5)
1021BUGS
1022 Check the BUGS file for an up-to-date list.
1023
1024 Cursor change support is not yet implemented.
1025
1026 Click-and-drag doesn't work with X11 mouse report overriding.
1027 1264
1028CURRENT PROJECT COORDINATOR 1265CURRENT PROJECT COORDINATOR
1029 Project Coordinator 1266 Project Coordinator
1030 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1267 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1031 1268
… …
1048 1285
1049 Oezguer Kesim <kesim@math.fu-berlin.de> 1286 Oezguer Kesim <kesim@math.fu-berlin.de>
1050 Project Coordinator (changes.txt 2.21a to 2.4.5) 1287 Project Coordinator (changes.txt 2.21a to 2.4.5)
1051 1288
1052 Geoff Wing <gcw@pobox.com> 1289 Geoff Wing <gcw@pobox.com>
1053 Rewrote screen display and text selection routines. Project 1290 Rewrote screen display and text selection routines.
1291
1054 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1292 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1055 1293
1056 Marc Alexander Lehmann <rxvt-unicode@schmorp.de> 1294 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1057 Forked rxvt-unicode, rewrote most of the display code and internal 1295 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1058 character handling to store text in unicode, improve xterm 1296 perl extension, random hacks, numerous bugfixes and extensions.
1059 compatibility and apply numerous other bugfixes and extensions.
1060 1297
1061 Project Coordinator (Changes 1.0 -) 1298 Project Coordinator (Changes 1.0 -)
1062 1299
1300 Emanuele Giaquinta <e.giaquinta@glauco.it>
1301 Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1302

Diff Legend

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