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.12 by root, Mon Aug 16 02:09:28 2004 UTC vs.
Revision 1.106 by root, Wed Jan 25 21:03:03 2006 UTC

11B<rxvt-unicode>, version B<@@RXVT_VERSION@@>, is a colour vt102 terminal 11B<rxvt-unicode>, version B<@@RXVT_VERSION@@>, is a colour vt102 terminal
12emulator intended as an I<xterm>(1) replacement for users who do not 12emulator intended as an I<xterm>(1) replacement for users who do not
13require features such as Tektronix 4014 emulation and toolkit-style 13require features such as Tektronix 4014 emulation and toolkit-style
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
17=head1 FREQUENTLY ASKED QUESTIONS
18
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
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/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
16 23
17=head1 RXVT-UNICODE VS. RXVT 24=head1 RXVT-UNICODE VS. RXVT
18 25
19Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
20internally. That means it can store and display most scripts in the 27internally. That means it can store and display most scripts in the
24like tibetan or devenagari. Don't expect pretty output when using these 31like tibetan or devenagari. Don't expect pretty output when using these
25scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
26fine, though. A somewhat difficult case are left-to-right scripts, such 33fine, though. A somewhat difficult case are left-to-right scripts, such
27as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
28belong into the application, not the terminal emulator (too many things -- 35belong into the application, not the terminal emulator (too many things --
29such as cursor-movement while editing -- break othwerwise), but that might 36such as cursor-movement while editing -- break otherwise), but that might
30change. 37change.
31 38
32If 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
33me recommend C<mlterm>, which is a very userfriendly, lean and clean 40me recommend C<mlterm>, which is a very userfriendly, lean and clean
34terminal emulator. In fact, the reason rxvt-unicode was born was solely 41terminal emulator. In fact, the reason rxvt-unicode was born was solely
53drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
54@@RXVT_NAME@@c(1) (client). 61@@RXVT_NAME@@c(1) (client).
55 62
56It also makes technical information about escape sequences (which have 63It also makes technical information about escape sequences (which have
57been extended) easier accessible: see @@RXVT_NAME@@(7) for technical 64been extended) easier accessible: see @@RXVT_NAME@@(7) for technical
58reference documentation (escape sequences etc.) and the FAQ section at the 65reference documentation (escape sequences etc.).
59end of this document.
60 66
61=head1 OPTIONS 67=head1 OPTIONS
62 68
63The 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
64below. In keeping with the smaller-is-better philosophy, options may be 70below. In keeping with the smaller-is-better philosophy, options may be
87 93
88Attempt 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
89respected). In the absence of this option, the display specified by the 95respected). In the absence of this option, the display specified by the
90B<DISPLAY> environment variable is used. 96B<DISPLAY> environment variable is used.
91 97
98=item B<-depth> I<bitdepth>
99
100Compile I<frills>: Attempt to find a visual with the given bit depth;
101resource B<depth>.
102
92=item B<-geometry> I<geom> 103=item B<-geometry> I<geom>
93 104
94Window geometry (B<-g> still respected); resource B<geometry>. 105Window geometry (B<-g> still respected); resource B<geometry>.
95 106
96=item B<-rv>|B<+rv> 107=item B<-rv>|B<+rv>
99 110
100=item B<-j>|B<+j> 111=item B<-j>|B<+j>
101 112
102Turn on/off jump scrolling; resource B<jumpScroll>. 113Turn on/off jump scrolling; resource B<jumpScroll>.
103 114
104=item B<-ip>|B<+ip> 115=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
105 116
106Turn on/off inheriting parent window's pixmap. Alternative form is 117Turn on/off inheriting parent window's pixmap. Alternative form is
107B<-tr>; resource B<inheritPixmap>. 118B<-tr>; resource B<inheritPixmap>.
108 119
109=item B<-fade> I<number> 120=item B<-fade> I<number>
110 121
111Fade the text by the given percentage when focus is lost. 122Fade the text by the given percentage when focus is lost. Small values
123fade a little only, 100 completely replaces all colours by the fade
124colour; resource B<fading>.
125
126=item B<-fadecolor> I<colour>
127
128Fade to this colour when fading is used (see B<-fade>). The default colour
129is black. resource B<fadeColor>.
112 130
113=item B<-tint> I<colour> 131=item B<-tint> I<colour>
114 132
115Tint the transparent background pixmap with the given colour when 133Tint the transparent background pixmap with the given colour when
116transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> 134transparency is enabled with B<-tr> or B<-ip>. This only works for
117option that can be used to brighten or darken the image in addition to 135non-tiled backgrounds, currently. See also the B<-sh> option that can be
118tinting it. 136used to brighten or darken the image in addition to tinting it; resource
137I<tintColor>. Example:
138
139 @@RXVT_NAME@@ -tr -tint blue -sh 40
119 140
120=item B<-sh> 141=item B<-sh>
121 142
122I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 143I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
123background image in addition to tinting it (i.e. B<-tint> must be 144background image in addition to tinting it (i.e. B<-tint> must be
124specified, too). 145specified, too, e.g. C<-tint white>).
125 146
126=item B<-bg> I<colour> 147=item B<-bg> I<colour>
127 148
128Window background colour; resource B<background>. 149Window background colour; resource B<background>.
129 150
132Window foreground colour; resource B<foreground>. 153Window foreground colour; resource B<foreground>.
133 154
134=item B<-pixmap> I<file[;geom]> 155=item B<-pixmap> I<file[;geom]>
135 156
136Compile I<XPM>: Specify XPM file for the background and also optionally 157Compile I<XPM>: Specify XPM file for the background and also optionally
137specify its scaling with a geometry string. Note you may need to add 158specify its scaling with a geometry string. Note you may need to
138quotes to avoid special shell interpretation of the `;' in the 159add quotes to avoid special shell interpretation of the C<;> in the
139command-line; resource B<backgroundPixmap>. 160command-line; resource B<backgroundPixmap>.
140 161
141=item B<-cr> I<colour> 162=item B<-cr> I<colour>
142 163
143The cursor colour; resource B<cursorColor>. 164The cursor colour; resource B<cursorColor>.
150 171
151The mouse pointer background colour; resource B<pointerColor2>. 172The mouse pointer background colour; resource B<pointerColor2>.
152 173
153=item B<-bd> I<colour> 174=item B<-bd> I<colour>
154 175
155The colour of the border between the xterm scrollbar and the text; 176The colour of the border around the text area and between the scrollbar and the text;
156resource B<borderColor>. 177resource B<borderColor>.
157 178
158=item B<-fn> I<fontname> 179=item B<-fn> I<fontlist>
159 180
160Select the fonts to be used. This is a comma seperated list of font 181Select the fonts to be used. This is a comma separated list of font names
161names that are used in turn when trying to display Unicode characters. 182that are checked in order when trying to find glyphs for characters. The
162The first font defines the cell size for characters; other fonts might 183first font defines the cell size for characters; other fonts might be
163be smaller, but not larger. A reasonable default font list is always 184smaller, but not (in general) larger. A (hopefully) reasonable default
164appended to it. resource B<font>. 185font list is always appended to it. See resource B<font> for more details.
186
187In short, to specify an X11 core font, just specify it's name or prefix it
188with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
189e.g.:
190
191 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
192 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
165 193
166See also the question "How does rxvt-unicode choose fonts?" in the FAQ 194See also the question "How does rxvt-unicode choose fonts?" in the FAQ
167section. 195section of @@RXVT_NAME@@(7).
168 196
197=item B<-fb> I<fontlist>
198
199Compile I<font-styles>: The bold font list to use when B<bold> characters
200are to be printed. See resource B<boldFont> for details.
201
202=item B<-fi> I<fontlist>
203
204Compile I<font-styles>: The italic font list to use when I<italic>
205characters are to be printed. See resource B<italicFont> for details.
206
207=item B<-fbi> I<fontlist>
208
209Compile I<font-styles>: The bold italic font list to use when B<< I<bold
210italic> >> characters are to be printed. See resource B<boldItalicFont>
211for details.
212
169=item B<-rb>|B<+rb> 213=item B<-is>|B<+is>
170 214
171Enable "real bold" support. When this option is on, bold text will be 215Compile I<font-styles>: Bold/Italic font styles imply high intensity
172displayed using the first available bold font in the font list. Bold 216foreground/background (default). See resource B<intensityStyles> for
173fonts should thus be specified in the font list after their 217details.
174corresponding regular fonts. If no bold font can be found, a regular
175font will be used. resource B<realBold>.
176 218
177=item B<-name> I<name> 219=item B<-name> I<name>
178 220
179Specify the application name under which resources are to be obtained, 221Specify the application name under which resources are to be obtained,
180rather than the default executable file name. Name should not contain 222rather than the default executable file name. Name should not contain
218 260
219Put scrollbar on right/left; resource B<scrollBar_right>. 261Put scrollbar on right/left; resource B<scrollBar_right>.
220 262
221=item B<-st>|B<+st> 263=item B<-st>|B<+st>
222 264
223Display normal (non XTerm/NeXT) scrollbar without/with a trough; 265Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
224resource B<scrollBar_floating>. 266resource B<scrollBar_floating>.
267
268=item B<-ptab>|B<+ptab>
269
270If enabled (default), "Horizontal Tab" characters are being stored as
271actual wide characters in the screen buffer, which makes it possible to
272select and paste them. Since a horizontal tab is a cursor movement and
273not an actual glyph, this can sometimes be visually annoying as the cursor
274on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
225 275
226=item B<-bc>|B<+bc> 276=item B<-bc>|B<+bc>
227 277
228Blink the cursor; resource B<cursorBlink>. 278Blink the cursor; resource B<cursorBlink>.
229 279
252 302
253Compile I<frills>: Set MWM hints to request a borderless window, i.e. 303Compile I<frills>: Set MWM hints to request a borderless window, i.e.
254if honoured by the WM, the rxvt-unicode window will not have window 304if honoured by the WM, the rxvt-unicode window will not have window
255decorations; resource B<borderLess>. 305decorations; resource B<borderLess>.
256 306
307=item B<-override-redirect>
308
309Compile I<frills>: Sets override-redirect on the window; resource
310B<override-redirect>.
311
312=item B<-sbg>
313
314Compile I<frills>: Disable the usage of the built-in block graphics/line
315drawing characters and just rely on what the specified fonts provide. Use
316this if you have a good font and want to use its block graphic glyphs;
317resource B<skipBuiltinGlyphs>.
318
257=item B<-lsp> I<number> 319=item B<-lsp> I<number>
258 320
259Compile I<linespace>: Lines (pixel height) to insert between each row 321Compile I<frills>: Lines (pixel height) to insert between each row of
260of the display; resource B<linespace>. 322the display. Useful to work around font rendering problems; resource
323B<linespace>.
261 324
262=item B<-tn> I<termname> 325=item B<-tn> I<termname>
263 326
264This option specifies the name of the terminal type to be set in the 327This option specifies the name of the terminal type to be set in the
265B<TERM> environment variable. This terminal type must exist in the 328B<TERM> environment variable. This terminal type must exist in the
274given on the command line. If this option is used, it must be the last 337given on the command line. If this option is used, it must be the last
275on the command-line. If there is no B<-e> option then the default is to 338on the command-line. If there is no B<-e> option then the default is to
276run the program specified by the B<SHELL> environment variable or, 339run the program specified by the B<SHELL> environment variable or,
277failing that, I<sh(1)>. 340failing that, I<sh(1)>.
278 341
342Please note that you must specify a program with arguments. If you want to
343run shell commands, you have to specify the shell, like this:
344
345 @@RXVT_NAME@@ -e sh -c "shell commands"
346
279=item B<-title> I<text> 347=item B<-title> I<text>
280 348
281Window title (B<-T> still respected); the default title is the basename 349Window title (B<-T> still respected); the default title is the basename
282of the program specified after the B<-e> option, if any, otherwise the 350of the program specified after the B<-e> option, if any, otherwise the
283application name; resource B<title>. 351application name; resource B<title>.
301 369
302Compile I<XIM>: input method name. resource B<inputMethod>. 370Compile I<XIM>: input method name. resource B<inputMethod>.
303 371
304=item B<-imlocale> I<string> 372=item B<-imlocale> I<string>
305 373
306The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 374The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
307de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 375C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
308extension to be able to input japanese characters while staying in 376input extension to be able to input japanese characters while staying in
309another locale. 377another locale. resource B<imLocale>.
378
379=item B<-imfont> I<fontset>
380
381Set the font set to use for the X Input Method, see resource B<imFont>
382for more info.
383
384=item B<-tcw>
385
386Change the meaning of triple-click selection with the left mouse
387button. Instead of selecting a full line it will extend the selection the
388end of the logical line only. resource B<tripleclickwords>.
310 389
311=item B<-insecure> 390=item B<-insecure>
312 391
313Enable "insecure" mode, which currently enables most of the escape 392Enable "insecure" mode, which currently enables most of the escape
314sequences that echo strings. See the resource B<insecure> for more 393sequences that echo strings. See the resource B<insecure> for more
328=item B<-ssr>|B<+ssr> 407=item B<-ssr>|B<+ssr>
329 408
330Turn on/off secondary screen scroll (default enabled); resource 409Turn on/off secondary screen scroll (default enabled); resource
331B<secondaryScroll>. 410B<secondaryScroll>.
332 411
412=item B<-hold>|B<+hold>
413
414Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
415will not immediately destroy its window when the program executed within
416it exits. Instead, it will wait till it is being killed or closed by the
417user; resource B<hold>.
418
419=item B<-keysym.>I<sym> I<string>
420
421Remap a key symbol. See resource B<keysym>.
422
423=item B<-embed> I<windowid>
424
425Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
426which enables applications to easily embed a terminal.
427
428Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
429shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
430quite a bit, so don't expect it to keep some specific state. It's best to
431create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
432
433The window will not be destroyed when @@RXVT_NAME@@ exits.
434
435It might be useful to know that @@RXVT_NAME@@ will not close file
436descriptors passed to it (except for stdin/out/err, of course), so you
437can use file descriptors to communicate with the programs within the
438terminal. This works regardless of wether the C<-embed> option was used or
439not.
440
441Here is a short Gtk2-perl snippet that illustrates how this option can be
442used (a longer example is in F<doc/embed>):
443
444 my $rxvt = new Gtk2::Socket;
445 $rxvt->signal_connect_after (realize => sub {
446 my $xid = $_[0]->window->get_xid;
447 system "@@RXVT_NAME@@ -embed $xid &";
448 });
449
450=item B<-pty-fd> I<file descriptor>
451
452Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
453pair but instead use the given filehandle as the tty master. This is
454useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
455without having to run a program within it.
456
457If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
458entries and will not tinker with pty/tty permissions - you have to do that
459yourself if you want that.
460
461As an extremely special case, specifying C<-1> will completely suppress
462pty/tty operations.
463
464Here is a example in perl that illustrates how this option can be used (a
465longer example is in F<doc/pty-fd>):
466
467 use IO::Pty;
468 use Fcntl;
469
470 my $pty = new IO::Pty;
471 fcntl $pty, F_SETFD, 0; # clear close-on-exec
472 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
473 close $pty;
474
475 # now communicate with rxvt
476 my $slave = $pty->slave;
477 while (<$slave>) { print $slave "got <$_>\n" }
478
333=item B<-xrm> I<resourcestring> 479=item B<-pe> I<string>
334 480
335No effect on rxvt-unicode. Simply passes through an argument to be made 481Comma-separated list of perl extension scripts to use (or not to use) in
336available in the instance's argument list. Appears in I<WM_COMMAND> in 482this terminal instance. See resource B<perl-ext> for details.
337some window managers.
338 483
339=back 484=back
340 485
341=head1 RESOURCES (available also as long-options) 486=head1 RESOURCES (available also as long-options)
342 487
343Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 488Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
344options) compiled into your version. 489options) compiled into your version.
345 490
346There are two different methods that @@RXVT_NAME@@ can use to get the 491You can set and change the resources using X11 tools like B<xrdb>. Many
347Xresource data: using the X libraries (Xrm*-functions) or internal 492distribution do also load settings from the B<~/.Xresources> file when X
348Xresources reader (B<~/.Xdefaults>). For the first method (ie. 493starts. @@RXVT_NAME@@ will consult the following files/resources in order,
349B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 494with later settings overwriting earlier ones:
350resources using X11 tools like B<xset>. Many distribution do also load
351settings from the B<~/.Xresources> file when X starts.
352 495
353If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> 496 1. system-wide app-defaults file, either locale-dependent OR global
354lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults 497 2. app-defaults file in $XAPPLRESDIR
355set in XAPPLOADDIR/URxvt (compile-time defined: usually 498 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
356B</usr/lib/X11/app-defaults/URxvt>) and resources set in 499 4. SCREEN_RESOURCES for the current screen
357B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist. 500 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
501
358Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 502Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
359class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 503names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
360resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 504common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
361easily configured, while the class name B<URxvt> allows resources 505configured, while the class name B<URxvt> allows resources unique to
362unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 506B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
363shared between different B<@@RXVT_NAME@@> configurations. If no 507configurations. If no resources are specified, suitable defaults will
364resources are specified, suitable defaults will be used. Command-line 508be used. Command-line arguments can be used to override resource
365arguments can be used to override resource settings. The following 509settings. The following resources are supported (you might want to
366resources are allowed: 510check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
511extensions not documented here):
367 512
368=over 4 513=over 4
514
515=item B<depth:> I<bitdepth>
516
517Compile I<frills>: Attempt to find a visual with the given bit depth;
518option B<-depth>.
369 519
370=item B<geometry:> I<geom> 520=item B<geometry:> I<geom>
371 521
372Create the window with the specified X window geometry [default 80x24]; 522Create the window with the specified X window geometry [default 80x24];
373option B<-geometry>. 523option B<-geometry>.
389high-intensity (bold = bright foreground, blink = bright background) 539high-intensity (bold = bright foreground, blink = bright background)
390colours. The canonical names are as follows: 0=black, 1=red, 2=green, 540colours. The canonical names are as follows: 0=black, 1=red, 2=green,
3913=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 5413=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
392names used are listed in the B<COLORS AND GRAPHICS> section. 542names used are listed in the B<COLORS AND GRAPHICS> section.
393 543
544Colours higher than 15 cannot be set using resources (yet), but can be
545changed using an escape command (see @@RXVT_NAME@@(7)).
546
547Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
54888 colour support). Colours 80-87 are evenly spaces grey steps.
549
394=item B<colorBD:> I<colour> 550=item B<colorBD:> I<colour>
395 551
552=item B<colorIT:> I<colour>
553
396Use the specified colour to display bold characters when the foreground 554Use the specified colour to display bold or italic characters when the
397colour is the default. This option will be ignored if B<realBold> is 555foreground colour is the default. If font styles are not available
398enabled. 556(Compile I<styles>) and this option is unset, reverse video is used instead.
399 557
400=item B<colorUL:> I<colour> 558=item B<colorUL:> I<colour>
401 559
402Use the specified colour to display underlined characters when the 560Use the specified colour to display underlined characters when the
403foreground colour is the default. 561foreground colour is the default.
404 562
405=item B<colorRV:> I<colour> 563=item B<colorRV:> I<colour>
406 564
407Use the specified colour as the background for reverse video 565Use the specified colour as the background for reverse video
408characters. 566characters.
567
568=item B<underlineColor:> I<colour>
569
570If set, use the specified colour as the colour for the underline
571itself. If unset, use the foreground colour.
409 572
410=item B<cursorColor:> I<colour> 573=item B<cursorColor:> I<colour>
411 574
412Use the specified colour for the cursor. The default is to use the 575Use the specified colour for the cursor. The default is to use the
413foreground colour; option B<-cr>. 576foreground colour; option B<-cr>.
436artificial transparency. B<False>: do not inherit the parent windows' 599artificial transparency. B<False>: do not inherit the parent windows'
437pixmap. 600pixmap.
438 601
439=item B<fading:> I<number> 602=item B<fading:> I<number>
440 603
441Fade the text by the given percentage when focus is lost. 604Fade the text by the given percentage when focus is lost; option B<-fade>.
605
606=item B<fadeColor:> I<colour>
607
608Fade to this colour, when fading is used (see B<fading:>). The default
609colour is black; option B<-fadecolor>.
442 610
443=item B<tintColor:> I<colour> 611=item B<tintColor:> I<colour>
444 612
445Tint the transparent background pixmap with the given colour. 613Tint the transparent background pixmap with the given colour; option
614B<-tint>.
446 615
447=item B<shading:> I<number> 616=item B<shading:> I<number>
448 617
449Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 618Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
450image in addition to tinting it. 619image in addition to tinting it.
451 620
452=item B<fading:> I<number>
453
454Scale the tint colour by the given percentage.
455
456=item B<scrollColor:> I<colour> 621=item B<scrollColor:> I<colour>
457 622
458Use the specified colour for the scrollbar [default #B2B2B2]. 623Use the specified colour for the scrollbar [default #B2B2B2].
459 624
460=item B<troughColor:> I<colour> 625=item B<troughColor:> I<colour>
461 626
462Use the specified colour for the scrollbar's trough area [default 627Use the specified colour for the scrollbar's trough area [default
463#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 628#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
629
630=item B<borderColor:> I<colour>
631
632The colour of the border around the text area and between the scrollbar
633and the text.
464 634
465=item B<backgroundPixmap:> I<file[;geom]> 635=item B<backgroundPixmap:> I<file[;geom]>
466 636
467Use the specified XPM file (note the `.xpm' extension is optional) for 637Use the specified XPM file (note the `.xpm' extension is optional) for
468the background and also optionally specify its scaling with a geometry 638the background and also optionally specify its scaling with a geometry
472of 1 displays the image without any scaling. A scale of 2 to 9 642of 1 displays the image without any scaling. A scale of 2 to 9
473specifies an integer number of images in that direction. No image will 643specifies an integer number of images in that direction. No image will
474be magnified beyond 10 times its original size. The maximum permitted 644be magnified beyond 10 times its original size. The maximum permitted
475scale is 1000. [default 0x0+50+50] 645scale is 1000. [default 0x0+50+50]
476 646
477=item B<menu:> I<file[;tag]>
478
479Read in the specified menu file (note the `.menu' extension is
480optional) and also optionally specify a starting tag to find. See the
481reference documentation for details on the syntax for the menuBar.
482
483=item B<path:> I<path> 647=item B<path:> I<path>
484 648
485Specify the colon-delimited search path for finding files (XPM and 649Specify the colon-delimited search path for finding XPM files.
486menus), in addition to the paths specified by the B<RXVTPATH> and
487B<PATH> environment variables.
488 650
489=item B<font:> I<fontname> 651=item B<font:> I<fontlist>
490 652
491Select the fonts to be used. This is a comma seperated list of font 653Select the fonts to be used. This is a comma separated list of font names
492names that are used in turn when trying to display Unicode characters. 654that are checked in order when trying to find glyphs for characters. The
493The first font defines the cell size for characters; other fonts might 655first font defines the cell size for characters; other fonts might be
494be smaller, but not larger. A reasonable default font list is always 656smaller, but not (in general) larger. A (hopefully) reasonable default
495appended to it. option B<-fn>. 657font list is always appended to it; option B<-fn>.
496 658
497=item B<realBold:> I<boolean> 659Each font can either be a standard X11 core font (XLFD) name, with
660optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
498 661
499B<True>: Enable "real bold" support. When this option is on, bold text 662In addition, each font can be prefixed with additional hints and
500will be displayed using the first available bold font in the font list. 663specifications enclosed in square brackets (C<[]>). The only available
501Bold fonts should thus be specified in the font list after their 664hint currently is C<codeset=codeset-name>, and this is only used for Xft
502corresponding regular fonts. If no bold font can be found, a regular 665fonts.
503font will be used. option B<-rb>. B<False>: Display bold text in a 666
504regular font, using the color specified with B<colorBD>; option B<+rb>. 667For example, this font resource
668
669 URxvt.font: 9x15bold,\
670 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
671 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
672 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
673 xft:Code2000:antialias=false
674
675specifies five fonts to be used. The first one is C<9x15bold> (actually
676the iso8859-1 version of the second font), which is the base font (because
677it is named first) and thus defines the character cell grid to be 9 pixels
678wide and 15 pixels high.
679
680The second font is just used to add additional unicode characters not in
681the base font, likewise the third, which is unfortunately non-bold, but
682the bold version of the font does contain less characters, so this is a
683useful supplement.
684
685The third font is an Xft font with aliasing turned off, and the characters
686are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
687contains other characters, but we are not interested in them.
688
689The last font is a useful catch-all font that supplies most of the
690remaining unicode characters.
691
692=item B<boldFont:> I<fontlist>
693
694=item B<italicFont:> I<fontlist>
695
696=item B<boldItalicFont:> I<fontlist>
697
698The font list to use for displaying B<bold>, I<italic> or B<< I<bold
699italic> >> characters, respectively.
700
701If specified and non-empty, then the syntax is the same as for the
702B<font>-resource, and the given font list will be used as is, which makes
703it possible to substitute completely different font styles for bold and
704italic.
705
706If unset (the default), a suitable font list will be synthesized by
707"morphing" the normal text font list into the desired shape. If that is
708not possible, replacement fonts of the desired shape will be tried.
709
710If set, but empty, then this specific style is disabled and the normal
711text font will being used for the given style.
712
713=item B<intensityStyles:> I<boolean>
714
715When font styles are not enabled, or this option is enabled (B<True>,
716option B<-is>, the default), bold and italic font styles imply high
717intensity foreground/backround colours. Disabling this option (B<False>,
718option B<+is>) disables this behaviour, the high intensity colours are not
719reachable.
505 720
506=item B<selectstyle:> I<mode> 721=item B<selectstyle:> I<mode>
507 722
508Set mouse selection style to B<old> which is 2.20, B<oldword> which is 723Set mouse selection style to B<old> which is 2.20, B<oldword> which is
509xterm style with 2.20 old word selection, or anything else which gives 724xterm style with 2.20 old word selection, or anything else which gives
510xterm style selection. 725xterm style selection.
511 726
512=item B<scrollstyle:> I<mode> 727=item B<scrollstyle:> I<mode>
513 728
514Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 729Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
515the author's favourite.. 730the author's favourite.
516 731
517=item B<title:> I<string> 732=item B<title:> I<string>
518 733
519Set window title string, the default title is the command-line 734Set window title string, the default title is the command-line
520specified after the B<-e> option, if any, otherwise the application 735specified after the B<-e> option, if any, otherwise the application
552 767
553Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 768Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
554B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or 769B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
555B<Shift-Print> to include the scrollback as well. 770B<Shift-Print> to include the scrollback as well.
556 771
772The string will be interpreted as if typed into the shell as-is.
773
774Example:
775
776 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
777
778This creates a new file in your home directory with the screen contents
779everytime you hit C<Print>.
780
557=item B<scrollBar:> I<boolean> 781=item B<scrollBar:> I<boolean>
558 782
559B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 783B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
560disable the scrollbar; option B<+sb>. 784disable the scrollbar; option B<+sb>.
561 785
580B<False>: do not scroll to bottom when tty receives output; option 804B<False>: do not scroll to bottom when tty receives output; option
581B<+si>. 805B<+si>.
582 806
583=item B<scrollWithBuffer:> I<boolean> 807=item B<scrollWithBuffer:> I<boolean>
584 808
585B<True>: scroll with scrollback buffer when tty recieves new lines (and 809B<True>: scroll with scrollback buffer when tty receives new lines (and
586B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 810B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
587with scrollback buffer when tty recieves new lines; option B<-sw>. 811with scrollback buffer when tty recieves new lines; option B<+sw>.
588 812
589=item B<scrollTtyKeypress:> I<boolean> 813=item B<scrollTtyKeypress:> I<boolean>
590 814
591B<True>: scroll to bottom when a non-special key is pressed. Special keys 815B<True>: scroll to bottom when a non-special key is pressed. Special keys
592are those which are intercepted by rxvt-unicode for special handling and 816are those which are intercepted by rxvt-unicode for special handling and
611=item B<borderLess:> I<boolean> 835=item B<borderLess:> I<boolean>
612 836
613Set MWM hints to request a borderless window, i.e. if honoured by the 837Set MWM hints to request a borderless window, i.e. if honoured by the
614WM, the rxvt-unicode window will not have window decorations; option B<-bl>. 838WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
615 839
840=item B<skipBuiltinGlyphs:> I<boolean>
841
842Compile I<frills>: Disable the usage of the built-in block graphics/line
843drawing characters and just rely on what the specified fonts provide. Use
844this if you have a good font and want to use its block graphic glyphs;
845option B<-sbg>.
846
616=item B<termName:> I<termname> 847=item B<termName:> I<termname>
617 848
618Specifies the terminal type name to be set in the B<TERM> environment 849Specifies the terminal type name to be set in the B<TERM> environment
619variable; option B<-tn>. 850variable; option B<-tn>.
620 851
630 861
631=item B<mouseWheelScrollPage:> I<boolean> 862=item B<mouseWheelScrollPage:> I<boolean>
632 863
633B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel 864B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
634scrolls five lines [default]. 865scrolls five lines [default].
866
867=item B<pastableTabs:> I<boolean>
868
869B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
870movement only; option C<-ptab>.
635 871
636=item B<cursorBlink:> I<boolean> 872=item B<cursorBlink:> I<boolean>
637 873
638B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 874B<True>: blink the cursor. B<False>: do not blink the cursor [default];
639option B<-bc>. 875option B<-bc>.
652 888
653Mouse pointer background colour. 889Mouse pointer background colour.
654 890
655=item B<pointerBlankDelay:> I<number> 891=item B<pointerBlankDelay:> I<number>
656 892
657Specifies number of seconds before blanking the pointer [default 2]. 893Specifies number of seconds before blanking the pointer [default 2]. Use a
894large number (e.g. C<987654321>) to effectively disable the timeout.
658 895
659=item B<backspacekey:> I<string> 896=item B<backspacekey:> I<string>
660 897
661The string to send when the backspace key is pressed. If set to B<DEC> 898The string to send when the backspace key is pressed. If set to B<DEC>
662or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 899or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
669pressed. If unset it will send the sequence traditionally associated 906pressed. If unset it will send the sequence traditionally associated
670with the B<Execute> key. 907with the B<Execute> key.
671 908
672=item B<cutchars:> I<string> 909=item B<cutchars:> I<string>
673 910
674The characters used as delimiters for double-click word selection. The 911The characters used as delimiters for double-click word selection
675built-in default: 912(whitespace delimiting is added automatically if resource is given).
913
914When the selection extension is in use (the default if compiled in, see
915the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters
916will be created (if the resource exists, otherwise, no regex will be
917created). In this mode, characters outside ISO-8859-1 can be used.
918
919When the selection extension is not used, only ISO-8859-1 characters can
920be used. If not specified, the built-in default is used:
676 921
677B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 922B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
678 923
679=item B<preeditType:> I<style> 924=item B<preeditType:> I<style>
680 925
684 929
685I<name> of inputMethod to use; option B<-im>. 930I<name> of inputMethod to use; option B<-im>.
686 931
687=item B<imLocale:> I<name> 932=item B<imLocale:> I<name>
688 933
689The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 934The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
690de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 935C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
691extension to be able to input japanese characters while staying in 936input extension to be able to input japanese characters while staying in
692another locale. option B<-imlocale>. 937another locale; option B<-imlocale>.
693 938
694=item B<insecure> 939=item B<imFont:> I<fontset>
940
941Specify the font-set used for XIM styles C<OverTheSpot> or
942C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
943by commas), i.e. it's not in the same format as the other font lists used
944in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
945found, preferably one or two pixels differing in size to the base font.
946option B<-imfont>.
947
948=item B<tripleclickwords:> I<boolean>
949
950Change the meaning of triple-click selection with the left mouse
951button. Instead of selecting a full line it will extend the selection to
952the end of the logical line only; option B<-tcw>.
953
954=item B<insecure:> I<boolean>
695 955
696Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 956Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
697echo arbitrary strings like the icon name or the locale. This could be 957echo arbitrary strings like the icon name or the locale. This could be
698abused if somebody gets 8-bit-clean access to your display, wether 958abused if somebody gets 8-bit-clean access to your display, whether
699throuh a mail client displaying mail bodies unfiltered or though 959through a mail client displaying mail bodies unfiltered or through
700write(1). Therefore, these sequences are disabled by default. (Note 960write(1) or any other means. Therefore, these sequences are disabled by
701that other terminals, including xterm, have these sequences 961default. (Note that many other terminals, including xterm, have these
702enabled by default). You can enable them by setting this boolean 962sequences enabled by default, which doesn't make it safer, though).
703resource or specifying B<-insecure> as an option. At the moment, this 963
704enabled display-answer, locale, findfont, icon label and window title 964You can enable them by setting this boolean resource or specifying
705requests as well as dynamic menubar dispatch. 965B<-insecure> as an option. At the moment, this enables display-answer,
966locale, findfont, icon label and window title requests.
706 967
707=item B<modifier:> I<modifier> 968=item B<modifier:> I<modifier>
708 969
709Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 970Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
710B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 971B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
714 975
715Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 976Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
716character is passed through. It may contain escape values as described 977character is passed through. It may contain escape values as described
717in the entry on B<keysym> following. 978in the entry on B<keysym> following.
718 979
719=item B<secondaryScreen:> I<bool> 980=item B<secondaryScreen:> I<boolean>
720 981
721Turn on/off secondary screen (default enabled). 982Turn on/off secondary screen (default enabled).
722 983
723=item B<secondaryScroll:> I<bool> 984=item B<secondaryScroll:> I<boolean>
724 985
725Turn on/off secondary screen scroll (default enabled). If the this 986Turn on/off secondary screen scroll (default enabled). If the this
726option is enabled, scrolls on the secondary screen will change the 987option is enabled, scrolls on the secondary screen will change the
727scrollback buffer and switching to/from the secondary screen will 988scrollback buffer and switching to/from the secondary screen will
728instead scroll the screen up. 989instead scroll the screen up.
729 990
991=item B<hold>: I<boolean>
992
993Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
994will not immediately destroy its window when the program executed within
995it exits. Instead, it will wait till it is being killed or closed by the
996user.
997
730=item B<keysym.>I<sym>: I<string> 998=item B<keysym.>I<sym>: I<string>
731 999
732Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may 1000Compile I<frills>: Associate I<string> with keysym I<sym>. The
733contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: 1001intervening resource name B<keysym.> cannot be omitted.
734newline, \r: return, \t: 1002
1003The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
1004any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
1005B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
1006and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
1007B<2>, B<3>, B<4>, B<5>.
1008
1009The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1010whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1011keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1012current application keymap mode state.
1013
1014The spellings of I<key> can be obtained by using B<xev>(1) command or
1015searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1016omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1017keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1018performed in an exact manner; however, the closest match is assured.
1019
1020I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
1021C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
735tab, \000: octal number) or control characters (^?: delete, ^@: null, 1022C<\000>: octal number) or verbatim control characters (C<^?>: delete,
736^A ...) and may enclosed with double quotes so that it can start or end 1023C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
737with whitespace. The intervening resource name B<keysym.> cannot be 1024can start or end with whitespace.
738omitted. This resource is only available when compiled with 1025
739KEYSYM_RESOURCE. 1026Please note that you need to double the C<\> in resource files, as
1027Xlib itself does it's own de-escaping (you can use C<\033> instead of
1028C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1029processing).
1030
1031You can define a range of keysyms in one shot by providing a I<string>
1032with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
1033should be a character not used by the strings.
1034
1035Its usage can be demonstrated by an example:
1036
1037 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1038
1039The above line is equivalent to the following three lines:
1040
1041 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
1042 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
1043 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
1044
1045If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1046is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1047example the following means "change the current locale to C<zh_CN.GBK>
1048when Control-Meta-c is being pressed":
1049
1050 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1051
1052If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1053is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1054manpage. For example, the F<selection> extension (activated via
1055C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1056
1057 URxvt.keysym.M-C-c: perl:selection:rot13
1058
1059Due the the large number of modifier combinations, a defined key mapping
1060will match if at I<at least> the specified identifiers are being set, and
1061no other key mappings with those and more bits are being defined. That
1062means that defining a key map for C<a> will automatically provide
1063definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1064mappings themselves.
1065
1066Unfortunately, this will override built-in key mappings. For example
1067if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
1068C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
1069user-defined keymap using the C<builtin:> replacement:
1070
1071 URxvt.keysym.Insert: <my insert key sequence>
1072 URxvt.keysym.S-Insert: builtin:
1073
1074The first line defines a mapping for C<Insert> and I<any> combination
1075of modifiers. The second line re-establishes the default mapping for
1076C<Shift-Insert>.
1077
1078The following example will map Control-Meta-1 and Control-Meta-2 to
1079the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1080font-switching at runtime:
1081
1082 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1083 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1084
1085Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1086info):
1087
1088 URxvt.keysym.M-C-3: command:\033[8;25;80t
1089 URxvt.keysym.M-C-4: command:\033[8;48;110t
1090
1091=item B<perl-ext-common>: I<string>
1092
1093=item B<perl-ext>: I<string>
1094
1095Comma-separated list(s) of perl extension scripts (default: C<default>) to
1096use in this terminal instance; option B<-pe>.
1097
1098Extension names can be prefixed with a C<-> sign to prohibit using
1099them. This can be useful to selectively disable some extensions loaded
1100by default, or specified via the C<perl-ext-common> resource. For
1101example, C<default,-selection> will use all the default extension except
1102C<selection>.
1103
1104Extension names can also be followed by an argument in angle brackets
1105(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1106searchable scorllback to Alt/Meta-s). Mentioning the same extension
1107multiple times with different arguments will pass multiple arguments to
1108the extension.
1109
1110Each extension is looked up in the library directories, loaded if
1111necessary, and bound to the current terminal instance.
1112
1113If both of these resources are the empty string, then the perl
1114interpreter will not be initialized. The idea behind two options is that
1115B<perl-ext-common> will be used for extensions that should be available to
1116all instances, while B<perl-ext> is used for specific instances.
1117
1118=item B<perl-eval>: I<string>
1119
1120Perl code to be evaluated when all extensions have been registered. See
1121the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1122will be ignored when running setuid/setgid.
1123
1124=item B<perl-lib>: I<path>
1125
1126Colon-separated list of additional directories that hold extension
1127scripts. When looking for extensions specified by the C<perl> resource,
1128@@RXVT_NAME@@ will first look in these directories and then in
1129F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1130will be ignored when running setuid/setgid.
1131
1132See the @@RXVT_NAME@@perl(3) manpage.
1133
1134=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1135
1136Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1137details.
1138
1139=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1140
1141Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1142for details.
1143
1144=item B<searchable-scrollback:> I<keysym>
1145
1146Sets the hotkey that starts the incremental scrollback buffer search
1147(default: C<M-s>).
1148
1149=item B<urlLauncher>: I<string>
1150
1151Specifies the program to be started with a URL argument. Used by the
1152C<selection-popup> and C<mark-urls> perl extensions.
1153
1154=item B<transient-for>: I<windowid>
1155
1156Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1157
1158=item B<override-redirect>: I<boolean>
1159
1160Compile I<frills>: Sets override-redirect for the terminal window, making
1161it almost invisible to window managers; option B<-override-redirect>.
740 1162
741=back 1163=back
742 1164
743=head1 THE SCROLLBAR 1165=head1 THE SCROLLBAR
744 1166
758the normal text selection/insertion, hold either the Shift or the Meta 1180the normal text selection/insertion, hold either the Shift or the Meta
759(Alt) key while performing the desired mouse action. 1181(Alt) key while performing the desired mouse action.
760 1182
761If mouse reporting mode is active, the normal scrollbar actions are 1183If mouse reporting mode is active, the normal scrollbar actions are
762disabled -- on the assumption that we are using a fullscreen 1184disabled -- on the assumption that we are using a fullscreen
763application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 1185application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
764(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 1186(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
765up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down), 1187up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
766respectively. 1188respectively.
767 1189
768=head1 TEXT SELECTION AND INSERTION 1190=head1 TEXT SELECTION AND INSERTION
769 1191
770The behaviour of text selection and insertion mechanism is similar to 1192The behaviour of text selection and insertion mechanism is similar to
772 1194
773=over 4 1195=over 4
774 1196
775=item B<Selection>: 1197=item B<Selection>:
776 1198
777Left click at the beginning of the region, drag to the end of the 1199Left click at the beginning of the region, drag to the end of the region
778region and release; Right click to extend the marked region; Left 1200and release; Right click to extend the marked region; Left double-click
779double-click to select a word; Left triple-click to select the entire 1201to select a word; Left triple-click to select the entire logical line
780line. 1202(which can span multiple screen lines), unless modified by resource
1203B<tripleclickwords>.
1204
1205Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1206(Compile: I<frills>) will create a rectangular selection instead of a
1207normal one. In this mode, every selected row becomes its own line in the
1208selection, and trailing whitespace is visually underlined and removed from
1209the selection.
781 1210
782=item B<Insertion>: 1211=item B<Insertion>:
783 1212
784Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1213Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
785an B<@@RXVT_NAME@@> window causes the current text selection to be 1214window causes the value of the PRIMARY selection (or CLIPBOARD with the
786inserted as if it had been typed on the keyboard. 1215Meta modifier) to be inserted as if it had been typed on the keyboard.
1216
1217Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1218inserted too.
787 1219
788=back 1220=back
789 1221
790=head1 CHANGING FONTS 1222=head1 CHANGING FONTS
791 1223
792Changing fonts (or font sizes, respectively) via the keypad is not yet 1224Changing fonts (or font sizes, respectively) via the keypad is not yet
793supported in rxvt-unicode. Bug me if you need this. 1225supported in rxvt-unicode. Bug me if you need this.
794 1226
795You can, however, switch fonts at runtime using escape sequences (and 1227You can, however, switch fonts at runtime using escape sequences, e.g.:
796therefore using the menubar), e.g.:
797 1228
798 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1229 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1230
1231You can use keyboard shortcuts, too:
1232
1233 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1234 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
799 1235
800rxvt-unicode will automatically re-apply these fonts to the output so far. 1236rxvt-unicode will automatically re-apply these fonts to the output so far.
801 1237
802=head1 ISO 14755 SUPPORT 1238=head1 ISO 14755 SUPPORT
803 1239
807C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1243C<--enable-frills>, the rest is available when rxvt-unicode was compiled
808with C<--enable-iso14755>. 1244with C<--enable-iso14755>.
809 1245
810=over 4 1246=over 4
811 1247
812=item 5.1: Basic method 1248=item * 5.1: Basic method
813 1249
814This allows you to enter unicode characters using their hexcode. 1250This allows you to enter unicode characters using their hexcode.
815 1251
816Start by pressing and holding both C<Control> and C<Shift>, then enter 1252Start by pressing and holding both C<Control> and C<Shift>, then enter
817hex-digits (between one and six). Releasing C<Control> and C<Shift> will 1253hex-digits (between one and six). Releasing C<Control> and C<Shift> will
824address, which you cannot type. Fortunately, the card has the e-mail 1260address, which you cannot type. Fortunately, the card has the e-mail
825address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily 1261address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
826by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>, 1262by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
827followed by releasing the modifier keys. 1263followed by releasing the modifier keys.
828 1264
829=item 5.2: Keyboard symbols entry method 1265=item * 5.2: Keyboard symbols entry method
830 1266
831This mode lets you input characters representing the keycap symbols of 1267This mode lets you input characters representing the keycap symbols of
832your keyboard, if representable in the current locale encoding. 1268your keyboard, if representable in the current locale encoding.
833 1269
834Start by pressing C<Control> and C<Shift> together, then releasing 1270Start by pressing C<Control> and C<Shift> together, then releasing
835them. The next special key (cursor keys, home etc.) you enter will not 1271them. The next special key (cursor keys, home etc.) you enter will not
836invoke it's usual function but instead will insert the corresponding 1272invoke it's usual function but instead will insert the corresponding
837keycap symbol. The symbol will only be entered when the key has been 1273keycap symbol. The symbol will only be entered when the key has been
838released, otherwise pressing e.g. C<Shift> would enter the symbol for 1274released, otherwise pressing e.g. C<Shift> would enter the symbol for
839C<ISO Level 2 Switch>, although your intention might have beenm to enter a 1275C<ISO Level 2 Switch>, although your intention might have been to enter a
840reverse tab (Shift-Tab). 1276reverse tab (Shift-Tab).
841 1277
842=item 5.3: Screen-selection entry method 1278=item * 5.3: Screen-selection entry method
843 1279
844While this is implemented already (it's basically the selection 1280While this is implemented already (it's basically the selection
845mechanism), it could be extended by displaying a unicode character map. 1281mechanism), it could be extended by displaying a unicode character map.
846 1282
847=item 5.4: Feedback method for identifying displayed characters for later input 1283=item * 5.4: Feedback method for identifying displayed characters for later input
848 1284
849This method lets you display the unicode character code associated with 1285This method lets you display the unicode character code associated with
850characters already displayed. 1286characters already displayed.
851 1287
852You enter this mode by holding down C<Control> and C<Shift> together, then 1288You enter this mode by holding down C<Control> and C<Shift> together, then
853pressing and holding the left mouse button and moving around. The unicode 1289pressing and holding the left mouse button and moving around. The unicode
854hex code(s) (it might be a combining character) of the character under the 1290hex code(s) (it might be a combining character) of the character under the
855pointer is displayed until you release C<Control> and C<Shift>. 1291pointer is displayed until you release C<Control> and C<Shift>.
856 1292
1293In addition to the hex codes it will display the font used to draw this
1294character - due to implementation reasons, characters combined with
1295combining characters, line drawing characters and unknown characters will
1296always be drawn using the built-in support font.
1297
857=back 1298=back
858 1299
859With respect to conformance, rxvt-unicode is supposed to be compliant to 1300With respect to conformance, rxvt-unicode is supposed to be compliant to
860both scenario A and B of ISO 14755, including part 5.2. 1301both scenario A and B of ISO 14755, including part 5.2.
861 1302
862=head1 LOGIN STAMP 1303=head1 LOGIN STAMP
863 1304
864B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so 1305B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
865that it can be seen via the I<who(1)> command, and can accept messages. 1306it can be seen via the I<who(1)> command, and can accept messages. To
866To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on 1307allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
867some systems. 1308on some systems or setgid to root or to some other group on others.
868 1309
869=head1 COLORS AND GRAPHICS 1310=head1 COLORS AND GRAPHICS
870 1311
871In addition to the default foreground and background colours, 1312In addition to the default foreground and background colours,
872B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1313B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
913would yield White on Black, while on I<xterm>(1) it would yield Black 1354would yield White on Black, while on I<xterm>(1) it would yield Black
914on White. 1355on White.
915 1356
916=back 1357=back
917 1358
918=head1 FREQUENTLY ASKED QUESTIONS (FAQ) 1359=head1 ENVIRONMENT
1360
1361B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
919 1362
920=over 4 1363=over 4
921 1364
922=item How do I know which rxvt-unicode version I'm using? 1365=item B<TERM>
923 1366
924The version number is displayed with the usage (-h). For rxvt-unicode 1367Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
925version 2.14 and later, the escape sequence C<ESC[8n> sets the window 1368resources or on the commandline.
926title to the version number.
927 1369
928=item Rxvt-unicode does not seem to understand the selected encoding? 1370=item B<COLORTERM>
929 1371
930=item Unicode does not seem to work? 1372Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
1373compiled with XPM support, and optionally with the added extension
1374C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
931 1375
932If you encounter strange problems like typing an accented character but 1376=item B<COLORFGBG>
933getting two unrelated other characters or similar, or if program output is
934subtly garbled, then you should check your locale settings.
935 1377
936Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the 1378Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
937programs. Often rxvt-unicode is started in the C<C> locale, while the 1379the colour code used as default foreground/text colour (or the string
938login script running within the rxvt-unicode window changes the locale to 1380C<default> to indicate that the default-colour escape sequence is to be
939sth. else, e.h. C<en_GB.UTF-8>. Needless to say, this is not going to work. 1381used), C<bg> is the colour code used as default background colour (or the
1382string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1383was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
1384(and do) use this information to optimize screen output.
940 1385
941The best thing is to fix your startup environment, as you will likely run 1386=item B<WINDOWID>
942into other problems. If nothing works you can try this in your .profile.
943 1387
944 printf '\e]701;%s\007' "$LC_CTYPE" 1388Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1389window, which usually has subwindows for the scrollbar, the terminal
1390window and so on).
945 1391
946If this doesn't work, then maybe you use a C<LC_CTYPE> specification not 1392=item B<TERMINFO>
947supported on your systems. Some systems have a C<locale> comamnd which
948displays this. If it displays sth. like:
949 1393
950 locale: Cannot set LC_CTYPE to default locale: ... 1394Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1395C<--with-terminfo=PATH>.
951 1396
952Then the locale you specified is not supported on your system. 1397=item B<DISPLAY>
953 1398
954If nothing works and you are sure that everything is set correctly then 1399Used by @@RXVT_NAME@@ to connect to the display and set to the correct
955you will need to remember a little known fact: Some programs just don't 1400display in it's child processes.
956support locales :(
957 1401
958=item Why do the characters look ugly? 1402=item B<SHELL>
959 1403
960=item How does rxvt-unicode choose fonts? 1404The shell to be used for command execution, defaults to C</bin/sh>.
961 1405
962Most fonts do not contain the full range of Unicode, which is 1406=item B<RXVT_SOCKET>
963fine. Chances are that the font you (or the admin/package maintainer of
964your system/os) have specified does not cover all the characters you want
965to display.
966 1407
967B<rxvt-unicode> makes a best-effort try at finding a replacement 1408The unix domain socket path used by @@RXVT_NAME@@c(1) and
968font. Often the result is fine, but sometimes the chosen font looks 1409@@RXVT_NAME@@d(1).
969bad. In that case, select a font of your taste and add it to the font
970list, e.g.:
971 1410
972 @@RXVT_NAME@@ -fn basefont,font2,font3... 1411Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
973 1412
974When rxvt-unicode sees a character, it will first look at the base 1413=item B<HOME>
975font. If the base font does not contain the character, it will go to the
976next font, and so on.
977 1414
978The only limitation is that all the fonts must not be larger than the base 1415Used to locate the default directory for the unix domain socket for
979font, as the base font defines the principial cell size, which must be the 1416daemon communications and to locate various resource files (such as
980same due to the way terminals work. 1417C<.Xdefaults>)
981 1418
982=item Why do some chinese characters look so different than others? 1419=item B<XAPPLRESDIR>
983 1420
984This is because there is a difference between script and language -- 1421Directory where various X resource files are being located.
985rxvt-unicode does not know which language the text that is output
986is, as it only knows the unicode character codes. If rxvt-unicode
987first sees a japanese character, it might choose a japanese font for
988it. Subseqzuent japanese characters will take that font. Now, many chinese
989characters aren't represented in japanese fonts, so when the first
990non-japanese character comes up, rxvt-unicode will look for a chinese font
991-- unfortunately at this point, it will still use the japanese font for
992japanese characters that are also chinese.
993 1422
994The workaround is easy: just tag a chinese font at the end of your font 1423=item B<XENVIRONMENT>
995list (see the previous question). The key is to view the font list as
996a preference list: If you expect more japanese, list a japanese font
997first. If you expect more chinese, put a chinese font first.
998 1424
999In the future it might be possible to switch preferences at runtime (the 1425If set and accessible, gives the name of a X resource file to be loaded by
1000internal data structure has no problem with using different fonts for
1001the same character at the same time, but no interface for this has been
1002designed yet).
1003
1004=item How does rxvt-unicode determine the encoding to use?
1005
1006=item Is there an option to switch encodings?
1007
1008Unlike some other terminals, rxvt-unicode has no encoding switch, and no
1009specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
1010UTF-8 or any other encodings with respect to terminal I/O.
1011
1012The reasons is that there exists a perfectly fine mechanism for selecting
1013the encoding, doing I/O and (most important) communicating this to all
1014applications so everybody agrees on character properties such as width and
1015code number. This mechanism is the I<locale>.
1016
1017Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
1018programs doing the same (that is, most) will automatically agree in the
1019interpretation of characters.
1020
1021Unfortunately, there is no system-independent way to select locales, nor
1022is there a standard on how locale specifiers will look like.
1023
1024On most systems, the content of the C<LC_CTYPE> environment variable
1025contains an arbitrary string which corresponds to an already-installed
1026locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
1027C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
1028(i.e. C<de> or C<german>) are also common.
1029
1030Rxvt-unicode ignores all other locale categories, and except for
1031the encoding, ignores country or language-specific settings,
1032i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the same for rxvt-unicode.
1033
1034If you want to use a specific encoding you have to make sure you start
1035rxvt-unicode with the correct C<LC_CTYPE> category.
1036
1037=item Can I switch locales at runtime?
1038
1039Yes, using an escape sequence. Try sth. like this, which sets
1040rxvt-unicode's idea of C<LC_CTYPE>.
1041
1042 printf '\e]701;%s\007' ja_JP.SJIS
1043
1044See also the previous question.
1045
1046Sometimes this capability is rather handy when you want to work in one
1047locale (e.g. C<de_DE.UTF-8>) but some programs don't support UTF-8. For
1048example, I use this script to start C<xjdic>, which first switches to a
1049locale supported by xjdic and back later:
1050
1051 printf '\e]701;%s\007' ja_JP.SJIS
1052 xjdic -js
1053 printf '\e]701;%s\007' de_DE.UTF-8
1054
1055=item Can I switch the fonts at runtime?
1056
1057Yes, using an escape sequence. Try sth. like this, which has the same
1058effect as using the C<-fn> switch, and takes effect immediately:
1059
1060 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
1061
1062This is useful if you e.g. work primarily with japanese (and prefer a
1063japanese font), but you have to switch to chinese temporarily, where
1064japanese fonts would only be in your way.
1065
1066You can think of this as a kind of manual ISO-2022 switching.
1067
1068=item Mouse cut/paste suddenly no longer works.
1069
1070Make sure that mouse reporting is actually turned off since killing
1071some editors prematurely may leave the mouse in mouse report mode. I've
1072heard that tcsh may use mouse reporting unless it otherwise specified. A
1073quick check is to see if cut/paste works when the Alt or Shift keys are
1074depressed. See @@RXVT_NAME@@(7)
1075
1076=item What's with this bold/blink stuff?
1077
1078If no bold colour is set via C<colorBD:>, bold will invert text using the
1079standard foreground colour.
1080
1081For the standard background colour, blinking will actually make the
1082text blink when compiled with C<--enable-blinking>. with standard
1083colours. Without C<--enable-blinking>, the blink attribute will be
1084ignored.
1085
1086On ANSI colours, bold/blink attributes are used to set high-intensity
1087foreground/background colors.
1088
1089color0-7 are the low-intensity colors.
1090
1091color8-15 are the corresponding high-intensity colors.
1092
1093=item I don't like the screen colors. How do I change them?
1094
1095You can change the screen colors at run-time using F<~/.Xdefaults>
1096resources (or as long-options).
1097
1098Here are values that are supposed to resemble a VGA screen,
1099including the murky brown that passes for low-intensity yellow:
1100
1101 Rxvt*color0: #000000
1102 Rxvt*color1: #A80000
1103 Rxvt*color2: #00A800
1104 Rxvt*color3: #A8A800
1105 Rxvt*color4: #0000A8
1106 Rxvt*color5: #A800A8
1107 Rxvt*color6: #00A8A8
1108 Rxvt*color7: #A8A8A8
1109
1110 Rxvt*color8: #000054
1111 Rxvt*color9: #FF0054
1112 Rxvt*color10: #00FF54
1113 Rxvt*color11: #FFFF54
1114 Rxvt*color12: #0000FF
1115 Rxvt*color13: #FF00FF
1116 Rxvt*color14: #00FFFF
1117 Rxvt*color15: #FFFFFF
1118
1119=item What's with the strange Backspace/Delete key behaviour?
1120
1121Assuming that the physical Backspace key corresponds to the
1122BackSpace keysym (not likely for Linux ... see the following
1123question) there are two standard values that can be used for
1124Backspace: C<^H> and C<^?>.
1125
1126Historically, either value is correct, but rxvt-unicode adopts the debian
1127policy of using C<^?> when unsure, because it's the one only only correct
1128choice :).
1129
1130Rxvt-unicode tries to inherit the current stty settings and uses the value
1131of `erase' to guess the value for backspace. If rxvt-unicode wasn't
1132started from a terminal (say, from a menu or by remote shell), then the
1133system value of `erase', which corresponds to CERASE in <termios.h>, will
1134be used (which may not be the same as your stty setting).
1135
1136For starting a new rxvt-unicode:
1137
1138 # use Backspace = ^H
1139 $ stty erase ^H
1140 $ @@RXVT_NAME@@ 1426@@RXVT_NAME@@.
1141
1142 # use Backspace = ^?
1143 $ stty erase ^?
1144 $ @@RXVT_NAME@@
1145
1146Toggle with "ESC[36h" / "ESC[36l" as documented in @@RXVT_NAME@@(7).
1147
1148For an existing rxvt-unicode:
1149
1150 # use Backspace = ^H
1151 $ stty erase ^H
1152 $ echo -n "^[[36h"
1153
1154 # use Backspace = ^?
1155 $ stty erase ^?
1156 $ echo -n "^[[36l"
1157
1158This helps satisfy some of the Backspace discrepancies that occur, but
1159if you use Backspace = C<^H>, make sure that the termcap/terminfo value
1160properly reflects that.
1161
1162The Delete key is a another casualty of the ill-defined Backspace problem.
1163To avoid confusion between the Backspace and Delete keys, the Delete
1164key has been assigned an escape sequence to match the vt100 for Execute
1165(ESC[3~) and is in the supplied termcap/terminfo.
1166
1167Some other Backspace problems:
1168
1169some editors use termcap/terminfo,
1170some editors (vim I'm told) expect Backspace = ^H,
1171GNU Emacs (and Emacs-like editors) use ^H for help.
1172
1173Perhaps someday this will all be resolved in a consistent manner.
1174
1175=item I don't like the key-bindings. How do I change them?
1176
1177There are some compile-time selections available via configure. Unless
1178you have run "configure" with the C<--disable-resources> option you can
1179use the `keysym' resource to alter the keystrings associated with keysym
11800xFF00 - 0xFFFF (function, cursor keys, etc).
1181
1182Here's an example for a tn3270 session started using `@@RXVT_NAME@@ -name tn3270'
1183
1184 !# ----- special uses ------:
1185 ! tn3270 login, remap function and arrow keys.
1186 tn3270*font: *clean-bold-*-*--15-*
1187
1188 ! keysym - used by rxvt only
1189 ! Delete - ^D
1190 tn3270*keysym.0xFFFF: \004
1191
1192 ! Home - ^A
1193 tn3270*keysym.0xFF50: \001
1194 ! Left - ^B
1195 tn3270*keysym.0xFF51: \002
1196 ! Up - ^P
1197 tn3270*keysym.0xFF52: \020
1198 ! Right - ^F
1199 tn3270*keysym.0xFF53: \006
1200 ! Down - ^N
1201 tn3270*keysym.0xFF54: \016
1202 ! End - ^E
1203 tn3270*keysym.0xFF57: \005
1204
1205 ! F1 - F12
1206 tn3270*keysym.0xFFBE: \e1
1207 tn3270*keysym.0xFFBF: \e2
1208 tn3270*keysym.0xFFC0: \e3
1209 tn3270*keysym.0xFFC1: \e4
1210 tn3270*keysym.0xFFC2: \e5
1211 tn3270*keysym.0xFFC3: \e6
1212 tn3270*keysym.0xFFC4: \e7
1213 tn3270*keysym.0xFFC5: \e8
1214 tn3270*keysym.0xFFC6: \e9
1215 tn3270*keysym.0xFFC7: \e0
1216 tn3270*keysym.0xFFC8: \e-
1217 tn3270*keysym.0xFFC9: \e=
1218
1219 ! map Prior/Next to F7/F8
1220 tn3270*keysym.0xFF55: \e7
1221 tn3270*keysym.0xFF56: \e8
1222
1223=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
1224How do I make use of them? For example, the Sun Keyboard type 4
1225has the following mappings that rxvt-unicode doesn't recognize.
1226
1227 KP_Insert == Insert
1228 F22 == Print
1229 F27 == Home
1230 F29 == Prior
1231 F33 == End
1232 F35 == Next
1233
1234Rather than have rxvt-unicode try to accomodate all the various possible keyboard
1235mappings, it is better to use `xmodmap' to remap the keys as required for
1236your particular machine.
1237
1238=item How do I distinguish if I'm running rxvt-unicode or a regular xterm?
1239I need this to decide about setting colors etc.
1240
1241rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
1242check and see if that is set. Note that several programs, JED, slrn,
1243Midnight Commander automatically check this variable to decide whether or
1244not to use color.
1245
1246=item How do I set the correct, full IP address for the DISPLAY variable?
1247
1248If you've compiled rxvt-unicode with DISPLAY_IS_IP and ahve enabled
1249insecure mode then it is possible to use the following shell script
1250snippets to correctly set the display. If your version of rxvt-unicode
1251wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
1252the COLORTERM variable can be used to distinguish rxvt-unicode from a
1253regular xterm.
1254
1255Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
1256snippets:
1257
1258 # Bourne/Korn/POSIX family of shells:
1259 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
1260 if [ ${TERM:-foo} = xterm ]; then
1261 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
1262 echo -n '^[Z'
1263 read term_id
1264 stty icanon echo
1265 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
1266 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
1267 read DISPLAY # set it in our local shell
1268 fi
1269 fi
1270
1271=item How do I compile the manual pages for myself?
1272
1273You need to have a recent version of perl installed as F</usr/bin/perl>,
1274one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
1275the doc subdirectory and enter C<make alldoc>.
1276 1427
1277=back 1428=back
1278 1429
1279=head1 ENVIRONMENT
1280
1281B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>
1282and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X
1283window id number of the B<@@RXVT_NAME@@> window and it also uses and
1284sets the environment variable B<DISPLAY> to specify which display
1285terminal to use. B<@@RXVT_NAME@@> uses the environment variables
1286B<RXVTPATH> and B<PATH> to find XPM files.
1287
1288=head1 FILES 1430=head1 FILES
1289 1431
1290=over 4 1432=over 4
1291 1433
1292=item B</etc/utmp>
1293
1294System file for login records.
1295
1296=item B</usr/lib/X11/rgb.txt> 1434=item B</usr/lib/X11/rgb.txt>
1297 1435
1298Color names. 1436Color names.
1299 1437
1300=back 1438=back
1301 1439
1302=head1 SEE ALSO 1440=head1 SEE ALSO
1303 1441
1304@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1442@@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)
1305
1306=head1 BUGS
1307
1308Check the BUGS file for an up-to-date list.
1309
1310Cursor change support is not yet implemented.
1311
1312Click-and-drag doesn't work with X11 mouse report overriding.
1313 1443
1314=head1 CURRENT PROJECT COORDINATOR 1444=head1 CURRENT PROJECT COORDINATOR
1315 1445
1316=over 4 1446=over 4
1317 1447
1318=item Project Coordinator 1448=item Project Coordinator
1319 1449
1320@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1450Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1321 1451
1322=item Web page maintainter 1452L<http://software.schmorp.de/#rxvt-unicode>
1323
1324@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1325
1326L<@@RXVT_WEBPAGE@@>
1327 1453
1328=back 1454=back
1329 1455
1330=head1 AUTHORS 1456=head1 AUTHORS
1331 1457
1353 1479
1354Project Coordinator (changes.txt 2.21a to 2.4.5) 1480Project Coordinator (changes.txt 2.21a to 2.4.5)
1355 1481
1356=item Geoff Wing L<< <gcw@pobox.com> >> 1482=item Geoff Wing L<< <gcw@pobox.com> >>
1357 1483
1358Rewrote screen display and text selection routines. Project Coordinator 1484Rewrote screen display and text selection routines.
1485
1359(changes.txt 2.4.6 - rxvt-unicode) 1486Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1360 1487
1361=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1488=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1362 1489
1363Forked rxvt-unicode, rewrote most of the display code and internal 1490Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1364character handling to store text in unicode, improve xterm 1491extension, random hacks, numerous bugfixes and extensions.
1365compatibility and apply numerous other bugfixes and extensions.
1366 1492
1367Project Coordinator (Changes 1.0 -) 1493Project Coordinator (Changes 1.0 -)
1368 1494
1495=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1496
1497Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1498
1369=back 1499=back
1370 1500

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines