… | |
… | |
108 | of graphical corruption. This is harmless, but we can't do anything about |
108 | of graphical corruption. This is harmless, but we can't do anything about |
109 | this, so watch out] |
109 | this, so watch out] |
110 | |
110 | |
111 | =item B<-visual> I<visualID> |
111 | =item B<-visual> I<visualID> |
112 | |
112 | |
113 | Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible |
113 | Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for |
114 | visual ids). |
114 | possible visual ids) instead of the default, and also allocate a private |
|
|
115 | colormap. All visual types except for DirectColor are supported. |
115 | |
116 | |
116 | =item B<-geometry> I<geom> |
117 | =item B<-geometry> I<geom> |
117 | |
118 | |
118 | Window geometry (B<-g> still respected); resource B<geometry>. |
119 | Window geometry (B<-g> still respected); resource B<geometry>. |
119 | |
120 | |
… | |
… | |
219 | |
220 | |
220 | =item B<-ls>|B<+ls> |
221 | =item B<-ls>|B<+ls> |
221 | |
222 | |
222 | Start as a login-shell/sub-shell; resource B<loginShell>. |
223 | Start as a login-shell/sub-shell; resource B<loginShell>. |
223 | |
224 | |
|
|
225 | =item B<-mc> I<milliseconds> |
|
|
226 | |
|
|
227 | Specify the maximum time between multi-click selections. |
|
|
228 | |
224 | =item B<-ut>|B<+ut> |
229 | =item B<-ut>|B<+ut> |
225 | |
230 | |
226 | Compile I<utmp>: Inhibit/enable writing a utmp entry; resource |
231 | Compile I<utmp>: Inhibit/enable writing a utmp entry; resource |
227 | B<utmpInhibit>. |
232 | B<utmpInhibit>. |
228 | |
233 | |
… | |
… | |
306 | |
311 | |
307 | =item B<-override-redirect> |
312 | =item B<-override-redirect> |
308 | |
313 | |
309 | Compile I<frills>: Sets override-redirect on the window; resource |
314 | Compile I<frills>: Sets override-redirect on the window; resource |
310 | B<override-redirect>. |
315 | B<override-redirect>. |
|
|
316 | |
|
|
317 | =item B<-dockapp> |
|
|
318 | |
|
|
319 | Sets the initial state of the window to WithdrawnState, which makes |
|
|
320 | window managers that support this extension treat it as a dockapp. |
311 | |
321 | |
312 | =item B<-sbg> |
322 | =item B<-sbg> |
313 | |
323 | |
314 | Compile I<frills>: Disable the usage of the built-in block graphics/line |
324 | Compile I<frills>: Disable the usage of the built-in block graphics/line |
315 | drawing characters and just rely on what the specified fonts provide. Use |
325 | drawing characters and just rely on what the specified fonts provide. Use |
… | |
… | |
369 | |
379 | |
370 | =item B<-pt> I<style> |
380 | =item B<-pt> I<style> |
371 | |
381 | |
372 | Compile I<XIM>: input style for input method; B<OverTheSpot>, |
382 | Compile I<XIM>: input style for input method; B<OverTheSpot>, |
373 | B<OffTheSpot>, B<Root>; resource B<preeditType>. |
383 | B<OffTheSpot>, B<Root>; resource B<preeditType>. |
|
|
384 | |
|
|
385 | If the perl extension C<xim-onthespot> is used (which is the default), |
|
|
386 | then additionally the C<OnTheSpot> preedit type is available. |
374 | |
387 | |
375 | =item B<-im> I<text> |
388 | =item B<-im> I<text> |
376 | |
389 | |
377 | Compile I<XIM>: input method name. resource B<inputMethod>. |
390 | Compile I<XIM>: input method name. resource B<inputMethod>. |
378 | |
391 | |
… | |
… | |
781 | |
794 | |
782 | B<True>: start as a login shell by prepending a `-' to B<argv[0]> of |
795 | B<True>: start as a login shell by prepending a `-' to B<argv[0]> of |
783 | the shell; option B<-ls>. B<False>: start as a normal sub-shell |
796 | the shell; option B<-ls>. B<False>: start as a normal sub-shell |
784 | [default]; option B<+ls>. |
797 | [default]; option B<+ls>. |
785 | |
798 | |
|
|
799 | =item B<multiClickTime:> I<number> |
|
|
800 | |
|
|
801 | Specify the maximum time in milliseconds between multi-click select |
|
|
802 | events. The default is 500 milliseconds; option B<-mc>. |
|
|
803 | |
786 | =item B<utmpInhibit:> I<boolean> |
804 | =item B<utmpInhibit:> I<boolean> |
787 | |
805 | |
788 | B<True>: inhibit writing record into the system log file B<utmp>; |
806 | B<True>: inhibit writing record into the system log file B<utmp>; |
789 | option B<-ut>. B<False>: write record into the system log file B<utmp> |
807 | option B<-ut>. B<False>: write record into the system log file B<utmp> |
790 | [default]; option B<+ut>. |
808 | [default]; option B<+ut>. |
… | |
… | |
927 | |
945 | |
928 | =item B<pointerColor2:> I<colour> |
946 | =item B<pointerColor2:> I<colour> |
929 | |
947 | |
930 | Mouse pointer background colour. |
948 | Mouse pointer background colour. |
931 | |
949 | |
|
|
950 | =item B<pointerShape:> I<string> |
|
|
951 | |
|
|
952 | Compile I<frills>: Specifies the name of the mouse pointer shape |
|
|
953 | [default B<xterm>]. See the macros in the B<X11/cursorfont.h> include |
|
|
954 | file for possible values (omit the C<XC_> prefix). |
|
|
955 | |
932 | =item B<pointerBlankDelay:> I<number> |
956 | =item B<pointerBlankDelay:> I<number> |
933 | |
957 | |
934 | Specifies number of seconds before blanking the pointer [default 2]. Use a |
958 | Specifies number of seconds before blanking the pointer [default 2]. Use a |
935 | large number (e.g. C<987654321>) to effectively disable the timeout. |
959 | large number (e.g. C<987654321>) to effectively disable the timeout. |
936 | |
960 | |
… | |
… | |
962 | |
986 | |
963 | B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> |
987 | B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> |
964 | |
988 | |
965 | =item B<preeditType:> I<style> |
989 | =item B<preeditType:> I<style> |
966 | |
990 | |
967 | B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. |
991 | B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. |
968 | |
992 | |
969 | =item B<inputMethod:> I<name> |
993 | =item B<inputMethod:> I<name> |
970 | |
994 | |
971 | I<name> of inputMethod to use; option B<-im>. |
995 | I<name> of inputMethod to use; option B<-im>. |
972 | |
996 | |
… | |
… | |
1055 | extension might provide. |
1079 | extension might provide. |
1056 | |
1080 | |
1057 | The key combination that triggers the action, I<sym>, has the following format: |
1081 | The key combination that triggers the action, I<sym>, has the following format: |
1058 | |
1082 | |
1059 | (modifiers-)key |
1083 | (modifiers-)key |
1060 | |
1084 | |
1061 | Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>, |
1085 | Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>, |
1062 | B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, |
1086 | B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, |
1063 | B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>, |
1087 | B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>, |
1064 | B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>. |
1088 | B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>. |
1065 | |
1089 | |
… | |
… | |
1085 | As with any resource value, the I<action> string may contain backslash |
1109 | As with any resource value, the I<action> string may contain backslash |
1086 | escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal |
1110 | escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal |
1087 | number), see RESOURCES in C<man 7 X> for further details. |
1111 | number), see RESOURCES in C<man 7 X> for further details. |
1088 | |
1112 | |
1089 | An action starts with an action prefix that selects a certain type |
1113 | An action starts with an action prefix that selects a certain type |
1090 | of action, followed by a colon. An action strings without colons is |
1114 | of action, followed by a colon. An action string without colons is |
1091 | interpreted as a literal string to pass to the tty (as if they were |
1115 | interpreted as a literal string to pass to the tty (as if it was |
1092 | prefixed with C<string:>). |
1116 | prefixed with C<string:>). |
1093 | |
1117 | |
1094 | The following action prefixes are known - extensions can provide |
1118 | The following action prefixes are known - extensions can provide |
1095 | additional prefixes: |
1119 | additional prefixes: |
1096 | |
1120 | |
… | |
… | |
1104 | string C<echo rm -rf /> followed by a newline: |
1128 | string C<echo rm -rf /> followed by a newline: |
1105 | |
1129 | |
1106 | URxvt.keysym.Shift-Tab: string:echo rm -rf /\n |
1130 | URxvt.keysym.Shift-Tab: string:echo rm -rf /\n |
1107 | |
1131 | |
1108 | This could in theory be used to completely redefine your keymap. |
1132 | This could in theory be used to completely redefine your keymap. |
|
|
1133 | |
|
|
1134 | In addition, for actions of this type, you can define a range of |
|
|
1135 | keysyms in one shot by loading the C<keysym-list> perl extension and |
|
|
1136 | providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where |
|
|
1137 | the delimiter `/' should be a character not used by the strings. |
|
|
1138 | |
|
|
1139 | Its usage can be demonstrated by an example: |
|
|
1140 | |
|
|
1141 | URxvt.keysym.M-C-0x61: list|\033<|abc|> |
|
|
1142 | |
|
|
1143 | The above line is equivalent to the following three lines: |
|
|
1144 | |
|
|
1145 | URxvt.keysym.Meta-Control-0x61: string:\033<a> |
|
|
1146 | URxvt.keysym.Meta-Control-0x62: string:\033<b> |
|
|
1147 | URxvt.keysym.Meta-Control-0x63: string:\033<c> |
1109 | |
1148 | |
1110 | =item command:STRING |
1149 | =item command:STRING |
1111 | |
1150 | |
1112 | If I<action> takes the form of C<command:STRING>, the specified B<STRING> |
1151 | If I<action> takes the form of C<command:STRING>, the specified B<STRING> |
1113 | is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically |
1152 | is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically |
… | |
… | |
1149 | |
1188 | |
1150 | The first line defines a mapping for C<Insert> and I<any> combination |
1189 | The first line defines a mapping for C<Insert> and I<any> combination |
1151 | of modifiers. The second line re-establishes the default mapping for |
1190 | of modifiers. The second line re-establishes the default mapping for |
1152 | C<Shift-Insert>. |
1191 | C<Shift-Insert>. |
1153 | |
1192 | |
|
|
1193 | =item builtin-string: |
|
|
1194 | |
|
|
1195 | This action is mainly useful to restore string mappings for keys that |
|
|
1196 | have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit |
|
|
1197 | difficult to explain - basically, this action will send the string to the |
|
|
1198 | application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in |
|
|
1199 | action for it. |
|
|
1200 | |
|
|
1201 | An example might make it clearer: @@RXVT_NAME@@ normally pastes the |
|
|
1202 | selection when you press C<Shift-Insert>. With the following bindings, it |
|
|
1203 | would instead emit the (undocumented, but what applications running in the |
|
|
1204 | terminal might expect) sequence C<ESC [ 2 $> instead: |
|
|
1205 | |
|
|
1206 | URxvt.keysym.S-Insert: builtin-string: |
|
|
1207 | URxvt.keysym.C-S-Insert: builtin: |
|
|
1208 | |
|
|
1209 | The first line disables the paste functionality for that key |
|
|
1210 | combination, and the second reinstates the default behaviour for |
|
|
1211 | C<Control-Shift-Insert>, which would otherwise be overridden. |
|
|
1212 | |
|
|
1213 | Similarly, to let applications gain access to the C<C-M-c> (copy to |
|
|
1214 | clipboard) and C<C-M-v> (paste clipboard) key combination, you can do |
|
|
1215 | this: |
|
|
1216 | |
|
|
1217 | URxvt.keysym.C-M-c: builtin-string: |
|
|
1218 | URxvt.keysym.C-M-v: builtin-string: |
|
|
1219 | |
1154 | =item EXTENSION:STRING |
1220 | =item EXTENSION:STRING |
1155 | |
1221 | |
1156 | An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3) |
1222 | An action of this form invokes the action B<STRING>, if any, provided |
1157 | extension of the same name. The extension will be loaded automatically if |
1223 | by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will |
1158 | neccessary. |
1224 | be loaded automatically if necessary. |
1159 | |
1225 | |
1160 | Not all extensions define key actions, but popular extensions that do |
1226 | Not all extensions define actions, but popular extensions that do |
1161 | include the I<selection> and I<matcher> extensions (documented in their |
1227 | include the I<selection> and I<matcher> extensions (documented in their |
1162 | own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1), |
1228 | own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1), |
1163 | respectively). |
1229 | respectively). |
1164 | |
1230 | |
1165 | From the silly examples department, this will rot13-"encrypt" |
1231 | From the silly examples department, this will rot13-"encrypt" |
1166 | @@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC |
1232 | @@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC |
1167 | keyboards: |
1233 | keyboards: |
1168 | |
1234 | |
1169 | URxvt.keysym.M-C-c: selection:rot13 |
1235 | URxvt.keysym.M-C-c: selection:rot13 |
1170 | |
1236 | |
1171 | =item perl:STRING |
1237 | =item perl:STRING *DEPRECATED* |
1172 | |
1238 | |
1173 | This is a deprecated way of passing key mappings to perl extensions. It is |
1239 | This is a deprecated way of invoking commands provided by perl |
1174 | still supported, but should not be used anymore. |
1240 | extensions. It is still supported, but should not be used anymore. |
1175 | |
1241 | |
1176 | =back |
1242 | =back |
1177 | |
|
|
1178 | In addition, you can define a range of keysyms in one shot by loading |
|
|
1179 | the C<keysym-list> perl extension and providing a I<string> with pattern |
|
|
1180 | B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' should be a |
|
|
1181 | character not used by the strings. |
|
|
1182 | |
|
|
1183 | Its usage can be demonstrated by an example: |
|
|
1184 | |
|
|
1185 | URxvt.keysym.M-C-0x61: list|\033<|abc|> |
|
|
1186 | |
|
|
1187 | The above line is equivalent to the following three lines: |
|
|
1188 | |
|
|
1189 | URxvt.keysym.Meta-Control-0x61: \033<a> |
|
|
1190 | URxvt.keysym.Meta-Control-0x62: \033<b> |
|
|
1191 | URxvt.keysym.Meta-Control-0x63: \033<c> |
|
|
1192 | |
1243 | |
1193 | =item B<perl-ext-common>: I<string> |
1244 | =item B<perl-ext-common>: I<string> |
1194 | |
1245 | |
1195 | =item B<perl-ext>: I<string> |
1246 | =item B<perl-ext>: I<string> |
1196 | |
1247 | |
… | |
… | |
1198 | use in this terminal instance; option B<-pe>. |
1249 | use in this terminal instance; option B<-pe>. |
1199 | |
1250 | |
1200 | Extension names can be prefixed with a C<-> sign to prohibit using |
1251 | Extension names can be prefixed with a C<-> sign to prohibit using |
1201 | them. This can be useful to selectively disable some extensions loaded |
1252 | them. This can be useful to selectively disable some extensions loaded |
1202 | by default, or specified via the C<perl-ext-common> resource. For |
1253 | by default, or specified via the C<perl-ext-common> resource. For |
1203 | example, C<default,-selection> will use all the default extension except |
1254 | example, C<default,-selection> will use all the default extensions except |
1204 | C<selection>. |
1255 | C<selection>. |
1205 | |
1256 | |
1206 | Extension names can also be followed by an argument in angle brackets |
1257 | The default set includes the C<selection>, C<option-popup>, |
1207 | (e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for |
1258 | C<selection-popup>, C<readline> and C<searchable-scrollback> |
1208 | searchable scrollback to Alt/Meta-s). Mentioning the same extension |
1259 | extensions, and extensions which are mentioned in B<keysym> resources. |
1209 | multiple times with different arguments will pass multiple arguments to |
1260 | |
1210 | the extension. |
1261 | Any extension such that a corresponding resource is given on the |
|
|
1262 | command line is automatically appended to B<perl-ext>. |
1211 | |
1263 | |
1212 | Each extension is looked up in the library directories, loaded if |
1264 | Each extension is looked up in the library directories, loaded if |
1213 | necessary, and bound to the current terminal instance. |
1265 | necessary, and bound to the current terminal instance. When the library |
|
|
1266 | search path contains multiple extension files of the same name, then the |
|
|
1267 | first one found will be used. |
1214 | |
1268 | |
1215 | If both of these resources are the empty string, then the perl |
1269 | If both of these resources are the empty string, then the perl interpreter |
1216 | interpreter will not be initialized. The idea behind two options is that |
1270 | will not be initialized. The rationale for having two options is that |
1217 | B<perl-ext-common> will be used for extensions that should be available to |
1271 | B<perl-ext-common> will be used for extensions that should be available to |
1218 | all instances, while B<perl-ext> is used for specific instances. |
1272 | all instances, while B<perl-ext> is used for specific instances. |
1219 | |
1273 | |
1220 | =item B<perl-eval>: I<string> |
1274 | =item B<perl-eval>: I<string> |
1221 | |
1275 | |
… | |
… | |
1239 | =item B<< selection-autotransform.I<idx> >>: I<perl-transform> |
1293 | =item B<< selection-autotransform.I<idx> >>: I<perl-transform> |
1240 | |
1294 | |
1241 | Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage |
1295 | Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage |
1242 | for details. |
1296 | for details. |
1243 | |
1297 | |
1244 | =item B<searchable-scrollback:> I<keysym> |
1298 | =item B<searchable-scrollback:> I<keysym> *DEPRECATED* |
1245 | |
1299 | |
1246 | Sets the hotkey that starts the incremental scrollback buffer search |
1300 | This resource is deprecated and will be removed. Use a B<keysym> resource |
1247 | (default: C<M-s>). |
1301 | instead, e.g.: |
|
|
1302 | |
|
|
1303 | URxvt.keysym.M-s: searchable-scrollback:start |
1248 | |
1304 | |
1249 | =item B<url-launcher>: I<string> |
1305 | =item B<url-launcher>: I<string> |
1250 | |
1306 | |
1251 | Specifies the program to be started with a URL argument. Used by the |
1307 | Specifies the program to be started with a URL argument. Used by the |
1252 | C<selection-popup> and C<matcher> perl extensions. |
1308 | C<selection-popup> and C<matcher> perl extensions. |