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.48 by root, Thu Feb 3 10:24:10 2005 UTC vs.
Revision 1.160 by root, Fri Jan 25 18:42:23 2008 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines