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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines