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.48 by root, Thu Feb 3 10:24:10 2005 UTC vs.
Revision 1.144 by sasha, Thu Nov 15 18:40: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 devanagari. 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>
101 108
102Turn on/off simulated reverse video; resource B<reverseVideo>. 109Turn on/off simulated reverse video; resource B<reverseVideo>.
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 (allow multiple lines per refresh); resource B<jumpScroll>.
107 114
108=item B<-ip>|B<+ip> 115=item B<-ss>|B<+ss>
109 116
110Turn on/off inheriting parent window's pixmap. Alternative form is 117Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
111B<-tr>; resource B<inheritPixmap>. 118
119=item B<-tr>|B<+tr>
120
121Turn on/off illusion of a transparent window background. Obsolete form of it is
122B<-ip> and it should not be used anymore; resource B<transparent>.
123
124I<Please note that old resource name of B<inheritPixmap> is obsolete and should be
125changed to B<transparent>. Backwards compatibility support for B<inheritPixmap> will
126be phased out in future versions of rxvt!>
127
128I<Please address all transparency related issues to Sasha Vasko at
129sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
112 130
113=item B<-fade> I<number> 131=item B<-fade> I<number>
114 132
115Fade the text by the given percentage when focus is lost. resource B<fading>. 133Fade the text by the given percentage when focus is lost. Small values
134fade a little only, 100 completely replaces all colours by the fade
135colour; resource B<fading>.
136
137=item B<-fadecolor> I<colour>
138
139Fade to this colour when fading is used (see B<-fade>). The default colour
140is opaque black. resource B<fadeColor>.
116 141
117=item B<-tint> I<colour> 142=item B<-tint> I<colour>
118 143
119Tint the transparent background pixmap with the given colour when 144Tint the transparent background pixmap with the given colour when
120transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> 145transparency is enabled with B<-tr>. This only works for
146non-tiled backgrounds, currently. See also the B<-sh> option that can be
121option that can be used to brighten or darken the image in addition to 147used to brighten or darken the image in addition to tinting it.
122tinting it. 148Please note that certain tint colours can be applied on the server-side,
149thus yielding performance gain of two orders of magnitude. These colours are:
150blue, red, green, cyan, magenta, yellow, and those close to them. Also
151pure black and pure white colors essentially mean no tinting; resource
152I<tintColor>. Example:
123 153
124=item B<-sh> 154 @@RXVT_NAME@@ -tr -tint blue -sh 40
125 155
156=item B<-sh> I<number>
157
126I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 158Darken (0 .. 100) or lighten (100 .. 200) the transparent
127background image in addition to tinting it (i.e. B<-tint> must be 159background image in addition to (or instead of) tinting it;
128specified, too, e.g. C<-tint white>). 160resource I<shading>.
161
162=item B<-blt> I<string>
163
164Specify background blending type. If background pixmap is specified
165at the same time as transparency - such pixmap will be blended over
166transparency image, using method specified. Supported values are :
167B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
168B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
169B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
170alpha-blending. Compile I<afterimage>; resource I<blendType>.
171
172=item B<-blr> I<HxV>
173
174Apply Gaussian Blur with the specified radii to the transparent
175background image. If single number is specified - both vertical and
176horizontal radii are considered to be the same. Setting one of the
177radii to 1 and another to a large number creates interesting effects
178on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
179resource I<blurRadius>.
129 180
130=item B<-bg> I<colour> 181=item B<-bg> I<colour>
131 182
132Window background colour; resource B<background>. 183Window background colour; resource B<background>.
133 184
134=item B<-fg> I<colour> 185=item B<-fg> I<colour>
135 186
136Window foreground colour; resource B<foreground>. 187Window foreground colour; resource B<foreground>.
137 188
138=item B<-pixmap> I<file[;geom]> 189=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
139 190
140Compile I<XPM>: Specify XPM file for the background and also optionally 191Compile I<afterimage>: Specify image file for the background and also
141specify its scaling with a geometry string. Note you may need to 192optionally specify its scaling with a geometry string. Note you may need to
142add quotes to avoid special shell interpretation of the C<;> in the 193add quotes to avoid special shell interpretation of the C<;> in the
143command-line; resource B<backgroundPixmap>. 194command-line; for more details see resource B<backgroundPixmap>.
144 195
145=item B<-cr> I<colour> 196=item B<-cr> I<colour>
146 197
147The cursor colour; resource B<cursorColor>. 198The cursor colour; resource B<cursorColor>.
148 199
160resource B<borderColor>. 211resource B<borderColor>.
161 212
162=item B<-fn> I<fontlist> 213=item B<-fn> I<fontlist>
163 214
164Select the fonts to be used. This is a comma separated list of font names 215Select 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 216that are checked in order when trying to find glyphs for characters. The
166first font defines the cell size for characters; other fonts might be 217first font defines the cell size for characters; other fonts might be
167smaller, but not (in general) larger. A (hopefully) reasonable default 218smaller, but not (in general) larger. A (hopefully) reasonable default
168font list is always appended to it. See resource B<font> for more details. 219font list is always appended to it. See resource B<font> for more details.
169 220
170In short, to specify an X11 core font, just specify it's name or prefix it 221In short, to specify an X11 core font, just specify its name or prefix it
171with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, 222with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
172e.g.: 223e.g.:
173 224
174 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 225 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
175 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 226 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
177See also the question "How does rxvt-unicode choose fonts?" in the FAQ 228See also the question "How does rxvt-unicode choose fonts?" in the FAQ
178section of @@RXVT_NAME@@(7). 229section of @@RXVT_NAME@@(7).
179 230
180=item B<-fb> I<fontlist> 231=item B<-fb> I<fontlist>
181 232
182Compile font-styles: The bold font list to use when bold characters are to 233Compile I<font-styles>: The bold font list to use when B<bold> characters
183be printed. See resource B<boldFont> for details. 234are to be printed. See resource B<boldFont> for details.
184 235
185=item B<-fi> I<fontlist> 236=item B<-fi> I<fontlist>
186 237
187Compile font-styles: The italic font list to use when bold characters are to 238Compile I<font-styles>: The italic font list to use when I<italic>
188be printed. See resource B<italicFont> for details. 239characters are to be printed. See resource B<italicFont> for details.
189 240
190=item B<-fbi> I<fontlist> 241=item B<-fbi> I<fontlist>
191 242
192Compile font-styles: The bold italic font list to use when bold characters are to 243Compile I<font-styles>: The bold italic font list to use when B<< I<bold
193be printed. See resource B<boldItalicFont> for details. 244italic> >> characters are to be printed. See resource B<boldItalicFont>
245for details.
246
247=item B<-is>|B<+is>
248
249Compile I<font-styles>: Bold/Italic font styles imply high intensity
250foreground/background (default). See resource B<intensityStyles> for
251details.
194 252
195=item B<-name> I<name> 253=item B<-name> I<name>
196 254
197Specify the application name under which resources are to be obtained, 255Specify the application name under which resources are to be obtained,
198rather than the default executable file name. Name should not contain 256rather than the default executable file name. Name should not contain
236 294
237Put scrollbar on right/left; resource B<scrollBar_right>. 295Put scrollbar on right/left; resource B<scrollBar_right>.
238 296
239=item B<-st>|B<+st> 297=item B<-st>|B<+st>
240 298
241Display normal (non XTerm/NeXT) scrollbar without/with a trough; 299Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
242resource B<scrollBar_floating>. 300resource B<scrollBar_floating>.
243 301
244=item B<-ptab>|B<+ptab> 302=item B<-ptab>|B<+ptab>
245 303
246If enabled (default), "Horizontal Tab" characters are being stored as 304If enabled (default), "Horizontal Tab" characters are being stored as
278 336
279Compile I<frills>: Set MWM hints to request a borderless window, i.e. 337Compile I<frills>: Set MWM hints to request a borderless window, i.e.
280if honoured by the WM, the rxvt-unicode window will not have window 338if honoured by the WM, the rxvt-unicode window will not have window
281decorations; resource B<borderLess>. 339decorations; resource B<borderLess>.
282 340
341=item B<-override-redirect>
342
343Compile I<frills>: Sets override-redirect on the window; resource
344B<override-redirect>.
345
346=item B<-sbg>
347
348Compile I<frills>: Disable the usage of the built-in block graphics/line
349drawing characters and just rely on what the specified fonts provide. Use
350this if you have a good font and want to use its block graphic glyphs;
351resource B<skipBuiltinGlyphs>.
352
283=item B<-lsp> I<number> 353=item B<-lsp> I<number>
284 354
285Compile I<frills>: Lines (pixel height) to insert between each row of 355Compile I<frills>: Lines (pixel height) to insert between each row of
286the display. Useful to work around font rendering problems; resource 356the display. Useful to work around font rendering problems; resource
287B<linespace>. 357B<lineSpace>.
288 358
289=item B<-tn> I<termname> 359=item B<-tn> I<termname>
290 360
291This option specifies the name of the terminal type to be set in the 361This option specifies the name of the terminal type to be set in the
292B<TERM> environment variable. This terminal type must exist in the 362B<TERM> environment variable. This terminal type must exist in the
301given on the command line. If this option is used, it must be the last 371given on the command line. If this option is used, it must be the last
302on the command-line. If there is no B<-e> option then the default is to 372on the command-line. If there is no B<-e> option then the default is to
303run the program specified by the B<SHELL> environment variable or, 373run the program specified by the B<SHELL> environment variable or,
304failing that, I<sh(1)>. 374failing that, I<sh(1)>.
305 375
376Please note that you must specify a program with arguments. If you want to
377run shell commands, you have to specify the shell, like this:
378
379 @@RXVT_NAME@@ -e sh -c "shell commands"
380
306=item B<-title> I<text> 381=item B<-title> I<text>
307 382
308Window title (B<-T> still respected); the default title is the basename 383Window title (B<-T> still respected); the default title is the basename
309of the program specified after the B<-e> option, if any, otherwise the 384of the program specified after the B<-e> option, if any, otherwise the
310application name; resource B<title>. 385application name; resource B<title>.
341for more info. 416for more info.
342 417
343=item B<-tcw> 418=item B<-tcw>
344 419
345Change the meaning of triple-click selection with the left mouse 420Change the meaning of triple-click selection with the left mouse
421button. Only effective when the original (non-perl) selection code is
346button. Instead of selecting a full line it will extend the selection the 422in-use. Instead of selecting a full line it will extend the selection the
347end of the logical line only. resource B<tripleclickwords>. 423end of the logical line only. resource B<tripleclickwords>.
348 424
349=item B<-insecure> 425=item B<-insecure>
350 426
351Enable "insecure" mode, which currently enables most of the escape 427Enable "insecure" mode, which currently enables most of the escape
366=item B<-ssr>|B<+ssr> 442=item B<-ssr>|B<+ssr>
367 443
368Turn on/off secondary screen scroll (default enabled); resource 444Turn on/off secondary screen scroll (default enabled); resource
369B<secondaryScroll>. 445B<secondaryScroll>.
370 446
447=item B<-hold>|B<+hold>
448
449Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
450will not immediately destroy its window when the program executed within
451it exits. Instead, it will wait till it is being killed or closed by the
452user; resource B<hold>.
453
454=item B<-keysym.>I<sym> I<string>
455
456Remap a key symbol. See resource B<keysym>.
457
458=item B<-embed> I<windowid>
459
460Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
461which enables applications to easily embed a terminal.
462
463Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
464shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
465quite a bit, so don't expect it to keep some specific state. It's best to
466create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
467
468The window will not be destroyed when @@RXVT_NAME@@ exits.
469
470It might be useful to know that @@RXVT_NAME@@ will not close file
471descriptors passed to it (except for stdin/out/err, of course), so you
472can use file descriptors to communicate with the programs within the
473terminal. This works regardless of whether the C<-embed> option was used or
474not.
475
476Here is a short Gtk2-perl snippet that illustrates how this option can be
477used (a longer example is in F<doc/embed>):
478
479 my $rxvt = new Gtk2::Socket;
480 $rxvt->signal_connect_after (realize => sub {
481 my $xid = $_[0]->window->get_xid;
482 system "@@RXVT_NAME@@ -embed $xid &";
483 });
484
485=item B<-pty-fd> I<file descriptor>
486
487Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
488pair but instead use the given file descriptor as the tty master. This is
489useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
490without having to run a program within it.
491
492If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
493entries and will not tinker with pty/tty permissions - you have to do that
494yourself if you want that.
495
496As an extremely special case, specifying C<-1> will completely suppress
497pty/tty operations.
498
499Here is a example in perl that illustrates how this option can be used (a
500longer example is in F<doc/pty-fd>):
501
502 use IO::Pty;
503 use Fcntl;
504
505 my $pty = new IO::Pty;
506 fcntl $pty, F_SETFD, 0; # clear close-on-exec
507 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
508 close $pty;
509
510 # now communicate with rxvt
511 my $slave = $pty->slave;
512 while (<$slave>) { print $slave "got <$_>\n" }
513
371=item B<-xrm> I<resourcestring> 514=item B<-pe> I<string>
372 515
373No effect on rxvt-unicode. Simply passes through an argument to be made 516Comma-separated list of perl extension scripts to use (or not to use) in
374available in the instance's argument list. Appears in I<WM_COMMAND> in 517this terminal instance. See resource B<perl-ext> for details.
375some window managers.
376 518
377=back 519=back
378 520
379=head1 RESOURCES (available also as long-options) 521=head1 RESOURCES (available also as long-options)
380 522
381Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 523Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
382options) compiled into your version. 524options) compiled into your version.
383 525
384There are two different methods that @@RXVT_NAME@@ can use to get the 526You can set and change the resources using X11 tools like B<xrdb>. Many
385Xresource data: using the X libraries (Xrm*-functions) or internal 527distribution do also load settings from the B<~/.Xresources> file when X
386Xresources reader (B<~/.Xdefaults>). For the first method (ie. 528starts. @@RXVT_NAME@@ will consult the following files/resources in order,
387B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 529with later settings overwriting earlier ones:
388resources using X11 tools like B<xset>. Many distribution do also load
389settings from the B<~/.Xresources> file when X starts.
390 530
391If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> 531 1. system-wide app-defaults file, either locale-dependent OR global
392lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults 532 2. app-defaults file in $XAPPLRESDIR
393set in XAPPLOADDIR/URxvt (compile-time defined: usually 533 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
394B</usr/lib/X11/app-defaults/URxvt>) and resources set in 534 4. SCREEN_RESOURCES for the current screen
395B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist. 535 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
536
396Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 537Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
397class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 538names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
398resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 539common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
399easily configured, while the class name B<URxvt> allows resources 540configured, while the class name B<URxvt> allows resources unique to
400unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 541B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
401shared between different B<@@RXVT_NAME@@> configurations. If no 542configurations. If no resources are specified, suitable defaults will
402resources are specified, suitable defaults will be used. Command-line 543be used. Command-line arguments can be used to override resource
403arguments can be used to override resource settings. The following 544settings. The following resources are supported (you might want to
404resources are allowed: 545check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
546extensions not documented here):
405 547
406=over 4 548=over 4
549
550=item B<depth:> I<bitdepth>
551
552Compile I<xft>: Attempt to find a visual with the given bit depth;
553option B<-depth>.
407 554
408=item B<geometry:> I<geom> 555=item B<geometry:> I<geom>
409 556
410Create the window with the specified X window geometry [default 80x24]; 557Create the window with the specified X window geometry [default 80x24];
411option B<-geometry>. 558option B<-geometry>.
448Use the specified colour to display underlined characters when the 595Use the specified colour to display underlined characters when the
449foreground colour is the default. 596foreground colour is the default.
450 597
451=item B<colorRV:> I<colour> 598=item B<colorRV:> I<colour>
452 599
453Use the specified colour as the background for reverse video 600Use the specified colour as the background for reverse video characters
454characters. 601when OPTION_HC is disabled (--disable-frills).
455 602
456=item B<underlineColor:> I<colour> 603=item B<underlineColor:> I<colour>
457 604
458If set, use the specified colour as the colour for the underline 605If set, use the specified colour as the colour for the underline
459itself. If unset, use the foreground colour. 606itself. If unset, use the foreground colour.
475option B<-rv>. B<False>: regular screen colours [default]; option 622option B<-rv>. B<False>: regular screen colours [default]; option
476B<+rv>. See note in B<COLORS AND GRAPHICS> section. 623B<+rv>. See note in B<COLORS AND GRAPHICS> section.
477 624
478=item B<jumpScroll:> I<boolean> 625=item B<jumpScroll:> I<boolean>
479 626
480B<True>: specify that jump scrolling should be used. When scrolling 627B<True>: specify that jump scrolling should be used. When receiving lots
481quickly, fewer screen updates are performed [default]; option B<-j>. 628of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
629has been read, resulting in fewer updates while still displaying every
630received line; option B<-j>.
631
482B<False>: specify that smooth scrolling should be used; option B<+j>. 632B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
633force a screen refresh on each new line it received; option B<+j>.
634
635=item B<skipScroll:> I<boolean>
636
637B<True>: (the default) specify that skip scrolling should be used. When
638receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
639(around 60 times per second), resulting in far fewer updates. This can
640result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
641option B<-ss>.
642
643B<False>: specify that everything is to be displayed, even
644if the refresh is too fast for the human eye to read anything (or the
645monitor to display anything); option B<+ss>.
483 646
484=item B<inheritPixmap:> I<boolean> 647=item B<inheritPixmap:> I<boolean>
485 648
486B<True>: make the background inherit the parent windows' pixmap, giving 649B<True>: make the background inherit the parent windows' pixmap, giving
487artificial transparency. B<False>: do not inherit the parent windows' 650artificial transparency. B<False>: do not inherit the parent windows'
488pixmap. 651pixmap.
489 652
653I<Please note that transparency of any kind if completely unsupported by
654the author. Don't bug him with installation questions!>
655
490=item B<fading:> I<number> 656=item B<fading:> I<number>
491 657
492Fade the text by the given percentage when focus is lost. 658Fade the text by the given percentage when focus is lost; option B<-fade>.
659
660=item B<fadeColor:> I<colour>
661
662Fade to this colour, when fading is used (see B<fading:>). The default
663colour is black; option B<-fadecolor>.
493 664
494=item B<tintColor:> I<colour> 665=item B<tintColor:> I<colour>
495 666
496Tint the transparent background pixmap with the given colour. 667Tint the transparent background pixmap with the given colour; option
668B<-tint>.
497 669
498=item B<shading:> I<number> 670=item B<shading:> I<number>
499 671
500Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 672Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
501image in addition to tinting it. 673in addition to tinting it; option B<-sh>.
674
675=item B<blendType:> I<string>
676
677Specify background blending type; option B<-blt>.
678
679=item B<blurRadius:> I<number>
680
681Apply Gaussian Blurr with the specified radius to the transparent
682background image; option B<-blr>.
502 683
503=item B<scrollColor:> I<colour> 684=item B<scrollColor:> I<colour>
504 685
505Use the specified colour for the scrollbar [default #B2B2B2]. 686Use the specified colour for the scrollbar [default #B2B2B2].
506 687
507=item B<troughColor:> I<colour> 688=item B<troughColor:> I<colour>
508 689
509Use the specified colour for the scrollbar's trough area [default 690Use the specified colour for the scrollbar's trough area [default
510#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 691#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
511 692
512=item B<borderColor:> I<colour> 693=item B<borderColor:> I<colour>
513 694
514The colour of the border around the text area and between the scrollbar 695The colour of the border around the text area and between the scrollbar
515and the text. 696and the text.
516 697
517=item B<backgroundPixmap:> I<file[;geom]> 698=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
518 699
519Use the specified XPM file (note the `.xpm' extension is optional) for 700Use the specified image file for the background and also optionally
520the background and also optionally specify its scaling with a geometry 701specify its scaling with a geometry string B<WxH+X+Y>,
521string B<WxH+X+Y>, in which B<"W" / "H"> specify the 702in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
522horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 703and B<"X" / "Y"> locate the image centre (percent).
523centre (percent). A scale of 0 displays the image with tiling. A scale 704A scale of 0 displays the image with tiling. A scale of 1 displays the
524of 1 displays the image without any scaling. A scale of 2 to 9 705image without any scaling. A scale of 2 to 9 specifies an integer
525specifies an integer number of images in that direction. No image will 706number of images in that direction. No image will be magnified beyond
526be magnified beyond 10 times its original size. The maximum permitted 70710 times its original size. The maximum permitted scale is 1000.
527scale is 1000. [default 0x0+50+50] 708Additional operations can be specified after colon B<:op1:op2...>.
709Supported operations are:
710 B<"tile"> - force background image to be tiled and not scaled. Equivalent to 0x0,
711 B<"propscale"> - will scale image keeping proportions,
712 B<"auto"> - will scale image to match window size. Equivalent to 100x100;
713 B<"hscale"> - will scale image horizontally to the window size;
714 B<"vscale"> - will scale image vertically to the window size;
715 B<"scale"> - will scale image to match window size;
716 B<"root"> - will tile image as if it was a root window background, auto-adjusting
717 whenever terminal window moves.
528 718
529=item B<menu:> I<file[;tag]> 719If used in conjunction with B<-tr> option - specified pixmap will be
530 720blended over transparency image using either alpha-blending, or any
531Read in the specified menu file (note the `.menu' extension is 721other blending type, specified with B<-blt "type"> option.
532optional) and also optionally specify a starting tag to find. See the 722[default 0x0+50+50]
533reference documentation for details on the syntax for the menuBar.
534 723
535=item B<path:> I<path> 724=item B<path:> I<path>
536 725
537Specify the colon-delimited search path for finding files (XPM and 726Specify the colon-delimited search path for finding background image files.
538menus), in addition to the paths specified by the B<RXVTPATH> and
539B<PATH> environment variables.
540 727
541=item B<font:> I<fontlist> 728=item B<font:> I<fontlist>
542 729
543Select the fonts to be used. This is a comma separated list of font 730Select the fonts to be used. This is a comma separated list of font names
544names that are used in turn when trying to display Unicode characters. 731that are checked in order when trying to find glyphs for characters. The
545The first font defines the cell size for characters; other fonts might 732first font defines the cell size for characters; other fonts might be
546be smaller, but not larger. A reasonable default font list is always 733smaller, but not (in general) larger. A (hopefully) reasonable default
547appended to it. option B<-fn>. 734font list is always appended to it; option B<-fn>.
548 735
549Each font can either be a standard X11 core font (XLFD) name, with 736Each font can either be a standard X11 core font (XLFD) name, with
550optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 737optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
551 738
552In addition, each font can be prefixed with additional hints and 739In addition, each font can be prefixed with additional hints and
554hint currently is C<codeset=codeset-name>, and this is only used for Xft 741hint currently is C<codeset=codeset-name>, and this is only used for Xft
555fonts. 742fonts.
556 743
557For example, this font resource 744For example, this font resource
558 745
559 URxvt*font: 9x15bold,\ 746 URxvt.font: 9x15bold,\
560 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 747 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
561 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 748 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
562 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 749 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
563 xft:Code2000:antialias=false 750 xft:Code2000:antialias=false
564 751
598not possible, replacement fonts of the desired shape will be tried. 785not possible, replacement fonts of the desired shape will be tried.
599 786
600If set, but empty, then this specific style is disabled and the normal 787If set, but empty, then this specific style is disabled and the normal
601text font will being used for the given style. 788text font will being used for the given style.
602 789
790=item B<intensityStyles:> I<boolean>
791
792When font styles are not enabled, or this option is enabled (B<True>,
793option B<-is>, the default), bold and italic font styles imply high
794intensity foreground/background colours. Disabling this option (B<False>,
795option B<+is>) disables this behaviour, the high intensity colours are not
796reachable.
797
603=item B<selectstyle:> I<mode> 798=item B<selectstyle:> I<mode>
604 799
605Set mouse selection style to B<old> which is 2.20, B<oldword> which is 800Set mouse selection style to B<old> which is 2.20, B<oldword> which
606xterm style with 2.20 old word selection, or anything else which gives 801is xterm style with 2.20 old word selection, or anything else which
607xterm style selection. 802gives xterm style selection. Only effective when the original (non-perl)
803selection code is in use.
608 804
609=item B<scrollstyle:> I<mode> 805=item B<scrollstyle:> I<mode>
610 806
611Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 807Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
612the author's favourite.. 808the author's favourite.
613 809
614=item B<title:> I<string> 810=item B<title:> I<string>
615 811
616Set window title string, the default title is the command-line 812Set window title string, the default title is the command-line
617specified after the B<-e> option, if any, otherwise the application 813specified after the B<-e> option, if any, otherwise the application
626=item B<mapAlert:> I<boolean> 822=item B<mapAlert:> I<boolean>
627 823
628B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 824B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
629de-iconify (map) on receipt of a bell character [default]. 825de-iconify (map) on receipt of a bell character [default].
630 826
827=item B<urgentOnBell:> I<boolean>
828
829B<True>: set the urgency hint for the wm on receipt of a bell character.
830B<False>: do not set the urgency hint [default].
831
631=item B<visualBell:> I<boolean> 832=item B<visualBell:> I<boolean>
632 833
633B<True>: use visual bell on receipt of a bell character; option B<-vb>. 834B<True>: use visual bell on receipt of a bell character; option B<-vb>.
634B<False>: no visual bell [default]; option B<+vb>. 835B<False>: no visual bell [default]; option B<+vb>.
635 836
649 850
650Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 851Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
651B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or 852B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
652B<Shift-Print> to include the scrollback as well. 853B<Shift-Print> to include the scrollback as well.
653 854
855The string will be interpreted as if typed into the shell as-is.
856
857Example:
858
859 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
860
861This creates a new file in your home directory with the screen contents
862every time you hit C<Print>.
863
654=item B<scrollBar:> I<boolean> 864=item B<scrollBar:> I<boolean>
655 865
656B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 866B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
657disable the scrollbar; option B<+sb>. 867disable the scrollbar; option B<+sb>.
658 868
678B<+si>. 888B<+si>.
679 889
680=item B<scrollWithBuffer:> I<boolean> 890=item B<scrollWithBuffer:> I<boolean>
681 891
682B<True>: scroll with scrollback buffer when tty receives new lines (and 892B<True>: scroll with scrollback buffer when tty receives new lines (and
683B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 893B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
684with scrollback buffer when tty recieves new lines; option B<-sw>. 894with scrollback buffer when tty receives new lines; option B<+sw>.
685 895
686=item B<scrollTtyKeypress:> I<boolean> 896=item B<scrollTtyKeypress:> I<boolean>
687 897
688B<True>: scroll to bottom when a non-special key is pressed. Special keys 898B<True>: scroll to bottom when a non-special key is pressed. Special keys
689are those which are intercepted by rxvt-unicode for special handling and 899are those which are intercepted by rxvt-unicode for special handling and
708=item B<borderLess:> I<boolean> 918=item B<borderLess:> I<boolean>
709 919
710Set MWM hints to request a borderless window, i.e. if honoured by the 920Set MWM hints to request a borderless window, i.e. if honoured by the
711WM, the rxvt-unicode window will not have window decorations; option B<-bl>. 921WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
712 922
923=item B<skipBuiltinGlyphs:> I<boolean>
924
925Compile I<frills>: Disable the usage of the built-in block graphics/line
926drawing characters and just rely on what the specified fonts provide. Use
927this if you have a good font and want to use its block graphic glyphs;
928option B<-sbg>.
929
713=item B<termName:> I<termname> 930=item B<termName:> I<termname>
714 931
715Specifies the terminal type name to be set in the B<TERM> environment 932Specifies the terminal type name to be set in the B<TERM> environment
716variable; option B<-tn>. 933variable; option B<-tn>.
717 934
718=item B<linespace:> I<number> 935=item B<lineSpace:> I<number>
719 936
720Specifies number of lines (pixel height) to insert between each row of 937Specifies number of lines (pixel height) to insert between each row of
721the display [default 0]; option B<-lsp>. 938the display [default 0]; option B<-lsp>.
722 939
723=item B<meta8:> I<boolean> 940=item B<meta8:> I<boolean>
754 971
755Mouse pointer background colour. 972Mouse pointer background colour.
756 973
757=item B<pointerBlankDelay:> I<number> 974=item B<pointerBlankDelay:> I<number>
758 975
759Specifies number of seconds before blanking the pointer [default 2]. 976Specifies number of seconds before blanking the pointer [default 2]. Use a
977large number (e.g. C<987654321>) to effectively disable the timeout.
760 978
761=item B<backspacekey:> I<string> 979=item B<backspacekey:> I<string>
762 980
763The string to send when the backspace key is pressed. If set to B<DEC> 981The string to send when the backspace key is pressed. If set to B<DEC>
764or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 982or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
771pressed. If unset it will send the sequence traditionally associated 989pressed. If unset it will send the sequence traditionally associated
772with the B<Execute> key. 990with the B<Execute> key.
773 991
774=item B<cutchars:> I<string> 992=item B<cutchars:> I<string>
775 993
776The characters used as delimiters for double-click word selection. The 994The characters used as delimiters for double-click word selection
777built-in default: 995(whitespace delimiting is added automatically if resource is given).
996
997When the perl selection extension is in use (the default if compiled
998in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
999characters will be created (if the resource exists, otherwise, no regex
1000will be created). In this mode, characters outside ISO-8859-1 can be used.
1001
1002When the selection extension is not used, only ISO-8859-1 characters can
1003be used. If not specified, the built-in default is used:
778 1004
779B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1005B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
780 1006
781=item B<preeditType:> I<style> 1007=item B<preeditType:> I<style>
782 1008
789=item B<imLocale:> I<name> 1015=item B<imLocale:> I<name>
790 1016
791The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. 1017The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
792C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the 1018C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
793input extension to be able to input japanese characters while staying in 1019input extension to be able to input japanese characters while staying in
794another locale. option B<-imlocale>. 1020another locale; option B<-imlocale>.
795 1021
796=item B<imFont:> I<fontset> 1022=item B<imFont:> I<fontset>
797 1023
798Specify the font-set used for XIM styles C<OverTheSpot> or 1024Specify the font-set used for XIM styles C<OverTheSpot> or
799C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated 1025C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
804 1030
805=item B<tripleclickwords:> I<boolean> 1031=item B<tripleclickwords:> I<boolean>
806 1032
807Change the meaning of triple-click selection with the left mouse 1033Change the meaning of triple-click selection with the left mouse
808button. Instead of selecting a full line it will extend the selection to 1034button. Instead of selecting a full line it will extend the selection to
809the end of the logical line only. option B<-tcw>. 1035the end of the logical line only; option B<-tcw>.
810 1036
811=item B<insecure:> I<boolean> 1037=item B<insecure:> I<boolean>
812 1038
813Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1039Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
814echo arbitrary strings like the icon name or the locale. This could be 1040echo arbitrary strings like the icon name or the locale. This could be
815abused if somebody gets 8-bit-clean access to your display, whether 1041abused if somebody gets 8-bit-clean access to your display, whether
816throuh a mail client displaying mail bodies unfiltered or though 1042through a mail client displaying mail bodies unfiltered or through
817write(1). Therefore, these sequences are disabled by default. (Note 1043write(1) or any other means. Therefore, these sequences are disabled by
818that other terminals, including xterm, have these sequences 1044default. (Note that many other terminals, including xterm, have these
819enabled by default). You can enable them by setting this boolean 1045sequences enabled by default, which doesn't make it safer, though).
820resource or specifying B<-insecure> as an option. At the moment, this 1046
821enabled display-answer, locale, findfont, icon label and window title 1047You can enable them by setting this boolean resource or specifying
822requests as well as dynamic menubar dispatch. 1048B<-insecure> as an option. At the moment, this enables display-answer,
1049locale, findfont, icon label and window title requests.
823 1050
824=item B<modifier:> I<modifier> 1051=item B<modifier:> I<modifier>
825 1052
826Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 1053Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
827B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 1054B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
831 1058
832Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1059Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
833character is passed through. It may contain escape values as described 1060character is passed through. It may contain escape values as described
834in the entry on B<keysym> following. 1061in the entry on B<keysym> following.
835 1062
836=item B<secondaryScreen:> I<bool> 1063=item B<secondaryScreen:> I<boolean>
837 1064
838Turn on/off secondary screen (default enabled). 1065Turn on/off secondary screen (default enabled).
839 1066
840=item B<secondaryScroll:> I<bool> 1067=item B<secondaryScroll:> I<boolean>
841 1068
842Turn on/off secondary screen scroll (default enabled). If the this 1069Turn on/off secondary screen scroll (default enabled). If this
843option is enabled, scrolls on the secondary screen will change the 1070option is enabled, scrolls on the secondary screen will change the
844scrollback buffer and switching to/from the secondary screen will 1071scrollback buffer and switching to/from the secondary screen will
845instead scroll the screen up. 1072instead scroll the screen up.
1073
1074=item B<hold>: I<boolean>
1075
1076Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1077will not immediately destroy its window when the program executed within
1078it exits. Instead, it will wait till it is being killed or closed by the
1079user.
846 1080
847=item B<keysym.>I<sym>: I<string> 1081=item B<keysym.>I<sym>: I<string>
848 1082
849Compile I<frills>: Associate I<string> with keysym I<sym>. The 1083Compile I<frills>: Associate I<string> with keysym I<sym>. The
850intervening resource name B<keysym.> cannot be omitted. 1084intervening resource name B<keysym.> cannot be omitted.
864searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1098searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
865omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1099omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
866keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1100keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
867performed in an exact manner; however, the closest match is assured. 1101performed in an exact manner; however, the closest match is assured.
868 1102
869I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1103I<string> may contain escape values (C<\n>: newline, C<\000>: octal
870C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1104number), see RESOURCES in C<man 7 X> for futher details.
871C<\000>: octal number) or verbatim control characters (C<^?>: delete,
872C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
873can start or end with whitespace.
874
875Please note that you need to double the C<\> when using
876C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
877use C<\033> instead of C<\e> (and so on), which will work with both Xt and
878@@RXVT_NAME@@'s own processing).
879 1105
880You can define a range of keysyms in one shot by providing a I<string> 1106You can define a range of keysyms in one shot by providing a I<string>
881with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1107with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
882should be a character not used by the strings. 1108should be a character not used by the strings.
883 1109
884Its usage can be demonstrated by an example: 1110Its usage can be demonstrated by an example:
885 1111
886 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1112 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
896example the following means "change the current locale to C<zh_CN.GBK> 1122example the following means "change the current locale to C<zh_CN.GBK>
897when Control-Meta-c is being pressed": 1123when Control-Meta-c is being pressed":
898 1124
899 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1125 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
900 1126
1127If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1128is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1129manpage. For example, the F<selection> extension (activated via
1130C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1131
1132 URxvt.keysym.M-C-c: perl:selection:rot13
1133
1134Due the the large number of modifier combinations, a defined key mapping
1135will match if at I<at least> the specified identifiers are being set, and
1136no other key mappings with those and more bits are being defined. That
1137means that defining a key map for C<a> will automatically provide
1138definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1139mappings themselves.
1140
1141Unfortunately, this will override built-in key mappings. For example
1142if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
1143C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
1144user-defined keymap using the C<builtin:> replacement:
1145
1146 URxvt.keysym.Insert: <my insert key sequence>
1147 URxvt.keysym.S-Insert: builtin:
1148
1149The first line defines a mapping for C<Insert> and I<any> combination
1150of modifiers. The second line re-establishes the default mapping for
1151C<Shift-Insert>.
1152
901The following example will map Control-Meta-1 and Control-Meta-2 to 1153The following example will map Control-Meta-1 and Control-Meta-2 to
902the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited 1154the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
903font-switching at runtime: 1155font-switching at runtime:
904 1156
905 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1157 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
908Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1160Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
909info): 1161info):
910 1162
911 URxvt.keysym.M-C-3: command:\033[8;25;80t 1163 URxvt.keysym.M-C-3: command:\033[8;25;80t
912 URxvt.keysym.M-C-4: command:\033[8;48;110t 1164 URxvt.keysym.M-C-4: command:\033[8;48;110t
1165
1166=item B<perl-ext-common>: I<string>
1167
1168=item B<perl-ext>: I<string>
1169
1170Comma-separated list(s) of perl extension scripts (default: C<default>) to
1171use in this terminal instance; option B<-pe>.
1172
1173Extension names can be prefixed with a C<-> sign to prohibit using
1174them. This can be useful to selectively disable some extensions loaded
1175by default, or specified via the C<perl-ext-common> resource. For
1176example, C<default,-selection> will use all the default extension except
1177C<selection>.
1178
1179Extension names can also be followed by an argument in angle brackets
1180(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1181searchable scrollback to Alt/Meta-s). Mentioning the same extension
1182multiple times with different arguments will pass multiple arguments to
1183the extension.
1184
1185Each extension is looked up in the library directories, loaded if
1186necessary, and bound to the current terminal instance.
1187
1188If both of these resources are the empty string, then the perl
1189interpreter will not be initialized. The idea behind two options is that
1190B<perl-ext-common> will be used for extensions that should be available to
1191all instances, while B<perl-ext> is used for specific instances.
1192
1193=item B<perl-eval>: I<string>
1194
1195Perl code to be evaluated when all extensions have been registered. See
1196the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1197will be ignored when running setuid/setgid.
1198
1199=item B<perl-lib>: I<path>
1200
1201Colon-separated list of additional directories that hold extension
1202scripts. When looking for extensions specified by the C<perl> resource,
1203@@RXVT_NAME@@ will first look in these directories and then in
1204F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1205will be ignored when running setuid/setgid.
1206
1207See the @@RXVT_NAME@@perl(3) manpage.
1208
1209=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1210
1211Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1212details.
1213
1214=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1215
1216Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1217for details.
1218
1219=item B<searchable-scrollback:> I<keysym>
1220
1221Sets the hotkey that starts the incremental scrollback buffer search
1222(default: C<M-s>).
1223
1224=item B<urlLauncher>: I<string>
1225
1226Specifies the program to be started with a URL argument. Used by the
1227C<selection-popup> and C<matcher> perl extensions.
1228
1229=item B<transient-for>: I<windowid>
1230
1231Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1232
1233=item B<override-redirect>: I<boolean>
1234
1235Compile I<frills>: Sets override-redirect for the terminal window, making
1236it almost invisible to window managers; option B<-override-redirect>.
1237
1238=item B<iso14755_52:> I<boolean>
1239
1240Turn on/off ISO 14755 5.2 mode (default enabled).
913 1241
914=back 1242=back
915 1243
916=head1 THE SCROLLBAR 1244=head1 THE SCROLLBAR
917 1245
931the normal text selection/insertion, hold either the Shift or the Meta 1259the normal text selection/insertion, hold either the Shift or the Meta
932(Alt) key while performing the desired mouse action. 1260(Alt) key while performing the desired mouse action.
933 1261
934If mouse reporting mode is active, the normal scrollbar actions are 1262If mouse reporting mode is active, the normal scrollbar actions are
935disabled -- on the assumption that we are using a fullscreen 1263disabled -- on the assumption that we are using a fullscreen
936application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 1264application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
937(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 1265(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
938up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down), 1266up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
939respectively. 1267respectively.
940 1268
941=head1 TEXT SELECTION AND INSERTION 1269=head1 THE SELECTION: SELECTING AND PASTING TEXT
942 1270
943The behaviour of text selection and insertion mechanism is similar to 1271The behaviour of text selection and insertion/pasting mechanism is similar
944I<xterm>(1). 1272to I<xterm>(1).
945 1273
946=over 4 1274=over 4
947 1275
948=item B<Selection>: 1276=item B<Selecting>:
949 1277
950Left click at the beginning of the region, drag to the end of the region 1278Left click at the beginning of the region, drag to the end of the region
951and release; Right click to extend the marked region; Left double-click 1279and release; Right click to extend the marked region; Left double-click
952to select a word; Left triple-click to select the entire logical line 1280to select a word; Left triple-click to select the entire logical line
953(which can span multiple screen lines), unless modified by resource 1281(which can span multiple screen lines), unless modified by resource
954B<tripleclickwords>. 1282B<tripleclickwords>.
955 1283
956Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1284Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
957(Compile: I<frills>) will create a rectangular selection instead of a normal 1285(Compile: I<frills>) will create a rectangular selection instead of a
958one. 1286normal one. In this mode, every selected row becomes its own line in the
1287selection, and trailing whitespace is visually underlined and removed from
1288the selection.
959 1289
960=item B<Insertion>: 1290=item B<Pasting>:
961 1291
962Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1292Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
963an B<@@RXVT_NAME@@> window causes the current text selection to be 1293window causes the value of the PRIMARY selection (or CLIPBOARD with the
964inserted as if it had been typed on the keyboard. 1294B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1295
1296Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1297inserted too.
965 1298
966=back 1299=back
967 1300
968=head1 CHANGING FONTS 1301=head1 CHANGING FONTS
969 1302
970Changing fonts (or font sizes, respectively) via the keypad is not yet 1303Changing fonts (or font sizes, respectively) via the keypad is not yet
971supported in rxvt-unicode. Bug me if you need this. 1304supported in rxvt-unicode. Bug me if you need this.
972 1305
973You can, however, switch fonts at runtime using escape sequences (and 1306You can, however, switch fonts at runtime using escape sequences, e.g.:
974therefore using the menubar), e.g.:
975 1307
976 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1308 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1309
1310You can use keyboard shortcuts, too:
1311
1312 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1313 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
977 1314
978rxvt-unicode will automatically re-apply these fonts to the output so far. 1315rxvt-unicode will automatically re-apply these fonts to the output so far.
979 1316
980=head1 ISO 14755 SUPPORT 1317=head1 ISO 14755 SUPPORT
981 1318
982ISO 14755 is a standard for entering and viewing unicode characters 1319ISO 14755 is a standard for entering and viewing unicode characters
983and character codes using the keyboard. It consists of 4 parts. The 1320and character codes using the keyboard. It consists of 4 parts. The
984first part is available rxvt-unicode has been compiled with 1321first part is available if rxvt-unicode has been compiled with
985C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1322C<--enable-frills>, the rest is available when rxvt-unicode was compiled
986with C<--enable-iso14755>. 1323with C<--enable-iso14755>.
987 1324
988=over 4 1325=over 4
989 1326
1009This mode lets you input characters representing the keycap symbols of 1346This mode lets you input characters representing the keycap symbols of
1010your keyboard, if representable in the current locale encoding. 1347your keyboard, if representable in the current locale encoding.
1011 1348
1012Start by pressing C<Control> and C<Shift> together, then releasing 1349Start by pressing C<Control> and C<Shift> together, then releasing
1013them. The next special key (cursor keys, home etc.) you enter will not 1350them. The next special key (cursor keys, home etc.) you enter will not
1014invoke it's usual function but instead will insert the corresponding 1351invoke its usual function but instead will insert the corresponding
1015keycap symbol. The symbol will only be entered when the key has been 1352keycap symbol. The symbol will only be entered when the key has been
1016released, otherwise pressing e.g. C<Shift> would enter the symbol for 1353released, otherwise pressing e.g. C<Shift> would enter the symbol for
1017C<ISO Level 2 Switch>, although your intention might have been to enter a 1354C<ISO Level 2 Switch>, although your intention might have been to enter a
1018reverse tab (Shift-Tab). 1355reverse tab (Shift-Tab).
1019 1356
1052=head1 COLORS AND GRAPHICS 1389=head1 COLORS AND GRAPHICS
1053 1390
1054In addition to the default foreground and background colours, 1391In addition to the default foreground and background colours,
1055B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1392B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1056high-intensity bold/blink versions of the same). Here is a list of the 1393high-intensity bold/blink versions of the same). Here is a list of the
1057colours with their B<rgb.txt> names. 1394colours with their names.
1058 1395
1059=begin table 1396=begin table
1060 1397
1061 B<color0> (black) = Black 1398 B<color0> (black) = Black
1062 B<color1> (red) = Red3 1399 B<color1> (red) = Red3
1082It is also possible to specify the colour values of B<foreground>, 1419It is also possible to specify the colour values of B<foreground>,
1083B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1420B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1084a number 0-15, as a convenient shorthand to reference the colour name of 1421a number 0-15, as a convenient shorthand to reference the colour name of
1085color0-color15. 1422color0-color15.
1086 1423
1424In addition to the colours defined above, @@RXVT_NAME@@ offers an
1425additional 72 colours. The first 64 of those (with indices 16 to 79)
1426consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
142716>), followed by 8 additional shades of gray (with indices 80 to 87).
1428
1429Together, all those colours implement the 88 colour xterm colours. Only
1430the first 16 can be changed using resources currently, the rest can only
1431be changed via command sequences ("escape codes").
1432
1087Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1433Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1088always swapping the foreground/background colours. This is in contrast to 1434always swapping the foreground/background colours. This is in contrast to
1089I<xterm>(1) where the colours are only swapped if they have not otherwise 1435I<xterm>(1) where the colours are only swapped if they have not otherwise
1090been specified. For example, 1436been specified. For example,
1091 1437
1096would yield White on Black, while on I<xterm>(1) it would yield Black 1442would yield White on Black, while on I<xterm>(1) it would yield Black
1097on White. 1443on White.
1098 1444
1099=back 1445=back
1100 1446
1447=head2 ALPHA CHANNEL SUPPORT
1448
1449If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1450their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1451(recommended, but B<MUST> have 4 digits/component) colour specifications,
1452in addition to the ones provided by X, where the additional A component
1453specifies opacity (alpha) values. The minimum value of C<0> is completely
1454transparent). You can also prefix any color with C<[percent]>, where
1455C<percent> is a decimal percentage (0-100) that specifies the opacity of
1456the color, where C<0> is completely transparent and C<100> is completelxy
1457opaque.
1458
1459You probably need to specify B<"-depth 32">, too, and have the luck that
1460your X-server uses ARGB pixel layout, as X is far from just supporting
1461ARGB visuals out of the box, and rxvt-unicode just fudges around.
1462
1463For example, the following selects an almost completely transparent red
1464background, and an almost opaque pink foreground:
1465
1466 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1467
1468I<Please note that transparency of any kind if completely unsupported by
1469the author. Don't bug him with installation questions!>
1470
1101=head1 ENVIRONMENT 1471=head1 ENVIRONMENT
1102 1472
1103B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> 1473B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1104and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X 1474
1105window id number of the B<@@RXVT_NAME@@> window and it also uses and 1475=over 4
1106sets the environment variable B<DISPLAY> to specify which display 1476
1107terminal to use. B<@@RXVT_NAME@@> uses the environment variables 1477=item B<TERM>
1108B<RXVTPATH> and B<PATH> to find XPM files. 1478
1479Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1480resources or on the command line.
1481
1482=item B<COLORTERM>
1483
1484Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1485compiled with background image support, and optionally with the added
1486extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1487screen.
1488
1489=item B<COLORFGBG>
1490
1491Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1492the colour code used as default foreground/text colour (or the string
1493C<default> to indicate that the default-colour escape sequence is to be
1494used), C<bg> is the colour code used as default background colour (or the
1495string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1496was compiled with background image support. Libraries like C<ncurses>
1497and C<slang> can (and do) use this information to optimize screen output.
1498
1499=item B<WINDOWID>
1500
1501Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1502window, which usually has subwindows for the scrollbar, the terminal
1503window and so on).
1504
1505=item B<TERMINFO>
1506
1507Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1508C<--with-terminfo=PATH>.
1509
1510=item B<DISPLAY>
1511
1512Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1513display in its child processes.
1514
1515=item B<SHELL>
1516
1517The shell to be used for command execution, defaults to C</bin/sh>.
1518
1519=item B<RXVT_SOCKET>
1520
1521The unix domain socket path used by @@RXVT_NAME@@c(1) and
1522@@RXVT_NAME@@d(1).
1523
1524Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1525
1526=item B<HOME>
1527
1528Used to locate the default directory for the unix domain socket for
1529daemon communications and to locate various resource files (such as
1530C<.Xdefaults>)
1531
1532=item B<XAPPLRESDIR>
1533
1534Directory where various X resource files are being located.
1535
1536=item B<XENVIRONMENT>
1537
1538If set and accessible, gives the name of a X resource file to be loaded by
1539@@RXVT_NAME@@.
1540
1541=back
1109 1542
1110=head1 FILES 1543=head1 FILES
1111 1544
1112=over 4 1545=over 4
1113 1546
1117 1550
1118=back 1551=back
1119 1552
1120=head1 SEE ALSO 1553=head1 SEE ALSO
1121 1554
1122@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1555@@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)
1123
1124=head1 BUGS
1125
1126Check the BUGS file for an up-to-date list.
1127
1128Cursor change support is not yet implemented.
1129
1130Click-and-drag doesn't work with X11 mouse report overriding.
1131 1556
1132=head1 CURRENT PROJECT COORDINATOR 1557=head1 CURRENT PROJECT COORDINATOR
1133 1558
1134=over 4 1559=over 4
1135 1560
1136=item Project Coordinator 1561=item Project Coordinator
1137 1562
1138@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1563Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1139 1564
1140=item Web page maintainter 1565L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1141
1142@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1143
1144L<@@RXVT_WEBPAGE@@>
1145 1566
1146=back 1567=back
1147 1568
1148=head1 AUTHORS 1569=head1 AUTHORS
1149 1570
1171 1592
1172Project Coordinator (changes.txt 2.21a to 2.4.5) 1593Project Coordinator (changes.txt 2.21a to 2.4.5)
1173 1594
1174=item Geoff Wing L<< <gcw@pobox.com> >> 1595=item Geoff Wing L<< <gcw@pobox.com> >>
1175 1596
1176Rewrote screen display and text selection routines. Project Coordinator 1597Rewrote screen display and text selection routines.
1598
1177(changes.txt 2.4.6 - rxvt-unicode) 1599Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1178 1600
1179=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1601=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1180 1602
1181Forked rxvt-unicode, rewrote most of the display code and internal 1603Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1182character handling to store text in unicode, improve xterm 1604extension, random hacks, numerous bugfixes and extensions.
1183compatibility and apply numerous other bugfixes and extensions.
1184 1605
1185Project Coordinator (Changes 1.0 -) 1606Project Coordinator (Changes 1.0 -)
1186 1607
1608=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1609
1610Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1611
1187=back 1612=back
1188 1613

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines