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.34 by root, Wed Dec 1 02:29:14 2004 UTC vs.
Revision 1.43 by root, Sun Jan 16 19:22:16 2005 UTC

110Turn on/off inheriting parent window's pixmap. Alternative form is 110Turn on/off inheriting parent window's pixmap. Alternative form is
111B<-tr>; resource B<inheritPixmap>. 111B<-tr>; resource B<inheritPixmap>.
112 112
113=item B<-fade> I<number> 113=item B<-fade> I<number>
114 114
115Fade the text by the given percentage when focus is lost. 115Fade the text by the given percentage when focus is lost. resource B<fading>.
116 116
117=item B<-tint> I<colour> 117=item B<-tint> I<colour>
118 118
119Tint the transparent background pixmap with the given colour when 119Tint the transparent background pixmap with the given colour when
120transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> 120transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>
123 123
124=item B<-sh> 124=item B<-sh>
125 125
126I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 126I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
127background image in addition to tinting it (i.e. B<-tint> must be 127background image in addition to tinting it (i.e. B<-tint> must be
128specified, too). 128specified, too, e.g. C<-tint white>).
129 129
130=item B<-bg> I<colour> 130=item B<-bg> I<colour>
131 131
132Window background colour; resource B<background>. 132Window background colour; resource B<background>.
133 133
136Window foreground colour; resource B<foreground>. 136Window foreground colour; resource B<foreground>.
137 137
138=item B<-pixmap> I<file[;geom]> 138=item B<-pixmap> I<file[;geom]>
139 139
140Compile I<XPM>: Specify XPM file for the background and also optionally 140Compile I<XPM>: Specify XPM file for the background and also optionally
141specify its scaling with a geometry string. Note you may need to add 141specify its scaling with a geometry string. Note you may need to
142quotes to avoid special shell interpretation of the `;' in the 142add quotes to avoid special shell interpretation of the C<;> in the
143command-line; resource B<backgroundPixmap>. 143command-line; resource B<backgroundPixmap>.
144 144
145=item B<-cr> I<colour> 145=item B<-cr> I<colour>
146 146
147The cursor colour; resource B<cursorColor>. 147The cursor colour; resource B<cursorColor>.
280if honoured by the WM, the rxvt-unicode window will not have window 280if honoured by the WM, the rxvt-unicode window will not have window
281decorations; resource B<borderLess>. 281decorations; resource B<borderLess>.
282 282
283=item B<-lsp> I<number> 283=item B<-lsp> I<number>
284 284
285Compile I<linespace>: Lines (pixel height) to insert between each row 285Compile I<frills>: Lines (pixel height) to insert between each row of
286of the display; resource B<linespace>. 286the display. Useful to work around font rendering problems; resource
287B<linespace>.
287 288
288=item B<-tn> I<termname> 289=item B<-tn> I<termname>
289 290
290This option specifies the name of the terminal type to be set in the 291This option specifies the name of the terminal type to be set in the
291B<TERM> environment variable. This terminal type must exist in the 292B<TERM> environment variable. This terminal type must exist in the
427 428
428=item B<colorIT:> I<colour> 429=item B<colorIT:> I<colour>
429 430
430Use the specified colour to display bold or italic characters when the 431Use the specified colour to display bold or italic characters when the
431foreground colour is the default. If font styles are not available 432foreground colour is the default. If font styles are not available
432(Compile styles) and this option is unset, reverse video is used instead. 433(Compile I<styles>) and this option is unset, reverse video is used instead.
433 434
434=item B<colorUL:> I<colour> 435=item B<colorUL:> I<colour>
435 436
436Use the specified colour to display underlined characters when the 437Use the specified colour to display underlined characters when the
437foreground colour is the default. 438foreground colour is the default.
438 439
439=item B<colorRV:> I<colour> 440=item B<colorRV:> I<colour>
440 441
441Use the specified colour as the background for reverse video 442Use the specified colour as the background for reverse video
442characters. 443characters.
444
445=item B<underlineColor:> I<colour>
446
447If set, use the specified colour as the colour for the underline
448itself. If unset, use the foreground colour.
443 449
444=item B<cursorColor:> I<colour> 450=item B<cursorColor:> I<colour>
445 451
446Use the specified colour for the cursor. The default is to use the 452Use the specified colour for the cursor. The default is to use the
447foreground colour; option B<-cr>. 453foreground colour; option B<-cr>.
528The first font defines the cell size for characters; other fonts might 534The first font defines the cell size for characters; other fonts might
529be smaller, but not larger. A reasonable default font list is always 535be smaller, but not larger. A reasonable default font list is always
530appended to it. option B<-fn>. 536appended to it. option B<-fn>.
531 537
532Each font can either be a standard X11 core font (XLFD) name, with 538Each font can either be a standard X11 core font (XLFD) name, with
533optional prefix C<x:> or a Xft font (Compile xft), prefixed with C<xft:>. 539optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
534 540
535In addition, each font can be prefixed with additional hints and 541In addition, each font can be prefixed with additional hints and
536specifications enclosed in square brackets (C<[]>). The only available 542specifications enclosed in square brackets (C<[]>). The only available
537hint currently is C<codeset=codeset-name>, and this is only used for Xft 543hint currently is C<codeset=codeset-name>, and this is only used for Xft
538fonts. 544fonts.
812scrollback buffer and switching to/from the secondary screen will 818scrollback buffer and switching to/from the secondary screen will
813instead scroll the screen up. 819instead scroll the screen up.
814 820
815=item B<keysym.>I<sym>: I<string> 821=item B<keysym.>I<sym>: I<string>
816 822
817Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may 823Compile I<frills>: Associate I<string> with keysym I<sym>. The
818contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: 824intervening resource name B<keysym.> cannot be omitted.
819newline, \r: return, \t: 825
826The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
827any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
828B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
829and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
830B<2>, B<3>, B<4>, B<5>.
831
832The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
833whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
834keys are being mapped. B<AppKeypad> is a artificial modifier mapped to the
835current application keymap mode state.
836
837The spellings of I<key> can be obtained by using B<xev>(1) command or
838searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
839omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
840keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
841performed in an exact manner; however, the closest match is assured.
842
843I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
844C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
820tab, \000: octal number) or control characters (^?: delete, ^@: null, 845C<\000>: octal number) or verbatim control characters (C<^?>: delete,
821^A ...) and may enclosed with double quotes so that it can start or end 846C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
822with whitespace. The intervening resource name B<keysym.> cannot be 847can start or end with whitespace.
823omitted. This resource is only available when compiled with 848
824KEYSYM_RESOURCE. 849You can define a range of keysyms in one shot by providing a I<string>
850with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
851should be a character not used by the strings.
852
853Its usage can be demonstrated by an example:
854
855 URxvt.keysym.M-C-0x61: list|\e<M-C-|abc|>
856
857The above line is equivalent to the following three lines:
858
859 URxvt.keysym.Meta-Control-0x61: \e<M-C-a>
860 URxvt.keysym.Meta-Control-0x62: \e<M-C-b>
861 URxvt.keysym.Meta-Control-0x63: \e<M-C-c>
862
863If I<string> takes the form of C<proto:STRING>, the specified B<STRING> is
864interpreted and executed as @@RXVT_NAME@@'s control sequence. For example,
865C<proto:\033]701;zh_CN.GBK\007> means: change the current locale to
866C<zh_CN.GBK>.
825 867
826=back 868=back
827 869
828=head1 THE SCROLLBAR 870=head1 THE SCROLLBAR
829 871
863region and release; Right click to extend the marked region; Left 905region and release; Right click to extend the marked region; Left
864double-click to select a word; Left triple-click to select the entire 906double-click to select a word; Left triple-click to select the entire
865line. 907line.
866 908
867Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 909Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
868(Compile: frills) will create a rectangular selection instead of a normal 910(Compile: I<frills>) will create a rectangular selection instead of a normal
869one. 911one.
870 912
871=item B<Insertion>: 913=item B<Insertion>:
872 914
873Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 915Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines