… | |
… | |
4 | |
4 | |
5 | SYNOPSIS |
5 | SYNOPSIS |
6 | rxvt [options] [-e command [ args ]] |
6 | rxvt [options] [-e command [ args ]] |
7 | |
7 | |
8 | DESCRIPTION |
8 | DESCRIPTION |
9 | rxvt-unicode, version 6.1, is a colour vt102 terminal emulator intended |
9 | rxvt-unicode, version 7.5, 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 | |
… | |
… | |
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 | |
88 | |
|
|
89 | -depth *bitdepth* |
|
|
90 | Compile *xft*: Attempt to find a visual with the given bit depth; |
|
|
91 | resource depth. |
|
|
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 |
93 | Turn on/off simulated reverse video; resource reverseVideo. |
97 | Turn on/off simulated reverse video; resource reverseVideo. |
… | |
… | |
96 | Turn on/off jump scrolling; resource jumpScroll. |
100 | Turn on/off jump scrolling; resource jumpScroll. |
97 | |
101 | |
98 | -ip|+ip | -tr|+tr |
102 | -ip|+ip | -tr|+tr |
99 | Turn on/off inheriting parent window's pixmap. Alternative form is |
103 | Turn on/off inheriting parent window's pixmap. Alternative form is |
100 | -tr; resource inheritPixmap. |
104 | -tr; resource inheritPixmap. |
|
|
105 | |
|
|
106 | *Please note that transparency of any kind if completely unsupported |
|
|
107 | by the author. Don't bug him with installation questions!* |
101 | |
108 | |
102 | -fade *number* |
109 | -fade *number* |
103 | Fade the text by the given percentage when focus is lost. Small |
110 | Fade the text by the given percentage when focus is lost. Small |
104 | values fade a little only, 100 completely replaces all colours by |
111 | values fade a little only, 100 completely replaces all colours by |
105 | the fade colour; resource fading. |
112 | the fade colour; resource fading. |
106 | |
113 | |
107 | -fadecolor *colour* |
114 | -fadecolor *colour* |
108 | Fade to this colour when fading is used (see -fade). The default |
115 | Fade to this colour when fading is used (see -fade). The default |
109 | colour is black. resource fadeColor. |
116 | colour is opaque black. resource fadeColor. |
110 | |
117 | |
111 | -tint *colour* |
118 | -tint *colour* |
112 | Tint the transparent background pixmap with the given colour when |
119 | Tint the transparent background pixmap with the given colour when |
113 | transparency is enabled with -tr or -ip. This only works for |
120 | transparency is enabled with -tr or -ip. This only works for |
114 | non-tiled backgrounds, currently. See also the -sh option that can |
121 | non-tiled backgrounds, currently. See also the -sh option that can |
… | |
… | |
146 | The colour of the border around the text area and between the |
153 | The colour of the border around the text area and between the |
147 | scrollbar and the text; resource borderColor. |
154 | scrollbar and the text; resource borderColor. |
148 | |
155 | |
149 | -fn *fontlist* |
156 | -fn *fontlist* |
150 | Select the fonts to be used. This is a comma separated list of font |
157 | 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 |
158 | names that are checked in order when trying to find glyphs for |
152 | characters. The first font defines the cell size for characters; |
159 | characters. The first font defines the cell size for characters; |
153 | other fonts might be smaller, but not (in general) larger. A |
160 | other fonts might be smaller, but not (in general) larger. A |
154 | (hopefully) reasonable default font list is always appended to it. |
161 | (hopefully) reasonable default font list is always appended to it. |
155 | See resource font for more details. |
162 | See resource font for more details. |
156 | |
163 | |
… | |
… | |
163 | |
170 | |
164 | See also the question "How does rxvt-unicode choose fonts?" in the |
171 | See also the question "How does rxvt-unicode choose fonts?" in the |
165 | FAQ section of rxvt(7). |
172 | FAQ section of rxvt(7). |
166 | |
173 | |
167 | -fb *fontlist* |
174 | -fb *fontlist* |
168 | Compile font-styles: The bold font list to use when bold characters |
175 | Compile *font-styles*: The bold font list to use when bold |
169 | are to be printed. See resource boldFont for details. |
176 | characters are to be printed. See resource boldFont for details. |
170 | |
177 | |
171 | -fi *fontlist* |
178 | -fi *fontlist* |
172 | Compile font-styles: The italic font list to use when bold |
179 | Compile *font-styles*: The italic font list to use when *italic* |
173 | characters are to be printed. See resource italicFont for details. |
180 | characters are to be printed. See resource italicFont for details. |
174 | |
181 | |
175 | -fbi *fontlist* |
182 | -fbi *fontlist* |
176 | Compile font-styles: The bold italic font list to use when bold |
183 | Compile *font-styles*: The bold italic font list to use when *bold |
177 | characters are to be printed. See resource boldItalicFont for |
184 | italic* characters are to be printed. See resource boldItalicFont |
|
|
185 | for details. |
|
|
186 | |
|
|
187 | -is|+is |
|
|
188 | Compile *font-styles*: Bold/Italic font styles imply high intensity |
|
|
189 | foreground/background (default). See resource intensityStyles for |
178 | details. |
190 | details. |
179 | |
191 | |
180 | -name *name* |
192 | -name *name* |
181 | Specify the application name under which resources are to be |
193 | Specify the application name under which resources are to be |
182 | obtained, rather than the default executable file name. Name should |
194 | obtained, rather than the default executable file name. Name should |
… | |
… | |
246 | externalBorder. |
258 | externalBorder. |
247 | |
259 | |
248 | -bl Compile *frills*: Set MWM hints to request a borderless window, i.e. |
260 | -bl Compile *frills*: Set MWM hints to request a borderless window, i.e. |
249 | if honoured by the WM, the rxvt-unicode window will not have window |
261 | if honoured by the WM, the rxvt-unicode window will not have window |
250 | decorations; resource borderLess. |
262 | decorations; resource borderLess. |
|
|
263 | |
|
|
264 | -override-redirect |
|
|
265 | Compile *frills*: Sets override-redirect on the window; resource |
|
|
266 | override-redirect. |
|
|
267 | |
|
|
268 | -sbg |
|
|
269 | Compile *frills*: Disable the usage of the built-in block |
|
|
270 | graphics/line drawing characters and just rely on what the specified |
|
|
271 | fonts provide. Use this if you have a good font and want to use its |
|
|
272 | block graphic glyphs; resource skipBuiltinGlyphs. |
251 | |
273 | |
252 | -lsp *number* |
274 | -lsp *number* |
253 | Compile *frills*: Lines (pixel height) to insert between each row of |
275 | Compile *frills*: Lines (pixel height) to insert between each row of |
254 | the display. Useful to work around font rendering problems; resource |
276 | the display. Useful to work around font rendering problems; resource |
255 | linespace. |
277 | linespace. |
… | |
… | |
360 | $rxvt->signal_connect_after (realize => sub { |
382 | $rxvt->signal_connect_after (realize => sub { |
361 | my $xid = $_[0]->window->get_xid; |
383 | my $xid = $_[0]->window->get_xid; |
362 | system "rxvt -embed $xid &"; |
384 | system "rxvt -embed $xid &"; |
363 | }); |
385 | }); |
364 | |
386 | |
365 | -pty-fd *fileno* |
387 | -pty-fd *file descriptor* |
366 | Tells rxvt NOT to execute any commands or create a new pty/tty pair |
388 | Tells rxvt NOT to execute any commands or create a new pty/tty pair |
367 | but instead use the given filehandle as the tty master. This is |
389 | but instead use the given filehandle as the tty master. This is |
368 | useful if you want to drive rxvt as a generic terminal emulator |
390 | useful if you want to drive rxvt as a generic terminal emulator |
369 | without having to run a program within it. |
391 | without having to run a program within it. |
370 | |
392 | |
371 | If this switch is given, rxvt will not create any utmp/wtmp entries |
393 | If this switch is given, rxvt will not create any utmp/wtmp entries |
372 | and will not tinker with pty/tty permissions - you have to do that |
394 | and will not tinker with pty/tty permissions - you have to do that |
373 | yourself if you want that. |
395 | yourself if you want that. |
374 | |
396 | |
|
|
397 | As an extremely special case, specifying -1 will completely suppress |
|
|
398 | pty/tty operations. |
|
|
399 | |
375 | Here is a example in perl that illustrates how this option can be |
400 | Here is a example in perl that illustrates how this option can be |
376 | used (a longer example is in doc/pty-fd): |
401 | used (a longer example is in doc/pty-fd): |
377 | |
402 | |
378 | use IO::Pty; |
403 | use IO::Pty; |
379 | use Fcntl; |
404 | use Fcntl; |
… | |
… | |
385 | |
410 | |
386 | # now communicate with rxvt |
411 | # now communicate with rxvt |
387 | my $slave = $pty->slave; |
412 | my $slave = $pty->slave; |
388 | while (<$slave>) { print $slave "got <$_>\n" } |
413 | while (<$slave>) { print $slave "got <$_>\n" } |
389 | |
414 | |
|
|
415 | -pe *string* |
|
|
416 | Comma-separated list of perl extension scripts to use (or not to |
|
|
417 | use) in this terminal instance. See resource perl-ext for details. |
|
|
418 | |
390 | RESOURCES (available also as long-options) |
419 | RESOURCES (available also as long-options) |
391 | Note: `rxvt --help' gives a list of all resources (long options) |
420 | Note: `rxvt --help' gives a list of all resources (long options) |
392 | compiled into your version. |
421 | compiled into your version. |
393 | |
422 | |
394 | There are two different methods that rxvt can use to get the Xresource |
|
|
395 | data: using the X libraries (Xrm*-functions) or internal Xresources |
|
|
396 | reader (~/.Xdefaults). For the first method (ie. rxvt -h lists |
|
|
397 | XGetDefaults), you can set and change the resources using X11 tools like |
423 | You can set and change the resources using X11 tools like xrdb. Many |
398 | xrdb. Many distribution do also load settings from the ~/.Xresources |
424 | distribution do also load settings from the ~/.Xresources file when X |
399 | file when X starts. rxvt will consult the following files/resources in |
425 | starts. rxvt will consult the following files/resources in order, with |
400 | order, with later settings overwriting earlier ones: |
426 | later settings overwriting earlier ones: |
401 | |
427 | |
402 | 1. system-wide app-defaults file, either locale-dependent OR global |
428 | 1. system-wide app-defaults file, either locale-dependent OR global |
403 | 2. app-defaults file in $XAPPLRESDIR |
429 | 2. app-defaults file in $XAPPLRESDIR |
404 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
430 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
405 | 4. SCREEN_RESOURCES for the current screen |
431 | 4. SCREEN_RESOURCES for the current screen |
406 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
432 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
407 | |
433 | |
408 | If compiled with internal Xresources support (i.e. rxvt -h lists |
434 | Note that when reading X resources, rxvt recognizes two class names: |
409 | .Xdefaults) then rxvt accepts application defaults set in |
435 | Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt |
410 | XAPPLOADDIR/URxvt (compile-time defined: usually |
436 | and the original *rxvt* to be easily configured, while the class name |
411 | /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or |
437 | URxvt allows resources unique to rxvt, to be shared between different |
412 | ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X |
|
|
413 | resources, rxvt recognizes two class names: XTerm and URxvt. The class |
|
|
414 | name Rxvt allows resources common to both rxvt and the original *rxvt* |
|
|
415 | to be easily configured, while the class name URxvt allows resources |
|
|
416 | unique to rxvt, notably colours and key-handling, to be shared between |
|
|
417 | different rxvt configurations. If no resources are specified, suitable |
438 | rxvt configurations. If no resources are specified, suitable defaults |
418 | defaults will be used. Command-line arguments can be used to override |
439 | will be used. Command-line arguments can be used to override resource |
419 | resource settings. The following resources are allowed: |
440 | settings. The following resources are supported (you might want to check |
|
|
441 | the rxvtperl(3) manpage for additional settings by perl extensions not |
|
|
442 | documented here): |
|
|
443 | |
|
|
444 | depth: *bitdepth* |
|
|
445 | Compile *xft*: Attempt to find a visual with the given bit depth; |
|
|
446 | option -depth. |
420 | |
447 | |
421 | geometry: *geom* |
448 | geometry: *geom* |
422 | Create the window with the specified X window geometry [default |
449 | Create the window with the specified X window geometry [default |
423 | 80x24]; option -geometry. |
450 | 80x24]; option -geometry. |
424 | |
451 | |
… | |
… | |
485 | |
512 | |
486 | inheritPixmap: *boolean* |
513 | inheritPixmap: *boolean* |
487 | True: make the background inherit the parent windows' pixmap, giving |
514 | True: make the background inherit the parent windows' pixmap, giving |
488 | artificial transparency. False: do not inherit the parent windows' |
515 | artificial transparency. False: do not inherit the parent windows' |
489 | pixmap. |
516 | pixmap. |
|
|
517 | |
|
|
518 | *Please note that transparency of any kind if completely unsupported |
|
|
519 | by the author. Don't bug him with installation questions!* |
490 | |
520 | |
491 | fading: *number* |
521 | fading: *number* |
492 | Fade the text by the given percentage when focus is lost; option |
522 | Fade the text by the given percentage when focus is lost; option |
493 | -fade. |
523 | -fade. |
494 | |
524 | |
… | |
… | |
524 | scale of 1 displays the image without any scaling. A scale of 2 to 9 |
554 | scale of 1 displays the image without any scaling. A scale of 2 to 9 |
525 | specifies an integer number of images in that direction. No image |
555 | specifies an integer number of images in that direction. No image |
526 | will be magnified beyond 10 times its original size. The maximum |
556 | will be magnified beyond 10 times its original size. The maximum |
527 | permitted scale is 1000. [default 0x0+50+50] |
557 | permitted scale is 1000. [default 0x0+50+50] |
528 | |
558 | |
529 | menu: *file[;tag]* |
|
|
530 | Read in the specified menu file (note the `.menu' extension is |
|
|
531 | optional) and also optionally specify a starting tag to find. See |
|
|
532 | the reference documentation for details on the syntax for the |
|
|
533 | menuBar. |
|
|
534 | |
|
|
535 | path: *path* |
559 | path: *path* |
536 | Specify the colon-delimited search path for finding files (XPM and |
560 | Specify the colon-delimited search path for finding XPM files. |
537 | menus), in addition to the paths specified by the RXVTPATH and PATH |
|
|
538 | environment variables. |
|
|
539 | |
561 | |
540 | font: *fontlist* |
562 | font: *fontlist* |
541 | Select the fonts to be used. This is a comma separated list of font |
563 | Select the fonts to be used. This is a comma separated list of font |
542 | names that are used in turn when trying to display Unicode |
564 | names that are checked in order when trying to find glyphs for |
543 | characters. The first font defines the cell size for characters; |
565 | characters. The first font defines the cell size for characters; |
544 | other fonts might be smaller, but not larger. A reasonable default |
566 | other fonts might be smaller, but not (in general) larger. A |
545 | font list is always appended to it. option -fn. |
567 | (hopefully) reasonable default font list is always appended to it; |
|
|
568 | option -fn. |
546 | |
569 | |
547 | Each font can either be a standard X11 core font (XLFD) name, with |
570 | Each font can either be a standard X11 core font (XLFD) name, with |
548 | optional prefix "x:" or a Xft font (Compile *xft*), prefixed with |
571 | optional prefix "x:" or a Xft font (Compile *xft*), prefixed with |
549 | "xft:". |
572 | "xft:". |
550 | |
573 | |
… | |
… | |
553 | available hint currently is "codeset=codeset-name", and this is only |
576 | available hint currently is "codeset=codeset-name", and this is only |
554 | used for Xft fonts. |
577 | used for Xft fonts. |
555 | |
578 | |
556 | For example, this font resource |
579 | For example, this font resource |
557 | |
580 | |
558 | URxvt*font: 9x15bold,\ |
581 | URxvt.font: 9x15bold,\ |
559 | -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ |
582 | -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ |
560 | -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ |
583 | -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ |
561 | [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ |
584 | [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ |
562 | xft:Code2000:antialias=false |
585 | xft:Code2000:antialias=false |
563 | |
586 | |
… | |
… | |
596 | tried. |
619 | tried. |
597 | |
620 | |
598 | If set, but empty, then this specific style is disabled and the |
621 | If set, but empty, then this specific style is disabled and the |
599 | normal text font will being used for the given style. |
622 | normal text font will being used for the given style. |
600 | |
623 | |
|
|
624 | intensityStyles: *boolean* |
|
|
625 | When font styles are not enabled, or this option is enabled (True, |
|
|
626 | option -is, the default), bold and italic font styles imply high |
|
|
627 | intensity foreground/backround colours. Disabling this option |
|
|
628 | (False, option +is) disables this behaviour, the high intensity |
|
|
629 | colours are not reachable. |
|
|
630 | |
601 | selectstyle: *mode* |
631 | selectstyle: *mode* |
602 | Set mouse selection style to old which is 2.20, oldword which is |
632 | Set mouse selection style to old which is 2.20, oldword which is |
603 | xterm style with 2.20 old word selection, or anything else which |
633 | xterm style with 2.20 old word selection, or anything else which |
604 | gives xterm style selection. |
634 | gives xterm style selection. |
605 | |
635 | |
… | |
… | |
642 | |
672 | |
643 | The string will be interpreted as if typed into the shell as-is. |
673 | The string will be interpreted as if typed into the shell as-is. |
644 | |
674 | |
645 | Example: |
675 | Example: |
646 | |
676 | |
647 | URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
677 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
648 | |
678 | |
649 | This creates a new file in your home directory with the screen |
679 | This creates a new file in your home directory with the screen |
650 | contents everytime you hit "Print". |
680 | contents everytime you hit "Print". |
651 | |
681 | |
652 | scrollBar: *boolean* |
682 | scrollBar: *boolean* |
… | |
… | |
695 | borderLess: *boolean* |
725 | borderLess: *boolean* |
696 | Set MWM hints to request a borderless window, i.e. if honoured by |
726 | Set MWM hints to request a borderless window, i.e. if honoured by |
697 | the WM, the rxvt-unicode window will not have window decorations; |
727 | the WM, the rxvt-unicode window will not have window decorations; |
698 | option -bl. |
728 | option -bl. |
699 | |
729 | |
|
|
730 | skipBuiltinGlyphs: *boolean* |
|
|
731 | Compile *frills*: Disable the usage of the built-in block |
|
|
732 | graphics/line drawing characters and just rely on what the specified |
|
|
733 | fonts provide. Use this if you have a good font and want to use its |
|
|
734 | block graphic glyphs; option -sbg. |
|
|
735 | |
700 | termName: *termname* |
736 | termName: *termname* |
701 | Specifies the terminal type name to be set in the TERM environment |
737 | Specifies the terminal type name to be set in the TERM environment |
702 | variable; option -tn. |
738 | variable; option -tn. |
703 | |
739 | |
704 | linespace: *number* |
740 | linespace: *number* |
… | |
… | |
747 | The string to send when the delete key (not the keypad delete key) |
783 | The string to send when the delete key (not the keypad delete key) |
748 | is pressed. If unset it will send the sequence traditionally |
784 | is pressed. If unset it will send the sequence traditionally |
749 | associated with the Execute key. |
785 | associated with the Execute key. |
750 | |
786 | |
751 | cutchars: *string* |
787 | cutchars: *string* |
752 | The characters used as delimiters for double-click word selection. |
788 | The characters used as delimiters for double-click word selection |
753 | The built-in default: |
789 | (whitespace delimiting is added automatically if resource is given). |
|
|
790 | |
|
|
791 | When the selection extension is in use (the default if compiled in, |
|
|
792 | see the rxvtperl(3) manpage), a suitable regex using these |
|
|
793 | characters will be created (if the resource exists, otherwise, no |
|
|
794 | regex will be created). In this mode, characters outside ISO-8859-1 |
|
|
795 | can be used. |
|
|
796 | |
|
|
797 | When the selection extension is not used, only ISO-8859-1 characters |
|
|
798 | can be used. If not specified, the built-in default is used: |
754 | |
799 | |
755 | BACKSLASH `"'&()*,;<=>?@[]{|} |
800 | BACKSLASH `"'&()*,;<=>?@[]{|} |
756 | |
801 | |
757 | preeditType: *style* |
802 | preeditType: *style* |
758 | OverTheSpot, OffTheSpot, Root; option -pt. |
803 | OverTheSpot, OffTheSpot, Root; option -pt. |
… | |
… | |
762 | |
807 | |
763 | imLocale: *name* |
808 | imLocale: *name* |
764 | The locale to use for opening the IM. You can use an "LC_CTYPE" of |
809 | The locale to use for opening the IM. You can use an "LC_CTYPE" of |
765 | e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for |
810 | e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for |
766 | the input extension to be able to input japanese characters while |
811 | the input extension to be able to input japanese characters while |
767 | staying in another locale. option -imlocale. |
812 | staying in another locale; option -imlocale. |
768 | |
813 | |
769 | imFont: *fontset* |
814 | imFont: *fontset* |
770 | Specify the font-set used for XIM styles "OverTheSpot" or |
815 | Specify the font-set used for XIM styles "OverTheSpot" or |
771 | "OffTheSpot". It must be a standard X font set (XLFD patterns |
816 | "OffTheSpot". It must be a standard X font set (XLFD patterns |
772 | separated by commas), i.e. it's not in the same format as the other |
817 | separated by commas), i.e. it's not in the same format as the other |
… | |
… | |
775 | to the base font. option -imfont. |
820 | to the base font. option -imfont. |
776 | |
821 | |
777 | tripleclickwords: *boolean* |
822 | tripleclickwords: *boolean* |
778 | Change the meaning of triple-click selection with the left mouse |
823 | Change the meaning of triple-click selection with the left mouse |
779 | button. Instead of selecting a full line it will extend the |
824 | button. Instead of selecting a full line it will extend the |
780 | selection to the end of the logical line only. option -tcw. |
825 | selection to the end of the logical line only; option -tcw. |
781 | |
826 | |
782 | insecure: *boolean* |
827 | insecure: *boolean* |
783 | Enables "insecure" mode. Rxvt-unicode offers some escape sequences |
828 | Enables "insecure" mode. Rxvt-unicode offers some escape sequences |
784 | that echo arbitrary strings like the icon name or the locale. This |
829 | that echo arbitrary strings like the icon name or the locale. This |
785 | could be abused if somebody gets 8-bit-clean access to your display, |
830 | could be abused if somebody gets 8-bit-clean access to your display, |
… | |
… | |
789 | xterm, have these sequences enabled by default, which doesn't make |
834 | xterm, have these sequences enabled by default, which doesn't make |
790 | it safer, though). |
835 | it safer, though). |
791 | |
836 | |
792 | You can enable them by setting this boolean resource or specifying |
837 | You can enable them by setting this boolean resource or specifying |
793 | -insecure as an option. At the moment, this enables display-answer, |
838 | -insecure as an option. At the moment, this enables display-answer, |
794 | locale, findfont, icon label and window title requests as well as |
839 | locale, findfont, icon label and window title requests. |
795 | dynamic menubar dispatch. |
|
|
796 | |
840 | |
797 | modifier: *modifier* |
841 | modifier: *modifier* |
798 | Set the key to be interpreted as the Meta key to: alt, meta, hyper, |
842 | Set the key to be interpreted as the Meta key to: alt, meta, hyper, |
799 | super, mod1, mod2, mod3, mod4, mod5; option -mod. |
843 | super, mod1, mod2, mod3, mod4, mod5; option -mod. |
800 | |
844 | |
801 | answerbackString: *string* |
845 | answerbackString: *string* |
802 | Specify the reply rxvt-unicode sends to the shell when an ENQ |
846 | Specify the reply rxvt-unicode sends to the shell when an ENQ |
803 | (control-E) character is passed through. It may contain escape |
847 | (control-E) character is passed through. It may contain escape |
804 | values as described in the entry on keysym following. |
848 | values as described in the entry on keysym following. |
805 | |
849 | |
806 | secondaryScreen: *bool* |
850 | secondaryScreen: *boolean* |
807 | Turn on/off secondary screen (default enabled). |
851 | Turn on/off secondary screen (default enabled). |
808 | |
852 | |
809 | secondaryScroll: *bool* |
853 | secondaryScroll: *boolean* |
810 | Turn on/off secondary screen scroll (default enabled). If the this |
854 | Turn on/off secondary screen scroll (default enabled). If the this |
811 | option is enabled, scrolls on the secondary screen will change the |
855 | option is enabled, scrolls on the secondary screen will change the |
812 | scrollback buffer and switching to/from the secondary screen will |
856 | scrollback buffer and switching to/from the secondary screen will |
813 | instead scroll the screen up. |
857 | instead scroll the screen up. |
814 | |
858 | |
815 | hold: *bool* |
859 | hold: *boolean* |
816 | Turn on/off hold window after exit support. If enabled, rxvt will |
860 | Turn on/off hold window after exit support. If enabled, rxvt will |
817 | not immediately destroy its window when the program executed within |
861 | not immediately destroy its window when the program executed within |
818 | it exits. Instead, it will wait till it is being killed or closed by |
862 | it exits. Instead, it will wait till it is being killed or closed by |
819 | the user. |
863 | the user. |
820 | |
864 | |
… | |
… | |
843 | "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, |
887 | "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, |
844 | "\000": octal number) or verbatim control characters ("^?": delete, |
888 | "\000": octal number) or verbatim control characters ("^?": delete, |
845 | "^@": null, "^A" ...) and may be enclosed with double quotes so that |
889 | "^@": null, "^A" ...) and may be enclosed with double quotes so that |
846 | it can start or end with whitespace. |
890 | it can start or end with whitespace. |
847 | |
891 | |
848 | Please note that you need to double the "\" when using |
892 | Please note that you need to double the "\" in resource files, as |
849 | "--enable-xgetdefault", as X itself does it's own de-escaping (you |
893 | Xlib itself does it's own de-escaping (you can use "\033" instead of |
850 | can use "\033" instead of "\e" (and so on), which will work with |
894 | "\e" (and so on), which will work with both Xt and rxvt's own |
851 | both Xt and rxvt's own processing). |
895 | processing). |
852 | |
896 | |
853 | You can define a range of keysyms in one shot by providing a |
897 | You can define a range of keysyms in one shot by providing a |
854 | *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter |
898 | *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter |
855 | `/' should be a character not used by the strings. |
899 | `/' should be a character not used by the strings. |
856 | |
900 | |
… | |
… | |
868 | is interpreted and executed as rxvt's control sequence. For example |
912 | is interpreted and executed as rxvt's control sequence. For example |
869 | the following means "change the current locale to "zh_CN.GBK" when |
913 | the following means "change the current locale to "zh_CN.GBK" when |
870 | Control-Meta-c is being pressed": |
914 | Control-Meta-c is being pressed": |
871 | |
915 | |
872 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
916 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
|
|
917 | |
|
|
918 | If *string* takes the form "perl:STRING", then the specified STRING |
|
|
919 | is passed to the "on_keyboard_command" perl handler. See the |
|
|
920 | rxvtperl(3) manpage. For example, the selection extension (activated |
|
|
921 | via "rxvt -pe selection") listens for "selection:rot13" events: |
|
|
922 | |
|
|
923 | URxvt.keysym.M-C-c: perl:selection:rot13 |
873 | |
924 | |
874 | Due the the large number of modifier combinations, a defined key |
925 | Due the the large number of modifier combinations, a defined key |
875 | mapping will match if at *at least* the specified identifiers are |
926 | mapping will match if at *at least* the specified identifiers are |
876 | being set, and no other key mappings with those and more bits are |
927 | being set, and no other key mappings with those and more bits are |
877 | being defined. That means that defining a key map for "a" will |
928 | being defined. That means that defining a key map for "a" will |
… | |
… | |
901 | info): |
952 | info): |
902 | |
953 | |
903 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
954 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
904 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
955 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
905 | |
956 | |
|
|
957 | perl-ext-common: *string* |
|
|
958 | perl-ext: *string* |
|
|
959 | Comma-separated list(s) of perl extension scripts (default: |
|
|
960 | "default") to use in this terminal instance; option -pe. |
|
|
961 | |
|
|
962 | Extension names can be prefixed with a "-" sign to prohibit using |
|
|
963 | them. This can be useful to selectively disable some extensions |
|
|
964 | loaded by default, or specified via the "perl-ext-common" resource. |
|
|
965 | For example, "default,-selection" will use all the default extension |
|
|
966 | except "selection". |
|
|
967 | |
|
|
968 | Extension names can also be followed by an argument in angle |
|
|
969 | brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey |
|
|
970 | for searchable scorllback to Alt/Meta-s). Mentioning the same |
|
|
971 | extension multiple times with different arguments will pass multiple |
|
|
972 | arguments to the extension. |
|
|
973 | |
|
|
974 | Each extension is looked up in the library directories, loaded if |
|
|
975 | necessary, and bound to the current terminal instance. |
|
|
976 | |
|
|
977 | If both of these resources are the empty string, then the perl |
|
|
978 | interpreter will not be initialized. The idea behind two options is |
|
|
979 | that perl-ext-common will be used for extensions that should be |
|
|
980 | available to all instances, while perl-ext is used for specific |
|
|
981 | instances. |
|
|
982 | |
|
|
983 | perl-eval: *string* |
|
|
984 | Perl code to be evaluated when all extensions have been registered. |
|
|
985 | See the rxvtperl(3) manpage. Due to security reasons, this resource |
|
|
986 | will be ignored when running setuid/setgid. |
|
|
987 | |
|
|
988 | perl-lib: *path* |
|
|
989 | Colon-separated list of additional directories that hold extension |
|
|
990 | scripts. When looking for extensions specified by the "perl" |
|
|
991 | resource, rxvt will first look in these directories and then in |
|
|
992 | /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource |
|
|
993 | will be ignored when running setuid/setgid. |
|
|
994 | |
|
|
995 | See the rxvtperl(3) manpage. |
|
|
996 | |
|
|
997 | selection.pattern-*idx*: *perl-regex* |
|
|
998 | Additional selection patterns, see the rxvtperl(3) manpage for |
|
|
999 | details. |
|
|
1000 | |
|
|
1001 | selection-autotransform.*idx*: *perl-transform* |
|
|
1002 | Selection auto-transform patterns, see the rxvtperl(3) manpage for |
|
|
1003 | details. |
|
|
1004 | |
|
|
1005 | searchable-scrollback: *keysym* |
|
|
1006 | Sets the hotkey that starts the incremental scrollback buffer search |
|
|
1007 | (default: "M-s"). |
|
|
1008 | |
|
|
1009 | urlLauncher: *string* |
|
|
1010 | Specifies the program to be started with a URL argument. Used by the |
|
|
1011 | "selection-popup" and "mark-urls" perl extensions. |
|
|
1012 | |
|
|
1013 | transient-for: *windowid* |
|
|
1014 | Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given |
|
|
1015 | window id. |
|
|
1016 | |
|
|
1017 | override-redirect: *boolean* |
|
|
1018 | Compile *frills*: Sets override-redirect for the terminal window, |
|
|
1019 | making it almost invisible to window managers; option |
|
|
1020 | -override-redirect. |
|
|
1021 | |
906 | THE SCROLLBAR |
1022 | THE SCROLLBAR |
907 | Lines of text that scroll off the top of the rxvt window (resource: |
1023 | Lines of text that scroll off the top of the rxvt window (resource: |
908 | saveLines) and can be scrolled back using the scrollbar or by |
1024 | saveLines) and can be scrolled back using the scrollbar or by |
909 | keystrokes. The normal rxvt scrollbar has arrows and its behaviour is |
1025 | keystrokes. The normal rxvt scrollbar has arrows and its behaviour is |
910 | fairly intuitive. The xterm-scrollbar is without arrows and its |
1026 | fairly intuitive. The xterm-scrollbar is without arrows and its |
… | |
… | |
941 | normal one. In this mode, every selected row becomes its own line in |
1057 | normal one. In this mode, every selected row becomes its own line in |
942 | the selection, and trailing whitespace is visually underlined and |
1058 | the selection, and trailing whitespace is visually underlined and |
943 | removed from the selection. |
1059 | removed from the selection. |
944 | |
1060 | |
945 | Insertion: |
1061 | Insertion: |
946 | Pressing and releasing the Middle mouse button (or Shift-Insert) in |
1062 | Pressing and releasing the Middle mouse button in an rxvt window |
947 | an rxvt window causes the current text selection to be inserted as |
1063 | causes the value of the PRIMARY selection (or CLIPBOARD with the |
948 | if it had been typed on the keyboard. |
1064 | Meta modifier) to be inserted as if it had been typed on the |
|
|
1065 | keyboard. |
|
|
1066 | |
|
|
1067 | Pressing Shift-Insert causes the value of the PRIMARY selection to |
|
|
1068 | be inserted too. |
949 | |
1069 | |
950 | CHANGING FONTS |
1070 | CHANGING FONTS |
951 | Changing fonts (or font sizes, respectively) via the keypad is not yet |
1071 | Changing fonts (or font sizes, respectively) via the keypad is not yet |
952 | supported in rxvt-unicode. Bug me if you need this. |
1072 | supported in rxvt-unicode. Bug me if you need this. |
953 | |
1073 | |
954 | You can, however, switch fonts at runtime using escape sequences (and |
1074 | You can, however, switch fonts at runtime using escape sequences, e.g.: |
955 | therefore using the menubar), e.g.: |
|
|
956 | |
1075 | |
957 | printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" |
1076 | printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" |
|
|
1077 | |
|
|
1078 | You can use keyboard shortcuts, too: |
|
|
1079 | |
|
|
1080 | URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007 |
|
|
1081 | URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007 |
958 | |
1082 | |
959 | rxvt-unicode will automatically re-apply these fonts to the output so |
1083 | rxvt-unicode will automatically re-apply these fonts to the output so |
960 | far. |
1084 | far. |
961 | |
1085 | |
962 | ISO 14755 SUPPORT |
1086 | ISO 14755 SUPPORT |
… | |
… | |
1025 | setgid to root or to some other group on others. |
1149 | setgid to root or to some other group on others. |
1026 | |
1150 | |
1027 | COLORS AND GRAPHICS |
1151 | COLORS AND GRAPHICS |
1028 | In addition to the default foreground and background colours, rxvt can |
1152 | In addition to the default foreground and background colours, rxvt can |
1029 | display up to 16 colours (8 ANSI colours plus high-intensity bold/blink |
1153 | display up to 16 colours (8 ANSI colours plus high-intensity bold/blink |
1030 | versions of the same). Here is a list of the colours with their rgb.txt |
1154 | versions of the same). Here is a list of the colours with their names. |
1031 | names. |
|
|
1032 | |
1155 | |
1033 | color0 (black) = Black |
1156 | color0 (black) = Black |
1034 | color1 (red) = Red3 |
1157 | color1 (red) = Red3 |
1035 | color2 (green) = Green3 |
1158 | color2 (green) = Green3 |
1036 | color3 (yellow) = Yellow3 |
1159 | color3 (yellow) = Yellow3 |
… | |
… | |
1052 | It is also possible to specify the colour values of foreground, |
1175 | It is also possible to specify the colour values of foreground, |
1053 | background, cursorColor, cursorColor2, colorBD, colorUL as a number |
1176 | background, cursorColor, cursorColor2, colorBD, colorUL as a number |
1054 | 0-15, as a convenient shorthand to reference the colour name of |
1177 | 0-15, as a convenient shorthand to reference the colour name of |
1055 | color0-color15. |
1178 | color0-color15. |
1056 | |
1179 | |
|
|
1180 | In addition to the colours defined above, rxvt offers an additional 72 |
|
|
1181 | colours. The first 64 of those (with indices 16 to 79) consist of a |
|
|
1182 | 4*4*4 RGB colour cube (i.e. *index = r * 16 + g * 4 + b + 16*), followed |
|
|
1183 | by 8 additional shades of gray (with indices 80 to 87). |
|
|
1184 | |
|
|
1185 | Together, all those colours implement the 88 colour xterm colours. Only |
|
|
1186 | the first 16 can be changed using resources currently, the rest can only |
|
|
1187 | be changed via command sequences ("escape codes"). |
|
|
1188 | |
1057 | Note that -rv ("reverseVideo: True") simulates reverse video by always |
1189 | Note that -rv ("reverseVideo: True") simulates reverse video by always |
1058 | swapping the foreground/background colours. This is in contrast to |
1190 | swapping the foreground/background colours. This is in contrast to |
1059 | *xterm*(1) where the colours are only swapped if they have not otherwise |
1191 | *xterm*(1) where the colours are only swapped if they have not otherwise |
1060 | been specified. For example, |
1192 | been specified. For example, |
1061 | |
1193 | |
1062 | rxvt -fg Black -bg White -rv |
1194 | rxvt -fg Black -bg White -rv |
1063 | would yield White on Black, while on *xterm*(1) it would yield Black |
1195 | would yield White on Black, while on *xterm*(1) it would yield Black |
1064 | on White. |
1196 | on White. |
|
|
1197 | |
|
|
1198 | ALPHA CHANNEL SUPPORT |
|
|
1199 | If Xft support has been compiled in and as long as Xft/Xrender/X don't |
|
|
1200 | get their act together, rxvt-unicode will support |
|
|
1201 | "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4 |
|
|
1202 | digits/component) colour specifications, in addition to the ones |
|
|
1203 | provided by X, where the additional A component specifies opacity |
|
|
1204 | (alpha) values. The minimum value of 0 is completely transparent). You |
|
|
1205 | can also prefix any color with "[a]", where "a" is on to four hex digits |
|
|
1206 | specifiying the opacity value. |
|
|
1207 | |
|
|
1208 | You probably need to specify "-depth 32", too, and have the luck that |
|
|
1209 | your X-server uses ARGB pixel layout, as X is far from just supporting |
|
|
1210 | ARGB visuals out of the box, and rxvt-unicode just fudges around. |
|
|
1211 | |
|
|
1212 | For example, the following selects an almost completely transparent red |
|
|
1213 | background, and an almost opaque pink foreground: |
|
|
1214 | |
|
|
1215 | rxvt -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink" |
|
|
1216 | |
|
|
1217 | *Please note that transparency of any kind if completely unsupported by |
|
|
1218 | the author. Don't bug him with installation questions!* |
1065 | |
1219 | |
1066 | ENVIRONMENT |
1220 | ENVIRONMENT |
1067 | rxvt sets and/or uses the following environment variables: |
1221 | rxvt sets and/or uses the following environment variables: |
1068 | |
1222 | |
1069 | TERM |
1223 | TERM |
… | |
… | |
1098 | display in it's child processes. |
1252 | display in it's child processes. |
1099 | |
1253 | |
1100 | SHELL |
1254 | SHELL |
1101 | The shell to be used for command execution, defaults to "/bin/sh". |
1255 | The shell to be used for command execution, defaults to "/bin/sh". |
1102 | |
1256 | |
1103 | RXVTPATH |
|
|
1104 | The path where rxvt looks for support files such as menu and xpm |
|
|
1105 | files. |
|
|
1106 | |
|
|
1107 | PATH |
|
|
1108 | Used in the same way as "RXVTPATH". |
|
|
1109 | |
|
|
1110 | RXVT_SOCKET |
1257 | RXVT_SOCKET |
1111 | The unix domain socket path used by rxvtc(1) and rxvtd(1). |
1258 | The unix domain socket path used by rxvtc(1) and rxvtd(1). |
1112 | |
1259 | |
1113 | Default $HOME/.rxvt-unicode-*<nodename*. |
1260 | Default $HOME/.rxvt-unicode-*<nodename*. |
1114 | |
1261 | |
… | |
… | |
1155 | |
1302 | |
1156 | Oezguer Kesim <kesim@math.fu-berlin.de> |
1303 | Oezguer Kesim <kesim@math.fu-berlin.de> |
1157 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1304 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1158 | |
1305 | |
1159 | Geoff Wing <gcw@pobox.com> |
1306 | Geoff Wing <gcw@pobox.com> |
1160 | Rewrote screen display and text selection routines. Project |
1307 | Rewrote screen display and text selection routines. |
|
|
1308 | |
1161 | Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1309 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1162 | |
1310 | |
1163 | Marc Alexander Lehmann <rxvt-unicode@schmorp.de> |
1311 | Marc Alexander Lehmann <rxvt-unicode@schmorp.de> |
1164 | Forked rxvt-unicode, rewrote most of the display code and internal |
1312 | Forked rxvt-unicode, unicode support, rewrote almost all the code, |
1165 | character handling to store text in unicode, improve xterm |
1313 | perl extension, random hacks, numerous bugfixes and extensions. |
1166 | compatibility and apply numerous other bugfixes and extensions. |
|
|
1167 | |
1314 | |
1168 | Project Coordinator (Changes 1.0 -) |
1315 | Project Coordinator (Changes 1.0 -) |
1169 | |
1316 | |
|
|
1317 | Emanuele Giaquinta <e.giaquinta@glauco.it> |
|
|
1318 | Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. |
|
|
1319 | |