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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.76 by root, Wed Jan 11 19:55:34 2006 UTC vs.
Revision 1.100 by root, Tue Jan 31 01:00:49 2006 UTC

… …
16=head1 DESCRIPTION 16=head1 DESCRIPTION
17 17
18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting 18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
19all escape sequences, and other background information. 19all escape sequences, and other background information.
20 20
21The newest version of this document is 21The newest version of this document is also available on the World Wide Web at
22also available on the World Wide Web at
23L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
24 23
25=head1 FREQUENTLY ASKED QUESTIONS 24=head1 FREQUENTLY ASKED QUESTIONS
26 25
27=over 4 26=head2 The new selection selects pieces that are too big, how can I select
27single words?
28 28
29If you want to select e.g. alphanumeric words, you can use the following
30setting:
31
32 URxvt.selection.pattern-0: ([[:word:]]+)
33
34If you click more than twice, the selection will be extended
35more and more.
36
37To get a selection that is very similar to the old code, try this pattern:
38
39 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
40
41Please also note that the I<LeftClick Shift-LeftClik> combination also
42selects words like the old code.
43
44=head2 I don't like the new selection/popups/hotkeys/perl, how do I
45change/disable it?
46
47You can disable the perl extension completely by setting the
48B<perl-ext-common> resource to the empty string, which also keeps
49rxvt-unicode from initialising perl, saving memory.
50
51If you only want to disable specific features, you first have to
52identify which perl extension is responsible. For this, read the section
53B<PREPACKAGED EXTENSIONS> in the @@RXVT_NAME@@perl(3) manpage. For
54example, to disable the B<selection-popup> and B<option-popup>, specify
55this B<perl-ext-common> resource:
56
57 URxvt.perl-ext-common: default,-selection-popup,-option-popup
58
59This will keep the default extensions, but disable the two popup
60extensions. Some extensions can also be configured, for example,
61scrollback search mode is triggered by B<M-s>. You can move it to any
62other combination either by setting the B<searchable-scrollback> resource:
63
64 URxvt.searchable-scrollback: CM-s
65
66=head3 The cursor moves when selecting text in the current input line, how
67do I switch this off?
68
69See next entry.
70
71=head2 During rlogin/ssh/telnet/etc. sessions, clicking near the cursor
72outputs strange escape sequences, how do I fix this?
73
74These are caused by the C<readline> perl extension. Under normal
75circumstances, it will move your cursor around when you click into the
76line that contains it. It tries hard not to do this at the wrong moment,
77but when running a program that doesn't parse cursor movements or in some
78cases during rlogin sessions, it fails to detect this properly.
79
80You can permamently switch this feature off by disabling the C<readline>
81extension:
82
83 URxvt.perl-ext-common: default,-readline
84
85=head2 Why doesn't rxvt-unicode read my resources?
86
87Well, why, indeed? It does, in a way very similar to other X
88applications. Most importantly, this means that if you or your OS loads
89resources into the X display (the right way to do it), rxvt-unicode will
90ignore any resource files in your home directory. It will only read
91F<$HOME/.Xdefaults> when no resources are attached to the display.
92
93If you have or use an F<$HOME/.Xresources> file, chances are that
94resources are loaded into your X-server. In this case, you have to
95re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
96
97Also consider the form resources have to use:
98
99 URxvt.resource: value
100
101If you want to use another form (there are lots of different ways of
102specifying resources), make sure you understand wether and why it
103works. If unsure, use the form above.
104
105=head2 I can't get transparency working, what am I doing wrong?
106
107First of all, transparency isn't officially supported in rxvt-unicode, so
108you are mostly on your own. Do not bug the author about it (but you may
109bug everybody else). Also, if you can't get it working consider it a rite
110of passage: ... and you failed.
111
112Here are four ways to get transparency. B<Do> read the manpage and option
113descriptions for the programs mentioned and rxvt-unicode. Really, do it!
114
1151. Use inheritPixmap:
116
117 Esetroot wallpaper.jpg
118 @@RXVT_NAME@@ -ip -tint red -sh 40
119
120That works. If you think it doesn't, you lack transparency and tinting
121support, or you are unable to read.
122
1232. Use a simple pixmap and emulate pseudo-transparency. This enables you
124to use effects other than tinting and shading: Just shade/tint/whatever
125your picture with gimp:
126
127 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm
128 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
129
130That works. If you think it doesn't, you lack XPM and Perl support, or you
131are unable to read.
132
1333. Use an ARGB visual:
134
135 @@RXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
136
137This requires XFT support, and the support of your X-server. If that
138doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
139there yet, no matter what they claim. Rxvt-Unicode contains the neccessary
140bugfixes and workarounds for Xft and Xlib to make it work, but that
141doesn't mean that your WM has the required kludges in place.
142
1434. Use xcompmgr and let it do the job:
144
145 xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
146 -set _NET_WM_WINDOW_OPACITY 0xc0000000
147
148Then click on a window you want to make transparent. Replace C<0xc0000000>
149by other values to change the degree of opacity. If it doesn't work and
150your server crashes, you got to keep the pieces.
151
29=item Isn't rxvt supposed to be small? Don't all those features bloat? 152=head2 Isn't rxvt supposed to be small? Don't all those features bloat?
30 153
31I often get asked about this, and I think, no, they didn't cause extra 154I often get asked about this, and I think, no, they didn't cause extra
32bloat. If you compare a minimal rxvt and a minimal urxvt, you can see 155bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
33that the urxvt binary is larger (due to some encoding tables always being 156that the urxvt binary is larger (due to some encoding tables always being
34compiled in), but it actually uses less memory (RSS) after startup. Even 157compiled in), but it actually uses less memory (RSS) after startup. Even
… …
66(21152k + extra 4204k in separate processes) or konsole (22200k + extra 189(21152k + extra 4204k in separate processes) or konsole (22200k + extra
6743180k in daemons that stay around after exit, plus half a minute of 19043180k in daemons that stay around after exit, plus half a minute of
68startup time, including the hundreds of warnings it spits out), it fares 191startup time, including the hundreds of warnings it spits out), it fares
69extremely well *g*. 192extremely well *g*.
70 193
71=item Why C++, isn't that unportable/bloated/uncool? 194=head2 Why C++, isn't that unportable/bloated/uncool?
72 195
73Is this a question? :) It comes up very often. The simple answer is: I had 196Is this a question? :) It comes up very often. The simple answer is: I had
74to write it, and C++ allowed me to write and maintain it in a fraction 197to write it, and C++ allowed me to write and maintain it in a fraction
75of the time and effort (which is a scarce resource for me). Put even 198of the time and effort (which is a scarce resource for me). Put even
76shorter: It simply wouldn't exist without C++. 199shorter: It simply wouldn't exist without C++.
… …
100 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) 223 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
101 224
102No large bloated libraries (of course, none were linked in statically), 225No large bloated libraries (of course, none were linked in statically),
103except maybe libX11 :) 226except maybe libX11 :)
104 227
105=item Does it support tabs, can I have a tabbed rxvt-unicode? 228=head2 Does it support tabs, can I have a tabbed rxvt-unicode?
106 229
107rxvt-unicode does not directly support tabs. It will work fine with 230Beginning with version 7.3, there is a perl extension that implements a
108tabbing functionality of many window managers or similar tabbing programs, 231simple tabbed terminal. It is installed by default, so any of these should
109and its embedding-features allow it to be embedded into other programs, 232give you tabs:
110as witnessed by F<doc/rxvt-tabbed> or the upcoming C<Gtk2::URxvt> perl
111module, which features a tabbed urxvt (murxvt) terminal as an example
112embedding application.
113 233
234 @@RXVT_NAME@@ -pe tabbed
235
236 URxvt.perl-ext-common: default,tabbed
237
238It will also work fine with tabbing functionality of many window managers
239or similar tabbing programs, and its embedding-features allow it to be
240embedded into other programs, as witnessed by F<doc/rxvt-tabbed> or
241the upcoming C<Gtk2::URxvt> perl module, which features a tabbed urxvt
242(murxvt) terminal as an example embedding application.
243
114=item How do I know which rxvt-unicode version I'm using? 244=head2 How do I know which rxvt-unicode version I'm using?
115 245
116The version number is displayed with the usage (-h). Also the escape 246The version number is displayed with the usage (-h). Also the escape
117sequence C<ESC [ 8 n> sets the window title to the version number. When 247sequence C<ESC [ 8 n> sets the window title to the version number. When
118using the @@RXVT_NAME@@c client, the version displayed is that of the 248using the @@RXVT_NAME@@c client, the version displayed is that of the
119daemon. 249daemon.
120 250
121=item I am using Debian GNU/Linux and have a problem... 251=head2 I am using Debian GNU/Linux and have a problem...
122 252
123The Debian GNU/Linux package of rxvt-unicode in sarge contains large 253The Debian GNU/Linux package of rxvt-unicode in sarge contains large
124patches that considerably change the behaviour of rxvt-unicode. Before 254patches that considerably change the behaviour of rxvt-unicode (but
125reporting a bug to the original rxvt-unicode author please download and 255unfortunately this notice has been removed). Before reporting a bug to
126install the genuine version (L<http://software.schmorp.de#rxvt-unicode>) 256the original rxvt-unicode author please download and install the genuine
127and try to reproduce the problem. If you cannot, chances are that the 257version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
128problems are specific to Debian GNU/Linux, in which case it should be 258the problem. If you cannot, chances are that the problems are specific to
129reported via the Debian Bug Tracking System (use C<reportbug> to report 259Debian GNU/Linux, in which case it should be reported via the Debian Bug
130the bug). 260Tracking System (use C<reportbug> to report the bug).
131 261
132For other problems that also affect the Debian package, you can and 262For other problems that also affect the Debian package, you can and
133probably should use the Debian BTS, too, because, after all, it's also a 263probably should use the Debian BTS, too, because, after all, it's also a
134bug in the Debian version and it serves as a reminder for other users that 264bug in the Debian version and it serves as a reminder for other users that
135might encounter the same issue. 265might encounter the same issue.
136 266
137=item I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation? 267=head2 I am maintaining rxvt-unicode for distribution/OS XXX, any
268recommendation?
138 269
139You should build one binary with the default options. F<configure> 270You should build one binary with the default options. F<configure>
140now enables most useful options, and the trend goes to making them 271now enables most useful options, and the trend goes to making them
141runtime-switchable, too, so there is usually no drawback to enbaling them, 272runtime-switchable, too, so there is usually no drawback to enbaling them,
142except higher disk and possibly memory usage. The perl interpreter should 273except higher disk and possibly memory usage. The perl interpreter should
… …
152If you can/want build more binaries, I recommend building a minimal 283If you can/want build more binaries, I recommend building a minimal
153one with C<--disable-everything> (very useful) and a maximal one with 284one with C<--disable-everything> (very useful) and a maximal one with
154C<--enable-everything> (less useful, it will be very big due to a lot of 285C<--enable-everything> (less useful, it will be very big due to a lot of
155encodings built-in that increase download times and are rarely used). 286encodings built-in that increase download times and are rarely used).
156 287
157=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe? 288=head2 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
158 289
159Likely not. While I honestly try to make it secure, and am probably not 290It should be, starting with release 7.1. You are encouraged to properly
160bad at it, I think it is simply unreasonable to expect all of freetype 291install urxvt with privileges necessary for your OS now.
161+ fontconfig + xft + xlib + perl + ... + rxvt-unicode itself to all be
162secure. Also, rxvt-unicode disables some options when it detects that it
163runs setuid or setgid, which is not nice. Besides, with the embedded perl
164interpreter the possibility for security problems easily multiplies.
165 292
166Elevated privileges are only required for utmp and pty operations on some 293When rxvt-unicode detects that it runs setuid or setgid, it will fork
167systems (for example, GNU/Linux doesn't need any extra privileges for 294into a helper process for privileged operations (pty handling on some
168ptys, but some need it for utmp support). It is planned to mvoe this into 295systems, utmp/wtmp/lastlog handling on others) and drop privileges
169a forked handler process, but this is not yet done. 296immediately. This is much safer than most other terminals that keep
297privileges while running (but is more relevant to urxvt, as it contains
298things as perl interpreters, which might be "helpful" to attackers).
170 299
171So, while setuid/setgid operation is supported and not a problem on your 300This forking is done as the very first within main(), which is very early
172typical single-user-no-other-logins unix desktop, always remember that 301and reduces possible bugs to initialisation code run before main(), or
173its an awful lot of code, most of which isn't checked for security issues 302things like the dynamic loader of your system, which should result in very
174regularly. 303little risk.
175 304
176=item When I log-in to another system it tells me about missing terminfo data? 305=head2 When I log-in to another system it tells me about missing terminfo data?
177 306
178The terminal description used by rxvt-unicode is not as widely available 307The terminal description used by rxvt-unicode is not as widely available
179as that for xterm, or even rxvt (for which the same problem often arises). 308as that for xterm, or even rxvt (for which the same problem often arises).
180 309
181The correct solution for this problem is to install the terminfo, this can 310The correct solution for this problem is to install the terminfo, this can
… …
199 URxvt.termName: rxvt 328 URxvt.termName: rxvt
200 329
201If you don't plan to use B<rxvt> (quite common...) you could also replace 330If you don't plan to use B<rxvt> (quite common...) you could also replace
202the rxvt terminfo file with the rxvt-unicode one. 331the rxvt terminfo file with the rxvt-unicode one.
203 332
204=item C<tic> outputs some error when compiling the terminfo entry. 333=head2 C<tic> outputs some error when compiling the terminfo entry.
205 334
206Most likely it's the empty definition for C<enacs=>. Just replace it by 335Most likely it's the empty definition for C<enacs=>. Just replace it by
207C<enacs=\E[0@> and try again. 336C<enacs=\E[0@> and try again.
208 337
209=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@. 338=head2 C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
210 339
340See next entry.
341
211=item I need a termcap file entry. 342=head2 I need a termcap file entry.
212 343
213One reason you might want this is that some distributions or operating 344One reason you might want this is that some distributions or operating
214systems still compile some programs using the long-obsoleted termcap 345systems still compile some programs using the long-obsoleted termcap
215library (Fedora Core's bash is one example) and rely on a termcap entry 346library (Fedora Core's bash is one example) and rely on a termcap entry
216for C<rxvt-unicode>. 347for C<rxvt-unicode>.
… …
242 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\ 373 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
243 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\ 374 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
244 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\ 375 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
245 :vs=\E[?25h: 376 :vs=\E[?25h:
246 377
247=item Why does C<ls> no longer have coloured output? 378=head2 Why does C<ls> no longer have coloured output?
248 379
249The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to 380The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
250decide wether a terminal has colour, but uses it's own configuration 381decide wether a terminal has colour, but uses it's own configuration
251file. Needless to say, C<rxvt-unicode> is not in it's default file (among 382file. Needless to say, C<rxvt-unicode> is not in it's default file (among
252with most other terminals supporting colour). Either add: 383with most other terminals supporting colour). Either add:
… …
257 388
258 alias ls='ls --color=auto' 389 alias ls='ls --color=auto'
259 390
260to your C<.profile> or C<.bashrc>. 391to your C<.profile> or C<.bashrc>.
261 392
262=item Why doesn't vim/emacs etc. use the 88 colour mode? 393=head2 Why doesn't vim/emacs etc. use the 88 colour mode?
263 394
395See next entry.
396
264=item Why doesn't vim/emacs etc. make use of italic? 397=head2 Why doesn't vim/emacs etc. make use of italic?
265 398
399See next entry.
400
266=item Why are the secondary screen-related options not working properly? 401=head2 Why are the secondary screen-related options not working properly?
267 402
268Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged 403Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
269distributions (most notably Debian GNU/Linux) break rxvt-unicode 404distributions (most notably Debian GNU/Linux) break rxvt-unicode
270by setting C<TERM> to C<rxvt>, which doesn't have these extra 405by setting C<TERM> to C<rxvt>, which doesn't have these extra
271features. Unfortunately, some of these (most notably, again, Debian 406features. Unfortunately, some of these (most notably, again, Debian
272GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo 407GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
273file, so you will need to install it on your own (See the question B<When 408file, so you will need to install it on your own (See the question B<When
274I log-in to another system it tells me about missing terminfo data?> on 409I log-in to another system it tells me about missing terminfo data?> on
275how to do this). 410how to do this).
276 411
277=item My numerical keypad acts weird and generates differing output? 412=head2 My numerical keypad acts weird and generates differing output?
278 413
279Some Debian GNUL/Linux users seem to have this problem, although no 414Some Debian GNUL/Linux users seem to have this problem, although no
280specific details were reported so far. It is possible that this is caused 415specific details were reported so far. It is possible that this is caused
281by the wrong C<TERM> setting, although the details of wether and how 416by the wrong C<TERM> setting, although the details of wether and how
282this can happen are unknown, as C<TERM=rxvt> should offer a compatible 417this can happen are unknown, as C<TERM=rxvt> should offer a compatible
283keymap. See the answer to the previous question, and please report if that 418keymap. See the answer to the previous question, and please report if that
284helped. 419helped.
285 420
286=item Rxvt-unicode does not seem to understand the selected encoding? 421=head2 Rxvt-unicode does not seem to understand the selected encoding?
287 422
423See next entry.
424
288=item Unicode does not seem to work? 425=head2 Unicode does not seem to work?
289 426
290If you encounter strange problems like typing an accented character but 427If you encounter strange problems like typing an accented character but
291getting two unrelated other characters or similar, or if program output is 428getting two unrelated other characters or similar, or if program output is
292subtly garbled, then you should check your locale settings. 429subtly garbled, then you should check your locale settings.
293 430
… …
313 450
314If nothing works and you are sure that everything is set correctly then 451If nothing works and you are sure that everything is set correctly then
315you will need to remember a little known fact: Some programs just don't 452you will need to remember a little known fact: Some programs just don't
316support locales :( 453support locales :(
317 454
318=item Why do some characters look so much different than others? 455=head2 Why do some characters look so much different than others?
319 456
457See next entry.
458
320=item How does rxvt-unicode choose fonts? 459=head2 How does rxvt-unicode choose fonts?
321 460
322Most fonts do not contain the full range of Unicode, which is 461Most fonts do not contain the full range of Unicode, which is
323fine. Chances are that the font you (or the admin/package maintainer of 462fine. Chances are that the font you (or the admin/package maintainer of
324your system/os) have specified does not cover all the characters you want 463your system/os) have specified does not cover all the characters you want
325to display. 464to display.
… …
343 482
344The only limitation is that none of the fonts may be larger than the base 483The only limitation is that none of the fonts may be larger than the base
345font, as the base font defines the terminal character cell size, which 484font, as the base font defines the terminal character cell size, which
346must be the same due to the way terminals work. 485must be the same due to the way terminals work.
347 486
348=item Why do some chinese characters look so different than others? 487=head2 Why do some chinese characters look so different than others?
349 488
350This is because there is a difference between script and language -- 489This is because there is a difference between script and language --
351rxvt-unicode does not know which language the text that is output is, 490rxvt-unicode does not know which language the text that is output is,
352as it only knows the unicode character codes. If rxvt-unicode first 491as it only knows the unicode character codes. If rxvt-unicode first
353sees a japanese/chinese character, it might choose a japanese font for 492sees a japanese/chinese character, it might choose a japanese font for
… …
368has been designed yet). 507has been designed yet).
369 508
370Until then, you might get away with switching fonts at runtime (see L<Can 509Until then, you might get away with switching fonts at runtime (see L<Can
371I switch the fonts at runtime?> later in this document). 510I switch the fonts at runtime?> later in this document).
372 511
373=item Why does rxvt-unicode sometimes leave pixel droppings? 512=head2 Why does rxvt-unicode sometimes leave pixel droppings?
374 513
375Most fonts were not designed for terminal use, which means that character 514Most fonts were not designed for terminal use, which means that character
376size varies a lot. A font that is otherwise fine for terminal use might 515size varies a lot. A font that is otherwise fine for terminal use might
377contain some characters that are simply too wide. Rxvt-unicode will avoid 516contain some characters that are simply too wide. Rxvt-unicode will avoid
378these characters. For characters that are just "a bit" too wide a special 517these characters. For characters that are just "a bit" too wide a special
… …
390might be forced to use a different font. 529might be forced to use a different font.
391 530
392All of this is not a problem when using X11 core fonts, as their bounding 531All of this is not a problem when using X11 core fonts, as their bounding
393box data is correct. 532box data is correct.
394 533
395=item On Solaris 9, many line-drawing characters are too wide. 534=head2 On Solaris 9, many line-drawing characters are too wide.
396 535
397Seems to be a known bug, read 536Seems to be a known bug, read
398L<http://nixdoc.net/files/forum/about34198.html>. Some people use the 537L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
399following ugly workaround to get non-double-wide-characters working: 538following ugly workaround to get non-double-wide-characters working:
400 539
401 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x) 540 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
402 541
403=item My Compose (Multi_key) key is no longer working. 542=head2 My Compose (Multi_key) key is no longer working.
404 543
405The most common causes for this are that either your locale is not set 544The most common causes for this are that either your locale is not set
406correctly, or you specified a B<preeditStyle> that is not supported by 545correctly, or you specified a B<preeditStyle> that is not supported by
407your input method. For example, if you specified B<OverTheSpot> and 546your input method. For example, if you specified B<OverTheSpot> and
408your input method (e.g. the default input method handling Compose keys) 547your input method (e.g. the default input method handling Compose keys)
… …
410rxvt-unicode will continue without an input method. 549rxvt-unicode will continue without an input method.
411 550
412In this case either do not specify a B<preeditStyle> or specify more than 551In this case either do not specify a B<preeditStyle> or specify more than
413one pre-edit style, such as B<OverTheSpot,Root,None>. 552one pre-edit style, such as B<OverTheSpot,Root,None>.
414 553
415=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755 554=head2 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
416 555
417Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on 556Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
418international keyboards) or simply use ISO 14755 support to your 557international keyboards) or simply use ISO 14755 support to your
419advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other 558advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
420codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape 559codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
421character and so on. 560character and so on.
422 561
423=item How can I keep rxvt-unicode from using reverse video so much? 562=head2 How can I keep rxvt-unicode from using reverse video so much?
424 563
425First of all, make sure you are running with the right terminal settings 564First of all, make sure you are running with the right terminal settings
426(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then 565(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
427make sure you have specified colours for italic and bold, as otherwise 566make sure you have specified colours for italic and bold, as otherwise
428rxvt-unicode might use reverse video to simulate the effect: 567rxvt-unicode might use reverse video to simulate the effect:
429 568
430 URxvt.colorBD: white 569 URxvt.colorBD: white
431 URxvt.colorIT: green 570 URxvt.colorIT: green
432 571
433=item Some programs assume totally weird colours (red instead of blue), how can I fix that? 572=head2 Some programs assume totally weird colours (red instead of blue), how can I fix that?
434 573
435For some unexplainable reason, some rare programs assume a very weird 574For some unexplainable reason, some rare programs assume a very weird
436colour palette when confronted with a terminal with more than the standard 575colour palette when confronted with a terminal with more than the standard
4378 colours (rxvt-unicode supports 88). The right fix is, of course, to fix 5768 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
438these programs not to assume non-ISO colours without very good reasons. 577these programs not to assume non-ISO colours without very good reasons.
439 578
440In the meantime, you can either edit your C<rxvt-unicode> terminfo 579In the meantime, you can either edit your C<rxvt-unicode> terminfo
441definition to only claim 8 colour support or use C<TERM=rxvt>, which will 580definition to only claim 8 colour support or use C<TERM=rxvt>, which will
442fix colours but keep you from using other rxvt-unicode features. 581fix colours but keep you from using other rxvt-unicode features.
443 582
444=item I am on FreeBSD and rxvt-unicode does not seem to work at all. 583=head2 I am on FreeBSD and rxvt-unicode does not seem to work at all.
445 584
446Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 585Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
447in your compile environment, or an implementation that implements it, 586in your compile environment, or an implementation that implements it,
448wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that 587wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
449B<wchar_t> is represented as unicode. 588B<wchar_t> is represented as unicode.
… …
471 610
472The rxvt-unicode author insists that the right way to fix this is in the 611The rxvt-unicode author insists that the right way to fix this is in the
473system libraries once and for all, instead of forcing every app to carry 612system libraries once and for all, instead of forcing every app to carry
474complete replacements for them :) 613complete replacements for them :)
475 614
476=item I use Solaris 9 and it doesn't compile/work/etc. 615=head2 I use Solaris 9 and it doesn't compile/work/etc.
477 616
478Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst 617Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
479problems with C<wcwidth> and a compile problem. 618problems with C<wcwidth> and a compile problem.
480 619
481=item How can I use rxvt-unicode under cygwin? 620=head2 How can I use rxvt-unicode under cygwin?
482 621
483rxvt-unicode should compile and run out of the box on cygwin, using 622rxvt-unicode should compile and run out of the box on cygwin, using
484the X11 libraries that come with cygwin. libW11 emulation is no 623the X11 libraries that come with cygwin. libW11 emulation is no
485longer supported (and makes no sense, either, as it only supported a 624longer supported (and makes no sense, either, as it only supported a
486single font). I recommend starting the X-server in C<-multiwindow> or 625single font). I recommend starting the X-server in C<-multiwindow> or
… …
489 628
490At the time of this writing, cygwin didn't seem to support any multi-byte 629At the time of this writing, cygwin didn't seem to support any multi-byte
491encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited 630encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
492to 8-bit encodings. 631to 8-bit encodings.
493 632
494=item How does rxvt-unicode determine the encoding to use? 633=head2 How does rxvt-unicode determine the encoding to use?
495 634
635See next entry.
636
496=item Is there an option to switch encodings? 637=head2 Is there an option to switch encodings?
497 638
498Unlike some other terminals, rxvt-unicode has no encoding switch, and no 639Unlike some other terminals, rxvt-unicode has no encoding switch, and no
499specific "utf-8" mode, such as xterm. In fact, it doesn't even know about 640specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
500UTF-8 or any other encodings with respect to terminal I/O. 641UTF-8 or any other encodings with respect to terminal I/O.
501 642
… …
526rxvt-unicode. 667rxvt-unicode.
527 668
528If you want to use a specific encoding you have to make sure you start 669If you want to use a specific encoding you have to make sure you start
529rxvt-unicode with the correct C<LC_CTYPE> category. 670rxvt-unicode with the correct C<LC_CTYPE> category.
530 671
531=item Can I switch locales at runtime? 672=head2 Can I switch locales at runtime?
532 673
533Yes, using an escape sequence. Try something like this, which sets 674Yes, using an escape sequence. Try something like this, which sets
534rxvt-unicode's idea of C<LC_CTYPE>. 675rxvt-unicode's idea of C<LC_CTYPE>.
535 676
536 printf '\e]701;%s\007' ja_JP.SJIS 677 printf '\e]701;%s\007' ja_JP.SJIS
… …
548 689
549You can also use xterm's C<luit> program, which usually works fine, except 690You can also use xterm's C<luit> program, which usually works fine, except
550for some locales where character width differs between program- and 691for some locales where character width differs between program- and
551rxvt-unicode-locales. 692rxvt-unicode-locales.
552 693
553=item Can I switch the fonts at runtime? 694=head2 Can I switch the fonts at runtime?
554 695
555Yes, using an escape sequence. Try something like this, which has the same 696Yes, using an escape sequence. Try something like this, which has the same
556effect as using the C<-fn> switch, and takes effect immediately: 697effect as using the C<-fn> switch, and takes effect immediately:
557 698
558 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic" 699 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
… …
561japanese font), but you have to switch to chinese temporarily, where 702japanese font), but you have to switch to chinese temporarily, where
562japanese fonts would only be in your way. 703japanese fonts would only be in your way.
563 704
564You can think of this as a kind of manual ISO-2022 switching. 705You can think of this as a kind of manual ISO-2022 switching.
565 706
566=item Why do italic characters look as if clipped? 707=head2 Why do italic characters look as if clipped?
567 708
568Many fonts have difficulties with italic characters and hinting. For 709Many fonts have difficulties with italic characters and hinting. For
569example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans 710example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
570Mono> completely fails in it's italic face. A workaround might be to 711Mono> completely fails in it's italic face. A workaround might be to
571enable freetype autohinting, i.e. like this: 712enable freetype autohinting, i.e. like this:
572 713
573 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true 714 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
574 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true 715 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
575 716
576=item My input method wants <some encoding> but I want UTF-8, what can I do? 717=head2 My input method wants <some encoding> but I want UTF-8, what can I do?
577 718
578You can specify separate locales for the input method and the rest of the 719You can specify separate locales for the input method and the rest of the
579terminal, using the resource C<imlocale>: 720terminal, using the resource C<imlocale>:
580 721
581 URxvt*imlocale: ja_JP.EUC-JP 722 URxvt.imlocale: ja_JP.EUC-JP
582 723
583Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still 724Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
584use your input method. Please note, however, that you will not be able to 725use your input method. Please note, however, that you will not be able to
585input characters outside C<EUC-JP> in a normal way then, as your input 726input characters outside C<EUC-JP> in a normal way then, as your input
586method limits you. 727method limits you.
587 728
588=item Rxvt-unicode crashes when the X Input Method changes or exits. 729=head2 Rxvt-unicode crashes when the X Input Method changes or exits.
589 730
590Unfortunately, this is unavoidable, as the XIM protocol is racy by 731Unfortunately, this is unavoidable, as the XIM protocol is racy by
591design. Applications can avoid some crashes at the expense of memory 732design. Applications can avoid some crashes at the expense of memory
592leaks, and Input Methods can avoid some crashes by careful ordering at 733leaks, and Input Methods can avoid some crashes by careful ordering at
593exit time. B<kinput2> (and derived input methods) generally succeeds, 734exit time. B<kinput2> (and derived input methods) generally succeeds,
594while B<SCIM> (or similar input methods) fails. In the end, however, 735while B<SCIM> (or similar input methods) fails. In the end, however,
595crashes cannot be completely avoided even if both sides cooperate. 736crashes cannot be completely avoided even if both sides cooperate.
596 737
597So the only workaround is not to kill your Input Method Servers. 738So the only workaround is not to kill your Input Method Servers.
598 739
599=item Rxvt-unicode uses gobs of memory, how can I reduce that? 740=head2 Rxvt-unicode uses gobs of memory, how can I reduce that?
600 741
601Rxvt-unicode tries to obey the rule of not charging you for something you 742Rxvt-unicode tries to obey the rule of not charging you for something you
602don't use. One thing you should try is to configure out all settings that 743don't use. One thing you should try is to configure out all settings that
603you don't need, for example, Xft support is a resource hog by design, 744you don't need, for example, Xft support is a resource hog by design,
604when used. Compiling it out ensures that no Xft font will be loaded 745when used. Compiling it out ensures that no Xft font will be loaded
… …
6096 bytes per screen cell. For a 160x?? window this amounts to almost a 7506 bytes per screen cell. For a 160x?? window this amounts to almost a
610kilobyte per line. A scrollback buffer of 10000 lines will then (if full) 751kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
611use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as 752use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
612rxvt-unicode then uses 8 bytes per screen cell. 753rxvt-unicode then uses 8 bytes per screen cell.
613 754
614=item Can I speed up Xft rendering somehow? 755=head2 Can I speed up Xft rendering somehow?
615 756
616Yes, the most obvious way to speed it up is to avoid Xft entirely, as 757Yes, the most obvious way to speed it up is to avoid Xft entirely, as
617it is simply slow. If you still want Xft fonts you might try to disable 758it is simply slow. If you still want Xft fonts you might try to disable
618antialiasing (by appending C<:antialias=false>), which saves lots of 759antialiasing (by appending C<:antialias=false>), which saves lots of
619memory and also speeds up rendering considerably. 760memory and also speeds up rendering considerably.
620 761
621=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 762=head2 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
622 763
623Rxvt-unicode will use whatever you specify as a font. If it needs to 764Rxvt-unicode will use whatever you specify as a font. If it needs to
624fall back to it's default font search list it will prefer X11 core 765fall back to it's default font search list it will prefer X11 core
625fonts, because they are small and fast, and then use Xft fonts. It has 766fonts, because they are small and fast, and then use Xft fonts. It has
626antialiasing disabled for most of them, because the author thinks they 767antialiasing disabled for most of them, because the author thinks they
627look best that way. 768look best that way.
628 769
629If you want antialiasing, you have to specify the fonts manually. 770If you want antialiasing, you have to specify the fonts manually.
630 771
631=item Mouse cut/paste suddenly no longer works. 772=head2 Mouse cut/paste suddenly no longer works.
632 773
633Make sure that mouse reporting is actually turned off since killing 774Make sure that mouse reporting is actually turned off since killing
634some editors prematurely may leave the mouse in mouse report mode. I've 775some editors prematurely may leave the mouse in mouse report mode. I've
635heard that tcsh may use mouse reporting unless it otherwise specified. A 776heard that tcsh may use mouse reporting unless it otherwise specified. A
636quick check is to see if cut/paste works when the Alt or Shift keys are 777quick check is to see if cut/paste works when the Alt or Shift keys are
637depressed. See @@RXVT_NAME@@(7) 778depressed.
638 779
639=item What's with this bold/blink stuff? 780=head2 What's with this bold/blink stuff?
640 781
641If no bold colour is set via C<colorBD:>, bold will invert text using the 782If no bold colour is set via C<colorBD:>, bold will invert text using the
642standard foreground colour. 783standard foreground colour.
643 784
644For the standard background colour, blinking will actually make the 785For the standard background colour, blinking will actually make the
… …
651 792
652color0-7 are the low-intensity colors. 793color0-7 are the low-intensity colors.
653 794
654color8-15 are the corresponding high-intensity colors. 795color8-15 are the corresponding high-intensity colors.
655 796
656=item I don't like the screen colors. How do I change them? 797=head2 I don't like the screen colors. How do I change them?
657 798
658You can change the screen colors at run-time using F<~/.Xdefaults> 799You can change the screen colors at run-time using F<~/.Xdefaults>
659resources (or as long-options). 800resources (or as long-options).
660 801
661Here are values that are supposed to resemble a VGA screen, 802Here are values that are supposed to resemble a VGA screen,
… …
699 URxvt.color6: #73f7ff 840 URxvt.color6: #73f7ff
700 URxvt.color14: #73f7ff 841 URxvt.color14: #73f7ff
701 URxvt.color7: #e1dddd 842 URxvt.color7: #e1dddd
702 URxvt.color15: #e1dddd 843 URxvt.color15: #e1dddd
703 844
704=item How can I start @@RXVT_NAME@@d in a race-free way? 845=head2 How can I start @@RXVT_NAME@@d in a race-free way?
705 846
706Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the 847Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the
707display, create the listening socket and then fork. 848display, create the listening socket and then fork.
708 849
709=item What's with the strange Backspace/Delete key behaviour? 850=head2 What's with the strange Backspace/Delete key behaviour?
710 851
711Assuming that the physical Backspace key corresponds to the 852Assuming that the physical Backspace key corresponds to the
712BackSpace keysym (not likely for Linux ... see the following 853BackSpace keysym (not likely for Linux ... see the following
713question) there are two standard values that can be used for 854question) there are two standard values that can be used for
714Backspace: C<^H> and C<^?>. 855Backspace: C<^H> and C<^?>.
… …
731 872
732 # use Backspace = ^? 873 # use Backspace = ^?
733 $ stty erase ^? 874 $ stty erase ^?
734 $ @@RXVT_NAME@@ 875 $ @@RXVT_NAME@@
735 876
736Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7). 877Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
737 878
738For an existing rxvt-unicode: 879For an existing rxvt-unicode:
739 880
740 # use Backspace = ^H 881 # use Backspace = ^H
741 $ stty erase ^H 882 $ stty erase ^H
… …
760some editors (vim I'm told) expect Backspace = ^H, 901some editors (vim I'm told) expect Backspace = ^H,
761GNU Emacs (and Emacs-like editors) use ^H for help. 902GNU Emacs (and Emacs-like editors) use ^H for help.
762 903
763Perhaps someday this will all be resolved in a consistent manner. 904Perhaps someday this will all be resolved in a consistent manner.
764 905
765=item I don't like the key-bindings. How do I change them? 906=head2 I don't like the key-bindings. How do I change them?
766 907
767There are some compile-time selections available via configure. Unless 908There are some compile-time selections available via configure. Unless
768you have run "configure" with the C<--disable-resources> option you can 909you have run "configure" with the C<--disable-resources> option you can
769use the `keysym' resource to alter the keystrings associated with keysyms. 910use the `keysym' resource to alter the keystrings associated with keysyms.
770 911
… …
791 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz > 932 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
792 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007 933 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
793 934
794See some more examples in the documentation for the B<keysym> resource. 935See some more examples in the documentation for the B<keysym> resource.
795 936
796=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys. 937=head2 I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
797How do I make use of them? For example, the Sun Keyboard type 4 938How do I make use of them? For example, the Sun Keyboard type 4
798has the following mappings that rxvt-unicode doesn't recognize. 939has the following mappings that rxvt-unicode doesn't recognize.
799 940
800 KP_Insert == Insert 941 KP_Insert == Insert
801 F22 == Print 942 F22 == Print
… …
806 947
807Rather than have rxvt-unicode try to accommodate all the various possible 948Rather than have rxvt-unicode try to accommodate all the various possible
808keyboard mappings, it is better to use `xmodmap' to remap the keys as 949keyboard mappings, it is better to use `xmodmap' to remap the keys as
809required for your particular machine. 950required for your particular machine.
810 951
811=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm? 952=head2 How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
812I need this to decide about setting colors etc. 953I need this to decide about setting colors etc.
813 954
814rxvt and rxvt-unicode always export the variable "COLORTERM", so you can 955rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
815check and see if that is set. Note that several programs, JED, slrn, 956check and see if that is set. Note that several programs, JED, slrn,
816Midnight Commander automatically check this variable to decide whether or 957Midnight Commander automatically check this variable to decide whether or
817not to use color. 958not to use color.
818 959
819=item How do I set the correct, full IP address for the DISPLAY variable? 960=head2 How do I set the correct, full IP address for the DISPLAY variable?
820 961
821If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled 962If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
822insecure mode then it is possible to use the following shell script 963insecure mode then it is possible to use the following shell script
823snippets to correctly set the display. If your version of rxvt-unicode 964snippets to correctly set the display. If your version of rxvt-unicode
824wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then 965wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
… …
839 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string 980 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
840 read DISPLAY # set it in our local shell 981 read DISPLAY # set it in our local shell
841 fi 982 fi
842 fi 983 fi
843 984
844=item How do I compile the manual pages for myself? 985=head2 How do I compile the manual pages for myself?
845 986
846You need to have a recent version of perl installed as F</usr/bin/perl>, 987You need to have a recent version of perl installed as F</usr/bin/perl>,
847one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to 988one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
848the doc subdirectory and enter C<make alldoc>. 989the doc subdirectory and enter C<make alldoc>.
849 990
850=item My question isn't answered here, can I ask a human? 991=head2 My question isn't answered here, can I ask a human?
851 992
852Before sending me mail, you could go to IRC: C<irc.freenode.net>, 993Before sending me mail, you could go to IRC: C<irc.freenode.net>,
853channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be 994channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
854interested in learning about new and exciting problems (but not FAQs :). 995interested in learning about new and exciting problems (but not FAQs :).
855 996
856=back
857
858=head1 RXVT TECHNICAL REFERENCE 997=head1 RXVT TECHNICAL REFERENCE
859 998
860=head1 DESCRIPTION 999=head1 DESCRIPTION
861 1000
862The rest of this document describes various technical aspects of 1001The rest of this document describes various technical aspects of
863B<rxvt-unicode>. First the description of supported command sequences, 1002B<rxvt-unicode>. First the description of supported command sequences,
864followed by menu and pixmap support and last by a description of all 1003followed by pixmap support and last by a description of all features
865features selectable at C<configure> time. 1004selectable at C<configure> time.
866 1005
867=head1 Definitions 1006=head1 Definitions
868 1007
869=over 4 1008=over 4
870 1009
… …
1438 B<< C<h> >> Send Mouse X & Y on button press. 1577 B<< C<h> >> Send Mouse X & Y on button press.
1439 B<< C<l> >> No mouse reporting. 1578 B<< C<l> >> No mouse reporting.
1440 1579
1441=end table 1580=end table
1442 1581
1443=item B<< C<Ps = 10> >> (B<rxvt>)
1444
1445=begin table
1446
1447 B<< C<h> >> menuBar visible
1448 B<< C<l> >> menuBar invisible
1449
1450=end table
1451
1452=item B<< C<Ps = 25> >> 1582=item B<< C<Ps = 25> >>
1453 1583
1454=begin table 1584=begin table
1455 1585
1456 B<< C<h> >> Visible cursor {cnorm/cvvis} 1586 B<< C<h> >> Visible cursor {cnorm/cvvis}
… …
1638 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 1768 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1639 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 1769 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1640 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 1770 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1641 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706] 1771 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1642 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707] 1772 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1643 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 1773 B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM).
1644 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. 1774 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1645 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 1775 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1646 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. 1776 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1647 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >> 1777 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >>
1648 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 1778 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1649 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills). 1779 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills).
1650 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar). 1780 B<< C<Ps = 702> >> Request version if B<< C<Pt> >> is B<< C<?> >>, returning C<rxvt-unicode>, the resource name, the major and minor version numbers, e.g. C<ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST>.
1651 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 1781 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1652 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency). 1782 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1653 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >> 1783 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1654 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >> 1784 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1655 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 1785 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
… …
1662 1792
1663=end table 1793=end table
1664 1794
1665=back 1795=back
1666 1796
1667X<menuBar>
1668
1669=head1 menuBar
1670
1671B<< The exact syntax used is I<almost> solidified. >>
1672In the menus, B<DON'T> try to use menuBar commands that add or remove a
1673menuBar.
1674
1675Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1676omitted: use B<./> to specify a menu relative to the current menu.
1677
1678=head2 Overview of menuBar operation
1679
1680For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1681of C<Pt> can be used for a variety of tasks:
1682
1683At the top level is the current menuBar which is a member of a circular
1684linked-list of other such menuBars.
1685
1686The menuBar acts as a parent for the various drop-down menus, which in
1687turn, may have labels, separator lines, menuItems and subMenus.
1688
1689The menuItems are the useful bits: you can use them to mimic keyboard
1690input or even to send text or escape sequences back to rxvt.
1691
1692The menuBar syntax is intended to provide a simple yet robust method of
1693constructing and manipulating menus and navigating through the
1694menuBars.
1695
1696The first step is to use the tag B<< [menu:I<name>] >> which creates
1697the menuBar called I<name> and allows access. You may now or menus,
1698subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1699menuBar access as B<readonly> to prevent accidental corruption of the
1700menus. To re-access the current menuBar for alterations, use the tag
1701B<[menu]>, make the alterations and then use B<[done]>
1702
1703X<menuBarCommands>
1704
1705=head2 Commands
1706
1707=over 4
1708
1709=item B<< [menu:+I<name>] >>
1710
1711access the named menuBar for creation or alteration. If a new menuBar
1712is created, it is called I<name> (max of 15 chars) and the current
1713menuBar is pushed onto the stack
1714
1715=item B<[menu]>
1716
1717access the current menuBar for alteration
1718
1719=item B<< [title:+I<string>] >>
1720
1721set the current menuBar's title to I<string>, which may contain the
1722following format specifiers:
1723
1724 B<%n> rxvt name (as per the B<-name> command-line option)
1725 B<%v> rxvt version
1726 B<%%> literal B<%> character
1727
1728=item B<[done]>
1729
1730set menuBar access as B<readonly>.
1731End-of-file tag for B<< [read:+I<file>] >> operations.
1732
1733=item B<< [read:+I<file>] >>
1734
1735read menu commands directly from I<file> (extension ".menu" will be
1736appended if required.) Start reading at a line with B<[menu]> or B<<
1737[menu:+I<name> >> and continuing until B<[done]> is encountered.
1738
1739Blank and comment lines (starting with B<#>) are ignored. Actually,
1740since any invalid menu commands are also ignored, almost anything could
1741be construed as a comment line, but this may be tightened up in the
1742future ... so don't count on it!.
1743
1744=item B<< [read:+I<file>;+I<name>] >>
1745
1746The same as B<< [read:+I<file>] >>, but start reading at a line with
1747B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1748B<[done]> is encountered.
1749
1750=item B<[dump]>
1751
1752dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1753later rereading.
1754
1755=item B<[rm:name]>
1756
1757remove the named menuBar
1758
1759=item B<[rm] [rm:]>
1760
1761remove the current menuBar
1762
1763=item B<[rm*] [rm:*]>
1764
1765remove all menuBars
1766
1767=item B<[swap]>
1768
1769swap the top two menuBars
1770
1771=item B<[prev]>
1772
1773access the previous menuBar
1774
1775=item B<[next]>
1776
1777access the next menuBar
1778
1779=item B<[show]>
1780
1781Enable display of the menuBar
1782
1783=item B<[hide]>
1784
1785Disable display of the menuBar
1786
1787=item B<< [pixmap:+I<name>] >>
1788
1789=item B<< [pixmap:+I<name>;I<scaling>] >>
1790
1791(set the background pixmap globally
1792
1793B<< A Future implementation I<may> make this local to the menubar >>)
1794
1795=item B<< [:+I<command>:] >>
1796
1797ignore the menu readonly status and issue a I<command> to or a menu or
1798menuitem or change the ; a useful shortcut for setting the quick arrows
1799from a menuBar.
1800
1801=back
1802
1803X<menuBarAdd>
1804
1805=head2 Adding and accessing menus
1806
1807The following commands may also be B<+> prefixed.
1808
1809=over 4
1810
1811=item B</+>
1812
1813access menuBar top level
1814
1815=item B<./+>
1816
1817access current menu level
1818
1819=item B<../+>
1820
1821access parent menu (1 level up)
1822
1823=item B<../../>
1824
1825access parent menu (multiple levels up)
1826
1827=item B<< I</path/>menu >>
1828
1829add/access menu
1830
1831=item B<< I</path/>menu/* >>
1832
1833add/access menu and clear it if it exists
1834
1835=item B<< I</path/>{-} >>
1836
1837add separator
1838
1839=item B<< I</path/>{item} >>
1840
1841add B<item> as a label
1842
1843=item B<< I</path/>{item} action >>
1844
1845add/alter I<menuitem> with an associated I<action>
1846
1847=item B<< I</path/>{item}{right-text} >>
1848
1849add/alter I<menuitem> with B<right-text> as the right-justified text
1850and as the associated I<action>
1851
1852=item B<< I</path/>{item}{rtext} action >>
1853
1854add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1855the right-justified text.
1856
1857=back
1858
1859=over 4
1860
1861=item Special characters in I<action> must be backslash-escaped:
1862
1863B<\a \b \E \e \n \r \t \octal>
1864
1865=item or in control-character notation:
1866
1867B<^@, ^A .. ^Z .. ^_, ^?>
1868
1869=back
1870
1871To send a string starting with a B<NUL> (B<^@>) character to the
1872program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1873the first of which will be stripped off and the balance directed to the
1874program. Otherwise if I<action> begins with B<NUL> followed by
1875non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1876balance is sent back to rxvt.
1877
1878As a convenience for the many Emacs-type editors, I<action> may start
1879with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1880appended if missed from B<M-x> commands.
1881
1882As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1883quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1884
1885=over 4
1886
1887=item For example,
1888
1889B<M-xapropos> is equivalent to B<\Exapropos\r>
1890
1891=item and
1892
1893B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1894
1895=back
1896
1897The option B<< {I<right-rtext>} >> will be right-justified. In the
1898absence of a specified action, this text will be used as the I<action>
1899as well.
1900
1901=over 4
1902
1903=item For example,
1904
1905B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1906
1907=back
1908
1909The left label I<is> necessary, since it's used for matching, but
1910implicitly hiding the left label (by using same name for both left and
1911right labels), or explicitly hiding the left label (by preceeding it
1912with a dot), makes it possible to have right-justified text only.
1913
1914=over 4
1915
1916=item For example,
1917
1918B</File/{Open}{Open} Open-File-Action>
1919
1920=item or hiding it
1921
1922B</File/{.anylabel}{Open} Open-File-Action>
1923
1924=back
1925
1926X<menuBarRemove>
1927
1928=head2 Removing menus
1929
1930=over 4
1931
1932=item B<< -/*+ >>
1933
1934remove all menus from the menuBar, the same as B<[clear]>
1935
1936=item B<< -+I</path>menu+ >>
1937
1938remove menu
1939
1940=item B<< -+I</path>{item}+ >>
1941
1942remove item
1943
1944=item B<< -+I</path>{-} >>
1945
1946remove separator)
1947
1948=item B<-/path/menu/*>
1949
1950remove all items, separators and submenus from menu
1951
1952=back
1953
1954X<menuBarArrows>
1955
1956=head2 Quick Arrows
1957
1958The menus also provide a hook for I<quick arrows> to provide easier
1959user access. If nothing has been explicitly set, the default is to
1960emulate the curror keys. The syntax permits each arrow to be altered
1961individually or all four at once without re-entering their common
1962beginning/end text. For example, to explicitly associate cursor actions
1963with the arrows, any of the following forms could be used:
1964
1965=over 4
1966
1967=item B<< <r>+I<Right> >>
1968
1969=item B<< <l>+I<Left> >>
1970
1971=item B<< <u>+I<Up> >>
1972
1973=item B<< <d>+I<Down> >>
1974
1975Define actions for the respective arrow buttons
1976
1977=item B<< <b>+I<Begin> >>
1978
1979=item B<< <e>+I<End> >>
1980
1981Define common beginning/end parts for I<quick arrows> which used in
1982conjunction with the above <r> <l> <u> <d> constructs
1983
1984=back
1985
1986=over 4
1987
1988=item For example, define arrows individually,
1989
1990 <u>\E[A
1991
1992 <d>\E[B
1993
1994 <r>\E[C
1995
1996 <l>\E[D
1997
1998=item or all at once
1999
2000 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
2001
2002=item or more compactly (factoring out common parts)
2003
2004 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
2005
2006=back
2007
2008X<menuBarSummary>
2009
2010=head2 Command Summary
2011
2012A short summary of the most I<common> commands:
2013
2014=over 4
2015
2016=item [menu:name]
2017
2018use an existing named menuBar or start a new one
2019
2020=item [menu]
2021
2022use the current menuBar
2023
2024=item [title:string]
2025
2026set menuBar title
2027
2028=item [done]
2029
2030set menu access to readonly and, if reading from a file, signal EOF
2031
2032=item [done:name]
2033
2034if reading from a file using [read:file;name] signal EOF
2035
2036=item [rm:name]
2037
2038remove named menuBar(s)
2039
2040=item [rm] [rm:]
2041
2042remove current menuBar
2043
2044=item [rm*] [rm:*]
2045
2046remove all menuBar(s)
2047
2048=item [swap]
2049
2050swap top two menuBars
2051
2052=item [prev]
2053
2054access the previous menuBar
2055
2056=item [next]
2057
2058access the next menuBar
2059
2060=item [show]
2061
2062map menuBar
2063
2064=item [hide]
2065
2066unmap menuBar
2067
2068=item [pixmap;file]
2069
2070=item [pixmap;file;scaling]
2071
2072set a background pixmap
2073
2074=item [read:file]
2075
2076=item [read:file;name]
2077
2078read in a menu from a file
2079
2080=item [dump]
2081
2082dump out all menuBars to /tmp/rxvt-PID
2083
2084=item /
2085
2086access menuBar top level
2087
2088=item ./
2089
2090=item ../
2091
2092=item ../../
2093
2094access current or parent menu level
2095
2096=item /path/menu
2097
2098add/access menu
2099
2100=item /path/{-}
2101
2102add separator
2103
2104=item /path/{item}{rtext} action
2105
2106add/alter menu item
2107
2108=item -/*
2109
2110remove all menus from the menuBar
2111
2112=item -/path/menu
2113
2114remove menu items, separators and submenus from menu
2115
2116=item -/path/menu
2117
2118remove menu
2119
2120=item -/path/{item}
2121
2122remove item
2123
2124=item -/path/{-}
2125
2126remove separator
2127
2128=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
2129
2130menu quick arrows
2131
2132=back
2133X<XPM> 1797X<XPM>
2134 1798
2135=head1 XPM 1799=head1 XPM
2136 1800
2137For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 1801For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
… …
2384alternative input methods (e.g. kinput2) and will also correctly 2048alternative input methods (e.g. kinput2) and will also correctly
2385set up the input for people using dead keys or compose keys. 2049set up the input for people using dead keys or compose keys.
2386 2050
2387=item --enable-unicode3 (default: off) 2051=item --enable-unicode3 (default: off)
2388 2052
2053Recommended to stay off unless you really need non-BMP characters.
2054
2389Enable direct support for displaying unicode codepoints above 2055Enable direct support for displaying unicode codepoints above
239065535 (the basic multilingual page). This increases storage 205665535 (the basic multilingual page). This increases storage
2391requirements per character from 2 to 4 bytes. X11 fonts do not yet 2057requirements per character from 2 to 4 bytes. X11 fonts do not yet
2392support these extra characters, but Xft does. 2058support these extra characters, but Xft does.
2393 2059
… …
2403composite characters. This is required for proper viewing of text 2069composite characters. This is required for proper viewing of text
2404where accents are encoded as seperate unicode characters. This is 2070where accents are encoded as seperate unicode characters. This is
2405done by using precomposited characters when available or creating 2071done by using precomposited characters when available or creating
2406new pseudo-characters when no precomposed form exists. 2072new pseudo-characters when no precomposed form exists.
2407 2073
2408Without --enable-unicode3, the number of additional precomposed characters 2074Without --enable-unicode3, the number of additional precomposed
2409is rather limited (2048, if this is full, rxvt-unicode will use the 2075characters is somewhat limited (the 6400 private use characters will be
2410private use area, extending the number of combinations to 8448). With
2411--enable-unicode3, no practical limit exists. 2076(ab-)used). With --enable-unicode3, no practical limit exists.
2412 2077
2413This option will also enable storage (but not display) of characters 2078This option will also enable storage (but not display) of characters
2414beyond plane 0 (>65535) when --enable-unicode3 was not specified. 2079beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2415 2080
2416The combining table also contains entries for arabic presentation forms, 2081The combining table also contains entries for arabic presentation forms,
2417but these are not currently used. Bug me if you want these to be used (and 2082but these are not currently used. Bug me if you want these to be used (and
2418tell me how these are to be used...). 2083tell me how these are to be used...).
2419 2084
2420=item --enable-fallback(=CLASS) (default: Rxvt) 2085=item --enable-fallback(=CLASS) (default: Rxvt)
2421 2086
2422When reading resource settings, also read settings for class CLASS. To disable resource fallback use --disable-fallback. 2087When reading resource settings, also read settings for class CLASS. To
2088disable resource fallback use --disable-fallback.
2423 2089
2424=item --with-res-name=NAME (default: urxvt) 2090=item --with-res-name=NAME (default: urxvt)
2425 2091
2426Use the given name as default application name when 2092Use the given name as default application name when
2427reading resources. Specify --with-res-name=rxvt to replace rxvt. 2093reading resources. Specify --with-res-name=rxvt to replace rxvt.
… …
2464 2130
2465=item --enable-tinting (default: on) 2131=item --enable-tinting (default: on)
2466 2132
2467Add support for tinting of transparent backgrounds (requires C<--enable-transparency>). 2133Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2468 2134
2469=item --enable-menubar (default: off) [DEPRECATED]
2470
2471Add support for our menu bar system (this interacts badly with dynamic
2472locale switching currently). This option is DEPRECATED and will be removed
2473in the future.
2474
2475=item --enable-rxvt-scroll (default: on) 2135=item --enable-rxvt-scroll (default: on)
2476 2136
2477Add support for the original rxvt scrollbar. 2137Add support for the original rxvt scrollbar.
2478 2138
2479=item --enable-next-scroll (default: on) 2139=item --enable-next-scroll (default: on)
… …
2488 2148
2489Add support for a very unobtrusive, plain-looking scrollbar that 2149Add support for a very unobtrusive, plain-looking scrollbar that
2490is the favourite of the rxvt-unicode author, having used it for 2150is the favourite of the rxvt-unicode author, having used it for
2491many years. 2151many years.
2492 2152
2493=item --enable-half-shadow (default: off)
2494
2495Make shadows on the scrollbar only half the normal width & height.
2496only applicable to rxvt scrollbars.
2497
2498=item --enable-ttygid (default: off) 2153=item --enable-ttygid (default: off)
2499 2154
2500Change tty device setting to group "tty" - only use this if 2155Change tty device setting to group "tty" - only use this if
2501your system uses this type of security. 2156your system uses this type of security.
2502 2157
… …
2510do it. 2165do it.
2511 2166
2512=item --disable-resources 2167=item --disable-resources
2513 2168
2514Removes any support for resource checking. 2169Removes any support for resource checking.
2515
2516=item --enable-xgetdefault
2517
2518Make resources checking via XGetDefault() instead of our small
2519version which only checks ~/.Xdefaults, or if that doesn't exist then
2520~/.Xresources.
2521
2522Please note that nowadays, things like XIM will automatically pull in and
2523use the full X resource manager, so the overhead of using it might be very
2524small, if nonexistant.
2525
2526=item --enable-strings (default: off)
2527
2528Add support for our possibly faster memset() function and other
2529various routines, overriding your system's versions which may
2530have been hand-crafted in assembly or may require extra libraries
2531to link in. (this breaks ANSI-C rules and has problems on many
2532GNU/Linux systems).
2533 2170
2534=item --disable-swapscreen 2171=item --disable-swapscreen
2535 2172
2536Remove support for secondary/swap screen. 2173Remove support for secondary/swap screen.
2537 2174
… …
2546 2183
2547 MWM-hints 2184 MWM-hints
2548 EWMH-hints (pid, utf8 names) and protocols (ping) 2185 EWMH-hints (pid, utf8 names) and protocols (ping)
2549 seperate underline colour (-underlineColor) 2186 seperate underline colour (-underlineColor)
2550 settable border widths and borderless switch (-w, -b, -bl) 2187 settable border widths and borderless switch (-w, -b, -bl)
2188 visual depth selection (-depth)
2551 settable extra linespacing /-lsp) 2189 settable extra linespacing /-lsp)
2552 iso-14755-2 and -3, and visual feedback 2190 iso-14755-2 and -3, and visual feedback
2553 backindex and forwardindex escape sequence
2554 window op and some xterm/OSC escape sequences
2555 tripleclickwords (-tcw) 2191 tripleclickwords (-tcw)
2556 settable insecure mode (-insecure) 2192 settable insecure mode (-insecure)
2557 keysym remapping support 2193 keysym remapping support
2558 cursor blinking and underline cursor (-cb, -uc) 2194 cursor blinking and underline cursor (-cb, -uc)
2559 XEmbed support (-embed) 2195 XEmbed support (-embed)
2560 user-pty (-pty-fd) 2196 user-pty (-pty-fd)
2561 hold on exit (-hold) 2197 hold on exit (-hold)
2562 skip builtin block graphics (-sbg) 2198 skip builtin block graphics (-sbg)
2199
2200It also enabled some non-essential features otherwise disabled, such as:
2201
2202 some round-trip time optimisations
2203 nearest color allocation on pseudocolor screens
2204 UTF8_STRING supporr for selection
2563 sgr modes 90..97 and 100..107 2205 sgr modes 90..97 and 100..107
2206 backindex and forwardindex escape sequences
2207 view change/zero scorllback esacpe sequences
2208 locale switching escape sequence
2209 window op and some xterm/OSC escape sequences
2210 rectangular selections
2211 trailing space removal for selections
2212 verbose X error handling
2564 2213
2565=item --enable-iso14755 (default: on) 2214=item --enable-iso14755 (default: on)
2566 2215
2567Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2216Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2568F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2217F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
… …
2611 2260
2612=item --enable-pointer-blank (default: on) 2261=item --enable-pointer-blank (default: on)
2613 2262
2614Add support to have the pointer disappear when typing or inactive. 2263Add support to have the pointer disappear when typing or inactive.
2615 2264
2616=item --enable-perl (default: off) 2265=item --enable-perl (default: on)
2617 2266
2618Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2267Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2619manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files 2268manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2620in F<src/perl-ext/> for the extensions that are installed by default. The 2269in F<src/perl-ext/> for the extensions that are installed by default. The
2621perl interpreter that is used can be specified via the C<PERL> environment 2270perl interpreter that is used can be specified via the C<PERL> environment

Diff Legend

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