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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.143 by ayin, Thu Aug 2 00:09:54 2007 UTC vs.
Revision 1.161 by ayin, Sat Jan 19 12:13:32 2008 UTC

… …
17 17
18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting 18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
19all escape sequences, and other background information. 19all escape sequences, and other background information.
20 20
21The newest version of this document is also available on the World Wide Web at 21The newest version of this document is also available on the World Wide Web at
22L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>. 22L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23
24The main manual page for @@RXVT_NAME@@ itself is available at
25L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
23 26
24=head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS 27=head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS
25 28
26 29
27=head2 Meta, Features & Commandline Issues 30=head2 Meta, Features & Commandline Issues
… …
197 200
198And here is rxvt-unicode: 201And here is rxvt-unicode:
199 202
200 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) 203 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
201 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000) 204 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
202 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000) 205 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
203 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000) 206 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
204 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) 207 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
205 208
206No large bloated libraries (of course, none were linked in statically), 209No large bloated libraries (of course, none were linked in statically),
207except maybe libX11 :) 210except maybe libX11 :)
208 211
209 212
210=head2 Rendering, Font & Look and Feel Issues 213=head2 Rendering, Font & Look and Feel Issues
211 214
212=head3 I can't get transparency working, what am I doing wrong? 215=head3 I can't get transparency working, what am I doing wrong?
213 216
214First of all, transparency isn't officially supported in rxvt-unicode, so 217First of all, please address all transparency related issues to Sasha Vasko at
215you are mostly on your own. Do not bug the author about it (but you may 218sasha@aftercode.net and do not bug the author about it. Also, if you can't
216bug everybody else). Also, if you can't get it working consider it a rite 219get it working consider it a rite of passage: ... and you failed.
217of passage: ... and you failed.
218 220
219Here are four ways to get transparency. B<Do> read the manpage and option 221Here are four ways to get transparency. B<Do> read the manpage and option
220descriptions for the programs mentioned and rxvt-unicode. Really, do it! 222descriptions for the programs mentioned and rxvt-unicode. Really, do it!
221 223
2221. Use inheritPixmap: 2241. Use transparent mode:
223 225
224 Esetroot wallpaper.jpg 226 Esetroot wallpaper.jpg
225 @@URXVT_NAME@@ -ip -tint red -sh 40 227 @@URXVT_NAME@@ -tr -tint red -sh 40
226 228
227That works. If you think it doesn't, you lack transparency and tinting 229That works. If you think it doesn't, you lack transparency and tinting
228support, or you are unable to read. 230support, or you are unable to read.
229 231
2302. Use a simple pixmap and emulate pseudo-transparency. This enables you 2322. Use a simple pixmap and emulate pseudo-transparency. This enables you
231to use effects other than tinting and shading: Just shade/tint/whatever 233to use effects other than tinting and shading: Just shade/tint/whatever
232your picture with gimp or any other tool: 234your picture with gimp or any other tool:
233 235
234 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm 236 convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg
235 @@URXVT_NAME@@ -pixmap background.xpm -pe automove-background 237 @@URXVT_NAME@@ -pixmap "background.jpg;:root"
236 238
237That works. If you think it doesn't, you lack XPM and Perl support, or you 239That works. If you think it doesn't, you lack AfterImage support, or you
238are unable to read. 240are unable to read.
239 241
2403. Use an ARGB visual: 2423. Use an ARGB visual:
241 243
242 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc 244 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
… …
342=head3 What's with this bold/blink stuff? 344=head3 What's with this bold/blink stuff?
343 345
344If no bold colour is set via C<colorBD:>, bold will invert text using the 346If no bold colour is set via C<colorBD:>, bold will invert text using the
345standard foreground colour. 347standard foreground colour.
346 348
347For the standard background colour, blinking will actually make the 349For the standard background colour, blinking will actually make
348text blink when compiled with C<--enable-blinking>. with standard 350the text blink when compiled with C<--enable-text-blink>. Without
349colours. Without C<--enable-blinking>, the blink attribute will be 351C<--enable-text-blink>, the blink attribute will be ignored.
350ignored.
351 352
352On ANSI colours, bold/blink attributes are used to set high-intensity 353On ANSI colours, bold/blink attributes are used to set high-intensity
353foreground/background colors. 354foreground/background colors.
354 355
355color0-7 are the low-intensity colors. 356color0-7 are the low-intensity colors.
… …
460has been designed yet). 461has been designed yet).
461 462
462Until then, you might get away with switching fonts at runtime (see L<Can 463Until then, you might get away with switching fonts at runtime (see L<Can
463I switch the fonts at runtime?> later in this document). 464I switch the fonts at runtime?> later in this document).
464 465
466=head3 How can I make mplayer display video correctly?
467
468We are working on it, in the meantime, as a workaround, use something like:
469
470 @@URXVT_NAME@@ -b 600 -geometry 20x1 -e sh -c 'mplayer -wid $WINDOWID file...'
471
472
465=head2 Keyboard, Mouse & User Interaction 473=head2 Keyboard, Mouse & User Interaction
466 474
467=head3 The new selection selects pieces that are too big, how can I select single words? 475=head3 The new selection selects pieces that are too big, how can I select single words?
468 476
469If you want to select e.g. alphanumeric words, you can use the following 477If you want to select e.g. alphanumeric words, you can use the following
… …
476 484
477To get a selection that is very similar to the old code, try this pattern: 485To get a selection that is very similar to the old code, try this pattern:
478 486
479 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+) 487 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
480 488
481Please also note that the I<LeftClick Shift-LeftClik> combination also 489Please also note that the I<LeftClick Shift-LeftClick> combination also
482selects words like the old code. 490selects words like the old code.
483 491
484=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it? 492=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
485 493
486You can disable the perl extension completely by setting the 494You can disable the perl extension completely by setting the
… …
604key has been assigned an escape sequence to match the vt100 for Execute 612key has been assigned an escape sequence to match the vt100 for Execute
605(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo. 613(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
606 614
607Some other Backspace problems: 615Some other Backspace problems:
608 616
609some editors use termcap/terminfo, 617some editors use termcap/terminfo,
610some editors (vim I'm told) expect Backspace = ^H, 618some editors (vim I'm told) expect Backspace = ^H,
611GNU Emacs (and Emacs-like editors) use ^H for help. 619GNU Emacs (and Emacs-like editors) use ^H for help.
612 620
613Perhaps someday this will all be resolved in a consistent manner. 621Perhaps someday this will all be resolved in a consistent manner.
614 622
… …
655Rather than have rxvt-unicode try to accommodate all the various possible 663Rather than have rxvt-unicode try to accommodate all the various possible
656keyboard mappings, it is better to use `xmodmap' to remap the keys as 664keyboard mappings, it is better to use `xmodmap' to remap the keys as
657required for your particular machine. 665required for your particular machine.
658 666
659 667
660
661=head2 Terminal Configuration 668=head2 Terminal Configuration
662 669
663=head3 Can I see a typical configuration? 670=head3 Can I see a typical configuration?
664 671
665The default configuration tries to be xterm-like, which I don't like that 672The default configuration tries to be xterm-like, which I don't like that
… …
1068C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input 1075C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
1069method servers are running with this command: 1076method servers are running with this command:
1070 1077
1071 xprop -root XIM_SERVERS 1078 xprop -root XIM_SERVERS
1072 1079
1073=item 1080=item
1074 1081
1075=back 1082=back
1076 1083
1077=head3 My input method wants <some encoding> but I want UTF-8, what can I do? 1084=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
1078 1085
… …
1805 1812
1806=item B<< C<Pm = 30> >> 1813=item B<< C<Pm = 30> >>
1807 1814
1808=begin table 1815=begin table
1809 1816
1810 B<< C<h> >> scrollBar visisble 1817 B<< C<h> >> scrollBar visible
1811 B<< C<l> >> scrollBar invisisble 1818 B<< C<l> >> scrollBar invisible
1812 1819
1813=end table 1820=end table
1814 1821
1815=item B<< C<Pm = 35> >> (B<rxvt>) 1822=item B<< C<Pm = 35> >> (B<rxvt>)
1816 1823
… …
1895=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented> 1902=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1896 1903
1897=begin table 1904=begin table
1898 1905
1899 B<< C<h> >> Use Hilite Mouse Tracking. 1906 B<< C<h> >> Use Hilite Mouse Tracking.
1907 B<< C<l> >> No mouse reporting.
1908
1909=end table
1910
1911=item B<< C<Pm = 1002> >> (X11 XTerm)
1912
1913=begin table
1914
1915 B<< C<h> >> Send Mouse X & Y on button press and release, and motion with a button pressed.
1916 B<< C<l> >> No mouse reporting.
1917
1918=end table
1919
1920=item B<< C<Pm = 1003> >> (X11 XTerm)
1921
1922=begin table
1923
1924 B<< C<h> >> Send Mouse X & Y on button press and release, and motion.
1900 B<< C<l> >> No mouse reporting. 1925 B<< C<l> >> No mouse reporting.
1901 1926
1902=end table 1927=end table
1903 1928
1904=item B<< C<Pm = 1010> >> (B<rxvt>) 1929=item B<< C<Pm = 1010> >> (B<rxvt>)
… …
1983 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 2008 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1984 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 2009 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1985 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 2010 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1986 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706] 2011 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1987 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707] 2012 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1988 B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM). 2013 B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile AfterImage).
1989 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. 2014 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1990 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 2015 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1991 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. 2016 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1992 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >> 2017 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >>
1993 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 2018 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
… …
2007 2032
2008=end table 2033=end table
2009 2034
2010=back 2035=back
2011 2036
2012=head1 XPM 2037=head1 BACKGROUND IMAGE
2013 2038
2014For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 2039For the BACKGROUND IMAGE XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> the value
2015of B<< C<Pt> >> can be the name of the background pixmap followed by a 2040of B<< C<Pt> >> can be the name of the background image file followed by a
2016sequence of scaling/positioning commands separated by semi-colons. The 2041sequence of scaling/positioning commands separated by semi-colons. The
2017scaling/positioning commands are as follows: 2042scaling/positioning commands are as follows:
2018 2043
2019=over 4 2044=over 4
2020 2045
… …
2058 2083
2059For example: 2084For example:
2060 2085
2061=over 4 2086=over 4
2062 2087
2063=item B<\E]20;funky\a> 2088=item B<\E]20;funky.jpg\a>
2064 2089
2065load B<funky.xpm> as a tiled image 2090load B<funky.jpg> as a tiled image
2066 2091
2067=item B<\E]20;mona;100\a> 2092=item B<\E]20;mona.jpg;100\a>
2068 2093
2069load B<mona.xpm> with a scaling of 100% 2094load B<mona.jpg> with a scaling of 100%
2070 2095
2071=item B<\E]20;;200;?\a> 2096=item B<\E]20;;200;?\a>
2072 2097
2073rescale the current pixmap to 200% and display the image geometry in 2098rescale the current pixmap to 200% and display the image geometry in
2074the title 2099the title
… …
2201 2226
2202=head1 CONFIGURE OPTIONS 2227=head1 CONFIGURE OPTIONS
2203 2228
2204General hint: if you get compile errors, then likely your configuration 2229General hint: if you get compile errors, then likely your configuration
2205hasn't been tested well. Either try with C<--enable-everything> or use 2230hasn't been tested well. Either try with C<--enable-everything> or use
2206the default configuration (i.e. C<--enable-xxx> or C<--disable-xxx>). Of 2231the default configuration (i.e. no C<--enable-xxx> or C<--disable-xxx>
2207course, you should always report when a combination doesn't work, so it 2232switches). Of course, you should always report when a combination doesn't
2208can be fixed. Marc Lehmann <rxvt@schmorp.de>. 2233work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2209 2234
2210All 2235All
2211 2236
2212=over 4 2237=over 4
2213 2238
… …
2302=item --with-res-name=NAME (default: urxvt) 2327=item --with-res-name=NAME (default: urxvt)
2303 2328
2304Use the given name as default application name when 2329Use the given name as default application name when
2305reading resources. Specify --with-res-name=rxvt to replace rxvt. 2330reading resources. Specify --with-res-name=rxvt to replace rxvt.
2306 2331
2307=item --with-res-class=CLASS /default: URxvt) 2332=item --with-res-class=CLASS (default: URxvt)
2308 2333
2309Use the given class as default application class 2334Use the given class as default application class
2310when reading resources. Specify --with-res-class=Rxvt to replace 2335when reading resources. Specify --with-res-class=Rxvt to replace
2311rxvt. 2336rxvt.
2312 2337
… …
2342to third-party libraries used by libAI). Memory footprint may somewhat be 2367to third-party libraries used by libAI). Memory footprint may somewhat be
2343lowered if libAfterImage is configured without support for SVG. 2368lowered if libAfterImage is configured without support for SVG.
2344 2369
2345=item --enable-transparency (default: on) 2370=item --enable-transparency (default: on)
2346 2371
2347Add support for inheriting parent backgrounds thus giving a fake 2372Add support for backgrounds, creating illusion of transparency in the term.
2348transparency to the term.
2349 2373
2350=item --enable-fading (default: on) 2374=item --enable-fading (default: on)
2351 2375
2352Add support for fading the text when focus is lost. 2376Add support for fading the text when focus is lost.
2353
2354=item --enable-tinting (default: on)
2355
2356Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2357 2377
2358=item --enable-rxvt-scroll (default: on) 2378=item --enable-rxvt-scroll (default: on)
2359 2379
2360Add support for the original rxvt scrollbar. 2380Add support for the original rxvt scrollbar.
2361 2381
… …
2370=item --enable-plain-scroll (default: on) 2390=item --enable-plain-scroll (default: on)
2371 2391
2372Add support for a very unobtrusive, plain-looking scrollbar that 2392Add support for a very unobtrusive, plain-looking scrollbar that
2373is the favourite of the rxvt-unicode author, having used it for 2393is the favourite of the rxvt-unicode author, having used it for
2374many years. 2394many years.
2375
2376=item --enable-ttygid (default: off)
2377
2378Change tty device setting to group "tty" - only use this if
2379your system uses this type of security.
2380 2395
2381=item --disable-backspace-key 2396=item --disable-backspace-key
2382 2397
2383Removes any handling of the backspace key by us - let the X server do it. 2398Removes any handling of the backspace key by us - let the X server do it.
2384 2399
… …
2417 keysym remapping support 2432 keysym remapping support
2418 cursor blinking and underline cursor (-cb, -uc) 2433 cursor blinking and underline cursor (-cb, -uc)
2419 XEmbed support (-embed) 2434 XEmbed support (-embed)
2420 user-pty (-pty-fd) 2435 user-pty (-pty-fd)
2421 hold on exit (-hold) 2436 hold on exit (-hold)
2437 compile in built-in block graphics
2422 skip builtin block graphics (-sbg) 2438 skip builtin block graphics (-sbg)
2423 separate highlightcolor support (-hc) 2439 separate highlightcolor support (-hc)
2424 2440
2425It also enables some non-essential features otherwise disabled, such as: 2441It also enables some non-essential features otherwise disabled, such as:
2426 2442
… …
2467 2483
2468Add smart growth/shrink behaviour when resizing. 2484Add smart growth/shrink behaviour when resizing.
2469This should keep the window corner which is closest to a corner of 2485This should keep the window corner which is closest to a corner of
2470the screen in a fixed position. 2486the screen in a fixed position.
2471 2487
2488=item --enable-text-blink (default: on)
2489
2490Add support for blinking text.
2491
2472=item --enable-pointer-blank (default: on) 2492=item --enable-pointer-blank (default: on)
2473 2493
2474Add support to have the pointer disappear when typing or inactive. 2494Add support to have the pointer disappear when typing or inactive.
2475 2495
2476=item --enable-perl (default: on) 2496=item --enable-perl (default: on)

Diff Legend

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