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.43 by root, Sun Jan 16 19:22:16 2005 UTC vs.
Revision 1.55 by root, Mon Feb 14 10:44:50 2005 UTC

14configurability. As a result, B<rxvt-unicode> uses much less swap space -- 14configurability. As a result, B<rxvt-unicode> uses much less swap space --
15a significant advantage on a machine serving many X sessions. 15a significant advantage on a machine serving many X sessions.
16 16
17=head1 FREQUENTLY ASKED QUESTIONS 17=head1 FREQUENTLY ASKED QUESTIONS
18 18
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of frequently 19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20asked questions and answer to them and some common problems. 20frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
21 23
22=head1 RXVT-UNICODE VS. RXVT 24=head1 RXVT-UNICODE VS. RXVT
23 25
24Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
25internally. That means it can store and display most scripts in the 27internally. That means it can store and display most scripts in the
328 330
329Compile I<XIM>: input method name. resource B<inputMethod>. 331Compile I<XIM>: input method name. resource B<inputMethod>.
330 332
331=item B<-imlocale> I<string> 333=item B<-imlocale> I<string>
332 334
333The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 335The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
334de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 336C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
335extension to be able to input japanese characters while staying in 337input extension to be able to input japanese characters while staying in
336another locale. 338another locale. resource B<imLocale>.
339
340=item B<-imfont> I<fontset>
341
342Set the font set to use for the X Input Method, see resource B<imFont>
343for more info.
344
345=item B<-tcw>
346
347Change the meaning of triple-click selection with the left mouse
348button. Instead of selecting a full line it will extend the selection the
349end of the logical line only. resource B<tripleclickwords>.
337 350
338=item B<-insecure> 351=item B<-insecure>
339 352
340Enable "insecure" mode, which currently enables most of the escape 353Enable "insecure" mode, which currently enables most of the escape
341sequences that echo strings. See the resource B<insecure> for more 354sequences that echo strings. See the resource B<insecure> for more
354 367
355=item B<-ssr>|B<+ssr> 368=item B<-ssr>|B<+ssr>
356 369
357Turn on/off secondary screen scroll (default enabled); resource 370Turn on/off secondary screen scroll (default enabled); resource
358B<secondaryScroll>. 371B<secondaryScroll>.
372
373=item B<-keysym.>I<sym>: I<string>
374
375Remap a key symbol. See resource B<keysym>.
359 376
360=item B<-xrm> I<resourcestring> 377=item B<-xrm> I<resourcestring>
361 378
362No effect on rxvt-unicode. Simply passes through an argument to be made 379No effect on rxvt-unicode. Simply passes through an argument to be made
363available in the instance's argument list. Appears in I<WM_COMMAND> in 380available in the instance's argument list. Appears in I<WM_COMMAND> in
372 389
373There are two different methods that @@RXVT_NAME@@ can use to get the 390There are two different methods that @@RXVT_NAME@@ can use to get the
374Xresource data: using the X libraries (Xrm*-functions) or internal 391Xresource data: using the X libraries (Xrm*-functions) or internal
375Xresources reader (B<~/.Xdefaults>). For the first method (ie. 392Xresources reader (B<~/.Xdefaults>). For the first method (ie.
376B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 393B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
377resources using X11 tools like B<xset>. Many distribution do also load 394resources using X11 tools like B<xrdb>. Many distribution do also load
378settings from the B<~/.Xresources> file when X starts. 395settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
396will consult the following files/resources in order, with later settings
397overwriting earlier ones:
398
399 1. system-wide app-defaults file, either locale-dependent OR global
400 2. app-defaults file in $XAPPLRESDIR
401 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
402 4. SCREEN_RESOURCES for the current screen
403 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
379 404
380If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> 405If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
381lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults 406lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
382set in XAPPLOADDIR/URxvt (compile-time defined: usually 407set in XAPPLOADDIR/URxvt (compile-time defined: usually
383B</usr/lib/X11/app-defaults/URxvt>) and resources set in 408B</usr/lib/X11/app-defaults/URxvt>) and resources set in
775 800
776I<name> of inputMethod to use; option B<-im>. 801I<name> of inputMethod to use; option B<-im>.
777 802
778=item B<imLocale:> I<name> 803=item B<imLocale:> I<name>
779 804
780The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 805The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
781de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 806C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
782extension to be able to input japanese characters while staying in 807input extension to be able to input japanese characters while staying in
783another locale. option B<-imlocale>. 808another locale. option B<-imlocale>.
809
810=item B<imFont:> I<fontset>
811
812Specify the font-set used for XIM styles C<OverTheSpot> or
813C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
814by commas), i.e. it's not in the same format as the other font lists used
815in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
816found, preferably one or two pixels differing in size to the base font.
817option B<-imfont>.
818
819=item B<tripleclickwords:> I<boolean>
820
821Change the meaning of triple-click selection with the left mouse
822button. Instead of selecting a full line it will extend the selection to
823the end of the logical line only. option B<-tcw>.
784 824
785=item B<insecure:> I<boolean> 825=item B<insecure:> I<boolean>
786 826
787Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 827Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
788echo arbitrary strings like the icon name or the locale. This could be 828echo arbitrary strings like the icon name or the locale. This could be
829and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, 869and 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>. 870B<2>, B<3>, B<4>, B<5>.
831 871
832The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 872The 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 873whatever 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 874keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
835current application keymap mode state. 875current application keymap mode state.
836 876
837The spellings of I<key> can be obtained by using B<xev>(1) command or 877The 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 878searching 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 879omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
844C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 884C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
845C<\000>: octal number) or verbatim control characters (C<^?>: delete, 885C<\000>: octal number) or verbatim control characters (C<^?>: delete,
846C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 886C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
847can start or end with whitespace. 887can start or end with whitespace.
848 888
889Please note that you need to double the C<\> when using
890C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
891use C<\033> instead of C<\e> (and so on), which will work with both Xt and
892@@RXVT_NAME@@'s own processing).
893
849You can define a range of keysyms in one shot by providing a I<string> 894You can define a range of keysyms in one shot by providing a I<string>
850with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 895with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
851should be a character not used by the strings. 896should be a character not used by the strings.
852 897
853Its usage can be demonstrated by an example: 898Its usage can be demonstrated by an example:
854 899
855 URxvt.keysym.M-C-0x61: list|\e<M-C-|abc|> 900 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
856 901
857The above line is equivalent to the following three lines: 902The above line is equivalent to the following three lines:
858 903
859 URxvt.keysym.Meta-Control-0x61: \e<M-C-a> 904 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
860 URxvt.keysym.Meta-Control-0x62: \e<M-C-b> 905 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
861 URxvt.keysym.Meta-Control-0x63: \e<M-C-c> 906 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
862 907
863If I<string> takes the form of C<proto:STRING>, the specified B<STRING> is 908If I<string> takes the form of C<command:STRING>, the specified B<STRING>
864interpreted and executed as @@RXVT_NAME@@'s control sequence. For example, 909is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
865C<proto:\033]701;zh_CN.GBK\007> means: change the current locale to 910example the following means "change the current locale to C<zh_CN.GBK>
866C<zh_CN.GBK>. 911when Control-Meta-c is being pressed":
912
913 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
914
915The following example will map Control-Meta-1 and Control-Meta-2 to
916the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
917font-switching at runtime:
918
919 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
920 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
921
922Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
923info):
924
925 URxvt.keysym.M-C-3: command:\033[8;25;80t
926 URxvt.keysym.M-C-4: command:\033[8;48;110t
867 927
868=back 928=back
869 929
870=head1 THE SCROLLBAR 930=head1 THE SCROLLBAR
871 931
885the normal text selection/insertion, hold either the Shift or the Meta 945the normal text selection/insertion, hold either the Shift or the Meta
886(Alt) key while performing the desired mouse action. 946(Alt) key while performing the desired mouse action.
887 947
888If mouse reporting mode is active, the normal scrollbar actions are 948If mouse reporting mode is active, the normal scrollbar actions are
889disabled -- on the assumption that we are using a fullscreen 949disabled -- on the assumption that we are using a fullscreen
890application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 950application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
891(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 951(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
892up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down), 952up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
893respectively. 953respectively.
894 954
895=head1 TEXT SELECTION AND INSERTION 955=head1 TEXT SELECTION AND INSERTION
896 956
897The behaviour of text selection and insertion mechanism is similar to 957The behaviour of text selection and insertion mechanism is similar to
899 959
900=over 4 960=over 4
901 961
902=item B<Selection>: 962=item B<Selection>:
903 963
904Left click at the beginning of the region, drag to the end of the 964Left click at the beginning of the region, drag to the end of the region
905region and release; Right click to extend the marked region; Left 965and release; Right click to extend the marked region; Left double-click
906double-click to select a word; Left triple-click to select the entire 966to select a word; Left triple-click to select the entire logical line
907line. 967(which can span multiple screen lines), unless modified by resource
968B<tripleclickwords>.
908 969
909Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 970Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
910(Compile: I<frills>) will create a rectangular selection instead of a normal 971(Compile: I<frills>) will create a rectangular selection instead of a normal
911one. 972one.
912 973
938C<--enable-frills>, the rest is available when rxvt-unicode was compiled 999C<--enable-frills>, the rest is available when rxvt-unicode was compiled
939with C<--enable-iso14755>. 1000with C<--enable-iso14755>.
940 1001
941=over 4 1002=over 4
942 1003
943=item 5.1: Basic method 1004=item * 5.1: Basic method
944 1005
945This allows you to enter unicode characters using their hexcode. 1006This allows you to enter unicode characters using their hexcode.
946 1007
947Start by pressing and holding both C<Control> and C<Shift>, then enter 1008Start by pressing and holding both C<Control> and C<Shift>, then enter
948hex-digits (between one and six). Releasing C<Control> and C<Shift> will 1009hex-digits (between one and six). Releasing C<Control> and C<Shift> will
955address, which you cannot type. Fortunately, the card has the e-mail 1016address, which you cannot type. Fortunately, the card has the e-mail
956address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily 1017address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
957by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>, 1018by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
958followed by releasing the modifier keys. 1019followed by releasing the modifier keys.
959 1020
960=item 5.2: Keyboard symbols entry method 1021=item * 5.2: Keyboard symbols entry method
961 1022
962This mode lets you input characters representing the keycap symbols of 1023This mode lets you input characters representing the keycap symbols of
963your keyboard, if representable in the current locale encoding. 1024your keyboard, if representable in the current locale encoding.
964 1025
965Start by pressing C<Control> and C<Shift> together, then releasing 1026Start by pressing C<Control> and C<Shift> together, then releasing
968keycap symbol. The symbol will only be entered when the key has been 1029keycap symbol. The symbol will only be entered when the key has been
969released, otherwise pressing e.g. C<Shift> would enter the symbol for 1030released, otherwise pressing e.g. C<Shift> would enter the symbol for
970C<ISO Level 2 Switch>, although your intention might have been to enter a 1031C<ISO Level 2 Switch>, although your intention might have been to enter a
971reverse tab (Shift-Tab). 1032reverse tab (Shift-Tab).
972 1033
973=item 5.3: Screen-selection entry method 1034=item * 5.3: Screen-selection entry method
974 1035
975While this is implemented already (it's basically the selection 1036While this is implemented already (it's basically the selection
976mechanism), it could be extended by displaying a unicode character map. 1037mechanism), it could be extended by displaying a unicode character map.
977 1038
978=item 5.4: Feedback method for identifying displayed characters for later input 1039=item * 5.4: Feedback method for identifying displayed characters for later input
979 1040
980This method lets you display the unicode character code associated with 1041This method lets you display the unicode character code associated with
981characters already displayed. 1042characters already displayed.
982 1043
983You enter this mode by holding down C<Control> and C<Shift> together, then 1044You enter this mode by holding down C<Control> and C<Shift> together, then
995With respect to conformance, rxvt-unicode is supposed to be compliant to 1056With respect to conformance, rxvt-unicode is supposed to be compliant to
996both scenario A and B of ISO 14755, including part 5.2. 1057both scenario A and B of ISO 14755, including part 5.2.
997 1058
998=head1 LOGIN STAMP 1059=head1 LOGIN STAMP
999 1060
1000B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so 1061B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1001that it can be seen via the I<who(1)> command, and can accept messages. 1062it can be seen via the I<who(1)> command, and can accept messages. To
1002To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on 1063allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1003some systems. 1064on some systems or setgid to root or to some other group on others.
1004 1065
1005=head1 COLORS AND GRAPHICS 1066=head1 COLORS AND GRAPHICS
1006 1067
1007In addition to the default foreground and background colours, 1068In addition to the default foreground and background colours,
1008B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1069B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1051 1112
1052=back 1113=back
1053 1114
1054=head1 ENVIRONMENT 1115=head1 ENVIRONMENT
1055 1116
1056B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> 1117B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1057and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X 1118
1058window id number of the B<@@RXVT_NAME@@> window and it also uses and 1119=over 4
1059sets the environment variable B<DISPLAY> to specify which display 1120
1060terminal to use. B<@@RXVT_NAME@@> uses the environment variables 1121=item B<TERM>
1061B<RXVTPATH> and B<PATH> to find XPM files. 1122
1123Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1124resources or on the commandline.
1125
1126=item B<COLORTERM>
1127
1128Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
1129compiled with XPM support, and optionally with the added extension
1130C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1131
1132=item B<COLORFGBG>
1133
1134Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1135the colour code used as default foreground/text colour (or the string
1136C<default> to indicate that the default-colour escape sequence is to be
1137used), C<bg> is the colour code used as default background colour (or the
1138string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1139was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
1140(and do) use this information to optimize screen output.
1141
1142=item B<WINDOWID>
1143
1144Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1145window, which usually has subwindows for the scrollbar, the terminal
1146window and so on).
1147
1148=item B<TERMINFO>
1149
1150Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1151C<--with-terminfo=PATH>.
1152
1153=item B<DISPLAY>
1154
1155Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1156display in it's child processes.
1157
1158=item B<SHELL>
1159
1160The shell to be used for command execution, defaults to C</bin/sh>.
1161
1162=item B<RXVTPATH>
1163
1164The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1165files.
1166
1167=item B<PATH>
1168
1169Used in the same way as C<RXVTPATH>.
1170
1171=item B<RXVT_SOCKET>
1172
1173The unix domain socket path used by @@RXVT_NAME@@c(1) and
1174@@RXVT_NAME@@d(1).
1175
1176Default C<< $HOME/.rxvt-unicode-<nodename >>.
1177
1178=item B<HOME>
1179
1180Used to locate the default directory for the unix domain socket for
1181daemon communications and to locate various resource files (such as
1182C<.Xdefaults>)
1183
1184=item B<XAPPLRESDIR>
1185
1186Directory where various X resource files are being located.
1187
1188=item B<XENVIRONMENT>
1189
1190If set and accessible, gives the name of a X resource file to be loaded by
1191@@RXVT_NAME@@.
1192
1193=back
1062 1194
1063=head1 FILES 1195=head1 FILES
1064 1196
1065=over 4 1197=over 4
1066 1198
1067=item B</etc/utmp>
1068
1069System file for login records.
1070
1071=item B</usr/lib/X11/rgb.txt> 1199=item B</usr/lib/X11/rgb.txt>
1072 1200
1073Color names. 1201Color names.
1074 1202
1075=back 1203=back
1090 1218
1091=over 4 1219=over 4
1092 1220
1093=item Project Coordinator 1221=item Project Coordinator
1094 1222
1095@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1223Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1096 1224
1097=item Web page maintainter 1225L<http://software.schmorp.de/#rxvt-unicode>
1098
1099@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1100
1101L<@@RXVT_WEBPAGE@@>
1102 1226
1103=back 1227=back
1104 1228
1105=head1 AUTHORS 1229=head1 AUTHORS
1106 1230
1131=item Geoff Wing L<< <gcw@pobox.com> >> 1255=item Geoff Wing L<< <gcw@pobox.com> >>
1132 1256
1133Rewrote screen display and text selection routines. Project Coordinator 1257Rewrote screen display and text selection routines. Project Coordinator
1134(changes.txt 2.4.6 - rxvt-unicode) 1258(changes.txt 2.4.6 - rxvt-unicode)
1135 1259
1136=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1260=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1137 1261
1138Forked rxvt-unicode, rewrote most of the display code and internal 1262Forked rxvt-unicode, rewrote most of the display code and internal
1139character handling to store text in unicode, improve xterm 1263character handling to store text in unicode, improve xterm
1140compatibility and apply numerous other bugfixes and extensions. 1264compatibility and apply numerous other bugfixes and extensions.
1141 1265

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines