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.76 by root, Sat Dec 31 16:06:48 2005 UTC vs.
Revision 1.163 by root, Mon May 19 14:00:02 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
89 92
90Print out a message describing available options. 93Print out a message describing available options.
91 94
92=item B<-display> I<displayname> 95=item B<-display> I<displayname>
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 (the older form B<-d>
95respected). In the absence of this option, the display specified by the 98is still respected. but deprecated). In the absence of this option, the
96B<DISPLAY> environment variable is used. 99display specified by the B<DISPLAY> environment variable is used.
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]
97 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
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.
206 252
207=item B<-is>|B<+is> 253=item B<-is>|B<+is>
208 254
209Compile font-styles: Bold/Italic font styles imply high intensity 255Compile I<font-styles>: Bold/Blink font styles imply high intensity
210foreground/background (default). See resource B<intensityStyles> for 256foreground/background (default). See resource B<intensityStyles> for
211details. 257details.
212 258
213=item B<-name> I<name> 259=item B<-name> I<name>
214 260
232 278
233=item B<-sb>|B<+sb> 279=item B<-sb>|B<+sb>
234 280
235Turn on/off scrollbar; resource B<scrollBar>. 281Turn on/off scrollbar; resource B<scrollBar>.
236 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
237=item B<-si>|B<+si> 292=item B<-si>|B<+si>
238 293
239Turn on/off scroll-to-bottom on TTY output inhibit; resource 294Turn on/off scroll-to-bottom on TTY output inhibit; resource
240B<scrollTtyOutput> has opposite effect. 295B<scrollTtyOutput> has opposite effect.
241 296
247=item B<-sw>|B<+sw> 302=item B<-sw>|B<+sw>
248 303
249Turn on/off scrolling with the scrollback buffer as new lines appear. 304Turn on/off scrolling with the scrollback buffer as new lines appear.
250This only takes effect if B<-si> is also given; resource 305This only takes effect if B<-si> is also given; resource
251B<scrollWithBuffer>. 306B<scrollWithBuffer>.
252
253=item B<-sr>|B<+sr>
254
255Put scrollbar on right/left; resource B<scrollBar_right>.
256
257=item B<-st>|B<+st>
258
259Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
260resource B<scrollBar_floating>.
261 307
262=item B<-ptab>|B<+ptab> 308=item B<-ptab>|B<+ptab>
263 309
264If enabled (default), "Horizontal Tab" characters are being stored as 310If enabled (default), "Horizontal Tab" characters are being stored as
265actual wide characters in the screen buffer, which makes it possible to 311actual wide characters in the screen buffer, which makes it possible to
296 342
297Compile 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.
298if 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
299decorations; resource B<borderLess>. 345decorations; resource B<borderLess>.
300 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
301=item B<-lsp> I<number> 359=item B<-lsp> I<number>
302 360
303Compile I<frills>: Lines (pixel height) to insert between each row of 361Compile I<frills>: Lines (pixel height) to insert between each row of
304the display. Useful to work around font rendering problems; resource 362the display. Useful to work around font rendering problems; resource
305B<linespace>. 363B<lineSpace>.
306 364
307=item B<-tn> I<termname> 365=item B<-tn> I<termname>
308 366
309This 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
310B<TERM> environment variable. This terminal type must exist in the 368B<TERM> environment variable. This terminal type must exist in the
364for more info. 422for more info.
365 423
366=item B<-tcw> 424=item B<-tcw>
367 425
368Change 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
369button. 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
370end of the logical line only. resource B<tripleclickwords>. 429the end of the logical line only. resource B<tripleclickwords>.
371 430
372=item B<-insecure> 431=item B<-insecure>
373 432
374Enable "insecure" mode, which currently enables most of the escape 433Enable "insecure" mode, which currently enables most of the escape
375sequences that echo strings. See the resource B<insecure> for more 434sequences that echo strings. See the resource B<insecure> for more
396Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 455Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
397will not immediately destroy its window when the program executed within 456will not immediately destroy its window when the program executed within
398it 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
399user; resource B<hold>. 458user; resource B<hold>.
400 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
401=item B<-keysym.>I<sym> I<string> 473=item B<-keysym.>I<sym> I<string>
402 474
403Remap a key symbol. See resource B<keysym>. 475Remap a key symbol. See resource B<keysym>.
404 476
405=item B<-embed> I<windowid> 477=item B<-embed> I<windowid>
406 478
407Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 479Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
408which enables applications to easily embed a terminal. 480which enables applications to easily embed a terminal.
409 481
410Right 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
411shouldn'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
412quite 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
415The window will not be destroyed when @@RXVT_NAME@@ exits. 487The window will not be destroyed when @@RXVT_NAME@@ exits.
416 488
417It 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
418descriptors 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
419can use file descriptors to communicate with the programs within the 491can use file descriptors to communicate with the programs within the
420terminal. 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
421not. 493not.
422 494
423Here 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
424used (a longer example is in F<doc/embed>): 496used (a longer example is in F<doc/embed>):
425 497
427 $rxvt->signal_connect_after (realize => sub { 499 $rxvt->signal_connect_after (realize => sub {
428 my $xid = $_[0]->window->get_xid; 500 my $xid = $_[0]->window->get_xid;
429 system "@@RXVT_NAME@@ -embed $xid &"; 501 system "@@RXVT_NAME@@ -embed $xid &";
430 }); 502 });
431 503
432=item B<-pty-fd> I<fileno> 504=item B<-pty-fd> I<file descriptor>
433 505
434Tells @@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
435pair 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
436useful 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
437without having to run a program within it. 509without having to run a program within it.
438 510
439If 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
440entries 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
441yourself 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.
442 518
443Here 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
444longer example is in F<doc/pty-fd>): 520longer example is in F<doc/pty-fd>):
445 521
446 use IO::Pty; 522 use IO::Pty;
453 529
454 # now communicate with rxvt 530 # now communicate with rxvt
455 my $slave = $pty->slave; 531 my $slave = $pty->slave;
456 while (<$slave>) { print $slave "got <$_>\n" } 532 while (<$slave>) { print $slave "got <$_>\n" }
457 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
458=back 539=back
459 540
460=head1 RESOURCES (available also as long-options) 541=head1 RESOURCES
461 542
462Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 543Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
463options) compiled into your version. 544options) compiled into your version. All resources are also available as
545long-options.
464 546
465There 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
466Xresource data: using the X libraries (Xrm*-functions) or internal 548distribution do also load settings from the B<~/.Xresources> file when X
467Xresources reader (B<~/.Xdefaults>). For the first method (ie. 549starts. @@RXVT_NAME@@ will consult the following files/resources in order,
468B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 550with later settings overwriting earlier ones:
469resources using X11 tools like B<xrdb>. Many distribution do also load
470settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
471will consult the following files/resources in order, with later settings
472overwriting earlier ones:
473 551
474 1. system-wide app-defaults file, either locale-dependent OR global 552 1. system-wide app-defaults file, either locale-dependent OR global
475 2. app-defaults file in $XAPPLRESDIR 553 2. app-defaults file in $XAPPLRESDIR
476 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 554 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
477 4. SCREEN_RESOURCES for the current screen 555 4. SCREEN_RESOURCES for the current screen
478 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 556 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
557 6. resources specified via -xrm on the commandline
479 558
480If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
481lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
482set in XAPPLOADDIR/URxvt (compile-time defined: usually
483B</usr/lib/X11/app-defaults/URxvt>) and resources set in
484B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
485Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 559Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
486class 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
487resources 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
488easily configured, while the class name B<URxvt> allows resources 562configured, while the class name B<URxvt> allows resources unique to
489unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 563B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
490shared between different B<@@RXVT_NAME@@> configurations. If no 564configurations. If no resources are specified, suitable defaults will
491resources are specified, suitable defaults will be used. Command-line 565be used. Command-line arguments can be used to override resource
492arguments can be used to override resource settings. The following 566settings. The following resources are supported (you might want to
493resources are allowed: 567check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
568extensions not documented here):
494 569
495=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>.
576
577=item B<buffered:> I<boolean>
578
579Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
580On some card/driver combination enabling it slightly decreases
581performance, on most it greatly helps it. The slowdown is small, so it
582should normally be enabled.
496 583
497=item B<geometry:> I<geom> 584=item B<geometry:> I<geom>
498 585
499Create the window with the specified X window geometry [default 80x24]; 586Create the window with the specified X window geometry [default 80x24];
500option B<-geometry>. 587option B<-geometry>.
537Use the specified colour to display underlined characters when the 624Use the specified colour to display underlined characters when the
538foreground colour is the default. 625foreground colour is the default.
539 626
540=item B<colorRV:> I<colour> 627=item B<colorRV:> I<colour>
541 628
542Use the specified colour as the background for reverse video 629Use the specified colour as the background for reverse video characters
543characters. 630when OPTION_HC is disabled (--disable-frills).
544 631
545=item B<underlineColor:> I<colour> 632=item B<underlineColor:> I<colour>
546 633
547If set, use the specified colour as the colour for the underline 634If set, use the specified colour as the colour for the underline
548itself. If unset, use the foreground colour. 635itself. If unset, use the foreground colour.
564option B<-rv>. B<False>: regular screen colours [default]; option 651option B<-rv>. B<False>: regular screen colours [default]; option
565B<+rv>. See note in B<COLORS AND GRAPHICS> section. 652B<+rv>. See note in B<COLORS AND GRAPHICS> section.
566 653
567=item B<jumpScroll:> I<boolean> 654=item B<jumpScroll:> I<boolean>
568 655
569B<True>: specify that jump scrolling should be used. When scrolling 656B<True>: specify that jump scrolling should be used. When receiving lots
570quickly, fewer screen updates are performed [default]; option B<-j>. 657of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
658has been read, resulting in fewer updates while still displaying every
659received line; option B<-j>.
660
571B<False>: specify that smooth scrolling should be used; option B<+j>. 661B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
662force a screen refresh on each new line it received; option B<+j>.
572 663
573=item B<inheritPixmap:> I<boolean> 664=item B<skipScroll:> I<boolean>
574 665
575B<True>: make the background inherit the parent windows' pixmap, giving 666B<True>: (the default) specify that skip scrolling should be used. When
576artificial transparency. B<False>: do not inherit the parent windows' 667receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
577pixmap. 668(around 60 times per second), resulting in far fewer updates. This can
669result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
670option B<-ss>.
671
672B<False>: specify that everything is to be displayed, even
673if the refresh is too fast for the human eye to read anything (or the
674monitor to display anything); option B<+ss>.
675
676=item B<transparent:> I<boolean>
677
678Turn on/off illusion of a transparent window background.
679
680B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
681future versions.
682
683I<Please address all transparency related issues to Sasha Vasko at
684sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
578 685
579=item B<fading:> I<number> 686=item B<fading:> I<number>
580 687
581Fade the text by the given percentage when focus is lost; option B<-fade>. 688Fade the text by the given percentage when focus is lost; option B<-fade>.
582 689
590Tint the transparent background pixmap with the given colour; option 697Tint the transparent background pixmap with the given colour; option
591B<-tint>. 698B<-tint>.
592 699
593=item B<shading:> I<number> 700=item B<shading:> I<number>
594 701
595Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 702Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
596image in addition to tinting it. 703in addition to tinting it; option B<-sh>.
704
705=item B<blendType:> I<string>
706
707Specify background blending type; option B<-blt>.
708
709=item B<blurRadius:> I<number>
710
711Apply Gaussian Blurr with the specified radius to the transparent
712background image; option B<-blr>.
597 713
598=item B<scrollColor:> I<colour> 714=item B<scrollColor:> I<colour>
599 715
600Use the specified colour for the scrollbar [default #B2B2B2]. 716Use the specified colour for the scrollbar [default #B2B2B2].
601 717
607=item B<borderColor:> I<colour> 723=item B<borderColor:> I<colour>
608 724
609The colour of the border around the text area and between the scrollbar 725The colour of the border around the text area and between the scrollbar
610and the text. 726and the text.
611 727
612=item B<backgroundPixmap:> I<file[;geom]> 728=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
613 729
614Use the specified XPM file (note the `.xpm' extension is optional) for 730Use the specified image file for the background and also
615the background and also optionally specify its scaling with a geometry 731optionally specify its scaling with a geometry string B<WxH+X+Y>,
616string B<WxH+X+Y>, in which B<"W" / "H"> specify the 732(default C<0x0+50+50>) in which B<"W" / "H"> specify the
617horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 733horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
618centre (percent). A scale of 0 displays the image with tiling. A scale 734centre (percent). A scale of 0 displays the image with tiling. A scale
619of 1 displays the image without any scaling. A scale of 2 to 9 735of 1 displays the image without any scaling. A scale of 2 to 9 specifies
620specifies an integer number of images in that direction. No image will 736an integer number of images in that direction. No image will be magnified
621be magnified beyond 10 times its original size. The maximum permitted 737beyond 10 times its original size. The maximum permitted scale is 1000.
622scale is 1000. [default 0x0+50+50] 738Additional operations can be specified after colon B<:op1:op2...>.
739Supported operations are:
623 740
624=item B<menu:> I<file[;tag]> 741 tile force background image to be tiled and not scaled. Equivalent to 0x0
742 propscale will scale image keeping proportions
743 auto will scale image to match window size. Equivalent to 100x100
744 hscale will scale image horizontally to the window size
745 vscale will scale image vertically to the window size
746 scale will scale image to match window size
747 root will tile image as if it was a root window background, auto-adjusting
748 whenever terminal window moves
625 749
626Read in the specified menu file (note the `.menu' extension is 750If used in conjunction with B<-tr> option, the specified pixmap will be
627optional) and also optionally specify a starting tag to find. See the 751blended over transparency image using either alpha-blending, or any
628reference documentation for details on the syntax for the menuBar. 752other blending type, specified with B<-blt "type"> option.
629 753
630=item B<path:> I<path> 754=item B<path:> I<path>
631 755
632Specify the colon-delimited search path for finding files (XPM and 756Specify the colon-delimited search path for finding background image files.
633menus), in addition to the paths specified by the B<RXVTPATH> and
634B<PATH> environment variables.
635 757
636=item B<font:> I<fontlist> 758=item B<font:> I<fontlist>
637 759
638Select the fonts to be used. This is a comma separated list of font 760Select the fonts to be used. This is a comma separated list of font names
639names that are used in turn when trying to display Unicode characters. 761that are checked in order when trying to find glyphs for characters. The
640The first font defines the cell size for characters; other fonts might 762first font defines the cell size for characters; other fonts might be
641be smaller, but not larger. A reasonable default font list is always 763smaller, but not (in general) larger. A (hopefully) reasonable default
642appended to it. option B<-fn>. 764font list is always appended to it; option B<-fn>.
643 765
644Each font can either be a standard X11 core font (XLFD) name, with 766Each font can either be a standard X11 core font (XLFD) name, with
645optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 767optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
646 768
647In addition, each font can be prefixed with additional hints and 769In addition, each font can be prefixed with additional hints and
649hint currently is C<codeset=codeset-name>, and this is only used for Xft 771hint currently is C<codeset=codeset-name>, and this is only used for Xft
650fonts. 772fonts.
651 773
652For example, this font resource 774For example, this font resource
653 775
654 URxvt*font: 9x15bold,\ 776 URxvt.font: 9x15bold,\
655 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 777 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
656 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 778 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
657 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 779 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
658 xft:Code2000:antialias=false 780 xft:Code2000:antialias=false
659 781
696text font will being used for the given style. 818text font will being used for the given style.
697 819
698=item B<intensityStyles:> I<boolean> 820=item B<intensityStyles:> I<boolean>
699 821
700When font styles are not enabled, or this option is enabled (B<True>, 822When font styles are not enabled, or this option is enabled (B<True>,
701option B<-is>, the default), bold and italic font styles imply high 823option B<-is>, the default), bold/blink font styles imply high
702intensity foreground/backround colours. Disabling this option (B<False>, 824intensity foreground/background colours. Disabling this option (B<False>,
703option B<+is>) disables this behaviour, the high intensity colours are not 825option B<+is>) disables this behaviour, the high intensity colours are not
704reachable. 826reachable.
705
706=item B<selectstyle:> I<mode>
707
708Set mouse selection style to B<old> which is 2.20, B<oldword> which is
709xterm style with 2.20 old word selection, or anything else which gives
710xterm style selection.
711
712=item B<scrollstyle:> I<mode>
713
714Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
715the author's favourite.
716 827
717=item B<title:> I<string> 828=item B<title:> I<string>
718 829
719Set window title string, the default title is the command-line 830Set window title string, the default title is the command-line
720specified after the B<-e> option, if any, otherwise the application 831specified after the B<-e> option, if any, otherwise the application
729=item B<mapAlert:> I<boolean> 840=item B<mapAlert:> I<boolean>
730 841
731B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 842B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
732de-iconify (map) on receipt of a bell character [default]. 843de-iconify (map) on receipt of a bell character [default].
733 844
845=item B<urgentOnBell:> I<boolean>
846
847B<True>: set the urgency hint for the wm on receipt of a bell character.
848B<False>: do not set the urgency hint [default].
849
734=item B<visualBell:> I<boolean> 850=item B<visualBell:> I<boolean>
735 851
736B<True>: use visual bell on receipt of a bell character; option B<-vb>. 852B<True>: use visual bell on receipt of a bell character; option B<-vb>.
737B<False>: no visual bell [default]; option B<+vb>. 853B<False>: no visual bell [default]; option B<+vb>.
738 854
756 872
757The string will be interpreted as if typed into the shell as-is. 873The string will be interpreted as if typed into the shell as-is.
758 874
759Example: 875Example:
760 876
761 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 877 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
762 878
763This creates a new file in your home directory with the screen contents 879This creates a new file in your home directory with the screen contents
764everytime you hit C<Print>. 880every time you hit C<Print>.
881
882=item B<scrollstyle:> I<mode>
883
884Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
885the author's favourite.
765 886
766=item B<scrollBar:> I<boolean> 887=item B<scrollBar:> I<boolean>
767 888
768B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 889B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
769disable the scrollbar; option B<+sb>. 890disable the scrollbar; option B<+sb>.
791 912
792=item B<scrollWithBuffer:> I<boolean> 913=item B<scrollWithBuffer:> I<boolean>
793 914
794B<True>: scroll with scrollback buffer when tty receives new lines (and 915B<True>: scroll with scrollback buffer when tty receives new lines (and
795B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 916B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
796with scrollback buffer when tty recieves new lines; option B<+sw>. 917with scrollback buffer when tty receives new lines; option B<+sw>.
797 918
798=item B<scrollTtyKeypress:> I<boolean> 919=item B<scrollTtyKeypress:> I<boolean>
799 920
800B<True>: scroll to bottom when a non-special key is pressed. Special keys 921B<True>: scroll to bottom when a non-special key is pressed. Special keys
801are those which are intercepted by rxvt-unicode for special handling and 922are those which are intercepted by rxvt-unicode for special handling and
820=item B<borderLess:> I<boolean> 941=item B<borderLess:> I<boolean>
821 942
822Set MWM hints to request a borderless window, i.e. if honoured by the 943Set MWM hints to request a borderless window, i.e. if honoured by the
823WM, the rxvt-unicode window will not have window decorations; option B<-bl>. 944WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
824 945
946=item B<skipBuiltinGlyphs:> I<boolean>
947
948Compile I<frills>: Disable the usage of the built-in block graphics/line
949drawing characters and just rely on what the specified fonts provide. Use
950this if you have a good font and want to use its block graphic glyphs;
951option B<-sbg>.
952
825=item B<termName:> I<termname> 953=item B<termName:> I<termname>
826 954
827Specifies the terminal type name to be set in the B<TERM> environment 955Specifies the terminal type name to be set in the B<TERM> environment
828variable; option B<-tn>. 956variable; option B<-tn>.
829 957
830=item B<linespace:> I<number> 958=item B<lineSpace:> I<number>
831 959
832Specifies number of lines (pixel height) to insert between each row of 960Specifies number of lines (pixel height) to insert between each row of
833the display [default 0]; option B<-lsp>. 961the display [default 0]; option B<-lsp>.
834 962
835=item B<meta8:> I<boolean> 963=item B<meta8:> I<boolean>
884pressed. If unset it will send the sequence traditionally associated 1012pressed. If unset it will send the sequence traditionally associated
885with the B<Execute> key. 1013with the B<Execute> key.
886 1014
887=item B<cutchars:> I<string> 1015=item B<cutchars:> I<string>
888 1016
889The characters used as delimiters for double-click word selection. The 1017The characters used as delimiters for double-click word selection
890built-in default: 1018(whitespace delimiting is added automatically if resource is given).
891 1019
1020When the perl selection extension is in use (the default if compiled
1021in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
1022characters will be created (if the resource exists, otherwise, no regex
1023will be created). In this mode, characters outside ISO-8859-1 can be used.
1024
1025When the selection extension is not used, only ISO-8859-1 characters can
1026be used. If not specified, the built-in default is used:
1027
892B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1028B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
893 1029
894=item B<preeditType:> I<style> 1030=item B<preeditType:> I<style>
895 1031
896B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1032B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
897 1033
902=item B<imLocale:> I<name> 1038=item B<imLocale:> I<name>
903 1039
904The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. 1040The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
905C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the 1041C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
906input extension to be able to input japanese characters while staying in 1042input extension to be able to input japanese characters while staying in
907another locale. option B<-imlocale>. 1043another locale; option B<-imlocale>.
908 1044
909=item B<imFont:> I<fontset> 1045=item B<imFont:> I<fontset>
910 1046
911Specify the font-set used for XIM styles C<OverTheSpot> or 1047Specify the font-set used for XIM styles C<OverTheSpot> or
912C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated 1048C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
917 1053
918=item B<tripleclickwords:> I<boolean> 1054=item B<tripleclickwords:> I<boolean>
919 1055
920Change the meaning of triple-click selection with the left mouse 1056Change the meaning of triple-click selection with the left mouse
921button. Instead of selecting a full line it will extend the selection to 1057button. Instead of selecting a full line it will extend the selection to
922the end of the logical line only. option B<-tcw>. 1058the end of the logical line only; option B<-tcw>.
923 1059
924=item B<insecure:> I<boolean> 1060=item B<insecure:> I<boolean>
925 1061
926Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1062Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
927echo arbitrary strings like the icon name or the locale. This could be 1063echo arbitrary strings like the icon name or the locale. This could be
931default. (Note that many other terminals, including xterm, have these 1067default. (Note that many other terminals, including xterm, have these
932sequences enabled by default, which doesn't make it safer, though). 1068sequences enabled by default, which doesn't make it safer, though).
933 1069
934You can enable them by setting this boolean resource or specifying 1070You can enable them by setting this boolean resource or specifying
935B<-insecure> as an option. At the moment, this enables display-answer, 1071B<-insecure> as an option. At the moment, this enables display-answer,
936locale, findfont, icon label and window title requests as well as dynamic 1072locale, findfont, icon label and window title requests.
937menubar dispatch.
938 1073
939=item B<modifier:> I<modifier> 1074=item B<modifier:> I<modifier>
940 1075
941Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 1076Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
942B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 1077B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
946 1081
947Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1082Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
948character is passed through. It may contain escape values as described 1083character is passed through. It may contain escape values as described
949in the entry on B<keysym> following. 1084in the entry on B<keysym> following.
950 1085
951=item B<secondaryScreen:> I<bool> 1086=item B<secondaryScreen:> I<boolean>
952 1087
953Turn on/off secondary screen (default enabled). 1088Turn on/off secondary screen (default enabled).
954 1089
955=item B<secondaryScroll:> I<bool> 1090=item B<secondaryScroll:> I<boolean>
956 1091
957Turn on/off secondary screen scroll (default enabled). If the this 1092Turn on/off secondary screen scroll (default enabled). If this
958option is enabled, scrolls on the secondary screen will change the 1093option is enabled, scrolls on the secondary screen will change the
959scrollback buffer and switching to/from the secondary screen will 1094scrollback buffer and, when secondaryScreen is off, switching
960instead scroll the screen up. 1095to/from the secondary screen will instead scroll the screen up.
961 1096
962=item B<hold>: I<bool> 1097=item B<hold>: I<boolean>
963 1098
964Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1099Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
965will not immediately destroy its window when the program executed within 1100will not immediately destroy its window when the program executed within
966it exits. Instead, it will wait till it is being killed or closed by the 1101it exits. Instead, it will wait till it is being killed or closed by the
967user. 1102user.
986searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1121searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
987omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1122omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
988keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1123keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
989performed in an exact manner; however, the closest match is assured. 1124performed in an exact manner; however, the closest match is assured.
990 1125
991I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1126I<string> may contain escape values (C<\n>: newline, C<\000>: octal
992C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1127number), see RESOURCES in C<man 7 X> for futher details.
993C<\000>: octal number) or verbatim control characters (C<^?>: delete,
994C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
995can start or end with whitespace.
996
997Please note that you need to double the C<\> when using
998C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
999use C<\033> instead of C<\e> (and so on), which will work with both Xt and
1000@@RXVT_NAME@@'s own processing).
1001 1128
1002You can define a range of keysyms in one shot by providing a I<string> 1129You can define a range of keysyms in one shot by providing a I<string>
1003with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1130with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1004should be a character not used by the strings. 1131should be a character not used by the strings.
1005 1132
1006Its usage can be demonstrated by an example: 1133Its usage can be demonstrated by an example:
1007 1134
1008 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1135 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1017is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1144is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1018example the following means "change the current locale to C<zh_CN.GBK> 1145example the following means "change the current locale to C<zh_CN.GBK>
1019when Control-Meta-c is being pressed": 1146when Control-Meta-c is being pressed":
1020 1147
1021 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1148 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1149
1150If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1151is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1152manpage. For example, the F<selection> extension (activated via
1153C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1154
1155 URxvt.keysym.M-C-c: perl:selection:rot13
1022 1156
1023Due the the large number of modifier combinations, a defined key mapping 1157Due the the large number of modifier combinations, a defined key mapping
1024will match if at I<at least> the specified identifiers are being set, and 1158will match if at I<at least> the specified identifiers are being set, and
1025no other key mappings with those and more bits are being defined. That 1159no other key mappings with those and more bits are being defined. That
1026means that defining a key map for C<a> will automatically provide 1160means that defining a key map for C<a> will automatically provide
1050info): 1184info):
1051 1185
1052 URxvt.keysym.M-C-3: command:\033[8;25;80t 1186 URxvt.keysym.M-C-3: command:\033[8;25;80t
1053 URxvt.keysym.M-C-4: command:\033[8;48;110t 1187 URxvt.keysym.M-C-4: command:\033[8;48;110t
1054 1188
1189=item B<perl-ext-common>: I<string>
1190
1191=item B<perl-ext>: I<string>
1192
1193Comma-separated list(s) of perl extension scripts (default: C<default>) to
1194use in this terminal instance; option B<-pe>.
1195
1196Extension names can be prefixed with a C<-> sign to prohibit using
1197them. This can be useful to selectively disable some extensions loaded
1198by default, or specified via the C<perl-ext-common> resource. For
1199example, C<default,-selection> will use all the default extension except
1200C<selection>.
1201
1202Extension names can also be followed by an argument in angle brackets
1203(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1204searchable scrollback to Alt/Meta-s). Mentioning the same extension
1205multiple times with different arguments will pass multiple arguments to
1206the extension.
1207
1208Each extension is looked up in the library directories, loaded if
1209necessary, and bound to the current terminal instance.
1210
1211If both of these resources are the empty string, then the perl
1212interpreter will not be initialized. The idea behind two options is that
1213B<perl-ext-common> will be used for extensions that should be available to
1214all instances, while B<perl-ext> is used for specific instances.
1215
1216=item B<perl-eval>: I<string>
1217
1218Perl code to be evaluated when all extensions have been registered. See
1219the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1220will be ignored when running setuid/setgid.
1221
1222=item B<perl-lib>: I<path>
1223
1224Colon-separated list of additional directories that hold extension
1225scripts. When looking for extensions specified by the C<perl> resource,
1226@@RXVT_NAME@@ will first look in these directories and then in
1227F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1228will be ignored when running setuid/setgid.
1229
1230See the @@RXVT_NAME@@perl(3) manpage.
1231
1232=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1233
1234Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1235details.
1236
1237=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1238
1239Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1240for details.
1241
1242=item B<searchable-scrollback:> I<keysym>
1243
1244Sets the hotkey that starts the incremental scrollback buffer search
1245(default: C<M-s>).
1246
1247=item B<urlLauncher>: I<string>
1248
1249Specifies the program to be started with a URL argument. Used by the
1250C<selection-popup> and C<matcher> perl extensions.
1251
1252=item B<transient-for>: I<windowid>
1253
1254Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1255
1256=item B<override-redirect>: I<boolean>
1257
1258Compile I<frills>: Sets override-redirect for the terminal window, making
1259it almost invisible to window managers; option B<-override-redirect>.
1260
1261=item B<iso14755_52:> I<boolean>
1262
1263Turn on/off ISO 14755 5.2 mode (default enabled).
1264
1055=back 1265=back
1056 1266
1057=head1 THE SCROLLBAR 1267=head1 THE SCROLLBAR
1058 1268
1059Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window 1269Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
1077application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1287application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1078(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1288(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1079up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1289up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1080respectively. 1290respectively.
1081 1291
1082=head1 TEXT SELECTION AND INSERTION 1292=head1 THE SELECTION: SELECTING AND PASTING TEXT
1083 1293
1084The behaviour of text selection and insertion mechanism is similar to 1294The behaviour of text selection and insertion/pasting mechanism is similar
1085I<xterm>(1). 1295to I<xterm>(1).
1086 1296
1087=over 4 1297=over 4
1088 1298
1089=item B<Selection>: 1299=item B<Selecting>:
1090 1300
1091Left click at the beginning of the region, drag to the end of the region 1301Left click at the beginning of the region, drag to the end of the region
1092and release; Right click to extend the marked region; Left double-click 1302and release; Right click to extend the marked region; Left double-click
1093to select a word; Left triple-click to select the entire logical line 1303to select a word; Left triple-click to select the entire logical line
1094(which can span multiple screen lines), unless modified by resource 1304(which can span multiple screen lines), unless modified by resource
1098(Compile: I<frills>) will create a rectangular selection instead of a 1308(Compile: I<frills>) will create a rectangular selection instead of a
1099normal one. In this mode, every selected row becomes its own line in the 1309normal one. In this mode, every selected row becomes its own line in the
1100selection, and trailing whitespace is visually underlined and removed from 1310selection, and trailing whitespace is visually underlined and removed from
1101the selection. 1311the selection.
1102 1312
1103=item B<Insertion>: 1313=item B<Pasting>:
1104 1314
1105Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1315Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1106an B<@@RXVT_NAME@@> window causes the current text selection to be 1316window causes the value of the PRIMARY selection (or CLIPBOARD with the
1107inserted as if it had been typed on the keyboard. 1317B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1318
1319Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1320inserted too.
1108 1321
1109=back 1322=back
1110 1323
1111=head1 CHANGING FONTS 1324=head1 CHANGING FONTS
1112 1325
1113Changing fonts (or font sizes, respectively) via the keypad is not yet 1326Changing fonts (or font sizes, respectively) via the keypad is not yet
1114supported in rxvt-unicode. Bug me if you need this. 1327supported in rxvt-unicode. Bug me if you need this.
1115 1328
1116You can, however, switch fonts at runtime using escape sequences (and 1329You can, however, switch fonts at runtime using escape sequences, e.g.:
1117therefore using the menubar), e.g.:
1118 1330
1119 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1331 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1332
1333You can use keyboard shortcuts, too:
1334
1335 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1336 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1120 1337
1121rxvt-unicode will automatically re-apply these fonts to the output so far. 1338rxvt-unicode will automatically re-apply these fonts to the output so far.
1122 1339
1123=head1 ISO 14755 SUPPORT 1340=head1 ISO 14755 SUPPORT
1124 1341
1125ISO 14755 is a standard for entering and viewing unicode characters 1342ISO 14755 is a standard for entering and viewing unicode characters
1126and character codes using the keyboard. It consists of 4 parts. The 1343and character codes using the keyboard. It consists of 4 parts. The
1127first part is available rxvt-unicode has been compiled with 1344first part is available if rxvt-unicode has been compiled with
1128C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1345C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1129with C<--enable-iso14755>. 1346with C<--enable-iso14755>.
1130 1347
1131=over 4 1348=over 4
1132 1349
1152This mode lets you input characters representing the keycap symbols of 1369This mode lets you input characters representing the keycap symbols of
1153your keyboard, if representable in the current locale encoding. 1370your keyboard, if representable in the current locale encoding.
1154 1371
1155Start by pressing C<Control> and C<Shift> together, then releasing 1372Start by pressing C<Control> and C<Shift> together, then releasing
1156them. The next special key (cursor keys, home etc.) you enter will not 1373them. The next special key (cursor keys, home etc.) you enter will not
1157invoke it's usual function but instead will insert the corresponding 1374invoke its usual function but instead will insert the corresponding
1158keycap symbol. The symbol will only be entered when the key has been 1375keycap symbol. The symbol will only be entered when the key has been
1159released, otherwise pressing e.g. C<Shift> would enter the symbol for 1376released, otherwise pressing e.g. C<Shift> would enter the symbol for
1160C<ISO Level 2 Switch>, although your intention might have been to enter a 1377C<ISO Level 2 Switch>, although your intention might have been to enter a
1161reverse tab (Shift-Tab). 1378reverse tab (Shift-Tab).
1162 1379
1195=head1 COLORS AND GRAPHICS 1412=head1 COLORS AND GRAPHICS
1196 1413
1197In addition to the default foreground and background colours, 1414In addition to the default foreground and background colours,
1198B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1415B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1199high-intensity bold/blink versions of the same). Here is a list of the 1416high-intensity bold/blink versions of the same). Here is a list of the
1200colours with their B<rgb.txt> names. 1417colours with their names.
1201 1418
1202=begin table 1419=begin table
1203 1420
1204 B<color0> (black) = Black 1421 B<color0> (black) = Black
1205 B<color1> (red) = Red3 1422 B<color1> (red) = Red3
1225It is also possible to specify the colour values of B<foreground>, 1442It is also possible to specify the colour values of B<foreground>,
1226B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1443B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1227a number 0-15, as a convenient shorthand to reference the colour name of 1444a number 0-15, as a convenient shorthand to reference the colour name of
1228color0-color15. 1445color0-color15.
1229 1446
1447In addition to the colours defined above, @@RXVT_NAME@@ offers an
1448additional 72 colours. The first 64 of those (with indices 16 to 79)
1449consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
145016>), followed by 8 additional shades of gray (with indices 80 to 87).
1451
1452Together, all those colours implement the 88 colour xterm colours. Only
1453the first 16 can be changed using resources currently, the rest can only
1454be changed via command sequences ("escape codes").
1455
1230Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1456Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1231always swapping the foreground/background colours. This is in contrast to 1457always swapping the foreground/background colours. This is in contrast to
1232I<xterm>(1) where the colours are only swapped if they have not otherwise 1458I<xterm>(1) where the colours are only swapped if they have not otherwise
1233been specified. For example, 1459been specified. For example,
1234 1460
1239would yield White on Black, while on I<xterm>(1) it would yield Black 1465would yield White on Black, while on I<xterm>(1) it would yield Black
1240on White. 1466on White.
1241 1467
1242=back 1468=back
1243 1469
1470=head2 ALPHA CHANNEL SUPPORT
1471
1472If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1473their act together, rxvt-unicode will do it's own alpha channel management:
1474
1475You can prefix any color with an opaquenes percentage enclosed in
1476brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1477(0-100) that specifies the opacity of the color, where C<0> is completely
1478transparent and C<100> is completely opaque. For example, C<[50]red> is a
1479half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1480is the recommended format to specify transparency values, and works with
1481all ways to specify a colour.
1482
1483For complete control, rxvt-unicode also supports
1484C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1485specifications, where the additional C<aaaa> component specifies opacity
1486(alpha) values. The minimum value of C<0000> is completely transparent,
1487while C<ffff> is completely opaque). The two example colours from
1488earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1489C<rgba:0000/ff00/0000/f332>.
1490
1491You probably need to specify B<"-depth 32">, too, to force a visual with
1492alpha channels, and have the luck that your X-server uses ARGB pixel
1493layout, as X is far from just supporting ARGB visuals out of the box, and
1494rxvt-unicode just fudges around.
1495
1496For example, the following selects an almost completely transparent black
1497background, and an almost opaque pink foreground:
1498
1499 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1500
1501When not using a background image, then the interpretation of the
1502alpha channel is up to your compositing manager (most interpret it as
1503transparency of course).
1504
1505When using a background pixmap or pseudo-transparency, then the background
1506colour will always behave as if it were completely transparent (so the
1507background image shows instead), regardless of how it was specified, while
1508other colours will either be transparent as specified (the background
1509image will show through) on servers supporting the RENDER extension, or
1510fully opaque on servers not supporting the RENDER EXTENSION.
1511
1512Please note that due to bugs in Xft, specifying alpha values might result
1513in garbage being displayed when the X-server does not support the RENDER
1514extension.
1515
1244=head1 ENVIRONMENT 1516=head1 ENVIRONMENT
1245 1517
1246B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1518B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1247 1519
1248=over 4 1520=over 4
1249 1521
1250=item B<TERM> 1522=item B<TERM>
1251 1523
1252Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1524Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1253resources or on the commandline. 1525resources or on the command line.
1254 1526
1255=item B<COLORTERM> 1527=item B<COLORTERM>
1256 1528
1257Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1529Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1258compiled with XPM support, and optionally with the added extension 1530compiled with background image support, and optionally with the added
1259C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1531extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1532screen.
1260 1533
1261=item B<COLORFGBG> 1534=item B<COLORFGBG>
1262 1535
1263Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1536Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1264the colour code used as default foreground/text colour (or the string 1537the colour code used as default foreground/text colour (or the string
1265C<default> to indicate that the default-colour escape sequence is to be 1538C<default> to indicate that the default-colour escape sequence is to be
1266used), C<bg> is the colour code used as default background colour (or the 1539used), C<bg> is the colour code used as default background colour (or the
1267string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1540string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1268was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1541was compiled with background image support. Libraries like C<ncurses>
1269(and do) use this information to optimize screen output. 1542and C<slang> can (and do) use this information to optimize screen output.
1270 1543
1271=item B<WINDOWID> 1544=item B<WINDOWID>
1272 1545
1273Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1546Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1274window, which usually has subwindows for the scrollbar, the terminal 1547window, which usually has subwindows for the scrollbar, the terminal
1280C<--with-terminfo=PATH>. 1553C<--with-terminfo=PATH>.
1281 1554
1282=item B<DISPLAY> 1555=item B<DISPLAY>
1283 1556
1284Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1557Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1285display in it's child processes. 1558display in its child processes if C<-display> isn't used to override. It
1559defaults to C<:0> if it doesn't exist.
1286 1560
1287=item B<SHELL> 1561=item B<SHELL>
1288 1562
1289The shell to be used for command execution, defaults to C</bin/sh>. 1563The shell to be used for command execution, defaults to C</bin/sh>.
1290
1291=item B<RXVTPATH>
1292
1293The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1294files.
1295
1296=item B<PATH>
1297
1298Used in the same way as C<RXVTPATH>.
1299 1564
1300=item B<RXVT_SOCKET> 1565=item B<RXVT_SOCKET>
1301 1566
1302The unix domain socket path used by @@RXVT_NAME@@c(1) and 1567The unix domain socket path used by @@RXVT_NAME@@c(1) and
1303@@RXVT_NAME@@d(1). 1568@@RXVT_NAME@@d(1).
1341 1606
1342=item Project Coordinator 1607=item Project Coordinator
1343 1608
1344Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1609Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1345 1610
1346L<http://software.schmorp.de/#rxvt-unicode> 1611L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1347 1612
1348=back 1613=back
1349 1614
1350=head1 AUTHORS 1615=head1 AUTHORS
1351 1616
1373 1638
1374Project Coordinator (changes.txt 2.21a to 2.4.5) 1639Project Coordinator (changes.txt 2.21a to 2.4.5)
1375 1640
1376=item Geoff Wing L<< <gcw@pobox.com> >> 1641=item Geoff Wing L<< <gcw@pobox.com> >>
1377 1642
1378Rewrote screen display and text selection routines. Project Coordinator 1643Rewrote screen display and text selection routines.
1644
1379(changes.txt 2.4.6 - rxvt-unicode) 1645Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1380 1646
1381=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1647=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1382 1648
1383Forked rxvt-unicode, rewrote most of the display code and internal 1649Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1384character handling to store text in unicode, improve xterm 1650extension, random hacks, numerous bugfixes and extensions.
1385compatibility and apply numerous other bugfixes and extensions.
1386 1651
1387Project Coordinator (Changes 1.0 -) 1652Project Coordinator (Changes 1.0 -)
1388 1653
1654=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1655
1656Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1657
1389=back 1658=back
1390 1659

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines