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.28 by root, Sat Dec 24 12:55:17 2005 UTC vs.
Revision 1.50 by root, Wed Jan 25 21:48:47 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
23 Isn't rxvt supposed to be small? Don't all those features bloat? 63 Isn't rxvt supposed to be small? Don't all those features bloat?
24 I often get asked about this, and I think, no, they didn't cause 64 I often get asked about this, and I think, no, they didn't cause
25 extra bloat. If you compare a minimal rxvt and a minimal urxvt, you 65 extra bloat. If you compare a minimal rxvt and a minimal urxvt, you
26 can see that the urxvt binary is larger (due to some encoding tables 66 can see that the urxvt binary is larger (due to some encoding tables
27 always being compiled in), but it actually uses less memory (RSS) 67 always being compiled in), but it actually uses less memory (RSS)
… …
56 96
57 Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), 97 Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k),
58 this still fares rather well. And compared to some monsters like 98 this still fares rather well. And compared to some monsters like
59 gnome-terminal (21152k + extra 4204k in separate processes) or 99 gnome-terminal (21152k + extra 4204k in separate processes) or
60 konsole (22200k + extra 43180k in daemons that stay around after 100 konsole (22200k + extra 43180k in daemons that stay around after
61 exit, plus half aminute of startup time, including the hundreds of 101 exit, plus half a minute of startup time, including the hundreds of
62 warnings it spits out), it fares extremely well *g*. 102 warnings it spits out), it fares extremely well *g*.
63 103
64 Why C++, isn't that unportable/bloated/uncool? 104 Why C++, isn't that unportable/bloated/uncool?
65 Is this a question? :) It comes up very often. The simple answer is: 105 Is this a question? :) It comes up very often. The simple answer is:
66 I had to write it, and C++ allowed me to write and maintain it in a 106 I had to write it, and C++ allowed me to write and maintain it in a
… …
104 terminal as an example embedding application. 144 terminal as an example embedding application.
105 145
106 How do I know which rxvt-unicode version I'm using? 146 How do I know which rxvt-unicode version I'm using?
107 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
108 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.
109 When using the urxvtc client, the version displayed is that of the 149 When using the rxvtc client, the version displayed is that of the
110 daemon. 150 daemon.
111 151
112 I am using Debian GNU/Linux and have a problem... 152 I am using Debian GNU/Linux and have a problem...
113 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
114 patches that considerably change the behaviour of rxvt-unicode. 154 patches that considerably change the behaviour of rxvt-unicode (but
115 Before reporting a bug to the original rxvt-unicode author please 155 unfortunately this notice has been removed). Before reporting a bug
116 download and install the genuine version 156 to the original rxvt-unicode author please download and install the
117 (<http://software.schmorp.de#rxvt-unicode>) and try to reproduce the 157 genuine version (<http://software.schmorp.de#rxvt-unicode>) and try
118 problem. If you cannot, chances are that the problems are specific 158 to reproduce the problem. If you cannot, chances are that the
119 to Debian GNU/Linux, in which case it should be reported via the 159 problems are specific to Debian GNU/Linux, in which case it should
120 Debian Bug Tracking System (use "reportbug" to report the bug). 160 be reported via the Debian Bug Tracking System (use "reportbug" to
161 report the bug).
121 162
122 For other problems that also affect the Debian package, you can and 163 For other problems that also affect the Debian package, you can and
123 probably should use the Debian BTS, too, because, after all, it's 164 probably should use the Debian BTS, too, because, after all, it's
124 also a bug in the Debian version and it serves as a reminder for 165 also a bug in the Debian version and it serves as a reminder for
125 other users that might encounter the same issue. 166 other users that might encounter the same issue.
167
168 I am maintaining rxvt-unicode for distribution/OS XXX, any
169 recommendation?
170 You should build one binary with the default options. configure now
171 enables most useful options, and the trend goes to making them
172 runtime-switchable, too, so there is usually no drawback to enbaling
173 them, except higher disk and possibly memory usage. The perl
174 interpreter should be enabled, as important functionality (menus,
175 selection, likely more in the future) depends on it.
176
177 You should not overwrite the "perl-ext-common" snd "perl-ext"
178 resources system-wide (except maybe with "defaults"). This will
179 result in useful behaviour. If your distribution aims at low memory,
180 add an empty "perl-ext-common" resource to the app-defaults file.
181 This will keep the perl interpreter disabled until the user enables
182 it.
183
184 If you can/want build more binaries, I recommend building a minimal
185 one with "--disable-everything" (very useful) and a maximal one with
186 "--enable-everything" (less useful, it will be very big due to a lot
187 of encodings built-in that increase download times and are rarely
188 used).
189
190 I need to make it setuid/setgid to support utmp/ptys on my OS, is this
191 safe?
192 It should be, starting with release 7.1. You are encouraged to
193 properly install urxvt with privileges necessary for your OS now.
194
195 When rxvt-unicode detects that it runs setuid or setgid, it will
196 fork into a helper process for privileged operations (pty handling
197 on some systems, utmp/wtmp/lastlog handling on others) and drop
198 privileges immediately. This is much safer than most other terminals
199 that keep privileges while running (but is more relevant to urxvt,
200 as it contains things as perl interpreters, which might be "helpful"
201 to attackers).
202
203 This forking is done as the very first within main(), which is very
204 early and reduces possible bugs to initialisation code run before
205 main(), or things like the dynamic loader of your system, which
206 should result in very little risk.
126 207
127 When I log-in to another system it tells me about missing terminfo data? 208 When I log-in to another system it tells me about missing terminfo data?
128 The terminal description used by rxvt-unicode is not as widely 209 The terminal description used by rxvt-unicode is not as widely
129 available as that for xterm, or even rxvt (for which the same 210 available as that for xterm, or even rxvt (for which the same
130 problem often arises). 211 problem often arises).
… …
155 236
156 "tic" outputs some error when compiling the terminfo entry. 237 "tic" outputs some error when compiling the terminfo entry.
157 Most likely it's the empty definition for "enacs=". Just replace it 238 Most likely it's the empty definition for "enacs=". Just replace it
158 by "enacs=\E[0@" and try again. 239 by "enacs=\E[0@" and try again.
159 240
160 "bash"'s readline does not work correctly under urxvt. 241 "bash"'s readline does not work correctly under rxvt.
161 I need a termcap file entry. 242 I need a termcap file entry.
162 One reason you might want this is that some distributions or 243 One reason you might want this is that some distributions or
163 operating systems still compile some programs using the 244 operating systems still compile some programs using the
164 long-obsoleted termcap library (Fedora Core's bash is one example) 245 long-obsoleted termcap library (Fedora Core's bash is one example)
165 and rely on a termcap entry for "rxvt-unicode". 246 and rely on a termcap entry for "rxvt-unicode".
… …
276 indeed look correct. 357 indeed look correct.
277 358
278 In that case, select a font of your taste and add it to the font 359 In that case, select a font of your taste and add it to the font
279 list, e.g.: 360 list, e.g.:
280 361
281 urxvt -fn basefont,font2,font3... 362 rxvt -fn basefont,font2,font3...
282 363
283 When rxvt-unicode sees a character, it will first look at the base 364 When rxvt-unicode sees a character, it will first look at the base
284 font. If the base font does not contain the character, it will go to 365 font. If the base font does not contain the character, it will go to
285 the next font, and so on. Specifying your own fonts will also speed 366 the next font, and so on. Specifying your own fonts will also speed
286 up this search and use less resources within rxvt-unicode and the 367 up this search and use less resources within rxvt-unicode and the
… …
518 599
519 My input method wants <some encoding> but I want UTF-8, what can I do? 600 My input method wants <some encoding> but I want UTF-8, what can I do?
520 You can specify separate locales for the input method and the rest 601 You can specify separate locales for the input method and the rest
521 of the terminal, using the resource "imlocale": 602 of the terminal, using the resource "imlocale":
522 603
523 URxvt*imlocale: ja_JP.EUC-JP 604 URxvt.imlocale: ja_JP.EUC-JP
524 605
525 Now you can start your terminal with "LC_CTYPE=ja_JP.UTF-8" and 606 Now you can start your terminal with "LC_CTYPE=ja_JP.UTF-8" and
526 still use your input method. Please note, however, that you will not 607 still use your input method. Please note, however, that you will not
527 be able to input characters outside "EUC-JP" in a normal way then, 608 be able to input characters outside "EUC-JP" in a normal way then,
528 as your input method limits you. 609 as your input method limits you.
… …
571 Mouse cut/paste suddenly no longer works. 652 Mouse cut/paste suddenly no longer works.
572 Make sure that mouse reporting is actually turned off since killing 653 Make sure that mouse reporting is actually turned off since killing
573 some editors prematurely may leave the mouse in mouse report mode. 654 some editors prematurely may leave the mouse in mouse report mode.
574 I've heard that tcsh may use mouse reporting unless it otherwise 655 I've heard that tcsh may use mouse reporting unless it otherwise
575 specified. A quick check is to see if cut/paste works when the Alt 656 specified. A quick check is to see if cut/paste works when the Alt
576 or Shift keys are depressed. See urxvt(7) 657 or Shift keys are depressed.
577 658
578 What's with this bold/blink stuff? 659 What's with this bold/blink stuff?
579 If no bold colour is set via "colorBD:", bold will invert text using 660 If no bold colour is set via "colorBD:", bold will invert text using
580 the standard foreground colour. 661 the standard foreground colour.
581 662
… …
636 URxvt.color6: #73f7ff 717 URxvt.color6: #73f7ff
637 URxvt.color14: #73f7ff 718 URxvt.color14: #73f7ff
638 URxvt.color7: #e1dddd 719 URxvt.color7: #e1dddd
639 URxvt.color15: #e1dddd 720 URxvt.color15: #e1dddd
640 721
641 How can I start urxvtd in a race-free way? 722 How can I start rxvtd in a race-free way?
642 Try "urxvtd -f -o", which tells urxvtd to open the display, create 723 Try "rxvtd -f -o", which tells rxvtd to open the display, create the
643 the listening socket and then fork. 724 listening socket and then fork.
644 725
645 What's with the strange Backspace/Delete key behaviour? 726 What's with the strange Backspace/Delete key behaviour?
646 Assuming that the physical Backspace key corresponds to the 727 Assuming that the physical Backspace key corresponds to the
647 BackSpace keysym (not likely for Linux ... see the following 728 BackSpace keysym (not likely for Linux ... see the following
648 question) there are two standard values that can be used for 729 question) there are two standard values that can be used for
… …
661 742
662 For starting a new rxvt-unicode: 743 For starting a new rxvt-unicode:
663 744
664 # use Backspace = ^H 745 # use Backspace = ^H
665 $ stty erase ^H 746 $ stty erase ^H
666 $ urxvt 747 $ rxvt
667 748
668 # use Backspace = ^? 749 # use Backspace = ^?
669 $ stty erase ^? 750 $ stty erase ^?
670 $ urxvt 751 $ rxvt
671 752
672 Toggle with "ESC [ 36 h" / "ESC [ 36 l" as documented in urxvt(7). 753 Toggle with "ESC [ 36 h" / "ESC [ 36 l".
673 754
674 For an existing rxvt-unicode: 755 For an existing rxvt-unicode:
675 756
676 # use Backspace = ^H 757 # use Backspace = ^H
677 $ stty erase ^H 758 $ stty erase ^H
… …
703 There are some compile-time selections available via configure. 784 There are some compile-time selections available via configure.
704 Unless you have run "configure" with the "--disable-resources" 785 Unless you have run "configure" with the "--disable-resources"
705 option you can use the `keysym' resource to alter the keystrings 786 option you can use the `keysym' resource to alter the keystrings
706 associated with keysyms. 787 associated with keysyms.
707 788
708 Here's an example for a URxvt session started using "urxvt -name 789 Here's an example for a URxvt session started using "rxvt -name
709 URxvt" 790 URxvt"
710 791
711 URxvt.keysym.Home: \033[1~ 792 URxvt.keysym.Home: \033[1~
712 URxvt.keysym.End: \033[4~ 793 URxvt.keysym.End: \033[4~
713 URxvt.keysym.C-apostrophe: \033<C-'> 794 URxvt.keysym.C-apostrophe: \033<C-'>
… …
789 870
790RXVT TECHNICAL REFERENCE 871RXVT TECHNICAL REFERENCE
791DESCRIPTION 872DESCRIPTION
792 The rest of this document describes various technical aspects of 873 The rest of this document describes various technical aspects of
793 rxvt-unicode. First the description of supported command sequences, 874 rxvt-unicode. First the description of supported command sequences,
794 followed by menu and pixmap support and last by a description of all 875 followed by pixmap support and last by a description of all features
795 features selectable at "configure" time. 876 selectable at "configure" time.
796 877
797Definitions 878Definitions
798 "c" The literal character c. 879 "c" The literal character c.
799 880
800 "C" A single (required) character. 881 "C" A single (required) character.
… …
1169 1250
1170 "Ps = 9" X10 XTerm 1251 "Ps = 9" X10 XTerm
1171 h Send Mouse X & Y on button press. 1252 h Send Mouse X & Y on button press.
1172 l No mouse reporting. 1253 l No mouse reporting.
1173 1254
1174 "Ps = 10" (rxvt)
1175 h menuBar visible
1176 l menuBar invisible
1177
1178 "Ps = 25" 1255 "Ps = 25"
1179 h Visible cursor {cnorm/cvvis} 1256 h Visible cursor {cnorm/cvvis}
1180 l Invisible cursor {civis} 1257 l Invisible cursor {civis}
1181 1258
1182 "Ps = 30" 1259 "Ps = 30"
… …
1230 l Scroll to bottom on TTY output 1307 l Scroll to bottom on TTY output
1231 1308
1232 "Ps = 1011" (rxvt) 1309 "Ps = 1011" (rxvt)
1233 h Scroll to bottom when a key is pressed 1310 h Scroll to bottom when a key is pressed
1234 l Don't scroll to bottom when a key is pressed 1311 l Don't scroll to bottom when a key is pressed
1312
1313 "Ps = 1021" (rxvt)
1314 h Bold/italic implies high intensity (see option -is)
1315 l Font styles have no effect on intensity (Compile styles)
1235 1316
1236 "Ps = 1047" 1317 "Ps = 1047"
1237 h Use Alternate Screen Buffer 1318 h Use Alternate Screen Buffer
1238 l Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it 1319 l Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1239 1320
… …
1262 Ps = 10 Change colour of text foreground to Pt (NB: may change in future) 1343 Ps = 10 Change colour of text foreground to Pt (NB: may change in future)
1263 Ps = 11 Change colour of text background to Pt (NB: may change in future) 1344 Ps = 11 Change colour of text background to Pt (NB: may change in future)
1264 Ps = 12 Change colour of text cursor foreground to Pt 1345 Ps = 12 Change colour of text cursor foreground to Pt
1265 Ps = 13 Change colour of mouse foreground to Pt 1346 Ps = 13 Change colour of mouse foreground to Pt
1266 Ps = 17 Change colour of highlight characters to Pt 1347 Ps = 17 Change colour of highlight characters to Pt
1267 Ps = 18 Change colour of bold characters to Pt 1348 Ps = 18 Change colour of bold characters to Pt [deprecated, see 706]
1268 Ps = 19 Change colour of underlined characters to Pt 1349 Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707]
1269 Ps = 20 Change default background to Pt 1350 Ps = 20 Change background pixmap parameters (see section XPM) (Compile XPM).
1270 Ps = 39 Change default foreground colour to Pt. 1351 Ps = 39 Change default foreground colour to Pt.
1271 Ps = 46 Change Log File to Pt unimplemented 1352 Ps = 46 Change Log File to Pt unimplemented
1272 Ps = 49 Change default background colour to Pt. 1353 Ps = 49 Change default background colour to Pt.
1273 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 1354 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
1274 Ps = 55 Log all scrollback buffer and all of screen to Pt 1355 Ps = 55 Log all scrollback buffer and all of screen to Pt
1275 Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills). 1356 Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills).
1276 Ps = 703 Menubar command Pt (Compile menubar).
1277 Ps = 704 Change colour of italic characters to Pt 1357 Ps = 704 Change colour of italic characters to Pt
1278 Ps = 705 Change background pixmap tint colour to Pt (Compile transparency). 1358 Ps = 705 Change background pixmap tint colour to Pt (Compile transparency).
1359 Ps = 706 Change colour of bold characters to Pt
1360 Ps = 707 Change colour of underlined characters to Pt
1279 Ps = 710 Set normal fontset to Pt. Same as Ps = 50. 1361 Ps = 710 Set normal fontset to Pt. Same as Ps = 50.
1280 Ps = 711 Set bold fontset to Pt. Similar to Ps = 50 (Compile styles). 1362 Ps = 711 Set bold fontset to Pt. Similar to Ps = 50 (Compile styles).
1281 Ps = 712 Set italic fontset to Pt. Similar to Ps = 50 (Compile styles). 1363 Ps = 712 Set italic fontset to Pt. Similar to Ps = 50 (Compile styles).
1282 Ps = 713 Set bold-italic fontset to Pt. Similar to Ps = 50 (Compile styles). 1364 Ps = 713 Set bold-italic fontset to Pt. Similar to Ps = 50 (Compile styles).
1283 Ps = 720 Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills). 1365 Ps = 720 Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
1284 Ps = 721 Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills). 1366 Ps = 721 Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
1367 Ps = 777 Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl).
1285 1368
1286 1369
1287
1288menuBar
1289 The exact syntax used is *almost* solidified. In the menus, DON'T try to
1290 use menuBar commands that add or remove a menuBar.
1291
1292 Note that in all of the commands, the */path/* *cannot* be omitted: use
1293 ./ to specify a menu relative to the current menu.
1294
1295 Overview of menuBar operation
1296 For the menuBar XTerm escape sequence "ESC ] 703 ; Pt ST", the syntax of
1297 "Pt" can be used for a variety of tasks:
1298
1299 At the top level is the current menuBar which is a member of a circular
1300 linked-list of other such menuBars.
1301
1302 The menuBar acts as a parent for the various drop-down menus, which in
1303 turn, may have labels, separator lines, menuItems and subMenus.
1304
1305 The menuItems are the useful bits: you can use them to mimic keyboard
1306 input or even to send text or escape sequences back to rxvt.
1307
1308 The menuBar syntax is intended to provide a simple yet robust method of
1309 constructing and manipulating menus and navigating through the menuBars.
1310
1311 The first step is to use the tag [menu:*name*] which creates the menuBar
1312 called *name* and allows access. You may now or menus, subMenus, and
1313 menuItems. Finally, use the tag [done] to set the menuBar access as
1314 readonly to prevent accidental corruption of the menus. To re-access the
1315 current menuBar for alterations, use the tag [menu], make the
1316 alterations and then use [done]
1317
1318
1319
1320 Commands
1321 [menu:+*name*]
1322 access the named menuBar for creation or alteration. If a new
1323 menuBar is created, it is called *name* (max of 15 chars) and the
1324 current menuBar is pushed onto the stack
1325
1326 [menu]
1327 access the current menuBar for alteration
1328
1329 [title:+*string*]
1330 set the current menuBar's title to *string*, which may contain the
1331 following format specifiers:
1332
1333 B<%n> rxvt name (as per the B<-name> command-line option)
1334 B<%v> rxvt version
1335 B<%%> literal B<%> character
1336
1337 [done]
1338 set menuBar access as readonly. End-of-file tag for [read:+*file*]
1339 operations.
1340
1341 [read:+*file*]
1342 read menu commands directly from *file* (extension ".menu" will be
1343 appended if required.) Start reading at a line with [menu] or
1344 [menu:+*name* and continuing until [done] is encountered.
1345
1346 Blank and comment lines (starting with #) are ignored. Actually,
1347 since any invalid menu commands are also ignored, almost anything
1348 could be construed as a comment line, but this may be tightened up
1349 in the future ... so don't count on it!.
1350
1351 [read:+*file*;+*name*]
1352 The same as [read:+*file*], but start reading at a line with
1353 [menu:+*name*] and continuing until [done:+*name*] or [done] is
1354 encountered.
1355
1356 [dump]
1357 dump all menuBars to the file /tmp/rxvt-PID in a format suitable for
1358 later rereading.
1359
1360 [rm:name]
1361 remove the named menuBar
1362
1363 [rm] [rm:]
1364 remove the current menuBar
1365
1366 [rm*] [rm:*]
1367 remove all menuBars
1368
1369 [swap]
1370 swap the top two menuBars
1371
1372 [prev]
1373 access the previous menuBar
1374
1375 [next]
1376 access the next menuBar
1377
1378 [show]
1379 Enable display of the menuBar
1380
1381 [hide]
1382 Disable display of the menuBar
1383
1384 [pixmap:+*name*]
1385 [pixmap:+*name*;*scaling*]
1386 (set the background pixmap globally
1387
1388 A Future implementation *may* make this local to the menubar)
1389
1390 [:+*command*:]
1391 ignore the menu readonly status and issue a *command* to or a menu
1392 or menuitem or change the ; a useful shortcut for setting the quick
1393 arrows from a menuBar.
1394
1395
1396
1397 Adding and accessing menus
1398 The following commands may also be + prefixed.
1399
1400 /+ access menuBar top level
1401
1402 ./+ access current menu level
1403
1404 ../+
1405 access parent menu (1 level up)
1406
1407 ../../
1408 access parent menu (multiple levels up)
1409
1410 */path/*menu
1411 add/access menu
1412
1413 */path/*menu/*
1414 add/access menu and clear it if it exists
1415
1416 */path/*{-}
1417 add separator
1418
1419 */path/*{item}
1420 add item as a label
1421
1422 */path/*{item} action
1423 add/alter *menuitem* with an associated *action*
1424
1425 */path/*{item}{right-text}
1426 add/alter *menuitem* with right-text as the right-justified text and
1427 as the associated *action*
1428
1429 */path/*{item}{rtext} action
1430 add/alter *menuitem* with an associated *action* and with rtext as
1431 the right-justified text.
1432
1433 Special characters in *action* must be backslash-escaped:
1434 \a \b \E \e \n \r \t \octal
1435
1436 or in control-character notation:
1437 ^@, ^A .. ^Z .. ^_, ^?
1438
1439 To send a string starting with a NUL (^@) character to the program,
1440 start *action* with a pair of NUL characters (^@^@), the first of which
1441 will be stripped off and the balance directed to the program. Otherwise
1442 if *action* begins with NUL followed by non-+NUL characters, the leading
1443 NUL is stripped off and the balance is sent back to rxvt.
1444
1445 As a convenience for the many Emacs-type editors, *action* may start
1446 with M- (eg, M-$ is equivalent to \E$) and a CR will be appended if
1447 missed from M-x commands.
1448
1449 As a convenience for issuing XTerm ESC ] sequences from a menubar (or
1450 quick arrow), a BEL (^G) will be appended if needed.
1451
1452 For example,
1453 M-xapropos is equivalent to \Exapropos\r
1454
1455 and \E]703;mona;100 is equivalent to \E]703;mona;100\a
1456
1457 The option {*right-rtext*} will be right-justified. In the absence of a
1458 specified action, this text will be used as the *action* as well.
1459
1460 For example,
1461 /File/{Open}{^X^F} is equivalent to /File/{Open}{^X^F} ^X^F
1462
1463 The left label *is* necessary, since it's used for matching, but
1464 implicitly hiding the left label (by using same name for both left and
1465 right labels), or explicitly hiding the left label (by preceeding it
1466 with a dot), makes it possible to have right-justified text only.
1467
1468 For example,
1469 /File/{Open}{Open} Open-File-Action
1470
1471 or hiding it
1472 /File/{.anylabel}{Open} Open-File-Action
1473
1474
1475
1476 Removing menus
1477 -/*+
1478 remove all menus from the menuBar, the same as [clear]
1479
1480 -+*/path*menu+
1481 remove menu
1482
1483 -+*/path*{item}+
1484 remove item
1485
1486 -+*/path*{-}
1487 remove separator)
1488
1489 -/path/menu/*
1490 remove all items, separators and submenus from menu
1491
1492
1493
1494 Quick Arrows
1495 The menus also provide a hook for *quick arrows* to provide easier user
1496 access. If nothing has been explicitly set, the default is to emulate
1497 the curror keys. The syntax permits each arrow to be altered
1498 individually or all four at once without re-entering their common
1499 beginning/end text. For example, to explicitly associate cursor actions
1500 with the arrows, any of the following forms could be used:
1501
1502 <r>+*Right*
1503 <l>+*Left*
1504 <u>+*Up*
1505 <d>+*Down*
1506 Define actions for the respective arrow buttons
1507
1508 <b>+*Begin*
1509 <e>+*End*
1510 Define common beginning/end parts for *quick arrows* which used in
1511 conjunction with the above <r> <l> <u> <d> constructs
1512
1513 For example, define arrows individually,
1514 <u>\E[A
1515
1516 <d>\E[B
1517
1518 <r>\E[C
1519
1520 <l>\E[D
1521
1522 or all at once
1523 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1524
1525 or more compactly (factoring out common parts)
1526 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1527
1528
1529
1530 Command Summary
1531 A short summary of the most *common* commands:
1532
1533 [menu:name]
1534 use an existing named menuBar or start a new one
1535
1536 [menu]
1537 use the current menuBar
1538
1539 [title:string]
1540 set menuBar title
1541
1542 [done]
1543 set menu access to readonly and, if reading from a file, signal EOF
1544
1545 [done:name]
1546 if reading from a file using [read:file;name] signal EOF
1547
1548 [rm:name]
1549 remove named menuBar(s)
1550
1551 [rm] [rm:]
1552 remove current menuBar
1553
1554 [rm*] [rm:*]
1555 remove all menuBar(s)
1556
1557 [swap]
1558 swap top two menuBars
1559
1560 [prev]
1561 access the previous menuBar
1562
1563 [next]
1564 access the next menuBar
1565
1566 [show]
1567 map menuBar
1568
1569 [hide]
1570 unmap menuBar
1571
1572 [pixmap;file]
1573 [pixmap;file;scaling]
1574 set a background pixmap
1575
1576 [read:file]
1577 [read:file;name]
1578 read in a menu from a file
1579
1580 [dump]
1581 dump out all menuBars to /tmp/rxvt-PID
1582
1583 / access menuBar top level
1584
1585 ./
1586 ../
1587 ../../
1588 access current or parent menu level
1589
1590 /path/menu
1591 add/access menu
1592
1593 /path/{-}
1594 add separator
1595
1596 /path/{item}{rtext} action
1597 add/alter menu item
1598
1599 -/* remove all menus from the menuBar
1600
1601 -/path/menu
1602 remove menu items, separators and submenus from menu
1603
1604 -/path/menu
1605 remove menu
1606
1607 -/path/{item}
1608 remove item
1609
1610 -/path/{-}
1611 remove separator
1612
1613 <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1614 menu quick arrows
1615 1370
1616XPM 1371XPM
1617 For the XPM XTerm escape sequence "ESC ] 20 ; Pt ST" then value of "Pt" 1372 For the XPM XTerm escape sequence "ESC ] 20 ; Pt ST" then value of "Pt"
1618 can be the name of the background pixmap followed by a sequence of 1373 can be the name of the background pixmap followed by a sequence of
1619 scaling/positioning commands separated by semi-colons. The 1374 scaling/positioning commands separated by semi-colons. The
… …
1804 Add support for XIM (X Input Method) protocol. This allows using 1559 Add support for XIM (X Input Method) protocol. This allows using
1805 alternative input methods (e.g. kinput2) and will also correctly set 1560 alternative input methods (e.g. kinput2) and will also correctly set
1806 up the input for people using dead keys or compose keys. 1561 up the input for people using dead keys or compose keys.
1807 1562
1808 --enable-unicode3 (default: off) 1563 --enable-unicode3 (default: off)
1564 Recommended to stay off unless you really need non-BMP characters.
1565
1809 Enable direct support for displaying unicode codepoints above 65535 1566 Enable direct support for displaying unicode codepoints above 65535
1810 (the basic multilingual page). This increases storage requirements 1567 (the basic multilingual page). This increases storage requirements
1811 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
1812 extra characters, but Xft does. 1569 extra characters, but Xft does.
1813 1570
… …
1823 accents are encoded as seperate unicode characters. This is done by 1580 accents are encoded as seperate unicode characters. This is done by
1824 using precomposited characters when available or creating new 1581 using precomposited characters when available or creating new
1825 pseudo-characters when no precomposed form exists. 1582 pseudo-characters when no precomposed form exists.
1826 1583
1827 Without --enable-unicode3, the number of additional precomposed 1584 Without --enable-unicode3, the number of additional precomposed
1828 characters is rather limited (2048, if this is full, rxvt-unicode 1585 characters is somewhat limited (the 6400 private use characters will
1829 will use the private use area, extending the number of combinations
1830 to 8448). With --enable-unicode3, no practical limit exists. 1586 be (ab-)used). With --enable-unicode3, no practical limit exists.
1831 1587
1832 This option will also enable storage (but not display) of characters 1588 This option will also enable storage (but not display) of characters
1833 beyond plane 0 (>65535) when --enable-unicode3 was not specified. 1589 beyond plane 0 (>65535) when --enable-unicode3 was not specified.
1834 1590
1835 The combining table also contains entries for arabic presentation 1591 The combining table also contains entries for arabic presentation
… …
1860 --enable-lastlog (default: on) 1616 --enable-lastlog (default: on)
1861 Write user and tty to lastlog file (used by programs like lastlogin) 1617 Write user and tty to lastlog file (used by programs like lastlogin)
1862 at start of rxvt execution. This option requires --enable-utmp to 1618 at start of rxvt execution. This option requires --enable-utmp to
1863 also be specified. 1619 also be specified.
1864 1620
1865 --enable-xpm-background (default: off) 1621 --enable-xpm-background (default: on)
1866 Add support for XPM background pixmaps. 1622 Add support for XPM background pixmaps.
1867 1623
1868 --enable-transparency (default: off) 1624 --enable-transparency (default: on)
1869 Add support for inheriting parent backgrounds thus giving a fake 1625 Add support for inheriting parent backgrounds thus giving a fake
1870 transparency to the term. 1626 transparency to the term.
1871 1627
1872 --enable-fading (default: on) 1628 --enable-fading (default: on)
1873 Add support for fading the text when focus is lost (requires 1629 Add support for fading the text when focus is lost (requires
1874 "--enable-transparency"). 1630 "--enable-transparency").
1875 1631
1876 --enable-tinting (default: on) 1632 --enable-tinting (default: on)
1877 Add support for tinting of transparent backgrounds (requires 1633 Add support for tinting of transparent backgrounds (requires
1878 "--enable-transparency"). 1634 "--enable-transparency").
1879
1880 --enable-menubar (default: off)
1881 Add support for our menu bar system (this interacts badly with
1882 dynamic locale switching currently).
1883 1635
1884 --enable-rxvt-scroll (default: on) 1636 --enable-rxvt-scroll (default: on)
1885 Add support for the original rxvt scrollbar. 1637 Add support for the original rxvt scrollbar.
1886 1638
1887 --enable-next-scroll (default: on) 1639 --enable-next-scroll (default: on)
… …
1893 --enable-plain-scroll (default: on) 1645 --enable-plain-scroll (default: on)
1894 Add support for a very unobtrusive, plain-looking scrollbar that is 1646 Add support for a very unobtrusive, plain-looking scrollbar that is
1895 the favourite of the rxvt-unicode author, having used it for many 1647 the favourite of the rxvt-unicode author, having used it for many
1896 years. 1648 years.
1897 1649
1898 --enable-half-shadow (default: off)
1899 Make shadows on the scrollbar only half the normal width & height.
1900 only applicable to rxvt scrollbars.
1901
1902 --enable-ttygid (default: off) 1650 --enable-ttygid (default: off)
1903 Change tty device setting to group "tty" - only use this if your 1651 Change tty device setting to group "tty" - only use this if your
1904 system uses this type of security. 1652 system uses this type of security.
1905 1653
1906 --disable-backspace-key 1654 --disable-backspace-key
… …
1911 Removes any handling of the delete key by us - let the X server do 1659 Removes any handling of the delete key by us - let the X server do
1912 it. 1660 it.
1913 1661
1914 --disable-resources 1662 --disable-resources
1915 Removes any support for resource checking. 1663 Removes any support for resource checking.
1916
1917 --enable-xgetdefault
1918 Make resources checking via XGetDefault() instead of our small
1919 version which only checks ~/.Xdefaults, or if that doesn't exist
1920 then ~/.Xresources.
1921
1922 Please note that nowadays, things like XIM will automatically pull
1923 in and use the full X resource manager, so the overhead of using it
1924 might be very small, if nonexistant.
1925
1926 --enable-strings (default: off)
1927 Add support for our possibly faster memset() function and other
1928 various routines, overriding your system's versions which may have
1929 been hand-crafted in assembly or may require extra libraries to link
1930 in. (this breaks ANSI-C rules and has problems on many GNU/Linux
1931 systems).
1932 1664
1933 --disable-swapscreen 1665 --disable-swapscreen
1934 Remove support for secondary/swap screen. 1666 Remove support for secondary/swap screen.
1935 1667
1936 --enable-frills (default: on) 1668 --enable-frills (default: on)
… …
1941 A non-exhaustive list of features enabled by "--enable-frills" 1673 A non-exhaustive list of features enabled by "--enable-frills"
1942 (possibly in combination with other switches) is: 1674 (possibly in combination with other switches) is:
1943 1675
1944 MWM-hints 1676 MWM-hints
1945 EWMH-hints (pid, utf8 names) and protocols (ping) 1677 EWMH-hints (pid, utf8 names) and protocols (ping)
1946 seperate underline colour 1678 seperate underline colour (-underlineColor)
1947 settable border widths and borderless switch 1679 settable border widths and borderless switch (-w, -b, -bl)
1680 visual selection (-depth)
1948 settable extra linespacing 1681 settable extra linespacing /-lsp)
1949 iso-14755-2 and -3, and visual feedback 1682 iso-14755-2 and -3, and visual feedback
1950 backindex and forwardindex escape sequence 1683 backindex and forwardindex escape sequence
1951 window op and some xterm/OSC escape sequences 1684 window op and some xterm/OSC escape sequences
1952 tripleclickwords 1685 tripleclickwords (-tcw)
1953 settable insecure mode 1686 settable insecure mode (-insecure)
1954 keysym remapping support 1687 keysym remapping support
1955 cursor blinking and underline cursor 1688 cursor blinking and underline cursor (-cb, -uc)
1956 -embed, -pty-fd and -hold options 1689 XEmbed support (-embed)
1690 user-pty (-pty-fd)
1691 hold on exit (-hold)
1692 skip builtin block graphics (-sbg)
1693 sgr modes 90..97 and 100..107
1957 1694
1958 --enable-iso14755 (default: on) 1695 --enable-iso14755 (default: on)
1959 Enable extended ISO 14755 support (see urxvt(1), or doc/rxvt.1.txt). 1696 Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt).
1960 Basic support (section 5.1) is enabled by "--enable-frills", while 1697 Basic support (section 5.1) is enabled by "--enable-frills", while
1961 support for 5.2, 5.3 and 5.4 is enabled with this switch. 1698 support for 5.2, 5.3 and 5.4 is enabled with this switch.
1962 1699
1963 --enable-keepscrolling (default: on) 1700 --enable-keepscrolling (default: on)
1964 Add support for continual scrolling of the display when you hold the 1701 Add support for continual scrolling of the display when you hold the
… …
1994 corner of the screen in a fixed position. 1731 corner of the screen in a fixed position.
1995 1732
1996 --enable-pointer-blank (default: on) 1733 --enable-pointer-blank (default: on)
1997 Add support to have the pointer disappear when typing or inactive. 1734 Add support to have the pointer disappear when typing or inactive.
1998 1735
1736 --enable-perl (default: on)
1737 Enable an embedded perl interpreter. See the rxvtperl(3) manpage
1738 (doc/rxvtperl.txt) for more info on this feature, or the files in
1739 src/perl-ext/ for the extensions that are installed by default. The
1740 perl interpreter that is used can be specified via the "PERL"
1741 environment variable when running configure.
1742
1999 --with-name=NAME (default: urxvt) 1743 --with-name=NAME (default: urxvt)
2000 Set the basename for the installed binaries, resulting in "urxvt", 1744 Set the basename for the installed binaries, resulting in "urxvt",
2001 "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt". 1745 "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt".
2002 1746
2003 --with-term=NAME (default: rxvt-unicode) 1747 --with-term=NAME (default: rxvt-unicode)

Diff Legend

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