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

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.1 by root, Tue Jan 11 02:24:59 2005 UTC vs.
Revision 1.41 by root, Wed Jan 11 02:13:55 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 4.8, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 6.3, 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
15FREQUENTLY ASKED QUESTIONS 15FREQUENTLY ASKED QUESTIONS
16 See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions 16 See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions
17 and answer to them and some common problems. 17 and answer to them and some common problems. That document is also
18 accessible on the World-Wide-Web at
19 <http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
18 20
19RXVT-UNICODE VS. RXVT 21RXVT-UNICODE VS. RXVT
20 Unlike the original rxvt, rxvt-unicode stores all text in Unicode 22 Unlike the original rxvt, rxvt-unicode stores all text in Unicode
21 internally. That means it can store and display most scripts in the 23 internally. That means it can store and display most scripts in the
22 world. Being a terminal emulator, however, some things are very 24 world. Being a terminal emulator, however, some things are very
… …
91 Turn on/off simulated reverse video; resource reverseVideo. 93 Turn on/off simulated reverse video; resource reverseVideo.
92 94
93 -j|+j 95 -j|+j
94 Turn on/off jump scrolling; resource jumpScroll. 96 Turn on/off jump scrolling; resource jumpScroll.
95 97
96 -ip|+ip 98 -ip|+ip | -tr|+tr
97 Turn on/off inheriting parent window's pixmap. Alternative form is 99 Turn on/off inheriting parent window's pixmap. Alternative form is
98 -tr; resource inheritPixmap. 100 -tr; resource inheritPixmap.
99 101
100 -fade *number* 102 -fade *number*
101 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
102 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.
103 110
104 -tint *colour* 111 -tint *colour*
105 Tint the transparent background pixmap with the given colour when 112 Tint the transparent background pixmap with the given colour when
106 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
107 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;
108 tinting it. 116 resource *tintColor*. Example:
117
118 rxvt -tr -tint blue -sh 40
109 119
110 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent 120 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent
111 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
112 specified, too, e.g. "-tint white"). 122 specified, too, e.g. "-tint white").
113 123
… …
118 Window foreground colour; resource foreground. 128 Window foreground colour; resource foreground.
119 129
120 -pixmap *file[;geom]* 130 -pixmap *file[;geom]*
121 Compile *XPM*: Specify XPM file for the background and also 131 Compile *XPM*: Specify XPM file for the background and also
122 optionally specify its scaling with a geometry string. Note you may 132 optionally specify its scaling with a geometry string. Note you may
123 need to add quotes to avoid special shell interpretation of the `;' 133 need to add quotes to avoid special shell interpretation of the ";"
124 in the command-line; resource backgroundPixmap. 134 in the command-line; resource backgroundPixmap.
125 135
126 -cr *colour* 136 -cr *colour*
127 The cursor colour; resource cursorColor. 137 The cursor colour; resource cursorColor.
128 138
… …
153 163
154 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
155 FAQ section of rxvt(7). 165 FAQ section of rxvt(7).
156 166
157 -fb *fontlist* 167 -fb *fontlist*
158 Compile font-styles: The bold font list to use when bold characters 168 Compile *font-styles*: The bold font list to use when bold
159 are to be printed. See resource boldFont for details. 169 characters are to be printed. See resource boldFont for details.
160 170
161 -fi *fontlist* 171 -fi *fontlist*
162 Compile font-styles: The italic font list to use when bold 172 Compile *font-styles*: The italic font list to use when *italic*
163 characters are to be printed. See resource italicFont for details. 173 characters are to be printed. See resource italicFont for details.
164 174
165 -fbi *fontlist* 175 -fbi *fontlist*
166 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
167 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
168 details. 183 details.
169 184
170 -name *name* 185 -name *name*
171 Specify the application name under which resources are to be 186 Specify the application name under which resources are to be
172 obtained, rather than the default executable file name. Name should 187 obtained, rather than the default executable file name. Name should
… …
202 217
203 -sr|+sr 218 -sr|+sr
204 Put scrollbar on right/left; resource scrollBar_right. 219 Put scrollbar on right/left; resource scrollBar_right.
205 220
206 -st|+st 221 -st|+st
207 Display normal (non XTerm/NeXT) scrollbar without/with a trough; 222 Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
208 resource scrollBar_floating. 223 resource scrollBar_floating.
209 224
210 -ptab|+ptab 225 -ptab|+ptab
211 If enabled (default), "Horizontal Tab" characters are being stored 226 If enabled (default), "Horizontal Tab" characters are being stored
212 as actual wide characters in the screen buffer, which makes it 227 as actual wide characters in the screen buffer, which makes it
… …
236 externalBorder. 251 externalBorder.
237 252
238 -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.
239 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
240 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.
241 262
242 -lsp *number* 263 -lsp *number*
243 Compile *frills*: Lines (pixel height) to insert between each row of 264 Compile *frills*: Lines (pixel height) to insert between each row of
244 the display. Useful to work around font rendering problems; resource 265 the display. Useful to work around font rendering problems; resource
245 linespace. 266 linespace.
… …
257 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
258 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
259 run the program specified by the SHELL environment variable or, 280 run the program specified by the SHELL environment variable or,
260 failing that, *sh(1)*. 281 failing that, *sh(1)*.
261 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
262 -title *text* 289 -title *text*
263 Window title (-T still respected); the default title is the basename 290 Window title (-T still respected); the default title is the basename
264 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
265 application name; resource title. 292 application name; resource title.
266 293
… …
277 304
278 -im *text* 305 -im *text*
279 Compile *XIM*: input method name. resource inputMethod. 306 Compile *XIM*: input method name. resource inputMethod.
280 307
281 -imlocale *string* 308 -imlocale *string*
282 The locale to use for opening the IM. You can use an LC_CTYPE of 309 The locale to use for opening the IM. You can use an "LC_CTYPE" of
283 e.g. de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the 310 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for
284 input extension to be able to input japanese characters while 311 the input extension to be able to input japanese characters while
285 staying in another locale. 312 staying in another locale. resource imLocale.
313
314 -imfont *fontset*
315 Set the font set to use for the X Input Method, see resource imFont
316 for more info.
317
318 -tcw
319 Change the meaning of triple-click selection with the left mouse
320 button. Instead of selecting a full line it will extend the
321 selection the end of the logical line only. resource
322 tripleclickwords.
286 323
287 -insecure 324 -insecure
288 Enable "insecure" mode, which currently enables most of the escape 325 Enable "insecure" mode, which currently enables most of the escape
289 sequences that echo strings. See the resource insecure for more 326 sequences that echo strings. See the resource insecure for more
290 info. 327 info.
… …
299 336
300 -ssr|+ssr 337 -ssr|+ssr
301 Turn on/off secondary screen scroll (default enabled); resource 338 Turn on/off secondary screen scroll (default enabled); resource
302 secondaryScroll. 339 secondaryScroll.
303 340
304 -xrm *resourcestring* 341 -hold|+hold
305 No effect on rxvt-unicode. Simply passes through an argument to be 342 Turn on/off hold window after exit support. If enabled, rxvt will
306 made available in the instance's argument list. Appears in 343 not immediately destroy its window when the program executed within
307 *WM_COMMAND* in some window managers. 344 it exits. Instead, it will wait till it is being killed or closed by
345 the user; resource hold.
346
347 -keysym.*sym* *string*
348 Remap a key symbol. See resource keysym.
349
350 -embed *windowid*
351 Tells rxvt to embed it's windows into an already-existing window,
352 which enables applications to easily embed a terminal.
353
354 Right now, rxvt will first unmap/map the specified window, so it
355 shouldn't be a top-level window. rxvt will also reconfigure it quite
356 a bit, so don't expect it to keep some specific state. It's best to
357 create an extra subwindow for rxvt and leave it alone.
358
359 The window will not be destroyed when rxvt exits.
360
361 It might be useful to know that rxvt will not close file descriptors
362 passed to it (except for stdin/out/err, of course), so you can use
363 file descriptors to communicate with the programs within the
364 terminal. This works regardless of wether the "-embed" option was
365 used or not.
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.
308 407
309RESOURCES (available also as long-options) 408RESOURCES (available also as long-options)
310 Note: `rxvt --help' gives a list of all resources (long options) 409 Note: `rxvt --help' gives a list of all resources (long options)
311 compiled into your version. 410 compiled into your version.
312 411
313 There are two different methods that rxvt can use to get the Xresource 412 There are two different methods that rxvt can use to get the Xresource
314 data: using the X libraries (Xrm*-functions) or internal Xresources 413 data: using the X libraries (Xrm*-functions) or internal Xresources
315 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists 414 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
316 XGetDefaults), you can set and change the resources using X11 tools like 415 XGetDefaults), you can set and change the resources using X11 tools like
317 xset. Many distribution do also load settings from the ~/.Xresources 416 xrdb. Many distribution do also load settings from the ~/.Xresources
318 file when X starts. 417 file when X starts. rxvt will consult the following files/resources in
418 order, with later settings overwriting earlier ones:
419
420 1. system-wide app-defaults file, either locale-dependent OR global
421 2. app-defaults file in $XAPPLRESDIR
422 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
423 4. SCREEN_RESOURCES for the current screen
424 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
319 425
320 If compiled with internal Xresources support (i.e. rxvt -h lists 426 If compiled with internal Xresources support (i.e. rxvt -h lists
321 .Xdefaults) then rxvt accepts application defaults set in 427 .Xdefaults) then rxvt accepts application defaults set in
322 XAPPLOADDIR/URxvt (compile-time defined: usually 428 XAPPLOADDIR/URxvt (compile-time defined: usually
323 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 429 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or
… …
359 465
360 colorBD: *colour* 466 colorBD: *colour*
361 colorIT: *colour* 467 colorIT: *colour*
362 Use the specified colour to display bold or italic characters when 468 Use the specified colour to display bold or italic characters when
363 the foreground colour is the default. If font styles are not 469 the foreground colour is the default. If font styles are not
364 available (Compile styles) and this option is unset, reverse video 470 available (Compile *styles*) and this option is unset, reverse video
365 is used instead. 471 is used instead.
366 472
367 colorUL: *colour* 473 colorUL: *colour*
368 Use the specified colour to display underlined characters when the 474 Use the specified colour to display underlined characters when the
369 foreground colour is the default. 475 foreground colour is the default.
… …
399 True: make the background inherit the parent windows' pixmap, giving 505 True: make the background inherit the parent windows' pixmap, giving
400 artificial transparency. False: do not inherit the parent windows' 506 artificial transparency. False: do not inherit the parent windows'
401 pixmap. 507 pixmap.
402 508
403 fading: *number* 509 fading: *number*
404 Fade the text by the given percentage when focus is lost. 510 Fade the text by the given percentage when focus is lost; option
511 -fade.
512
513 fadeColor: *colour*
514 Fade to this colour, when fading is used (see fading:). The default
515 colour is black; option -fadecolor.
405 516
406 tintColor: *colour* 517 tintColor: *colour*
407 Tint the transparent background pixmap with the given colour. 518 Tint the transparent background pixmap with the given colour; option
519 -tint.
408 520
409 shading: *number* 521 shading: *number*
410 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 522 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
411 image in addition to tinting it. 523 image in addition to tinting it.
412 524
413 scrollColor: *colour* 525 scrollColor: *colour*
414 Use the specified colour for the scrollbar [default #B2B2B2]. 526 Use the specified colour for the scrollbar [default #B2B2B2].
415 527
416 troughColor: *colour* 528 troughColor: *colour*
417 Use the specified colour for the scrollbar's trough area [default 529 Use the specified colour for the scrollbar's trough area [default
418 #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 530 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
419 531
420 borderColor: *colour* 532 borderColor: *colour*
421 The colour of the border around the text area and between the 533 The colour of the border around the text area and between the
422 scrollbar and the text. 534 scrollbar and the text.
423 535
… …
446 font: *fontlist* 558 font: *fontlist*
447 Select the fonts to be used. This is a comma separated list of font 559 Select the fonts to be used. This is a comma separated list of font
448 names that are used in turn when trying to display Unicode 560 names that are used in turn when trying to display Unicode
449 characters. The first font defines the cell size for characters; 561 characters. The first font defines the cell size for characters;
450 other fonts might be smaller, but not larger. A reasonable default 562 other fonts might be smaller, but not larger. A reasonable default
451 font list is always appended to it. option -fn. 563 font list is always appended to it; option -fn.
452 564
453 Each font can either be a standard X11 core font (XLFD) name, with 565 Each font can either be a standard X11 core font (XLFD) name, with
454 optional prefix "x:" or a Xft font (Compile xft), prefixed with 566 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
455 "xft:". 567 "xft:".
456 568
457 In addition, each font can be prefixed with additional hints and 569 In addition, each font can be prefixed with additional hints and
458 specifications enclosed in square brackets ("[]"). The only 570 specifications enclosed in square brackets ("[]"). The only
459 available hint currently is "codeset=codeset-name", and this is only 571 available hint currently is "codeset=codeset-name", and this is only
… …
502 tried. 614 tried.
503 615
504 If set, but empty, then this specific style is disabled and the 616 If set, but empty, then this specific style is disabled and the
505 normal text font will being used for the given style. 617 normal text font will being used for the given style.
506 618
619 intensityStyles: *boolean*
620 When font styles are not enabled, or this option is enabled (True,
621 option -is, the default), bold and italic font styles imply high
622 intensity foreground/backround colours. Disabling this option
623 (False, option +is) disables this behaviour, the high intensity
624 colours are not reachable.
625
507 selectstyle: *mode* 626 selectstyle: *mode*
508 Set mouse selection style to old which is 2.20, oldword which is 627 Set mouse selection style to old which is 2.20, oldword which is
509 xterm style with 2.20 old word selection, or anything else which 628 xterm style with 2.20 old word selection, or anything else which
510 gives xterm style selection. 629 gives xterm style selection.
511 630
512 scrollstyle: *mode* 631 scrollstyle: *mode*
513 Set scrollbar style to rxvt, plain, next or xterm. plain is the 632 Set scrollbar style to rxvt, plain, next or xterm. plain is the
514 author's favourite.. 633 author's favourite.
515 634
516 title: *string* 635 title: *string*
517 Set window title string, the default title is the command-line 636 Set window title string, the default title is the command-line
518 specified after the -e option, if any, otherwise the application 637 specified after the -e option, if any, otherwise the application
519 name; option -title. 638 name; option -title.
… …
544 print-pipe: *string* 663 print-pipe: *string*
545 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use 664 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use
546 Print to initiate a screen dump to the printer and Ctrl-Print or 665 Print to initiate a screen dump to the printer and Ctrl-Print or
547 Shift-Print to include the scrollback as well. 666 Shift-Print to include the scrollback as well.
548 667
668 The string will be interpreted as if typed into the shell as-is.
669
670 Example:
671
672 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
673
674 This creates a new file in your home directory with the screen
675 contents everytime you hit "Print".
676
549 scrollBar: *boolean* 677 scrollBar: *boolean*
550 True: enable the scrollbar [default]; option -sb. False: disable the 678 True: enable the scrollbar [default]; option -sb. False: disable the
551 scrollbar; option +sb. 679 scrollbar; option +sb.
552 680
553 scrollBar_right: *boolean* 681 scrollBar_right: *boolean*
… …
566 True: scroll to bottom when tty receives output; option -si. False: 694 True: scroll to bottom when tty receives output; option -si. False:
567 do not scroll to bottom when tty receives output; option +si. 695 do not scroll to bottom when tty receives output; option +si.
568 696
569 scrollWithBuffer: *boolean* 697 scrollWithBuffer: *boolean*
570 True: scroll with scrollback buffer when tty receives new lines (and 698 True: scroll with scrollback buffer when tty receives new lines (and
571 scrollTtyOutput is False); option +sw. False: do not scroll with 699 scrollTtyOutput is False); option -sw. False: do not scroll with
572 scrollback buffer when tty recieves new lines; option -sw. 700 scrollback buffer when tty recieves new lines; option +sw.
573 701
574 scrollTtyKeypress: *boolean* 702 scrollTtyKeypress: *boolean*
575 True: scroll to bottom when a non-special key is pressed. Special 703 True: scroll to bottom when a non-special key is pressed. Special
576 keys are those which are intercepted by rxvt-unicode for special 704 keys are those which are intercepted by rxvt-unicode for special
577 handling and are not passed onto the shell; option -sk. False: do 705 handling and are not passed onto the shell; option -sk. False: do
… …
592 borderLess: *boolean* 720 borderLess: *boolean*
593 Set MWM hints to request a borderless window, i.e. if honoured by 721 Set MWM hints to request a borderless window, i.e. if honoured by
594 the WM, the rxvt-unicode window will not have window decorations; 722 the WM, the rxvt-unicode window will not have window decorations;
595 option -bl. 723 option -bl.
596 724
725 skipBuiltinGlyphs: *boolean*
726 Compile *frills*: Disable the usage of the built-in block
727 graphics/line drawing characters and just rely on what the specified
728 fonts provide. Use this if you have a good font and want to use its
729 block graphic glyphs; option -sbg.
730
597 termName: *termname* 731 termName: *termname*
598 Specifies the terminal type name to be set in the TERM environment 732 Specifies the terminal type name to be set in the TERM environment
599 variable; option -tn. 733 variable; option -tn.
600 734
601 linespace: *number* 735 linespace: *number*
… …
629 pointerColor2: *colour* 763 pointerColor2: *colour*
630 Mouse pointer background colour. 764 Mouse pointer background colour.
631 765
632 pointerBlankDelay: *number* 766 pointerBlankDelay: *number*
633 Specifies number of seconds before blanking the pointer [default 2]. 767 Specifies number of seconds before blanking the pointer [default 2].
768 Use a large number (e.g. 987654321) to effectively disable the
769 timeout.
634 770
635 backspacekey: *string* 771 backspacekey: *string*
636 The string to send when the backspace key is pressed. If set to DEC 772 The string to send when the backspace key is pressed. If set to DEC
637 or unset it will send Delete (code 127) or, if shifted, Backspace 773 or unset it will send Delete (code 127) or, if shifted, Backspace
638 (code 8) - which can be reversed with the appropriate DEC private 774 (code 8) - which can be reversed with the appropriate DEC private
… …
654 790
655 inputMethod: *name* 791 inputMethod: *name*
656 *name* of inputMethod to use; option -im. 792 *name* of inputMethod to use; option -im.
657 793
658 imLocale: *name* 794 imLocale: *name*
659 The locale to use for opening the IM. You can use an LC_CTYPE of 795 The locale to use for opening the IM. You can use an "LC_CTYPE" of
660 e.g. de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the 796 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for
661 input extension to be able to input japanese characters while 797 the input extension to be able to input japanese characters while
662 staying in another locale. option -imlocale. 798 staying in another locale; option -imlocale.
799
800 imFont: *fontset*
801 Specify the font-set used for XIM styles "OverTheSpot" or
802 "OffTheSpot". It must be a standard X font set (XLFD patterns
803 separated by commas), i.e. it's not in the same format as the other
804 font lists used in rxvt. The default will be set-up to chose *any*
805 suitable found found, preferably one or two pixels differing in size
806 to the base font. option -imfont.
807
808 tripleclickwords: *boolean*
809 Change the meaning of triple-click selection with the left mouse
810 button. Instead of selecting a full line it will extend the
811 selection to the end of the logical line only; option -tcw.
663 812
664 insecure: *boolean* 813 insecure: *boolean*
665 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 814 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
666 that echo arbitrary strings like the icon name or the locale. This 815 that echo arbitrary strings like the icon name or the locale. This
667 could be abused if somebody gets 8-bit-clean access to your display, 816 could be abused if somebody gets 8-bit-clean access to your display,
668 whether throuh a mail client displaying mail bodies unfiltered or 817 whether through a mail client displaying mail bodies unfiltered or
669 though write(1). Therefore, these sequences are disabled by default. 818 through write(1) or any other means. Therefore, these sequences are
670 (Note that other terminals, including xterm, have these sequences 819 disabled by default. (Note that many other terminals, including
671 enabled by default). You can enable them by setting this boolean 820 xterm, have these sequences enabled by default, which doesn't make
672 resource or specifying -insecure as an option. At the moment, this 821 it safer, though).
673 enabled display-answer, locale, findfont, icon label and window 822
674 title requests as well as dynamic menubar dispatch. 823 You can enable them by setting this boolean resource or specifying
824 -insecure as an option. At the moment, this enables display-answer,
825 locale, findfont, icon label and window title requests as well as
826 dynamic menubar dispatch.
675 827
676 modifier: *modifier* 828 modifier: *modifier*
677 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 829 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
678 super, mod1, mod2, mod3, mod4, mod5; option -mod. 830 super, mod1, mod2, mod3, mod4, mod5; option -mod.
679 831
… …
689 Turn on/off secondary screen scroll (default enabled). If the this 841 Turn on/off secondary screen scroll (default enabled). If the this
690 option is enabled, scrolls on the secondary screen will change the 842 option is enabled, scrolls on the secondary screen will change the
691 scrollback buffer and switching to/from the secondary screen will 843 scrollback buffer and switching to/from the secondary screen will
692 instead scroll the screen up. 844 instead scroll the screen up.
693 845
846 hold: *bool*
847 Turn on/off hold window after exit support. If enabled, rxvt will
848 not immediately destroy its window when the program executed within
849 it exits. Instead, it will wait till it is being killed or closed by
850 the user.
851
694 keysym.*sym*: *string* 852 keysym.*sym*: *string*
695 Associate *string* with keysym *sym* (0xFF00 - 0xFFFF). It may 853 Compile *frills*: Associate *string* with keysym *sym*. The
696 contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:
697 newline, \r: return, \t: tab, \000: octal number) or control
698 characters (^?: delete, ^@: null, ^A ...) and may enclosed with
699 double quotes so that it can start or end with whitespace. The
700 intervening resource name keysym. cannot be omitted. This resource 854 intervening resource name keysym. cannot be omitted.
701 is only available when compiled with KEYSYM_RESOURCE. 855
856 The format of *sym* is "*(modifiers-)key*", where *modifiers* can be
857 any combination of ISOLevel3, AppKeypad, Control, NumLock, Shift,
858 Meta, Lock, Mod1, Mod2, Mod3, Mod4, Mod5, and the abbreviated I, K,
859 C, N, S, M, A, L, 1, 2, 3, 4, 5.
860
861 The NumLock, Meta and ISOLevel3 modifiers are usually aliased to
862 whatever modifier the NumLock key, Meta/Alt keys or ISO Level3
863 Shift/AltGr keys are being mapped. AppKeypad is a synthetic modifier
864 mapped to the current application keymap mode state.
865
866 The spellings of *key* can be obtained by using xev(1) command or
867 searching keysym macros from /usr/X11R6/include/X11/keysymdef.h and
868 omitting the prefix XK_. Alternatively you can specify *key* by its
869 hex keysym value (0x0000 - 0xFFFF). Note that the lookup of *sym*s
870 is not performed in an exact manner; however, the closest match is
871 assured.
872
873 *string* may contain escape values ("\a": bell, "\b": backspace,
874 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
875 "\000": octal number) or verbatim control characters ("^?": delete,
876 "^@": null, "^A" ...) and may be enclosed with double quotes so that
877 it can start or end with whitespace.
878
879 Please note that you need to double the "\" when using
880 "--enable-xgetdefault", as X itself does it's own de-escaping (you
881 can use "\033" instead of "\e" (and so on), which will work with
882 both Xt and rxvt's own processing).
883
884 You can define a range of keysyms in one shot by providing a
885 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
886 `/' should be a character not used by the strings.
887
888 Its usage can be demonstrated by an example:
889
890 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
891
892 The above line is equivalent to the following three lines:
893
894 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
895 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
896 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
897
898 If *string* takes the form of "command:STRING", the specified STRING
899 is interpreted and executed as rxvt's control sequence. For example
900 the following means "change the current locale to "zh_CN.GBK" when
901 Control-Meta-c is being pressed":
902
903 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
904
905 If *string* takes the form "perl:STRING", then the specified STRING
906 is passed to the "on_keyboard_command" perl handler. See the
907 rxvtperl(3) manpage. For example, the selection extension (activated
908 via "rxvt -pe selection") listens for "selection:rot13" events:
909
910 URxvt.keysym.M-C-c: perl:selection:rot13
911
912 Due the the large number of modifier combinations, a defined key
913 mapping will match if at *at least* the specified identifiers are
914 being set, and no other key mappings with those and more bits are
915 being defined. That means that defining a key map for "a" will
916 automatically provide definitions for "Meta-a", "Shift-a" and so on,
917 unless some of those are defined mappings themselves.
918
919 Unfortunately, this will override built-in key mappings. For example
920 if you overwrite the "Insert" key you will disable rxvt's
921 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
922 the user-defined keymap using the "builtin:" replacement:
923
924 URxvt.keysym.Insert: <my insert key sequence>
925 URxvt.keysym.S-Insert: builtin:
926
927 The first line defines a mapping for "Insert" and *any* combination
928 of modifiers. The second line re-establishes the default mapping for
929 "Shift-Insert".
930
931 The following example will map Control-Meta-1 and Control-Meta-2 to
932 the fonts "suxuseuro" and "9x15bold", so you can have some limited
933 font-switching at runtime:
934
935 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
936 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
937
938 Other things are possible, e.g. resizing (see rxvt(7) for more
939 info):
940
941 URxvt.keysym.M-C-3: command:\033[8;25;80t
942 URxvt.keysym.M-C-4: command:\033[8;48;110t
943
944 perl-ext-common: *string*
945 perl-ext: *string*
946 Comma-separated list(s) of perl extension scripts (default:
947 "default") to use in this terminal instance; option -pe.
948
949 Extension names can be prefixed with a "-" sign to prohibit using
950 them. This can be useful to selectively disable some extensions
951 loaded by default, or specified via the "perl-ext-common" resource.
952 For example, "default,-selection" will use all the default extension
953 except "selection".
954
955 Extension names can also be followed by an argument in angle
956 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
957 for searchable scorllback to Alt/Meta-s). Mentioning the same
958 extension multiple times with different arguments will pass multiple
959 arguments to the extension.
960
961 Each extension is looked up in the library directories, loaded if
962 necessary, and bound to the current terminal instance.
963
964 If both of these resources are the empty string, then the perl
965 interpreter will not be initialized. The idea behind two options is
966 that perl-ext-common will be used for extensions that should be
967 available to all instances, while perl-ext is used for specific
968 instances.
969
970 perl-eval: *string*
971 Perl code to be evaluated when all extensions have been registered.
972 See the rxvtperl(3) manpage. Due to security reasons, this resource
973 will be ignored when running setuid/setgid.
974
975 perl-lib: *path*
976 Colon-separated list of additional directories that hold extension
977 scripts. When looking for extensions specified by the "perl"
978 resource, rxvt will first look in these directories and then in
979 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
980 will be ignored when running setuid/setgid.
981
982 See the rxvtperl(3) manpage.
983
984 urlLauncher: *string*
985 Specifies the program to be started with a URL argument. Used by the
986 "selection-popup" and "mark-urls" perl extensions.
987
988 transient-for: *windowid*
989 Sets the WM_TRANSIENT_FOR property to the given window iw.
702 990
703THE SCROLLBAR 991THE SCROLLBAR
704 Lines of text that scroll off the top of the rxvt window (resource: 992 Lines of text that scroll off the top of the rxvt window (resource:
705 saveLines) and can be scrolled back using the scrollbar or by 993 saveLines) and can be scrolled back using the scrollbar or by
706 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 994 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
… …
716 normal text selection/insertion, hold either the Shift or the Meta (Alt) 1004 normal text selection/insertion, hold either the Shift or the Meta (Alt)
717 key while performing the desired mouse action. 1005 key while performing the desired mouse action.
718 1006
719 If mouse reporting mode is active, the normal scrollbar actions are 1007 If mouse reporting mode is active, the normal scrollbar actions are
720 disabled -- on the assumption that we are using a fullscreen 1008 disabled -- on the assumption that we are using a fullscreen
721 application. Instead, pressing Button1 and Button3 sends ESC[6~ (Next) 1009 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
722 and ESC[5~ (Prior), respectively. Similarly, clicking on the up and down 1010 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
723 arrows sends ESC[A (Up) and ESC[B (Down), respectively. 1011 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
724 1012
725TEXT SELECTION AND INSERTION 1013TEXT SELECTION AND INSERTION
726 The behaviour of text selection and insertion mechanism is similar to 1014 The behaviour of text selection and insertion mechanism is similar to
727 *xterm*(1). 1015 *xterm*(1).
728 1016
729 Selection: 1017 Selection:
730 Left click at the beginning of the region, drag to the end of the 1018 Left click at the beginning of the region, drag to the end of the
731 region and release; Right click to extend the marked region; Left 1019 region and release; Right click to extend the marked region; Left
732 double-click to select a word; Left triple-click to select the 1020 double-click to select a word; Left triple-click to select the
733 entire line. 1021 entire logical line (which can span multiple screen lines), unless
1022 modified by resource tripleclickwords.
734 1023
735 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 1024 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
736 (Compile: frills) will create a rectangular selection instead of a 1025 (Compile: *frills*) will create a rectangular selection instead of a
737 normal one. 1026 normal one. In this mode, every selected row becomes its own line in
1027 the selection, and trailing whitespace is visually underlined and
1028 removed from the selection.
738 1029
739 Insertion: 1030 Insertion:
740 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1031 Pressing and releasing the Middle mouse button (or Shift-Insert) in
741 an rxvt window causes the current text selection to be inserted as 1032 an rxvt window causes the current text selection to be inserted as
742 if it had been typed on the keyboard. 1033 if it had been typed on the keyboard.
… …
746 supported in rxvt-unicode. Bug me if you need this. 1037 supported in rxvt-unicode. Bug me if you need this.
747 1038
748 You can, however, switch fonts at runtime using escape sequences (and 1039 You can, however, switch fonts at runtime using escape sequences (and
749 therefore using the menubar), e.g.: 1040 therefore using the menubar), e.g.:
750 1041
751 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1042 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
752 1043
753 rxvt-unicode will automatically re-apply these fonts to the output so 1044 rxvt-unicode will automatically re-apply these fonts to the output so
754 far. 1045 far.
755 1046
756ISO 14755 SUPPORT 1047ISO 14755 SUPPORT
… …
758 character codes using the keyboard. It consists of 4 parts. The first 1049 character codes using the keyboard. It consists of 4 parts. The first
759 part is available rxvt-unicode has been compiled with "--enable-frills", 1050 part is available rxvt-unicode has been compiled with "--enable-frills",
760 the rest is available when rxvt-unicode was compiled with 1051 the rest is available when rxvt-unicode was compiled with
761 "--enable-iso14755". 1052 "--enable-iso14755".
762 1053
763 5.1: Basic method 1054 * 5.1: Basic method
764 This allows you to enter unicode characters using their hexcode. 1055 This allows you to enter unicode characters using their hexcode.
765 1056
766 Start by pressing and holding both "Control" and "Shift", then enter 1057 Start by pressing and holding both "Control" and "Shift", then enter
767 hex-digits (between one and six). Releasing "Control" and "Shift" 1058 hex-digits (between one and six). Releasing "Control" and "Shift"
768 will commit the character as if it were typed directly. While 1059 will commit the character as if it were typed directly. While
… …
774 address, which you cannot type. Fortunately, the card has the e-mail 1065 address, which you cannot type. Fortunately, the card has the e-mail
775 address printed as hexcodes, e.g. "671d 65e5". You can enter this 1066 address printed as hexcodes, e.g. "671d 65e5". You can enter this
776 easily by pressing "Control" and "Shift", followed by 1067 easily by pressing "Control" and "Shift", followed by
777 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys. 1068 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys.
778 1069
779 5.2: Keyboard symbols entry method 1070 * 5.2: Keyboard symbols entry method
780 This mode lets you input characters representing the keycap symbols 1071 This mode lets you input characters representing the keycap symbols
781 of your keyboard, if representable in the current locale encoding. 1072 of your keyboard, if representable in the current locale encoding.
782 1073
783 Start by pressing "Control" and "Shift" together, then releasing 1074 Start by pressing "Control" and "Shift" together, then releasing
784 them. The next special key (cursor keys, home etc.) you enter will 1075 them. The next special key (cursor keys, home etc.) you enter will
… …
786 corresponding keycap symbol. The symbol will only be entered when 1077 corresponding keycap symbol. The symbol will only be entered when
787 the key has been released, otherwise pressing e.g. "Shift" would 1078 the key has been released, otherwise pressing e.g. "Shift" would
788 enter the symbol for "ISO Level 2 Switch", although your intention 1079 enter the symbol for "ISO Level 2 Switch", although your intention
789 might have been to enter a reverse tab (Shift-Tab). 1080 might have been to enter a reverse tab (Shift-Tab).
790 1081
791 5.3: Screen-selection entry method 1082 * 5.3: Screen-selection entry method
792 While this is implemented already (it's basically the selection 1083 While this is implemented already (it's basically the selection
793 mechanism), it could be extended by displaying a unicode character 1084 mechanism), it could be extended by displaying a unicode character
794 map. 1085 map.
795 1086
796 5.4: Feedback method for identifying displayed characters for later 1087 * 5.4: Feedback method for identifying displayed characters for later
797 input 1088 input
798 This method lets you display the unicode character code associated 1089 This method lets you display the unicode character code associated
799 with characters already displayed. 1090 with characters already displayed.
800 1091
801 You enter this mode by holding down "Control" and "Shift" together, 1092 You enter this mode by holding down "Control" and "Shift" together,
… …
813 both scenario A and B of ISO 14755, including part 5.2. 1104 both scenario A and B of ISO 14755, including part 5.2.
814 1105
815LOGIN STAMP 1106LOGIN STAMP
816 rxvt tries to write an entry into the *utmp*(5) file so that it can be 1107 rxvt tries to write an entry into the *utmp*(5) file so that it can be
817 seen via the *who(1)* command, and can accept messages. To allow this 1108 seen via the *who(1)* command, and can accept messages. To allow this
818 feature, rxvt must be installed setuid root on some systems. 1109 feature, rxvt may need to be installed setuid root on some systems or
1110 setgid to root or to some other group on others.
819 1111
820COLORS AND GRAPHICS 1112COLORS AND GRAPHICS
821 In addition to the default foreground and background colours, rxvt can 1113 In addition to the default foreground and background colours, rxvt can
822 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 1114 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
823 versions of the same). Here is a list of the colours with their rgb.txt 1115 versions of the same). Here is a list of the colours with their rgb.txt
… …
855 rxvt -fg Black -bg White -rv 1147 rxvt -fg Black -bg White -rv
856 would yield White on Black, while on *xterm*(1) it would yield Black 1148 would yield White on Black, while on *xterm*(1) it would yield Black
857 on White. 1149 on White.
858 1150
859ENVIRONMENT 1151ENVIRONMENT
860 rxvt sets the environment variables TERM, COLORTERM and COLORFGBG. The 1152 rxvt sets and/or uses the following environment variables:
861 environment variable WINDOWID is set to the X window id number of the 1153
862 rxvt window and it also uses and sets the environment variable DISPLAY 1154 TERM
863 to specify which display terminal to use. rxvt uses the environment 1155 Normally set to "rxvt-unicode", unless overwritten at configure
864 variables RXVTPATH and PATH to find XPM files. 1156 time, via resources or on the commandline.
1157
1158 COLORTERM
1159 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled
1160 with XPM support, and optionally with the added extension "-mono" to
1161 indicate that rxvt-unicode runs on a monochrome screen.
1162
1163 COLORFGBG
1164 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1165 the colour code used as default foreground/text colour (or the
1166 string "default" to indicate that the default-colour escape sequence
1167 is to be used), "bg" is the colour code used as default background
1168 colour (or the string "default"), and "xpm" is the string "default"
1169 if rxvt was compiled with XPM support. Libraries like "ncurses" and
1170 "slang" can (and do) use this information to optimize screen output.
1171
1172 WINDOWID
1173 Set to the (decimal) X Window ID of the rxvt window (the toplevel
1174 window, which usually has subwindows for the scrollbar, the terminal
1175 window and so on).
1176
1177 TERMINFO
1178 Set to the terminfo directory iff rxvt was configured with
1179 "--with-terminfo=PATH".
1180
1181 DISPLAY
1182 Used by rxvt to connect to the display and set to the correct
1183 display in it's child processes.
1184
1185 SHELL
1186 The shell to be used for command execution, defaults to "/bin/sh".
1187
1188 RXVTPATH
1189 The path where rxvt looks for support files such as menu and xpm
1190 files.
1191
1192 PATH
1193 Used in the same way as "RXVTPATH".
1194
1195 RXVT_SOCKET
1196 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1197
1198 Default $HOME/.rxvt-unicode-*<nodename*.
1199
1200 HOME
1201 Used to locate the default directory for the unix domain socket for
1202 daemon communications and to locate various resource files (such as
1203 ".Xdefaults")
1204
1205 XAPPLRESDIR
1206 Directory where various X resource files are being located.
1207
1208 XENVIRONMENT
1209 If set and accessible, gives the name of a X resource file to be
1210 loaded by rxvt.
865 1211
866FILES 1212FILES
867 /etc/utmp
868 System file for login records.
869
870 /usr/lib/X11/rgb.txt 1213 /usr/lib/X11/rgb.txt
871 Color names. 1214 Color names.
872 1215
873SEE ALSO 1216SEE ALSO
874 rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1217 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
875 1218 tty(4), utmp(5)
876BUGS
877 Check the BUGS file for an up-to-date list.
878
879 Cursor change support is not yet implemented.
880
881 Click-and-drag doesn't work with X11 mouse report overriding.
882 1219
883CURRENT PROJECT COORDINATOR 1220CURRENT PROJECT COORDINATOR
884 Project Coordinator 1221 Project Coordinator
885 Marc A. Lehmann rxvt@schmorp.de 1222 Marc A. Lehmann <rxvt-unicode@schmorp.de>
886 1223
887 Web page maintainter
888 Marc A. Lehmann rxvt@schmorp.de
889
890 <http://software.schmorp.de/> 1224 <http://software.schmorp.de/#rxvt-unicode>
891 1225
892AUTHORS 1226AUTHORS
893 John Bovey 1227 John Bovey
894 University of Kent, 1992, wrote the original Xvt. 1228 University of Kent, 1992, wrote the original Xvt.
895 1229
… …
909 1243
910 Geoff Wing <gcw@pobox.com> 1244 Geoff Wing <gcw@pobox.com>
911 Rewrote screen display and text selection routines. Project 1245 Rewrote screen display and text selection routines. Project
912 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1246 Coordinator (changes.txt 2.4.6 - rxvt-unicode)
913 1247
914 Marc Alexander Lehmann <rxvt@schmorp.de> 1248 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
915 Forked rxvt-unicode, rewrote most of the display code and internal 1249 Forked rxvt-unicode, rewrote most of the display code and internal
916 character handling to store text in unicode, improve xterm 1250 character handling to store text in unicode, improve xterm
917 compatibility and apply numerous other bugfixes and extensions. 1251 compatibility and apply numerous other bugfixes and extensions.
918 1252
919 Project Coordinator (Changes 1.0 -) 1253 Project Coordinator (Changes 1.0 -)

Diff Legend

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