ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.pod
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.30 by root, Wed Sep 8 17:10:23 2004 UTC vs.
Revision 1.69 by root, Tue Oct 25 19:04:45 2005 UTC

14configurability. As a result, B<rxvt-unicode> uses much less swap space -- 14configurability. As a result, B<rxvt-unicode> uses much less swap space --
15a significant advantage on a machine serving many X sessions. 15a significant advantage on a machine serving many X sessions.
16 16
17=head1 FREQUENTLY ASKED QUESTIONS 17=head1 FREQUENTLY ASKED QUESTIONS
18 18
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of frequently 19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20asked questions and answer to them and some common problems. 20frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at
22L<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
24Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
25internally. That means it can store and display most scripts in the 27internally. 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
106Turn on/off jump scrolling; resource B<jumpScroll>. 108Turn 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
110Turn on/off inheriting parent window's pixmap. Alternative form is 112Turn on/off inheriting parent window's pixmap. Alternative form is
111B<-tr>; resource B<inheritPixmap>. 113B<-tr>; resource B<inheritPixmap>.
112 114
113=item B<-fade> I<number> 115=item B<-fade> I<number>
114 116
115Fade the text by the given percentage when focus is lost. 117Fade the text by the given percentage when focus is lost. Small values
118fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>.
120
121=item B<-fadecolor> I<colour>
122
123Fade to this colour when fading is used (see B<-fade>). The default colour
124is black. resource B<fadeColor>.
116 125
117=item B<-tint> I<colour> 126=item B<-tint> I<colour>
118 127
119Tint the transparent background pixmap with the given colour when 128Tint the transparent background pixmap with the given colour when
120transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> 129transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>
121option that can be used to brighten or darken the image in addition to 130option that can be used to brighten or darken the image in addition to
122tinting it. 131tinting it; resource I<tintColor>. Example:
132
133 @@RXVT_NAME@@ -tr -tint blue -sh 40
123 134
124=item B<-sh> 135=item B<-sh>
125 136
126I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 137I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
127background image in addition to tinting it (i.e. B<-tint> must be 138background image in addition to tinting it (i.e. B<-tint> must be
128specified, too). 139specified, too, e.g. C<-tint white>).
129 140
130=item B<-bg> I<colour> 141=item B<-bg> I<colour>
131 142
132Window background colour; resource B<background>. 143Window background colour; resource B<background>.
133 144
136Window foreground colour; resource B<foreground>. 147Window foreground colour; resource B<foreground>.
137 148
138=item B<-pixmap> I<file[;geom]> 149=item B<-pixmap> I<file[;geom]>
139 150
140Compile I<XPM>: Specify XPM file for the background and also optionally 151Compile I<XPM>: Specify XPM file for the background and also optionally
141specify its scaling with a geometry string. Note you may need to add 152specify its scaling with a geometry string. Note you may need to
142quotes to avoid special shell interpretation of the `;' in the 153add quotes to avoid special shell interpretation of the C<;> in the
143command-line; resource B<backgroundPixmap>. 154command-line; resource B<backgroundPixmap>.
144 155
145=item B<-cr> I<colour> 156=item B<-cr> I<colour>
146 157
147The cursor colour; resource B<cursorColor>. 158The cursor colour; resource B<cursorColor>.
162=item B<-fn> I<fontlist> 173=item B<-fn> I<fontlist>
163 174
164Select the fonts to be used. This is a comma separated list of font names 175Select the fonts to be used. This is a comma separated list of font names
165that are used in turn when trying to display Unicode characters. The 176that are used in turn when trying to display Unicode characters. The
166first font defines the cell size for characters; other fonts might be 177first font defines the cell size for characters; other fonts might be
167smaller, but not (in general) larger. A reasonable default font list is 178smaller, but not (in general) larger. A (hopefully) reasonable default
168always appended to it. See resource B<font> for details. 179font list is always appended to it. See resource B<font> for more details.
180
181In short, to specify an X11 core font, just specify it's name or prefix it
182with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
183e.g.:
184
185 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
186 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
169 187
170See also the question "How does rxvt-unicode choose fonts?" in the FAQ 188See also the question "How does rxvt-unicode choose fonts?" in the FAQ
171section of @@RXVT_NAME@@(7). 189section of @@RXVT_NAME@@(7).
172 190
173=item B<-fb> I<fontlist> 191=item B<-fb> I<fontlist>
229 247
230Put scrollbar on right/left; resource B<scrollBar_right>. 248Put scrollbar on right/left; resource B<scrollBar_right>.
231 249
232=item B<-st>|B<+st> 250=item B<-st>|B<+st>
233 251
234Display normal (non XTerm/NeXT) scrollbar without/with a trough; 252Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
235resource B<scrollBar_floating>. 253resource B<scrollBar_floating>.
254
255=item B<-ptab>|B<+ptab>
256
257If enabled (default), "Horizontal Tab" characters are being stored as
258actual wide characters in the screen buffer, which makes it possible to
259select and paste them. Since a horizontal tab is a cursor movement and
260not an actual glyph, this can sometimes be visually annoying as the cursor
261on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
236 262
237=item B<-bc>|B<+bc> 263=item B<-bc>|B<+bc>
238 264
239Blink the cursor; resource B<cursorBlink>. 265Blink the cursor; resource B<cursorBlink>.
240 266
265if honoured by the WM, the rxvt-unicode window will not have window 291if honoured by the WM, the rxvt-unicode window will not have window
266decorations; resource B<borderLess>. 292decorations; resource B<borderLess>.
267 293
268=item B<-lsp> I<number> 294=item B<-lsp> I<number>
269 295
270Compile I<linespace>: Lines (pixel height) to insert between each row 296Compile I<frills>: Lines (pixel height) to insert between each row of
271of the display; resource B<linespace>. 297the display. Useful to work around font rendering problems; resource
298B<linespace>.
272 299
273=item B<-tn> I<termname> 300=item B<-tn> I<termname>
274 301
275This option specifies the name of the terminal type to be set in the 302This option specifies the name of the terminal type to be set in the
276B<TERM> environment variable. This terminal type must exist in the 303B<TERM> environment variable. This terminal type must exist in the
312 339
313Compile I<XIM>: input method name. resource B<inputMethod>. 340Compile I<XIM>: input method name. resource B<inputMethod>.
314 341
315=item B<-imlocale> I<string> 342=item B<-imlocale> I<string>
316 343
317The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 344The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
318de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 345C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
319extension to be able to input japanese characters while staying in 346input extension to be able to input japanese characters while staying in
320another locale. 347another locale. resource B<imLocale>.
348
349=item B<-imfont> I<fontset>
350
351Set the font set to use for the X Input Method, see resource B<imFont>
352for more info.
353
354=item B<-tcw>
355
356Change the meaning of triple-click selection with the left mouse
357button. Instead of selecting a full line it will extend the selection the
358end of the logical line only. resource B<tripleclickwords>.
321 359
322=item B<-insecure> 360=item B<-insecure>
323 361
324Enable "insecure" mode, which currently enables most of the escape 362Enable "insecure" mode, which currently enables most of the escape
325sequences that echo strings. See the resource B<insecure> for more 363sequences that echo strings. See the resource B<insecure> for more
339=item B<-ssr>|B<+ssr> 377=item B<-ssr>|B<+ssr>
340 378
341Turn on/off secondary screen scroll (default enabled); resource 379Turn on/off secondary screen scroll (default enabled); resource
342B<secondaryScroll>. 380B<secondaryScroll>.
343 381
344=item B<-xrm> I<resourcestring> 382=item B<-keysym.>I<sym> I<string>
345 383
346No effect on rxvt-unicode. Simply passes through an argument to be made 384Remap a key symbol. See resource B<keysym>.
347available in the instance's argument list. Appears in I<WM_COMMAND> in 385
348some window managers. 386=item B<-embed> I<windowid>
387
388Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
389which enables applications to easily embed a terminal.
390
391Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
392shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
393quite a bit, so don't expect it to keep some specific state. It's best to
394create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
395
396The window will not be destroyed when @@RXVT_NAME@@ exits.
397
398It might be useful to know that @@RXVT_NAME@@ will not close file
399descriptors passed to it (except for stdin/out/err, of course), so you
400can use file descriptors to communicate with the programs within the
401terminal. This works regardless of wether the C<-embed> option was used or
402not.
403
404Here is a short Gtk2-perl snippet that illustrates how this option can be
405used (a longer example is in F<doc/embed>):
406
407 my $rxvt = new Gtk2::Socket;
408 $rxvt->signal_connect_after (realize => sub {
409 my $xid = $_[0]->window->get_xid;
410 system "@@RXVT_NAME@@ -embed $xid &";
411 });
412
413=item B<-pty-fd> I<fileno>
414
415Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
416pair but instead use the given filehandle as the tty master. This is
417useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
418without having to run a program within it.
419
420If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
421entries and will not tinker with pty/tty permissions - you have to do that
422yourself if you want that.
423
424Here is a example in perl that illustrates how this option can be used (a
425longer example is in F<doc/pty-fd>):
426
427 use IO::Pty;
428 use Fcntl;
429
430 my $pty = new IO::Pty;
431 fcntl $pty, F_SETFD, 0; # clear close-on-exec
432 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
433 close $pty;
434
435 # now communicate with rxvt
436 my $slave = $pty->slave;
437 while (<$slave>) { print $slave "got <$_>\n" }
349 438
350=back 439=back
351 440
352=head1 RESOURCES (available also as long-options) 441=head1 RESOURCES (available also as long-options)
353 442
356 445
357There are two different methods that @@RXVT_NAME@@ can use to get the 446There are two different methods that @@RXVT_NAME@@ can use to get the
358Xresource data: using the X libraries (Xrm*-functions) or internal 447Xresource data: using the X libraries (Xrm*-functions) or internal
359Xresources reader (B<~/.Xdefaults>). For the first method (ie. 448Xresources reader (B<~/.Xdefaults>). For the first method (ie.
360B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 449B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
361resources using X11 tools like B<xset>. Many distribution do also load 450resources using X11 tools like B<xrdb>. Many distribution do also load
362settings from the B<~/.Xresources> file when X starts. 451settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
452will consult the following files/resources in order, with later settings
453overwriting earlier ones:
454
455 1. system-wide app-defaults file, either locale-dependent OR global
456 2. app-defaults file in $XAPPLRESDIR
457 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
458 4. SCREEN_RESOURCES for the current screen
459 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
363 460
364If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> 461If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
365lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults 462lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
366set in XAPPLOADDIR/URxvt (compile-time defined: usually 463set in XAPPLOADDIR/URxvt (compile-time defined: usually
367B</usr/lib/X11/app-defaults/URxvt>) and resources set in 464B</usr/lib/X11/app-defaults/URxvt>) and resources set in
412 509
413=item B<colorIT:> I<colour> 510=item B<colorIT:> I<colour>
414 511
415Use the specified colour to display bold or italic characters when the 512Use the specified colour to display bold or italic characters when the
416foreground colour is the default. If font styles are not available 513foreground colour is the default. If font styles are not available
417(Compile styles) and this option is unset, reverse video is used instead. 514(Compile I<styles>) and this option is unset, reverse video is used instead.
418 515
419=item B<colorUL:> I<colour> 516=item B<colorUL:> I<colour>
420 517
421Use the specified colour to display underlined characters when the 518Use the specified colour to display underlined characters when the
422foreground colour is the default. 519foreground colour is the default.
423 520
424=item B<colorRV:> I<colour> 521=item B<colorRV:> I<colour>
425 522
426Use the specified colour as the background for reverse video 523Use the specified colour as the background for reverse video
427characters. 524characters.
525
526=item B<underlineColor:> I<colour>
527
528If set, use the specified colour as the colour for the underline
529itself. If unset, use the foreground colour.
428 530
429=item B<cursorColor:> I<colour> 531=item B<cursorColor:> I<colour>
430 532
431Use the specified colour for the cursor. The default is to use the 533Use the specified colour for the cursor. The default is to use the
432foreground colour; option B<-cr>. 534foreground colour; option B<-cr>.
455artificial transparency. B<False>: do not inherit the parent windows' 557artificial transparency. B<False>: do not inherit the parent windows'
456pixmap. 558pixmap.
457 559
458=item B<fading:> I<number> 560=item B<fading:> I<number>
459 561
460Fade the text by the given percentage when focus is lost. 562Fade the text by the given percentage when focus is lost; option B<-fade>.
563
564=item B<fadeColor:> I<colour>
565
566Fade to this colour, when fading is used (see B<fading:>). The default
567colour is black; option B<-fadecolor>.
461 568
462=item B<tintColor:> I<colour> 569=item B<tintColor:> I<colour>
463 570
464Tint the transparent background pixmap with the given colour. 571Tint the transparent background pixmap with the given colour; option
572B<-tint>.
465 573
466=item B<shading:> I<number> 574=item B<shading:> I<number>
467 575
468Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 576Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
469image in addition to tinting it. 577image in addition to tinting it.
470 578
471=item B<fading:> I<number>
472
473Scale the tint colour by the given percentage.
474
475=item B<scrollColor:> I<colour> 579=item B<scrollColor:> I<colour>
476 580
477Use the specified colour for the scrollbar [default #B2B2B2]. 581Use the specified colour for the scrollbar [default #B2B2B2].
478 582
479=item B<troughColor:> I<colour> 583=item B<troughColor:> I<colour>
480 584
481Use the specified colour for the scrollbar's trough area [default 585Use the specified colour for the scrollbar's trough area [default
482#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 586#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
483 587
484=item B<borderColor:> I<colour> 588=item B<borderColor:> I<colour>
485 589
486The colour of the border around the text area and between the scrollbar 590The colour of the border around the text area and between the scrollbar
487and the text. 591and the text.
517The first font defines the cell size for characters; other fonts might 621The first font defines the cell size for characters; other fonts might
518be smaller, but not larger. A reasonable default font list is always 622be smaller, but not larger. A reasonable default font list is always
519appended to it. option B<-fn>. 623appended to it. option B<-fn>.
520 624
521Each font can either be a standard X11 core font (XLFD) name, with 625Each font can either be a standard X11 core font (XLFD) name, with
522optional prefix C<x:> or a Xft font (Compile xft), prefixed with C<xft:>. 626optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
523 627
524In addition, each font can be prefixed with additional hints and 628In addition, each font can be prefixed with additional hints and
525specifications enclosed in square brackets (C<[]>). The only available 629specifications enclosed in square brackets (C<[]>). The only available
526hint currently is C<codeset=codeset-name>, and this is only used for Xft 630hint currently is C<codeset=codeset-name>, and this is only used for Xft
527fonts. 631fonts.
537specifies five fonts to be used. The first one is C<9x15bold> (actually 641specifies five fonts to be used. The first one is C<9x15bold> (actually
538the iso8859-1 version of the second font), which is the base font (because 642the iso8859-1 version of the second font), which is the base font (because
539it is named first) and thus defines the character cell grid to be 9 pixels 643it is named first) and thus defines the character cell grid to be 9 pixels
540wide and 15 pixels high. 644wide and 15 pixels high.
541 645
542the second font is just used to add additional unicode characters not in 646The second font is just used to add additional unicode characters not in
543the base font, likewise the third, which is unfortunately non-bold, but 647the base font, likewise the third, which is unfortunately non-bold, but
544the bold version of the font does contain less characters, so this is a 648the bold version of the font does contain less characters, so this is a
545useful supplement. 649useful supplement.
546 650
547The third font is an Xft font with aliasing turned off, and the characters 651The third font is an Xft font with aliasing turned off, and the characters
579xterm style selection. 683xterm style selection.
580 684
581=item B<scrollstyle:> I<mode> 685=item B<scrollstyle:> I<mode>
582 686
583Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 687Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
584the author's favourite.. 688the author's favourite.
585 689
586=item B<title:> I<string> 690=item B<title:> I<string>
587 691
588Set window title string, the default title is the command-line 692Set window title string, the default title is the command-line
589specified after the B<-e> option, if any, otherwise the application 693specified after the B<-e> option, if any, otherwise the application
621 725
622Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 726Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
623B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or 727B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
624B<Shift-Print> to include the scrollback as well. 728B<Shift-Print> to include the scrollback as well.
625 729
730The string will be interpreted as if typed into the shell as-is.
731
732Example:
733
734 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
735
736This creates a new file in your home directory with the screen contents
737everytime you hit C<Print>.
738
626=item B<scrollBar:> I<boolean> 739=item B<scrollBar:> I<boolean>
627 740
628B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 741B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
629disable the scrollbar; option B<+sb>. 742disable the scrollbar; option B<+sb>.
630 743
650B<+si>. 763B<+si>.
651 764
652=item B<scrollWithBuffer:> I<boolean> 765=item B<scrollWithBuffer:> I<boolean>
653 766
654B<True>: scroll with scrollback buffer when tty receives new lines (and 767B<True>: scroll with scrollback buffer when tty receives new lines (and
655B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 768B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
656with scrollback buffer when tty recieves new lines; option B<-sw>. 769with scrollback buffer when tty recieves new lines; option B<+sw>.
657 770
658=item B<scrollTtyKeypress:> I<boolean> 771=item B<scrollTtyKeypress:> I<boolean>
659 772
660B<True>: scroll to bottom when a non-special key is pressed. Special keys 773B<True>: scroll to bottom when a non-special key is pressed. Special keys
661are those which are intercepted by rxvt-unicode for special handling and 774are those which are intercepted by rxvt-unicode for special handling and
700=item B<mouseWheelScrollPage:> I<boolean> 813=item B<mouseWheelScrollPage:> I<boolean>
701 814
702B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel 815B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
703scrolls five lines [default]. 816scrolls five lines [default].
704 817
818=item B<pastableTabs:> I<boolean>
819
820B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
821movement only; option C<-ptab>.
822
705=item B<cursorBlink:> I<boolean> 823=item B<cursorBlink:> I<boolean>
706 824
707B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 825B<True>: blink the cursor. B<False>: do not blink the cursor [default];
708option B<-bc>. 826option B<-bc>.
709 827
721 839
722Mouse pointer background colour. 840Mouse pointer background colour.
723 841
724=item B<pointerBlankDelay:> I<number> 842=item B<pointerBlankDelay:> I<number>
725 843
726Specifies number of seconds before blanking the pointer [default 2]. 844Specifies number of seconds before blanking the pointer [default 2]. Use a
845large number (e.g. C<987654321>) to effectively disable the timeout.
727 846
728=item B<backspacekey:> I<string> 847=item B<backspacekey:> I<string>
729 848
730The string to send when the backspace key is pressed. If set to B<DEC> 849The string to send when the backspace key is pressed. If set to B<DEC>
731or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 850or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
753 872
754I<name> of inputMethod to use; option B<-im>. 873I<name> of inputMethod to use; option B<-im>.
755 874
756=item B<imLocale:> I<name> 875=item B<imLocale:> I<name>
757 876
758The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 877The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
759de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 878C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
760extension to be able to input japanese characters while staying in 879input extension to be able to input japanese characters while staying in
761another locale. option B<-imlocale>. 880another locale. option B<-imlocale>.
881
882=item B<imFont:> I<fontset>
883
884Specify the font-set used for XIM styles C<OverTheSpot> or
885C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
886by commas), i.e. it's not in the same format as the other font lists used
887in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
888found, preferably one or two pixels differing in size to the base font.
889option B<-imfont>.
890
891=item B<tripleclickwords:> I<boolean>
892
893Change the meaning of triple-click selection with the left mouse
894button. Instead of selecting a full line it will extend the selection to
895the end of the logical line only. option B<-tcw>.
762 896
763=item B<insecure:> I<boolean> 897=item B<insecure:> I<boolean>
764 898
765Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 899Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
766echo arbitrary strings like the icon name or the locale. This could be 900echo arbitrary strings like the icon name or the locale. This could be
796scrollback buffer and switching to/from the secondary screen will 930scrollback buffer and switching to/from the secondary screen will
797instead scroll the screen up. 931instead scroll the screen up.
798 932
799=item B<keysym.>I<sym>: I<string> 933=item B<keysym.>I<sym>: I<string>
800 934
801Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may 935Compile I<frills>: Associate I<string> with keysym I<sym>. The
802contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: 936intervening resource name B<keysym.> cannot be omitted.
803newline, \r: return, \t: 937
938The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
939any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
940B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
941and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
942B<2>, B<3>, B<4>, B<5>.
943
944The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
945whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
946keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
947current application keymap mode state.
948
949The spellings of I<key> can be obtained by using B<xev>(1) command or
950searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
951omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
952keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
953performed in an exact manner; however, the closest match is assured.
954
955I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
956C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
804tab, \000: octal number) or control characters (^?: delete, ^@: null, 957C<\000>: octal number) or verbatim control characters (C<^?>: delete,
805^A ...) and may enclosed with double quotes so that it can start or end 958C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
806with whitespace. The intervening resource name B<keysym.> cannot be 959can start or end with whitespace.
807omitted. This resource is only available when compiled with 960
808KEYSYM_RESOURCE. 961Please note that you need to double the C<\> when using
962C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
963use C<\033> instead of C<\e> (and so on), which will work with both Xt and
964@@RXVT_NAME@@'s own processing).
965
966You can define a range of keysyms in one shot by providing a I<string>
967with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
968should be a character not used by the strings.
969
970Its usage can be demonstrated by an example:
971
972 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
973
974The above line is equivalent to the following three lines:
975
976 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
977 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
978 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
979
980If I<string> takes the form of C<command:STRING>, the specified B<STRING>
981is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
982example the following means "change the current locale to C<zh_CN.GBK>
983when Control-Meta-c is being pressed":
984
985 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
986
987Due the the large number of modifier combinations, a defined key mapping
988will match if at I<at least> the specified identifiers are being set, and
989no other key mappings with those and more bits are being defined. That
990means that defining a key map for C<a> will automatically provide
991definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
992mappings themselves.
993
994Unfortunately, this will override built-in key mappings. For example
995if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
996C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
997user-defined keymap using the C<builtin:> replacement:
998
999 URxvt.keysym.Insert: <my insert key sequence>
1000 URxvt.keysym.S-Insert: builtin:
1001
1002The first line defines a mapping for C<Insert> and I<any> combination
1003of modifiers. The second line re-establishes the default mapping for
1004C<Shift-Insert>.
1005
1006The following example will map Control-Meta-1 and Control-Meta-2 to
1007the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1008font-switching at runtime:
1009
1010 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1011 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1012
1013Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1014info):
1015
1016 URxvt.keysym.M-C-3: command:\033[8;25;80t
1017 URxvt.keysym.M-C-4: command:\033[8;48;110t
809 1018
810=back 1019=back
811 1020
812=head1 THE SCROLLBAR 1021=head1 THE SCROLLBAR
813 1022
827the normal text selection/insertion, hold either the Shift or the Meta 1036the normal text selection/insertion, hold either the Shift or the Meta
828(Alt) key while performing the desired mouse action. 1037(Alt) key while performing the desired mouse action.
829 1038
830If mouse reporting mode is active, the normal scrollbar actions are 1039If mouse reporting mode is active, the normal scrollbar actions are
831disabled -- on the assumption that we are using a fullscreen 1040disabled -- on the assumption that we are using a fullscreen
832application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 1041application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
833(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 1042(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
834up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down), 1043up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
835respectively. 1044respectively.
836 1045
837=head1 TEXT SELECTION AND INSERTION 1046=head1 TEXT SELECTION AND INSERTION
838 1047
839The behaviour of text selection and insertion mechanism is similar to 1048The behaviour of text selection and insertion mechanism is similar to
841 1050
842=over 4 1051=over 4
843 1052
844=item B<Selection>: 1053=item B<Selection>:
845 1054
846Left click at the beginning of the region, drag to the end of the 1055Left click at the beginning of the region, drag to the end of the region
847region and release; Right click to extend the marked region; Left 1056and release; Right click to extend the marked region; Left double-click
848double-click to select a word; Left triple-click to select the entire 1057to select a word; Left triple-click to select the entire logical line
849line. 1058(which can span multiple screen lines), unless modified by resource
1059B<tripleclickwords>.
850 1060
851Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1061Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
852(Compile: frills) will create a rectangular selection instead of a normal 1062(Compile: I<frills>) will create a rectangular selection instead of a normal
853one. 1063one.
854 1064
855=item B<Insertion>: 1065=item B<Insertion>:
856 1066
857Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1067Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
880C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1090C<--enable-frills>, the rest is available when rxvt-unicode was compiled
881with C<--enable-iso14755>. 1091with C<--enable-iso14755>.
882 1092
883=over 4 1093=over 4
884 1094
885=item 5.1: Basic method 1095=item * 5.1: Basic method
886 1096
887This allows you to enter unicode characters using their hexcode. 1097This allows you to enter unicode characters using their hexcode.
888 1098
889Start by pressing and holding both C<Control> and C<Shift>, then enter 1099Start by pressing and holding both C<Control> and C<Shift>, then enter
890hex-digits (between one and six). Releasing C<Control> and C<Shift> will 1100hex-digits (between one and six). Releasing C<Control> and C<Shift> will
897address, which you cannot type. Fortunately, the card has the e-mail 1107address, which you cannot type. Fortunately, the card has the e-mail
898address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily 1108address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
899by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>, 1109by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
900followed by releasing the modifier keys. 1110followed by releasing the modifier keys.
901 1111
902=item 5.2: Keyboard symbols entry method 1112=item * 5.2: Keyboard symbols entry method
903 1113
904This mode lets you input characters representing the keycap symbols of 1114This mode lets you input characters representing the keycap symbols of
905your keyboard, if representable in the current locale encoding. 1115your keyboard, if representable in the current locale encoding.
906 1116
907Start by pressing C<Control> and C<Shift> together, then releasing 1117Start by pressing C<Control> and C<Shift> together, then releasing
910keycap symbol. The symbol will only be entered when the key has been 1120keycap symbol. The symbol will only be entered when the key has been
911released, otherwise pressing e.g. C<Shift> would enter the symbol for 1121released, otherwise pressing e.g. C<Shift> would enter the symbol for
912C<ISO Level 2 Switch>, although your intention might have been to enter a 1122C<ISO Level 2 Switch>, although your intention might have been to enter a
913reverse tab (Shift-Tab). 1123reverse tab (Shift-Tab).
914 1124
915=item 5.3: Screen-selection entry method 1125=item * 5.3: Screen-selection entry method
916 1126
917While this is implemented already (it's basically the selection 1127While this is implemented already (it's basically the selection
918mechanism), it could be extended by displaying a unicode character map. 1128mechanism), it could be extended by displaying a unicode character map.
919 1129
920=item 5.4: Feedback method for identifying displayed characters for later input 1130=item * 5.4: Feedback method for identifying displayed characters for later input
921 1131
922This method lets you display the unicode character code associated with 1132This method lets you display the unicode character code associated with
923characters already displayed. 1133characters already displayed.
924 1134
925You enter this mode by holding down C<Control> and C<Shift> together, then 1135You enter this mode by holding down C<Control> and C<Shift> together, then
937With respect to conformance, rxvt-unicode is supposed to be compliant to 1147With respect to conformance, rxvt-unicode is supposed to be compliant to
938both scenario A and B of ISO 14755, including part 5.2. 1148both scenario A and B of ISO 14755, including part 5.2.
939 1149
940=head1 LOGIN STAMP 1150=head1 LOGIN STAMP
941 1151
942B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so 1152B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
943that it can be seen via the I<who(1)> command, and can accept messages. 1153it can be seen via the I<who(1)> command, and can accept messages. To
944To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on 1154allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
945some systems. 1155on some systems or setgid to root or to some other group on others.
946 1156
947=head1 COLORS AND GRAPHICS 1157=head1 COLORS AND GRAPHICS
948 1158
949In addition to the default foreground and background colours, 1159In addition to the default foreground and background colours,
950B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1160B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
993 1203
994=back 1204=back
995 1205
996=head1 ENVIRONMENT 1206=head1 ENVIRONMENT
997 1207
998B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> 1208B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
999and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X 1209
1000window id number of the B<@@RXVT_NAME@@> window and it also uses and 1210=over 4
1001sets the environment variable B<DISPLAY> to specify which display 1211
1002terminal to use. B<@@RXVT_NAME@@> uses the environment variables 1212=item B<TERM>
1003B<RXVTPATH> and B<PATH> to find XPM files. 1213
1214Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1215resources or on the commandline.
1216
1217=item B<COLORTERM>
1218
1219Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
1220compiled with XPM support, and optionally with the added extension
1221C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1222
1223=item B<COLORFGBG>
1224
1225Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1226the colour code used as default foreground/text colour (or the string
1227C<default> to indicate that the default-colour escape sequence is to be
1228used), C<bg> is the colour code used as default background colour (or the
1229string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1230was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
1231(and do) use this information to optimize screen output.
1232
1233=item B<WINDOWID>
1234
1235Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1236window, which usually has subwindows for the scrollbar, the terminal
1237window and so on).
1238
1239=item B<TERMINFO>
1240
1241Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1242C<--with-terminfo=PATH>.
1243
1244=item B<DISPLAY>
1245
1246Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1247display in it's child processes.
1248
1249=item B<SHELL>
1250
1251The shell to be used for command execution, defaults to C</bin/sh>.
1252
1253=item B<RXVTPATH>
1254
1255The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1256files.
1257
1258=item B<PATH>
1259
1260Used in the same way as C<RXVTPATH>.
1261
1262=item B<RXVT_SOCKET>
1263
1264The unix domain socket path used by @@RXVT_NAME@@c(1) and
1265@@RXVT_NAME@@d(1).
1266
1267Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1268
1269=item B<HOME>
1270
1271Used to locate the default directory for the unix domain socket for
1272daemon communications and to locate various resource files (such as
1273C<.Xdefaults>)
1274
1275=item B<XAPPLRESDIR>
1276
1277Directory where various X resource files are being located.
1278
1279=item B<XENVIRONMENT>
1280
1281If set and accessible, gives the name of a X resource file to be loaded by
1282@@RXVT_NAME@@.
1283
1284=back
1004 1285
1005=head1 FILES 1286=head1 FILES
1006 1287
1007=over 4 1288=over 4
1008 1289
1009=item B</etc/utmp>
1010
1011System file for login records.
1012
1013=item B</usr/lib/X11/rgb.txt> 1290=item B</usr/lib/X11/rgb.txt>
1014 1291
1015Color names. 1292Color names.
1016 1293
1017=back 1294=back
1018 1295
1019=head1 SEE ALSO 1296=head1 SEE ALSO
1020 1297
1021@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1298@@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)
1022 1299
1023=head1 BUGS 1300=head1 BUGS
1024 1301
1025Check the BUGS file for an up-to-date list. 1302Check the BUGS file for an up-to-date list.
1026 1303
1032 1309
1033=over 4 1310=over 4
1034 1311
1035=item Project Coordinator 1312=item Project Coordinator
1036 1313
1037@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1314Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1038 1315
1039=item Web page maintainter 1316L<http://software.schmorp.de/#rxvt-unicode>
1040
1041@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1042
1043L<@@RXVT_WEBPAGE@@>
1044 1317
1045=back 1318=back
1046 1319
1047=head1 AUTHORS 1320=head1 AUTHORS
1048 1321
1073=item Geoff Wing L<< <gcw@pobox.com> >> 1346=item Geoff Wing L<< <gcw@pobox.com> >>
1074 1347
1075Rewrote screen display and text selection routines. Project Coordinator 1348Rewrote screen display and text selection routines. Project Coordinator
1076(changes.txt 2.4.6 - rxvt-unicode) 1349(changes.txt 2.4.6 - rxvt-unicode)
1077 1350
1078=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1351=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1079 1352
1080Forked rxvt-unicode, rewrote most of the display code and internal 1353Forked rxvt-unicode, rewrote most of the display code and internal
1081character handling to store text in unicode, improve xterm 1354character handling to store text in unicode, improve xterm
1082compatibility and apply numerous other bugfixes and extensions. 1355compatibility and apply numerous other bugfixes and extensions.
1083 1356

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines