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.90 by root, Mon Jan 9 01:36:56 2006 UTC vs.
Revision 1.175 by root, Mon Apr 12 17:06:55 2010 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>.
186
187=item B<-icon> I<file>
188
189Compile I<afterimage>: Use the specified image as application icon. This
190is used by many window managers, taskbars and pagers to represent the
191application window; resource I<iconFile>.
141 192
142=item B<-bg> I<colour> 193=item B<-bg> I<colour>
143 194
144Window background colour; resource B<background>. 195Window background colour; resource B<background>.
145 196
146=item B<-fg> I<colour> 197=item B<-fg> I<colour>
147 198
148Window foreground colour; resource B<foreground>. 199Window foreground colour; resource B<foreground>.
149 200
150=item B<-pixmap> I<file[;geom]> 201=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
151 202
152Compile I<XPM>: Specify XPM file for the background and also optionally 203Compile I<afterimage>: Specify image file for the background and also
153specify its scaling with a geometry string. Note you may need to 204optionally specify its scaling with a geometry string. Note you may need to
154add quotes to avoid special shell interpretation of the C<;> in the 205add quotes to avoid special shell interpretation of the C<;> in the
155command-line; resource B<backgroundPixmap>. 206command-line; for more details see resource B<backgroundPixmap>.
156 207
157=item B<-cr> I<colour> 208=item B<-cr> I<colour>
158 209
159The cursor colour; resource B<cursorColor>. 210The cursor colour; resource B<cursorColor>.
160 211
172resource B<borderColor>. 223resource B<borderColor>.
173 224
174=item B<-fn> I<fontlist> 225=item B<-fn> I<fontlist>
175 226
176Select the fonts to be used. This is a comma separated list of font names 227Select 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 228that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 229first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 230smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 231font list is always appended to it. See resource B<font> for more details.
181 232
182In short, to specify an X11 core font, just specify it's name or prefix it 233In 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:>, 234with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184e.g.: 235e.g.:
185 236
186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 237 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 238 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
205italic> >> characters are to be printed. See resource B<boldItalicFont> 256italic> >> characters are to be printed. See resource B<boldItalicFont>
206for details. 257for details.
207 258
208=item B<-is>|B<+is> 259=item B<-is>|B<+is>
209 260
210Compile I<font-styles>: Bold/Italic font styles imply high intensity 261Compile I<font-styles>: Bold/Blink font styles imply high intensity
211foreground/background (default). See resource B<intensityStyles> for 262foreground/background (default). See resource B<intensityStyles> for
212details. 263details.
213 264
214=item B<-name> I<name> 265=item B<-name> I<name>
215 266
233 284
234=item B<-sb>|B<+sb> 285=item B<-sb>|B<+sb>
235 286
236Turn on/off scrollbar; resource B<scrollBar>. 287Turn on/off scrollbar; resource B<scrollBar>.
237 288
289=item B<-sr>|B<+sr>
290
291Put scrollbar on right/left; resource B<scrollBar_right>.
292
293=item B<-st>|B<+st>
294
295Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
296resource B<scrollBar_floating>.
297
238=item B<-si>|B<+si> 298=item B<-si>|B<+si>
239 299
240Turn on/off scroll-to-bottom on TTY output inhibit; resource 300Turn on/off scroll-to-bottom on TTY output inhibit; resource
241B<scrollTtyOutput> has opposite effect. 301B<scrollTtyOutput> has opposite effect.
242 302
248=item B<-sw>|B<+sw> 308=item B<-sw>|B<+sw>
249 309
250Turn on/off scrolling with the scrollback buffer as new lines appear. 310Turn on/off scrolling with the scrollback buffer as new lines appear.
251This only takes effect if B<-si> is also given; resource 311This only takes effect if B<-si> is also given; resource
252B<scrollWithBuffer>. 312B<scrollWithBuffer>.
253
254=item B<-sr>|B<+sr>
255
256Put scrollbar on right/left; resource B<scrollBar_right>.
257
258=item B<-st>|B<+st>
259
260Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
261resource B<scrollBar_floating>.
262 313
263=item B<-ptab>|B<+ptab> 314=item B<-ptab>|B<+ptab>
264 315
265If enabled (default), "Horizontal Tab" characters are being stored as 316If enabled (default), "Horizontal Tab" characters are being stored as
266actual wide characters in the screen buffer, which makes it possible to 317actual wide characters in the screen buffer, which makes it possible to
270 321
271=item B<-bc>|B<+bc> 322=item B<-bc>|B<+bc>
272 323
273Blink the cursor; resource B<cursorBlink>. 324Blink the cursor; resource B<cursorBlink>.
274 325
326=item B<-uc>|B<+uc>
327
328Make the cursor underlined; resource B<cursorUnderline>.
329
275=item B<-iconic> 330=item B<-iconic>
276 331
277Start iconified, if the window manager supports that option. 332Start iconified, if the window manager supports that option.
278Alternative form is B<-ic>. 333Alternative form is B<-ic>.
279 334
295 350
296=item B<-bl> 351=item B<-bl>
297 352
298Compile I<frills>: Set MWM hints to request a borderless window, i.e. 353Compile I<frills>: Set MWM hints to request a borderless window, i.e.
299if honoured by the WM, the rxvt-unicode window will not have window 354if honoured by the WM, the rxvt-unicode window will not have window
300decorations; resource B<borderLess>. 355decorations; resource B<borderLess>. If the window manager does not
356support MWM hints (e.g. kwin), enables override-redirect mode.
357
358=item B<-override-redirect>
359
360Compile I<frills>: Sets override-redirect on the window; resource
361B<override-redirect>.
301 362
302=item B<-sbg> 363=item B<-sbg>
303 364
304Compile I<frills>: Disable the usage of the built-in block graphics/line 365Compile I<frills>: Disable the usage of the built-in block graphics/line
305drawing characters and just rely on what the specified fonts provide. Use 366drawing characters and just rely on what the specified fonts provide. Use
308 369
309=item B<-lsp> I<number> 370=item B<-lsp> I<number>
310 371
311Compile I<frills>: Lines (pixel height) to insert between each row of 372Compile I<frills>: Lines (pixel height) to insert between each row of
312the display. Useful to work around font rendering problems; resource 373the display. Useful to work around font rendering problems; resource
313B<linespace>. 374B<lineSpace>.
375
376=item B<-letsp> I<number>
377
378Compile I<frills>: Amount to adjust the computed character width by
379to control overall letter spacing. Negative values will tighten up the
380letter spacing, positive values will space letters out more. Useful to
381work around odd font metrics; resource B<letterSpace>.
314 382
315=item B<-tn> I<termname> 383=item B<-tn> I<termname>
316 384
317This option specifies the name of the terminal type to be set in the 385This option specifies the name of the terminal type to be set in the
318B<TERM> environment variable. This terminal type must exist in the 386B<TERM> environment variable. This terminal type must exist in the
372for more info. 440for more info.
373 441
374=item B<-tcw> 442=item B<-tcw>
375 443
376Change the meaning of triple-click selection with the left mouse 444Change the meaning of triple-click selection with the left mouse
445button. Only effective when the original (non-perl) selection code is
377button. Instead of selecting a full line it will extend the selection the 446in-use. Instead of selecting a full line it will extend the selection to
378end of the logical line only. resource B<tripleclickwords>. 447the end of the logical line only. resource B<tripleclickwords>.
379 448
380=item B<-insecure> 449=item B<-insecure>
381 450
382Enable "insecure" mode, which currently enables most of the escape 451Enable "insecure" mode, which currently enables most of the escape
383sequences that echo strings. See the resource B<insecure> for more 452sequences that echo strings. See the resource B<insecure> for more
404Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 473Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
405will not immediately destroy its window when the program executed within 474will not immediately destroy its window when the program executed within
406it exits. Instead, it will wait till it is being killed or closed by the 475it exits. Instead, it will wait till it is being killed or closed by the
407user; resource B<hold>. 476user; resource B<hold>.
408 477
478=item B<-cd> I<path>
479
480Sets the working directory for the shell (or the command specified via
481B<-e>). The I<path> must be an absolute path and it must exist for
482@@RXVT_NAME@@ to start; resource B<chdir>.
483
484=item B<-xrm> I<string>
485
486Works like the X Toolkit option of the same name, by adding the I<string>
487as if it were specified in a resource file. Resource values specified this
488way take precedence over all other resource specifications.
489
490Note that you need to use the I<same> syntax as in the .Xdefaults file,
491e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
492options can be specified as long-options on the commandline, so use
493of B<-xrm> is mostly limited to cases where you want to specify other
494resources (e.g. for input methods) or for compatibility with other
495programs.
496
409=item B<-keysym.>I<sym> I<string> 497=item B<-keysym.>I<sym> I<string>
410 498
411Remap a key symbol. See resource B<keysym>. 499Remap a key symbol. See resource B<keysym>.
412 500
413=item B<-embed> I<windowid> 501=item B<-embed> I<windowid>
414 502
415Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 503Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
416which enables applications to easily embed a terminal. 504which enables applications to easily embed a terminal.
417 505
418Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 506Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
419shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 507shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
420quite a bit, so don't expect it to keep some specific state. It's best to 508quite a bit, so don't expect it to keep some specific state. It's best to
423The window will not be destroyed when @@RXVT_NAME@@ exits. 511The window will not be destroyed when @@RXVT_NAME@@ exits.
424 512
425It might be useful to know that @@RXVT_NAME@@ will not close file 513It might be useful to know that @@RXVT_NAME@@ will not close file
426descriptors passed to it (except for stdin/out/err, of course), so you 514descriptors passed to it (except for stdin/out/err, of course), so you
427can use file descriptors to communicate with the programs within the 515can use file descriptors to communicate with the programs within the
428terminal. This works regardless of wether the C<-embed> option was used or 516terminal. This works regardless of whether the C<-embed> option was used or
429not. 517not.
430 518
431Here is a short Gtk2-perl snippet that illustrates how this option can be 519Here is a short Gtk2-perl snippet that illustrates how this option can be
432used (a longer example is in F<doc/embed>): 520used (a longer example is in F<doc/embed>):
433 521
438 }); 526 });
439 527
440=item B<-pty-fd> I<file descriptor> 528=item B<-pty-fd> I<file descriptor>
441 529
442Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 530Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
443pair but instead use the given filehandle as the tty master. This is 531pair but instead use the given file descriptor as the tty master. This is
444useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 532useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
445without having to run a program within it. 533without having to run a program within it.
446 534
447If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 535If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
448entries and will not tinker with pty/tty permissions - you have to do that 536entries and will not tinker with pty/tty permissions - you have to do that
449yourself if you want that. 537yourself if you want that.
450 538
451As an extremely special case, specifying C<-1> will completely suppress 539As an extremely special case, specifying C<-1> will completely suppress
452pty/tty operations. 540pty/tty operations, which is probably only useful in conjunction with some
541perl extension that manages the terminal.
453 542
454Here is a example in perl that illustrates how this option can be used (a 543Here is a example in perl that illustrates how this option can be used (a
455longer example is in F<doc/pty-fd>): 544longer example is in F<doc/pty-fd>):
456 545
457 use IO::Pty; 546 use IO::Pty;
471Comma-separated list of perl extension scripts to use (or not to use) in 560Comma-separated list of perl extension scripts to use (or not to use) in
472this terminal instance. See resource B<perl-ext> for details. 561this terminal instance. See resource B<perl-ext> for details.
473 562
474=back 563=back
475 564
476=head1 RESOURCES (available also as long-options) 565=head1 RESOURCES
477 566
478Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 567Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
479options) compiled into your version. 568options) compiled into your version. All resources are also available as
569long-options.
480 570
481There are two different methods that @@RXVT_NAME@@ can use to get the 571You can set and change the resources using X11 tools like B<xrdb>. Many
482Xresource data: using the X libraries (Xrm*-functions) or internal 572distribution do also load settings from the B<~/.Xresources> file when X
483Xresources reader (B<~/.Xdefaults>). For the first method (ie. 573starts. @@RXVT_NAME@@ will consult the following files/resources in order,
484B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 574with later settings overwriting earlier ones:
485resources using X11 tools like B<xrdb>. Many distribution do also load
486settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
487will consult the following files/resources in order, with later settings
488overwriting earlier ones:
489 575
490 1. system-wide app-defaults file, either locale-dependent OR global 576 1. system-wide app-defaults file, either locale-dependent OR global
491 2. app-defaults file in $XAPPLRESDIR 577 2. app-defaults file in $XAPPLRESDIR
492 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 578 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
493 4. SCREEN_RESOURCES for the current screen 579 4. SCREEN_RESOURCES for the current screen
494 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 580 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
581 6. resources specified via -xrm on the commandline
495 582
496If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
497lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
498set in XAPPLOADDIR/URxvt (compile-time defined: usually
499B</usr/lib/X11/app-defaults/URxvt>) and resources set in
500B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
501Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 583Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
502class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 584names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
503resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 585common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
504easily configured, while the class name B<URxvt> allows resources 586configured, while the class name B<URxvt> allows resources unique to
505unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 587B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
506shared between different B<@@RXVT_NAME@@> configurations. If no 588configurations. If no resources are specified, suitable defaults will
507resources are specified, suitable defaults will be used. Command-line 589be used. Command-line arguments can be used to override resource
508arguments can be used to override resource settings. The following 590settings. The following resources are supported (you might want to
509resources are allowed: 591check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
592extensions not documented here):
510 593
511=over 4 594=over 4
595
596=item B<depth:> I<bitdepth>
597
598Compile I<xft>: Attempt to find a visual with the given bit depth;
599option B<-depth>.
600
601=item B<buffered:> I<boolean>
602
603Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
604On some card/driver combination enabling it slightly decreases
605performance, on most it greatly helps it. The slowdown is small, so it
606should normally be enabled.
512 607
513=item B<geometry:> I<geom> 608=item B<geometry:> I<geom>
514 609
515Create the window with the specified X window geometry [default 80x24]; 610Create the window with the specified X window geometry [default 80x24];
516option B<-geometry>. 611option B<-geometry>.
553Use the specified colour to display underlined characters when the 648Use the specified colour to display underlined characters when the
554foreground colour is the default. 649foreground colour is the default.
555 650
556=item B<colorRV:> I<colour> 651=item B<colorRV:> I<colour>
557 652
558Use the specified colour as the background for reverse video 653Use the specified colour as the background for reverse video characters
559characters. 654when OPTION_HC is disabled (--disable-frills).
560 655
561=item B<underlineColor:> I<colour> 656=item B<underlineColor:> I<colour>
562 657
563If set, use the specified colour as the colour for the underline 658If set, use the specified colour as the colour for the underline
564itself. If unset, use the foreground colour. 659itself. If unset, use the foreground colour.
580option B<-rv>. B<False>: regular screen colours [default]; option 675option B<-rv>. B<False>: regular screen colours [default]; option
581B<+rv>. See note in B<COLORS AND GRAPHICS> section. 676B<+rv>. See note in B<COLORS AND GRAPHICS> section.
582 677
583=item B<jumpScroll:> I<boolean> 678=item B<jumpScroll:> I<boolean>
584 679
585B<True>: specify that jump scrolling should be used. When scrolling 680B<True>: specify that jump scrolling should be used. When receiving lots
586quickly, fewer screen updates are performed [default]; option B<-j>. 681of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
682has been read, resulting in fewer updates while still displaying every
683received line; option B<-j>.
684
587B<False>: specify that smooth scrolling should be used; option B<+j>. 685B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
686force a screen refresh on each new line it received; option B<+j>.
588 687
589=item B<inheritPixmap:> I<boolean> 688=item B<skipScroll:> I<boolean>
590 689
591B<True>: make the background inherit the parent windows' pixmap, giving 690B<True>: (the default) specify that skip scrolling should be used. When
592artificial transparency. B<False>: do not inherit the parent windows' 691receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
593pixmap. 692(around 60 times per second), resulting in far fewer updates. This can
693result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
694option B<-ss>.
695
696B<False>: specify that everything is to be displayed, even
697if the refresh is too fast for the human eye to read anything (or the
698monitor to display anything); option B<+ss>.
699
700=item B<transparent:> I<boolean>
701
702Turn on/off illusion of a transparent window background.
703
704B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
705future versions.
706
707I<Please address all transparency related issues to Sasha Vasko at
708sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
594 709
595=item B<fading:> I<number> 710=item B<fading:> I<number>
596 711
597Fade the text by the given percentage when focus is lost; option B<-fade>. 712Fade the text by the given percentage when focus is lost; option B<-fade>.
598 713
606Tint the transparent background pixmap with the given colour; option 721Tint the transparent background pixmap with the given colour; option
607B<-tint>. 722B<-tint>.
608 723
609=item B<shading:> I<number> 724=item B<shading:> I<number>
610 725
611Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 726Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
612image in addition to tinting it. 727in addition to tinting it; option B<-sh>.
728
729=item B<blendType:> I<string>
730
731Specify background blending type; option B<-blt>.
732
733=item B<blurRadius:> I<number>
734
735Apply gaussian blur with the specified radius to the transparent
736background image; option B<-blr>.
737
738=item B<iconFile:> I<file>
739
740Set the application icon pixmap; option B<-icon>.
613 741
614=item B<scrollColor:> I<colour> 742=item B<scrollColor:> I<colour>
615 743
616Use the specified colour for the scrollbar [default #B2B2B2]. 744Use the specified colour for the scrollbar [default #B2B2B2].
617 745
623=item B<borderColor:> I<colour> 751=item B<borderColor:> I<colour>
624 752
625The colour of the border around the text area and between the scrollbar 753The colour of the border around the text area and between the scrollbar
626and the text. 754and the text.
627 755
628=item B<backgroundPixmap:> I<file[;geom]> 756=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
629 757
630Use the specified XPM file (note the `.xpm' extension is optional) for 758Use the specified image file for the background and also
631the background and also optionally specify its scaling with a geometry 759optionally specify its scaling with a geometry string B<WxH+X+Y>,
632string B<WxH+X+Y>, in which B<"W" / "H"> specify the 760(default C<0x0+50+50>) in which B<"W" / "H"> specify the
633horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 761horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
634centre (percent). A scale of 0 displays the image with tiling. A scale 762centre (percent). A scale of 0 displays the image with tiling. A scale
635of 1 displays the image without any scaling. A scale of 2 to 9 763of 1 displays the image without any scaling. A scale of 2 to 9 specifies
636specifies an integer number of images in that direction. No image will 764an integer number of images in that direction. No image will be magnified
637be magnified beyond 10 times its original size. The maximum permitted 765beyond 10 times its original size. The maximum permitted scale is 1000.
638scale is 1000. [default 0x0+50+50] 766Additional operations can be specified after colon B<:op1:op2...>.
767Supported operations are:
639 768
640=item B<menu:> I<file[;tag]> 769 tile force background image to be tiled and not scaled. Equivalent to 0x0
770 propscale will scale image keeping proportions
771 auto will scale image to match window size. Equivalent to 100x100
772 hscale will scale image horizontally to the window size
773 vscale will scale image vertically to the window size
774 scale will scale image to match window size
775 root will tile image as if it was a root window background, auto-adjusting
776 whenever terminal window moves
641 777
642Read in the specified menu file (note the `.menu' extension is 778If used in conjunction with B<-tr> option, the specified pixmap will be
643optional) and also optionally specify a starting tag to find. See the 779blended over transparency image using either alpha-blending, or any
644reference documentation for details on the syntax for the menuBar. 780other blending type, specified with B<-blt "type"> option.
645 781
646=item B<path:> I<path> 782=item B<path:> I<path>
647 783
648Specify the colon-delimited search path for finding files (XPM and 784Specify the colon-delimited search path for finding background image files.
649menus), in addition to the paths specified by the B<RXVTPATH> and
650B<PATH> environment variables.
651 785
652=item B<font:> I<fontlist> 786=item B<font:> I<fontlist>
653 787
654Select the fonts to be used. This is a comma separated list of font 788Select the fonts to be used. This is a comma separated list of font names
655names that are used in turn when trying to display Unicode characters. 789that are checked in order when trying to find glyphs for characters. The
656The first font defines the cell size for characters; other fonts might 790first font defines the cell size for characters; other fonts might be
657be smaller, but not larger. A reasonable default font list is always 791smaller, but not (in general) larger. A (hopefully) reasonable default
658appended to it; option B<-fn>. 792font list is always appended to it; option B<-fn>.
659 793
660Each font can either be a standard X11 core font (XLFD) name, with 794Each font can either be a standard X11 core font (XLFD) name, with
661optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 795optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
662 796
663In addition, each font can be prefixed with additional hints and 797In addition, each font can be prefixed with additional hints and
665hint currently is C<codeset=codeset-name>, and this is only used for Xft 799hint currently is C<codeset=codeset-name>, and this is only used for Xft
666fonts. 800fonts.
667 801
668For example, this font resource 802For example, this font resource
669 803
670 URxvt*font: 9x15bold,\ 804 URxvt.font: 9x15bold,\
671 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 805 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
672 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 806 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
673 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 807 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
674 xft:Code2000:antialias=false 808 xft:Code2000:antialias=false
675 809
678it is named first) and thus defines the character cell grid to be 9 pixels 812it is named first) and thus defines the character cell grid to be 9 pixels
679wide and 15 pixels high. 813wide and 15 pixels high.
680 814
681The second font is just used to add additional unicode characters not in 815The second font is just used to add additional unicode characters not in
682the base font, likewise the third, which is unfortunately non-bold, but 816the base font, likewise the third, which is unfortunately non-bold, but
683the bold version of the font does contain less characters, so this is a 817the bold version of the font does contain fewer characters, so this is a
684useful supplement. 818useful supplement.
685 819
686The third font is an Xft font with aliasing turned off, and the characters 820The third font is an Xft font with aliasing turned off, and the characters
687are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 821are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
688contains other characters, but we are not interested in them. 822contains other characters, but we are not interested in them.
712text font will being used for the given style. 846text font will being used for the given style.
713 847
714=item B<intensityStyles:> I<boolean> 848=item B<intensityStyles:> I<boolean>
715 849
716When font styles are not enabled, or this option is enabled (B<True>, 850When font styles are not enabled, or this option is enabled (B<True>,
717option B<-is>, the default), bold and italic font styles imply high 851option B<-is>, the default), bold/blink font styles imply high
718intensity foreground/backround colours. Disabling this option (B<False>, 852intensity foreground/background colours. Disabling this option (B<False>,
719option B<+is>) disables this behaviour, the high intensity colours are not 853option B<+is>) disables this behaviour, the high intensity colours are not
720reachable. 854reachable.
721
722=item B<selectstyle:> I<mode>
723
724Set mouse selection style to B<old> which is 2.20, B<oldword> which is
725xterm style with 2.20 old word selection, or anything else which gives
726xterm style selection.
727
728=item B<scrollstyle:> I<mode>
729
730Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
731the author's favourite.
732 855
733=item B<title:> I<string> 856=item B<title:> I<string>
734 857
735Set window title string, the default title is the command-line 858Set window title string, the default title is the command-line
736specified after the B<-e> option, if any, otherwise the application 859specified after the B<-e> option, if any, otherwise the application
745=item B<mapAlert:> I<boolean> 868=item B<mapAlert:> I<boolean>
746 869
747B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 870B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
748de-iconify (map) on receipt of a bell character [default]. 871de-iconify (map) on receipt of a bell character [default].
749 872
873=item B<urgentOnBell:> I<boolean>
874
875B<True>: set the urgency hint for the wm on receipt of a bell character.
876B<False>: do not set the urgency hint [default].
877
878@@RXVT_NAME@@ resets the urgency hint on every focus change.
879
750=item B<visualBell:> I<boolean> 880=item B<visualBell:> I<boolean>
751 881
752B<True>: use visual bell on receipt of a bell character; option B<-vb>. 882B<True>: use visual bell on receipt of a bell character; option B<-vb>.
753B<False>: no visual bell [default]; option B<+vb>. 883B<False>: no visual bell [default]; option B<+vb>.
754 884
772 902
773The string will be interpreted as if typed into the shell as-is. 903The string will be interpreted as if typed into the shell as-is.
774 904
775Example: 905Example:
776 906
777 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 907 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
778 908
779This creates a new file in your home directory with the screen contents 909This creates a new file in your home directory with the screen contents
780everytime you hit C<Print>. 910every time you hit C<Print>.
911
912=item B<scrollstyle:> I<mode>
913
914Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
915the author's favourite.
781 916
782=item B<scrollBar:> I<boolean> 917=item B<scrollBar:> I<boolean>
783 918
784B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 919B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
785disable the scrollbar; option B<+sb>. 920disable the scrollbar; option B<+sb>.
807 942
808=item B<scrollWithBuffer:> I<boolean> 943=item B<scrollWithBuffer:> I<boolean>
809 944
810B<True>: scroll with scrollback buffer when tty receives new lines (and 945B<True>: scroll with scrollback buffer when tty receives new lines (and
811B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 946B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
812with scrollback buffer when tty recieves new lines; option B<+sw>. 947with scrollback buffer when tty receives new lines; option B<+sw>.
813 948
814=item B<scrollTtyKeypress:> I<boolean> 949=item B<scrollTtyKeypress:> I<boolean>
815 950
816B<True>: scroll to bottom when a non-special key is pressed. Special keys 951B<True>: scroll to bottom when a non-special key is pressed. Special keys
817are those which are intercepted by rxvt-unicode for special handling and 952are those which are intercepted by rxvt-unicode for special handling and
848=item B<termName:> I<termname> 983=item B<termName:> I<termname>
849 984
850Specifies the terminal type name to be set in the B<TERM> environment 985Specifies the terminal type name to be set in the B<TERM> environment
851variable; option B<-tn>. 986variable; option B<-tn>.
852 987
853=item B<linespace:> I<number> 988=item B<lineSpace:> I<number>
854 989
855Specifies number of lines (pixel height) to insert between each row of 990Specifies number of lines (pixel height) to insert between each row of
856the display [default 0]; option B<-lsp>. 991the display [default 0]; option B<-lsp>.
857 992
858=item B<meta8:> I<boolean> 993=item B<meta8:> I<boolean>
872 1007
873=item B<cursorBlink:> I<boolean> 1008=item B<cursorBlink:> I<boolean>
874 1009
875B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 1010B<True>: blink the cursor. B<False>: do not blink the cursor [default];
876option B<-bc>. 1011option B<-bc>.
1012
1013=item B<cursorUnderline:> I<boolean>
1014
1015B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
1016option B<-uc>.
877 1017
878=item B<pointerBlank:> I<boolean> 1018=item B<pointerBlank:> I<boolean>
879 1019
880B<True>: blank the pointer when a key is pressed or after a set number 1020B<True>: blank the pointer when a key is pressed or after a set number
881of seconds of inactivity. B<False>: the pointer is always visible 1021of seconds of inactivity. B<False>: the pointer is always visible
907pressed. If unset it will send the sequence traditionally associated 1047pressed. If unset it will send the sequence traditionally associated
908with the B<Execute> key. 1048with the B<Execute> key.
909 1049
910=item B<cutchars:> I<string> 1050=item B<cutchars:> I<string>
911 1051
912The characters used as delimiters for double-click word selection. The 1052The characters used as delimiters for double-click word selection
913built-in default: 1053(whitespace delimiting is added automatically if resource is given).
914 1054
1055When the perl selection extension is in use (the default if compiled
1056in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
1057characters will be created (if the resource exists, otherwise, no regex
1058will be created). In this mode, characters outside ISO-8859-1 can be used.
1059
1060When the selection extension is not used, only ISO-8859-1 characters can
1061be used. If not specified, the built-in default is used:
1062
915B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1063B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
916 1064
917=item B<preeditType:> I<style> 1065=item B<preeditType:> I<style>
918 1066
919B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1067B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
920 1068
954default. (Note that many other terminals, including xterm, have these 1102default. (Note that many other terminals, including xterm, have these
955sequences enabled by default, which doesn't make it safer, though). 1103sequences enabled by default, which doesn't make it safer, though).
956 1104
957You can enable them by setting this boolean resource or specifying 1105You can enable them by setting this boolean resource or specifying
958B<-insecure> as an option. At the moment, this enables display-answer, 1106B<-insecure> as an option. At the moment, this enables display-answer,
959locale, findfont, icon label and window title requests as well as dynamic 1107locale, findfont, icon label and window title requests.
960menubar dispatch.
961 1108
962=item B<modifier:> I<modifier> 1109=item B<modifier:> I<modifier>
963 1110
964Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 1111Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
965B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 1112B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
969 1116
970Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1117Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
971character is passed through. It may contain escape values as described 1118character is passed through. It may contain escape values as described
972in the entry on B<keysym> following. 1119in the entry on B<keysym> following.
973 1120
974=item B<secondaryScreen:> I<bool> 1121=item B<secondaryScreen:> I<boolean>
975 1122
976Turn on/off secondary screen (default enabled). 1123Turn on/off secondary screen (default enabled).
977 1124
978=item B<secondaryScroll:> I<bool> 1125=item B<secondaryScroll:> I<boolean>
979 1126
980Turn on/off secondary screen scroll (default enabled). If the this 1127Turn on/off secondary screen scroll (default enabled). If this
981option is enabled, scrolls on the secondary screen will change the 1128option is enabled, scrolls on the secondary screen will change the
982scrollback buffer and switching to/from the secondary screen will 1129scrollback buffer and, when secondaryScreen is off, switching
983instead scroll the screen up. 1130to/from the secondary screen will instead scroll the screen up.
984 1131
985=item B<hold>: I<bool> 1132=item B<hold>: I<boolean>
986 1133
987Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1134Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
988will not immediately destroy its window when the program executed within 1135will not immediately destroy its window when the program executed within
989it exits. Instead, it will wait till it is being killed or closed by the 1136it exits. Instead, it will wait till it is being killed or closed by the
990user. 1137user.
1138
1139=item B<chdir>: I<path>
1140
1141Sets the working directory for the shell (or the command specified via
1142B<-e>). The I<path> must be an absolute path and it must exist for
1143@@RXVT_NAME@@ to start. If it isn't specified then the current working
1144directory will be used; option B<-cd>.
991 1145
992=item B<keysym.>I<sym>: I<string> 1146=item B<keysym.>I<sym>: I<string>
993 1147
994Compile I<frills>: Associate I<string> with keysym I<sym>. The 1148Compile I<frills>: Associate I<string> with keysym I<sym>. The
995intervening resource name B<keysym.> cannot be omitted. 1149intervening resource name B<keysym.> cannot be omitted.
1009searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1163searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1010omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1164omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1011keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1165keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1012performed in an exact manner; however, the closest match is assured. 1166performed in an exact manner; however, the closest match is assured.
1013 1167
1014I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1168I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1015C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1169number), see RESOURCES in C<man 7 X> for futher details.
1016C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1017C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1018can start or end with whitespace.
1019
1020Please note that you need to double the C<\> when using
1021C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
1022use C<\033> instead of C<\e> (and so on), which will work with both Xt and
1023@@RXVT_NAME@@'s own processing).
1024 1170
1025You can define a range of keysyms in one shot by providing a I<string> 1171You can define a range of keysyms in one shot by providing a I<string>
1026with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1172with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1027should be a character not used by the strings. 1173should be a character not used by the strings.
1028 1174
1029Its usage can be demonstrated by an example: 1175Its usage can be demonstrated by an example:
1030 1176
1031 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1177 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1042when Control-Meta-c is being pressed": 1188when Control-Meta-c is being pressed":
1043 1189
1044 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1190 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1045 1191
1046If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1192If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1047is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1193is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1048manpage. For example, the F<selection> extension (activated via 1194manpage. For example, the F<selection> extension (activated via
1049C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1195C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1050 1196
1051 URxvt.keysym.M-C-c: perl:selection:rot13 1197 URxvt.keysym.M-C-c: perl:selection:rot13
1052 1198
1088 1234
1089Comma-separated list(s) of perl extension scripts (default: C<default>) to 1235Comma-separated list(s) of perl extension scripts (default: C<default>) to
1090use in this terminal instance; option B<-pe>. 1236use in this terminal instance; option B<-pe>.
1091 1237
1092Extension names can be prefixed with a C<-> sign to prohibit using 1238Extension names can be prefixed with a C<-> sign to prohibit using
1093it. This can be useful to selectively disable some extensions loaded 1239them. This can be useful to selectively disable some extensions loaded
1094by default, or specified via the C<perl-ext-common> resource. For 1240by default, or specified via the C<perl-ext-common> resource. For
1095example, C<default,-selection> will use all the default extension except 1241example, C<default,-selection> will use all the default extension except
1096C<selection>. 1242C<selection>.
1243
1244Extension names can also be followed by an argument in angle brackets
1245(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1246searchable scrollback to Alt/Meta-s). Mentioning the same extension
1247multiple times with different arguments will pass multiple arguments to
1248the extension.
1097 1249
1098Each extension is looked up in the library directories, loaded if 1250Each extension is looked up in the library directories, loaded if
1099necessary, and bound to the current terminal instance. 1251necessary, and bound to the current terminal instance.
1100 1252
1101If both of these resources are the empty string, then the perl 1253If both of these resources are the empty string, then the perl
1104all instances, while B<perl-ext> is used for specific instances. 1256all instances, while B<perl-ext> is used for specific instances.
1105 1257
1106=item B<perl-eval>: I<string> 1258=item B<perl-eval>: I<string>
1107 1259
1108Perl code to be evaluated when all extensions have been registered. See 1260Perl code to be evaluated when all extensions have been registered. See
1109the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1261the @@RXVT_NAME@@perl(3) manpage.
1110will be ignored when running setuid/setgid.
1111 1262
1112=item B<perl-lib>: I<path> 1263=item B<perl-lib>: I<path>
1113 1264
1114Colon-separated list of additional directories that hold extension 1265Colon-separated list of additional directories that hold extension
1115scripts. When looking for extensions specified by the C<perl> resource, 1266scripts. When looking for extensions specified by the C<perl> resource,
1116@@RXVT_NAME@@ will first look in these directories and then in 1267@@RXVT_NAME@@ will first look in these directories and then in
1117F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1268F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1118will be ignored when running setuid/setgid.
1119 1269
1120See the @@RXVT_NAME@@perl(3) manpage. 1270See the @@RXVT_NAME@@perl(3) manpage.
1121 1271
1272=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1273
1274Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1275details.
1276
1277=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1278
1279Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1280for details.
1281
1282=item B<searchable-scrollback:> I<keysym>
1283
1284Sets the hotkey that starts the incremental scrollback buffer search
1285(default: C<M-s>).
1286
1287=item B<urlLauncher>: I<string>
1288
1289Specifies the program to be started with a URL argument. Used by the
1290C<selection-popup> and C<matcher> perl extensions.
1291
1122=item B<transient-for>: I<windowid> 1292=item B<transient-for>: I<windowid>
1123 1293
1124Sets the WM_TRANSIENT_FOR property to the given window iw. 1294Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1295
1296=item B<override-redirect>: I<boolean>
1297
1298Compile I<frills>: Sets override-redirect for the terminal window, making
1299it almost invisible to window managers; option B<-override-redirect>.
1300
1301=item B<iso14755:> I<boolean>
1302
1303Turn on/off ISO 14755 (default enabled).
1304
1305=item B<iso14755_52:> I<boolean>
1306
1307Turn on/off ISO 14755 5.2 mode (default enabled).
1125 1308
1126=back 1309=back
1127 1310
1128=head1 THE SCROLLBAR 1311=head1 THE SCROLLBAR
1129 1312
1148application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1331application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1149(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1332(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1150up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1333up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1151respectively. 1334respectively.
1152 1335
1153=head1 TEXT SELECTION AND INSERTION 1336=head1 THE SELECTION: SELECTING AND PASTING TEXT
1154 1337
1155The behaviour of text selection and insertion mechanism is similar to 1338The behaviour of text selection and insertion/pasting mechanism is similar
1156I<xterm>(1). 1339to I<xterm>(1).
1157 1340
1158=over 4 1341=over 4
1159 1342
1160=item B<Selection>: 1343=item B<Selecting>:
1161 1344
1162Left click at the beginning of the region, drag to the end of the region 1345Left click at the beginning of the region, drag to the end of the region
1163and release; Right click to extend the marked region; Left double-click 1346and release; Right click to extend the marked region; Left double-click
1164to select a word; Left triple-click to select the entire logical line 1347to select a word; Left triple-click to select the entire logical line
1165(which can span multiple screen lines), unless modified by resource 1348(which can span multiple screen lines), unless modified by resource
1169(Compile: I<frills>) will create a rectangular selection instead of a 1352(Compile: I<frills>) will create a rectangular selection instead of a
1170normal one. In this mode, every selected row becomes its own line in the 1353normal one. In this mode, every selected row becomes its own line in the
1171selection, and trailing whitespace is visually underlined and removed from 1354selection, and trailing whitespace is visually underlined and removed from
1172the selection. 1355the selection.
1173 1356
1174=item B<Insertion>: 1357=item B<Pasting>:
1175 1358
1176Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1359Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1177an B<@@RXVT_NAME@@> window causes the current text selection to be 1360window causes the value of the PRIMARY selection (or CLIPBOARD with the
1178inserted as if it had been typed on the keyboard. 1361B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1362
1363Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1364inserted too.
1179 1365
1180=back 1366=back
1181 1367
1182=head1 CHANGING FONTS 1368=head1 CHANGING FONTS
1183 1369
1184Changing fonts (or font sizes, respectively) via the keypad is not yet 1370Changing fonts (or font sizes, respectively) via the keypad is not yet
1185supported in rxvt-unicode. Bug me if you need this. 1371supported in rxvt-unicode. Bug me if you need this.
1186 1372
1187You can, however, switch fonts at runtime using escape sequences (and 1373You can, however, switch fonts at runtime using escape sequences, e.g.:
1188therefore using the menubar), e.g.:
1189 1374
1190 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1375 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1376
1377You can use keyboard shortcuts, too:
1378
1379 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1380 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1191 1381
1192rxvt-unicode will automatically re-apply these fonts to the output so far. 1382rxvt-unicode will automatically re-apply these fonts to the output so far.
1193 1383
1194=head1 ISO 14755 SUPPORT 1384=head1 ISO 14755 SUPPORT
1195 1385
1196ISO 14755 is a standard for entering and viewing unicode characters 1386ISO 14755 is a standard for entering and viewing unicode characters
1197and character codes using the keyboard. It consists of 4 parts. The 1387and character codes using the keyboard. It consists of 4 parts. The
1198first part is available rxvt-unicode has been compiled with 1388first part is available if rxvt-unicode has been compiled with
1199C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1389C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1200with C<--enable-iso14755>. 1390with C<--enable-iso14755>.
1201 1391
1202=over 4 1392=over 4
1203 1393
1223This mode lets you input characters representing the keycap symbols of 1413This mode lets you input characters representing the keycap symbols of
1224your keyboard, if representable in the current locale encoding. 1414your keyboard, if representable in the current locale encoding.
1225 1415
1226Start by pressing C<Control> and C<Shift> together, then releasing 1416Start by pressing C<Control> and C<Shift> together, then releasing
1227them. The next special key (cursor keys, home etc.) you enter will not 1417them. The next special key (cursor keys, home etc.) you enter will not
1228invoke it's usual function but instead will insert the corresponding 1418invoke its usual function but instead will insert the corresponding
1229keycap symbol. The symbol will only be entered when the key has been 1419keycap symbol. The symbol will only be entered when the key has been
1230released, otherwise pressing e.g. C<Shift> would enter the symbol for 1420released, otherwise pressing e.g. C<Shift> would enter the symbol for
1231C<ISO Level 2 Switch>, although your intention might have been to enter a 1421C<ISO Level 2 Switch>, although your intention might have been to enter a
1232reverse tab (Shift-Tab). 1422reverse tab (Shift-Tab).
1233 1423
1266=head1 COLORS AND GRAPHICS 1456=head1 COLORS AND GRAPHICS
1267 1457
1268In addition to the default foreground and background colours, 1458In addition to the default foreground and background colours,
1269B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1459B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1270high-intensity bold/blink versions of the same). Here is a list of the 1460high-intensity bold/blink versions of the same). Here is a list of the
1271colours with their B<rgb.txt> names. 1461colours with their names.
1272 1462
1273=begin table 1463=begin table
1274 1464
1275 B<color0> (black) = Black 1465 B<color0> (black) = Black
1276 B<color1> (red) = Red3 1466 B<color1> (red) = Red3
1296It is also possible to specify the colour values of B<foreground>, 1486It is also possible to specify the colour values of B<foreground>,
1297B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1487B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1298a number 0-15, as a convenient shorthand to reference the colour name of 1488a number 0-15, as a convenient shorthand to reference the colour name of
1299color0-color15. 1489color0-color15.
1300 1490
1491In addition to the colours defined above, @@RXVT_NAME@@ offers an
1492additional 72 colours. The first 64 of those (with indices 16 to 79)
1493consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
149416>), followed by 8 additional shades of gray (with indices 80 to 87).
1495
1496Together, all those colours implement the 88 colour xterm colours. Only
1497the first 16 can be changed using resources currently, the rest can only
1498be changed via command sequences ("escape codes").
1499
1301Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1500Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1302always swapping the foreground/background colours. This is in contrast to 1501always swapping the foreground/background colours. This is in contrast to
1303I<xterm>(1) where the colours are only swapped if they have not otherwise 1502I<xterm>(1) where the colours are only swapped if they have not otherwise
1304been specified. For example, 1503been specified. For example,
1305 1504
1505 @@RXVT_NAME@@ -fg Black -bg White -rv
1506
1507would yield White on Black, while on I<xterm>(1) it would yield Black on
1508White.
1509
1510=head2 ALPHA CHANNEL SUPPORT
1511
1512If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1513their act together, rxvt-unicode will do it's own alpha channel management:
1514
1515You can prefix any color with an opaquenes percentage enclosed in
1516brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1517(0-100) that specifies the opacity of the color, where C<0> is completely
1518transparent and C<100> is completely opaque. For example, C<[50]red> is a
1519half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1520is the recommended format to specify transparency values, and works with
1521all ways to specify a colour.
1522
1523For complete control, rxvt-unicode also supports
1524C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1525specifications, where the additional C<aaaa> component specifies opacity
1526(alpha) values. The minimum value of C<0000> is completely transparent,
1527while C<ffff> is completely opaque). The two example colours from
1528earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1529C<rgba:0000/ff00/0000/f332>.
1530
1531You probably need to specify B<"-depth 32">, too, to force a visual with
1532alpha channels, and have the luck that your X-server uses ARGB pixel
1533layout, as X is far from just supporting ARGB visuals out of the box, and
1534rxvt-unicode just fudges around.
1535
1536For example, the following selects an almost completely transparent black
1537background, and an almost opaque pink foreground:
1538
1539 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1540
1541When not using a background image, then the interpretation of the
1542alpha channel is up to your compositing manager (most interpret it as
1543transparency of course).
1544
1545When using a background pixmap or pseudo-transparency, then the background
1546colour will always behave as if it were completely transparent (so the
1547background image shows instead), regardless of how it was specified, while
1548other colours will either be transparent as specified (the background
1549image will show through) on servers supporting the RENDER extension, or
1550fully opaque on servers not supporting the RENDER EXTENSION.
1551
1552Please note that due to bugs in Xft, specifying alpha values might result
1553in garbage being displayed when the X-server does not support the RENDER
1554extension.
1555
1556=head1 ENVIRONMENT
1557
1558B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1559
1306=over 4 1560=over 4
1307 1561
1308=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1309
1310would yield White on Black, while on I<xterm>(1) it would yield Black
1311on White.
1312
1313=back
1314
1315=head1 ENVIRONMENT
1316
1317B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1318
1319=over 4
1320
1321=item B<TERM> 1562=item B<TERM>
1322 1563
1323Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1564Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1324resources or on the commandline. 1565resources or on the command line.
1325 1566
1326=item B<COLORTERM> 1567=item B<COLORTERM>
1327 1568
1328Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1569Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1329compiled with XPM support, and optionally with the added extension 1570compiled with background image support, and optionally with the added
1330C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1571extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1572screen.
1331 1573
1332=item B<COLORFGBG> 1574=item B<COLORFGBG>
1333 1575
1334Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1576Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1335the colour code used as default foreground/text colour (or the string 1577the colour code used as default foreground/text colour (or the string
1336C<default> to indicate that the default-colour escape sequence is to be 1578C<default> to indicate that the default-colour escape sequence is to be
1337used), C<bg> is the colour code used as default background colour (or the 1579used), C<bg> is the colour code used as default background colour (or the
1338string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1580string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1339was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1581was compiled with background image support. Libraries like C<ncurses>
1340(and do) use this information to optimize screen output. 1582and C<slang> can (and do) use this information to optimize screen output.
1341 1583
1342=item B<WINDOWID> 1584=item B<WINDOWID>
1343 1585
1344Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1586Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1345window, which usually has subwindows for the scrollbar, the terminal 1587window, which usually has subwindows for the scrollbar, the terminal
1351C<--with-terminfo=PATH>. 1593C<--with-terminfo=PATH>.
1352 1594
1353=item B<DISPLAY> 1595=item B<DISPLAY>
1354 1596
1355Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1597Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1356display in it's child processes. 1598display in its child processes if C<-display> isn't used to override. It
1599defaults to C<:0> if it doesn't exist.
1357 1600
1358=item B<SHELL> 1601=item B<SHELL>
1359 1602
1360The shell to be used for command execution, defaults to C</bin/sh>. 1603The shell to be used for command execution, defaults to C</bin/sh>.
1361
1362=item B<RXVTPATH>
1363
1364The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1365files.
1366
1367=item B<PATH>
1368
1369Used in the same way as C<RXVTPATH>.
1370 1604
1371=item B<RXVT_SOCKET> 1605=item B<RXVT_SOCKET>
1372 1606
1373The unix domain socket path used by @@RXVT_NAME@@c(1) and 1607The unix domain socket path used by @@RXVT_NAME@@c(1) and
1374@@RXVT_NAME@@d(1). 1608@@RXVT_NAME@@d(1).
1412 1646
1413=item Project Coordinator 1647=item Project Coordinator
1414 1648
1415Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1649Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1416 1650
1417L<http://software.schmorp.de/#rxvt-unicode> 1651L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1418 1652
1419=back 1653=back
1420 1654
1421=head1 AUTHORS 1655=head1 AUTHORS
1422 1656
1444 1678
1445Project Coordinator (changes.txt 2.21a to 2.4.5) 1679Project Coordinator (changes.txt 2.21a to 2.4.5)
1446 1680
1447=item Geoff Wing L<< <gcw@pobox.com> >> 1681=item Geoff Wing L<< <gcw@pobox.com> >>
1448 1682
1449Rewrote screen display and text selection routines. Project Coordinator 1683Rewrote screen display and text selection routines.
1684
1450(changes.txt 2.4.6 - rxvt-unicode) 1685Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1451 1686
1452=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1687=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1453 1688
1454Forked rxvt-unicode, rewrote most of the display code and internal 1689Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1455character handling to store text in unicode, improve xterm 1690extension, random hacks, numerous bugfixes and extensions.
1456compatibility and apply numerous other bugfixes and extensions.
1457 1691
1458Project Coordinator (Changes 1.0 -) 1692Project Coordinator (Changes 1.0 -)
1459 1693
1694=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1695
1696Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1697
1460=back 1698=back
1461 1699

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines