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.48 by root, Thu Feb 3 10:24:10 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
312 328
313Compile I<XIM>: input method name. resource B<inputMethod>. 329Compile I<XIM>: input method name. resource B<inputMethod>.
314 330
315=item B<-imlocale> I<string> 331=item B<-imlocale> I<string>
316 332
317The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 333The 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 334C<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 335input extension to be able to input japanese characters while staying in
320another locale. 336another locale. resource B<imLocale>.
337
338=item B<-imfont> I<fontset>
339
340Set the font set to use for the X Input Method, see resource B<imFont>
341for more info.
342
343=item B<-tcw>
344
345Change the meaning of triple-click selection with the left mouse
346button. Instead of selecting a full line it will extend the selection the
347end of the logical line only. resource B<tripleclickwords>.
321 348
322=item B<-insecure> 349=item B<-insecure>
323 350
324Enable "insecure" mode, which currently enables most of the escape 351Enable "insecure" mode, which currently enables most of the escape
325sequences that echo strings. See the resource B<insecure> for more 352sequences that echo strings. See the resource B<insecure> for more
412 439
413=item B<colorIT:> I<colour> 440=item B<colorIT:> I<colour>
414 441
415Use the specified colour to display bold or italic characters when the 442Use the specified colour to display bold or italic characters when the
416foreground colour is the default. If font styles are not available 443foreground colour is the default. If font styles are not available
417(Compile styles) and this option is unset, reverse video is used instead. 444(Compile I<styles>) and this option is unset, reverse video is used instead.
418 445
419=item B<colorUL:> I<colour> 446=item B<colorUL:> I<colour>
420 447
421Use the specified colour to display underlined characters when the 448Use the specified colour to display underlined characters when the
422foreground colour is the default. 449foreground colour is the default.
423 450
424=item B<colorRV:> I<colour> 451=item B<colorRV:> I<colour>
425 452
426Use the specified colour as the background for reverse video 453Use the specified colour as the background for reverse video
427characters. 454characters.
455
456=item B<underlineColor:> I<colour>
457
458If set, use the specified colour as the colour for the underline
459itself. If unset, use the foreground colour.
428 460
429=item B<cursorColor:> I<colour> 461=item B<cursorColor:> I<colour>
430 462
431Use the specified colour for the cursor. The default is to use the 463Use the specified colour for the cursor. The default is to use the
432foreground colour; option B<-cr>. 464foreground colour; option B<-cr>.
465 497
466=item B<shading:> I<number> 498=item B<shading:> I<number>
467 499
468Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 500Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
469image in addition to tinting it. 501image in addition to tinting it.
470
471=item B<fading:> I<number>
472
473Scale the tint colour by the given percentage.
474 502
475=item B<scrollColor:> I<colour> 503=item B<scrollColor:> I<colour>
476 504
477Use the specified colour for the scrollbar [default #B2B2B2]. 505Use the specified colour for the scrollbar [default #B2B2B2].
478 506
517The first font defines the cell size for characters; other fonts might 545The first font defines the cell size for characters; other fonts might
518be smaller, but not larger. A reasonable default font list is always 546be smaller, but not larger. A reasonable default font list is always
519appended to it. option B<-fn>. 547appended to it. option B<-fn>.
520 548
521Each font can either be a standard X11 core font (XLFD) name, with 549Each 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:>. 550optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
523 551
524In addition, each font can be prefixed with additional hints and 552In addition, each font can be prefixed with additional hints and
525specifications enclosed in square brackets (C<[]>). The only available 553specifications enclosed in square brackets (C<[]>). The only available
526hint currently is C<codeset=codeset-name>, and this is only used for Xft 554hint currently is C<codeset=codeset-name>, and this is only used for Xft
527fonts. 555fonts.
537specifies five fonts to be used. The first one is C<9x15bold> (actually 565specifies 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 566the 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 567it is named first) and thus defines the character cell grid to be 9 pixels
540wide and 15 pixels high. 568wide and 15 pixels high.
541 569
542the second font is just used to add additional unicode characters not in 570The second font is just used to add additional unicode characters not in
543the base font, likewise the third, which is unfortunately non-bold, but 571the 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 572the bold version of the font does contain less characters, so this is a
545useful supplement. 573useful supplement.
546 574
547The third font is an Xft font with aliasing turned off, and the characters 575The third font is an Xft font with aliasing turned off, and the characters
700=item B<mouseWheelScrollPage:> I<boolean> 728=item B<mouseWheelScrollPage:> I<boolean>
701 729
702B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel 730B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
703scrolls five lines [default]. 731scrolls five lines [default].
704 732
733=item B<pastableTabs:> I<boolean>
734
735B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
736movement only; option C<-ptab>.
737
705=item B<cursorBlink:> I<boolean> 738=item B<cursorBlink:> I<boolean>
706 739
707B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 740B<True>: blink the cursor. B<False>: do not blink the cursor [default];
708option B<-bc>. 741option B<-bc>.
709 742
753 786
754I<name> of inputMethod to use; option B<-im>. 787I<name> of inputMethod to use; option B<-im>.
755 788
756=item B<imLocale:> I<name> 789=item B<imLocale:> I<name>
757 790
758The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 791The 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 792C<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 793input extension to be able to input japanese characters while staying in
761another locale. option B<-imlocale>. 794another locale. option B<-imlocale>.
795
796=item B<imFont:> I<fontset>
797
798Specify the font-set used for XIM styles C<OverTheSpot> or
799C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
800by commas), i.e. it's not in the same format as the other font lists used
801in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
802found, preferably one or two pixels differing in size to the base font.
803option B<-imfont>.
804
805=item B<tripleclickwords:> I<boolean>
806
807Change the meaning of triple-click selection with the left mouse
808button. Instead of selecting a full line it will extend the selection to
809the end of the logical line only. option B<-tcw>.
762 810
763=item B<insecure:> I<boolean> 811=item B<insecure:> I<boolean>
764 812
765Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 813Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
766echo arbitrary strings like the icon name or the locale. This could be 814echo arbitrary strings like the icon name or the locale. This could be
796scrollback buffer and switching to/from the secondary screen will 844scrollback buffer and switching to/from the secondary screen will
797instead scroll the screen up. 845instead scroll the screen up.
798 846
799=item B<keysym.>I<sym>: I<string> 847=item B<keysym.>I<sym>: I<string>
800 848
801Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may 849Compile I<frills>: Associate I<string> with keysym I<sym>. The
802contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: 850intervening resource name B<keysym.> cannot be omitted.
803newline, \r: return, \t: 851
852The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
853any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
854B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
855and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
856B<2>, B<3>, B<4>, B<5>.
857
858The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
859whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
860keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
861current application keymap mode state.
862
863The spellings of I<key> can be obtained by using B<xev>(1) command or
864searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
865omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
866keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
867performed in an exact manner; however, the closest match is assured.
868
869I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
870C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
804tab, \000: octal number) or control characters (^?: delete, ^@: null, 871C<\000>: octal number) or verbatim control characters (C<^?>: delete,
805^A ...) and may enclosed with double quotes so that it can start or end 872C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
806with whitespace. The intervening resource name B<keysym.> cannot be 873can start or end with whitespace.
807omitted. This resource is only available when compiled with 874
808KEYSYM_RESOURCE. 875Please note that you need to double the C<\> when using
876C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
877use C<\033> instead of C<\e> (and so on), which will work with both Xt and
878@@RXVT_NAME@@'s own processing).
879
880You can define a range of keysyms in one shot by providing a I<string>
881with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
882should be a character not used by the strings.
883
884Its usage can be demonstrated by an example:
885
886 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
887
888The above line is equivalent to the following three lines:
889
890 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
891 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
892 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
893
894If I<string> takes the form of C<command:STRING>, the specified B<STRING>
895is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
896example the following means "change the current locale to C<zh_CN.GBK>
897when Control-Meta-c is being pressed":
898
899 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
900
901The following example will map Control-Meta-1 and Control-Meta-2 to
902the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
903font-switching at runtime:
904
905 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
906 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
907
908Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
909info):
910
911 URxvt.keysym.M-C-3: command:\033[8;25;80t
912 URxvt.keysym.M-C-4: command:\033[8;48;110t
809 913
810=back 914=back
811 915
812=head1 THE SCROLLBAR 916=head1 THE SCROLLBAR
813 917
841 945
842=over 4 946=over 4
843 947
844=item B<Selection>: 948=item B<Selection>:
845 949
846Left click at the beginning of the region, drag to the end of the 950Left 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 951and release; Right click to extend the marked region; Left double-click
848double-click to select a word; Left triple-click to select the entire 952to select a word; Left triple-click to select the entire logical line
849line. 953(which can span multiple screen lines), unless modified by resource
954B<tripleclickwords>.
850 955
851Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 956Starting 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 957(Compile: I<frills>) will create a rectangular selection instead of a normal
853one. 958one.
854 959
855=item B<Insertion>: 960=item B<Insertion>:
856 961
857Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 962Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
880C<--enable-frills>, the rest is available when rxvt-unicode was compiled 985C<--enable-frills>, the rest is available when rxvt-unicode was compiled
881with C<--enable-iso14755>. 986with C<--enable-iso14755>.
882 987
883=over 4 988=over 4
884 989
885=item 5.1: Basic method 990=item * 5.1: Basic method
886 991
887This allows you to enter unicode characters using their hexcode. 992This allows you to enter unicode characters using their hexcode.
888 993
889Start by pressing and holding both C<Control> and C<Shift>, then enter 994Start 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 995hex-digits (between one and six). Releasing C<Control> and C<Shift> will
897address, which you cannot type. Fortunately, the card has the e-mail 1002address, 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 1003address 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>, 1004by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
900followed by releasing the modifier keys. 1005followed by releasing the modifier keys.
901 1006
902=item 5.2: Keyboard symbols entry method 1007=item * 5.2: Keyboard symbols entry method
903 1008
904This mode lets you input characters representing the keycap symbols of 1009This mode lets you input characters representing the keycap symbols of
905your keyboard, if representable in the current locale encoding. 1010your keyboard, if representable in the current locale encoding.
906 1011
907Start by pressing C<Control> and C<Shift> together, then releasing 1012Start by pressing C<Control> and C<Shift> together, then releasing
910keycap symbol. The symbol will only be entered when the key has been 1015keycap symbol. The symbol will only be entered when the key has been
911released, otherwise pressing e.g. C<Shift> would enter the symbol for 1016released, 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 1017C<ISO Level 2 Switch>, although your intention might have been to enter a
913reverse tab (Shift-Tab). 1018reverse tab (Shift-Tab).
914 1019
915=item 5.3: Screen-selection entry method 1020=item * 5.3: Screen-selection entry method
916 1021
917While this is implemented already (it's basically the selection 1022While this is implemented already (it's basically the selection
918mechanism), it could be extended by displaying a unicode character map. 1023mechanism), it could be extended by displaying a unicode character map.
919 1024
920=item 5.4: Feedback method for identifying displayed characters for later input 1025=item * 5.4: Feedback method for identifying displayed characters for later input
921 1026
922This method lets you display the unicode character code associated with 1027This method lets you display the unicode character code associated with
923characters already displayed. 1028characters already displayed.
924 1029
925You enter this mode by holding down C<Control> and C<Shift> together, then 1030You 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 1042With respect to conformance, rxvt-unicode is supposed to be compliant to
938both scenario A and B of ISO 14755, including part 5.2. 1043both scenario A and B of ISO 14755, including part 5.2.
939 1044
940=head1 LOGIN STAMP 1045=head1 LOGIN STAMP
941 1046
942B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so 1047B<@@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. 1048it 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 1049allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
945some systems. 1050on some systems or setgid to root or to some other group on others.
946 1051
947=head1 COLORS AND GRAPHICS 1052=head1 COLORS AND GRAPHICS
948 1053
949In addition to the default foreground and background colours, 1054In addition to the default foreground and background colours,
950B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1055B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1004 1109
1005=head1 FILES 1110=head1 FILES
1006 1111
1007=over 4 1112=over 4
1008 1113
1009=item B</etc/utmp>
1010
1011System file for login records.
1012
1013=item B</usr/lib/X11/rgb.txt> 1114=item B</usr/lib/X11/rgb.txt>
1014 1115
1015Color names. 1116Color names.
1016 1117
1017=back 1118=back

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines