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

Comparing cvsroot/rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.30 by root, Mon Jan 2 19:36:07 2006 UTC vs.
Revision 1.45 by root, Fri Jan 13 12:40:46 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 rxvt [options] [-e command [ args ]] 6 urxvt [options] [-e command [ args ]]
7 7
8DESCRIPTION 8DESCRIPTION
9 rxvt-unicode, version 6.2, 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 urxvt(7) (try "man 7 urxvt") for a list of frequently asked
17 and answer to them and some common problems. That document is also 17 questions and answer to them and some common problems. That document is
18 accessible on the World-Wide-Web at 18 also 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 rxvtd(1) (daemon) and rxvtc(1) 57 drastically reduces memory usage. See urxvtd(1) (daemon) and urxvtc(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 rxvt(7) for technical reference 61 been extended) easier accessible: see urxvt(7) for technical reference
62 documentation (escape sequences etc.). 62 documentation (escape sequences etc.).
63 63
64OPTIONS 64OPTIONS
65 The rxvt options (mostly a subset of *xterm*'s) are listed below. In 65 The urxvt 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. `rxvt 68 may not accurately reflect the version installed on your system. `urxvt
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: `rxvt -help' gives a list of all command-line options 72 line. Note: `urxvt -help' gives a list of all command-line options
73 compiled into your version. 73 compiled into your version.
74 74
75 Note that rxvt permits the resource name to be used as a long-option 75 Note that urxvt 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: `rxvt --loginShell --color1 Orange'. 77 than those listed. For example: `urxvt --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.
… …
113 transparency is enabled with -tr or -ip. This only works for 113 transparency is enabled with -tr or -ip. This only works for
114 non-tiled backgrounds, currently. See also the -sh option that can 114 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; 115 be used to brighten or darken the image in addition to tinting it;
116 resource *tintColor*. Example: 116 resource *tintColor*. Example:
117 117
118 rxvt -tr -tint blue -sh 40 118 urxvt -tr -tint blue -sh 40
119 119
120 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent 120 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent
121 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
122 specified, too, e.g. "-tint white"). 122 specified, too, e.g. "-tint white").
123 123
… …
146 The colour of the border around the text area and between the 146 The colour of the border around the text area and between the
147 scrollbar and the text; resource borderColor. 147 scrollbar and the text; resource borderColor.
148 148
149 -fn *fontlist* 149 -fn *fontlist*
150 Select the fonts to be used. This is a comma separated list of font 150 Select the fonts to be used. This is a comma separated list of font
151 names that are used in turn when trying to display Unicode 151 names that are checked in order when trying to find glyphs for
152 characters. The first font defines the cell size for characters; 152 characters. The first font defines the cell size for characters;
153 other fonts might be smaller, but not (in general) larger. A 153 other fonts might be smaller, but not (in general) larger. A
154 (hopefully) reasonable default font list is always appended to it. 154 (hopefully) reasonable default font list is always appended to it.
155 See resource font for more details. 155 See resource font for more details.
156 156
157 In short, to specify an X11 core font, just specify it's name or 157 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 158 prefix it with "x:". To specify an XFT-font, you need to prefix it
159 with "xft:", e.g.: 159 with "xft:", e.g.:
160 160
161 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 161 urxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
162 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" 162 urxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
163 163
164 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
165 FAQ section of rxvt(7). 165 FAQ section of urxvt(7).
166 166
167 -fb *fontlist* 167 -fb *fontlist*
168 Compile font-styles: The bold font list to use when bold characters 168 Compile *font-styles*: The bold font list to use when bold
169 are to be printed. See resource boldFont for details. 169 characters are to be printed. See resource boldFont for details.
170 170
171 -fi *fontlist* 171 -fi *fontlist*
172 Compile font-styles: The italic font list to use when bold 172 Compile *font-styles*: The italic font list to use when *italic*
173 characters are to be printed. See resource italicFont for details. 173 characters are to be printed. See resource italicFont for details.
174 174
175 -fbi *fontlist* 175 -fbi *fontlist*
176 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
177 characters are to be printed. See resource boldItalicFont for 177 italic* characters are to be printed. See resource boldItalicFont
178 details. 178 for details.
179 179
180 -is|+is 180 -is|+is
181 Compile font-styles: Bold/Italic font styles imply high intensity 181 Compile *font-styles*: Bold/Italic font styles imply high intensity
182 foreground/background (default). See resource intensityStyles for 182 foreground/background (default). See resource intensityStyles for
183 details. 183 details.
184 184
185 -name *name* 185 -name *name*
186 Specify the application name under which resources are to be 186 Specify the application name under which resources are to be
… …
252 252
253 -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.
254 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
255 decorations; resource borderLess. 255 decorations; resource borderLess.
256 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.
262
257 -lsp *number* 263 -lsp *number*
258 Compile *frills*: Lines (pixel height) to insert between each row of 264 Compile *frills*: Lines (pixel height) to insert between each row of
259 the display. Useful to work around font rendering problems; resource 265 the display. Useful to work around font rendering problems; resource
260 linespace. 266 linespace.
261 267
… …
264 TERM environment variable. This terminal type must exist in the 270 TERM environment variable. This terminal type must exist in the
265 *termcap(5)* database and should have *li#* and *co#* entries; 271 *termcap(5)* database and should have *li#* and *co#* entries;
266 resource termName. 272 resource termName.
267 273
268 -e *command [arguments]* 274 -e *command [arguments]*
269 Run the command with its command-line arguments in the rxvt window; 275 Run the command with its command-line arguments in the urxvt window;
270 also sets the window title and icon name to be the basename of the 276 also sets the window title and icon name to be the basename of the
271 program being executed if neither *-title* (*-T*) nor *-n* are given 277 program being executed if neither *-title* (*-T*) nor *-n* are given
272 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
273 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
274 run the program specified by the SHELL environment variable or, 280 run the program specified by the SHELL environment variable or,
… …
276 282
277 Please note that you must specify a program with arguments. If you 283 Please note that you must specify a program with arguments. If you
278 want to run shell commands, you have to specify the shell, like 284 want to run shell commands, you have to specify the shell, like
279 this: 285 this:
280 286
281 rxvt -e sh -c "shell commands" 287 urxvt -e sh -c "shell commands"
282 288
283 -title *text* 289 -title *text*
284 Window title (-T still respected); the default title is the basename 290 Window title (-T still respected); the default title is the basename
285 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
286 application name; resource title. 292 application name; resource title.
… …
331 -ssr|+ssr 337 -ssr|+ssr
332 Turn on/off secondary screen scroll (default enabled); resource 338 Turn on/off secondary screen scroll (default enabled); resource
333 secondaryScroll. 339 secondaryScroll.
334 340
335 -hold|+hold 341 -hold|+hold
336 Turn on/off hold window after exit support. If enabled, rxvt will 342 Turn on/off hold window after exit support. If enabled, urxvt will
337 not immediately destroy its window when the program executed within 343 not immediately destroy its window when the program executed within
338 it exits. Instead, it will wait till it is being killed or closed by 344 it exits. Instead, it will wait till it is being killed or closed by
339 the user; resource hold. 345 the user; resource hold.
340 346
341 -keysym.*sym* *string* 347 -keysym.*sym* *string*
342 Remap a key symbol. See resource keysym. 348 Remap a key symbol. See resource keysym.
343 349
344 -embed *windowid* 350 -embed *windowid*
345 Tells rxvt to embed it's windows into an already-existing window, 351 Tells urxvt to embed it's windows into an already-existing window,
346 which enables applications to easily embed a terminal. 352 which enables applications to easily embed a terminal.
347 353
348 Right now, rxvt will first unmap/map the specified window, so it 354 Right now, urxvt will first unmap/map the specified window, so it
349 shouldn't be a top-level window. rxvt will also reconfigure it quite 355 shouldn't be a top-level window. urxvt will also reconfigure it
350 a bit, so don't expect it to keep some specific state. It's best to 356 quite a bit, so don't expect it to keep some specific state. It's
351 create an extra subwindow for rxvt and leave it alone. 357 best to create an extra subwindow for urxvt and leave it alone.
352 358
353 The window will not be destroyed when rxvt exits. 359 The window will not be destroyed when urxvt exits.
354 360
355 It might be useful to know that rxvt will not close file descriptors 361 It might be useful to know that urxvt will not close file
356 passed to it (except for stdin/out/err, of course), so you can use 362 descriptors passed to it (except for stdin/out/err, of course), so
357 file descriptors to communicate with the programs within the 363 you can use file descriptors to communicate with the programs within
358 terminal. This works regardless of wether the "-embed" option was 364 the terminal. This works regardless of wether the "-embed" option
359 used or not. 365 was used or not.
360 366
361 Here is a short Gtk2-perl snippet that illustrates how this option 367 Here is a short Gtk2-perl snippet that illustrates how this option
362 can be used (a longer example is in doc/embed): 368 can be used (a longer example is in doc/embed):
363 369
364 my $rxvt = new Gtk2::Socket; 370 my $rxvt = new Gtk2::Socket;
365 $rxvt->signal_connect_after (realize => sub { 371 $rxvt->signal_connect_after (realize => sub {
366 my $xid = $_[0]->window->get_xid; 372 my $xid = $_[0]->window->get_xid;
367 system "rxvt -embed $xid &"; 373 system "urxvt -embed $xid &";
368 }); 374 });
369 375
370 -pty-fd *fileno* 376 -pty-fd *file descriptor*
371 Tells rxvt NOT to execute any commands or create a new pty/tty pair 377 Tells urxvt NOT to execute any commands or create a new pty/tty pair
372 but instead use the given filehandle as the tty master. This is 378 but instead use the given filehandle as the tty master. This is
373 useful if you want to drive rxvt as a generic terminal emulator 379 useful if you want to drive urxvt as a generic terminal emulator
374 without having to run a program within it. 380 without having to run a program within it.
375 381
376 If this switch is given, rxvt will not create any utmp/wtmp entries 382 If this switch is given, urxvt will not create any utmp/wtmp entries
377 and will not tinker with pty/tty permissions - you have to do that 383 and will not tinker with pty/tty permissions - you have to do that
378 yourself if you want that. 384 yourself if you want that.
379 385
386 As an extremely special case, specifying -1 will completely suppress
387 pty/tty operations.
388
380 Here is a example in perl that illustrates how this option can be 389 Here is a example in perl that illustrates how this option can be
381 used (a longer example is in doc/pty-fd): 390 used (a longer example is in doc/pty-fd):
382 391
383 use IO::Pty; 392 use IO::Pty;
384 use Fcntl; 393 use Fcntl;
385 394
386 my $pty = new IO::Pty; 395 my $pty = new IO::Pty;
387 fcntl $pty, F_SETFD, 0; # clear close-on-exec 396 fcntl $pty, F_SETFD, 0; # clear close-on-exec
388 system "rxvt -pty-fd " . (fileno $pty) . "&"; 397 system "urxvt -pty-fd " . (fileno $pty) . "&";
389 close $pty; 398 close $pty;
390 399
391 # now communicate with rxvt 400 # now communicate with rxvt
392 my $slave = $pty->slave; 401 my $slave = $pty->slave;
393 while (<$slave>) { print $slave "got <$_>\n" } 402 while (<$slave>) { print $slave "got <$_>\n" }
394 403
395 -perl *string* 404 -pe *string*
396 Used by perl extension. See resource perl. 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.
397 407
398RESOURCES (available also as long-options) 408RESOURCES (available also as long-options)
399 Note: `rxvt --help' gives a list of all resources (long options) 409 Note: `urxvt --help' gives a list of all resources (long options)
400 compiled into your version. 410 compiled into your version.
401 411
402 There are two different methods that rxvt can use to get the Xresource
403 data: using the X libraries (Xrm*-functions) or internal Xresources
404 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
405 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
406 xrdb. Many distribution do also load settings from the ~/.Xresources 413 distribution do also load settings from the ~/.Xresources file when X
407 file when X starts. rxvt will consult the following files/resources in 414 starts. urxvt will consult the following files/resources in order, with
408 order, with later settings overwriting earlier ones: 415 later settings overwriting earlier ones:
409 416
410 1. system-wide app-defaults file, either locale-dependent OR global 417 1. system-wide app-defaults file, either locale-dependent OR global
411 2. app-defaults file in $XAPPLRESDIR 418 2. app-defaults file in $XAPPLRESDIR
412 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 419 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
413 4. SCREEN_RESOURCES for the current screen 420 4. SCREEN_RESOURCES for the current screen
414 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 421 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
415 422
416 If compiled with internal Xresources support (i.e. rxvt -h lists 423 Note that when reading X resources, urxvt recognizes two class names:
417 .Xdefaults) then rxvt accepts application defaults set in 424 Rxvt and URxvt. The class name Rxvt allows resources common to both
418 XAPPLOADDIR/URxvt (compile-time defined: usually 425 urxvt and the original *rxvt* to be easily configured, while the class
419 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 426 name URxvt allows resources unique to urxvt, to be shared between
420 ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X
421 resources, rxvt recognizes two class names: XTerm and URxvt. The class
422 name Rxvt allows resources common to both rxvt and the original *rxvt*
423 to be easily configured, while the class name URxvt allows resources
424 unique to rxvt, notably colours and key-handling, to be shared between
425 different rxvt configurations. If no resources are specified, suitable 427 different urxvt configurations. If no resources are specified, suitable
426 defaults will be used. Command-line arguments can be used to override 428 defaults will be used. Command-line arguments can be used to override
427 resource settings. The following resources are allowed: 429 resource settings. The following resources are supported (you might want
430 to check the urxvtperl(3) manpage for additional settings by perl
431 extensions not documented here):
428 432
429 geometry: *geom* 433 geometry: *geom*
430 Create the window with the specified X window geometry [default 434 Create the window with the specified X window geometry [default
431 80x24]; option -geometry. 435 80x24]; option -geometry.
432 436
… …
446 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but 450 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but
447 the actual colour names used are listed in the COLORS AND GRAPHICS 451 the actual colour names used are listed in the COLORS AND GRAPHICS
448 section. 452 section.
449 453
450 Colours higher than 15 cannot be set using resources (yet), but can 454 Colours higher than 15 cannot be set using resources (yet), but can
451 be changed using an escape command (see rxvt(7)). 455 be changed using an escape command (see urxvt(7)).
452 456
453 Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm 457 Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm
454 with 88 colour support). Colours 80-87 are evenly spaces grey steps. 458 with 88 colour support). Colours 80-87 are evenly spaces grey steps.
455 459
456 colorBD: *colour* 460 colorBD: *colour*
… …
545 menus), in addition to the paths specified by the RXVTPATH and PATH 549 menus), in addition to the paths specified by the RXVTPATH and PATH
546 environment variables. 550 environment variables.
547 551
548 font: *fontlist* 552 font: *fontlist*
549 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
550 names that are used in turn when trying to display Unicode 554 names that are checked in order when trying to find glyphs for
551 characters. The first font defines the cell size for characters; 555 characters. The first font defines the cell size for characters;
552 other fonts might be smaller, but not larger. A reasonable default 556 other fonts might be smaller, but not (in general) larger. A
553 font list is always appended to it; option -fn. 557 (hopefully) reasonable default font list is always appended to it;
558 option -fn.
554 559
555 Each font can either be a standard X11 core font (XLFD) name, with 560 Each font can either be a standard X11 core font (XLFD) name, with
556 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 561 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
557 "xft:". 562 "xft:".
558 563
… …
710 borderLess: *boolean* 715 borderLess: *boolean*
711 Set MWM hints to request a borderless window, i.e. if honoured by 716 Set MWM hints to request a borderless window, i.e. if honoured by
712 the WM, the rxvt-unicode window will not have window decorations; 717 the WM, the rxvt-unicode window will not have window decorations;
713 option -bl. 718 option -bl.
714 719
720 skipBuiltinGlyphs: *boolean*
721 Compile *frills*: Disable the usage of the built-in block
722 graphics/line drawing characters and just rely on what the specified
723 fonts provide. Use this if you have a good font and want to use its
724 block graphic glyphs; option -sbg.
725
715 termName: *termname* 726 termName: *termname*
716 Specifies the terminal type name to be set in the TERM environment 727 Specifies the terminal type name to be set in the TERM environment
717 variable; option -tn. 728 variable; option -tn.
718 729
719 linespace: *number* 730 linespace: *number*
… …
783 794
784 imFont: *fontset* 795 imFont: *fontset*
785 Specify the font-set used for XIM styles "OverTheSpot" or 796 Specify the font-set used for XIM styles "OverTheSpot" or
786 "OffTheSpot". It must be a standard X font set (XLFD patterns 797 "OffTheSpot". It must be a standard X font set (XLFD patterns
787 separated by commas), i.e. it's not in the same format as the other 798 separated by commas), i.e. it's not in the same format as the other
788 font lists used in rxvt. The default will be set-up to chose *any* 799 font lists used in urxvt. The default will be set-up to chose *any*
789 suitable found found, preferably one or two pixels differing in size 800 suitable found found, preferably one or two pixels differing in size
790 to the base font. option -imfont. 801 to the base font. option -imfont.
791 802
792 tripleclickwords: *boolean* 803 tripleclickwords: *boolean*
793 Change the meaning of triple-click selection with the left mouse 804 Change the meaning of triple-click selection with the left mouse
… …
826 option is enabled, scrolls on the secondary screen will change the 837 option is enabled, scrolls on the secondary screen will change the
827 scrollback buffer and switching to/from the secondary screen will 838 scrollback buffer and switching to/from the secondary screen will
828 instead scroll the screen up. 839 instead scroll the screen up.
829 840
830 hold: *bool* 841 hold: *bool*
831 Turn on/off hold window after exit support. If enabled, rxvt will 842 Turn on/off hold window after exit support. If enabled, urxvt will
832 not immediately destroy its window when the program executed within 843 not immediately destroy its window when the program executed within
833 it exits. Instead, it will wait till it is being killed or closed by 844 it exits. Instead, it will wait till it is being killed or closed by
834 the user. 845 the user.
835 846
836 keysym.*sym*: *string* 847 keysym.*sym*: *string*
… …
858 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 869 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
859 "\000": octal number) or verbatim control characters ("^?": delete, 870 "\000": octal number) or verbatim control characters ("^?": delete,
860 "^@": null, "^A" ...) and may be enclosed with double quotes so that 871 "^@": null, "^A" ...) and may be enclosed with double quotes so that
861 it can start or end with whitespace. 872 it can start or end with whitespace.
862 873
863 Please note that you need to double the "\" when using 874 Please note that you need to double the "\" in resource files, as
864 "--enable-xgetdefault", as X itself does it's own de-escaping (you 875 Xlib itself does it's own de-escaping (you can use "\033" instead of
865 can use "\033" instead of "\e" (and so on), which will work with 876 "\e" (and so on), which will work with both Xt and urxvt's own
866 both Xt and rxvt's own processing). 877 processing).
867 878
868 You can define a range of keysyms in one shot by providing a 879 You can define a range of keysyms in one shot by providing a
869 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 880 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
870 `/' should be a character not used by the strings. 881 `/' should be a character not used by the strings.
871 882
… …
878 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 889 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
879 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 890 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
880 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 891 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
881 892
882 If *string* takes the form of "command:STRING", the specified STRING 893 If *string* takes the form of "command:STRING", the specified STRING
883 is interpreted and executed as rxvt's control sequence. For example 894 is interpreted and executed as urxvt's control sequence. For example
884 the following means "change the current locale to "zh_CN.GBK" when 895 the following means "change the current locale to "zh_CN.GBK" when
885 Control-Meta-c is being pressed": 896 Control-Meta-c is being pressed":
886 897
887 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 898 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
899
900 If *string* takes the form "perl:STRING", then the specified STRING
901 is passed to the "on_keyboard_command" perl handler. See the
902 urxvtperl(3) manpage. For example, the selection extension
903 (activated via "urxvt -pe selection") listens for "selection:rot13"
904 events:
905
906 URxvt.keysym.M-C-c: perl:selection:rot13
888 907
889 Due the the large number of modifier combinations, a defined key 908 Due the the large number of modifier combinations, a defined key
890 mapping will match if at *at least* the specified identifiers are 909 mapping will match if at *at least* the specified identifiers are
891 being set, and no other key mappings with those and more bits are 910 being set, and no other key mappings with those and more bits are
892 being defined. That means that defining a key map for "a" will 911 being defined. That means that defining a key map for "a" will
893 automatically provide definitions for "Meta-a", "Shift-a" and so on, 912 automatically provide definitions for "Meta-a", "Shift-a" and so on,
894 unless some of those are defined mappings themselves. 913 unless some of those are defined mappings themselves.
895 914
896 Unfortunately, this will override built-in key mappings. For example 915 Unfortunately, this will override built-in key mappings. For example
897 if you overwrite the "Insert" key you will disable rxvt's 916 if you overwrite the "Insert" key you will disable urxvt's
898 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into 917 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
899 the user-defined keymap using the "builtin:" replacement: 918 the user-defined keymap using the "builtin:" replacement:
900 919
901 URxvt.keysym.Insert: <my insert key sequence> 920 URxvt.keysym.Insert: <my insert key sequence>
902 URxvt.keysym.S-Insert: builtin: 921 URxvt.keysym.S-Insert: builtin:
… …
910 font-switching at runtime: 929 font-switching at runtime:
911 930
912 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 931 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
913 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 932 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
914 933
915 Other things are possible, e.g. resizing (see rxvt(7) for more 934 Other things are possible, e.g. resizing (see urxvt(7) for more
916 info): 935 info):
917 936
918 URxvt.keysym.M-C-3: command:\033[8;25;80t 937 URxvt.keysym.M-C-3: command:\033[8;25;80t
919 URxvt.keysym.M-C-4: command:\033[8;48;110t 938 URxvt.keysym.M-C-4: command:\033[8;48;110t
920 939
940 perl-ext-common: *string*
921 perl: *string* 941 perl-ext: *string*
922 Used by perl extension and is free for any use, as it is not 942 Comma-separated list(s) of perl extension scripts (default:
923 interpreted by rxvt-unicode itself; option perl. 943 "default") to use in this terminal instance; option -pe.
944
945 Extension names can be prefixed with a "-" sign to prohibit using
946 them. This can be useful to selectively disable some extensions
947 loaded by default, or specified via the "perl-ext-common" resource.
948 For example, "default,-selection" will use all the default extension
949 except "selection".
950
951 Extension names can also be followed by an argument in angle
952 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
953 for searchable scorllback to Alt/Meta-s). Mentioning the same
954 extension multiple times with different arguments will pass multiple
955 arguments to the extension.
956
957 Each extension is looked up in the library directories, loaded if
958 necessary, and bound to the current terminal instance.
959
960 If both of these resources are the empty string, then the perl
961 interpreter will not be initialized. The idea behind two options is
962 that perl-ext-common will be used for extensions that should be
963 available to all instances, while perl-ext is used for specific
964 instances.
924 965
925 perl-eval: *string* 966 perl-eval: *string*
926 Perl code to be evaluated when all extensions have been loaded. See 967 Perl code to be evaluated when all extensions have been registered.
927 the rxvtperl(3) manpage. 968 See the urxvtperl(3) manpage. Due to security reasons, this resource
969 will be ignored when running setuid/setgid.
928 970
929 perl-lib: *path* 971 perl-lib: *path*
930 Additional directory that holds extension scripts that are loaded 972 Colon-separated list of additional directories that hold extension
931 and enabled for this terminal instance, in addition to scripts 973 scripts. When looking for extensions specified by the "perl"
932 stored in /opt/rxvt/lib/urxvt/perl-ext/, which are global to all 974 resource, urxvt will first look in these directories and then in
933 terminal instances. 975 /usr/local/lib/urxvt/perl/. Due to security reasons, this resource
976 will be ignored when running setuid/setgid.
934 977
935 See the rxvtperl(3) manpage. 978 See the urxvtperl(3) manpage.
979
980 selection.pattern-*idx*: *perl-regex*
981 Additional selection patterns, see the urxvtperl(3) manpage for
982 details.
983
984 selection-autotransform.*idx*: *perl-transform*
985 Selection auto-transform patterns, see the urxvtperl(3) manpage for
986 details.
987
988 searchable-scrollback: *keysym*
989 Sets the hotkey that starts the incremental scrollback buffer search
990 (default: "M-s").
991
992 urlLauncher: *string*
993 Specifies the program to be started with a URL argument. Used by the
994 "selection-popup" and "mark-urls" perl extensions.
995
996 transient-for: *windowid*
997 Sets the WM_TRANSIENT_FOR property to the given window iw.
936 998
937THE SCROLLBAR 999THE SCROLLBAR
938 Lines of text that scroll off the top of the rxvt window (resource: 1000 Lines of text that scroll off the top of the urxvt window (resource:
939 saveLines) and can be scrolled back using the scrollbar or by 1001 saveLines) and can be scrolled back using the scrollbar or by
940 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1002 keystrokes. The normal urxvt scrollbar has arrows and its behaviour is
941 fairly intuitive. The xterm-scrollbar is without arrows and its 1003 fairly intuitive. The xterm-scrollbar is without arrows and its
942 behaviour mimics that of *xterm* 1004 behaviour mimics that of *xterm*
943 1005
944 Scroll down with Button1 (xterm-scrollbar) or Shift-Next. Scroll up with 1006 Scroll down with Button1 (xterm-scrollbar) or Shift-Next. Scroll up with
945 Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with 1007 Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with
… …
973 the selection, and trailing whitespace is visually underlined and 1035 the selection, and trailing whitespace is visually underlined and
974 removed from the selection. 1036 removed from the selection.
975 1037
976 Insertion: 1038 Insertion:
977 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1039 Pressing and releasing the Middle mouse button (or Shift-Insert) in
978 an rxvt window causes the current text selection to be inserted as 1040 an urxvt window causes the current text selection to be inserted as
979 if it had been typed on the keyboard. 1041 if it had been typed on the keyboard.
980 1042
981CHANGING FONTS 1043CHANGING FONTS
982 Changing fonts (or font sizes, respectively) via the keypad is not yet 1044 Changing fonts (or font sizes, respectively) via the keypad is not yet
983 supported in rxvt-unicode. Bug me if you need this. 1045 supported in rxvt-unicode. Bug me if you need this.
… …
1048 1110
1049 With respect to conformance, rxvt-unicode is supposed to be compliant to 1111 With respect to conformance, rxvt-unicode is supposed to be compliant to
1050 both scenario A and B of ISO 14755, including part 5.2. 1112 both scenario A and B of ISO 14755, including part 5.2.
1051 1113
1052LOGIN STAMP 1114LOGIN STAMP
1053 rxvt tries to write an entry into the *utmp*(5) file so that it can be 1115 urxvt tries to write an entry into the *utmp*(5) file so that it can be
1054 seen via the *who(1)* command, and can accept messages. To allow this 1116 seen via the *who(1)* command, and can accept messages. To allow this
1055 feature, rxvt may need to be installed setuid root on some systems or 1117 feature, urxvt may need to be installed setuid root on some systems or
1056 setgid to root or to some other group on others. 1118 setgid to root or to some other group on others.
1057 1119
1058COLORS AND GRAPHICS 1120COLORS AND GRAPHICS
1059 In addition to the default foreground and background colours, rxvt can 1121 In addition to the default foreground and background colours, urxvt can
1060 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 1122 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
1061 versions of the same). Here is a list of the colours with their rgb.txt 1123 versions of the same). Here is a list of the colours with their rgb.txt
1062 names. 1124 names.
1063 1125
1064 color0 (black) = Black 1126 color0 (black) = Black
… …
1088 Note that -rv ("reverseVideo: True") simulates reverse video by always 1150 Note that -rv ("reverseVideo: True") simulates reverse video by always
1089 swapping the foreground/background colours. This is in contrast to 1151 swapping the foreground/background colours. This is in contrast to
1090 *xterm*(1) where the colours are only swapped if they have not otherwise 1152 *xterm*(1) where the colours are only swapped if they have not otherwise
1091 been specified. For example, 1153 been specified. For example,
1092 1154
1093 rxvt -fg Black -bg White -rv 1155 urxvt -fg Black -bg White -rv
1094 would yield White on Black, while on *xterm*(1) it would yield Black 1156 would yield White on Black, while on *xterm*(1) it would yield Black
1095 on White. 1157 on White.
1096 1158
1097ENVIRONMENT 1159ENVIRONMENT
1098 rxvt sets and/or uses the following environment variables: 1160 urxvt sets and/or uses the following environment variables:
1099 1161
1100 TERM 1162 TERM
1101 Normally set to "rxvt-unicode", unless overwritten at configure 1163 Normally set to "rxvt-unicode", unless overwritten at configure
1102 time, via resources or on the commandline. 1164 time, via resources or on the commandline.
1103 1165
1104 COLORTERM 1166 COLORTERM
1105 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled 1167 Either "rxvt", "rxvt-xpm", depending on wether urxvt was compiled
1106 with XPM support, and optionally with the added extension "-mono" to 1168 with XPM support, and optionally with the added extension "-mono" to
1107 indicate that rxvt-unicode runs on a monochrome screen. 1169 indicate that rxvt-unicode runs on a monochrome screen.
1108 1170
1109 COLORFGBG 1171 COLORFGBG
1110 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is 1172 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1111 the colour code used as default foreground/text colour (or the 1173 the colour code used as default foreground/text colour (or the
1112 string "default" to indicate that the default-colour escape sequence 1174 string "default" to indicate that the default-colour escape sequence
1113 is to be used), "bg" is the colour code used as default background 1175 is to be used), "bg" is the colour code used as default background
1114 colour (or the string "default"), and "xpm" is the string "default" 1176 colour (or the string "default"), and "xpm" is the string "default"
1115 if rxvt was compiled with XPM support. Libraries like "ncurses" and 1177 if urxvt was compiled with XPM support. Libraries like "ncurses" and
1116 "slang" can (and do) use this information to optimize screen output. 1178 "slang" can (and do) use this information to optimize screen output.
1117 1179
1118 WINDOWID 1180 WINDOWID
1119 Set to the (decimal) X Window ID of the rxvt window (the toplevel 1181 Set to the (decimal) X Window ID of the urxvt window (the toplevel
1120 window, which usually has subwindows for the scrollbar, the terminal 1182 window, which usually has subwindows for the scrollbar, the terminal
1121 window and so on). 1183 window and so on).
1122 1184
1123 TERMINFO 1185 TERMINFO
1124 Set to the terminfo directory iff rxvt was configured with 1186 Set to the terminfo directory iff urxvt was configured with
1125 "--with-terminfo=PATH". 1187 "--with-terminfo=PATH".
1126 1188
1127 DISPLAY 1189 DISPLAY
1128 Used by rxvt to connect to the display and set to the correct 1190 Used by urxvt to connect to the display and set to the correct
1129 display in it's child processes. 1191 display in it's child processes.
1130 1192
1131 SHELL 1193 SHELL
1132 The shell to be used for command execution, defaults to "/bin/sh". 1194 The shell to be used for command execution, defaults to "/bin/sh".
1133 1195
1134 RXVTPATH 1196 RXVTPATH
1135 The path where rxvt looks for support files such as menu and xpm 1197 The path where urxvt looks for support files such as menu and xpm
1136 files. 1198 files.
1137 1199
1138 PATH 1200 PATH
1139 Used in the same way as "RXVTPATH". 1201 Used in the same way as "RXVTPATH".
1140 1202
1141 RXVT_SOCKET 1203 RXVT_SOCKET
1142 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1204 The unix domain socket path used by urxvtc(1) and urxvtd(1).
1143 1205
1144 Default $HOME/.rxvt-unicode-*<nodename*. 1206 Default $HOME/.rxvt-unicode-*<nodename*.
1145 1207
1146 HOME 1208 HOME
1147 Used to locate the default directory for the unix domain socket for 1209 Used to locate the default directory for the unix domain socket for
… …
1151 XAPPLRESDIR 1213 XAPPLRESDIR
1152 Directory where various X resource files are being located. 1214 Directory where various X resource files are being located.
1153 1215
1154 XENVIRONMENT 1216 XENVIRONMENT
1155 If set and accessible, gives the name of a X resource file to be 1217 If set and accessible, gives the name of a X resource file to be
1156 loaded by rxvt. 1218 loaded by urxvt.
1157 1219
1158FILES 1220FILES
1159 /usr/lib/X11/rgb.txt 1221 /usr/lib/X11/rgb.txt
1160 Color names. 1222 Color names.
1161 1223
1162SEE ALSO 1224SEE ALSO
1163 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4), 1225 urxvt(7), urxvtc(1), urxvtd(1), xterm(1), sh(1), resize(1), X(1),
1164 tty(4), utmp(5) 1226 pty(4), tty(4), utmp(5)
1165 1227
1166CURRENT PROJECT COORDINATOR 1228CURRENT PROJECT COORDINATOR
1167 Project Coordinator 1229 Project Coordinator
1168 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1230 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1169 1231

Diff Legend

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