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.32 by root, Sat Oct 9 11:18:12 2004 UTC vs.
Revision 1.74 by root, Thu Dec 22 16:44:10 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>. This only works for
121option that can be used to brighten or darken the image in addition to 130non-tiled backgrounds, currently. See also the B<-sh> option that can be
122tinting it. 131used to brighten or darken the image in addition to tinting it; resource
132I<tintColor>. Example:
133
134 @@RXVT_NAME@@ -tr -tint blue -sh 40
123 135
124=item B<-sh> 136=item B<-sh>
125 137
126I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
127background image in addition to tinting it (i.e. B<-tint> must be 139background image in addition to tinting it (i.e. B<-tint> must be
128specified, too). 140specified, too, e.g. C<-tint white>).
129 141
130=item B<-bg> I<colour> 142=item B<-bg> I<colour>
131 143
132Window background colour; resource B<background>. 144Window background colour; resource B<background>.
133 145
136Window foreground colour; resource B<foreground>. 148Window foreground colour; resource B<foreground>.
137 149
138=item B<-pixmap> I<file[;geom]> 150=item B<-pixmap> I<file[;geom]>
139 151
140Compile I<XPM>: Specify XPM file for the background and also optionally 152Compile I<XPM>: Specify XPM file for the background and also optionally
141specify its scaling with a geometry string. Note you may need to add 153specify its scaling with a geometry string. Note you may need to
142quotes to avoid special shell interpretation of the `;' in the 154add quotes to avoid special shell interpretation of the C<;> in the
143command-line; resource B<backgroundPixmap>. 155command-line; resource B<backgroundPixmap>.
144 156
145=item B<-cr> I<colour> 157=item B<-cr> I<colour>
146 158
147The cursor colour; resource B<cursorColor>. 159The cursor colour; resource B<cursorColor>.
162=item B<-fn> I<fontlist> 174=item B<-fn> I<fontlist>
163 175
164Select the fonts to be used. This is a comma separated list of font names 176Select 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 177that are used in turn when trying to display Unicode characters. The
166first font defines the cell size for characters; other fonts might be 178first font defines the cell size for characters; other fonts might be
167smaller, but not (in general) larger. A reasonable default font list is 179smaller, but not (in general) larger. A (hopefully) reasonable default
168always appended to it. See resource B<font> for details. 180font list is always appended to it. See resource B<font> for more details.
181
182In short, to specify an X11 core font, just specify it's name or prefix it
183with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184e.g.:
185
186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
169 188
170See also the question "How does rxvt-unicode choose fonts?" in the FAQ 189See also the question "How does rxvt-unicode choose fonts?" in the FAQ
171section of @@RXVT_NAME@@(7). 190section of @@RXVT_NAME@@(7).
172 191
173=item B<-fb> I<fontlist> 192=item B<-fb> I<fontlist>
229 248
230Put scrollbar on right/left; resource B<scrollBar_right>. 249Put scrollbar on right/left; resource B<scrollBar_right>.
231 250
232=item B<-st>|B<+st> 251=item B<-st>|B<+st>
233 252
234Display normal (non XTerm/NeXT) scrollbar without/with a trough; 253Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
235resource B<scrollBar_floating>. 254resource B<scrollBar_floating>.
255
256=item B<-ptab>|B<+ptab>
257
258If enabled (default), "Horizontal Tab" characters are being stored as
259actual wide characters in the screen buffer, which makes it possible to
260select and paste them. Since a horizontal tab is a cursor movement and
261not an actual glyph, this can sometimes be visually annoying as the cursor
262on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
236 263
237=item B<-bc>|B<+bc> 264=item B<-bc>|B<+bc>
238 265
239Blink the cursor; resource B<cursorBlink>. 266Blink the cursor; resource B<cursorBlink>.
240 267
265if honoured by the WM, the rxvt-unicode window will not have window 292if honoured by the WM, the rxvt-unicode window will not have window
266decorations; resource B<borderLess>. 293decorations; resource B<borderLess>.
267 294
268=item B<-lsp> I<number> 295=item B<-lsp> I<number>
269 296
270Compile I<linespace>: Lines (pixel height) to insert between each row 297Compile I<frills>: Lines (pixel height) to insert between each row of
271of the display; resource B<linespace>. 298the display. Useful to work around font rendering problems; resource
299B<linespace>.
272 300
273=item B<-tn> I<termname> 301=item B<-tn> I<termname>
274 302
275This option specifies the name of the terminal type to be set in the 303This option specifies the name of the terminal type to be set in the
276B<TERM> environment variable. This terminal type must exist in the 304B<TERM> environment variable. This terminal type must exist in the
285given on the command line. If this option is used, it must be the last 313given on the command line. If this option is used, it must be the last
286on the command-line. If there is no B<-e> option then the default is to 314on the command-line. If there is no B<-e> option then the default is to
287run the program specified by the B<SHELL> environment variable or, 315run the program specified by the B<SHELL> environment variable or,
288failing that, I<sh(1)>. 316failing that, I<sh(1)>.
289 317
318Please note that you must specify a program with arguments. If you want to
319run shell commands, you have to specify the shell, like this:
320
321 @@RXVT_NAME@@ -e sh -c "shell commands"
322
290=item B<-title> I<text> 323=item B<-title> I<text>
291 324
292Window title (B<-T> still respected); the default title is the basename 325Window title (B<-T> still respected); the default title is the basename
293of the program specified after the B<-e> option, if any, otherwise the 326of the program specified after the B<-e> option, if any, otherwise the
294application name; resource B<title>. 327application name; resource B<title>.
312 345
313Compile I<XIM>: input method name. resource B<inputMethod>. 346Compile I<XIM>: input method name. resource B<inputMethod>.
314 347
315=item B<-imlocale> I<string> 348=item B<-imlocale> I<string>
316 349
317The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 350The 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 351C<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 352input extension to be able to input japanese characters while staying in
320another locale. 353another locale. resource B<imLocale>.
354
355=item B<-imfont> I<fontset>
356
357Set the font set to use for the X Input Method, see resource B<imFont>
358for more info.
359
360=item B<-tcw>
361
362Change the meaning of triple-click selection with the left mouse
363button. Instead of selecting a full line it will extend the selection the
364end of the logical line only. resource B<tripleclickwords>.
321 365
322=item B<-insecure> 366=item B<-insecure>
323 367
324Enable "insecure" mode, which currently enables most of the escape 368Enable "insecure" mode, which currently enables most of the escape
325sequences that echo strings. See the resource B<insecure> for more 369sequences that echo strings. See the resource B<insecure> for more
339=item B<-ssr>|B<+ssr> 383=item B<-ssr>|B<+ssr>
340 384
341Turn on/off secondary screen scroll (default enabled); resource 385Turn on/off secondary screen scroll (default enabled); resource
342B<secondaryScroll>. 386B<secondaryScroll>.
343 387
344=item B<-xrm> I<resourcestring> 388=item B<-hold>|B<+hold>
345 389
346No effect on rxvt-unicode. Simply passes through an argument to be made 390Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
347available in the instance's argument list. Appears in I<WM_COMMAND> in 391will not immediately destroy its window when the program executed within
348some window managers. 392it exits. Instead, it will wait till it is being killed or closed by the
393user; resource B<hold>.
394
395=item B<-keysym.>I<sym> I<string>
396
397Remap a key symbol. See resource B<keysym>.
398
399=item B<-embed> I<windowid>
400
401Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
402which enables applications to easily embed a terminal.
403
404Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
405shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
406quite a bit, so don't expect it to keep some specific state. It's best to
407create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
408
409The window will not be destroyed when @@RXVT_NAME@@ exits.
410
411It might be useful to know that @@RXVT_NAME@@ will not close file
412descriptors passed to it (except for stdin/out/err, of course), so you
413can use file descriptors to communicate with the programs within the
414terminal. This works regardless of wether the C<-embed> option was used or
415not.
416
417Here is a short Gtk2-perl snippet that illustrates how this option can be
418used (a longer example is in F<doc/embed>):
419
420 my $rxvt = new Gtk2::Socket;
421 $rxvt->signal_connect_after (realize => sub {
422 my $xid = $_[0]->window->get_xid;
423 system "@@RXVT_NAME@@ -embed $xid &";
424 });
425
426=item B<-pty-fd> I<fileno>
427
428Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
429pair but instead use the given filehandle as the tty master. This is
430useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
431without having to run a program within it.
432
433If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
434entries and will not tinker with pty/tty permissions - you have to do that
435yourself if you want that.
436
437Here is a example in perl that illustrates how this option can be used (a
438longer example is in F<doc/pty-fd>):
439
440 use IO::Pty;
441 use Fcntl;
442
443 my $pty = new IO::Pty;
444 fcntl $pty, F_SETFD, 0; # clear close-on-exec
445 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
446 close $pty;
447
448 # now communicate with rxvt
449 my $slave = $pty->slave;
450 while (<$slave>) { print $slave "got <$_>\n" }
349 451
350=back 452=back
351 453
352=head1 RESOURCES (available also as long-options) 454=head1 RESOURCES (available also as long-options)
353 455
356 458
357There are two different methods that @@RXVT_NAME@@ can use to get the 459There are two different methods that @@RXVT_NAME@@ can use to get the
358Xresource data: using the X libraries (Xrm*-functions) or internal 460Xresource data: using the X libraries (Xrm*-functions) or internal
359Xresources reader (B<~/.Xdefaults>). For the first method (ie. 461Xresources reader (B<~/.Xdefaults>). For the first method (ie.
360B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 462B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
361resources using X11 tools like B<xset>. Many distribution do also load 463resources using X11 tools like B<xrdb>. Many distribution do also load
362settings from the B<~/.Xresources> file when X starts. 464settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
465will consult the following files/resources in order, with later settings
466overwriting earlier ones:
467
468 1. system-wide app-defaults file, either locale-dependent OR global
469 2. app-defaults file in $XAPPLRESDIR
470 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
471 4. SCREEN_RESOURCES for the current screen
472 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
363 473
364If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> 474If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
365lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults 475lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
366set in XAPPLOADDIR/URxvt (compile-time defined: usually 476set in XAPPLOADDIR/URxvt (compile-time defined: usually
367B</usr/lib/X11/app-defaults/URxvt>) and resources set in 477B</usr/lib/X11/app-defaults/URxvt>) and resources set in
412 522
413=item B<colorIT:> I<colour> 523=item B<colorIT:> I<colour>
414 524
415Use the specified colour to display bold or italic characters when the 525Use the specified colour to display bold or italic characters when the
416foreground colour is the default. If font styles are not available 526foreground colour is the default. If font styles are not available
417(Compile styles) and this option is unset, reverse video is used instead. 527(Compile I<styles>) and this option is unset, reverse video is used instead.
418 528
419=item B<colorUL:> I<colour> 529=item B<colorUL:> I<colour>
420 530
421Use the specified colour to display underlined characters when the 531Use the specified colour to display underlined characters when the
422foreground colour is the default. 532foreground colour is the default.
423 533
424=item B<colorRV:> I<colour> 534=item B<colorRV:> I<colour>
425 535
426Use the specified colour as the background for reverse video 536Use the specified colour as the background for reverse video
427characters. 537characters.
538
539=item B<underlineColor:> I<colour>
540
541If set, use the specified colour as the colour for the underline
542itself. If unset, use the foreground colour.
428 543
429=item B<cursorColor:> I<colour> 544=item B<cursorColor:> I<colour>
430 545
431Use the specified colour for the cursor. The default is to use the 546Use the specified colour for the cursor. The default is to use the
432foreground colour; option B<-cr>. 547foreground colour; option B<-cr>.
455artificial transparency. B<False>: do not inherit the parent windows' 570artificial transparency. B<False>: do not inherit the parent windows'
456pixmap. 571pixmap.
457 572
458=item B<fading:> I<number> 573=item B<fading:> I<number>
459 574
460Fade the text by the given percentage when focus is lost. 575Fade the text by the given percentage when focus is lost; option B<-fade>.
576
577=item B<fadeColor:> I<colour>
578
579Fade to this colour, when fading is used (see B<fading:>). The default
580colour is black; option B<-fadecolor>.
461 581
462=item B<tintColor:> I<colour> 582=item B<tintColor:> I<colour>
463 583
464Tint the transparent background pixmap with the given colour. 584Tint the transparent background pixmap with the given colour; option
585B<-tint>.
465 586
466=item B<shading:> I<number> 587=item B<shading:> I<number>
467 588
468Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 589Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
469image in addition to tinting it. 590image in addition to tinting it.
473Use the specified colour for the scrollbar [default #B2B2B2]. 594Use the specified colour for the scrollbar [default #B2B2B2].
474 595
475=item B<troughColor:> I<colour> 596=item B<troughColor:> I<colour>
476 597
477Use the specified colour for the scrollbar's trough area [default 598Use the specified colour for the scrollbar's trough area [default
478#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 599#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
479 600
480=item B<borderColor:> I<colour> 601=item B<borderColor:> I<colour>
481 602
482The colour of the border around the text area and between the scrollbar 603The colour of the border around the text area and between the scrollbar
483and the text. 604and the text.
513The first font defines the cell size for characters; other fonts might 634The first font defines the cell size for characters; other fonts might
514be smaller, but not larger. A reasonable default font list is always 635be smaller, but not larger. A reasonable default font list is always
515appended to it. option B<-fn>. 636appended to it. option B<-fn>.
516 637
517Each font can either be a standard X11 core font (XLFD) name, with 638Each font can either be a standard X11 core font (XLFD) name, with
518optional prefix C<x:> or a Xft font (Compile xft), prefixed with C<xft:>. 639optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
519 640
520In addition, each font can be prefixed with additional hints and 641In addition, each font can be prefixed with additional hints and
521specifications enclosed in square brackets (C<[]>). The only available 642specifications enclosed in square brackets (C<[]>). The only available
522hint currently is C<codeset=codeset-name>, and this is only used for Xft 643hint currently is C<codeset=codeset-name>, and this is only used for Xft
523fonts. 644fonts.
533specifies five fonts to be used. The first one is C<9x15bold> (actually 654specifies five fonts to be used. The first one is C<9x15bold> (actually
534the iso8859-1 version of the second font), which is the base font (because 655the iso8859-1 version of the second font), which is the base font (because
535it is named first) and thus defines the character cell grid to be 9 pixels 656it is named first) and thus defines the character cell grid to be 9 pixels
536wide and 15 pixels high. 657wide and 15 pixels high.
537 658
538the second font is just used to add additional unicode characters not in 659The second font is just used to add additional unicode characters not in
539the base font, likewise the third, which is unfortunately non-bold, but 660the base font, likewise the third, which is unfortunately non-bold, but
540the bold version of the font does contain less characters, so this is a 661the bold version of the font does contain less characters, so this is a
541useful supplement. 662useful supplement.
542 663
543The third font is an Xft font with aliasing turned off, and the characters 664The third font is an Xft font with aliasing turned off, and the characters
575xterm style selection. 696xterm style selection.
576 697
577=item B<scrollstyle:> I<mode> 698=item B<scrollstyle:> I<mode>
578 699
579Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 700Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
580the author's favourite.. 701the author's favourite.
581 702
582=item B<title:> I<string> 703=item B<title:> I<string>
583 704
584Set window title string, the default title is the command-line 705Set window title string, the default title is the command-line
585specified after the B<-e> option, if any, otherwise the application 706specified after the B<-e> option, if any, otherwise the application
617 738
618Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 739Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
619B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or 740B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
620B<Shift-Print> to include the scrollback as well. 741B<Shift-Print> to include the scrollback as well.
621 742
743The string will be interpreted as if typed into the shell as-is.
744
745Example:
746
747 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
748
749This creates a new file in your home directory with the screen contents
750everytime you hit C<Print>.
751
622=item B<scrollBar:> I<boolean> 752=item B<scrollBar:> I<boolean>
623 753
624B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 754B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
625disable the scrollbar; option B<+sb>. 755disable the scrollbar; option B<+sb>.
626 756
646B<+si>. 776B<+si>.
647 777
648=item B<scrollWithBuffer:> I<boolean> 778=item B<scrollWithBuffer:> I<boolean>
649 779
650B<True>: scroll with scrollback buffer when tty receives new lines (and 780B<True>: scroll with scrollback buffer when tty receives new lines (and
651B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 781B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
652with scrollback buffer when tty recieves new lines; option B<-sw>. 782with scrollback buffer when tty recieves new lines; option B<+sw>.
653 783
654=item B<scrollTtyKeypress:> I<boolean> 784=item B<scrollTtyKeypress:> I<boolean>
655 785
656B<True>: scroll to bottom when a non-special key is pressed. Special keys 786B<True>: scroll to bottom when a non-special key is pressed. Special keys
657are those which are intercepted by rxvt-unicode for special handling and 787are those which are intercepted by rxvt-unicode for special handling and
696=item B<mouseWheelScrollPage:> I<boolean> 826=item B<mouseWheelScrollPage:> I<boolean>
697 827
698B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel 828B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
699scrolls five lines [default]. 829scrolls five lines [default].
700 830
831=item B<pastableTabs:> I<boolean>
832
833B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
834movement only; option C<-ptab>.
835
701=item B<cursorBlink:> I<boolean> 836=item B<cursorBlink:> I<boolean>
702 837
703B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 838B<True>: blink the cursor. B<False>: do not blink the cursor [default];
704option B<-bc>. 839option B<-bc>.
705 840
717 852
718Mouse pointer background colour. 853Mouse pointer background colour.
719 854
720=item B<pointerBlankDelay:> I<number> 855=item B<pointerBlankDelay:> I<number>
721 856
722Specifies number of seconds before blanking the pointer [default 2]. 857Specifies number of seconds before blanking the pointer [default 2]. Use a
858large number (e.g. C<987654321>) to effectively disable the timeout.
723 859
724=item B<backspacekey:> I<string> 860=item B<backspacekey:> I<string>
725 861
726The string to send when the backspace key is pressed. If set to B<DEC> 862The string to send when the backspace key is pressed. If set to B<DEC>
727or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 863or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
749 885
750I<name> of inputMethod to use; option B<-im>. 886I<name> of inputMethod to use; option B<-im>.
751 887
752=item B<imLocale:> I<name> 888=item B<imLocale:> I<name>
753 889
754The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 890The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
755de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 891C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
756extension to be able to input japanese characters while staying in 892input extension to be able to input japanese characters while staying in
757another locale. option B<-imlocale>. 893another locale. option B<-imlocale>.
894
895=item B<imFont:> I<fontset>
896
897Specify the font-set used for XIM styles C<OverTheSpot> or
898C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
899by commas), i.e. it's not in the same format as the other font lists used
900in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
901found, preferably one or two pixels differing in size to the base font.
902option B<-imfont>.
903
904=item B<tripleclickwords:> I<boolean>
905
906Change the meaning of triple-click selection with the left mouse
907button. Instead of selecting a full line it will extend the selection to
908the end of the logical line only. option B<-tcw>.
758 909
759=item B<insecure:> I<boolean> 910=item B<insecure:> I<boolean>
760 911
761Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 912Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
762echo arbitrary strings like the icon name or the locale. This could be 913echo arbitrary strings like the icon name or the locale. This could be
763abused if somebody gets 8-bit-clean access to your display, whether 914abused if somebody gets 8-bit-clean access to your display, whether
764throuh a mail client displaying mail bodies unfiltered or though 915through a mail client displaying mail bodies unfiltered or through
765write(1). Therefore, these sequences are disabled by default. (Note 916write(1) or any other means. Therefore, these sequences are disabled by
766that other terminals, including xterm, have these sequences 917default. (Note that many other terminals, including xterm, have these
767enabled by default). You can enable them by setting this boolean 918sequences enabled by default, which doesn't make it safer, though).
768resource or specifying B<-insecure> as an option. At the moment, this 919
769enabled display-answer, locale, findfont, icon label and window title 920You can enable them by setting this boolean resource or specifying
770requests as well as dynamic menubar dispatch. 921B<-insecure> as an option. At the moment, this enables display-answer,
922locale, findfont, icon label and window title requests as well as dynamic
923menubar dispatch.
771 924
772=item B<modifier:> I<modifier> 925=item B<modifier:> I<modifier>
773 926
774Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 927Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
775B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 928B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
790Turn on/off secondary screen scroll (default enabled). If the this 943Turn on/off secondary screen scroll (default enabled). If the this
791option is enabled, scrolls on the secondary screen will change the 944option is enabled, scrolls on the secondary screen will change the
792scrollback buffer and switching to/from the secondary screen will 945scrollback buffer and switching to/from the secondary screen will
793instead scroll the screen up. 946instead scroll the screen up.
794 947
948=item B<hold>: I<bool>
949
950Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
951will not immediately destroy its window when the program executed within
952it exits. Instead, it will wait till it is being killed or closed by the
953user.
954
795=item B<keysym.>I<sym>: I<string> 955=item B<keysym.>I<sym>: I<string>
796 956
797Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may 957Compile I<frills>: Associate I<string> with keysym I<sym>. The
798contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: 958intervening resource name B<keysym.> cannot be omitted.
799newline, \r: return, \t: 959
960The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
961any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
962B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
963and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
964B<2>, B<3>, B<4>, B<5>.
965
966The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
967whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
968keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
969current application keymap mode state.
970
971The spellings of I<key> can be obtained by using B<xev>(1) command or
972searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
973omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
974keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
975performed in an exact manner; however, the closest match is assured.
976
977I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
978C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
800tab, \000: octal number) or control characters (^?: delete, ^@: null, 979C<\000>: octal number) or verbatim control characters (C<^?>: delete,
801^A ...) and may enclosed with double quotes so that it can start or end 980C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
802with whitespace. The intervening resource name B<keysym.> cannot be 981can start or end with whitespace.
803omitted. This resource is only available when compiled with 982
804KEYSYM_RESOURCE. 983Please note that you need to double the C<\> when using
984C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
985use C<\033> instead of C<\e> (and so on), which will work with both Xt and
986@@RXVT_NAME@@'s own processing).
987
988You can define a range of keysyms in one shot by providing a I<string>
989with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
990should be a character not used by the strings.
991
992Its usage can be demonstrated by an example:
993
994 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
995
996The above line is equivalent to the following three lines:
997
998 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
999 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
1000 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
1001
1002If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1003is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1004example the following means "change the current locale to C<zh_CN.GBK>
1005when Control-Meta-c is being pressed":
1006
1007 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1008
1009Due the the large number of modifier combinations, a defined key mapping
1010will match if at I<at least> the specified identifiers are being set, and
1011no other key mappings with those and more bits are being defined. That
1012means that defining a key map for C<a> will automatically provide
1013definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1014mappings themselves.
1015
1016Unfortunately, this will override built-in key mappings. For example
1017if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
1018C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
1019user-defined keymap using the C<builtin:> replacement:
1020
1021 URxvt.keysym.Insert: <my insert key sequence>
1022 URxvt.keysym.S-Insert: builtin:
1023
1024The first line defines a mapping for C<Insert> and I<any> combination
1025of modifiers. The second line re-establishes the default mapping for
1026C<Shift-Insert>.
1027
1028The following example will map Control-Meta-1 and Control-Meta-2 to
1029the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1030font-switching at runtime:
1031
1032 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1033 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1034
1035Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1036info):
1037
1038 URxvt.keysym.M-C-3: command:\033[8;25;80t
1039 URxvt.keysym.M-C-4: command:\033[8;48;110t
805 1040
806=back 1041=back
807 1042
808=head1 THE SCROLLBAR 1043=head1 THE SCROLLBAR
809 1044
823the normal text selection/insertion, hold either the Shift or the Meta 1058the normal text selection/insertion, hold either the Shift or the Meta
824(Alt) key while performing the desired mouse action. 1059(Alt) key while performing the desired mouse action.
825 1060
826If mouse reporting mode is active, the normal scrollbar actions are 1061If mouse reporting mode is active, the normal scrollbar actions are
827disabled -- on the assumption that we are using a fullscreen 1062disabled -- on the assumption that we are using a fullscreen
828application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 1063application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
829(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 1064(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
830up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down), 1065up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
831respectively. 1066respectively.
832 1067
833=head1 TEXT SELECTION AND INSERTION 1068=head1 TEXT SELECTION AND INSERTION
834 1069
835The behaviour of text selection and insertion mechanism is similar to 1070The behaviour of text selection and insertion mechanism is similar to
837 1072
838=over 4 1073=over 4
839 1074
840=item B<Selection>: 1075=item B<Selection>:
841 1076
842Left click at the beginning of the region, drag to the end of the 1077Left click at the beginning of the region, drag to the end of the region
843region and release; Right click to extend the marked region; Left 1078and release; Right click to extend the marked region; Left double-click
844double-click to select a word; Left triple-click to select the entire 1079to select a word; Left triple-click to select the entire logical line
845line. 1080(which can span multiple screen lines), unless modified by resource
1081B<tripleclickwords>.
846 1082
847Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1083Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
848(Compile: frills) will create a rectangular selection instead of a normal 1084(Compile: I<frills>) will create a rectangular selection instead of a normal
849one. 1085one.
850 1086
851=item B<Insertion>: 1087=item B<Insertion>:
852 1088
853Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1089Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
862supported in rxvt-unicode. Bug me if you need this. 1098supported in rxvt-unicode. Bug me if you need this.
863 1099
864You can, however, switch fonts at runtime using escape sequences (and 1100You can, however, switch fonts at runtime using escape sequences (and
865therefore using the menubar), e.g.: 1101therefore using the menubar), e.g.:
866 1102
867 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1103 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
868 1104
869rxvt-unicode will automatically re-apply these fonts to the output so far. 1105rxvt-unicode will automatically re-apply these fonts to the output so far.
870 1106
871=head1 ISO 14755 SUPPORT 1107=head1 ISO 14755 SUPPORT
872 1108
876C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1112C<--enable-frills>, the rest is available when rxvt-unicode was compiled
877with C<--enable-iso14755>. 1113with C<--enable-iso14755>.
878 1114
879=over 4 1115=over 4
880 1116
881=item 5.1: Basic method 1117=item * 5.1: Basic method
882 1118
883This allows you to enter unicode characters using their hexcode. 1119This allows you to enter unicode characters using their hexcode.
884 1120
885Start by pressing and holding both C<Control> and C<Shift>, then enter 1121Start by pressing and holding both C<Control> and C<Shift>, then enter
886hex-digits (between one and six). Releasing C<Control> and C<Shift> will 1122hex-digits (between one and six). Releasing C<Control> and C<Shift> will
893address, which you cannot type. Fortunately, the card has the e-mail 1129address, which you cannot type. Fortunately, the card has the e-mail
894address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily 1130address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
895by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>, 1131by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
896followed by releasing the modifier keys. 1132followed by releasing the modifier keys.
897 1133
898=item 5.2: Keyboard symbols entry method 1134=item * 5.2: Keyboard symbols entry method
899 1135
900This mode lets you input characters representing the keycap symbols of 1136This mode lets you input characters representing the keycap symbols of
901your keyboard, if representable in the current locale encoding. 1137your keyboard, if representable in the current locale encoding.
902 1138
903Start by pressing C<Control> and C<Shift> together, then releasing 1139Start by pressing C<Control> and C<Shift> together, then releasing
906keycap symbol. The symbol will only be entered when the key has been 1142keycap symbol. The symbol will only be entered when the key has been
907released, otherwise pressing e.g. C<Shift> would enter the symbol for 1143released, otherwise pressing e.g. C<Shift> would enter the symbol for
908C<ISO Level 2 Switch>, although your intention might have been to enter a 1144C<ISO Level 2 Switch>, although your intention might have been to enter a
909reverse tab (Shift-Tab). 1145reverse tab (Shift-Tab).
910 1146
911=item 5.3: Screen-selection entry method 1147=item * 5.3: Screen-selection entry method
912 1148
913While this is implemented already (it's basically the selection 1149While this is implemented already (it's basically the selection
914mechanism), it could be extended by displaying a unicode character map. 1150mechanism), it could be extended by displaying a unicode character map.
915 1151
916=item 5.4: Feedback method for identifying displayed characters for later input 1152=item * 5.4: Feedback method for identifying displayed characters for later input
917 1153
918This method lets you display the unicode character code associated with 1154This method lets you display the unicode character code associated with
919characters already displayed. 1155characters already displayed.
920 1156
921You enter this mode by holding down C<Control> and C<Shift> together, then 1157You enter this mode by holding down C<Control> and C<Shift> together, then
933With respect to conformance, rxvt-unicode is supposed to be compliant to 1169With respect to conformance, rxvt-unicode is supposed to be compliant to
934both scenario A and B of ISO 14755, including part 5.2. 1170both scenario A and B of ISO 14755, including part 5.2.
935 1171
936=head1 LOGIN STAMP 1172=head1 LOGIN STAMP
937 1173
938B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so 1174B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
939that it can be seen via the I<who(1)> command, and can accept messages. 1175it can be seen via the I<who(1)> command, and can accept messages. To
940To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on 1176allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
941some systems. 1177on some systems or setgid to root or to some other group on others.
942 1178
943=head1 COLORS AND GRAPHICS 1179=head1 COLORS AND GRAPHICS
944 1180
945In addition to the default foreground and background colours, 1181In addition to the default foreground and background colours,
946B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1182B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
989 1225
990=back 1226=back
991 1227
992=head1 ENVIRONMENT 1228=head1 ENVIRONMENT
993 1229
994B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> 1230B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
995and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X 1231
996window id number of the B<@@RXVT_NAME@@> window and it also uses and 1232=over 4
997sets the environment variable B<DISPLAY> to specify which display 1233
998terminal to use. B<@@RXVT_NAME@@> uses the environment variables 1234=item B<TERM>
999B<RXVTPATH> and B<PATH> to find XPM files. 1235
1236Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1237resources or on the commandline.
1238
1239=item B<COLORTERM>
1240
1241Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
1242compiled with XPM support, and optionally with the added extension
1243C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1244
1245=item B<COLORFGBG>
1246
1247Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1248the colour code used as default foreground/text colour (or the string
1249C<default> to indicate that the default-colour escape sequence is to be
1250used), C<bg> is the colour code used as default background colour (or the
1251string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1252was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
1253(and do) use this information to optimize screen output.
1254
1255=item B<WINDOWID>
1256
1257Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1258window, which usually has subwindows for the scrollbar, the terminal
1259window and so on).
1260
1261=item B<TERMINFO>
1262
1263Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1264C<--with-terminfo=PATH>.
1265
1266=item B<DISPLAY>
1267
1268Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1269display in it's child processes.
1270
1271=item B<SHELL>
1272
1273The shell to be used for command execution, defaults to C</bin/sh>.
1274
1275=item B<RXVTPATH>
1276
1277The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1278files.
1279
1280=item B<PATH>
1281
1282Used in the same way as C<RXVTPATH>.
1283
1284=item B<RXVT_SOCKET>
1285
1286The unix domain socket path used by @@RXVT_NAME@@c(1) and
1287@@RXVT_NAME@@d(1).
1288
1289Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1290
1291=item B<HOME>
1292
1293Used to locate the default directory for the unix domain socket for
1294daemon communications and to locate various resource files (such as
1295C<.Xdefaults>)
1296
1297=item B<XAPPLRESDIR>
1298
1299Directory where various X resource files are being located.
1300
1301=item B<XENVIRONMENT>
1302
1303If set and accessible, gives the name of a X resource file to be loaded by
1304@@RXVT_NAME@@.
1305
1306=back
1000 1307
1001=head1 FILES 1308=head1 FILES
1002 1309
1003=over 4 1310=over 4
1004 1311
1005=item B</etc/utmp>
1006
1007System file for login records.
1008
1009=item B</usr/lib/X11/rgb.txt> 1312=item B</usr/lib/X11/rgb.txt>
1010 1313
1011Color names. 1314Color names.
1012 1315
1013=back 1316=back
1014 1317
1015=head1 SEE ALSO 1318=head1 SEE ALSO
1016 1319
1017@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1320@@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)
1018
1019=head1 BUGS
1020
1021Check the BUGS file for an up-to-date list.
1022
1023Cursor change support is not yet implemented.
1024
1025Click-and-drag doesn't work with X11 mouse report overriding.
1026 1321
1027=head1 CURRENT PROJECT COORDINATOR 1322=head1 CURRENT PROJECT COORDINATOR
1028 1323
1029=over 4 1324=over 4
1030 1325
1031=item Project Coordinator 1326=item Project Coordinator
1032 1327
1033@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1328Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1034 1329
1035=item Web page maintainter 1330L<http://software.schmorp.de/#rxvt-unicode>
1036
1037@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1038
1039L<@@RXVT_WEBPAGE@@>
1040 1331
1041=back 1332=back
1042 1333
1043=head1 AUTHORS 1334=head1 AUTHORS
1044 1335
1069=item Geoff Wing L<< <gcw@pobox.com> >> 1360=item Geoff Wing L<< <gcw@pobox.com> >>
1070 1361
1071Rewrote screen display and text selection routines. Project Coordinator 1362Rewrote screen display and text selection routines. Project Coordinator
1072(changes.txt 2.4.6 - rxvt-unicode) 1363(changes.txt 2.4.6 - rxvt-unicode)
1073 1364
1074=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1365=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1075 1366
1076Forked rxvt-unicode, rewrote most of the display code and internal 1367Forked rxvt-unicode, rewrote most of the display code and internal
1077character handling to store text in unicode, improve xterm 1368character handling to store text in unicode, improve xterm
1078compatibility and apply numerous other bugfixes and extensions. 1369compatibility and apply numerous other bugfixes and extensions.
1079 1370

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines