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

Comparing rxvt-unicode/doc/rxvt.7.txt (file contents):
Revision 1.21 by root, Wed Jul 13 02:53:54 2005 UTC vs.
Revision 1.45 by root, Mon Jan 16 15:07:27 2006 UTC

… …
18 The newest version of this document is also available on the World Wide 18 The newest version of this document is also available on the World Wide
19 Web at 19 Web at
20 <http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 20 <http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
21 21
22FREQUENTLY ASKED QUESTIONS 22FREQUENTLY ASKED QUESTIONS
23 The new selection selects pieces that are too big, how can I select
24 single words?
25 Yes. For example, if you want to select alphanumeric words, you can
26 use the following resource:
27
28 URxvt.selection.pattern-0: ([[:word:]]+)
29
30 If you click more than twice, the selection will be extended more
31 and more.
32
33 To get a selection that is very similar to the old code, try this
34 pattern:
35
36 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
37
38 Please also note that the *LeftClick Shift-LeftClik* combination
39 also selects words like the old code.
40
41 I don't like the new selection/popups/hotkeys/perl, how do I
42 change/disable it?
43 You can disable the perl extension completely by setting the
44 perl-ext-common resource to the empty string, which also keeps
45 rxvt-unicode from initialising perl, saving memory.
46
47 If you only want to disable specific features, you first have to
48 identify which perl extension is responsible. For this, read the
49 section PREPACKAGED EXTENSIONS in the rxvtperl(3) manpage. For
50 example, to disable the selection-popup and option-popup, specify
51 this perl-ext-common resource:
52
53 URxvt.perl-ext-common: default,-selection-popup,-option-popup
54
55 This will keep the default extensions, but disable the two popup
56 extensions. Some extensions can also be configured, for example,
57 scrollback search mode is triggered by M-s. You can move it to any
58 other combination either by setting the searchable-scrollback
59 resource:
60
61 URxvt.searchable-scrollback: CM-s
62
63 Isn't rxvt supposed to be small? Don't all those features bloat?
64 I often get asked about this, and I think, no, they didn't cause
65 extra bloat. If you compare a minimal rxvt and a minimal urxvt, you
66 can see that the urxvt binary is larger (due to some encoding tables
67 always being compiled in), but it actually uses less memory (RSS)
68 after startup. Even with "--disable-everything", this comparison is
69 a bit unfair, as many features unique to urxvt (locale, encoding
70 conversion, iso14755 etc.) are already in use in this mode.
71
72 text data bss drs rss filename
73 98398 1664 24 15695 1824 rxvt --disable-everything
74 188985 9048 66616 18222 1788 urxvt --disable-everything
75
76 When you "--enable-everything" (which _is_ unfair, as this involves
77 xft and full locale/XIM support which are quite bloaty inside libX11
78 and my libc), the two diverge, but not unreasnobaly so.
79
80 text data bss drs rss filename
81 163431 2152 24 20123 2060 rxvt --enable-everything
82 1035683 49680 66648 29096 3680 urxvt --enable-everything
83
84 The very large size of the text section is explained by the
85 east-asian encoding tables, which, if unused, take up disk space but
86 nothing else and can be compiled out unless you rely on X11 core
87 fonts that use those encodings. The BSS size comes from the 64k
88 emergency buffer that my c++ compiler allocates (but of course
89 doesn't use unless you are out of memory). Also, using an xft font
90 instead of a core font immediately adds a few megabytes of RSS. Xft
91 indeed is responsible for a lot of RSS even when not used.
92
93 Of course, due to every character using two or four bytes instead of
94 one, a large scrollback buffer will ultimately make rxvt-unicode use
95 more memory.
96
97 Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k),
98 this still fares rather well. And compared to some monsters like
99 gnome-terminal (21152k + extra 4204k in separate processes) or
100 konsole (22200k + extra 43180k in daemons that stay around after
101 exit, plus half a minute of startup time, including the hundreds of
102 warnings it spits out), it fares extremely well *g*.
103
104 Why C++, isn't that unportable/bloated/uncool?
105 Is this a question? :) It comes up very often. The simple answer is:
106 I had to write it, and C++ allowed me to write and maintain it in a
107 fraction of the time and effort (which is a scarce resource for me).
108 Put even shorter: It simply wouldn't exist without C++.
109
110 My personal stance on this is that C++ is less portable than C, but
111 in the case of rxvt-unicode this hardly matters, as its portability
112 limits are defined by things like X11, pseudo terminals, locale
113 support and unix domain sockets, which are all less portable than
114 C++ itself.
115
116 Regarding the bloat, see the above question: It's easy to write
117 programs in C that use gobs of memory, an certainly possible to
118 write programs in C++ that don't. C++ also often comes with large
119 libraries, but this is not necessarily the case with GCC. Here is
120 what rxvt links against on my system with a minimal config:
121
122 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
123 libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
124 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
125 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
126
127 And here is rxvt-unicode:
128
129 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
130 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
131 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
132 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
133 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
134
135 No large bloated libraries (of course, none were linked in
136 statically), except maybe libX11 :)
137
138 Does it support tabs, can I have a tabbed rxvt-unicode?
139 rxvt-unicode does not directly support tabs. It will work fine with
140 tabbing functionality of many window managers or similar tabbing
141 programs, and its embedding-features allow it to be embedded into
142 other programs, as witnessed by doc/rxvt-tabbed or the upcoming
143 "Gtk2::URxvt" perl module, which features a tabbed urxvt (murxvt)
144 terminal as an example embedding application.
145
23 How do I know which rxvt-unicode version I'm using? 146 How do I know which rxvt-unicode version I'm using?
24 The version number is displayed with the usage (-h). Also the escape 147 The version number is displayed with the usage (-h). Also the escape
25 sequence "ESC [ 8 n" sets the window title to the version number. 148 sequence "ESC [ 8 n" sets the window title to the version number.
149 When using the rxvtc client, the version displayed is that of the
150 daemon.
26 151
27 I am using Debian GNU/Linux and have a problem... 152 I am using Debian GNU/Linux and have a problem...
28 The Debian GNU/Linux package of rxvt-unicode in sarge contains large 153 The Debian GNU/Linux package of rxvt-unicode in sarge contains large
29 patches that considerably change the behaviour of rxvt-unicode. 154 patches that considerably change the behaviour of rxvt-unicode.
30 Before reporting a bug to the original rxvt-unicode author please 155 Before reporting a bug to the original rxvt-unicode author please
… …
36 161
37 For other problems that also affect the Debian package, you can and 162 For other problems that also affect the Debian package, you can and
38 probably should use the Debian BTS, too, because, after all, it's 163 probably should use the Debian BTS, too, because, after all, it's
39 also a bug in the Debian version and it serves as a reminder for 164 also a bug in the Debian version and it serves as a reminder for
40 other users that might encounter the same issue. 165 other users that might encounter the same issue.
166
167 I am maintaining rxvt-unicode for distribution/OS XXX, any
168 recommendation?
169 You should build one binary with the default options. configure now
170 enables most useful options, and the trend goes to making them
171 runtime-switchable, too, so there is usually no drawback to enbaling
172 them, except higher disk and possibly memory usage. The perl
173 interpreter should be enabled, as important functionality (menus,
174 selection, likely more in the future) depends on it.
175
176 You should not overwrite the "perl-ext-common" snd "perl-ext"
177 resources system-wide (except maybe with "defaults"). This will
178 result in useful behaviour. If your distribution aims at low memory,
179 add an empty "perl-ext-common" resource to the app-defaults file.
180 This will keep the perl interpreter disabled until the user enables
181 it.
182
183 If you can/want build more binaries, I recommend building a minimal
184 one with "--disable-everything" (very useful) and a maximal one with
185 "--enable-everything" (less useful, it will be very big due to a lot
186 of encodings built-in that increase download times and are rarely
187 used).
188
189 I need to make it setuid/setgid to support utmp/ptys on my OS, is this
190 safe?
191 Likely not. While I honestly try to make it secure, and am probably
192 not bad at it, I think it is simply unreasonable to expect all of
193 freetype + fontconfig + xft + xlib + perl + ... + rxvt-unicode
194 itself to all be secure. Also, rxvt-unicode disables some options
195 when it detects that it runs setuid or setgid, which is not nice.
196 Besides, with the embedded perl interpreter the possibility for
197 security problems easily multiplies.
198
199 Elevated privileges are only required for utmp and pty operations on
200 some systems (for example, GNU/Linux doesn't need any extra
201 privileges for ptys, but some need it for utmp support). It is
202 planned to mvoe this into a forked handler process, but this is not
203 yet done.
204
205 So, while setuid/setgid operation is supported and not a problem on
206 your typical single-user-no-other-logins unix desktop, always
207 remember that its an awful lot of code, most of which isn't checked
208 for security issues regularly.
41 209
42 When I log-in to another system it tells me about missing terminfo data? 210 When I log-in to another system it tells me about missing terminfo data?
43 The terminal description used by rxvt-unicode is not as widely 211 The terminal description used by rxvt-unicode is not as widely
44 available as that for xterm, or even rxvt (for which the same 212 available as that for xterm, or even rxvt (for which the same
45 problem often arises). 213 problem often arises).
… …
433 601
434 My input method wants <some encoding> but I want UTF-8, what can I do? 602 My input method wants <some encoding> but I want UTF-8, what can I do?
435 You can specify separate locales for the input method and the rest 603 You can specify separate locales for the input method and the rest
436 of the terminal, using the resource "imlocale": 604 of the terminal, using the resource "imlocale":
437 605
438 URxvt*imlocale: ja_JP.EUC-JP 606 URxvt.imlocale: ja_JP.EUC-JP
439 607
440 Now you can start your terminal with "LC_CTYPE=ja_JP.UTF-8" and 608 Now you can start your terminal with "LC_CTYPE=ja_JP.UTF-8" and
441 still use your input method. Please note, however, that you will not 609 still use your input method. Please note, however, that you will not
442 be able to input characters outside "EUC-JP" in a normal way then, 610 be able to input characters outside "EUC-JP" in a normal way then,
443 as your input method limits you. 611 as your input method limits you.
… …
469 it gets worse, as rxvt-unicode then uses 8 bytes per screen cell. 637 it gets worse, as rxvt-unicode then uses 8 bytes per screen cell.
470 638
471 Can I speed up Xft rendering somehow? 639 Can I speed up Xft rendering somehow?
472 Yes, the most obvious way to speed it up is to avoid Xft entirely, 640 Yes, the most obvious way to speed it up is to avoid Xft entirely,
473 as it is simply slow. If you still want Xft fonts you might try to 641 as it is simply slow. If you still want Xft fonts you might try to
474 disable antialiasing (by appending ":antialiasing=false"), which 642 disable antialiasing (by appending ":antialias=false"), which saves
475 saves lots of memory and also speeds up rendering considerably. 643 lots of memory and also speeds up rendering considerably.
476 644
477 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 645 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
478 Rxvt-unicode will use whatever you specify as a font. If it needs to 646 Rxvt-unicode will use whatever you specify as a font. If it needs to
479 fall back to it's default font search list it will prefer X11 core 647 fall back to it's default font search list it will prefer X11 core
480 fonts, because they are small and fast, and then use Xft fonts. It 648 fonts, because they are small and fast, and then use Xft fonts. It
… …
486 Mouse cut/paste suddenly no longer works. 654 Mouse cut/paste suddenly no longer works.
487 Make sure that mouse reporting is actually turned off since killing 655 Make sure that mouse reporting is actually turned off since killing
488 some editors prematurely may leave the mouse in mouse report mode. 656 some editors prematurely may leave the mouse in mouse report mode.
489 I've heard that tcsh may use mouse reporting unless it otherwise 657 I've heard that tcsh may use mouse reporting unless it otherwise
490 specified. A quick check is to see if cut/paste works when the Alt 658 specified. A quick check is to see if cut/paste works when the Alt
491 or Shift keys are depressed. See rxvt(7) 659 or Shift keys are depressed.
492 660
493 What's with this bold/blink stuff? 661 What's with this bold/blink stuff?
494 If no bold colour is set via "colorBD:", bold will invert text using 662 If no bold colour is set via "colorBD:", bold will invert text using
495 the standard foreground colour. 663 the standard foreground colour.
496 664
… …
552 URxvt.color14: #73f7ff 720 URxvt.color14: #73f7ff
553 URxvt.color7: #e1dddd 721 URxvt.color7: #e1dddd
554 URxvt.color15: #e1dddd 722 URxvt.color15: #e1dddd
555 723
556 How can I start rxvtd in a race-free way? 724 How can I start rxvtd in a race-free way?
557 Despite it's name, rxvtd is not a real daemon, but more like a 725 Try "rxvtd -f -o", which tells rxvtd to open the display, create the
558 server that answers rxvtc's requests, so it doesn't background 726 listening socket and then fork.
559 itself.
560
561 To ensure rxvtd is listening on it's socket, you can use the
562 following method to wait for the startup message before continuing:
563
564 { rxvtd & } | read
565 727
566 What's with the strange Backspace/Delete key behaviour? 728 What's with the strange Backspace/Delete key behaviour?
567 Assuming that the physical Backspace key corresponds to the 729 Assuming that the physical Backspace key corresponds to the
568 BackSpace keysym (not likely for Linux ... see the following 730 BackSpace keysym (not likely for Linux ... see the following
569 question) there are two standard values that can be used for 731 question) there are two standard values that can be used for
… …
588 750
589 # use Backspace = ^? 751 # use Backspace = ^?
590 $ stty erase ^? 752 $ stty erase ^?
591 $ rxvt 753 $ rxvt
592 754
593 Toggle with "ESC [ 36 h" / "ESC [ 36 l" as documented in rxvt(7). 755 Toggle with "ESC [ 36 h" / "ESC [ 36 l".
594 756
595 For an existing rxvt-unicode: 757 For an existing rxvt-unicode:
596 758
597 # use Backspace = ^H 759 # use Backspace = ^H
598 $ stty erase ^H 760 $ stty erase ^H
… …
1090 1252
1091 "Ps = 9" X10 XTerm 1253 "Ps = 9" X10 XTerm
1092 h Send Mouse X & Y on button press. 1254 h Send Mouse X & Y on button press.
1093 l No mouse reporting. 1255 l No mouse reporting.
1094 1256
1095 "Ps = 10" (rxvt)
1096 h menuBar visible
1097 l menuBar invisible
1098
1099 "Ps = 25" 1257 "Ps = 25"
1100 h Visible cursor {cnorm/cvvis} 1258 h Visible cursor {cnorm/cvvis}
1101 l Invisible cursor {civis} 1259 l Invisible cursor {civis}
1102 1260
1103 "Ps = 30" 1261 "Ps = 30"
… …
1151 l Scroll to bottom on TTY output 1309 l Scroll to bottom on TTY output
1152 1310
1153 "Ps = 1011" (rxvt) 1311 "Ps = 1011" (rxvt)
1154 h Scroll to bottom when a key is pressed 1312 h Scroll to bottom when a key is pressed
1155 l Don't scroll to bottom when a key is pressed 1313 l Don't scroll to bottom when a key is pressed
1314
1315 "Ps = 1021" (rxvt)
1316 h Bold/italic implies high intensity (see option -is)
1317 l Font styles have no effect on intensity (Compile styles)
1156 1318
1157 "Ps = 1047" 1319 "Ps = 1047"
1158 h Use Alternate Screen Buffer 1320 h Use Alternate Screen Buffer
1159 l Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it 1321 l Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1160 1322
… …
1183 Ps = 10 Change colour of text foreground to Pt (NB: may change in future) 1345 Ps = 10 Change colour of text foreground to Pt (NB: may change in future)
1184 Ps = 11 Change colour of text background to Pt (NB: may change in future) 1346 Ps = 11 Change colour of text background to Pt (NB: may change in future)
1185 Ps = 12 Change colour of text cursor foreground to Pt 1347 Ps = 12 Change colour of text cursor foreground to Pt
1186 Ps = 13 Change colour of mouse foreground to Pt 1348 Ps = 13 Change colour of mouse foreground to Pt
1187 Ps = 17 Change colour of highlight characters to Pt 1349 Ps = 17 Change colour of highlight characters to Pt
1188 Ps = 18 Change colour of bold characters to Pt 1350 Ps = 18 Change colour of bold characters to Pt [deprecated, see 706]
1189 Ps = 19 Change colour of underlined characters to Pt 1351 Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707]
1190 Ps = 20 Change default background to Pt 1352 Ps = 20 Change default background to Pt
1191 Ps = 39 Change default foreground colour to Pt. 1353 Ps = 39 Change default foreground colour to Pt.
1192 Ps = 46 Change Log File to Pt unimplemented 1354 Ps = 46 Change Log File to Pt unimplemented
1193 Ps = 49 Change default background colour to Pt. 1355 Ps = 49 Change default background colour to Pt.
1194 Ps = 50 Set fontset to Pt, with the following special values of Pt (rxvt) #+n change up n #-n change down n if n is missing of 0, a value of 1 is used empty change to font0 n change to font n 1356 Ps = 50 Set fontset to Pt, with the following special values of Pt (rxvt) #+n change up n #-n change down n if n is missing of 0, a value of 1 is used empty change to font0 n change to font n
1195 Ps = 55 Log all scrollback buffer and all of screen to Pt 1357 Ps = 55 Log all scrollback buffer and all of screen to Pt
1196 Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills). 1358 Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills).
1197 Ps = 703 Menubar command Pt (Compile menubar).
1198 Ps = 704 Change colour of italic characters to Pt 1359 Ps = 704 Change colour of italic characters to Pt
1199 Ps = 705 Change background pixmap tint colour to Pt (Compile transparency). 1360 Ps = 705 Change background pixmap tint colour to Pt (Compile transparency).
1361 Ps = 706 Change colour of bold characters to Pt
1362 Ps = 707 Change colour of underlined characters to Pt
1200 Ps = 710 Set normal fontset to Pt. Same as Ps = 50. 1363 Ps = 710 Set normal fontset to Pt. Same as Ps = 50.
1201 Ps = 711 Set bold fontset to Pt. Similar to Ps = 50 (Compile styles). 1364 Ps = 711 Set bold fontset to Pt. Similar to Ps = 50 (Compile styles).
1202 Ps = 712 Set italic fontset to Pt. Similar to Ps = 50 (Compile styles). 1365 Ps = 712 Set italic fontset to Pt. Similar to Ps = 50 (Compile styles).
1203 Ps = 713 Set bold-italic fontset to Pt. Similar to Ps = 50 (Compile styles). 1366 Ps = 713 Set bold-italic fontset to Pt. Similar to Ps = 50 (Compile styles).
1204 Ps = 720 Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills). 1367 Ps = 720 Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
1205 Ps = 721 Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills). 1368 Ps = 721 Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
1369 Ps = 777 Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl).
1206 1370
1207 1371
1208
1209menuBar
1210 The exact syntax used is *almost* solidified. In the menus, DON'T try to
1211 use menuBar commands that add or remove a menuBar.
1212
1213 Note that in all of the commands, the */path/* *cannot* be omitted: use
1214 ./ to specify a menu relative to the current menu.
1215
1216 Overview of menuBar operation
1217 For the menuBar XTerm escape sequence "ESC ] 703 ; Pt ST", the syntax of
1218 "Pt" can be used for a variety of tasks:
1219
1220 At the top level is the current menuBar which is a member of a circular
1221 linked-list of other such menuBars.
1222
1223 The menuBar acts as a parent for the various drop-down menus, which in
1224 turn, may have labels, separator lines, menuItems and subMenus.
1225
1226 The menuItems are the useful bits: you can use them to mimic keyboard
1227 input or even to send text or escape sequences back to rxvt.
1228
1229 The menuBar syntax is intended to provide a simple yet robust method of
1230 constructing and manipulating menus and navigating through the menuBars.
1231
1232 The first step is to use the tag [menu:*name*] which creates the menuBar
1233 called *name* and allows access. You may now or menus, subMenus, and
1234 menuItems. Finally, use the tag [done] to set the menuBar access as
1235 readonly to prevent accidental corruption of the menus. To re-access the
1236 current menuBar for alterations, use the tag [menu], make the
1237 alterations and then use [done]
1238
1239
1240
1241 Commands
1242 [menu:+*name*]
1243 access the named menuBar for creation or alteration. If a new
1244 menuBar is created, it is called *name* (max of 15 chars) and the
1245 current menuBar is pushed onto the stack
1246
1247 [menu]
1248 access the current menuBar for alteration
1249
1250 [title:+*string*]
1251 set the current menuBar's title to *string*, which may contain the
1252 following format specifiers:
1253
1254 B<%n> rxvt name (as per the B<-name> command-line option)
1255 B<%v> rxvt version
1256 B<%%> literal B<%> character
1257
1258 [done]
1259 set menuBar access as readonly. End-of-file tag for [read:+*file*]
1260 operations.
1261
1262 [read:+*file*]
1263 read menu commands directly from *file* (extension ".menu" will be
1264 appended if required.) Start reading at a line with [menu] or
1265 [menu:+*name* and continuing until [done] is encountered.
1266
1267 Blank and comment lines (starting with #) are ignored. Actually,
1268 since any invalid menu commands are also ignored, almost anything
1269 could be construed as a comment line, but this may be tightened up
1270 in the future ... so don't count on it!.
1271
1272 [read:+*file*;+*name*]
1273 The same as [read:+*file*], but start reading at a line with
1274 [menu:+*name*] and continuing until [done:+*name*] or [done] is
1275 encountered.
1276
1277 [dump]
1278 dump all menuBars to the file /tmp/rxvt-PID in a format suitable for
1279 later rereading.
1280
1281 [rm:name]
1282 remove the named menuBar
1283
1284 [rm] [rm:]
1285 remove the current menuBar
1286
1287 [rm*] [rm:*]
1288 remove all menuBars
1289
1290 [swap]
1291 swap the top two menuBars
1292
1293 [prev]
1294 access the previous menuBar
1295
1296 [next]
1297 access the next menuBar
1298
1299 [show]
1300 Enable display of the menuBar
1301
1302 [hide]
1303 Disable display of the menuBar
1304
1305 [pixmap:+*name*]
1306 [pixmap:+*name*;*scaling*]
1307 (set the background pixmap globally
1308
1309 A Future implementation *may* make this local to the menubar)
1310
1311 [:+*command*:]
1312 ignore the menu readonly status and issue a *command* to or a menu
1313 or menuitem or change the ; a useful shortcut for setting the quick
1314 arrows from a menuBar.
1315
1316
1317
1318 Adding and accessing menus
1319 The following commands may also be + prefixed.
1320
1321 /+ access menuBar top level
1322
1323 ./+ access current menu level
1324
1325 ../+
1326 access parent menu (1 level up)
1327
1328 ../../
1329 access parent menu (multiple levels up)
1330
1331 */path/*menu
1332 add/access menu
1333
1334 */path/*menu/*
1335 add/access menu and clear it if it exists
1336
1337 */path/*{-}
1338 add separator
1339
1340 */path/*{item}
1341 add item as a label
1342
1343 */path/*{item} action
1344 add/alter *menuitem* with an associated *action*
1345
1346 */path/*{item}{right-text}
1347 add/alter *menuitem* with right-text as the right-justified text and
1348 as the associated *action*
1349
1350 */path/*{item}{rtext} action
1351 add/alter *menuitem* with an associated *action* and with rtext as
1352 the right-justified text.
1353
1354 Special characters in *action* must be backslash-escaped:
1355 \a \b \E \e \n \r \t \octal
1356
1357 or in control-character notation:
1358 ^@, ^A .. ^Z .. ^_, ^?
1359
1360 To send a string starting with a NUL (^@) character to the program,
1361 start *action* with a pair of NUL characters (^@^@), the first of which
1362 will be stripped off and the balance directed to the program. Otherwise
1363 if *action* begins with NUL followed by non-+NUL characters, the leading
1364 NUL is stripped off and the balance is sent back to rxvt.
1365
1366 As a convenience for the many Emacs-type editors, *action* may start
1367 with M- (eg, M-$ is equivalent to \E$) and a CR will be appended if
1368 missed from M-x commands.
1369
1370 As a convenience for issuing XTerm ESC ] sequences from a menubar (or
1371 quick arrow), a BEL (^G) will be appended if needed.
1372
1373 For example,
1374 M-xapropos is equivalent to \Exapropos\r
1375
1376 and \E]703;mona;100 is equivalent to \E]703;mona;100\a
1377
1378 The option {*right-rtext*} will be right-justified. In the absence of a
1379 specified action, this text will be used as the *action* as well.
1380
1381 For example,
1382 /File/{Open}{^X^F} is equivalent to /File/{Open}{^X^F} ^X^F
1383
1384 The left label *is* necessary, since it's used for matching, but
1385 implicitly hiding the left label (by using same name for both left and
1386 right labels), or explicitly hiding the left label (by preceeding it
1387 with a dot), makes it possible to have right-justified text only.
1388
1389 For example,
1390 /File/{Open}{Open} Open-File-Action
1391
1392 or hiding it
1393 /File/{.anylabel}{Open} Open-File-Action
1394
1395
1396
1397 Removing menus
1398 -/*+
1399 remove all menus from the menuBar, the same as [clear]
1400
1401 -+*/path*menu+
1402 remove menu
1403
1404 -+*/path*{item}+
1405 remove item
1406
1407 -+*/path*{-}
1408 remove separator)
1409
1410 -/path/menu/*
1411 remove all items, separators and submenus from menu
1412
1413
1414
1415 Quick Arrows
1416 The menus also provide a hook for *quick arrows* to provide easier user
1417 access. If nothing has been explicitly set, the default is to emulate
1418 the curror keys. The syntax permits each arrow to be altered
1419 individually or all four at once without re-entering their common
1420 beginning/end text. For example, to explicitly associate cursor actions
1421 with the arrows, any of the following forms could be used:
1422
1423 <r>+*Right*
1424 <l>+*Left*
1425 <u>+*Up*
1426 <d>+*Down*
1427 Define actions for the respective arrow buttons
1428
1429 <b>+*Begin*
1430 <e>+*End*
1431 Define common beginning/end parts for *quick arrows* which used in
1432 conjunction with the above <r> <l> <u> <d> constructs
1433
1434 For example, define arrows individually,
1435 <u>\E[A
1436
1437 <d>\E[B
1438
1439 <r>\E[C
1440
1441 <l>\E[D
1442
1443 or all at once
1444 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1445
1446 or more compactly (factoring out common parts)
1447 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1448
1449
1450
1451 Command Summary
1452 A short summary of the most *common* commands:
1453
1454 [menu:name]
1455 use an existing named menuBar or start a new one
1456
1457 [menu]
1458 use the current menuBar
1459
1460 [title:string]
1461 set menuBar title
1462
1463 [done]
1464 set menu access to readonly and, if reading from a file, signal EOF
1465
1466 [done:name]
1467 if reading from a file using [read:file;name] signal EOF
1468
1469 [rm:name]
1470 remove named menuBar(s)
1471
1472 [rm] [rm:]
1473 remove current menuBar
1474
1475 [rm*] [rm:*]
1476 remove all menuBar(s)
1477
1478 [swap]
1479 swap top two menuBars
1480
1481 [prev]
1482 access the previous menuBar
1483
1484 [next]
1485 access the next menuBar
1486
1487 [show]
1488 map menuBar
1489
1490 [hide]
1491 unmap menuBar
1492
1493 [pixmap;file]
1494 [pixmap;file;scaling]
1495 set a background pixmap
1496
1497 [read:file]
1498 [read:file;name]
1499 read in a menu from a file
1500
1501 [dump]
1502 dump out all menuBars to /tmp/rxvt-PID
1503
1504 / access menuBar top level
1505
1506 ./
1507 ../
1508 ../../
1509 access current or parent menu level
1510
1511 /path/menu
1512 add/access menu
1513
1514 /path/{-}
1515 add separator
1516
1517 /path/{item}{rtext} action
1518 add/alter menu item
1519
1520 -/* remove all menus from the menuBar
1521
1522 -/path/menu
1523 remove menu items, separators and submenus from menu
1524
1525 -/path/menu
1526 remove menu
1527
1528 -/path/{item}
1529 remove item
1530
1531 -/path/{-}
1532 remove separator
1533
1534 <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1535 menu quick arrows
1536 1372
1537XPM 1373XPM
1538 For the XPM XTerm escape sequence "ESC ] 20 ; Pt ST" then value of "Pt" 1374 For the XPM XTerm escape sequence "ESC ] 20 ; Pt ST" then value of "Pt"
1539 can be the name of the background pixmap followed by a sequence of 1375 can be the name of the background pixmap followed by a sequence of
1540 scaling/positioning commands separated by semi-colons. The 1376 scaling/positioning commands separated by semi-colons. The
… …
1675 XK_KP_8 8 ESC O x 1511 XK_KP_8 8 ESC O x
1676 XK_KP_9 9 ESC O y 1512 XK_KP_9 9 ESC O y
1677 1513
1678CONFIGURE OPTIONS 1514CONFIGURE OPTIONS
1679 General hint: if you get compile errors, then likely your configuration 1515 General hint: if you get compile errors, then likely your configuration
1680 hasn't been tested well. Either try with --enable-everything or use the 1516 hasn't been tested well. Either try with "--enable-everything" or use
1681 ./reconf script as a base for experiments. ./reconf is used by myself, 1517 the ./reconf script as a base for experiments. ./reconf is used by
1682 so it should generally be a working config. Of course, you should always 1518 myself, so it should generally be a working config. Of course, you
1683 report when a combination doesn't work, so it can be fixed. Marc Lehmann 1519 should always report when a combination doesn't work, so it can be
1684 <rxvt@schmorp.de>. 1520 fixed. Marc Lehmann <rxvt@schmorp.de>.
1521
1522 All
1685 1523
1686 --enable-everything 1524 --enable-everything
1687 Add support for all non-multichoice options listed in "./configure 1525 Add (or remove) support for all non-multichoice options listed in
1688 --help". Note that unlike other enable options this is order 1526 "./configure --help".
1689 dependant. You can specify this and then disable options which this
1690 enables by *following* this with the appropriate commands.
1691 1527
1692 --enable-xft 1528 You can specify this and then disable options you do not like by
1529 *following* this with the appropriate "--disable-..." arguments, or
1530 you can start with a minimal configuration by specifying
1531 "--disable-everything" and than adding just the "--enable-..."
1532 arguments you want.
1533
1534 --enable-xft (default: enabled)
1693 Add support for Xft (anti-aliases, among others) fonts. Xft fonts 1535 Add support for Xft (anti-aliases, among others) fonts. Xft fonts
1694 are slower and require lots of memory, but as long as you don't use 1536 are slower and require lots of memory, but as long as you don't use
1695 them, you don't pay for them. 1537 them, you don't pay for them.
1696 1538
1697 --enable-font-styles 1539 --enable-font-styles (default: on)
1698 Add support for bold, *italic* and *bold italic* font styles. The 1540 Add support for bold, *italic* and *bold italic* font styles. The
1699 fonts can be set manually or automatically. 1541 fonts can be set manually or automatically.
1700 1542
1701 --with-codesets=NAME,... 1543 --with-codesets=NAME,... (default: all)
1702 Compile in support for additional codeset (encoding) groups ("eu", 1544 Compile in support for additional codeset (encoding) groups ("eu",
1703 "vn" are always compiled in, which includes most 8-bit character 1545 "vn" are always compiled in, which includes most 8-bit character
1704 sets). These codeset tables are used for driving X11 core fonts, 1546 sets). These codeset tables are used for driving X11 core fonts,
1705 they are not required for Xft fonts, although having them compiled 1547 they are not required for Xft fonts, although having them compiled
1706 in lets rxvt-unicode choose replacement fonts more intelligently. 1548 in lets rxvt-unicode choose replacement fonts more intelligently.
… …
1713 zh_ext rarely used but very big chinese encodigs 1555 zh_ext rarely used but very big chinese encodigs
1714 jp common japanese encodings 1556 jp common japanese encodings
1715 jp_ext rarely used but big japanese encodings 1557 jp_ext rarely used but big japanese encodings
1716 kr korean encodings 1558 kr korean encodings
1717 1559
1718 --enable-xim 1560 --enable-xim (default: on)
1719 Add support for XIM (X Input Method) protocol. This allows using 1561 Add support for XIM (X Input Method) protocol. This allows using
1720 alternative input methods (e.g. kinput2) and will also correctly set 1562 alternative input methods (e.g. kinput2) and will also correctly set
1721 up the input for people using dead keys or compose keys. 1563 up the input for people using dead keys or compose keys.
1722 1564
1723 --enable-unicode3 1565 --enable-unicode3 (default: off)
1724 Enable direct support for displaying unicode codepoints above 65535 1566 Enable direct support for displaying unicode codepoints above 65535
1725 (the basic multilingual page). This increases storage requirements 1567 (the basic multilingual page). This increases storage requirements
1726 per character from 2 to 4 bytes. X11 fonts do not yet support these 1568 per character from 2 to 4 bytes. X11 fonts do not yet support these
1727 extra characters, but Xft does. 1569 extra characters, but Xft does.
1728 1570
… …
1730 even without this flag, but the number of such characters is limited 1572 even without this flag, but the number of such characters is limited
1731 to a view thousand (shared with combining characters, see next 1573 to a view thousand (shared with combining characters, see next
1732 switch), and right now rxvt-unicode cannot display them 1574 switch), and right now rxvt-unicode cannot display them
1733 (input/output and cut&paste still work, though). 1575 (input/output and cut&paste still work, though).
1734 1576
1735 --enable-combining 1577 --enable-combining (default: on)
1736 Enable automatic composition of combining characters into composite 1578 Enable automatic composition of combining characters into composite
1737 characters. This is required for proper viewing of text where 1579 characters. This is required for proper viewing of text where
1738 accents are encoded as seperate unicode characters. This is done by 1580 accents are encoded as seperate unicode characters. This is done by
1739 using precomposited characters when available or creating new 1581 using precomposited characters when available or creating new
1740 pseudo-characters when no precomposed form exists. 1582 pseudo-characters when no precomposed form exists.
… …
1749 1591
1750 The combining table also contains entries for arabic presentation 1592 The combining table also contains entries for arabic presentation
1751 forms, but these are not currently used. Bug me if you want these to 1593 forms, but these are not currently used. Bug me if you want these to
1752 be used (and tell me how these are to be used...). 1594 be used (and tell me how these are to be used...).
1753 1595
1754 --enable-fallback(=CLASS) 1596 --enable-fallback(=CLASS) (default: Rxvt)
1755 When reading resource settings, also read settings for class CLASS 1597 When reading resource settings, also read settings for class CLASS.
1756 (default: Rxvt). To disable resource fallback use 1598 To disable resource fallback use --disable-fallback.
1757 --disable-fallback.
1758 1599
1759 --with-res-name=NAME 1600 --with-res-name=NAME (default: urxvt)
1760 Use the given name (default: urxvt) as default application name when 1601 Use the given name as default application name when reading
1761 reading resources. Specify --with-res-name=rxvt to replace rxvt. 1602 resources. Specify --with-res-name=rxvt to replace rxvt.
1762 1603
1763 --with-res-class=CLASS 1604 --with-res-class=CLASS /default: URxvt)
1764 Use the given class (default: URxvt) as default application class 1605 Use the given class as default application class when reading
1765 when reading resources. Specify --with-res-class=Rxvt to replace 1606 resources. Specify --with-res-class=Rxvt to replace rxvt.
1766 rxvt.
1767 1607
1768 --enable-utmp 1608 --enable-utmp (default: on)
1769 Write user and tty to utmp file (used by programs like w) at start 1609 Write user and tty to utmp file (used by programs like w) at start
1770 of rxvt execution and delete information when rxvt exits. 1610 of rxvt execution and delete information when rxvt exits.
1771 1611
1772 --enable-wtmp 1612 --enable-wtmp (default: on)
1773 Write user and tty to wtmp file (used by programs like last) at 1613 Write user and tty to wtmp file (used by programs like last) at
1774 start of rxvt execution and write logout when rxvt exits. This 1614 start of rxvt execution and write logout when rxvt exits. This
1775 option requires --enable-utmp to also be specified. 1615 option requires --enable-utmp to also be specified.
1776 1616
1777 --enable-lastlog 1617 --enable-lastlog (default: on)
1778 Write user and tty to lastlog file (used by programs like lastlogin) 1618 Write user and tty to lastlog file (used by programs like lastlogin)
1779 at start of rxvt execution. This option requires --enable-utmp to 1619 at start of rxvt execution. This option requires --enable-utmp to
1780 also be specified. 1620 also be specified.
1781 1621
1782 --enable-xpm-background 1622 --enable-xpm-background (default: on)
1783 Add support for XPM background pixmaps. 1623 Add support for XPM background pixmaps.
1784 1624
1785 --enable-transparency 1625 --enable-transparency (default: on)
1786 Add support for inheriting parent backgrounds thus giving a fake 1626 Add support for inheriting parent backgrounds thus giving a fake
1787 transparency to the term. 1627 transparency to the term.
1788 1628
1789 --enable-fading 1629 --enable-fading (default: on)
1790 Add support for fading the text when focus is lost. 1630 Add support for fading the text when focus is lost (requires
1631 "--enable-transparency").
1791 1632
1792 --enable-tinting 1633 --enable-tinting (default: on)
1793 Add support for tinting of transparent backgrounds. 1634 Add support for tinting of transparent backgrounds (requires
1635 "--enable-transparency").
1794 1636
1795 --enable-menubar
1796 Add support for our menu bar system (this interacts badly with
1797 dynamic locale switching currently).
1798
1799 --enable-rxvt-scroll 1637 --enable-rxvt-scroll (default: on)
1800 Add support for the original rxvt scrollbar. 1638 Add support for the original rxvt scrollbar.
1801 1639
1802 --enable-next-scroll 1640 --enable-next-scroll (default: on)
1803 Add support for a NeXT-like scrollbar. 1641 Add support for a NeXT-like scrollbar.
1804 1642
1805 --enable-xterm-scroll 1643 --enable-xterm-scroll (default: on)
1806 Add support for an Xterm-like scrollbar. 1644 Add support for an Xterm-like scrollbar.
1807 1645
1808 --enable-plain-scroll 1646 --enable-plain-scroll (default: on)
1809 Add support for a very unobtrusive, plain-looking scrollbar that is 1647 Add support for a very unobtrusive, plain-looking scrollbar that is
1810 the favourite of the rxvt-unicode author, having used it for many 1648 the favourite of the rxvt-unicode author, having used it for many
1811 years. 1649 years.
1812 1650
1813 --enable-half-shadow 1651 --enable-half-shadow (default: off)
1814 Make shadows on the scrollbar only half the normal width & height. 1652 Make shadows on the scrollbar only half the normal width & height.
1815 only applicable to rxvt scrollbars. 1653 only applicable to rxvt scrollbars.
1816 1654
1817 --enable-ttygid 1655 --enable-ttygid (default: off)
1818 Change tty device setting to group "tty" - only use this if your 1656 Change tty device setting to group "tty" - only use this if your
1819 system uses this type of security. 1657 system uses this type of security.
1820 1658
1821 --disable-backspace-key 1659 --disable-backspace-key
1822 Disable any handling of the backspace key by us - let the X server 1660 Removes any handling of the backspace key by us - let the X server
1823 do it. 1661 do it.
1824 1662
1825 --disable-delete-key 1663 --disable-delete-key
1826 Disable any handling of the delete key by us - let the X server do 1664 Removes any handling of the delete key by us - let the X server do
1827 it. 1665 it.
1828 1666
1829 --disable-resources 1667 --disable-resources
1830 Remove all resources checking. 1668 Removes any support for resource checking.
1831
1832 --enable-xgetdefault
1833 Make resources checking via XGetDefault() instead of our small
1834 version which only checks ~/.Xdefaults, or if that doesn't exist
1835 then ~/.Xresources.
1836
1837 Please note that nowadays, things like XIM will automatically pull
1838 in and use the full X resource manager, so the overhead of using it
1839 might be very small, if nonexistant.
1840
1841 --enable-strings
1842 Add support for our possibly faster memset() function and other
1843 various routines, overriding your system's versions which may have
1844 been hand-crafted in assembly or may require extra libraries to link
1845 in. (this breaks ANSI-C rules and has problems on many GNU/Linux
1846 systems).
1847 1669
1848 --disable-swapscreen 1670 --disable-swapscreen
1849 Remove support for swap screen. 1671 Remove support for secondary/swap screen.
1850 1672
1851 --enable-frills 1673 --enable-frills (default: on)
1852 Add support for many small features that are not essential but nice 1674 Add support for many small features that are not essential but nice
1853 to have. Normally you want this, but for very small binaries you may 1675 to have. Normally you want this, but for very small binaries you may
1854 want to disable this. 1676 want to disable this.
1855 1677
1856 A non-exhaustive list of features enabled by "--enable-frills" 1678 A non-exhaustive list of features enabled by "--enable-frills"
1857 (possibly in combination with other switches) is: 1679 (possibly in combination with other switches) is:
1858 1680
1859 MWM-hints 1681 MWM-hints
1860 EWMH-hints (pid, utf8 names) and protocols (ping) 1682 EWMH-hints (pid, utf8 names) and protocols (ping)
1861 seperate underline colour 1683 seperate underline colour (-underlineColor)
1862 settable border widths and borderless switch 1684 settable border widths and borderless switch (-w, -b, -bl)
1863 settable extra linespacing 1685 settable extra linespacing /-lsp)
1864 iso-14755-2 and -3, and visual feedback 1686 iso-14755-2 and -3, and visual feedback
1865 backindex and forwardindex escape sequence 1687 backindex and forwardindex escape sequence
1866 window op and some xterm/OSC escape sequences 1688 window op and some xterm/OSC escape sequences
1867 tripleclickwords 1689 tripleclickwords (-tcw)
1868 settable insecure mode 1690 settable insecure mode (-insecure)
1869 keysym remapping support 1691 keysym remapping support
1870 cursor blinking and underline cursor 1692 cursor blinking and underline cursor (-cb, -uc)
1871 -embed and -pty-fd options 1693 XEmbed support (-embed)
1694 user-pty (-pty-fd)
1695 hold on exit (-hold)
1696 skip builtin block graphics (-sbg)
1697 sgr modes 90..97 and 100..107
1872 1698
1873 --enable-iso14755 1699 --enable-iso14755 (default: on)
1874 Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt). 1700 Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt).
1875 Basic support (section 5.1) is enabled by "--enable-frills", while 1701 Basic support (section 5.1) is enabled by "--enable-frills", while
1876 support for 5.2, 5.3 and 5.4 is enabled with this switch. 1702 support for 5.2, 5.3 and 5.4 is enabled with this switch.
1877 1703
1878 --enable-keepscrolling 1704 --enable-keepscrolling (default: on)
1879 Add support for continual scrolling of the display when you hold the 1705 Add support for continual scrolling of the display when you hold the
1880 mouse button down on a scrollbar arrow. 1706 mouse button down on a scrollbar arrow.
1881 1707
1882 --enable-mousewheel 1708 --enable-mousewheel (default: on)
1883 Add support for scrolling via mouse wheel or buttons 4 & 5. 1709 Add support for scrolling via mouse wheel or buttons 4 & 5.
1884 1710
1885 --enable-slipwheeling 1711 --enable-slipwheeling (default: on)
1886 Add support for continual scrolling (using the mouse wheel as an 1712 Add support for continual scrolling (using the mouse wheel as an
1887 accelerator) while the control key is held down. This option 1713 accelerator) while the control key is held down. This option
1888 requires --enable-mousewheel to also be specified. 1714 requires --enable-mousewheel to also be specified.
1889 1715
1890 --disable-new-selection 1716 --disable-new-selection
1891 Remove support for mouse selection style like that of xterm. 1717 Remove support for mouse selection style like that of xterm.
1892 1718
1893 --enable-dmalloc 1719 --enable-dmalloc (default: off)
1894 Use Gray Watson's malloc - which is good for debugging See 1720 Use Gray Watson's malloc - which is good for debugging See
1895 http://www.letters.com/dmalloc/ for details If you use either this 1721 http://www.letters.com/dmalloc/ for details If you use either this
1896 or the next option, you may need to edit src/Makefile after 1722 or the next option, you may need to edit src/Makefile after
1897 compiling to point DINCLUDE and DLIB to the right places. 1723 compiling to point DINCLUDE and DLIB to the right places.
1898 1724
1899 You can only use either this option and the following (should you 1725 You can only use either this option and the following (should you
1900 use either) . 1726 use either) .
1901 1727
1902 --enable-dlmalloc 1728 --enable-dlmalloc (default: off)
1903 Use Doug Lea's malloc - which is good for a production version See 1729 Use Doug Lea's malloc - which is good for a production version See
1904 <http://g.oswego.edu/dl/html/malloc.html> for details. 1730 <http://g.oswego.edu/dl/html/malloc.html> for details.
1905 1731
1906 --enable-smart-resize 1732 --enable-smart-resize (default: on)
1907 Add smart growth/shrink behaviour when changing font size via from 1733 Add smart growth/shrink behaviour when changing font size via hot
1908 hot keys. This should keep in a fixed position the rxvt corner which 1734 keys. This should keep the window corner which is closest to a
1909 is closest to a corner of the screen. 1735 corner of the screen in a fixed position.
1910 1736
1911 --enable-pointer-blank 1737 --enable-pointer-blank (default: on)
1912 Add support to have the pointer disappear when typing or inactive. 1738 Add support to have the pointer disappear when typing or inactive.
1913 1739
1914 --with-name=NAME 1740 --enable-perl (default: off)
1741 Enable an embedded perl interpreter. See the rxvtperl(3) manpage
1742 (doc/rxvtperl.txt) for more info on this feature, or the files in
1743 src/perl-ext/ for the extensions that are installed by default. The
1744 perl interpreter that is used can be specified via the "PERL"
1745 environment variable when running configure.
1746
1747 --with-name=NAME (default: urxvt)
1915 Set the basename for the installed binaries (default: "urxvt", 1748 Set the basename for the installed binaries, resulting in "urxvt",
1916 resulting in "urxvt", "urxvtd" etc.). Specify "--with-name=rxvt" to 1749 "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt".
1917 replace with "rxvt".
1918 1750
1919 --with-term=NAME 1751 --with-term=NAME (default: rxvt-unicode)
1920 Change the environmental variable for the terminal to NAME (default 1752 Change the environmental variable for the terminal to NAME.
1921 "rxvt-unicode")
1922 1753
1923 --with-terminfo=PATH 1754 --with-terminfo=PATH
1924 Change the environmental variable for the path to the terminfo tree 1755 Change the environmental variable for the path to the terminfo tree
1925 to PATH. 1756 to PATH.
1926 1757

Diff Legend

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