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.45 by root, Fri Jan 13 12:40:46 2006 UTC vs.
Revision 1.53 by root, Thu Jan 26 00:09:47 2006 UTC

1NAME 1NAME
2 rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window 2 rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window
3 system) 3 system)
4 4
5SYNOPSIS 5SYNOPSIS
6 urxvt [options] [-e command [ args ]] 6 rxvt [options] [-e command [ args ]]
7 7
8DESCRIPTION 8DESCRIPTION
9 rxvt-unicode, version 7.0, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 7.3a, 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 urxvt(7) (try "man 7 urxvt") for a list of frequently asked 16 See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions
17 questions and answer to them and some common problems. That document is 17 and answer to them and some common problems. That document is also
18 also accessible on the World-Wide-Web at 18 accessible on the World-Wide-Web at
19 <http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 19 <http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
20 20
21RXVT-UNICODE VS. RXVT 21RXVT-UNICODE VS. RXVT
22 Unlike the original rxvt, rxvt-unicode stores all text in Unicode 22 Unlike the original rxvt, rxvt-unicode stores all text in Unicode
23 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
… …
52 It is still faithfully following the original rxvt idea of being lean 52 It is still faithfully following the original rxvt idea of being lean
53 and nice on resources: for example, you can still configure rxvt-unicode 53 and nice on resources: for example, you can still configure rxvt-unicode
54 without most of it's features to get a lean binary. It also comes with a 54 without most of it's features to get a lean binary. It also comes with a
55 client/daemon pair that lets you open any number of terminal windows 55 client/daemon pair that lets you open any number of terminal windows
56 from within a single process, which makes startup time very fast and 56 from within a single process, which makes startup time very fast and
57 drastically reduces memory usage. See urxvtd(1) (daemon) and urxvtc(1) 57 drastically reduces memory usage. See rxvtd(1) (daemon) and rxvtc(1)
58 (client). 58 (client).
59 59
60 It also makes technical information about escape sequences (which have 60 It also makes technical information about escape sequences (which have
61 been extended) easier accessible: see urxvt(7) for technical reference 61 been extended) easier accessible: see rxvt(7) for technical reference
62 documentation (escape sequences etc.). 62 documentation (escape sequences etc.).
63 63
64OPTIONS 64OPTIONS
65 The urxvt options (mostly a subset of *xterm*'s) are listed below. In 65 The rxvt options (mostly a subset of *xterm*'s) are listed below. In
66 keeping with the smaller-is-better philosophy, options may be eliminated 66 keeping with the smaller-is-better philosophy, options may be eliminated
67 or default values chosen at compile-time, so options and defaults listed 67 or default values chosen at compile-time, so options and defaults listed
68 may not accurately reflect the version installed on your system. `urxvt 68 may not accurately reflect the version installed on your system. `rxvt
69 -h' gives a list of major compile-time options on the *Options* line. 69 -h' gives a list of major compile-time options on the *Options* line.
70 Option descriptions may be prefixed with which compile option each is 70 Option descriptions may be prefixed with which compile option each is
71 dependent upon. e.g. `Compile *XIM*:' requires *XIM* on the *Options* 71 dependent upon. e.g. `Compile *XIM*:' requires *XIM* on the *Options*
72 line. Note: `urxvt -help' gives a list of all command-line options 72 line. Note: `rxvt -help' gives a list of all command-line options
73 compiled into your version. 73 compiled into your version.
74 74
75 Note that urxvt permits the resource name to be used as a long-option 75 Note that rxvt permits the resource name to be used as a long-option
76 (--/++ option) so the potential command-line options are far greater 76 (--/++ option) so the potential command-line options are far greater
77 than those listed. For example: `urxvt --loginShell --color1 Orange'. 77 than those listed. For example: `rxvt --loginShell --color1 Orange'.
78 78
79 The following options are available: 79 The following options are available:
80 80
81 -help, --help 81 -help, --help
82 Print out a message describing available options. 82 Print out a message describing available options.
83 83
84 -display *displayname* 84 -display *displayname*
85 Attempt to open a window on the named X display (-d still 85 Attempt to open a window on the named X display (-d still
86 respected). In the absence of this option, the display specified by 86 respected). In the absence of this option, the display specified by
87 the DISPLAY environment variable is used. 87 the DISPLAY environment variable is used.
88
89 -depth *bitdepth*
90 Compile *frills*: Attempt to find a visual with the given bit depth;
91 resource depth.
88 92
89 -geometry *geom* 93 -geometry *geom*
90 Window geometry (-g still respected); resource geometry. 94 Window geometry (-g still respected); resource geometry.
91 95
92 -rv|+rv 96 -rv|+rv
… …
113 transparency is enabled with -tr or -ip. This only works for 117 transparency is enabled with -tr or -ip. This only works for
114 non-tiled backgrounds, currently. See also the -sh option that can 118 non-tiled backgrounds, currently. See also the -sh option that can
115 be used to brighten or darken the image in addition to tinting it; 119 be used to brighten or darken the image in addition to tinting it;
116 resource *tintColor*. Example: 120 resource *tintColor*. Example:
117 121
118 urxvt -tr -tint blue -sh 40 122 rxvt -tr -tint blue -sh 40
119 123
120 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent 124 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent
121 background image in addition to tinting it (i.e. -tint must be 125 background image in addition to tinting it (i.e. -tint must be
122 specified, too, e.g. "-tint white"). 126 specified, too, e.g. "-tint white").
123 127
… …
156 160
157 In short, to specify an X11 core font, just specify it's name or 161 In short, to specify an X11 core font, just specify it's name or
158 prefix it with "x:". To specify an XFT-font, you need to prefix it 162 prefix it with "x:". To specify an XFT-font, you need to prefix it
159 with "xft:", e.g.: 163 with "xft:", e.g.:
160 164
161 urxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 165 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
162 urxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" 166 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
163 167
164 See also the question "How does rxvt-unicode choose fonts?" in the 168 See also the question "How does rxvt-unicode choose fonts?" in the
165 FAQ section of urxvt(7). 169 FAQ section of rxvt(7).
166 170
167 -fb *fontlist* 171 -fb *fontlist*
168 Compile *font-styles*: The bold font list to use when bold 172 Compile *font-styles*: The bold font list to use when bold
169 characters are to be printed. See resource boldFont for details. 173 characters are to be printed. See resource boldFont for details.
170 174
… …
252 256
253 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e. 257 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e.
254 if honoured by the WM, the rxvt-unicode window will not have window 258 if honoured by the WM, the rxvt-unicode window will not have window
255 decorations; resource borderLess. 259 decorations; resource borderLess.
256 260
261 -override-redirect
262 Compile *frills*: Sets override-redirect on the window; resource
263 override-redirect.
264
257 -sbg 265 -sbg
258 Compile *frills*: Disable the usage of the built-in block 266 Compile *frills*: Disable the usage of the built-in block
259 graphics/line drawing characters and just rely on what the specified 267 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 268 fonts provide. Use this if you have a good font and want to use its
261 block graphic glyphs; resource skipBuiltinGlyphs. 269 block graphic glyphs; resource skipBuiltinGlyphs.
… …
270 TERM environment variable. This terminal type must exist in the 278 TERM environment variable. This terminal type must exist in the
271 *termcap(5)* database and should have *li#* and *co#* entries; 279 *termcap(5)* database and should have *li#* and *co#* entries;
272 resource termName. 280 resource termName.
273 281
274 -e *command [arguments]* 282 -e *command [arguments]*
275 Run the command with its command-line arguments in the urxvt window; 283 Run the command with its command-line arguments in the rxvt window;
276 also sets the window title and icon name to be the basename of the 284 also sets the window title and icon name to be the basename of the
277 program being executed if neither *-title* (*-T*) nor *-n* are given 285 program being executed if neither *-title* (*-T*) nor *-n* are given
278 on the command line. If this option is used, it must be the last on 286 on the command line. If this option is used, it must be the last on
279 the command-line. If there is no -e option then the default is to 287 the command-line. If there is no -e option then the default is to
280 run the program specified by the SHELL environment variable or, 288 run the program specified by the SHELL environment variable or,
… …
282 290
283 Please note that you must specify a program with arguments. If you 291 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 292 want to run shell commands, you have to specify the shell, like
285 this: 293 this:
286 294
287 urxvt -e sh -c "shell commands" 295 rxvt -e sh -c "shell commands"
288 296
289 -title *text* 297 -title *text*
290 Window title (-T still respected); the default title is the basename 298 Window title (-T still respected); the default title is the basename
291 of the program specified after the -e option, if any, otherwise the 299 of the program specified after the -e option, if any, otherwise the
292 application name; resource title. 300 application name; resource title.
… …
337 -ssr|+ssr 345 -ssr|+ssr
338 Turn on/off secondary screen scroll (default enabled); resource 346 Turn on/off secondary screen scroll (default enabled); resource
339 secondaryScroll. 347 secondaryScroll.
340 348
341 -hold|+hold 349 -hold|+hold
342 Turn on/off hold window after exit support. If enabled, urxvt will 350 Turn on/off hold window after exit support. If enabled, rxvt will
343 not immediately destroy its window when the program executed within 351 not immediately destroy its window when the program executed within
344 it exits. Instead, it will wait till it is being killed or closed by 352 it exits. Instead, it will wait till it is being killed or closed by
345 the user; resource hold. 353 the user; resource hold.
346 354
347 -keysym.*sym* *string* 355 -keysym.*sym* *string*
348 Remap a key symbol. See resource keysym. 356 Remap a key symbol. See resource keysym.
349 357
350 -embed *windowid* 358 -embed *windowid*
351 Tells urxvt to embed it's windows into an already-existing window, 359 Tells rxvt to embed it's windows into an already-existing window,
352 which enables applications to easily embed a terminal. 360 which enables applications to easily embed a terminal.
353 361
354 Right now, urxvt will first unmap/map the specified window, so it 362 Right now, rxvt will first unmap/map the specified window, so it
355 shouldn't be a top-level window. urxvt will also reconfigure it 363 shouldn't be a top-level window. rxvt will also reconfigure it quite
356 quite a bit, so don't expect it to keep some specific state. It's 364 a bit, so don't expect it to keep some specific state. It's best to
357 best to create an extra subwindow for urxvt and leave it alone. 365 create an extra subwindow for rxvt and leave it alone.
358 366
359 The window will not be destroyed when urxvt exits. 367 The window will not be destroyed when rxvt exits.
360 368
361 It might be useful to know that urxvt will not close file 369 It might be useful to know that rxvt will not close file descriptors
362 descriptors passed to it (except for stdin/out/err, of course), so 370 passed to it (except for stdin/out/err, of course), so you can use
363 you can use file descriptors to communicate with the programs within 371 file descriptors to communicate with the programs within the
364 the terminal. This works regardless of wether the "-embed" option 372 terminal. This works regardless of wether the "-embed" option was
365 was used or not. 373 used or not.
366 374
367 Here is a short Gtk2-perl snippet that illustrates how this option 375 Here is a short Gtk2-perl snippet that illustrates how this option
368 can be used (a longer example is in doc/embed): 376 can be used (a longer example is in doc/embed):
369 377
370 my $rxvt = new Gtk2::Socket; 378 my $rxvt = new Gtk2::Socket;
371 $rxvt->signal_connect_after (realize => sub { 379 $rxvt->signal_connect_after (realize => sub {
372 my $xid = $_[0]->window->get_xid; 380 my $xid = $_[0]->window->get_xid;
373 system "urxvt -embed $xid &"; 381 system "rxvt -embed $xid &";
374 }); 382 });
375 383
376 -pty-fd *file descriptor* 384 -pty-fd *file descriptor*
377 Tells urxvt NOT to execute any commands or create a new pty/tty pair 385 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 386 but instead use the given filehandle as the tty master. This is
379 useful if you want to drive urxvt as a generic terminal emulator 387 useful if you want to drive rxvt as a generic terminal emulator
380 without having to run a program within it. 388 without having to run a program within it.
381 389
382 If this switch is given, urxvt will not create any utmp/wtmp entries 390 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 391 and will not tinker with pty/tty permissions - you have to do that
384 yourself if you want that. 392 yourself if you want that.
385 393
386 As an extremely special case, specifying -1 will completely suppress 394 As an extremely special case, specifying -1 will completely suppress
387 pty/tty operations. 395 pty/tty operations.
… …
392 use IO::Pty; 400 use IO::Pty;
393 use Fcntl; 401 use Fcntl;
394 402
395 my $pty = new IO::Pty; 403 my $pty = new IO::Pty;
396 fcntl $pty, F_SETFD, 0; # clear close-on-exec 404 fcntl $pty, F_SETFD, 0; # clear close-on-exec
397 system "urxvt -pty-fd " . (fileno $pty) . "&"; 405 system "rxvt -pty-fd " . (fileno $pty) . "&";
398 close $pty; 406 close $pty;
399 407
400 # now communicate with rxvt 408 # now communicate with rxvt
401 my $slave = $pty->slave; 409 my $slave = $pty->slave;
402 while (<$slave>) { print $slave "got <$_>\n" } 410 while (<$slave>) { print $slave "got <$_>\n" }
… …
404 -pe *string* 412 -pe *string*
405 Comma-separated list of perl extension scripts to use (or not to 413 Comma-separated list of perl extension scripts to use (or not to
406 use) in this terminal instance. See resource perl-ext for details. 414 use) in this terminal instance. See resource perl-ext for details.
407 415
408RESOURCES (available also as long-options) 416RESOURCES (available also as long-options)
409 Note: `urxvt --help' gives a list of all resources (long options) 417 Note: `rxvt --help' gives a list of all resources (long options)
410 compiled into your version. 418 compiled into your version.
411 419
412 You can set and change the resources using X11 tools like xrdb. Many 420 You can set and change the resources using X11 tools like xrdb. Many
413 distribution do also load settings from the ~/.Xresources file when X 421 distribution do also load settings from the ~/.Xresources file when X
414 starts. urxvt will consult the following files/resources in order, with 422 starts. rxvt will consult the following files/resources in order, with
415 later settings overwriting earlier ones: 423 later settings overwriting earlier ones:
416 424
417 1. system-wide app-defaults file, either locale-dependent OR global 425 1. system-wide app-defaults file, either locale-dependent OR global
418 2. app-defaults file in $XAPPLRESDIR 426 2. app-defaults file in $XAPPLRESDIR
419 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 427 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
420 4. SCREEN_RESOURCES for the current screen 428 4. SCREEN_RESOURCES for the current screen
421 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 429 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
422 430
423 Note that when reading X resources, urxvt recognizes two class names: 431 Note that when reading X resources, rxvt recognizes two class names:
424 Rxvt and URxvt. The class name Rxvt allows resources common to both 432 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
425 urxvt and the original *rxvt* to be easily configured, while the class 433 and the original *rxvt* to be easily configured, while the class name
426 name URxvt allows resources unique to urxvt, to be shared between 434 URxvt allows resources unique to rxvt, to be shared between different
427 different urxvt configurations. If no resources are specified, suitable 435 rxvt configurations. If no resources are specified, suitable defaults
428 defaults will be used. Command-line arguments can be used to override 436 will be used. Command-line arguments can be used to override resource
429 resource settings. The following resources are supported (you might want 437 settings. The following resources are supported (you might want to check
430 to check the urxvtperl(3) manpage for additional settings by perl 438 the rxvtperl(3) manpage for additional settings by perl extensions not
431 extensions not documented here): 439 documented here):
440
441 depth: *bitdepth*
442 Compile *frills*: Attempt to find a visual with the given bit depth;
443 option -depth.
432 444
433 geometry: *geom* 445 geometry: *geom*
434 Create the window with the specified X window geometry [default 446 Create the window with the specified X window geometry [default
435 80x24]; option -geometry. 447 80x24]; option -geometry.
436 448
… …
450 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but 462 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but
451 the actual colour names used are listed in the COLORS AND GRAPHICS 463 the actual colour names used are listed in the COLORS AND GRAPHICS
452 section. 464 section.
453 465
454 Colours higher than 15 cannot be set using resources (yet), but can 466 Colours higher than 15 cannot be set using resources (yet), but can
455 be changed using an escape command (see urxvt(7)). 467 be changed using an escape command (see rxvt(7)).
456 468
457 Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm 469 Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm
458 with 88 colour support). Colours 80-87 are evenly spaces grey steps. 470 with 88 colour support). Colours 80-87 are evenly spaces grey steps.
459 471
460 colorBD: *colour* 472 colorBD: *colour*
… …
536 scale of 1 displays the image without any scaling. A scale of 2 to 9 548 scale of 1 displays the image without any scaling. A scale of 2 to 9
537 specifies an integer number of images in that direction. No image 549 specifies an integer number of images in that direction. No image
538 will be magnified beyond 10 times its original size. The maximum 550 will be magnified beyond 10 times its original size. The maximum
539 permitted scale is 1000. [default 0x0+50+50] 551 permitted scale is 1000. [default 0x0+50+50]
540 552
541 menu: *file[;tag]*
542 Read in the specified menu file (note the `.menu' extension is
543 optional) and also optionally specify a starting tag to find. See
544 the reference documentation for details on the syntax for the
545 menuBar.
546
547 path: *path* 553 path: *path*
548 Specify the colon-delimited search path for finding files (XPM and 554 Specify the colon-delimited search path for finding XPM files.
549 menus), in addition to the paths specified by the RXVTPATH and PATH
550 environment variables.
551 555
552 font: *fontlist* 556 font: *fontlist*
553 Select the fonts to be used. This is a comma separated list of font 557 Select the fonts to be used. This is a comma separated list of font
554 names that are checked in order when trying to find glyphs for 558 names that are checked in order when trying to find glyphs for
555 characters. The first font defines the cell size for characters; 559 characters. The first font defines the cell size for characters;
… …
566 available hint currently is "codeset=codeset-name", and this is only 570 available hint currently is "codeset=codeset-name", and this is only
567 used for Xft fonts. 571 used for Xft fonts.
568 572
569 For example, this font resource 573 For example, this font resource
570 574
571 URxvt*font: 9x15bold,\ 575 URxvt.font: 9x15bold,\
572 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 576 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
573 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 577 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
574 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 578 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
575 xft:Code2000:antialias=false 579 xft:Code2000:antialias=false
576 580
… …
662 666
663 The string will be interpreted as if typed into the shell as-is. 667 The string will be interpreted as if typed into the shell as-is.
664 668
665 Example: 669 Example:
666 670
667 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 671 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
668 672
669 This creates a new file in your home directory with the screen 673 This creates a new file in your home directory with the screen
670 contents everytime you hit "Print". 674 contents everytime you hit "Print".
671 675
672 scrollBar: *boolean* 676 scrollBar: *boolean*
… …
773 The string to send when the delete key (not the keypad delete key) 777 The string to send when the delete key (not the keypad delete key)
774 is pressed. If unset it will send the sequence traditionally 778 is pressed. If unset it will send the sequence traditionally
775 associated with the Execute key. 779 associated with the Execute key.
776 780
777 cutchars: *string* 781 cutchars: *string*
778 The characters used as delimiters for double-click word selection. 782 The characters used as delimiters for double-click word selection
779 The built-in default: 783 (whitespace delimiting is added automatically if resource is given).
784
785 When the selection extension is in use (the default if compiled in,
786 see the rxvtperl(3) manpage), a suitable regex using these
787 characters will be created (if the resource exists, otherwise, no
788 regex will be created). In this mode, characters outside ISO-8859-1
789 can be used.
790
791 When the selection extension is not used, only ISO-8859-1 characters
792 can be used. If not specified, the built-in default is used:
780 793
781 BACKSLASH `"'&()*,;<=>?@[]{|} 794 BACKSLASH `"'&()*,;<=>?@[]{|}
782 795
783 preeditType: *style* 796 preeditType: *style*
784 OverTheSpot, OffTheSpot, Root; option -pt. 797 OverTheSpot, OffTheSpot, Root; option -pt.
… …
794 807
795 imFont: *fontset* 808 imFont: *fontset*
796 Specify the font-set used for XIM styles "OverTheSpot" or 809 Specify the font-set used for XIM styles "OverTheSpot" or
797 "OffTheSpot". It must be a standard X font set (XLFD patterns 810 "OffTheSpot". It must be a standard X font set (XLFD patterns
798 separated by commas), i.e. it's not in the same format as the other 811 separated by commas), i.e. it's not in the same format as the other
799 font lists used in urxvt. The default will be set-up to chose *any* 812 font lists used in rxvt. The default will be set-up to chose *any*
800 suitable found found, preferably one or two pixels differing in size 813 suitable found found, preferably one or two pixels differing in size
801 to the base font. option -imfont. 814 to the base font. option -imfont.
802 815
803 tripleclickwords: *boolean* 816 tripleclickwords: *boolean*
804 Change the meaning of triple-click selection with the left mouse 817 Change the meaning of triple-click selection with the left mouse
… …
815 xterm, have these sequences enabled by default, which doesn't make 828 xterm, have these sequences enabled by default, which doesn't make
816 it safer, though). 829 it safer, though).
817 830
818 You can enable them by setting this boolean resource or specifying 831 You can enable them by setting this boolean resource or specifying
819 -insecure as an option. At the moment, this enables display-answer, 832 -insecure as an option. At the moment, this enables display-answer,
820 locale, findfont, icon label and window title requests as well as 833 locale, findfont, icon label and window title requests.
821 dynamic menubar dispatch.
822 834
823 modifier: *modifier* 835 modifier: *modifier*
824 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 836 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
825 super, mod1, mod2, mod3, mod4, mod5; option -mod. 837 super, mod1, mod2, mod3, mod4, mod5; option -mod.
826 838
827 answerbackString: *string* 839 answerbackString: *string*
828 Specify the reply rxvt-unicode sends to the shell when an ENQ 840 Specify the reply rxvt-unicode sends to the shell when an ENQ
829 (control-E) character is passed through. It may contain escape 841 (control-E) character is passed through. It may contain escape
830 values as described in the entry on keysym following. 842 values as described in the entry on keysym following.
831 843
832 secondaryScreen: *bool* 844 secondaryScreen: *boolean*
833 Turn on/off secondary screen (default enabled). 845 Turn on/off secondary screen (default enabled).
834 846
835 secondaryScroll: *bool* 847 secondaryScroll: *boolean*
836 Turn on/off secondary screen scroll (default enabled). If the this 848 Turn on/off secondary screen scroll (default enabled). If the this
837 option is enabled, scrolls on the secondary screen will change the 849 option is enabled, scrolls on the secondary screen will change the
838 scrollback buffer and switching to/from the secondary screen will 850 scrollback buffer and switching to/from the secondary screen will
839 instead scroll the screen up. 851 instead scroll the screen up.
840 852
841 hold: *bool* 853 hold: *boolean*
842 Turn on/off hold window after exit support. If enabled, urxvt will 854 Turn on/off hold window after exit support. If enabled, rxvt will
843 not immediately destroy its window when the program executed within 855 not immediately destroy its window when the program executed within
844 it exits. Instead, it will wait till it is being killed or closed by 856 it exits. Instead, it will wait till it is being killed or closed by
845 the user. 857 the user.
846 858
847 keysym.*sym*: *string* 859 keysym.*sym*: *string*
… …
871 "^@": null, "^A" ...) and may be enclosed with double quotes so that 883 "^@": null, "^A" ...) and may be enclosed with double quotes so that
872 it can start or end with whitespace. 884 it can start or end with whitespace.
873 885
874 Please note that you need to double the "\" in resource files, as 886 Please note that you need to double the "\" in resource files, as
875 Xlib itself does it's own de-escaping (you can use "\033" instead of 887 Xlib itself does it's own de-escaping (you can use "\033" instead of
876 "\e" (and so on), which will work with both Xt and urxvt's own 888 "\e" (and so on), which will work with both Xt and rxvt's own
877 processing). 889 processing).
878 890
879 You can define a range of keysyms in one shot by providing a 891 You can define a range of keysyms in one shot by providing a
880 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 892 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
881 `/' should be a character not used by the strings. 893 `/' should be a character not used by the strings.
… …
889 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 901 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
890 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 902 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
891 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 903 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
892 904
893 If *string* takes the form of "command:STRING", the specified STRING 905 If *string* takes the form of "command:STRING", the specified STRING
894 is interpreted and executed as urxvt's control sequence. For example 906 is interpreted and executed as rxvt's control sequence. For example
895 the following means "change the current locale to "zh_CN.GBK" when 907 the following means "change the current locale to "zh_CN.GBK" when
896 Control-Meta-c is being pressed": 908 Control-Meta-c is being pressed":
897 909
898 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 910 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
899 911
900 If *string* takes the form "perl:STRING", then the specified STRING 912 If *string* takes the form "perl:STRING", then the specified STRING
901 is passed to the "on_keyboard_command" perl handler. See the 913 is passed to the "on_keyboard_command" perl handler. See the
902 urxvtperl(3) manpage. For example, the selection extension 914 rxvtperl(3) manpage. For example, the selection extension (activated
903 (activated via "urxvt -pe selection") listens for "selection:rot13" 915 via "rxvt -pe selection") listens for "selection:rot13" events:
904 events:
905 916
906 URxvt.keysym.M-C-c: perl:selection:rot13 917 URxvt.keysym.M-C-c: perl:selection:rot13
907 918
908 Due the the large number of modifier combinations, a defined key 919 Due the the large number of modifier combinations, a defined key
909 mapping will match if at *at least* the specified identifiers are 920 mapping will match if at *at least* the specified identifiers are
… …
911 being defined. That means that defining a key map for "a" will 922 being defined. That means that defining a key map for "a" will
912 automatically provide definitions for "Meta-a", "Shift-a" and so on, 923 automatically provide definitions for "Meta-a", "Shift-a" and so on,
913 unless some of those are defined mappings themselves. 924 unless some of those are defined mappings themselves.
914 925
915 Unfortunately, this will override built-in key mappings. For example 926 Unfortunately, this will override built-in key mappings. For example
916 if you overwrite the "Insert" key you will disable urxvt's 927 if you overwrite the "Insert" key you will disable rxvt's
917 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into 928 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
918 the user-defined keymap using the "builtin:" replacement: 929 the user-defined keymap using the "builtin:" replacement:
919 930
920 URxvt.keysym.Insert: <my insert key sequence> 931 URxvt.keysym.Insert: <my insert key sequence>
921 URxvt.keysym.S-Insert: builtin: 932 URxvt.keysym.S-Insert: builtin:
… …
929 font-switching at runtime: 940 font-switching at runtime:
930 941
931 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 942 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
932 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 943 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
933 944
934 Other things are possible, e.g. resizing (see urxvt(7) for more 945 Other things are possible, e.g. resizing (see rxvt(7) for more
935 info): 946 info):
936 947
937 URxvt.keysym.M-C-3: command:\033[8;25;80t 948 URxvt.keysym.M-C-3: command:\033[8;25;80t
938 URxvt.keysym.M-C-4: command:\033[8;48;110t 949 URxvt.keysym.M-C-4: command:\033[8;48;110t
939 950
… …
963 available to all instances, while perl-ext is used for specific 974 available to all instances, while perl-ext is used for specific
964 instances. 975 instances.
965 976
966 perl-eval: *string* 977 perl-eval: *string*
967 Perl code to be evaluated when all extensions have been registered. 978 Perl code to be evaluated when all extensions have been registered.
968 See the urxvtperl(3) manpage. Due to security reasons, this resource 979 See the rxvtperl(3) manpage. Due to security reasons, this resource
969 will be ignored when running setuid/setgid. 980 will be ignored when running setuid/setgid.
970 981
971 perl-lib: *path* 982 perl-lib: *path*
972 Colon-separated list of additional directories that hold extension 983 Colon-separated list of additional directories that hold extension
973 scripts. When looking for extensions specified by the "perl" 984 scripts. When looking for extensions specified by the "perl"
974 resource, urxvt will first look in these directories and then in 985 resource, rxvt will first look in these directories and then in
975 /usr/local/lib/urxvt/perl/. Due to security reasons, this resource 986 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
976 will be ignored when running setuid/setgid. 987 will be ignored when running setuid/setgid.
977 988
978 See the urxvtperl(3) manpage. 989 See the rxvtperl(3) manpage.
979 990
980 selection.pattern-*idx*: *perl-regex* 991 selection.pattern-*idx*: *perl-regex*
981 Additional selection patterns, see the urxvtperl(3) manpage for 992 Additional selection patterns, see the rxvtperl(3) manpage for
982 details. 993 details.
983 994
984 selection-autotransform.*idx*: *perl-transform* 995 selection-autotransform.*idx*: *perl-transform*
985 Selection auto-transform patterns, see the urxvtperl(3) manpage for 996 Selection auto-transform patterns, see the rxvtperl(3) manpage for
986 details. 997 details.
987 998
988 searchable-scrollback: *keysym* 999 searchable-scrollback: *keysym*
989 Sets the hotkey that starts the incremental scrollback buffer search 1000 Sets the hotkey that starts the incremental scrollback buffer search
990 (default: "M-s"). 1001 (default: "M-s").
… …
992 urlLauncher: *string* 1003 urlLauncher: *string*
993 Specifies the program to be started with a URL argument. Used by the 1004 Specifies the program to be started with a URL argument. Used by the
994 "selection-popup" and "mark-urls" perl extensions. 1005 "selection-popup" and "mark-urls" perl extensions.
995 1006
996 transient-for: *windowid* 1007 transient-for: *windowid*
997 Sets the WM_TRANSIENT_FOR property to the given window iw. 1008 Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given
1009 window id.
1010
1011 override-redirect: *boolean*
1012 Compile *frills*: Sets override-redirect for the terminal window,
1013 making it almost invisible to window managers; option
1014 -override-redirect.
998 1015
999THE SCROLLBAR 1016THE SCROLLBAR
1000 Lines of text that scroll off the top of the urxvt window (resource: 1017 Lines of text that scroll off the top of the rxvt window (resource:
1001 saveLines) and can be scrolled back using the scrollbar or by 1018 saveLines) and can be scrolled back using the scrollbar or by
1002 keystrokes. The normal urxvt scrollbar has arrows and its behaviour is 1019 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
1003 fairly intuitive. The xterm-scrollbar is without arrows and its 1020 fairly intuitive. The xterm-scrollbar is without arrows and its
1004 behaviour mimics that of *xterm* 1021 behaviour mimics that of *xterm*
1005 1022
1006 Scroll down with Button1 (xterm-scrollbar) or Shift-Next. Scroll up with 1023 Scroll down with Button1 (xterm-scrollbar) or Shift-Next. Scroll up with
1007 Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with 1024 Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with
… …
1034 normal one. In this mode, every selected row becomes its own line in 1051 normal one. In this mode, every selected row becomes its own line in
1035 the selection, and trailing whitespace is visually underlined and 1052 the selection, and trailing whitespace is visually underlined and
1036 removed from the selection. 1053 removed from the selection.
1037 1054
1038 Insertion: 1055 Insertion:
1039 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1056 Pressing and releasing the Middle mouse button in an rxvt window
1040 an urxvt window causes the current text selection to be inserted as 1057 causes the value of the PRIMARY selection (or CLIPBOARD with the
1041 if it had been typed on the keyboard. 1058 Meta modifier) to be inserted as if it had been typed on the
1059 keyboard.
1060
1061 Pressing Shift-Insert causes the value of the PRIMARY selection to
1062 be inserted too.
1042 1063
1043CHANGING FONTS 1064CHANGING FONTS
1044 Changing fonts (or font sizes, respectively) via the keypad is not yet 1065 Changing fonts (or font sizes, respectively) via the keypad is not yet
1045 supported in rxvt-unicode. Bug me if you need this. 1066 supported in rxvt-unicode. Bug me if you need this.
1046 1067
1047 You can, however, switch fonts at runtime using escape sequences (and 1068 You can, however, switch fonts at runtime using escape sequences, e.g.:
1048 therefore using the menubar), e.g.:
1049 1069
1050 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1070 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1071
1072 You can use keyboard shortcuts, too:
1073
1074 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1075 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1051 1076
1052 rxvt-unicode will automatically re-apply these fonts to the output so 1077 rxvt-unicode will automatically re-apply these fonts to the output so
1053 far. 1078 far.
1054 1079
1055ISO 14755 SUPPORT 1080ISO 14755 SUPPORT
… …
1110 1135
1111 With respect to conformance, rxvt-unicode is supposed to be compliant to 1136 With respect to conformance, rxvt-unicode is supposed to be compliant to
1112 both scenario A and B of ISO 14755, including part 5.2. 1137 both scenario A and B of ISO 14755, including part 5.2.
1113 1138
1114LOGIN STAMP 1139LOGIN STAMP
1115 urxvt tries to write an entry into the *utmp*(5) file so that it can be 1140 rxvt tries to write an entry into the *utmp*(5) file so that it can be
1116 seen via the *who(1)* command, and can accept messages. To allow this 1141 seen via the *who(1)* command, and can accept messages. To allow this
1117 feature, urxvt may need to be installed setuid root on some systems or 1142 feature, rxvt may need to be installed setuid root on some systems or
1118 setgid to root or to some other group on others. 1143 setgid to root or to some other group on others.
1119 1144
1120COLORS AND GRAPHICS 1145COLORS AND GRAPHICS
1121 In addition to the default foreground and background colours, urxvt can 1146 In addition to the default foreground and background colours, rxvt can
1122 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 1147 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
1123 versions of the same). Here is a list of the colours with their rgb.txt 1148 versions of the same). Here is a list of the colours with their rgb.txt
1124 names. 1149 names.
1125 1150
1126 color0 (black) = Black 1151 color0 (black) = Black
… …
1150 Note that -rv ("reverseVideo: True") simulates reverse video by always 1175 Note that -rv ("reverseVideo: True") simulates reverse video by always
1151 swapping the foreground/background colours. This is in contrast to 1176 swapping the foreground/background colours. This is in contrast to
1152 *xterm*(1) where the colours are only swapped if they have not otherwise 1177 *xterm*(1) where the colours are only swapped if they have not otherwise
1153 been specified. For example, 1178 been specified. For example,
1154 1179
1155 urxvt -fg Black -bg White -rv 1180 rxvt -fg Black -bg White -rv
1156 would yield White on Black, while on *xterm*(1) it would yield Black 1181 would yield White on Black, while on *xterm*(1) it would yield Black
1157 on White. 1182 on White.
1158 1183
1159ENVIRONMENT 1184ENVIRONMENT
1160 urxvt sets and/or uses the following environment variables: 1185 rxvt sets and/or uses the following environment variables:
1161 1186
1162 TERM 1187 TERM
1163 Normally set to "rxvt-unicode", unless overwritten at configure 1188 Normally set to "rxvt-unicode", unless overwritten at configure
1164 time, via resources or on the commandline. 1189 time, via resources or on the commandline.
1165 1190
1166 COLORTERM 1191 COLORTERM
1167 Either "rxvt", "rxvt-xpm", depending on wether urxvt was compiled 1192 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled
1168 with XPM support, and optionally with the added extension "-mono" to 1193 with XPM support, and optionally with the added extension "-mono" to
1169 indicate that rxvt-unicode runs on a monochrome screen. 1194 indicate that rxvt-unicode runs on a monochrome screen.
1170 1195
1171 COLORFGBG 1196 COLORFGBG
1172 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is 1197 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1173 the colour code used as default foreground/text colour (or the 1198 the colour code used as default foreground/text colour (or the
1174 string "default" to indicate that the default-colour escape sequence 1199 string "default" to indicate that the default-colour escape sequence
1175 is to be used), "bg" is the colour code used as default background 1200 is to be used), "bg" is the colour code used as default background
1176 colour (or the string "default"), and "xpm" is the string "default" 1201 colour (or the string "default"), and "xpm" is the string "default"
1177 if urxvt was compiled with XPM support. Libraries like "ncurses" and 1202 if rxvt was compiled with XPM support. Libraries like "ncurses" and
1178 "slang" can (and do) use this information to optimize screen output. 1203 "slang" can (and do) use this information to optimize screen output.
1179 1204
1180 WINDOWID 1205 WINDOWID
1181 Set to the (decimal) X Window ID of the urxvt window (the toplevel 1206 Set to the (decimal) X Window ID of the rxvt window (the toplevel
1182 window, which usually has subwindows for the scrollbar, the terminal 1207 window, which usually has subwindows for the scrollbar, the terminal
1183 window and so on). 1208 window and so on).
1184 1209
1185 TERMINFO 1210 TERMINFO
1186 Set to the terminfo directory iff urxvt was configured with 1211 Set to the terminfo directory iff rxvt was configured with
1187 "--with-terminfo=PATH". 1212 "--with-terminfo=PATH".
1188 1213
1189 DISPLAY 1214 DISPLAY
1190 Used by urxvt to connect to the display and set to the correct 1215 Used by rxvt to connect to the display and set to the correct
1191 display in it's child processes. 1216 display in it's child processes.
1192 1217
1193 SHELL 1218 SHELL
1194 The shell to be used for command execution, defaults to "/bin/sh". 1219 The shell to be used for command execution, defaults to "/bin/sh".
1195 1220
1196 RXVTPATH
1197 The path where urxvt looks for support files such as menu and xpm
1198 files.
1199
1200 PATH
1201 Used in the same way as "RXVTPATH".
1202
1203 RXVT_SOCKET 1221 RXVT_SOCKET
1204 The unix domain socket path used by urxvtc(1) and urxvtd(1). 1222 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1205 1223
1206 Default $HOME/.rxvt-unicode-*<nodename*. 1224 Default $HOME/.rxvt-unicode-*<nodename*.
1207 1225
1208 HOME 1226 HOME
1209 Used to locate the default directory for the unix domain socket for 1227 Used to locate the default directory for the unix domain socket for
… …
1213 XAPPLRESDIR 1231 XAPPLRESDIR
1214 Directory where various X resource files are being located. 1232 Directory where various X resource files are being located.
1215 1233
1216 XENVIRONMENT 1234 XENVIRONMENT
1217 If set and accessible, gives the name of a X resource file to be 1235 If set and accessible, gives the name of a X resource file to be
1218 loaded by urxvt. 1236 loaded by rxvt.
1219 1237
1220FILES 1238FILES
1221 /usr/lib/X11/rgb.txt 1239 /usr/lib/X11/rgb.txt
1222 Color names. 1240 Color names.
1223 1241
1224SEE ALSO 1242SEE ALSO
1225 urxvt(7), urxvtc(1), urxvtd(1), xterm(1), sh(1), resize(1), X(1), 1243 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
1226 pty(4), tty(4), utmp(5) 1244 tty(4), utmp(5)
1227 1245
1228CURRENT PROJECT COORDINATOR 1246CURRENT PROJECT COORDINATOR
1229 Project Coordinator 1247 Project Coordinator
1230 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1248 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1231 1249
… …
1248 1266
1249 Oezguer Kesim <kesim@math.fu-berlin.de> 1267 Oezguer Kesim <kesim@math.fu-berlin.de>
1250 Project Coordinator (changes.txt 2.21a to 2.4.5) 1268 Project Coordinator (changes.txt 2.21a to 2.4.5)
1251 1269
1252 Geoff Wing <gcw@pobox.com> 1270 Geoff Wing <gcw@pobox.com>
1253 Rewrote screen display and text selection routines. Project 1271 Rewrote screen display and text selection routines.
1272
1254 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1273 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1255 1274
1256 Marc Alexander Lehmann <rxvt-unicode@schmorp.de> 1275 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1257 Forked rxvt-unicode, rewrote most of the display code and internal 1276 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1258 character handling to store text in unicode, improve xterm 1277 perl extension, random hacks, numerous bugfixes and extensions.
1259 compatibility and apply numerous other bugfixes and extensions.
1260 1278
1261 Project Coordinator (Changes 1.0 -) 1279 Project Coordinator (Changes 1.0 -)
1262 1280
1281 Emanuele Giaquinta <e.giaquinta@glauco.it>
1282 Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1283

Diff Legend

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