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.34 by root, Wed Dec 1 02:29:14 2004 UTC vs.
Revision 1.130 by sasha, Fri Jun 8 20:04:12 2007 UTC

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
17=head1 FREQUENTLY ASKED QUESTIONS 17=head1 FREQUENTLY ASKED QUESTIONS
18 18
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of frequently 19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20asked questions and answer to them and some common problems. 20frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
21 23
22=head1 RXVT-UNICODE VS. RXVT 24=head1 RXVT-UNICODE VS. RXVT
23 25
24Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
25internally. That means it can store and display most scripts in the 27internally. That means it can store and display most scripts in the
26world. Being a terminal emulator, however, some things are very difficult, 28world. Being a terminal emulator, however, some things are very difficult,
27especially cursive scripts such as arabic, vertically written scripts 29especially cursive scripts such as arabic, vertically written scripts
28like mongolian or scripts requiring extremely complex combining rules, 30like mongolian or scripts requiring extremely complex combining rules,
29like tibetan or devenagari. Don't expect pretty output when using these 31like tibetan or devenagari. Don't expect pretty output when using these
30scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
31fine, though. A somewhat difficult case are left-to-right scripts, such 33fine, though. A somewhat difficult case are right-to-left scripts, such
32as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
33belong into the application, not the terminal emulator (too many things -- 35belong into the application, not the terminal emulator (too many things --
34such as cursor-movement while editing -- break otherwise), but that might 36such as cursor-movement while editing -- break otherwise), but that might
35change. 37change.
36 38
37If you are looking for a terminal that supports more exotic scripts, let 39If you are looking for a terminal that supports more exotic scripts, let
38me recommend C<mlterm>, which is a very userfriendly, lean and clean 40me recommend C<mlterm>, which is a very user friendly, lean and clean
39terminal emulator. In fact, the reason rxvt-unicode was born was solely 41terminal 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 42because the author couldn't get C<mlterm> to use one font for latin1 and
41another for japanese. 43another for japanese.
42 44
43Therefore another design rationale was the use of multiple fonts to 45Therefore another design rationale was the use of multiple fonts to
44display characters: The idea of a single unicode font which many other 46display 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 47programs force onto its users never made sense to me: You should be able
46to choose any font for any script freely. 48to choose any font for any script freely.
47 49
48Apart from that, rxvt-unicode is also much better internationalised than 50Apart from that, rxvt-unicode is also much better internationalised than
49it's predecessor, supports things such as XFT and ISO 14755 that are handy 51its 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 52in i18n-environments, is faster, and has a lot bugs less than the original
51rxvt. This all in addition to dozens of other small improvements. 53rxvt. This all in addition to dozens of other small improvements.
52 54
53It is still faithfully following the original rxvt idea of being lean 55It is still faithfully following the original rxvt idea of being lean
54and nice on resources: for example, you can still configure rxvt-unicode 56and 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 57without 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 58a client/daemon pair that lets you open any number of terminal windows
57from within a single process, which makes startup time very fast and 59from within a single process, which makes startup time very fast and
58drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
59@@RXVT_NAME@@c(1) (client). 61@@RXVT_NAME@@c(1) (client).
60 62
61It also makes technical information about escape sequences (which have 63It also makes technical information about escape sequences (which have
62been extended) easier accessible: see @@RXVT_NAME@@(7) for technical 64been extended) more accessible: see @@RXVT_NAME@@(7) for technical
63reference documentation (escape sequences etc.). 65reference documentation (escape sequences etc.).
64 66
65=head1 OPTIONS 67=head1 OPTIONS
66 68
67The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed 69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
91 93
92Attempt to open a window on the named X display (B<-d> still 94Attempt to open a window on the named X display (B<-d> still
93respected). In the absence of this option, the display specified by the 95respected). In the absence of this option, the display specified by the
94B<DISPLAY> environment variable is used. 96B<DISPLAY> environment variable is used.
95 97
98=item B<-depth> I<bitdepth>
99
100Compile I<xft>: Attempt to find a visual with the given bit depth;
101resource B<depth>.
102
96=item B<-geometry> I<geom> 103=item B<-geometry> I<geom>
97 104
98Window geometry (B<-g> still respected); resource B<geometry>. 105Window geometry (B<-g> still respected); resource B<geometry>.
99 106
100=item B<-rv>|B<+rv> 107=item B<-rv>|B<+rv>
103 110
104=item B<-j>|B<+j> 111=item B<-j>|B<+j>
105 112
106Turn on/off jump scrolling; resource B<jumpScroll>. 113Turn on/off jump scrolling; resource B<jumpScroll>.
107 114
108=item B<-ip>|B<+ip> 115=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
109 116
110Turn on/off inheriting parent window's pixmap. Alternative form is 117Turn on/off inheriting parent window's pixmap. Alternative form is
111B<-tr>; resource B<inheritPixmap>. 118B<-tr>; resource B<inheritPixmap>.
112 119
120I<Please note that transparency of any kind if completely unsupported by
121the author. Don't bug him with installation questions! Read the FAQ (man 7
122@@RXVT_NAME@@)!>
123
113=item B<-fade> I<number> 124=item B<-fade> I<number>
114 125
115Fade the text by the given percentage when focus is lost. 126Fade the text by the given percentage when focus is lost. Small values
127fade a little only, 100 completely replaces all colours by the fade
128colour; resource B<fading>.
129
130=item B<-fadecolor> I<colour>
131
132Fade to this colour when fading is used (see B<-fade>). The default colour
133is opaque black. resource B<fadeColor>.
116 134
117=item B<-tint> I<colour> 135=item B<-tint> I<colour>
118 136
119Tint the transparent background pixmap with the given colour when 137Tint the transparent background pixmap with the given colour when
120transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> 138transparency is enabled with B<-tr> or B<-ip>. This only works for
121option that can be used to brighten or darken the image in addition to 139non-tiled backgrounds, currently. See also the B<-sh> option that can be
122tinting it. 140used to brighten or darken the image in addition to tinting it; resource
141I<tintColor>. Example:
123 142
124=item B<-sh> 143 @@RXVT_NAME@@ -tr -tint blue -sh 40
125 144
145=item B<-sh> I<number>
146
126I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 147Darken (0 .. 100) or lighten (-1 .. -100) the transparent
127background image in addition to tinting it (i.e. B<-tint> must be 148background image in addition to (or instead of) tinting it;
128specified, too). 149resource I<shading>.
150
151=item B<-blt> I<string>
152
153Specify background blending type. If background pixmap is specified
154at the same time as transparency - such pixmap will be blended over
155transparency image, using method specified. Supported values are :
156B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
157B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
158B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
159alpha-blending; resource I<blendType>.
160
161=item B<-blr> I<number>
162
163Apply Gaussian Blur with the specified radius to the transparent
164background image; resource I<blurRadius>.
129 165
130=item B<-bg> I<colour> 166=item B<-bg> I<colour>
131 167
132Window background colour; resource B<background>. 168Window background colour; resource B<background>.
133 169
135 171
136Window foreground colour; resource B<foreground>. 172Window foreground colour; resource B<foreground>.
137 173
138=item B<-pixmap> I<file[;geom]> 174=item B<-pixmap> I<file[;geom]>
139 175
140Compile I<XPM>: Specify XPM file for the background and also optionally 176Compile I<afterimage>: Specify image file for the background and also
141specify its scaling with a geometry string. Note you may need to add 177optionally specify its scaling with a geometry string. Note you may need to
142quotes to avoid special shell interpretation of the `;' in the 178add quotes to avoid special shell interpretation of the C<;> in the
143command-line; resource B<backgroundPixmap>. 179command-line; for more details see resource B<backgroundPixmap>.
144 180
145=item B<-cr> I<colour> 181=item B<-cr> I<colour>
146 182
147The cursor colour; resource B<cursorColor>. 183The cursor colour; resource B<cursorColor>.
148 184
160resource B<borderColor>. 196resource B<borderColor>.
161 197
162=item B<-fn> I<fontlist> 198=item B<-fn> I<fontlist>
163 199
164Select the fonts to be used. This is a comma separated list of font names 200Select 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 201that are checked in order when trying to find glyphs for characters. The
166first font defines the cell size for characters; other fonts might be 202first font defines the cell size for characters; other fonts might be
167smaller, but not (in general) larger. A (hopefully) reasonable default 203smaller, but not (in general) larger. A (hopefully) reasonable default
168font list is always appended to it. See resource B<font> for more details. 204font list is always appended to it. See resource B<font> for more details.
169 205
170In short, to specify an X11 core font, just specify it's name or prefix it 206In 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:>, 207with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
172e.g.: 208e.g.:
173 209
174 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 210 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
175 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 211 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
177See also the question "How does rxvt-unicode choose fonts?" in the FAQ 213See also the question "How does rxvt-unicode choose fonts?" in the FAQ
178section of @@RXVT_NAME@@(7). 214section of @@RXVT_NAME@@(7).
179 215
180=item B<-fb> I<fontlist> 216=item B<-fb> I<fontlist>
181 217
182Compile font-styles: The bold font list to use when bold characters are to 218Compile I<font-styles>: The bold font list to use when B<bold> characters
183be printed. See resource B<boldFont> for details. 219are to be printed. See resource B<boldFont> for details.
184 220
185=item B<-fi> I<fontlist> 221=item B<-fi> I<fontlist>
186 222
187Compile font-styles: The italic font list to use when bold characters are to 223Compile I<font-styles>: The italic font list to use when I<italic>
188be printed. See resource B<italicFont> for details. 224characters are to be printed. See resource B<italicFont> for details.
189 225
190=item B<-fbi> I<fontlist> 226=item B<-fbi> I<fontlist>
191 227
192Compile font-styles: The bold italic font list to use when bold characters are to 228Compile I<font-styles>: The bold italic font list to use when B<< I<bold
193be printed. See resource B<boldItalicFont> for details. 229italic> >> characters are to be printed. See resource B<boldItalicFont>
230for details.
231
232=item B<-is>|B<+is>
233
234Compile I<font-styles>: Bold/Italic font styles imply high intensity
235foreground/background (default). See resource B<intensityStyles> for
236details.
194 237
195=item B<-name> I<name> 238=item B<-name> I<name>
196 239
197Specify the application name under which resources are to be obtained, 240Specify the application name under which resources are to be obtained,
198rather than the default executable file name. Name should not contain 241rather than the default executable file name. Name should not contain
236 279
237Put scrollbar on right/left; resource B<scrollBar_right>. 280Put scrollbar on right/left; resource B<scrollBar_right>.
238 281
239=item B<-st>|B<+st> 282=item B<-st>|B<+st>
240 283
241Display normal (non XTerm/NeXT) scrollbar without/with a trough; 284Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
242resource B<scrollBar_floating>. 285resource B<scrollBar_floating>.
243 286
244=item B<-ptab>|B<+ptab> 287=item B<-ptab>|B<+ptab>
245 288
246If enabled (default), "Horizontal Tab" characters are being stored as 289If enabled (default), "Horizontal Tab" characters are being stored as
278 321
279Compile I<frills>: Set MWM hints to request a borderless window, i.e. 322Compile 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 323if honoured by the WM, the rxvt-unicode window will not have window
281decorations; resource B<borderLess>. 324decorations; resource B<borderLess>.
282 325
326=item B<-override-redirect>
327
328Compile I<frills>: Sets override-redirect on the window; resource
329B<override-redirect>.
330
331=item B<-sbg>
332
333Compile I<frills>: Disable the usage of the built-in block graphics/line
334drawing characters and just rely on what the specified fonts provide. Use
335this if you have a good font and want to use its block graphic glyphs;
336resource B<skipBuiltinGlyphs>.
337
283=item B<-lsp> I<number> 338=item B<-lsp> I<number>
284 339
285Compile I<linespace>: Lines (pixel height) to insert between each row 340Compile I<frills>: Lines (pixel height) to insert between each row of
286of the display; resource B<linespace>. 341the display. Useful to work around font rendering problems; resource
342B<linespace>.
287 343
288=item B<-tn> I<termname> 344=item B<-tn> I<termname>
289 345
290This option specifies the name of the terminal type to be set in the 346This option specifies the name of the terminal type to be set in the
291B<TERM> environment variable. This terminal type must exist in the 347B<TERM> environment variable. This terminal type must exist in the
300given on the command line. If this option is used, it must be the last 356given on the command line. If this option is used, it must be the last
301on the command-line. If there is no B<-e> option then the default is to 357on the command-line. If there is no B<-e> option then the default is to
302run the program specified by the B<SHELL> environment variable or, 358run the program specified by the B<SHELL> environment variable or,
303failing that, I<sh(1)>. 359failing that, I<sh(1)>.
304 360
361Please note that you must specify a program with arguments. If you want to
362run shell commands, you have to specify the shell, like this:
363
364 @@RXVT_NAME@@ -e sh -c "shell commands"
365
305=item B<-title> I<text> 366=item B<-title> I<text>
306 367
307Window title (B<-T> still respected); the default title is the basename 368Window title (B<-T> still respected); the default title is the basename
308of the program specified after the B<-e> option, if any, otherwise the 369of the program specified after the B<-e> option, if any, otherwise the
309application name; resource B<title>. 370application name; resource B<title>.
327 388
328Compile I<XIM>: input method name. resource B<inputMethod>. 389Compile I<XIM>: input method name. resource B<inputMethod>.
329 390
330=item B<-imlocale> I<string> 391=item B<-imlocale> I<string>
331 392
332The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 393The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
333de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 394C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
334extension to be able to input japanese characters while staying in 395input extension to be able to input japanese characters while staying in
335another locale. 396another locale. resource B<imLocale>.
397
398=item B<-imfont> I<fontset>
399
400Set the font set to use for the X Input Method, see resource B<imFont>
401for more info.
402
403=item B<-tcw>
404
405Change the meaning of triple-click selection with the left mouse
406button. Only effective when the original (non-perl) selection code is
407in-use. Instead of selecting a full line it will extend the selection the
408end of the logical line only. resource B<tripleclickwords>.
336 409
337=item B<-insecure> 410=item B<-insecure>
338 411
339Enable "insecure" mode, which currently enables most of the escape 412Enable "insecure" mode, which currently enables most of the escape
340sequences that echo strings. See the resource B<insecure> for more 413sequences that echo strings. See the resource B<insecure> for more
354=item B<-ssr>|B<+ssr> 427=item B<-ssr>|B<+ssr>
355 428
356Turn on/off secondary screen scroll (default enabled); resource 429Turn on/off secondary screen scroll (default enabled); resource
357B<secondaryScroll>. 430B<secondaryScroll>.
358 431
432=item B<-hold>|B<+hold>
433
434Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
435will not immediately destroy its window when the program executed within
436it exits. Instead, it will wait till it is being killed or closed by the
437user; resource B<hold>.
438
439=item B<-keysym.>I<sym> I<string>
440
441Remap a key symbol. See resource B<keysym>.
442
443=item B<-embed> I<windowid>
444
445Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
446which enables applications to easily embed a terminal.
447
448Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
449shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
450quite a bit, so don't expect it to keep some specific state. It's best to
451create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
452
453The window will not be destroyed when @@RXVT_NAME@@ exits.
454
455It might be useful to know that @@RXVT_NAME@@ will not close file
456descriptors passed to it (except for stdin/out/err, of course), so you
457can use file descriptors to communicate with the programs within the
458terminal. This works regardless of whether the C<-embed> option was used or
459not.
460
461Here is a short Gtk2-perl snippet that illustrates how this option can be
462used (a longer example is in F<doc/embed>):
463
464 my $rxvt = new Gtk2::Socket;
465 $rxvt->signal_connect_after (realize => sub {
466 my $xid = $_[0]->window->get_xid;
467 system "@@RXVT_NAME@@ -embed $xid &";
468 });
469
470=item B<-pty-fd> I<file descriptor>
471
472Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
473pair but instead use the given file descriptor as the tty master. This is
474useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
475without having to run a program within it.
476
477If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
478entries and will not tinker with pty/tty permissions - you have to do that
479yourself if you want that.
480
481As an extremely special case, specifying C<-1> will completely suppress
482pty/tty operations.
483
484Here is a example in perl that illustrates how this option can be used (a
485longer example is in F<doc/pty-fd>):
486
487 use IO::Pty;
488 use Fcntl;
489
490 my $pty = new IO::Pty;
491 fcntl $pty, F_SETFD, 0; # clear close-on-exec
492 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
493 close $pty;
494
495 # now communicate with rxvt
496 my $slave = $pty->slave;
497 while (<$slave>) { print $slave "got <$_>\n" }
498
359=item B<-xrm> I<resourcestring> 499=item B<-pe> I<string>
360 500
361No effect on rxvt-unicode. Simply passes through an argument to be made 501Comma-separated list of perl extension scripts to use (or not to use) in
362available in the instance's argument list. Appears in I<WM_COMMAND> in 502this terminal instance. See resource B<perl-ext> for details.
363some window managers.
364 503
365=back 504=back
366 505
367=head1 RESOURCES (available also as long-options) 506=head1 RESOURCES (available also as long-options)
368 507
369Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 508Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
370options) compiled into your version. 509options) compiled into your version.
371 510
372There are two different methods that @@RXVT_NAME@@ can use to get the 511You can set and change the resources using X11 tools like B<xrdb>. Many
373Xresource data: using the X libraries (Xrm*-functions) or internal 512distribution do also load settings from the B<~/.Xresources> file when X
374Xresources reader (B<~/.Xdefaults>). For the first method (ie. 513starts. @@RXVT_NAME@@ will consult the following files/resources in order,
375B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 514with later settings overwriting earlier ones:
376resources using X11 tools like B<xset>. Many distribution do also load
377settings from the B<~/.Xresources> file when X starts.
378 515
379If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> 516 1. system-wide app-defaults file, either locale-dependent OR global
380lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults 517 2. app-defaults file in $XAPPLRESDIR
381set in XAPPLOADDIR/URxvt (compile-time defined: usually 518 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
382B</usr/lib/X11/app-defaults/URxvt>) and resources set in 519 4. SCREEN_RESOURCES for the current screen
383B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist. 520 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
521
384Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 522Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
385class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 523names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
386resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 524common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
387easily configured, while the class name B<URxvt> allows resources 525configured, while the class name B<URxvt> allows resources unique to
388unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 526B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
389shared between different B<@@RXVT_NAME@@> configurations. If no 527configurations. If no resources are specified, suitable defaults will
390resources are specified, suitable defaults will be used. Command-line 528be used. Command-line arguments can be used to override resource
391arguments can be used to override resource settings. The following 529settings. The following resources are supported (you might want to
392resources are allowed: 530check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
531extensions not documented here):
393 532
394=over 4 533=over 4
534
535=item B<depth:> I<bitdepth>
536
537Compile I<xft>: Attempt to find a visual with the given bit depth;
538option B<-depth>.
395 539
396=item B<geometry:> I<geom> 540=item B<geometry:> I<geom>
397 541
398Create the window with the specified X window geometry [default 80x24]; 542Create the window with the specified X window geometry [default 80x24];
399option B<-geometry>. 543option B<-geometry>.
427 571
428=item B<colorIT:> I<colour> 572=item B<colorIT:> I<colour>
429 573
430Use the specified colour to display bold or italic characters when the 574Use the specified colour to display bold or italic characters when the
431foreground colour is the default. If font styles are not available 575foreground colour is the default. If font styles are not available
432(Compile styles) and this option is unset, reverse video is used instead. 576(Compile I<styles>) and this option is unset, reverse video is used instead.
433 577
434=item B<colorUL:> I<colour> 578=item B<colorUL:> I<colour>
435 579
436Use the specified colour to display underlined characters when the 580Use the specified colour to display underlined characters when the
437foreground colour is the default. 581foreground colour is the default.
438 582
439=item B<colorRV:> I<colour> 583=item B<colorRV:> I<colour>
440 584
441Use the specified colour as the background for reverse video 585Use the specified colour as the background for reverse video characters
442characters. 586when OPTION_HC is disabled (--disable-frills).
587
588=item B<underlineColor:> I<colour>
589
590If set, use the specified colour as the colour for the underline
591itself. If unset, use the foreground colour.
443 592
444=item B<cursorColor:> I<colour> 593=item B<cursorColor:> I<colour>
445 594
446Use the specified colour for the cursor. The default is to use the 595Use the specified colour for the cursor. The default is to use the
447foreground colour; option B<-cr>. 596foreground colour; option B<-cr>.
468 617
469B<True>: make the background inherit the parent windows' pixmap, giving 618B<True>: make the background inherit the parent windows' pixmap, giving
470artificial transparency. B<False>: do not inherit the parent windows' 619artificial transparency. B<False>: do not inherit the parent windows'
471pixmap. 620pixmap.
472 621
622I<Please note that transparency of any kind if completely unsupported by
623the author. Don't bug him with installation questions!>
624
473=item B<fading:> I<number> 625=item B<fading:> I<number>
474 626
475Fade the text by the given percentage when focus is lost. 627Fade the text by the given percentage when focus is lost; option B<-fade>.
628
629=item B<fadeColor:> I<colour>
630
631Fade to this colour, when fading is used (see B<fading:>). The default
632colour is black; option B<-fadecolor>.
476 633
477=item B<tintColor:> I<colour> 634=item B<tintColor:> I<colour>
478 635
479Tint the transparent background pixmap with the given colour. 636Tint the transparent background pixmap with the given colour; option
637B<-tint>.
480 638
481=item B<shading:> I<number> 639=item B<shading:> I<number>
482 640
483Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 641Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
484image in addition to tinting it. 642in addition to tinting it; option B<-sh>.
643
644=item B<blendType:> I<string>
645
646Specify background blending type; option B<-blt>.
647
648=item B<blurRadius:> I<number>
649
650Apply Gaussian Blurr with the specified radius to the transparent
651background image; option B<-blr>.
485 652
486=item B<scrollColor:> I<colour> 653=item B<scrollColor:> I<colour>
487 654
488Use the specified colour for the scrollbar [default #B2B2B2]. 655Use the specified colour for the scrollbar [default #B2B2B2].
489 656
490=item B<troughColor:> I<colour> 657=item B<troughColor:> I<colour>
491 658
492Use the specified colour for the scrollbar's trough area [default 659Use the specified colour for the scrollbar's trough area [default
493#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 660#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
494 661
495=item B<borderColor:> I<colour> 662=item B<borderColor:> I<colour>
496 663
497The colour of the border around the text area and between the scrollbar 664The colour of the border around the text area and between the scrollbar
498and the text. 665and the text.
499 666
500=item B<backgroundPixmap:> I<file[;geom]> 667=item B<backgroundPixmap:> I<file[;geom]>
501 668
502Use the specified XPM file (note the `.xpm' extension is optional) for 669Use the specified image file for the background and also optionally
503the background and also optionally specify its scaling with a geometry 670specify its scaling with a geometry string B<WxH+X+Y>,
504string B<WxH+X+Y>, in which B<"W" / "H"> specify the 671in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
505horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 672and B<"X" / "Y"> locate the image centre (percent).
506centre (percent). A scale of 0 displays the image with tiling. A scale 673A scale of 0 displays the image with tiling. A scale of 1 displays the
507of 1 displays the image without any scaling. A scale of 2 to 9 674image without any scaling. A scale of 2 to 9 specifies an integer
508specifies an integer number of images in that direction. No image will 675number of images in that direction. No image will be magnified beyond
509be magnified beyond 10 times its original size. The maximum permitted 67610 times its original size. The maximum permitted scale is 1000.
510scale is 1000. [default 0x0+50+50] 677Special string of B<"auto"> used as a geometry will cause image to be
511 678automatically scaled to match window size.
512=item B<menu:> I<file[;tag]> 679If used in conjunction with B<-tr> option - specified pixmap will be
513 680blended over transparency image using either alpha-blending, or any
514Read in the specified menu file (note the `.menu' extension is 681other blending type, specified with B<-blt "type"> option.
515optional) and also optionally specify a starting tag to find. See the 682[default 0x0+50+50]
516reference documentation for details on the syntax for the menuBar.
517 683
518=item B<path:> I<path> 684=item B<path:> I<path>
519 685
520Specify the colon-delimited search path for finding files (XPM and 686Specify the colon-delimited search path for finding XPM files.
521menus), in addition to the paths specified by the B<RXVTPATH> and
522B<PATH> environment variables.
523 687
524=item B<font:> I<fontlist> 688=item B<font:> I<fontlist>
525 689
526Select the fonts to be used. This is a comma separated list of font 690Select the fonts to be used. This is a comma separated list of font names
527names that are used in turn when trying to display Unicode characters. 691that are checked in order when trying to find glyphs for characters. The
528The first font defines the cell size for characters; other fonts might 692first font defines the cell size for characters; other fonts might be
529be smaller, but not larger. A reasonable default font list is always 693smaller, but not (in general) larger. A (hopefully) reasonable default
530appended to it. option B<-fn>. 694font list is always appended to it; option B<-fn>.
531 695
532Each font can either be a standard X11 core font (XLFD) name, with 696Each font can either be a standard X11 core font (XLFD) name, with
533optional prefix C<x:> or a Xft font (Compile xft), prefixed with C<xft:>. 697optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
534 698
535In addition, each font can be prefixed with additional hints and 699In addition, each font can be prefixed with additional hints and
536specifications enclosed in square brackets (C<[]>). The only available 700specifications enclosed in square brackets (C<[]>). The only available
537hint currently is C<codeset=codeset-name>, and this is only used for Xft 701hint currently is C<codeset=codeset-name>, and this is only used for Xft
538fonts. 702fonts.
539 703
540For example, this font resource 704For example, this font resource
541 705
542 URxvt*font: 9x15bold,\ 706 URxvt.font: 9x15bold,\
543 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 707 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
544 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 708 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
545 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 709 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
546 xft:Code2000:antialias=false 710 xft:Code2000:antialias=false
547 711
581not possible, replacement fonts of the desired shape will be tried. 745not possible, replacement fonts of the desired shape will be tried.
582 746
583If set, but empty, then this specific style is disabled and the normal 747If set, but empty, then this specific style is disabled and the normal
584text font will being used for the given style. 748text font will being used for the given style.
585 749
750=item B<intensityStyles:> I<boolean>
751
752When font styles are not enabled, or this option is enabled (B<True>,
753option B<-is>, the default), bold and italic font styles imply high
754intensity foreground/background colours. Disabling this option (B<False>,
755option B<+is>) disables this behaviour, the high intensity colours are not
756reachable.
757
586=item B<selectstyle:> I<mode> 758=item B<selectstyle:> I<mode>
587 759
588Set mouse selection style to B<old> which is 2.20, B<oldword> which is 760Set mouse selection style to B<old> which is 2.20, B<oldword> which
589xterm style with 2.20 old word selection, or anything else which gives 761is xterm style with 2.20 old word selection, or anything else which
590xterm style selection. 762gives xterm style selection. Only effective when the original (non-perl)
763selection code is in use.
591 764
592=item B<scrollstyle:> I<mode> 765=item B<scrollstyle:> I<mode>
593 766
594Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 767Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
595the author's favourite.. 768the author's favourite.
596 769
597=item B<title:> I<string> 770=item B<title:> I<string>
598 771
599Set window title string, the default title is the command-line 772Set window title string, the default title is the command-line
600specified after the B<-e> option, if any, otherwise the application 773specified after the B<-e> option, if any, otherwise the application
609=item B<mapAlert:> I<boolean> 782=item B<mapAlert:> I<boolean>
610 783
611B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 784B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
612de-iconify (map) on receipt of a bell character [default]. 785de-iconify (map) on receipt of a bell character [default].
613 786
787=item B<urgentOnBell:> I<boolean>
788
789B<True>: set the urgency hint for the wm on receipt of a bell character.
790B<False>: do not set the urgency hint [default].
791
614=item B<visualBell:> I<boolean> 792=item B<visualBell:> I<boolean>
615 793
616B<True>: use visual bell on receipt of a bell character; option B<-vb>. 794B<True>: use visual bell on receipt of a bell character; option B<-vb>.
617B<False>: no visual bell [default]; option B<+vb>. 795B<False>: no visual bell [default]; option B<+vb>.
618 796
632 810
633Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 811Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
634B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or 812B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
635B<Shift-Print> to include the scrollback as well. 813B<Shift-Print> to include the scrollback as well.
636 814
815The string will be interpreted as if typed into the shell as-is.
816
817Example:
818
819 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
820
821This creates a new file in your home directory with the screen contents
822every time you hit C<Print>.
823
637=item B<scrollBar:> I<boolean> 824=item B<scrollBar:> I<boolean>
638 825
639B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 826B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
640disable the scrollbar; option B<+sb>. 827disable the scrollbar; option B<+sb>.
641 828
661B<+si>. 848B<+si>.
662 849
663=item B<scrollWithBuffer:> I<boolean> 850=item B<scrollWithBuffer:> I<boolean>
664 851
665B<True>: scroll with scrollback buffer when tty receives new lines (and 852B<True>: scroll with scrollback buffer when tty receives new lines (and
666B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 853B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
667with scrollback buffer when tty recieves new lines; option B<-sw>. 854with scrollback buffer when tty receives new lines; option B<+sw>.
668 855
669=item B<scrollTtyKeypress:> I<boolean> 856=item B<scrollTtyKeypress:> I<boolean>
670 857
671B<True>: scroll to bottom when a non-special key is pressed. Special keys 858B<True>: scroll to bottom when a non-special key is pressed. Special keys
672are those which are intercepted by rxvt-unicode for special handling and 859are those which are intercepted by rxvt-unicode for special handling and
691=item B<borderLess:> I<boolean> 878=item B<borderLess:> I<boolean>
692 879
693Set MWM hints to request a borderless window, i.e. if honoured by the 880Set MWM hints to request a borderless window, i.e. if honoured by the
694WM, the rxvt-unicode window will not have window decorations; option B<-bl>. 881WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
695 882
883=item B<skipBuiltinGlyphs:> I<boolean>
884
885Compile I<frills>: Disable the usage of the built-in block graphics/line
886drawing characters and just rely on what the specified fonts provide. Use
887this if you have a good font and want to use its block graphic glyphs;
888option B<-sbg>.
889
696=item B<termName:> I<termname> 890=item B<termName:> I<termname>
697 891
698Specifies the terminal type name to be set in the B<TERM> environment 892Specifies the terminal type name to be set in the B<TERM> environment
699variable; option B<-tn>. 893variable; option B<-tn>.
700 894
737 931
738Mouse pointer background colour. 932Mouse pointer background colour.
739 933
740=item B<pointerBlankDelay:> I<number> 934=item B<pointerBlankDelay:> I<number>
741 935
742Specifies number of seconds before blanking the pointer [default 2]. 936Specifies number of seconds before blanking the pointer [default 2]. Use a
937large number (e.g. C<987654321>) to effectively disable the timeout.
743 938
744=item B<backspacekey:> I<string> 939=item B<backspacekey:> I<string>
745 940
746The string to send when the backspace key is pressed. If set to B<DEC> 941The string to send when the backspace key is pressed. If set to B<DEC>
747or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 942or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
754pressed. If unset it will send the sequence traditionally associated 949pressed. If unset it will send the sequence traditionally associated
755with the B<Execute> key. 950with the B<Execute> key.
756 951
757=item B<cutchars:> I<string> 952=item B<cutchars:> I<string>
758 953
759The characters used as delimiters for double-click word selection. The 954The characters used as delimiters for double-click word selection
760built-in default: 955(whitespace delimiting is added automatically if resource is given).
956
957When the perl selection extension is in use (the default if compiled
958in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
959characters will be created (if the resource exists, otherwise, no regex
960will be created). In this mode, characters outside ISO-8859-1 can be used.
961
962When the selection extension is not used, only ISO-8859-1 characters can
963be used. If not specified, the built-in default is used:
761 964
762B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 965B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
763 966
764=item B<preeditType:> I<style> 967=item B<preeditType:> I<style>
765 968
769 972
770I<name> of inputMethod to use; option B<-im>. 973I<name> of inputMethod to use; option B<-im>.
771 974
772=item B<imLocale:> I<name> 975=item B<imLocale:> I<name>
773 976
774The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 977The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
775de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 978C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
776extension to be able to input japanese characters while staying in 979input extension to be able to input japanese characters while staying in
777another locale. option B<-imlocale>. 980another locale; option B<-imlocale>.
981
982=item B<imFont:> I<fontset>
983
984Specify the font-set used for XIM styles C<OverTheSpot> or
985C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
986by commas), i.e. it's not in the same format as the other font lists used
987in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
988found, preferably one or two pixels differing in size to the base font.
989option B<-imfont>.
990
991=item B<tripleclickwords:> I<boolean>
992
993Change the meaning of triple-click selection with the left mouse
994button. Instead of selecting a full line it will extend the selection to
995the end of the logical line only; option B<-tcw>.
778 996
779=item B<insecure:> I<boolean> 997=item B<insecure:> I<boolean>
780 998
781Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 999Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
782echo arbitrary strings like the icon name or the locale. This could be 1000echo arbitrary strings like the icon name or the locale. This could be
783abused if somebody gets 8-bit-clean access to your display, whether 1001abused if somebody gets 8-bit-clean access to your display, whether
784throuh a mail client displaying mail bodies unfiltered or though 1002through a mail client displaying mail bodies unfiltered or through
785write(1). Therefore, these sequences are disabled by default. (Note 1003write(1) or any other means. Therefore, these sequences are disabled by
786that other terminals, including xterm, have these sequences 1004default. (Note that many other terminals, including xterm, have these
787enabled by default). You can enable them by setting this boolean 1005sequences enabled by default, which doesn't make it safer, though).
788resource or specifying B<-insecure> as an option. At the moment, this 1006
789enabled display-answer, locale, findfont, icon label and window title 1007You can enable them by setting this boolean resource or specifying
790requests as well as dynamic menubar dispatch. 1008B<-insecure> as an option. At the moment, this enables display-answer,
1009locale, findfont, icon label and window title requests.
791 1010
792=item B<modifier:> I<modifier> 1011=item B<modifier:> I<modifier>
793 1012
794Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 1013Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
795B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 1014B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
799 1018
800Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1019Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
801character is passed through. It may contain escape values as described 1020character is passed through. It may contain escape values as described
802in the entry on B<keysym> following. 1021in the entry on B<keysym> following.
803 1022
804=item B<secondaryScreen:> I<bool> 1023=item B<secondaryScreen:> I<boolean>
805 1024
806Turn on/off secondary screen (default enabled). 1025Turn on/off secondary screen (default enabled).
807 1026
808=item B<secondaryScroll:> I<bool> 1027=item B<secondaryScroll:> I<boolean>
809 1028
810Turn on/off secondary screen scroll (default enabled). If the this 1029Turn on/off secondary screen scroll (default enabled). If this
811option is enabled, scrolls on the secondary screen will change the 1030option is enabled, scrolls on the secondary screen will change the
812scrollback buffer and switching to/from the secondary screen will 1031scrollback buffer and switching to/from the secondary screen will
813instead scroll the screen up. 1032instead scroll the screen up.
814 1033
1034=item B<hold>: I<boolean>
1035
1036Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1037will not immediately destroy its window when the program executed within
1038it exits. Instead, it will wait till it is being killed or closed by the
1039user.
1040
815=item B<keysym.>I<sym>: I<string> 1041=item B<keysym.>I<sym>: I<string>
816 1042
817Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may 1043Compile I<frills>: Associate I<string> with keysym I<sym>. The
818contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: 1044intervening resource name B<keysym.> cannot be omitted.
819newline, \r: return, \t: 1045
1046The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
1047any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
1048B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
1049and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
1050B<2>, B<3>, B<4>, B<5>.
1051
1052The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1053whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1054keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1055current application keymap mode state.
1056
1057The spellings of I<key> can be obtained by using B<xev>(1) command or
1058searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1059omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1060keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1061performed in an exact manner; however, the closest match is assured.
1062
1063I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
1064C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
820tab, \000: octal number) or control characters (^?: delete, ^@: null, 1065C<\000>: octal number) or verbatim control characters (C<^?>: delete,
821^A ...) and may enclosed with double quotes so that it can start or end 1066C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
822with whitespace. The intervening resource name B<keysym.> cannot be 1067can start or end with whitespace. B<This feature is deprecated and will
823omitted. This resource is only available when compiled with 1068be removed>.
824KEYSYM_RESOURCE. 1069
1070Please note that you need to double the C<\> in resource files, as
1071Xlib itself does its own de-escaping (you can use C<\033> instead of
1072C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1073processing).
1074
1075You can define a range of keysyms in one shot by providing a I<string>
1076with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1077should be a character not used by the strings.
1078
1079Its usage can be demonstrated by an example:
1080
1081 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1082
1083The above line is equivalent to the following three lines:
1084
1085 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
1086 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
1087 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
1088
1089If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1090is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1091example the following means "change the current locale to C<zh_CN.GBK>
1092when Control-Meta-c is being pressed":
1093
1094 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1095
1096If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1097is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1098manpage. For example, the F<selection> extension (activated via
1099C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1100
1101 URxvt.keysym.M-C-c: perl:selection:rot13
1102
1103Due the the large number of modifier combinations, a defined key mapping
1104will match if at I<at least> the specified identifiers are being set, and
1105no other key mappings with those and more bits are being defined. That
1106means that defining a key map for C<a> will automatically provide
1107definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1108mappings themselves.
1109
1110Unfortunately, this will override built-in key mappings. For example
1111if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
1112C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
1113user-defined keymap using the C<builtin:> replacement:
1114
1115 URxvt.keysym.Insert: <my insert key sequence>
1116 URxvt.keysym.S-Insert: builtin:
1117
1118The first line defines a mapping for C<Insert> and I<any> combination
1119of modifiers. The second line re-establishes the default mapping for
1120C<Shift-Insert>.
1121
1122The following example will map Control-Meta-1 and Control-Meta-2 to
1123the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1124font-switching at runtime:
1125
1126 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1127 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1128
1129Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1130info):
1131
1132 URxvt.keysym.M-C-3: command:\033[8;25;80t
1133 URxvt.keysym.M-C-4: command:\033[8;48;110t
1134
1135=item B<perl-ext-common>: I<string>
1136
1137=item B<perl-ext>: I<string>
1138
1139Comma-separated list(s) of perl extension scripts (default: C<default>) to
1140use in this terminal instance; option B<-pe>.
1141
1142Extension names can be prefixed with a C<-> sign to prohibit using
1143them. This can be useful to selectively disable some extensions loaded
1144by default, or specified via the C<perl-ext-common> resource. For
1145example, C<default,-selection> will use all the default extension except
1146C<selection>.
1147
1148Extension names can also be followed by an argument in angle brackets
1149(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1150searchable scrollback to Alt/Meta-s). Mentioning the same extension
1151multiple times with different arguments will pass multiple arguments to
1152the extension.
1153
1154Each extension is looked up in the library directories, loaded if
1155necessary, and bound to the current terminal instance.
1156
1157If both of these resources are the empty string, then the perl
1158interpreter will not be initialized. The idea behind two options is that
1159B<perl-ext-common> will be used for extensions that should be available to
1160all instances, while B<perl-ext> is used for specific instances.
1161
1162=item B<perl-eval>: I<string>
1163
1164Perl code to be evaluated when all extensions have been registered. See
1165the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1166will be ignored when running setuid/setgid.
1167
1168=item B<perl-lib>: I<path>
1169
1170Colon-separated list of additional directories that hold extension
1171scripts. When looking for extensions specified by the C<perl> resource,
1172@@RXVT_NAME@@ will first look in these directories and then in
1173F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1174will be ignored when running setuid/setgid.
1175
1176See the @@RXVT_NAME@@perl(3) manpage.
1177
1178=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1179
1180Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1181details.
1182
1183=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1184
1185Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1186for details.
1187
1188=item B<searchable-scrollback:> I<keysym>
1189
1190Sets the hotkey that starts the incremental scrollback buffer search
1191(default: C<M-s>).
1192
1193=item B<urlLauncher>: I<string>
1194
1195Specifies the program to be started with a URL argument. Used by the
1196C<selection-popup> and C<matcher> perl extensions.
1197
1198=item B<transient-for>: I<windowid>
1199
1200Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1201
1202=item B<override-redirect>: I<boolean>
1203
1204Compile I<frills>: Sets override-redirect for the terminal window, making
1205it almost invisible to window managers; option B<-override-redirect>.
825 1206
826=back 1207=back
827 1208
828=head1 THE SCROLLBAR 1209=head1 THE SCROLLBAR
829 1210
843the normal text selection/insertion, hold either the Shift or the Meta 1224the normal text selection/insertion, hold either the Shift or the Meta
844(Alt) key while performing the desired mouse action. 1225(Alt) key while performing the desired mouse action.
845 1226
846If mouse reporting mode is active, the normal scrollbar actions are 1227If mouse reporting mode is active, the normal scrollbar actions are
847disabled -- on the assumption that we are using a fullscreen 1228disabled -- on the assumption that we are using a fullscreen
848application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 1229application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
849(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 1230(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
850up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down), 1231up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
851respectively. 1232respectively.
852 1233
853=head1 TEXT SELECTION AND INSERTION 1234=head1 THE SELECTION: SELECTING AND PASTING TEXT
854 1235
855The behaviour of text selection and insertion mechanism is similar to 1236The behaviour of text selection and insertion/pasting mechanism is similar
856I<xterm>(1). 1237to I<xterm>(1).
857 1238
858=over 4 1239=over 4
859 1240
860=item B<Selection>: 1241=item B<Selecting>:
861 1242
862Left click at the beginning of the region, drag to the end of the 1243Left click at the beginning of the region, drag to the end of the region
863region and release; Right click to extend the marked region; Left 1244and release; Right click to extend the marked region; Left double-click
864double-click to select a word; Left triple-click to select the entire 1245to select a word; Left triple-click to select the entire logical line
865line. 1246(which can span multiple screen lines), unless modified by resource
1247B<tripleclickwords>.
866 1248
867Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1249Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
868(Compile: frills) will create a rectangular selection instead of a normal 1250(Compile: I<frills>) will create a rectangular selection instead of a
869one. 1251normal one. In this mode, every selected row becomes its own line in the
1252selection, and trailing whitespace is visually underlined and removed from
1253the selection.
870 1254
871=item B<Insertion>: 1255=item B<Pasting>:
872 1256
873Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1257Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
874an B<@@RXVT_NAME@@> window causes the current text selection to be 1258window causes the value of the PRIMARY selection (or CLIPBOARD with the
875inserted as if it had been typed on the keyboard. 1259B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1260
1261Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1262inserted too.
876 1263
877=back 1264=back
878 1265
879=head1 CHANGING FONTS 1266=head1 CHANGING FONTS
880 1267
881Changing fonts (or font sizes, respectively) via the keypad is not yet 1268Changing fonts (or font sizes, respectively) via the keypad is not yet
882supported in rxvt-unicode. Bug me if you need this. 1269supported in rxvt-unicode. Bug me if you need this.
883 1270
884You can, however, switch fonts at runtime using escape sequences (and 1271You can, however, switch fonts at runtime using escape sequences, e.g.:
885therefore using the menubar), e.g.:
886 1272
887 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1273 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1274
1275You can use keyboard shortcuts, too:
1276
1277 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1278 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
888 1279
889rxvt-unicode will automatically re-apply these fonts to the output so far. 1280rxvt-unicode will automatically re-apply these fonts to the output so far.
890 1281
891=head1 ISO 14755 SUPPORT 1282=head1 ISO 14755 SUPPORT
892 1283
896C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1287C<--enable-frills>, the rest is available when rxvt-unicode was compiled
897with C<--enable-iso14755>. 1288with C<--enable-iso14755>.
898 1289
899=over 4 1290=over 4
900 1291
901=item 5.1: Basic method 1292=item * 5.1: Basic method
902 1293
903This allows you to enter unicode characters using their hexcode. 1294This allows you to enter unicode characters using their hexcode.
904 1295
905Start by pressing and holding both C<Control> and C<Shift>, then enter 1296Start by pressing and holding both C<Control> and C<Shift>, then enter
906hex-digits (between one and six). Releasing C<Control> and C<Shift> will 1297hex-digits (between one and six). Releasing C<Control> and C<Shift> will
913address, which you cannot type. Fortunately, the card has the e-mail 1304address, which you cannot type. Fortunately, the card has the e-mail
914address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily 1305address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
915by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>, 1306by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
916followed by releasing the modifier keys. 1307followed by releasing the modifier keys.
917 1308
918=item 5.2: Keyboard symbols entry method 1309=item * 5.2: Keyboard symbols entry method
919 1310
920This mode lets you input characters representing the keycap symbols of 1311This mode lets you input characters representing the keycap symbols of
921your keyboard, if representable in the current locale encoding. 1312your keyboard, if representable in the current locale encoding.
922 1313
923Start by pressing C<Control> and C<Shift> together, then releasing 1314Start by pressing C<Control> and C<Shift> together, then releasing
924them. The next special key (cursor keys, home etc.) you enter will not 1315them. The next special key (cursor keys, home etc.) you enter will not
925invoke it's usual function but instead will insert the corresponding 1316invoke its usual function but instead will insert the corresponding
926keycap symbol. The symbol will only be entered when the key has been 1317keycap symbol. The symbol will only be entered when the key has been
927released, otherwise pressing e.g. C<Shift> would enter the symbol for 1318released, otherwise pressing e.g. C<Shift> would enter the symbol for
928C<ISO Level 2 Switch>, although your intention might have been to enter a 1319C<ISO Level 2 Switch>, although your intention might have been to enter a
929reverse tab (Shift-Tab). 1320reverse tab (Shift-Tab).
930 1321
931=item 5.3: Screen-selection entry method 1322=item * 5.3: Screen-selection entry method
932 1323
933While this is implemented already (it's basically the selection 1324While this is implemented already (it's basically the selection
934mechanism), it could be extended by displaying a unicode character map. 1325mechanism), it could be extended by displaying a unicode character map.
935 1326
936=item 5.4: Feedback method for identifying displayed characters for later input 1327=item * 5.4: Feedback method for identifying displayed characters for later input
937 1328
938This method lets you display the unicode character code associated with 1329This method lets you display the unicode character code associated with
939characters already displayed. 1330characters already displayed.
940 1331
941You enter this mode by holding down C<Control> and C<Shift> together, then 1332You enter this mode by holding down C<Control> and C<Shift> together, then
953With respect to conformance, rxvt-unicode is supposed to be compliant to 1344With respect to conformance, rxvt-unicode is supposed to be compliant to
954both scenario A and B of ISO 14755, including part 5.2. 1345both scenario A and B of ISO 14755, including part 5.2.
955 1346
956=head1 LOGIN STAMP 1347=head1 LOGIN STAMP
957 1348
958B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so 1349B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
959that it can be seen via the I<who(1)> command, and can accept messages. 1350it can be seen via the I<who(1)> command, and can accept messages. To
960To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on 1351allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
961some systems. 1352on some systems or setgid to root or to some other group on others.
962 1353
963=head1 COLORS AND GRAPHICS 1354=head1 COLORS AND GRAPHICS
964 1355
965In addition to the default foreground and background colours, 1356In addition to the default foreground and background colours,
966B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1357B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
967high-intensity bold/blink versions of the same). Here is a list of the 1358high-intensity bold/blink versions of the same). Here is a list of the
968colours with their B<rgb.txt> names. 1359colours with their names.
969 1360
970=begin table 1361=begin table
971 1362
972 B<color0> (black) = Black 1363 B<color0> (black) = Black
973 B<color1> (red) = Red3 1364 B<color1> (red) = Red3
993It is also possible to specify the colour values of B<foreground>, 1384It is also possible to specify the colour values of B<foreground>,
994B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1385B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
995a number 0-15, as a convenient shorthand to reference the colour name of 1386a number 0-15, as a convenient shorthand to reference the colour name of
996color0-color15. 1387color0-color15.
997 1388
1389In addition to the colours defined above, @@RXVT_NAME@@ offers an
1390additional 72 colours. The first 64 of those (with indices 16 to 79)
1391consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
139216>), followed by 8 additional shades of gray (with indices 80 to 87).
1393
1394Together, all those colours implement the 88 colour xterm colours. Only
1395the first 16 can be changed using resources currently, the rest can only
1396be changed via command sequences ("escape codes").
1397
998Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1398Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
999always swapping the foreground/background colours. This is in contrast to 1399always swapping the foreground/background colours. This is in contrast to
1000I<xterm>(1) where the colours are only swapped if they have not otherwise 1400I<xterm>(1) where the colours are only swapped if they have not otherwise
1001been specified. For example, 1401been specified. For example,
1002 1402
1007would yield White on Black, while on I<xterm>(1) it would yield Black 1407would yield White on Black, while on I<xterm>(1) it would yield Black
1008on White. 1408on White.
1009 1409
1010=back 1410=back
1011 1411
1412=head2 ALPHA CHANNEL SUPPORT
1413
1414If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1415their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1416(recommended, but B<MUST> have 4 digits/component) colour specifications,
1417in addition to the ones provided by X, where the additional A component
1418specifies opacity (alpha) values. The minimum value of C<0> is completely
1419transparent). You can also prefix any color with C<[percent]>, where
1420C<percent> is a decimal percentage (0-100) that specifies the opacity of
1421the color, where C<0> is completely transparent and C<100> is completelxy
1422opaque.
1423
1424You probably need to specify B<"-depth 32">, too, and have the luck that
1425your X-server uses ARGB pixel layout, as X is far from just supporting
1426ARGB visuals out of the box, and rxvt-unicode just fudges around.
1427
1428For example, the following selects an almost completely transparent red
1429background, and an almost opaque pink foreground:
1430
1431 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1432
1433I<Please note that transparency of any kind if completely unsupported by
1434the author. Don't bug him with installation questions!>
1435
1012=head1 ENVIRONMENT 1436=head1 ENVIRONMENT
1013 1437
1014B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> 1438B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1015and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X 1439
1016window id number of the B<@@RXVT_NAME@@> window and it also uses and 1440=over 4
1017sets the environment variable B<DISPLAY> to specify which display 1441
1018terminal to use. B<@@RXVT_NAME@@> uses the environment variables 1442=item B<TERM>
1019B<RXVTPATH> and B<PATH> to find XPM files. 1443
1444Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1445resources or on the command line.
1446
1447=item B<COLORTERM>
1448
1449Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1450compiled with XPM support, and optionally with the added extension
1451C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1452
1453=item B<COLORFGBG>
1454
1455Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1456the colour code used as default foreground/text colour (or the string
1457C<default> to indicate that the default-colour escape sequence is to be
1458used), C<bg> is the colour code used as default background colour (or the
1459string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1460was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
1461(and do) use this information to optimize screen output.
1462
1463=item B<WINDOWID>
1464
1465Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1466window, which usually has subwindows for the scrollbar, the terminal
1467window and so on).
1468
1469=item B<TERMINFO>
1470
1471Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1472C<--with-terminfo=PATH>.
1473
1474=item B<DISPLAY>
1475
1476Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1477display in its child processes.
1478
1479=item B<SHELL>
1480
1481The shell to be used for command execution, defaults to C</bin/sh>.
1482
1483=item B<RXVT_SOCKET>
1484
1485The unix domain socket path used by @@RXVT_NAME@@c(1) and
1486@@RXVT_NAME@@d(1).
1487
1488Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1489
1490=item B<HOME>
1491
1492Used to locate the default directory for the unix domain socket for
1493daemon communications and to locate various resource files (such as
1494C<.Xdefaults>)
1495
1496=item B<XAPPLRESDIR>
1497
1498Directory where various X resource files are being located.
1499
1500=item B<XENVIRONMENT>
1501
1502If set and accessible, gives the name of a X resource file to be loaded by
1503@@RXVT_NAME@@.
1504
1505=back
1020 1506
1021=head1 FILES 1507=head1 FILES
1022 1508
1023=over 4 1509=over 4
1024 1510
1025=item B</etc/utmp>
1026
1027System file for login records.
1028
1029=item B</usr/lib/X11/rgb.txt> 1511=item B</usr/lib/X11/rgb.txt>
1030 1512
1031Color names. 1513Color names.
1032 1514
1033=back 1515=back
1034 1516
1035=head1 SEE ALSO 1517=head1 SEE ALSO
1036 1518
1037@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1519@@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)
1038
1039=head1 BUGS
1040
1041Check the BUGS file for an up-to-date list.
1042
1043Cursor change support is not yet implemented.
1044
1045Click-and-drag doesn't work with X11 mouse report overriding.
1046 1520
1047=head1 CURRENT PROJECT COORDINATOR 1521=head1 CURRENT PROJECT COORDINATOR
1048 1522
1049=over 4 1523=over 4
1050 1524
1051=item Project Coordinator 1525=item Project Coordinator
1052 1526
1053@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1527Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1054 1528
1055=item Web page maintainter 1529L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1056
1057@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1058
1059L<@@RXVT_WEBPAGE@@>
1060 1530
1061=back 1531=back
1062 1532
1063=head1 AUTHORS 1533=head1 AUTHORS
1064 1534
1086 1556
1087Project Coordinator (changes.txt 2.21a to 2.4.5) 1557Project Coordinator (changes.txt 2.21a to 2.4.5)
1088 1558
1089=item Geoff Wing L<< <gcw@pobox.com> >> 1559=item Geoff Wing L<< <gcw@pobox.com> >>
1090 1560
1091Rewrote screen display and text selection routines. Project Coordinator 1561Rewrote screen display and text selection routines.
1562
1092(changes.txt 2.4.6 - rxvt-unicode) 1563Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1093 1564
1094=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1565=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1095 1566
1096Forked rxvt-unicode, rewrote most of the display code and internal 1567Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1097character handling to store text in unicode, improve xterm 1568extension, random hacks, numerous bugfixes and extensions.
1098compatibility and apply numerous other bugfixes and extensions.
1099 1569
1100Project Coordinator (Changes 1.0 -) 1570Project Coordinator (Changes 1.0 -)
1101 1571
1572=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1573
1574Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1575
1102=back 1576=back
1103 1577

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines