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

Comparing rxvt-unicode/doc/rxvt.7.man.in (file contents):
Revision 1.43 by root, Thu Jan 12 23:11:23 2006 UTC vs.
Revision 1.66 by root, Tue Jan 31 21:04:14 2006 UTC

127.\} 127.\}
128.rm #[ #] #H #V #F C 128.rm #[ #] #H #V #F C
129.\" ======================================================================== 129.\" ========================================================================
130.\" 130.\"
131.IX Title "rxvt 7" 131.IX Title "rxvt 7"
132.TH rxvt 7 "2006-01-13" "7.0" "RXVT-UNICODE" 132.TH rxvt 7 "2006-01-31" "7.5" "RXVT-UNICODE"
133.SH "NAME" 133.SH "NAME"
134RXVT REFERENCE \- FAQ, command sequences and other background information 134RXVT REFERENCE \- FAQ, command sequences and other background information
135.SH "SYNOPSIS" 135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
137.Vb 2 137.Vb 2
151.SH "DESCRIPTION" 151.SH "DESCRIPTION"
152.IX Header "DESCRIPTION" 152.IX Header "DESCRIPTION"
153This document contains the \s-1FAQ\s0, the \s-1RXVT\s0 \s-1TECHNICAL\s0 \s-1REFERENCE\s0 documenting 153This document contains the \s-1FAQ\s0, the \s-1RXVT\s0 \s-1TECHNICAL\s0 \s-1REFERENCE\s0 documenting
154all escape sequences, and other background information. 154all escape sequences, and other background information.
155.PP 155.PP
156The newest version of this document is 156The newest version of this document is also available on the World Wide Web at
157also available on the World Wide Web at
158<http://cvs.schmorp.de/browse/*checkout*/rxvt\-unicode/doc/rxvt.7.html>. 157<http://cvs.schmorp.de/browse/*checkout*/rxvt\-unicode/doc/rxvt.7.html>.
159.SH "FREQUENTLY ASKED QUESTIONS" 158.SH "RXVT\-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS"
160.IX Header "FREQUENTLY ASKED QUESTIONS" 159.IX Header "RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS"
161.IP "The new selection selects pieces that are too big/too small, can I change this?" 4 160.Sh "Meta, Features & Commandline Issues"
162.IX Item "The new selection selects pieces that are too big/too small, can I change this?" 161.IX Subsection "Meta, Features & Commandline Issues"
163Yes. For example, if you want to select smaller pieces (\*(L"words\*(R") you can 162\fIMy question isn't answered here, can I ask a human?\fR
164use the following resource: 163.IX Subsection "My question isn't answered here, can I ask a human?"
165.Sp 164.PP
165Before sending me mail, you could go to \s-1IRC:\s0 \f(CW\*(C`irc.freenode.net\*(C'\fR,
166channel \f(CW\*(C`#rxvt\-unicode\*(C'\fR has some rxvt-unicode enthusiasts that might be
167interested in learning about new and exciting problems (but not FAQs :).
168.PP
169\fIDoes it support tabs, can I have a tabbed rxvt\-unicode?\fR
170.IX Subsection "Does it support tabs, can I have a tabbed rxvt-unicode?"
171.PP
172Beginning with version 7.3, there is a perl extension that implements a
173simple tabbed terminal. It is installed by default, so any of these should
174give you tabs:
175.PP
166.Vb 1 176.Vb 1
167\& URxvt.selection.pattern-0: ([[:word:]]+) 177\& @@URXVT_NAME@@ -pe tabbed
168.Ve 178.Ve
169.Sp 179.PP
170If you click more than twice, the selection will be extended
171more and more.
172.Sp
173To get a selection that is very similar to the old code, try this pattern:
174.Sp
175.Vb 1 180.Vb 1
176\& URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\e\e\e\e]^`{|})]+) 181\& URxvt.perl-ext-common: default,tabbed
177.Ve 182.Ve
178.IP "I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?" 4 183.PP
179.IX Item "I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?" 184It will also work fine with tabbing functionality of many window managers
180You can disable the perl extension completely by setting the 185or similar tabbing programs, and its embedding-features allow it to be
181\&\fBperl-ext-common\fR resource to the empty string, which also keeps 186embedded into other programs, as witnessed by \fIdoc/rxvt\-tabbed\fR or
182rxvt-unicode from initialising perl, saving memory. 187the upcoming \f(CW\*(C`Gtk2::URxvt\*(C'\fR perl module, which features a tabbed urxvt
183.Sp 188(murxvt) terminal as an example embedding application.
184If you only want to disable specific features, you first have to 189.PP
185identify which perl extension is responsible. For this, read the section 190\fIHow do I know which rxvt-unicode version I'm using?\fR
186\&\fB\s-1PREPACKAGED\s0 \s-1EXTENSIONS\s0\fR in the @@RXVT_NAME@@\fIperl\fR\|(3) manpage. For 191.IX Subsection "How do I know which rxvt-unicode version I'm using?"
187example, to disable the \fBselection-popup\fR and \fBoption-popup\fR, specify 192.PP
188this \fBperl-ext-common\fR resource: 193The version number is displayed with the usage (\-h). Also the escape
189.Sp 194sequence \f(CW\*(C`ESC [ 8 n\*(C'\fR sets the window title to the version number. When
195using the @@URXVT_NAME@@c client, the version displayed is that of the
196daemon.
197.PP
198\fIRxvt-unicode uses gobs of memory, how can I reduce that?\fR
199.IX Subsection "Rxvt-unicode uses gobs of memory, how can I reduce that?"
200.PP
201Rxvt-unicode tries to obey the rule of not charging you for something you
202don't use. One thing you should try is to configure out all settings that
203you don't need, for example, Xft support is a resource hog by design,
204when used. Compiling it out ensures that no Xft font will be loaded
205accidentally when rxvt-unicode tries to find a font for your characters.
206.PP
207Also, many people (me included) like large windows and even larger
208scrollback buffers: Without \f(CW\*(C`\-\-enable\-unicode3\*(C'\fR, rxvt-unicode will use
2096 bytes per screen cell. For a 160x?? window this amounts to almost a
210kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
211use 10 Megabytes of memory. With \f(CW\*(C`\-\-enable\-unicode3\*(C'\fR it gets worse, as
212rxvt-unicode then uses 8 bytes per screen cell.
213.PP
214\fIHow can I start @@URXVT_NAME@@d in a race-free way?\fR
215.IX Subsection "How can I start @@URXVT_NAME@@d in a race-free way?"
216.PP
217Try \f(CW\*(C`@@URXVT_NAME@@d \-f \-o\*(C'\fR, which tells @@URXVT_NAME@@d to open the
218display, create the listening socket and then fork.
219.PP
220\fIHow do I distinguish wether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.\fR
221.IX Subsection "How do I distinguish wether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc."
222.PP
223The original rxvt and rxvt-unicode always export the variable \*(L"\s-1COLORTERM\s0\*(R",
224so you can check and see if that is set. Note that several programs, \s-1JED\s0,
225slrn, Midnight Commander automatically check this variable to decide
226whether or not to use color.
227.PP
228\fIHow do I set the correct, full \s-1IP\s0 address for the \s-1DISPLAY\s0 variable?\fR
229.IX Subsection "How do I set the correct, full IP address for the DISPLAY variable?"
230.PP
231If you've compiled rxvt-unicode with \s-1DISPLAY_IS_IP\s0 and have enabled
232insecure mode then it is possible to use the following shell script
233snippets to correctly set the display. If your version of rxvt-unicode
234wasn't also compiled with \s-1ESCZ_ANSWER\s0 (as assumed in these snippets) then
235the \s-1COLORTERM\s0 variable can be used to distinguish rxvt-unicode from a
236regular xterm.
237.PP
238Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
239snippets:
240.PP
190.Vb 1 241.Vb 12
191\& URxvt.perl-ext-common: default,-selection-popup,-option-popup 242\& # Bourne/Korn/POSIX family of shells:
243\& [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
244\& if [ ${TERM:-foo} = xterm ]; then
245\& stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
246\& echo -n '^[Z'
247\& read term_id
248\& stty icanon echo
249\& if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
250\& echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
251\& read DISPLAY # set it in our local shell
252\& fi
253\& fi
192.Ve 254.Ve
193.Sp 255.PP
194This will keep the default extensions, but disable the two popup 256\fIHow do I compile the manual pages on my own?\fR
195extensions. Some extensions can also be configured, for example, 257.IX Subsection "How do I compile the manual pages on my own?"
196scrollback search mode is triggered by \fBM\-s\fR. You can move it to any 258.PP
197other combination either by setting the \fBsearchable-scrollback\fR resource: 259You need to have a recent version of perl installed as \fI/usr/bin/perl\fR,
198.Sp 260one that comes with \fIpod2man\fR, \fIpod2text\fR and \fIpod2html\fR. Then go to
199.Vb 1 261the doc subdirectory and enter \f(CW\*(C`make alldoc\*(C'\fR.
200\& URxvt.searchable-scrollback: CM-s 262.PP
201.Ve
202.IP "Isn't rxvt supposed to be small? Don't all those features bloat?" 4 263\fIIsn't rxvt-unicode supposed to be small? Don't all those features bloat?\fR
203.IX Item "Isn't rxvt supposed to be small? Don't all those features bloat?" 264.IX Subsection "Isn't rxvt-unicode supposed to be small? Don't all those features bloat?"
265.PP
204I often get asked about this, and I think, no, they didn't cause extra 266I often get asked about this, and I think, no, they didn't cause extra
205bloat. If you compare a minimal rxvt and a minimal urxvt, you can see 267bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
206that the urxvt binary is larger (due to some encoding tables always being 268that the urxvt binary is larger (due to some encoding tables always being
207compiled in), but it actually uses less memory (\s-1RSS\s0) after startup. Even 269compiled in), but it actually uses less memory (\s-1RSS\s0) after startup. Even
208with \f(CW\*(C`\-\-disable\-everything\*(C'\fR, this comparison is a bit unfair, as many 270with \f(CW\*(C`\-\-disable\-everything\*(C'\fR, this comparison is a bit unfair, as many
209features unique to urxvt (locale, encoding conversion, iso14755 etc.) are 271features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
210already in use in this mode. 272already in use in this mode.
211.Sp 273.PP
212.Vb 3 274.Vb 3
213\& text data bss drs rss filename 275\& text data bss drs rss filename
214\& 98398 1664 24 15695 1824 rxvt --disable-everything 276\& 98398 1664 24 15695 1824 rxvt --disable-everything
215\& 188985 9048 66616 18222 1788 urxvt --disable-everything 277\& 188985 9048 66616 18222 1788 urxvt --disable-everything
216.Ve 278.Ve
217.Sp 279.PP
218When you \f(CW\*(C`\-\-enable\-everything\*(C'\fR (which _is_ unfair, as this involves xft 280When you \f(CW\*(C`\-\-enable\-everything\*(C'\fR (which \fIis\fR unfair, as this involves xft
219and full locale/XIM support which are quite bloaty inside libX11 and my 281and full locale/XIM support which are quite bloaty inside libX11 and my
220libc), the two diverge, but not unreasnobaly so. 282libc), the two diverge, but not unreasnobaly so.
221.Sp 283.PP
222.Vb 3 284.Vb 3
223\& text data bss drs rss filename 285\& text data bss drs rss filename
224\& 163431 2152 24 20123 2060 rxvt --enable-everything 286\& 163431 2152 24 20123 2060 rxvt --enable-everything
225\& 1035683 49680 66648 29096 3680 urxvt --enable-everything 287\& 1035683 49680 66648 29096 3680 urxvt --enable-everything
226.Ve 288.Ve
227.Sp 289.PP
228The very large size of the text section is explained by the east-asian 290The very large size of the text section is explained by the east-asian
229encoding tables, which, if unused, take up disk space but nothing else 291encoding tables, which, if unused, take up disk space but nothing else
230and can be compiled out unless you rely on X11 core fonts that use those 292and can be compiled out unless you rely on X11 core fonts that use those
231encodings. The \s-1BSS\s0 size comes from the 64k emergency buffer that my c++ 293encodings. The \s-1BSS\s0 size comes from the 64k emergency buffer that my c++
232compiler allocates (but of course doesn't use unless you are out of 294compiler allocates (but of course doesn't use unless you are out of
233memory). Also, using an xft font instead of a core font immediately adds a 295memory). Also, using an xft font instead of a core font immediately adds a
234few megabytes of \s-1RSS\s0. Xft indeed is responsible for a lot of \s-1RSS\s0 even when 296few megabytes of \s-1RSS\s0. Xft indeed is responsible for a lot of \s-1RSS\s0 even when
235not used. 297not used.
236.Sp 298.PP
237Of course, due to every character using two or four bytes instead of one, 299Of course, due to every character using two or four bytes instead of one,
238a large scrollback buffer will ultimately make rxvt-unicode use more 300a large scrollback buffer will ultimately make rxvt-unicode use more
239memory. 301memory.
240.Sp 302.PP
241Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this 303Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
242still fares rather well. And compared to some monsters like gnome-terminal 304still fares rather well. And compared to some monsters like gnome-terminal
243(21152k + extra 4204k in separate processes) or konsole (22200k + extra 305(21152k + extra 4204k in separate processes) or konsole (22200k + extra
24443180k in daemons that stay around after exit, plus half a minute of 30643180k in daemons that stay around after exit, plus half a minute of
245startup time, including the hundreds of warnings it spits out), it fares 307startup time, including the hundreds of warnings it spits out), it fares
246extremely well *g*. 308extremely well *g*.
309.PP
247.IP "Why \*(C+, isn't that unportable/bloated/uncool?" 4 310\fIWhy \*(C+, isn't that unportable/bloated/uncool?\fR
248.IX Item "Why , isn't that unportable/bloated/uncool?" 311.IX Subsection "Why , isn't that unportable/bloated/uncool?"
312.PP
249Is this a question? :) It comes up very often. The simple answer is: I had 313Is this a question? :) It comes up very often. The simple answer is: I had
250to write it, and \*(C+ allowed me to write and maintain it in a fraction 314to write it, and \*(C+ allowed me to write and maintain it in a fraction
251of the time and effort (which is a scarce resource for me). Put even 315of the time and effort (which is a scarce resource for me). Put even
252shorter: It simply wouldn't exist without \*(C+. 316shorter: It simply wouldn't exist without \*(C+.
253.Sp 317.PP
254My personal stance on this is that \*(C+ is less portable than C, but in 318My personal stance on this is that \*(C+ is less portable than C, but in
255the case of rxvt-unicode this hardly matters, as its portability limits 319the case of rxvt-unicode this hardly matters, as its portability limits
256are defined by things like X11, pseudo terminals, locale support and unix 320are defined by things like X11, pseudo terminals, locale support and unix
257domain sockets, which are all less portable than \*(C+ itself. 321domain sockets, which are all less portable than \*(C+ itself.
258.Sp 322.PP
259Regarding the bloat, see the above question: It's easy to write programs 323Regarding the bloat, see the above question: It's easy to write programs
260in C that use gobs of memory, an certainly possible to write programs in 324in C that use gobs of memory, an certainly possible to write programs in
261\&\*(C+ that don't. \*(C+ also often comes with large libraries, but this is 325\&\*(C+ that don't. \*(C+ also often comes with large libraries, but this is
262not necessarily the case with \s-1GCC\s0. Here is what rxvt links against on my 326not necessarily the case with \s-1GCC\s0. Here is what rxvt links against on my
263system with a minimal config: 327system with a minimal config:
264.Sp 328.PP
265.Vb 4 329.Vb 4
266\& libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) 330\& libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
267\& libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000) 331\& libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
268\& libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000) 332\& libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
269\& /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) 333\& /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
270.Ve 334.Ve
271.Sp 335.PP
272And here is rxvt\-unicode: 336And here is rxvt\-unicode:
273.Sp 337.PP
274.Vb 5 338.Vb 5
275\& libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) 339\& libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
276\& libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000) 340\& libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
277\& libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000) 341\& libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
278\& libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000) 342\& libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
279\& /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) 343\& /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
280.Ve 344.Ve
281.Sp 345.PP
282No large bloated libraries (of course, none were linked in statically), 346No large bloated libraries (of course, none were linked in statically),
283except maybe libX11 :) 347except maybe libX11 :)
284.IP "Does it support tabs, can I have a tabbed rxvt\-unicode?" 4 348.Sh "Rendering, Font & Look and Feel Issues"
285.IX Item "Does it support tabs, can I have a tabbed rxvt-unicode?" 349.IX Subsection "Rendering, Font & Look and Feel Issues"
286rxvt-unicode does not directly support tabs. It will work fine with 350\fII can't get transparency working, what am I doing wrong?\fR
287tabbing functionality of many window managers or similar tabbing programs, 351.IX Subsection "I can't get transparency working, what am I doing wrong?"
288and its embedding-features allow it to be embedded into other programs, 352.PP
289as witnessed by \fIdoc/rxvt\-tabbed\fR or the upcoming \f(CW\*(C`Gtk2::URxvt\*(C'\fR perl 353First of all, transparency isn't officially supported in rxvt\-unicode, so
290module, which features a tabbed urxvt (murxvt) terminal as an example 354you are mostly on your own. Do not bug the author about it (but you may
291embedding application. 355bug everybody else). Also, if you can't get it working consider it a rite
292.IP "How do I know which rxvt-unicode version I'm using?" 4 356of passage: ... and you failed.
293.IX Item "How do I know which rxvt-unicode version I'm using?" 357.PP
294The version number is displayed with the usage (\-h). Also the escape 358Here are four ways to get transparency. \fBDo\fR read the manpage and option
295sequence \f(CW\*(C`ESC [ 8 n\*(C'\fR sets the window title to the version number. When 359descriptions for the programs mentioned and rxvt\-unicode. Really, do it!
296using the @@RXVT_NAME@@c client, the version displayed is that of the 360.PP
297daemon. 3611. Use inheritPixmap:
298.IP "I am using Debian GNU/Linux and have a problem..." 4 362.PP
299.IX Item "I am using Debian GNU/Linux and have a problem..." 363.Vb 2
300The Debian GNU/Linux package of rxvt-unicode in sarge contains large 364\& Esetroot wallpaper.jpg
301patches that considerably change the behaviour of rxvt\-unicode. Before 365\& @@URXVT_NAME@@ -ip -tint red -sh 40
302reporting a bug to the original rxvt-unicode author please download and 366.Ve
303install the genuine version (<http://software.schmorp.de#rxvt\-unicode>) 367.PP
304and try to reproduce the problem. If you cannot, chances are that the 368That works. If you think it doesn't, you lack transparency and tinting
305problems are specific to Debian GNU/Linux, in which case it should be 369support, or you are unable to read.
306reported via the Debian Bug Tracking System (use \f(CW\*(C`reportbug\*(C'\fR to report 370.PP
307the bug). 3712. Use a simple pixmap and emulate pseudo\-transparency. This enables you
308.Sp 372to use effects other than tinting and shading: Just shade/tint/whatever
309For other problems that also affect the Debian package, you can and 373your picture with gimp or any other tool:
310probably should use the Debian \s-1BTS\s0, too, because, after all, it's also a 374.PP
311bug in the Debian version and it serves as a reminder for other users that 375.Vb 2
312might encounter the same issue. 376\& convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm
313.IP "I am maintaining rxvt-unicode for distribution/OS \s-1XXX\s0, any recommendation?" 4 377\& @@URXVT_NAME@@ -pixmap background.xpm -pe automove-background
314.IX Item "I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?" 378.Ve
315You should build one binary with the default options. \fIconfigure\fR 379.PP
316now enables most useful options, and the trend goes to making them 380That works. If you think it doesn't, you lack \s-1XPM\s0 and Perl support, or you
317runtime\-switchable, too, so there is usually no drawback to enbaling them, 381are unable to read.
318except higher disk and possibly memory usage. The perl interpreter should 382.PP
319be enabled, as important functionality (menus, selection, likely more in 3833. Use an \s-1ARGB\s0 visual:
320the future) depends on it. 384.PP
321.Sp 385.Vb 1
322You should not overwrite the \f(CW\*(C`perl\-ext\-common\*(C'\fR snd \f(CW\*(C`perl\-ext\*(C'\fR resources 386\& @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
323system-wide (except maybe with \f(CW\*(C`defaults\*(C'\fR). This will result in useful 387.Ve
324behaviour. If your distribution aims at low memory, add an empty 388.PP
325\&\f(CW\*(C`perl\-ext\-common\*(C'\fR resource to the app-defaults file. This will keep the 389This requires \s-1XFT\s0 support, and the support of your X\-server. If that
326perl interpreter disabled until the user enables it. 390doesn't work for you, blame Xorg and Keith Packard. \s-1ARGB\s0 visuals aren't
327.Sp 391there yet, no matter what they claim. Rxvt-Unicode contains the neccessary
328If you can/want build more binaries, I recommend building a minimal 392bugfixes and workarounds for Xft and Xlib to make it work, but that
329one with \f(CW\*(C`\-\-disable\-everything\*(C'\fR (very useful) and a maximal one with 393doesn't mean that your \s-1WM\s0 has the required kludges in place.
330\&\f(CW\*(C`\-\-enable\-everything\*(C'\fR (less useful, it will be very big due to a lot of 394.PP
331encodings built-in that increase download times and are rarely used). 3954. Use xcompmgr and let it do the job:
332.IP "I need to make it setuid/setgid to support utmp/ptys on my \s-1OS\s0, is this safe?" 4 396.PP
333.IX Item "I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?" 397.Vb 2
334Likely not. While I honestly try to make it secure, and am probably not 398\& xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \e
335bad at it, I think it is simply unreasonable to expect all of freetype 399\& -set _NET_WM_WINDOW_OPACITY 0xc0000000
336+ fontconfig + xft + xlib + perl + ... + rxvt-unicode itself to all be 400.Ve
337secure. Also, rxvt-unicode disables some options when it detects that it 401.PP
338runs setuid or setgid, which is not nice. Besides, with the embedded perl 402Then click on a window you want to make transparent. Replace \f(CW0xc0000000\fR
339interpreter the possibility for security problems easily multiplies. 403by other values to change the degree of opacity. If it doesn't work and
340.Sp 404your server crashes, you got to keep the pieces.
341Elevated privileges are only required for utmp and pty operations on some 405.PP
342systems (for example, GNU/Linux doesn't need any extra privileges for 406\fIWhy do some chinese characters look so different than others?\fR
343ptys, but some need it for utmp support). It is planned to mvoe this into 407.IX Subsection "Why do some chinese characters look so different than others?"
344a forked handler process, but this is not yet done. 408.PP
345.Sp 409This is because there is a difference between script and language \*(--
346So, while setuid/setgid operation is supported and not a problem on your 410rxvt-unicode does not know which language the text that is output is,
347typical single-user-no-other-logins unix desktop, always remember that 411as it only knows the unicode character codes. If rxvt-unicode first
348its an awful lot of code, most of which isn't checked for security issues 412sees a japanese/chinese character, it might choose a japanese font for
349regularly. 413display. Subsequent japanese characters will use that font. Now, many
414chinese characters aren't represented in japanese fonts, so when the first
415non-japanese character comes up, rxvt-unicode will look for a chinese font
416\&\*(-- unfortunately at this point, it will still use the japanese font for
417chinese characters that are also in the japanese font.
418.PP
419The workaround is easy: just tag a chinese font at the end of your font
420list (see the previous question). The key is to view the font list as
421a preference list: If you expect more japanese, list a japanese font
422first. If you expect more chinese, put a chinese font first.
423.PP
424In the future it might be possible to switch language preferences at
425runtime (the internal data structure has no problem with using different
426fonts for the same character at the same time, but no interface for this
427has been designed yet).
428.PP
429Until then, you might get away with switching fonts at runtime (see \*(L"Can I switch the fonts at runtime?\*(R" later in this document).
430.PP
431\fIWhy does rxvt-unicode sometimes leave pixel droppings?\fR
432.IX Subsection "Why does rxvt-unicode sometimes leave pixel droppings?"
433.PP
434Most fonts were not designed for terminal use, which means that character
435size varies a lot. A font that is otherwise fine for terminal use might
436contain some characters that are simply too wide. Rxvt-unicode will avoid
437these characters. For characters that are just \*(L"a bit\*(R" too wide a special
438\&\*(L"careful\*(R" rendering mode is used that redraws adjacent characters.
439.PP
440All of this requires that fonts do not lie about character sizes,
441however: Xft fonts often draw glyphs larger than their acclaimed bounding
442box, and rxvt-unicode has no way of detecting this (the correct way is to
443ask for the character bounding box, which unfortunately is wrong in these
444cases).
445.PP
446It's not clear (to me at least), wether this is a bug in Xft, freetype,
447or the respective font. If you encounter this problem you might try using
448the \f(CW\*(C`\-lsp\*(C'\fR option to give the font more height. If that doesn't work, you
449might be forced to use a different font.
450.PP
451All of this is not a problem when using X11 core fonts, as their bounding
452box data is correct.
453.PP
454\fIHow can I keep rxvt-unicode from using reverse video so much?\fR
455.IX Subsection "How can I keep rxvt-unicode from using reverse video so much?"
456.PP
457First of all, make sure you are running with the right terminal settings
458(\f(CW\*(C`TERM=rxvt\-unicode\*(C'\fR), which will get rid of most of these effects. Then
459make sure you have specified colours for italic and bold, as otherwise
460rxvt-unicode might use reverse video to simulate the effect:
461.PP
462.Vb 2
463\& URxvt.colorBD: white
464\& URxvt.colorIT: green
465.Ve
466.PP
467\fISome programs assume totally weird colours (red instead of blue), how can I fix that?\fR
468.IX Subsection "Some programs assume totally weird colours (red instead of blue), how can I fix that?"
469.PP
470For some unexplainable reason, some rare programs assume a very weird
471colour palette when confronted with a terminal with more than the standard
4728 colours (rxvt\-unicode supports 88). The right fix is, of course, to fix
473these programs not to assume non-ISO colours without very good reasons.
474.PP
475In the meantime, you can either edit your \f(CW\*(C`rxvt\-unicode\*(C'\fR terminfo
476definition to only claim 8 colour support or use \f(CW\*(C`TERM=rxvt\*(C'\fR, which will
477fix colours but keep you from using other rxvt-unicode features.
478.PP
479\fICan I switch the fonts at runtime?\fR
480.IX Subsection "Can I switch the fonts at runtime?"
481.PP
482Yes, using an escape sequence. Try something like this, which has the same
483effect as using the \f(CW\*(C`\-fn\*(C'\fR switch, and takes effect immediately:
484.PP
485.Vb 1
486\& printf '\ee]50;%s\e007' "9x15bold,xft:Kochi Gothic"
487.Ve
488.PP
489This is useful if you e.g. work primarily with japanese (and prefer a
490japanese font), but you have to switch to chinese temporarily, where
491japanese fonts would only be in your way.
492.PP
493You can think of this as a kind of manual \s-1ISO\-2022\s0 switching.
494.PP
495\fIWhy do italic characters look as if clipped?\fR
496.IX Subsection "Why do italic characters look as if clipped?"
497.PP
498Many fonts have difficulties with italic characters and hinting. For
499example, the otherwise very nicely hinted font \f(CW\*(C`xft:Bitstream Vera Sans
500Mono\*(C'\fR completely fails in it's italic face. A workaround might be to
501enable freetype autohinting, i.e. like this:
502.PP
503.Vb 2
504\& URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
505\& URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
506.Ve
507.PP
508\fICan I speed up Xft rendering somehow?\fR
509.IX Subsection "Can I speed up Xft rendering somehow?"
510.PP
511Yes, the most obvious way to speed it up is to avoid Xft entirely, as
512it is simply slow. If you still want Xft fonts you might try to disable
513antialiasing (by appending \f(CW\*(C`:antialias=false\*(C'\fR), which saves lots of
514memory and also speeds up rendering considerably.
515.PP
516\fIRxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?\fR
517.IX Subsection "Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?"
518.PP
519Rxvt-unicode will use whatever you specify as a font. If it needs to
520fall back to it's default font search list it will prefer X11 core
521fonts, because they are small and fast, and then use Xft fonts. It has
522antialiasing disabled for most of them, because the author thinks they
523look best that way.
524.PP
525If you want antialiasing, you have to specify the fonts manually.
526.PP
527\fIWhat's with this bold/blink stuff?\fR
528.IX Subsection "What's with this bold/blink stuff?"
529.PP
530If no bold colour is set via \f(CW\*(C`colorBD:\*(C'\fR, bold will invert text using the
531standard foreground colour.
532.PP
533For the standard background colour, blinking will actually make the
534text blink when compiled with \f(CW\*(C`\-\-enable\-blinking\*(C'\fR. with standard
535colours. Without \f(CW\*(C`\-\-enable\-blinking\*(C'\fR, the blink attribute will be
536ignored.
537.PP
538On \s-1ANSI\s0 colours, bold/blink attributes are used to set high-intensity
539foreground/background colors.
540.PP
541color0\-7 are the low-intensity colors.
542.PP
543color8\-15 are the corresponding high-intensity colors.
544.PP
545\fII don't like the screen colors. How do I change them?\fR
546.IX Subsection "I don't like the screen colors. How do I change them?"
547.PP
548You can change the screen colors at run-time using \fI~/.Xdefaults\fR
549resources (or as long\-options).
550.PP
551Here are values that are supposed to resemble a \s-1VGA\s0 screen,
552including the murky brown that passes for low-intensity yellow:
553.PP
554.Vb 8
555\& URxvt.color0: #000000
556\& URxvt.color1: #A80000
557\& URxvt.color2: #00A800
558\& URxvt.color3: #A8A800
559\& URxvt.color4: #0000A8
560\& URxvt.color5: #A800A8
561\& URxvt.color6: #00A8A8
562\& URxvt.color7: #A8A8A8
563.Ve
564.PP
565.Vb 8
566\& URxvt.color8: #000054
567\& URxvt.color9: #FF0054
568\& URxvt.color10: #00FF54
569\& URxvt.color11: #FFFF54
570\& URxvt.color12: #0000FF
571\& URxvt.color13: #FF00FF
572\& URxvt.color14: #00FFFF
573\& URxvt.color15: #FFFFFF
574.Ve
575.PP
576And here is a more complete set of non-standard colors.
577.PP
578.Vb 18
579\& URxvt.cursorColor: #dc74d1
580\& URxvt.pointerColor: #dc74d1
581\& URxvt.background: #0e0e0e
582\& URxvt.foreground: #4ad5e1
583\& URxvt.color0: #000000
584\& URxvt.color8: #8b8f93
585\& URxvt.color1: #dc74d1
586\& URxvt.color9: #dc74d1
587\& URxvt.color2: #0eb8c7
588\& URxvt.color10: #0eb8c7
589\& URxvt.color3: #dfe37e
590\& URxvt.color11: #dfe37e
591\& URxvt.color5: #9e88f0
592\& URxvt.color13: #9e88f0
593\& URxvt.color6: #73f7ff
594\& URxvt.color14: #73f7ff
595\& URxvt.color7: #e1dddd
596\& URxvt.color15: #e1dddd
597.Ve
598.PP
599(They were described (not by me) as \*(L"pretty girly\*(R").
600.PP
601\fIWhy do some characters look so much different than others?\fR
602.IX Subsection "Why do some characters look so much different than others?"
603.PP
604See next entry.
605.PP
606\fIHow does rxvt-unicode choose fonts?\fR
607.IX Subsection "How does rxvt-unicode choose fonts?"
608.PP
609Most fonts do not contain the full range of Unicode, which is
610fine. Chances are that the font you (or the admin/package maintainer of
611your system/os) have specified does not cover all the characters you want
612to display.
613.PP
614\&\fBrxvt-unicode\fR makes a best-effort try at finding a replacement
615font. Often the result is fine, but sometimes the chosen font looks
616bad/ugly/wrong. Some fonts have totally strange characters that don't
617resemble the correct glyph at all, and rxvt-unicode lacks the artificial
618intelligence to detect that a specific glyph is wrong: it has to believe
619the font that the characters it claims to contain indeed look correct.
620.PP
621In that case, select a font of your taste and add it to the font list,
622e.g.:
623.PP
624.Vb 1
625\& @@URXVT_NAME@@ -fn basefont,font2,font3...
626.Ve
627.PP
628When rxvt-unicode sees a character, it will first look at the base
629font. If the base font does not contain the character, it will go to the
630next font, and so on. Specifying your own fonts will also speed up this
631search and use less resources within rxvt-unicode and the X\-server.
632.PP
633The only limitation is that none of the fonts may be larger than the base
634font, as the base font defines the terminal character cell size, which
635must be the same due to the way terminals work.
636.Sh "Keyboard, Mouse & User Interaction"
637.IX Subsection "Keyboard, Mouse & User Interaction"
638\fIThe new selection selects pieces that are too big, how can I select single words?\fR
639.IX Subsection "The new selection selects pieces that are too big, how can I select single words?"
640.PP
641If you want to select e.g. alphanumeric words, you can use the following
642setting:
643.PP
644.Vb 1
645\& URxvt.selection.pattern-0: ([[:word:]]+)
646.Ve
647.PP
648If you click more than twice, the selection will be extended
649more and more.
650.PP
651To get a selection that is very similar to the old code, try this pattern:
652.PP
653.Vb 1
654\& URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\e\e\e\e]^`{|})]+)
655.Ve
656.PP
657Please also note that the \fILeftClick Shift-LeftClik\fR combination also
658selects words like the old code.
659.PP
660\fII don't like the new selection/popups/hotkeys/perl, how do I change/disable it?\fR
661.IX Subsection "I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?"
662.PP
663You can disable the perl extension completely by setting the
664\&\fBperl-ext-common\fR resource to the empty string, which also keeps
665rxvt-unicode from initialising perl, saving memory.
666.PP
667If you only want to disable specific features, you first have to
668identify which perl extension is responsible. For this, read the section
669\&\fB\s-1PREPACKAGED\s0 \s-1EXTENSIONS\s0\fR in the @@URXVT_NAME@@\fIperl\fR\|(3) manpage. For
670example, to disable the \fBselection-popup\fR and \fBoption-popup\fR, specify
671this \fBperl-ext-common\fR resource:
672.PP
673.Vb 1
674\& URxvt.perl-ext-common: default,-selection-popup,-option-popup
675.Ve
676.PP
677This will keep the default extensions, but disable the two popup
678extensions. Some extensions can also be configured, for example,
679scrollback search mode is triggered by \fBM\-s\fR. You can move it to any
680other combination either by setting the \fBsearchable-scrollback\fR resource:
681.PP
682.Vb 1
683\& URxvt.searchable-scrollback: CM-s
684.Ve
685.PP
686\fIThe cursor moves when selecting text in the current input line, how do I switch this off?\fR
687.IX Subsection "The cursor moves when selecting text in the current input line, how do I switch this off?"
688.PP
689See next entry.
690.PP
691\fIDuring rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?\fR
692.IX Subsection "During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?"
693.PP
694These are caused by the \f(CW\*(C`readline\*(C'\fR perl extension. Under normal
695circumstances, it will move your cursor around when you click into the
696line that contains it. It tries hard not to do this at the wrong moment,
697but when running a program that doesn't parse cursor movements or in some
698cases during rlogin sessions, it fails to detect this properly.
699.PP
700You can permamently switch this feature off by disabling the \f(CW\*(C`readline\*(C'\fR
701extension:
702.PP
703.Vb 1
704\& URxvt.perl-ext-common: default,-readline
705.Ve
706.PP
707\fIMy numerical keypad acts weird and generates differing output?\fR
708.IX Subsection "My numerical keypad acts weird and generates differing output?"
709.PP
710Some Debian GNUL/Linux users seem to have this problem, although no
711specific details were reported so far. It is possible that this is caused
712by the wrong \f(CW\*(C`TERM\*(C'\fR setting, although the details of wether and how
713this can happen are unknown, as \f(CW\*(C`TERM=rxvt\*(C'\fR should offer a compatible
714keymap. See the answer to the previous question, and please report if that
715helped.
716.PP
717\fIMy Compose (Multi_key) key is no longer working.\fR
718.IX Subsection "My Compose (Multi_key) key is no longer working."
719.PP
720The most common causes for this are that either your locale is not set
721correctly, or you specified a \fBpreeditStyle\fR that is not supported by
722your input method. For example, if you specified \fBOverTheSpot\fR and
723your input method (e.g. the default input method handling Compose keys)
724does not support this (for instance because it is not visual), then
725rxvt-unicode will continue without an input method.
726.PP
727In this case either do not specify a \fBpreeditStyle\fR or specify more than
728one pre-edit style, such as \fBOverTheSpot,Root,None\fR.
729.PP
730\fII cannot type \f(CI\*(C`Ctrl\-Shift\-2\*(C'\fI to get an \s-1ASCII\s0 \s-1NUL\s0 character due to \s-1ISO\s0 14755\fR
731.IX Subsection "I cannot type Ctrl-Shift-2 to get an ASCII NUL character due to ISO 14755"
732.PP
733Either try \f(CW\*(C`Ctrl\-2\*(C'\fR alone (it often is mapped to \s-1ASCII\s0 \s-1NUL\s0 even on
734international keyboards) or simply use \s-1ISO\s0 14755 support to your
735advantage, typing <Ctrl\-Shift\-0> to get a \s-1ASCII\s0 \s-1NUL\s0. This works for other
736codes, too, such as \f(CW\*(C`Ctrl\-Shift\-1\-d\*(C'\fR to type the default telnet escape
737character and so on.
738.PP
739\fIMouse cut/paste suddenly no longer works.\fR
740.IX Subsection "Mouse cut/paste suddenly no longer works."
741.PP
742Make sure that mouse reporting is actually turned off since killing
743some editors prematurely may leave the mouse in mouse report mode. I've
744heard that tcsh may use mouse reporting unless it otherwise specified. A
745quick check is to see if cut/paste works when the Alt or Shift keys are
746depressed.
747.PP
748\fIWhat's with the strange Backspace/Delete key behaviour?\fR
749.IX Subsection "What's with the strange Backspace/Delete key behaviour?"
750.PP
751Assuming that the physical Backspace key corresponds to the
752BackSpace keysym (not likely for Linux ... see the following
753question) there are two standard values that can be used for
754Backspace: \f(CW\*(C`^H\*(C'\fR and \f(CW\*(C`^?\*(C'\fR.
755.PP
756Historically, either value is correct, but rxvt-unicode adopts the debian
757policy of using \f(CW\*(C`^?\*(C'\fR when unsure, because it's the one only only correct
758choice :).
759.PP
760Rxvt-unicode tries to inherit the current stty settings and uses the value
761of `erase' to guess the value for backspace. If rxvt-unicode wasn't
762started from a terminal (say, from a menu or by remote shell), then the
763system value of `erase', which corresponds to \s-1CERASE\s0 in <termios.h>, will
764be used (which may not be the same as your stty setting).
765.PP
766For starting a new rxvt\-unicode:
767.PP
768.Vb 3
769\& # use Backspace = ^H
770\& $ stty erase ^H
771\& $ @@URXVT_NAME@@
772.Ve
773.PP
774.Vb 3
775\& # use Backspace = ^?
776\& $ stty erase ^?
777\& $ @@URXVT_NAME@@
778.Ve
779.PP
780Toggle with \f(CW\*(C`ESC [ 36 h\*(C'\fR / \f(CW\*(C`ESC [ 36 l\*(C'\fR.
781.PP
782For an existing rxvt\-unicode:
783.PP
784.Vb 3
785\& # use Backspace = ^H
786\& $ stty erase ^H
787\& $ echo -n "^[[36h"
788.Ve
789.PP
790.Vb 3
791\& # use Backspace = ^?
792\& $ stty erase ^?
793\& $ echo -n "^[[36l"
794.Ve
795.PP
796This helps satisfy some of the Backspace discrepancies that occur, but
797if you use Backspace = \f(CW\*(C`^H\*(C'\fR, make sure that the termcap/terminfo value
798properly reflects that.
799.PP
800The Delete key is a another casualty of the ill-defined Backspace problem.
801To avoid confusion between the Backspace and Delete keys, the Delete
802key has been assigned an escape sequence to match the vt100 for Execute
803(\f(CW\*(C`ESC [ 3 ~\*(C'\fR) and is in the supplied termcap/terminfo.
804.PP
805Some other Backspace problems:
806.PP
807some editors use termcap/terminfo,
808some editors (vim I'm told) expect Backspace = ^H,
809\&\s-1GNU\s0 Emacs (and Emacs-like editors) use ^H for help.
810.PP
811Perhaps someday this will all be resolved in a consistent manner.
812.PP
813\fII don't like the key\-bindings. How do I change them?\fR
814.IX Subsection "I don't like the key-bindings. How do I change them?"
815.PP
816There are some compile-time selections available via configure. Unless
817you have run \*(L"configure\*(R" with the \f(CW\*(C`\-\-disable\-resources\*(C'\fR option you can
818use the `keysym' resource to alter the keystrings associated with keysyms.
819.PP
820Here's an example for a URxvt session started using \f(CW\*(C`@@URXVT_NAME@@ \-name URxvt\*(C'\fR
821.PP
822.Vb 20
823\& URxvt.keysym.Home: \e033[1~
824\& URxvt.keysym.End: \e033[4~
825\& URxvt.keysym.C-apostrophe: \e033<C-'>
826\& URxvt.keysym.C-slash: \e033<C-/>
827\& URxvt.keysym.C-semicolon: \e033<C-;>
828\& URxvt.keysym.C-grave: \e033<C-`>
829\& URxvt.keysym.C-comma: \e033<C-,>
830\& URxvt.keysym.C-period: \e033<C-.>
831\& URxvt.keysym.C-0x60: \e033<C-`>
832\& URxvt.keysym.C-Tab: \e033<C-Tab>
833\& URxvt.keysym.C-Return: \e033<C-Return>
834\& URxvt.keysym.S-Return: \e033<S-Return>
835\& URxvt.keysym.S-space: \e033<S-Space>
836\& URxvt.keysym.M-Up: \e033<M-Up>
837\& URxvt.keysym.M-Down: \e033<M-Down>
838\& URxvt.keysym.M-Left: \e033<M-Left>
839\& URxvt.keysym.M-Right: \e033<M-Right>
840\& URxvt.keysym.M-C-0: list \e033<M-C- 0123456789 >
841\& URxvt.keysym.M-C-a: list \e033<M-C- abcdefghijklmnopqrstuvwxyz >
842\& URxvt.keysym.F12: command:\e033]701;zh_CN.GBK\e007
843.Ve
844.PP
845See some more examples in the documentation for the \fBkeysym\fR resource.
846.PP
847\fII'm using keyboard model \s-1XXX\s0 that has extra Prior/Next/Insert keys. How do I make use of them? For example, the Sun Keyboard type 4 has the following map\fR
848.IX Subsection "I'm using keyboard model XXX that has extra Prior/Next/Insert keys. How do I make use of them? For example, the Sun Keyboard type 4 has the following map"
849.PP
850.Vb 6
851\& KP_Insert == Insert
852\& F22 == Print
853\& F27 == Home
854\& F29 == Prior
855\& F33 == End
856\& F35 == Next
857.Ve
858.PP
859Rather than have rxvt-unicode try to accommodate all the various possible
860keyboard mappings, it is better to use `xmodmap' to remap the keys as
861required for your particular machine.
862.Sh "Terminal Configuration"
863.IX Subsection "Terminal Configuration"
864\fIWhy doesn't rxvt-unicode read my resources?\fR
865.IX Subsection "Why doesn't rxvt-unicode read my resources?"
866.PP
867Well, why, indeed? It does, in a way very similar to other X
868applications. Most importantly, this means that if you or your \s-1OS\s0 loads
869resources into the X display (the right way to do it), rxvt-unicode will
870ignore any resource files in your home directory. It will only read
871\&\fI$HOME/.Xdefaults\fR when no resources are attached to the display.
872.PP
873If you have or use an \fI$HOME/.Xresources\fR file, chances are that
874resources are loaded into your X\-server. In this case, you have to
875re-login after every change (or run \fIxrdb \-merge \f(CI$HOME\fI/.Xresources\fR).
876.PP
877Also consider the form resources have to use:
878.PP
879.Vb 1
880\& URxvt.resource: value
881.Ve
882.PP
883If you want to use another form (there are lots of different ways of
884specifying resources), make sure you understand wether and why it
885works. If unsure, use the form above.
886.PP
350.IP "When I log-in to another system it tells me about missing terminfo data?" 4 887\fIWhen I log-in to another system it tells me about missing terminfo data?\fR
351.IX Item "When I log-in to another system it tells me about missing terminfo data?" 888.IX Subsection "When I log-in to another system it tells me about missing terminfo data?"
889.PP
352The terminal description used by rxvt-unicode is not as widely available 890The terminal description used by rxvt-unicode is not as widely available
353as that for xterm, or even rxvt (for which the same problem often arises). 891as that for xterm, or even rxvt (for which the same problem often arises).
354.Sp 892.PP
355The correct solution for this problem is to install the terminfo, this can 893The correct solution for this problem is to install the terminfo, this can
356be done like this (with ncurses' infocmp): 894be done like this (with ncurses' infocmp):
357.Sp 895.PP
358.Vb 2 896.Vb 2
359\& REMOTE=remotesystem.domain 897\& REMOTE=remotesystem.domain
360\& infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti" 898\& infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
361.Ve 899.Ve
362.Sp 900.PP
363\&... or by installing rxvt-unicode normally on the remote system, 901\&... or by installing rxvt-unicode normally on the remote system,
364.Sp 902.PP
365If you cannot or do not want to do this, then you can simply set 903If you cannot or do not want to do this, then you can simply set
366\&\f(CW\*(C`TERM=rxvt\*(C'\fR or even \f(CW\*(C`TERM=xterm\*(C'\fR, and live with the small number of 904\&\f(CW\*(C`TERM=rxvt\*(C'\fR or even \f(CW\*(C`TERM=xterm\*(C'\fR, and live with the small number of
367problems arising, which includes wrong keymapping, less and different 905problems arising, which includes wrong keymapping, less and different
368colours and some refresh errors in fullscreen applications. It's a nice 906colours and some refresh errors in fullscreen applications. It's a nice
369quick-and-dirty workaround for rare cases, though. 907quick-and-dirty workaround for rare cases, though.
370.Sp 908.PP
371If you always want to do this (and are fine with the consequences) you 909If you always want to do this (and are fine with the consequences) you
372can either recompile rxvt-unicode with the desired \s-1TERM\s0 value or use a 910can either recompile rxvt-unicode with the desired \s-1TERM\s0 value or use a
373resource to set it: 911resource to set it:
374.Sp 912.PP
375.Vb 1 913.Vb 1
376\& URxvt.termName: rxvt 914\& URxvt.termName: rxvt
377.Ve 915.Ve
378.Sp 916.PP
379If you don't plan to use \fBrxvt\fR (quite common...) you could also replace 917If you don't plan to use \fBrxvt\fR (quite common...) you could also replace
380the rxvt terminfo file with the rxvt-unicode one. 918the rxvt terminfo file with the rxvt-unicode one and use \f(CW\*(C`TERM=rxvt\*(C'\fR.
381.ie n .IP """tic"" outputs some error when compiling the terminfo entry." 4 919.PP
382.el .IP "\f(CWtic\fR outputs some error when compiling the terminfo entry." 4 920\fI\f(CI\*(C`tic\*(C'\fI outputs some error when compiling the terminfo entry.\fR
383.IX Item "tic outputs some error when compiling the terminfo entry." 921.IX Subsection "tic outputs some error when compiling the terminfo entry."
922.PP
384Most likely it's the empty definition for \f(CW\*(C`enacs=\*(C'\fR. Just replace it by 923Most likely it's the empty definition for \f(CW\*(C`enacs=\*(C'\fR. Just replace it by
385\&\f(CW\*(C`enacs=\eE[0@\*(C'\fR and try again. 924\&\f(CW\*(C`enacs=\eE[0@\*(C'\fR and try again.
386.ie n .IP """bash""'s readline does not work correctly under @@RXVT_NAME@@." 4 925.PP
387.el .IP "\f(CWbash\fR's readline does not work correctly under @@RXVT_NAME@@." 4 926\fI\f(CI\*(C`bash\*(C'\fI's readline does not work correctly under @@URXVT_NAME@@.\fR
388.IX Item "bash's readline does not work correctly under @@RXVT_NAME@@." 927.IX Subsection "bash's readline does not work correctly under @@URXVT_NAME@@."
389.PD 0 928.PP
929See next entry.
930.PP
390.IP "I need a termcap file entry." 4 931\fII need a termcap file entry.\fR
391.IX Item "I need a termcap file entry." 932.IX Subsection "I need a termcap file entry."
392.PD 933.PP
393One reason you might want this is that some distributions or operating 934One reason you might want this is that some distributions or operating
394systems still compile some programs using the long-obsoleted termcap 935systems still compile some programs using the long-obsoleted termcap
395library (Fedora Core's bash is one example) and rely on a termcap entry 936library (Fedora Core's bash is one example) and rely on a termcap entry
396for \f(CW\*(C`rxvt\-unicode\*(C'\fR. 937for \f(CW\*(C`rxvt\-unicode\*(C'\fR.
397.Sp 938.PP
398You could use rxvt's termcap entry with resonable results in many cases. 939You could use rxvt's termcap entry with resonable results in many cases.
399You can also create a termcap entry by using terminfo's infocmp program 940You can also create a termcap entry by using terminfo's infocmp program
400like this: 941like this:
401.Sp 942.PP
402.Vb 1 943.Vb 1
403\& infocmp -C rxvt-unicode 944\& infocmp -C rxvt-unicode
404.Ve 945.Ve
405.Sp 946.PP
406Or you could use this termcap entry, generated by the command above: 947Or you could use this termcap entry, generated by the command above:
407.Sp 948.PP
408.Vb 20 949.Vb 20
409\& rxvt-unicode|rxvt-unicode terminal (X Window System):\e 950\& rxvt-unicode|rxvt-unicode terminal (X Window System):\e
410\& :am:bw:eo:km:mi:ms:xn:xo:\e 951\& :am:bw:eo:km:mi:ms:xn:xo:\e
411\& :co#80:it#8:li#24:lm#0:\e 952\& :co#80:it#8:li#24:lm#0:\e
412\& :AL=\eE[%dL:DC=\eE[%dP:DL=\eE[%dM:DO=\eE[%dB:IC=\eE[%d@:\e 953\& :AL=\eE[%dL:DC=\eE[%dP:DL=\eE[%dM:DO=\eE[%dB:IC=\eE[%d@:\e
425\& :sc=\eE7:se=\eE[27m:sf=^J:so=\eE[7m:sr=\eEM:st=\eEH:ta=^I:\e 966\& :sc=\eE7:se=\eE[27m:sf=^J:so=\eE[7m:sr=\eEM:st=\eEH:ta=^I:\e
426\& :te=\eE[r\eE[?1049l:ti=\eE[?1049h:ue=\eE[24m:up=\eE[A:\e 967\& :te=\eE[r\eE[?1049l:ti=\eE[?1049h:ue=\eE[24m:up=\eE[A:\e
427\& :us=\eE[4m:vb=\eE[?5h\eE[?5l:ve=\eE[?25h:vi=\eE[?25l:\e 968\& :us=\eE[4m:vb=\eE[?5h\eE[?5l:ve=\eE[?25h:vi=\eE[?25l:\e
428\& :vs=\eE[?25h: 969\& :vs=\eE[?25h:
429.Ve 970.Ve
430.ie n .IP "Why does ""ls"" no longer have coloured output?" 4 971.PP
431.el .IP "Why does \f(CWls\fR no longer have coloured output?" 4 972\fIWhy does \f(CI\*(C`ls\*(C'\fI no longer have coloured output?\fR
432.IX Item "Why does ls no longer have coloured output?" 973.IX Subsection "Why does ls no longer have coloured output?"
974.PP
433The \f(CW\*(C`ls\*(C'\fR in the \s-1GNU\s0 coreutils unfortunately doesn't use terminfo to 975The \f(CW\*(C`ls\*(C'\fR in the \s-1GNU\s0 coreutils unfortunately doesn't use terminfo to
434decide wether a terminal has colour, but uses it's own configuration 976decide wether a terminal has colour, but uses it's own configuration
435file. Needless to say, \f(CW\*(C`rxvt\-unicode\*(C'\fR is not in it's default file (among 977file. Needless to say, \f(CW\*(C`rxvt\-unicode\*(C'\fR is not in it's default file (among
436with most other terminals supporting colour). Either add: 978with most other terminals supporting colour). Either add:
437.Sp 979.PP
438.Vb 1 980.Vb 1
439\& TERM rxvt-unicode 981\& TERM rxvt-unicode
440.Ve 982.Ve
441.Sp 983.PP
442to \f(CW\*(C`/etc/DIR_COLORS\*(C'\fR or simply add: 984to \f(CW\*(C`/etc/DIR_COLORS\*(C'\fR or simply add:
443.Sp 985.PP
444.Vb 1 986.Vb 1
445\& alias ls='ls --color=auto' 987\& alias ls='ls --color=auto'
446.Ve 988.Ve
447.Sp 989.PP
448to your \f(CW\*(C`.profile\*(C'\fR or \f(CW\*(C`.bashrc\*(C'\fR. 990to your \f(CW\*(C`.profile\*(C'\fR or \f(CW\*(C`.bashrc\*(C'\fR.
991.PP
449.IP "Why doesn't vim/emacs etc. use the 88 colour mode?" 4 992\fIWhy doesn't vim/emacs etc. use the 88 colour mode?\fR
450.IX Item "Why doesn't vim/emacs etc. use the 88 colour mode?" 993.IX Subsection "Why doesn't vim/emacs etc. use the 88 colour mode?"
451.PD 0 994.PP
995See next entry.
996.PP
452.IP "Why doesn't vim/emacs etc. make use of italic?" 4 997\fIWhy doesn't vim/emacs etc. make use of italic?\fR
453.IX Item "Why doesn't vim/emacs etc. make use of italic?" 998.IX Subsection "Why doesn't vim/emacs etc. make use of italic?"
999.PP
1000See next entry.
1001.PP
454.IP "Why are the secondary screen-related options not working properly?" 4 1002\fIWhy are the secondary screen-related options not working properly?\fR
455.IX Item "Why are the secondary screen-related options not working properly?" 1003.IX Subsection "Why are the secondary screen-related options not working properly?"
456.PD 1004.PP
457Make sure you are using \f(CW\*(C`TERM=rxvt\-unicode\*(C'\fR. Some pre-packaged 1005Make sure you are using \f(CW\*(C`TERM=rxvt\-unicode\*(C'\fR. Some pre-packaged
458distributions (most notably Debian GNU/Linux) break rxvt-unicode 1006distributions (most notably Debian GNU/Linux) break rxvt-unicode
459by setting \f(CW\*(C`TERM\*(C'\fR to \f(CW\*(C`rxvt\*(C'\fR, which doesn't have these extra 1007by setting \f(CW\*(C`TERM\*(C'\fR to \f(CW\*(C`rxvt\*(C'\fR, which doesn't have these extra
460features. Unfortunately, some of these (most notably, again, Debian 1008features. Unfortunately, some of these (most notably, again, Debian
461GNU/Linux) furthermore fail to even install the \f(CW\*(C`rxvt\-unicode\*(C'\fR terminfo 1009GNU/Linux) furthermore fail to even install the \f(CW\*(C`rxvt\-unicode\*(C'\fR terminfo
462file, so you will need to install it on your own (See the question \fBWhen 1010file, so you will need to install it on your own (See the question \fBWhen
463I log-in to another system it tells me about missing terminfo data?\fR on 1011I log-in to another system it tells me about missing terminfo data?\fR on
464how to do this). 1012how to do this).
465.IP "My numerical keypad acts weird and generates differing output?" 4 1013.Sh "Encoding / Locale / Input Method Issues"
466.IX Item "My numerical keypad acts weird and generates differing output?" 1014.IX Subsection "Encoding / Locale / Input Method Issues"
467Some Debian GNUL/Linux users seem to have this problem, although no
468specific details were reported so far. It is possible that this is caused
469by the wrong \f(CW\*(C`TERM\*(C'\fR setting, although the details of wether and how
470this can happen are unknown, as \f(CW\*(C`TERM=rxvt\*(C'\fR should offer a compatible
471keymap. See the answer to the previous question, and please report if that
472helped.
473.IP "Rxvt-unicode does not seem to understand the selected encoding?" 4 1015\fIRxvt-unicode does not seem to understand the selected encoding?\fR
474.IX Item "Rxvt-unicode does not seem to understand the selected encoding?" 1016.IX Subsection "Rxvt-unicode does not seem to understand the selected encoding?"
475.PD 0 1017.PP
1018See next entry.
1019.PP
476.IP "Unicode does not seem to work?" 4 1020\fIUnicode does not seem to work?\fR
477.IX Item "Unicode does not seem to work?" 1021.IX Subsection "Unicode does not seem to work?"
478.PD 1022.PP
479If you encounter strange problems like typing an accented character but 1023If you encounter strange problems like typing an accented character but
480getting two unrelated other characters or similar, or if program output is 1024getting two unrelated other characters or similar, or if program output is
481subtly garbled, then you should check your locale settings. 1025subtly garbled, then you should check your locale settings.
482.Sp 1026.PP
483Rxvt-unicode must be started with the same \f(CW\*(C`LC_CTYPE\*(C'\fR setting as the 1027Rxvt-unicode must be started with the same \f(CW\*(C`LC_CTYPE\*(C'\fR setting as the
484programs. Often rxvt-unicode is started in the \f(CW\*(C`C\*(C'\fR locale, while the 1028programs. Often rxvt-unicode is started in the \f(CW\*(C`C\*(C'\fR locale, while the
485login script running within the rxvt-unicode window changes the locale to 1029login script running within the rxvt-unicode window changes the locale to
486something else, e.g. \f(CW\*(C`en_GB.UTF\-8\*(C'\fR. Needless to say, this is not going to work. 1030something else, e.g. \f(CW\*(C`en_GB.UTF\-8\*(C'\fR. Needless to say, this is not going to work.
487.Sp 1031.PP
488The best thing is to fix your startup environment, as you will likely run 1032The best thing is to fix your startup environment, as you will likely run
489into other problems. If nothing works you can try this in your .profile. 1033into other problems. If nothing works you can try this in your .profile.
490.Sp 1034.PP
491.Vb 1 1035.Vb 1
492\& printf '\ee]701;%s\e007' "$LC_CTYPE" 1036\& printf '\ee]701;%s\e007' "$LC_CTYPE"
493.Ve 1037.Ve
494.Sp 1038.PP
495If this doesn't work, then maybe you use a \f(CW\*(C`LC_CTYPE\*(C'\fR specification not 1039If this doesn't work, then maybe you use a \f(CW\*(C`LC_CTYPE\*(C'\fR specification not
496supported on your systems. Some systems have a \f(CW\*(C`locale\*(C'\fR command which 1040supported on your systems. Some systems have a \f(CW\*(C`locale\*(C'\fR command which
497displays this (also, \f(CW\*(C`perl \-e0\*(C'\fR can be used to check locale settings, as 1041displays this (also, \f(CW\*(C`perl \-e0\*(C'\fR can be used to check locale settings, as
498it will complain loudly if it cannot set the locale). If it displays something 1042it will complain loudly if it cannot set the locale). If it displays something
499like: 1043like:
500.Sp 1044.PP
501.Vb 1 1045.Vb 1
502\& locale: Cannot set LC_CTYPE to default locale: ... 1046\& locale: Cannot set LC_CTYPE to default locale: ...
503.Ve 1047.Ve
504.Sp 1048.PP
505Then the locale you specified is not supported on your system. 1049Then the locale you specified is not supported on your system.
506.Sp 1050.PP
507If nothing works and you are sure that everything is set correctly then 1051If nothing works and you are sure that everything is set correctly then
508you will need to remember a little known fact: Some programs just don't 1052you will need to remember a little known fact: Some programs just don't
509support locales :( 1053support locales :(
510.IP "Why do some characters look so much different than others?" 4 1054.PP
511.IX Item "Why do some characters look so much different than others?" 1055\fIHow does rxvt-unicode determine the encoding to use?\fR
512.PD 0 1056.IX Subsection "How does rxvt-unicode determine the encoding to use?"
513.IP "How does rxvt-unicode choose fonts?" 4 1057.PP
514.IX Item "How does rxvt-unicode choose fonts?" 1058See next entry.
515.PD 1059.PP
516Most fonts do not contain the full range of Unicode, which is 1060\fIIs there an option to switch encodings?\fR
517fine. Chances are that the font you (or the admin/package maintainer of 1061.IX Subsection "Is there an option to switch encodings?"
518your system/os) have specified does not cover all the characters you want 1062.PP
519to display. 1063Unlike some other terminals, rxvt-unicode has no encoding switch, and no
520.Sp 1064specific \*(L"utf\-8\*(R" mode, such as xterm. In fact, it doesn't even know about
521\&\fBrxvt-unicode\fR makes a best-effort try at finding a replacement 1065\&\s-1UTF\-8\s0 or any other encodings with respect to terminal I/O.
522font. Often the result is fine, but sometimes the chosen font looks 1066.PP
523bad/ugly/wrong. Some fonts have totally strange characters that don't 1067The reasons is that there exists a perfectly fine mechanism for selecting
524resemble the correct glyph at all, and rxvt-unicode lacks the artificial 1068the encoding, doing I/O and (most important) communicating this to all
525intelligence to detect that a specific glyph is wrong: it has to believe 1069applications so everybody agrees on character properties such as width
526the font that the characters it claims to contain indeed look correct. 1070and code number. This mechanism is the \fIlocale\fR. Applications not using
527.Sp 1071that info will have problems (for example, \f(CW\*(C`xterm\*(C'\fR gets the width of
528In that case, select a font of your taste and add it to the font list, 1072characters wrong as it uses it's own, locale-independent table under all
529e.g.: 1073locales).
530.Sp 1074.PP
1075Rxvt-unicode uses the \f(CW\*(C`LC_CTYPE\*(C'\fR locale category to select encoding. All
1076programs doing the same (that is, most) will automatically agree in the
1077interpretation of characters.
1078.PP
1079Unfortunately, there is no system-independent way to select locales, nor
1080is there a standard on how locale specifiers will look like.
1081.PP
1082On most systems, the content of the \f(CW\*(C`LC_CTYPE\*(C'\fR environment variable
1083contains an arbitrary string which corresponds to an already-installed
1084locale. Common names for locales are \f(CW\*(C`en_US.UTF\-8\*(C'\fR, \f(CW\*(C`de_DE.ISO\-8859\-15\*(C'\fR,
1085\&\f(CW\*(C`ja_JP.EUC\-JP\*(C'\fR, i.e. \f(CW\*(C`language_country.encoding\*(C'\fR, but other forms
1086(i.e. \f(CW\*(C`de\*(C'\fR or \f(CW\*(C`german\*(C'\fR) are also common.
1087.PP
1088Rxvt-unicode ignores all other locale categories, and except for
1089the encoding, ignores country or language-specific settings,
1090i.e. \f(CW\*(C`de_DE.UTF\-8\*(C'\fR and \f(CW\*(C`ja_JP.UTF\-8\*(C'\fR are the normally same to
1091rxvt\-unicode.
1092.PP
1093If you want to use a specific encoding you have to make sure you start
1094rxvt-unicode with the correct \f(CW\*(C`LC_CTYPE\*(C'\fR category.
1095.PP
1096\fICan I switch locales at runtime?\fR
1097.IX Subsection "Can I switch locales at runtime?"
1098.PP
1099Yes, using an escape sequence. Try something like this, which sets
1100rxvt\-unicode's idea of \f(CW\*(C`LC_CTYPE\*(C'\fR.
1101.PP
531.Vb 1 1102.Vb 1
532\& @@RXVT_NAME@@ -fn basefont,font2,font3... 1103\& printf '\ee]701;%s\e007' ja_JP.SJIS
533.Ve 1104.Ve
534.Sp 1105.PP
535When rxvt-unicode sees a character, it will first look at the base 1106See also the previous answer.
536font. If the base font does not contain the character, it will go to the 1107.PP
537next font, and so on. Specifying your own fonts will also speed up this 1108Sometimes this capability is rather handy when you want to work in
538search and use less resources within rxvt-unicode and the X\-server. 1109one locale (e.g. \f(CW\*(C`de_DE.UTF\-8\*(C'\fR) but some programs don't support it
539.Sp 1110(e.g. \s-1UTF\-8\s0). For example, I use this script to start \f(CW\*(C`xjdic\*(C'\fR, which
540The only limitation is that none of the fonts may be larger than the base 1111first switches to a locale supported by xjdic and back later:
541font, as the base font defines the terminal character cell size, which 1112.PP
542must be the same due to the way terminals work. 1113.Vb 3
543.IP "Why do some chinese characters look so different than others?" 4 1114\& printf '\ee]701;%s\e007' ja_JP.SJIS
544.IX Item "Why do some chinese characters look so different than others?" 1115\& xjdic -js
545This is because there is a difference between script and language \*(-- 1116\& printf '\ee]701;%s\e007' de_DE.UTF-8
546rxvt-unicode does not know which language the text that is output is, 1117.Ve
547as it only knows the unicode character codes. If rxvt-unicode first 1118.PP
548sees a japanese/chinese character, it might choose a japanese font for 1119You can also use xterm's \f(CW\*(C`luit\*(C'\fR program, which usually works fine, except
549display. Subsequent japanese characters will use that font. Now, many 1120for some locales where character width differs between program\- and
550chinese characters aren't represented in japanese fonts, so when the first 1121rxvt\-unicode\-locales.
551non-japanese character comes up, rxvt-unicode will look for a chinese font 1122.PP
552\&\*(-- unfortunately at this point, it will still use the japanese font for 1123\fIMy input method wants <some encoding> but I want \s-1UTF\-8\s0, what can I do?\fR
553chinese characters that are also in the japanese font. 1124.IX Subsection "My input method wants <some encoding> but I want UTF-8, what can I do?"
554.Sp 1125.PP
555The workaround is easy: just tag a chinese font at the end of your font 1126You can specify separate locales for the input method and the rest of the
556list (see the previous question). The key is to view the font list as 1127terminal, using the resource \f(CW\*(C`imlocale\*(C'\fR:
557a preference list: If you expect more japanese, list a japanese font 1128.PP
558first. If you expect more chinese, put a chinese font first. 1129.Vb 1
559.Sp 1130\& URxvt.imlocale: ja_JP.EUC-JP
560In the future it might be possible to switch language preferences at 1131.Ve
561runtime (the internal data structure has no problem with using different 1132.PP
562fonts for the same character at the same time, but no interface for this 1133Now you can start your terminal with \f(CW\*(C`LC_CTYPE=ja_JP.UTF\-8\*(C'\fR and still
563has been designed yet). 1134use your input method. Please note, however, that you will not be able to
564.Sp 1135input characters outside \f(CW\*(C`EUC\-JP\*(C'\fR in a normal way then, as your input
565Until then, you might get away with switching fonts at runtime (see \*(L"Can I switch the fonts at runtime?\*(R" later in this document). 1136method limits you.
566.IP "Why does rxvt-unicode sometimes leave pixel droppings?" 4 1137.PP
567.IX Item "Why does rxvt-unicode sometimes leave pixel droppings?" 1138\fIRxvt-unicode crashes when the X Input Method changes or exits.\fR
568Most fonts were not designed for terminal use, which means that character 1139.IX Subsection "Rxvt-unicode crashes when the X Input Method changes or exits."
569size varies a lot. A font that is otherwise fine for terminal use might 1140.PP
570contain some characters that are simply too wide. Rxvt-unicode will avoid 1141Unfortunately, this is unavoidable, as the \s-1XIM\s0 protocol is racy by
571these characters. For characters that are just \*(L"a bit\*(R" too wide a special 1142design. Applications can avoid some crashes at the expense of memory
572\&\*(L"careful\*(R" rendering mode is used that redraws adjacent characters. 1143leaks, and Input Methods can avoid some crashes by careful ordering at
573.Sp 1144exit time. \fBkinput2\fR (and derived input methods) generally succeeds,
574All of this requires that fonts do not lie about character sizes, 1145while \fB\s-1SCIM\s0\fR (or similar input methods) fails. In the end, however,
575however: Xft fonts often draw glyphs larger than their acclaimed bounding 1146crashes cannot be completely avoided even if both sides cooperate.
576box, and rxvt-unicode has no way of detecting this (the correct way is to 1147.PP
577ask for the character bounding box, which unfortunately is wrong in these 1148So the only workaround is not to kill your Input Method Servers.
578cases). 1149.Sh "Operating Systems / Package Maintaining"
579.Sp 1150.IX Subsection "Operating Systems / Package Maintaining"
580It's not clear (to me at least), wether this is a bug in Xft, freetype, 1151\fII am using Debian GNU/Linux and have a problem...\fR
581or the respective font. If you encounter this problem you might try using 1152.IX Subsection "I am using Debian GNU/Linux and have a problem..."
582the \f(CW\*(C`\-lsp\*(C'\fR option to give the font more height. If that doesn't work, you 1153.PP
583might be forced to use a different font. 1154The Debian GNU/Linux package of rxvt-unicode in sarge contains large
584.Sp 1155patches that considerably change the behaviour of rxvt-unicode (but
585All of this is not a problem when using X11 core fonts, as their bounding 1156unfortunately this notice has been removed). Before reporting a bug to
586box data is correct. 1157the original rxvt-unicode author please download and install the genuine
1158version (<http://software.schmorp.de#rxvt\-unicode>) and try to reproduce
1159the problem. If you cannot, chances are that the problems are specific to
1160Debian GNU/Linux, in which case it should be reported via the Debian Bug
1161Tracking System (use \f(CW\*(C`reportbug\*(C'\fR to report the bug).
1162.PP
1163For other problems that also affect the Debian package, you can and
1164probably should use the Debian \s-1BTS\s0, too, because, after all, it's also a
1165bug in the Debian version and it serves as a reminder for other users that
1166might encounter the same issue.
1167.PP
1168\fII am maintaining rxvt-unicode for distribution/OS \s-1XXX\s0, any recommendation?\fR
1169.IX Subsection "I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?"
1170.PP
1171You should build one binary with the default options. \fIconfigure\fR
1172now enables most useful options, and the trend goes to making them
1173runtime\-switchable, too, so there is usually no drawback to enbaling them,
1174except higher disk and possibly memory usage. The perl interpreter should
1175be enabled, as important functionality (menus, selection, likely more in
1176the future) depends on it.
1177.PP
1178You should not overwrite the \f(CW\*(C`perl\-ext\-common\*(C'\fR snd \f(CW\*(C`perl\-ext\*(C'\fR resources
1179system-wide (except maybe with \f(CW\*(C`defaults\*(C'\fR). This will result in useful
1180behaviour. If your distribution aims at low memory, add an empty
1181\&\f(CW\*(C`perl\-ext\-common\*(C'\fR resource to the app-defaults file. This will keep the
1182perl interpreter disabled until the user enables it.
1183.PP
1184If you can/want build more binaries, I recommend building a minimal
1185one with \f(CW\*(C`\-\-disable\-everything\*(C'\fR (very useful) and a maximal one with
1186\&\f(CW\*(C`\-\-enable\-everything\*(C'\fR (less useful, it will be very big due to a lot of
1187encodings built-in that increase download times and are rarely used).
1188.PP
1189\fII need to make it setuid/setgid to support utmp/ptys on my \s-1OS\s0, is this safe?\fR
1190.IX Subsection "I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?"
1191.PP
1192It should be, starting with release 7.1. You are encouraged to properly
1193install urxvt with privileges necessary for your \s-1OS\s0 now.
1194.PP
1195When rxvt-unicode detects that it runs setuid or setgid, it will fork
1196into a helper process for privileged operations (pty handling on some
1197systems, utmp/wtmp/lastlog handling on others) and drop privileges
1198immediately. This is much safer than most other terminals that keep
1199privileges while running (but is more relevant to urxvt, as it contains
1200things as perl interpreters, which might be \*(L"helpful\*(R" to attackers).
1201.PP
1202This forking is done as the very first within \fImain()\fR, which is very early
1203and reduces possible bugs to initialisation code run before \fImain()\fR, or
1204things like the dynamic loader of your system, which should result in very
1205little risk.
1206.PP
587.IP "On Solaris 9, many line-drawing characters are too wide." 4 1207\fIOn Solaris 9, many line-drawing characters are too wide.\fR
588.IX Item "On Solaris 9, many line-drawing characters are too wide." 1208.IX Subsection "On Solaris 9, many line-drawing characters are too wide."
1209.PP
589Seems to be a known bug, read 1210Seems to be a known bug, read
590<http://nixdoc.net/files/forum/about34198.html>. Some people use the 1211<http://nixdoc.net/files/forum/about34198.html>. Some people use the
591following ugly workaround to get non-double-wide-characters working: 1212following ugly workaround to get non-double-wide-characters working:
592.Sp 1213.PP
593.Vb 1 1214.Vb 1
594\& #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x) 1215\& #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
595.Ve 1216.Ve
596.IP "My Compose (Multi_key) key is no longer working." 4 1217.PP
597.IX Item "My Compose (Multi_key) key is no longer working."
598The most common causes for this are that either your locale is not set
599correctly, or you specified a \fBpreeditStyle\fR that is not supported by
600your input method. For example, if you specified \fBOverTheSpot\fR and
601your input method (e.g. the default input method handling Compose keys)
602does not support this (for instance because it is not visual), then
603rxvt-unicode will continue without an input method.
604.Sp
605In this case either do not specify a \fBpreeditStyle\fR or specify more than
606one pre-edit style, such as \fBOverTheSpot,Root,None\fR.
607.ie n .IP "I cannot type ""Ctrl\-Shift\-2"" to get an \s-1ASCII\s0 \s-1NUL\s0 character due to \s-1ISO\s0 14755" 4
608.el .IP "I cannot type \f(CWCtrl\-Shift\-2\fR to get an \s-1ASCII\s0 \s-1NUL\s0 character due to \s-1ISO\s0 14755" 4
609.IX Item "I cannot type Ctrl-Shift-2 to get an ASCII NUL character due to ISO 14755"
610Either try \f(CW\*(C`Ctrl\-2\*(C'\fR alone (it often is mapped to \s-1ASCII\s0 \s-1NUL\s0 even on
611international keyboards) or simply use \s-1ISO\s0 14755 support to your
612advantage, typing <Ctrl\-Shift\-0> to get a \s-1ASCII\s0 \s-1NUL\s0. This works for other
613codes, too, such as \f(CW\*(C`Ctrl\-Shift\-1\-d\*(C'\fR to type the default telnet escape
614character and so on.
615.IP "How can I keep rxvt-unicode from using reverse video so much?" 4
616.IX Item "How can I keep rxvt-unicode from using reverse video so much?"
617First of all, make sure you are running with the right terminal settings
618(\f(CW\*(C`TERM=rxvt\-unicode\*(C'\fR), which will get rid of most of these effects. Then
619make sure you have specified colours for italic and bold, as otherwise
620rxvt-unicode might use reverse video to simulate the effect:
621.Sp
622.Vb 2
623\& URxvt.colorBD: white
624\& URxvt.colorIT: green
625.Ve
626.IP "Some programs assume totally weird colours (red instead of blue), how can I fix that?" 4
627.IX Item "Some programs assume totally weird colours (red instead of blue), how can I fix that?"
628For some unexplainable reason, some rare programs assume a very weird
629colour palette when confronted with a terminal with more than the standard
6308 colours (rxvt\-unicode supports 88). The right fix is, of course, to fix
631these programs not to assume non-ISO colours without very good reasons.
632.Sp
633In the meantime, you can either edit your \f(CW\*(C`rxvt\-unicode\*(C'\fR terminfo
634definition to only claim 8 colour support or use \f(CW\*(C`TERM=rxvt\*(C'\fR, which will
635fix colours but keep you from using other rxvt-unicode features.
636.IP "I am on FreeBSD and rxvt-unicode does not seem to work at all." 4 1218\fII am on FreeBSD and rxvt-unicode does not seem to work at all.\fR
637.IX Item "I am on FreeBSD and rxvt-unicode does not seem to work at all." 1219.IX Subsection "I am on FreeBSD and rxvt-unicode does not seem to work at all."
1220.PP
638Rxvt-unicode requires the symbol \f(CW\*(C`_\|_STDC_ISO_10646_\|_\*(C'\fR to be defined 1221Rxvt-unicode requires the symbol \f(CW\*(C`_\|_STDC_ISO_10646_\|_\*(C'\fR to be defined
639in your compile environment, or an implementation that implements it, 1222in your compile environment, or an implementation that implements it,
640wether it defines the symbol or not. \f(CW\*(C`_\|_STDC_ISO_10646_\|_\*(C'\fR requires that 1223wether it defines the symbol or not. \f(CW\*(C`_\|_STDC_ISO_10646_\|_\*(C'\fR requires that
641\&\fBwchar_t\fR is represented as unicode. 1224\&\fBwchar_t\fR is represented as unicode.
642.Sp 1225.PP
643As you might have guessed, FreeBSD does neither define this symobl nor 1226As you might have guessed, FreeBSD does neither define this symobl nor
644does it support it. Instead, it uses it's own internal representation of 1227does it support it. Instead, it uses it's own internal representation of
645\&\fBwchar_t\fR. This is, of course, completely fine with respect to standards. 1228\&\fBwchar_t\fR. This is, of course, completely fine with respect to standards.
646.Sp 1229.PP
647However, that means rxvt-unicode only works in \f(CW\*(C`POSIX\*(C'\fR, \f(CW\*(C`ISO\-8859\-1\*(C'\fR and 1230However, that means rxvt-unicode only works in \f(CW\*(C`POSIX\*(C'\fR, \f(CW\*(C`ISO\-8859\-1\*(C'\fR and
648\&\f(CW\*(C`UTF\-8\*(C'\fR locales under FreeBSD (which all use Unicode as \fBwchar_t\fR. 1231\&\f(CW\*(C`UTF\-8\*(C'\fR locales under FreeBSD (which all use Unicode as \fBwchar_t\fR.
649.Sp 1232.PP
650\&\f(CW\*(C`_\|_STDC_ISO_10646_\|_\*(C'\fR is the only sane way to support multi-language 1233\&\f(CW\*(C`_\|_STDC_ISO_10646_\|_\*(C'\fR is the only sane way to support multi-language
651apps in an \s-1OS\s0, as using a locale-dependent (and non\-standardized) 1234apps in an \s-1OS\s0, as using a locale-dependent (and non\-standardized)
652representation of \fBwchar_t\fR makes it impossible to convert between 1235representation of \fBwchar_t\fR makes it impossible to convert between
653\&\fBwchar_t\fR (as used by X11 and your applications) and any other encoding 1236\&\fBwchar_t\fR (as used by X11 and your applications) and any other encoding
654without implementing OS-specific-wrappers for each and every locale. There 1237without implementing OS-specific-wrappers for each and every locale. There
655simply are no APIs to convert \fBwchar_t\fR into anything except the current 1238simply are no APIs to convert \fBwchar_t\fR into anything except the current
656locale encoding. 1239locale encoding.
657.Sp 1240.PP
658Some applications (such as the formidable \fBmlterm\fR) work around this 1241Some applications (such as the formidable \fBmlterm\fR) work around this
659by carrying their own replacement functions for character set handling 1242by carrying their own replacement functions for character set handling
660with them, and either implementing OS-dependent hacks or doing multiple 1243with them, and either implementing OS-dependent hacks or doing multiple
661conversions (which is slow and unreliable in case the \s-1OS\s0 implements 1244conversions (which is slow and unreliable in case the \s-1OS\s0 implements
662encodings slightly different than the terminal emulator). 1245encodings slightly different than the terminal emulator).
663.Sp 1246.PP
664The rxvt-unicode author insists that the right way to fix this is in the 1247The rxvt-unicode author insists that the right way to fix this is in the
665system libraries once and for all, instead of forcing every app to carry 1248system libraries once and for all, instead of forcing every app to carry
666complete replacements for them :) 1249complete replacements for them :)
1250.PP
667.IP "I use Solaris 9 and it doesn't compile/work/etc." 4 1251\fII use Solaris 9 and it doesn't compile/work/etc.\fR
668.IX Item "I use Solaris 9 and it doesn't compile/work/etc." 1252.IX Subsection "I use Solaris 9 and it doesn't compile/work/etc."
1253.PP
669Try the diff in \fIdoc/solaris9.patch\fR as a base. It fixes the worst 1254Try the diff in \fIdoc/solaris9.patch\fR as a base. It fixes the worst
670problems with \f(CW\*(C`wcwidth\*(C'\fR and a compile problem. 1255problems with \f(CW\*(C`wcwidth\*(C'\fR and a compile problem.
1256.PP
671.IP "How can I use rxvt-unicode under cygwin?" 4 1257\fIHow can I use rxvt-unicode under cygwin?\fR
672.IX Item "How can I use rxvt-unicode under cygwin?" 1258.IX Subsection "How can I use rxvt-unicode under cygwin?"
1259.PP
673rxvt-unicode should compile and run out of the box on cygwin, using 1260rxvt-unicode should compile and run out of the box on cygwin, using
674the X11 libraries that come with cygwin. libW11 emulation is no 1261the X11 libraries that come with cygwin. libW11 emulation is no
675longer supported (and makes no sense, either, as it only supported a 1262longer supported (and makes no sense, either, as it only supported a
676single font). I recommend starting the X\-server in \f(CW\*(C`\-multiwindow\*(C'\fR or 1263single font). I recommend starting the X\-server in \f(CW\*(C`\-multiwindow\*(C'\fR or
677\&\f(CW\*(C`\-rootless\*(C'\fR mode instead, which will result in similar look&feel as the 1264\&\f(CW\*(C`\-rootless\*(C'\fR mode instead, which will result in similar look&feel as the
678old libW11 emulation. 1265old libW11 emulation.
679.Sp 1266.PP
680At the time of this writing, cygwin didn't seem to support any multi-byte 1267At the time of this writing, cygwin didn't seem to support any multi-byte
681encodings (you might try \f(CW\*(C`LC_CTYPE=C\-UTF\-8\*(C'\fR), so you are likely limited 1268encodings (you might try \f(CW\*(C`LC_CTYPE=C\-UTF\-8\*(C'\fR), so you are likely limited
682to 8\-bit encodings. 1269to 8\-bit encodings.
683.IP "How does rxvt-unicode determine the encoding to use?" 4
684.IX Item "How does rxvt-unicode determine the encoding to use?"
685.PD 0
686.IP "Is there an option to switch encodings?" 4
687.IX Item "Is there an option to switch encodings?"
688.PD
689Unlike some other terminals, rxvt-unicode has no encoding switch, and no
690specific \*(L"utf\-8\*(R" mode, such as xterm. In fact, it doesn't even know about
691\&\s-1UTF\-8\s0 or any other encodings with respect to terminal I/O.
692.Sp
693The reasons is that there exists a perfectly fine mechanism for selecting
694the encoding, doing I/O and (most important) communicating this to all
695applications so everybody agrees on character properties such as width
696and code number. This mechanism is the \fIlocale\fR. Applications not using
697that info will have problems (for example, \f(CW\*(C`xterm\*(C'\fR gets the width of
698characters wrong as it uses it's own, locale-independent table under all
699locales).
700.Sp
701Rxvt-unicode uses the \f(CW\*(C`LC_CTYPE\*(C'\fR locale category to select encoding. All
702programs doing the same (that is, most) will automatically agree in the
703interpretation of characters.
704.Sp
705Unfortunately, there is no system-independent way to select locales, nor
706is there a standard on how locale specifiers will look like.
707.Sp
708On most systems, the content of the \f(CW\*(C`LC_CTYPE\*(C'\fR environment variable
709contains an arbitrary string which corresponds to an already-installed
710locale. Common names for locales are \f(CW\*(C`en_US.UTF\-8\*(C'\fR, \f(CW\*(C`de_DE.ISO\-8859\-15\*(C'\fR,
711\&\f(CW\*(C`ja_JP.EUC\-JP\*(C'\fR, i.e. \f(CW\*(C`language_country.encoding\*(C'\fR, but other forms
712(i.e. \f(CW\*(C`de\*(C'\fR or \f(CW\*(C`german\*(C'\fR) are also common.
713.Sp
714Rxvt-unicode ignores all other locale categories, and except for
715the encoding, ignores country or language-specific settings,
716i.e. \f(CW\*(C`de_DE.UTF\-8\*(C'\fR and \f(CW\*(C`ja_JP.UTF\-8\*(C'\fR are the normally same to
717rxvt\-unicode.
718.Sp
719If you want to use a specific encoding you have to make sure you start
720rxvt-unicode with the correct \f(CW\*(C`LC_CTYPE\*(C'\fR category.
721.IP "Can I switch locales at runtime?" 4
722.IX Item "Can I switch locales at runtime?"
723Yes, using an escape sequence. Try something like this, which sets
724rxvt\-unicode's idea of \f(CW\*(C`LC_CTYPE\*(C'\fR.
725.Sp
726.Vb 1
727\& printf '\ee]701;%s\e007' ja_JP.SJIS
728.Ve
729.Sp
730See also the previous answer.
731.Sp
732Sometimes this capability is rather handy when you want to work in
733one locale (e.g. \f(CW\*(C`de_DE.UTF\-8\*(C'\fR) but some programs don't support it
734(e.g. \s-1UTF\-8\s0). For example, I use this script to start \f(CW\*(C`xjdic\*(C'\fR, which
735first switches to a locale supported by xjdic and back later:
736.Sp
737.Vb 3
738\& printf '\ee]701;%s\e007' ja_JP.SJIS
739\& xjdic -js
740\& printf '\ee]701;%s\e007' de_DE.UTF-8
741.Ve
742.Sp
743You can also use xterm's \f(CW\*(C`luit\*(C'\fR program, which usually works fine, except
744for some locales where character width differs between program\- and
745rxvt\-unicode\-locales.
746.IP "Can I switch the fonts at runtime?" 4
747.IX Item "Can I switch the fonts at runtime?"
748Yes, using an escape sequence. Try something like this, which has the same
749effect as using the \f(CW\*(C`\-fn\*(C'\fR switch, and takes effect immediately:
750.Sp
751.Vb 1
752\& printf '\ee]50;%s\e007' "9x15bold,xft:Kochi Gothic"
753.Ve
754.Sp
755This is useful if you e.g. work primarily with japanese (and prefer a
756japanese font), but you have to switch to chinese temporarily, where
757japanese fonts would only be in your way.
758.Sp
759You can think of this as a kind of manual \s-1ISO\-2022\s0 switching.
760.IP "Why do italic characters look as if clipped?" 4
761.IX Item "Why do italic characters look as if clipped?"
762Many fonts have difficulties with italic characters and hinting. For
763example, the otherwise very nicely hinted font \f(CW\*(C`xft:Bitstream Vera Sans
764Mono\*(C'\fR completely fails in it's italic face. A workaround might be to
765enable freetype autohinting, i.e. like this:
766.Sp
767.Vb 2
768\& URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
769\& URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
770.Ve
771.IP "My input method wants <some encoding> but I want \s-1UTF\-8\s0, what can I do?" 4
772.IX Item "My input method wants <some encoding> but I want UTF-8, what can I do?"
773You can specify separate locales for the input method and the rest of the
774terminal, using the resource \f(CW\*(C`imlocale\*(C'\fR:
775.Sp
776.Vb 1
777\& URxvt*imlocale: ja_JP.EUC-JP
778.Ve
779.Sp
780Now you can start your terminal with \f(CW\*(C`LC_CTYPE=ja_JP.UTF\-8\*(C'\fR and still
781use your input method. Please note, however, that you will not be able to
782input characters outside \f(CW\*(C`EUC\-JP\*(C'\fR in a normal way then, as your input
783method limits you.
784.IP "Rxvt-unicode crashes when the X Input Method changes or exits." 4
785.IX Item "Rxvt-unicode crashes when the X Input Method changes or exits."
786Unfortunately, this is unavoidable, as the \s-1XIM\s0 protocol is racy by
787design. Applications can avoid some crashes at the expense of memory
788leaks, and Input Methods can avoid some crashes by careful ordering at
789exit time. \fBkinput2\fR (and derived input methods) generally succeeds,
790while \fB\s-1SCIM\s0\fR (or similar input methods) fails. In the end, however,
791crashes cannot be completely avoided even if both sides cooperate.
792.Sp
793So the only workaround is not to kill your Input Method Servers.
794.IP "Rxvt-unicode uses gobs of memory, how can I reduce that?" 4
795.IX Item "Rxvt-unicode uses gobs of memory, how can I reduce that?"
796Rxvt-unicode tries to obey the rule of not charging you for something you
797don't use. One thing you should try is to configure out all settings that
798you don't need, for example, Xft support is a resource hog by design,
799when used. Compiling it out ensures that no Xft font will be loaded
800accidentally when rxvt-unicode tries to find a font for your characters.
801.Sp
802Also, many people (me included) like large windows and even larger
803scrollback buffers: Without \f(CW\*(C`\-\-enable\-unicode3\*(C'\fR, rxvt-unicode will use
8046 bytes per screen cell. For a 160x?? window this amounts to almost a
805kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
806use 10 Megabytes of memory. With \f(CW\*(C`\-\-enable\-unicode3\*(C'\fR it gets worse, as
807rxvt-unicode then uses 8 bytes per screen cell.
808.IP "Can I speed up Xft rendering somehow?" 4
809.IX Item "Can I speed up Xft rendering somehow?"
810Yes, the most obvious way to speed it up is to avoid Xft entirely, as
811it is simply slow. If you still want Xft fonts you might try to disable
812antialiasing (by appending \f(CW\*(C`:antialias=false\*(C'\fR), which saves lots of
813memory and also speeds up rendering considerably.
814.IP "Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?" 4
815.IX Item "Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?"
816Rxvt-unicode will use whatever you specify as a font. If it needs to
817fall back to it's default font search list it will prefer X11 core
818fonts, because they are small and fast, and then use Xft fonts. It has
819antialiasing disabled for most of them, because the author thinks they
820look best that way.
821.Sp
822If you want antialiasing, you have to specify the fonts manually.
823.IP "Mouse cut/paste suddenly no longer works." 4
824.IX Item "Mouse cut/paste suddenly no longer works."
825Make sure that mouse reporting is actually turned off since killing
826some editors prematurely may leave the mouse in mouse report mode. I've
827heard that tcsh may use mouse reporting unless it otherwise specified. A
828quick check is to see if cut/paste works when the Alt or Shift keys are
829depressed. See @@RXVT_NAME@@(7)
830.IP "What's with this bold/blink stuff?" 4
831.IX Item "What's with this bold/blink stuff?"
832If no bold colour is set via \f(CW\*(C`colorBD:\*(C'\fR, bold will invert text using the
833standard foreground colour.
834.Sp
835For the standard background colour, blinking will actually make the
836text blink when compiled with \f(CW\*(C`\-\-enable\-blinking\*(C'\fR. with standard
837colours. Without \f(CW\*(C`\-\-enable\-blinking\*(C'\fR, the blink attribute will be
838ignored.
839.Sp
840On \s-1ANSI\s0 colours, bold/blink attributes are used to set high-intensity
841foreground/background colors.
842.Sp
843color0\-7 are the low-intensity colors.
844.Sp
845color8\-15 are the corresponding high-intensity colors.
846.IP "I don't like the screen colors. How do I change them?" 4
847.IX Item "I don't like the screen colors. How do I change them?"
848You can change the screen colors at run-time using \fI~/.Xdefaults\fR
849resources (or as long\-options).
850.Sp
851Here are values that are supposed to resemble a \s-1VGA\s0 screen,
852including the murky brown that passes for low-intensity yellow:
853.Sp
854.Vb 8
855\& URxvt.color0: #000000
856\& URxvt.color1: #A80000
857\& URxvt.color2: #00A800
858\& URxvt.color3: #A8A800
859\& URxvt.color4: #0000A8
860\& URxvt.color5: #A800A8
861\& URxvt.color6: #00A8A8
862\& URxvt.color7: #A8A8A8
863.Ve
864.Sp
865.Vb 8
866\& URxvt.color8: #000054
867\& URxvt.color9: #FF0054
868\& URxvt.color10: #00FF54
869\& URxvt.color11: #FFFF54
870\& URxvt.color12: #0000FF
871\& URxvt.color13: #FF00FF
872\& URxvt.color14: #00FFFF
873\& URxvt.color15: #FFFFFF
874.Ve
875.Sp
876And here is a more complete set of non-standard colors described (not by
877me) as \*(L"pretty girly\*(R".
878.Sp
879.Vb 18
880\& URxvt.cursorColor: #dc74d1
881\& URxvt.pointerColor: #dc74d1
882\& URxvt.background: #0e0e0e
883\& URxvt.foreground: #4ad5e1
884\& URxvt.color0: #000000
885\& URxvt.color8: #8b8f93
886\& URxvt.color1: #dc74d1
887\& URxvt.color9: #dc74d1
888\& URxvt.color2: #0eb8c7
889\& URxvt.color10: #0eb8c7
890\& URxvt.color3: #dfe37e
891\& URxvt.color11: #dfe37e
892\& URxvt.color5: #9e88f0
893\& URxvt.color13: #9e88f0
894\& URxvt.color6: #73f7ff
895\& URxvt.color14: #73f7ff
896\& URxvt.color7: #e1dddd
897\& URxvt.color15: #e1dddd
898.Ve
899.IP "How can I start @@RXVT_NAME@@d in a race-free way?" 4
900.IX Item "How can I start @@RXVT_NAME@@d in a race-free way?"
901Try \f(CW\*(C`@@RXVT_NAME@@d \-f \-o\*(C'\fR, which tells @@RXVT_NAME@@d to open the
902display, create the listening socket and then fork.
903.IP "What's with the strange Backspace/Delete key behaviour?" 4
904.IX Item "What's with the strange Backspace/Delete key behaviour?"
905Assuming that the physical Backspace key corresponds to the
906BackSpace keysym (not likely for Linux ... see the following
907question) there are two standard values that can be used for
908Backspace: \f(CW\*(C`^H\*(C'\fR and \f(CW\*(C`^?\*(C'\fR.
909.Sp
910Historically, either value is correct, but rxvt-unicode adopts the debian
911policy of using \f(CW\*(C`^?\*(C'\fR when unsure, because it's the one only only correct
912choice :).
913.Sp
914Rxvt-unicode tries to inherit the current stty settings and uses the value
915of `erase' to guess the value for backspace. If rxvt-unicode wasn't
916started from a terminal (say, from a menu or by remote shell), then the
917system value of `erase', which corresponds to \s-1CERASE\s0 in <termios.h>, will
918be used (which may not be the same as your stty setting).
919.Sp
920For starting a new rxvt\-unicode:
921.Sp
922.Vb 3
923\& # use Backspace = ^H
924\& $ stty erase ^H
925\& $ @@RXVT_NAME@@
926.Ve
927.Sp
928.Vb 3
929\& # use Backspace = ^?
930\& $ stty erase ^?
931\& $ @@RXVT_NAME@@
932.Ve
933.Sp
934Toggle with \f(CW\*(C`ESC [ 36 h\*(C'\fR / \f(CW\*(C`ESC [ 36 l\*(C'\fR as documented in @@RXVT_NAME@@(7).
935.Sp
936For an existing rxvt\-unicode:
937.Sp
938.Vb 3
939\& # use Backspace = ^H
940\& $ stty erase ^H
941\& $ echo -n "^[[36h"
942.Ve
943.Sp
944.Vb 3
945\& # use Backspace = ^?
946\& $ stty erase ^?
947\& $ echo -n "^[[36l"
948.Ve
949.Sp
950This helps satisfy some of the Backspace discrepancies that occur, but
951if you use Backspace = \f(CW\*(C`^H\*(C'\fR, make sure that the termcap/terminfo value
952properly reflects that.
953.Sp
954The Delete key is a another casualty of the ill-defined Backspace problem.
955To avoid confusion between the Backspace and Delete keys, the Delete
956key has been assigned an escape sequence to match the vt100 for Execute
957(\f(CW\*(C`ESC [ 3 ~\*(C'\fR) and is in the supplied termcap/terminfo.
958.Sp
959Some other Backspace problems:
960.Sp
961some editors use termcap/terminfo,
962some editors (vim I'm told) expect Backspace = ^H,
963\&\s-1GNU\s0 Emacs (and Emacs-like editors) use ^H for help.
964.Sp
965Perhaps someday this will all be resolved in a consistent manner.
966.IP "I don't like the key\-bindings. How do I change them?" 4
967.IX Item "I don't like the key-bindings. How do I change them?"
968There are some compile-time selections available via configure. Unless
969you have run \*(L"configure\*(R" with the \f(CW\*(C`\-\-disable\-resources\*(C'\fR option you can
970use the `keysym' resource to alter the keystrings associated with keysyms.
971.Sp
972Here's an example for a URxvt session started using \f(CW\*(C`@@RXVT_NAME@@ \-name URxvt\*(C'\fR
973.Sp
974.Vb 20
975\& URxvt.keysym.Home: \e033[1~
976\& URxvt.keysym.End: \e033[4~
977\& URxvt.keysym.C-apostrophe: \e033<C-'>
978\& URxvt.keysym.C-slash: \e033<C-/>
979\& URxvt.keysym.C-semicolon: \e033<C-;>
980\& URxvt.keysym.C-grave: \e033<C-`>
981\& URxvt.keysym.C-comma: \e033<C-,>
982\& URxvt.keysym.C-period: \e033<C-.>
983\& URxvt.keysym.C-0x60: \e033<C-`>
984\& URxvt.keysym.C-Tab: \e033<C-Tab>
985\& URxvt.keysym.C-Return: \e033<C-Return>
986\& URxvt.keysym.S-Return: \e033<S-Return>
987\& URxvt.keysym.S-space: \e033<S-Space>
988\& URxvt.keysym.M-Up: \e033<M-Up>
989\& URxvt.keysym.M-Down: \e033<M-Down>
990\& URxvt.keysym.M-Left: \e033<M-Left>
991\& URxvt.keysym.M-Right: \e033<M-Right>
992\& URxvt.keysym.M-C-0: list \e033<M-C- 0123456789 >
993\& URxvt.keysym.M-C-a: list \e033<M-C- abcdefghijklmnopqrstuvwxyz >
994\& URxvt.keysym.F12: command:\e033]701;zh_CN.GBK\e007
995.Ve
996.Sp
997See some more examples in the documentation for the \fBkeysym\fR resource.
998.IP "I'm using keyboard model \s-1XXX\s0 that has extra Prior/Next/Insert keys. How do I make use of them? For example, the Sun Keyboard type 4 has the following mappings that rxvt-unicode doesn't recognize." 4
999.IX Item "I'm using keyboard model XXX that has extra Prior/Next/Insert keys. How do I make use of them? For example, the Sun Keyboard type 4 has the following mappings that rxvt-unicode doesn't recognize."
1000.Vb 6
1001\& KP_Insert == Insert
1002\& F22 == Print
1003\& F27 == Home
1004\& F29 == Prior
1005\& F33 == End
1006\& F35 == Next
1007.Ve
1008.Sp
1009Rather than have rxvt-unicode try to accommodate all the various possible
1010keyboard mappings, it is better to use `xmodmap' to remap the keys as
1011required for your particular machine.
1012.IP "How do I distinguish wether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc." 4
1013.IX Item "How do I distinguish wether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc."
1014rxvt and rxvt-unicode always export the variable \*(L"\s-1COLORTERM\s0\*(R", so you can
1015check and see if that is set. Note that several programs, \s-1JED\s0, slrn,
1016Midnight Commander automatically check this variable to decide whether or
1017not to use color.
1018.IP "How do I set the correct, full \s-1IP\s0 address for the \s-1DISPLAY\s0 variable?" 4
1019.IX Item "How do I set the correct, full IP address for the DISPLAY variable?"
1020If you've compiled rxvt-unicode with \s-1DISPLAY_IS_IP\s0 and have enabled
1021insecure mode then it is possible to use the following shell script
1022snippets to correctly set the display. If your version of rxvt-unicode
1023wasn't also compiled with \s-1ESCZ_ANSWER\s0 (as assumed in these snippets) then
1024the \s-1COLORTERM\s0 variable can be used to distinguish rxvt-unicode from a
1025regular xterm.
1026.Sp
1027Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
1028snippets:
1029.Sp
1030.Vb 12
1031\& # Bourne/Korn/POSIX family of shells:
1032\& [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
1033\& if [ ${TERM:-foo} = xterm ]; then
1034\& stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
1035\& echo -n '^[Z'
1036\& read term_id
1037\& stty icanon echo
1038\& if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
1039\& echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
1040\& read DISPLAY # set it in our local shell
1041\& fi
1042\& fi
1043.Ve
1044.IP "How do I compile the manual pages for myself?" 4
1045.IX Item "How do I compile the manual pages for myself?"
1046You need to have a recent version of perl installed as \fI/usr/bin/perl\fR,
1047one that comes with \fIpod2man\fR, \fIpod2text\fR and \fIpod2html\fR. Then go to
1048the doc subdirectory and enter \f(CW\*(C`make alldoc\*(C'\fR.
1049.IP "My question isn't answered here, can I ask a human?" 4
1050.IX Item "My question isn't answered here, can I ask a human?"
1051Before sending me mail, you could go to \s-1IRC:\s0 \f(CW\*(C`irc.freenode.net\*(C'\fR,
1052channel \f(CW\*(C`#rxvt\-unicode\*(C'\fR has some rxvt-unicode enthusiasts that might be
1053interested in learning about new and exciting problems (but not FAQs :).
1054.SH "RXVT TECHNICAL REFERENCE" 1270.SH "RXVT-UNICODE TECHNICAL REFERENCE"
1055.IX Header "RXVT TECHNICAL REFERENCE" 1271.IX Header "RXVT-UNICODE TECHNICAL REFERENCE"
1056.SH "DESCRIPTION" 1272.SH "DESCRIPTION"
1057.IX Header "DESCRIPTION" 1273.IX Header "DESCRIPTION"
1058The rest of this document describes various technical aspects of 1274The rest of this document describes various technical aspects of
1059\&\fBrxvt-unicode\fR. First the description of supported command sequences, 1275\&\fBrxvt-unicode\fR. First the description of supported command sequences,
1060followed by menu and pixmap support and last by a description of all 1276followed by pixmap support and last by a description of all features
1061features selectable at \f(CW\*(C`configure\*(C'\fR time. 1277selectable at \f(CW\*(C`configure\*(C'\fR time.
1062.SH "Definitions" 1278.SH "Definitions"
1063.IX Header "Definitions" 1279.IX Header "Definitions"
1064.ie n .IP "\fB\fB""c""\fB\fR" 4 1280.ie n .IP "\fB\fB""c""\fB\fR" 4
1065.el .IP "\fB\f(CBc\fB\fR" 4 1281.el .IP "\fB\f(CBc\fB\fR" 4
1066.IX Item "c" 1282.IX Item "c"
1613l l . 1829l l .
1614h Send Mouse X & Y on button press. 1830h Send Mouse X & Y on button press.
1615l No mouse reporting. 1831l No mouse reporting.
1616.TE 1832.TE
1617 1833
1618.ie n .IP "\fB\fB""Ps = 10""\fB\fR (\fBrxvt\fR)" 4
1619.el .IP "\fB\f(CBPs = 10\fB\fR (\fBrxvt\fR)" 4
1620.IX Item "Ps = 10 (rxvt)"
1621.TS
1622l l .
1623h menuBar visible
1624l menuBar invisible
1625.TE
1626
1627.ie n .IP "\fB\fB""Ps = 25""\fB\fR" 4 1834.ie n .IP "\fB\fB""Ps = 25""\fB\fR" 4
1628.el .IP "\fB\f(CBPs = 25\fB\fR" 4 1835.el .IP "\fB\f(CBPs = 25\fB\fR" 4
1629.IX Item "Ps = 25" 1836.IX Item "Ps = 25"
1630.TS 1837.TS
1631l l . 1838l l .
1817Ps = 12 Change colour of text cursor foreground to Pt 2024Ps = 12 Change colour of text cursor foreground to Pt
1818Ps = 13 Change colour of mouse foreground to Pt 2025Ps = 13 Change colour of mouse foreground to Pt
1819Ps = 17 Change colour of highlight characters to Pt 2026Ps = 17 Change colour of highlight characters to Pt
1820Ps = 18 Change colour of bold characters to Pt [deprecated, see 706] 2027Ps = 18 Change colour of bold characters to Pt [deprecated, see 706]
1821Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707] 2028Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707]
1822Ps = 20 Change default background to Pt 2029Ps = 20 Change background pixmap parameters (see section XPM) (Compile XPM).
1823Ps = 39 Change default foreground colour to Pt. 2030Ps = 39 Change default foreground colour to Pt.
1824Ps = 46 Change Log File to Pt unimplemented 2031Ps = 46 Change Log File to Pt unimplemented
1825Ps = 49 Change default background colour to Pt. 2032Ps = 49 Change default background colour to Pt.
1826Ps = 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 2033Ps = 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
1827Ps = 55 Log all scrollback buffer and all of screen to Pt 2034Ps = 55 Log all scrollback buffer and all of screen to Pt
1828Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills). 2035Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills).
1829Ps = 703 Menubar command Pt (Compile menubar). 2036Ps = 702 Request version if Pt is ?, returning rxvt-unicode, the resource name, the major and minor version numbers, e.g. ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST.
1830Ps = 704 Change colour of italic characters to Pt 2037Ps = 704 Change colour of italic characters to Pt
1831Ps = 705 Change background pixmap tint colour to Pt (Compile transparency). 2038Ps = 705 Change background pixmap tint colour to Pt (Compile transparency).
1832Ps = 706 Change colour of bold characters to Pt 2039Ps = 706 Change colour of bold characters to Pt
1833Ps = 707 Change colour of underlined characters to Pt 2040Ps = 707 Change colour of underlined characters to Pt
1834Ps = 710 Set normal fontset to Pt. Same as Ps = 50. 2041Ps = 710 Set normal fontset to Pt. Same as Ps = 50.
1840Ps = 777 Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl). 2047Ps = 777 Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl).
1841.TE 2048.TE
1842 2049
1843.PP 2050.PP
1844 2051
1845.IX Xref "menuBar" 2052.IX Xref "XPM"
1846.SH "menuBar"
1847.IX Header "menuBar"
1848\&\fBThe exact syntax used is \f(BIalmost\fB solidified.\fR
1849In the menus, \fB\s-1DON\s0'T\fR try to use menuBar commands that add or remove a
1850menuBar.
1851.PP
1852Note that in all of the commands, the \fB\f(BI/path/\fB\fR \fIcannot\fR be
1853omitted: use \fB./\fR to specify a menu relative to the current menu.
1854.Sh "Overview of menuBar operation"
1855.IX Subsection "Overview of menuBar operation"
1856For the menuBar XTerm escape sequence \f(CW\*(C`ESC ] 703 ; Pt ST\*(C'\fR, the syntax
1857of \f(CW\*(C`Pt\*(C'\fR can be used for a variety of tasks:
1858.PP
1859At the top level is the current menuBar which is a member of a circular
1860linked-list of other such menuBars.
1861.PP
1862The menuBar acts as a parent for the various drop-down menus, which in
1863turn, may have labels, separator lines, menuItems and subMenus.
1864.PP
1865The menuItems are the useful bits: you can use them to mimic keyboard
1866input or even to send text or escape sequences back to rxvt.
1867.PP
1868The menuBar syntax is intended to provide a simple yet robust method of
1869constructing and manipulating menus and navigating through the
1870menuBars.
1871.PP
1872The first step is to use the tag \fB[menu:\f(BIname\fB]\fR which creates
1873the menuBar called \fIname\fR and allows access. You may now or menus,
1874subMenus, and menuItems. Finally, use the tag \fB[done]\fR to set the
1875menuBar access as \fBreadonly\fR to prevent accidental corruption of the
1876menus. To re-access the current menuBar for alterations, use the tag
1877\&\fB[menu]\fR, make the alterations and then use \fB[done]\fR
1878.PP
1879
1880.IX Xref "menuBarCommands"
1881.Sh "Commands"
1882.IX Subsection "Commands"
1883.IP "\fB[menu:+\f(BIname\fB]\fR" 4
1884.IX Item "[menu:+name]"
1885access the named menuBar for creation or alteration. If a new menuBar
1886is created, it is called \fIname\fR (max of 15 chars) and the current
1887menuBar is pushed onto the stack
1888.IP "\fB[menu]\fR" 4
1889.IX Item "[menu]"
1890access the current menuBar for alteration
1891.IP "\fB[title:+\f(BIstring\fB]\fR" 4
1892.IX Item "[title:+string]"
1893set the current menuBar's title to \fIstring\fR, which may contain the
1894following format specifiers:
1895.Sp
1896.Vb 3
1897\& B<%n> rxvt name (as per the B<-name> command-line option)
1898\& B<%v> rxvt version
1899\& B<%%> literal B<%> character
1900.Ve
1901.IP "\fB[done]\fR" 4
1902.IX Item "[done]"
1903set menuBar access as \fBreadonly\fR.
1904End-of-file tag for \fB[read:+\f(BIfile\fB]\fR operations.
1905.IP "\fB[read:+\f(BIfile\fB]\fR" 4
1906.IX Item "[read:+file]"
1907read menu commands directly from \fIfile\fR (extension \*(L".menu\*(R" will be
1908appended if required.) Start reading at a line with \fB[menu]\fR or \fB[menu:+\f(BIname\fB\fR and continuing until \fB[done]\fR is encountered.
1909.Sp
1910Blank and comment lines (starting with \fB#\fR) are ignored. Actually,
1911since any invalid menu commands are also ignored, almost anything could
1912be construed as a comment line, but this may be tightened up in the
1913future ... so don't count on it!.
1914.IP "\fB[read:+\f(BIfile\fB;+\f(BIname\fB]\fR" 4
1915.IX Item "[read:+file;+name]"
1916The same as \fB[read:+\f(BIfile\fB]\fR, but start reading at a line with
1917\&\fB[menu:+\f(BIname\fB]\fR and continuing until \fB[done:+\f(BIname\fB]\fR or
1918\&\fB[done]\fR is encountered.
1919.IP "\fB[dump]\fR" 4
1920.IX Item "[dump]"
1921dump all menuBars to the file \fB/tmp/rxvt\-PID\fR in a format suitable for
1922later rereading.
1923.IP "\fB[rm:name]\fR" 4
1924.IX Item "[rm:name]"
1925remove the named menuBar
1926.IP "\fB[rm] [rm:]\fR" 4
1927.IX Item "[rm] [rm:]"
1928remove the current menuBar
1929.IP "\fB[rm*] [rm:*]\fR" 4
1930.IX Item "[rm*] [rm:*]"
1931remove all menuBars
1932.IP "\fB[swap]\fR" 4
1933.IX Item "[swap]"
1934swap the top two menuBars
1935.IP "\fB[prev]\fR" 4
1936.IX Item "[prev]"
1937access the previous menuBar
1938.IP "\fB[next]\fR" 4
1939.IX Item "[next]"
1940access the next menuBar
1941.IP "\fB[show]\fR" 4
1942.IX Item "[show]"
1943Enable display of the menuBar
1944.IP "\fB[hide]\fR" 4
1945.IX Item "[hide]"
1946Disable display of the menuBar
1947.IP "\fB[pixmap:+\f(BIname\fB]\fR" 4
1948.IX Item "[pixmap:+name]"
1949.PD 0
1950.IP "\fB[pixmap:+\f(BIname\fB;\f(BIscaling\fB]\fR" 4
1951.IX Item "[pixmap:+name;scaling]"
1952.PD
1953(set the background pixmap globally
1954.Sp
1955\&\fBA Future implementation \f(BImay\fB make this local to the menubar\fR)
1956.IP "\fB[:+\f(BIcommand\fB:]\fR" 4
1957.IX Item "[:+command:]"
1958ignore the menu readonly status and issue a \fIcommand\fR to or a menu or
1959menuitem or change the ; a useful shortcut for setting the quick arrows
1960from a menuBar.
1961.PP
1962
1963.IX Xref "menuBarAdd"
1964.Sh "Adding and accessing menus"
1965.IX Subsection "Adding and accessing menus"
1966The following commands may also be \fB+\fR prefixed.
1967.IP "\fB/+\fR" 4
1968.IX Item "/+"
1969access menuBar top level
1970.IP "\fB./+\fR" 4
1971.IX Item "./+"
1972access current menu level
1973.IP "\fB../+\fR" 4
1974.IX Item "../+"
1975access parent menu (1 level up)
1976.IP "\fB../../\fR" 4
1977.IX Item "../../"
1978access parent menu (multiple levels up)
1979.IP "\fB\f(BI/path/\fBmenu\fR" 4
1980.IX Item "/path/menu"
1981add/access menu
1982.IP "\fB\f(BI/path/\fBmenu/*\fR" 4
1983.IX Item "/path/menu/*"
1984add/access menu and clear it if it exists
1985.IP "\fB\f(BI/path/\fB{\-}\fR" 4
1986.IX Item "/path/{-}"
1987add separator
1988.IP "\fB\f(BI/path/\fB{item}\fR" 4
1989.IX Item "/path/{item}"
1990add \fBitem\fR as a label
1991.IP "\fB\f(BI/path/\fB{item} action\fR" 4
1992.IX Item "/path/{item} action"
1993add/alter \fImenuitem\fR with an associated \fIaction\fR
1994.IP "\fB\f(BI/path/\fB{item}{right\-text}\fR" 4
1995.IX Item "/path/{item}{right-text}"
1996add/alter \fImenuitem\fR with \fBright-text\fR as the right-justified text
1997and as the associated \fIaction\fR
1998.IP "\fB\f(BI/path/\fB{item}{rtext} action\fR" 4
1999.IX Item "/path/{item}{rtext} action"
2000add/alter \fImenuitem\fR with an associated \fIaction\fR and with \fBrtext\fR as
2001the right-justified text.
2002.IP "Special characters in \fIaction\fR must be backslash\-escaped:" 4
2003.IX Item "Special characters in action must be backslash-escaped:"
2004\&\fB\ea \eb \eE \ee \en \er \et \eoctal\fR
2005.IP "or in control-character notation:" 4
2006.IX Item "or in control-character notation:"
2007\&\fB^@, ^A .. ^Z .. ^_, ^?\fR
2008.PP
2009To send a string starting with a \fB\s-1NUL\s0\fR (\fB^@\fR) character to the
2010program, start \fIaction\fR with a pair of \fB\s-1NUL\s0\fR characters (\fB^@^@\fR),
2011the first of which will be stripped off and the balance directed to the
2012program. Otherwise if \fIaction\fR begins with \fB\s-1NUL\s0\fR followed by
2013non\-+\fB\s-1NUL\s0\fR characters, the leading \fB\s-1NUL\s0\fR is stripped off and the
2014balance is sent back to rxvt.
2015.PP
2016As a convenience for the many Emacs-type editors, \fIaction\fR may start
2017with \fBM\-\fR (eg, \fBM\-$\fR is equivalent to \fB\eE$\fR) and a \fB\s-1CR\s0\fR will be
2018appended if missed from \fBM\-x\fR commands.
2019.PP
2020As a convenience for issuing XTerm \fB\s-1ESC\s0 ]\fR sequences from a menubar (or
2021quick arrow), a \fB\s-1BEL\s0\fR (\fB^G\fR) will be appended if needed.
2022.IP "For example," 4
2023.IX Item "For example,"
2024\&\fBM\-xapropos\fR is equivalent to \fB\eExapropos\er\fR
2025.IP "and" 4
2026.IX Item "and"
2027\&\fB\eE]703;mona;100\fR is equivalent to \fB\eE]703;mona;100\ea\fR
2028.PP
2029The option \fB{\f(BIright-rtext\fB}\fR will be right\-justified. In the
2030absence of a specified action, this text will be used as the \fIaction\fR
2031as well.
2032.IP "For example," 4
2033.IX Item "For example,"
2034\&\fB/File/{Open}{^X^F}\fR is equivalent to \fB/File/{Open}{^X^F} ^X^F\fR
2035.PP
2036The left label \fIis\fR necessary, since it's used for matching, but
2037implicitly hiding the left label (by using same name for both left and
2038right labels), or explicitly hiding the left label (by preceeding it
2039with a dot), makes it possible to have right-justified text only.
2040.IP "For example," 4
2041.IX Item "For example,"
2042\&\fB/File/{Open}{Open} Open-File-Action\fR
2043.IP "or hiding it" 4
2044.IX Item "or hiding it"
2045\&\fB/File/{.anylabel}{Open} Open-File-Action\fR
2046.PP
2047
2048.IX Xref "menuBarRemove"
2049.Sh "Removing menus"
2050.IX Subsection "Removing menus"
2051.IP "\fB\-/*+\fR" 4
2052.IX Item "-/*+"
2053remove all menus from the menuBar, the same as \fB[clear]\fR
2054.IP "\fB\-+\f(BI/path\fBmenu+\fR" 4
2055.IX Item "-+/pathmenu+"
2056remove menu
2057.IP "\fB\-+\f(BI/path\fB{item}+\fR" 4
2058.IX Item "-+/path{item}+"
2059remove item
2060.IP "\fB\-+\f(BI/path\fB{\-}\fR" 4
2061.IX Item "-+/path{-}"
2062remove separator)
2063.IP "\fB\-/path/menu/*\fR" 4
2064.IX Item "-/path/menu/*"
2065remove all items, separators and submenus from menu
2066.PP
2067
2068.IX Xref "menuBarArrows"
2069.Sh "Quick Arrows"
2070.IX Subsection "Quick Arrows"
2071The menus also provide a hook for \fIquick arrows\fR to provide easier
2072user access. If nothing has been explicitly set, the default is to
2073emulate the curror keys. The syntax permits each arrow to be altered
2074individually or all four at once without re-entering their common
2075beginning/end text. For example, to explicitly associate cursor actions
2076with the arrows, any of the following forms could be used:
2077.IP "\fB<r>+\f(BIRight\fB\fR" 4
2078.IX Item "<r>+Right"
2079.PD 0
2080.IP "\fB<l>+\f(BILeft\fB\fR" 4
2081.IX Item "<l>+Left"
2082.IP "\fB<u>+\f(BIUp\fB\fR" 4
2083.IX Item "<u>+Up"
2084.IP "\fB<d>+\f(BIDown\fB\fR" 4
2085.IX Item "<d>+Down"
2086.PD
2087Define actions for the respective arrow buttons
2088.IP "\fB<b>+\f(BIBegin\fB\fR" 4
2089.IX Item "<b>+Begin"
2090.PD 0
2091.IP "\fB<e>+\f(BIEnd\fB\fR" 4
2092.IX Item "<e>+End"
2093.PD
2094Define common beginning/end parts for \fIquick arrows\fR which used in
2095conjunction with the above <r> <l> <u> <d> constructs
2096.IP "For example, define arrows individually," 4
2097.IX Item "For example, define arrows individually,"
2098.Vb 1
2099\& <u>\eE[A
2100.Ve
2101.Sp
2102.Vb 1
2103\& <d>\eE[B
2104.Ve
2105.Sp
2106.Vb 1
2107\& <r>\eE[C
2108.Ve
2109.Sp
2110.Vb 1
2111\& <l>\eE[D
2112.Ve
2113.IP "or all at once" 4
2114.IX Item "or all at once"
2115.Vb 1
2116\& <u>\eE[AZ<><d>\eE[BZ<><r>\eE[CZ<><l>\eE[D
2117.Ve
2118.IP "or more compactly (factoring out common parts)" 4
2119.IX Item "or more compactly (factoring out common parts)"
2120.Vb 1
2121\& <b>\eE[<u>AZ<><d>BZ<><r>CZ<><l>D
2122.Ve
2123.PP
2124
2125.IX Xref "menuBarSummary"
2126.Sh "Command Summary"
2127.IX Subsection "Command Summary"
2128A short summary of the most \fIcommon\fR commands:
2129.IP "[menu:name]" 4
2130.IX Item "[menu:name]"
2131use an existing named menuBar or start a new one
2132.IP "[menu]" 4
2133.IX Item "[menu]"
2134use the current menuBar
2135.IP "[title:string]" 4
2136.IX Item "[title:string]"
2137set menuBar title
2138.IP "[done]" 4
2139.IX Item "[done]"
2140set menu access to readonly and, if reading from a file, signal \s-1EOF\s0
2141.IP "[done:name]" 4
2142.IX Item "[done:name]"
2143if reading from a file using [read:file;name] signal \s-1EOF\s0
2144.IP "[rm:name]" 4
2145.IX Item "[rm:name]"
2146remove named menuBar(s)
2147.IP "[rm] [rm:]" 4
2148.IX Item "[rm] [rm:]"
2149remove current menuBar
2150.IP "[rm*] [rm:*]" 4
2151.IX Item "[rm*] [rm:*]"
2152remove all menuBar(s)
2153.IP "[swap]" 4
2154.IX Item "[swap]"
2155swap top two menuBars
2156.IP "[prev]" 4
2157.IX Item "[prev]"
2158access the previous menuBar
2159.IP "[next]" 4
2160.IX Item "[next]"
2161access the next menuBar
2162.IP "[show]" 4
2163.IX Item "[show]"
2164map menuBar
2165.IP "[hide]" 4
2166.IX Item "[hide]"
2167unmap menuBar
2168.IP "[pixmap;file]" 4
2169.IX Item "[pixmap;file]"
2170.PD 0
2171.IP "[pixmap;file;scaling]" 4
2172.IX Item "[pixmap;file;scaling]"
2173.PD
2174set a background pixmap
2175.IP "[read:file]" 4
2176.IX Item "[read:file]"
2177.PD 0
2178.IP "[read:file;name]" 4
2179.IX Item "[read:file;name]"
2180.PD
2181read in a menu from a file
2182.IP "[dump]" 4
2183.IX Item "[dump]"
2184dump out all menuBars to /tmp/rxvt\-PID
2185.IP "/" 4
2186access menuBar top level
2187.IP "./" 4
2188.PD 0
2189.IP "../" 4
2190.IP "../../" 4
2191.PD
2192access current or parent menu level
2193.IP "/path/menu" 4
2194.IX Item "/path/menu"
2195add/access menu
2196.IP "/path/{\-}" 4
2197.IX Item "/path/{-}"
2198add separator
2199.IP "/path/{item}{rtext} action" 4
2200.IX Item "/path/{item}{rtext} action"
2201add/alter menu item
2202.IP "\-/*" 4
2203remove all menus from the menuBar
2204.IP "\-/path/menu" 4
2205.IX Item "-/path/menu"
2206remove menu items, separators and submenus from menu
2207.IP "\-/path/menu" 4
2208.IX Item "-/path/menu"
2209remove menu
2210.IP "\-/path/{item}" 4
2211.IX Item "-/path/{item}"
2212remove item
2213.IP "\-/path/{\-}" 4
2214.IX Item "-/path/{-}"
2215remove separator
2216.IP "<b>Begin<r>Right<l>Left<u>Up<d>Down<e>End" 4
2217.IX Item "<b>Begin<r>Right<l>Left<u>Up<d>Down<e>End"
2218menu quick arrows
2219.SH "XPM" 2053.SH "XPM"
2220.IX Header "XPM" 2054.IX Header "XPM"
2221For the \s-1XPM\s0 XTerm escape sequence \fB\f(CB\*(C`ESC ] 20 ; Pt ST\*(C'\fB\fR then value 2055For the \s-1XPM\s0 XTerm escape sequence \fB\f(CB\*(C`ESC ] 20 ; Pt ST\*(C'\fB\fR then value
2222of \fB\f(CB\*(C`Pt\*(C'\fB\fR can be the name of the background pixmap followed by a 2056of \fB\f(CB\*(C`Pt\*(C'\fB\fR can be the name of the background pixmap followed by a
2223sequence of scaling/positioning commands separated by semi\-colons. The 2057sequence of scaling/positioning commands separated by semi\-colons. The
2293.TS 2127.TS
2294l l . 2128l l .
22954 Shift 21294 Shift
22968 Meta 21308 Meta
229716 Control 213116 Control
229832 Double Click (Rxvt extension) 213232 Double Click (rxvt extension)
2299.TE 2133.TE
2300 2134
2301Col = \fB\f(CB\*(C`<x> \- SPACE\*(C'\fB\fR 2135Col = \fB\f(CB\*(C`<x> \- SPACE\*(C'\fB\fR
2302.Sp 2136.Sp
2303Row = \fB\f(CB\*(C`<y> \- SPACE\*(C'\fB\fR 2137Row = \fB\f(CB\*(C`<y> \- SPACE\*(C'\fB\fR
2425Add support for \s-1XIM\s0 (X Input Method) protocol. This allows using 2259Add support for \s-1XIM\s0 (X Input Method) protocol. This allows using
2426alternative input methods (e.g. kinput2) and will also correctly 2260alternative input methods (e.g. kinput2) and will also correctly
2427set up the input for people using dead keys or compose keys. 2261set up the input for people using dead keys or compose keys.
2428.IP "\-\-enable\-unicode3 (default: off)" 4 2262.IP "\-\-enable\-unicode3 (default: off)" 4
2429.IX Item "--enable-unicode3 (default: off)" 2263.IX Item "--enable-unicode3 (default: off)"
2264Recommended to stay off unless you really need non-BMP characters.
2265.Sp
2430Enable direct support for displaying unicode codepoints above 2266Enable direct support for displaying unicode codepoints above
243165535 (the basic multilingual page). This increases storage 226765535 (the basic multilingual page). This increases storage
2432requirements per character from 2 to 4 bytes. X11 fonts do not yet 2268requirements per character from 2 to 4 bytes. X11 fonts do not yet
2433support these extra characters, but Xft does. 2269support these extra characters, but Xft does.
2434.Sp 2270.Sp
2443composite characters. This is required for proper viewing of text 2279composite characters. This is required for proper viewing of text
2444where accents are encoded as seperate unicode characters. This is 2280where accents are encoded as seperate unicode characters. This is
2445done by using precomposited characters when available or creating 2281done by using precomposited characters when available or creating
2446new pseudo-characters when no precomposed form exists. 2282new pseudo-characters when no precomposed form exists.
2447.Sp 2283.Sp
2448Without \-\-enable\-unicode3, the number of additional precomposed characters 2284Without \-\-enable\-unicode3, the number of additional precomposed
2449is rather limited (2048, if this is full, rxvt-unicode will use the 2285characters is somewhat limited (the 6400 private use characters will be
2450private use area, extending the number of combinations to 8448). With
2451\&\-\-enable\-unicode3, no practical limit exists. 2286(ab\-)used). With \-\-enable\-unicode3, no practical limit exists.
2452.Sp 2287.Sp
2453This option will also enable storage (but not display) of characters 2288This option will also enable storage (but not display) of characters
2454beyond plane 0 (>65535) when \-\-enable\-unicode3 was not specified. 2289beyond plane 0 (>65535) when \-\-enable\-unicode3 was not specified.
2455.Sp 2290.Sp
2456The combining table also contains entries for arabic presentation forms, 2291The combining table also contains entries for arabic presentation forms,
2457but these are not currently used. Bug me if you want these to be used (and 2292but these are not currently used. Bug me if you want these to be used (and
2458tell me how these are to be used...). 2293tell me how these are to be used...).
2459.IP "\-\-enable\-fallback(=CLASS) (default: Rxvt)" 4 2294.IP "\-\-enable\-fallback(=CLASS) (default: Rxvt)" 4
2460.IX Item "--enable-fallback(=CLASS) (default: Rxvt)" 2295.IX Item "--enable-fallback(=CLASS) (default: Rxvt)"
2461When reading resource settings, also read settings for class \s-1CLASS\s0. To disable resource fallback use \-\-disable\-fallback. 2296When reading resource settings, also read settings for class \s-1CLASS\s0. To
2297disable resource fallback use \-\-disable\-fallback.
2462.IP "\-\-with\-res\-name=NAME (default: urxvt)" 4 2298.IP "\-\-with\-res\-name=NAME (default: urxvt)" 4
2463.IX Item "--with-res-name=NAME (default: urxvt)" 2299.IX Item "--with-res-name=NAME (default: urxvt)"
2464Use the given name as default application name when 2300Use the given name as default application name when
2465reading resources. Specify \-\-with\-res\-name=rxvt to replace rxvt. 2301reading resources. Specify \-\-with\-res\-name=rxvt to replace rxvt.
2466.IP "\-\-with\-res\-class=CLASS /default: URxvt)" 4 2302.IP "\-\-with\-res\-class=CLASS /default: URxvt)" 4
2493.IX Item "--enable-fading (default: on)" 2329.IX Item "--enable-fading (default: on)"
2494Add support for fading the text when focus is lost (requires \f(CW\*(C`\-\-enable\-transparency\*(C'\fR). 2330Add support for fading the text when focus is lost (requires \f(CW\*(C`\-\-enable\-transparency\*(C'\fR).
2495.IP "\-\-enable\-tinting (default: on)" 4 2331.IP "\-\-enable\-tinting (default: on)" 4
2496.IX Item "--enable-tinting (default: on)" 2332.IX Item "--enable-tinting (default: on)"
2497Add support for tinting of transparent backgrounds (requires \f(CW\*(C`\-\-enable\-transparency\*(C'\fR). 2333Add support for tinting of transparent backgrounds (requires \f(CW\*(C`\-\-enable\-transparency\*(C'\fR).
2498.IP "\-\-enable\-menubar (default: off) [\s-1DEPRECATED\s0]" 4
2499.IX Item "--enable-menubar (default: off) [DEPRECATED]"
2500Add support for our menu bar system (this interacts badly with dynamic
2501locale switching currently). This option is \s-1DEPRECATED\s0 and will be removed
2502in the future.
2503.IP "\-\-enable\-rxvt\-scroll (default: on)" 4 2334.IP "\-\-enable\-rxvt\-scroll (default: on)" 4
2504.IX Item "--enable-rxvt-scroll (default: on)" 2335.IX Item "--enable-rxvt-scroll (default: on)"
2505Add support for the original rxvt scrollbar. 2336Add support for the original rxvt scrollbar.
2506.IP "\-\-enable\-next\-scroll (default: on)" 4 2337.IP "\-\-enable\-next\-scroll (default: on)" 4
2507.IX Item "--enable-next-scroll (default: on)" 2338.IX Item "--enable-next-scroll (default: on)"
2512.IP "\-\-enable\-plain\-scroll (default: on)" 4 2343.IP "\-\-enable\-plain\-scroll (default: on)" 4
2513.IX Item "--enable-plain-scroll (default: on)" 2344.IX Item "--enable-plain-scroll (default: on)"
2514Add support for a very unobtrusive, plain-looking scrollbar that 2345Add support for a very unobtrusive, plain-looking scrollbar that
2515is the favourite of the rxvt-unicode author, having used it for 2346is the favourite of the rxvt-unicode author, having used it for
2516many years. 2347many years.
2517.IP "\-\-enable\-half\-shadow (default: off)" 4
2518.IX Item "--enable-half-shadow (default: off)"
2519Make shadows on the scrollbar only half the normal width & height.
2520only applicable to rxvt scrollbars.
2521.IP "\-\-enable\-ttygid (default: off)" 4 2348.IP "\-\-enable\-ttygid (default: off)" 4
2522.IX Item "--enable-ttygid (default: off)" 2349.IX Item "--enable-ttygid (default: off)"
2523Change tty device setting to group \*(L"tty\*(R" \- only use this if 2350Change tty device setting to group \*(L"tty\*(R" \- only use this if
2524your system uses this type of security. 2351your system uses this type of security.
2525.IP "\-\-disable\-backspace\-key" 4 2352.IP "\-\-disable\-backspace\-key" 4
2530Removes any handling of the delete key by us \- let the X server 2357Removes any handling of the delete key by us \- let the X server
2531do it. 2358do it.
2532.IP "\-\-disable\-resources" 4 2359.IP "\-\-disable\-resources" 4
2533.IX Item "--disable-resources" 2360.IX Item "--disable-resources"
2534Removes any support for resource checking. 2361Removes any support for resource checking.
2535.IP "\-\-enable\-strings (default: off)" 4
2536.IX Item "--enable-strings (default: off)"
2537Add support for our possibly faster \fImemset()\fR function and other
2538various routines, overriding your system's versions which may
2539have been hand-crafted in assembly or may require extra libraries
2540to link in. (this breaks ANSI-C rules and has problems on many
2541GNU/Linux systems).
2542.IP "\-\-disable\-swapscreen" 4 2362.IP "\-\-disable\-swapscreen" 4
2543.IX Item "--disable-swapscreen" 2363.IX Item "--disable-swapscreen"
2544Remove support for secondary/swap screen. 2364Remove support for secondary/swap screen.
2545.IP "\-\-enable\-frills (default: on)" 4 2365.IP "\-\-enable\-frills (default: on)" 4
2546.IX Item "--enable-frills (default: on)" 2366.IX Item "--enable-frills (default: on)"
2549disable this. 2369disable this.
2550.Sp 2370.Sp
2551A non-exhaustive list of features enabled by \f(CW\*(C`\-\-enable\-frills\*(C'\fR (possibly 2371A non-exhaustive list of features enabled by \f(CW\*(C`\-\-enable\-frills\*(C'\fR (possibly
2552in combination with other switches) is: 2372in combination with other switches) is:
2553.Sp 2373.Sp
2554.Vb 17 2374.Vb 15
2555\& MWM-hints 2375\& MWM-hints
2556\& EWMH-hints (pid, utf8 names) and protocols (ping) 2376\& EWMH-hints (pid, utf8 names) and protocols (ping)
2557\& seperate underline colour (-underlineColor) 2377\& seperate underline colour (-underlineColor)
2558\& settable border widths and borderless switch (-w, -b, -bl) 2378\& settable border widths and borderless switch (-w, -b, -bl)
2379\& visual depth selection (-depth)
2559\& settable extra linespacing /-lsp) 2380\& settable extra linespacing /-lsp)
2560\& iso-14755-2 and -3, and visual feedback 2381\& iso-14755-2 and -3, and visual feedback
2561\& backindex and forwardindex escape sequence
2562\& window op and some xterm/OSC escape sequences
2563\& tripleclickwords (-tcw) 2382\& tripleclickwords (-tcw)
2564\& settable insecure mode (-insecure) 2383\& settable insecure mode (-insecure)
2565\& keysym remapping support 2384\& keysym remapping support
2566\& cursor blinking and underline cursor (-cb, -uc) 2385\& cursor blinking and underline cursor (-cb, -uc)
2567\& XEmbed support (-embed) 2386\& XEmbed support (-embed)
2568\& user-pty (-pty-fd) 2387\& user-pty (-pty-fd)
2569\& hold on exit (-hold) 2388\& hold on exit (-hold)
2570\& skip builtin block graphics (-sbg) 2389\& skip builtin block graphics (-sbg)
2390.Ve
2391.Sp
2392It also enabled some non-essential features otherwise disabled, such as:
2393.Sp
2394.Vb 11
2395\& some round-trip time optimisations
2396\& nearest color allocation on pseudocolor screens
2397\& UTF8_STRING supporr for selection
2571\& sgr modes 90..97 and 100..107 2398\& sgr modes 90..97 and 100..107
2399\& backindex and forwardindex escape sequences
2400\& view change/zero scorllback esacpe sequences
2401\& locale switching escape sequence
2402\& window op and some xterm/OSC escape sequences
2403\& rectangular selections
2404\& trailing space removal for selections
2405\& verbose X error handling
2572.Ve 2406.Ve
2573.IP "\-\-enable\-iso14755 (default: on)" 4 2407.IP "\-\-enable\-iso14755 (default: on)" 4
2574.IX Item "--enable-iso14755 (default: on)" 2408.IX Item "--enable-iso14755 (default: on)"
2575Enable extended \s-1ISO\s0 14755 support (see @@RXVT_NAME@@(1), or 2409Enable extended \s-1ISO\s0 14755 support (see @@RXVT_NAME@@(1), or
2576\&\fIdoc/rxvt.1.txt\fR). Basic support (section 5.1) is enabled by 2410\&\fIdoc/rxvt.1.txt\fR). Basic support (section 5.1) is enabled by
2610keys. This should keep the window corner which is closest to a corner of 2444keys. This should keep the window corner which is closest to a corner of
2611the screen in a fixed position. 2445the screen in a fixed position.
2612.IP "\-\-enable\-pointer\-blank (default: on)" 4 2446.IP "\-\-enable\-pointer\-blank (default: on)" 4
2613.IX Item "--enable-pointer-blank (default: on)" 2447.IX Item "--enable-pointer-blank (default: on)"
2614Add support to have the pointer disappear when typing or inactive. 2448Add support to have the pointer disappear when typing or inactive.
2615.IP "\-\-enable\-perl (default: off)" 4 2449.IP "\-\-enable\-perl (default: on)" 4
2616.IX Item "--enable-perl (default: off)" 2450.IX Item "--enable-perl (default: on)"
2617Enable an embedded perl interpreter. See the \fB@@RXVT_NAME@@\f(BIperl\fB\|(3)\fR 2451Enable an embedded perl interpreter. See the \fB@@RXVT_NAME@@\f(BIperl\fB\|(3)\fR
2618manpage (\fIdoc/rxvtperl.txt\fR) for more info on this feature, or the files 2452manpage (\fIdoc/rxvtperl.txt\fR) for more info on this feature, or the files
2619in \fIsrc/perl\-ext/\fR for the extensions that are installed by default. The 2453in \fIsrc/perl\-ext/\fR for the extensions that are installed by default. The
2620perl interpreter that is used can be specified via the \f(CW\*(C`PERL\*(C'\fR environment 2454perl interpreter that is used can be specified via the \f(CW\*(C`PERL\*(C'\fR environment
2621variable when running configure. 2455variable when running configure.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines