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.128 by root, Wed May 16 22:37:10 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
471=item B<fading:> I<number>
472
473Scale the tint colour by the given percentage.
474 627
475=item B<scrollColor:> I<colour> 628=item B<scrollColor:> I<colour>
476 629
477Use the specified colour for the scrollbar [default #B2B2B2]. 630Use the specified colour for the scrollbar [default #B2B2B2].
478 631
479=item B<troughColor:> I<colour> 632=item B<troughColor:> I<colour>
480 633
481Use the specified colour for the scrollbar's trough area [default 634Use the specified colour for the scrollbar's trough area [default
482#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 635#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
483 636
484=item B<borderColor:> I<colour> 637=item B<borderColor:> I<colour>
485 638
486The 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
487and the text. 640and the text.
496of 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
497specifies an integer number of images in that direction. No image will 650specifies an integer number of images in that direction. No image will
498be magnified beyond 10 times its original size. The maximum permitted 651be magnified beyond 10 times its original size. The maximum permitted
499scale is 1000. [default 0x0+50+50] 652scale is 1000. [default 0x0+50+50]
500 653
501=item B<menu:> I<file[;tag]>
502
503Read in the specified menu file (note the `.menu' extension is
504optional) and also optionally specify a starting tag to find. See the
505reference documentation for details on the syntax for the menuBar.
506
507=item B<path:> I<path> 654=item B<path:> I<path>
508 655
509Specify the colon-delimited search path for finding files (XPM and 656Specify 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 657
513=item B<font:> I<fontlist> 658=item B<font:> I<fontlist>
514 659
515Select 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
516names that are used in turn when trying to display Unicode characters. 661that are checked in order when trying to find glyphs for characters. The
517The first font defines the cell size for characters; other fonts might 662first font defines the cell size for characters; other fonts might be
518be smaller, but not larger. A reasonable default font list is always 663smaller, but not (in general) larger. A (hopefully) reasonable default
519appended to it. option B<-fn>. 664font list is always appended to it; option B<-fn>.
520 665
521Each 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
522optional 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:>.
523 668
524In addition, each font can be prefixed with additional hints and 669In addition, each font can be prefixed with additional hints and
525specifications enclosed in square brackets (C<[]>). The only available 670specifications enclosed in square brackets (C<[]>). The only available
526hint 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
527fonts. 672fonts.
528 673
529For example, this font resource 674For example, this font resource
530 675
531 URxvt*font: 9x15bold,\ 676 URxvt.font: 9x15bold,\
532 -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,\
533 -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, \
534 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 679 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
535 xft:Code2000:antialias=false 680 xft:Code2000:antialias=false
536 681
537specifies 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
538the 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
539it 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
540wide and 15 pixels high. 685wide and 15 pixels high.
541 686
542the 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
543the base font, likewise the third, which is unfortunately non-bold, but 688the 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 689the bold version of the font does contain less characters, so this is a
545useful supplement. 690useful supplement.
546 691
547The 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
570not possible, replacement fonts of the desired shape will be tried. 715not possible, replacement fonts of the desired shape will be tried.
571 716
572If 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
573text font will being used for the given style. 718text font will being used for the given style.
574 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
575=item B<selectstyle:> I<mode> 728=item B<selectstyle:> I<mode>
576 729
577Set 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
578xterm 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
579xterm style selection. 732xterm style selection.
580 733
581=item B<scrollstyle:> I<mode> 734=item B<scrollstyle:> I<mode>
582 735
583Set 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
584the author's favourite.. 737the author's favourite.
585 738
586=item B<title:> I<string> 739=item B<title:> I<string>
587 740
588Set window title string, the default title is the command-line 741Set window title string, the default title is the command-line
589specified after the B<-e> option, if any, otherwise the application 742specified after the B<-e> option, if any, otherwise the application
598=item B<mapAlert:> I<boolean> 751=item B<mapAlert:> I<boolean>
599 752
600B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 753B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
601de-iconify (map) on receipt of a bell character [default]. 754de-iconify (map) on receipt of a bell character [default].
602 755
756=item B<urgentOnBell:> I<boolean>
757
758B<True>: set the urgency hint for the wm on receipt of a bell character.
759B<False>: do not set the urgency hint [default].
760
603=item B<visualBell:> I<boolean> 761=item B<visualBell:> I<boolean>
604 762
605B<True>: use visual bell on receipt of a bell character; option B<-vb>. 763B<True>: use visual bell on receipt of a bell character; option B<-vb>.
606B<False>: no visual bell [default]; option B<+vb>. 764B<False>: no visual bell [default]; option B<+vb>.
607 765
621 779
622Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 780Specify 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 781B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
624B<Shift-Print> to include the scrollback as well. 782B<Shift-Print> to include the scrollback as well.
625 783
784The string will be interpreted as if typed into the shell as-is.
785
786Example:
787
788 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
789
790This creates a new file in your home directory with the screen contents
791every time you hit C<Print>.
792
626=item B<scrollBar:> I<boolean> 793=item B<scrollBar:> I<boolean>
627 794
628B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 795B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
629disable the scrollbar; option B<+sb>. 796disable the scrollbar; option B<+sb>.
630 797
650B<+si>. 817B<+si>.
651 818
652=item B<scrollWithBuffer:> I<boolean> 819=item B<scrollWithBuffer:> I<boolean>
653 820
654B<True>: scroll with scrollback buffer when tty receives new lines (and 821B<True>: scroll with scrollback buffer when tty receives new lines (and
655B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 822B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
656with scrollback buffer when tty recieves new lines; option B<-sw>. 823with scrollback buffer when tty receives new lines; option B<+sw>.
657 824
658=item B<scrollTtyKeypress:> I<boolean> 825=item B<scrollTtyKeypress:> I<boolean>
659 826
660B<True>: scroll to bottom when a non-special key is pressed. Special keys 827B<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 828are those which are intercepted by rxvt-unicode for special handling and
680=item B<borderLess:> I<boolean> 847=item B<borderLess:> I<boolean>
681 848
682Set MWM hints to request a borderless window, i.e. if honoured by the 849Set 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>. 850WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
684 851
852=item B<skipBuiltinGlyphs:> I<boolean>
853
854Compile I<frills>: Disable the usage of the built-in block graphics/line
855drawing characters and just rely on what the specified fonts provide. Use
856this if you have a good font and want to use its block graphic glyphs;
857option B<-sbg>.
858
685=item B<termName:> I<termname> 859=item B<termName:> I<termname>
686 860
687Specifies the terminal type name to be set in the B<TERM> environment 861Specifies the terminal type name to be set in the B<TERM> environment
688variable; option B<-tn>. 862variable; option B<-tn>.
689 863
699 873
700=item B<mouseWheelScrollPage:> I<boolean> 874=item B<mouseWheelScrollPage:> I<boolean>
701 875
702B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel 876B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
703scrolls five lines [default]. 877scrolls five lines [default].
878
879=item B<pastableTabs:> I<boolean>
880
881B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
882movement only; option C<-ptab>.
704 883
705=item B<cursorBlink:> I<boolean> 884=item B<cursorBlink:> I<boolean>
706 885
707B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 886B<True>: blink the cursor. B<False>: do not blink the cursor [default];
708option B<-bc>. 887option B<-bc>.
721 900
722Mouse pointer background colour. 901Mouse pointer background colour.
723 902
724=item B<pointerBlankDelay:> I<number> 903=item B<pointerBlankDelay:> I<number>
725 904
726Specifies number of seconds before blanking the pointer [default 2]. 905Specifies number of seconds before blanking the pointer [default 2]. Use a
906large number (e.g. C<987654321>) to effectively disable the timeout.
727 907
728=item B<backspacekey:> I<string> 908=item B<backspacekey:> I<string>
729 909
730The string to send when the backspace key is pressed. If set to B<DEC> 910The 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> 911or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
738pressed. If unset it will send the sequence traditionally associated 918pressed. If unset it will send the sequence traditionally associated
739with the B<Execute> key. 919with the B<Execute> key.
740 920
741=item B<cutchars:> I<string> 921=item B<cutchars:> I<string>
742 922
743The characters used as delimiters for double-click word selection. The 923The characters used as delimiters for double-click word selection
744built-in default: 924(whitespace delimiting is added automatically if resource is given).
925
926When the selection extension is in use (the default if compiled in, see
927the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters
928will be created (if the resource exists, otherwise, no regex will be
929created). In this mode, characters outside ISO-8859-1 can be used.
930
931When the selection extension is not used, only ISO-8859-1 characters can
932be used. If not specified, the built-in default is used:
745 933
746B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 934B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
747 935
748=item B<preeditType:> I<style> 936=item B<preeditType:> I<style>
749 937
753 941
754I<name> of inputMethod to use; option B<-im>. 942I<name> of inputMethod to use; option B<-im>.
755 943
756=item B<imLocale:> I<name> 944=item B<imLocale:> I<name>
757 945
758The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 946The 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 947C<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 948input extension to be able to input japanese characters while staying in
761another locale. option B<-imlocale>. 949another locale; option B<-imlocale>.
950
951=item B<imFont:> I<fontset>
952
953Specify the font-set used for XIM styles C<OverTheSpot> or
954C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
955by commas), i.e. it's not in the same format as the other font lists used
956in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
957found, preferably one or two pixels differing in size to the base font.
958option B<-imfont>.
959
960=item B<tripleclickwords:> I<boolean>
961
962Change the meaning of triple-click selection with the left mouse
963button. Instead of selecting a full line it will extend the selection to
964the end of the logical line only; option B<-tcw>.
762 965
763=item B<insecure:> I<boolean> 966=item B<insecure:> I<boolean>
764 967
765Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 968Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
766echo arbitrary strings like the icon name or the locale. This could be 969echo arbitrary strings like the icon name or the locale. This could be
767abused if somebody gets 8-bit-clean access to your display, whether 970abused if somebody gets 8-bit-clean access to your display, whether
768throuh a mail client displaying mail bodies unfiltered or though 971through a mail client displaying mail bodies unfiltered or through
769write(1). Therefore, these sequences are disabled by default. (Note 972write(1) or any other means. Therefore, these sequences are disabled by
770that other terminals, including xterm, have these sequences 973default. (Note that many other terminals, including xterm, have these
771enabled by default). You can enable them by setting this boolean 974sequences enabled by default, which doesn't make it safer, though).
772resource or specifying B<-insecure> as an option. At the moment, this 975
773enabled display-answer, locale, findfont, icon label and window title 976You can enable them by setting this boolean resource or specifying
774requests as well as dynamic menubar dispatch. 977B<-insecure> as an option. At the moment, this enables display-answer,
978locale, findfont, icon label and window title requests.
775 979
776=item B<modifier:> I<modifier> 980=item B<modifier:> I<modifier>
777 981
778Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 982Set 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 983B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
783 987
784Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 988Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
785character is passed through. It may contain escape values as described 989character is passed through. It may contain escape values as described
786in the entry on B<keysym> following. 990in the entry on B<keysym> following.
787 991
788=item B<secondaryScreen:> I<bool> 992=item B<secondaryScreen:> I<boolean>
789 993
790Turn on/off secondary screen (default enabled). 994Turn on/off secondary screen (default enabled).
791 995
792=item B<secondaryScroll:> I<bool> 996=item B<secondaryScroll:> I<boolean>
793 997
794Turn on/off secondary screen scroll (default enabled). If the this 998Turn on/off secondary screen scroll (default enabled). If this
795option is enabled, scrolls on the secondary screen will change the 999option is enabled, scrolls on the secondary screen will change the
796scrollback buffer and switching to/from the secondary screen will 1000scrollback buffer and switching to/from the secondary screen will
797instead scroll the screen up. 1001instead scroll the screen up.
798 1002
1003=item B<hold>: I<boolean>
1004
1005Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1006will not immediately destroy its window when the program executed within
1007it exits. Instead, it will wait till it is being killed or closed by the
1008user.
1009
799=item B<keysym.>I<sym>: I<string> 1010=item B<keysym.>I<sym>: I<string>
800 1011
801Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may 1012Compile I<frills>: Associate I<string> with keysym I<sym>. The
802contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: 1013intervening resource name B<keysym.> cannot be omitted.
803newline, \r: return, \t: 1014
1015The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
1016any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
1017B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
1018and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
1019B<2>, B<3>, B<4>, B<5>.
1020
1021The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1022whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1023keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1024current application keymap mode state.
1025
1026The spellings of I<key> can be obtained by using B<xev>(1) command or
1027searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1028omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1029keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1030performed in an exact manner; however, the closest match is assured.
1031
1032I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
1033C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
804tab, \000: octal number) or control characters (^?: delete, ^@: null, 1034C<\000>: octal number) or verbatim control characters (C<^?>: delete,
805^A ...) and may enclosed with double quotes so that it can start or end 1035C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
806with whitespace. The intervening resource name B<keysym.> cannot be 1036can start or end with whitespace. B<This feature is deprecated and will
807omitted. This resource is only available when compiled with 1037be removed>.
808KEYSYM_RESOURCE. 1038
1039Please note that you need to double the C<\> in resource files, as
1040Xlib itself does its own de-escaping (you can use C<\033> instead of
1041C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1042processing).
1043
1044You can define a range of keysyms in one shot by providing a I<string>
1045with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1046should be a character not used by the strings.
1047
1048Its usage can be demonstrated by an example:
1049
1050 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1051
1052The above line is equivalent to the following three lines:
1053
1054 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
1055 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
1056 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
1057
1058If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1059is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1060example the following means "change the current locale to C<zh_CN.GBK>
1061when Control-Meta-c is being pressed":
1062
1063 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1064
1065If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1066is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1067manpage. For example, the F<selection> extension (activated via
1068C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1069
1070 URxvt.keysym.M-C-c: perl:selection:rot13
1071
1072Due the the large number of modifier combinations, a defined key mapping
1073will match if at I<at least> the specified identifiers are being set, and
1074no other key mappings with those and more bits are being defined. That
1075means that defining a key map for C<a> will automatically provide
1076definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1077mappings themselves.
1078
1079Unfortunately, this will override built-in key mappings. For example
1080if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
1081C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
1082user-defined keymap using the C<builtin:> replacement:
1083
1084 URxvt.keysym.Insert: <my insert key sequence>
1085 URxvt.keysym.S-Insert: builtin:
1086
1087The first line defines a mapping for C<Insert> and I<any> combination
1088of modifiers. The second line re-establishes the default mapping for
1089C<Shift-Insert>.
1090
1091The following example will map Control-Meta-1 and Control-Meta-2 to
1092the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1093font-switching at runtime:
1094
1095 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1096 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1097
1098Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1099info):
1100
1101 URxvt.keysym.M-C-3: command:\033[8;25;80t
1102 URxvt.keysym.M-C-4: command:\033[8;48;110t
1103
1104=item B<perl-ext-common>: I<string>
1105
1106=item B<perl-ext>: I<string>
1107
1108Comma-separated list(s) of perl extension scripts (default: C<default>) to
1109use in this terminal instance; option B<-pe>.
1110
1111Extension names can be prefixed with a C<-> sign to prohibit using
1112them. This can be useful to selectively disable some extensions loaded
1113by default, or specified via the C<perl-ext-common> resource. For
1114example, C<default,-selection> will use all the default extension except
1115C<selection>.
1116
1117Extension names can also be followed by an argument in angle brackets
1118(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1119searchable scrollback to Alt/Meta-s). Mentioning the same extension
1120multiple times with different arguments will pass multiple arguments to
1121the extension.
1122
1123Each extension is looked up in the library directories, loaded if
1124necessary, and bound to the current terminal instance.
1125
1126If both of these resources are the empty string, then the perl
1127interpreter will not be initialized. The idea behind two options is that
1128B<perl-ext-common> will be used for extensions that should be available to
1129all instances, while B<perl-ext> is used for specific instances.
1130
1131=item B<perl-eval>: I<string>
1132
1133Perl code to be evaluated when all extensions have been registered. See
1134the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1135will be ignored when running setuid/setgid.
1136
1137=item B<perl-lib>: I<path>
1138
1139Colon-separated list of additional directories that hold extension
1140scripts. When looking for extensions specified by the C<perl> resource,
1141@@RXVT_NAME@@ will first look in these directories and then in
1142F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1143will be ignored when running setuid/setgid.
1144
1145See the @@RXVT_NAME@@perl(3) manpage.
1146
1147=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1148
1149Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1150details.
1151
1152=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1153
1154Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1155for details.
1156
1157=item B<searchable-scrollback:> I<keysym>
1158
1159Sets the hotkey that starts the incremental scrollback buffer search
1160(default: C<M-s>).
1161
1162=item B<urlLauncher>: I<string>
1163
1164Specifies the program to be started with a URL argument. Used by the
1165C<selection-popup> and C<matcher> perl extensions.
1166
1167=item B<transient-for>: I<windowid>
1168
1169Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1170
1171=item B<override-redirect>: I<boolean>
1172
1173Compile I<frills>: Sets override-redirect for the terminal window, making
1174it almost invisible to window managers; option B<-override-redirect>.
809 1175
810=back 1176=back
811 1177
812=head1 THE SCROLLBAR 1178=head1 THE SCROLLBAR
813 1179
827the normal text selection/insertion, hold either the Shift or the Meta 1193the normal text selection/insertion, hold either the Shift or the Meta
828(Alt) key while performing the desired mouse action. 1194(Alt) key while performing the desired mouse action.
829 1195
830If mouse reporting mode is active, the normal scrollbar actions are 1196If mouse reporting mode is active, the normal scrollbar actions are
831disabled -- on the assumption that we are using a fullscreen 1197disabled -- on the assumption that we are using a fullscreen
832application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 1198application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
833(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 1199(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), 1200up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
835respectively. 1201respectively.
836 1202
837=head1 TEXT SELECTION AND INSERTION 1203=head1 THE SELECTION: SELECTING AND PASTING TEXT
838 1204
839The behaviour of text selection and insertion mechanism is similar to 1205The behaviour of text selection and insertion/pasting mechanism is similar
840I<xterm>(1). 1206to I<xterm>(1).
841 1207
842=over 4 1208=over 4
843 1209
844=item B<Selection>: 1210=item B<Selecting>:
845 1211
846Left click at the beginning of the region, drag to the end of the 1212Left 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 1213and release; Right click to extend the marked region; Left double-click
848double-click to select a word; Left triple-click to select the entire 1214to select a word; Left triple-click to select the entire logical line
849line. 1215(which can span multiple screen lines), unless modified by resource
1216B<tripleclickwords>.
850 1217
851Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1218Starting 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 1219(Compile: I<frills>) will create a rectangular selection instead of a
853one. 1220normal one. In this mode, every selected row becomes its own line in the
1221selection, and trailing whitespace is visually underlined and removed from
1222the selection.
854 1223
855=item B<Insertion>: 1224=item B<Pasting>:
856 1225
857Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1226Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
858an B<@@RXVT_NAME@@> window causes the current text selection to be 1227window causes the value of the PRIMARY selection (or CLIPBOARD with the
859inserted as if it had been typed on the keyboard. 1228B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1229
1230Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1231inserted too.
860 1232
861=back 1233=back
862 1234
863=head1 CHANGING FONTS 1235=head1 CHANGING FONTS
864 1236
865Changing fonts (or font sizes, respectively) via the keypad is not yet 1237Changing fonts (or font sizes, respectively) via the keypad is not yet
866supported in rxvt-unicode. Bug me if you need this. 1238supported in rxvt-unicode. Bug me if you need this.
867 1239
868You can, however, switch fonts at runtime using escape sequences (and 1240You can, however, switch fonts at runtime using escape sequences, e.g.:
869therefore using the menubar), e.g.:
870 1241
871 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1242 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1243
1244You can use keyboard shortcuts, too:
1245
1246 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1247 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
872 1248
873rxvt-unicode will automatically re-apply these fonts to the output so far. 1249rxvt-unicode will automatically re-apply these fonts to the output so far.
874 1250
875=head1 ISO 14755 SUPPORT 1251=head1 ISO 14755 SUPPORT
876 1252
880C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1256C<--enable-frills>, the rest is available when rxvt-unicode was compiled
881with C<--enable-iso14755>. 1257with C<--enable-iso14755>.
882 1258
883=over 4 1259=over 4
884 1260
885=item 5.1: Basic method 1261=item * 5.1: Basic method
886 1262
887This allows you to enter unicode characters using their hexcode. 1263This allows you to enter unicode characters using their hexcode.
888 1264
889Start by pressing and holding both C<Control> and C<Shift>, then enter 1265Start 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 1266hex-digits (between one and six). Releasing C<Control> and C<Shift> will
897address, which you cannot type. Fortunately, the card has the e-mail 1273address, 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 1274address 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>, 1275by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
900followed by releasing the modifier keys. 1276followed by releasing the modifier keys.
901 1277
902=item 5.2: Keyboard symbols entry method 1278=item * 5.2: Keyboard symbols entry method
903 1279
904This mode lets you input characters representing the keycap symbols of 1280This mode lets you input characters representing the keycap symbols of
905your keyboard, if representable in the current locale encoding. 1281your keyboard, if representable in the current locale encoding.
906 1282
907Start by pressing C<Control> and C<Shift> together, then releasing 1283Start by pressing C<Control> and C<Shift> together, then releasing
908them. The next special key (cursor keys, home etc.) you enter will not 1284them. The next special key (cursor keys, home etc.) you enter will not
909invoke it's usual function but instead will insert the corresponding 1285invoke its usual function but instead will insert the corresponding
910keycap symbol. The symbol will only be entered when the key has been 1286keycap symbol. The symbol will only be entered when the key has been
911released, otherwise pressing e.g. C<Shift> would enter the symbol for 1287released, 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 1288C<ISO Level 2 Switch>, although your intention might have been to enter a
913reverse tab (Shift-Tab). 1289reverse tab (Shift-Tab).
914 1290
915=item 5.3: Screen-selection entry method 1291=item * 5.3: Screen-selection entry method
916 1292
917While this is implemented already (it's basically the selection 1293While this is implemented already (it's basically the selection
918mechanism), it could be extended by displaying a unicode character map. 1294mechanism), it could be extended by displaying a unicode character map.
919 1295
920=item 5.4: Feedback method for identifying displayed characters for later input 1296=item * 5.4: Feedback method for identifying displayed characters for later input
921 1297
922This method lets you display the unicode character code associated with 1298This method lets you display the unicode character code associated with
923characters already displayed. 1299characters already displayed.
924 1300
925You enter this mode by holding down C<Control> and C<Shift> together, then 1301You 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 1313With respect to conformance, rxvt-unicode is supposed to be compliant to
938both scenario A and B of ISO 14755, including part 5.2. 1314both scenario A and B of ISO 14755, including part 5.2.
939 1315
940=head1 LOGIN STAMP 1316=head1 LOGIN STAMP
941 1317
942B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so 1318B<@@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. 1319it 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 1320allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
945some systems. 1321on some systems or setgid to root or to some other group on others.
946 1322
947=head1 COLORS AND GRAPHICS 1323=head1 COLORS AND GRAPHICS
948 1324
949In addition to the default foreground and background colours, 1325In addition to the default foreground and background colours,
950B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1326B<@@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 1327high-intensity bold/blink versions of the same). Here is a list of the
952colours with their B<rgb.txt> names. 1328colours with their names.
953 1329
954=begin table 1330=begin table
955 1331
956 B<color0> (black) = Black 1332 B<color0> (black) = Black
957 B<color1> (red) = Red3 1333 B<color1> (red) = Red3
977It is also possible to specify the colour values of B<foreground>, 1353It is also possible to specify the colour values of B<foreground>,
978B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1354B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
979a number 0-15, as a convenient shorthand to reference the colour name of 1355a number 0-15, as a convenient shorthand to reference the colour name of
980color0-color15. 1356color0-color15.
981 1357
1358In addition to the colours defined above, @@RXVT_NAME@@ offers an
1359additional 72 colours. The first 64 of those (with indices 16 to 79)
1360consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
136116>), followed by 8 additional shades of gray (with indices 80 to 87).
1362
1363Together, all those colours implement the 88 colour xterm colours. Only
1364the first 16 can be changed using resources currently, the rest can only
1365be changed via command sequences ("escape codes").
1366
982Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1367Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
983always swapping the foreground/background colours. This is in contrast to 1368always swapping the foreground/background colours. This is in contrast to
984I<xterm>(1) where the colours are only swapped if they have not otherwise 1369I<xterm>(1) where the colours are only swapped if they have not otherwise
985been specified. For example, 1370been specified. For example,
986 1371
991would yield White on Black, while on I<xterm>(1) it would yield Black 1376would yield White on Black, while on I<xterm>(1) it would yield Black
992on White. 1377on White.
993 1378
994=back 1379=back
995 1380
1381=head2 ALPHA CHANNEL SUPPORT
1382
1383If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1384their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1385(recommended, but B<MUST> have 4 digits/component) colour specifications,
1386in addition to the ones provided by X, where the additional A component
1387specifies opacity (alpha) values. The minimum value of C<0> is completely
1388transparent). You can also prefix any color with C<[percent]>, where
1389C<percent> is a decimal percentage (0-100) that specifies the opacity of
1390the color, where C<0> is completely transparent and C<100> is completelxy
1391opaque.
1392
1393You probably need to specify B<"-depth 32">, too, and have the luck that
1394your X-server uses ARGB pixel layout, as X is far from just supporting
1395ARGB visuals out of the box, and rxvt-unicode just fudges around.
1396
1397For example, the following selects an almost completely transparent red
1398background, and an almost opaque pink foreground:
1399
1400 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1401
1402I<Please note that transparency of any kind if completely unsupported by
1403the author. Don't bug him with installation questions!>
1404
996=head1 ENVIRONMENT 1405=head1 ENVIRONMENT
997 1406
998B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> 1407B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
999and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X 1408
1000window id number of the B<@@RXVT_NAME@@> window and it also uses and 1409=over 4
1001sets the environment variable B<DISPLAY> to specify which display 1410
1002terminal to use. B<@@RXVT_NAME@@> uses the environment variables 1411=item B<TERM>
1003B<RXVTPATH> and B<PATH> to find XPM files. 1412
1413Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1414resources or on the command line.
1415
1416=item B<COLORTERM>
1417
1418Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1419compiled with XPM support, and optionally with the added extension
1420C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1421
1422=item B<COLORFGBG>
1423
1424Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1425the colour code used as default foreground/text colour (or the string
1426C<default> to indicate that the default-colour escape sequence is to be
1427used), C<bg> is the colour code used as default background colour (or the
1428string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1429was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
1430(and do) use this information to optimize screen output.
1431
1432=item B<WINDOWID>
1433
1434Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1435window, which usually has subwindows for the scrollbar, the terminal
1436window and so on).
1437
1438=item B<TERMINFO>
1439
1440Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1441C<--with-terminfo=PATH>.
1442
1443=item B<DISPLAY>
1444
1445Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1446display in its child processes.
1447
1448=item B<SHELL>
1449
1450The shell to be used for command execution, defaults to C</bin/sh>.
1451
1452=item B<RXVT_SOCKET>
1453
1454The unix domain socket path used by @@RXVT_NAME@@c(1) and
1455@@RXVT_NAME@@d(1).
1456
1457Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1458
1459=item B<HOME>
1460
1461Used to locate the default directory for the unix domain socket for
1462daemon communications and to locate various resource files (such as
1463C<.Xdefaults>)
1464
1465=item B<XAPPLRESDIR>
1466
1467Directory where various X resource files are being located.
1468
1469=item B<XENVIRONMENT>
1470
1471If set and accessible, gives the name of a X resource file to be loaded by
1472@@RXVT_NAME@@.
1473
1474=back
1004 1475
1005=head1 FILES 1476=head1 FILES
1006 1477
1007=over 4 1478=over 4
1008 1479
1009=item B</etc/utmp>
1010
1011System file for login records.
1012
1013=item B</usr/lib/X11/rgb.txt> 1480=item B</usr/lib/X11/rgb.txt>
1014 1481
1015Color names. 1482Color names.
1016 1483
1017=back 1484=back
1018 1485
1019=head1 SEE ALSO 1486=head1 SEE ALSO
1020 1487
1021@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1488@@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 1489
1031=head1 CURRENT PROJECT COORDINATOR 1490=head1 CURRENT PROJECT COORDINATOR
1032 1491
1033=over 4 1492=over 4
1034 1493
1035=item Project Coordinator 1494=item Project Coordinator
1036 1495
1037@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1496Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1038 1497
1039=item Web page maintainter 1498L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1040
1041@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1042
1043L<@@RXVT_WEBPAGE@@>
1044 1499
1045=back 1500=back
1046 1501
1047=head1 AUTHORS 1502=head1 AUTHORS
1048 1503
1070 1525
1071Project Coordinator (changes.txt 2.21a to 2.4.5) 1526Project Coordinator (changes.txt 2.21a to 2.4.5)
1072 1527
1073=item Geoff Wing L<< <gcw@pobox.com> >> 1528=item Geoff Wing L<< <gcw@pobox.com> >>
1074 1529
1075Rewrote screen display and text selection routines. Project Coordinator 1530Rewrote screen display and text selection routines.
1531
1076(changes.txt 2.4.6 - rxvt-unicode) 1532Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1077 1533
1078=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1534=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1079 1535
1080Forked rxvt-unicode, rewrote most of the display code and internal 1536Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1081character handling to store text in unicode, improve xterm 1537extension, random hacks, numerous bugfixes and extensions.
1082compatibility and apply numerous other bugfixes and extensions.
1083 1538
1084Project Coordinator (Changes 1.0 -) 1539Project Coordinator (Changes 1.0 -)
1085 1540
1541=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1542
1543Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1544
1086=back 1545=back
1087 1546

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines