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.98 by root, Mon Jan 16 15:12:48 2006 UTC vs.
Revision 1.212 by sf-exg, Sun Jan 1 14:31:28 2012 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 pseudo-transparency by using the root pixmap as background; resource B<transparent>.
130
131B<-ip> is still accepted as an obsolete alias but will be removed in
132future versions.
114 133
115=item B<-fade> I<number> 134=item B<-fade> I<number>
116 135
117Fade the text by the given percentage when focus is lost. Small values 136Fade the text by the given percentage when focus is lost. Small values
118fade a little only, 100 completely replaces all colours by the fade 137fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>. 138colour; resource B<fading>.
120 139
121=item B<-fadecolor> I<colour> 140=item B<-fadecolor> I<colour>
122 141
123Fade to this colour when fading is used (see B<-fade>). The default colour 142Fade to this colour when fading is used (see B<-fade>). The default colour
124is black. resource B<fadeColor>. 143is opaque black. resource B<fadeColor>.
125 144
126=item B<-tint> I<colour> 145=item B<-tint> I<colour>
127 146
128Tint the transparent background pixmap with the given colour when 147Tint the transparent background with the given colour;
129transparency is enabled with B<-tr> or B<-ip>. This only works for 148resource I<tintColor>.
130non-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
132I<tintColor>. Example:
133 149
134 @@RXVT_NAME@@ -tr -tint blue -sh 40 150=item B<-sh> I<number>
135 151
136=item B<-sh>
137
138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 152Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
139background image in addition to tinting it (i.e. B<-tint> must be 153A value of 100 means no shading; resource I<shading>.
140specified, too, e.g. C<-tint white>). 154
155=item B<-blt> I<string>
156
157Specify background blending type. If background pixmap is specified
158at the same time as transparency - such pixmap will be blended over
159the transparent background, using the method specified. Supported values are:
160B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
161B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
162B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
163alpha-blending. Compile I<afterimage>; resource I<blendType>.
164
165=item B<-blr> I<HxV>
166
167Apply Gaussian Blur with the specified radii to the transparent
168background. If a single number is specified, the vertical and
169horizontal radii are considered to be the same. Setting one of the
170radii to 1 and the other to a large number creates interesting effects
171on some backgrounds. The maximum radius value is 128. An horizontal or
172vertical radius of 0 disables blurring;
173resource I<blurRadius>.
174
175=item B<-icon> I<file>
176
177Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
178is used by many window managers, taskbars and pagers to represent the
179application window; resource I<iconFile>.
141 180
142=item B<-bg> I<colour> 181=item B<-bg> I<colour>
143 182
144Window background colour; resource B<background>. 183Window background colour; resource B<background>.
145 184
146=item B<-fg> I<colour> 185=item B<-fg> I<colour>
147 186
148Window foreground colour; resource B<foreground>. 187Window foreground colour; resource B<foreground>.
149 188
150=item B<-pixmap> I<file[;geom]> 189=item B<-pixmap> I<file[;oplist]>
151 190
152Compile I<XPM>: Specify XPM file for the background and also optionally 191Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
153specify its scaling with a geometry string. Note you may need to 192optionally specify a list of operations to modify it. Note you may need to
154add quotes to avoid special shell interpretation of the C<;> in the 193add quotes to avoid special shell interpretation of the C<;> in the
155command-line; resource B<backgroundPixmap>. 194command-line; for more details see resource B<backgroundPixmap>.
156 195
157=item B<-cr> I<colour> 196=item B<-cr> I<colour>
158 197
159The cursor colour; resource B<cursorColor>. 198The cursor colour; resource B<cursorColor>.
160 199
177that are checked in order when trying to find glyphs for characters. The 216that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 217first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 218smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 219font list is always appended to it. See resource B<font> for more details.
181 220
182In short, to specify an X11 core font, just specify it's name or prefix it 221In 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:>, 222with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184e.g.: 223e.g.:
185 224
186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 225 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 226 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
205italic> >> characters are to be printed. See resource B<boldItalicFont> 244italic> >> characters are to be printed. See resource B<boldItalicFont>
206for details. 245for details.
207 246
208=item B<-is>|B<+is> 247=item B<-is>|B<+is>
209 248
210Compile I<font-styles>: Bold/Italic font styles imply high intensity 249Compile I<font-styles>: Bold/Blink font styles imply high intensity
211foreground/background (default). See resource B<intensityStyles> for 250foreground/background (default). See resource B<intensityStyles> for
212details. 251details.
213 252
214=item B<-name> I<name> 253=item B<-name> I<name>
215 254
233 272
234=item B<-sb>|B<+sb> 273=item B<-sb>|B<+sb>
235 274
236Turn on/off scrollbar; resource B<scrollBar>. 275Turn on/off scrollbar; resource B<scrollBar>.
237 276
277=item B<-sr>|B<+sr>
278
279Put scrollbar on right/left; resource B<scrollBar_right>.
280
281=item B<-st>|B<+st>
282
283Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
284resource B<scrollBar_floating>.
285
238=item B<-si>|B<+si> 286=item B<-si>|B<+si>
239 287
240Turn on/off scroll-to-bottom on TTY output inhibit; resource 288Turn on/off scroll-to-bottom on TTY output inhibit; resource
241B<scrollTtyOutput> has opposite effect. 289B<scrollTtyOutput> has opposite effect.
242 290
248=item B<-sw>|B<+sw> 296=item B<-sw>|B<+sw>
249 297
250Turn on/off scrolling with the scrollback buffer as new lines appear. 298Turn on/off scrolling with the scrollback buffer as new lines appear.
251This only takes effect if B<-si> is also given; resource 299This only takes effect if B<-si> is also given; resource
252B<scrollWithBuffer>. 300B<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 301
263=item B<-ptab>|B<+ptab> 302=item B<-ptab>|B<+ptab>
264 303
265If enabled (default), "Horizontal Tab" characters are being stored as 304If enabled (default), "Horizontal Tab" characters are being stored as
266actual wide characters in the screen buffer, which makes it possible to 305actual wide characters in the screen buffer, which makes it possible to
270 309
271=item B<-bc>|B<+bc> 310=item B<-bc>|B<+bc>
272 311
273Blink the cursor; resource B<cursorBlink>. 312Blink the cursor; resource B<cursorBlink>.
274 313
314=item B<-uc>|B<+uc>
315
316Make the cursor underlined; resource B<cursorUnderline>.
317
275=item B<-iconic> 318=item B<-iconic>
276 319
277Start iconified, if the window manager supports that option. 320Start iconified, if the window manager supports that option.
278Alternative form is B<-ic>. 321Alternative form is B<-ic>.
279 322
295 338
296=item B<-bl> 339=item B<-bl>
297 340
298Compile I<frills>: Set MWM hints to request a borderless window, i.e. 341Compile 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 342if honoured by the WM, the rxvt-unicode window will not have window
300decorations; resource B<borderLess>. 343decorations; resource B<borderLess>. If the window manager does not
344support MWM hints (e.g. kwin), enables override-redirect mode.
345
346=item B<-override-redirect>
347
348Compile I<frills>: Sets override-redirect on the window; resource
349B<override-redirect>.
301 350
302=item B<-sbg> 351=item B<-sbg>
303 352
304Compile I<frills>: Disable the usage of the built-in block graphics/line 353Compile I<frills>: Disable the usage of the built-in block graphics/line
305drawing characters and just rely on what the specified fonts provide. Use 354drawing characters and just rely on what the specified fonts provide. Use
308 357
309=item B<-lsp> I<number> 358=item B<-lsp> I<number>
310 359
311Compile I<frills>: Lines (pixel height) to insert between each row of 360Compile I<frills>: Lines (pixel height) to insert between each row of
312the display. Useful to work around font rendering problems; resource 361the display. Useful to work around font rendering problems; resource
313B<linespace>. 362B<lineSpace>.
363
364=item B<-letsp> I<number>
365
366Compile I<frills>: Amount to adjust the computed character width by
367to control overall letter spacing. Negative values will tighten up the
368letter spacing, positive values will space letters out more. Useful to
369work around odd font metrics; resource B<letterSpace>.
314 370
315=item B<-tn> I<termname> 371=item B<-tn> I<termname>
316 372
317This option specifies the name of the terminal type to be set in the 373This option specifies the name of the terminal type to be set in the
318B<TERM> environment variable. This terminal type must exist in the 374B<TERM> environment variable. This terminal type must exist in the
372for more info. 428for more info.
373 429
374=item B<-tcw> 430=item B<-tcw>
375 431
376Change the meaning of triple-click selection with the left mouse 432Change the meaning of triple-click selection with the left mouse
433button. Only effective when the original (non-perl) selection code is
377button. Instead of selecting a full line it will extend the selection the 434in-use. Instead of selecting a full line it will extend the selection to
378end of the logical line only. resource B<tripleclickwords>. 435the end of the logical line only. resource B<tripleclickwords>.
379 436
380=item B<-insecure> 437=item B<-insecure>
381 438
382Enable "insecure" mode, which currently enables most of the escape 439Enable "insecure" mode, which currently enables most of the escape
383sequences that echo strings. See the resource B<insecure> for more 440sequences that echo strings. See the resource B<insecure> for more
404Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 461Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
405will not immediately destroy its window when the program executed within 462will 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 463it exits. Instead, it will wait till it is being killed or closed by the
407user; resource B<hold>. 464user; resource B<hold>.
408 465
466=item B<-cd> I<path>
467
468Sets the working directory for the shell (or the command specified via
469B<-e>). The I<path> must be an absolute path and it must exist for
470@@RXVT_NAME@@ to start; resource B<chdir>.
471
472=item B<-xrm> I<string>
473
474Works like the X Toolkit option of the same name, by adding the I<string>
475as if it were specified in a resource file. Resource values specified this
476way take precedence over all other resource specifications.
477
478Note that you need to use the I<same> syntax as in the .Xdefaults file,
479e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
480options can be specified as long-options on the commandline, so use
481of B<-xrm> is mostly limited to cases where you want to specify other
482resources (e.g. for input methods) or for compatibility with other
483programs.
484
409=item B<-keysym.>I<sym> I<string> 485=item B<-keysym.>I<sym> I<string>
410 486
411Remap a key symbol. See resource B<keysym>. 487Remap a key symbol. See resource B<keysym>.
412 488
413=item B<-embed> I<windowid> 489=item B<-embed> I<windowid>
414 490
415Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 491Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
416which enables applications to easily embed a terminal. 492which enables applications to easily embed a terminal.
417 493
418Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 494Right 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 495shouldn'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 496quite 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. 499The window will not be destroyed when @@RXVT_NAME@@ exits.
424 500
425It might be useful to know that @@RXVT_NAME@@ will not close file 501It 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 502descriptors passed to it (except for stdin/out/err, of course), so you
427can use file descriptors to communicate with the programs within the 503can use file descriptors to communicate with the programs within the
428terminal. This works regardless of wether the C<-embed> option was used or 504terminal. This works regardless of whether the C<-embed> option was used or
429not. 505not.
430 506
431Here is a short Gtk2-perl snippet that illustrates how this option can be 507Here is a short Gtk2-perl snippet that illustrates how this option can be
432used (a longer example is in F<doc/embed>): 508used (a longer example is in F<doc/embed>):
433 509
438 }); 514 });
439 515
440=item B<-pty-fd> I<file descriptor> 516=item B<-pty-fd> I<file descriptor>
441 517
442Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 518Tells @@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 519pair 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 520useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
445without having to run a program within it. 521without having to run a program within it.
446 522
447If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 523If 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 524entries and will not tinker with pty/tty permissions - you have to do that
449yourself if you want that. 525yourself if you want that.
450 526
451As an extremely special case, specifying C<-1> will completely suppress 527As an extremely special case, specifying C<-1> will completely suppress
452pty/tty operations. 528pty/tty operations, which is probably only useful in conjunction with some
529perl extension that manages the terminal.
453 530
454Here is a example in perl that illustrates how this option can be used (a 531Here is a example in perl that illustrates how this option can be used (a
455longer example is in F<doc/pty-fd>): 532longer example is in F<doc/pty-fd>):
456 533
457 use IO::Pty; 534 use IO::Pty;
471Comma-separated list of perl extension scripts to use (or not to use) in 548Comma-separated list of perl extension scripts to use (or not to use) in
472this terminal instance. See resource B<perl-ext> for details. 549this terminal instance. See resource B<perl-ext> for details.
473 550
474=back 551=back
475 552
476=head1 RESOURCES (available also as long-options) 553=head1 RESOURCES
477 554
478Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 555Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
479options) compiled into your version. 556options) compiled into your version. All resources are also available as
557long-options.
480 558
481You can set and change the resources using X11 tools like B<xrdb>. Many 559You 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 560distribution do also load settings from the B<~/.Xresources> file when X
483starts. @@RXVT_NAME@@ will consult the following files/resources in order, 561starts. @@RXVT_NAME@@ will consult the following files/resources in order,
484with later settings overwriting earlier ones: 562with later settings overwriting earlier ones:
485 563
486 1. system-wide app-defaults file, either locale-dependent OR global
487 2. app-defaults file in $XAPPLRESDIR 564 1. app-defaults file in $XAPPLRESDIR
565 2. $HOME/.Xdefaults
488 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 566 3. RESOURCE_MANAGER property on root-window of screen 0
489 4. SCREEN_RESOURCES for the current screen 567 4. SCREEN_RESOURCES property on root-window of the current screen
490 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 568 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
569 6. resources specified via -xrm on the commandline
491 570
492Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 571Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
493names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 572names: 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 573common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
495configured, while the class name B<URxvt> allows resources unique to 574configured, while the class name B<URxvt> allows resources unique to
500check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 579check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
501extensions not documented here): 580extensions not documented here):
502 581
503=over 4 582=over 4
504 583
584=item B<depth:> I<bitdepth>
585
586Compile I<xft>: Attempt to find a visual with the given bit depth;
587option B<-depth>.
588
589=item B<buffered:> I<boolean>
590
591Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
592On some card/driver combination enabling it slightly decreases
593performance, on most it greatly helps it. The slowdown is small, so it
594should normally be enabled.
595
505=item B<geometry:> I<geom> 596=item B<geometry:> I<geom>
506 597
507Create the window with the specified X window geometry [default 80x24]; 598Create the window with the specified X window geometry [default 80x24];
508option B<-geometry>. 599option B<-geometry>.
509 600
522Use the specified colour for the colour value I<n>, where 0-7 613Use the specified colour for the colour value I<n>, where 0-7
523corresponds to low-intensity (normal) colours and 8-15 corresponds to 614corresponds to low-intensity (normal) colours and 8-15 corresponds to
524high-intensity (bold = bright foreground, blink = bright background) 615high-intensity (bold = bright foreground, blink = bright background)
525colours. The canonical names are as follows: 0=black, 1=red, 2=green, 616colours. 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 6173=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
527names used are listed in the B<COLORS AND GRAPHICS> section. 618names used are listed in the B<COLOURS AND GRAPHICS> section.
528 619
529Colours higher than 15 cannot be set using resources (yet), but can be 620Colours higher than 15 cannot be set using resources (yet), but can be
530changed using an escape command (see @@RXVT_NAME@@(7)). 621changed using an escape command (see @@RXVT_NAME@@(7)).
531 622
532Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 623Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
543=item B<colorUL:> I<colour> 634=item B<colorUL:> I<colour>
544 635
545Use the specified colour to display underlined characters when the 636Use the specified colour to display underlined characters when the
546foreground colour is the default. 637foreground colour is the default.
547 638
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> 639=item B<underlineColor:> I<colour>
554 640
555If set, use the specified colour as the colour for the underline 641If set, use the specified colour as the colour for the underline
556itself. If unset, use the foreground colour. 642itself. If unset, use the foreground colour.
643
644=item B<highlightColor:> I<colour>
645
646If set, use the specified colour as the background for highlighted
647characters. If unset, use reverse video.
648
649=item B<highlightTextColor:> I<colour>
650
651If set and highlightColor is set, use the specified colour as the
652foreground for highlighted characters.
557 653
558=item B<cursorColor:> I<colour> 654=item B<cursorColor:> I<colour>
559 655
560Use the specified colour for the cursor. The default is to use the 656Use the specified colour for the cursor. The default is to use the
561foreground colour; option B<-cr>. 657foreground colour; option B<-cr>.
568 664
569=item B<reverseVideo:> I<boolean> 665=item B<reverseVideo:> I<boolean>
570 666
571B<True>: simulate reverse video by foreground and background colours; 667B<True>: simulate reverse video by foreground and background colours;
572option B<-rv>. B<False>: regular screen colours [default]; option 668option B<-rv>. B<False>: regular screen colours [default]; option
573B<+rv>. See note in B<COLORS AND GRAPHICS> section. 669B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
574 670
575=item B<jumpScroll:> I<boolean> 671=item B<jumpScroll:> I<boolean>
576 672
577B<True>: specify that jump scrolling should be used. When scrolling 673B<True>: specify that jump scrolling should be used. When receiving lots
578quickly, fewer screen updates are performed [default]; option B<-j>. 674of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
675has been read, resulting in fewer updates while still displaying every
676received line; option B<-j>.
677
579B<False>: specify that smooth scrolling should be used; option B<+j>. 678B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
679force a screen refresh on each new line it received; option B<+j>.
580 680
581=item B<inheritPixmap:> I<boolean> 681=item B<skipScroll:> I<boolean>
582 682
583B<True>: make the background inherit the parent windows' pixmap, giving 683B<True>: (the default) specify that skip scrolling should be used. When
584artificial transparency. B<False>: do not inherit the parent windows' 684receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
585pixmap. 685(around 60 times per second), resulting in far fewer updates. This can
686result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
687option B<-ss>.
688
689B<False>: specify that everything is to be displayed, even
690if the refresh is too fast for the human eye to read anything (or the
691monitor to display anything); option B<+ss>.
692
693=item B<transparent:> I<boolean>
694
695Turn on/off pseudo-transparency by using the root pixmap as background.
696
697B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
698future versions.
586 699
587=item B<fading:> I<number> 700=item B<fading:> I<number>
588 701
589Fade the text by the given percentage when focus is lost; option B<-fade>. 702Fade the text by the given percentage when focus is lost; option B<-fade>.
590 703
593Fade to this colour, when fading is used (see B<fading:>). The default 706Fade to this colour, when fading is used (see B<fading:>). The default
594colour is black; option B<-fadecolor>. 707colour is black; option B<-fadecolor>.
595 708
596=item B<tintColor:> I<colour> 709=item B<tintColor:> I<colour>
597 710
598Tint the transparent background pixmap with the given colour; option 711Tint the transparent background with the given colour. If the RENDER
599B<-tint>. 712extension is not available only black, red, green, yellow, blue,
713magenta, cyan and white tints can be performed server-side. Note that
714a black tint yields a completely black image while a white tint yields
715the image unchanged; option B<-tint>.
600 716
601=item B<shading:> I<number> 717=item B<shading:> I<number>
602 718
603Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 719Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
604image in addition to tinting it. 720A value of 100 means no shading; option B<-sh>.
721
722=item B<blendType:> I<string>
723
724Specify background blending type; option B<-blt>.
725
726=item B<blurRadius:> I<number>
727
728Apply gaussian blur with the specified radius to the transparent
729background; option B<-blr>.
730
731=item B<iconFile:> I<file>
732
733Set the application icon pixmap; option B<-icon>.
605 734
606=item B<scrollColor:> I<colour> 735=item B<scrollColor:> I<colour>
607 736
608Use the specified colour for the scrollbar [default #B2B2B2]. 737Use the specified colour for the scrollbar [default #B2B2B2].
609 738
615=item B<borderColor:> I<colour> 744=item B<borderColor:> I<colour>
616 745
617The colour of the border around the text area and between the scrollbar 746The colour of the border around the text area and between the scrollbar
618and the text. 747and the text.
619 748
620=item B<backgroundPixmap:> I<file[;geom]> 749=item B<backgroundPixmap:> I<file[;oplist]>
621 750
622Use the specified XPM file (note the `.xpm' extension is optional) for 751Use the specified image file for the background and also
623the background and also optionally specify its scaling with a geometry 752optionally specify a colon separated list of operations to modify it.
624string B<WxH+X+Y>, in which B<"W" / "H"> specify the 753Supported operations are:
625horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 754
626centre (percent). A scale of 0 displays the image with tiling. A scale 755=over 4
627of 1 displays the image without any scaling. A scale of 2 to 9 756
628specifies an integer number of images in that direction. No image will 757=item B<WxH+X+Y>
629be magnified beyond 10 times its original size. The maximum permitted 758
630scale is 1000. [default 0x0+50+50] 759sets scale and position. B<"W" / "H"> specify the horizontal/vertical
760scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
761scale of 0 disables scaling. The maximum permitted scale is 1000.
762
763=item B<op=tile>
764
765enables tiling
766
767=item B<op=keep-aspect>
768
769maintain the image aspect ratio when scaling
770
771=item B<op=root-align>
772
773use the position of the terminal window relative to the root window as
774the image offset, simulating a root window background
775
776=back
777
778The default scale and position setting is C<100x100+50+50>.
779Alternatively, a predefined set of templates can be used to achieve
780the most common setups:
781
782=over 4
783
784=item B<style=tiled>
785
786the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
787
788=item B<style=aspect-stretched>
789
790the image is scaled to fill the whole window maintaining the aspect
791ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
792
793=item B<style=stretched>
794
795the image is scaled to fill the whole window. Equivalent to 100x100
796
797=item B<style=centered>
798
799the image is centered with no scaling. Equivalent to 0x0+50+50
800
801=item B<style=root-tiled>
802
803the image is tiled with no scaling and using 'root' positioning.
804Equivalent to 0x0:op=tile:op=root-align
805
806=back
807
808If multiple templates are specified the last one wins. Note that a
809template overrides all the scale, position and operations settings.
810
811If used in conjunction with B<-tr> option, the specified pixmap will be
812blended over the transparent background using alpha-blending. If I<afterimage>
813support has been compiled in it is possible to choose other blending
814types with B<-blt "type"> option.
631 815
632=item B<path:> I<path> 816=item B<path:> I<path>
633 817
634Specify the colon-delimited search path for finding XPM files. 818Specify the colon-delimited search path for finding background image files.
635 819
636=item B<font:> I<fontlist> 820=item B<font:> I<fontlist>
637 821
638Select the fonts to be used. This is a comma separated list of font names 822Select the fonts to be used. This is a comma separated list of font names
639that are checked in order when trying to find glyphs for characters. The 823that are checked in order when trying to find glyphs for characters. The
662it is named first) and thus defines the character cell grid to be 9 pixels 846it is named first) and thus defines the character cell grid to be 9 pixels
663wide and 15 pixels high. 847wide and 15 pixels high.
664 848
665The second font is just used to add additional unicode characters not in 849The second font is just used to add additional unicode characters not in
666the base font, likewise the third, which is unfortunately non-bold, but 850the base font, likewise the third, which is unfortunately non-bold, but
667the bold version of the font does contain less characters, so this is a 851the bold version of the font does contain fewer characters, so this is a
668useful supplement. 852useful supplement.
669 853
670The third font is an Xft font with aliasing turned off, and the characters 854The third font is an Xft font with aliasing turned off, and the characters
671are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 855are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
672contains other characters, but we are not interested in them. 856contains other characters, but we are not interested in them.
696text font will being used for the given style. 880text font will being used for the given style.
697 881
698=item B<intensityStyles:> I<boolean> 882=item B<intensityStyles:> I<boolean>
699 883
700When font styles are not enabled, or this option is enabled (B<True>, 884When font styles are not enabled, or this option is enabled (B<True>,
701option B<-is>, the default), bold and italic font styles imply high 885option B<-is>, the default), bold/blink font styles imply high
702intensity foreground/backround colours. Disabling this option (B<False>, 886intensity foreground/background colours. Disabling this option (B<False>,
703option B<+is>) disables this behaviour, the high intensity colours are not 887option B<+is>) disables this behaviour, the high intensity colours are not
704reachable. 888reachable.
705
706=item B<selectstyle:> I<mode>
707
708Set mouse selection style to B<old> which is 2.20, B<oldword> which is
709xterm style with 2.20 old word selection, or anything else which gives
710xterm style selection.
711
712=item B<scrollstyle:> I<mode>
713
714Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
715the author's favourite.
716 889
717=item B<title:> I<string> 890=item B<title:> I<string>
718 891
719Set window title string, the default title is the command-line 892Set window title string, the default title is the command-line
720specified after the B<-e> option, if any, otherwise the application 893specified after the B<-e> option, if any, otherwise the application
729=item B<mapAlert:> I<boolean> 902=item B<mapAlert:> I<boolean>
730 903
731B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 904B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
732de-iconify (map) on receipt of a bell character [default]. 905de-iconify (map) on receipt of a bell character [default].
733 906
907=item B<urgentOnBell:> I<boolean>
908
909B<True>: set the urgency hint for the wm on receipt of a bell character.
910B<False>: do not set the urgency hint [default].
911
912@@RXVT_NAME@@ resets the urgency hint on every focus change.
913
734=item B<visualBell:> I<boolean> 914=item B<visualBell:> I<boolean>
735 915
736B<True>: use visual bell on receipt of a bell character; option B<-vb>. 916B<True>: use visual bell on receipt of a bell character; option B<-vb>.
737B<False>: no visual bell [default]; option B<+vb>. 917B<False>: no visual bell [default]; option B<+vb>.
738 918
759Example: 939Example:
760 940
761 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 941 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
762 942
763This creates a new file in your home directory with the screen contents 943This creates a new file in your home directory with the screen contents
764everytime you hit C<Print>. 944every time you hit C<Print>.
945
946=item B<scrollstyle:> I<mode>
947
948Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
949the author's favourite.
950
951=item B<thickness:> I<number>
952
953Set the scrollbar width in pixels.
765 954
766=item B<scrollBar:> I<boolean> 955=item B<scrollBar:> I<boolean>
767 956
768B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 957B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
769disable the scrollbar; option B<+sb>. 958disable the scrollbar; option B<+sb>.
789B<False>: do not scroll to bottom when tty receives output; option 978B<False>: do not scroll to bottom when tty receives output; option
790B<+si>. 979B<+si>.
791 980
792=item B<scrollWithBuffer:> I<boolean> 981=item B<scrollWithBuffer:> I<boolean>
793 982
794B<True>: scroll with scrollback buffer when tty receives new lines (and 983B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
795B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 984try to show the same lines) and B<scrollTtyOutput> is False; option
796with scrollback buffer when tty recieves new lines; option B<+sw>. 985B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
986new lines; option B<+sw>.
797 987
798=item B<scrollTtyKeypress:> I<boolean> 988=item B<scrollTtyKeypress:> I<boolean>
799 989
800B<True>: scroll to bottom when a non-special key is pressed. Special keys 990B<True>: scroll to bottom when a non-special key is pressed. Special keys
801are those which are intercepted by rxvt-unicode for special handling and 991are those which are intercepted by rxvt-unicode for special handling and
832=item B<termName:> I<termname> 1022=item B<termName:> I<termname>
833 1023
834Specifies the terminal type name to be set in the B<TERM> environment 1024Specifies the terminal type name to be set in the B<TERM> environment
835variable; option B<-tn>. 1025variable; option B<-tn>.
836 1026
837=item B<linespace:> I<number> 1027=item B<lineSpace:> I<number>
838 1028
839Specifies number of lines (pixel height) to insert between each row of 1029Specifies number of lines (pixel height) to insert between each row of
840the display [default 0]; option B<-lsp>. 1030the display [default 0]; option B<-lsp>.
841 1031
842=item B<meta8:> I<boolean> 1032=item B<meta8:> I<boolean>
856 1046
857=item B<cursorBlink:> I<boolean> 1047=item B<cursorBlink:> I<boolean>
858 1048
859B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 1049B<True>: blink the cursor. B<False>: do not blink the cursor [default];
860option B<-bc>. 1050option B<-bc>.
1051
1052=item B<cursorUnderline:> I<boolean>
1053
1054B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
1055option B<-uc>.
861 1056
862=item B<pointerBlank:> I<boolean> 1057=item B<pointerBlank:> I<boolean>
863 1058
864B<True>: blank the pointer when a key is pressed or after a set number 1059B<True>: blank the pointer when a key is pressed or after a set number
865of seconds of inactivity. B<False>: the pointer is always visible 1060of seconds of inactivity. B<False>: the pointer is always visible
879large number (e.g. C<987654321>) to effectively disable the timeout. 1074large number (e.g. C<987654321>) to effectively disable the timeout.
880 1075
881=item B<backspacekey:> I<string> 1076=item B<backspacekey:> I<string>
882 1077
883The string to send when the backspace key is pressed. If set to B<DEC> 1078The string to send when the backspace key is pressed. If set to B<DEC>
884or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 1079or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
885(code 8) - which can be reversed with the appropriate DEC private mode 1080(code 8) - which can be reversed with the appropriate DEC private mode
886escape sequence. 1081escape sequence.
887 1082
888=item B<deletekey:> I<string> 1083=item B<deletekey:> I<string>
889 1084
891pressed. If unset it will send the sequence traditionally associated 1086pressed. If unset it will send the sequence traditionally associated
892with the B<Execute> key. 1087with the B<Execute> key.
893 1088
894=item B<cutchars:> I<string> 1089=item B<cutchars:> I<string>
895 1090
896The characters used as delimiters for double-click word selection. The 1091The characters used as delimiters for double-click word selection
897built-in default: 1092(whitespace delimiting is added automatically if resource is given).
898 1093
1094When the perl selection extension is in use (the default if compiled
1095in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
1096characters will be created (if the resource exists, otherwise, no regex
1097will be created). In this mode, characters outside ISO-8859-1 can be used.
1098
1099When the selection extension is not used, only ISO-8859-1 characters can
1100be used. If not specified, the built-in default is used:
1101
899B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1102B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
900 1103
901=item B<preeditType:> I<style> 1104=item B<preeditType:> I<style>
902 1105
903B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1106B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
904 1107
952 1155
953Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1156Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
954character is passed through. It may contain escape values as described 1157character is passed through. It may contain escape values as described
955in the entry on B<keysym> following. 1158in the entry on B<keysym> following.
956 1159
957=item B<secondaryScreen:> I<bool> 1160=item B<secondaryScreen:> I<boolean>
958 1161
959Turn on/off secondary screen (default enabled). 1162Turn on/off secondary screen (default enabled).
960 1163
961=item B<secondaryScroll:> I<bool> 1164=item B<secondaryScroll:> I<boolean>
962 1165
963Turn on/off secondary screen scroll (default enabled). If the this 1166Turn on/off secondary screen scroll (default enabled). If this
964option is enabled, scrolls on the secondary screen will change the 1167option is enabled, scrolls on the secondary screen will change the
965scrollback buffer and switching to/from the secondary screen will 1168scrollback buffer and, when secondaryScreen is off, switching
966instead scroll the screen up. 1169to/from the secondary screen will instead scroll the screen up.
967 1170
968=item B<hold>: I<bool> 1171=item B<hold>: I<boolean>
969 1172
970Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1173Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
971will not immediately destroy its window when the program executed within 1174will not immediately destroy its window when the program executed within
972it exits. Instead, it will wait till it is being killed or closed by the 1175it exits. Instead, it will wait till it is being killed or closed by the
973user. 1176user.
1177
1178=item B<chdir>: I<path>
1179
1180Sets the working directory for the shell (or the command specified via
1181B<-e>). The I<path> must be an absolute path and it must exist for
1182@@RXVT_NAME@@ to start. If it isn't specified then the current working
1183directory will be used; option B<-cd>.
974 1184
975=item B<keysym.>I<sym>: I<string> 1185=item B<keysym.>I<sym>: I<string>
976 1186
977Compile I<frills>: Associate I<string> with keysym I<sym>. The 1187Compile I<frills>: Associate I<string> with keysym I<sym>. The
978intervening resource name B<keysym.> cannot be omitted. 1188intervening resource name B<keysym.> cannot be omitted.
992searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1202searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
993omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1203omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
994keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1204keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
995performed in an exact manner; however, the closest match is assured. 1205performed in an exact manner; however, the closest match is assured.
996 1206
997I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1207I<string> may contain escape values (C<\n>: newline, C<\000>: octal
998C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1208number), see RESOURCES in C<man 7 X> for further details.
999C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1000C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1001can start or end with whitespace.
1002 1209
1003Please note that you need to double the C<\> in resource files, as
1004Xlib itself does it's own de-escaping (you can use C<\033> instead of
1005C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1006processing).
1007
1008You can define a range of keysyms in one shot by providing a I<string> 1210You can define a range of keysyms in one shot by
1211loading the C<keysym-list> perl extension and providing a I<string>
1009with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1212with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1010should be a character not used by the strings. 1213should be a character not used by the strings.
1011 1214
1012Its usage can be demonstrated by an example: 1215Its usage can be demonstrated by an example:
1013 1216
1014 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1217 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1015 1218
1016The above line is equivalent to the following three lines: 1219The above line is equivalent to the following three lines:
1017 1220
1018 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1221 URxvt.keysym.Meta-Control-0x61: \033<a>
1019 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1222 URxvt.keysym.Meta-Control-0x62: \033<b>
1020 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1223 URxvt.keysym.Meta-Control-0x63: \033<c>
1021 1224
1022If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1225If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1023is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1226is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1024example the following means "change the current locale to C<zh_CN.GBK> 1227example the following means "change the current locale to C<zh_CN.GBK>
1025when Control-Meta-c is being pressed": 1228when Control-Meta-c is being pressed":
1026 1229
1027 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1230 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1028 1231
1029If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1232If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1030is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1233is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1031manpage. For example, the F<selection> extension (activated via 1234manpage. For example, the F<selection> extension (activated via
1032C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1235C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1033 1236
1034 URxvt.keysym.M-C-c: perl:selection:rot13 1237 URxvt.keysym.M-C-c: perl:selection:rot13
1035 1238
1036Due the the large number of modifier combinations, a defined key mapping 1239Due the the large number of modifier combinations, a defined key mapping
1037will match if at I<at least> the specified identifiers are being set, and 1240will match if I<at least> the specified identifiers are being set, and
1038no other key mappings with those and more bits are being defined. That 1241no other key mappings with those and more bits are being defined. That
1039means that defining a key map for C<a> will automatically provide 1242means that defining a key map for C<a> will automatically provide
1040definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined 1243definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1041mappings themselves. 1244mappings themselves.
1042 1245
1078example, C<default,-selection> will use all the default extension except 1281example, C<default,-selection> will use all the default extension except
1079C<selection>. 1282C<selection>.
1080 1283
1081Extension names can also be followed by an argument in angle brackets 1284Extension names can also be followed by an argument in angle brackets
1082(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1285(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1083searchable scorllback to Alt/Meta-s). Mentioning the same extension 1286searchable scrollback to Alt/Meta-s). Mentioning the same extension
1084multiple times with different arguments will pass multiple arguments to 1287multiple times with different arguments will pass multiple arguments to
1085the extension. 1288the extension.
1086 1289
1087Each extension is looked up in the library directories, loaded if 1290Each extension is looked up in the library directories, loaded if
1088necessary, and bound to the current terminal instance. 1291necessary, and bound to the current terminal instance.
1093all instances, while B<perl-ext> is used for specific instances. 1296all instances, while B<perl-ext> is used for specific instances.
1094 1297
1095=item B<perl-eval>: I<string> 1298=item B<perl-eval>: I<string>
1096 1299
1097Perl code to be evaluated when all extensions have been registered. See 1300Perl code to be evaluated when all extensions have been registered. See
1098the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1301the @@RXVT_NAME@@perl(3) manpage.
1099will be ignored when running setuid/setgid.
1100 1302
1101=item B<perl-lib>: I<path> 1303=item B<perl-lib>: I<path>
1102 1304
1103Colon-separated list of additional directories that hold extension 1305Colon-separated list of additional directories that hold extension
1104scripts. When looking for extensions specified by the C<perl> resource, 1306scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1105@@RXVT_NAME@@ will first look in these directories and then in 1307look in these directories, then in $HOME/.urxvt/ext and lastly in
1106F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1308F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1107will be ignored when running setuid/setgid.
1108 1309
1109See the @@RXVT_NAME@@perl(3) manpage. 1310See the @@RXVT_NAME@@perl(3) manpage.
1110 1311
1111=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1312=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1112 1313
1124(default: C<M-s>). 1325(default: C<M-s>).
1125 1326
1126=item B<urlLauncher>: I<string> 1327=item B<urlLauncher>: I<string>
1127 1328
1128Specifies the program to be started with a URL argument. Used by the 1329Specifies the program to be started with a URL argument. Used by the
1129C<selection-popup> and C<mark-urls> perl extensions. 1330C<selection-popup> and C<matcher> perl extensions.
1130 1331
1131=item B<transient-for>: I<windowid> 1332=item B<transient-for>: I<windowid>
1132 1333
1133Sets the WM_TRANSIENT_FOR property to the given window iw. 1334Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1335
1336=item B<override-redirect>: I<boolean>
1337
1338Compile I<frills>: Sets override-redirect for the terminal window, making
1339it almost invisible to window managers; option B<-override-redirect>.
1340
1341=item B<iso14755:> I<boolean>
1342
1343Turn on/off ISO 14755 (default enabled).
1344
1345=item B<iso14755_52:> I<boolean>
1346
1347Turn on/off ISO 14755 5.2 mode (default enabled).
1134 1348
1135=back 1349=back
1136 1350
1137=head1 THE SCROLLBAR 1351=head1 THE SCROLLBAR
1138 1352
1157application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1371application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1158(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1372(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1159up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1373up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1160respectively. 1374respectively.
1161 1375
1162=head1 TEXT SELECTION AND INSERTION 1376=head1 THE SELECTION: SELECTING AND PASTING TEXT
1163 1377
1164The behaviour of text selection and insertion mechanism is similar to 1378The behaviour of text selection and insertion/pasting mechanism is similar
1165I<xterm>(1). 1379to I<xterm>(1).
1166 1380
1167=over 4 1381=over 4
1168 1382
1169=item B<Selection>: 1383=item B<Selecting>:
1170 1384
1171Left click at the beginning of the region, drag to the end of the region 1385Left click at the beginning of the region, drag to the end of the region
1172and release; Right click to extend the marked region; Left double-click 1386and release; Right click to extend the marked region; Left double-click
1173to select a word; Left triple-click to select the entire logical line 1387to select a word; Left triple-click to select the entire logical line
1174(which can span multiple screen lines), unless modified by resource 1388(which can span multiple screen lines), unless modified by resource
1178(Compile: I<frills>) will create a rectangular selection instead of a 1392(Compile: I<frills>) will create a rectangular selection instead of a
1179normal one. In this mode, every selected row becomes its own line in the 1393normal one. In this mode, every selected row becomes its own line in the
1180selection, and trailing whitespace is visually underlined and removed from 1394selection, and trailing whitespace is visually underlined and removed from
1181the selection. 1395the selection.
1182 1396
1183=item B<Insertion>: 1397=item B<Pasting>:
1184 1398
1185Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1399Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1186an B<@@RXVT_NAME@@> window causes the current text selection to be 1400window causes the value of the PRIMARY selection (or CLIPBOARD with the
1187inserted as if it had been typed on the keyboard. 1401B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1402
1403Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1404inserted too.
1188 1405
1189=back 1406=back
1190 1407
1191=head1 CHANGING FONTS 1408=head1 CHANGING FONTS
1192 1409
1206 1423
1207=head1 ISO 14755 SUPPORT 1424=head1 ISO 14755 SUPPORT
1208 1425
1209ISO 14755 is a standard for entering and viewing unicode characters 1426ISO 14755 is a standard for entering and viewing unicode characters
1210and character codes using the keyboard. It consists of 4 parts. The 1427and character codes using the keyboard. It consists of 4 parts. The
1211first part is available rxvt-unicode has been compiled with 1428first part is available if rxvt-unicode has been compiled with
1212C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1429C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1213with C<--enable-iso14755>. 1430with C<--enable-iso14755>.
1214 1431
1215=over 4 1432=over 4
1216 1433
1236This mode lets you input characters representing the keycap symbols of 1453This mode lets you input characters representing the keycap symbols of
1237your keyboard, if representable in the current locale encoding. 1454your keyboard, if representable in the current locale encoding.
1238 1455
1239Start by pressing C<Control> and C<Shift> together, then releasing 1456Start by pressing C<Control> and C<Shift> together, then releasing
1240them. The next special key (cursor keys, home etc.) you enter will not 1457them. The next special key (cursor keys, home etc.) you enter will not
1241invoke it's usual function but instead will insert the corresponding 1458invoke its usual function but instead will insert the corresponding
1242keycap symbol. The symbol will only be entered when the key has been 1459keycap symbol. The symbol will only be entered when the key has been
1243released, otherwise pressing e.g. C<Shift> would enter the symbol for 1460released, otherwise pressing e.g. C<Shift> would enter the symbol for
1244C<ISO Level 2 Switch>, although your intention might have been to enter a 1461C<ISO Level 2 Switch>, although your intention might have been to enter a
1245reverse tab (Shift-Tab). 1462reverse tab (Shift-Tab).
1246 1463
1274B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1491B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1275it can be seen via the I<who(1)> command, and can accept messages. To 1492it can be seen via the I<who(1)> command, and can accept messages. To
1276allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1493allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1277on some systems or setgid to root or to some other group on others. 1494on some systems or setgid to root or to some other group on others.
1278 1495
1279=head1 COLORS AND GRAPHICS 1496=head1 COLOURS AND GRAPHICS
1280 1497
1281In addition to the default foreground and background colours, 1498In addition to the default foreground and background colours,
1282B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1499B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1283high-intensity bold/blink versions of the same). Here is a list of the 1500high-intensity (potentially bold/blink) versions of the same, and 72 (or
1284colours with their B<rgb.txt> names. 1501240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1502cube plus a 8 (24) colour greyscale ramp.
1503
1504Here is a list of the ANSI colours with their names.
1285 1505
1286=begin table 1506=begin table
1287 1507
1288 B<color0> (black) = Black 1508 B<color0> (black) = Black
1289 B<color1> (red) = Red3 1509 B<color1> (red) = Red3
1309It is also possible to specify the colour values of B<foreground>, 1529It is also possible to specify the colour values of B<foreground>,
1310B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1530B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1311a number 0-15, as a convenient shorthand to reference the colour name of 1531a number 0-15, as a convenient shorthand to reference the colour name of
1312color0-color15. 1532color0-color15.
1313 1533
1534The following text gives values for the standard 88 colour mode (and
1535values for the 256 colour mode in parentheses).
1536
1537The RGB cube uses indices 16..79 (16..231) using the following formulas:
1538
1539 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1540 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1541
1542The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1543steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1544the RGB cube.
1545
1546Together, all those colours implement the 88 (256) colour xterm
1547colours. Only the first 16 can be changed using resources currently, the
1548rest can only be changed via command sequences ("escape codes").
1549
1550Applications are advised to use terminfo or command sequences to discover
1551number and RGB values of all colours (yes, you can query this...).
1552
1314Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1553Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1315always swapping the foreground/background colours. This is in contrast to 1554always swapping the foreground/background colours. This is in contrast to
1316I<xterm>(1) where the colours are only swapped if they have not otherwise 1555I<xterm>(1) where the colours are only swapped if they have not otherwise
1317been specified. For example, 1556been specified. For example,
1318 1557
1558 @@RXVT_NAME@@ -fg Black -bg White -rv
1559
1560would yield White on Black, while on I<xterm>(1) it would yield Black on
1561White.
1562
1563=head2 ALPHA CHANNEL SUPPORT
1564
1565If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1566their act together, rxvt-unicode will do its own alpha channel management:
1567
1568You can prefix any colour with an opaqueness percentage enclosed in
1569brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1570(0-100) that specifies the opacity of the colour, where C<0> is completely
1571transparent and C<100> is completely opaque. For example, C<[50]red> is a
1572half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1573is the recommended format to specify transparency values, and works with
1574all ways to specify a colour.
1575
1576For complete control, rxvt-unicode also supports
1577C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1578specifications, where the additional C<aaaa> component specifies opacity
1579(alpha) values. The minimum value of C<0000> is completely transparent,
1580while C<ffff> is completely opaque). The two example colours from
1581earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1582C<rgba:0000/ff00/0000/f332>.
1583
1584You probably need to specify B<"-depth 32">, too, to force a visual with
1585alpha channels, and have the luck that your X-server uses ARGB pixel
1586layout, as X is far from just supporting ARGB visuals out of the box, and
1587rxvt-unicode just fudges around.
1588
1589For example, the following selects an almost completely transparent black
1590background, and an almost opaque pink foreground:
1591
1592 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1593
1594When not using a background image, then the interpretation of the
1595alpha channel is up to your compositing manager (most interpret it as
1596transparency of course).
1597
1598When using a background pixmap or pseudo-transparency, then the background
1599colour will always behave as if it were completely transparent (so the
1600background image shows instead), regardless of how it was specified, while
1601other colours will either be transparent as specified (the background
1602image will show through) on servers supporting the RENDER extension, or
1603fully opaque on servers not supporting the RENDER EXTENSION.
1604
1605Please note that due to bugs in Xft, specifying alpha values might result
1606in garbage being displayed when the X-server does not support the RENDER
1607extension.
1608
1609=head1 ENVIRONMENT
1610
1611B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1612
1319=over 4 1613=over 4
1320 1614
1321=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1322
1323would yield White on Black, while on I<xterm>(1) it would yield Black
1324on White.
1325
1326=back
1327
1328=head1 ENVIRONMENT
1329
1330B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1331
1332=over 4
1333
1334=item B<TERM> 1615=item B<TERM>
1335 1616
1336Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1617Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1337resources or on the commandline. 1618resources or on the command line.
1338 1619
1339=item B<COLORTERM> 1620=item B<COLORTERM>
1340 1621
1341Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1622Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1342compiled with XPM support, and optionally with the added extension 1623compiled with background image support, and optionally with the added
1343C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1624extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1625screen.
1344 1626
1345=item B<COLORFGBG> 1627=item B<COLORFGBG>
1346 1628
1347Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1629Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1348the colour code used as default foreground/text colour (or the string 1630the colour code used as default foreground/text colour (or the string
1349C<default> to indicate that the default-colour escape sequence is to be 1631C<default> to indicate that the default-colour escape sequence is to be
1350used), C<bg> is the colour code used as default background colour (or the 1632used), C<bg> is the colour code used as default background colour (or the
1351string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1633string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1352was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1634was compiled with background image support. Libraries like C<ncurses>
1353(and do) use this information to optimize screen output. 1635and C<slang> can (and do) use this information to optimize screen output.
1354 1636
1355=item B<WINDOWID> 1637=item B<WINDOWID>
1356 1638
1357Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1639Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1358window, which usually has subwindows for the scrollbar, the terminal 1640window, which usually has subwindows for the scrollbar, the terminal
1364C<--with-terminfo=PATH>. 1646C<--with-terminfo=PATH>.
1365 1647
1366=item B<DISPLAY> 1648=item B<DISPLAY>
1367 1649
1368Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1650Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1369display in it's child processes. 1651display in its child processes if C<-display> isn't used to override. It
1652defaults to C<:0> if it doesn't exist.
1370 1653
1371=item B<SHELL> 1654=item B<SHELL>
1372 1655
1373The shell to be used for command execution, defaults to C</bin/sh>. 1656The shell to be used for command execution, defaults to C</bin/sh>.
1374 1657
1375=item B<RXVT_SOCKET> 1658=item B<RXVT_SOCKET>
1376 1659
1377The unix domain socket path used by @@RXVT_NAME@@c(1) and 1660The unix domain socket path used by @@RXVT_NAME@@c(1) and
1378@@RXVT_NAME@@d(1). 1661@@RXVT_NAME@@d(1).
1379 1662
1380Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1663Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1381 1664
1382=item B<HOME> 1665=item B<HOME>
1383 1666
1384Used to locate the default directory for the unix domain socket for 1667Used to locate the default directory for the unix domain socket for
1385daemon communications and to locate various resource files (such as 1668daemon communications and to locate various resource files (such as
1386C<.Xdefaults>) 1669C<.Xdefaults>)
1387 1670
1388=item B<XAPPLRESDIR> 1671=item B<XAPPLRESDIR>
1389 1672
1390Directory where various X resource files are being located. 1673Directory where application-specific X resource files are located.
1391 1674
1392=item B<XENVIRONMENT> 1675=item B<XENVIRONMENT>
1393 1676
1394If set and accessible, gives the name of a X resource file to be loaded by 1677If set and accessible, gives the name of a X resource file to be loaded by
1395@@RXVT_NAME@@. 1678@@RXVT_NAME@@.
1400 1683
1401=over 4 1684=over 4
1402 1685
1403=item B</usr/lib/X11/rgb.txt> 1686=item B</usr/lib/X11/rgb.txt>
1404 1687
1405Color names. 1688Colour names.
1406 1689
1407=back 1690=back
1408 1691
1409=head1 SEE ALSO 1692=head1 SEE ALSO
1410 1693
1416 1699
1417=item Project Coordinator 1700=item Project Coordinator
1418 1701
1419Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1702Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1420 1703
1421L<http://software.schmorp.de/#rxvt-unicode> 1704L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1422 1705
1423=back 1706=back
1424 1707
1425=head1 AUTHORS 1708=head1 AUTHORS
1426 1709
1448 1731
1449Project Coordinator (changes.txt 2.21a to 2.4.5) 1732Project Coordinator (changes.txt 2.21a to 2.4.5)
1450 1733
1451=item Geoff Wing L<< <gcw@pobox.com> >> 1734=item Geoff Wing L<< <gcw@pobox.com> >>
1452 1735
1453Rewrote screen display and text selection routines. Project Coordinator 1736Rewrote screen display and text selection routines.
1737
1454(changes.txt 2.4.6 - rxvt-unicode) 1738Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1455 1739
1456=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1740=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1457 1741
1458Forked rxvt-unicode, rewrote most of the display code and internal 1742Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1459character handling to store text in unicode, improve xterm 1743extension, random hacks, numerous bugfixes and extensions.
1460compatibility and apply numerous other bugfixes and extensions.
1461 1744
1462Project Coordinator (Changes 1.0 -) 1745Project Coordinator (Changes 1.0 -)
1463 1746
1747=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1748
1749pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1750
1464=back 1751=back
1465 1752

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines