… | |
… | |
105 | |
105 | |
106 | =item B<-j>|B<+j> |
106 | =item B<-j>|B<+j> |
107 | |
107 | |
108 | Turn on/off jump scrolling; resource B<jumpScroll>. |
108 | Turn on/off jump scrolling; resource B<jumpScroll>. |
109 | |
109 | |
110 | =item B<-ip>|B<+ip> |
110 | =item B<-ip>|B<+ip> | B<-tr>|B<+tr> |
111 | |
111 | |
112 | Turn on/off inheriting parent window's pixmap. Alternative form is |
112 | Turn on/off inheriting parent window's pixmap. Alternative form is |
113 | B<-tr>; resource B<inheritPixmap>. |
113 | B<-tr>; resource B<inheritPixmap>. |
114 | |
114 | |
115 | =item B<-fade> I<number> |
115 | =item B<-fade> I<number> |
116 | |
116 | |
117 | Fade the text by the given percentage when focus is lost. resource B<fading>. |
117 | Fade the text by the given percentage when focus is lost. Small values |
|
|
118 | fade a little only, 100 completely replaces all colours by the fade |
|
|
119 | colour; resource B<fading>. |
|
|
120 | |
|
|
121 | =item B<-fadecolor> I<colour> |
|
|
122 | |
|
|
123 | Fade to this colour when fading is used (see B<-fade>). The default colour |
|
|
124 | is black. resource B<fadeColor>. |
118 | |
125 | |
119 | =item B<-tint> I<colour> |
126 | =item B<-tint> I<colour> |
120 | |
127 | |
121 | Tint the transparent background pixmap with the given colour when |
128 | Tint the transparent background pixmap with the given colour when |
122 | transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> |
129 | transparency is enabled with B<-tr> or B<-ip>. This only works for |
123 | option that can be used to brighten or darken the image in addition to |
130 | non-tiled backgrounds, currently. See also the B<-sh> option that can be |
124 | tinting it. |
131 | used to brighten or darken the image in addition to tinting it; resource |
|
|
132 | I<tintColor>. Example: |
|
|
133 | |
|
|
134 | @@RXVT_NAME@@ -tr -tint blue -sh 40 |
125 | |
135 | |
126 | =item B<-sh> |
136 | =item B<-sh> |
127 | |
137 | |
128 | I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
138 | I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
129 | background image in addition to tinting it (i.e. B<-tint> must be |
139 | background image in addition to tinting it (i.e. B<-tint> must be |
… | |
… | |
162 | resource B<borderColor>. |
172 | resource B<borderColor>. |
163 | |
173 | |
164 | =item B<-fn> I<fontlist> |
174 | =item B<-fn> I<fontlist> |
165 | |
175 | |
166 | Select the fonts to be used. This is a comma separated list of font names |
176 | Select the fonts to be used. This is a comma separated list of font names |
167 | that are used in turn when trying to display Unicode characters. The |
177 | that are checked in order when trying to find glyphs for characters. The |
168 | first font defines the cell size for characters; other fonts might be |
178 | first font defines the cell size for characters; other fonts might be |
169 | smaller, but not (in general) larger. A (hopefully) reasonable default |
179 | smaller, but not (in general) larger. A (hopefully) reasonable default |
170 | font list is always appended to it. See resource B<font> for more details. |
180 | font list is always appended to it. See resource B<font> for more details. |
171 | |
181 | |
172 | In short, to specify an X11 core font, just specify it's name or prefix it |
182 | In short, to specify an X11 core font, just specify it's name or prefix it |
… | |
… | |
179 | See also the question "How does rxvt-unicode choose fonts?" in the FAQ |
189 | See also the question "How does rxvt-unicode choose fonts?" in the FAQ |
180 | section of @@RXVT_NAME@@(7). |
190 | section of @@RXVT_NAME@@(7). |
181 | |
191 | |
182 | =item B<-fb> I<fontlist> |
192 | =item B<-fb> I<fontlist> |
183 | |
193 | |
184 | Compile font-styles: The bold font list to use when bold characters are to |
194 | Compile I<font-styles>: The bold font list to use when B<bold> characters |
185 | be printed. See resource B<boldFont> for details. |
195 | are to be printed. See resource B<boldFont> for details. |
186 | |
196 | |
187 | =item B<-fi> I<fontlist> |
197 | =item B<-fi> I<fontlist> |
188 | |
198 | |
189 | Compile font-styles: The italic font list to use when bold characters are to |
199 | Compile I<font-styles>: The italic font list to use when I<italic> |
190 | be printed. See resource B<italicFont> for details. |
200 | characters are to be printed. See resource B<italicFont> for details. |
191 | |
201 | |
192 | =item B<-fbi> I<fontlist> |
202 | =item B<-fbi> I<fontlist> |
193 | |
203 | |
194 | Compile font-styles: The bold italic font list to use when bold characters are to |
204 | Compile I<font-styles>: The bold italic font list to use when B<< I<bold |
195 | be printed. See resource B<boldItalicFont> for details. |
205 | italic> >> characters are to be printed. See resource B<boldItalicFont> |
|
|
206 | for details. |
|
|
207 | |
|
|
208 | =item B<-is>|B<+is> |
|
|
209 | |
|
|
210 | Compile I<font-styles>: Bold/Italic font styles imply high intensity |
|
|
211 | foreground/background (default). See resource B<intensityStyles> for |
|
|
212 | details. |
196 | |
213 | |
197 | =item B<-name> I<name> |
214 | =item B<-name> I<name> |
198 | |
215 | |
199 | Specify the application name under which resources are to be obtained, |
216 | Specify the application name under which resources are to be obtained, |
200 | rather than the default executable file name. Name should not contain |
217 | rather than the default executable file name. Name should not contain |
… | |
… | |
279 | =item B<-bl> |
296 | =item B<-bl> |
280 | |
297 | |
281 | Compile I<frills>: Set MWM hints to request a borderless window, i.e. |
298 | Compile I<frills>: Set MWM hints to request a borderless window, i.e. |
282 | if honoured by the WM, the rxvt-unicode window will not have window |
299 | if honoured by the WM, the rxvt-unicode window will not have window |
283 | decorations; resource B<borderLess>. |
300 | decorations; resource B<borderLess>. |
|
|
301 | |
|
|
302 | =item B<-override-redirect> |
|
|
303 | |
|
|
304 | Compile I<frills>: Sets override-redirect on the window; resource |
|
|
305 | B<override-redirect>. |
|
|
306 | |
|
|
307 | =item B<-sbg> |
|
|
308 | |
|
|
309 | Compile I<frills>: Disable the usage of the built-in block graphics/line |
|
|
310 | drawing characters and just rely on what the specified fonts provide. Use |
|
|
311 | this if you have a good font and want to use its block graphic glyphs; |
|
|
312 | resource B<skipBuiltinGlyphs>. |
284 | |
313 | |
285 | =item B<-lsp> I<number> |
314 | =item B<-lsp> I<number> |
286 | |
315 | |
287 | Compile I<frills>: Lines (pixel height) to insert between each row of |
316 | Compile I<frills>: Lines (pixel height) to insert between each row of |
288 | the display. Useful to work around font rendering problems; resource |
317 | the display. Useful to work around font rendering problems; resource |
… | |
… | |
303 | given on the command line. If this option is used, it must be the last |
332 | given on the command line. If this option is used, it must be the last |
304 | on the command-line. If there is no B<-e> option then the default is to |
333 | on the command-line. If there is no B<-e> option then the default is to |
305 | run the program specified by the B<SHELL> environment variable or, |
334 | run the program specified by the B<SHELL> environment variable or, |
306 | failing that, I<sh(1)>. |
335 | failing that, I<sh(1)>. |
307 | |
336 | |
|
|
337 | Please note that you must specify a program with arguments. If you want to |
|
|
338 | run shell commands, you have to specify the shell, like this: |
|
|
339 | |
|
|
340 | @@RXVT_NAME@@ -e sh -c "shell commands" |
|
|
341 | |
308 | =item B<-title> I<text> |
342 | =item B<-title> I<text> |
309 | |
343 | |
310 | Window title (B<-T> still respected); the default title is the basename |
344 | Window title (B<-T> still respected); the default title is the basename |
311 | of the program specified after the B<-e> option, if any, otherwise the |
345 | of the program specified after the B<-e> option, if any, otherwise the |
312 | application name; resource B<title>. |
346 | application name; resource B<title>. |
… | |
… | |
367 | |
401 | |
368 | =item B<-ssr>|B<+ssr> |
402 | =item B<-ssr>|B<+ssr> |
369 | |
403 | |
370 | Turn on/off secondary screen scroll (default enabled); resource |
404 | Turn on/off secondary screen scroll (default enabled); resource |
371 | B<secondaryScroll>. |
405 | B<secondaryScroll>. |
|
|
406 | |
|
|
407 | =item B<-hold>|B<+hold> |
|
|
408 | |
|
|
409 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
|
|
410 | will not immediately destroy its window when the program executed within |
|
|
411 | it exits. Instead, it will wait till it is being killed or closed by the |
|
|
412 | user; resource B<hold>. |
372 | |
413 | |
373 | =item B<-keysym.>I<sym> I<string> |
414 | =item B<-keysym.>I<sym> I<string> |
374 | |
415 | |
375 | Remap a key symbol. See resource B<keysym>. |
416 | Remap a key symbol. See resource B<keysym>. |
376 | |
417 | |
… | |
… | |
399 | $rxvt->signal_connect_after (realize => sub { |
440 | $rxvt->signal_connect_after (realize => sub { |
400 | my $xid = $_[0]->window->get_xid; |
441 | my $xid = $_[0]->window->get_xid; |
401 | system "@@RXVT_NAME@@ -embed $xid &"; |
442 | system "@@RXVT_NAME@@ -embed $xid &"; |
402 | }); |
443 | }); |
403 | |
444 | |
404 | =item B<-pty-fd> I<fileno> |
445 | =item B<-pty-fd> I<file descriptor> |
405 | |
446 | |
406 | Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty |
447 | Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty |
407 | pair but instead use the given filehandle as the tty master. This is |
448 | pair but instead use the given filehandle as the tty master. This is |
408 | useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator |
449 | useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator |
409 | without having to run a program within it. |
450 | without having to run a program within it. |
410 | |
451 | |
411 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
452 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
412 | entries and will not tinker with pty/tty permissions - you have to do that |
453 | entries and will not tinker with pty/tty permissions - you have to do that |
413 | yourself if you want that. |
454 | yourself if you want that. |
414 | |
455 | |
|
|
456 | As an extremely special case, specifying C<-1> will completely suppress |
|
|
457 | pty/tty operations. |
|
|
458 | |
415 | Here is a example in perl that illustrates how this option can be used (a |
459 | Here is a example in perl that illustrates how this option can be used (a |
416 | longer example is in F<doc/pty-fd>): |
460 | longer example is in F<doc/pty-fd>): |
417 | |
461 | |
418 | use IO::Pty; |
462 | use IO::Pty; |
419 | use Fcntl; |
463 | use Fcntl; |
… | |
… | |
425 | |
469 | |
426 | # now communicate with rxvt |
470 | # now communicate with rxvt |
427 | my $slave = $pty->slave; |
471 | my $slave = $pty->slave; |
428 | while (<$slave>) { print $slave "got <$_>\n" } |
472 | while (<$slave>) { print $slave "got <$_>\n" } |
429 | |
473 | |
|
|
474 | =item B<-pe> I<string> |
|
|
475 | |
|
|
476 | Comma-separated list of perl extension scripts to use (or not to use) in |
|
|
477 | this terminal instance. See resource B<perl-ext> for details. |
|
|
478 | |
430 | =back |
479 | =back |
431 | |
480 | |
432 | =head1 RESOURCES (available also as long-options) |
481 | =head1 RESOURCES (available also as long-options) |
433 | |
482 | |
434 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
483 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
435 | options) compiled into your version. |
484 | options) compiled into your version. |
436 | |
485 | |
437 | There are two different methods that @@RXVT_NAME@@ can use to get the |
486 | You can set and change the resources using X11 tools like B<xrdb>. Many |
438 | Xresource data: using the X libraries (Xrm*-functions) or internal |
487 | distribution do also load settings from the B<~/.Xresources> file when X |
439 | Xresources reader (B<~/.Xdefaults>). For the first method (ie. |
488 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
440 | B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the |
489 | with later settings overwriting earlier ones: |
441 | resources using X11 tools like B<xrdb>. Many distribution do also load |
|
|
442 | settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@ |
|
|
443 | will consult the following files/resources in order, with later settings |
|
|
444 | overwriting earlier ones: |
|
|
445 | |
490 | |
446 | 1. system-wide app-defaults file, either locale-dependent OR global |
491 | 1. system-wide app-defaults file, either locale-dependent OR global |
447 | 2. app-defaults file in $XAPPLRESDIR |
492 | 2. app-defaults file in $XAPPLRESDIR |
448 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
493 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
449 | 4. SCREEN_RESOURCES for the current screen |
494 | 4. SCREEN_RESOURCES for the current screen |
450 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
495 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
451 | |
496 | |
452 | If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> |
|
|
453 | lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults |
|
|
454 | set in XAPPLOADDIR/URxvt (compile-time defined: usually |
|
|
455 | B</usr/lib/X11/app-defaults/URxvt>) and resources set in |
|
|
456 | B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist. |
|
|
457 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two |
497 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class |
458 | class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows |
498 | names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources |
459 | resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be |
499 | common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily |
460 | easily configured, while the class name B<URxvt> allows resources |
500 | configured, while the class name B<URxvt> allows resources unique to |
461 | unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be |
501 | B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@> |
462 | shared between different B<@@RXVT_NAME@@> configurations. If no |
502 | configurations. If no resources are specified, suitable defaults will |
463 | resources are specified, suitable defaults will be used. Command-line |
503 | be used. Command-line arguments can be used to override resource |
464 | arguments can be used to override resource settings. The following |
504 | settings. The following resources are supported (you might want to |
465 | resources are allowed: |
505 | check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl |
|
|
506 | extensions not documented here): |
466 | |
507 | |
467 | =over 4 |
508 | =over 4 |
468 | |
509 | |
469 | =item B<geometry:> I<geom> |
510 | =item B<geometry:> I<geom> |
470 | |
511 | |
… | |
… | |
548 | artificial transparency. B<False>: do not inherit the parent windows' |
589 | artificial transparency. B<False>: do not inherit the parent windows' |
549 | pixmap. |
590 | pixmap. |
550 | |
591 | |
551 | =item B<fading:> I<number> |
592 | =item B<fading:> I<number> |
552 | |
593 | |
553 | Fade the text by the given percentage when focus is lost. |
594 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
|
|
595 | |
|
|
596 | =item B<fadeColor:> I<colour> |
|
|
597 | |
|
|
598 | Fade to this colour, when fading is used (see B<fading:>). The default |
|
|
599 | colour is black; option B<-fadecolor>. |
554 | |
600 | |
555 | =item B<tintColor:> I<colour> |
601 | =item B<tintColor:> I<colour> |
556 | |
602 | |
557 | Tint the transparent background pixmap with the given colour. |
603 | Tint the transparent background pixmap with the given colour; option |
|
|
604 | B<-tint>. |
558 | |
605 | |
559 | =item B<shading:> I<number> |
606 | =item B<shading:> I<number> |
560 | |
607 | |
561 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
608 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
562 | image in addition to tinting it. |
609 | image in addition to tinting it. |
… | |
… | |
585 | of 1 displays the image without any scaling. A scale of 2 to 9 |
632 | of 1 displays the image without any scaling. A scale of 2 to 9 |
586 | specifies an integer number of images in that direction. No image will |
633 | specifies an integer number of images in that direction. No image will |
587 | be magnified beyond 10 times its original size. The maximum permitted |
634 | be magnified beyond 10 times its original size. The maximum permitted |
588 | scale is 1000. [default 0x0+50+50] |
635 | scale is 1000. [default 0x0+50+50] |
589 | |
636 | |
590 | =item B<menu:> I<file[;tag]> |
|
|
591 | |
|
|
592 | Read in the specified menu file (note the `.menu' extension is |
|
|
593 | optional) and also optionally specify a starting tag to find. See the |
|
|
594 | reference documentation for details on the syntax for the menuBar. |
|
|
595 | |
|
|
596 | =item B<path:> I<path> |
637 | =item B<path:> I<path> |
597 | |
638 | |
598 | Specify the colon-delimited search path for finding files (XPM and |
639 | Specify the colon-delimited search path for finding XPM files. |
599 | menus), in addition to the paths specified by the B<RXVTPATH> and |
|
|
600 | B<PATH> environment variables. |
|
|
601 | |
640 | |
602 | =item B<font:> I<fontlist> |
641 | =item B<font:> I<fontlist> |
603 | |
642 | |
604 | Select the fonts to be used. This is a comma separated list of font |
643 | Select the fonts to be used. This is a comma separated list of font names |
605 | names that are used in turn when trying to display Unicode characters. |
644 | that are checked in order when trying to find glyphs for characters. The |
606 | The first font defines the cell size for characters; other fonts might |
645 | first font defines the cell size for characters; other fonts might be |
607 | be smaller, but not larger. A reasonable default font list is always |
646 | smaller, but not (in general) larger. A (hopefully) reasonable default |
608 | appended to it. option B<-fn>. |
647 | font list is always appended to it; option B<-fn>. |
609 | |
648 | |
610 | Each font can either be a standard X11 core font (XLFD) name, with |
649 | Each font can either be a standard X11 core font (XLFD) name, with |
611 | optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. |
650 | optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. |
612 | |
651 | |
613 | In addition, each font can be prefixed with additional hints and |
652 | In addition, each font can be prefixed with additional hints and |
… | |
… | |
615 | hint currently is C<codeset=codeset-name>, and this is only used for Xft |
654 | hint currently is C<codeset=codeset-name>, and this is only used for Xft |
616 | fonts. |
655 | fonts. |
617 | |
656 | |
618 | For example, this font resource |
657 | For example, this font resource |
619 | |
658 | |
620 | URxvt*font: 9x15bold,\ |
659 | URxvt.font: 9x15bold,\ |
621 | -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ |
660 | -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ |
622 | -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ |
661 | -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ |
623 | [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ |
662 | [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ |
624 | xft:Code2000:antialias=false |
663 | xft:Code2000:antialias=false |
625 | |
664 | |
… | |
… | |
659 | not possible, replacement fonts of the desired shape will be tried. |
698 | not possible, replacement fonts of the desired shape will be tried. |
660 | |
699 | |
661 | If set, but empty, then this specific style is disabled and the normal |
700 | If set, but empty, then this specific style is disabled and the normal |
662 | text font will being used for the given style. |
701 | text font will being used for the given style. |
663 | |
702 | |
|
|
703 | =item B<intensityStyles:> I<boolean> |
|
|
704 | |
|
|
705 | When font styles are not enabled, or this option is enabled (B<True>, |
|
|
706 | option B<-is>, the default), bold and italic font styles imply high |
|
|
707 | intensity foreground/backround colours. Disabling this option (B<False>, |
|
|
708 | option B<+is>) disables this behaviour, the high intensity colours are not |
|
|
709 | reachable. |
|
|
710 | |
664 | =item B<selectstyle:> I<mode> |
711 | =item B<selectstyle:> I<mode> |
665 | |
712 | |
666 | Set mouse selection style to B<old> which is 2.20, B<oldword> which is |
713 | Set mouse selection style to B<old> which is 2.20, B<oldword> which is |
667 | xterm style with 2.20 old word selection, or anything else which gives |
714 | xterm style with 2.20 old word selection, or anything else which gives |
668 | xterm style selection. |
715 | xterm style selection. |
… | |
… | |
714 | |
761 | |
715 | The string will be interpreted as if typed into the shell as-is. |
762 | The string will be interpreted as if typed into the shell as-is. |
716 | |
763 | |
717 | Example: |
764 | Example: |
718 | |
765 | |
719 | URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
766 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
720 | |
767 | |
721 | This creates a new file in your home directory with the screen contents |
768 | This creates a new file in your home directory with the screen contents |
722 | everytime you hit C<Print>. |
769 | everytime you hit C<Print>. |
723 | |
770 | |
724 | =item B<scrollBar:> I<boolean> |
771 | =item B<scrollBar:> I<boolean> |
… | |
… | |
778 | =item B<borderLess:> I<boolean> |
825 | =item B<borderLess:> I<boolean> |
779 | |
826 | |
780 | Set MWM hints to request a borderless window, i.e. if honoured by the |
827 | Set MWM hints to request a borderless window, i.e. if honoured by the |
781 | WM, the rxvt-unicode window will not have window decorations; option B<-bl>. |
828 | WM, the rxvt-unicode window will not have window decorations; option B<-bl>. |
782 | |
829 | |
|
|
830 | =item B<skipBuiltinGlyphs:> I<boolean> |
|
|
831 | |
|
|
832 | Compile I<frills>: Disable the usage of the built-in block graphics/line |
|
|
833 | drawing characters and just rely on what the specified fonts provide. Use |
|
|
834 | this if you have a good font and want to use its block graphic glyphs; |
|
|
835 | option B<-sbg>. |
|
|
836 | |
783 | =item B<termName:> I<termname> |
837 | =item B<termName:> I<termname> |
784 | |
838 | |
785 | Specifies the terminal type name to be set in the B<TERM> environment |
839 | Specifies the terminal type name to be set in the B<TERM> environment |
786 | variable; option B<-tn>. |
840 | variable; option B<-tn>. |
787 | |
841 | |
… | |
… | |
842 | pressed. If unset it will send the sequence traditionally associated |
896 | pressed. If unset it will send the sequence traditionally associated |
843 | with the B<Execute> key. |
897 | with the B<Execute> key. |
844 | |
898 | |
845 | =item B<cutchars:> I<string> |
899 | =item B<cutchars:> I<string> |
846 | |
900 | |
847 | The characters used as delimiters for double-click word selection. The |
901 | The characters used as delimiters for double-click word selection. |
848 | built-in default: |
902 | |
|
|
903 | When the selection extension is in use (the default if compiled in, see |
|
|
904 | the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters |
|
|
905 | will be created (if the resource exists, otherwise, no regex will be |
|
|
906 | created). In this mode, characters outside ISO-8859-1 can be used. |
|
|
907 | |
|
|
908 | When the selection extension is not used, only ISO-8859-1 characters can |
|
|
909 | be used. If not specified, the built-in default is used: |
849 | |
910 | |
850 | B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> |
911 | B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> |
851 | |
912 | |
852 | =item B<preeditType:> I<style> |
913 | =item B<preeditType:> I<style> |
853 | |
914 | |
… | |
… | |
860 | =item B<imLocale:> I<name> |
921 | =item B<imLocale:> I<name> |
861 | |
922 | |
862 | The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. |
923 | The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. |
863 | C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the |
924 | C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the |
864 | input extension to be able to input japanese characters while staying in |
925 | input extension to be able to input japanese characters while staying in |
865 | another locale. option B<-imlocale>. |
926 | another locale; option B<-imlocale>. |
866 | |
927 | |
867 | =item B<imFont:> I<fontset> |
928 | =item B<imFont:> I<fontset> |
868 | |
929 | |
869 | Specify the font-set used for XIM styles C<OverTheSpot> or |
930 | Specify the font-set used for XIM styles C<OverTheSpot> or |
870 | C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated |
931 | C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated |
… | |
… | |
875 | |
936 | |
876 | =item B<tripleclickwords:> I<boolean> |
937 | =item B<tripleclickwords:> I<boolean> |
877 | |
938 | |
878 | Change the meaning of triple-click selection with the left mouse |
939 | Change the meaning of triple-click selection with the left mouse |
879 | button. Instead of selecting a full line it will extend the selection to |
940 | button. Instead of selecting a full line it will extend the selection to |
880 | the end of the logical line only. option B<-tcw>. |
941 | the end of the logical line only; option B<-tcw>. |
881 | |
942 | |
882 | =item B<insecure:> I<boolean> |
943 | =item B<insecure:> I<boolean> |
883 | |
944 | |
884 | Enables "insecure" mode. Rxvt-unicode offers some escape sequences that |
945 | Enables "insecure" mode. Rxvt-unicode offers some escape sequences that |
885 | echo arbitrary strings like the icon name or the locale. This could be |
946 | echo arbitrary strings like the icon name or the locale. This could be |
886 | abused if somebody gets 8-bit-clean access to your display, whether |
947 | abused if somebody gets 8-bit-clean access to your display, whether |
887 | throuh a mail client displaying mail bodies unfiltered or though |
948 | through a mail client displaying mail bodies unfiltered or through |
888 | write(1). Therefore, these sequences are disabled by default. (Note |
949 | write(1) or any other means. Therefore, these sequences are disabled by |
889 | that other terminals, including xterm, have these sequences |
950 | default. (Note that many other terminals, including xterm, have these |
890 | enabled by default). You can enable them by setting this boolean |
951 | sequences enabled by default, which doesn't make it safer, though). |
891 | resource or specifying B<-insecure> as an option. At the moment, this |
952 | |
892 | enabled display-answer, locale, findfont, icon label and window title |
953 | You can enable them by setting this boolean resource or specifying |
893 | requests as well as dynamic menubar dispatch. |
954 | B<-insecure> as an option. At the moment, this enables display-answer, |
|
|
955 | locale, findfont, icon label and window title requests. |
894 | |
956 | |
895 | =item B<modifier:> I<modifier> |
957 | =item B<modifier:> I<modifier> |
896 | |
958 | |
897 | Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, |
959 | Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, |
898 | B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option |
960 | B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option |
… | |
… | |
902 | |
964 | |
903 | Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) |
965 | Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) |
904 | character is passed through. It may contain escape values as described |
966 | character is passed through. It may contain escape values as described |
905 | in the entry on B<keysym> following. |
967 | in the entry on B<keysym> following. |
906 | |
968 | |
907 | =item B<secondaryScreen:> I<bool> |
969 | =item B<secondaryScreen:> I<boolean> |
908 | |
970 | |
909 | Turn on/off secondary screen (default enabled). |
971 | Turn on/off secondary screen (default enabled). |
910 | |
972 | |
911 | =item B<secondaryScroll:> I<bool> |
973 | =item B<secondaryScroll:> I<boolean> |
912 | |
974 | |
913 | Turn on/off secondary screen scroll (default enabled). If the this |
975 | Turn on/off secondary screen scroll (default enabled). If the this |
914 | option is enabled, scrolls on the secondary screen will change the |
976 | option is enabled, scrolls on the secondary screen will change the |
915 | scrollback buffer and switching to/from the secondary screen will |
977 | scrollback buffer and switching to/from the secondary screen will |
916 | instead scroll the screen up. |
978 | instead scroll the screen up. |
|
|
979 | |
|
|
980 | =item B<hold>: I<boolean> |
|
|
981 | |
|
|
982 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
|
|
983 | will not immediately destroy its window when the program executed within |
|
|
984 | it exits. Instead, it will wait till it is being killed or closed by the |
|
|
985 | user. |
917 | |
986 | |
918 | =item B<keysym.>I<sym>: I<string> |
987 | =item B<keysym.>I<sym>: I<string> |
919 | |
988 | |
920 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
989 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
921 | intervening resource name B<keysym.> cannot be omitted. |
990 | intervening resource name B<keysym.> cannot be omitted. |
… | |
… | |
941 | C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, |
1010 | C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, |
942 | C<\000>: octal number) or verbatim control characters (C<^?>: delete, |
1011 | C<\000>: octal number) or verbatim control characters (C<^?>: delete, |
943 | C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it |
1012 | C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it |
944 | can start or end with whitespace. |
1013 | can start or end with whitespace. |
945 | |
1014 | |
946 | Please note that you need to double the C<\> when using |
1015 | Please note that you need to double the C<\> in resource files, as |
947 | C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can |
1016 | Xlib itself does it's own de-escaping (you can use C<\033> instead of |
948 | use C<\033> instead of C<\e> (and so on), which will work with both Xt and |
1017 | C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own |
949 | @@RXVT_NAME@@'s own processing). |
1018 | processing). |
950 | |
1019 | |
951 | You can define a range of keysyms in one shot by providing a I<string> |
1020 | You can define a range of keysyms in one shot by providing a I<string> |
952 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' |
1021 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' |
953 | should be a character not used by the strings. |
1022 | should be a character not used by the strings. |
954 | |
1023 | |
… | |
… | |
966 | is interpreted and executed as @@RXVT_NAME@@'s control sequence. For |
1035 | is interpreted and executed as @@RXVT_NAME@@'s control sequence. For |
967 | example the following means "change the current locale to C<zh_CN.GBK> |
1036 | example the following means "change the current locale to C<zh_CN.GBK> |
968 | when Control-Meta-c is being pressed": |
1037 | when Control-Meta-c is being pressed": |
969 | |
1038 | |
970 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
1039 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
|
|
1040 | |
|
|
1041 | If I<string> takes the form C<perl:STRING>, then the specified B<STRING> |
|
|
1042 | is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) |
|
|
1043 | manpage. For example, the F<selection> extension (activated via |
|
|
1044 | C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: |
|
|
1045 | |
|
|
1046 | URxvt.keysym.M-C-c: perl:selection:rot13 |
971 | |
1047 | |
972 | Due the the large number of modifier combinations, a defined key mapping |
1048 | Due the the large number of modifier combinations, a defined key mapping |
973 | will match if at I<at least> the specified identifiers are being set, and |
1049 | will match if at I<at least> the specified identifiers are being set, and |
974 | no other key mappings with those and more bits are being defined. That |
1050 | no other key mappings with those and more bits are being defined. That |
975 | means that defining a key map for C<a> will automatically provide |
1051 | means that defining a key map for C<a> will automatically provide |
… | |
… | |
999 | info): |
1075 | info): |
1000 | |
1076 | |
1001 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
1077 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
1002 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
1078 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
1003 | |
1079 | |
|
|
1080 | =item B<perl-ext-common>: I<string> |
|
|
1081 | |
|
|
1082 | =item B<perl-ext>: I<string> |
|
|
1083 | |
|
|
1084 | Comma-separated list(s) of perl extension scripts (default: C<default>) to |
|
|
1085 | use in this terminal instance; option B<-pe>. |
|
|
1086 | |
|
|
1087 | Extension names can be prefixed with a C<-> sign to prohibit using |
|
|
1088 | them. This can be useful to selectively disable some extensions loaded |
|
|
1089 | by default, or specified via the C<perl-ext-common> resource. For |
|
|
1090 | example, C<default,-selection> will use all the default extension except |
|
|
1091 | C<selection>. |
|
|
1092 | |
|
|
1093 | Extension names can also be followed by an argument in angle brackets |
|
|
1094 | (e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for |
|
|
1095 | searchable scorllback to Alt/Meta-s). Mentioning the same extension |
|
|
1096 | multiple times with different arguments will pass multiple arguments to |
|
|
1097 | the extension. |
|
|
1098 | |
|
|
1099 | Each extension is looked up in the library directories, loaded if |
|
|
1100 | necessary, and bound to the current terminal instance. |
|
|
1101 | |
|
|
1102 | If both of these resources are the empty string, then the perl |
|
|
1103 | interpreter will not be initialized. The idea behind two options is that |
|
|
1104 | B<perl-ext-common> will be used for extensions that should be available to |
|
|
1105 | all instances, while B<perl-ext> is used for specific instances. |
|
|
1106 | |
|
|
1107 | =item B<perl-eval>: I<string> |
|
|
1108 | |
|
|
1109 | Perl code to be evaluated when all extensions have been registered. See |
|
|
1110 | the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource |
|
|
1111 | will be ignored when running setuid/setgid. |
|
|
1112 | |
|
|
1113 | =item B<perl-lib>: I<path> |
|
|
1114 | |
|
|
1115 | Colon-separated list of additional directories that hold extension |
|
|
1116 | scripts. When looking for extensions specified by the C<perl> resource, |
|
|
1117 | @@RXVT_NAME@@ will first look in these directories and then in |
|
|
1118 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource |
|
|
1119 | will be ignored when running setuid/setgid. |
|
|
1120 | |
|
|
1121 | See the @@RXVT_NAME@@perl(3) manpage. |
|
|
1122 | |
|
|
1123 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
|
|
1124 | |
|
|
1125 | Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for |
|
|
1126 | details. |
|
|
1127 | |
|
|
1128 | =item B<< selection-autotransform.I<idx> >>: I<perl-transform> |
|
|
1129 | |
|
|
1130 | Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage |
|
|
1131 | for details. |
|
|
1132 | |
|
|
1133 | =item B<searchable-scrollback:> I<keysym> |
|
|
1134 | |
|
|
1135 | Sets the hotkey that starts the incremental scrollback buffer search |
|
|
1136 | (default: C<M-s>). |
|
|
1137 | |
|
|
1138 | =item B<urlLauncher>: I<string> |
|
|
1139 | |
|
|
1140 | Specifies the program to be started with a URL argument. Used by the |
|
|
1141 | C<selection-popup> and C<mark-urls> perl extensions. |
|
|
1142 | |
|
|
1143 | =item B<transient-for>: I<windowid> |
|
|
1144 | |
|
|
1145 | Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. |
|
|
1146 | |
|
|
1147 | =item B<override-redirect>: I<boolean> |
|
|
1148 | |
|
|
1149 | Compile I<frills>: Sets override-redirect for the terminal window, making |
|
|
1150 | it almost invisible to window managers; option B<-override-redirect>. |
|
|
1151 | |
1004 | =back |
1152 | =back |
1005 | |
1153 | |
1006 | =head1 THE SCROLLBAR |
1154 | =head1 THE SCROLLBAR |
1007 | |
1155 | |
1008 | Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window |
1156 | Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window |
… | |
… | |
1042 | to select a word; Left triple-click to select the entire logical line |
1190 | to select a word; Left triple-click to select the entire logical line |
1043 | (which can span multiple screen lines), unless modified by resource |
1191 | (which can span multiple screen lines), unless modified by resource |
1044 | B<tripleclickwords>. |
1192 | B<tripleclickwords>. |
1045 | |
1193 | |
1046 | Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) |
1194 | Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) |
1047 | (Compile: I<frills>) will create a rectangular selection instead of a normal |
1195 | (Compile: I<frills>) will create a rectangular selection instead of a |
1048 | one. |
1196 | normal one. In this mode, every selected row becomes its own line in the |
|
|
1197 | selection, and trailing whitespace is visually underlined and removed from |
|
|
1198 | the selection. |
1049 | |
1199 | |
1050 | =item B<Insertion>: |
1200 | =item B<Insertion>: |
1051 | |
1201 | |
1052 | Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in |
1202 | Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> |
1053 | an B<@@RXVT_NAME@@> window causes the current text selection to be |
1203 | window causes the value of the PRIMARY selection (or CLIPBOARD with the |
1054 | inserted as if it had been typed on the keyboard. |
1204 | Meta modifier) to be inserted as if it had been typed on the keyboard. |
|
|
1205 | |
|
|
1206 | Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be |
|
|
1207 | inserted too. |
1055 | |
1208 | |
1056 | =back |
1209 | =back |
1057 | |
1210 | |
1058 | =head1 CHANGING FONTS |
1211 | =head1 CHANGING FONTS |
1059 | |
1212 | |
1060 | Changing fonts (or font sizes, respectively) via the keypad is not yet |
1213 | Changing fonts (or font sizes, respectively) via the keypad is not yet |
1061 | supported in rxvt-unicode. Bug me if you need this. |
1214 | supported in rxvt-unicode. Bug me if you need this. |
1062 | |
1215 | |
1063 | You can, however, switch fonts at runtime using escape sequences (and |
1216 | You can, however, switch fonts at runtime using escape sequences, e.g.: |
1064 | therefore using the menubar), e.g.: |
|
|
1065 | |
1217 | |
1066 | printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" |
1218 | printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" |
|
|
1219 | |
|
|
1220 | You can use keyboard shortcuts, too: |
|
|
1221 | |
|
|
1222 | URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007 |
|
|
1223 | URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007 |
1067 | |
1224 | |
1068 | rxvt-unicode will automatically re-apply these fonts to the output so far. |
1225 | rxvt-unicode will automatically re-apply these fonts to the output so far. |
1069 | |
1226 | |
1070 | =head1 ISO 14755 SUPPORT |
1227 | =head1 ISO 14755 SUPPORT |
1071 | |
1228 | |
… | |
… | |
1233 | |
1390 | |
1234 | =item B<SHELL> |
1391 | =item B<SHELL> |
1235 | |
1392 | |
1236 | The shell to be used for command execution, defaults to C</bin/sh>. |
1393 | The shell to be used for command execution, defaults to C</bin/sh>. |
1237 | |
1394 | |
1238 | =item B<RXVTPATH> |
|
|
1239 | |
|
|
1240 | The path where @@RXVT_NAME@@ looks for support files such as menu and xpm |
|
|
1241 | files. |
|
|
1242 | |
|
|
1243 | =item B<PATH> |
|
|
1244 | |
|
|
1245 | Used in the same way as C<RXVTPATH>. |
|
|
1246 | |
|
|
1247 | =item B<RXVT_SOCKET> |
1395 | =item B<RXVT_SOCKET> |
1248 | |
1396 | |
1249 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1397 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1250 | @@RXVT_NAME@@d(1). |
1398 | @@RXVT_NAME@@d(1). |
1251 | |
1399 | |
1252 | Default C<< $HOME/.rxvt-unicode-<nodename >>. |
1400 | Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. |
1253 | |
1401 | |
1254 | =item B<HOME> |
1402 | =item B<HOME> |
1255 | |
1403 | |
1256 | Used to locate the default directory for the unix domain socket for |
1404 | Used to locate the default directory for the unix domain socket for |
1257 | daemon communications and to locate various resource files (such as |
1405 | daemon communications and to locate various resource files (such as |
… | |
… | |
1278 | |
1426 | |
1279 | =back |
1427 | =back |
1280 | |
1428 | |
1281 | =head1 SEE ALSO |
1429 | =head1 SEE ALSO |
1282 | |
1430 | |
1283 | @@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) |
1431 | @@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) |
1284 | |
|
|
1285 | =head1 BUGS |
|
|
1286 | |
|
|
1287 | Check the BUGS file for an up-to-date list. |
|
|
1288 | |
|
|
1289 | Cursor change support is not yet implemented. |
|
|
1290 | |
|
|
1291 | Click-and-drag doesn't work with X11 mouse report overriding. |
|
|
1292 | |
1432 | |
1293 | =head1 CURRENT PROJECT COORDINATOR |
1433 | =head1 CURRENT PROJECT COORDINATOR |
1294 | |
1434 | |
1295 | =over 4 |
1435 | =over 4 |
1296 | |
1436 | |
… | |
… | |
1328 | |
1468 | |
1329 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1469 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1330 | |
1470 | |
1331 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1471 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1332 | |
1472 | |
1333 | Rewrote screen display and text selection routines. Project Coordinator |
1473 | Rewrote screen display and text selection routines. |
|
|
1474 | |
1334 | (changes.txt 2.4.6 - rxvt-unicode) |
1475 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1335 | |
1476 | |
1336 | =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1477 | =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1337 | |
1478 | |
1338 | Forked rxvt-unicode, rewrote most of the display code and internal |
1479 | Forked rxvt-unicode, unicode support, rewrote almost all the code, perl |
1339 | character handling to store text in unicode, improve xterm |
1480 | extension, random hacks, numerous bugfixes and extensions. |
1340 | compatibility and apply numerous other bugfixes and extensions. |
|
|
1341 | |
1481 | |
1342 | Project Coordinator (Changes 1.0 -) |
1482 | Project Coordinator (Changes 1.0 -) |
1343 | |
1483 | |
|
|
1484 | =item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> |
|
|
1485 | |
|
|
1486 | Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. |
|
|
1487 | |
1344 | =back |
1488 | =back |
1345 | |
1489 | |