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.4 by root, Tue Jan 18 01:27:09 2005 UTC vs.
Revision 1.7 by root, Thu Feb 3 10:24:10 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-18" "4.8" "RXVT-UNICODE" 132.TH rxvt 1 "2005-02-03" "4.9" "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 ]]
408.IP "\fB\-im\fR \fItext\fR" 4 408.IP "\fB\-im\fR \fItext\fR" 4
409.IX Item "-im text" 409.IX Item "-im text"
410Compile \fI\s-1XIM\s0\fR: input method name. resource \fBinputMethod\fR. 410Compile \fI\s-1XIM\s0\fR: input method name. resource \fBinputMethod\fR.
411.IP "\fB\-imlocale\fR \fIstring\fR" 4 411.IP "\fB\-imlocale\fR \fIstring\fR" 4
412.IX Item "-imlocale string" 412.IX Item "-imlocale string"
413The locale to use for opening the \s-1IM\s0. You can use an \s-1LC_CTYPE\s0 of e.g. 413The locale to use for opening the \s-1IM\s0. You can use an \f(CW\*(C`LC_CTYPE\*(C'\fR of e.g.
414de_DE.UTF\-8 for normal text processing but ja_JP.EUC\-JP for the input 414\&\f(CW\*(C`de_DE.UTF\-8\*(C'\fR for normal text processing but \f(CW\*(C`ja_JP.EUC\-JP\*(C'\fR for the
415extension to be able to input japanese characters while staying in 415input extension to be able to input japanese characters while staying in
416another locale. 416another locale. resource \fBimLocale\fR.
417.IP "\fB\-imfont\fR \fIfontset\fR" 4
418.IX Item "-imfont fontset"
419Set the font set to use for the X Input Method, see resource \fBimFont\fR
420for more info.
421.IP "\fB\-tcw\fR" 4
422.IX Item "-tcw"
423Change the meaning of triple-click selection with the left mouse
424button. Instead of selecting a full line it will extend the selection the
425end of the logical line only. resource \fBtripleclickwords\fR.
417.IP "\fB\-insecure\fR" 4 426.IP "\fB\-insecure\fR" 4
418.IX Item "-insecure" 427.IX Item "-insecure"
419Enable \*(L"insecure\*(R" mode, which currently enables most of the escape 428Enable \*(L"insecure\*(R" mode, which currently enables most of the escape
420sequences that echo strings. See the resource \fBinsecure\fR for more 429sequences that echo strings. See the resource \fBinsecure\fR for more
421info. 430info.
791.IP "\fBinputMethod:\fR \fIname\fR" 4 800.IP "\fBinputMethod:\fR \fIname\fR" 4
792.IX Item "inputMethod: name" 801.IX Item "inputMethod: name"
793\&\fIname\fR of inputMethod to use; option \fB\-im\fR. 802\&\fIname\fR of inputMethod to use; option \fB\-im\fR.
794.IP "\fBimLocale:\fR \fIname\fR" 4 803.IP "\fBimLocale:\fR \fIname\fR" 4
795.IX Item "imLocale: name" 804.IX Item "imLocale: name"
796The locale to use for opening the \s-1IM\s0. You can use an \s-1LC_CTYPE\s0 of e.g. 805The locale to use for opening the \s-1IM\s0. You can use an \f(CW\*(C`LC_CTYPE\*(C'\fR of e.g.
797de_DE.UTF\-8 for normal text processing but ja_JP.EUC\-JP for the input 806\&\f(CW\*(C`de_DE.UTF\-8\*(C'\fR for normal text processing but \f(CW\*(C`ja_JP.EUC\-JP\*(C'\fR for the
798extension to be able to input japanese characters while staying in 807input extension to be able to input japanese characters while staying in
799another locale. option \fB\-imlocale\fR. 808another locale. option \fB\-imlocale\fR.
809.IP "\fBimFont:\fR \fIfontset\fR" 4
810.IX Item "imFont: fontset"
811Specify the font-set used for \s-1XIM\s0 styles \f(CW\*(C`OverTheSpot\*(C'\fR or
812\&\f(CW\*(C`OffTheSpot\*(C'\fR. It must be a standard X font set (\s-1XLFD\s0 patterns separated
813by commas), i.e. it's not in the same format as the other font lists used
814in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
815found, preferably one or two pixels differing in size to the base font.
816option \fB\-imfont\fR.
817.IP "\fBtripleclickwords:\fR \fIboolean\fR" 4
818.IX Item "tripleclickwords: boolean"
819Change the meaning of triple-click selection with the left mouse
820button. Instead of selecting a full line it will extend the selection to
821the end of the logical line only. option \fB\-tcw\fR.
800.IP "\fBinsecure:\fR \fIboolean\fR" 4 822.IP "\fBinsecure:\fR \fIboolean\fR" 4
801.IX Item "insecure: boolean" 823.IX Item "insecure: boolean"
802Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that 824Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that
803echo arbitrary strings like the icon name or the locale. This could be 825echo arbitrary strings like the icon name or the locale. This could be
804abused if somebody gets 8\-bit\-clean access to your display, whether 826abused if somebody gets 8\-bit\-clean access to your display, whether
839and the abbreviated \fBI\fR, \fBK\fR, \fBC\fR, \fBN\fR, \fBS\fR, \fBM\fR, \fBA\fR, \fBL\fR, \fB1\fR, 861and the abbreviated \fBI\fR, \fBK\fR, \fBC\fR, \fBN\fR, \fBS\fR, \fBM\fR, \fBA\fR, \fBL\fR, \fB1\fR,
840\&\fB2\fR, \fB3\fR, \fB4\fR, \fB5\fR. 862\&\fB2\fR, \fB3\fR, \fB4\fR, \fB5\fR.
841.Sp 863.Sp
842The \fBNumLock\fR, \fBMeta\fR and \fBISOLevel3\fR modifiers are usually aliased to 864The \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 865whatever 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 866keys are being mapped. \fBAppKeypad\fR is a synthetic modifier mapped to the
845current application keymap mode state. 867current application keymap mode state.
846.Sp 868.Sp
847The spellings of \fIkey\fR can be obtained by using \fBxev\fR(1) command or 869The spellings of \fIkey\fR can be obtained by using \fBxev\fR(1) command or
848searching keysym macros from \fB/usr/X11R6/include/X11/keysymdef.h\fR and 870searching keysym macros from \fB/usr/X11R6/include/X11/keysymdef.h\fR and
849omitting the prefix \fB\s-1XK_\s0\fR. Alternatively you can specify \fIkey\fR by its hex 871omitting the prefix \fB\s-1XK_\s0\fR. Alternatively you can specify \fIkey\fR by its hex
872\& URxvt.keysym.Meta-Control-0x61: \ee<M-C-a> 894\& URxvt.keysym.Meta-Control-0x61: \ee<M-C-a>
873\& URxvt.keysym.Meta-Control-0x62: \ee<M-C-b> 895\& URxvt.keysym.Meta-Control-0x62: \ee<M-C-b>
874\& URxvt.keysym.Meta-Control-0x63: \ee<M-C-c> 896\& URxvt.keysym.Meta-Control-0x63: \ee<M-C-c>
875.Ve 897.Ve
876.Sp 898.Sp
877If \fIstring\fR takes the form of \f(CW\*(C`proto:STRING\*(C'\fR, the specified \fB\s-1STRING\s0\fR is 899If \fIstring\fR takes the form of \f(CW\*(C`proto:STRING\*(C'\fR, the specified \fB\s-1STRING\s0\fR
878interpreted and executed as @@RXVT_NAME@@'s control sequence. For example, 900is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
901example the following means "change the current locale to \f(CW\*(C`zh_CN.GBK\*(C'\fR
902when Control-Meta-c is being pressed":
903.Sp
904.Vb 1
905\& URxvt.keysym.M-C-c: proto:\e033]701;zh_CN.GBK\e007
906.Ve
907.Sp
908The following example will map Control\-Meta\-1 and Control\-Meta\-2 to
909the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you cna have some limited
910font-switching at runtime:
911.Sp
912.Vb 2
913\& URxvt.keysym.M-C-1: proto:\e033]50;suxuseuro\e007
914\& URxvt.keysym.M-C-2: proto:\e033]50;9x15bold\e007
915.Ve
916.Sp
879\&\f(CW\*(C`proto:\e033]701;zh_CN.GBK\e007\*(C'\fR means: change the current locale to 917\&\f(CW\*(C`proto:\e033]701;zh_CN.GBK\e007\*(C'\fR means: change the current locale to
880\&\f(CW\*(C`zh_CN.GBK\*(C'\fR. 918\&\f(CW\*(C`zh_CN.GBK\*(C'\fR.
881.SH "THE SCROLLBAR" 919.SH "THE SCROLLBAR"
882.IX Header "THE SCROLLBAR" 920.IX Header "THE SCROLLBAR"
883Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window 921Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window
905.IX Header "TEXT SELECTION AND INSERTION" 943.IX Header "TEXT SELECTION AND INSERTION"
906The behaviour of text selection and insertion mechanism is similar to 944The behaviour of text selection and insertion mechanism is similar to
907\&\fIxterm\fR(1). 945\&\fIxterm\fR(1).
908.IP "\fBSelection\fR:" 4 946.IP "\fBSelection\fR:" 4
909.IX Item "Selection:" 947.IX Item "Selection:"
910Left click at the beginning of the region, drag to the end of the 948Left click at the beginning of the region, drag to the end of the region
911region and release; Right click to extend the marked region; Left 949and release; Right click to extend the marked region; Left double-click
912double-click to select a word; Left triple-click to select the entire 950to select a word; Left triple-click to select the entire logical line
913line. 951(which can span multiple screen lines), unless modified by resource
952\&\fBtripleclickwords\fR.
914.Sp 953.Sp
915Starting a selection while pressing the \fBMeta\fR key (or \fBMeta+Ctrl\fR keys) 954Starting a selection while pressing the \fBMeta\fR key (or \fBMeta+Ctrl\fR keys)
916(Compile: \fIfrills\fR) will create a rectangular selection instead of a normal 955(Compile: \fIfrills\fR) will create a rectangular selection instead of a normal
917one. 956one.
918.IP "\fBInsertion\fR:" 4 957.IP "\fBInsertion\fR:" 4
938\&\s-1ISO\s0 14755 is a standard for entering and viewing unicode characters 977\&\s-1ISO\s0 14755 is a standard for entering and viewing unicode characters
939and character codes using the keyboard. It consists of 4 parts. The 978and character codes using the keyboard. It consists of 4 parts. The
940first part is available rxvt-unicode has been compiled with 979first part is available rxvt-unicode has been compiled with
941\&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, the rest is available when rxvt-unicode was compiled 980\&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, the rest is available when rxvt-unicode was compiled
942with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR. 981with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR.
943.IP "5.1: Basic method" 4 982.IP "* 5.1: Basic method" 4
944.IX Item "5.1: Basic method" 983.IX Item "5.1: Basic method"
945This allows you to enter unicode characters using their hexcode. 984This allows you to enter unicode characters using their hexcode.
946.Sp 985.Sp
947Start by pressing and holding both \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, then enter 986Start by pressing and holding both \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, then enter
948hex-digits (between one and six). Releasing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR will 987hex-digits (between one and six). Releasing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR will
954As an example of use, imagine a business card with a japanese e\-mail 993As an example of use, imagine a business card with a japanese e\-mail
955address, which you cannot type. Fortunately, the card has the e\-mail 994address, which you cannot type. Fortunately, the card has the e\-mail
956address printed as hexcodes, e.g. \f(CW\*(C`671d 65e5\*(C'\fR. You can enter this easily 995address printed as hexcodes, e.g. \f(CW\*(C`671d 65e5\*(C'\fR. You can enter this easily
957by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, followed by \f(CW\*(C`6\-7\-1\-D\-SPACE\-6\-5\-E\-5\*(C'\fR, 996by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, followed by \f(CW\*(C`6\-7\-1\-D\-SPACE\-6\-5\-E\-5\*(C'\fR,
958followed by releasing the modifier keys. 997followed by releasing the modifier keys.
959.IP "5.2: Keyboard symbols entry method" 4 998.IP "* 5.2: Keyboard symbols entry method" 4
960.IX Item "5.2: Keyboard symbols entry method" 999.IX Item "5.2: Keyboard symbols entry method"
961This mode lets you input characters representing the keycap symbols of 1000This mode lets you input characters representing the keycap symbols of
962your keyboard, if representable in the current locale encoding. 1001your keyboard, if representable in the current locale encoding.
963.Sp 1002.Sp
964Start by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then releasing 1003Start by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then releasing
966invoke it's usual function but instead will insert the corresponding 1005invoke it's usual function but instead will insert the corresponding
967keycap symbol. The symbol will only be entered when the key has been 1006keycap symbol. The symbol will only be entered when the key has been
968released, otherwise pressing e.g. \f(CW\*(C`Shift\*(C'\fR would enter the symbol for 1007released, otherwise pressing e.g. \f(CW\*(C`Shift\*(C'\fR would enter the symbol for
969\&\f(CW\*(C`ISO Level 2 Switch\*(C'\fR, although your intention might have been to enter a 1008\&\f(CW\*(C`ISO Level 2 Switch\*(C'\fR, although your intention might have been to enter a
970reverse tab (Shift\-Tab). 1009reverse tab (Shift\-Tab).
971.IP "5.3: Screen-selection entry method" 4 1010.IP "* 5.3: Screen-selection entry method" 4
972.IX Item "5.3: Screen-selection entry method" 1011.IX Item "5.3: Screen-selection entry method"
973While this is implemented already (it's basically the selection 1012While this is implemented already (it's basically the selection
974mechanism), it could be extended by displaying a unicode character map. 1013mechanism), it could be extended by displaying a unicode character map.
975.IP "5.4: Feedback method for identifying displayed characters for later input" 4 1014.IP "* 5.4: Feedback method for identifying displayed characters for later input" 4
976.IX Item "5.4: Feedback method for identifying displayed characters for later input" 1015.IX Item "5.4: Feedback method for identifying displayed characters for later input"
977This method lets you display the unicode character code associated with 1016This method lets you display the unicode character code associated with
978characters already displayed. 1017characters already displayed.
979.Sp 1018.Sp
980You enter this mode by holding down \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then 1019You enter this mode by holding down \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then
989.PP 1028.PP
990With respect to conformance, rxvt-unicode is supposed to be compliant to 1029With respect to conformance, rxvt-unicode is supposed to be compliant to
991both scenario A and B of \s-1ISO\s0 14755, including part 5.2. 1030both scenario A and B of \s-1ISO\s0 14755, including part 5.2.
992.SH "LOGIN STAMP" 1031.SH "LOGIN STAMP"
993.IX Header "LOGIN STAMP" 1032.IX Header "LOGIN STAMP"
994\&\fB@@RXVT_NAME@@\fR tries to write an entry into the \fIutmp\fR(5) file so 1033\&\fB@@RXVT_NAME@@\fR tries to write an entry into the \fIutmp\fR(5) file so that
995that it can be seen via the \fI\fIwho\fI\|(1)\fR command, and can accept messages. 1034it can be seen via the \fI\fIwho\fI\|(1)\fR command, and can accept messages. To
996To allow this feature, \fB@@RXVT_NAME@@\fR must be installed setuid root on 1035allow this feature, \fB@@RXVT_NAME@@\fR may need to be installed setuid root
997some systems. 1036on some systems or setgid to root or to some other group on others.
998.SH "COLORS AND GRAPHICS" 1037.SH "COLORS AND GRAPHICS"
999.IX Header "COLORS AND GRAPHICS" 1038.IX Header "COLORS AND GRAPHICS"
1000In addition to the default foreground and background colours, 1039In addition to the default foreground and background colours,
1001\&\fB@@RXVT_NAME@@\fR can display up to 16 colours (8 \s-1ANSI\s0 colours plus 1040\&\fB@@RXVT_NAME@@\fR can display up to 16 colours (8 \s-1ANSI\s0 colours plus
1002high-intensity bold/blink versions of the same). Here is a list of the 1041high-intensity bold/blink versions of the same). Here is a list of the
1045sets the environment variable \fB\s-1DISPLAY\s0\fR to specify which display 1084sets the environment variable \fB\s-1DISPLAY\s0\fR to specify which display
1046terminal to use. \fB@@RXVT_NAME@@\fR uses the environment variables 1085terminal to use. \fB@@RXVT_NAME@@\fR uses the environment variables
1047\&\fB\s-1RXVTPATH\s0\fR and \fB\s-1PATH\s0\fR to find \s-1XPM\s0 files. 1086\&\fB\s-1RXVTPATH\s0\fR and \fB\s-1PATH\s0\fR to find \s-1XPM\s0 files.
1048.SH "FILES" 1087.SH "FILES"
1049.IX Header "FILES" 1088.IX Header "FILES"
1050.IP "\fB/etc/utmp\fR" 4
1051.IX Item "/etc/utmp"
1052System file for login records.
1053.IP "\fB/usr/lib/X11/rgb.txt\fR" 4 1089.IP "\fB/usr/lib/X11/rgb.txt\fR" 4
1054.IX Item "/usr/lib/X11/rgb.txt" 1090.IX Item "/usr/lib/X11/rgb.txt"
1055Color names. 1091Color names.
1056.SH "SEE ALSO" 1092.SH "SEE ALSO"
1057.IX Header "SEE ALSO" 1093.IX Header "SEE ALSO"

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines