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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines