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.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>.
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
327 328
328Compile I<XIM>: input method name. resource B<inputMethod>. 329Compile I<XIM>: input method name. resource B<inputMethod>.
329 330
330=item B<-imlocale> I<string> 331=item B<-imlocale> I<string>
331 332
332The 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.
333de_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
334extension to be able to input japanese characters while staying in 335input extension to be able to input japanese characters while staying in
335another 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>.
336 348
337=item B<-insecure> 349=item B<-insecure>
338 350
339Enable "insecure" mode, which currently enables most of the escape 351Enable "insecure" mode, which currently enables most of the escape
340sequences that echo strings. See the resource B<insecure> for more 352sequences that echo strings. See the resource B<insecure> for more
427 439
428=item B<colorIT:> I<colour> 440=item B<colorIT:> I<colour>
429 441
430Use the specified colour to display bold or italic characters when the 442Use the specified colour to display bold or italic characters when the
431foreground colour is the default. If font styles are not available 443foreground colour is the default. If font styles are not available
432(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.
433 445
434=item B<colorUL:> I<colour> 446=item B<colorUL:> I<colour>
435 447
436Use the specified colour to display underlined characters when the 448Use the specified colour to display underlined characters when the
437foreground colour is the default. 449foreground colour is the default.
438 450
439=item B<colorRV:> I<colour> 451=item B<colorRV:> I<colour>
440 452
441Use the specified colour as the background for reverse video 453Use the specified colour as the background for reverse video
442characters. 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.
443 460
444=item B<cursorColor:> I<colour> 461=item B<cursorColor:> I<colour>
445 462
446Use 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
447foreground colour; option B<-cr>. 464foreground colour; option B<-cr>.
528The first font defines the cell size for characters; other fonts might 545The first font defines the cell size for characters; other fonts might
529be smaller, but not larger. A reasonable default font list is always 546be smaller, but not larger. A reasonable default font list is always
530appended to it. option B<-fn>. 547appended to it. option B<-fn>.
531 548
532Each 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
533optional 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:>.
534 551
535In addition, each font can be prefixed with additional hints and 552In addition, each font can be prefixed with additional hints and
536specifications enclosed in square brackets (C<[]>). The only available 553specifications enclosed in square brackets (C<[]>). The only available
537hint 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
538fonts. 555fonts.
769 786
770I<name> of inputMethod to use; option B<-im>. 787I<name> of inputMethod to use; option B<-im>.
771 788
772=item B<imLocale:> I<name> 789=item B<imLocale:> I<name>
773 790
774The 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.
775de_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
776extension to be able to input japanese characters while staying in 793input extension to be able to input japanese characters while staying in
777another 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>.
778 810
779=item B<insecure:> I<boolean> 811=item B<insecure:> I<boolean>
780 812
781Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 813Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
782echo 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
812scrollback buffer and switching to/from the secondary screen will 844scrollback buffer and switching to/from the secondary screen will
813instead scroll the screen up. 845instead scroll the screen up.
814 846
815=item B<keysym.>I<sym>: I<string> 847=item B<keysym.>I<sym>: I<string>
816 848
817Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may 849Compile I<frills>: Associate I<string> with keysym I<sym>. The
818contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: 850intervening resource name B<keysym.> cannot be omitted.
819newline, \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,
820tab, \000: octal number) or control characters (^?: delete, ^@: null, 871C<\000>: octal number) or verbatim control characters (C<^?>: delete,
821^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
822with whitespace. The intervening resource name B<keysym.> cannot be 873can start or end with whitespace.
823omitted. This resource is only available when compiled with 874
824KEYSYM_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
825 913
826=back 914=back
827 915
828=head1 THE SCROLLBAR 916=head1 THE SCROLLBAR
829 917
857 945
858=over 4 946=over 4
859 947
860=item B<Selection>: 948=item B<Selection>:
861 949
862Left 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
863region and release; Right click to extend the marked region; Left 951and release; Right click to extend the marked region; Left double-click
864double-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
865line. 953(which can span multiple screen lines), unless modified by resource
954B<tripleclickwords>.
866 955
867Starting 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)
868(Compile: frills) will create a rectangular selection instead of a normal 957(Compile: I<frills>) will create a rectangular selection instead of a normal
869one. 958one.
870 959
871=item B<Insertion>: 960=item B<Insertion>:
872 961
873Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 962Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
896C<--enable-frills>, the rest is available when rxvt-unicode was compiled 985C<--enable-frills>, the rest is available when rxvt-unicode was compiled
897with C<--enable-iso14755>. 986with C<--enable-iso14755>.
898 987
899=over 4 988=over 4
900 989
901=item 5.1: Basic method 990=item * 5.1: Basic method
902 991
903This allows you to enter unicode characters using their hexcode. 992This allows you to enter unicode characters using their hexcode.
904 993
905Start 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
906hex-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
913address, which you cannot type. Fortunately, the card has the e-mail 1002address, which you cannot type. Fortunately, the card has the e-mail
914address 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
915by 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>,
916followed by releasing the modifier keys. 1005followed by releasing the modifier keys.
917 1006
918=item 5.2: Keyboard symbols entry method 1007=item * 5.2: Keyboard symbols entry method
919 1008
920This mode lets you input characters representing the keycap symbols of 1009This mode lets you input characters representing the keycap symbols of
921your keyboard, if representable in the current locale encoding. 1010your keyboard, if representable in the current locale encoding.
922 1011
923Start by pressing C<Control> and C<Shift> together, then releasing 1012Start by pressing C<Control> and C<Shift> together, then releasing
926keycap 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
927released, otherwise pressing e.g. C<Shift> would enter the symbol for 1016released, otherwise pressing e.g. C<Shift> would enter the symbol for
928C<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
929reverse tab (Shift-Tab). 1018reverse tab (Shift-Tab).
930 1019
931=item 5.3: Screen-selection entry method 1020=item * 5.3: Screen-selection entry method
932 1021
933While this is implemented already (it's basically the selection 1022While this is implemented already (it's basically the selection
934mechanism), it could be extended by displaying a unicode character map. 1023mechanism), it could be extended by displaying a unicode character map.
935 1024
936=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
937 1026
938This method lets you display the unicode character code associated with 1027This method lets you display the unicode character code associated with
939characters already displayed. 1028characters already displayed.
940 1029
941You 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
953With respect to conformance, rxvt-unicode is supposed to be compliant to 1042With respect to conformance, rxvt-unicode is supposed to be compliant to
954both scenario A and B of ISO 14755, including part 5.2. 1043both scenario A and B of ISO 14755, including part 5.2.
955 1044
956=head1 LOGIN STAMP 1045=head1 LOGIN STAMP
957 1046
958B<@@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
959that 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
960To 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
961some systems. 1050on some systems or setgid to root or to some other group on others.
962 1051
963=head1 COLORS AND GRAPHICS 1052=head1 COLORS AND GRAPHICS
964 1053
965In addition to the default foreground and background colours, 1054In addition to the default foreground and background colours,
966B<@@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
1020 1109
1021=head1 FILES 1110=head1 FILES
1022 1111
1023=over 4 1112=over 4
1024 1113
1025=item B</etc/utmp>
1026
1027System file for login records.
1028
1029=item B</usr/lib/X11/rgb.txt> 1114=item B</usr/lib/X11/rgb.txt>
1030 1115
1031Color names. 1116Color names.
1032 1117
1033=back 1118=back

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines