1 | NAME |
1 | NAME |
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 | |
5 | SYNOPSIS |
5 | SYNOPSIS |
6 | rxvt [options] [-e command [ args ]] |
6 | urxvt [options] [-e command [ args ]] |
7 | |
7 | |
8 | DESCRIPTION |
8 | DESCRIPTION |
9 | rxvt-unicode, version 6.3, 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 | |
15 | FREQUENTLY ASKED QUESTIONS |
15 | FREQUENTLY 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 | |
21 | RXVT-UNICODE VS. RXVT |
21 | RXVT-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 | |
64 | OPTIONS |
64 | OPTIONS |
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 |
168 | Compile *font-styles*: The bold font list to use when bold |
169 | characters are to be printed. See resource boldFont for details. |
169 | characters are to be printed. See resource boldFont for details. |
170 | |
170 | |
… | |
… | |
270 | TERM environment variable. This terminal type must exist in the |
270 | TERM environment variable. This terminal type must exist in the |
271 | *termcap(5)* database and should have *li#* and *co#* entries; |
271 | *termcap(5)* database and should have *li#* and *co#* entries; |
272 | resource termName. |
272 | resource termName. |
273 | |
273 | |
274 | -e *command [arguments]* |
274 | -e *command [arguments]* |
275 | 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; |
276 | 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 |
277 | program being executed if neither *-title* (*-T*) nor *-n* are given |
277 | 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 |
278 | 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 |
279 | 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, |
280 | run the program specified by the SHELL environment variable or, |
… | |
… | |
282 | |
282 | |
283 | 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 |
284 | 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 |
285 | this: |
285 | this: |
286 | |
286 | |
287 | rxvt -e sh -c "shell commands" |
287 | urxvt -e sh -c "shell commands" |
288 | |
288 | |
289 | -title *text* |
289 | -title *text* |
290 | Window title (-T still respected); the default title is the basename |
290 | Window title (-T still respected); the default title is the basename |
291 | 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 |
292 | application name; resource title. |
292 | application name; resource title. |
… | |
… | |
337 | -ssr|+ssr |
337 | -ssr|+ssr |
338 | Turn on/off secondary screen scroll (default enabled); resource |
338 | Turn on/off secondary screen scroll (default enabled); resource |
339 | secondaryScroll. |
339 | secondaryScroll. |
340 | |
340 | |
341 | -hold|+hold |
341 | -hold|+hold |
342 | 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 |
343 | not immediately destroy its window when the program executed within |
343 | 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 |
344 | it exits. Instead, it will wait till it is being killed or closed by |
345 | the user; resource hold. |
345 | the user; resource hold. |
346 | |
346 | |
347 | -keysym.*sym* *string* |
347 | -keysym.*sym* *string* |
348 | Remap a key symbol. See resource keysym. |
348 | Remap a key symbol. See resource keysym. |
349 | |
349 | |
350 | -embed *windowid* |
350 | -embed *windowid* |
351 | 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, |
352 | which enables applications to easily embed a terminal. |
352 | which enables applications to easily embed a terminal. |
353 | |
353 | |
354 | 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 |
355 | 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 |
356 | 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 |
357 | create an extra subwindow for rxvt and leave it alone. |
357 | best to create an extra subwindow for urxvt and leave it alone. |
358 | |
358 | |
359 | The window will not be destroyed when rxvt exits. |
359 | The window will not be destroyed when urxvt exits. |
360 | |
360 | |
361 | 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 |
362 | 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 |
363 | file descriptors to communicate with the programs within the |
363 | you can use file descriptors to communicate with the programs within |
364 | terminal. This works regardless of wether the "-embed" option was |
364 | the terminal. This works regardless of wether the "-embed" option |
365 | used or not. |
365 | was used or not. |
366 | |
366 | |
367 | 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 |
368 | can be used (a longer example is in doc/embed): |
368 | can be used (a longer example is in doc/embed): |
369 | |
369 | |
370 | my $rxvt = new Gtk2::Socket; |
370 | my $rxvt = new Gtk2::Socket; |
371 | $rxvt->signal_connect_after (realize => sub { |
371 | $rxvt->signal_connect_after (realize => sub { |
372 | my $xid = $_[0]->window->get_xid; |
372 | my $xid = $_[0]->window->get_xid; |
373 | system "rxvt -embed $xid &"; |
373 | system "urxvt -embed $xid &"; |
374 | }); |
374 | }); |
375 | |
375 | |
376 | -pty-fd *file descriptor* |
376 | -pty-fd *file descriptor* |
377 | 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 |
378 | 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 |
379 | 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 |
380 | without having to run a program within it. |
380 | without having to run a program within it. |
381 | |
381 | |
382 | 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 |
383 | 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 |
384 | yourself if you want that. |
384 | yourself if you want that. |
385 | |
385 | |
386 | As an extremely special case, specifying -1 will completely suppress |
386 | As an extremely special case, specifying -1 will completely suppress |
387 | pty/tty operations. |
387 | pty/tty operations. |
… | |
… | |
392 | use IO::Pty; |
392 | use IO::Pty; |
393 | use Fcntl; |
393 | use Fcntl; |
394 | |
394 | |
395 | my $pty = new IO::Pty; |
395 | my $pty = new IO::Pty; |
396 | fcntl $pty, F_SETFD, 0; # clear close-on-exec |
396 | fcntl $pty, F_SETFD, 0; # clear close-on-exec |
397 | system "rxvt -pty-fd " . (fileno $pty) . "&"; |
397 | system "urxvt -pty-fd " . (fileno $pty) . "&"; |
398 | close $pty; |
398 | close $pty; |
399 | |
399 | |
400 | # now communicate with rxvt |
400 | # now communicate with rxvt |
401 | my $slave = $pty->slave; |
401 | my $slave = $pty->slave; |
402 | while (<$slave>) { print $slave "got <$_>\n" } |
402 | while (<$slave>) { print $slave "got <$_>\n" } |
… | |
… | |
404 | -pe *string* |
404 | -pe *string* |
405 | Comma-separated list of perl extension scripts to use (or not to |
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. |
406 | use) in this terminal instance. See resource perl-ext for details. |
407 | |
407 | |
408 | RESOURCES (available also as long-options) |
408 | RESOURCES (available also as long-options) |
409 | Note: `rxvt --help' gives a list of all resources (long options) |
409 | Note: `urxvt --help' gives a list of all resources (long options) |
410 | compiled into your version. |
410 | compiled into your version. |
411 | |
411 | |
412 | There are two different methods that rxvt can use to get the Xresource |
|
|
413 | data: using the X libraries (Xrm*-functions) or internal Xresources |
|
|
414 | reader (~/.Xdefaults). For the first method (ie. rxvt -h lists |
|
|
415 | 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 |
416 | xrdb. Many distribution do also load settings from the ~/.Xresources |
413 | distribution do also load settings from the ~/.Xresources file when X |
417 | file when X starts. rxvt will consult the following files/resources in |
414 | starts. urxvt will consult the following files/resources in order, with |
418 | order, with later settings overwriting earlier ones: |
415 | later settings overwriting earlier ones: |
419 | |
416 | |
420 | 1. system-wide app-defaults file, either locale-dependent OR global |
417 | 1. system-wide app-defaults file, either locale-dependent OR global |
421 | 2. app-defaults file in $XAPPLRESDIR |
418 | 2. app-defaults file in $XAPPLRESDIR |
422 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
419 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
423 | 4. SCREEN_RESOURCES for the current screen |
420 | 4. SCREEN_RESOURCES for the current screen |
424 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
421 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
425 | |
422 | |
426 | If compiled with internal Xresources support (i.e. rxvt -h lists |
423 | Note that when reading X resources, urxvt recognizes two class names: |
427 | .Xdefaults) then rxvt accepts application defaults set in |
424 | Rxvt and URxvt. The class name Rxvt allows resources common to both |
428 | XAPPLOADDIR/URxvt (compile-time defined: usually |
425 | urxvt and the original *rxvt* to be easily configured, while the class |
429 | /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or |
426 | name URxvt allows resources unique to urxvt, to be shared between |
430 | ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X |
|
|
431 | resources, rxvt recognizes two class names: XTerm and URxvt. The class |
|
|
432 | name Rxvt allows resources common to both rxvt and the original *rxvt* |
|
|
433 | to be easily configured, while the class name URxvt allows resources |
|
|
434 | unique to rxvt, notably colours and key-handling, to be shared between |
|
|
435 | different rxvt configurations. If no resources are specified, suitable |
427 | different urxvt configurations. If no resources are specified, suitable |
436 | 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 |
437 | 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): |
438 | |
432 | |
439 | geometry: *geom* |
433 | geometry: *geom* |
440 | Create the window with the specified X window geometry [default |
434 | Create the window with the specified X window geometry [default |
441 | 80x24]; option -geometry. |
435 | 80x24]; option -geometry. |
442 | |
436 | |
… | |
… | |
456 | 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 |
457 | 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 |
458 | section. |
452 | section. |
459 | |
453 | |
460 | 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 |
461 | be changed using an escape command (see rxvt(7)). |
455 | be changed using an escape command (see urxvt(7)). |
462 | |
456 | |
463 | 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 |
464 | 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. |
465 | |
459 | |
466 | colorBD: *colour* |
460 | colorBD: *colour* |
… | |
… | |
555 | 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 |
556 | environment variables. |
550 | environment variables. |
557 | |
551 | |
558 | font: *fontlist* |
552 | font: *fontlist* |
559 | 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 |
560 | names that are used in turn when trying to display Unicode |
554 | names that are checked in order when trying to find glyphs for |
561 | characters. The first font defines the cell size for characters; |
555 | characters. The first font defines the cell size for characters; |
562 | other fonts might be smaller, but not larger. A reasonable default |
556 | other fonts might be smaller, but not (in general) larger. A |
563 | font list is always appended to it; option -fn. |
557 | (hopefully) reasonable default font list is always appended to it; |
|
|
558 | option -fn. |
564 | |
559 | |
565 | 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 |
566 | optional prefix "x:" or a Xft font (Compile *xft*), prefixed with |
561 | optional prefix "x:" or a Xft font (Compile *xft*), prefixed with |
567 | "xft:". |
562 | "xft:". |
568 | |
563 | |
… | |
… | |
799 | |
794 | |
800 | imFont: *fontset* |
795 | imFont: *fontset* |
801 | Specify the font-set used for XIM styles "OverTheSpot" or |
796 | Specify the font-set used for XIM styles "OverTheSpot" or |
802 | "OffTheSpot". It must be a standard X font set (XLFD patterns |
797 | "OffTheSpot". It must be a standard X font set (XLFD patterns |
803 | separated by commas), i.e. it's not in the same format as the other |
798 | separated by commas), i.e. it's not in the same format as the other |
804 | font lists used in rxvt. The default will be set-up to chose *any* |
799 | font lists used in urxvt. The default will be set-up to chose *any* |
805 | suitable found found, preferably one or two pixels differing in size |
800 | suitable found found, preferably one or two pixels differing in size |
806 | to the base font. option -imfont. |
801 | to the base font. option -imfont. |
807 | |
802 | |
808 | tripleclickwords: *boolean* |
803 | tripleclickwords: *boolean* |
809 | Change the meaning of triple-click selection with the left mouse |
804 | Change the meaning of triple-click selection with the left mouse |
… | |
… | |
842 | option is enabled, scrolls on the secondary screen will change the |
837 | option is enabled, scrolls on the secondary screen will change the |
843 | scrollback buffer and switching to/from the secondary screen will |
838 | scrollback buffer and switching to/from the secondary screen will |
844 | instead scroll the screen up. |
839 | instead scroll the screen up. |
845 | |
840 | |
846 | hold: *bool* |
841 | hold: *bool* |
847 | 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 |
848 | not immediately destroy its window when the program executed within |
843 | not immediately destroy its window when the program executed within |
849 | it exits. Instead, it will wait till it is being killed or closed by |
844 | it exits. Instead, it will wait till it is being killed or closed by |
850 | the user. |
845 | the user. |
851 | |
846 | |
852 | keysym.*sym*: *string* |
847 | keysym.*sym*: *string* |
… | |
… | |
874 | "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, |
869 | "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, |
875 | "\000": octal number) or verbatim control characters ("^?": delete, |
870 | "\000": octal number) or verbatim control characters ("^?": delete, |
876 | "^@": null, "^A" ...) and may be enclosed with double quotes so that |
871 | "^@": null, "^A" ...) and may be enclosed with double quotes so that |
877 | it can start or end with whitespace. |
872 | it can start or end with whitespace. |
878 | |
873 | |
879 | Please note that you need to double the "\" when using |
874 | Please note that you need to double the "\" in resource files, as |
880 | "--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 |
881 | 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 |
882 | both Xt and rxvt's own processing). |
877 | processing). |
883 | |
878 | |
884 | 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 |
885 | *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter |
880 | *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter |
886 | `/' should be a character not used by the strings. |
881 | `/' should be a character not used by the strings. |
887 | |
882 | |
… | |
… | |
894 | URxvt.keysym.Meta-Control-0x61: \033<M-C-a> |
889 | URxvt.keysym.Meta-Control-0x61: \033<M-C-a> |
895 | URxvt.keysym.Meta-Control-0x62: \033<M-C-b> |
890 | URxvt.keysym.Meta-Control-0x62: \033<M-C-b> |
896 | URxvt.keysym.Meta-Control-0x63: \033<M-C-c> |
891 | URxvt.keysym.Meta-Control-0x63: \033<M-C-c> |
897 | |
892 | |
898 | If *string* takes the form of "command:STRING", the specified STRING |
893 | If *string* takes the form of "command:STRING", the specified STRING |
899 | is interpreted and executed as rxvt's control sequence. For example |
894 | is interpreted and executed as urxvt's control sequence. For example |
900 | 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 |
901 | Control-Meta-c is being pressed": |
896 | Control-Meta-c is being pressed": |
902 | |
897 | |
903 | 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 |
904 | |
899 | |
905 | If *string* takes the form "perl:STRING", then the specified STRING |
900 | If *string* takes the form "perl:STRING", then the specified STRING |
906 | is passed to the "on_keyboard_command" perl handler. See the |
901 | is passed to the "on_keyboard_command" perl handler. See the |
907 | rxvtperl(3) manpage. For example, the selection extension (activated |
902 | urxvtperl(3) manpage. For example, the selection extension |
908 | via "rxvt -pe selection") listens for "selection:rot13" events: |
903 | (activated via "urxvt -pe selection") listens for "selection:rot13" |
|
|
904 | events: |
909 | |
905 | |
910 | URxvt.keysym.M-C-c: perl:selection:rot13 |
906 | URxvt.keysym.M-C-c: perl:selection:rot13 |
911 | |
907 | |
912 | Due the the large number of modifier combinations, a defined key |
908 | Due the the large number of modifier combinations, a defined key |
913 | mapping will match if at *at least* the specified identifiers are |
909 | mapping will match if at *at least* the specified identifiers are |
… | |
… | |
915 | 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 |
916 | automatically provide definitions for "Meta-a", "Shift-a" and so on, |
912 | automatically provide definitions for "Meta-a", "Shift-a" and so on, |
917 | unless some of those are defined mappings themselves. |
913 | unless some of those are defined mappings themselves. |
918 | |
914 | |
919 | Unfortunately, this will override built-in key mappings. For example |
915 | Unfortunately, this will override built-in key mappings. For example |
920 | if you overwrite the "Insert" key you will disable rxvt's |
916 | if you overwrite the "Insert" key you will disable urxvt's |
921 | "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 |
922 | the user-defined keymap using the "builtin:" replacement: |
918 | the user-defined keymap using the "builtin:" replacement: |
923 | |
919 | |
924 | URxvt.keysym.Insert: <my insert key sequence> |
920 | URxvt.keysym.Insert: <my insert key sequence> |
925 | URxvt.keysym.S-Insert: builtin: |
921 | URxvt.keysym.S-Insert: builtin: |
… | |
… | |
933 | font-switching at runtime: |
929 | font-switching at runtime: |
934 | |
930 | |
935 | URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 |
931 | URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 |
936 | URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 |
932 | URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 |
937 | |
933 | |
938 | 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 |
939 | info): |
935 | info): |
940 | |
936 | |
941 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
937 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
942 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
938 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
943 | |
939 | |
… | |
… | |
945 | perl-ext: *string* |
941 | perl-ext: *string* |
946 | Comma-separated list(s) of perl extension scripts (default: |
942 | Comma-separated list(s) of perl extension scripts (default: |
947 | "default") to use in this terminal instance; option -pe. |
943 | "default") to use in this terminal instance; option -pe. |
948 | |
944 | |
949 | Extension names can be prefixed with a "-" sign to prohibit using |
945 | Extension names can be prefixed with a "-" sign to prohibit using |
950 | it. This can be useful to selectively disable some extensions loaded |
946 | them. This can be useful to selectively disable some extensions |
951 | by default, or specified via the "perl-ext-common" resource. For |
947 | loaded by default, or specified via the "perl-ext-common" resource. |
952 | example, "default,-selection" will use all the default extension |
948 | For example, "default,-selection" will use all the default extension |
953 | except "selection". |
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. |
954 | |
956 | |
955 | Each extension is looked up in the library directories, loaded if |
957 | Each extension is looked up in the library directories, loaded if |
956 | necessary, and bound to the current terminal instance. |
958 | necessary, and bound to the current terminal instance. |
957 | |
959 | |
958 | If both of these resources are the empty string, then the perl |
960 | If both of these resources are the empty string, then the perl |
… | |
… | |
961 | available to all instances, while perl-ext is used for specific |
963 | available to all instances, while perl-ext is used for specific |
962 | instances. |
964 | instances. |
963 | |
965 | |
964 | perl-eval: *string* |
966 | perl-eval: *string* |
965 | Perl code to be evaluated when all extensions have been registered. |
967 | Perl code to be evaluated when all extensions have been registered. |
966 | See the rxvtperl(3) manpage. |
968 | See the urxvtperl(3) manpage. Due to security reasons, this resource |
|
|
969 | will be ignored when running setuid/setgid. |
967 | |
970 | |
968 | perl-lib: *path* |
971 | perl-lib: *path* |
969 | Colon-separated list of additional directories that hold extension |
972 | Colon-separated list of additional directories that hold extension |
970 | scripts. When looking for extensions specified by the "perl" |
973 | scripts. When looking for extensions specified by the "perl" |
971 | resource, rxvt will first look in these directories and then in |
974 | resource, urxvt will first look in these directories and then in |
972 | /opt/rxvt/lib/urxvt/perl/. |
975 | /usr/local/lib/urxvt/perl/. Due to security reasons, this resource |
|
|
976 | will be ignored when running setuid/setgid. |
973 | |
977 | |
974 | 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. |
975 | |
998 | |
976 | THE SCROLLBAR |
999 | THE SCROLLBAR |
977 | 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: |
978 | saveLines) and can be scrolled back using the scrollbar or by |
1001 | saveLines) and can be scrolled back using the scrollbar or by |
979 | keystrokes. The normal rxvt scrollbar has arrows and its behaviour is |
1002 | keystrokes. The normal urxvt scrollbar has arrows and its behaviour is |
980 | fairly intuitive. The xterm-scrollbar is without arrows and its |
1003 | fairly intuitive. The xterm-scrollbar is without arrows and its |
981 | behaviour mimics that of *xterm* |
1004 | behaviour mimics that of *xterm* |
982 | |
1005 | |
983 | 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 |
984 | Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with |
1007 | Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with |
… | |
… | |
1012 | the selection, and trailing whitespace is visually underlined and |
1035 | the selection, and trailing whitespace is visually underlined and |
1013 | removed from the selection. |
1036 | removed from the selection. |
1014 | |
1037 | |
1015 | Insertion: |
1038 | Insertion: |
1016 | Pressing and releasing the Middle mouse button (or Shift-Insert) in |
1039 | Pressing and releasing the Middle mouse button (or Shift-Insert) in |
1017 | 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 |
1018 | if it had been typed on the keyboard. |
1041 | if it had been typed on the keyboard. |
1019 | |
1042 | |
1020 | CHANGING FONTS |
1043 | CHANGING FONTS |
1021 | 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 |
1022 | supported in rxvt-unicode. Bug me if you need this. |
1045 | supported in rxvt-unicode. Bug me if you need this. |
… | |
… | |
1087 | |
1110 | |
1088 | 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 |
1089 | 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. |
1090 | |
1113 | |
1091 | LOGIN STAMP |
1114 | LOGIN STAMP |
1092 | 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 |
1093 | 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 |
1094 | 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 |
1095 | setgid to root or to some other group on others. |
1118 | setgid to root or to some other group on others. |
1096 | |
1119 | |
1097 | COLORS AND GRAPHICS |
1120 | COLORS AND GRAPHICS |
1098 | In addition to the default foreground and background colours, rxvt can |
1121 | In addition to the default foreground and background colours, urxvt can |
1099 | 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 |
1100 | 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 |
1101 | names. |
1124 | names. |
1102 | |
1125 | |
1103 | color0 (black) = Black |
1126 | color0 (black) = Black |
… | |
… | |
1127 | Note that -rv ("reverseVideo: True") simulates reverse video by always |
1150 | Note that -rv ("reverseVideo: True") simulates reverse video by always |
1128 | swapping the foreground/background colours. This is in contrast to |
1151 | swapping the foreground/background colours. This is in contrast to |
1129 | *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 |
1130 | been specified. For example, |
1153 | been specified. For example, |
1131 | |
1154 | |
1132 | rxvt -fg Black -bg White -rv |
1155 | urxvt -fg Black -bg White -rv |
1133 | 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 |
1134 | on White. |
1157 | on White. |
1135 | |
1158 | |
1136 | ENVIRONMENT |
1159 | ENVIRONMENT |
1137 | rxvt sets and/or uses the following environment variables: |
1160 | urxvt sets and/or uses the following environment variables: |
1138 | |
1161 | |
1139 | TERM |
1162 | TERM |
1140 | Normally set to "rxvt-unicode", unless overwritten at configure |
1163 | Normally set to "rxvt-unicode", unless overwritten at configure |
1141 | time, via resources or on the commandline. |
1164 | time, via resources or on the commandline. |
1142 | |
1165 | |
1143 | COLORTERM |
1166 | COLORTERM |
1144 | Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled |
1167 | Either "rxvt", "rxvt-xpm", depending on wether urxvt was compiled |
1145 | with XPM support, and optionally with the added extension "-mono" to |
1168 | with XPM support, and optionally with the added extension "-mono" to |
1146 | indicate that rxvt-unicode runs on a monochrome screen. |
1169 | indicate that rxvt-unicode runs on a monochrome screen. |
1147 | |
1170 | |
1148 | COLORFGBG |
1171 | COLORFGBG |
1149 | 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 |
1150 | the colour code used as default foreground/text colour (or the |
1173 | the colour code used as default foreground/text colour (or the |
1151 | string "default" to indicate that the default-colour escape sequence |
1174 | string "default" to indicate that the default-colour escape sequence |
1152 | 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 |
1153 | colour (or the string "default"), and "xpm" is the string "default" |
1176 | colour (or the string "default"), and "xpm" is the string "default" |
1154 | if rxvt was compiled with XPM support. Libraries like "ncurses" and |
1177 | if urxvt was compiled with XPM support. Libraries like "ncurses" and |
1155 | "slang" can (and do) use this information to optimize screen output. |
1178 | "slang" can (and do) use this information to optimize screen output. |
1156 | |
1179 | |
1157 | WINDOWID |
1180 | WINDOWID |
1158 | 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 |
1159 | window, which usually has subwindows for the scrollbar, the terminal |
1182 | window, which usually has subwindows for the scrollbar, the terminal |
1160 | window and so on). |
1183 | window and so on). |
1161 | |
1184 | |
1162 | TERMINFO |
1185 | TERMINFO |
1163 | Set to the terminfo directory iff rxvt was configured with |
1186 | Set to the terminfo directory iff urxvt was configured with |
1164 | "--with-terminfo=PATH". |
1187 | "--with-terminfo=PATH". |
1165 | |
1188 | |
1166 | DISPLAY |
1189 | DISPLAY |
1167 | 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 |
1168 | display in it's child processes. |
1191 | display in it's child processes. |
1169 | |
1192 | |
1170 | SHELL |
1193 | SHELL |
1171 | 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". |
1172 | |
1195 | |
1173 | RXVTPATH |
1196 | RXVTPATH |
1174 | 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 |
1175 | files. |
1198 | files. |
1176 | |
1199 | |
1177 | PATH |
1200 | PATH |
1178 | Used in the same way as "RXVTPATH". |
1201 | Used in the same way as "RXVTPATH". |
1179 | |
1202 | |
1180 | RXVT_SOCKET |
1203 | RXVT_SOCKET |
1181 | 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). |
1182 | |
1205 | |
1183 | Default $HOME/.rxvt-unicode-*<nodename*. |
1206 | Default $HOME/.rxvt-unicode-*<nodename*. |
1184 | |
1207 | |
1185 | HOME |
1208 | HOME |
1186 | 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 |
… | |
… | |
1190 | XAPPLRESDIR |
1213 | XAPPLRESDIR |
1191 | Directory where various X resource files are being located. |
1214 | Directory where various X resource files are being located. |
1192 | |
1215 | |
1193 | XENVIRONMENT |
1216 | XENVIRONMENT |
1194 | 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 |
1195 | loaded by rxvt. |
1218 | loaded by urxvt. |
1196 | |
1219 | |
1197 | FILES |
1220 | FILES |
1198 | /usr/lib/X11/rgb.txt |
1221 | /usr/lib/X11/rgb.txt |
1199 | Color names. |
1222 | Color names. |
1200 | |
1223 | |
1201 | SEE ALSO |
1224 | SEE ALSO |
1202 | 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), |
1203 | tty(4), utmp(5) |
1226 | pty(4), tty(4), utmp(5) |
1204 | |
1227 | |
1205 | CURRENT PROJECT COORDINATOR |
1228 | CURRENT PROJECT COORDINATOR |
1206 | Project Coordinator |
1229 | Project Coordinator |
1207 | Marc A. Lehmann <rxvt-unicode@schmorp.de> |
1230 | Marc A. Lehmann <rxvt-unicode@schmorp.de> |
1208 | |
1231 | |