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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines