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.95 by root, Thu Jan 12 12:15:10 2006 UTC vs.
Revision 1.177 by root, Sun May 23 00:48:53 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 colours 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> - colour 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
481You can set and change the resources using X11 tools like B<xrdb>. Many 571You can set and change the resources using X11 tools like B<xrdb>. Many
482distribution do also load settings from the B<~/.Xresources> file when X 572distribution do also load settings from the B<~/.Xresources> file when X
483starts. @@RXVT_NAME@@ will consult the following files/resources in order, 573starts. @@RXVT_NAME@@ will consult the following files/resources in order,
484with later settings overwriting earlier ones: 574with later settings overwriting earlier ones:
486 1. system-wide app-defaults file, either locale-dependent OR global 576 1. system-wide app-defaults file, either locale-dependent OR global
487 2. app-defaults file in $XAPPLRESDIR 577 2. app-defaults file in $XAPPLRESDIR
488 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 578 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
489 4. SCREEN_RESOURCES for the current screen 579 4. SCREEN_RESOURCES for the current screen
490 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 580 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
581 6. resources specified via -xrm on the commandline
491 582
492Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 583Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
493names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 584names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
494common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily 585common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
495configured, while the class name B<URxvt> allows resources unique to 586configured, while the class name B<URxvt> allows resources unique to
500check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 591check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
501extensions not documented here): 592extensions not documented here):
502 593
503=over 4 594=over 4
504 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.
607
505=item B<geometry:> I<geom> 608=item B<geometry:> I<geom>
506 609
507Create the window with the specified X window geometry [default 80x24]; 610Create the window with the specified X window geometry [default 80x24];
508option B<-geometry>. 611option B<-geometry>.
509 612
522Use the specified colour for the colour value I<n>, where 0-7 625Use the specified colour for the colour value I<n>, where 0-7
523corresponds to low-intensity (normal) colours and 8-15 corresponds to 626corresponds to low-intensity (normal) colours and 8-15 corresponds to
524high-intensity (bold = bright foreground, blink = bright background) 627high-intensity (bold = bright foreground, blink = bright background)
525colours. The canonical names are as follows: 0=black, 1=red, 2=green, 628colours. The canonical names are as follows: 0=black, 1=red, 2=green,
5263=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 6293=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
527names used are listed in the B<COLORS AND GRAPHICS> section. 630names used are listed in the B<COLOURS AND GRAPHICS> section.
528 631
529Colours higher than 15 cannot be set using resources (yet), but can be 632Colours higher than 15 cannot be set using resources (yet), but can be
530changed using an escape command (see @@RXVT_NAME@@(7)). 633changed using an escape command (see @@RXVT_NAME@@(7)).
531 634
532Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 635Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
543=item B<colorUL:> I<colour> 646=item B<colorUL:> I<colour>
544 647
545Use the specified colour to display underlined characters when the 648Use the specified colour to display underlined characters when the
546foreground colour is the default. 649foreground colour is the default.
547 650
548=item B<colorRV:> I<colour>
549
550Use the specified colour as the background for reverse video
551characters.
552
553=item B<underlineColor:> I<colour> 651=item B<underlineColor:> I<colour>
554 652
555If set, use the specified colour as the colour for the underline 653If set, use the specified colour as the colour for the underline
556itself. If unset, use the foreground colour. 654itself. If unset, use the foreground colour.
655
656=item B<highlightColor:> I<colour>
657
658If set, use the specified colour as the background for highlighted
659characters. If unset, use reverse video.
660
661=item B<highlightTextColor:> I<colour>
662
663If set and highlightColor is set, use the specified colour as the
664foreground for highlighted characters.
557 665
558=item B<cursorColor:> I<colour> 666=item B<cursorColor:> I<colour>
559 667
560Use the specified colour for the cursor. The default is to use the 668Use the specified colour for the cursor. The default is to use the
561foreground colour; option B<-cr>. 669foreground colour; option B<-cr>.
568 676
569=item B<reverseVideo:> I<boolean> 677=item B<reverseVideo:> I<boolean>
570 678
571B<True>: simulate reverse video by foreground and background colours; 679B<True>: simulate reverse video by foreground and background colours;
572option B<-rv>. B<False>: regular screen colours [default]; option 680option B<-rv>. B<False>: regular screen colours [default]; option
573B<+rv>. See note in B<COLORS AND GRAPHICS> section. 681B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
574 682
575=item B<jumpScroll:> I<boolean> 683=item B<jumpScroll:> I<boolean>
576 684
577B<True>: specify that jump scrolling should be used. When scrolling 685B<True>: specify that jump scrolling should be used. When receiving lots
578quickly, fewer screen updates are performed [default]; option B<-j>. 686of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
687has been read, resulting in fewer updates while still displaying every
688received line; option B<-j>.
689
579B<False>: specify that smooth scrolling should be used; option B<+j>. 690B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
691force a screen refresh on each new line it received; option B<+j>.
580 692
581=item B<inheritPixmap:> I<boolean> 693=item B<skipScroll:> I<boolean>
582 694
583B<True>: make the background inherit the parent windows' pixmap, giving 695B<True>: (the default) specify that skip scrolling should be used. When
584artificial transparency. B<False>: do not inherit the parent windows' 696receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
585pixmap. 697(around 60 times per second), resulting in far fewer updates. This can
698result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
699option B<-ss>.
700
701B<False>: specify that everything is to be displayed, even
702if the refresh is too fast for the human eye to read anything (or the
703monitor to display anything); option B<+ss>.
704
705=item B<transparent:> I<boolean>
706
707Turn on/off illusion of a transparent window background.
708
709B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
710future versions.
711
712I<Please address all transparency related issues to Sasha Vasko at
713sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
586 714
587=item B<fading:> I<number> 715=item B<fading:> I<number>
588 716
589Fade the text by the given percentage when focus is lost; option B<-fade>. 717Fade the text by the given percentage when focus is lost; option B<-fade>.
590 718
598Tint the transparent background pixmap with the given colour; option 726Tint the transparent background pixmap with the given colour; option
599B<-tint>. 727B<-tint>.
600 728
601=item B<shading:> I<number> 729=item B<shading:> I<number>
602 730
603Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 731Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
604image in addition to tinting it. 732in addition to tinting it; option B<-sh>.
733
734=item B<blendType:> I<string>
735
736Specify background blending type; option B<-blt>.
737
738=item B<blurRadius:> I<number>
739
740Apply gaussian blur with the specified radius to the transparent
741background image; option B<-blr>.
742
743=item B<iconFile:> I<file>
744
745Set the application icon pixmap; option B<-icon>.
605 746
606=item B<scrollColor:> I<colour> 747=item B<scrollColor:> I<colour>
607 748
608Use the specified colour for the scrollbar [default #B2B2B2]. 749Use the specified colour for the scrollbar [default #B2B2B2].
609 750
615=item B<borderColor:> I<colour> 756=item B<borderColor:> I<colour>
616 757
617The colour of the border around the text area and between the scrollbar 758The colour of the border around the text area and between the scrollbar
618and the text. 759and the text.
619 760
620=item B<backgroundPixmap:> I<file[;geom]> 761=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
621 762
622Use the specified XPM file (note the `.xpm' extension is optional) for 763Use the specified image file for the background and also
623the background and also optionally specify its scaling with a geometry 764optionally specify its scaling with a geometry string B<WxH+X+Y>,
624string B<WxH+X+Y>, in which B<"W" / "H"> specify the 765(default C<0x0+50+50>) in which B<"W" / "H"> specify the
625horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 766horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
626centre (percent). A scale of 0 displays the image with tiling. A scale 767centre (percent). A scale of 0 displays the image with tiling. A scale
627of 1 displays the image without any scaling. A scale of 2 to 9 768of 1 displays the image without any scaling. A scale of 2 to 9 specifies
628specifies an integer number of images in that direction. No image will 769an integer number of images in that direction. No image will be magnified
629be magnified beyond 10 times its original size. The maximum permitted 770beyond 10 times its original size. The maximum permitted scale is 1000.
630scale is 1000. [default 0x0+50+50] 771Additional operations can be specified after colon B<:op1:op2...>.
772Supported operations are:
631 773
632=item B<menu:> I<file[;tag]> 774 tile force background image to be tiled and not scaled. Equivalent to 0x0
775 propscale will scale image keeping proportions
776 auto will scale image to match window size. Equivalent to 100x100
777 hscale will scale image horizontally to the window size
778 vscale will scale image vertically to the window size
779 scale will scale image to match window size
780 root will tile image as if it was a root window background, auto-adjusting
781 whenever terminal window moves
633 782
634Read in the specified menu file (note the `.menu' extension is 783If used in conjunction with B<-tr> option, the specified pixmap will be
635optional) and also optionally specify a starting tag to find. See the 784blended over transparency image using either alpha-blending, or any
636reference documentation for details on the syntax for the menuBar. 785other blending type, specified with B<-blt "type"> option.
637 786
638=item B<path:> I<path> 787=item B<path:> I<path>
639 788
640Specify the colon-delimited search path for finding files (XPM and 789Specify the colon-delimited search path for finding background image files.
641menus), in addition to the paths specified by the B<RXVTPATH> and
642B<PATH> environment variables.
643 790
644=item B<font:> I<fontlist> 791=item B<font:> I<fontlist>
645 792
646Select the fonts to be used. This is a comma separated list of font 793Select the fonts to be used. This is a comma separated list of font names
647names that are used in turn when trying to display Unicode characters. 794that are checked in order when trying to find glyphs for characters. The
648The first font defines the cell size for characters; other fonts might 795first font defines the cell size for characters; other fonts might be
649be smaller, but not larger. A reasonable default font list is always 796smaller, but not (in general) larger. A (hopefully) reasonable default
650appended to it; option B<-fn>. 797font list is always appended to it; option B<-fn>.
651 798
652Each font can either be a standard X11 core font (XLFD) name, with 799Each font can either be a standard X11 core font (XLFD) name, with
653optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 800optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
654 801
655In addition, each font can be prefixed with additional hints and 802In addition, each font can be prefixed with additional hints and
657hint currently is C<codeset=codeset-name>, and this is only used for Xft 804hint currently is C<codeset=codeset-name>, and this is only used for Xft
658fonts. 805fonts.
659 806
660For example, this font resource 807For example, this font resource
661 808
662 URxvt*font: 9x15bold,\ 809 URxvt.font: 9x15bold,\
663 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 810 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
664 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 811 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
665 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 812 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
666 xft:Code2000:antialias=false 813 xft:Code2000:antialias=false
667 814
670it is named first) and thus defines the character cell grid to be 9 pixels 817it is named first) and thus defines the character cell grid to be 9 pixels
671wide and 15 pixels high. 818wide and 15 pixels high.
672 819
673The second font is just used to add additional unicode characters not in 820The second font is just used to add additional unicode characters not in
674the base font, likewise the third, which is unfortunately non-bold, but 821the base font, likewise the third, which is unfortunately non-bold, but
675the bold version of the font does contain less characters, so this is a 822the bold version of the font does contain fewer characters, so this is a
676useful supplement. 823useful supplement.
677 824
678The third font is an Xft font with aliasing turned off, and the characters 825The third font is an Xft font with aliasing turned off, and the characters
679are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 826are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
680contains other characters, but we are not interested in them. 827contains other characters, but we are not interested in them.
704text font will being used for the given style. 851text font will being used for the given style.
705 852
706=item B<intensityStyles:> I<boolean> 853=item B<intensityStyles:> I<boolean>
707 854
708When font styles are not enabled, or this option is enabled (B<True>, 855When font styles are not enabled, or this option is enabled (B<True>,
709option B<-is>, the default), bold and italic font styles imply high 856option B<-is>, the default), bold/blink font styles imply high
710intensity foreground/backround colours. Disabling this option (B<False>, 857intensity foreground/background colours. Disabling this option (B<False>,
711option B<+is>) disables this behaviour, the high intensity colours are not 858option B<+is>) disables this behaviour, the high intensity colours are not
712reachable. 859reachable.
713
714=item B<selectstyle:> I<mode>
715
716Set mouse selection style to B<old> which is 2.20, B<oldword> which is
717xterm style with 2.20 old word selection, or anything else which gives
718xterm style selection.
719
720=item B<scrollstyle:> I<mode>
721
722Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
723the author's favourite.
724 860
725=item B<title:> I<string> 861=item B<title:> I<string>
726 862
727Set window title string, the default title is the command-line 863Set window title string, the default title is the command-line
728specified after the B<-e> option, if any, otherwise the application 864specified after the B<-e> option, if any, otherwise the application
737=item B<mapAlert:> I<boolean> 873=item B<mapAlert:> I<boolean>
738 874
739B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 875B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
740de-iconify (map) on receipt of a bell character [default]. 876de-iconify (map) on receipt of a bell character [default].
741 877
878=item B<urgentOnBell:> I<boolean>
879
880B<True>: set the urgency hint for the wm on receipt of a bell character.
881B<False>: do not set the urgency hint [default].
882
883@@RXVT_NAME@@ resets the urgency hint on every focus change.
884
742=item B<visualBell:> I<boolean> 885=item B<visualBell:> I<boolean>
743 886
744B<True>: use visual bell on receipt of a bell character; option B<-vb>. 887B<True>: use visual bell on receipt of a bell character; option B<-vb>.
745B<False>: no visual bell [default]; option B<+vb>. 888B<False>: no visual bell [default]; option B<+vb>.
746 889
764 907
765The string will be interpreted as if typed into the shell as-is. 908The string will be interpreted as if typed into the shell as-is.
766 909
767Example: 910Example:
768 911
769 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 912 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
770 913
771This creates a new file in your home directory with the screen contents 914This creates a new file in your home directory with the screen contents
772everytime you hit C<Print>. 915every time you hit C<Print>.
916
917=item B<scrollstyle:> I<mode>
918
919Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
920the author's favourite.
773 921
774=item B<scrollBar:> I<boolean> 922=item B<scrollBar:> I<boolean>
775 923
776B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 924B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
777disable the scrollbar; option B<+sb>. 925disable the scrollbar; option B<+sb>.
799 947
800=item B<scrollWithBuffer:> I<boolean> 948=item B<scrollWithBuffer:> I<boolean>
801 949
802B<True>: scroll with scrollback buffer when tty receives new lines (and 950B<True>: scroll with scrollback buffer when tty receives new lines (and
803B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 951B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
804with scrollback buffer when tty recieves new lines; option B<+sw>. 952with scrollback buffer when tty receives new lines; option B<+sw>.
805 953
806=item B<scrollTtyKeypress:> I<boolean> 954=item B<scrollTtyKeypress:> I<boolean>
807 955
808B<True>: scroll to bottom when a non-special key is pressed. Special keys 956B<True>: scroll to bottom when a non-special key is pressed. Special keys
809are those which are intercepted by rxvt-unicode for special handling and 957are those which are intercepted by rxvt-unicode for special handling and
840=item B<termName:> I<termname> 988=item B<termName:> I<termname>
841 989
842Specifies the terminal type name to be set in the B<TERM> environment 990Specifies the terminal type name to be set in the B<TERM> environment
843variable; option B<-tn>. 991variable; option B<-tn>.
844 992
845=item B<linespace:> I<number> 993=item B<lineSpace:> I<number>
846 994
847Specifies number of lines (pixel height) to insert between each row of 995Specifies number of lines (pixel height) to insert between each row of
848the display [default 0]; option B<-lsp>. 996the display [default 0]; option B<-lsp>.
849 997
850=item B<meta8:> I<boolean> 998=item B<meta8:> I<boolean>
864 1012
865=item B<cursorBlink:> I<boolean> 1013=item B<cursorBlink:> I<boolean>
866 1014
867B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 1015B<True>: blink the cursor. B<False>: do not blink the cursor [default];
868option B<-bc>. 1016option B<-bc>.
1017
1018=item B<cursorUnderline:> I<boolean>
1019
1020B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
1021option B<-uc>.
869 1022
870=item B<pointerBlank:> I<boolean> 1023=item B<pointerBlank:> I<boolean>
871 1024
872B<True>: blank the pointer when a key is pressed or after a set number 1025B<True>: blank the pointer when a key is pressed or after a set number
873of seconds of inactivity. B<False>: the pointer is always visible 1026of seconds of inactivity. B<False>: the pointer is always visible
899pressed. If unset it will send the sequence traditionally associated 1052pressed. If unset it will send the sequence traditionally associated
900with the B<Execute> key. 1053with the B<Execute> key.
901 1054
902=item B<cutchars:> I<string> 1055=item B<cutchars:> I<string>
903 1056
904The characters used as delimiters for double-click word selection. The 1057The characters used as delimiters for double-click word selection
905built-in default: 1058(whitespace delimiting is added automatically if resource is given).
906 1059
1060When the perl selection extension is in use (the default if compiled
1061in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
1062characters will be created (if the resource exists, otherwise, no regex
1063will be created). In this mode, characters outside ISO-8859-1 can be used.
1064
1065When the selection extension is not used, only ISO-8859-1 characters can
1066be used. If not specified, the built-in default is used:
1067
907B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1068B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
908 1069
909=item B<preeditType:> I<style> 1070=item B<preeditType:> I<style>
910 1071
911B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1072B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
912 1073
946default. (Note that many other terminals, including xterm, have these 1107default. (Note that many other terminals, including xterm, have these
947sequences enabled by default, which doesn't make it safer, though). 1108sequences enabled by default, which doesn't make it safer, though).
948 1109
949You can enable them by setting this boolean resource or specifying 1110You can enable them by setting this boolean resource or specifying
950B<-insecure> as an option. At the moment, this enables display-answer, 1111B<-insecure> as an option. At the moment, this enables display-answer,
951locale, findfont, icon label and window title requests as well as dynamic 1112locale, findfont, icon label and window title requests.
952menubar dispatch.
953 1113
954=item B<modifier:> I<modifier> 1114=item B<modifier:> I<modifier>
955 1115
956Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 1116Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
957B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 1117B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
961 1121
962Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1122Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
963character is passed through. It may contain escape values as described 1123character is passed through. It may contain escape values as described
964in the entry on B<keysym> following. 1124in the entry on B<keysym> following.
965 1125
966=item B<secondaryScreen:> I<bool> 1126=item B<secondaryScreen:> I<boolean>
967 1127
968Turn on/off secondary screen (default enabled). 1128Turn on/off secondary screen (default enabled).
969 1129
970=item B<secondaryScroll:> I<bool> 1130=item B<secondaryScroll:> I<boolean>
971 1131
972Turn on/off secondary screen scroll (default enabled). If the this 1132Turn on/off secondary screen scroll (default enabled). If this
973option is enabled, scrolls on the secondary screen will change the 1133option is enabled, scrolls on the secondary screen will change the
974scrollback buffer and switching to/from the secondary screen will 1134scrollback buffer and, when secondaryScreen is off, switching
975instead scroll the screen up. 1135to/from the secondary screen will instead scroll the screen up.
976 1136
977=item B<hold>: I<bool> 1137=item B<hold>: I<boolean>
978 1138
979Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1139Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
980will not immediately destroy its window when the program executed within 1140will not immediately destroy its window when the program executed within
981it exits. Instead, it will wait till it is being killed or closed by the 1141it exits. Instead, it will wait till it is being killed or closed by the
982user. 1142user.
1143
1144=item B<chdir>: I<path>
1145
1146Sets the working directory for the shell (or the command specified via
1147B<-e>). The I<path> must be an absolute path and it must exist for
1148@@RXVT_NAME@@ to start. If it isn't specified then the current working
1149directory will be used; option B<-cd>.
983 1150
984=item B<keysym.>I<sym>: I<string> 1151=item B<keysym.>I<sym>: I<string>
985 1152
986Compile I<frills>: Associate I<string> with keysym I<sym>. The 1153Compile I<frills>: Associate I<string> with keysym I<sym>. The
987intervening resource name B<keysym.> cannot be omitted. 1154intervening resource name B<keysym.> cannot be omitted.
1001searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1168searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1002omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1169omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1003keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1170keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1004performed in an exact manner; however, the closest match is assured. 1171performed in an exact manner; however, the closest match is assured.
1005 1172
1006I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1173I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1007C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1174number), see RESOURCES in C<man 7 X> for futher details.
1008C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1009C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1010can start or end with whitespace.
1011
1012Please note that you need to double the C<\> in resource files, as
1013Xlib itself does it's own de-escaping (you can use C<\033> instead of
1014C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1015processing).
1016 1175
1017You can define a range of keysyms in one shot by providing a I<string> 1176You can define a range of keysyms in one shot by providing a I<string>
1018with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1177with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1019should be a character not used by the strings. 1178should be a character not used by the strings.
1020 1179
1021Its usage can be demonstrated by an example: 1180Its usage can be demonstrated by an example:
1022 1181
1023 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1182 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1034when Control-Meta-c is being pressed": 1193when Control-Meta-c is being pressed":
1035 1194
1036 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1195 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1037 1196
1038If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1197If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1039is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1198is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1040manpage. For example, the F<selection> extension (activated via 1199manpage. For example, the F<selection> extension (activated via
1041C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1200C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1042 1201
1043 URxvt.keysym.M-C-c: perl:selection:rot13 1202 URxvt.keysym.M-C-c: perl:selection:rot13
1044 1203
1087example, C<default,-selection> will use all the default extension except 1246example, C<default,-selection> will use all the default extension except
1088C<selection>. 1247C<selection>.
1089 1248
1090Extension names can also be followed by an argument in angle brackets 1249Extension names can also be followed by an argument in angle brackets
1091(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1250(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1092searchable scorllback to Alt/Meta-s). Mentioning the same extension 1251searchable scrollback to Alt/Meta-s). Mentioning the same extension
1093multiple times with different arguments will pass multiple arguments to 1252multiple times with different arguments will pass multiple arguments to
1094the extension. 1253the extension.
1095 1254
1096Each extension is looked up in the library directories, loaded if 1255Each extension is looked up in the library directories, loaded if
1097necessary, and bound to the current terminal instance. 1256necessary, and bound to the current terminal instance.
1102all instances, while B<perl-ext> is used for specific instances. 1261all instances, while B<perl-ext> is used for specific instances.
1103 1262
1104=item B<perl-eval>: I<string> 1263=item B<perl-eval>: I<string>
1105 1264
1106Perl code to be evaluated when all extensions have been registered. See 1265Perl code to be evaluated when all extensions have been registered. See
1107the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1266the @@RXVT_NAME@@perl(3) manpage.
1108will be ignored when running setuid/setgid.
1109 1267
1110=item B<perl-lib>: I<path> 1268=item B<perl-lib>: I<path>
1111 1269
1112Colon-separated list of additional directories that hold extension 1270Colon-separated list of additional directories that hold extension
1113scripts. When looking for extensions specified by the C<perl> resource, 1271scripts. When looking for extensions specified by the C<perl> resource,
1114@@RXVT_NAME@@ will first look in these directories and then in 1272@@RXVT_NAME@@ will first look in these directories and then in
1115F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1273F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1116will be ignored when running setuid/setgid.
1117 1274
1118See the @@RXVT_NAME@@perl(3) manpage. 1275See the @@RXVT_NAME@@perl(3) manpage.
1119 1276
1120=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1277=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1121 1278
1133(default: C<M-s>). 1290(default: C<M-s>).
1134 1291
1135=item B<urlLauncher>: I<string> 1292=item B<urlLauncher>: I<string>
1136 1293
1137Specifies the program to be started with a URL argument. Used by the 1294Specifies the program to be started with a URL argument. Used by the
1138C<selection-popup> and C<mark-urls> perl extensions. 1295C<selection-popup> and C<matcher> perl extensions.
1139 1296
1140=item B<transient-for>: I<windowid> 1297=item B<transient-for>: I<windowid>
1141 1298
1142Sets the WM_TRANSIENT_FOR property to the given window iw. 1299Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1300
1301=item B<override-redirect>: I<boolean>
1302
1303Compile I<frills>: Sets override-redirect for the terminal window, making
1304it almost invisible to window managers; option B<-override-redirect>.
1305
1306=item B<iso14755:> I<boolean>
1307
1308Turn on/off ISO 14755 (default enabled).
1309
1310=item B<iso14755_52:> I<boolean>
1311
1312Turn on/off ISO 14755 5.2 mode (default enabled).
1143 1313
1144=back 1314=back
1145 1315
1146=head1 THE SCROLLBAR 1316=head1 THE SCROLLBAR
1147 1317
1166application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1336application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1167(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1337(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1168up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1338up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1169respectively. 1339respectively.
1170 1340
1171=head1 TEXT SELECTION AND INSERTION 1341=head1 THE SELECTION: SELECTING AND PASTING TEXT
1172 1342
1173The behaviour of text selection and insertion mechanism is similar to 1343The behaviour of text selection and insertion/pasting mechanism is similar
1174I<xterm>(1). 1344to I<xterm>(1).
1175 1345
1176=over 4 1346=over 4
1177 1347
1178=item B<Selection>: 1348=item B<Selecting>:
1179 1349
1180Left click at the beginning of the region, drag to the end of the region 1350Left click at the beginning of the region, drag to the end of the region
1181and release; Right click to extend the marked region; Left double-click 1351and release; Right click to extend the marked region; Left double-click
1182to select a word; Left triple-click to select the entire logical line 1352to select a word; Left triple-click to select the entire logical line
1183(which can span multiple screen lines), unless modified by resource 1353(which can span multiple screen lines), unless modified by resource
1187(Compile: I<frills>) will create a rectangular selection instead of a 1357(Compile: I<frills>) will create a rectangular selection instead of a
1188normal one. In this mode, every selected row becomes its own line in the 1358normal one. In this mode, every selected row becomes its own line in the
1189selection, and trailing whitespace is visually underlined and removed from 1359selection, and trailing whitespace is visually underlined and removed from
1190the selection. 1360the selection.
1191 1361
1192=item B<Insertion>: 1362=item B<Pasting>:
1193 1363
1194Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1364Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1195an B<@@RXVT_NAME@@> window causes the current text selection to be 1365window causes the value of the PRIMARY selection (or CLIPBOARD with the
1196inserted as if it had been typed on the keyboard. 1366B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1367
1368Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1369inserted too.
1197 1370
1198=back 1371=back
1199 1372
1200=head1 CHANGING FONTS 1373=head1 CHANGING FONTS
1201 1374
1202Changing fonts (or font sizes, respectively) via the keypad is not yet 1375Changing fonts (or font sizes, respectively) via the keypad is not yet
1203supported in rxvt-unicode. Bug me if you need this. 1376supported in rxvt-unicode. Bug me if you need this.
1204 1377
1205You can, however, switch fonts at runtime using escape sequences (and 1378You can, however, switch fonts at runtime using escape sequences, e.g.:
1206therefore using the menubar), e.g.:
1207 1379
1208 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1380 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1381
1382You can use keyboard shortcuts, too:
1383
1384 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1385 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1209 1386
1210rxvt-unicode will automatically re-apply these fonts to the output so far. 1387rxvt-unicode will automatically re-apply these fonts to the output so far.
1211 1388
1212=head1 ISO 14755 SUPPORT 1389=head1 ISO 14755 SUPPORT
1213 1390
1214ISO 14755 is a standard for entering and viewing unicode characters 1391ISO 14755 is a standard for entering and viewing unicode characters
1215and character codes using the keyboard. It consists of 4 parts. The 1392and character codes using the keyboard. It consists of 4 parts. The
1216first part is available rxvt-unicode has been compiled with 1393first part is available if rxvt-unicode has been compiled with
1217C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1394C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1218with C<--enable-iso14755>. 1395with C<--enable-iso14755>.
1219 1396
1220=over 4 1397=over 4
1221 1398
1241This mode lets you input characters representing the keycap symbols of 1418This mode lets you input characters representing the keycap symbols of
1242your keyboard, if representable in the current locale encoding. 1419your keyboard, if representable in the current locale encoding.
1243 1420
1244Start by pressing C<Control> and C<Shift> together, then releasing 1421Start by pressing C<Control> and C<Shift> together, then releasing
1245them. The next special key (cursor keys, home etc.) you enter will not 1422them. The next special key (cursor keys, home etc.) you enter will not
1246invoke it's usual function but instead will insert the corresponding 1423invoke its usual function but instead will insert the corresponding
1247keycap symbol. The symbol will only be entered when the key has been 1424keycap symbol. The symbol will only be entered when the key has been
1248released, otherwise pressing e.g. C<Shift> would enter the symbol for 1425released, otherwise pressing e.g. C<Shift> would enter the symbol for
1249C<ISO Level 2 Switch>, although your intention might have been to enter a 1426C<ISO Level 2 Switch>, although your intention might have been to enter a
1250reverse tab (Shift-Tab). 1427reverse tab (Shift-Tab).
1251 1428
1279B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1456B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1280it can be seen via the I<who(1)> command, and can accept messages. To 1457it can be seen via the I<who(1)> command, and can accept messages. To
1281allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1458allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1282on some systems or setgid to root or to some other group on others. 1459on some systems or setgid to root or to some other group on others.
1283 1460
1284=head1 COLORS AND GRAPHICS 1461=head1 COLOURS AND GRAPHICS
1285 1462
1286In addition to the default foreground and background colours, 1463In addition to the default foreground and background colours,
1287B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1464B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1288high-intensity bold/blink versions of the same). Here is a list of the 1465high-intensity bold/blink versions of the same). Here is a list of the
1289colours with their B<rgb.txt> names. 1466colours with their names.
1290 1467
1291=begin table 1468=begin table
1292 1469
1293 B<color0> (black) = Black 1470 B<color0> (black) = Black
1294 B<color1> (red) = Red3 1471 B<color1> (red) = Red3
1314It is also possible to specify the colour values of B<foreground>, 1491It is also possible to specify the colour values of B<foreground>,
1315B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1492B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1316a number 0-15, as a convenient shorthand to reference the colour name of 1493a number 0-15, as a convenient shorthand to reference the colour name of
1317color0-color15. 1494color0-color15.
1318 1495
1496In addition to the colours defined above, @@RXVT_NAME@@ offers an
1497additional 72 colours. The first 64 of those (with indices 16 to 79)
1498consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
149916>), followed by 8 additional shades of gray (with indices 80 to 87).
1500
1501Together, all those colours implement the 88 colour xterm colours. Only
1502the first 16 can be changed using resources currently, the rest can only
1503be changed via command sequences ("escape codes").
1504
1319Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1505Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1320always swapping the foreground/background colours. This is in contrast to 1506always swapping the foreground/background colours. This is in contrast to
1321I<xterm>(1) where the colours are only swapped if they have not otherwise 1507I<xterm>(1) where the colours are only swapped if they have not otherwise
1322been specified. For example, 1508been specified. For example,
1323 1509
1510 @@RXVT_NAME@@ -fg Black -bg White -rv
1511
1512would yield White on Black, while on I<xterm>(1) it would yield Black on
1513White.
1514
1515=head2 ALPHA CHANNEL SUPPORT
1516
1517If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1518their act together, rxvt-unicode will do it's own alpha channel management:
1519
1520You can prefix any colour with an opaquenes percentage enclosed in
1521brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1522(0-100) that specifies the opacity of the colour, where C<0> is completely
1523transparent and C<100> is completely opaque. For example, C<[50]red> is a
1524half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1525is the recommended format to specify transparency values, and works with
1526all ways to specify a colour.
1527
1528For complete control, rxvt-unicode also supports
1529C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1530specifications, where the additional C<aaaa> component specifies opacity
1531(alpha) values. The minimum value of C<0000> is completely transparent,
1532while C<ffff> is completely opaque). The two example colours from
1533earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1534C<rgba:0000/ff00/0000/f332>.
1535
1536You probably need to specify B<"-depth 32">, too, to force a visual with
1537alpha channels, and have the luck that your X-server uses ARGB pixel
1538layout, as X is far from just supporting ARGB visuals out of the box, and
1539rxvt-unicode just fudges around.
1540
1541For example, the following selects an almost completely transparent black
1542background, and an almost opaque pink foreground:
1543
1544 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1545
1546When not using a background image, then the interpretation of the
1547alpha channel is up to your compositing manager (most interpret it as
1548transparency of course).
1549
1550When using a background pixmap or pseudo-transparency, then the background
1551colour will always behave as if it were completely transparent (so the
1552background image shows instead), regardless of how it was specified, while
1553other colours will either be transparent as specified (the background
1554image will show through) on servers supporting the RENDER extension, or
1555fully opaque on servers not supporting the RENDER EXTENSION.
1556
1557Please note that due to bugs in Xft, specifying alpha values might result
1558in garbage being displayed when the X-server does not support the RENDER
1559extension.
1560
1561=head1 ENVIRONMENT
1562
1563B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1564
1324=over 4 1565=over 4
1325 1566
1326=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1327
1328would yield White on Black, while on I<xterm>(1) it would yield Black
1329on White.
1330
1331=back
1332
1333=head1 ENVIRONMENT
1334
1335B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1336
1337=over 4
1338
1339=item B<TERM> 1567=item B<TERM>
1340 1568
1341Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1569Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1342resources or on the commandline. 1570resources or on the command line.
1343 1571
1344=item B<COLORTERM> 1572=item B<COLORTERM>
1345 1573
1346Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1574Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1347compiled with XPM support, and optionally with the added extension 1575compiled with background image support, and optionally with the added
1348C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1576extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1577screen.
1349 1578
1350=item B<COLORFGBG> 1579=item B<COLORFGBG>
1351 1580
1352Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1581Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1353the colour code used as default foreground/text colour (or the string 1582the colour code used as default foreground/text colour (or the string
1354C<default> to indicate that the default-colour escape sequence is to be 1583C<default> to indicate that the default-colour escape sequence is to be
1355used), C<bg> is the colour code used as default background colour (or the 1584used), C<bg> is the colour code used as default background colour (or the
1356string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1585string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1357was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1586was compiled with background image support. Libraries like C<ncurses>
1358(and do) use this information to optimize screen output. 1587and C<slang> can (and do) use this information to optimize screen output.
1359 1588
1360=item B<WINDOWID> 1589=item B<WINDOWID>
1361 1590
1362Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1591Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1363window, which usually has subwindows for the scrollbar, the terminal 1592window, which usually has subwindows for the scrollbar, the terminal
1369C<--with-terminfo=PATH>. 1598C<--with-terminfo=PATH>.
1370 1599
1371=item B<DISPLAY> 1600=item B<DISPLAY>
1372 1601
1373Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1602Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1374display in it's child processes. 1603display in its child processes if C<-display> isn't used to override. It
1604defaults to C<:0> if it doesn't exist.
1375 1605
1376=item B<SHELL> 1606=item B<SHELL>
1377 1607
1378The shell to be used for command execution, defaults to C</bin/sh>. 1608The shell to be used for command execution, defaults to C</bin/sh>.
1379
1380=item B<RXVTPATH>
1381
1382The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1383files.
1384
1385=item B<PATH>
1386
1387Used in the same way as C<RXVTPATH>.
1388 1609
1389=item B<RXVT_SOCKET> 1610=item B<RXVT_SOCKET>
1390 1611
1391The unix domain socket path used by @@RXVT_NAME@@c(1) and 1612The unix domain socket path used by @@RXVT_NAME@@c(1) and
1392@@RXVT_NAME@@d(1). 1613@@RXVT_NAME@@d(1).
1414 1635
1415=over 4 1636=over 4
1416 1637
1417=item B</usr/lib/X11/rgb.txt> 1638=item B</usr/lib/X11/rgb.txt>
1418 1639
1419Color names. 1640Colour names.
1420 1641
1421=back 1642=back
1422 1643
1423=head1 SEE ALSO 1644=head1 SEE ALSO
1424 1645
1430 1651
1431=item Project Coordinator 1652=item Project Coordinator
1432 1653
1433Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1654Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1434 1655
1435L<http://software.schmorp.de/#rxvt-unicode> 1656L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1436 1657
1437=back 1658=back
1438 1659
1439=head1 AUTHORS 1660=head1 AUTHORS
1440 1661
1462 1683
1463Project Coordinator (changes.txt 2.21a to 2.4.5) 1684Project Coordinator (changes.txt 2.21a to 2.4.5)
1464 1685
1465=item Geoff Wing L<< <gcw@pobox.com> >> 1686=item Geoff Wing L<< <gcw@pobox.com> >>
1466 1687
1467Rewrote screen display and text selection routines. Project Coordinator 1688Rewrote screen display and text selection routines.
1689
1468(changes.txt 2.4.6 - rxvt-unicode) 1690Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1469 1691
1470=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1692=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1471 1693
1472Forked rxvt-unicode, rewrote most of the display code and internal 1694Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1473character handling to store text in unicode, improve xterm 1695extension, random hacks, numerous bugfixes and extensions.
1474compatibility and apply numerous other bugfixes and extensions.
1475 1696
1476Project Coordinator (Changes 1.0 -) 1697Project Coordinator (Changes 1.0 -)
1477 1698
1699=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1700
1701Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1702
1478=back 1703=back
1479 1704

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines