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.147 by sasha, Thu Sep 20 15:56:41 2007 UTC vs.
Revision 1.162 by ayin, Sat Jan 19 15:00:49 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, please address all transparency related issues to Sasha Vasko at 217First of all, please address all transparency related issues to Sasha Vasko at
215sasha@aftercode.net and do not bug the author about it. Also, if you can't 218sasha@aftercode.net and do not bug the author about it. Also, if you can't
216get it working consider it a rite of passage: ... and you failed. 219get it working consider it a rite of passage: ... and you failed.
217 220
218Here 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
219descriptions for the programs mentioned and rxvt-unicode. Really, do it! 222descriptions for the programs mentioned and rxvt-unicode. Really, do it!
220 223
2211. Use inheritPixmap: 2241. Use transparent mode:
222 225
223 Esetroot wallpaper.jpg 226 Esetroot wallpaper.jpg
224 @@URXVT_NAME@@ -ip -tint red -sh 40 227 @@URXVT_NAME@@ -tr -tint red -sh 40
225 228
226That 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
227support, or you are unable to read. 230support, or you are unable to read.
228 231
2292. Use a simple pixmap and emulate pseudo-transparency. This enables you 2322. Use a simple pixmap and emulate pseudo-transparency. This enables you
230to use effects other than tinting and shading: Just shade/tint/whatever 233to use effects other than tinting and shading: Just shade/tint/whatever
231your picture with gimp or any other tool: 234your picture with gimp or any other tool:
232 235
233 convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg 236 convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg
234 @@URXVT_NAME@@ -pixmap background.jpg -pe automove-background 237 @@URXVT_NAME@@ -pixmap "background.jpg;:root"
235 238
236That works. If you think it doesn't, you lack AfterImage and Perl support, or you 239That works. If you think it doesn't, you lack AfterImage support, or you
237are unable to read. 240are unable to read.
238 241
2393. Use an ARGB visual: 2423. Use an ARGB visual:
240 243
241 @@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
341=head3 What's with this bold/blink stuff? 344=head3 What's with this bold/blink stuff?
342 345
343If 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
344standard foreground colour. 347standard foreground colour.
345 348
346For the standard background colour, blinking will actually make the 349For the standard background colour, blinking will actually make
347text blink when compiled with C<--enable-blinking>. with standard 350the text blink when compiled with C<--enable-text-blink>. Without
348colours. Without C<--enable-blinking>, the blink attribute will be 351C<--enable-text-blink>, the blink attribute will be ignored.
349ignored.
350 352
351On ANSI colours, bold/blink attributes are used to set high-intensity 353On ANSI colours, bold/blink attributes are used to set high-intensity
352foreground/background colors. 354foreground/background colors.
353 355
354color0-7 are the low-intensity colors. 356color0-7 are the low-intensity colors.
482 484
483To 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:
484 486
485 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+) 487 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
486 488
487Please also note that the I<LeftClick Shift-LeftClik> combination also 489Please also note that the I<LeftClick Shift-LeftClick> combination also
488selects words like the old code. 490selects words like the old code.
489 491
490=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?
491 493
492You can disable the perl extension completely by setting the 494You can disable the perl extension completely by setting the
610key 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
611(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo. 613(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
612 614
613Some other Backspace problems: 615Some other Backspace problems:
614 616
615some editors use termcap/terminfo, 617some editors use termcap/terminfo,
616some editors (vim I'm told) expect Backspace = ^H, 618some editors (vim I'm told) expect Backspace = ^H,
617GNU Emacs (and Emacs-like editors) use ^H for help. 619GNU Emacs (and Emacs-like editors) use ^H for help.
618 620
619Perhaps someday this will all be resolved in a consistent manner. 621Perhaps someday this will all be resolved in a consistent manner.
620 622
1073C<@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
1074method servers are running with this command: 1076method servers are running with this command:
1075 1077
1076 xprop -root XIM_SERVERS 1078 xprop -root XIM_SERVERS
1077 1079
1078=item 1080=item
1079 1081
1080=back 1082=back
1081 1083
1082=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?
1083 1085
1810 1812
1811=item B<< C<Pm = 30> >> 1813=item B<< C<Pm = 30> >>
1812 1814
1813=begin table 1815=begin table
1814 1816
1815 B<< C<h> >> scrollBar visisble 1817 B<< C<h> >> scrollBar visible
1816 B<< C<l> >> scrollBar invisisble 1818 B<< C<l> >> scrollBar invisible
1817 1819
1818=end table 1820=end table
1819 1821
1820=item B<< C<Pm = 35> >> (B<rxvt>) 1822=item B<< C<Pm = 35> >> (B<rxvt>)
1821 1823
1900=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented> 1902=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1901 1903
1902=begin table 1904=begin table
1903 1905
1904 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.
1905 B<< C<l> >> No mouse reporting. 1925 B<< C<l> >> No mouse reporting.
1906 1926
1907=end table 1927=end table
1908 1928
1909=item B<< C<Pm = 1010> >> (B<rxvt>) 1929=item B<< C<Pm = 1010> >> (B<rxvt>)
1981 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >> 2001 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >>
1982 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >> 2002 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>
1983 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >> 2003 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >>
1984 B<< C<Ps = 3> >> If B<< C<Pt> >> starts with a B<< C<?> >>, query the (STRING) property of the window and return it. If B<< C<Pt> >> contains a B<< C<=> >>, set the named property to the given value, else delete the specified property. 2004 B<< C<Ps = 3> >> If B<< C<Pt> >> starts with a B<< C<?> >>, query the (STRING) property of the window and return it. If B<< C<Pt> >> contains a B<< C<=> >>, set the named property to the given value, else delete the specified property.
1985 B<< C<Ps = 4> >> B<< C<Pt> >> is a semi-colon separated sequence of one or more semi-colon separated B<number>/B<name> pairs, where B<number> is an index to a colour and B<name> is the name of a colour. Each pair causes the B<number>ed colour to be changed to B<name>. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white 2005 B<< C<Ps = 4> >> B<< C<Pt> >> is a semi-colon separated sequence of one or more semi-colon separated B<number>/B<name> pairs, where B<number> is an index to a colour and B<name> is the name of a colour. Each pair causes the B<number>ed colour to be changed to B<name>. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white
1986 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 2006 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >>
1987 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 2007 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >>
1988 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> >>
1989 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> >>
1990 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> >>
1991 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]
1992 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]
1993 B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile AfterImage). 2013 B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile AfterImage).
1994 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> >>. [deprecated, use 10]
1995 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>
1996 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> >>. [deprecated, use 11]
1997 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> >>
1998 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> >>
1999 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills). 2019 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills).
2000 B<< C<Ps = 702> >> Request version if B<< C<Pt> >> is B<< C<?> >>, returning C<rxvt-unicode>, the resource name, the major and minor version numbers, e.g. C<ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST>. 2020 B<< C<Ps = 702> >> Request version if B<< C<Pt> >> is B<< C<?> >>, returning C<rxvt-unicode>, the resource name, the major and minor version numbers, e.g. C<ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST>.
2001 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 2021 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
2014 2034
2015=back 2035=back
2016 2036
2017=head1 BACKGROUND IMAGE 2037=head1 BACKGROUND IMAGE
2018 2038
2019For the BACGROUND IMAGE 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
2020of B<< C<Pt> >> can be the name of the background image file followed by a 2040of B<< C<Pt> >> can be the name of the background image file followed by a
2021sequence of scaling/positioning commands separated by semi-colons. The 2041sequence of scaling/positioning commands separated by semi-colons. The
2022scaling/positioning commands are as follows: 2042scaling/positioning commands are as follows:
2023 2043
2024=over 4 2044=over 4
2307=item --with-res-name=NAME (default: urxvt) 2327=item --with-res-name=NAME (default: urxvt)
2308 2328
2309Use the given name as default application name when 2329Use the given name as default application name when
2310reading resources. Specify --with-res-name=rxvt to replace rxvt. 2330reading resources. Specify --with-res-name=rxvt to replace rxvt.
2311 2331
2312=item --with-res-class=CLASS /default: URxvt) 2332=item --with-res-class=CLASS (default: URxvt)
2313 2333
2314Use the given class as default application class 2334Use the given class as default application class
2315when reading resources. Specify --with-res-class=Rxvt to replace 2335when reading resources. Specify --with-res-class=Rxvt to replace
2316rxvt. 2336rxvt.
2317 2337
2347to third-party libraries used by libAI). Memory footprint may somewhat be 2367to third-party libraries used by libAI). Memory footprint may somewhat be
2348lowered if libAfterImage is configured without support for SVG. 2368lowered if libAfterImage is configured without support for SVG.
2349 2369
2350=item --enable-transparency (default: on) 2370=item --enable-transparency (default: on)
2351 2371
2352Add support for inheriting parent backgrounds thus giving a fake 2372Add support for backgrounds, creating illusion of transparency in the term.
2353transparency to the term.
2354 2373
2355=item --enable-fading (default: on) 2374=item --enable-fading (default: on)
2356 2375
2357Add support for fading the text when focus is lost. 2376Add support for fading the text when focus is lost.
2358 2377
2371=item --enable-plain-scroll (default: on) 2390=item --enable-plain-scroll (default: on)
2372 2391
2373Add support for a very unobtrusive, plain-looking scrollbar that 2392Add support for a very unobtrusive, plain-looking scrollbar that
2374is the favourite of the rxvt-unicode author, having used it for 2393is the favourite of the rxvt-unicode author, having used it for
2375many years. 2394many years.
2376
2377=item --enable-ttygid (default: off)
2378
2379Change tty device setting to group "tty" - only use this if
2380your system uses this type of security.
2381 2395
2382=item --disable-backspace-key 2396=item --disable-backspace-key
2383 2397
2384Removes 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.
2385 2399
2418 keysym remapping support 2432 keysym remapping support
2419 cursor blinking and underline cursor (-cb, -uc) 2433 cursor blinking and underline cursor (-cb, -uc)
2420 XEmbed support (-embed) 2434 XEmbed support (-embed)
2421 user-pty (-pty-fd) 2435 user-pty (-pty-fd)
2422 hold on exit (-hold) 2436 hold on exit (-hold)
2437 compile in built-in block graphics
2423 skip builtin block graphics (-sbg) 2438 skip builtin block graphics (-sbg)
2424 separate highlightcolor support (-hc) 2439 separate highlightcolor support (-hc)
2425 2440
2426It also enables some non-essential features otherwise disabled, such as: 2441It also enables some non-essential features otherwise disabled, such as:
2427 2442
2468 2483
2469Add smart growth/shrink behaviour when resizing. 2484Add smart growth/shrink behaviour when resizing.
2470This 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
2471the screen in a fixed position. 2486the screen in a fixed position.
2472 2487
2488=item --enable-text-blink (default: on)
2489
2490Add support for blinking text.
2491
2473=item --enable-pointer-blank (default: on) 2492=item --enable-pointer-blank (default: on)
2474 2493
2475Add support to have the pointer disappear when typing or inactive. 2494Add support to have the pointer disappear when typing or inactive.
2476 2495
2477=item --enable-perl (default: on) 2496=item --enable-perl (default: on)

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines