… | |
… | |
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 |
… | |
… | |
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 |
… | |
… | |
238 | |
255 | |
239 | Put scrollbar on right/left; resource B<scrollBar_right>. |
256 | Put scrollbar on right/left; resource B<scrollBar_right>. |
240 | |
257 | |
241 | =item B<-st>|B<+st> |
258 | =item B<-st>|B<+st> |
242 | |
259 | |
243 | Display normal (non XTerm/NeXT) scrollbar without/with a trough; |
260 | Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; |
244 | resource B<scrollBar_floating>. |
261 | resource B<scrollBar_floating>. |
245 | |
262 | |
246 | =item B<-ptab>|B<+ptab> |
263 | =item B<-ptab>|B<+ptab> |
247 | |
264 | |
248 | If enabled (default), "Horizontal Tab" characters are being stored as |
265 | If enabled (default), "Horizontal Tab" characters are being stored as |
… | |
… | |
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<-sbg> |
|
|
303 | |
|
|
304 | Compile I<frills>: Disable the usage of the built-in block graphics/line |
|
|
305 | drawing characters and just rely on what the specified fonts provide. Use |
|
|
306 | this if you have a good font and want to use its block graphic glyphs; |
|
|
307 | resource B<skipBuiltinGlyphs>. |
284 | |
308 | |
285 | =item B<-lsp> I<number> |
309 | =item B<-lsp> I<number> |
286 | |
310 | |
287 | Compile I<frills>: Lines (pixel height) to insert between each row of |
311 | Compile I<frills>: Lines (pixel height) to insert between each row of |
288 | the display. Useful to work around font rendering problems; resource |
312 | 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 |
327 | 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 |
328 | 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, |
329 | run the program specified by the B<SHELL> environment variable or, |
306 | failing that, I<sh(1)>. |
330 | failing that, I<sh(1)>. |
307 | |
331 | |
|
|
332 | Please note that you must specify a program with arguments. If you want to |
|
|
333 | run shell commands, you have to specify the shell, like this: |
|
|
334 | |
|
|
335 | @@RXVT_NAME@@ -e sh -c "shell commands" |
|
|
336 | |
308 | =item B<-title> I<text> |
337 | =item B<-title> I<text> |
309 | |
338 | |
310 | Window title (B<-T> still respected); the default title is the basename |
339 | 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 |
340 | of the program specified after the B<-e> option, if any, otherwise the |
312 | application name; resource B<title>. |
341 | application name; resource B<title>. |
… | |
… | |
367 | |
396 | |
368 | =item B<-ssr>|B<+ssr> |
397 | =item B<-ssr>|B<+ssr> |
369 | |
398 | |
370 | Turn on/off secondary screen scroll (default enabled); resource |
399 | Turn on/off secondary screen scroll (default enabled); resource |
371 | B<secondaryScroll>. |
400 | B<secondaryScroll>. |
|
|
401 | |
|
|
402 | =item B<-hold>|B<+hold> |
|
|
403 | |
|
|
404 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
|
|
405 | will not immediately destroy its window when the program executed within |
|
|
406 | it exits. Instead, it will wait till it is being killed or closed by the |
|
|
407 | user; resource B<hold>. |
372 | |
408 | |
373 | =item B<-keysym.>I<sym> I<string> |
409 | =item B<-keysym.>I<sym> I<string> |
374 | |
410 | |
375 | Remap a key symbol. See resource B<keysym>. |
411 | Remap a key symbol. See resource B<keysym>. |
376 | |
412 | |
… | |
… | |
399 | $rxvt->signal_connect_after (realize => sub { |
435 | $rxvt->signal_connect_after (realize => sub { |
400 | my $xid = $_[0]->window->get_xid; |
436 | my $xid = $_[0]->window->get_xid; |
401 | system "@@RXVT_NAME@@ -embed $xid &"; |
437 | system "@@RXVT_NAME@@ -embed $xid &"; |
402 | }); |
438 | }); |
403 | |
439 | |
404 | =item B<-pty-fd> I<fileno> |
440 | =item B<-pty-fd> I<file descriptor> |
405 | |
441 | |
406 | Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty |
442 | 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 |
443 | 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 |
444 | useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator |
409 | without having to run a program within it. |
445 | without having to run a program within it. |
410 | |
446 | |
411 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
447 | 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 |
448 | entries and will not tinker with pty/tty permissions - you have to do that |
413 | yourself if you want that. |
449 | yourself if you want that. |
414 | |
450 | |
|
|
451 | As an extremely special case, specifying C<-1> will completely suppress |
|
|
452 | pty/tty operations. |
|
|
453 | |
415 | Here is a example in perl that illustrates how this option can be used (a |
454 | Here is a example in perl that illustrates how this option can be used (a |
416 | longer example is in F<doc/pty-fd>): |
455 | longer example is in F<doc/pty-fd>): |
417 | |
456 | |
418 | use IO::Pty; |
457 | use IO::Pty; |
419 | use Fcntl; |
458 | use Fcntl; |
… | |
… | |
425 | |
464 | |
426 | # now communicate with rxvt |
465 | # now communicate with rxvt |
427 | my $slave = $pty->slave; |
466 | my $slave = $pty->slave; |
428 | while (<$slave>) { print $slave "got <$_>\n" } |
467 | while (<$slave>) { print $slave "got <$_>\n" } |
429 | |
468 | |
|
|
469 | =item B<-pe> I<string> |
|
|
470 | |
|
|
471 | Comma-separated list of perl extension scripts to use (or not to use) in |
|
|
472 | this terminal instance. See resource B<perl-ext> for details. |
|
|
473 | |
430 | =back |
474 | =back |
431 | |
475 | |
432 | =head1 RESOURCES (available also as long-options) |
476 | =head1 RESOURCES (available also as long-options) |
433 | |
477 | |
434 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
478 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
435 | options) compiled into your version. |
479 | options) compiled into your version. |
436 | |
480 | |
437 | There are two different methods that @@RXVT_NAME@@ can use to get the |
481 | 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 |
482 | distribution do also load settings from the B<~/.Xresources> file when X |
439 | Xresources reader (B<~/.Xdefaults>). For the first method (ie. |
483 | 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 |
484 | 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 | |
485 | |
446 | 1. system-wide app-defaults file, either locale-dependent OR global |
486 | 1. system-wide app-defaults file, either locale-dependent OR global |
447 | 2. app-defaults file in $XAPPLRESDIR |
487 | 2. app-defaults file in $XAPPLRESDIR |
448 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
488 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
449 | 4. SCREEN_RESOURCES for the current screen |
489 | 4. SCREEN_RESOURCES for the current screen |
450 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
490 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
451 | |
491 | |
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 |
492 | 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 |
493 | 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 |
494 | 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 |
495 | configured, while the class name B<URxvt> allows resources unique to |
461 | unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be |
496 | B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@> |
462 | shared between different B<@@RXVT_NAME@@> configurations. If no |
497 | configurations. If no resources are specified, suitable defaults will |
463 | resources are specified, suitable defaults will be used. Command-line |
498 | be used. Command-line arguments can be used to override resource |
464 | arguments can be used to override resource settings. The following |
499 | settings. The following resources are supported (you might want to |
465 | resources are allowed: |
500 | check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl |
|
|
501 | extensions not documented here): |
466 | |
502 | |
467 | =over 4 |
503 | =over 4 |
468 | |
504 | |
469 | =item B<geometry:> I<geom> |
505 | =item B<geometry:> I<geom> |
470 | |
506 | |
… | |
… | |
548 | artificial transparency. B<False>: do not inherit the parent windows' |
584 | artificial transparency. B<False>: do not inherit the parent windows' |
549 | pixmap. |
585 | pixmap. |
550 | |
586 | |
551 | =item B<fading:> I<number> |
587 | =item B<fading:> I<number> |
552 | |
588 | |
553 | Fade the text by the given percentage when focus is lost. |
589 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
|
|
590 | |
|
|
591 | =item B<fadeColor:> I<colour> |
|
|
592 | |
|
|
593 | Fade to this colour, when fading is used (see B<fading:>). The default |
|
|
594 | colour is black; option B<-fadecolor>. |
554 | |
595 | |
555 | =item B<tintColor:> I<colour> |
596 | =item B<tintColor:> I<colour> |
556 | |
597 | |
557 | Tint the transparent background pixmap with the given colour. |
598 | Tint the transparent background pixmap with the given colour; option |
|
|
599 | B<-tint>. |
558 | |
600 | |
559 | =item B<shading:> I<number> |
601 | =item B<shading:> I<number> |
560 | |
602 | |
561 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
603 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
562 | image in addition to tinting it. |
604 | image in addition to tinting it. |
… | |
… | |
566 | Use the specified colour for the scrollbar [default #B2B2B2]. |
608 | Use the specified colour for the scrollbar [default #B2B2B2]. |
567 | |
609 | |
568 | =item B<troughColor:> I<colour> |
610 | =item B<troughColor:> I<colour> |
569 | |
611 | |
570 | Use the specified colour for the scrollbar's trough area [default |
612 | Use the specified colour for the scrollbar's trough area [default |
571 | #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. |
613 | #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar. |
572 | |
614 | |
573 | =item B<borderColor:> I<colour> |
615 | =item B<borderColor:> I<colour> |
574 | |
616 | |
575 | The colour of the border around the text area and between the scrollbar |
617 | The colour of the border around the text area and between the scrollbar |
576 | and the text. |
618 | and the text. |
… | |
… | |
603 | |
645 | |
604 | Select the fonts to be used. This is a comma separated list of font |
646 | Select the fonts to be used. This is a comma separated list of font |
605 | names that are used in turn when trying to display Unicode characters. |
647 | names that are used in turn when trying to display Unicode characters. |
606 | The first font defines the cell size for characters; other fonts might |
648 | The first font defines the cell size for characters; other fonts might |
607 | be smaller, but not larger. A reasonable default font list is always |
649 | be smaller, but not larger. A reasonable default font list is always |
608 | appended to it. option B<-fn>. |
650 | appended to it; option B<-fn>. |
609 | |
651 | |
610 | Each font can either be a standard X11 core font (XLFD) name, with |
652 | 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:>. |
653 | optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. |
612 | |
654 | |
613 | In addition, each font can be prefixed with additional hints and |
655 | In addition, each font can be prefixed with additional hints and |
… | |
… | |
659 | not possible, replacement fonts of the desired shape will be tried. |
701 | not possible, replacement fonts of the desired shape will be tried. |
660 | |
702 | |
661 | If set, but empty, then this specific style is disabled and the normal |
703 | If set, but empty, then this specific style is disabled and the normal |
662 | text font will being used for the given style. |
704 | text font will being used for the given style. |
663 | |
705 | |
|
|
706 | =item B<intensityStyles:> I<boolean> |
|
|
707 | |
|
|
708 | When font styles are not enabled, or this option is enabled (B<True>, |
|
|
709 | option B<-is>, the default), bold and italic font styles imply high |
|
|
710 | intensity foreground/backround colours. Disabling this option (B<False>, |
|
|
711 | option B<+is>) disables this behaviour, the high intensity colours are not |
|
|
712 | reachable. |
|
|
713 | |
664 | =item B<selectstyle:> I<mode> |
714 | =item B<selectstyle:> I<mode> |
665 | |
715 | |
666 | Set mouse selection style to B<old> which is 2.20, B<oldword> which is |
716 | 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 |
717 | xterm style with 2.20 old word selection, or anything else which gives |
668 | xterm style selection. |
718 | xterm style selection. |
669 | |
719 | |
670 | =item B<scrollstyle:> I<mode> |
720 | =item B<scrollstyle:> I<mode> |
671 | |
721 | |
672 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
722 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
673 | the author's favourite.. |
723 | the author's favourite. |
674 | |
724 | |
675 | =item B<title:> I<string> |
725 | =item B<title:> I<string> |
676 | |
726 | |
677 | Set window title string, the default title is the command-line |
727 | Set window title string, the default title is the command-line |
678 | specified after the B<-e> option, if any, otherwise the application |
728 | specified after the B<-e> option, if any, otherwise the application |
… | |
… | |
709 | =item B<print-pipe:> I<string> |
759 | =item B<print-pipe:> I<string> |
710 | |
760 | |
711 | Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use |
761 | Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use |
712 | B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or |
762 | B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or |
713 | B<Shift-Print> to include the scrollback as well. |
763 | B<Shift-Print> to include the scrollback as well. |
|
|
764 | |
|
|
765 | The string will be interpreted as if typed into the shell as-is. |
|
|
766 | |
|
|
767 | Example: |
|
|
768 | |
|
|
769 | URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
|
|
770 | |
|
|
771 | This creates a new file in your home directory with the screen contents |
|
|
772 | everytime you hit C<Print>. |
714 | |
773 | |
715 | =item B<scrollBar:> I<boolean> |
774 | =item B<scrollBar:> I<boolean> |
716 | |
775 | |
717 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
776 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
718 | disable the scrollbar; option B<+sb>. |
777 | disable the scrollbar; option B<+sb>. |
… | |
… | |
769 | =item B<borderLess:> I<boolean> |
828 | =item B<borderLess:> I<boolean> |
770 | |
829 | |
771 | Set MWM hints to request a borderless window, i.e. if honoured by the |
830 | Set MWM hints to request a borderless window, i.e. if honoured by the |
772 | WM, the rxvt-unicode window will not have window decorations; option B<-bl>. |
831 | WM, the rxvt-unicode window will not have window decorations; option B<-bl>. |
773 | |
832 | |
|
|
833 | =item B<skipBuiltinGlyphs:> I<boolean> |
|
|
834 | |
|
|
835 | Compile I<frills>: Disable the usage of the built-in block graphics/line |
|
|
836 | drawing characters and just rely on what the specified fonts provide. Use |
|
|
837 | this if you have a good font and want to use its block graphic glyphs; |
|
|
838 | option B<-sbg>. |
|
|
839 | |
774 | =item B<termName:> I<termname> |
840 | =item B<termName:> I<termname> |
775 | |
841 | |
776 | Specifies the terminal type name to be set in the B<TERM> environment |
842 | Specifies the terminal type name to be set in the B<TERM> environment |
777 | variable; option B<-tn>. |
843 | variable; option B<-tn>. |
778 | |
844 | |
… | |
… | |
815 | |
881 | |
816 | Mouse pointer background colour. |
882 | Mouse pointer background colour. |
817 | |
883 | |
818 | =item B<pointerBlankDelay:> I<number> |
884 | =item B<pointerBlankDelay:> I<number> |
819 | |
885 | |
820 | Specifies number of seconds before blanking the pointer [default 2]. |
886 | Specifies number of seconds before blanking the pointer [default 2]. Use a |
|
|
887 | large number (e.g. C<987654321>) to effectively disable the timeout. |
821 | |
888 | |
822 | =item B<backspacekey:> I<string> |
889 | =item B<backspacekey:> I<string> |
823 | |
890 | |
824 | The string to send when the backspace key is pressed. If set to B<DEC> |
891 | The string to send when the backspace key is pressed. If set to B<DEC> |
825 | or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> |
892 | or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> |
… | |
… | |
850 | =item B<imLocale:> I<name> |
917 | =item B<imLocale:> I<name> |
851 | |
918 | |
852 | The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. |
919 | The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. |
853 | C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the |
920 | C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the |
854 | input extension to be able to input japanese characters while staying in |
921 | input extension to be able to input japanese characters while staying in |
855 | another locale. option B<-imlocale>. |
922 | another locale; option B<-imlocale>. |
856 | |
923 | |
857 | =item B<imFont:> I<fontset> |
924 | =item B<imFont:> I<fontset> |
858 | |
925 | |
859 | Specify the font-set used for XIM styles C<OverTheSpot> or |
926 | Specify the font-set used for XIM styles C<OverTheSpot> or |
860 | C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated |
927 | C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated |
… | |
… | |
865 | |
932 | |
866 | =item B<tripleclickwords:> I<boolean> |
933 | =item B<tripleclickwords:> I<boolean> |
867 | |
934 | |
868 | Change the meaning of triple-click selection with the left mouse |
935 | Change the meaning of triple-click selection with the left mouse |
869 | button. Instead of selecting a full line it will extend the selection to |
936 | button. Instead of selecting a full line it will extend the selection to |
870 | the end of the logical line only. option B<-tcw>. |
937 | the end of the logical line only; option B<-tcw>. |
871 | |
938 | |
872 | =item B<insecure:> I<boolean> |
939 | =item B<insecure:> I<boolean> |
873 | |
940 | |
874 | Enables "insecure" mode. Rxvt-unicode offers some escape sequences that |
941 | Enables "insecure" mode. Rxvt-unicode offers some escape sequences that |
875 | echo arbitrary strings like the icon name or the locale. This could be |
942 | echo arbitrary strings like the icon name or the locale. This could be |
876 | abused if somebody gets 8-bit-clean access to your display, whether |
943 | abused if somebody gets 8-bit-clean access to your display, whether |
877 | throuh a mail client displaying mail bodies unfiltered or though |
944 | through a mail client displaying mail bodies unfiltered or through |
878 | write(1). Therefore, these sequences are disabled by default. (Note |
945 | write(1) or any other means. Therefore, these sequences are disabled by |
879 | that other terminals, including xterm, have these sequences |
946 | default. (Note that many other terminals, including xterm, have these |
880 | enabled by default). You can enable them by setting this boolean |
947 | sequences enabled by default, which doesn't make it safer, though). |
881 | resource or specifying B<-insecure> as an option. At the moment, this |
948 | |
882 | enabled display-answer, locale, findfont, icon label and window title |
949 | You can enable them by setting this boolean resource or specifying |
883 | requests as well as dynamic menubar dispatch. |
950 | B<-insecure> as an option. At the moment, this enables display-answer, |
|
|
951 | locale, findfont, icon label and window title requests as well as dynamic |
|
|
952 | menubar dispatch. |
884 | |
953 | |
885 | =item B<modifier:> I<modifier> |
954 | =item B<modifier:> I<modifier> |
886 | |
955 | |
887 | Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, |
956 | Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, |
888 | B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option |
957 | B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option |
… | |
… | |
902 | |
971 | |
903 | Turn on/off secondary screen scroll (default enabled). If the this |
972 | Turn on/off secondary screen scroll (default enabled). If the this |
904 | option is enabled, scrolls on the secondary screen will change the |
973 | option is enabled, scrolls on the secondary screen will change the |
905 | scrollback buffer and switching to/from the secondary screen will |
974 | scrollback buffer and switching to/from the secondary screen will |
906 | instead scroll the screen up. |
975 | instead scroll the screen up. |
|
|
976 | |
|
|
977 | =item B<hold>: I<bool> |
|
|
978 | |
|
|
979 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
|
|
980 | will not immediately destroy its window when the program executed within |
|
|
981 | it exits. Instead, it will wait till it is being killed or closed by the |
|
|
982 | user. |
907 | |
983 | |
908 | =item B<keysym.>I<sym>: I<string> |
984 | =item B<keysym.>I<sym>: I<string> |
909 | |
985 | |
910 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
986 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
911 | intervening resource name B<keysym.> cannot be omitted. |
987 | intervening resource name B<keysym.> cannot be omitted. |
… | |
… | |
931 | C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, |
1007 | C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, |
932 | C<\000>: octal number) or verbatim control characters (C<^?>: delete, |
1008 | C<\000>: octal number) or verbatim control characters (C<^?>: delete, |
933 | C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it |
1009 | C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it |
934 | can start or end with whitespace. |
1010 | can start or end with whitespace. |
935 | |
1011 | |
936 | Please note that you need to double the C<\> when using |
1012 | Please note that you need to double the C<\> in resource files, as |
937 | C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can |
1013 | Xlib itself does it's own de-escaping (you can use C<\033> instead of |
938 | use C<\033> instead of C<\e> (and so on), which will work with both Xt and |
1014 | C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own |
939 | @@RXVT_NAME@@'s own processing). |
1015 | processing). |
940 | |
1016 | |
941 | You can define a range of keysyms in one shot by providing a I<string> |
1017 | You can define a range of keysyms in one shot by providing a I<string> |
942 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' |
1018 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' |
943 | should be a character not used by the strings. |
1019 | should be a character not used by the strings. |
944 | |
1020 | |
… | |
… | |
957 | example the following means "change the current locale to C<zh_CN.GBK> |
1033 | example the following means "change the current locale to C<zh_CN.GBK> |
958 | when Control-Meta-c is being pressed": |
1034 | when Control-Meta-c is being pressed": |
959 | |
1035 | |
960 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
1036 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
961 | |
1037 | |
|
|
1038 | If I<string> takes the form C<perl:STRING>, then the specified B<STRING> |
|
|
1039 | is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) |
|
|
1040 | manpage. For example, the F<selection> extension (activated via |
|
|
1041 | C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: |
|
|
1042 | |
|
|
1043 | URxvt.keysym.M-C-c: perl:selection:rot13 |
|
|
1044 | |
|
|
1045 | Due the the large number of modifier combinations, a defined key mapping |
|
|
1046 | will match if at I<at least> the specified identifiers are being set, and |
|
|
1047 | no other key mappings with those and more bits are being defined. That |
|
|
1048 | means that defining a key map for C<a> will automatically provide |
|
|
1049 | definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined |
|
|
1050 | mappings themselves. |
|
|
1051 | |
|
|
1052 | Unfortunately, this will override built-in key mappings. For example |
|
|
1053 | if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s |
|
|
1054 | C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the |
|
|
1055 | user-defined keymap using the C<builtin:> replacement: |
|
|
1056 | |
|
|
1057 | URxvt.keysym.Insert: <my insert key sequence> |
|
|
1058 | URxvt.keysym.S-Insert: builtin: |
|
|
1059 | |
|
|
1060 | The first line defines a mapping for C<Insert> and I<any> combination |
|
|
1061 | of modifiers. The second line re-establishes the default mapping for |
|
|
1062 | C<Shift-Insert>. |
|
|
1063 | |
962 | The following example will map Control-Meta-1 and Control-Meta-2 to |
1064 | The following example will map Control-Meta-1 and Control-Meta-2 to |
963 | the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited |
1065 | the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited |
964 | font-switching at runtime: |
1066 | font-switching at runtime: |
965 | |
1067 | |
966 | URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 |
1068 | URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 |
… | |
… | |
969 | Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more |
1071 | Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more |
970 | info): |
1072 | info): |
971 | |
1073 | |
972 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
1074 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
973 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
1075 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
|
|
1076 | |
|
|
1077 | =item B<perl-ext-common>: I<string> |
|
|
1078 | |
|
|
1079 | =item B<perl-ext>: I<string> |
|
|
1080 | |
|
|
1081 | Comma-separated list(s) of perl extension scripts (default: C<default>) to |
|
|
1082 | use in this terminal instance; option B<-pe>. |
|
|
1083 | |
|
|
1084 | Extension names can be prefixed with a C<-> sign to prohibit using |
|
|
1085 | them. This can be useful to selectively disable some extensions loaded |
|
|
1086 | by default, or specified via the C<perl-ext-common> resource. For |
|
|
1087 | example, C<default,-selection> will use all the default extension except |
|
|
1088 | C<selection>. |
|
|
1089 | |
|
|
1090 | Extension names can also be followed by an argument in angle brackets |
|
|
1091 | (e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for |
|
|
1092 | searchable scorllback to Alt/Meta-s). Mentioning the same extension |
|
|
1093 | multiple times with different arguments will pass multiple arguments to |
|
|
1094 | the extension. |
|
|
1095 | |
|
|
1096 | Each extension is looked up in the library directories, loaded if |
|
|
1097 | necessary, and bound to the current terminal instance. |
|
|
1098 | |
|
|
1099 | If both of these resources are the empty string, then the perl |
|
|
1100 | interpreter will not be initialized. The idea behind two options is that |
|
|
1101 | B<perl-ext-common> will be used for extensions that should be available to |
|
|
1102 | all instances, while B<perl-ext> is used for specific instances. |
|
|
1103 | |
|
|
1104 | =item B<perl-eval>: I<string> |
|
|
1105 | |
|
|
1106 | Perl code to be evaluated when all extensions have been registered. See |
|
|
1107 | the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource |
|
|
1108 | will be ignored when running setuid/setgid. |
|
|
1109 | |
|
|
1110 | =item B<perl-lib>: I<path> |
|
|
1111 | |
|
|
1112 | Colon-separated list of additional directories that hold extension |
|
|
1113 | scripts. When looking for extensions specified by the C<perl> resource, |
|
|
1114 | @@RXVT_NAME@@ will first look in these directories and then in |
|
|
1115 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource |
|
|
1116 | will be ignored when running setuid/setgid. |
|
|
1117 | |
|
|
1118 | See the @@RXVT_NAME@@perl(3) manpage. |
|
|
1119 | |
|
|
1120 | =item B<searchable-scrollback:> I<keysym> |
|
|
1121 | |
|
|
1122 | Sets the hotkey that starts the incremental scrollback buffer search |
|
|
1123 | (default: C<M-s>). |
|
|
1124 | |
|
|
1125 | =item B<urlLauncher>: I<string> |
|
|
1126 | |
|
|
1127 | Specifies the program to be started with a URL argument. Used by the |
|
|
1128 | C<selection-popup> and C<mark-urls> perl extensions. |
|
|
1129 | |
|
|
1130 | =item B<transient-for>: I<windowid> |
|
|
1131 | |
|
|
1132 | Sets the WM_TRANSIENT_FOR property to the given window iw. |
974 | |
1133 | |
975 | =back |
1134 | =back |
976 | |
1135 | |
977 | =head1 THE SCROLLBAR |
1136 | =head1 THE SCROLLBAR |
978 | |
1137 | |
… | |
… | |
1013 | to select a word; Left triple-click to select the entire logical line |
1172 | to select a word; Left triple-click to select the entire logical line |
1014 | (which can span multiple screen lines), unless modified by resource |
1173 | (which can span multiple screen lines), unless modified by resource |
1015 | B<tripleclickwords>. |
1174 | B<tripleclickwords>. |
1016 | |
1175 | |
1017 | Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) |
1176 | Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) |
1018 | (Compile: I<frills>) will create a rectangular selection instead of a normal |
1177 | (Compile: I<frills>) will create a rectangular selection instead of a |
1019 | one. |
1178 | normal one. In this mode, every selected row becomes its own line in the |
|
|
1179 | selection, and trailing whitespace is visually underlined and removed from |
|
|
1180 | the selection. |
1020 | |
1181 | |
1021 | =item B<Insertion>: |
1182 | =item B<Insertion>: |
1022 | |
1183 | |
1023 | Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in |
1184 | Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in |
1024 | an B<@@RXVT_NAME@@> window causes the current text selection to be |
1185 | an B<@@RXVT_NAME@@> window causes the current text selection to be |
… | |
… | |
1032 | supported in rxvt-unicode. Bug me if you need this. |
1193 | supported in rxvt-unicode. Bug me if you need this. |
1033 | |
1194 | |
1034 | You can, however, switch fonts at runtime using escape sequences (and |
1195 | You can, however, switch fonts at runtime using escape sequences (and |
1035 | therefore using the menubar), e.g.: |
1196 | therefore using the menubar), e.g.: |
1036 | |
1197 | |
1037 | printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" |
1198 | printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" |
1038 | |
1199 | |
1039 | rxvt-unicode will automatically re-apply these fonts to the output so far. |
1200 | rxvt-unicode will automatically re-apply these fonts to the output so far. |
1040 | |
1201 | |
1041 | =head1 ISO 14755 SUPPORT |
1202 | =head1 ISO 14755 SUPPORT |
1042 | |
1203 | |
… | |
… | |
1218 | =item B<RXVT_SOCKET> |
1379 | =item B<RXVT_SOCKET> |
1219 | |
1380 | |
1220 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1381 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1221 | @@RXVT_NAME@@d(1). |
1382 | @@RXVT_NAME@@d(1). |
1222 | |
1383 | |
1223 | Default C<< $HOME/.rxvt-unicode-<nodename >>. |
1384 | Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. |
1224 | |
1385 | |
1225 | =item B<HOME> |
1386 | =item B<HOME> |
1226 | |
1387 | |
1227 | Used to locate the default directory for the unix domain socket for |
1388 | Used to locate the default directory for the unix domain socket for |
1228 | daemon communications and to locate various resource files (such as |
1389 | daemon communications and to locate various resource files (such as |
… | |
… | |
1249 | |
1410 | |
1250 | =back |
1411 | =back |
1251 | |
1412 | |
1252 | =head1 SEE ALSO |
1413 | =head1 SEE ALSO |
1253 | |
1414 | |
1254 | @@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) |
1415 | @@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) |
1255 | |
|
|
1256 | =head1 BUGS |
|
|
1257 | |
|
|
1258 | Check the BUGS file for an up-to-date list. |
|
|
1259 | |
|
|
1260 | Cursor change support is not yet implemented. |
|
|
1261 | |
|
|
1262 | Click-and-drag doesn't work with X11 mouse report overriding. |
|
|
1263 | |
1416 | |
1264 | =head1 CURRENT PROJECT COORDINATOR |
1417 | =head1 CURRENT PROJECT COORDINATOR |
1265 | |
1418 | |
1266 | =over 4 |
1419 | =over 4 |
1267 | |
1420 | |