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.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>.
… …
162=item B<-fn> I<fontlist> 162=item B<-fn> I<fontlist>
163 163
164Select the fonts to be used. This is a comma separated list of font names 164Select 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 165that are used in turn when trying to display Unicode characters. The
166first font defines the cell size for characters; other fonts might be 166first font defines the cell size for characters; other fonts might be
167smaller, but not (in general) larger. A reasonable default font list is 167smaller, but not (in general) larger. A (hopefully) reasonable default
168always appended to it. See resource B<font> for details. 168font list is always appended to it. See resource B<font> for more details.
169
170In short, to specify an X11 core font, just specify it's name or prefix it
171with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
172e.g.:
173
174 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
175 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
169 176
170See also the question "How does rxvt-unicode choose fonts?" in the FAQ 177See also the question "How does rxvt-unicode choose fonts?" in the FAQ
171section of @@RXVT_NAME@@(7). 178section of @@RXVT_NAME@@(7).
172 179
173=item B<-fb> I<fontlist> 180=item B<-fb> I<fontlist>
… …
232=item B<-st>|B<+st> 239=item B<-st>|B<+st>
233 240
234Display normal (non XTerm/NeXT) scrollbar without/with a trough; 241Display normal (non XTerm/NeXT) scrollbar without/with a trough;
235resource B<scrollBar_floating>. 242resource B<scrollBar_floating>.
236 243
244=item B<-ptab>|B<+ptab>
245
246If enabled (default), "Horizontal Tab" characters are being stored as
247actual wide characters in the screen buffer, which makes it possible to
248select and paste them. Since a horizontal tab is a cursor movement and
249not an actual glyph, this can sometimes be visually annoying as the cursor
250on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
251
237=item B<-bc>|B<+bc> 252=item B<-bc>|B<+bc>
238 253
239Blink the cursor; resource B<cursorBlink>. 254Blink the cursor; resource B<cursorBlink>.
240 255
241=item B<-iconic> 256=item B<-iconic>
… …
265if 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
266decorations; resource B<borderLess>. 281decorations; resource B<borderLess>.
267 282
268=item B<-lsp> I<number> 283=item B<-lsp> I<number>
269 284
270Compile I<linespace>: Lines (pixel height) to insert between each row 285Compile I<frills>: Lines (pixel height) to insert between each row of
271of the display; resource B<linespace>. 286the display. Useful to work around font rendering problems; resource
287B<linespace>.
272 288
273=item B<-tn> I<termname> 289=item B<-tn> I<termname>
274 290
275This 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
276B<TERM> environment variable. This terminal type must exist in the 292B<TERM> environment variable. This terminal type must exist in the
… …
412 428
413=item B<colorIT:> I<colour> 429=item B<colorIT:> I<colour>
414 430
415Use the specified colour to display bold or italic characters when the 431Use the specified colour to display bold or italic characters when the
416foreground colour is the default. If font styles are not available 432foreground colour is the default. If font styles are not available
417(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.
418 434
419=item B<colorUL:> I<colour> 435=item B<colorUL:> I<colour>
420 436
421Use the specified colour to display underlined characters when the 437Use the specified colour to display underlined characters when the
422foreground colour is the default. 438foreground colour is the default.
423 439
424=item B<colorRV:> I<colour> 440=item B<colorRV:> I<colour>
425 441
426Use the specified colour as the background for reverse video 442Use the specified colour as the background for reverse video
427characters. 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.
428 449
429=item B<cursorColor:> I<colour> 450=item B<cursorColor:> I<colour>
430 451
431Use 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
432foreground colour; option B<-cr>. 453foreground colour; option B<-cr>.
… …
465 486
466=item B<shading:> I<number> 487=item B<shading:> I<number>
467 488
468Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 489Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
469image in addition to tinting it. 490image in addition to tinting it.
470
471=item B<fading:> I<number>
472
473Scale the tint colour by the given percentage.
474 491
475=item B<scrollColor:> I<colour> 492=item B<scrollColor:> I<colour>
476 493
477Use the specified colour for the scrollbar [default #B2B2B2]. 494Use the specified colour for the scrollbar [default #B2B2B2].
478 495
… …
517The first font defines the cell size for characters; other fonts might 534The first font defines the cell size for characters; other fonts might
518be smaller, but not larger. A reasonable default font list is always 535be smaller, but not larger. A reasonable default font list is always
519appended to it. option B<-fn>. 536appended to it. option B<-fn>.
520 537
521Each 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
522optional 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:>.
523 540
524In addition, each font can be prefixed with additional hints and 541In addition, each font can be prefixed with additional hints and
525specifications enclosed in square brackets (C<[]>). The only available 542specifications enclosed in square brackets (C<[]>). The only available
526hint 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
527fonts. 544fonts.
… …
537specifies five fonts to be used. The first one is C<9x15bold> (actually 554specifies 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 555the 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 556it is named first) and thus defines the character cell grid to be 9 pixels
540wide and 15 pixels high. 557wide and 15 pixels high.
541 558
542the second font is just used to add additional unicode characters not in 559The second font is just used to add additional unicode characters not in
543the base font, likewise the third, which is unfortunately non-bold, but 560the 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 561the bold version of the font does contain less characters, so this is a
545useful supplement. 562useful supplement.
546 563
547The third font is an Xft font with aliasing turned off, and the characters 564The third font is an Xft font with aliasing turned off, and the characters
… …
699 716
700=item B<mouseWheelScrollPage:> I<boolean> 717=item B<mouseWheelScrollPage:> I<boolean>
701 718
702B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel 719B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
703scrolls five lines [default]. 720scrolls five lines [default].
721
722=item B<pastableTabs:> I<boolean>
723
724B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
725movement only; option C<-ptab>.
704 726
705=item B<cursorBlink:> I<boolean> 727=item B<cursorBlink:> I<boolean>
706 728
707B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 729B<True>: blink the cursor. B<False>: do not blink the cursor [default];
708option B<-bc>. 730option B<-bc>.
… …
796scrollback buffer and switching to/from the secondary screen will 818scrollback buffer and switching to/from the secondary screen will
797instead scroll the screen up. 819instead scroll the screen up.
798 820
799=item B<keysym.>I<sym>: I<string> 821=item B<keysym.>I<sym>: I<string>
800 822
801Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may 823Compile I<frills>: Associate I<string> with keysym I<sym>. The
802contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: 824intervening resource name B<keysym.> cannot be omitted.
803newline, \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,
804tab, \000: octal number) or control characters (^?: delete, ^@: null, 845C<\000>: octal number) or verbatim control characters (C<^?>: delete,
805^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
806with whitespace. The intervening resource name B<keysym.> cannot be 847can start or end with whitespace.
807omitted. This resource is only available when compiled with 848
808KEYSYM_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>.
809 867
810=back 868=back
811 869
812=head1 THE SCROLLBAR 870=head1 THE SCROLLBAR
813 871
… …
847region and release; Right click to extend the marked region; Left 905region and release; Right click to extend the marked region; Left
848double-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
849line. 907line.
850 908
851Starting 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)
852(Compile: frills) will create a rectangular selection instead of a normal 910(Compile: I<frills>) will create a rectangular selection instead of a normal
853one. 911one.
854 912
855=item B<Insertion>: 913=item B<Insertion>:
856 914
857Pressing 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