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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines