ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.man.in
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.man.in (file contents):
Revision 1.2 by root, Sun Jan 16 15:59:45 2005 UTC vs.
Revision 1.3 by root, Mon Jan 17 01:44:51 2005 UTC

… …
127.\} 127.\}
128.rm #[ #] #H #V #F C 128.rm #[ #] #H #V #F C
129.\" ======================================================================== 129.\" ========================================================================
130.\" 130.\"
131.IX Title "rxvt 1" 131.IX Title "rxvt 1"
132.TH rxvt 1 "2005-01-16" "4.8" "RXVT-UNICODE" 132.TH rxvt 1 "2005-01-17" "4.8" "RXVT-UNICODE"
133.SH "NAME" 133.SH "NAME"
134rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system) 134rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system)
135.SH "SYNOPSIS" 135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
137\&\fB@@RXVT_NAME@@\fR [options] [\-e command [ args ]] 137\&\fB@@RXVT_NAME@@\fR [options] [\-e command [ args ]]
… …
248.IX Item "-fg colour" 248.IX Item "-fg colour"
249Window foreground colour; resource \fBforeground\fR. 249Window foreground colour; resource \fBforeground\fR.
250.IP "\fB\-pixmap\fR \fIfile[;geom]\fR" 4 250.IP "\fB\-pixmap\fR \fIfile[;geom]\fR" 4
251.IX Item "-pixmap file[;geom]" 251.IX Item "-pixmap file[;geom]"
252Compile \fI\s-1XPM\s0\fR: Specify \s-1XPM\s0 file for the background and also optionally 252Compile \fI\s-1XPM\s0\fR: Specify \s-1XPM\s0 file for the background and also optionally
253specify its scaling with a geometry string. Note you may need to add 253specify its scaling with a geometry string. Note you may need to
254quotes to avoid special shell interpretation of the `;' in the 254add quotes to avoid special shell interpretation of the \f(CW\*(C`;\*(C'\fR in the
255command\-line; resource \fBbackgroundPixmap\fR. 255command\-line; resource \fBbackgroundPixmap\fR.
256.IP "\fB\-cr\fR \fIcolour\fR" 4 256.IP "\fB\-cr\fR \fIcolour\fR" 4
257.IX Item "-cr colour" 257.IX Item "-cr colour"
258The cursor colour; resource \fBcursorColor\fR. 258The cursor colour; resource \fBcursorColor\fR.
259.IP "\fB\-pr\fR \fIcolour\fR" 4 259.IP "\fB\-pr\fR \fIcolour\fR" 4
… …
495.IP "\fBcolorIT:\fR \fIcolour\fR" 4 495.IP "\fBcolorIT:\fR \fIcolour\fR" 4
496.IX Item "colorIT: colour" 496.IX Item "colorIT: colour"
497.PD 497.PD
498Use the specified colour to display bold or italic characters when the 498Use the specified colour to display bold or italic characters when the
499foreground colour is the default. If font styles are not available 499foreground colour is the default. If font styles are not available
500(Compile styles) and this option is unset, reverse video is used instead. 500(Compile \fIstyles\fR) and this option is unset, reverse video is used instead.
501.IP "\fBcolorUL:\fR \fIcolour\fR" 4 501.IP "\fBcolorUL:\fR \fIcolour\fR" 4
502.IX Item "colorUL: colour" 502.IX Item "colorUL: colour"
503Use the specified colour to display underlined characters when the 503Use the specified colour to display underlined characters when the
504foreground colour is the default. 504foreground colour is the default.
505.IP "\fBcolorRV:\fR \fIcolour\fR" 4 505.IP "\fBcolorRV:\fR \fIcolour\fR" 4
… …
583The first font defines the cell size for characters; other fonts might 583The first font defines the cell size for characters; other fonts might
584be smaller, but not larger. A reasonable default font list is always 584be smaller, but not larger. A reasonable default font list is always
585appended to it. option \fB\-fn\fR. 585appended to it. option \fB\-fn\fR.
586.Sp 586.Sp
587Each font can either be a standard X11 core font (\s-1XLFD\s0) name, with 587Each font can either be a standard X11 core font (\s-1XLFD\s0) name, with
588optional prefix \f(CW\*(C`x:\*(C'\fR or a Xft font (Compile xft), prefixed with \f(CW\*(C`xft:\*(C'\fR. 588optional prefix \f(CW\*(C`x:\*(C'\fR or a Xft font (Compile \fIxft\fR), prefixed with \f(CW\*(C`xft:\*(C'\fR.
589.Sp 589.Sp
590In addition, each font can be prefixed with additional hints and 590In addition, each font can be prefixed with additional hints and
591specifications enclosed in square brackets (\f(CW\*(C`[]\*(C'\fR). The only available 591specifications enclosed in square brackets (\f(CW\*(C`[]\*(C'\fR). The only available
592hint currently is \f(CW\*(C`codeset=codeset\-name\*(C'\fR, and this is only used for Xft 592hint currently is \f(CW\*(C`codeset=codeset\-name\*(C'\fR, and this is only used for Xft
593fonts. 593fonts.
… …
828option is enabled, scrolls on the secondary screen will change the 828option is enabled, scrolls on the secondary screen will change the
829scrollback buffer and switching to/from the secondary screen will 829scrollback buffer and switching to/from the secondary screen will
830instead scroll the screen up. 830instead scroll the screen up.
831.IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4 831.IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4
832.IX Item "keysym.sym: string" 832.IX Item "keysym.sym: string"
833Associate \fIstring\fR with keysym \fIsym\fR. The intervening resource 833Compile \fIfrills\fR: Associate \fIstring\fR with keysym \fIsym\fR. The
834name \fBkeysym.\fR cannot be omitted. This resource is only available 834intervening resource name \fBkeysym.\fR cannot be omitted.
835when compiled with \s-1KEYSYM_RESOURCE\s0.
836.Sp 835.Sp
837The format of \fIsym\fR is "\fI(mask\-)key\fR", 836The format of \fIsym\fR is "\fI(modifiers\-)key\fR", where \fImodifiers\fR can be
838where \fImask\fR can be any combination of \fBControl\fR, \fBNumLock\fR, 837any combination of \fBISOLevel3\fR, \fBAppKeypad\fR, \fBControl\fR, \fBNumLock\fR,
839\&\fBShift\fR, \fBMeta\fR, \fBLock\fR, \fBMod1\fR, \fBMod2\fR, \fBMod3\fR, \fBMod4\fR, 838\&\fBShift\fR, \fBMeta\fR, \fBLock\fR, \fBMod1\fR, \fBMod2\fR, \fBMod3\fR, \fBMod4\fR, \fBMod5\fR,
840\&\fBMod5\fR, and the abbreviated 839and the abbreviated \fBI\fR, \fBK\fR, \fBC\fR, \fBN\fR, \fBS\fR, \fBM\fR, \fBA\fR, \fBL\fR, \fB1\fR,
841\&\fBC\fR, \fBN\fR, \fBS\fR, \fBM\fR, \fBA\fR, \fBL\fR, \fB1\fR, \fB2\fR, \fB3\fR, \fB4\fR, \fB5\fR. 840\&\fB2\fR, \fB3\fR, \fB4\fR, \fB5\fR.
841.Sp
842The \fBNumLock\fR, \fBMeta\fR and \fBISOLevel3\fR modifiers are usually aliased to
843whatever modifier the NumLock key, Meta/Alt keys or \s-1ISO\s0 Level3 Shift/AltGr
844keys are being mapped. \fBAppKeypad\fR is a artificial modifier mapped to the
845current application keymap mode state.
846.Sp
842The spellings of \fIkey\fR can be obtained by using \fBxev\fR(1) 847The spellings of \fIkey\fR can be obtained by using \fBxev\fR(1) command or
843command or searching keysym macros from 848searching keysym macros from \fB/usr/X11R6/include/X11/keysymdef.h\fR and
844\&\fB/usr/X11R6/include/X11/keysymdef.h\fR and omit the prefix \fB\s-1XK_\s0\fR. 849omitting the prefix \fB\s-1XK_\s0\fR. Alternatively you can specify \fIkey\fR by its hex
845Alternatively you can specify \fIkey\fR by its hex keysym value 850keysym value (\fB0x0000 \- 0xFFFF\fR). Note that the lookup of \fIsym\fRs is not
846(\fB0x0000 \- 0xFFFF\fR). 851performed in an exact manner; however, the closest match is assured.
847Note that the lookup of \fIsym\fRs is not performed in an exact manner;
848however, the closest match is assured.
849.Sp 852.Sp
850\&\fIstring\fR may 853\&\fIstring\fR may contain escape values (\f(CW\*(C`\ea\*(C'\fR: bell, \f(CW\*(C`\eb\*(C'\fR: backspace,
851contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape, \en: 854\&\f(CW\*(C`\ee\*(C'\fR, \f(CW\*(C`\eE\*(C'\fR: escape, \f(CW\*(C`\en\*(C'\fR: newline, \f(CW\*(C`\er\*(C'\fR: carriage return, \f(CW\*(C`\et\*(C'\fR: tab,
852newline, \er: return, \et: 855\&\f(CW\*(C`\e000\*(C'\fR: octal number) or verbatim control characters (\f(CW\*(C`^?\*(C'\fR: delete,
853tab, \e000: octal number) or control characters (^?: delete, ^@: null, 856\&\f(CW\*(C`^@\*(C'\fR: null, \f(CW\*(C`^A\*(C'\fR ...) and may be enclosed with double quotes so that it
854^A ...) and may enclosed with double quotes so that it can start or end 857can start or end with whitespace.
855with whitespace.
856.Sp 858.Sp
857You can define a range of keysyms in one shot by providing a \fIstring\fR 859You can define a range of keysyms in one shot by providing a \fIstring\fR
858with pattern \fBlist/STRING1/STRING2/STRING3\fR, where the delimeter `/' 860with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimeter `/'
859should be a character not used by the \fB\s-1STRING\s0\fRs. 861should be a character not used by the strings.
860.Sp 862.Sp
861Its usage can be demonstrated by an example: 863Its usage can be demonstrated by an example:
864.Sp
865.Vb 1
862 URxvt.keysym.M\-C\-0x61: list.abc.\ee<M\-C\-.> 866\& URxvt.keysym.M-C-0x61: list|\ee<M-C-|abc|>
867.Ve
863.Sp 868.Sp
864The above line is equivalent to the following three lines: 869The above line is equivalent to the following three lines:
870.Sp
871.Vb 3
865 URxvt.keysym.Meta\-Control\-0x61: \ee<M\-C\-a> 872\& URxvt.keysym.Meta-Control-0x61: \ee<M-C-a>
866 URxvt.keysym.Meta\-Control\-0x62: \ee<M\-C\-b> 873\& URxvt.keysym.Meta-Control-0x62: \ee<M-C-b>
867 URxvt.keysym.Meta\-Control\-0x63: \ee<M\-C\-c> 874\& URxvt.keysym.Meta-Control-0x63: \ee<M-C-c>
875.Ve
868.Sp 876.Sp
869If \fIstring\fR takes the form of \fBproto:STRING\fR, 877If \fIstring\fR takes the form of \f(CW\*(C`proto:STRING\*(C'\fR, the specified \fB\s-1STRING\s0\fR is
870the specified \fB\s-1STRING\s0\fR is interpreted and executed as \fB@@RXVT_NAME@@\fR's 878interpreted and executed as @@RXVT_NAME@@'s control sequence. For example,
871control sequence. For example, \fB\*(L"proto:\e033]701;zh_CN.GBK\e007\*(R"\fR 879\&\f(CW\*(C`proto:\e033]701;zh_CN.GBK\e007\*(C'\fR means: change the current locale to
872means changing the current locale to zh_CN.GBK. 880\&\f(CW\*(C`zh_CN.GBK\*(C'\fR.
873.SH "THE SCROLLBAR" 881.SH "THE SCROLLBAR"
874.IX Header "THE SCROLLBAR" 882.IX Header "THE SCROLLBAR"
875Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window 883Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window
876(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar 884(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar
877or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and 885or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and
… …
903region and release; Right click to extend the marked region; Left 911region and release; Right click to extend the marked region; Left
904double-click to select a word; Left triple-click to select the entire 912double-click to select a word; Left triple-click to select the entire
905line. 913line.
906.Sp 914.Sp
907Starting a selection while pressing the \fBMeta\fR key (or \fBMeta+Ctrl\fR keys) 915Starting a selection while pressing the \fBMeta\fR key (or \fBMeta+Ctrl\fR keys)
908(Compile: frills) will create a rectangular selection instead of a normal 916(Compile: \fIfrills\fR) will create a rectangular selection instead of a normal
909one. 917one.
910.IP "\fBInsertion\fR:" 4 918.IP "\fBInsertion\fR:" 4
911.IX Item "Insertion:" 919.IX Item "Insertion:"
912Pressing and releasing the Middle mouse button (or \fBShift-Insert\fR) in 920Pressing and releasing the Middle mouse button (or \fBShift-Insert\fR) in
913an \fB@@RXVT_NAME@@\fR window causes the current text selection to be 921an \fB@@RXVT_NAME@@\fR window causes the current text selection to be

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines