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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.75 by root, Tue Dec 27 01:50:00 2005 UTC vs.
Revision 1.160 by root, Fri Jan 25 18:42:23 2008 UTC

12emulator intended as an I<xterm>(1) replacement for users who do not 12emulator intended as an I<xterm>(1) replacement for users who do not
13require features such as Tektronix 4014 emulation and toolkit-style 13require features such as Tektronix 4014 emulation and toolkit-style
14configurability. As a result, B<rxvt-unicode> uses much less swap space -- 14configurability. As a result, B<rxvt-unicode> uses much less swap space --
15a significant advantage on a machine serving many X sessions. 15a significant advantage on a machine serving many X sessions.
16 16
17This document is also available on the World-Wide-Web at
18L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
19
17=head1 FREQUENTLY ASKED QUESTIONS 20=head1 FREQUENTLY ASKED QUESTIONS
18 21
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of 22See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20frequently asked questions and answer to them and some common 23frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at 24problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 25L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23 26
24=head1 RXVT-UNICODE VS. RXVT 27=head1 RXVT-UNICODE VS. RXVT
25 28
26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 29Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27internally. That means it can store and display most scripts in the 30internally. That means it can store and display most scripts in the
28world. Being a terminal emulator, however, some things are very difficult, 31world. Being a terminal emulator, however, some things are very difficult,
29especially cursive scripts such as arabic, vertically written scripts 32especially cursive scripts such as arabic, vertically written scripts
30like mongolian or scripts requiring extremely complex combining rules, 33like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devenagari. Don't expect pretty output when using these 34like tibetan or devanagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 35scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are left-to-right scripts, such 36fine, though. A somewhat difficult case are right-to-left scripts, such
34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 37as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35belong into the application, not the terminal emulator (too many things -- 38belong in the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 39such as cursor-movement while editing -- break otherwise), but that might
37change. 40change.
38 41
39If you are looking for a terminal that supports more exotic scripts, let 42If you are looking for a terminal that supports more exotic scripts, let
40me recommend C<mlterm>, which is a very userfriendly, lean and clean 43me recommend C<mlterm>, which is a very user friendly, lean and clean
41terminal emulator. In fact, the reason rxvt-unicode was born was solely 44terminal emulator. In fact, the reason rxvt-unicode was born was solely
42because the author couldn't get C<mlterm> to use one font for latin1 and 45because the author couldn't get C<mlterm> to use one font for latin1 and
43another for japanese. 46another for japanese.
44 47
45Therefore another design rationale was the use of multiple fonts to 48Therefore another design rationale was the use of multiple fonts to
46display characters: The idea of a single unicode font which many other 49display characters: The idea of a single unicode font which many other
47programs force onto it's users never made sense to me: You should be able 50programs force onto its users never made sense to me: You should be able
48to choose any font for any script freely. 51to choose any font for any script freely.
49 52
50Apart from that, rxvt-unicode is also much better internationalised than 53Apart from that, rxvt-unicode is also much better internationalised than
51it's predecessor, supports things such as XFT and ISO 14755 that are handy 54its predecessor, supports things such as XFT and ISO 14755 that are handy
52in i18n-environments, is faster, and has a lot less bugs than the original 55in i18n-environments, is faster, and has a lot bugs less than the original
53rxvt. This all in addition to dozens of other small improvements. 56rxvt. This all in addition to dozens of other small improvements.
54 57
55It is still faithfully following the original rxvt idea of being lean 58It is still faithfully following the original rxvt idea of being lean
56and nice on resources: for example, you can still configure rxvt-unicode 59and nice on resources: for example, you can still configure rxvt-unicode
57without most of it's features to get a lean binary. It also comes with 60without most of its features to get a lean binary. It also comes with
58a client/daemon pair that lets you open any number of terminal windows 61a client/daemon pair that lets you open any number of terminal windows
59from within a single process, which makes startup time very fast and 62from within a single process, which makes startup time very fast and
60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 63drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61@@RXVT_NAME@@c(1) (client). 64@@RXVT_NAME@@c(1) (client).
62 65
63It also makes technical information about escape sequences (which have 66It also makes technical information about escape sequences (which have
64been extended) easier accessible: see @@RXVT_NAME@@(7) for technical 67been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65reference documentation (escape sequences etc.). 68reference documentation (escape sequences etc.).
66 69
67=head1 OPTIONS 70=head1 OPTIONS
68 71
69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed 72The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
93 96
94Attempt to open a window on the named X display (B<-d> still 97Attempt to open a window on the named X display (B<-d> still
95respected). In the absence of this option, the display specified by the 98respected). In the absence of this option, the display specified by the
96B<DISPLAY> environment variable is used. 99B<DISPLAY> environment variable is used.
97 100
101=item B<-depth> I<bitdepth>
102
103Compile I<xft>: Attempt to find a visual with the given bit depth;
104resource B<depth>.
105
106[Please note that many X servers (and libXft) are buggy with
107respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108of graphical corruption. This is harmless, but we can't do anything about
109this, so watch out]
110
98=item B<-geometry> I<geom> 111=item B<-geometry> I<geom>
99 112
100Window geometry (B<-g> still respected); resource B<geometry>. 113Window geometry (B<-g> still respected); resource B<geometry>.
101 114
102=item B<-rv>|B<+rv> 115=item B<-rv>|B<+rv>
103 116
104Turn on/off simulated reverse video; resource B<reverseVideo>. 117Turn on/off simulated reverse video; resource B<reverseVideo>.
105 118
106=item B<-j>|B<+j> 119=item B<-j>|B<+j>
107 120
108Turn on/off jump scrolling; resource B<jumpScroll>. 121Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
109 122
110=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 123=item B<-ss>|B<+ss>
111 124
112Turn on/off inheriting parent window's pixmap. Alternative form is 125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
113B<-tr>; resource B<inheritPixmap>. 126
127=item B<-tr>|B<+tr>
128
129Turn on/off illusion of a transparent window background; resource B<transparent>.
130
131B<-ip> is still accepted as an obsolete alias but will be removed in
132future versions.
133
134I<Please address all transparency related issues to Sasha Vasko at
135sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
114 136
115=item B<-fade> I<number> 137=item B<-fade> I<number>
116 138
117Fade the text by the given percentage when focus is lost. Small values 139Fade the text by the given percentage when focus is lost. Small values
118fade a little only, 100 completely replaces all colours by the fade 140fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>. 141colour; resource B<fading>.
120 142
121=item B<-fadecolor> I<colour> 143=item B<-fadecolor> I<colour>
122 144
123Fade to this colour when fading is used (see B<-fade>). The default colour 145Fade to this colour when fading is used (see B<-fade>). The default colour
124is black. resource B<fadeColor>. 146is opaque black. resource B<fadeColor>.
125 147
126=item B<-tint> I<colour> 148=item B<-tint> I<colour>
127 149
128Tint the transparent background pixmap with the given colour when 150Tint the transparent background pixmap with the given colour when
129transparency is enabled with B<-tr> or B<-ip>. This only works for 151transparency is enabled with B<-tr>. This only works for
130non-tiled backgrounds, currently. See also the B<-sh> option that can be 152non-tiled backgrounds, currently. See also the B<-sh> option that can be
131used to brighten or darken the image in addition to tinting it; resource 153used to brighten or darken the image in addition to tinting it.
154Please note that certain tint colours can be applied on the server-side,
155thus yielding performance gain of two orders of magnitude. These colours are:
156blue, red, green, cyan, magenta, yellow, and those close to them. Also
157pure black and pure white colors essentially mean no tinting; resource
132I<tintColor>. Example: 158I<tintColor>. Example:
133 159
134 @@RXVT_NAME@@ -tr -tint blue -sh 40 160 @@RXVT_NAME@@ -tr -tint blue -sh 40
135 161
136=item B<-sh> 162=item B<-sh> I<number>
137 163
138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 164Darken (0 .. 100) or lighten (100 .. 200) the transparent
139background image in addition to tinting it (i.e. B<-tint> must be 165background image in addition to (or instead of) tinting it;
140specified, too, e.g. C<-tint white>). 166resource I<shading>.
167
168=item B<-blt> I<string>
169
170Specify background blending type. If background pixmap is specified
171at the same time as transparency - such pixmap will be blended over
172transparency image, using method specified. Supported values are :
173B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
174B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
175B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
176alpha-blending. Compile I<afterimage>; resource I<blendType>.
177
178=item B<-blr> I<HxV>
179
180Apply Gaussian Blur with the specified radii to the transparent
181background image. If single number is specified - both vertical and
182horizontal radii are considered to be the same. Setting one of the
183radii to 1 and another to a large number creates interesting effects
184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
185resource I<blurRadius>.
141 186
142=item B<-bg> I<colour> 187=item B<-bg> I<colour>
143 188
144Window background colour; resource B<background>. 189Window background colour; resource B<background>.
145 190
146=item B<-fg> I<colour> 191=item B<-fg> I<colour>
147 192
148Window foreground colour; resource B<foreground>. 193Window foreground colour; resource B<foreground>.
149 194
150=item B<-pixmap> I<file[;geom]> 195=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
151 196
152Compile I<XPM>: Specify XPM file for the background and also optionally 197Compile I<afterimage>: Specify image file for the background and also
153specify its scaling with a geometry string. Note you may need to 198optionally specify its scaling with a geometry string. Note you may need to
154add quotes to avoid special shell interpretation of the C<;> in the 199add quotes to avoid special shell interpretation of the C<;> in the
155command-line; resource B<backgroundPixmap>. 200command-line; for more details see resource B<backgroundPixmap>.
156 201
157=item B<-cr> I<colour> 202=item B<-cr> I<colour>
158 203
159The cursor colour; resource B<cursorColor>. 204The cursor colour; resource B<cursorColor>.
160 205
172resource B<borderColor>. 217resource B<borderColor>.
173 218
174=item B<-fn> I<fontlist> 219=item B<-fn> I<fontlist>
175 220
176Select the fonts to be used. This is a comma separated list of font names 221Select the fonts to be used. This is a comma separated list of font names
177that are used in turn when trying to display Unicode characters. The 222that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 223first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 224smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 225font list is always appended to it. See resource B<font> for more details.
181 226
182In short, to specify an X11 core font, just specify it's name or prefix it 227In short, to specify an X11 core font, just specify its name or prefix it
183with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, 228with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184e.g.: 229e.g.:
185 230
186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 231 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 232 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
189See also the question "How does rxvt-unicode choose fonts?" in the FAQ 234See also the question "How does rxvt-unicode choose fonts?" in the FAQ
190section of @@RXVT_NAME@@(7). 235section of @@RXVT_NAME@@(7).
191 236
192=item B<-fb> I<fontlist> 237=item B<-fb> I<fontlist>
193 238
194Compile font-styles: The bold font list to use when bold characters are to 239Compile I<font-styles>: The bold font list to use when B<bold> characters
195be printed. See resource B<boldFont> for details. 240are to be printed. See resource B<boldFont> for details.
196 241
197=item B<-fi> I<fontlist> 242=item B<-fi> I<fontlist>
198 243
199Compile font-styles: The italic font list to use when bold characters are to 244Compile I<font-styles>: The italic font list to use when I<italic>
200be printed. See resource B<italicFont> for details. 245characters are to be printed. See resource B<italicFont> for details.
201 246
202=item B<-fbi> I<fontlist> 247=item B<-fbi> I<fontlist>
203 248
204Compile font-styles: The bold italic font list to use when bold characters are to 249Compile I<font-styles>: The bold italic font list to use when B<< I<bold
205be printed. See resource B<boldItalicFont> for details. 250italic> >> characters are to be printed. See resource B<boldItalicFont>
251for details.
252
253=item B<-is>|B<+is>
254
255Compile I<font-styles>: Bold/Blink font styles imply high intensity
256foreground/background (default). See resource B<intensityStyles> for
257details.
206 258
207=item B<-name> I<name> 259=item B<-name> I<name>
208 260
209Specify the application name under which resources are to be obtained, 261Specify the application name under which resources are to be obtained,
210rather than the default executable file name. Name should not contain 262rather than the default executable file name. Name should not contain
226 278
227=item B<-sb>|B<+sb> 279=item B<-sb>|B<+sb>
228 280
229Turn on/off scrollbar; resource B<scrollBar>. 281Turn on/off scrollbar; resource B<scrollBar>.
230 282
283=item B<-sr>|B<+sr>
284
285Put scrollbar on right/left; resource B<scrollBar_right>.
286
287=item B<-st>|B<+st>
288
289Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
290resource B<scrollBar_floating>.
291
231=item B<-si>|B<+si> 292=item B<-si>|B<+si>
232 293
233Turn on/off scroll-to-bottom on TTY output inhibit; resource 294Turn on/off scroll-to-bottom on TTY output inhibit; resource
234B<scrollTtyOutput> has opposite effect. 295B<scrollTtyOutput> has opposite effect.
235 296
241=item B<-sw>|B<+sw> 302=item B<-sw>|B<+sw>
242 303
243Turn on/off scrolling with the scrollback buffer as new lines appear. 304Turn on/off scrolling with the scrollback buffer as new lines appear.
244This only takes effect if B<-si> is also given; resource 305This only takes effect if B<-si> is also given; resource
245B<scrollWithBuffer>. 306B<scrollWithBuffer>.
246
247=item B<-sr>|B<+sr>
248
249Put scrollbar on right/left; resource B<scrollBar_right>.
250
251=item B<-st>|B<+st>
252
253Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
254resource B<scrollBar_floating>.
255 307
256=item B<-ptab>|B<+ptab> 308=item B<-ptab>|B<+ptab>
257 309
258If enabled (default), "Horizontal Tab" characters are being stored as 310If enabled (default), "Horizontal Tab" characters are being stored as
259actual wide characters in the screen buffer, which makes it possible to 311actual wide characters in the screen buffer, which makes it possible to
290 342
291Compile I<frills>: Set MWM hints to request a borderless window, i.e. 343Compile I<frills>: Set MWM hints to request a borderless window, i.e.
292if honoured by the WM, the rxvt-unicode window will not have window 344if honoured by the WM, the rxvt-unicode window will not have window
293decorations; resource B<borderLess>. 345decorations; resource B<borderLess>.
294 346
347=item B<-override-redirect>
348
349Compile I<frills>: Sets override-redirect on the window; resource
350B<override-redirect>.
351
352=item B<-sbg>
353
354Compile I<frills>: Disable the usage of the built-in block graphics/line
355drawing characters and just rely on what the specified fonts provide. Use
356this if you have a good font and want to use its block graphic glyphs;
357resource B<skipBuiltinGlyphs>.
358
295=item B<-lsp> I<number> 359=item B<-lsp> I<number>
296 360
297Compile I<frills>: Lines (pixel height) to insert between each row of 361Compile I<frills>: Lines (pixel height) to insert between each row of
298the display. Useful to work around font rendering problems; resource 362the display. Useful to work around font rendering problems; resource
299B<linespace>. 363B<lineSpace>.
300 364
301=item B<-tn> I<termname> 365=item B<-tn> I<termname>
302 366
303This option specifies the name of the terminal type to be set in the 367This option specifies the name of the terminal type to be set in the
304B<TERM> environment variable. This terminal type must exist in the 368B<TERM> environment variable. This terminal type must exist in the
358for more info. 422for more info.
359 423
360=item B<-tcw> 424=item B<-tcw>
361 425
362Change the meaning of triple-click selection with the left mouse 426Change the meaning of triple-click selection with the left mouse
427button. Only effective when the original (non-perl) selection code is
363button. Instead of selecting a full line it will extend the selection the 428in-use. Instead of selecting a full line it will extend the selection to
364end of the logical line only. resource B<tripleclickwords>. 429the end of the logical line only. resource B<tripleclickwords>.
365 430
366=item B<-insecure> 431=item B<-insecure>
367 432
368Enable "insecure" mode, which currently enables most of the escape 433Enable "insecure" mode, which currently enables most of the escape
369sequences that echo strings. See the resource B<insecure> for more 434sequences that echo strings. See the resource B<insecure> for more
390Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 455Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
391will not immediately destroy its window when the program executed within 456will not immediately destroy its window when the program executed within
392it exits. Instead, it will wait till it is being killed or closed by the 457it exits. Instead, it will wait till it is being killed or closed by the
393user; resource B<hold>. 458user; resource B<hold>.
394 459
460=item B<-xrm> I<string>
461
462Works like the X Toolkit option of the same name, by adding the I<string>
463as if it were specified in a resource file. Resource values specified this
464way take precedence over all other resource specifications.
465
466Note that you need to use the I<same> syntax as in the .Xdefaults file,
467e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
468options can be specified as long-options on the commandline, so use
469of B<-xrm> is mostly limited to cases where you want to specify other
470resources (e.g. for input methods) or for compatibility with other
471programs.
472
395=item B<-keysym.>I<sym> I<string> 473=item B<-keysym.>I<sym> I<string>
396 474
397Remap a key symbol. See resource B<keysym>. 475Remap a key symbol. See resource B<keysym>.
398 476
399=item B<-embed> I<windowid> 477=item B<-embed> I<windowid>
400 478
401Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 479Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
402which enables applications to easily embed a terminal. 480which enables applications to easily embed a terminal.
403 481
404Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 482Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
405shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 483shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
406quite a bit, so don't expect it to keep some specific state. It's best to 484quite a bit, so don't expect it to keep some specific state. It's best to
409The window will not be destroyed when @@RXVT_NAME@@ exits. 487The window will not be destroyed when @@RXVT_NAME@@ exits.
410 488
411It might be useful to know that @@RXVT_NAME@@ will not close file 489It might be useful to know that @@RXVT_NAME@@ will not close file
412descriptors passed to it (except for stdin/out/err, of course), so you 490descriptors passed to it (except for stdin/out/err, of course), so you
413can use file descriptors to communicate with the programs within the 491can use file descriptors to communicate with the programs within the
414terminal. This works regardless of wether the C<-embed> option was used or 492terminal. This works regardless of whether the C<-embed> option was used or
415not. 493not.
416 494
417Here is a short Gtk2-perl snippet that illustrates how this option can be 495Here is a short Gtk2-perl snippet that illustrates how this option can be
418used (a longer example is in F<doc/embed>): 496used (a longer example is in F<doc/embed>):
419 497
421 $rxvt->signal_connect_after (realize => sub { 499 $rxvt->signal_connect_after (realize => sub {
422 my $xid = $_[0]->window->get_xid; 500 my $xid = $_[0]->window->get_xid;
423 system "@@RXVT_NAME@@ -embed $xid &"; 501 system "@@RXVT_NAME@@ -embed $xid &";
424 }); 502 });
425 503
426=item B<-pty-fd> I<fileno> 504=item B<-pty-fd> I<file descriptor>
427 505
428Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 506Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
429pair but instead use the given filehandle as the tty master. This is 507pair but instead use the given file descriptor as the tty master. This is
430useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 508useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
431without having to run a program within it. 509without having to run a program within it.
432 510
433If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 511If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
434entries and will not tinker with pty/tty permissions - you have to do that 512entries and will not tinker with pty/tty permissions - you have to do that
435yourself if you want that. 513yourself if you want that.
514
515As an extremely special case, specifying C<-1> will completely suppress
516pty/tty operations, which is probably only useful in conjunction with some
517perl extension that manages the terminal.
436 518
437Here is a example in perl that illustrates how this option can be used (a 519Here is a example in perl that illustrates how this option can be used (a
438longer example is in F<doc/pty-fd>): 520longer example is in F<doc/pty-fd>):
439 521
440 use IO::Pty; 522 use IO::Pty;
447 529
448 # now communicate with rxvt 530 # now communicate with rxvt
449 my $slave = $pty->slave; 531 my $slave = $pty->slave;
450 while (<$slave>) { print $slave "got <$_>\n" } 532 while (<$slave>) { print $slave "got <$_>\n" }
451 533
534=item B<-pe> I<string>
535
536Comma-separated list of perl extension scripts to use (or not to use) in
537this terminal instance. See resource B<perl-ext> for details.
538
452=back 539=back
453 540
454=head1 RESOURCES (available also as long-options) 541=head1 RESOURCES
455 542
456Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 543Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
457options) compiled into your version. 544options) compiled into your version. All resources are also available as
545long-options.
458 546
459There are two different methods that @@RXVT_NAME@@ can use to get the 547You can set and change the resources using X11 tools like B<xrdb>. Many
460Xresource data: using the X libraries (Xrm*-functions) or internal 548distribution do also load settings from the B<~/.Xresources> file when X
461Xresources reader (B<~/.Xdefaults>). For the first method (ie. 549starts. @@RXVT_NAME@@ will consult the following files/resources in order,
462B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 550with later settings overwriting earlier ones:
463resources using X11 tools like B<xrdb>. Many distribution do also load
464settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
465will consult the following files/resources in order, with later settings
466overwriting earlier ones:
467 551
468 1. system-wide app-defaults file, either locale-dependent OR global 552 1. system-wide app-defaults file, either locale-dependent OR global
469 2. app-defaults file in $XAPPLRESDIR 553 2. app-defaults file in $XAPPLRESDIR
470 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 554 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
471 4. SCREEN_RESOURCES for the current screen 555 4. SCREEN_RESOURCES for the current screen
472 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 556 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
557 6. resources specified via -xrm on the commandline
473 558
474If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
475lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
476set in XAPPLOADDIR/URxvt (compile-time defined: usually
477B</usr/lib/X11/app-defaults/URxvt>) and resources set in
478B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
479Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 559Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
480class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 560names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
481resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 561common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
482easily configured, while the class name B<URxvt> allows resources 562configured, while the class name B<URxvt> allows resources unique to
483unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 563B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
484shared between different B<@@RXVT_NAME@@> configurations. If no 564configurations. If no resources are specified, suitable defaults will
485resources are specified, suitable defaults will be used. Command-line 565be used. Command-line arguments can be used to override resource
486arguments can be used to override resource settings. The following 566settings. The following resources are supported (you might want to
487resources are allowed: 567check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
568extensions not documented here):
488 569
489=over 4 570=over 4
571
572=item B<depth:> I<bitdepth>
573
574Compile I<xft>: Attempt to find a visual with the given bit depth;
575option B<-depth>.
490 576
491=item B<geometry:> I<geom> 577=item B<geometry:> I<geom>
492 578
493Create the window with the specified X window geometry [default 80x24]; 579Create the window with the specified X window geometry [default 80x24];
494option B<-geometry>. 580option B<-geometry>.
531Use the specified colour to display underlined characters when the 617Use the specified colour to display underlined characters when the
532foreground colour is the default. 618foreground colour is the default.
533 619
534=item B<colorRV:> I<colour> 620=item B<colorRV:> I<colour>
535 621
536Use the specified colour as the background for reverse video 622Use the specified colour as the background for reverse video characters
537characters. 623when OPTION_HC is disabled (--disable-frills).
538 624
539=item B<underlineColor:> I<colour> 625=item B<underlineColor:> I<colour>
540 626
541If set, use the specified colour as the colour for the underline 627If set, use the specified colour as the colour for the underline
542itself. If unset, use the foreground colour. 628itself. If unset, use the foreground colour.
558option B<-rv>. B<False>: regular screen colours [default]; option 644option B<-rv>. B<False>: regular screen colours [default]; option
559B<+rv>. See note in B<COLORS AND GRAPHICS> section. 645B<+rv>. See note in B<COLORS AND GRAPHICS> section.
560 646
561=item B<jumpScroll:> I<boolean> 647=item B<jumpScroll:> I<boolean>
562 648
563B<True>: specify that jump scrolling should be used. When scrolling 649B<True>: specify that jump scrolling should be used. When receiving lots
564quickly, fewer screen updates are performed [default]; option B<-j>. 650of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
651has been read, resulting in fewer updates while still displaying every
652received line; option B<-j>.
653
565B<False>: specify that smooth scrolling should be used; option B<+j>. 654B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
655force a screen refresh on each new line it received; option B<+j>.
566 656
567=item B<inheritPixmap:> I<boolean> 657=item B<skipScroll:> I<boolean>
568 658
569B<True>: make the background inherit the parent windows' pixmap, giving 659B<True>: (the default) specify that skip scrolling should be used. When
570artificial transparency. B<False>: do not inherit the parent windows' 660receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
571pixmap. 661(around 60 times per second), resulting in far fewer updates. This can
662result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
663option B<-ss>.
664
665B<False>: specify that everything is to be displayed, even
666if the refresh is too fast for the human eye to read anything (or the
667monitor to display anything); option B<+ss>.
668
669=item B<transparent:> I<boolean>
670
671Turn on/off illusion of a transparent window background.
672
673B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
674future versions.
675
676I<Please address all transparency related issues to Sasha Vasko at
677sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
572 678
573=item B<fading:> I<number> 679=item B<fading:> I<number>
574 680
575Fade the text by the given percentage when focus is lost; option B<-fade>. 681Fade the text by the given percentage when focus is lost; option B<-fade>.
576 682
584Tint the transparent background pixmap with the given colour; option 690Tint the transparent background pixmap with the given colour; option
585B<-tint>. 691B<-tint>.
586 692
587=item B<shading:> I<number> 693=item B<shading:> I<number>
588 694
589Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 695Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
590image in addition to tinting it. 696in addition to tinting it; option B<-sh>.
697
698=item B<blendType:> I<string>
699
700Specify background blending type; option B<-blt>.
701
702=item B<blurRadius:> I<number>
703
704Apply Gaussian Blurr with the specified radius to the transparent
705background image; option B<-blr>.
591 706
592=item B<scrollColor:> I<colour> 707=item B<scrollColor:> I<colour>
593 708
594Use the specified colour for the scrollbar [default #B2B2B2]. 709Use the specified colour for the scrollbar [default #B2B2B2].
595 710
601=item B<borderColor:> I<colour> 716=item B<borderColor:> I<colour>
602 717
603The colour of the border around the text area and between the scrollbar 718The colour of the border around the text area and between the scrollbar
604and the text. 719and the text.
605 720
606=item B<backgroundPixmap:> I<file[;geom]> 721=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
607 722
608Use the specified XPM file (note the `.xpm' extension is optional) for 723Use the specified image file for the background and also
609the background and also optionally specify its scaling with a geometry 724optionally specify its scaling with a geometry string B<WxH+X+Y>,
610string B<WxH+X+Y>, in which B<"W" / "H"> specify the 725(default C<0x0+50+50>) in which B<"W" / "H"> specify the
611horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 726horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
612centre (percent). A scale of 0 displays the image with tiling. A scale 727centre (percent). A scale of 0 displays the image with tiling. A scale
613of 1 displays the image without any scaling. A scale of 2 to 9 728of 1 displays the image without any scaling. A scale of 2 to 9 specifies
614specifies an integer number of images in that direction. No image will 729an integer number of images in that direction. No image will be magnified
615be magnified beyond 10 times its original size. The maximum permitted 730beyond 10 times its original size. The maximum permitted scale is 1000.
616scale is 1000. [default 0x0+50+50] 731Additional operations can be specified after colon B<:op1:op2...>.
732Supported operations are:
617 733
618=item B<menu:> I<file[;tag]> 734 tile force background image to be tiled and not scaled. Equivalent to 0x0
735 propscale will scale image keeping proportions
736 auto will scale image to match window size. Equivalent to 100x100
737 hscale will scale image horizontally to the window size
738 vscale will scale image vertically to the window size
739 scale will scale image to match window size
740 root will tile image as if it was a root window background, auto-adjusting
741 whenever terminal window moves
619 742
620Read in the specified menu file (note the `.menu' extension is 743If used in conjunction with B<-tr> option, the specified pixmap will be
621optional) and also optionally specify a starting tag to find. See the 744blended over transparency image using either alpha-blending, or any
622reference documentation for details on the syntax for the menuBar. 745other blending type, specified with B<-blt "type"> option.
623 746
624=item B<path:> I<path> 747=item B<path:> I<path>
625 748
626Specify the colon-delimited search path for finding files (XPM and 749Specify the colon-delimited search path for finding background image files.
627menus), in addition to the paths specified by the B<RXVTPATH> and
628B<PATH> environment variables.
629 750
630=item B<font:> I<fontlist> 751=item B<font:> I<fontlist>
631 752
632Select the fonts to be used. This is a comma separated list of font 753Select the fonts to be used. This is a comma separated list of font names
633names that are used in turn when trying to display Unicode characters. 754that are checked in order when trying to find glyphs for characters. The
634The first font defines the cell size for characters; other fonts might 755first font defines the cell size for characters; other fonts might be
635be smaller, but not larger. A reasonable default font list is always 756smaller, but not (in general) larger. A (hopefully) reasonable default
636appended to it. option B<-fn>. 757font list is always appended to it; option B<-fn>.
637 758
638Each font can either be a standard X11 core font (XLFD) name, with 759Each font can either be a standard X11 core font (XLFD) name, with
639optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 760optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
640 761
641In addition, each font can be prefixed with additional hints and 762In addition, each font can be prefixed with additional hints and
643hint currently is C<codeset=codeset-name>, and this is only used for Xft 764hint currently is C<codeset=codeset-name>, and this is only used for Xft
644fonts. 765fonts.
645 766
646For example, this font resource 767For example, this font resource
647 768
648 URxvt*font: 9x15bold,\ 769 URxvt.font: 9x15bold,\
649 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 770 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
650 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 771 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
651 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 772 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
652 xft:Code2000:antialias=false 773 xft:Code2000:antialias=false
653 774
687not possible, replacement fonts of the desired shape will be tried. 808not possible, replacement fonts of the desired shape will be tried.
688 809
689If set, but empty, then this specific style is disabled and the normal 810If set, but empty, then this specific style is disabled and the normal
690text font will being used for the given style. 811text font will being used for the given style.
691 812
692=item B<selectstyle:> I<mode> 813=item B<intensityStyles:> I<boolean>
693 814
694Set mouse selection style to B<old> which is 2.20, B<oldword> which is 815When font styles are not enabled, or this option is enabled (B<True>,
695xterm style with 2.20 old word selection, or anything else which gives 816option B<-is>, the default), bold/blink font styles imply high
696xterm style selection. 817intensity foreground/background colours. Disabling this option (B<False>,
697 818option B<+is>) disables this behaviour, the high intensity colours are not
698=item B<scrollstyle:> I<mode> 819reachable.
699
700Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
701the author's favourite.
702 820
703=item B<title:> I<string> 821=item B<title:> I<string>
704 822
705Set window title string, the default title is the command-line 823Set window title string, the default title is the command-line
706specified after the B<-e> option, if any, otherwise the application 824specified after the B<-e> option, if any, otherwise the application
715=item B<mapAlert:> I<boolean> 833=item B<mapAlert:> I<boolean>
716 834
717B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 835B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
718de-iconify (map) on receipt of a bell character [default]. 836de-iconify (map) on receipt of a bell character [default].
719 837
838=item B<urgentOnBell:> I<boolean>
839
840B<True>: set the urgency hint for the wm on receipt of a bell character.
841B<False>: do not set the urgency hint [default].
842
720=item B<visualBell:> I<boolean> 843=item B<visualBell:> I<boolean>
721 844
722B<True>: use visual bell on receipt of a bell character; option B<-vb>. 845B<True>: use visual bell on receipt of a bell character; option B<-vb>.
723B<False>: no visual bell [default]; option B<+vb>. 846B<False>: no visual bell [default]; option B<+vb>.
724 847
742 865
743The string will be interpreted as if typed into the shell as-is. 866The string will be interpreted as if typed into the shell as-is.
744 867
745Example: 868Example:
746 869
747 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 870 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
748 871
749This creates a new file in your home directory with the screen contents 872This creates a new file in your home directory with the screen contents
750everytime you hit C<Print>. 873every time you hit C<Print>.
874
875=item B<scrollstyle:> I<mode>
876
877Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
878the author's favourite.
751 879
752=item B<scrollBar:> I<boolean> 880=item B<scrollBar:> I<boolean>
753 881
754B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 882B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
755disable the scrollbar; option B<+sb>. 883disable the scrollbar; option B<+sb>.
777 905
778=item B<scrollWithBuffer:> I<boolean> 906=item B<scrollWithBuffer:> I<boolean>
779 907
780B<True>: scroll with scrollback buffer when tty receives new lines (and 908B<True>: scroll with scrollback buffer when tty receives new lines (and
781B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 909B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
782with scrollback buffer when tty recieves new lines; option B<+sw>. 910with scrollback buffer when tty receives new lines; option B<+sw>.
783 911
784=item B<scrollTtyKeypress:> I<boolean> 912=item B<scrollTtyKeypress:> I<boolean>
785 913
786B<True>: scroll to bottom when a non-special key is pressed. Special keys 914B<True>: scroll to bottom when a non-special key is pressed. Special keys
787are those which are intercepted by rxvt-unicode for special handling and 915are those which are intercepted by rxvt-unicode for special handling and
806=item B<borderLess:> I<boolean> 934=item B<borderLess:> I<boolean>
807 935
808Set MWM hints to request a borderless window, i.e. if honoured by the 936Set MWM hints to request a borderless window, i.e. if honoured by the
809WM, the rxvt-unicode window will not have window decorations; option B<-bl>. 937WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
810 938
939=item B<skipBuiltinGlyphs:> I<boolean>
940
941Compile I<frills>: Disable the usage of the built-in block graphics/line
942drawing characters and just rely on what the specified fonts provide. Use
943this if you have a good font and want to use its block graphic glyphs;
944option B<-sbg>.
945
811=item B<termName:> I<termname> 946=item B<termName:> I<termname>
812 947
813Specifies the terminal type name to be set in the B<TERM> environment 948Specifies the terminal type name to be set in the B<TERM> environment
814variable; option B<-tn>. 949variable; option B<-tn>.
815 950
816=item B<linespace:> I<number> 951=item B<lineSpace:> I<number>
817 952
818Specifies number of lines (pixel height) to insert between each row of 953Specifies number of lines (pixel height) to insert between each row of
819the display [default 0]; option B<-lsp>. 954the display [default 0]; option B<-lsp>.
820 955
821=item B<meta8:> I<boolean> 956=item B<meta8:> I<boolean>
870pressed. If unset it will send the sequence traditionally associated 1005pressed. If unset it will send the sequence traditionally associated
871with the B<Execute> key. 1006with the B<Execute> key.
872 1007
873=item B<cutchars:> I<string> 1008=item B<cutchars:> I<string>
874 1009
875The characters used as delimiters for double-click word selection. The 1010The characters used as delimiters for double-click word selection
876built-in default: 1011(whitespace delimiting is added automatically if resource is given).
877 1012
1013When the perl selection extension is in use (the default if compiled
1014in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
1015characters will be created (if the resource exists, otherwise, no regex
1016will be created). In this mode, characters outside ISO-8859-1 can be used.
1017
1018When the selection extension is not used, only ISO-8859-1 characters can
1019be used. If not specified, the built-in default is used:
1020
878B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1021B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
879 1022
880=item B<preeditType:> I<style> 1023=item B<preeditType:> I<style>
881 1024
882B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1025B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
883 1026
888=item B<imLocale:> I<name> 1031=item B<imLocale:> I<name>
889 1032
890The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. 1033The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
891C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the 1034C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
892input extension to be able to input japanese characters while staying in 1035input extension to be able to input japanese characters while staying in
893another locale. option B<-imlocale>. 1036another locale; option B<-imlocale>.
894 1037
895=item B<imFont:> I<fontset> 1038=item B<imFont:> I<fontset>
896 1039
897Specify the font-set used for XIM styles C<OverTheSpot> or 1040Specify the font-set used for XIM styles C<OverTheSpot> or
898C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated 1041C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
903 1046
904=item B<tripleclickwords:> I<boolean> 1047=item B<tripleclickwords:> I<boolean>
905 1048
906Change the meaning of triple-click selection with the left mouse 1049Change the meaning of triple-click selection with the left mouse
907button. Instead of selecting a full line it will extend the selection to 1050button. Instead of selecting a full line it will extend the selection to
908the end of the logical line only. option B<-tcw>. 1051the end of the logical line only; option B<-tcw>.
909 1052
910=item B<insecure:> I<boolean> 1053=item B<insecure:> I<boolean>
911 1054
912Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1055Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
913echo arbitrary strings like the icon name or the locale. This could be 1056echo arbitrary strings like the icon name or the locale. This could be
917default. (Note that many other terminals, including xterm, have these 1060default. (Note that many other terminals, including xterm, have these
918sequences enabled by default, which doesn't make it safer, though). 1061sequences enabled by default, which doesn't make it safer, though).
919 1062
920You can enable them by setting this boolean resource or specifying 1063You can enable them by setting this boolean resource or specifying
921B<-insecure> as an option. At the moment, this enables display-answer, 1064B<-insecure> as an option. At the moment, this enables display-answer,
922locale, findfont, icon label and window title requests as well as dynamic 1065locale, findfont, icon label and window title requests.
923menubar dispatch.
924 1066
925=item B<modifier:> I<modifier> 1067=item B<modifier:> I<modifier>
926 1068
927Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 1069Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
928B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 1070B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
932 1074
933Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1075Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
934character is passed through. It may contain escape values as described 1076character is passed through. It may contain escape values as described
935in the entry on B<keysym> following. 1077in the entry on B<keysym> following.
936 1078
937=item B<secondaryScreen:> I<bool> 1079=item B<secondaryScreen:> I<boolean>
938 1080
939Turn on/off secondary screen (default enabled). 1081Turn on/off secondary screen (default enabled).
940 1082
941=item B<secondaryScroll:> I<bool> 1083=item B<secondaryScroll:> I<boolean>
942 1084
943Turn on/off secondary screen scroll (default enabled). If the this 1085Turn on/off secondary screen scroll (default enabled). If this
944option is enabled, scrolls on the secondary screen will change the 1086option is enabled, scrolls on the secondary screen will change the
945scrollback buffer and switching to/from the secondary screen will 1087scrollback buffer and switching to/from the secondary screen will
946instead scroll the screen up. 1088instead scroll the screen up.
947 1089
948=item B<hold>: I<bool> 1090=item B<hold>: I<boolean>
949 1091
950Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1092Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
951will not immediately destroy its window when the program executed within 1093will not immediately destroy its window when the program executed within
952it exits. Instead, it will wait till it is being killed or closed by the 1094it exits. Instead, it will wait till it is being killed or closed by the
953user. 1095user.
972searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1114searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
973omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1115omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
974keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1116keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
975performed in an exact manner; however, the closest match is assured. 1117performed in an exact manner; however, the closest match is assured.
976 1118
977I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1119I<string> may contain escape values (C<\n>: newline, C<\000>: octal
978C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1120number), see RESOURCES in C<man 7 X> for futher details.
979C<\000>: octal number) or verbatim control characters (C<^?>: delete,
980C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
981can start or end with whitespace.
982
983Please note that you need to double the C<\> when using
984C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
985use C<\033> instead of C<\e> (and so on), which will work with both Xt and
986@@RXVT_NAME@@'s own processing).
987 1121
988You can define a range of keysyms in one shot by providing a I<string> 1122You can define a range of keysyms in one shot by providing a I<string>
989with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1123with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
990should be a character not used by the strings. 1124should be a character not used by the strings.
991 1125
992Its usage can be demonstrated by an example: 1126Its usage can be demonstrated by an example:
993 1127
994 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1128 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1003is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1137is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1004example the following means "change the current locale to C<zh_CN.GBK> 1138example the following means "change the current locale to C<zh_CN.GBK>
1005when Control-Meta-c is being pressed": 1139when Control-Meta-c is being pressed":
1006 1140
1007 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1141 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1142
1143If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1144is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1145manpage. For example, the F<selection> extension (activated via
1146C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1147
1148 URxvt.keysym.M-C-c: perl:selection:rot13
1008 1149
1009Due the the large number of modifier combinations, a defined key mapping 1150Due the the large number of modifier combinations, a defined key mapping
1010will match if at I<at least> the specified identifiers are being set, and 1151will match if at I<at least> the specified identifiers are being set, and
1011no other key mappings with those and more bits are being defined. That 1152no other key mappings with those and more bits are being defined. That
1012means that defining a key map for C<a> will automatically provide 1153means that defining a key map for C<a> will automatically provide
1036info): 1177info):
1037 1178
1038 URxvt.keysym.M-C-3: command:\033[8;25;80t 1179 URxvt.keysym.M-C-3: command:\033[8;25;80t
1039 URxvt.keysym.M-C-4: command:\033[8;48;110t 1180 URxvt.keysym.M-C-4: command:\033[8;48;110t
1040 1181
1182=item B<perl-ext-common>: I<string>
1183
1184=item B<perl-ext>: I<string>
1185
1186Comma-separated list(s) of perl extension scripts (default: C<default>) to
1187use in this terminal instance; option B<-pe>.
1188
1189Extension names can be prefixed with a C<-> sign to prohibit using
1190them. This can be useful to selectively disable some extensions loaded
1191by default, or specified via the C<perl-ext-common> resource. For
1192example, C<default,-selection> will use all the default extension except
1193C<selection>.
1194
1195Extension names can also be followed by an argument in angle brackets
1196(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1197searchable scrollback to Alt/Meta-s). Mentioning the same extension
1198multiple times with different arguments will pass multiple arguments to
1199the extension.
1200
1201Each extension is looked up in the library directories, loaded if
1202necessary, and bound to the current terminal instance.
1203
1204If both of these resources are the empty string, then the perl
1205interpreter will not be initialized. The idea behind two options is that
1206B<perl-ext-common> will be used for extensions that should be available to
1207all instances, while B<perl-ext> is used for specific instances.
1208
1209=item B<perl-eval>: I<string>
1210
1211Perl code to be evaluated when all extensions have been registered. See
1212the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1213will be ignored when running setuid/setgid.
1214
1215=item B<perl-lib>: I<path>
1216
1217Colon-separated list of additional directories that hold extension
1218scripts. When looking for extensions specified by the C<perl> resource,
1219@@RXVT_NAME@@ will first look in these directories and then in
1220F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1221will be ignored when running setuid/setgid.
1222
1223See the @@RXVT_NAME@@perl(3) manpage.
1224
1225=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1226
1227Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1228details.
1229
1230=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1231
1232Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1233for details.
1234
1235=item B<searchable-scrollback:> I<keysym>
1236
1237Sets the hotkey that starts the incremental scrollback buffer search
1238(default: C<M-s>).
1239
1240=item B<urlLauncher>: I<string>
1241
1242Specifies the program to be started with a URL argument. Used by the
1243C<selection-popup> and C<matcher> perl extensions.
1244
1245=item B<transient-for>: I<windowid>
1246
1247Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1248
1249=item B<override-redirect>: I<boolean>
1250
1251Compile I<frills>: Sets override-redirect for the terminal window, making
1252it almost invisible to window managers; option B<-override-redirect>.
1253
1254=item B<iso14755_52:> I<boolean>
1255
1256Turn on/off ISO 14755 5.2 mode (default enabled).
1257
1041=back 1258=back
1042 1259
1043=head1 THE SCROLLBAR 1260=head1 THE SCROLLBAR
1044 1261
1045Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window 1262Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
1063application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1280application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1064(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1281(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1065up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1282up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1066respectively. 1283respectively.
1067 1284
1068=head1 TEXT SELECTION AND INSERTION 1285=head1 THE SELECTION: SELECTING AND PASTING TEXT
1069 1286
1070The behaviour of text selection and insertion mechanism is similar to 1287The behaviour of text selection and insertion/pasting mechanism is similar
1071I<xterm>(1). 1288to I<xterm>(1).
1072 1289
1073=over 4 1290=over 4
1074 1291
1075=item B<Selection>: 1292=item B<Selecting>:
1076 1293
1077Left click at the beginning of the region, drag to the end of the region 1294Left click at the beginning of the region, drag to the end of the region
1078and release; Right click to extend the marked region; Left double-click 1295and release; Right click to extend the marked region; Left double-click
1079to select a word; Left triple-click to select the entire logical line 1296to select a word; Left triple-click to select the entire logical line
1080(which can span multiple screen lines), unless modified by resource 1297(which can span multiple screen lines), unless modified by resource
1084(Compile: I<frills>) will create a rectangular selection instead of a 1301(Compile: I<frills>) will create a rectangular selection instead of a
1085normal one. In this mode, every selected row becomes its own line in the 1302normal one. In this mode, every selected row becomes its own line in the
1086selection, and trailing whitespace is visually underlined and removed from 1303selection, and trailing whitespace is visually underlined and removed from
1087the selection. 1304the selection.
1088 1305
1089=item B<Insertion>: 1306=item B<Pasting>:
1090 1307
1091Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1308Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1092an B<@@RXVT_NAME@@> window causes the current text selection to be 1309window causes the value of the PRIMARY selection (or CLIPBOARD with the
1093inserted as if it had been typed on the keyboard. 1310B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1311
1312Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1313inserted too.
1094 1314
1095=back 1315=back
1096 1316
1097=head1 CHANGING FONTS 1317=head1 CHANGING FONTS
1098 1318
1099Changing fonts (or font sizes, respectively) via the keypad is not yet 1319Changing fonts (or font sizes, respectively) via the keypad is not yet
1100supported in rxvt-unicode. Bug me if you need this. 1320supported in rxvt-unicode. Bug me if you need this.
1101 1321
1102You can, however, switch fonts at runtime using escape sequences (and 1322You can, however, switch fonts at runtime using escape sequences, e.g.:
1103therefore using the menubar), e.g.:
1104 1323
1105 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1324 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1325
1326You can use keyboard shortcuts, too:
1327
1328 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1329 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1106 1330
1107rxvt-unicode will automatically re-apply these fonts to the output so far. 1331rxvt-unicode will automatically re-apply these fonts to the output so far.
1108 1332
1109=head1 ISO 14755 SUPPORT 1333=head1 ISO 14755 SUPPORT
1110 1334
1111ISO 14755 is a standard for entering and viewing unicode characters 1335ISO 14755 is a standard for entering and viewing unicode characters
1112and character codes using the keyboard. It consists of 4 parts. The 1336and character codes using the keyboard. It consists of 4 parts. The
1113first part is available rxvt-unicode has been compiled with 1337first part is available if rxvt-unicode has been compiled with
1114C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1338C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1115with C<--enable-iso14755>. 1339with C<--enable-iso14755>.
1116 1340
1117=over 4 1341=over 4
1118 1342
1138This mode lets you input characters representing the keycap symbols of 1362This mode lets you input characters representing the keycap symbols of
1139your keyboard, if representable in the current locale encoding. 1363your keyboard, if representable in the current locale encoding.
1140 1364
1141Start by pressing C<Control> and C<Shift> together, then releasing 1365Start by pressing C<Control> and C<Shift> together, then releasing
1142them. The next special key (cursor keys, home etc.) you enter will not 1366them. The next special key (cursor keys, home etc.) you enter will not
1143invoke it's usual function but instead will insert the corresponding 1367invoke its usual function but instead will insert the corresponding
1144keycap symbol. The symbol will only be entered when the key has been 1368keycap symbol. The symbol will only be entered when the key has been
1145released, otherwise pressing e.g. C<Shift> would enter the symbol for 1369released, otherwise pressing e.g. C<Shift> would enter the symbol for
1146C<ISO Level 2 Switch>, although your intention might have been to enter a 1370C<ISO Level 2 Switch>, although your intention might have been to enter a
1147reverse tab (Shift-Tab). 1371reverse tab (Shift-Tab).
1148 1372
1181=head1 COLORS AND GRAPHICS 1405=head1 COLORS AND GRAPHICS
1182 1406
1183In addition to the default foreground and background colours, 1407In addition to the default foreground and background colours,
1184B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1408B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1185high-intensity bold/blink versions of the same). Here is a list of the 1409high-intensity bold/blink versions of the same). Here is a list of the
1186colours with their B<rgb.txt> names. 1410colours with their names.
1187 1411
1188=begin table 1412=begin table
1189 1413
1190 B<color0> (black) = Black 1414 B<color0> (black) = Black
1191 B<color1> (red) = Red3 1415 B<color1> (red) = Red3
1211It is also possible to specify the colour values of B<foreground>, 1435It is also possible to specify the colour values of B<foreground>,
1212B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1436B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1213a number 0-15, as a convenient shorthand to reference the colour name of 1437a number 0-15, as a convenient shorthand to reference the colour name of
1214color0-color15. 1438color0-color15.
1215 1439
1440In addition to the colours defined above, @@RXVT_NAME@@ offers an
1441additional 72 colours. The first 64 of those (with indices 16 to 79)
1442consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
144316>), followed by 8 additional shades of gray (with indices 80 to 87).
1444
1445Together, all those colours implement the 88 colour xterm colours. Only
1446the first 16 can be changed using resources currently, the rest can only
1447be changed via command sequences ("escape codes").
1448
1216Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1449Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1217always swapping the foreground/background colours. This is in contrast to 1450always swapping the foreground/background colours. This is in contrast to
1218I<xterm>(1) where the colours are only swapped if they have not otherwise 1451I<xterm>(1) where the colours are only swapped if they have not otherwise
1219been specified. For example, 1452been specified. For example,
1220 1453
1225would yield White on Black, while on I<xterm>(1) it would yield Black 1458would yield White on Black, while on I<xterm>(1) it would yield Black
1226on White. 1459on White.
1227 1460
1228=back 1461=back
1229 1462
1463=head2 ALPHA CHANNEL SUPPORT
1464
1465If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1466their act together, rxvt-unicode will do it's own alpha channel management:
1467
1468You can prefix any color with an opaquenes percentage enclosed in
1469brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1470(0-100) that specifies the opacity of the color, where C<0> is completely
1471transparent and C<100> is completely opaque. For example, C<[50]red> is a
1472half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1473is the recommended format to specify transparency values, and works with
1474all ways to specify a colour.
1475
1476For complete control, rxvt-unicode also supports
1477C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1478specifications, where the additional C<aaaa> component specifies opacity
1479(alpha) values. The minimum value of C<0000> is completely transparent,
1480while C<ffff> is completely opaque). The two example colours from
1481earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1482C<rgba:0000/ff00/0000/f332>.
1483
1484You probably need to specify B<"-depth 32">, too, to force a visual with
1485alpha channels, and have the luck that your X-server uses ARGB pixel
1486layout, as X is far from just supporting ARGB visuals out of the box, and
1487rxvt-unicode just fudges around.
1488
1489For example, the following selects an almost completely transparent black
1490background, and an almost opaque pink foreground:
1491
1492 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1493
1494When not using a background image, then the interpretation of the
1495alpha channel is up to your compositing manager (most interpret it as
1496transparency of course).
1497
1498When using a background pixmap or pseudo-transparency, then the background
1499colour will always behave as if it were completely transparent (so the
1500background image shows instead), regardless of how it was specified, while
1501other colours will either be transparent as specified (the background
1502image will show through) on servers supporting the RENDER extension, or
1503fully opaque on servers not supporting the RENDER EXTENSION.
1504
1505Please note that due to bugs in Xft, specifying alpha values might result
1506in garbage being displayed when the X-server does not support the RENDER
1507extension.
1508
1230=head1 ENVIRONMENT 1509=head1 ENVIRONMENT
1231 1510
1232B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1511B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1233 1512
1234=over 4 1513=over 4
1235 1514
1236=item B<TERM> 1515=item B<TERM>
1237 1516
1238Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1517Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1239resources or on the commandline. 1518resources or on the command line.
1240 1519
1241=item B<COLORTERM> 1520=item B<COLORTERM>
1242 1521
1243Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1522Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1244compiled with XPM support, and optionally with the added extension 1523compiled with background image support, and optionally with the added
1245C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1524extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1525screen.
1246 1526
1247=item B<COLORFGBG> 1527=item B<COLORFGBG>
1248 1528
1249Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1529Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1250the colour code used as default foreground/text colour (or the string 1530the colour code used as default foreground/text colour (or the string
1251C<default> to indicate that the default-colour escape sequence is to be 1531C<default> to indicate that the default-colour escape sequence is to be
1252used), C<bg> is the colour code used as default background colour (or the 1532used), C<bg> is the colour code used as default background colour (or the
1253string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1533string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1254was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1534was compiled with background image support. Libraries like C<ncurses>
1255(and do) use this information to optimize screen output. 1535and C<slang> can (and do) use this information to optimize screen output.
1256 1536
1257=item B<WINDOWID> 1537=item B<WINDOWID>
1258 1538
1259Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1539Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1260window, which usually has subwindows for the scrollbar, the terminal 1540window, which usually has subwindows for the scrollbar, the terminal
1266C<--with-terminfo=PATH>. 1546C<--with-terminfo=PATH>.
1267 1547
1268=item B<DISPLAY> 1548=item B<DISPLAY>
1269 1549
1270Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1550Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1271display in it's child processes. 1551display in its child processes.
1272 1552
1273=item B<SHELL> 1553=item B<SHELL>
1274 1554
1275The shell to be used for command execution, defaults to C</bin/sh>. 1555The shell to be used for command execution, defaults to C</bin/sh>.
1276
1277=item B<RXVTPATH>
1278
1279The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1280files.
1281
1282=item B<PATH>
1283
1284Used in the same way as C<RXVTPATH>.
1285 1556
1286=item B<RXVT_SOCKET> 1557=item B<RXVT_SOCKET>
1287 1558
1288The unix domain socket path used by @@RXVT_NAME@@c(1) and 1559The unix domain socket path used by @@RXVT_NAME@@c(1) and
1289@@RXVT_NAME@@d(1). 1560@@RXVT_NAME@@d(1).
1327 1598
1328=item Project Coordinator 1599=item Project Coordinator
1329 1600
1330Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1601Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1331 1602
1332L<http://software.schmorp.de/#rxvt-unicode> 1603L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1333 1604
1334=back 1605=back
1335 1606
1336=head1 AUTHORS 1607=head1 AUTHORS
1337 1608
1359 1630
1360Project Coordinator (changes.txt 2.21a to 2.4.5) 1631Project Coordinator (changes.txt 2.21a to 2.4.5)
1361 1632
1362=item Geoff Wing L<< <gcw@pobox.com> >> 1633=item Geoff Wing L<< <gcw@pobox.com> >>
1363 1634
1364Rewrote screen display and text selection routines. Project Coordinator 1635Rewrote screen display and text selection routines.
1636
1365(changes.txt 2.4.6 - rxvt-unicode) 1637Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1366 1638
1367=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1639=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1368 1640
1369Forked rxvt-unicode, rewrote most of the display code and internal 1641Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1370character handling to store text in unicode, improve xterm 1642extension, random hacks, numerous bugfixes and extensions.
1371compatibility and apply numerous other bugfixes and extensions.
1372 1643
1373Project Coordinator (Changes 1.0 -) 1644Project Coordinator (Changes 1.0 -)
1374 1645
1646=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1647
1648Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1649
1375=back 1650=back
1376 1651

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines