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.3 by root, Mon Jan 17 01:44:51 2005 UTC vs.
Revision 1.43 by root, Thu Jan 12 05:37:34 2006 UTC

… …
4 4
5SYNOPSIS 5SYNOPSIS
6 rxvt [options] [-e command [ args ]] 6 rxvt [options] [-e command [ args ]]
7 7
8DESCRIPTION 8DESCRIPTION
9 rxvt-unicode, version 4.8, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 7.0, is a colour vt102 terminal emulator intended
10 as an *xterm*(1) replacement for users who do not require features such 10 as an *xterm*(1) replacement for users who do not require features such
11 as Tektronix 4014 emulation and toolkit-style configurability. As a 11 as Tektronix 4014 emulation and toolkit-style configurability. As a
12 result, rxvt-unicode uses much less swap space -- a significant 12 result, rxvt-unicode uses much less swap space -- a significant
13 advantage on a machine serving many X sessions. 13 advantage on a machine serving many X sessions.
14 14
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
… …
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
314 data: using the X libraries (Xrm*-functions) or internal Xresources
315 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
316 XGetDefaults), you can set and change the resources using X11 tools like 412 You can set and change the resources using X11 tools like xrdb. Many
317 xset. Many distribution do also load settings from the ~/.Xresources 413 distribution do also load settings from the ~/.Xresources file when X
318 file when X starts. 414 starts. rxvt will consult the following files/resources in order, with
415 later settings overwriting earlier ones:
319 416
320 If compiled with internal Xresources support (i.e. rxvt -h lists 417 1. system-wide app-defaults file, either locale-dependent OR global
321 .Xdefaults) then rxvt accepts application defaults set in 418 2. app-defaults file in $XAPPLRESDIR
322 XAPPLOADDIR/URxvt (compile-time defined: usually 419 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
323 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 420 4. SCREEN_RESOURCES for the current screen
324 ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X 421 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
325 resources, rxvt recognizes two class names: XTerm and URxvt. The class 422
326 name Rxvt allows resources common to both rxvt and the original *rxvt* 423 Note that when reading X resources, rxvt recognizes two class names:
327 to be easily configured, while the class name URxvt allows resources 424 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
328 unique to rxvt, notably colours and key-handling, to be shared between 425 and the original *rxvt* to be easily configured, while the class name
426 URxvt allows resources unique to rxvt, to be shared between different
329 different rxvt configurations. If no resources are specified, suitable 427 rxvt configurations. If no resources are specified, suitable defaults
330 defaults will be used. Command-line arguments can be used to override 428 will be used. Command-line arguments can be used to override resource
331 resource settings. The following resources are allowed: 429 settings. The following resources are supported (you might want to check
430 the rxvtperl(3) manpage for additional settings by perl extensions not
431 documented here):
332 432
333 geometry: *geom* 433 geometry: *geom*
334 Create the window with the specified X window geometry [default 434 Create the window with the specified X window geometry [default
335 80x24]; option -geometry. 435 80x24]; option -geometry.
336 436
… …
399 True: make the background inherit the parent windows' pixmap, giving 499 True: make the background inherit the parent windows' pixmap, giving
400 artificial transparency. False: do not inherit the parent windows' 500 artificial transparency. False: do not inherit the parent windows'
401 pixmap. 501 pixmap.
402 502
403 fading: *number* 503 fading: *number*
404 Fade the text by the given percentage when focus is lost. 504 Fade the text by the given percentage when focus is lost; option
505 -fade.
506
507 fadeColor: *colour*
508 Fade to this colour, when fading is used (see fading:). The default
509 colour is black; option -fadecolor.
405 510
406 tintColor: *colour* 511 tintColor: *colour*
407 Tint the transparent background pixmap with the given colour. 512 Tint the transparent background pixmap with the given colour; option
513 -tint.
408 514
409 shading: *number* 515 shading: *number*
410 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 516 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
411 image in addition to tinting it. 517 image in addition to tinting it.
412 518
413 scrollColor: *colour* 519 scrollColor: *colour*
414 Use the specified colour for the scrollbar [default #B2B2B2]. 520 Use the specified colour for the scrollbar [default #B2B2B2].
415 521
416 troughColor: *colour* 522 troughColor: *colour*
417 Use the specified colour for the scrollbar's trough area [default 523 Use the specified colour for the scrollbar's trough area [default
418 #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 524 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
419 525
420 borderColor: *colour* 526 borderColor: *colour*
421 The colour of the border around the text area and between the 527 The colour of the border around the text area and between the
422 scrollbar and the text. 528 scrollbar and the text.
423 529
… …
446 font: *fontlist* 552 font: *fontlist*
447 Select the fonts to be used. This is a comma separated list of font 553 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 554 names that are used in turn when trying to display Unicode
449 characters. The first font defines the cell size for characters; 555 characters. The first font defines the cell size for characters;
450 other fonts might be smaller, but not larger. A reasonable default 556 other fonts might be smaller, but not larger. A reasonable default
451 font list is always appended to it. option -fn. 557 font list is always appended to it; option -fn.
452 558
453 Each font can either be a standard X11 core font (XLFD) name, with 559 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 560 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
455 "xft:". 561 "xft:".
456 562
… …
502 tried. 608 tried.
503 609
504 If set, but empty, then this specific style is disabled and the 610 If set, but empty, then this specific style is disabled and the
505 normal text font will being used for the given style. 611 normal text font will being used for the given style.
506 612
613 intensityStyles: *boolean*
614 When font styles are not enabled, or this option is enabled (True,
615 option -is, the default), bold and italic font styles imply high
616 intensity foreground/backround colours. Disabling this option
617 (False, option +is) disables this behaviour, the high intensity
618 colours are not reachable.
619
507 selectstyle: *mode* 620 selectstyle: *mode*
508 Set mouse selection style to old which is 2.20, oldword which is 621 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 622 xterm style with 2.20 old word selection, or anything else which
510 gives xterm style selection. 623 gives xterm style selection.
511 624
512 scrollstyle: *mode* 625 scrollstyle: *mode*
513 Set scrollbar style to rxvt, plain, next or xterm. plain is the 626 Set scrollbar style to rxvt, plain, next or xterm. plain is the
514 author's favourite.. 627 author's favourite.
515 628
516 title: *string* 629 title: *string*
517 Set window title string, the default title is the command-line 630 Set window title string, the default title is the command-line
518 specified after the -e option, if any, otherwise the application 631 specified after the -e option, if any, otherwise the application
519 name; option -title. 632 name; option -title.
… …
544 print-pipe: *string* 657 print-pipe: *string*
545 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use 658 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 659 Print to initiate a screen dump to the printer and Ctrl-Print or
547 Shift-Print to include the scrollback as well. 660 Shift-Print to include the scrollback as well.
548 661
662 The string will be interpreted as if typed into the shell as-is.
663
664 Example:
665
666 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
667
668 This creates a new file in your home directory with the screen
669 contents everytime you hit "Print".
670
549 scrollBar: *boolean* 671 scrollBar: *boolean*
550 True: enable the scrollbar [default]; option -sb. False: disable the 672 True: enable the scrollbar [default]; option -sb. False: disable the
551 scrollbar; option +sb. 673 scrollbar; option +sb.
552 674
553 scrollBar_right: *boolean* 675 scrollBar_right: *boolean*
… …
566 True: scroll to bottom when tty receives output; option -si. False: 688 True: scroll to bottom when tty receives output; option -si. False:
567 do not scroll to bottom when tty receives output; option +si. 689 do not scroll to bottom when tty receives output; option +si.
568 690
569 scrollWithBuffer: *boolean* 691 scrollWithBuffer: *boolean*
570 True: scroll with scrollback buffer when tty receives new lines (and 692 True: scroll with scrollback buffer when tty receives new lines (and
571 scrollTtyOutput is False); option +sw. False: do not scroll with 693 scrollTtyOutput is False); option -sw. False: do not scroll with
572 scrollback buffer when tty recieves new lines; option -sw. 694 scrollback buffer when tty recieves new lines; option +sw.
573 695
574 scrollTtyKeypress: *boolean* 696 scrollTtyKeypress: *boolean*
575 True: scroll to bottom when a non-special key is pressed. Special 697 True: scroll to bottom when a non-special key is pressed. Special
576 keys are those which are intercepted by rxvt-unicode for special 698 keys are those which are intercepted by rxvt-unicode for special
577 handling and are not passed onto the shell; option -sk. False: do 699 handling and are not passed onto the shell; option -sk. False: do
… …
592 borderLess: *boolean* 714 borderLess: *boolean*
593 Set MWM hints to request a borderless window, i.e. if honoured by 715 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; 716 the WM, the rxvt-unicode window will not have window decorations;
595 option -bl. 717 option -bl.
596 718
719 skipBuiltinGlyphs: *boolean*
720 Compile *frills*: Disable the usage of the built-in block
721 graphics/line drawing characters and just rely on what the specified
722 fonts provide. Use this if you have a good font and want to use its
723 block graphic glyphs; option -sbg.
724
597 termName: *termname* 725 termName: *termname*
598 Specifies the terminal type name to be set in the TERM environment 726 Specifies the terminal type name to be set in the TERM environment
599 variable; option -tn. 727 variable; option -tn.
600 728
601 linespace: *number* 729 linespace: *number*
… …
629 pointerColor2: *colour* 757 pointerColor2: *colour*
630 Mouse pointer background colour. 758 Mouse pointer background colour.
631 759
632 pointerBlankDelay: *number* 760 pointerBlankDelay: *number*
633 Specifies number of seconds before blanking the pointer [default 2]. 761 Specifies number of seconds before blanking the pointer [default 2].
762 Use a large number (e.g. 987654321) to effectively disable the
763 timeout.
634 764
635 backspacekey: *string* 765 backspacekey: *string*
636 The string to send when the backspace key is pressed. If set to DEC 766 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 767 or unset it will send Delete (code 127) or, if shifted, Backspace
638 (code 8) - which can be reversed with the appropriate DEC private 768 (code 8) - which can be reversed with the appropriate DEC private
… …
654 784
655 inputMethod: *name* 785 inputMethod: *name*
656 *name* of inputMethod to use; option -im. 786 *name* of inputMethod to use; option -im.
657 787
658 imLocale: *name* 788 imLocale: *name*
659 The locale to use for opening the IM. You can use an LC_CTYPE of 789 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 790 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 791 the input extension to be able to input japanese characters while
662 staying in another locale. option -imlocale. 792 staying in another locale; option -imlocale.
793
794 imFont: *fontset*
795 Specify the font-set used for XIM styles "OverTheSpot" or
796 "OffTheSpot". It must be a standard X font set (XLFD patterns
797 separated by commas), i.e. it's not in the same format as the other
798 font lists used in rxvt. The default will be set-up to chose *any*
799 suitable found found, preferably one or two pixels differing in size
800 to the base font. option -imfont.
801
802 tripleclickwords: *boolean*
803 Change the meaning of triple-click selection with the left mouse
804 button. Instead of selecting a full line it will extend the
805 selection to the end of the logical line only; option -tcw.
663 806
664 insecure: *boolean* 807 insecure: *boolean*
665 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 808 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
666 that echo arbitrary strings like the icon name or the locale. This 809 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, 810 could be abused if somebody gets 8-bit-clean access to your display,
668 whether throuh a mail client displaying mail bodies unfiltered or 811 whether through a mail client displaying mail bodies unfiltered or
669 though write(1). Therefore, these sequences are disabled by default. 812 through write(1) or any other means. Therefore, these sequences are
670 (Note that other terminals, including xterm, have these sequences 813 disabled by default. (Note that many other terminals, including
671 enabled by default). You can enable them by setting this boolean 814 xterm, have these sequences enabled by default, which doesn't make
672 resource or specifying -insecure as an option. At the moment, this 815 it safer, though).
673 enabled display-answer, locale, findfont, icon label and window 816
674 title requests as well as dynamic menubar dispatch. 817 You can enable them by setting this boolean resource or specifying
818 -insecure as an option. At the moment, this enables display-answer,
819 locale, findfont, icon label and window title requests as well as
820 dynamic menubar dispatch.
675 821
676 modifier: *modifier* 822 modifier: *modifier*
677 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 823 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
678 super, mod1, mod2, mod3, mod4, mod5; option -mod. 824 super, mod1, mod2, mod3, mod4, mod5; option -mod.
679 825
… …
689 Turn on/off secondary screen scroll (default enabled). If the this 835 Turn on/off secondary screen scroll (default enabled). If the this
690 option is enabled, scrolls on the secondary screen will change the 836 option is enabled, scrolls on the secondary screen will change the
691 scrollback buffer and switching to/from the secondary screen will 837 scrollback buffer and switching to/from the secondary screen will
692 instead scroll the screen up. 838 instead scroll the screen up.
693 839
840 hold: *bool*
841 Turn on/off hold window after exit support. If enabled, rxvt will
842 not immediately destroy its window when the program executed within
843 it exits. Instead, it will wait till it is being killed or closed by
844 the user.
845
694 keysym.*sym*: *string* 846 keysym.*sym*: *string*
695 Compile *frills*: Associate *string* with keysym *sym*. The 847 Compile *frills*: Associate *string* with keysym *sym*. The
696 intervening resource name keysym. cannot be omitted. 848 intervening resource name keysym. cannot be omitted.
697 849
698 The format of *sym* is "*(modifiers-)key*", where *modifiers* can be 850 The format of *sym* is "*(modifiers-)key*", where *modifiers* can be
… …
700 Meta, Lock, Mod1, Mod2, Mod3, Mod4, Mod5, and the abbreviated I, K, 852 Meta, Lock, Mod1, Mod2, Mod3, Mod4, Mod5, and the abbreviated I, K,
701 C, N, S, M, A, L, 1, 2, 3, 4, 5. 853 C, N, S, M, A, L, 1, 2, 3, 4, 5.
702 854
703 The NumLock, Meta and ISOLevel3 modifiers are usually aliased to 855 The NumLock, Meta and ISOLevel3 modifiers are usually aliased to
704 whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 856 whatever modifier the NumLock key, Meta/Alt keys or ISO Level3
705 Shift/AltGr keys are being mapped. AppKeypad is a artificial 857 Shift/AltGr keys are being mapped. AppKeypad is a synthetic modifier
706 modifier mapped to the current application keymap mode state. 858 mapped to the current application keymap mode state.
707 859
708 The spellings of *key* can be obtained by using xev(1) command or 860 The spellings of *key* can be obtained by using xev(1) command or
709 searching keysym macros from /usr/X11R6/include/X11/keysymdef.h and 861 searching keysym macros from /usr/X11R6/include/X11/keysymdef.h and
710 omitting the prefix XK_. Alternatively you can specify *key* by its 862 omitting the prefix XK_. Alternatively you can specify *key* by its
711 hex keysym value (0x0000 - 0xFFFF). Note that the lookup of *sym*s 863 hex keysym value (0x0000 - 0xFFFF). Note that the lookup of *sym*s
… …
716 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 868 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
717 "\000": octal number) or verbatim control characters ("^?": delete, 869 "\000": octal number) or verbatim control characters ("^?": delete,
718 "^@": null, "^A" ...) and may be enclosed with double quotes so that 870 "^@": null, "^A" ...) and may be enclosed with double quotes so that
719 it can start or end with whitespace. 871 it can start or end with whitespace.
720 872
873 Please note that you need to double the "\" in resource files, as
874 Xlib itself does it's own de-escaping (you can use "\033" instead of
875 "\e" (and so on), which will work with both Xt and rxvt's own
876 processing).
877
721 You can define a range of keysyms in one shot by providing a 878 You can define a range of keysyms in one shot by providing a
722 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 879 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
723 `/' should be a character not used by the strings. 880 `/' should be a character not used by the strings.
724 881
725 Its usage can be demonstrated by an example: 882 Its usage can be demonstrated by an example:
726 883
727 URxvt.keysym.M-C-0x61: list|\e<M-C-|abc|> 884 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
728 885
729 The above line is equivalent to the following three lines: 886 The above line is equivalent to the following three lines:
730 887
731 URxvt.keysym.Meta-Control-0x61: \e<M-C-a> 888 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
732 URxvt.keysym.Meta-Control-0x62: \e<M-C-b> 889 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
733 URxvt.keysym.Meta-Control-0x63: \e<M-C-c> 890 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
734 891
735 If *string* takes the form of "proto:STRING", the specified STRING 892 If *string* takes the form of "command:STRING", the specified STRING
736 is interpreted and executed as rxvt's control sequence. For example, 893 is interpreted and executed as rxvt's control sequence. For example
737 "proto:\033]701;zh_CN.GBK\007" means: change the current locale to 894 the following means "change the current locale to "zh_CN.GBK" when
738 "zh_CN.GBK". 895 Control-Meta-c is being pressed":
896
897 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
898
899 If *string* takes the form "perl:STRING", then the specified STRING
900 is passed to the "on_keyboard_command" perl handler. See the
901 rxvtperl(3) manpage. For example, the selection extension (activated
902 via "rxvt -pe selection") listens for "selection:rot13" events:
903
904 URxvt.keysym.M-C-c: perl:selection:rot13
905
906 Due the the large number of modifier combinations, a defined key
907 mapping will match if at *at least* the specified identifiers are
908 being set, and no other key mappings with those and more bits are
909 being defined. That means that defining a key map for "a" will
910 automatically provide definitions for "Meta-a", "Shift-a" and so on,
911 unless some of those are defined mappings themselves.
912
913 Unfortunately, this will override built-in key mappings. For example
914 if you overwrite the "Insert" key you will disable rxvt's
915 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
916 the user-defined keymap using the "builtin:" replacement:
917
918 URxvt.keysym.Insert: <my insert key sequence>
919 URxvt.keysym.S-Insert: builtin:
920
921 The first line defines a mapping for "Insert" and *any* combination
922 of modifiers. The second line re-establishes the default mapping for
923 "Shift-Insert".
924
925 The following example will map Control-Meta-1 and Control-Meta-2 to
926 the fonts "suxuseuro" and "9x15bold", so you can have some limited
927 font-switching at runtime:
928
929 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
930 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
931
932 Other things are possible, e.g. resizing (see rxvt(7) for more
933 info):
934
935 URxvt.keysym.M-C-3: command:\033[8;25;80t
936 URxvt.keysym.M-C-4: command:\033[8;48;110t
937
938 perl-ext-common: *string*
939 perl-ext: *string*
940 Comma-separated list(s) of perl extension scripts (default:
941 "default") to use in this terminal instance; option -pe.
942
943 Extension names can be prefixed with a "-" sign to prohibit using
944 them. This can be useful to selectively disable some extensions
945 loaded by default, or specified via the "perl-ext-common" resource.
946 For example, "default,-selection" will use all the default extension
947 except "selection".
948
949 Extension names can also be followed by an argument in angle
950 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
951 for searchable scorllback to Alt/Meta-s). Mentioning the same
952 extension multiple times with different arguments will pass multiple
953 arguments to the extension.
954
955 Each extension is looked up in the library directories, loaded if
956 necessary, and bound to the current terminal instance.
957
958 If both of these resources are the empty string, then the perl
959 interpreter will not be initialized. The idea behind two options is
960 that perl-ext-common will be used for extensions that should be
961 available to all instances, while perl-ext is used for specific
962 instances.
963
964 perl-eval: *string*
965 Perl code to be evaluated when all extensions have been registered.
966 See the rxvtperl(3) manpage. Due to security reasons, this resource
967 will be ignored when running setuid/setgid.
968
969 perl-lib: *path*
970 Colon-separated list of additional directories that hold extension
971 scripts. When looking for extensions specified by the "perl"
972 resource, rxvt will first look in these directories and then in
973 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
974 will be ignored when running setuid/setgid.
975
976 See the rxvtperl(3) manpage.
977
978 searchable-scrollback: *keysym*
979 Sets the hotkey that starts the incremental scrollback buffer search
980 (default: "M-s").
981
982 urlLauncher: *string*
983 Specifies the program to be started with a URL argument. Used by the
984 "selection-popup" and "mark-urls" perl extensions.
985
986 transient-for: *windowid*
987 Sets the WM_TRANSIENT_FOR property to the given window iw.
739 988
740THE SCROLLBAR 989THE SCROLLBAR
741 Lines of text that scroll off the top of the rxvt window (resource: 990 Lines of text that scroll off the top of the rxvt window (resource:
742 saveLines) and can be scrolled back using the scrollbar or by 991 saveLines) and can be scrolled back using the scrollbar or by
743 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 992 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
… …
753 normal text selection/insertion, hold either the Shift or the Meta (Alt) 1002 normal text selection/insertion, hold either the Shift or the Meta (Alt)
754 key while performing the desired mouse action. 1003 key while performing the desired mouse action.
755 1004
756 If mouse reporting mode is active, the normal scrollbar actions are 1005 If mouse reporting mode is active, the normal scrollbar actions are
757 disabled -- on the assumption that we are using a fullscreen 1006 disabled -- on the assumption that we are using a fullscreen
758 application. Instead, pressing Button1 and Button3 sends ESC[6~ (Next) 1007 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
759 and ESC[5~ (Prior), respectively. Similarly, clicking on the up and down 1008 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
760 arrows sends ESC[A (Up) and ESC[B (Down), respectively. 1009 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
761 1010
762TEXT SELECTION AND INSERTION 1011TEXT SELECTION AND INSERTION
763 The behaviour of text selection and insertion mechanism is similar to 1012 The behaviour of text selection and insertion mechanism is similar to
764 *xterm*(1). 1013 *xterm*(1).
765 1014
766 Selection: 1015 Selection:
767 Left click at the beginning of the region, drag to the end of the 1016 Left click at the beginning of the region, drag to the end of the
768 region and release; Right click to extend the marked region; Left 1017 region and release; Right click to extend the marked region; Left
769 double-click to select a word; Left triple-click to select the 1018 double-click to select a word; Left triple-click to select the
770 entire line. 1019 entire logical line (which can span multiple screen lines), unless
1020 modified by resource tripleclickwords.
771 1021
772 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 1022 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
773 (Compile: *frills*) will create a rectangular selection instead of a 1023 (Compile: *frills*) will create a rectangular selection instead of a
774 normal one. 1024 normal one. In this mode, every selected row becomes its own line in
1025 the selection, and trailing whitespace is visually underlined and
1026 removed from the selection.
775 1027
776 Insertion: 1028 Insertion:
777 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1029 Pressing and releasing the Middle mouse button (or Shift-Insert) in
778 an rxvt window causes the current text selection to be inserted as 1030 an rxvt window causes the current text selection to be inserted as
779 if it had been typed on the keyboard. 1031 if it had been typed on the keyboard.
… …
783 supported in rxvt-unicode. Bug me if you need this. 1035 supported in rxvt-unicode. Bug me if you need this.
784 1036
785 You can, however, switch fonts at runtime using escape sequences (and 1037 You can, however, switch fonts at runtime using escape sequences (and
786 therefore using the menubar), e.g.: 1038 therefore using the menubar), e.g.:
787 1039
788 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1040 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
789 1041
790 rxvt-unicode will automatically re-apply these fonts to the output so 1042 rxvt-unicode will automatically re-apply these fonts to the output so
791 far. 1043 far.
792 1044
793ISO 14755 SUPPORT 1045ISO 14755 SUPPORT
… …
795 character codes using the keyboard. It consists of 4 parts. The first 1047 character codes using the keyboard. It consists of 4 parts. The first
796 part is available rxvt-unicode has been compiled with "--enable-frills", 1048 part is available rxvt-unicode has been compiled with "--enable-frills",
797 the rest is available when rxvt-unicode was compiled with 1049 the rest is available when rxvt-unicode was compiled with
798 "--enable-iso14755". 1050 "--enable-iso14755".
799 1051
800 5.1: Basic method 1052 * 5.1: Basic method
801 This allows you to enter unicode characters using their hexcode. 1053 This allows you to enter unicode characters using their hexcode.
802 1054
803 Start by pressing and holding both "Control" and "Shift", then enter 1055 Start by pressing and holding both "Control" and "Shift", then enter
804 hex-digits (between one and six). Releasing "Control" and "Shift" 1056 hex-digits (between one and six). Releasing "Control" and "Shift"
805 will commit the character as if it were typed directly. While 1057 will commit the character as if it were typed directly. While
… …
811 address, which you cannot type. Fortunately, the card has the e-mail 1063 address, which you cannot type. Fortunately, the card has the e-mail
812 address printed as hexcodes, e.g. "671d 65e5". You can enter this 1064 address printed as hexcodes, e.g. "671d 65e5". You can enter this
813 easily by pressing "Control" and "Shift", followed by 1065 easily by pressing "Control" and "Shift", followed by
814 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys. 1066 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys.
815 1067
816 5.2: Keyboard symbols entry method 1068 * 5.2: Keyboard symbols entry method
817 This mode lets you input characters representing the keycap symbols 1069 This mode lets you input characters representing the keycap symbols
818 of your keyboard, if representable in the current locale encoding. 1070 of your keyboard, if representable in the current locale encoding.
819 1071
820 Start by pressing "Control" and "Shift" together, then releasing 1072 Start by pressing "Control" and "Shift" together, then releasing
821 them. The next special key (cursor keys, home etc.) you enter will 1073 them. The next special key (cursor keys, home etc.) you enter will
… …
823 corresponding keycap symbol. The symbol will only be entered when 1075 corresponding keycap symbol. The symbol will only be entered when
824 the key has been released, otherwise pressing e.g. "Shift" would 1076 the key has been released, otherwise pressing e.g. "Shift" would
825 enter the symbol for "ISO Level 2 Switch", although your intention 1077 enter the symbol for "ISO Level 2 Switch", although your intention
826 might have been to enter a reverse tab (Shift-Tab). 1078 might have been to enter a reverse tab (Shift-Tab).
827 1079
828 5.3: Screen-selection entry method 1080 * 5.3: Screen-selection entry method
829 While this is implemented already (it's basically the selection 1081 While this is implemented already (it's basically the selection
830 mechanism), it could be extended by displaying a unicode character 1082 mechanism), it could be extended by displaying a unicode character
831 map. 1083 map.
832 1084
833 5.4: Feedback method for identifying displayed characters for later 1085 * 5.4: Feedback method for identifying displayed characters for later
834 input 1086 input
835 This method lets you display the unicode character code associated 1087 This method lets you display the unicode character code associated
836 with characters already displayed. 1088 with characters already displayed.
837 1089
838 You enter this mode by holding down "Control" and "Shift" together, 1090 You enter this mode by holding down "Control" and "Shift" together,
… …
850 both scenario A and B of ISO 14755, including part 5.2. 1102 both scenario A and B of ISO 14755, including part 5.2.
851 1103
852LOGIN STAMP 1104LOGIN STAMP
853 rxvt tries to write an entry into the *utmp*(5) file so that it can be 1105 rxvt tries to write an entry into the *utmp*(5) file so that it can be
854 seen via the *who(1)* command, and can accept messages. To allow this 1106 seen via the *who(1)* command, and can accept messages. To allow this
855 feature, rxvt must be installed setuid root on some systems. 1107 feature, rxvt may need to be installed setuid root on some systems or
1108 setgid to root or to some other group on others.
856 1109
857COLORS AND GRAPHICS 1110COLORS AND GRAPHICS
858 In addition to the default foreground and background colours, rxvt can 1111 In addition to the default foreground and background colours, rxvt can
859 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 1112 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
860 versions of the same). Here is a list of the colours with their rgb.txt 1113 versions of the same). Here is a list of the colours with their rgb.txt
… …
892 rxvt -fg Black -bg White -rv 1145 rxvt -fg Black -bg White -rv
893 would yield White on Black, while on *xterm*(1) it would yield Black 1146 would yield White on Black, while on *xterm*(1) it would yield Black
894 on White. 1147 on White.
895 1148
896ENVIRONMENT 1149ENVIRONMENT
897 rxvt sets the environment variables TERM, COLORTERM and COLORFGBG. The 1150 rxvt sets and/or uses the following environment variables:
898 environment variable WINDOWID is set to the X window id number of the 1151
899 rxvt window and it also uses and sets the environment variable DISPLAY 1152 TERM
900 to specify which display terminal to use. rxvt uses the environment 1153 Normally set to "rxvt-unicode", unless overwritten at configure
901 variables RXVTPATH and PATH to find XPM files. 1154 time, via resources or on the commandline.
1155
1156 COLORTERM
1157 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled
1158 with XPM support, and optionally with the added extension "-mono" to
1159 indicate that rxvt-unicode runs on a monochrome screen.
1160
1161 COLORFGBG
1162 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1163 the colour code used as default foreground/text colour (or the
1164 string "default" to indicate that the default-colour escape sequence
1165 is to be used), "bg" is the colour code used as default background
1166 colour (or the string "default"), and "xpm" is the string "default"
1167 if rxvt was compiled with XPM support. Libraries like "ncurses" and
1168 "slang" can (and do) use this information to optimize screen output.
1169
1170 WINDOWID
1171 Set to the (decimal) X Window ID of the rxvt window (the toplevel
1172 window, which usually has subwindows for the scrollbar, the terminal
1173 window and so on).
1174
1175 TERMINFO
1176 Set to the terminfo directory iff rxvt was configured with
1177 "--with-terminfo=PATH".
1178
1179 DISPLAY
1180 Used by rxvt to connect to the display and set to the correct
1181 display in it's child processes.
1182
1183 SHELL
1184 The shell to be used for command execution, defaults to "/bin/sh".
1185
1186 RXVTPATH
1187 The path where rxvt looks for support files such as menu and xpm
1188 files.
1189
1190 PATH
1191 Used in the same way as "RXVTPATH".
1192
1193 RXVT_SOCKET
1194 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1195
1196 Default $HOME/.rxvt-unicode-*<nodename*.
1197
1198 HOME
1199 Used to locate the default directory for the unix domain socket for
1200 daemon communications and to locate various resource files (such as
1201 ".Xdefaults")
1202
1203 XAPPLRESDIR
1204 Directory where various X resource files are being located.
1205
1206 XENVIRONMENT
1207 If set and accessible, gives the name of a X resource file to be
1208 loaded by rxvt.
902 1209
903FILES 1210FILES
904 /etc/utmp
905 System file for login records.
906
907 /usr/lib/X11/rgb.txt 1211 /usr/lib/X11/rgb.txt
908 Color names. 1212 Color names.
909 1213
910SEE ALSO 1214SEE ALSO
911 rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1215 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
912 1216 tty(4), utmp(5)
913BUGS
914 Check the BUGS file for an up-to-date list.
915
916 Cursor change support is not yet implemented.
917
918 Click-and-drag doesn't work with X11 mouse report overriding.
919 1217
920CURRENT PROJECT COORDINATOR 1218CURRENT PROJECT COORDINATOR
921 Project Coordinator 1219 Project Coordinator
922 Marc A. Lehmann rxvt@schmorp.de 1220 Marc A. Lehmann <rxvt-unicode@schmorp.de>
923 1221
924 Web page maintainter
925 Marc A. Lehmann rxvt@schmorp.de
926
927 <http://software.schmorp.de/> 1222 <http://software.schmorp.de/#rxvt-unicode>
928 1223
929AUTHORS 1224AUTHORS
930 John Bovey 1225 John Bovey
931 University of Kent, 1992, wrote the original Xvt. 1226 University of Kent, 1992, wrote the original Xvt.
932 1227
… …
946 1241
947 Geoff Wing <gcw@pobox.com> 1242 Geoff Wing <gcw@pobox.com>
948 Rewrote screen display and text selection routines. Project 1243 Rewrote screen display and text selection routines. Project
949 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1244 Coordinator (changes.txt 2.4.6 - rxvt-unicode)
950 1245
951 Marc Alexander Lehmann <rxvt@schmorp.de> 1246 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
952 Forked rxvt-unicode, rewrote most of the display code and internal 1247 Forked rxvt-unicode, rewrote most of the display code and internal
953 character handling to store text in unicode, improve xterm 1248 character handling to store text in unicode, improve xterm
954 compatibility and apply numerous other bugfixes and extensions. 1249 compatibility and apply numerous other bugfixes and extensions.
955 1250
956 Project Coordinator (Changes 1.0 -) 1251 Project Coordinator (Changes 1.0 -)

Diff Legend

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