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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines