… | |
… | |
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> |
… | |
… | |
124 | is black. resource B<fadeColor>. |
124 | is black. resource B<fadeColor>. |
125 | |
125 | |
126 | =item B<-tint> I<colour> |
126 | =item B<-tint> I<colour> |
127 | |
127 | |
128 | Tint the transparent background pixmap with the given colour when |
128 | Tint the transparent background pixmap with the given colour when |
129 | 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 |
130 | 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 |
131 | tinting it; resource I<tintColor>. |
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 |
132 | |
135 | |
133 | =item B<-sh> |
136 | =item B<-sh> |
134 | |
137 | |
135 | I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
138 | I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
136 | 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 |
… | |
… | |
169 | resource B<borderColor>. |
172 | resource B<borderColor>. |
170 | |
173 | |
171 | =item B<-fn> I<fontlist> |
174 | =item B<-fn> I<fontlist> |
172 | |
175 | |
173 | 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 |
174 | 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 |
175 | 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 |
176 | smaller, but not (in general) larger. A (hopefully) reasonable default |
179 | smaller, but not (in general) larger. A (hopefully) reasonable default |
177 | 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. |
178 | |
181 | |
179 | 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 |
… | |
… | |
186 | 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 |
187 | section of @@RXVT_NAME@@(7). |
190 | section of @@RXVT_NAME@@(7). |
188 | |
191 | |
189 | =item B<-fb> I<fontlist> |
192 | =item B<-fb> I<fontlist> |
190 | |
193 | |
191 | 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 |
192 | be printed. See resource B<boldFont> for details. |
195 | are to be printed. See resource B<boldFont> for details. |
193 | |
196 | |
194 | =item B<-fi> I<fontlist> |
197 | =item B<-fi> I<fontlist> |
195 | |
198 | |
196 | 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> |
197 | be printed. See resource B<italicFont> for details. |
200 | characters are to be printed. See resource B<italicFont> for details. |
198 | |
201 | |
199 | =item B<-fbi> I<fontlist> |
202 | =item B<-fbi> I<fontlist> |
200 | |
203 | |
201 | 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 |
202 | 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. |
203 | |
213 | |
204 | =item B<-name> I<name> |
214 | =item B<-name> I<name> |
205 | |
215 | |
206 | Specify the application name under which resources are to be obtained, |
216 | Specify the application name under which resources are to be obtained, |
207 | rather than the default executable file name. Name should not contain |
217 | rather than the default executable file name. Name should not contain |
… | |
… | |
286 | =item B<-bl> |
296 | =item B<-bl> |
287 | |
297 | |
288 | 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. |
289 | 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 |
290 | 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>. |
291 | |
313 | |
292 | =item B<-lsp> I<number> |
314 | =item B<-lsp> I<number> |
293 | |
315 | |
294 | 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 |
295 | the display. Useful to work around font rendering problems; resource |
317 | the display. Useful to work around font rendering problems; resource |
… | |
… | |
310 | 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 |
311 | 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 |
312 | run the program specified by the B<SHELL> environment variable or, |
334 | run the program specified by the B<SHELL> environment variable or, |
313 | failing that, I<sh(1)>. |
335 | failing that, I<sh(1)>. |
314 | |
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 | |
315 | =item B<-title> I<text> |
342 | =item B<-title> I<text> |
316 | |
343 | |
317 | 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 |
318 | 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 |
319 | application name; resource B<title>. |
346 | application name; resource B<title>. |
… | |
… | |
374 | |
401 | |
375 | =item B<-ssr>|B<+ssr> |
402 | =item B<-ssr>|B<+ssr> |
376 | |
403 | |
377 | Turn on/off secondary screen scroll (default enabled); resource |
404 | Turn on/off secondary screen scroll (default enabled); resource |
378 | 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>. |
379 | |
413 | |
380 | =item B<-keysym.>I<sym> I<string> |
414 | =item B<-keysym.>I<sym> I<string> |
381 | |
415 | |
382 | Remap a key symbol. See resource B<keysym>. |
416 | Remap a key symbol. See resource B<keysym>. |
383 | |
417 | |
… | |
… | |
406 | $rxvt->signal_connect_after (realize => sub { |
440 | $rxvt->signal_connect_after (realize => sub { |
407 | my $xid = $_[0]->window->get_xid; |
441 | my $xid = $_[0]->window->get_xid; |
408 | system "@@RXVT_NAME@@ -embed $xid &"; |
442 | system "@@RXVT_NAME@@ -embed $xid &"; |
409 | }); |
443 | }); |
410 | |
444 | |
411 | =item B<-pty-fd> I<fileno> |
445 | =item B<-pty-fd> I<file descriptor> |
412 | |
446 | |
413 | 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 |
414 | 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 |
415 | 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 |
416 | without having to run a program within it. |
450 | without having to run a program within it. |
417 | |
451 | |
418 | 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 |
419 | 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 |
420 | yourself if you want that. |
454 | yourself if you want that. |
421 | |
455 | |
|
|
456 | As an extremely special case, specifying C<-1> will completely suppress |
|
|
457 | pty/tty operations. |
|
|
458 | |
422 | 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 |
423 | longer example is in F<doc/pty-fd>): |
460 | longer example is in F<doc/pty-fd>): |
424 | |
461 | |
425 | use IO::Pty; |
462 | use IO::Pty; |
426 | use Fcntl; |
463 | use Fcntl; |
… | |
… | |
432 | |
469 | |
433 | # now communicate with rxvt |
470 | # now communicate with rxvt |
434 | my $slave = $pty->slave; |
471 | my $slave = $pty->slave; |
435 | while (<$slave>) { print $slave "got <$_>\n" } |
472 | while (<$slave>) { print $slave "got <$_>\n" } |
436 | |
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 | |
437 | =back |
479 | =back |
438 | |
480 | |
439 | =head1 RESOURCES (available also as long-options) |
481 | =head1 RESOURCES (available also as long-options) |
440 | |
482 | |
441 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
483 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
442 | options) compiled into your version. |
484 | options) compiled into your version. |
443 | |
485 | |
444 | 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 |
445 | Xresource data: using the X libraries (Xrm*-functions) or internal |
487 | distribution do also load settings from the B<~/.Xresources> file when X |
446 | Xresources reader (B<~/.Xdefaults>). For the first method (ie. |
488 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
447 | B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the |
489 | with later settings overwriting earlier ones: |
448 | resources using X11 tools like B<xrdb>. Many distribution do also load |
|
|
449 | settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@ |
|
|
450 | will consult the following files/resources in order, with later settings |
|
|
451 | overwriting earlier ones: |
|
|
452 | |
490 | |
453 | 1. system-wide app-defaults file, either locale-dependent OR global |
491 | 1. system-wide app-defaults file, either locale-dependent OR global |
454 | 2. app-defaults file in $XAPPLRESDIR |
492 | 2. app-defaults file in $XAPPLRESDIR |
455 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
493 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
456 | 4. SCREEN_RESOURCES for the current screen |
494 | 4. SCREEN_RESOURCES for the current screen |
457 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
495 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
458 | |
496 | |
459 | If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> |
|
|
460 | lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults |
|
|
461 | set in XAPPLOADDIR/URxvt (compile-time defined: usually |
|
|
462 | B</usr/lib/X11/app-defaults/URxvt>) and resources set in |
|
|
463 | B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist. |
|
|
464 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two |
497 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class |
465 | 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 |
466 | 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 |
467 | easily configured, while the class name B<URxvt> allows resources |
500 | configured, while the class name B<URxvt> allows resources unique to |
468 | unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be |
501 | B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@> |
469 | shared between different B<@@RXVT_NAME@@> configurations. If no |
502 | configurations. If no resources are specified, suitable defaults will |
470 | resources are specified, suitable defaults will be used. Command-line |
503 | be used. Command-line arguments can be used to override resource |
471 | arguments can be used to override resource settings. The following |
504 | settings. The following resources are supported (you might want to |
472 | resources are allowed: |
505 | check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl |
|
|
506 | extensions not documented here): |
473 | |
507 | |
474 | =over 4 |
508 | =over 4 |
475 | |
509 | |
476 | =item B<geometry:> I<geom> |
510 | =item B<geometry:> I<geom> |
477 | |
511 | |
… | |
… | |
598 | 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 |
599 | 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 |
600 | be magnified beyond 10 times its original size. The maximum permitted |
634 | be magnified beyond 10 times its original size. The maximum permitted |
601 | scale is 1000. [default 0x0+50+50] |
635 | scale is 1000. [default 0x0+50+50] |
602 | |
636 | |
603 | =item B<menu:> I<file[;tag]> |
|
|
604 | |
|
|
605 | Read in the specified menu file (note the `.menu' extension is |
|
|
606 | optional) and also optionally specify a starting tag to find. See the |
|
|
607 | reference documentation for details on the syntax for the menuBar. |
|
|
608 | |
|
|
609 | =item B<path:> I<path> |
637 | =item B<path:> I<path> |
610 | |
638 | |
611 | Specify the colon-delimited search path for finding files (XPM and |
639 | Specify the colon-delimited search path for finding XPM files. |
612 | menus), in addition to the paths specified by the B<RXVTPATH> and |
|
|
613 | B<PATH> environment variables. |
|
|
614 | |
640 | |
615 | =item B<font:> I<fontlist> |
641 | =item B<font:> I<fontlist> |
616 | |
642 | |
617 | 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 |
618 | 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 |
619 | 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 |
620 | be smaller, but not larger. A reasonable default font list is always |
646 | smaller, but not (in general) larger. A (hopefully) reasonable default |
621 | appended to it. option B<-fn>. |
647 | font list is always appended to it; option B<-fn>. |
622 | |
648 | |
623 | 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 |
624 | 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:>. |
625 | |
651 | |
626 | In addition, each font can be prefixed with additional hints and |
652 | In addition, each font can be prefixed with additional hints and |
… | |
… | |
628 | 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 |
629 | fonts. |
655 | fonts. |
630 | |
656 | |
631 | For example, this font resource |
657 | For example, this font resource |
632 | |
658 | |
633 | URxvt*font: 9x15bold,\ |
659 | URxvt.font: 9x15bold,\ |
634 | -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,\ |
635 | -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, \ |
636 | [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ |
662 | [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ |
637 | xft:Code2000:antialias=false |
663 | xft:Code2000:antialias=false |
638 | |
664 | |
… | |
… | |
672 | not possible, replacement fonts of the desired shape will be tried. |
698 | not possible, replacement fonts of the desired shape will be tried. |
673 | |
699 | |
674 | 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 |
675 | text font will being used for the given style. |
701 | text font will being used for the given style. |
676 | |
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 | |
677 | =item B<selectstyle:> I<mode> |
711 | =item B<selectstyle:> I<mode> |
678 | |
712 | |
679 | 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 |
680 | 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 |
681 | xterm style selection. |
715 | xterm style selection. |
… | |
… | |
727 | |
761 | |
728 | 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. |
729 | |
763 | |
730 | Example: |
764 | Example: |
731 | |
765 | |
732 | URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
766 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
733 | |
767 | |
734 | 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 |
735 | everytime you hit C<Print>. |
769 | everytime you hit C<Print>. |
736 | |
770 | |
737 | =item B<scrollBar:> I<boolean> |
771 | =item B<scrollBar:> I<boolean> |
… | |
… | |
791 | =item B<borderLess:> I<boolean> |
825 | =item B<borderLess:> I<boolean> |
792 | |
826 | |
793 | 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 |
794 | 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>. |
795 | |
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 | |
796 | =item B<termName:> I<termname> |
837 | =item B<termName:> I<termname> |
797 | |
838 | |
798 | 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 |
799 | variable; option B<-tn>. |
840 | variable; option B<-tn>. |
800 | |
841 | |
… | |
… | |
873 | =item B<imLocale:> I<name> |
914 | =item B<imLocale:> I<name> |
874 | |
915 | |
875 | The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. |
916 | The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. |
876 | C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the |
917 | C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the |
877 | input extension to be able to input japanese characters while staying in |
918 | input extension to be able to input japanese characters while staying in |
878 | another locale. option B<-imlocale>. |
919 | another locale; option B<-imlocale>. |
879 | |
920 | |
880 | =item B<imFont:> I<fontset> |
921 | =item B<imFont:> I<fontset> |
881 | |
922 | |
882 | Specify the font-set used for XIM styles C<OverTheSpot> or |
923 | Specify the font-set used for XIM styles C<OverTheSpot> or |
883 | C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated |
924 | C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated |
… | |
… | |
888 | |
929 | |
889 | =item B<tripleclickwords:> I<boolean> |
930 | =item B<tripleclickwords:> I<boolean> |
890 | |
931 | |
891 | Change the meaning of triple-click selection with the left mouse |
932 | Change the meaning of triple-click selection with the left mouse |
892 | button. Instead of selecting a full line it will extend the selection to |
933 | button. Instead of selecting a full line it will extend the selection to |
893 | the end of the logical line only. option B<-tcw>. |
934 | the end of the logical line only; option B<-tcw>. |
894 | |
935 | |
895 | =item B<insecure:> I<boolean> |
936 | =item B<insecure:> I<boolean> |
896 | |
937 | |
897 | Enables "insecure" mode. Rxvt-unicode offers some escape sequences that |
938 | Enables "insecure" mode. Rxvt-unicode offers some escape sequences that |
898 | echo arbitrary strings like the icon name or the locale. This could be |
939 | echo arbitrary strings like the icon name or the locale. This could be |
899 | abused if somebody gets 8-bit-clean access to your display, whether |
940 | abused if somebody gets 8-bit-clean access to your display, whether |
900 | throuh a mail client displaying mail bodies unfiltered or though |
941 | through a mail client displaying mail bodies unfiltered or through |
901 | write(1). Therefore, these sequences are disabled by default. (Note |
942 | write(1) or any other means. Therefore, these sequences are disabled by |
902 | that other terminals, including xterm, have these sequences |
943 | default. (Note that many other terminals, including xterm, have these |
903 | enabled by default). You can enable them by setting this boolean |
944 | sequences enabled by default, which doesn't make it safer, though). |
904 | resource or specifying B<-insecure> as an option. At the moment, this |
945 | |
905 | enabled display-answer, locale, findfont, icon label and window title |
946 | You can enable them by setting this boolean resource or specifying |
906 | requests as well as dynamic menubar dispatch. |
947 | B<-insecure> as an option. At the moment, this enables display-answer, |
|
|
948 | locale, findfont, icon label and window title requests. |
907 | |
949 | |
908 | =item B<modifier:> I<modifier> |
950 | =item B<modifier:> I<modifier> |
909 | |
951 | |
910 | Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, |
952 | Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, |
911 | B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option |
953 | B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option |
… | |
… | |
915 | |
957 | |
916 | Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) |
958 | Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) |
917 | character is passed through. It may contain escape values as described |
959 | character is passed through. It may contain escape values as described |
918 | in the entry on B<keysym> following. |
960 | in the entry on B<keysym> following. |
919 | |
961 | |
920 | =item B<secondaryScreen:> I<bool> |
962 | =item B<secondaryScreen:> I<boolean> |
921 | |
963 | |
922 | Turn on/off secondary screen (default enabled). |
964 | Turn on/off secondary screen (default enabled). |
923 | |
965 | |
924 | =item B<secondaryScroll:> I<bool> |
966 | =item B<secondaryScroll:> I<boolean> |
925 | |
967 | |
926 | Turn on/off secondary screen scroll (default enabled). If the this |
968 | Turn on/off secondary screen scroll (default enabled). If the this |
927 | option is enabled, scrolls on the secondary screen will change the |
969 | option is enabled, scrolls on the secondary screen will change the |
928 | scrollback buffer and switching to/from the secondary screen will |
970 | scrollback buffer and switching to/from the secondary screen will |
929 | instead scroll the screen up. |
971 | instead scroll the screen up. |
|
|
972 | |
|
|
973 | =item B<hold>: I<boolean> |
|
|
974 | |
|
|
975 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
|
|
976 | will not immediately destroy its window when the program executed within |
|
|
977 | it exits. Instead, it will wait till it is being killed or closed by the |
|
|
978 | user. |
930 | |
979 | |
931 | =item B<keysym.>I<sym>: I<string> |
980 | =item B<keysym.>I<sym>: I<string> |
932 | |
981 | |
933 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
982 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
934 | intervening resource name B<keysym.> cannot be omitted. |
983 | intervening resource name B<keysym.> cannot be omitted. |
… | |
… | |
954 | C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, |
1003 | C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, |
955 | C<\000>: octal number) or verbatim control characters (C<^?>: delete, |
1004 | C<\000>: octal number) or verbatim control characters (C<^?>: delete, |
956 | C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it |
1005 | C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it |
957 | can start or end with whitespace. |
1006 | can start or end with whitespace. |
958 | |
1007 | |
959 | Please note that you need to double the C<\> when using |
1008 | Please note that you need to double the C<\> in resource files, as |
960 | C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can |
1009 | Xlib itself does it's own de-escaping (you can use C<\033> instead of |
961 | use C<\033> instead of C<\e> (and so on), which will work with both Xt and |
1010 | C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own |
962 | @@RXVT_NAME@@'s own processing). |
1011 | processing). |
963 | |
1012 | |
964 | You can define a range of keysyms in one shot by providing a I<string> |
1013 | You can define a range of keysyms in one shot by providing a I<string> |
965 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' |
1014 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' |
966 | should be a character not used by the strings. |
1015 | should be a character not used by the strings. |
967 | |
1016 | |
… | |
… | |
979 | is interpreted and executed as @@RXVT_NAME@@'s control sequence. For |
1028 | is interpreted and executed as @@RXVT_NAME@@'s control sequence. For |
980 | example the following means "change the current locale to C<zh_CN.GBK> |
1029 | example the following means "change the current locale to C<zh_CN.GBK> |
981 | when Control-Meta-c is being pressed": |
1030 | when Control-Meta-c is being pressed": |
982 | |
1031 | |
983 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
1032 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
|
|
1033 | |
|
|
1034 | If I<string> takes the form C<perl:STRING>, then the specified B<STRING> |
|
|
1035 | is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) |
|
|
1036 | manpage. For example, the F<selection> extension (activated via |
|
|
1037 | C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: |
|
|
1038 | |
|
|
1039 | URxvt.keysym.M-C-c: perl:selection:rot13 |
984 | |
1040 | |
985 | Due the the large number of modifier combinations, a defined key mapping |
1041 | Due the the large number of modifier combinations, a defined key mapping |
986 | will match if at I<at least> the specified identifiers are being set, and |
1042 | will match if at I<at least> the specified identifiers are being set, and |
987 | no other key mappings with those and more bits are being defined. That |
1043 | no other key mappings with those and more bits are being defined. That |
988 | means that defining a key map for C<a> will automatically provide |
1044 | means that defining a key map for C<a> will automatically provide |
… | |
… | |
1012 | info): |
1068 | info): |
1013 | |
1069 | |
1014 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
1070 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
1015 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
1071 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
1016 | |
1072 | |
|
|
1073 | =item B<perl-ext-common>: I<string> |
|
|
1074 | |
|
|
1075 | =item B<perl-ext>: I<string> |
|
|
1076 | |
|
|
1077 | Comma-separated list(s) of perl extension scripts (default: C<default>) to |
|
|
1078 | use in this terminal instance; option B<-pe>. |
|
|
1079 | |
|
|
1080 | Extension names can be prefixed with a C<-> sign to prohibit using |
|
|
1081 | them. This can be useful to selectively disable some extensions loaded |
|
|
1082 | by default, or specified via the C<perl-ext-common> resource. For |
|
|
1083 | example, C<default,-selection> will use all the default extension except |
|
|
1084 | C<selection>. |
|
|
1085 | |
|
|
1086 | Extension names can also be followed by an argument in angle brackets |
|
|
1087 | (e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for |
|
|
1088 | searchable scorllback to Alt/Meta-s). Mentioning the same extension |
|
|
1089 | multiple times with different arguments will pass multiple arguments to |
|
|
1090 | the extension. |
|
|
1091 | |
|
|
1092 | Each extension is looked up in the library directories, loaded if |
|
|
1093 | necessary, and bound to the current terminal instance. |
|
|
1094 | |
|
|
1095 | If both of these resources are the empty string, then the perl |
|
|
1096 | interpreter will not be initialized. The idea behind two options is that |
|
|
1097 | B<perl-ext-common> will be used for extensions that should be available to |
|
|
1098 | all instances, while B<perl-ext> is used for specific instances. |
|
|
1099 | |
|
|
1100 | =item B<perl-eval>: I<string> |
|
|
1101 | |
|
|
1102 | Perl code to be evaluated when all extensions have been registered. See |
|
|
1103 | the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource |
|
|
1104 | will be ignored when running setuid/setgid. |
|
|
1105 | |
|
|
1106 | =item B<perl-lib>: I<path> |
|
|
1107 | |
|
|
1108 | Colon-separated list of additional directories that hold extension |
|
|
1109 | scripts. When looking for extensions specified by the C<perl> resource, |
|
|
1110 | @@RXVT_NAME@@ will first look in these directories and then in |
|
|
1111 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource |
|
|
1112 | will be ignored when running setuid/setgid. |
|
|
1113 | |
|
|
1114 | See the @@RXVT_NAME@@perl(3) manpage. |
|
|
1115 | |
|
|
1116 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
|
|
1117 | |
|
|
1118 | Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for |
|
|
1119 | details. |
|
|
1120 | |
|
|
1121 | =item B<< selection-autotransform.I<idx> >>: I<perl-transform> |
|
|
1122 | |
|
|
1123 | Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage |
|
|
1124 | for details. |
|
|
1125 | |
|
|
1126 | =item B<searchable-scrollback:> I<keysym> |
|
|
1127 | |
|
|
1128 | Sets the hotkey that starts the incremental scrollback buffer search |
|
|
1129 | (default: C<M-s>). |
|
|
1130 | |
|
|
1131 | =item B<urlLauncher>: I<string> |
|
|
1132 | |
|
|
1133 | Specifies the program to be started with a URL argument. Used by the |
|
|
1134 | C<selection-popup> and C<mark-urls> perl extensions. |
|
|
1135 | |
|
|
1136 | =item B<transient-for>: I<windowid> |
|
|
1137 | |
|
|
1138 | Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. |
|
|
1139 | |
|
|
1140 | =item B<override-redirect>: I<boolean> |
|
|
1141 | |
|
|
1142 | Compile I<frills>: Sets override-redirect for the terminal window, making |
|
|
1143 | it almost invisible to window managers; option B<-override-redirect>. |
|
|
1144 | |
1017 | =back |
1145 | =back |
1018 | |
1146 | |
1019 | =head1 THE SCROLLBAR |
1147 | =head1 THE SCROLLBAR |
1020 | |
1148 | |
1021 | Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window |
1149 | Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window |
… | |
… | |
1055 | to select a word; Left triple-click to select the entire logical line |
1183 | to select a word; Left triple-click to select the entire logical line |
1056 | (which can span multiple screen lines), unless modified by resource |
1184 | (which can span multiple screen lines), unless modified by resource |
1057 | B<tripleclickwords>. |
1185 | B<tripleclickwords>. |
1058 | |
1186 | |
1059 | Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) |
1187 | Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) |
1060 | (Compile: I<frills>) will create a rectangular selection instead of a normal |
1188 | (Compile: I<frills>) will create a rectangular selection instead of a |
1061 | one. |
1189 | normal one. In this mode, every selected row becomes its own line in the |
|
|
1190 | selection, and trailing whitespace is visually underlined and removed from |
|
|
1191 | the selection. |
1062 | |
1192 | |
1063 | =item B<Insertion>: |
1193 | =item B<Insertion>: |
1064 | |
1194 | |
1065 | Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in |
1195 | Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> window |
1066 | an B<@@RXVT_NAME@@> window causes the current text selection to be |
1196 | causes the value of the PRIMARY selection (Shift for CLIPBOARD) to be inserted |
1067 | inserted as if it had been typed on the keyboard. |
1197 | as if it had been typed on the keyboard. |
|
|
1198 | B<Shift-Insert> causes the value of the PRIMARY selection to be inserted too. |
1068 | |
1199 | |
1069 | =back |
1200 | =back |
1070 | |
1201 | |
1071 | =head1 CHANGING FONTS |
1202 | =head1 CHANGING FONTS |
1072 | |
1203 | |
1073 | Changing fonts (or font sizes, respectively) via the keypad is not yet |
1204 | Changing fonts (or font sizes, respectively) via the keypad is not yet |
1074 | supported in rxvt-unicode. Bug me if you need this. |
1205 | supported in rxvt-unicode. Bug me if you need this. |
1075 | |
1206 | |
1076 | You can, however, switch fonts at runtime using escape sequences (and |
1207 | You can, however, switch fonts at runtime using escape sequences, e.g.: |
1077 | therefore using the menubar), e.g.: |
|
|
1078 | |
1208 | |
1079 | printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" |
1209 | printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" |
|
|
1210 | |
|
|
1211 | You can use keyboard shortcuts, too: |
|
|
1212 | |
|
|
1213 | URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007 |
|
|
1214 | URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007 |
1080 | |
1215 | |
1081 | rxvt-unicode will automatically re-apply these fonts to the output so far. |
1216 | rxvt-unicode will automatically re-apply these fonts to the output so far. |
1082 | |
1217 | |
1083 | =head1 ISO 14755 SUPPORT |
1218 | =head1 ISO 14755 SUPPORT |
1084 | |
1219 | |
… | |
… | |
1246 | |
1381 | |
1247 | =item B<SHELL> |
1382 | =item B<SHELL> |
1248 | |
1383 | |
1249 | The shell to be used for command execution, defaults to C</bin/sh>. |
1384 | The shell to be used for command execution, defaults to C</bin/sh>. |
1250 | |
1385 | |
1251 | =item B<RXVTPATH> |
|
|
1252 | |
|
|
1253 | The path where @@RXVT_NAME@@ looks for support files such as menu and xpm |
|
|
1254 | files. |
|
|
1255 | |
|
|
1256 | =item B<PATH> |
|
|
1257 | |
|
|
1258 | Used in the same way as C<RXVTPATH>. |
|
|
1259 | |
|
|
1260 | =item B<RXVT_SOCKET> |
1386 | =item B<RXVT_SOCKET> |
1261 | |
1387 | |
1262 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1388 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1263 | @@RXVT_NAME@@d(1). |
1389 | @@RXVT_NAME@@d(1). |
1264 | |
1390 | |
… | |
… | |
1293 | |
1419 | |
1294 | =head1 SEE ALSO |
1420 | =head1 SEE ALSO |
1295 | |
1421 | |
1296 | @@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) |
1422 | @@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) |
1297 | |
1423 | |
1298 | =head1 BUGS |
|
|
1299 | |
|
|
1300 | Check the BUGS file for an up-to-date list. |
|
|
1301 | |
|
|
1302 | Cursor change support is not yet implemented. |
|
|
1303 | |
|
|
1304 | Click-and-drag doesn't work with X11 mouse report overriding. |
|
|
1305 | |
|
|
1306 | =head1 CURRENT PROJECT COORDINATOR |
1424 | =head1 CURRENT PROJECT COORDINATOR |
1307 | |
1425 | |
1308 | =over 4 |
1426 | =over 4 |
1309 | |
1427 | |
1310 | =item Project Coordinator |
1428 | =item Project Coordinator |
… | |
… | |
1341 | |
1459 | |
1342 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1460 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1343 | |
1461 | |
1344 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1462 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1345 | |
1463 | |
1346 | Rewrote screen display and text selection routines. Project Coordinator |
1464 | Rewrote screen display and text selection routines. |
|
|
1465 | |
1347 | (changes.txt 2.4.6 - rxvt-unicode) |
1466 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1348 | |
1467 | |
1349 | =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1468 | =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1350 | |
1469 | |
1351 | Forked rxvt-unicode, rewrote most of the display code and internal |
1470 | Forked rxvt-unicode, unicode support, rewrote almost all the code, perl |
1352 | character handling to store text in unicode, improve xterm |
1471 | extension, random hacks, numerous bugfixes and extensions. |
1353 | compatibility and apply numerous other bugfixes and extensions. |
|
|
1354 | |
1472 | |
1355 | Project Coordinator (Changes 1.0 -) |
1473 | Project Coordinator (Changes 1.0 -) |
1356 | |
1474 | |
|
|
1475 | =item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> |
|
|
1476 | |
|
|
1477 | Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. |
|
|
1478 | |
1357 | =back |
1479 | =back |
1358 | |
1480 | |