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.25 by root, Tue Oct 25 20:22:39 2005 UTC vs.
Revision 1.60 by root, Thu Jul 6 19:43:21 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.8, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 7.7, 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
… …
38 because the author couldn't get "mlterm" to use one font for latin1 and 38 because the author couldn't get "mlterm" to use one font for latin1 and
39 another for japanese. 39 another for japanese.
40 40
41 Therefore another design rationale was the use of multiple fonts to 41 Therefore another design rationale was the use of multiple fonts to
42 display characters: The idea of a single unicode font which many other 42 display characters: The idea of a single unicode font which many other
43 programs force onto it's users never made sense to me: You should be 43 programs force onto its users never made sense to me: You should be able
44 able to choose any font for any script freely. 44 to choose any font for any script freely.
45 45
46 Apart from that, rxvt-unicode is also much better internationalised than 46 Apart from that, rxvt-unicode is also much better internationalised than
47 it's predecessor, supports things such as XFT and ISO 14755 that are 47 its predecessor, supports things such as XFT and ISO 14755 that are
48 handy in i18n-environments, is faster, and has a lot less bugs than the 48 handy in i18n-environments, is faster, and has a lot less bugs than the
49 original rxvt. This all in addition to dozens of other small 49 original rxvt. This all in addition to dozens of other small
50 improvements. 50 improvements.
51 51
52 It is still faithfully following the original rxvt idea of being lean 52 It is still faithfully following the original rxvt idea of being lean
53 and nice on resources: for example, you can still configure rxvt-unicode 53 and nice on resources: for example, you can still configure rxvt-unicode
54 without most of it's features to get a lean binary. It also comes with a 54 without most of its features to get a lean binary. It also comes with a
55 client/daemon pair that lets you open any number of terminal windows 55 client/daemon pair that lets you open any number of terminal windows
56 from within a single process, which makes startup time very fast and 56 from within a single process, which makes startup time very fast and
57 drastically reduces memory usage. See rxvtd(1) (daemon) and rxvtc(1) 57 drastically reduces memory usage. See rxvtd(1) (daemon) and rxvtc(1)
58 (client). 58 (client).
59 59
… …
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.
… …
96 Turn on/off jump scrolling; resource jumpScroll. 100 Turn on/off jump scrolling; resource jumpScroll.
97 101
98 -ip|+ip | -tr|+tr 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.
105
106 *Please note that transparency of any kind if completely unsupported
107 by the author. Don't bug him with installation questions!*
101 108
102 -fade *number* 109 -fade *number*
103 Fade the text by the given percentage when focus is lost. Small 110 Fade the text by the given percentage when focus is lost. Small
104 values fade a little only, 100 completely replaces all colours by 111 values fade a little only, 100 completely replaces all colours by
105 the fade colour; resource fading. 112 the fade colour; resource fading.
106 113
107 -fadecolor *colour* 114 -fadecolor *colour*
108 Fade to this colour when fading is used (see -fade). The default 115 Fade to this colour when fading is used (see -fade). The default
109 colour is black. resource fadeColor. 116 colour is opaque black. resource fadeColor.
110 117
111 -tint *colour* 118 -tint *colour*
112 Tint the transparent background pixmap with the given colour when 119 Tint the transparent background pixmap with the given colour when
113 transparency is enabled with -tr or -ip. This only works for 120 transparency is enabled with -tr or -ip. This only works for
114 non-tiled backgrounds, currently. See also the -sh option that can 121 non-tiled backgrounds, currently. See also the -sh option that can
… …
146 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
147 scrollbar and the text; resource borderColor. 154 scrollbar and the text; resource borderColor.
148 155
149 -fn *fontlist* 156 -fn *fontlist*
150 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
151 names that are used in turn when trying to display Unicode 158 names that are checked in order when trying to find glyphs for
152 characters. The first font defines the cell size for characters; 159 characters. The first font defines the cell size for characters;
153 other fonts might be smaller, but not (in general) larger. A 160 other fonts might be smaller, but not (in general) larger. A
154 (hopefully) reasonable default font list is always appended to it. 161 (hopefully) reasonable default font list is always appended to it.
155 See resource font for more details. 162 See resource font for more details.
156 163
157 In short, to specify an X11 core font, just specify it's name or 164 In short, to specify an X11 core font, just specify its name or
158 prefix it with "x:". To specify an XFT-font, you need to prefix it 165 prefix it with "x:". To specify an XFT-font, you need to prefix it
159 with "xft:", e.g.: 166 with "xft:", e.g.:
160 167
161 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 168 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
162 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" 169 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
163 170
164 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
165 FAQ section of rxvt(7). 172 FAQ section of rxvt(7).
166 173
167 -fb *fontlist* 174 -fb *fontlist*
168 Compile font-styles: The bold font list to use when bold characters 175 Compile *font-styles*: The bold font list to use when bold
169 are to be printed. See resource boldFont for details. 176 characters are to be printed. See resource boldFont for details.
170 177
171 -fi *fontlist* 178 -fi *fontlist*
172 Compile font-styles: The italic font list to use when bold 179 Compile *font-styles*: The italic font list to use when *italic*
173 characters are to be printed. See resource italicFont for details. 180 characters are to be printed. See resource italicFont for details.
174 181
175 -fbi *fontlist* 182 -fbi *fontlist*
176 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
177 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
178 details. 190 details.
179 191
180 -name *name* 192 -name *name*
181 Specify the application name under which resources are to be 193 Specify the application name under which resources are to be
182 obtained, rather than the default executable file name. Name should 194 obtained, rather than the default executable file name. Name should
… …
246 externalBorder. 258 externalBorder.
247 259
248 -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.
249 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
250 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.
251 273
252 -lsp *number* 274 -lsp *number*
253 Compile *frills*: Lines (pixel height) to insert between each row of 275 Compile *frills*: Lines (pixel height) to insert between each row of
254 the display. Useful to work around font rendering problems; resource 276 the display. Useful to work around font rendering problems; resource
255 linespace. 277 linespace.
… …
267 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
268 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
269 run the program specified by the SHELL environment variable or, 291 run the program specified by the SHELL environment variable or,
270 failing that, *sh(1)*. 292 failing that, *sh(1)*.
271 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
272 -title *text* 300 -title *text*
273 Window title (-T still respected); the default title is the basename 301 Window title (-T still respected); the default title is the basename
274 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
275 application name; resource title. 303 application name; resource title.
276 304
… …
319 347
320 -ssr|+ssr 348 -ssr|+ssr
321 Turn on/off secondary screen scroll (default enabled); resource 349 Turn on/off secondary screen scroll (default enabled); resource
322 secondaryScroll. 350 secondaryScroll.
323 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
324 -keysym.*sym* *string* 358 -keysym.*sym* *string*
325 Remap a key symbol. See resource keysym. 359 Remap a key symbol. See resource keysym.
326 360
327 -embed *windowid* 361 -embed *windowid*
328 Tells rxvt to embed it's windows into an already-existing window, 362 Tells rxvt to embed its windows into an already-existing window,
329 which enables applications to easily embed a terminal. 363 which enables applications to easily embed a terminal.
330 364
331 Right now, rxvt will first unmap/map the specified window, so it 365 Right now, rxvt will first unmap/map the specified window, so it
332 shouldn't be a top-level window. rxvt will also reconfigure it quite 366 shouldn't be a top-level window. rxvt will also reconfigure it quite
333 a bit, so don't expect it to keep some specific state. It's best to 367 a bit, so don't expect it to keep some specific state. It's best to
… …
348 $rxvt->signal_connect_after (realize => sub { 382 $rxvt->signal_connect_after (realize => sub {
349 my $xid = $_[0]->window->get_xid; 383 my $xid = $_[0]->window->get_xid;
350 system "rxvt -embed $xid &"; 384 system "rxvt -embed $xid &";
351 }); 385 });
352 386
353 -pty-fd *fileno* 387 -pty-fd *file descriptor*
354 Tells rxvt NOT to execute any commands or create a new pty/tty pair 388 Tells rxvt NOT to execute any commands or create a new pty/tty pair
355 but instead use the given filehandle as the tty master. This is 389 but instead use the given filehandle as the tty master. This is
356 useful if you want to drive rxvt as a generic terminal emulator 390 useful if you want to drive rxvt as a generic terminal emulator
357 without having to run a program within it. 391 without having to run a program within it.
358 392
359 If this switch is given, rxvt will not create any utmp/wtmp entries 393 If this switch is given, rxvt will not create any utmp/wtmp entries
360 and will not tinker with pty/tty permissions - you have to do that 394 and will not tinker with pty/tty permissions - you have to do that
361 yourself if you want that. 395 yourself if you want that.
362 396
397 As an extremely special case, specifying -1 will completely suppress
398 pty/tty operations.
399
363 Here is a example in perl that illustrates how this option can be 400 Here is a example in perl that illustrates how this option can be
364 used (a longer example is in doc/pty-fd): 401 used (a longer example is in doc/pty-fd):
365 402
366 use IO::Pty; 403 use IO::Pty;
367 use Fcntl; 404 use Fcntl;
… …
373 410
374 # now communicate with rxvt 411 # now communicate with rxvt
375 my $slave = $pty->slave; 412 my $slave = $pty->slave;
376 while (<$slave>) { print $slave "got <$_>\n" } 413 while (<$slave>) { print $slave "got <$_>\n" }
377 414
415 -pe *string*
416 Comma-separated list of perl extension scripts to use (or not to
417 use) in this terminal instance. See resource perl-ext for details.
418
378RESOURCES (available also as long-options) 419RESOURCES (available also as long-options)
379 Note: `rxvt --help' gives a list of all resources (long options) 420 Note: `rxvt --help' gives a list of all resources (long options)
380 compiled into your version. 421 compiled into your version.
381 422
382 There are two different methods that rxvt can use to get the Xresource
383 data: using the X libraries (Xrm*-functions) or internal Xresources
384 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
385 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
386 xrdb. Many distribution do also load settings from the ~/.Xresources 424 distribution do also load settings from the ~/.Xresources file when X
387 file when X starts. rxvt will consult the following files/resources in 425 starts. rxvt will consult the following files/resources in order, with
388 order, with later settings overwriting earlier ones: 426 later settings overwriting earlier ones:
389 427
390 1. system-wide app-defaults file, either locale-dependent OR global 428 1. system-wide app-defaults file, either locale-dependent OR global
391 2. app-defaults file in $XAPPLRESDIR 429 2. app-defaults file in $XAPPLRESDIR
392 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 430 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
393 4. SCREEN_RESOURCES for the current screen 431 4. SCREEN_RESOURCES for the current screen
394 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 432 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
395 433
396 If compiled with internal Xresources support (i.e. rxvt -h lists 434 Note that when reading X resources, rxvt recognizes two class names:
397 .Xdefaults) then rxvt accepts application defaults set in 435 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
398 XAPPLOADDIR/URxvt (compile-time defined: usually 436 and the original *rxvt* to be easily configured, while the class name
399 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 437 URxvt allows resources unique to rxvt, to be shared between different
400 ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X
401 resources, rxvt recognizes two class names: XTerm and URxvt. The class
402 name Rxvt allows resources common to both rxvt and the original *rxvt*
403 to be easily configured, while the class name URxvt allows resources
404 unique to rxvt, notably colours and key-handling, to be shared between
405 different rxvt configurations. If no resources are specified, suitable 438 rxvt configurations. If no resources are specified, suitable defaults
406 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
407 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.
408 447
409 geometry: *geom* 448 geometry: *geom*
410 Create the window with the specified X window geometry [default 449 Create the window with the specified X window geometry [default
411 80x24]; option -geometry. 450 80x24]; option -geometry.
412 451
… …
473 512
474 inheritPixmap: *boolean* 513 inheritPixmap: *boolean*
475 True: make the background inherit the parent windows' pixmap, giving 514 True: make the background inherit the parent windows' pixmap, giving
476 artificial transparency. False: do not inherit the parent windows' 515 artificial transparency. False: do not inherit the parent windows'
477 pixmap. 516 pixmap.
517
518 *Please note that transparency of any kind if completely unsupported
519 by the author. Don't bug him with installation questions!*
478 520
479 fading: *number* 521 fading: *number*
480 Fade the text by the given percentage when focus is lost; option 522 Fade the text by the given percentage when focus is lost; option
481 -fade. 523 -fade.
482 524
… …
512 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
513 specifies an integer number of images in that direction. No image 555 specifies an integer number of images in that direction. No image
514 will be magnified beyond 10 times its original size. The maximum 556 will be magnified beyond 10 times its original size. The maximum
515 permitted scale is 1000. [default 0x0+50+50] 557 permitted scale is 1000. [default 0x0+50+50]
516 558
517 menu: *file[;tag]*
518 Read in the specified menu file (note the `.menu' extension is
519 optional) and also optionally specify a starting tag to find. See
520 the reference documentation for details on the syntax for the
521 menuBar.
522
523 path: *path* 559 path: *path*
524 Specify the colon-delimited search path for finding files (XPM and 560 Specify the colon-delimited search path for finding XPM files.
525 menus), in addition to the paths specified by the RXVTPATH and PATH
526 environment variables.
527 561
528 font: *fontlist* 562 font: *fontlist*
529 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
530 names that are used in turn when trying to display Unicode 564 names that are checked in order when trying to find glyphs for
531 characters. The first font defines the cell size for characters; 565 characters. The first font defines the cell size for characters;
532 other fonts might be smaller, but not larger. A reasonable default 566 other fonts might be smaller, but not (in general) larger. A
533 font list is always appended to it. option -fn. 567 (hopefully) reasonable default font list is always appended to it;
568 option -fn.
534 569
535 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
536 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 571 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
537 "xft:". 572 "xft:".
538 573
… …
541 available hint currently is "codeset=codeset-name", and this is only 576 available hint currently is "codeset=codeset-name", and this is only
542 used for Xft fonts. 577 used for Xft fonts.
543 578
544 For example, this font resource 579 For example, this font resource
545 580
546 URxvt*font: 9x15bold,\ 581 URxvt.font: 9x15bold,\
547 -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,\
548 -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, \
549 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 584 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
550 xft:Code2000:antialias=false 585 xft:Code2000:antialias=false
551 586
… …
584 tried. 619 tried.
585 620
586 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
587 normal text font will being used for the given style. 622 normal text font will being used for the given style.
588 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
589 selectstyle: *mode* 631 selectstyle: *mode*
590 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
591 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
592 gives xterm style selection. 634 gives xterm style selection.
593 635
… …
630 672
631 The string will be interpreted as if typed into the shell as-is. 673 The string will be interpreted as if typed into the shell as-is.
632 674
633 Example: 675 Example:
634 676
635 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 677 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
636 678
637 This creates a new file in your home directory with the screen 679 This creates a new file in your home directory with the screen
638 contents everytime you hit "Print". 680 contents everytime you hit "Print".
639 681
640 scrollBar: *boolean* 682 scrollBar: *boolean*
… …
683 borderLess: *boolean* 725 borderLess: *boolean*
684 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
685 the WM, the rxvt-unicode window will not have window decorations; 727 the WM, the rxvt-unicode window will not have window decorations;
686 option -bl. 728 option -bl.
687 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
688 termName: *termname* 736 termName: *termname*
689 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
690 variable; option -tn. 738 variable; option -tn.
691 739
692 linespace: *number* 740 linespace: *number*
… …
735 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)
736 is pressed. If unset it will send the sequence traditionally 784 is pressed. If unset it will send the sequence traditionally
737 associated with the Execute key. 785 associated with the Execute key.
738 786
739 cutchars: *string* 787 cutchars: *string*
740 The characters used as delimiters for double-click word selection. 788 The characters used as delimiters for double-click word selection
741 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:
742 799
743 BACKSLASH `"'&()*,;<=>?@[]{|} 800 BACKSLASH `"'&()*,;<=>?@[]{|}
744 801
745 preeditType: *style* 802 preeditType: *style*
746 OverTheSpot, OffTheSpot, Root; option -pt. 803 OverTheSpot, OffTheSpot, Root; option -pt.
… …
750 807
751 imLocale: *name* 808 imLocale: *name*
752 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
753 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
754 the input extension to be able to input japanese characters while 811 the input extension to be able to input japanese characters while
755 staying in another locale. option -imlocale. 812 staying in another locale; option -imlocale.
756 813
757 imFont: *fontset* 814 imFont: *fontset*
758 Specify the font-set used for XIM styles "OverTheSpot" or 815 Specify the font-set used for XIM styles "OverTheSpot" or
759 "OffTheSpot". It must be a standard X font set (XLFD patterns 816 "OffTheSpot". It must be a standard X font set (XLFD patterns
760 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
… …
763 to the base font. option -imfont. 820 to the base font. option -imfont.
764 821
765 tripleclickwords: *boolean* 822 tripleclickwords: *boolean*
766 Change the meaning of triple-click selection with the left mouse 823 Change the meaning of triple-click selection with the left mouse
767 button. Instead of selecting a full line it will extend the 824 button. Instead of selecting a full line it will extend the
768 selection to the end of the logical line only. option -tcw. 825 selection to the end of the logical line only; option -tcw.
769 826
770 insecure: *boolean* 827 insecure: *boolean*
771 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 828 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
772 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
773 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,
774 whether throuh a mail client displaying mail bodies unfiltered or 831 whether through a mail client displaying mail bodies unfiltered or
775 though write(1). Therefore, these sequences are disabled by default. 832 through write(1) or any other means. Therefore, these sequences are
776 (Note that other terminals, including xterm, have these sequences 833 disabled by default. (Note that many other terminals, including
777 enabled by default). You can enable them by setting this boolean 834 xterm, have these sequences enabled by default, which doesn't make
778 resource or specifying -insecure as an option. At the moment, this 835 it safer, though).
779 enabled display-answer, locale, findfont, icon label and window 836
780 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.
781 840
782 modifier: *modifier* 841 modifier: *modifier*
783 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,
784 super, mod1, mod2, mod3, mod4, mod5; option -mod. 843 super, mod1, mod2, mod3, mod4, mod5; option -mod.
785 844
786 answerbackString: *string* 845 answerbackString: *string*
787 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
788 (control-E) character is passed through. It may contain escape 847 (control-E) character is passed through. It may contain escape
789 values as described in the entry on keysym following. 848 values as described in the entry on keysym following.
790 849
791 secondaryScreen: *bool* 850 secondaryScreen: *boolean*
792 Turn on/off secondary screen (default enabled). 851 Turn on/off secondary screen (default enabled).
793 852
794 secondaryScroll: *bool* 853 secondaryScroll: *boolean*
795 Turn on/off secondary screen scroll (default enabled). If the this 854 Turn on/off secondary screen scroll (default enabled). If the this
796 option is enabled, scrolls on the secondary screen will change the 855 option is enabled, scrolls on the secondary screen will change the
797 scrollback buffer and switching to/from the secondary screen will 856 scrollback buffer and switching to/from the secondary screen will
798 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.
799 864
800 keysym.*sym*: *string* 865 keysym.*sym*: *string*
801 Compile *frills*: Associate *string* with keysym *sym*. The 866 Compile *frills*: Associate *string* with keysym *sym*. The
802 intervening resource name keysym. cannot be omitted. 867 intervening resource name keysym. cannot be omitted.
803 868
… …
822 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 887 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
823 "\000": octal number) or verbatim control characters ("^?": delete, 888 "\000": octal number) or verbatim control characters ("^?": delete,
824 "^@": null, "^A" ...) and may be enclosed with double quotes so that 889 "^@": null, "^A" ...) and may be enclosed with double quotes so that
825 it can start or end with whitespace. 890 it can start or end with whitespace.
826 891
827 Please note that you need to double the "\" when using 892 Please note that you need to double the "\" in resource files, as
828 "--enable-xgetdefault", as X itself does it's own de-escaping (you 893 Xlib itself does its own de-escaping (you can use "\033" instead of
829 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
830 both Xt and rxvt's own processing). 895 processing).
831 896
832 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
833 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 898 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
834 `/' should be a character not used by the strings. 899 `/' should be a character not used by the strings.
835 900
… …
847 is interpreted and executed as rxvt's control sequence. For example 912 is interpreted and executed as rxvt's control sequence. For example
848 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
849 Control-Meta-c is being pressed": 914 Control-Meta-c is being pressed":
850 915
851 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 916 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
917
918 If *string* takes the form "perl:STRING", then the specified STRING
919 is passed to the "on_keyboard_command" perl handler. See the
920 rxvtperl(3) manpage. For example, the selection extension (activated
921 via "rxvt -pe selection") listens for "selection:rot13" events:
922
923 URxvt.keysym.M-C-c: perl:selection:rot13
852 924
853 Due the the large number of modifier combinations, a defined key 925 Due the the large number of modifier combinations, a defined key
854 mapping will match if at *at least* the specified identifiers are 926 mapping will match if at *at least* the specified identifiers are
855 being set, and no other key mappings with those and more bits are 927 being set, and no other key mappings with those and more bits are
856 being defined. That means that defining a key map for "a" will 928 being defined. That means that defining a key map for "a" will
… …
880 info): 952 info):
881 953
882 URxvt.keysym.M-C-3: command:\033[8;25;80t 954 URxvt.keysym.M-C-3: command:\033[8;25;80t
883 URxvt.keysym.M-C-4: command:\033[8;48;110t 955 URxvt.keysym.M-C-4: command:\033[8;48;110t
884 956
957 perl-ext-common: *string*
958 perl-ext: *string*
959 Comma-separated list(s) of perl extension scripts (default:
960 "default") to use in this terminal instance; option -pe.
961
962 Extension names can be prefixed with a "-" sign to prohibit using
963 them. This can be useful to selectively disable some extensions
964 loaded by default, or specified via the "perl-ext-common" resource.
965 For example, "default,-selection" will use all the default extension
966 except "selection".
967
968 Extension names can also be followed by an argument in angle
969 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
970 for searchable scorllback to Alt/Meta-s). Mentioning the same
971 extension multiple times with different arguments will pass multiple
972 arguments to the extension.
973
974 Each extension is looked up in the library directories, loaded if
975 necessary, and bound to the current terminal instance.
976
977 If both of these resources are the empty string, then the perl
978 interpreter will not be initialized. The idea behind two options is
979 that perl-ext-common will be used for extensions that should be
980 available to all instances, while perl-ext is used for specific
981 instances.
982
983 perl-eval: *string*
984 Perl code to be evaluated when all extensions have been registered.
985 See the rxvtperl(3) manpage. Due to security reasons, this resource
986 will be ignored when running setuid/setgid.
987
988 perl-lib: *path*
989 Colon-separated list of additional directories that hold extension
990 scripts. When looking for extensions specified by the "perl"
991 resource, rxvt will first look in these directories and then in
992 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
993 will be ignored when running setuid/setgid.
994
995 See the rxvtperl(3) manpage.
996
997 selection.pattern-*idx*: *perl-regex*
998 Additional selection patterns, see the rxvtperl(3) manpage for
999 details.
1000
1001 selection-autotransform.*idx*: *perl-transform*
1002 Selection auto-transform patterns, see the rxvtperl(3) manpage for
1003 details.
1004
1005 searchable-scrollback: *keysym*
1006 Sets the hotkey that starts the incremental scrollback buffer search
1007 (default: "M-s").
1008
1009 urlLauncher: *string*
1010 Specifies the program to be started with a URL argument. Used by the
1011 "selection-popup" and "mark-urls" perl extensions.
1012
1013 transient-for: *windowid*
1014 Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given
1015 window id.
1016
1017 override-redirect: *boolean*
1018 Compile *frills*: Sets override-redirect for the terminal window,
1019 making it almost invisible to window managers; option
1020 -override-redirect.
1021
885THE SCROLLBAR 1022THE SCROLLBAR
886 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:
887 saveLines) and can be scrolled back using the scrollbar or by 1024 saveLines) and can be scrolled back using the scrollbar or by
888 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1025 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
889 fairly intuitive. The xterm-scrollbar is without arrows and its 1026 fairly intuitive. The xterm-scrollbar is without arrows and its
… …
915 entire logical line (which can span multiple screen lines), unless 1052 entire logical line (which can span multiple screen lines), unless
916 modified by resource tripleclickwords. 1053 modified by resource tripleclickwords.
917 1054
918 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)
919 (Compile: *frills*) will create a rectangular selection instead of a 1056 (Compile: *frills*) will create a rectangular selection instead of a
920 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.
921 1060
922 Insertion: 1061 Insertion:
923 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1062 Pressing and releasing the Middle mouse button in an rxvt window
924 an rxvt window causes the current text selection to be inserted as 1063 causes the value of the PRIMARY selection (or CLIPBOARD with the
925 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.
926 1069
927CHANGING FONTS 1070CHANGING FONTS
928 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
929 supported in rxvt-unicode. Bug me if you need this. 1072 supported in rxvt-unicode. Bug me if you need this.
930 1073
931 You can, however, switch fonts at runtime using escape sequences (and 1074 You can, however, switch fonts at runtime using escape sequences, e.g.:
932 therefore using the menubar), e.g.:
933 1075
934 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
935 1082
936 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
937 far. 1084 far.
938 1085
939ISO 14755 SUPPORT 1086ISO 14755 SUPPORT
… …
941 character codes using the keyboard. It consists of 4 parts. The first 1088 character codes using the keyboard. It consists of 4 parts. The first
942 part is available rxvt-unicode has been compiled with "--enable-frills", 1089 part is available rxvt-unicode has been compiled with "--enable-frills",
943 the rest is available when rxvt-unicode was compiled with 1090 the rest is available when rxvt-unicode was compiled with
944 "--enable-iso14755". 1091 "--enable-iso14755".
945 1092
946 * 5.1: Basic method 1093 * 5.1: Basic method
1094
947 This allows you to enter unicode characters using their hexcode. 1095 This allows you to enter unicode characters using their hexcode.
948 1096
949 Start by pressing and holding both "Control" and "Shift", then enter 1097 Start by pressing and holding both "Control" and "Shift", then enter
950 hex-digits (between one and six). Releasing "Control" and "Shift" 1098 hex-digits (between one and six). Releasing "Control" and "Shift"
951 will commit the character as if it were typed directly. While 1099 will commit the character as if it were typed directly. While
… …
957 address, which you cannot type. Fortunately, the card has the e-mail 1105 address, which you cannot type. Fortunately, the card has the e-mail
958 address printed as hexcodes, e.g. "671d 65e5". You can enter this 1106 address printed as hexcodes, e.g. "671d 65e5". You can enter this
959 easily by pressing "Control" and "Shift", followed by 1107 easily by pressing "Control" and "Shift", followed by
960 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys. 1108 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys.
961 1109
962 * 5.2: Keyboard symbols entry method 1110 * 5.2: Keyboard symbols entry method
1111
963 This mode lets you input characters representing the keycap symbols 1112 This mode lets you input characters representing the keycap symbols
964 of your keyboard, if representable in the current locale encoding. 1113 of your keyboard, if representable in the current locale encoding.
965 1114
966 Start by pressing "Control" and "Shift" together, then releasing 1115 Start by pressing "Control" and "Shift" together, then releasing
967 them. The next special key (cursor keys, home etc.) you enter will 1116 them. The next special key (cursor keys, home etc.) you enter will
968 not invoke it's usual function but instead will insert the 1117 not invoke its usual function but instead will insert the
969 corresponding keycap symbol. The symbol will only be entered when 1118 corresponding keycap symbol. The symbol will only be entered when
970 the key has been released, otherwise pressing e.g. "Shift" would 1119 the key has been released, otherwise pressing e.g. "Shift" would
971 enter the symbol for "ISO Level 2 Switch", although your intention 1120 enter the symbol for "ISO Level 2 Switch", although your intention
972 might have been to enter a reverse tab (Shift-Tab). 1121 might have been to enter a reverse tab (Shift-Tab).
973 1122
974 * 5.3: Screen-selection entry method 1123 * 5.3: Screen-selection entry method
1124
975 While this is implemented already (it's basically the selection 1125 While this is implemented already (it's basically the selection
976 mechanism), it could be extended by displaying a unicode character 1126 mechanism), it could be extended by displaying a unicode character
977 map. 1127 map.
978 1128
979 * 5.4: Feedback method for identifying displayed characters for later 1129 * 5.4: Feedback method for identifying displayed characters for later
980 input 1130 input
1131
981 This method lets you display the unicode character code associated 1132 This method lets you display the unicode character code associated
982 with characters already displayed. 1133 with characters already displayed.
983 1134
984 You enter this mode by holding down "Control" and "Shift" together, 1135 You enter this mode by holding down "Control" and "Shift" together,
985 then pressing and holding the left mouse button and moving around. 1136 then pressing and holding the left mouse button and moving around.
… …
1002 setgid to root or to some other group on others. 1153 setgid to root or to some other group on others.
1003 1154
1004COLORS AND GRAPHICS 1155COLORS AND GRAPHICS
1005 In addition to the default foreground and background colours, rxvt can 1156 In addition to the default foreground and background colours, rxvt can
1006 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 1157 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
1007 versions of the same). Here is a list of the colours with their rgb.txt 1158 versions of the same). Here is a list of the colours with their names.
1008 names.
1009 1159
1010 color0 (black) = Black 1160 color0 (black) = Black
1011 color1 (red) = Red3 1161 color1 (red) = Red3
1012 color2 (green) = Green3 1162 color2 (green) = Green3
1013 color3 (yellow) = Yellow3 1163 color3 (yellow) = Yellow3
1014 color4 (blue) = Blue3 1164 color4 (blue) = Blue3
1015 color5 (magenta) = Magenta3 1165 color5 (magenta) = Magenta3
1016 color6 (cyan) = Cyan3 1166 color6 (cyan) = Cyan3
1017 color7 (white) = AntiqueWhite 1167 color7 (white) = AntiqueWhite
1018 color8 (bright black) = Grey25 1168 color8 (bright black) = Grey25
1019 color9 (bright red) = Red 1169 color9 (bright red) = Red
1020 color10 (bright green) = Green 1170 color10 (bright green) = Green
1021 color11 (bright yellow) = Yellow 1171 color11 (bright yellow) = Yellow
1022 color12 (bright blue) = Blue 1172 color12 (bright blue) = Blue
1023 color13 (bright magenta) = Magenta 1173 color13 (bright magenta) = Magenta
1024 color14 (bright cyan) = Cyan 1174 color14 (bright cyan) = Cyan
1025 color15 (bright white) = White 1175 color15 (bright white) = White
1026 foreground = Black 1176 foreground = Black
1027 background = White 1177 background = White
1028
1029 It is also possible to specify the colour values of foreground, 1178 It is also possible to specify the colour values of foreground,
1030 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1179 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1031 0-15, as a convenient shorthand to reference the colour name of 1180 0-15, as a convenient shorthand to reference the colour name of
1032 color0-color15. 1181 color0-color15.
1033 1182
1183 In addition to the colours defined above, rxvt offers an additional 72
1184 colours. The first 64 of those (with indices 16 to 79) consist of a
1185 4*4*4 RGB colour cube (i.e. *index = r * 16 + g * 4 + b + 16*), followed
1186 by 8 additional shades of gray (with indices 80 to 87).
1187
1188 Together, all those colours implement the 88 colour xterm colours. Only
1189 the first 16 can be changed using resources currently, the rest can only
1190 be changed via command sequences ("escape codes").
1191
1034 Note that -rv ("reverseVideo: True") simulates reverse video by always 1192 Note that -rv ("reverseVideo: True") simulates reverse video by always
1035 swapping the foreground/background colours. This is in contrast to 1193 swapping the foreground/background colours. This is in contrast to
1036 *xterm*(1) where the colours are only swapped if they have not otherwise 1194 *xterm*(1) where the colours are only swapped if they have not otherwise
1037 been specified. For example, 1195 been specified. For example,
1038 1196
1039 rxvt -fg Black -bg White -rv 1197 rxvt -fg Black -bg White -rv
1040 would yield White on Black, while on *xterm*(1) it would yield Black 1198 would yield White on Black, while on *xterm*(1) it would yield Black
1041 on White. 1199 on White.
1200
1201 ALPHA CHANNEL SUPPORT
1202 If Xft support has been compiled in and as long as Xft/Xrender/X don't
1203 get their act together, rxvt-unicode will support
1204 "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4
1205 digits/component) colour specifications, in addition to the ones
1206 provided by X, where the additional A component specifies opacity
1207 (alpha) values. The minimum value of 0 is completely transparent). You
1208 can also prefix any color with "[a]", where "a" is on to four hex digits
1209 specifiying the opacity value.
1210
1211 You probably need to specify "-depth 32", too, and have the luck that
1212 your X-server uses ARGB pixel layout, as X is far from just supporting
1213 ARGB visuals out of the box, and rxvt-unicode just fudges around.
1214
1215 For example, the following selects an almost completely transparent red
1216 background, and an almost opaque pink foreground:
1217
1218 rxvt -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
1219
1220 *Please note that transparency of any kind if completely unsupported by
1221 the author. Don't bug him with installation questions!*
1042 1222
1043ENVIRONMENT 1223ENVIRONMENT
1044 rxvt sets and/or uses the following environment variables: 1224 rxvt sets and/or uses the following environment variables:
1045 1225
1046 TERM 1226 TERM
… …
1070 Set to the terminfo directory iff rxvt was configured with 1250 Set to the terminfo directory iff rxvt was configured with
1071 "--with-terminfo=PATH". 1251 "--with-terminfo=PATH".
1072 1252
1073 DISPLAY 1253 DISPLAY
1074 Used by rxvt to connect to the display and set to the correct 1254 Used by rxvt to connect to the display and set to the correct
1075 display in it's child processes. 1255 display in its child processes.
1076 1256
1077 SHELL 1257 SHELL
1078 The shell to be used for command execution, defaults to "/bin/sh". 1258 The shell to be used for command execution, defaults to "/bin/sh".
1079
1080 RXVTPATH
1081 The path where rxvt looks for support files such as menu and xpm
1082 files.
1083
1084 PATH
1085 Used in the same way as "RXVTPATH".
1086 1259
1087 RXVT_SOCKET 1260 RXVT_SOCKET
1088 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1261 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1089 1262
1090 Default $HOME/.rxvt-unicode-*<nodename*. 1263 Default $HOME/.rxvt-unicode-*<nodename*.
… …
1111 1284
1112CURRENT PROJECT COORDINATOR 1285CURRENT PROJECT COORDINATOR
1113 Project Coordinator 1286 Project Coordinator
1114 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1287 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1115 1288
1116 <http://software.schmorp.de/#rxvt-unicode> 1289 <http://software.schmorp.de/pkg/rxvt-unicode.html>
1117 1290
1118AUTHORS 1291AUTHORS
1119 John Bovey 1292 John Bovey
1120 University of Kent, 1992, wrote the original Xvt. 1293 University of Kent, 1992, wrote the original Xvt.
1121 1294
… …
1132 1305
1133 Oezguer Kesim <kesim@math.fu-berlin.de> 1306 Oezguer Kesim <kesim@math.fu-berlin.de>
1134 Project Coordinator (changes.txt 2.21a to 2.4.5) 1307 Project Coordinator (changes.txt 2.21a to 2.4.5)
1135 1308
1136 Geoff Wing <gcw@pobox.com> 1309 Geoff Wing <gcw@pobox.com>
1137 Rewrote screen display and text selection routines. Project 1310 Rewrote screen display and text selection routines.
1311
1138 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1312 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1139 1313
1140 Marc Alexander Lehmann <rxvt-unicode@schmorp.de> 1314 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1141 Forked rxvt-unicode, rewrote most of the display code and internal 1315 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1142 character handling to store text in unicode, improve xterm 1316 perl extension, random hacks, numerous bugfixes and extensions.
1143 compatibility and apply numerous other bugfixes and extensions.
1144 1317
1145 Project Coordinator (Changes 1.0 -) 1318 Project Coordinator (Changes 1.0 -)
1146 1319
1320 Emanuele Giaquinta <e.giaquinta@glauco.it>
1321 Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1322

Diff Legend

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