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.30 by root, Wed Sep 8 17:10:23 2004 UTC vs.
Revision 1.131 by ayin, Sat Jun 9 09:05:38 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 reasonable default font list is 203smaller, but not (in general) larger. A (hopefully) reasonable default
168always appended to it. See resource B<font> for details. 204font list is always appended to it. See resource B<font> for more details.
205
206In short, to specify an X11 core font, just specify its name or prefix it
207with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
208e.g.:
209
210 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
211 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
169 212
170See 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
171section of @@RXVT_NAME@@(7). 214section of @@RXVT_NAME@@(7).
172 215
173=item B<-fb> I<fontlist> 216=item B<-fb> I<fontlist>
174 217
175Compile 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
176be printed. See resource B<boldFont> for details. 219are to be printed. See resource B<boldFont> for details.
177 220
178=item B<-fi> I<fontlist> 221=item B<-fi> I<fontlist>
179 222
180Compile 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>
181be printed. See resource B<italicFont> for details. 224characters are to be printed. See resource B<italicFont> for details.
182 225
183=item B<-fbi> I<fontlist> 226=item B<-fbi> I<fontlist>
184 227
185Compile 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
186be 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.
187 237
188=item B<-name> I<name> 238=item B<-name> I<name>
189 239
190Specify the application name under which resources are to be obtained, 240Specify the application name under which resources are to be obtained,
191rather than the default executable file name. Name should not contain 241rather than the default executable file name. Name should not contain
229 279
230Put scrollbar on right/left; resource B<scrollBar_right>. 280Put scrollbar on right/left; resource B<scrollBar_right>.
231 281
232=item B<-st>|B<+st> 282=item B<-st>|B<+st>
233 283
234Display normal (non XTerm/NeXT) scrollbar without/with a trough; 284Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
235resource B<scrollBar_floating>. 285resource B<scrollBar_floating>.
286
287=item B<-ptab>|B<+ptab>
288
289If enabled (default), "Horizontal Tab" characters are being stored as
290actual wide characters in the screen buffer, which makes it possible to
291select and paste them. Since a horizontal tab is a cursor movement and
292not an actual glyph, this can sometimes be visually annoying as the cursor
293on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
236 294
237=item B<-bc>|B<+bc> 295=item B<-bc>|B<+bc>
238 296
239Blink the cursor; resource B<cursorBlink>. 297Blink the cursor; resource B<cursorBlink>.
240 298
263 321
264Compile 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.
265if 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
266decorations; resource B<borderLess>. 324decorations; resource B<borderLess>.
267 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
268=item B<-lsp> I<number> 338=item B<-lsp> I<number>
269 339
270Compile I<linespace>: Lines (pixel height) to insert between each row 340Compile I<frills>: Lines (pixel height) to insert between each row of
271of the display; resource B<linespace>. 341the display. Useful to work around font rendering problems; resource
342B<linespace>.
272 343
273=item B<-tn> I<termname> 344=item B<-tn> I<termname>
274 345
275This 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
276B<TERM> environment variable. This terminal type must exist in the 347B<TERM> environment variable. This terminal type must exist in the
285given 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
286on 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
287run the program specified by the B<SHELL> environment variable or, 358run the program specified by the B<SHELL> environment variable or,
288failing that, I<sh(1)>. 359failing that, I<sh(1)>.
289 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
290=item B<-title> I<text> 366=item B<-title> I<text>
291 367
292Window title (B<-T> still respected); the default title is the basename 368Window title (B<-T> still respected); the default title is the basename
293of 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
294application name; resource B<title>. 370application name; resource B<title>.
312 388
313Compile I<XIM>: input method name. resource B<inputMethod>. 389Compile I<XIM>: input method name. resource B<inputMethod>.
314 390
315=item B<-imlocale> I<string> 391=item B<-imlocale> I<string>
316 392
317The 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.
318de_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
319extension to be able to input japanese characters while staying in 395input extension to be able to input japanese characters while staying in
320another 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>.
321 409
322=item B<-insecure> 410=item B<-insecure>
323 411
324Enable "insecure" mode, which currently enables most of the escape 412Enable "insecure" mode, which currently enables most of the escape
325sequences that echo strings. See the resource B<insecure> for more 413sequences that echo strings. See the resource B<insecure> for more
339=item B<-ssr>|B<+ssr> 427=item B<-ssr>|B<+ssr>
340 428
341Turn on/off secondary screen scroll (default enabled); resource 429Turn on/off secondary screen scroll (default enabled); resource
342B<secondaryScroll>. 430B<secondaryScroll>.
343 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
344=item B<-xrm> I<resourcestring> 499=item B<-pe> I<string>
345 500
346No 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
347available in the instance's argument list. Appears in I<WM_COMMAND> in 502this terminal instance. See resource B<perl-ext> for details.
348some window managers.
349 503
350=back 504=back
351 505
352=head1 RESOURCES (available also as long-options) 506=head1 RESOURCES (available also as long-options)
353 507
354Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 508Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
355options) compiled into your version. 509options) compiled into your version.
356 510
357There 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
358Xresource data: using the X libraries (Xrm*-functions) or internal 512distribution do also load settings from the B<~/.Xresources> file when X
359Xresources reader (B<~/.Xdefaults>). For the first method (ie. 513starts. @@RXVT_NAME@@ will consult the following files/resources in order,
360B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 514with later settings overwriting earlier ones:
361resources using X11 tools like B<xset>. Many distribution do also load
362settings from the B<~/.Xresources> file when X starts.
363 515
364If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> 516 1. system-wide app-defaults file, either locale-dependent OR global
365lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults 517 2. app-defaults file in $XAPPLRESDIR
366set in XAPPLOADDIR/URxvt (compile-time defined: usually 518 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
367B</usr/lib/X11/app-defaults/URxvt>) and resources set in 519 4. SCREEN_RESOURCES for the current screen
368B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist. 520 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
521
369Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 522Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
370class 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
371resources 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
372easily configured, while the class name B<URxvt> allows resources 525configured, while the class name B<URxvt> allows resources unique to
373unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 526B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
374shared between different B<@@RXVT_NAME@@> configurations. If no 527configurations. If no resources are specified, suitable defaults will
375resources are specified, suitable defaults will be used. Command-line 528be used. Command-line arguments can be used to override resource
376arguments can be used to override resource settings. The following 529settings. The following resources are supported (you might want to
377resources are allowed: 530check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
531extensions not documented here):
378 532
379=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>.
380 539
381=item B<geometry:> I<geom> 540=item B<geometry:> I<geom>
382 541
383Create the window with the specified X window geometry [default 80x24]; 542Create the window with the specified X window geometry [default 80x24];
384option B<-geometry>. 543option B<-geometry>.
412 571
413=item B<colorIT:> I<colour> 572=item B<colorIT:> I<colour>
414 573
415Use the specified colour to display bold or italic characters when the 574Use the specified colour to display bold or italic characters when the
416foreground colour is the default. If font styles are not available 575foreground colour is the default. If font styles are not available
417(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.
418 577
419=item B<colorUL:> I<colour> 578=item B<colorUL:> I<colour>
420 579
421Use the specified colour to display underlined characters when the 580Use the specified colour to display underlined characters when the
422foreground colour is the default. 581foreground colour is the default.
423 582
424=item B<colorRV:> I<colour> 583=item B<colorRV:> I<colour>
425 584
426Use the specified colour as the background for reverse video 585Use the specified colour as the background for reverse video characters
427characters. 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.
428 592
429=item B<cursorColor:> I<colour> 593=item B<cursorColor:> I<colour>
430 594
431Use 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
432foreground colour; option B<-cr>. 596foreground colour; option B<-cr>.
453 617
454B<True>: make the background inherit the parent windows' pixmap, giving 618B<True>: make the background inherit the parent windows' pixmap, giving
455artificial transparency. B<False>: do not inherit the parent windows' 619artificial transparency. B<False>: do not inherit the parent windows'
456pixmap. 620pixmap.
457 621
622I<Please note that transparency of any kind if completely unsupported by
623the author. Don't bug him with installation questions!>
624
458=item B<fading:> I<number> 625=item B<fading:> I<number>
459 626
460Fade 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>.
461 633
462=item B<tintColor:> I<colour> 634=item B<tintColor:> I<colour>
463 635
464Tint the transparent background pixmap with the given colour. 636Tint the transparent background pixmap with the given colour; option
637B<-tint>.
465 638
466=item B<shading:> I<number> 639=item B<shading:> I<number>
467 640
468Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 641Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
469image in addition to tinting it. 642in addition to tinting it; option B<-sh>.
470 643
644=item B<blendType:> I<string>
645
646Specify background blending type; option B<-blt>.
647
471=item B<fading:> I<number> 648=item B<blurRadius:> I<number>
472 649
473Scale the tint colour by the given percentage. 650Apply Gaussian Blurr with the specified radius to the transparent
651background image; option B<-blr>.
474 652
475=item B<scrollColor:> I<colour> 653=item B<scrollColor:> I<colour>
476 654
477Use the specified colour for the scrollbar [default #B2B2B2]. 655Use the specified colour for the scrollbar [default #B2B2B2].
478 656
479=item B<troughColor:> I<colour> 657=item B<troughColor:> I<colour>
480 658
481Use the specified colour for the scrollbar's trough area [default 659Use the specified colour for the scrollbar's trough area [default
482#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 660#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
483 661
484=item B<borderColor:> I<colour> 662=item B<borderColor:> I<colour>
485 663
486The 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
487and the text. 665and the text.
488 666
489=item B<backgroundPixmap:> I<file[;geom]> 667=item B<backgroundPixmap:> I<file[;geom]>
490 668
491Use the specified XPM file (note the `.xpm' extension is optional) for 669Use the specified image file for the background and also optionally
492the background and also optionally specify its scaling with a geometry 670specify its scaling with a geometry string B<WxH+X+Y>,
493string B<WxH+X+Y>, in which B<"W" / "H"> specify the 671in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
494horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 672and B<"X" / "Y"> locate the image centre (percent).
495centre (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
496of 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
497specifies an integer number of images in that direction. No image will 675number of images in that direction. No image will be magnified beyond
498be magnified beyond 10 times its original size. The maximum permitted 67610 times its original size. The maximum permitted scale is 1000.
499scale is 1000. [default 0x0+50+50] 677Special string of B<"auto"> used as a geometry will cause image to be
500 678automatically scaled to match window size.
501=item B<menu:> I<file[;tag]> 679If used in conjunction with B<-tr> option - specified pixmap will be
502 680blended over transparency image using either alpha-blending, or any
503Read in the specified menu file (note the `.menu' extension is 681other blending type, specified with B<-blt "type"> option.
504optional) and also optionally specify a starting tag to find. See the 682[default 0x0+50+50]
505reference documentation for details on the syntax for the menuBar.
506 683
507=item B<path:> I<path> 684=item B<path:> I<path>
508 685
509Specify the colon-delimited search path for finding files (XPM and 686Specify the colon-delimited search path for finding XPM files.
510menus), in addition to the paths specified by the B<RXVTPATH> and
511B<PATH> environment variables.
512 687
513=item B<font:> I<fontlist> 688=item B<font:> I<fontlist>
514 689
515Select 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
516names that are used in turn when trying to display Unicode characters. 691that are checked in order when trying to find glyphs for characters. The
517The first font defines the cell size for characters; other fonts might 692first font defines the cell size for characters; other fonts might be
518be smaller, but not larger. A reasonable default font list is always 693smaller, but not (in general) larger. A (hopefully) reasonable default
519appended to it. option B<-fn>. 694font list is always appended to it; option B<-fn>.
520 695
521Each 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
522optional 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:>.
523 698
524In addition, each font can be prefixed with additional hints and 699In addition, each font can be prefixed with additional hints and
525specifications enclosed in square brackets (C<[]>). The only available 700specifications enclosed in square brackets (C<[]>). The only available
526hint 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
527fonts. 702fonts.
528 703
529For example, this font resource 704For example, this font resource
530 705
531 URxvt*font: 9x15bold,\ 706 URxvt.font: 9x15bold,\
532 -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,\
533 -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, \
534 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 709 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
535 xft:Code2000:antialias=false 710 xft:Code2000:antialias=false
536 711
537specifies five fonts to be used. The first one is C<9x15bold> (actually 712specifies five fonts to be used. The first one is C<9x15bold> (actually
538the iso8859-1 version of the second font), which is the base font (because 713the iso8859-1 version of the second font), which is the base font (because
539it is named first) and thus defines the character cell grid to be 9 pixels 714it is named first) and thus defines the character cell grid to be 9 pixels
540wide and 15 pixels high. 715wide and 15 pixels high.
541 716
542the second font is just used to add additional unicode characters not in 717The second font is just used to add additional unicode characters not in
543the base font, likewise the third, which is unfortunately non-bold, but 718the base font, likewise the third, which is unfortunately non-bold, but
544the bold version of the font does contain less characters, so this is a 719the bold version of the font does contain less characters, so this is a
545useful supplement. 720useful supplement.
546 721
547The third font is an Xft font with aliasing turned off, and the characters 722The third font is an Xft font with aliasing turned off, and the characters
570not possible, replacement fonts of the desired shape will be tried. 745not possible, replacement fonts of the desired shape will be tried.
571 746
572If 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
573text font will being used for the given style. 748text font will being used for the given style.
574 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
575=item B<selectstyle:> I<mode> 758=item B<selectstyle:> I<mode>
576 759
577Set 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
578xterm 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
579xterm style selection. 762gives xterm style selection. Only effective when the original (non-perl)
763selection code is in use.
580 764
581=item B<scrollstyle:> I<mode> 765=item B<scrollstyle:> I<mode>
582 766
583Set 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
584the author's favourite.. 768the author's favourite.
585 769
586=item B<title:> I<string> 770=item B<title:> I<string>
587 771
588Set window title string, the default title is the command-line 772Set window title string, the default title is the command-line
589specified after the B<-e> option, if any, otherwise the application 773specified after the B<-e> option, if any, otherwise the application
598=item B<mapAlert:> I<boolean> 782=item B<mapAlert:> I<boolean>
599 783
600B<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
601de-iconify (map) on receipt of a bell character [default]. 785de-iconify (map) on receipt of a bell character [default].
602 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
603=item B<visualBell:> I<boolean> 792=item B<visualBell:> I<boolean>
604 793
605B<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>.
606B<False>: no visual bell [default]; option B<+vb>. 795B<False>: no visual bell [default]; option B<+vb>.
607 796
621 810
622Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 811Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
623B<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
624B<Shift-Print> to include the scrollback as well. 813B<Shift-Print> to include the scrollback as well.
625 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
626=item B<scrollBar:> I<boolean> 824=item B<scrollBar:> I<boolean>
627 825
628B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 826B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
629disable the scrollbar; option B<+sb>. 827disable the scrollbar; option B<+sb>.
630 828
650B<+si>. 848B<+si>.
651 849
652=item B<scrollWithBuffer:> I<boolean> 850=item B<scrollWithBuffer:> I<boolean>
653 851
654B<True>: scroll with scrollback buffer when tty receives new lines (and 852B<True>: scroll with scrollback buffer when tty receives new lines (and
655B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 853B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
656with scrollback buffer when tty recieves new lines; option B<-sw>. 854with scrollback buffer when tty receives new lines; option B<+sw>.
657 855
658=item B<scrollTtyKeypress:> I<boolean> 856=item B<scrollTtyKeypress:> I<boolean>
659 857
660B<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
661are those which are intercepted by rxvt-unicode for special handling and 859are those which are intercepted by rxvt-unicode for special handling and
680=item B<borderLess:> I<boolean> 878=item B<borderLess:> I<boolean>
681 879
682Set 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
683WM, 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>.
684 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
685=item B<termName:> I<termname> 890=item B<termName:> I<termname>
686 891
687Specifies 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
688variable; option B<-tn>. 893variable; option B<-tn>.
689 894
699 904
700=item B<mouseWheelScrollPage:> I<boolean> 905=item B<mouseWheelScrollPage:> I<boolean>
701 906
702B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel 907B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
703scrolls five lines [default]. 908scrolls five lines [default].
909
910=item B<pastableTabs:> I<boolean>
911
912B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
913movement only; option C<-ptab>.
704 914
705=item B<cursorBlink:> I<boolean> 915=item B<cursorBlink:> I<boolean>
706 916
707B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 917B<True>: blink the cursor. B<False>: do not blink the cursor [default];
708option B<-bc>. 918option B<-bc>.
721 931
722Mouse pointer background colour. 932Mouse pointer background colour.
723 933
724=item B<pointerBlankDelay:> I<number> 934=item B<pointerBlankDelay:> I<number>
725 935
726Specifies 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.
727 938
728=item B<backspacekey:> I<string> 939=item B<backspacekey:> I<string>
729 940
730The 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>
731or 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>
738pressed. If unset it will send the sequence traditionally associated 949pressed. If unset it will send the sequence traditionally associated
739with the B<Execute> key. 950with the B<Execute> key.
740 951
741=item B<cutchars:> I<string> 952=item B<cutchars:> I<string>
742 953
743The characters used as delimiters for double-click word selection. The 954The characters used as delimiters for double-click word selection
744built-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:
745 964
746B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 965B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
747 966
748=item B<preeditType:> I<style> 967=item B<preeditType:> I<style>
749 968
753 972
754I<name> of inputMethod to use; option B<-im>. 973I<name> of inputMethod to use; option B<-im>.
755 974
756=item B<imLocale:> I<name> 975=item B<imLocale:> I<name>
757 976
758The 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.
759de_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
760extension to be able to input japanese characters while staying in 979input extension to be able to input japanese characters while staying in
761another 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>.
762 996
763=item B<insecure:> I<boolean> 997=item B<insecure:> I<boolean>
764 998
765Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 999Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
766echo 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
767abused if somebody gets 8-bit-clean access to your display, whether 1001abused if somebody gets 8-bit-clean access to your display, whether
768throuh a mail client displaying mail bodies unfiltered or though 1002through a mail client displaying mail bodies unfiltered or through
769write(1). Therefore, these sequences are disabled by default. (Note 1003write(1) or any other means. Therefore, these sequences are disabled by
770that other terminals, including xterm, have these sequences 1004default. (Note that many other terminals, including xterm, have these
771enabled by default). You can enable them by setting this boolean 1005sequences enabled by default, which doesn't make it safer, though).
772resource or specifying B<-insecure> as an option. At the moment, this 1006
773enabled display-answer, locale, findfont, icon label and window title 1007You can enable them by setting this boolean resource or specifying
774requests 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.
775 1010
776=item B<modifier:> I<modifier> 1011=item B<modifier:> I<modifier>
777 1012
778Set 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>,
779B<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
783 1018
784Specify 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)
785character is passed through. It may contain escape values as described 1020character is passed through. It may contain escape values as described
786in the entry on B<keysym> following. 1021in the entry on B<keysym> following.
787 1022
788=item B<secondaryScreen:> I<bool> 1023=item B<secondaryScreen:> I<boolean>
789 1024
790Turn on/off secondary screen (default enabled). 1025Turn on/off secondary screen (default enabled).
791 1026
792=item B<secondaryScroll:> I<bool> 1027=item B<secondaryScroll:> I<boolean>
793 1028
794Turn on/off secondary screen scroll (default enabled). If the this 1029Turn on/off secondary screen scroll (default enabled). If this
795option is enabled, scrolls on the secondary screen will change the 1030option is enabled, scrolls on the secondary screen will change the
796scrollback buffer and switching to/from the secondary screen will 1031scrollback buffer and switching to/from the secondary screen will
797instead scroll the screen up. 1032instead scroll the screen up.
798 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
799=item B<keysym.>I<sym>: I<string> 1041=item B<keysym.>I<sym>: I<string>
800 1042
801Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may 1043Compile I<frills>: Associate I<string> with keysym I<sym>. The
802contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: 1044intervening resource name B<keysym.> cannot be omitted.
803newline, \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,
804tab, \000: octal number) or control characters (^?: delete, ^@: null, 1065C<\000>: octal number) or verbatim control characters (C<^?>: delete,
805^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
806with whitespace. The intervening resource name B<keysym.> cannot be 1067can start or end with whitespace. B<This feature is deprecated and will
807omitted. This resource is only available when compiled with 1068be removed>.
808KEYSYM_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>.
1206
1207=item B<iso14755_52:> I<boolean>
1208
1209Turn on/off ISO 14755 5.2 mode (default enabled).
809 1210
810=back 1211=back
811 1212
812=head1 THE SCROLLBAR 1213=head1 THE SCROLLBAR
813 1214
827the normal text selection/insertion, hold either the Shift or the Meta 1228the normal text selection/insertion, hold either the Shift or the Meta
828(Alt) key while performing the desired mouse action. 1229(Alt) key while performing the desired mouse action.
829 1230
830If mouse reporting mode is active, the normal scrollbar actions are 1231If mouse reporting mode is active, the normal scrollbar actions are
831disabled -- on the assumption that we are using a fullscreen 1232disabled -- on the assumption that we are using a fullscreen
832application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 1233application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
833(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 1234(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
834up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down), 1235up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
835respectively. 1236respectively.
836 1237
837=head1 TEXT SELECTION AND INSERTION 1238=head1 THE SELECTION: SELECTING AND PASTING TEXT
838 1239
839The behaviour of text selection and insertion mechanism is similar to 1240The behaviour of text selection and insertion/pasting mechanism is similar
840I<xterm>(1). 1241to I<xterm>(1).
841 1242
842=over 4 1243=over 4
843 1244
844=item B<Selection>: 1245=item B<Selecting>:
845 1246
846Left click at the beginning of the region, drag to the end of the 1247Left click at the beginning of the region, drag to the end of the region
847region and release; Right click to extend the marked region; Left 1248and release; Right click to extend the marked region; Left double-click
848double-click to select a word; Left triple-click to select the entire 1249to select a word; Left triple-click to select the entire logical line
849line. 1250(which can span multiple screen lines), unless modified by resource
1251B<tripleclickwords>.
850 1252
851Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1253Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
852(Compile: frills) will create a rectangular selection instead of a normal 1254(Compile: I<frills>) will create a rectangular selection instead of a
853one. 1255normal one. In this mode, every selected row becomes its own line in the
1256selection, and trailing whitespace is visually underlined and removed from
1257the selection.
854 1258
855=item B<Insertion>: 1259=item B<Pasting>:
856 1260
857Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1261Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
858an B<@@RXVT_NAME@@> window causes the current text selection to be 1262window causes the value of the PRIMARY selection (or CLIPBOARD with the
859inserted as if it had been typed on the keyboard. 1263B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1264
1265Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1266inserted too.
860 1267
861=back 1268=back
862 1269
863=head1 CHANGING FONTS 1270=head1 CHANGING FONTS
864 1271
865Changing fonts (or font sizes, respectively) via the keypad is not yet 1272Changing fonts (or font sizes, respectively) via the keypad is not yet
866supported in rxvt-unicode. Bug me if you need this. 1273supported in rxvt-unicode. Bug me if you need this.
867 1274
868You can, however, switch fonts at runtime using escape sequences (and 1275You can, however, switch fonts at runtime using escape sequences, e.g.:
869therefore using the menubar), e.g.:
870 1276
871 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1277 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1278
1279You can use keyboard shortcuts, too:
1280
1281 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1282 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
872 1283
873rxvt-unicode will automatically re-apply these fonts to the output so far. 1284rxvt-unicode will automatically re-apply these fonts to the output so far.
874 1285
875=head1 ISO 14755 SUPPORT 1286=head1 ISO 14755 SUPPORT
876 1287
880C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1291C<--enable-frills>, the rest is available when rxvt-unicode was compiled
881with C<--enable-iso14755>. 1292with C<--enable-iso14755>.
882 1293
883=over 4 1294=over 4
884 1295
885=item 5.1: Basic method 1296=item * 5.1: Basic method
886 1297
887This allows you to enter unicode characters using their hexcode. 1298This allows you to enter unicode characters using their hexcode.
888 1299
889Start by pressing and holding both C<Control> and C<Shift>, then enter 1300Start by pressing and holding both C<Control> and C<Shift>, then enter
890hex-digits (between one and six). Releasing C<Control> and C<Shift> will 1301hex-digits (between one and six). Releasing C<Control> and C<Shift> will
897address, which you cannot type. Fortunately, the card has the e-mail 1308address, which you cannot type. Fortunately, the card has the e-mail
898address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily 1309address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
899by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>, 1310by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
900followed by releasing the modifier keys. 1311followed by releasing the modifier keys.
901 1312
902=item 5.2: Keyboard symbols entry method 1313=item * 5.2: Keyboard symbols entry method
903 1314
904This mode lets you input characters representing the keycap symbols of 1315This mode lets you input characters representing the keycap symbols of
905your keyboard, if representable in the current locale encoding. 1316your keyboard, if representable in the current locale encoding.
906 1317
907Start by pressing C<Control> and C<Shift> together, then releasing 1318Start by pressing C<Control> and C<Shift> together, then releasing
908them. The next special key (cursor keys, home etc.) you enter will not 1319them. The next special key (cursor keys, home etc.) you enter will not
909invoke it's usual function but instead will insert the corresponding 1320invoke its usual function but instead will insert the corresponding
910keycap symbol. The symbol will only be entered when the key has been 1321keycap symbol. The symbol will only be entered when the key has been
911released, otherwise pressing e.g. C<Shift> would enter the symbol for 1322released, otherwise pressing e.g. C<Shift> would enter the symbol for
912C<ISO Level 2 Switch>, although your intention might have been to enter a 1323C<ISO Level 2 Switch>, although your intention might have been to enter a
913reverse tab (Shift-Tab). 1324reverse tab (Shift-Tab).
914 1325
915=item 5.3: Screen-selection entry method 1326=item * 5.3: Screen-selection entry method
916 1327
917While this is implemented already (it's basically the selection 1328While this is implemented already (it's basically the selection
918mechanism), it could be extended by displaying a unicode character map. 1329mechanism), it could be extended by displaying a unicode character map.
919 1330
920=item 5.4: Feedback method for identifying displayed characters for later input 1331=item * 5.4: Feedback method for identifying displayed characters for later input
921 1332
922This method lets you display the unicode character code associated with 1333This method lets you display the unicode character code associated with
923characters already displayed. 1334characters already displayed.
924 1335
925You enter this mode by holding down C<Control> and C<Shift> together, then 1336You enter this mode by holding down C<Control> and C<Shift> together, then
937With respect to conformance, rxvt-unicode is supposed to be compliant to 1348With respect to conformance, rxvt-unicode is supposed to be compliant to
938both scenario A and B of ISO 14755, including part 5.2. 1349both scenario A and B of ISO 14755, including part 5.2.
939 1350
940=head1 LOGIN STAMP 1351=head1 LOGIN STAMP
941 1352
942B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so 1353B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
943that it can be seen via the I<who(1)> command, and can accept messages. 1354it can be seen via the I<who(1)> command, and can accept messages. To
944To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on 1355allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
945some systems. 1356on some systems or setgid to root or to some other group on others.
946 1357
947=head1 COLORS AND GRAPHICS 1358=head1 COLORS AND GRAPHICS
948 1359
949In addition to the default foreground and background colours, 1360In addition to the default foreground and background colours,
950B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1361B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
951high-intensity bold/blink versions of the same). Here is a list of the 1362high-intensity bold/blink versions of the same). Here is a list of the
952colours with their B<rgb.txt> names. 1363colours with their names.
953 1364
954=begin table 1365=begin table
955 1366
956 B<color0> (black) = Black 1367 B<color0> (black) = Black
957 B<color1> (red) = Red3 1368 B<color1> (red) = Red3
977It is also possible to specify the colour values of B<foreground>, 1388It is also possible to specify the colour values of B<foreground>,
978B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1389B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
979a number 0-15, as a convenient shorthand to reference the colour name of 1390a number 0-15, as a convenient shorthand to reference the colour name of
980color0-color15. 1391color0-color15.
981 1392
1393In addition to the colours defined above, @@RXVT_NAME@@ offers an
1394additional 72 colours. The first 64 of those (with indices 16 to 79)
1395consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
139616>), followed by 8 additional shades of gray (with indices 80 to 87).
1397
1398Together, all those colours implement the 88 colour xterm colours. Only
1399the first 16 can be changed using resources currently, the rest can only
1400be changed via command sequences ("escape codes").
1401
982Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1402Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
983always swapping the foreground/background colours. This is in contrast to 1403always swapping the foreground/background colours. This is in contrast to
984I<xterm>(1) where the colours are only swapped if they have not otherwise 1404I<xterm>(1) where the colours are only swapped if they have not otherwise
985been specified. For example, 1405been specified. For example,
986 1406
991would yield White on Black, while on I<xterm>(1) it would yield Black 1411would yield White on Black, while on I<xterm>(1) it would yield Black
992on White. 1412on White.
993 1413
994=back 1414=back
995 1415
1416=head2 ALPHA CHANNEL SUPPORT
1417
1418If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1419their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1420(recommended, but B<MUST> have 4 digits/component) colour specifications,
1421in addition to the ones provided by X, where the additional A component
1422specifies opacity (alpha) values. The minimum value of C<0> is completely
1423transparent). You can also prefix any color with C<[percent]>, where
1424C<percent> is a decimal percentage (0-100) that specifies the opacity of
1425the color, where C<0> is completely transparent and C<100> is completelxy
1426opaque.
1427
1428You probably need to specify B<"-depth 32">, too, and have the luck that
1429your X-server uses ARGB pixel layout, as X is far from just supporting
1430ARGB visuals out of the box, and rxvt-unicode just fudges around.
1431
1432For example, the following selects an almost completely transparent red
1433background, and an almost opaque pink foreground:
1434
1435 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1436
1437I<Please note that transparency of any kind if completely unsupported by
1438the author. Don't bug him with installation questions!>
1439
996=head1 ENVIRONMENT 1440=head1 ENVIRONMENT
997 1441
998B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> 1442B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
999and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X 1443
1000window id number of the B<@@RXVT_NAME@@> window and it also uses and 1444=over 4
1001sets the environment variable B<DISPLAY> to specify which display 1445
1002terminal to use. B<@@RXVT_NAME@@> uses the environment variables 1446=item B<TERM>
1003B<RXVTPATH> and B<PATH> to find XPM files. 1447
1448Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1449resources or on the command line.
1450
1451=item B<COLORTERM>
1452
1453Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1454compiled with XPM support, and optionally with the added extension
1455C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1456
1457=item B<COLORFGBG>
1458
1459Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1460the colour code used as default foreground/text colour (or the string
1461C<default> to indicate that the default-colour escape sequence is to be
1462used), C<bg> is the colour code used as default background colour (or the
1463string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1464was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
1465(and do) use this information to optimize screen output.
1466
1467=item B<WINDOWID>
1468
1469Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1470window, which usually has subwindows for the scrollbar, the terminal
1471window and so on).
1472
1473=item B<TERMINFO>
1474
1475Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1476C<--with-terminfo=PATH>.
1477
1478=item B<DISPLAY>
1479
1480Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1481display in its child processes.
1482
1483=item B<SHELL>
1484
1485The shell to be used for command execution, defaults to C</bin/sh>.
1486
1487=item B<RXVT_SOCKET>
1488
1489The unix domain socket path used by @@RXVT_NAME@@c(1) and
1490@@RXVT_NAME@@d(1).
1491
1492Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1493
1494=item B<HOME>
1495
1496Used to locate the default directory for the unix domain socket for
1497daemon communications and to locate various resource files (such as
1498C<.Xdefaults>)
1499
1500=item B<XAPPLRESDIR>
1501
1502Directory where various X resource files are being located.
1503
1504=item B<XENVIRONMENT>
1505
1506If set and accessible, gives the name of a X resource file to be loaded by
1507@@RXVT_NAME@@.
1508
1509=back
1004 1510
1005=head1 FILES 1511=head1 FILES
1006 1512
1007=over 4 1513=over 4
1008 1514
1009=item B</etc/utmp>
1010
1011System file for login records.
1012
1013=item B</usr/lib/X11/rgb.txt> 1515=item B</usr/lib/X11/rgb.txt>
1014 1516
1015Color names. 1517Color names.
1016 1518
1017=back 1519=back
1018 1520
1019=head1 SEE ALSO 1521=head1 SEE ALSO
1020 1522
1021@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1523@@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)
1022
1023=head1 BUGS
1024
1025Check the BUGS file for an up-to-date list.
1026
1027Cursor change support is not yet implemented.
1028
1029Click-and-drag doesn't work with X11 mouse report overriding.
1030 1524
1031=head1 CURRENT PROJECT COORDINATOR 1525=head1 CURRENT PROJECT COORDINATOR
1032 1526
1033=over 4 1527=over 4
1034 1528
1035=item Project Coordinator 1529=item Project Coordinator
1036 1530
1037@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1531Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1038 1532
1039=item Web page maintainter 1533L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1040
1041@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1042
1043L<@@RXVT_WEBPAGE@@>
1044 1534
1045=back 1535=back
1046 1536
1047=head1 AUTHORS 1537=head1 AUTHORS
1048 1538
1070 1560
1071Project Coordinator (changes.txt 2.21a to 2.4.5) 1561Project Coordinator (changes.txt 2.21a to 2.4.5)
1072 1562
1073=item Geoff Wing L<< <gcw@pobox.com> >> 1563=item Geoff Wing L<< <gcw@pobox.com> >>
1074 1564
1075Rewrote screen display and text selection routines. Project Coordinator 1565Rewrote screen display and text selection routines.
1566
1076(changes.txt 2.4.6 - rxvt-unicode) 1567Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1077 1568
1078=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1569=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1079 1570
1080Forked rxvt-unicode, rewrote most of the display code and internal 1571Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1081character handling to store text in unicode, improve xterm 1572extension, random hacks, numerous bugfixes and extensions.
1082compatibility and apply numerous other bugfixes and extensions.
1083 1573
1084Project Coordinator (Changes 1.0 -) 1574Project Coordinator (Changes 1.0 -)
1085 1575
1576=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1577
1578Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1579
1086=back 1580=back
1087 1581

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines