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.15 by root, Mon Feb 14 18:50:57 2005 UTC vs.
Revision 1.46 by root, Mon Jan 16 15:07:27 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.0, 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 -sbg
258 Compile *frills*: Disable the usage of the built-in block
259 graphics/line drawing characters and just rely on what the specified
260 fonts provide. Use this if you have a good font and want to use its
261 block graphic glyphs; resource skipBuiltinGlyphs.
243 262
244 -lsp *number* 263 -lsp *number*
245 Compile *frills*: Lines (pixel height) to insert between each row of 264 Compile *frills*: Lines (pixel height) to insert between each row of
246 the display. Useful to work around font rendering problems; resource 265 the display. Useful to work around font rendering problems; resource
247 linespace. 266 linespace.
… …
259 on the command line. If this option is used, it must be the last on 278 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 279 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, 280 run the program specified by the SHELL environment variable or,
262 failing that, *sh(1)*. 281 failing that, *sh(1)*.
263 282
283 Please note that you must specify a program with arguments. If you
284 want to run shell commands, you have to specify the shell, like
285 this:
286
287 rxvt -e sh -c "shell commands"
288
264 -title *text* 289 -title *text*
265 Window title (-T still respected); the default title is the basename 290 Window title (-T still respected); the default title is the basename
266 of the program specified after the -e option, if any, otherwise the 291 of the program specified after the -e option, if any, otherwise the
267 application name; resource title. 292 application name; resource title.
268 293
… …
311 336
312 -ssr|+ssr 337 -ssr|+ssr
313 Turn on/off secondary screen scroll (default enabled); resource 338 Turn on/off secondary screen scroll (default enabled); resource
314 secondaryScroll. 339 secondaryScroll.
315 340
341 -hold|+hold
342 Turn on/off hold window after exit support. If enabled, rxvt will
343 not immediately destroy its window when the program executed within
344 it exits. Instead, it will wait till it is being killed or closed by
345 the user; resource hold.
346
316 -keysym.*sym*: *string* 347 -keysym.*sym* *string*
317 Remap a key symbol. See resource keysym. 348 Remap a key symbol. See resource keysym.
318 349
319 -embed: *windowid* 350 -embed *windowid*
320 Tells rxvt to embed it's windows into an already-existing window, 351 Tells rxvt to embed it's windows into an already-existing window,
321 which enables applications to easily embed a terminal. 352 which enables applications to easily embed a terminal.
322 353
323 Right now, rxvt will first unmap/map the specified window, so it 354 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 355 shouldn't be a top-level window. rxvt will also reconfigure it quite
… …
331 passed to it (except for stdin/out/err, of course), so you can use 362 passed to it (except for stdin/out/err, of course), so you can use
332 file descriptors to communicate with the programs within the 363 file descriptors to communicate with the programs within the
333 terminal. This works regardless of wether the "-embed" option was 364 terminal. This works regardless of wether the "-embed" option was
334 used or not. 365 used or not.
335 366
367 Here is a short Gtk2-perl snippet that illustrates how this option
368 can be used (a longer example is in doc/embed):
369
370 my $rxvt = new Gtk2::Socket;
371 $rxvt->signal_connect_after (realize => sub {
372 my $xid = $_[0]->window->get_xid;
373 system "rxvt -embed $xid &";
374 });
375
376 -pty-fd *file descriptor*
377 Tells rxvt NOT to execute any commands or create a new pty/tty pair
378 but instead use the given filehandle as the tty master. This is
379 useful if you want to drive rxvt as a generic terminal emulator
380 without having to run a program within it.
381
382 If this switch is given, rxvt will not create any utmp/wtmp entries
383 and will not tinker with pty/tty permissions - you have to do that
384 yourself if you want that.
385
386 As an extremely special case, specifying -1 will completely suppress
387 pty/tty operations.
388
389 Here is a example in perl that illustrates how this option can be
390 used (a longer example is in doc/pty-fd):
391
392 use IO::Pty;
393 use Fcntl;
394
395 my $pty = new IO::Pty;
396 fcntl $pty, F_SETFD, 0; # clear close-on-exec
397 system "rxvt -pty-fd " . (fileno $pty) . "&";
398 close $pty;
399
400 # now communicate with rxvt
401 my $slave = $pty->slave;
402 while (<$slave>) { print $slave "got <$_>\n" }
403
404 -pe *string*
405 Comma-separated list of perl extension scripts to use (or not to
406 use) in this terminal instance. See resource perl-ext for details.
407
336RESOURCES (available also as long-options) 408RESOURCES (available also as long-options)
337 Note: `rxvt --help' gives a list of all resources (long options) 409 Note: `rxvt --help' gives a list of all resources (long options)
338 compiled into your version. 410 compiled into your version.
339 411
340 There are two different methods that rxvt can use to get the Xresource
341 data: using the X libraries (Xrm*-functions) or internal Xresources
342 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
343 XGetDefaults), you can set and change the resources using X11 tools like 412 You can set and change the resources using X11 tools like xrdb. Many
344 xrdb. Many distribution do also load settings from the ~/.Xresources 413 distribution do also load settings from the ~/.Xresources file when X
345 file when X starts. rxvt will consult the following files/resources in 414 starts. rxvt will consult the following files/resources in order, with
346 order, with later settings overwriting earlier ones: 415 later settings overwriting earlier ones:
347 416
348 1. system-wide app-defaults file, either locale-dependent OR global 417 1. system-wide app-defaults file, either locale-dependent OR global
349 2. app-defaults file in $XAPPLRESDIR 418 2. app-defaults file in $XAPPLRESDIR
350 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 419 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
351 4. SCREEN_RESOURCES for the current screen 420 4. SCREEN_RESOURCES for the current screen
352 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 421 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
353 422
354 If compiled with internal Xresources support (i.e. rxvt -h lists 423 Note that when reading X resources, rxvt recognizes two class names:
355 .Xdefaults) then rxvt accepts application defaults set in 424 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
356 XAPPLOADDIR/URxvt (compile-time defined: usually 425 and the original *rxvt* to be easily configured, while the class name
357 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 426 URxvt allows resources unique to rxvt, to be shared between different
358 ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X
359 resources, rxvt recognizes two class names: XTerm and URxvt. The class
360 name Rxvt allows resources common to both rxvt and the original *rxvt*
361 to be easily configured, while the class name URxvt allows resources
362 unique to rxvt, notably colours and key-handling, to be shared between
363 different rxvt configurations. If no resources are specified, suitable 427 rxvt configurations. If no resources are specified, suitable defaults
364 defaults will be used. Command-line arguments can be used to override 428 will be used. Command-line arguments can be used to override resource
365 resource settings. The following resources are allowed: 429 settings. The following resources are supported (you might want to check
430 the rxvtperl(3) manpage for additional settings by perl extensions not
431 documented here):
366 432
367 geometry: *geom* 433 geometry: *geom*
368 Create the window with the specified X window geometry [default 434 Create the window with the specified X window geometry [default
369 80x24]; option -geometry. 435 80x24]; option -geometry.
370 436
… …
433 True: make the background inherit the parent windows' pixmap, giving 499 True: make the background inherit the parent windows' pixmap, giving
434 artificial transparency. False: do not inherit the parent windows' 500 artificial transparency. False: do not inherit the parent windows'
435 pixmap. 501 pixmap.
436 502
437 fading: *number* 503 fading: *number*
438 Fade the text by the given percentage when focus is lost. 504 Fade the text by the given percentage when focus is lost; option
505 -fade.
506
507 fadeColor: *colour*
508 Fade to this colour, when fading is used (see fading:). The default
509 colour is black; option -fadecolor.
439 510
440 tintColor: *colour* 511 tintColor: *colour*
441 Tint the transparent background pixmap with the given colour. 512 Tint the transparent background pixmap with the given colour; option
513 -tint.
442 514
443 shading: *number* 515 shading: *number*
444 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 516 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
445 image in addition to tinting it. 517 image in addition to tinting it.
446 518
447 scrollColor: *colour* 519 scrollColor: *colour*
448 Use the specified colour for the scrollbar [default #B2B2B2]. 520 Use the specified colour for the scrollbar [default #B2B2B2].
449 521
450 troughColor: *colour* 522 troughColor: *colour*
451 Use the specified colour for the scrollbar's trough area [default 523 Use the specified colour for the scrollbar's trough area [default
452 #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 524 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
453 525
454 borderColor: *colour* 526 borderColor: *colour*
455 The colour of the border around the text area and between the 527 The colour of the border around the text area and between the
456 scrollbar and the text. 528 scrollbar and the text.
457 529
… …
464 scale of 1 displays the image without any scaling. A scale of 2 to 9 536 scale of 1 displays the image without any scaling. A scale of 2 to 9
465 specifies an integer number of images in that direction. No image 537 specifies an integer number of images in that direction. No image
466 will be magnified beyond 10 times its original size. The maximum 538 will be magnified beyond 10 times its original size. The maximum
467 permitted scale is 1000. [default 0x0+50+50] 539 permitted scale is 1000. [default 0x0+50+50]
468 540
469 menu: *file[;tag]*
470 Read in the specified menu file (note the `.menu' extension is
471 optional) and also optionally specify a starting tag to find. See
472 the reference documentation for details on the syntax for the
473 menuBar.
474
475 path: *path* 541 path: *path*
476 Specify the colon-delimited search path for finding files (XPM and 542 Specify the colon-delimited search path for finding XPM files.
477 menus), in addition to the paths specified by the RXVTPATH and PATH
478 environment variables.
479 543
480 font: *fontlist* 544 font: *fontlist*
481 Select the fonts to be used. This is a comma separated list of font 545 Select the fonts to be used. This is a comma separated list of font
482 names that are used in turn when trying to display Unicode 546 names that are checked in order when trying to find glyphs for
483 characters. The first font defines the cell size for characters; 547 characters. The first font defines the cell size for characters;
484 other fonts might be smaller, but not larger. A reasonable default 548 other fonts might be smaller, but not (in general) larger. A
485 font list is always appended to it. option -fn. 549 (hopefully) reasonable default font list is always appended to it;
550 option -fn.
486 551
487 Each font can either be a standard X11 core font (XLFD) name, with 552 Each font can either be a standard X11 core font (XLFD) name, with
488 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 553 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
489 "xft:". 554 "xft:".
490 555
… …
493 available hint currently is "codeset=codeset-name", and this is only 558 available hint currently is "codeset=codeset-name", and this is only
494 used for Xft fonts. 559 used for Xft fonts.
495 560
496 For example, this font resource 561 For example, this font resource
497 562
498 URxvt*font: 9x15bold,\ 563 URxvt.font: 9x15bold,\
499 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 564 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
500 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 565 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
501 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 566 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
502 xft:Code2000:antialias=false 567 xft:Code2000:antialias=false
503 568
… …
536 tried. 601 tried.
537 602
538 If set, but empty, then this specific style is disabled and the 603 If set, but empty, then this specific style is disabled and the
539 normal text font will being used for the given style. 604 normal text font will being used for the given style.
540 605
606 intensityStyles: *boolean*
607 When font styles are not enabled, or this option is enabled (True,
608 option -is, the default), bold and italic font styles imply high
609 intensity foreground/backround colours. Disabling this option
610 (False, option +is) disables this behaviour, the high intensity
611 colours are not reachable.
612
541 selectstyle: *mode* 613 selectstyle: *mode*
542 Set mouse selection style to old which is 2.20, oldword which is 614 Set mouse selection style to old which is 2.20, oldword which is
543 xterm style with 2.20 old word selection, or anything else which 615 xterm style with 2.20 old word selection, or anything else which
544 gives xterm style selection. 616 gives xterm style selection.
545 617
546 scrollstyle: *mode* 618 scrollstyle: *mode*
547 Set scrollbar style to rxvt, plain, next or xterm. plain is the 619 Set scrollbar style to rxvt, plain, next or xterm. plain is the
548 author's favourite.. 620 author's favourite.
549 621
550 title: *string* 622 title: *string*
551 Set window title string, the default title is the command-line 623 Set window title string, the default title is the command-line
552 specified after the -e option, if any, otherwise the application 624 specified after the -e option, if any, otherwise the application
553 name; option -title. 625 name; option -title.
… …
578 print-pipe: *string* 650 print-pipe: *string*
579 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use 651 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use
580 Print to initiate a screen dump to the printer and Ctrl-Print or 652 Print to initiate a screen dump to the printer and Ctrl-Print or
581 Shift-Print to include the scrollback as well. 653 Shift-Print to include the scrollback as well.
582 654
655 The string will be interpreted as if typed into the shell as-is.
656
657 Example:
658
659 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
660
661 This creates a new file in your home directory with the screen
662 contents everytime you hit "Print".
663
583 scrollBar: *boolean* 664 scrollBar: *boolean*
584 True: enable the scrollbar [default]; option -sb. False: disable the 665 True: enable the scrollbar [default]; option -sb. False: disable the
585 scrollbar; option +sb. 666 scrollbar; option +sb.
586 667
587 scrollBar_right: *boolean* 668 scrollBar_right: *boolean*
… …
600 True: scroll to bottom when tty receives output; option -si. False: 681 True: scroll to bottom when tty receives output; option -si. False:
601 do not scroll to bottom when tty receives output; option +si. 682 do not scroll to bottom when tty receives output; option +si.
602 683
603 scrollWithBuffer: *boolean* 684 scrollWithBuffer: *boolean*
604 True: scroll with scrollback buffer when tty receives new lines (and 685 True: scroll with scrollback buffer when tty receives new lines (and
605 scrollTtyOutput is False); option +sw. False: do not scroll with 686 scrollTtyOutput is False); option -sw. False: do not scroll with
606 scrollback buffer when tty recieves new lines; option -sw. 687 scrollback buffer when tty recieves new lines; option +sw.
607 688
608 scrollTtyKeypress: *boolean* 689 scrollTtyKeypress: *boolean*
609 True: scroll to bottom when a non-special key is pressed. Special 690 True: scroll to bottom when a non-special key is pressed. Special
610 keys are those which are intercepted by rxvt-unicode for special 691 keys are those which are intercepted by rxvt-unicode for special
611 handling and are not passed onto the shell; option -sk. False: do 692 handling and are not passed onto the shell; option -sk. False: do
… …
626 borderLess: *boolean* 707 borderLess: *boolean*
627 Set MWM hints to request a borderless window, i.e. if honoured by 708 Set MWM hints to request a borderless window, i.e. if honoured by
628 the WM, the rxvt-unicode window will not have window decorations; 709 the WM, the rxvt-unicode window will not have window decorations;
629 option -bl. 710 option -bl.
630 711
712 skipBuiltinGlyphs: *boolean*
713 Compile *frills*: Disable the usage of the built-in block
714 graphics/line drawing characters and just rely on what the specified
715 fonts provide. Use this if you have a good font and want to use its
716 block graphic glyphs; option -sbg.
717
631 termName: *termname* 718 termName: *termname*
632 Specifies the terminal type name to be set in the TERM environment 719 Specifies the terminal type name to be set in the TERM environment
633 variable; option -tn. 720 variable; option -tn.
634 721
635 linespace: *number* 722 linespace: *number*
… …
663 pointerColor2: *colour* 750 pointerColor2: *colour*
664 Mouse pointer background colour. 751 Mouse pointer background colour.
665 752
666 pointerBlankDelay: *number* 753 pointerBlankDelay: *number*
667 Specifies number of seconds before blanking the pointer [default 2]. 754 Specifies number of seconds before blanking the pointer [default 2].
755 Use a large number (e.g. 987654321) to effectively disable the
756 timeout.
668 757
669 backspacekey: *string* 758 backspacekey: *string*
670 The string to send when the backspace key is pressed. If set to DEC 759 The string to send when the backspace key is pressed. If set to DEC
671 or unset it will send Delete (code 127) or, if shifted, Backspace 760 or unset it will send Delete (code 127) or, if shifted, Backspace
672 (code 8) - which can be reversed with the appropriate DEC private 761 (code 8) - which can be reversed with the appropriate DEC private
… …
691 780
692 imLocale: *name* 781 imLocale: *name*
693 The locale to use for opening the IM. You can use an "LC_CTYPE" of 782 The locale to use for opening the IM. You can use an "LC_CTYPE" of
694 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for 783 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for
695 the input extension to be able to input japanese characters while 784 the input extension to be able to input japanese characters while
696 staying in another locale. option -imlocale. 785 staying in another locale; option -imlocale.
697 786
698 imFont: *fontset* 787 imFont: *fontset*
699 Specify the font-set used for XIM styles "OverTheSpot" or 788 Specify the font-set used for XIM styles "OverTheSpot" or
700 "OffTheSpot". It must be a standard X font set (XLFD patterns 789 "OffTheSpot". It must be a standard X font set (XLFD patterns
701 separated by commas), i.e. it's not in the same format as the other 790 separated by commas), i.e. it's not in the same format as the other
… …
704 to the base font. option -imfont. 793 to the base font. option -imfont.
705 794
706 tripleclickwords: *boolean* 795 tripleclickwords: *boolean*
707 Change the meaning of triple-click selection with the left mouse 796 Change the meaning of triple-click selection with the left mouse
708 button. Instead of selecting a full line it will extend the 797 button. Instead of selecting a full line it will extend the
709 selection to the end of the logical line only. option -tcw. 798 selection to the end of the logical line only; option -tcw.
710 799
711 insecure: *boolean* 800 insecure: *boolean*
712 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 801 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
713 that echo arbitrary strings like the icon name or the locale. This 802 that echo arbitrary strings like the icon name or the locale. This
714 could be abused if somebody gets 8-bit-clean access to your display, 803 could be abused if somebody gets 8-bit-clean access to your display,
715 whether throuh a mail client displaying mail bodies unfiltered or 804 whether through a mail client displaying mail bodies unfiltered or
716 though write(1). Therefore, these sequences are disabled by default. 805 through write(1) or any other means. Therefore, these sequences are
717 (Note that other terminals, including xterm, have these sequences 806 disabled by default. (Note that many other terminals, including
718 enabled by default). You can enable them by setting this boolean 807 xterm, have these sequences enabled by default, which doesn't make
719 resource or specifying -insecure as an option. At the moment, this 808 it safer, though).
720 enabled display-answer, locale, findfont, icon label and window 809
721 title requests as well as dynamic menubar dispatch. 810 You can enable them by setting this boolean resource or specifying
811 -insecure as an option. At the moment, this enables display-answer,
812 locale, findfont, icon label and window title requests.
722 813
723 modifier: *modifier* 814 modifier: *modifier*
724 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 815 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
725 super, mod1, mod2, mod3, mod4, mod5; option -mod. 816 super, mod1, mod2, mod3, mod4, mod5; option -mod.
726 817
… …
735 secondaryScroll: *bool* 826 secondaryScroll: *bool*
736 Turn on/off secondary screen scroll (default enabled). If the this 827 Turn on/off secondary screen scroll (default enabled). If the this
737 option is enabled, scrolls on the secondary screen will change the 828 option is enabled, scrolls on the secondary screen will change the
738 scrollback buffer and switching to/from the secondary screen will 829 scrollback buffer and switching to/from the secondary screen will
739 instead scroll the screen up. 830 instead scroll the screen up.
831
832 hold: *bool*
833 Turn on/off hold window after exit support. If enabled, rxvt will
834 not immediately destroy its window when the program executed within
835 it exits. Instead, it will wait till it is being killed or closed by
836 the user.
740 837
741 keysym.*sym*: *string* 838 keysym.*sym*: *string*
742 Compile *frills*: Associate *string* with keysym *sym*. The 839 Compile *frills*: Associate *string* with keysym *sym*. The
743 intervening resource name keysym. cannot be omitted. 840 intervening resource name keysym. cannot be omitted.
744 841
… …
763 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 860 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
764 "\000": octal number) or verbatim control characters ("^?": delete, 861 "\000": octal number) or verbatim control characters ("^?": delete,
765 "^@": null, "^A" ...) and may be enclosed with double quotes so that 862 "^@": null, "^A" ...) and may be enclosed with double quotes so that
766 it can start or end with whitespace. 863 it can start or end with whitespace.
767 864
768 Please note that you need to double the "\" when using 865 Please note that you need to double the "\" in resource files, as
769 "--enable-xgetdefault", as X itself does it's own de-escaping (you 866 Xlib itself does it's own de-escaping (you can use "\033" instead of
770 can use "\033" instead of "\e" (and so on), which will work with 867 "\e" (and so on), which will work with both Xt and rxvt's own
771 both Xt and rxvt's own processing). 868 processing).
772 869
773 You can define a range of keysyms in one shot by providing a 870 You can define a range of keysyms in one shot by providing a
774 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 871 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
775 `/' should be a character not used by the strings. 872 `/' should be a character not used by the strings.
776 873
… …
789 the following means "change the current locale to "zh_CN.GBK" when 886 the following means "change the current locale to "zh_CN.GBK" when
790 Control-Meta-c is being pressed": 887 Control-Meta-c is being pressed":
791 888
792 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 889 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
793 890
891 If *string* takes the form "perl:STRING", then the specified STRING
892 is passed to the "on_keyboard_command" perl handler. See the
893 rxvtperl(3) manpage. For example, the selection extension (activated
894 via "rxvt -pe selection") listens for "selection:rot13" events:
895
896 URxvt.keysym.M-C-c: perl:selection:rot13
897
898 Due the the large number of modifier combinations, a defined key
899 mapping will match if at *at least* the specified identifiers are
900 being set, and no other key mappings with those and more bits are
901 being defined. That means that defining a key map for "a" will
902 automatically provide definitions for "Meta-a", "Shift-a" and so on,
903 unless some of those are defined mappings themselves.
904
905 Unfortunately, this will override built-in key mappings. For example
906 if you overwrite the "Insert" key you will disable rxvt's
907 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
908 the user-defined keymap using the "builtin:" replacement:
909
910 URxvt.keysym.Insert: <my insert key sequence>
911 URxvt.keysym.S-Insert: builtin:
912
913 The first line defines a mapping for "Insert" and *any* combination
914 of modifiers. The second line re-establishes the default mapping for
915 "Shift-Insert".
916
794 The following example will map Control-Meta-1 and Control-Meta-2 to 917 The following example will map Control-Meta-1 and Control-Meta-2 to
795 the fonts "suxuseuro" and "9x15bold", so you can have some limited 918 the fonts "suxuseuro" and "9x15bold", so you can have some limited
796 font-switching at runtime: 919 font-switching at runtime:
797 920
798 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 921 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
… …
801 Other things are possible, e.g. resizing (see rxvt(7) for more 924 Other things are possible, e.g. resizing (see rxvt(7) for more
802 info): 925 info):
803 926
804 URxvt.keysym.M-C-3: command:\033[8;25;80t 927 URxvt.keysym.M-C-3: command:\033[8;25;80t
805 URxvt.keysym.M-C-4: command:\033[8;48;110t 928 URxvt.keysym.M-C-4: command:\033[8;48;110t
929
930 perl-ext-common: *string*
931 perl-ext: *string*
932 Comma-separated list(s) of perl extension scripts (default:
933 "default") to use in this terminal instance; option -pe.
934
935 Extension names can be prefixed with a "-" sign to prohibit using
936 them. This can be useful to selectively disable some extensions
937 loaded by default, or specified via the "perl-ext-common" resource.
938 For example, "default,-selection" will use all the default extension
939 except "selection".
940
941 Extension names can also be followed by an argument in angle
942 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
943 for searchable scorllback to Alt/Meta-s). Mentioning the same
944 extension multiple times with different arguments will pass multiple
945 arguments to the extension.
946
947 Each extension is looked up in the library directories, loaded if
948 necessary, and bound to the current terminal instance.
949
950 If both of these resources are the empty string, then the perl
951 interpreter will not be initialized. The idea behind two options is
952 that perl-ext-common will be used for extensions that should be
953 available to all instances, while perl-ext is used for specific
954 instances.
955
956 perl-eval: *string*
957 Perl code to be evaluated when all extensions have been registered.
958 See the rxvtperl(3) manpage. Due to security reasons, this resource
959 will be ignored when running setuid/setgid.
960
961 perl-lib: *path*
962 Colon-separated list of additional directories that hold extension
963 scripts. When looking for extensions specified by the "perl"
964 resource, rxvt will first look in these directories and then in
965 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
966 will be ignored when running setuid/setgid.
967
968 See the rxvtperl(3) manpage.
969
970 selection.pattern-*idx*: *perl-regex*
971 Additional selection patterns, see the rxvtperl(3) manpage for
972 details.
973
974 selection-autotransform.*idx*: *perl-transform*
975 Selection auto-transform patterns, see the rxvtperl(3) manpage for
976 details.
977
978 searchable-scrollback: *keysym*
979 Sets the hotkey that starts the incremental scrollback buffer search
980 (default: "M-s").
981
982 urlLauncher: *string*
983 Specifies the program to be started with a URL argument. Used by the
984 "selection-popup" and "mark-urls" perl extensions.
985
986 transient-for: *windowid*
987 Sets the WM_TRANSIENT_FOR property to the given window iw.
806 988
807THE SCROLLBAR 989THE SCROLLBAR
808 Lines of text that scroll off the top of the rxvt window (resource: 990 Lines of text that scroll off the top of the rxvt window (resource:
809 saveLines) and can be scrolled back using the scrollbar or by 991 saveLines) and can be scrolled back using the scrollbar or by
810 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 992 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
… …
837 entire logical line (which can span multiple screen lines), unless 1019 entire logical line (which can span multiple screen lines), unless
838 modified by resource tripleclickwords. 1020 modified by resource tripleclickwords.
839 1021
840 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 1022 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
841 (Compile: *frills*) will create a rectangular selection instead of a 1023 (Compile: *frills*) will create a rectangular selection instead of a
842 normal one. 1024 normal one. In this mode, every selected row becomes its own line in
1025 the selection, and trailing whitespace is visually underlined and
1026 removed from the selection.
843 1027
844 Insertion: 1028 Insertion:
845 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1029 Pressing and releasing the Middle mouse button (or Shift-Insert) in
846 an rxvt window causes the current text selection to be inserted as 1030 an rxvt window causes the current text selection to be inserted as
847 if it had been typed on the keyboard. 1031 if it had been typed on the keyboard.
848 1032
849CHANGING FONTS 1033CHANGING FONTS
850 Changing fonts (or font sizes, respectively) via the keypad is not yet 1034 Changing fonts (or font sizes, respectively) via the keypad is not yet
851 supported in rxvt-unicode. Bug me if you need this. 1035 supported in rxvt-unicode. Bug me if you need this.
852 1036
853 You can, however, switch fonts at runtime using escape sequences (and 1037 You can, however, switch fonts at runtime using escape sequences, e.g.:
854 therefore using the menubar), e.g.:
855 1038
856 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1039 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1040
1041 You can use keyboard shortcuts, too:
1042
1043 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1044 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
857 1045
858 rxvt-unicode will automatically re-apply these fonts to the output so 1046 rxvt-unicode will automatically re-apply these fonts to the output so
859 far. 1047 far.
860 1048
861ISO 14755 SUPPORT 1049ISO 14755 SUPPORT
… …
1007 Used in the same way as "RXVTPATH". 1195 Used in the same way as "RXVTPATH".
1008 1196
1009 RXVT_SOCKET 1197 RXVT_SOCKET
1010 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1198 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1011 1199
1012 Default "$HOME/.rxvt-unicode-<nodename". 1200 Default $HOME/.rxvt-unicode-*<nodename*.
1013 1201
1014 HOME 1202 HOME
1015 Used to locate the default directory for the unix domain socket for 1203 Used to locate the default directory for the unix domain socket for
1016 daemon communications and to locate various resource files (such as 1204 daemon communications and to locate various resource files (such as
1017 ".Xdefaults") 1205 ".Xdefaults")
… …
1026FILES 1214FILES
1027 /usr/lib/X11/rgb.txt 1215 /usr/lib/X11/rgb.txt
1028 Color names. 1216 Color names.
1029 1217
1030SEE ALSO 1218SEE ALSO
1031 rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1219 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
1032 1220 tty(4), utmp(5)
1033BUGS
1034 Check the BUGS file for an up-to-date list.
1035
1036 Cursor change support is not yet implemented.
1037
1038 Click-and-drag doesn't work with X11 mouse report overriding.
1039 1221
1040CURRENT PROJECT COORDINATOR 1222CURRENT PROJECT COORDINATOR
1041 Project Coordinator 1223 Project Coordinator
1042 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1224 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1043 1225

Diff Legend

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