… | |
… | |
14 | configurability. As a result, B<rxvt-unicode> uses much less swap space -- |
14 | configurability. As a result, B<rxvt-unicode> uses much less swap space -- |
15 | a significant advantage on a machine serving many X sessions. |
15 | a significant advantage on a machine serving many X sessions. |
16 | |
16 | |
17 | =head1 FREQUENTLY ASKED QUESTIONS |
17 | =head1 FREQUENTLY ASKED QUESTIONS |
18 | |
18 | |
19 | See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of frequently |
19 | See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of |
20 | asked questions and answer to them and some common problems. |
20 | frequently asked questions and answer to them and some common |
|
|
21 | problems. That document is also accessible on the World-Wide-Web at |
|
|
22 | L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. |
21 | |
23 | |
22 | =head1 RXVT-UNICODE VS. RXVT |
24 | =head1 RXVT-UNICODE VS. RXVT |
23 | |
25 | |
24 | Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode |
26 | Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode |
25 | internally. That means it can store and display most scripts in the |
27 | internally. That means it can store and display most scripts in the |
… | |
… | |
103 | |
105 | |
104 | =item B<-j>|B<+j> |
106 | =item B<-j>|B<+j> |
105 | |
107 | |
106 | Turn on/off jump scrolling; resource B<jumpScroll>. |
108 | Turn on/off jump scrolling; resource B<jumpScroll>. |
107 | |
109 | |
108 | =item B<-ip>|B<+ip> |
110 | =item B<-ip>|B<+ip> | B<-tr>|B<+tr> |
109 | |
111 | |
110 | Turn on/off inheriting parent window's pixmap. Alternative form is |
112 | Turn on/off inheriting parent window's pixmap. Alternative form is |
111 | B<-tr>; resource B<inheritPixmap>. |
113 | B<-tr>; resource B<inheritPixmap>. |
112 | |
114 | |
113 | =item B<-fade> I<number> |
115 | =item B<-fade> I<number> |
114 | |
116 | |
115 | 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>. |
116 | |
125 | |
117 | =item B<-tint> I<colour> |
126 | =item B<-tint> I<colour> |
118 | |
127 | |
119 | Tint the transparent background pixmap with the given colour when |
128 | Tint the transparent background pixmap with the given colour when |
120 | 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 |
121 | 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 |
122 | 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 |
123 | |
135 | |
124 | =item B<-sh> |
136 | =item B<-sh> |
125 | |
137 | |
126 | I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
138 | I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
127 | 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 |
… | |
… | |
236 | |
248 | |
237 | Put scrollbar on right/left; resource B<scrollBar_right>. |
249 | Put scrollbar on right/left; resource B<scrollBar_right>. |
238 | |
250 | |
239 | =item B<-st>|B<+st> |
251 | =item B<-st>|B<+st> |
240 | |
252 | |
241 | Display normal (non XTerm/NeXT) scrollbar without/with a trough; |
253 | Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; |
242 | resource B<scrollBar_floating>. |
254 | resource B<scrollBar_floating>. |
243 | |
255 | |
244 | =item B<-ptab>|B<+ptab> |
256 | =item B<-ptab>|B<+ptab> |
245 | |
257 | |
246 | If enabled (default), "Horizontal Tab" characters are being stored as |
258 | If enabled (default), "Horizontal Tab" characters are being stored as |
… | |
… | |
328 | |
340 | |
329 | Compile I<XIM>: input method name. resource B<inputMethod>. |
341 | Compile I<XIM>: input method name. resource B<inputMethod>. |
330 | |
342 | |
331 | =item B<-imlocale> I<string> |
343 | =item B<-imlocale> I<string> |
332 | |
344 | |
333 | The locale to use for opening the IM. You can use an LC_CTYPE of e.g. |
345 | The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. |
334 | de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input |
346 | C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the |
335 | extension to be able to input japanese characters while staying in |
347 | input extension to be able to input japanese characters while staying in |
336 | another locale. |
348 | another locale. resource B<imLocale>. |
|
|
349 | |
|
|
350 | =item B<-imfont> I<fontset> |
|
|
351 | |
|
|
352 | Set the font set to use for the X Input Method, see resource B<imFont> |
|
|
353 | for more info. |
|
|
354 | |
|
|
355 | =item B<-tcw> |
|
|
356 | |
|
|
357 | Change the meaning of triple-click selection with the left mouse |
|
|
358 | button. Instead of selecting a full line it will extend the selection the |
|
|
359 | end of the logical line only. resource B<tripleclickwords>. |
337 | |
360 | |
338 | =item B<-insecure> |
361 | =item B<-insecure> |
339 | |
362 | |
340 | Enable "insecure" mode, which currently enables most of the escape |
363 | Enable "insecure" mode, which currently enables most of the escape |
341 | sequences that echo strings. See the resource B<insecure> for more |
364 | sequences that echo strings. See the resource B<insecure> for more |
… | |
… | |
355 | =item B<-ssr>|B<+ssr> |
378 | =item B<-ssr>|B<+ssr> |
356 | |
379 | |
357 | Turn on/off secondary screen scroll (default enabled); resource |
380 | Turn on/off secondary screen scroll (default enabled); resource |
358 | B<secondaryScroll>. |
381 | B<secondaryScroll>. |
359 | |
382 | |
360 | =item B<-xrm> I<resourcestring> |
383 | =item B<-keysym.>I<sym> I<string> |
361 | |
384 | |
362 | No effect on rxvt-unicode. Simply passes through an argument to be made |
385 | Remap a key symbol. See resource B<keysym>. |
363 | available in the instance's argument list. Appears in I<WM_COMMAND> in |
386 | |
364 | some window managers. |
387 | =item B<-embed> I<windowid> |
|
|
388 | |
|
|
389 | Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, |
|
|
390 | which enables applications to easily embed a terminal. |
|
|
391 | |
|
|
392 | Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it |
|
|
393 | shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it |
|
|
394 | quite a bit, so don't expect it to keep some specific state. It's best to |
|
|
395 | create an extra subwindow for @@RXVT_NAME@@ and leave it alone. |
|
|
396 | |
|
|
397 | The window will not be destroyed when @@RXVT_NAME@@ exits. |
|
|
398 | |
|
|
399 | It might be useful to know that @@RXVT_NAME@@ will not close file |
|
|
400 | descriptors passed to it (except for stdin/out/err, of course), so you |
|
|
401 | can use file descriptors to communicate with the programs within the |
|
|
402 | terminal. This works regardless of wether the C<-embed> option was used or |
|
|
403 | not. |
|
|
404 | |
|
|
405 | Here is a short Gtk2-perl snippet that illustrates how this option can be |
|
|
406 | used (a longer example is in F<doc/embed>): |
|
|
407 | |
|
|
408 | my $rxvt = new Gtk2::Socket; |
|
|
409 | $rxvt->signal_connect_after (realize => sub { |
|
|
410 | my $xid = $_[0]->window->get_xid; |
|
|
411 | system "@@RXVT_NAME@@ -embed $xid &"; |
|
|
412 | }); |
|
|
413 | |
|
|
414 | =item B<-pty-fd> I<fileno> |
|
|
415 | |
|
|
416 | Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty |
|
|
417 | pair but instead use the given filehandle as the tty master. This is |
|
|
418 | useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator |
|
|
419 | without having to run a program within it. |
|
|
420 | |
|
|
421 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
|
|
422 | entries and will not tinker with pty/tty permissions - you have to do that |
|
|
423 | yourself if you want that. |
|
|
424 | |
|
|
425 | Here is a example in perl that illustrates how this option can be used (a |
|
|
426 | longer example is in F<doc/pty-fd>): |
|
|
427 | |
|
|
428 | use IO::Pty; |
|
|
429 | use Fcntl; |
|
|
430 | |
|
|
431 | my $pty = new IO::Pty; |
|
|
432 | fcntl $pty, F_SETFD, 0; # clear close-on-exec |
|
|
433 | system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&"; |
|
|
434 | close $pty; |
|
|
435 | |
|
|
436 | # now communicate with rxvt |
|
|
437 | my $slave = $pty->slave; |
|
|
438 | while (<$slave>) { print $slave "got <$_>\n" } |
365 | |
439 | |
366 | =back |
440 | =back |
367 | |
441 | |
368 | =head1 RESOURCES (available also as long-options) |
442 | =head1 RESOURCES (available also as long-options) |
369 | |
443 | |
… | |
… | |
372 | |
446 | |
373 | There are two different methods that @@RXVT_NAME@@ can use to get the |
447 | There are two different methods that @@RXVT_NAME@@ can use to get the |
374 | Xresource data: using the X libraries (Xrm*-functions) or internal |
448 | Xresource data: using the X libraries (Xrm*-functions) or internal |
375 | Xresources reader (B<~/.Xdefaults>). For the first method (ie. |
449 | Xresources reader (B<~/.Xdefaults>). For the first method (ie. |
376 | B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the |
450 | B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the |
377 | resources using X11 tools like B<xset>. Many distribution do also load |
451 | resources using X11 tools like B<xrdb>. Many distribution do also load |
378 | settings from the B<~/.Xresources> file when X starts. |
452 | settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@ |
|
|
453 | will consult the following files/resources in order, with later settings |
|
|
454 | overwriting earlier ones: |
|
|
455 | |
|
|
456 | 1. system-wide app-defaults file, either locale-dependent OR global |
|
|
457 | 2. app-defaults file in $XAPPLRESDIR |
|
|
458 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
|
|
459 | 4. SCREEN_RESOURCES for the current screen |
|
|
460 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
379 | |
461 | |
380 | If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> |
462 | If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> |
381 | lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults |
463 | lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults |
382 | set in XAPPLOADDIR/URxvt (compile-time defined: usually |
464 | set in XAPPLOADDIR/URxvt (compile-time defined: usually |
383 | B</usr/lib/X11/app-defaults/URxvt>) and resources set in |
465 | B</usr/lib/X11/app-defaults/URxvt>) and resources set in |
… | |
… | |
476 | artificial transparency. B<False>: do not inherit the parent windows' |
558 | artificial transparency. B<False>: do not inherit the parent windows' |
477 | pixmap. |
559 | pixmap. |
478 | |
560 | |
479 | =item B<fading:> I<number> |
561 | =item B<fading:> I<number> |
480 | |
562 | |
481 | Fade the text by the given percentage when focus is lost. |
563 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
|
|
564 | |
|
|
565 | =item B<fadeColor:> I<colour> |
|
|
566 | |
|
|
567 | Fade to this colour, when fading is used (see B<fading:>). The default |
|
|
568 | colour is black; option B<-fadecolor>. |
482 | |
569 | |
483 | =item B<tintColor:> I<colour> |
570 | =item B<tintColor:> I<colour> |
484 | |
571 | |
485 | Tint the transparent background pixmap with the given colour. |
572 | Tint the transparent background pixmap with the given colour; option |
|
|
573 | B<-tint>. |
486 | |
574 | |
487 | =item B<shading:> I<number> |
575 | =item B<shading:> I<number> |
488 | |
576 | |
489 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
577 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
490 | image in addition to tinting it. |
578 | image in addition to tinting it. |
… | |
… | |
494 | Use the specified colour for the scrollbar [default #B2B2B2]. |
582 | Use the specified colour for the scrollbar [default #B2B2B2]. |
495 | |
583 | |
496 | =item B<troughColor:> I<colour> |
584 | =item B<troughColor:> I<colour> |
497 | |
585 | |
498 | Use the specified colour for the scrollbar's trough area [default |
586 | Use the specified colour for the scrollbar's trough area [default |
499 | #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. |
587 | #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar. |
500 | |
588 | |
501 | =item B<borderColor:> I<colour> |
589 | =item B<borderColor:> I<colour> |
502 | |
590 | |
503 | The colour of the border around the text area and between the scrollbar |
591 | The colour of the border around the text area and between the scrollbar |
504 | and the text. |
592 | and the text. |
… | |
… | |
596 | xterm style selection. |
684 | xterm style selection. |
597 | |
685 | |
598 | =item B<scrollstyle:> I<mode> |
686 | =item B<scrollstyle:> I<mode> |
599 | |
687 | |
600 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
688 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
601 | the author's favourite.. |
689 | the author's favourite. |
602 | |
690 | |
603 | =item B<title:> I<string> |
691 | =item B<title:> I<string> |
604 | |
692 | |
605 | Set window title string, the default title is the command-line |
693 | Set window title string, the default title is the command-line |
606 | specified after the B<-e> option, if any, otherwise the application |
694 | specified after the B<-e> option, if any, otherwise the application |
… | |
… | |
638 | |
726 | |
639 | Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use |
727 | Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use |
640 | B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or |
728 | B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or |
641 | B<Shift-Print> to include the scrollback as well. |
729 | B<Shift-Print> to include the scrollback as well. |
642 | |
730 | |
|
|
731 | The string will be interpreted as if typed into the shell as-is. |
|
|
732 | |
|
|
733 | Example: |
|
|
734 | |
|
|
735 | URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
|
|
736 | |
|
|
737 | This creates a new file in your home directory with the screen contents |
|
|
738 | everytime you hit C<Print>. |
|
|
739 | |
643 | =item B<scrollBar:> I<boolean> |
740 | =item B<scrollBar:> I<boolean> |
644 | |
741 | |
645 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
742 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
646 | disable the scrollbar; option B<+sb>. |
743 | disable the scrollbar; option B<+sb>. |
647 | |
744 | |
… | |
… | |
667 | B<+si>. |
764 | B<+si>. |
668 | |
765 | |
669 | =item B<scrollWithBuffer:> I<boolean> |
766 | =item B<scrollWithBuffer:> I<boolean> |
670 | |
767 | |
671 | B<True>: scroll with scrollback buffer when tty receives new lines (and |
768 | B<True>: scroll with scrollback buffer when tty receives new lines (and |
672 | B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll |
769 | B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll |
673 | with scrollback buffer when tty recieves new lines; option B<-sw>. |
770 | with scrollback buffer when tty recieves new lines; option B<+sw>. |
674 | |
771 | |
675 | =item B<scrollTtyKeypress:> I<boolean> |
772 | =item B<scrollTtyKeypress:> I<boolean> |
676 | |
773 | |
677 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
774 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
678 | are those which are intercepted by rxvt-unicode for special handling and |
775 | are those which are intercepted by rxvt-unicode for special handling and |
… | |
… | |
743 | |
840 | |
744 | Mouse pointer background colour. |
841 | Mouse pointer background colour. |
745 | |
842 | |
746 | =item B<pointerBlankDelay:> I<number> |
843 | =item B<pointerBlankDelay:> I<number> |
747 | |
844 | |
748 | Specifies number of seconds before blanking the pointer [default 2]. |
845 | Specifies number of seconds before blanking the pointer [default 2]. Use a |
|
|
846 | large number (e.g. C<987654321>) to effectively disable the timeout. |
749 | |
847 | |
750 | =item B<backspacekey:> I<string> |
848 | =item B<backspacekey:> I<string> |
751 | |
849 | |
752 | The string to send when the backspace key is pressed. If set to B<DEC> |
850 | The string to send when the backspace key is pressed. If set to B<DEC> |
753 | or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> |
851 | or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> |
… | |
… | |
775 | |
873 | |
776 | I<name> of inputMethod to use; option B<-im>. |
874 | I<name> of inputMethod to use; option B<-im>. |
777 | |
875 | |
778 | =item B<imLocale:> I<name> |
876 | =item B<imLocale:> I<name> |
779 | |
877 | |
780 | The locale to use for opening the IM. You can use an LC_CTYPE of e.g. |
878 | The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. |
781 | de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input |
879 | C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the |
782 | extension to be able to input japanese characters while staying in |
880 | input extension to be able to input japanese characters while staying in |
783 | another locale. option B<-imlocale>. |
881 | another locale. option B<-imlocale>. |
|
|
882 | |
|
|
883 | =item B<imFont:> I<fontset> |
|
|
884 | |
|
|
885 | Specify the font-set used for XIM styles C<OverTheSpot> or |
|
|
886 | C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated |
|
|
887 | by commas), i.e. it's not in the same format as the other font lists used |
|
|
888 | in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found |
|
|
889 | found, preferably one or two pixels differing in size to the base font. |
|
|
890 | option B<-imfont>. |
|
|
891 | |
|
|
892 | =item B<tripleclickwords:> I<boolean> |
|
|
893 | |
|
|
894 | Change the meaning of triple-click selection with the left mouse |
|
|
895 | button. Instead of selecting a full line it will extend the selection to |
|
|
896 | the end of the logical line only. option B<-tcw>. |
784 | |
897 | |
785 | =item B<insecure:> I<boolean> |
898 | =item B<insecure:> I<boolean> |
786 | |
899 | |
787 | Enables "insecure" mode. Rxvt-unicode offers some escape sequences that |
900 | Enables "insecure" mode. Rxvt-unicode offers some escape sequences that |
788 | echo arbitrary strings like the icon name or the locale. This could be |
901 | echo arbitrary strings like the icon name or the locale. This could be |
… | |
… | |
829 | and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, |
942 | and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, |
830 | B<2>, B<3>, B<4>, B<5>. |
943 | B<2>, B<3>, B<4>, B<5>. |
831 | |
944 | |
832 | The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to |
945 | The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to |
833 | whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr |
946 | whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr |
834 | keys are being mapped. B<AppKeypad> is a artificial modifier mapped to the |
947 | keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the |
835 | current application keymap mode state. |
948 | current application keymap mode state. |
836 | |
949 | |
837 | The spellings of I<key> can be obtained by using B<xev>(1) command or |
950 | The spellings of I<key> can be obtained by using B<xev>(1) command or |
838 | searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and |
951 | searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and |
839 | omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex |
952 | omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex |
… | |
… | |
844 | C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, |
957 | C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, |
845 | C<\000>: octal number) or verbatim control characters (C<^?>: delete, |
958 | C<\000>: octal number) or verbatim control characters (C<^?>: delete, |
846 | C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it |
959 | C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it |
847 | can start or end with whitespace. |
960 | can start or end with whitespace. |
848 | |
961 | |
|
|
962 | Please note that you need to double the C<\> when using |
|
|
963 | C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can |
|
|
964 | use C<\033> instead of C<\e> (and so on), which will work with both Xt and |
|
|
965 | @@RXVT_NAME@@'s own processing). |
|
|
966 | |
849 | You can define a range of keysyms in one shot by providing a I<string> |
967 | You can define a range of keysyms in one shot by providing a I<string> |
850 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' |
968 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' |
851 | should be a character not used by the strings. |
969 | should be a character not used by the strings. |
852 | |
970 | |
853 | Its usage can be demonstrated by an example: |
971 | Its usage can be demonstrated by an example: |
854 | |
972 | |
855 | URxvt.keysym.M-C-0x61: list|\e<M-C-|abc|> |
973 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
856 | |
974 | |
857 | The above line is equivalent to the following three lines: |
975 | The above line is equivalent to the following three lines: |
858 | |
976 | |
859 | URxvt.keysym.Meta-Control-0x61: \e<M-C-a> |
977 | URxvt.keysym.Meta-Control-0x61: \033<M-C-a> |
860 | URxvt.keysym.Meta-Control-0x62: \e<M-C-b> |
978 | URxvt.keysym.Meta-Control-0x62: \033<M-C-b> |
861 | URxvt.keysym.Meta-Control-0x63: \e<M-C-c> |
979 | URxvt.keysym.Meta-Control-0x63: \033<M-C-c> |
862 | |
980 | |
863 | If I<string> takes the form of C<proto:STRING>, the specified B<STRING> is |
981 | If I<string> takes the form of C<command:STRING>, the specified B<STRING> |
864 | interpreted and executed as @@RXVT_NAME@@'s control sequence. For example, |
982 | is interpreted and executed as @@RXVT_NAME@@'s control sequence. For |
865 | C<proto:\033]701;zh_CN.GBK\007> means: change the current locale to |
983 | example the following means "change the current locale to C<zh_CN.GBK> |
866 | C<zh_CN.GBK>. |
984 | when Control-Meta-c is being pressed": |
|
|
985 | |
|
|
986 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
|
|
987 | |
|
|
988 | Due the the large number of modifier combinations, a defined key mapping |
|
|
989 | will match if at I<at least> the specified identifiers are being set, and |
|
|
990 | no other key mappings with those and more bits are being defined. That |
|
|
991 | means that defining a key map for C<a> will automatically provide |
|
|
992 | definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined |
|
|
993 | mappings themselves. |
|
|
994 | |
|
|
995 | Unfortunately, this will override built-in key mappings. For example |
|
|
996 | if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s |
|
|
997 | C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the |
|
|
998 | user-defined keymap using the C<builtin:> replacement: |
|
|
999 | |
|
|
1000 | URxvt.keysym.Insert: <my insert key sequence> |
|
|
1001 | URxvt.keysym.S-Insert: builtin: |
|
|
1002 | |
|
|
1003 | The first line defines a mapping for C<Insert> and I<any> combination |
|
|
1004 | of modifiers. The second line re-establishes the default mapping for |
|
|
1005 | C<Shift-Insert>. |
|
|
1006 | |
|
|
1007 | The following example will map Control-Meta-1 and Control-Meta-2 to |
|
|
1008 | the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited |
|
|
1009 | font-switching at runtime: |
|
|
1010 | |
|
|
1011 | URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 |
|
|
1012 | URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 |
|
|
1013 | |
|
|
1014 | Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more |
|
|
1015 | info): |
|
|
1016 | |
|
|
1017 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
|
|
1018 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
867 | |
1019 | |
868 | =back |
1020 | =back |
869 | |
1021 | |
870 | =head1 THE SCROLLBAR |
1022 | =head1 THE SCROLLBAR |
871 | |
1023 | |
… | |
… | |
885 | the normal text selection/insertion, hold either the Shift or the Meta |
1037 | the normal text selection/insertion, hold either the Shift or the Meta |
886 | (Alt) key while performing the desired mouse action. |
1038 | (Alt) key while performing the desired mouse action. |
887 | |
1039 | |
888 | If mouse reporting mode is active, the normal scrollbar actions are |
1040 | If mouse reporting mode is active, the normal scrollbar actions are |
889 | disabled -- on the assumption that we are using a fullscreen |
1041 | disabled -- on the assumption that we are using a fullscreen |
890 | application. Instead, pressing Button1 and Button3 sends B<ESC[6~> |
1042 | application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> |
891 | (Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the |
1043 | (Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the |
892 | up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down), |
1044 | up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), |
893 | respectively. |
1045 | respectively. |
894 | |
1046 | |
895 | =head1 TEXT SELECTION AND INSERTION |
1047 | =head1 TEXT SELECTION AND INSERTION |
896 | |
1048 | |
897 | The behaviour of text selection and insertion mechanism is similar to |
1049 | The behaviour of text selection and insertion mechanism is similar to |
… | |
… | |
899 | |
1051 | |
900 | =over 4 |
1052 | =over 4 |
901 | |
1053 | |
902 | =item B<Selection>: |
1054 | =item B<Selection>: |
903 | |
1055 | |
904 | Left click at the beginning of the region, drag to the end of the |
1056 | Left click at the beginning of the region, drag to the end of the region |
905 | region and release; Right click to extend the marked region; Left |
1057 | and release; Right click to extend the marked region; Left double-click |
906 | double-click to select a word; Left triple-click to select the entire |
1058 | to select a word; Left triple-click to select the entire logical line |
907 | line. |
1059 | (which can span multiple screen lines), unless modified by resource |
|
|
1060 | B<tripleclickwords>. |
908 | |
1061 | |
909 | Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) |
1062 | Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) |
910 | (Compile: I<frills>) will create a rectangular selection instead of a normal |
1063 | (Compile: I<frills>) will create a rectangular selection instead of a normal |
911 | one. |
1064 | one. |
912 | |
1065 | |
… | |
… | |
938 | C<--enable-frills>, the rest is available when rxvt-unicode was compiled |
1091 | C<--enable-frills>, the rest is available when rxvt-unicode was compiled |
939 | with C<--enable-iso14755>. |
1092 | with C<--enable-iso14755>. |
940 | |
1093 | |
941 | =over 4 |
1094 | =over 4 |
942 | |
1095 | |
943 | =item 5.1: Basic method |
1096 | =item * 5.1: Basic method |
944 | |
1097 | |
945 | This allows you to enter unicode characters using their hexcode. |
1098 | This allows you to enter unicode characters using their hexcode. |
946 | |
1099 | |
947 | Start by pressing and holding both C<Control> and C<Shift>, then enter |
1100 | Start by pressing and holding both C<Control> and C<Shift>, then enter |
948 | hex-digits (between one and six). Releasing C<Control> and C<Shift> will |
1101 | hex-digits (between one and six). Releasing C<Control> and C<Shift> will |
… | |
… | |
955 | address, which you cannot type. Fortunately, the card has the e-mail |
1108 | address, which you cannot type. Fortunately, the card has the e-mail |
956 | address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily |
1109 | address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily |
957 | by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>, |
1110 | by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>, |
958 | followed by releasing the modifier keys. |
1111 | followed by releasing the modifier keys. |
959 | |
1112 | |
960 | =item 5.2: Keyboard symbols entry method |
1113 | =item * 5.2: Keyboard symbols entry method |
961 | |
1114 | |
962 | This mode lets you input characters representing the keycap symbols of |
1115 | This mode lets you input characters representing the keycap symbols of |
963 | your keyboard, if representable in the current locale encoding. |
1116 | your keyboard, if representable in the current locale encoding. |
964 | |
1117 | |
965 | Start by pressing C<Control> and C<Shift> together, then releasing |
1118 | Start by pressing C<Control> and C<Shift> together, then releasing |
… | |
… | |
968 | keycap symbol. The symbol will only be entered when the key has been |
1121 | keycap symbol. The symbol will only be entered when the key has been |
969 | released, otherwise pressing e.g. C<Shift> would enter the symbol for |
1122 | released, otherwise pressing e.g. C<Shift> would enter the symbol for |
970 | C<ISO Level 2 Switch>, although your intention might have been to enter a |
1123 | C<ISO Level 2 Switch>, although your intention might have been to enter a |
971 | reverse tab (Shift-Tab). |
1124 | reverse tab (Shift-Tab). |
972 | |
1125 | |
973 | =item 5.3: Screen-selection entry method |
1126 | =item * 5.3: Screen-selection entry method |
974 | |
1127 | |
975 | While this is implemented already (it's basically the selection |
1128 | While this is implemented already (it's basically the selection |
976 | mechanism), it could be extended by displaying a unicode character map. |
1129 | mechanism), it could be extended by displaying a unicode character map. |
977 | |
1130 | |
978 | =item 5.4: Feedback method for identifying displayed characters for later input |
1131 | =item * 5.4: Feedback method for identifying displayed characters for later input |
979 | |
1132 | |
980 | This method lets you display the unicode character code associated with |
1133 | This method lets you display the unicode character code associated with |
981 | characters already displayed. |
1134 | characters already displayed. |
982 | |
1135 | |
983 | You enter this mode by holding down C<Control> and C<Shift> together, then |
1136 | You enter this mode by holding down C<Control> and C<Shift> together, then |
… | |
… | |
995 | With respect to conformance, rxvt-unicode is supposed to be compliant to |
1148 | With respect to conformance, rxvt-unicode is supposed to be compliant to |
996 | both scenario A and B of ISO 14755, including part 5.2. |
1149 | both scenario A and B of ISO 14755, including part 5.2. |
997 | |
1150 | |
998 | =head1 LOGIN STAMP |
1151 | =head1 LOGIN STAMP |
999 | |
1152 | |
1000 | B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so |
1153 | B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that |
1001 | that it can be seen via the I<who(1)> command, and can accept messages. |
1154 | it can be seen via the I<who(1)> command, and can accept messages. To |
1002 | To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on |
1155 | allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root |
1003 | some systems. |
1156 | on some systems or setgid to root or to some other group on others. |
1004 | |
1157 | |
1005 | =head1 COLORS AND GRAPHICS |
1158 | =head1 COLORS AND GRAPHICS |
1006 | |
1159 | |
1007 | In addition to the default foreground and background colours, |
1160 | In addition to the default foreground and background colours, |
1008 | B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus |
1161 | B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus |
… | |
… | |
1051 | |
1204 | |
1052 | =back |
1205 | =back |
1053 | |
1206 | |
1054 | =head1 ENVIRONMENT |
1207 | =head1 ENVIRONMENT |
1055 | |
1208 | |
1056 | B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> |
1209 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
1057 | and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X |
1210 | |
1058 | window id number of the B<@@RXVT_NAME@@> window and it also uses and |
1211 | =over 4 |
1059 | sets the environment variable B<DISPLAY> to specify which display |
1212 | |
1060 | terminal to use. B<@@RXVT_NAME@@> uses the environment variables |
1213 | =item B<TERM> |
1061 | B<RXVTPATH> and B<PATH> to find XPM files. |
1214 | |
|
|
1215 | Normally set to C<rxvt-unicode>, unless overwritten at configure time, via |
|
|
1216 | resources or on the commandline. |
|
|
1217 | |
|
|
1218 | =item B<COLORTERM> |
|
|
1219 | |
|
|
1220 | Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was |
|
|
1221 | compiled with XPM support, and optionally with the added extension |
|
|
1222 | C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. |
|
|
1223 | |
|
|
1224 | =item B<COLORFGBG> |
|
|
1225 | |
|
|
1226 | Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is |
|
|
1227 | the colour code used as default foreground/text colour (or the string |
|
|
1228 | C<default> to indicate that the default-colour escape sequence is to be |
|
|
1229 | used), C<bg> is the colour code used as default background colour (or the |
|
|
1230 | string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ |
|
|
1231 | was compiled with XPM support. Libraries like C<ncurses> and C<slang> can |
|
|
1232 | (and do) use this information to optimize screen output. |
|
|
1233 | |
|
|
1234 | =item B<WINDOWID> |
|
|
1235 | |
|
|
1236 | Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel |
|
|
1237 | window, which usually has subwindows for the scrollbar, the terminal |
|
|
1238 | window and so on). |
|
|
1239 | |
|
|
1240 | =item B<TERMINFO> |
|
|
1241 | |
|
|
1242 | Set to the terminfo directory iff @@RXVT_NAME@@ was configured with |
|
|
1243 | C<--with-terminfo=PATH>. |
|
|
1244 | |
|
|
1245 | =item B<DISPLAY> |
|
|
1246 | |
|
|
1247 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
|
|
1248 | display in it's child processes. |
|
|
1249 | |
|
|
1250 | =item B<SHELL> |
|
|
1251 | |
|
|
1252 | The shell to be used for command execution, defaults to C</bin/sh>. |
|
|
1253 | |
|
|
1254 | =item B<RXVTPATH> |
|
|
1255 | |
|
|
1256 | The path where @@RXVT_NAME@@ looks for support files such as menu and xpm |
|
|
1257 | files. |
|
|
1258 | |
|
|
1259 | =item B<PATH> |
|
|
1260 | |
|
|
1261 | Used in the same way as C<RXVTPATH>. |
|
|
1262 | |
|
|
1263 | =item B<RXVT_SOCKET> |
|
|
1264 | |
|
|
1265 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
|
|
1266 | @@RXVT_NAME@@d(1). |
|
|
1267 | |
|
|
1268 | Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. |
|
|
1269 | |
|
|
1270 | =item B<HOME> |
|
|
1271 | |
|
|
1272 | Used to locate the default directory for the unix domain socket for |
|
|
1273 | daemon communications and to locate various resource files (such as |
|
|
1274 | C<.Xdefaults>) |
|
|
1275 | |
|
|
1276 | =item B<XAPPLRESDIR> |
|
|
1277 | |
|
|
1278 | Directory where various X resource files are being located. |
|
|
1279 | |
|
|
1280 | =item B<XENVIRONMENT> |
|
|
1281 | |
|
|
1282 | If set and accessible, gives the name of a X resource file to be loaded by |
|
|
1283 | @@RXVT_NAME@@. |
|
|
1284 | |
|
|
1285 | =back |
1062 | |
1286 | |
1063 | =head1 FILES |
1287 | =head1 FILES |
1064 | |
1288 | |
1065 | =over 4 |
1289 | =over 4 |
1066 | |
1290 | |
1067 | =item B</etc/utmp> |
|
|
1068 | |
|
|
1069 | System file for login records. |
|
|
1070 | |
|
|
1071 | =item B</usr/lib/X11/rgb.txt> |
1291 | =item B</usr/lib/X11/rgb.txt> |
1072 | |
1292 | |
1073 | Color names. |
1293 | Color names. |
1074 | |
1294 | |
1075 | =back |
1295 | =back |
1076 | |
1296 | |
1077 | =head1 SEE ALSO |
1297 | =head1 SEE ALSO |
1078 | |
1298 | |
1079 | @@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) |
1299 | @@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) |
1080 | |
|
|
1081 | =head1 BUGS |
|
|
1082 | |
|
|
1083 | Check the BUGS file for an up-to-date list. |
|
|
1084 | |
|
|
1085 | Cursor change support is not yet implemented. |
|
|
1086 | |
|
|
1087 | Click-and-drag doesn't work with X11 mouse report overriding. |
|
|
1088 | |
1300 | |
1089 | =head1 CURRENT PROJECT COORDINATOR |
1301 | =head1 CURRENT PROJECT COORDINATOR |
1090 | |
1302 | |
1091 | =over 4 |
1303 | =over 4 |
1092 | |
1304 | |
1093 | =item Project Coordinator |
1305 | =item Project Coordinator |
1094 | |
1306 | |
1095 | @@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> |
1307 | Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1096 | |
1308 | |
1097 | =item Web page maintainter |
1309 | L<http://software.schmorp.de/#rxvt-unicode> |
1098 | |
|
|
1099 | @@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@> |
|
|
1100 | |
|
|
1101 | L<@@RXVT_WEBPAGE@@> |
|
|
1102 | |
1310 | |
1103 | =back |
1311 | =back |
1104 | |
1312 | |
1105 | =head1 AUTHORS |
1313 | =head1 AUTHORS |
1106 | |
1314 | |
… | |
… | |
1131 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1339 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1132 | |
1340 | |
1133 | Rewrote screen display and text selection routines. Project Coordinator |
1341 | Rewrote screen display and text selection routines. Project Coordinator |
1134 | (changes.txt 2.4.6 - rxvt-unicode) |
1342 | (changes.txt 2.4.6 - rxvt-unicode) |
1135 | |
1343 | |
1136 | =item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> |
1344 | =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1137 | |
1345 | |
1138 | Forked rxvt-unicode, rewrote most of the display code and internal |
1346 | Forked rxvt-unicode, rewrote most of the display code and internal |
1139 | character handling to store text in unicode, improve xterm |
1347 | character handling to store text in unicode, improve xterm |
1140 | compatibility and apply numerous other bugfixes and extensions. |
1348 | compatibility and apply numerous other bugfixes and extensions. |
1141 | |
1349 | |