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

Comparing cvsroot/rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.14 by root, Mon Feb 14 18:47:54 2005 UTC vs.
Revision 1.50 by root, Fri Jan 20 22:49:34 2006 UTC

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

Diff Legend

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