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.115 by root, Sat Apr 26 14:31:44 2014 UTC vs.
Revision 1.116 by root, Fri Dec 26 22:52:23 2014 UTC

… …
131.\} 131.\}
132.rm #[ #] #H #V #F C 132.rm #[ #] #H #V #F C
133.\" ======================================================================== 133.\" ========================================================================
134.\" 134.\"
135.IX Title "@@RXVT_NAME@@ 1" 135.IX Title "@@RXVT_NAME@@ 1"
136.TH @@RXVT_NAME@@ 1 "2014-04-26" "@@RXVT_VERSION@@" "RXVT-UNICODE" 136.TH @@RXVT_NAME@@ 1 "2014-12-26" "@@RXVT_VERSION@@" "RXVT-UNICODE"
137.\" For nroff, turn off justification. Always turn off hyphenation; it makes 137.\" For nroff, turn off justification. Always turn off hyphenation; it makes
138.\" way too many mistakes in technical documents. 138.\" way too many mistakes in technical documents.
139.if n .ad l 139.if n .ad l
140.nh 140.nh
141.SH "NAME" 141.SH "NAME"
… …
236respect to \f(CW\*(C`\-depth 32\*(C'\fR and/or alpha channels, and will cause all sorts 236respect to \f(CW\*(C`\-depth 32\*(C'\fR and/or alpha channels, and will cause all sorts
237of graphical corruption. This is harmless, but we can't do anything about 237of graphical corruption. This is harmless, but we can't do anything about
238this, so watch out] 238this, so watch out]
239.IP "\fB\-visual\fR \fIvisualID\fR" 4 239.IP "\fB\-visual\fR \fIvisualID\fR" 4
240.IX Item "-visual visualID" 240.IX Item "-visual visualID"
241Compile \fIfrills\fR: Use the given visual (see e.g. \f(CW\*(C`xdpyinfo\*(C'\fR for possible 241Compile \fIfrills\fR: Use the given visual (see e.g. \f(CW\*(C`xdpyinfo\*(C'\fR for
242visual ids). 242possible visual ids) instead of the default, and also allocate a private
243colormap. All visual types except for DirectColor are supported.
243.IP "\fB\-geometry\fR \fIgeom\fR" 4 244.IP "\fB\-geometry\fR \fIgeom\fR" 4
244.IX Item "-geometry geom" 245.IX Item "-geometry geom"
245Window geometry (\fB\-g\fR still respected); resource \fBgeometry\fR. 246Window geometry (\fB\-g\fR still respected); resource \fBgeometry\fR.
246.IP "\fB\-rv\fR|\fB+rv\fR" 4 247.IP "\fB\-rv\fR|\fB+rv\fR" 4
247.IX Item "-rv|+rv" 248.IX Item "-rv|+rv"
… …
328rather than the default executable file name. Name should not contain 329rather than the default executable file name. Name should not contain
329`.' or `*' characters. Also sets the icon and title name. 330`.' or `*' characters. Also sets the icon and title name.
330.IP "\fB\-ls\fR|\fB+ls\fR" 4 331.IP "\fB\-ls\fR|\fB+ls\fR" 4
331.IX Item "-ls|+ls" 332.IX Item "-ls|+ls"
332Start as a login\-shell/sub\-shell; resource \fBloginShell\fR. 333Start as a login\-shell/sub\-shell; resource \fBloginShell\fR.
334.IP "\fB\-mc\fR \fImilliseconds\fR" 4
335.IX Item "-mc milliseconds"
336Specify the maximum time between multi-click selections.
333.IP "\fB\-ut\fR|\fB+ut\fR" 4 337.IP "\fB\-ut\fR|\fB+ut\fR" 4
334.IX Item "-ut|+ut" 338.IX Item "-ut|+ut"
335Compile \fIutmp\fR: Inhibit/enable writing a utmp entry; resource 339Compile \fIutmp\fR: Inhibit/enable writing a utmp entry; resource
336\&\fButmpInhibit\fR. 340\&\fButmpInhibit\fR.
337.IP "\fB\-vb\fR|\fB+vb\fR" 4 341.IP "\fB\-vb\fR|\fB+vb\fR" 4
… …
399support \s-1MWM\s0 hints (e.g. kwin), enables override-redirect mode. 403support \s-1MWM\s0 hints (e.g. kwin), enables override-redirect mode.
400.IP "\fB\-override\-redirect\fR" 4 404.IP "\fB\-override\-redirect\fR" 4
401.IX Item "-override-redirect" 405.IX Item "-override-redirect"
402Compile \fIfrills\fR: Sets override-redirect on the window; resource 406Compile \fIfrills\fR: Sets override-redirect on the window; resource
403\&\fBoverride-redirect\fR. 407\&\fBoverride-redirect\fR.
408.IP "\fB\-dockapp\fR" 4
409.IX Item "-dockapp"
410Sets the initial state of the window to WithdrawnState, which makes
411window managers that support this extension treat it as a dockapp.
404.IP "\fB\-sbg\fR" 4 412.IP "\fB\-sbg\fR" 4
405.IX Item "-sbg" 413.IX Item "-sbg"
406Compile \fIfrills\fR: Disable the usage of the built-in block graphics/line 414Compile \fIfrills\fR: Disable the usage of the built-in block graphics/line
407drawing characters and just rely on what the specified fonts provide. Use 415drawing characters and just rely on what the specified fonts provide. Use
408this if you have a good font and want to use its block graphic glyphs; 416this if you have a good font and want to use its block graphic glyphs;
… …
827.IP "\fBloginShell:\fR \fIboolean\fR" 4 835.IP "\fBloginShell:\fR \fIboolean\fR" 4
828.IX Item "loginShell: boolean" 836.IX Item "loginShell: boolean"
829\&\fBTrue\fR: start as a login shell by prepending a `\-' to \fBargv[0]\fR of 837\&\fBTrue\fR: start as a login shell by prepending a `\-' to \fBargv[0]\fR of
830the shell; option \fB\-ls\fR. \fBFalse\fR: start as a normal sub-shell 838the shell; option \fB\-ls\fR. \fBFalse\fR: start as a normal sub-shell
831[default]; option \fB+ls\fR. 839[default]; option \fB+ls\fR.
840.IP "\fBmultiClickTime:\fR \fInumber\fR" 4
841.IX Item "multiClickTime: number"
842Specify the maximum time in milliseconds between multi-click select
843events. The default is 500 milliseconds; option \fB\-mc\fR.
832.IP "\fButmpInhibit:\fR \fIboolean\fR" 4 844.IP "\fButmpInhibit:\fR \fIboolean\fR" 4
833.IX Item "utmpInhibit: boolean" 845.IX Item "utmpInhibit: boolean"
834\&\fBTrue\fR: inhibit writing record into the system log file \fButmp\fR; 846\&\fBTrue\fR: inhibit writing record into the system log file \fButmp\fR;
835option \fB\-ut\fR. \fBFalse\fR: write record into the system log file \fButmp\fR 847option \fB\-ut\fR. \fBFalse\fR: write record into the system log file \fButmp\fR
836[default]; option \fB+ut\fR. 848[default]; option \fB+ut\fR.
… …
1047.IX Item "chdir: path" 1059.IX Item "chdir: path"
1048Sets the working directory for the shell (or the command specified via 1060Sets the working directory for the shell (or the command specified via
1049\&\fB\-e\fR). The \fIpath\fR must be an absolute path and it must exist for 1061\&\fB\-e\fR). The \fIpath\fR must be an absolute path and it must exist for
1050@@RXVT_NAME@@ to start. If it isn't specified then the current working 1062@@RXVT_NAME@@ to start. If it isn't specified then the current working
1051directory will be used; option \fB\-cd\fR. 1063directory will be used; option \fB\-cd\fR.
1052.IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4 1064.IP "\fBkeysym.\fR\fIsym\fR: \fIaction\fR" 4
1053.IX Item "keysym.sym: string" 1065.IX Item "keysym.sym: action"
1054Compile \fIfrills\fR: Associate \fIstring\fR with keysym \fIsym\fR. The 1066Compile \fIfrills\fR: Associate \fIaction\fR with keysym \fIsym\fR. The intervening
1055intervening resource name \fBkeysym.\fR cannot be omitted. 1067resource name \fBkeysym.\fR cannot be omitted.
1056.Sp 1068.Sp
1057The format of \fIsym\fR is "\fI(modifiers\-)key\fR", where \fImodifiers\fR can be 1069Using this resource, you can map key combinations such as
1058any combination of \fBISOLevel3\fR, \fBAppKeypad\fR, \fBControl\fR, \fBNumLock\fR, 1070\&\f(CW\*(C`Ctrl\-Shift\-BackSpace\*(C'\fR to various actions, such as outputting a different
1071string than would normally result from that combination, making the
1072terminal scroll up or down the way you want it, or any other thing an
1073extension might provide.
1074.Sp
1075The key combination that triggers the action, \fIsym\fR, has the following format:
1076.Sp
1077.Vb 1
1078\& (modifiers\-)key
1079.Ve
1080.Sp
1081Where \fImodifiers\fR can be any combination of \fBISOLevel3\fR, \fBAppKeypad\fR,
1082\&\fBControl\fR, \fBNumLock\fR, \fBShift\fR, \fBMeta\fR, \fBLock\fR, \fBMod1\fR, \fBMod2\fR,
1083\&\fBMod3\fR, \fBMod4\fR, \fBMod5\fR, and the abbreviated \fBI\fR, \fBK\fR, \fBC\fR, \fBN\fR,
1059\&\fBShift\fR, \fBMeta\fR, \fBLock\fR, \fBMod1\fR, \fBMod2\fR, \fBMod3\fR, \fBMod4\fR, \fBMod5\fR, 1084\&\fBS\fR, \fBM\fR, \fBA\fR, \fBL\fR, \fB1\fR, \fB2\fR, \fB3\fR, \fB4\fR, \fB5\fR.
1060and the abbreviated \fBI\fR, \fBK\fR, \fBC\fR, \fBN\fR, \fBS\fR, \fBM\fR, \fBA\fR, \fBL\fR, \fB1\fR,
1061\&\fB2\fR, \fB3\fR, \fB4\fR, \fB5\fR.
1062.Sp 1085.Sp
1063The \fBNumLock\fR, \fBMeta\fR and \fBISOLevel3\fR modifiers are usually aliased to 1086The \fBNumLock\fR, \fBMeta\fR and \fBISOLevel3\fR modifiers are usually aliased to
1064whatever modifier the NumLock key, Meta/Alt keys or \s-1ISO\s0 Level3 Shift/AltGr 1087whatever modifier the NumLock key, Meta/Alt keys or \s-1ISO\s0 Level3 Shift/AltGr
1065keys are being mapped. \fBAppKeypad\fR is a synthetic modifier mapped to the 1088keys are being mapped. \fBAppKeypad\fR is a synthetic modifier mapped to the
1066current application keymap mode state. 1089current application keymap mode state.
1067.Sp 1090.Sp
1068The spellings of \fIkey\fR can be obtained by using \fBxev\fR(1) command or 1091Due the the large number of modifier combinations, a key mapping will
1069searching keysym macros from \fB/usr/X11R6/include/X11/keysymdef.h\fR and 1092match if \fIat least\fR the specified identifiers are being set, and no other
1070omitting the prefix \fB\s-1XK_\s0\fR. Alternatively you can specify \fIkey\fR by its hex 1093key mappings with those and more bits are being defined. That means that
1071keysym value (\fB0x0000 \- 0xFFFF\fR). Note that the lookup of \fIsym\fRs is not 1094defining a mapping for \f(CW\*(C`a\*(C'\fR will automatically provide definitions for
1072performed in an exact manner; however, the closest match is assured. 1095\&\f(CW\*(C`Meta\-a\*(C'\fR, \f(CW\*(C`Shift\-a\*(C'\fR and so on, unless some of those are defined mappings
1096themselves. See the \f(CW\*(C`builtin:\*(C'\fR action, below, for a way to work around
1097this when this is a problem.
1073.Sp 1098.Sp
1074\&\fIstring\fR may contain escape values (\f(CW\*(C`\en\*(C'\fR: newline, \f(CW\*(C`\e000\*(C'\fR: octal 1099The spelling of \fIkey\fR depends on your implementation of X. An easy way to
1100find a key name is to use the \fBxev\fR(1) command. You can find a list by
1101looking for the \f(CW\*(C`XK_\*(C'\fR macros in the \fBX11/keysymdef.h\fR include file (omit
1102the \f(CW\*(C`XK_\*(C'\fR prefix). Alternatively you can specify \fIkey\fR by its hex keysym
1103value (\fB0x0000 \- 0xFFFF\fR).
1104.Sp
1105As with any resource value, the \fIaction\fR string may contain backslash
1106escape sequences (\f(CW\*(C`\en\*(C'\fR: newline, \f(CW\*(C`\e\e\*(C'\fR: backslash, \f(CW\*(C`\e000\*(C'\fR: octal
1075number), see \s-1RESOURCES\s0 in \f(CW\*(C`man 7 X\*(C'\fR for further details. 1107number), see \s-1RESOURCES\s0 in \f(CW\*(C`man 7 X\*(C'\fR for further details.
1076.Sp 1108.Sp
1077You can define a range of keysyms in one shot by 1109An action starts with an action prefix that selects a certain type
1078loading the \f(CW\*(C`keysym\-list\*(C'\fR perl extension and providing a \fIstring\fR 1110of action, followed by a colon. An action string without colons is
1079with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimiter `/' 1111interpreted as a literal string to pass to the tty (as if it was
1112prefixed with \f(CW\*(C`string:\*(C'\fR).
1113.Sp
1114The following action prefixes are known \- extensions can provide
1115additional prefixes:
1116.RS 4
1117.IP "string:STRING" 4
1118.IX Item "string:STRING"
1119If the \fIaction\fR starts with \f(CW\*(C`string:\*(C'\fR (or otherwise contains no colons),
1120then the remaining \f(CW\*(C`STRING\*(C'\fR will be passed to the program running in the
1121terminal. For example, you could replace whatever Shift-Tab outputs by the
1122string \f(CW\*(C`echo rm \-rf /\*(C'\fR followed by a newline:
1123.Sp
1124.Vb 1
1125\& URxvt.keysym.Shift\-Tab: string:echo rm \-rf /\en
1126.Ve
1127.Sp
1128This could in theory be used to completely redefine your keymap.
1129.Sp
1130In addition, for actions of this type, you can define a range of
1131keysyms in one shot by loading the \f(CW\*(C`keysym\-list\*(C'\fR perl extension and
1132providing an \fIaction\fR with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where
1080should be a character not used by the strings. 1133the delimiter `/' should be a character not used by the strings.
1081.Sp 1134.Sp
1082Its usage can be demonstrated by an example: 1135Its usage can be demonstrated by an example:
1083.Sp 1136.Sp
1084.Vb 1 1137.Vb 1
1085\& URxvt.keysym.M\-C\-0x61: list|\e033<|abc|> 1138\& URxvt.keysym.M\-C\-0x61: list|\e033<|abc|>
1086.Ve 1139.Ve
1087.Sp 1140.Sp
1088The above line is equivalent to the following three lines: 1141The above line is equivalent to the following three lines:
1089.Sp 1142.Sp
1090.Vb 3 1143.Vb 3
1091\& URxvt.keysym.Meta\-Control\-0x61: \e033<a> 1144\& URxvt.keysym.Meta\-Control\-0x61: string:\e033<a>
1092\& URxvt.keysym.Meta\-Control\-0x62: \e033<b> 1145\& URxvt.keysym.Meta\-Control\-0x62: string:\e033<b>
1093\& URxvt.keysym.Meta\-Control\-0x63: \e033<c> 1146\& URxvt.keysym.Meta\-Control\-0x63: string:\e033<c>
1094.Ve 1147.Ve
1095.Sp 1148.IP "command:STRING" 4
1149.IX Item "command:STRING"
1096If \fIstring\fR takes the form of \f(CW\*(C`command:STRING\*(C'\fR, the specified \fB\s-1STRING\s0\fR 1150If \fIaction\fR takes the form of \f(CW\*(C`command:STRING\*(C'\fR, the specified \fB\s-1STRING\s0\fR
1097is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1151is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1152the opposite of \f(CW\*(C`string:\*(C'\fR \- instead of sending it to the program running
1153in the terminal, it will be treated as if it were program output). This is
1154most useful to feed command sequences into @@RXVT_NAME@@.
1155.Sp
1098example the following means "change the current locale to \f(CW\*(C`zh_CN.GBK\*(C'\fR 1156For example the following means "change the current locale to \f(CW\*(C`zh_CN.GBK\*(C'\fR
1099when Control-Meta-c is being pressed": 1157when Control-Meta-c is being pressed":
1100.Sp 1158.Sp
1101.Vb 1 1159.Vb 1
1102\& URxvt.keysym.M\-C\-c: command:\e033]701;zh_CN.GBK\e007 1160\& URxvt.keysym.M\-C\-c: command:\e033]701;zh_CN.GBK\e007
1103.Ve 1161.Ve
1104.Sp 1162.Sp
1105If \fIstring\fR takes the form \f(CW\*(C`perl:STRING\*(C'\fR, then the specified \fB\s-1STRING\s0\fR 1163The following example will map Control\-Meta\-1 and Control\-Meta\-2 to
1106is passed to the \f(CW\*(C`on_user_command\*(C'\fR perl handler. See the @@RXVT_NAME@@\fIperl\fR\|(3) 1164the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited
1107manpage. For example, the \fIselection\fR extension (activated via 1165font-switching at runtime:
1108\&\f(CW\*(C`@@RXVT_NAME@@ \-pe selection\*(C'\fR) listens for \f(CW\*(C`selection:rot13\*(C'\fR events:
1109.Sp 1166.Sp
1110.Vb 1 1167.Vb 2
1111\& URxvt.keysym.M\-C\-c: perl:selection:rot13 1168\& URxvt.keysym.M\-C\-1: command:\e033]50;suxuseuro\e007
1169\& URxvt.keysym.M\-C\-2: command:\e033]50;9x15bold\e007
1112.Ve 1170.Ve
1113.Sp 1171.Sp
1114Due the the large number of modifier combinations, a defined key mapping 1172Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1115will match if \fIat least\fR the specified identifiers are being set, and 1173info):
1116no other key mappings with those and more bits are being defined. That
1117means that defining a key map for \f(CW\*(C`a\*(C'\fR will automatically provide
1118definitions for \f(CW\*(C`Meta\-a\*(C'\fR, \f(CW\*(C`Shift\-a\*(C'\fR and so on, unless some of those are defined
1119mappings themselves.
1120.Sp 1174.Sp
1121Unfortunately, this will override built-in key mappings. For example 1175.Vb 2
1176\& URxvt.keysym.M\-C\-3: command:\e033[8;25;80t
1177\& URxvt.keysym.M\-C\-4: command:\e033[8;48;110t
1178.Ve
1179.IP "builtin:" 4
1180.IX Item "builtin:"
1181The builtin action is the action that @@RXVT_NAME@@ would execute if no
1182key binding existed for the key combination. The obvious use is to undo
1183the effect of existing bindings. The not so obvious use is to reinstate
1184bindings when another binding overrides too many modifiers.
1185.Sp
1122if you overwrite the \f(CW\*(C`Insert\*(C'\fR key you will disable @@RXVT_NAME@@'s 1186For example if you overwrite the \f(CW\*(C`Insert\*(C'\fR key you will disable
1123\&\f(CW\*(C`Shift\-Insert\*(C'\fR mapping. To re-enable that, you can poke \*(L"holes\*(R" into the 1187@@RXVT_NAME@@'s \f(CW\*(C`Shift\-Insert\*(C'\fR mapping. To re-enable that, you can poke
1124user-defined keymap using the \f(CW\*(C`builtin:\*(C'\fR replacement: 1188\&\*(L"holes\*(R" into the user-defined keymap using the \f(CW\*(C`builtin:\*(C'\fR replacement:
1125.Sp 1189.Sp
1126.Vb 2 1190.Vb 2
1127\& URxvt.keysym.Insert: <my insert key sequence> 1191\& URxvt.keysym.Insert: <my insert key sequence>
1128\& URxvt.keysym.S\-Insert: builtin: 1192\& URxvt.keysym.S\-Insert: builtin:
1129.Ve 1193.Ve
1130.Sp 1194.Sp
1131The first line defines a mapping for \f(CW\*(C`Insert\*(C'\fR and \fIany\fR combination 1195The first line defines a mapping for \f(CW\*(C`Insert\*(C'\fR and \fIany\fR combination
1132of modifiers. The second line re-establishes the default mapping for 1196of modifiers. The second line re-establishes the default mapping for
1133\&\f(CW\*(C`Shift\-Insert\*(C'\fR. 1197\&\f(CW\*(C`Shift\-Insert\*(C'\fR.
1198.IP "builtin-string:" 4
1199.IX Item "builtin-string:"
1200This action is mainly useful to restore string mappings for keys that
1201have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1202difficult to explain \- basically, this action will send the string to the
1203application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1204action for it.
1134.Sp 1205.Sp
1135The following example will map Control\-Meta\-1 and Control\-Meta\-2 to 1206An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1136the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited 1207selection when you press \f(CW\*(C`Shift\-Insert\*(C'\fR. With the following bindings, it
1137font-switching at runtime: 1208would instead emit the (undocumented, but what applications running in the
1209terminal might expect) sequence \f(CW\*(C`ESC [ 2 $\*(C'\fR instead:
1138.Sp 1210.Sp
1139.Vb 2 1211.Vb 2
1140\& URxvt.keysym.M\-C\-1: command:\e033]50;suxuseuro\e007 1212\& URxvt.keysym.S\-Insert: builtin\-string:
1141\& URxvt.keysym.M\-C\-2: command:\e033]50;9x15bold\e007 1213\& URxvt.keysym.C\-S\-Insert: builtin:
1142.Ve 1214.Ve
1143.Sp 1215.Sp
1144Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1216The first line disables the paste functionality for that key
1145info): 1217combination, and the second reinstates the default behaviour for
1218\&\f(CW\*(C`Control\-Shift\-Insert\*(C'\fR, which would otherwise be overridden.
1219.Sp
1220Similarly, to let applications gain access to the \f(CW\*(C`C\-M\-c\*(C'\fR (copy to
1221clipboard) and \f(CW\*(C`C\-M\-v\*(C'\fR (paste clipboard) key combination, you can do
1222this:
1146.Sp 1223.Sp
1147.Vb 2 1224.Vb 2
1148\& URxvt.keysym.M\-C\-3: command:\e033[8;25;80t 1225\& URxvt.keysym.C\-M\-c: builtin\-string:
1149\& URxvt.keysym.M\-C\-4: command:\e033[8;48;110t 1226\& URxvt.keysym.C\-M\-v: builtin\-string:
1150.Ve 1227.Ve
1228.IP "\s-1EXTENSION:STRING\s0" 4
1229.IX Item "EXTENSION:STRING"
1230An action of this form invokes the action \fB\s-1STRING\s0\fR, if any, provided
1231by the @@RXVT_NAME@@\fIperl\fR\|(3) extension \fB\s-1EXTENSION\s0\fR. The extension will
1232be loaded automatically if necessary.
1233.Sp
1234Not all extensions define actions, but popular extensions that do
1235include the \fIselection\fR and \fImatcher\fR extensions (documented in their
1236own manpages, @@RXVT_NAME@@\-\fIselection\fR\|(1) and @@RXVT_NAME@@\-\fImatcher\fR\|(1),
1237respectively).
1238.Sp
1239From the silly examples department, this will rot13\-\*(L"encrypt\*(R"
1240@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical \s-1PC\s0
1241keyboards:
1242.Sp
1243.Vb 1
1244\& URxvt.keysym.M\-C\-c: selection:rot13
1245.Ve
1246.IP "perl:STRING *DEPRECATED*" 4
1247.IX Item "perl:STRING *DEPRECATED*"
1248This is a deprecated way of invoking commands provided by perl
1249extensions. It is still supported, but should not be used anymore.
1250.RE
1251.RS 4
1252.RE
1151.IP "\fBperl-ext-common\fR: \fIstring\fR" 4 1253.IP "\fBperl-ext-common\fR: \fIstring\fR" 4
1152.IX Item "perl-ext-common: string" 1254.IX Item "perl-ext-common: string"
1153.PD 0 1255.PD 0
1154.IP "\fBperl-ext\fR: \fIstring\fR" 4 1256.IP "\fBperl-ext\fR: \fIstring\fR" 4
1155.IX Item "perl-ext: string" 1257.IX Item "perl-ext: string"
… …
1158use in this terminal instance; option \fB\-pe\fR. 1260use in this terminal instance; option \fB\-pe\fR.
1159.Sp 1261.Sp
1160Extension names can be prefixed with a \f(CW\*(C`\-\*(C'\fR sign to prohibit using 1262Extension names can be prefixed with a \f(CW\*(C`\-\*(C'\fR sign to prohibit using
1161them. This can be useful to selectively disable some extensions loaded 1263them. This can be useful to selectively disable some extensions loaded
1162by default, or specified via the \f(CW\*(C`perl\-ext\-common\*(C'\fR resource. For 1264by default, or specified via the \f(CW\*(C`perl\-ext\-common\*(C'\fR resource. For
1163example, \f(CW\*(C`default,\-selection\*(C'\fR will use all the default extension except 1265example, \f(CW\*(C`default,\-selection\*(C'\fR will use all the default extensions except
1164\&\f(CW\*(C`selection\*(C'\fR. 1266\&\f(CW\*(C`selection\*(C'\fR.
1165.Sp 1267.Sp
1166Extension names can also be followed by an argument in angle brackets 1268The default set includes the \f(CW\*(C`selection\*(C'\fR, \f(CW\*(C`option\-popup\*(C'\fR,
1167(e.g. \f(CW\*(C`searchable\-scrollback<M\-s>\*(C'\fR, which binds the hotkey for 1269\&\f(CW\*(C`selection\-popup\*(C'\fR and \f(CW\*(C`readline\*(C'\fR extensions, any extensions that
1168searchable scrollback to Alt/Meta\-s). Mentioning the same extension 1270define keybindings via \f(CW\*(C`BINDING\*(C'\fR meta comments, and extensions which
1169multiple times with different arguments will pass multiple arguments to 1271are mentioned in \fBkeysym\fR resources.
1170the extension. 1272.Sp
1273Any extension such that a corresponding resource is given on the
1274command line is automatically appended to \fBperl-ext\fR.
1171.Sp 1275.Sp
1172Each extension is looked up in the library directories, loaded if 1276Each extension is looked up in the library directories, loaded if
1173necessary, and bound to the current terminal instance. 1277necessary, and bound to the current terminal instance. When the library
1278search path contains multiple extension files of the same name, then the
1279first one found will be used.
1174.Sp 1280.Sp
1175If both of these resources are the empty string, then the perl 1281If both of these resources are the empty string, then the perl interpreter
1176interpreter will not be initialized. The idea behind two options is that 1282will not be initialized. The rationale for having two options is that
1177\&\fBperl-ext-common\fR will be used for extensions that should be available to 1283\&\fBperl-ext-common\fR will be used for extensions that should be available to
1178all instances, while \fBperl-ext\fR is used for specific instances. 1284all instances, while \fBperl-ext\fR is used for specific instances.
1179.IP "\fBperl-eval\fR: \fIstring\fR" 4 1285.IP "\fBperl-eval\fR: \fIstring\fR" 4
1180.IX Item "perl-eval: string" 1286.IX Item "perl-eval: string"
1181Perl code to be evaluated when all extensions have been registered. See 1287Perl code to be evaluated when all extensions have been registered. See
… …
1194details. 1300details.
1195.IP "\fBselection-autotransform.\f(BIidx\fB\fR: \fIperl-transform\fR" 4 1301.IP "\fBselection-autotransform.\f(BIidx\fB\fR: \fIperl-transform\fR" 4
1196.IX Item "selection-autotransform.idx: perl-transform" 1302.IX Item "selection-autotransform.idx: perl-transform"
1197Selection auto-transform patterns, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage 1303Selection auto-transform patterns, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage
1198for details. 1304for details.
1199.IP "\fBsearchable-scrollback:\fR \fIkeysym\fR" 4 1305.IP "\fBsearchable-scrollback:\fR \fIkeysym\fR *DEPRECATED*" 4
1200.IX Item "searchable-scrollback: keysym" 1306.IX Item "searchable-scrollback: keysym *DEPRECATED*"
1201Sets the hotkey that starts the incremental scrollback buffer search 1307This resource is deprecated and will be removed. Use a \fBkeysym\fR resource
1202(default: \f(CW\*(C`M\-s\*(C'\fR). 1308instead, e.g.:
1309.Sp
1310.Vb 1
1311\& URxvt.keysym.M\-s: searchable\-scrollback:start
1312.Ve
1203.IP "\fBurl-launcher\fR: \fIstring\fR" 4 1313.IP "\fBurl-launcher\fR: \fIstring\fR" 4
1204.IX Item "url-launcher: string" 1314.IX Item "url-launcher: string"
1205Specifies the program to be started with a \s-1URL\s0 argument. Used by the 1315Specifies the program to be started with a \s-1URL\s0 argument. Used by the
1206\&\f(CW\*(C`selection\-popup\*(C'\fR and \f(CW\*(C`matcher\*(C'\fR perl extensions. 1316\&\f(CW\*(C`selection\-popup\*(C'\fR and \f(CW\*(C`matcher\*(C'\fR perl extensions.
1207.IP "\fBtransient-for\fR: \fIwindowid\fR" 4 1317.IP "\fBtransient-for\fR: \fIwindowid\fR" 4

Diff Legend

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