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.135 by ayin, Sun Jun 24 23:30:17 2007 UTC vs.
Revision 1.147 by sasha, Thu Sep 20 15:56:41 2007 UTC

… …
209 209
210=head2 Rendering, Font & Look and Feel Issues 210=head2 Rendering, Font & Look and Feel Issues
211 211
212=head3 I can't get transparency working, what am I doing wrong? 212=head3 I can't get transparency working, what am I doing wrong?
213 213
214First of all, transparency isn't officially supported in rxvt-unicode, so 214First 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 215sasha@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 216get it working consider it a rite of passage: ... and you failed.
217of passage: ... and you failed.
218 217
219Here are four ways to get transparency. B<Do> read the manpage and option 218Here are four ways to get transparency. B<Do> read the manpage and option
220descriptions for the programs mentioned and rxvt-unicode. Really, do it! 219descriptions for the programs mentioned and rxvt-unicode. Really, do it!
221 220
2221. Use inheritPixmap: 2211. Use inheritPixmap:
… …
229 228
2302. Use a simple pixmap and emulate pseudo-transparency. This enables you 2292. Use a simple pixmap and emulate pseudo-transparency. This enables you
231to use effects other than tinting and shading: Just shade/tint/whatever 230to use effects other than tinting and shading: Just shade/tint/whatever
232your picture with gimp or any other tool: 231your picture with gimp or any other tool:
233 232
234 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm 233 convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg
235 @@URXVT_NAME@@ -pixmap background.xpm -pe automove-background 234 @@URXVT_NAME@@ -pixmap background.jpg -pe automove-background
236 235
237That works. If you think it doesn't, you lack XPM and Perl support, or you 236That works. If you think it doesn't, you lack AfterImage and Perl support, or you
238are unable to read. 237are unable to read.
239 238
2403. Use an ARGB visual: 2393. Use an ARGB visual:
241 240
242 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc 241 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
… …
459fonts for the same character at the same time, but no interface for this 458fonts for the same character at the same time, but no interface for this
460has been designed yet). 459has been designed yet).
461 460
462Until then, you might get away with switching fonts at runtime (see L<Can 461Until then, you might get away with switching fonts at runtime (see L<Can
463I switch the fonts at runtime?> later in this document). 462I switch the fonts at runtime?> later in this document).
463
464=head3 How can I make mplayer display video correctly?
465
466We are working on it, in the meantime, as a workaround, use something like:
467
468 @@URXVT_NAME@@ -b 600 -geometry 20x1 -e sh -c 'mplayer -wid $WINDOWID file...'
469
464 470
465=head2 Keyboard, Mouse & User Interaction 471=head2 Keyboard, Mouse & User Interaction
466 472
467=head3 The new selection selects pieces that are too big, how can I select single words? 473=head3 The new selection selects pieces that are too big, how can I select single words?
468 474
… …
655Rather than have rxvt-unicode try to accommodate all the various possible 661Rather than have rxvt-unicode try to accommodate all the various possible
656keyboard mappings, it is better to use `xmodmap' to remap the keys as 662keyboard mappings, it is better to use `xmodmap' to remap the keys as
657required for your particular machine. 663required for your particular machine.
658 664
659 665
660
661=head2 Terminal Configuration 666=head2 Terminal Configuration
662 667
663=head3 Can I see a typical configuration? 668=head3 Can I see a typical configuration?
664 669
665The default configuration tries to be xterm-like, which I don't like that 670The default configuration tries to be xterm-like, which I don't like that
… …
1151This forking is done as the very first within main(), which is very early 1156This forking is done as the very first within main(), which is very early
1152and reduces possible bugs to initialisation code run before main(), or 1157and reduces possible bugs to initialisation code run before main(), or
1153things like the dynamic loader of your system, which should result in very 1158things like the dynamic loader of your system, which should result in very
1154little risk. 1159little risk.
1155 1160
1156=head3 On Solaris 9, many line-drawing characters are too wide.
1157
1158Seems to be a known bug, read
1159L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
1160following ugly workaround to get non-double-wide-characters working:
1161
1162 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
1163
1164=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all. 1161=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
1165 1162
1166Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1163Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
1167in your compile environment, or an implementation that implements it, 1164in your compile environment, or an implementation that implements it,
1168whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that 1165whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
… …
1191 1188
1192The rxvt-unicode author insists that the right way to fix this is in the 1189The rxvt-unicode author insists that the right way to fix this is in the
1193system libraries once and for all, instead of forcing every app to carry 1190system libraries once and for all, instead of forcing every app to carry
1194complete replacements for them :) 1191complete replacements for them :)
1195 1192
1196=head3 I use Solaris 9 and it doesn't compile/work/etc.
1197
1198Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
1199problems with C<wcwidth> and a compile problem.
1200
1201=head3 How can I use rxvt-unicode under cygwin? 1193=head3 How can I use rxvt-unicode under cygwin?
1202 1194
1203rxvt-unicode should compile and run out of the box on cygwin, using 1195rxvt-unicode should compile and run out of the box on cygwin, using
1204the X11 libraries that come with cygwin. libW11 emulation is no 1196the X11 libraries that come with cygwin. libW11 emulation is no
1205longer supported (and makes no sense, either, as it only supported a 1197longer supported (and makes no sense, either, as it only supported a
… …
1208old libW11 emulation. 1200old libW11 emulation.
1209 1201
1210At the time of this writing, cygwin didn't seem to support any multi-byte 1202At the time of this writing, cygwin didn't seem to support any multi-byte
1211encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited 1203encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1212to 8-bit encodings. 1204to 8-bit encodings.
1205
1206=head3 Character widths are not correct.
1207
1208urxvt uses the system wcwidth function to know the information about
1209the width of characters, so on systems with incorrect locale data you
1210will likely get bad results. Two notorious examples are Solaris 9,
1211where single-width characters like U+2514 are reported as double-width,
1212and Darwin 8, where combining chars are reported having width 1.
1213
1214The solution is to upgrade your system or switch to a better one. A
1215possibly working workaround is to use a wcwidth implementation like
1216
1217http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
1213 1218
1214=head1 RXVT-UNICODE TECHNICAL REFERENCE 1219=head1 RXVT-UNICODE TECHNICAL REFERENCE
1215 1220
1216The rest of this document describes various technical aspects of 1221The rest of this document describes various technical aspects of
1217B<rxvt-unicode>. First the description of supported command sequences, 1222B<rxvt-unicode>. First the description of supported command sequences,
… …
1983 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 1988 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> >> 1989 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> >> 1990 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] 1991 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] 1992 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). 1993 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> >>. 1994 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> 1995 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> >>. 1996 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> >> 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> >>
1993 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 1998 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
… …
2007 2012
2008=end table 2013=end table
2009 2014
2010=back 2015=back
2011 2016
2012=head1 XPM 2017=head1 BACKGROUND IMAGE
2013 2018
2014For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 2019For the BACGROUND IMAGE XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
2015of B<< C<Pt> >> can be the name of the background pixmap followed by a 2020of 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 2021sequence of scaling/positioning commands separated by semi-colons. The
2017scaling/positioning commands are as follows: 2022scaling/positioning commands are as follows:
2018 2023
2019=over 4 2024=over 4
2020 2025
… …
2058 2063
2059For example: 2064For example:
2060 2065
2061=over 4 2066=over 4
2062 2067
2063=item B<\E]20;funky\a> 2068=item B<\E]20;funky.jpg\a>
2064 2069
2065load B<funky.xpm> as a tiled image 2070load B<funky.jpg> as a tiled image
2066 2071
2067=item B<\E]20;mona;100\a> 2072=item B<\E]20;mona.jpg;100\a>
2068 2073
2069load B<mona.xpm> with a scaling of 100% 2074load B<mona.jpg> with a scaling of 100%
2070 2075
2071=item B<\E]20;;200;?\a> 2076=item B<\E]20;;200;?\a>
2072 2077
2073rescale the current pixmap to 200% and display the image geometry in 2078rescale the current pixmap to 200% and display the image geometry in
2074the title 2079the title
… …
2201 2206
2202=head1 CONFIGURE OPTIONS 2207=head1 CONFIGURE OPTIONS
2203 2208
2204General hint: if you get compile errors, then likely your configuration 2209General hint: if you get compile errors, then likely your configuration
2205hasn't been tested well. Either try with C<--enable-everything> or use 2210hasn'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 2211the 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 2212switches). Of course, you should always report when a combination doesn't
2208can be fixed. Marc Lehmann <rxvt@schmorp.de>. 2213work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2209 2214
2210All 2215All
2211 2216
2212=over 4 2217=over 4
2213 2218
… …
2325 2330
2326Write user and tty to lastlog file (used by programs like 2331Write user and tty to lastlog file (used by programs like
2327F<lastlogin>) at start of rxvt execution. This option requires 2332F<lastlogin>) at start of rxvt execution. This option requires
2328--enable-utmp to also be specified. 2333--enable-utmp to also be specified.
2329 2334
2330=item --enable-xpm-background (default: on) 2335=item --enable-afterimage (default: on)
2331 2336
2332Add support for XPM background pixmaps. 2337Add support for libAfterImage to be used for transparency and background
2338images. It adds support for many file formats including JPG, PNG,
2339SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
2340(L<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
2341
2342This option also adds such eye candy as blending an image over the root
2343background, as well as dynamic scaling and bluring of background images.
2344
2345Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might
2346increase by a few megabytes even if no extra features are used (mostly due
2347to third-party libraries used by libAI). Memory footprint may somewhat be
2348lowered if libAfterImage is configured without support for SVG.
2333 2349
2334=item --enable-transparency (default: on) 2350=item --enable-transparency (default: on)
2335 2351
2336Add support for inheriting parent backgrounds thus giving a fake 2352Add support for inheriting parent backgrounds thus giving a fake
2337transparency to the term. 2353transparency to the term.
2338 2354
2339=item --enable-fading (default: on) 2355=item --enable-fading (default: on)
2340 2356
2341Add support for fading the text when focus is lost (requires C<--enable-transparency>). 2357Add support for fading the text when focus is lost.
2342
2343=item --enable-tinting (default: on)
2344
2345Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2346 2358
2347=item --enable-rxvt-scroll (default: on) 2359=item --enable-rxvt-scroll (default: on)
2348 2360
2349Add support for the original rxvt scrollbar. 2361Add support for the original rxvt scrollbar.
2350 2362
… …
2435=item --enable-keepscrolling (default: on) 2447=item --enable-keepscrolling (default: on)
2436 2448
2437Add support for continual scrolling of the display when you hold 2449Add support for continual scrolling of the display when you hold
2438the mouse button down on a scrollbar arrow. 2450the mouse button down on a scrollbar arrow.
2439 2451
2452=item --enable-selectionscrolling (default: on)
2453
2454Add support for scrolling when the selection moves to the top or
2455bottom of the screen.
2456
2440=item --enable-mousewheel (default: on) 2457=item --enable-mousewheel (default: on)
2441 2458
2442Add support for scrolling via mouse wheel or buttons 4 & 5. 2459Add support for scrolling via mouse wheel or buttons 4 & 5.
2443 2460
2444=item --enable-slipwheeling (default: on) 2461=item --enable-slipwheeling (default: on)
2445 2462
2446Add support for continual scrolling (using the mouse wheel as an 2463Add support for continual scrolling (using the mouse wheel as an
2447accelerator) while the control key is held down. This option 2464accelerator) while the control key is held down. This option
2448requires --enable-mousewheel to also be specified. 2465requires --enable-mousewheel to also be specified.
2449 2466
2450=item --enable-smart-resize (default: on) 2467=item --enable-smart-resize (default: off)
2451 2468
2452Add smart growth/shrink behaviour when changing font size via hot 2469Add smart growth/shrink behaviour when resizing.
2453keys. This should keep the window corner which is closest to a corner of 2470This should keep the window corner which is closest to a corner of
2454the screen in a fixed position. 2471the screen in a fixed position.
2455 2472
2456=item --enable-pointer-blank (default: on) 2473=item --enable-pointer-blank (default: on)
2457 2474
2458Add support to have the pointer disappear when typing or inactive. 2475Add support to have the pointer disappear when typing or inactive.
… …
2466C<PERL> environment variable when running configure. Even when compiled 2483C<PERL> environment variable when running configure. Even when compiled
2467in, perl will I<not> be initialised when all extensions have been disabled 2484in, perl will I<not> be initialised when all extensions have been disabled
2468C<-pe "" --perl-ext-common "">, so it should be safe to enable from a 2485C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2469resource standpoint. 2486resource standpoint.
2470 2487
2488=item --with-afterimage-config=DIR
2489
2490Look for the libAfterImage config script in DIR.
2491
2471=item --with-name=NAME (default: urxvt) 2492=item --with-name=NAME (default: urxvt)
2472 2493
2473Set the basename for the installed binaries, resulting 2494Set the basename for the installed binaries, resulting
2474in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2495in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2475C<rxvt>. 2496C<rxvt>.
… …
2484PATH. 2505PATH.
2485 2506
2486=item --with-x 2507=item --with-x
2487 2508
2488Use the X Window System (pretty much default, eh?). 2509Use the X Window System (pretty much default, eh?).
2489
2490=item --with-xpm-includes=DIR
2491
2492Look for the XPM includes in DIR.
2493
2494=item --with-xpm-library=DIR
2495
2496Look for the XPM library in DIR.
2497
2498=item --with-xpm
2499
2500Not needed - define via --enable-xpm-background.
2501 2510
2502=back 2511=back
2503 2512
2504=head1 AUTHORS 2513=head1 AUTHORS
2505 2514

Diff Legend

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