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.244 by sf-exg, Tue Jun 16 11:58:26 2015 UTC

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 16
17This document is also available on the World-Wide-Web at
18L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
19
20=head1 FREQUENTLY ASKED QUESTIONS
21
22See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
23frequently asked questions and answer to them and some common
24problems. That document is also accessible on the World-Wide-Web at
25L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
26
17=head1 RXVT-UNICODE VS. RXVT 27=head1 RXVT-UNICODE VS. RXVT
18 28
19Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 29Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
20internally. That means it can store and display most scripts in the 30internally. That means it can store and display most scripts in the
21world. Being a terminal emulator, however, some things are very difficult, 31world. Being a terminal emulator, however, some things are very difficult,
22especially cursive scripts such as arabic, vertically written scripts 32especially cursive scripts such as arabic, vertically written scripts
23like mongolian or scripts requiring extremely complex combining rules, 33like mongolian or scripts requiring extremely complex combining rules,
24like tibetan or devenagari. Don't expect pretty output when using these 34like tibetan or devanagari. Don't expect pretty output when using these
25scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 35scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
26fine, though. A somewhat difficult case are left-to-right scripts, such 36fine, though. A somewhat difficult case are right-to-left scripts, such
27as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 37as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
28belong into the application, not the terminal emulator (too many things -- 38belong in the application, not the terminal emulator (too many things --
29such as cursor-movement while editing -- break othwerwise), but that might 39such as cursor-movement while editing -- break otherwise), but that might
30change. 40change.
31 41
32If you are looking for a terminal that supports more exotic scripts, let 42If you are looking for a terminal that supports more exotic scripts, let
33me recommend C<mlterm>, which is a very userfriendly, lean and clean 43me recommend C<mlterm>, which is a very user friendly, lean and clean
34terminal emulator. In fact, the reason rxvt-unicode was born was solely 44terminal emulator. In fact, the reason rxvt-unicode was born was solely
35because the author couldn't get C<mlterm> to use one font for latin1 and 45because the author couldn't get C<mlterm> to use one font for latin1 and
36another for japanese. 46another for japanese.
37 47
38Therefore another design rationale was the use of multiple fonts to 48Therefore another design rationale was the use of multiple fonts to
39display characters: The idea of a single unicode font which many other 49display characters: The idea of a single unicode font which many other
40programs force onto it's users never made sense to me: You should be able 50programs force onto its users never made sense to me: You should be able
41to choose any font for any script freely. 51to choose any font for any script freely.
42 52
43Apart from that, rxvt-unicode is also much better internationalised than 53Apart from that, rxvt-unicode is also much better internationalised than
44it's predecessor, supports things such as XFT and ISO 14755 that are handy 54its predecessor, supports things such as XFT and ISO 14755 that are handy
45in i18n-environments, is faster, and has a lot less bugs than the original 55in i18n-environments, is faster, and has a lot bugs less than the original
46rxvt. This all in addition to dozens of other small improvements. 56rxvt. This all in addition to dozens of other small improvements.
47 57
48It is still faithfully following the original rxvt idea of being lean 58It is still faithfully following the original rxvt idea of being lean
49and nice on resources: for example, you can still configure rxvt-unicode 59and nice on resources: for example, you can still configure rxvt-unicode
50without most of it's features to get a lean binary. It also comes with 60without most of its features to get a lean binary. It also comes with
51a client/daemon pair that lets you open any number of terminal windows 61a client/daemon pair that lets you open any number of terminal windows
52from within a single process, which makes startup time very fast and 62from within a single process, which makes startup time very fast and
53drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 63drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
54@@RXVT_NAME@@c(1) (client). 64@@RXVT_NAME@@c(1) (client).
55 65
56It also makes technical information about escape sequences (which have 66It also makes technical information about escape sequences (which have
57been extended) easier accessible: see @@RXVT_NAME@@(7) for technical 67been extended) more accessible: see @@RXVT_NAME@@(7) for technical
58reference documentation (escape sequences etc.) and the FAQ section at the 68reference documentation (escape sequences etc.).
59end of this document.
60 69
61=head1 OPTIONS 70=head1 OPTIONS
62 71
63The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed 72The 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 73below. In keeping with the smaller-is-better philosophy, options may be
83 92
84Print out a message describing available options. 93Print out a message describing available options.
85 94
86=item B<-display> I<displayname> 95=item B<-display> I<displayname>
87 96
88Attempt to open a window on the named X display (B<-d> still 97Attempt to open a window on the named X display (the older form B<-d>
89respected). In the absence of this option, the display specified by the 98is still respected. but deprecated). In the absence of this option, the
90B<DISPLAY> environment variable is used. 99display specified by the B<DISPLAY> environment variable is used.
100
101=item B<-depth> I<bitdepth>
102
103Compile I<frills>: Attempt to find a visual with the given bit depth;
104resource B<depth>.
105
106[Please note that many X servers (and libXft) are buggy with
107respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108of graphical corruption. This is harmless, but we can't do anything about
109this, so watch out]
110
111=item B<-visual> I<visualID>
112
113Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for
114possible visual ids) instead of the default, and also allocate a private
115colormap. All visual types except for DirectColor are supported.
91 116
92=item B<-geometry> I<geom> 117=item B<-geometry> I<geom>
93 118
94Window geometry (B<-g> still respected); resource B<geometry>. 119Window geometry (B<-g> still respected); resource B<geometry>.
95 120
97 122
98Turn on/off simulated reverse video; resource B<reverseVideo>. 123Turn on/off simulated reverse video; resource B<reverseVideo>.
99 124
100=item B<-j>|B<+j> 125=item B<-j>|B<+j>
101 126
102Turn on/off jump scrolling; resource B<jumpScroll>. 127Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
103 128
104=item B<-ip>|B<+ip> 129=item B<-ss>|B<+ss>
105 130
106Turn on/off inheriting parent window's pixmap. Alternative form is 131Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
107B<-tr>; resource B<inheritPixmap>.
108 132
109=item B<-fade> I<number> 133=item B<-fade> I<number>
110 134
111Fade the text by the given percentage when focus is lost. 135Fade the text by the given percentage when focus is lost. Small values
136fade a little only, 100 completely replaces all colours by the fade
137colour; resource B<fading>.
112 138
113=item B<-tint> I<colour> 139=item B<-fadecolor> I<colour>
114 140
115Tint the transparent background pixmap with the given colour when 141Fade to this colour when fading is used (see B<-fade>). The default colour
116transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> 142is opaque black. resource B<fadeColor>.
117option that can be used to brighten or darken the image in addition to
118tinting it.
119 143
120=item B<-sh> 144=item B<-icon> I<file>
121 145
122I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 146Compile I<pixbuf>: Use the specified image as application icon. This
123background image in addition to tinting it (i.e. B<-tint> must be 147is used by many window managers, taskbars and pagers to represent the
124specified, too). 148application window; resource I<iconFile>.
125 149
126=item B<-bg> I<colour> 150=item B<-bg> I<colour>
127 151
128Window background colour; resource B<background>. 152Window background colour; resource B<background>.
129 153
130=item B<-fg> I<colour> 154=item B<-fg> I<colour>
131 155
132Window foreground colour; resource B<foreground>. 156Window foreground colour; resource B<foreground>.
133 157
134=item B<-pixmap> I<file[;geom]>
135
136Compile I<XPM>: Specify XPM file for the background and also optionally
137specify its scaling with a geometry string. Note you may need to add
138quotes to avoid special shell interpretation of the `;' in the
139command-line; resource B<backgroundPixmap>.
140
141=item B<-cr> I<colour> 158=item B<-cr> I<colour>
142 159
143The cursor colour; resource B<cursorColor>. 160The cursor colour; resource B<cursorColor>.
144 161
145=item B<-pr> I<colour> 162=item B<-pr> I<colour>
150 167
151The mouse pointer background colour; resource B<pointerColor2>. 168The mouse pointer background colour; resource B<pointerColor2>.
152 169
153=item B<-bd> I<colour> 170=item B<-bd> I<colour>
154 171
155The colour of the border between the xterm scrollbar and the text; 172The colour of the border around the text area and between the scrollbar and the text;
156resource B<borderColor>. 173resource B<borderColor>.
157 174
158=item B<-fn> I<fontname> 175=item B<-fn> I<fontlist>
159 176
160Select the fonts to be used. This is a comma seperated list of font 177Select 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. 178that are checked in order when trying to find glyphs for characters. The
162The first font defines the cell size for characters; other fonts might 179first font defines the cell size for characters; other fonts might be
163be smaller, but not larger. A reasonable default font list is always 180smaller, but not (in general) larger. A (hopefully) reasonable default
164appended to it. resource B<font>. 181font list is always appended to it. See resource B<font> for more details.
182
183In short, to specify an X11 core font, just specify its name or prefix it
184with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
185e.g.:
186
187 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
188 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
165 189
166See also the question "How does rxvt-unicode choose fonts?" in the FAQ 190See also the question "How does rxvt-unicode choose fonts?" in the FAQ
167section. 191section of @@RXVT_NAME@@(7).
168 192
193=item B<-fb> I<fontlist>
194
195Compile I<font-styles>: The bold font list to use when B<bold> characters
196are to be printed. See resource B<boldFont> for details.
197
198=item B<-fi> I<fontlist>
199
200Compile I<font-styles>: The italic font list to use when I<italic>
201characters are to be printed. See resource B<italicFont> for details.
202
203=item B<-fbi> I<fontlist>
204
205Compile I<font-styles>: The bold italic font list to use when B<< I<bold
206italic> >> characters are to be printed. See resource B<boldItalicFont>
207for details.
208
169=item B<-rb>|B<+rb> 209=item B<-is>|B<+is>
170 210
171Enable "real bold" support. When this option is on, bold text will be 211Compile I<font-styles>: Bold/Blink font styles imply high intensity
172displayed using the first available bold font in the font list. Bold 212foreground/background (default). See resource B<intensityStyles> for
173fonts should thus be specified in the font list after their 213details.
174corresponding regular fonts. If no bold font can be found, a regular
175font will be used. resource B<realBold>.
176 214
177=item B<-name> I<name> 215=item B<-name> I<name>
178 216
179Specify the application name under which resources are to be obtained, 217Specify the application name under which resources are to be obtained,
180rather than the default executable file name. Name should not contain 218rather than the default executable file name. Name should not contain
182 220
183=item B<-ls>|B<+ls> 221=item B<-ls>|B<+ls>
184 222
185Start as a login-shell/sub-shell; resource B<loginShell>. 223Start as a login-shell/sub-shell; resource B<loginShell>.
186 224
225=item B<-mc> I<milliseconds>
226
227Specify the maximum time between multi-click selections.
228
187=item B<-ut>|B<+ut> 229=item B<-ut>|B<+ut>
188 230
189Compile I<utmp>: Inhibit/enable writing a utmp entry; resource 231Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
190B<utmpInhibit>. 232B<utmpInhibit>.
191 233
195B<visualBell>. 237B<visualBell>.
196 238
197=item B<-sb>|B<+sb> 239=item B<-sb>|B<+sb>
198 240
199Turn on/off scrollbar; resource B<scrollBar>. 241Turn on/off scrollbar; resource B<scrollBar>.
242
243=item B<-sr>|B<+sr>
244
245Put scrollbar on right/left; resource B<scrollBar_right>.
246
247=item B<-st>|B<+st>
248
249Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
250resource B<scrollBar_floating>.
200 251
201=item B<-si>|B<+si> 252=item B<-si>|B<+si>
202 253
203Turn on/off scroll-to-bottom on TTY output inhibit; resource 254Turn on/off scroll-to-bottom on TTY output inhibit; resource
204B<scrollTtyOutput> has opposite effect. 255B<scrollTtyOutput> has opposite effect.
212 263
213Turn on/off scrolling with the scrollback buffer as new lines appear. 264Turn on/off scrolling with the scrollback buffer as new lines appear.
214This only takes effect if B<-si> is also given; resource 265This only takes effect if B<-si> is also given; resource
215B<scrollWithBuffer>. 266B<scrollWithBuffer>.
216 267
217=item B<-sr>|B<+sr>
218
219Put scrollbar on right/left; resource B<scrollBar_right>.
220
221=item B<-st>|B<+st> 268=item B<-ptab>|B<+ptab>
222 269
223Display normal (non XTerm/NeXT) scrollbar without/with a trough; 270If enabled (default), "Horizontal Tab" characters are being stored as
224resource B<scrollBar_floating>. 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>.
279
280=item B<-uc>|B<+uc>
281
282Make the cursor underlined; resource B<cursorUnderline>.
229 283
230=item B<-iconic> 284=item B<-iconic>
231 285
232Start iconified, if the window manager supports that option. 286Start iconified, if the window manager supports that option.
233Alternative form is B<-ic>. 287Alternative form is B<-ic>.
250 304
251=item B<-bl> 305=item B<-bl>
252 306
253Compile I<frills>: Set MWM hints to request a borderless window, i.e. 307Compile I<frills>: Set MWM hints to request a borderless window, i.e.
254if honoured by the WM, the rxvt-unicode window will not have window 308if honoured by the WM, the rxvt-unicode window will not have window
255decorations; resource B<borderLess>. 309decorations; resource B<borderLess>. If the window manager does not
310support MWM hints (e.g. kwin), enables override-redirect mode.
311
312=item B<-override-redirect>
313
314Compile I<frills>: Sets override-redirect on the window; resource
315B<override-redirect>.
316
317=item B<-dockapp>
318
319Sets the initial state of the window to WithdrawnState, which makes
320window managers that support this extension treat it as a dockapp.
321
322=item B<-sbg>
323
324Compile I<frills>: Disable the usage of the built-in block graphics/line
325drawing characters and just rely on what the specified fonts provide. Use
326this if you have a good font and want to use its block graphic glyphs;
327resource B<skipBuiltinGlyphs>.
256 328
257=item B<-lsp> I<number> 329=item B<-lsp> I<number>
258 330
259Compile I<linespace>: Lines (pixel height) to insert between each row 331Compile I<frills>: Lines (pixel height) to insert between each row of
260of the display; resource B<linespace>. 332the display. Useful to work around font rendering problems; resource
333B<lineSpace>.
334
335=item B<-letsp> I<number>
336
337Compile I<frills>: Amount to adjust the computed character width by
338to control overall letter spacing. Negative values will tighten up the
339letter spacing, positive values will space letters out more. Useful to
340work around odd font metrics; resource B<letterSpace>.
261 341
262=item B<-tn> I<termname> 342=item B<-tn> I<termname>
263 343
264This option specifies the name of the terminal type to be set in the 344This option specifies the name of the terminal type to be set in the
265B<TERM> environment variable. This terminal type must exist in the 345B<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 354given 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 355on 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, 356run the program specified by the B<SHELL> environment variable or,
277failing that, I<sh(1)>. 357failing that, I<sh(1)>.
278 358
359Please note that you must specify a program with arguments. If you want to
360run shell commands, you have to specify the shell, like this:
361
362 @@RXVT_NAME@@ -e sh -c "shell commands"
363
279=item B<-title> I<text> 364=item B<-title> I<text>
280 365
281Window title (B<-T> still respected); the default title is the basename 366Window title (B<-T> still respected); the default title is the basename
282of the program specified after the B<-e> option, if any, otherwise the 367of the program specified after the B<-e> option, if any, otherwise the
283application name; resource B<title>. 368application name; resource B<title>.
295=item B<-pt> I<style> 380=item B<-pt> I<style>
296 381
297Compile I<XIM>: input style for input method; B<OverTheSpot>, 382Compile I<XIM>: input style for input method; B<OverTheSpot>,
298B<OffTheSpot>, B<Root>; resource B<preeditType>. 383B<OffTheSpot>, B<Root>; resource B<preeditType>.
299 384
385If the perl extension C<xim-onthespot> is used (which is the default),
386then additionally the C<OnTheSpot> preedit type is available.
387
300=item B<-im> I<text> 388=item B<-im> I<text>
301 389
302Compile I<XIM>: input method name. resource B<inputMethod>. 390Compile I<XIM>: input method name. resource B<inputMethod>.
303 391
304=item B<-imlocale> I<string> 392=item B<-imlocale> I<string>
305 393
306The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 394The 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 395C<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 396input extension to be able to input japanese characters while staying in
309another locale. 397another locale. resource B<imLocale>.
398
399=item B<-imfont> I<fontset>
400
401Set the font set to use for the X Input Method, see resource B<imFont>
402for more info.
403
404=item B<-tcw>
405
406Change the meaning of triple-click selection with the left mouse
407button. Only effective when the original (non-perl) selection code is
408in-use. Instead of selecting a full line it will extend the selection to
409the end of the logical line only. resource B<tripleclickwords>.
310 410
311=item B<-insecure> 411=item B<-insecure>
312 412
313Enable "insecure" mode, which currently enables most of the escape 413Enable "insecure" mode, which currently enables most of the escape
314sequences that echo strings. See the resource B<insecure> for more 414sequences that echo strings. See the resource B<insecure> for more
328=item B<-ssr>|B<+ssr> 428=item B<-ssr>|B<+ssr>
329 429
330Turn on/off secondary screen scroll (default enabled); resource 430Turn on/off secondary screen scroll (default enabled); resource
331B<secondaryScroll>. 431B<secondaryScroll>.
332 432
433=item B<-hold>|B<+hold>
434
435Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
436will not immediately destroy its window when the program executed within
437it exits. Instead, it will wait till it is being killed or closed by the
438user; resource B<hold>.
439
440=item B<-cd> I<path>
441
442Sets the working directory for the shell (or the command specified via
443B<-e>). The I<path> must be an absolute path and it must exist for
444@@RXVT_NAME@@ to start; resource B<chdir>.
445
333=item B<-xrm> I<resourcestring> 446=item B<-xrm> I<string>
334 447
335No effect on rxvt-unicode. Simply passes through an argument to be made 448Works like the X Toolkit option of the same name, by adding the I<string>
336available in the instance's argument list. Appears in I<WM_COMMAND> in 449as if it were specified in a resource file. Resource values specified this
337some window managers. 450way take precedence over all other resource specifications.
451
452Note that you need to use the I<same> syntax as in the .Xdefaults file,
453e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
454options can be specified as long-options on the commandline, so use
455of B<-xrm> is mostly limited to cases where you want to specify other
456resources (e.g. for input methods) or for compatibility with other
457programs.
458
459=item B<-keysym.>I<sym> I<string>
460
461Remap a key symbol. See resource B<keysym>.
462
463=item B<-embed> I<windowid>
464
465Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
466which enables applications to easily embed a terminal.
467
468Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
469shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
470quite a bit, so don't expect it to keep some specific state. It's best to
471create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
472
473The window will not be destroyed when @@RXVT_NAME@@ exits.
474
475It might be useful to know that @@RXVT_NAME@@ will not close file
476descriptors passed to it (except for stdin/out/err, of course), so you
477can use file descriptors to communicate with the programs within the
478terminal. This works regardless of whether the C<-embed> option was used or
479not.
480
481Here is a short Gtk2-perl snippet that illustrates how this option can be
482used (a longer example is in F<doc/embed>):
483
484 my $rxvt = new Gtk2::Socket;
485 $rxvt->signal_connect_after (realize => sub {
486 my $xid = $_[0]->window->get_xid;
487 system "@@RXVT_NAME@@ -embed $xid &";
488 });
489
490=item B<-pty-fd> I<file descriptor>
491
492Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
493pair but instead use the given file descriptor as the tty master. This is
494useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
495without having to run a program within it.
496
497If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
498entries and will not tinker with pty/tty permissions - you have to do that
499yourself if you want that.
500
501As an extremely special case, specifying C<-1> will completely suppress
502pty/tty operations, which is probably only useful in conjunction with some
503perl extension that manages the terminal.
504
505Here is a example in perl that illustrates how this option can be used (a
506longer example is in F<doc/pty-fd>):
507
508 use IO::Pty;
509 use Fcntl;
510
511 my $pty = new IO::Pty;
512 fcntl $pty, F_SETFD, 0; # clear close-on-exec
513 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
514 close $pty;
515
516 # now communicate with rxvt
517 my $slave = $pty->slave;
518 while (<$slave>) { print $slave "got <$_>\n" }
519
520=item B<-pe> I<string>
521
522Comma-separated list of perl extension scripts to use (or not to use) in
523this terminal instance. See resource B<perl-ext> for details.
338 524
339=back 525=back
340 526
341=head1 RESOURCES (available also as long-options) 527=head1 RESOURCES
342 528
343Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 529Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
344options) compiled into your version. 530options) compiled into your version. All resources are also available as
531long-options.
345 532
346There are two different methods that @@RXVT_NAME@@ can use to get the 533You can set and change the resources using X11 tools like B<xrdb>. Many
347Xresource data: using the X libraries (Xrm*-functions) or internal 534distribution do also load settings from the B<~/.Xresources> file when X
348Xresources reader (B<~/.Xdefaults>). For the first method (ie. 535starts. @@RXVT_NAME@@ will consult the following files/resources in order,
349B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 536with 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 537
353If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> 538 1. app-defaults file in $XAPPLRESDIR
354lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults 539 2. $HOME/.Xdefaults
355set in XAPPLOADDIR/URxvt (compile-time defined: usually 540 3. RESOURCE_MANAGER property on root-window of screen 0
356B</usr/lib/X11/app-defaults/URxvt>) and resources set in 541 4. SCREEN_RESOURCES property on root-window of the current screen
357B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist. 542 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
543 6. resources specified via -xrm on the commandline
544
358Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 545Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
359class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 546names: 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 547common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
361easily configured, while the class name B<URxvt> allows resources 548configured, while the class name B<URxvt> allows resources unique to
362unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 549B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
363shared between different B<@@RXVT_NAME@@> configurations. If no 550configurations. If no resources are specified, suitable defaults will
364resources are specified, suitable defaults will be used. Command-line 551be used. Command-line arguments can be used to override resource
365arguments can be used to override resource settings. The following 552settings. The following resources are supported (you might want to
366resources are allowed: 553check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
554extensions not documented here):
367 555
368=over 4 556=over 4
557
558=item B<depth:> I<bitdepth>
559
560Compile I<xft>: Attempt to find a visual with the given bit depth;
561option B<-depth>.
562
563=item B<buffered:> I<boolean>
564
565Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
566On some card/driver combination enabling it slightly decreases
567performance, on most it greatly helps it. The slowdown is small, so it
568should normally be enabled.
369 569
370=item B<geometry:> I<geom> 570=item B<geometry:> I<geom>
371 571
372Create the window with the specified X window geometry [default 80x24]; 572Create the window with the specified X window geometry [default 80x24];
373option B<-geometry>. 573option B<-geometry>.
387Use the specified colour for the colour value I<n>, where 0-7 587Use the specified colour for the colour value I<n>, where 0-7
388corresponds to low-intensity (normal) colours and 8-15 corresponds to 588corresponds to low-intensity (normal) colours and 8-15 corresponds to
389high-intensity (bold = bright foreground, blink = bright background) 589high-intensity (bold = bright foreground, blink = bright background)
390colours. The canonical names are as follows: 0=black, 1=red, 2=green, 590colours. 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 5913=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
392names used are listed in the B<COLORS AND GRAPHICS> section. 592names used are listed in the B<COLOURS AND GRAPHICS> section.
593
594Colours higher than 15 cannot be set using resources (yet), but can be
595changed using an escape command (see @@RXVT_NAME@@(7)).
596
597Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
59888 colour support). Colours 80-87 are evenly spaces grey steps.
393 599
394=item B<colorBD:> I<colour> 600=item B<colorBD:> I<colour>
395 601
602=item B<colorIT:> I<colour>
603
396Use the specified colour to display bold characters when the foreground 604Use the specified colour to display bold or italic characters when the
397colour is the default. This option will be ignored if B<realBold> is 605foreground colour is the default. If font styles are not available
398enabled. 606(Compile I<styles>) and this option is unset, reverse video is used instead.
399 607
400=item B<colorUL:> I<colour> 608=item B<colorUL:> I<colour>
401 609
402Use the specified colour to display underlined characters when the 610Use the specified colour to display underlined characters when the
403foreground colour is the default. 611foreground colour is the default.
404 612
405=item B<colorRV:> I<colour> 613=item B<underlineColor:> I<colour>
406 614
615If set, use the specified colour as the colour for the underline
616itself. If unset, use the foreground colour.
617
618=item B<highlightColor:> I<colour>
619
407Use the specified colour as the background for reverse video 620If set, use the specified colour as the background for highlighted
408characters. 621characters. If unset, use reverse video.
622
623=item B<highlightTextColor:> I<colour>
624
625If set and highlightColor is set, use the specified colour as the
626foreground for highlighted characters.
409 627
410=item B<cursorColor:> I<colour> 628=item B<cursorColor:> I<colour>
411 629
412Use the specified colour for the cursor. The default is to use the 630Use the specified colour for the cursor. The default is to use the
413foreground colour; option B<-cr>. 631foreground colour; option B<-cr>.
420 638
421=item B<reverseVideo:> I<boolean> 639=item B<reverseVideo:> I<boolean>
422 640
423B<True>: simulate reverse video by foreground and background colours; 641B<True>: simulate reverse video by foreground and background colours;
424option B<-rv>. B<False>: regular screen colours [default]; option 642option B<-rv>. B<False>: regular screen colours [default]; option
425B<+rv>. See note in B<COLORS AND GRAPHICS> section. 643B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
426 644
427=item B<jumpScroll:> I<boolean> 645=item B<jumpScroll:> I<boolean>
428 646
429B<True>: specify that jump scrolling should be used. When scrolling 647B<True>: specify that jump scrolling should be used. When receiving lots
430quickly, fewer screen updates are performed [default]; option B<-j>. 648of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
649has been read, resulting in fewer updates while still displaying every
650received line; option B<-j>.
651
431B<False>: specify that smooth scrolling should be used; option B<+j>. 652B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
653force a screen refresh on each new line it received; option B<+j>.
432 654
433=item B<inheritPixmap:> I<boolean> 655=item B<skipScroll:> I<boolean>
434 656
435B<True>: make the background inherit the parent windows' pixmap, giving 657B<True>: (the default) specify that skip scrolling should be used. When
436artificial transparency. B<False>: do not inherit the parent windows' 658receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
437pixmap. 659(around 60 times per second), resulting in far fewer updates. This can
660result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
661option B<-ss>.
662
663B<False>: specify that everything is to be displayed, even
664if the refresh is too fast for the human eye to read anything (or the
665monitor to display anything); option B<+ss>.
438 666
439=item B<fading:> I<number> 667=item B<fading:> I<number>
440 668
441Fade the text by the given percentage when focus is lost. 669Fade the text by the given percentage when focus is lost; option B<-fade>.
442 670
443=item B<tintColor:> I<colour> 671=item B<fadeColor:> I<colour>
444 672
445Tint the transparent background pixmap with the given colour. 673Fade to this colour, when fading is used (see B<fading:>). The default
674colour is black; option B<-fadecolor>.
446 675
447=item B<shading:> I<number> 676=item B<iconFile:> I<file>
448 677
449Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 678Set the application icon pixmap; option B<-icon>.
450image in addition to tinting it.
451
452=item B<fading:> I<number>
453
454Scale the tint colour by the given percentage.
455 679
456=item B<scrollColor:> I<colour> 680=item B<scrollColor:> I<colour>
457 681
458Use the specified colour for the scrollbar [default #B2B2B2]. 682Use the specified colour for the scrollbar [default #B2B2B2].
459 683
460=item B<troughColor:> I<colour> 684=item B<troughColor:> I<colour>
461 685
462Use the specified colour for the scrollbar's trough area [default 686Use the specified colour for the scrollbar's trough area [default
463#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 687#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
464 688
465=item B<backgroundPixmap:> I<file[;geom]> 689=item B<borderColor:> I<colour>
466 690
467Use the specified XPM file (note the `.xpm' extension is optional) for 691The colour of the border around the text area and between the scrollbar
468the background and also optionally specify its scaling with a geometry 692and the text.
469string B<WxH+X+Y>, in which B<"W" / "H"> specify the
470horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image
471centre (percent). A scale of 0 displays the image with tiling. A scale
472of 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
474be magnified beyond 10 times its original size. The maximum permitted
475scale is 1000. [default 0x0+50+50]
476 693
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>
484
485Specify the colon-delimited search path for finding files (XPM and
486menus), in addition to the paths specified by the B<RXVTPATH> and
487B<PATH> environment variables.
488
489=item B<font:> I<fontname> 694=item B<font:> I<fontlist>
490 695
491Select the fonts to be used. This is a comma seperated list of font 696Select 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. 697that are checked in order when trying to find glyphs for characters. The
493The first font defines the cell size for characters; other fonts might 698first font defines the cell size for characters; other fonts might be
494be smaller, but not larger. A reasonable default font list is always 699smaller, but not (in general) larger. A (hopefully) reasonable default
495appended to it. option B<-fn>. 700font list is always appended to it; option B<-fn>.
496 701
497=item B<realBold:> I<boolean> 702Each font can either be a standard X11 core font (XLFD) name, with
703optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
498 704
499B<True>: Enable "real bold" support. When this option is on, bold text 705In addition, each font can be prefixed with additional hints and
500will be displayed using the first available bold font in the font list. 706specifications enclosed in square brackets (C<[]>). The only available
501Bold fonts should thus be specified in the font list after their 707hint 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 708fonts.
503font will be used. option B<-rb>. B<False>: Display bold text in a
504regular font, using the color specified with B<colorBD>; option B<+rb>.
505 709
506=item B<selectstyle:> I<mode> 710For example, this font resource
507 711
508Set mouse selection style to B<old> which is 2.20, B<oldword> which is 712 URxvt.font: 9x15bold,\
509xterm style with 2.20 old word selection, or anything else which gives 713 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
510xterm style selection. 714 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
715 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
716 xft:Code2000:antialias=false
511 717
512=item B<scrollstyle:> I<mode> 718specifies five fonts to be used. The first one is C<9x15bold> (actually
719the iso8859-1 version of the second font), which is the base font (because
720it is named first) and thus defines the character cell grid to be 9 pixels
721wide and 15 pixels high.
513 722
514Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 723The second font is just used to add additional unicode characters not in
515the author's favourite.. 724the base font, likewise the third, which is unfortunately non-bold, but
725the bold version of the font does contain fewer characters, so this is a
726useful supplement.
727
728The third font is an Xft font with aliasing turned off, and the characters
729are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
730contains other characters, but we are not interested in them.
731
732The last font is a useful catch-all font that supplies most of the
733remaining unicode characters.
734
735=item B<boldFont:> I<fontlist>
736
737=item B<italicFont:> I<fontlist>
738
739=item B<boldItalicFont:> I<fontlist>
740
741The font list to use for displaying B<bold>, I<italic> or B<< I<bold
742italic> >> characters, respectively.
743
744If specified and non-empty, then the syntax is the same as for the
745B<font>-resource, and the given font list will be used as is, which makes
746it possible to substitute completely different font styles for bold and
747italic.
748
749If unset (the default), a suitable font list will be synthesized by
750"morphing" the normal text font list into the desired shape. If that is
751not possible, replacement fonts of the desired shape will be tried.
752
753If set, but empty, then this specific style is disabled and the normal
754text font will being used for the given style.
755
756=item B<intensityStyles:> I<boolean>
757
758When font styles are not enabled, or this option is enabled (B<True>,
759option B<-is>, the default), bold/blink font styles imply high
760intensity foreground/background colours. Disabling this option (B<False>,
761option B<+is>) disables this behaviour, the high intensity colours are not
762reachable.
516 763
517=item B<title:> I<string> 764=item B<title:> I<string>
518 765
519Set window title string, the default title is the command-line 766Set window title string, the default title is the command-line
520specified after the B<-e> option, if any, otherwise the application 767specified after the B<-e> option, if any, otherwise the application
529=item B<mapAlert:> I<boolean> 776=item B<mapAlert:> I<boolean>
530 777
531B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 778B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
532de-iconify (map) on receipt of a bell character [default]. 779de-iconify (map) on receipt of a bell character [default].
533 780
781=item B<urgentOnBell:> I<boolean>
782
783B<True>: set the urgency hint for the wm on receipt of a bell character.
784B<False>: do not set the urgency hint [default].
785
786@@RXVT_NAME@@ resets the urgency hint on every focus change.
787
534=item B<visualBell:> I<boolean> 788=item B<visualBell:> I<boolean>
535 789
536B<True>: use visual bell on receipt of a bell character; option B<-vb>. 790B<True>: use visual bell on receipt of a bell character; option B<-vb>.
537B<False>: no visual bell [default]; option B<+vb>. 791B<False>: no visual bell [default]; option B<+vb>.
538 792
540 794
541B<True>: start as a login shell by prepending a `-' to B<argv[0]> of 795B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
542the shell; option B<-ls>. B<False>: start as a normal sub-shell 796the shell; option B<-ls>. B<False>: start as a normal sub-shell
543[default]; option B<+ls>. 797[default]; option B<+ls>.
544 798
799=item B<multiClickTime:> I<number>
800
801Specify the maximum time in milliseconds between multi-click select
802events. The default is 500 milliseconds; option B<-mc>.
803
545=item B<utmpInhibit:> I<boolean> 804=item B<utmpInhibit:> I<boolean>
546 805
547B<True>: inhibit writing record into the system log file B<utmp>; 806B<True>: inhibit writing record into the system log file B<utmp>;
548option B<-ut>. B<False>: write record into the system log file B<utmp> 807option B<-ut>. B<False>: write record into the system log file B<utmp>
549[default]; option B<+ut>. 808[default]; option B<+ut>.
552 811
553Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 812Specify 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 813B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
555B<Shift-Print> to include the scrollback as well. 814B<Shift-Print> to include the scrollback as well.
556 815
816The string will be interpreted as if typed into the shell as-is.
817
818Example:
819
820 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
821
822This creates a new file in your home directory with the screen contents
823every time you hit C<Print>.
824
825=item B<scrollstyle:> I<mode>
826
827Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
828the author's favourite.
829
830=item B<thickness:> I<number>
831
832Set the scrollbar width in pixels.
833
557=item B<scrollBar:> I<boolean> 834=item B<scrollBar:> I<boolean>
558 835
559B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 836B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
560disable the scrollbar; option B<+sb>. 837disable the scrollbar; option B<+sb>.
561 838
580B<False>: do not scroll to bottom when tty receives output; option 857B<False>: do not scroll to bottom when tty receives output; option
581B<+si>. 858B<+si>.
582 859
583=item B<scrollWithBuffer:> I<boolean> 860=item B<scrollWithBuffer:> I<boolean>
584 861
585B<True>: scroll with scrollback buffer when tty recieves new lines (and 862B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
586B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 863try to show the same lines) and B<scrollTtyOutput> is False; option
587with scrollback buffer when tty recieves new lines; option B<-sw>. 864B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
865new lines; option B<+sw>.
588 866
589=item B<scrollTtyKeypress:> I<boolean> 867=item B<scrollTtyKeypress:> I<boolean>
590 868
591B<True>: scroll to bottom when a non-special key is pressed. Special keys 869B<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 870are those which are intercepted by rxvt-unicode for special handling and
611=item B<borderLess:> I<boolean> 889=item B<borderLess:> I<boolean>
612 890
613Set MWM hints to request a borderless window, i.e. if honoured by the 891Set 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>. 892WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
615 893
894=item B<skipBuiltinGlyphs:> I<boolean>
895
896Compile I<frills>: Disable the usage of the built-in block graphics/line
897drawing characters and just rely on what the specified fonts provide. Use
898this if you have a good font and want to use its block graphic glyphs;
899option B<-sbg>.
900
616=item B<termName:> I<termname> 901=item B<termName:> I<termname>
617 902
618Specifies the terminal type name to be set in the B<TERM> environment 903Specifies the terminal type name to be set in the B<TERM> environment
619variable; option B<-tn>. 904variable; option B<-tn>.
620 905
621=item B<linespace:> I<number> 906=item B<lineSpace:> I<number>
622 907
623Specifies number of lines (pixel height) to insert between each row of 908Specifies number of lines (pixel height) to insert between each row of
624the display [default 0]; option B<-lsp>. 909the display [default 0]; option B<-lsp>.
625 910
626=item B<meta8:> I<boolean> 911=item B<meta8:> I<boolean>
631=item B<mouseWheelScrollPage:> I<boolean> 916=item B<mouseWheelScrollPage:> I<boolean>
632 917
633B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel 918B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
634scrolls five lines [default]. 919scrolls five lines [default].
635 920
921=item B<pastableTabs:> I<boolean>
922
923B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
924movement only; option C<-ptab>.
925
636=item B<cursorBlink:> I<boolean> 926=item B<cursorBlink:> I<boolean>
637 927
638B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 928B<True>: blink the cursor. B<False>: do not blink the cursor [default];
639option B<-bc>. 929option B<-bc>.
930
931=item B<cursorUnderline:> I<boolean>
932
933B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
934option B<-uc>.
640 935
641=item B<pointerBlank:> I<boolean> 936=item B<pointerBlank:> I<boolean>
642 937
643B<True>: blank the pointer when a key is pressed or after a set number 938B<True>: blank the pointer when a key is pressed or after a set number
644of seconds of inactivity. B<False>: the pointer is always visible 939of seconds of inactivity. B<False>: the pointer is always visible
650 945
651=item B<pointerColor2:> I<colour> 946=item B<pointerColor2:> I<colour>
652 947
653Mouse pointer background colour. 948Mouse pointer background colour.
654 949
950=item B<pointerShape:> I<string>
951
952Compile I<frills>: Specifies the name of the mouse pointer shape
953[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
954file for possible values (omit the C<XC_> prefix).
955
655=item B<pointerBlankDelay:> I<number> 956=item B<pointerBlankDelay:> I<number>
656 957
657Specifies number of seconds before blanking the pointer [default 2]. 958Specifies number of seconds before blanking the pointer [default 2]. Use a
959large number (e.g. C<987654321>) to effectively disable the timeout.
658 960
659=item B<backspacekey:> I<string> 961=item B<backspacekey:> I<string>
660 962
661The string to send when the backspace key is pressed. If set to B<DEC> 963The 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> 964or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
663(code 8) - which can be reversed with the appropriate DEC private mode 965(code 8) - which can be reversed with the appropriate DEC private mode
664escape sequence. 966escape sequence.
665 967
666=item B<deletekey:> I<string> 968=item B<deletekey:> I<string>
667 969
669pressed. If unset it will send the sequence traditionally associated 971pressed. If unset it will send the sequence traditionally associated
670with the B<Execute> key. 972with the B<Execute> key.
671 973
672=item B<cutchars:> I<string> 974=item B<cutchars:> I<string>
673 975
674The characters used as delimiters for double-click word selection. The 976The characters used as delimiters for double-click word selection
675built-in default: 977(whitespace delimiting is added automatically if resource is given).
676 978
979When the perl selection extension is in use (the default if compiled
980in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
981characters will be created (if the resource exists, otherwise, no regex
982will be created). In this mode, characters outside ISO-8859-1 can be used.
983
984When the selection extension is not used, only ISO-8859-1 characters can
985be used. If not specified, the built-in default is used:
986
677B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 987B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
678 988
679=item B<preeditType:> I<style> 989=item B<preeditType:> I<style>
680 990
681B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 991B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
682 992
683=item B<inputMethod:> I<name> 993=item B<inputMethod:> I<name>
684 994
685I<name> of inputMethod to use; option B<-im>. 995I<name> of inputMethod to use; option B<-im>.
686 996
687=item B<imLocale:> I<name> 997=item B<imLocale:> I<name>
688 998
689The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 999The 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 1000C<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 1001input extension to be able to input japanese characters while staying in
692another locale. option B<-imlocale>. 1002another locale; option B<-imlocale>.
693 1003
694=item B<insecure> 1004=item B<imFont:> I<fontset>
1005
1006Specify the font-set used for XIM styles C<OverTheSpot> or
1007C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
1008by commas), i.e. it's not in the same format as the other font lists used
1009in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
1010found, preferably one or two pixels differing in size to the base font.
1011option B<-imfont>.
1012
1013=item B<tripleclickwords:> I<boolean>
1014
1015Change the meaning of triple-click selection with the left mouse
1016button. Instead of selecting a full line it will extend the selection to
1017the end of the logical line only; option B<-tcw>.
1018
1019=item B<insecure:> I<boolean>
695 1020
696Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1021Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
697echo arbitrary strings like the icon name or the locale. This could be 1022echo arbitrary strings like the icon name or the locale. This could be
698abused if somebody gets 8-bit-clean access to your display, wether 1023abused if somebody gets 8-bit-clean access to your display, whether
699throuh a mail client displaying mail bodies unfiltered or though 1024through a mail client displaying mail bodies unfiltered or through
700write(1). Therefore, these sequences are disabled by default. (Note 1025write(1) or any other means. Therefore, these sequences are disabled by
701that other terminals, including xterm, have these sequences 1026default. (Note that many other terminals, including xterm, have these
702enabled by default). You can enable them by setting this boolean 1027sequences enabled by default, which doesn't make it safer, though).
703resource or specifying B<-insecure> as an option. At the moment, this 1028
704enabled display-answer, locale, findfont, icon label and window title 1029You can enable them by setting this boolean resource or specifying
705requests as well as dynamic menubar dispatch. 1030B<-insecure> as an option. At the moment, this enables display-answer,
1031locale, findfont, icon label and window title requests.
706 1032
707=item B<modifier:> I<modifier> 1033=item B<modifier:> I<modifier>
708 1034
709Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 1035Set 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 1036B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
714 1040
715Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1041Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
716character is passed through. It may contain escape values as described 1042character is passed through. It may contain escape values as described
717in the entry on B<keysym> following. 1043in the entry on B<keysym> following.
718 1044
719=item B<secondaryScreen:> I<bool> 1045=item B<secondaryScreen:> I<boolean>
720 1046
721Turn on/off secondary screen (default enabled). 1047Turn on/off secondary screen (default enabled).
722 1048
723=item B<secondaryScroll:> I<bool> 1049=item B<secondaryScroll:> I<boolean>
724 1050
725Turn on/off secondary screen scroll (default enabled). If the this 1051Turn on/off secondary screen scroll (default enabled). If this
726option is enabled, scrolls on the secondary screen will change the 1052option is enabled, scrolls on the secondary screen will change the
727scrollback buffer and switching to/from the secondary screen will 1053scrollback buffer and, when secondaryScreen is off, switching
728instead scroll the screen up. 1054to/from the secondary screen will instead scroll the screen up.
729 1055
1056=item B<hold>: I<boolean>
1057
1058Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1059will not immediately destroy its window when the program executed within
1060it exits. Instead, it will wait till it is being killed or closed by the
1061user.
1062
1063=item B<chdir>: I<path>
1064
1065Sets the working directory for the shell (or the command specified via
1066B<-e>). The I<path> must be an absolute path and it must exist for
1067@@RXVT_NAME@@ to start. If it isn't specified then the current working
1068directory will be used; option B<-cd>.
1069
730=item B<keysym.>I<sym>: I<string> 1070=item B<keysym.>I<sym>: I<action>
731 1071
732Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may 1072Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
733contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: 1073resource name B<keysym.> cannot be omitted.
734newline, \r: return, \t: 1074
735tab, \000: octal number) or control characters (^?: delete, ^@: null, 1075Using this resource, you can map key combinations such as
736^A ...) and may enclosed with double quotes so that it can start or end 1076C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
737with whitespace. The intervening resource name B<keysym.> cannot be 1077string than would normally result from that combination, making the
738omitted. This resource is only available when compiled with 1078terminal scroll up or down the way you want it, or any other thing an
739KEYSYM_RESOURCE. 1079extension might provide.
1080
1081The key combination that triggers the action, I<sym>, has the following format:
1082
1083 (modifiers-)key
1084
1085Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
1086B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
1087B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
1088B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1089
1090The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1091whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1092keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1093current application keymap mode state.
1094
1095Due the the large number of modifier combinations, a key mapping will
1096match if I<at least> the specified identifiers are being set, and no other
1097key mappings with those and more bits are being defined. That means that
1098defining a mapping for C<a> will automatically provide definitions for
1099C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1100themselves. See the C<builtin:> action, below, for a way to work around
1101this when this is a problem.
1102
1103The spelling of I<key> depends on your implementation of X. An easy way to
1104find a key name is to use the B<xev>(1) command. You can find a list by
1105looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1106the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1107value (B<0x0000 - 0xFFFF>).
1108
1109As with any resource value, the I<action> string may contain backslash
1110escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1111number), see RESOURCES in C<man 7 X> for further details.
1112
1113An action starts with an action prefix that selects a certain type
1114of action, followed by a colon. An action string without colons is
1115interpreted as a literal string to pass to the tty (as if it was
1116prefixed with C<string:>).
1117
1118The following action prefixes are known - extensions can provide
1119additional prefixes:
1120
1121=over 4
1122
1123=item string:STRING
1124
1125If the I<action> starts with C<string:> (or otherwise contains no colons),
1126then the remaining C<STRING> will be passed to the program running in the
1127terminal. For example, you could replace whatever Shift-Tab outputs by the
1128string C<echo rm -rf /> followed by a newline:
1129
1130 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1131
1132This could in theory be used to completely redefine your keymap.
1133
1134In addition, for actions of this type, you can define a range of
1135keysyms in one shot by loading the C<keysym-list> perl extension and
1136providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1137the delimiter `/' should be a character not used by the strings.
1138
1139Its usage can be demonstrated by an example:
1140
1141 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1142
1143The above line is equivalent to the following three lines:
1144
1145 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1146 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1147 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1148
1149=item command:STRING
1150
1151If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1152is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1153the opposite of C<string:> - instead of sending it to the program running
1154in the terminal, it will be treated as if it were program output). This is
1155most useful to feed command sequences into @@RXVT_NAME@@.
1156
1157For example the following means "change the current locale to C<zh_CN.GBK>
1158when Control-Meta-c is being pressed":
1159
1160 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1161
1162The following example will map Control-Meta-1 and Control-Meta-2 to
1163the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1164font-switching at runtime:
1165
1166 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1167 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1168
1169Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1170info):
1171
1172 URxvt.keysym.M-C-3: command:\033[8;25;80t
1173 URxvt.keysym.M-C-4: command:\033[8;48;110t
1174
1175=item builtin:
1176
1177The builtin action is the action that @@RXVT_NAME@@ would execute if no
1178key binding existed for the key combination. The obvious use is to undo
1179the effect of existing bindings. The not so obvious use is to reinstate
1180bindings when another binding overrides too many modifiers.
1181
1182For example if you overwrite the C<Insert> key you will disable
1183@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1184"holes" into the user-defined keymap using the C<builtin:> replacement:
1185
1186 URxvt.keysym.Insert: <my insert key sequence>
1187 URxvt.keysym.S-Insert: builtin:
1188
1189The first line defines a mapping for C<Insert> and I<any> combination
1190of modifiers. The second line re-establishes the default mapping for
1191C<Shift-Insert>.
1192
1193=item builtin-string:
1194
1195This action is mainly useful to restore string mappings for keys that
1196have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1197difficult to explain - basically, this action will send the string to the
1198application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1199action for it.
1200
1201An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1202selection when you press C<Shift-Insert>. With the following bindings, it
1203would instead emit the (undocumented, but what applications running in the
1204terminal might expect) sequence C<ESC [ 2 $> instead:
1205
1206 URxvt.keysym.S-Insert: builtin-string:
1207 URxvt.keysym.C-S-Insert: builtin:
1208
1209The first line disables the paste functionality for that key
1210combination, and the second reinstates the default behaviour for
1211C<Control-Shift-Insert>, which would otherwise be overridden.
1212
1213Similarly, to let applications gain access to the C<C-M-c> (copy to
1214clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1215this:
1216
1217 URxvt.keysym.C-M-c: builtin-string:
1218 URxvt.keysym.C-M-v: builtin-string:
1219
1220=item EXTENSION:STRING
1221
1222An action of this form invokes the action B<STRING>, if any, provided
1223by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1224be loaded automatically if necessary.
1225
1226Not all extensions define actions, but popular extensions that do
1227include the I<selection> and I<matcher> extensions (documented in their
1228own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1229respectively).
1230
1231From the silly examples department, this will rot13-"encrypt"
1232@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1233keyboards:
1234
1235 URxvt.keysym.M-C-c: selection:rot13
1236
1237=item perl:STRING *DEPRECATED*
1238
1239This is a deprecated way of invoking commands provided by perl
1240extensions. It is still supported, but should not be used anymore.
1241
1242=back
1243
1244=item B<perl-ext-common>: I<string>
1245
1246=item B<perl-ext>: I<string>
1247
1248Comma-separated list(s) of perl extension scripts (default: C<default>) to
1249use in this terminal instance; option B<-pe>.
1250
1251Extension names can be prefixed with a C<-> sign to prohibit using
1252them. This can be useful to selectively disable some extensions loaded
1253by default, or specified via the C<perl-ext-common> resource. For
1254example, C<default,-selection> will use all the default extensions except
1255C<selection>.
1256
1257The default set includes the C<selection>, C<option-popup>,
1258C<selection-popup>, C<readline> and C<searchable-scrollback>
1259extensions, and extensions which are mentioned in B<keysym> resources.
1260
1261Any extension such that a corresponding resource is given on the
1262command line is automatically appended to B<perl-ext>.
1263
1264Each extension is looked up in the library directories, loaded if
1265necessary, and bound to the current terminal instance. When the library
1266search path contains multiple extension files of the same name, then the
1267first one found will be used.
1268
1269If both of these resources are the empty string, then the perl interpreter
1270will not be initialized. The rationale for having two options is that
1271B<perl-ext-common> will be used for extensions that should be available to
1272all instances, while B<perl-ext> is used for specific instances.
1273
1274=item B<perl-eval>: I<string>
1275
1276Perl code to be evaluated when all extensions have been registered. See
1277the @@RXVT_NAME@@perl(3) manpage.
1278
1279=item B<perl-lib>: I<path>
1280
1281Colon-separated list of additional directories that hold extension
1282scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1283in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1284lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1285
1286See the @@RXVT_NAME@@perl(3) manpage.
1287
1288=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1289
1290Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1291details.
1292
1293=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1294
1295Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1296for details.
1297
1298=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1299
1300This resource is deprecated and will be removed. Use a B<keysym> resource
1301instead, e.g.:
1302
1303 URxvt.keysym.M-s: searchable-scrollback:start
1304
1305=item B<url-launcher>: I<string>
1306
1307Specifies the program to be started with a URL argument. Used by the
1308C<selection-popup> and C<matcher> perl extensions.
1309
1310=item B<transient-for>: I<windowid>
1311
1312Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1313
1314=item B<override-redirect>: I<boolean>
1315
1316Compile I<frills>: Sets override-redirect for the terminal window, making
1317it almost invisible to window managers; option B<-override-redirect>.
1318
1319=item B<iso14755:> I<boolean>
1320
1321Turn on/off ISO 14755 (default enabled).
1322
1323=item B<iso14755_52:> I<boolean>
1324
1325Turn on/off ISO 14755 5.2 mode (default enabled).
1326
1327=back
1328
1329=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1330
1331=over 4
1332
1333=item B<-pixmap> I<file[;oplist]>
1334
1335=item B<backgroundPixmap:> I<file[;oplist]>
1336
1337Compile I<pixbuf>: Use the specified image file as the window's
1338background and also optionally specify a colon separated list of
1339operations to modify it. Note that you may need to quote the C<;>
1340character when using the command line option, as C<;> is usually a
1341metacharacter in shells. Supported operations are:
1342
1343=over 4
1344
1345=item B<WxH+X+Y>
1346
1347sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1348scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1349scale of 0 disables scaling.
1350
1351=item B<op=tile>
1352
1353enables tiling
1354
1355=item B<op=keep-aspect>
1356
1357maintain the image aspect ratio when scaling
1358
1359=item B<op=root-align>
1360
1361use the position of the terminal window relative to the root window as
1362the image offset, simulating a root window background
1363
1364=back
1365
1366The default scale and position setting is C<100x100+50+50>.
1367Alternatively, a predefined set of templates can be used to achieve
1368the most common setups:
1369
1370=over 4
1371
1372=item B<style=tiled>
1373
1374the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1375
1376=item B<style=aspect-stretched>
1377
1378the image is scaled to fill the whole window maintaining the aspect
1379ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1380
1381=item B<style=stretched>
1382
1383the image is scaled to fill the whole window. Equivalent to 100x100
1384
1385=item B<style=centered>
1386
1387the image is centered with no scaling. Equivalent to 0x0+50+50
1388
1389=item B<style=root-tiled>
1390
1391the image is tiled with no scaling and using 'root' positioning.
1392Equivalent to 0x0:op=tile:op=root-align
1393
1394=back
1395
1396If multiple templates are specified the last one wins. Note that a
1397template overrides all the scale, position and operations settings.
1398
1399If used in conjunction with pseudo-transparency, the specified pixmap
1400will be blended over the transparent background using alpha-blending.
1401
1402=item B<-tr>|B<+tr>
1403
1404=item B<transparent:> I<boolean>
1405
1406Turn on/off pseudo-transparency by using the root pixmap as background.
1407
1408B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1409will be removed in future versions.
1410
1411=item B<-tint> I<colour>
1412
1413=item B<tintColor:> I<colour>
1414
1415Tint the transparent background with the given colour. Note that a
1416black tint yields a completely black image while a white tint yields
1417the image unchanged.
1418
1419=item B<-sh> I<number>
1420
1421=item B<shading:> I<number>
1422
1423Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1424A value of 100 means no shading.
1425
1426=item B<-blr> I<HxV>
1427
1428=item B<blurRadius:> I<HxV>
1429
1430Apply gaussian blur with the specified radius to the transparent
1431background. If a single number is specified, the vertical and
1432horizontal radii are considered to be the same. Setting one of the
1433radii to 1 and the other to a large number creates interesting effects
1434on some backgrounds. The maximum radius value is 128. An horizontal or
1435vertical radius of 0 disables blurring.
1436
1437=item B<path:> I<path>
1438
1439Specify the colon-delimited search path for finding background image files.
740 1440
741=back 1441=back
742 1442
743=head1 THE SCROLLBAR 1443=head1 THE SCROLLBAR
744 1444
758the normal text selection/insertion, hold either the Shift or the Meta 1458the normal text selection/insertion, hold either the Shift or the Meta
759(Alt) key while performing the desired mouse action. 1459(Alt) key while performing the desired mouse action.
760 1460
761If mouse reporting mode is active, the normal scrollbar actions are 1461If mouse reporting mode is active, the normal scrollbar actions are
762disabled -- on the assumption that we are using a fullscreen 1462disabled -- on the assumption that we are using a fullscreen
763application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 1463application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
764(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 1464(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), 1465up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
766respectively. 1466respectively.
767 1467
768=head1 TEXT SELECTION AND INSERTION 1468=head1 THE SELECTION: SELECTING AND PASTING TEXT
769 1469
770The behaviour of text selection and insertion mechanism is similar to 1470The behaviour of text selection and insertion/pasting mechanism is similar
771I<xterm>(1). 1471to I<xterm>(1).
772 1472
773=over 4 1473=over 4
774 1474
775=item B<Selection>: 1475=item B<Selecting>:
776 1476
777Left click at the beginning of the region, drag to the end of the 1477Left 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 1478and release; Right click to extend the marked region; Left double-click
779double-click to select a word; Left triple-click to select the entire 1479to select a word; Left triple-click to select the entire logical line
780line. 1480(which can span multiple screen lines), unless modified by resource
1481B<tripleclickwords>.
781 1482
1483Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1484(Compile: I<frills>) will create a rectangular selection instead of a
1485normal one. In this mode, every selected row becomes its own line in the
1486selection, and trailing whitespace is visually underlined and removed from
1487the selection.
1488
782=item B<Insertion>: 1489=item B<Pasting>:
783 1490
784Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1491Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
785an B<@@RXVT_NAME@@> window causes the current text selection to be 1492window causes the value of the PRIMARY selection (or CLIPBOARD with the
786inserted as if it had been typed on the keyboard. 1493B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1494
1495Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1496inserted too.
1497
1498rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1499<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1500binding causes the value of the internal selection to be copied to the
1501CLIPBOARD selection, while the second binding causes the value of the
1502CLIPBOARD selection to be inserted.
787 1503
788=back 1504=back
789 1505
790=head1 CHANGING FONTS 1506=head1 CHANGING FONTS
791 1507
792Changing fonts (or font sizes, respectively) via the keypad is not yet 1508Changing fonts (or font sizes, respectively) via the keypad is not yet
793supported in rxvt-unicode. Bug me if you need this. 1509supported in rxvt-unicode. Bug me if you need this.
794 1510
795You can, however, switch fonts at runtime using escape sequences (and 1511You can, however, switch fonts at runtime using escape sequences, e.g.:
796therefore using the menubar), e.g.:
797 1512
798 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1513 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1514
1515You can use keyboard shortcuts, too:
1516
1517 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1518 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
799 1519
800rxvt-unicode will automatically re-apply these fonts to the output so far. 1520rxvt-unicode will automatically re-apply these fonts to the output so far.
801 1521
802=head1 ISO 14755 SUPPORT 1522=head1 ISO 14755 SUPPORT
803 1523
804ISO 14755 is a standard for entering and viewing unicode characters 1524ISO 14755 is a standard for entering and viewing unicode characters
805and character codes using the keyboard. It consists of 4 parts. The 1525and character codes using the keyboard. It consists of 4 parts. The
806first part is available rxvt-unicode has been compiled with 1526first part is available if rxvt-unicode has been compiled with
807C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1527C<--enable-frills>, the rest is available when rxvt-unicode was compiled
808with C<--enable-iso14755>. 1528with C<--enable-iso14755>.
809 1529
810=over 4 1530=over 4
811 1531
812=item 5.1: Basic method 1532=item * 5.1: Basic method
813 1533
814This allows you to enter unicode characters using their hexcode. 1534This allows you to enter unicode characters using their hexcode.
815 1535
816Start by pressing and holding both C<Control> and C<Shift>, then enter 1536Start 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 1537hex-digits (between one and six). Releasing C<Control> and C<Shift> will
824address, which you cannot type. Fortunately, the card has the e-mail 1544address, 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 1545address 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>, 1546by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
827followed by releasing the modifier keys. 1547followed by releasing the modifier keys.
828 1548
829=item 5.2: Keyboard symbols entry method 1549=item * 5.2: Keyboard symbols entry method
830 1550
831This mode lets you input characters representing the keycap symbols of 1551This mode lets you input characters representing the keycap symbols of
832your keyboard, if representable in the current locale encoding. 1552your keyboard, if representable in the current locale encoding.
833 1553
834Start by pressing C<Control> and C<Shift> together, then releasing 1554Start by pressing C<Control> and C<Shift> together, then releasing
835them. The next special key (cursor keys, home etc.) you enter will not 1555them. The next special key (cursor keys, home etc.) you enter will not
836invoke it's usual function but instead will insert the corresponding 1556invoke its usual function but instead will insert the corresponding
837keycap symbol. The symbol will only be entered when the key has been 1557keycap symbol. The symbol will only be entered when the key has been
838released, otherwise pressing e.g. C<Shift> would enter the symbol for 1558released, 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 1559C<ISO Level 2 Switch>, although your intention might have been to enter a
840reverse tab (Shift-Tab). 1560reverse tab (Shift-Tab).
841 1561
842=item 5.3: Screen-selection entry method 1562=item * 5.3: Screen-selection entry method
843 1563
844While this is implemented already (it's basically the selection 1564While this is implemented already (it's basically the selection
845mechanism), it could be extended by displaying a unicode character map. 1565mechanism), it could be extended by displaying a unicode character map.
846 1566
847=item 5.4: Feedback method for identifying displayed characters for later input 1567=item * 5.4: Feedback method for identifying displayed characters for later input
848 1568
849This method lets you display the unicode character code associated with 1569This method lets you display the unicode character code associated with
850characters already displayed. 1570characters already displayed.
851 1571
852You enter this mode by holding down C<Control> and C<Shift> together, then 1572You 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 1573pressing 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 1574hex code(s) (it might be a combining character) of the character under the
855pointer is displayed until you release C<Control> and C<Shift>. 1575pointer is displayed until you release C<Control> and C<Shift>.
856 1576
1577In addition to the hex codes it will display the font used to draw this
1578character - due to implementation reasons, characters combined with
1579combining characters, line drawing characters and unknown characters will
1580always be drawn using the built-in support font.
1581
857=back 1582=back
858 1583
859With respect to conformance, rxvt-unicode is supposed to be compliant to 1584With respect to conformance, rxvt-unicode is supposed to be compliant to
860both scenario A and B of ISO 14755, including part 5.2. 1585both scenario A and B of ISO 14755, including part 5.2.
861 1586
862=head1 LOGIN STAMP 1587=head1 LOGIN STAMP
863 1588
864B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so 1589B<@@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. 1590it 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 1591allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
867some systems. 1592on some systems or setgid to root or to some other group on others.
868 1593
869=head1 COLORS AND GRAPHICS 1594=head1 COLOURS AND GRAPHICS
870 1595
871In addition to the default foreground and background colours, 1596In addition to the default foreground and background colours,
872B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1597B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
873high-intensity bold/blink versions of the same). Here is a list of the 1598high-intensity (potentially bold/blink) versions of the same, and 72 (or
874colours with their B<rgb.txt> names. 1599240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1600cube plus a 8 (24) colour greyscale ramp.
1601
1602Here is a list of the ANSI colours with their names.
875 1603
876=begin table 1604=begin table
877 1605
878 B<color0> (black) = Black 1606 B<color0> (black) = Black
879 B<color1> (red) = Red3 1607 B<color1> (red) = Red3
899It is also possible to specify the colour values of B<foreground>, 1627It is also possible to specify the colour values of B<foreground>,
900B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1628B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
901a number 0-15, as a convenient shorthand to reference the colour name of 1629a number 0-15, as a convenient shorthand to reference the colour name of
902color0-color15. 1630color0-color15.
903 1631
1632The following text gives values for the standard 88 colour mode (and
1633values for the 256 colour mode in parentheses).
1634
1635The RGB cube uses indices 16..79 (16..231) using the following formulas:
1636
1637 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1638 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1639
1640The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1641steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1642the RGB cube.
1643
1644Together, all those colours implement the 88 (256) colour xterm
1645colours. Only the first 16 can be changed using resources currently, the
1646rest can only be changed via command sequences ("escape codes").
1647
1648Applications are advised to use terminfo or command sequences to discover
1649number and RGB values of all colours (yes, you can query this...).
1650
904Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1651Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
905always swapping the foreground/background colours. This is in contrast to 1652always swapping the foreground/background colours. This is in contrast to
906I<xterm>(1) where the colours are only swapped if they have not otherwise 1653I<xterm>(1) where the colours are only swapped if they have not otherwise
907been specified. For example, 1654been specified. For example,
908 1655
1656 @@RXVT_NAME@@ -fg Black -bg White -rv
1657
1658would yield White on Black, while on I<xterm>(1) it would yield Black on
1659White.
1660
1661=head2 ALPHA CHANNEL SUPPORT
1662
1663If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1664their act together, rxvt-unicode will do its own alpha channel management:
1665
1666You can prefix any colour with an opaqueness percentage enclosed in
1667brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1668(0-100) that specifies the opacity of the colour, where C<0> is completely
1669transparent and C<100> is completely opaque. For example, C<[50]red> is a
1670half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1671is the recommended format to specify transparency values, and works with
1672all ways to specify a colour.
1673
1674For complete control, rxvt-unicode also supports
1675C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1676specifications, where the additional C<aaaa> component specifies opacity
1677(alpha) values. The minimum value of C<0000> is completely transparent,
1678while C<ffff> is completely opaque). The two example colours from
1679earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1680C<rgba:0000/ff00/0000/f332>.
1681
1682You probably need to specify B<"-depth 32">, too, to force a visual with
1683alpha channels, and have the luck that your X-server uses ARGB pixel
1684layout, as X is far from just supporting ARGB visuals out of the box, and
1685rxvt-unicode just fudges around.
1686
1687For example, the following selects an almost completely transparent black
1688background, and an almost opaque pink foreground:
1689
1690 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1691
1692When not using a background image, then the interpretation of the
1693alpha channel is up to your compositing manager (most interpret it as
1694transparency of course).
1695
1696When using a background pixmap or pseudo-transparency, then the background
1697colour will always behave as if it were completely transparent (so the
1698background image shows instead), regardless of how it was specified, while
1699other colours will either be transparent as specified (the background
1700image will show through) on servers supporting the RENDER extension, or
1701fully opaque on servers not supporting the RENDER EXTENSION.
1702
1703Please note that due to bugs in Xft, specifying alpha values might result
1704in garbage being displayed when the X-server does not support the RENDER
1705extension.
1706
1707=head1 ENVIRONMENT
1708
1709B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1710
909=over 4 1711=over 4
910 1712
911=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1713=item B<TERM>
912 1714
913would yield White on Black, while on I<xterm>(1) it would yield Black 1715Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
914on White. 1716resources or on the command line.
1717
1718=item B<COLORTERM>
1719
1720Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1721compiled with background image support, and optionally with the added
1722extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1723screen.
1724
1725=item B<COLORFGBG>
1726
1727Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1728the colour code used as default foreground/text colour (or the string
1729C<default> to indicate that the default-colour escape sequence is to be
1730used), C<bg> is the colour code used as default background colour (or the
1731string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1732was compiled with background image support. Libraries like C<ncurses>
1733and C<slang> can (and do) use this information to optimize screen output.
1734
1735=item B<WINDOWID>
1736
1737Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1738window, which usually has subwindows for the scrollbar, the terminal
1739window and so on).
1740
1741=item B<TERMINFO>
1742
1743Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1744C<--with-terminfo=PATH>.
1745
1746=item B<DISPLAY>
1747
1748Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1749display in its child processes if C<-display> isn't used to override. It
1750defaults to C<:0> if it doesn't exist.
1751
1752=item B<SHELL>
1753
1754The shell to be used for command execution, defaults to C</bin/sh>.
1755
1756=item B<RXVT_SOCKET> [I<sic>]
1757
1758The unix domain socket path used by @@RXVT_NAME@@c(1) and
1759@@RXVT_NAME@@d(1).
1760
1761Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1762
1763=item B<URXVT_PERL_LIB>
1764
1765Additional F<:>-separated library search path for perl extensions. Will be
1766searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1767directory.
1768
1769=item B<URXVT_PERL_VERBOSITY>
1770
1771See L<@@RXVT_NAME@@perl>(3).
1772
1773=item B<HOME>
1774
1775Used to locate the default directory for the unix domain socket for
1776daemon communications and to locate various resource files (such as
1777C<.Xdefaults>)
1778
1779=item B<XAPPLRESDIR>
1780
1781Directory where application-specific X resource files are located.
1782
1783=item B<XENVIRONMENT>
1784
1785If set and accessible, gives the name of a X resource file to be loaded by
1786@@RXVT_NAME@@.
915 1787
916=back 1788=back
917 1789
918=head1 FREQUENTLY ASKED QUESTIONS (FAQ) 1790=head1 FILES
919 1791
920=over 4 1792=over 4
921 1793
922=item How do I know which rxvt-unicode version I'm using? 1794=item B</usr/lib/X11/rgb.txt>
923 1795
924The version number is displayed with the usage (-h). For rxvt-unicode 1796Colour names.
925version 2.14 and later, the escape sequence C<ESC[8n> sets the window
926title to the version number.
927
928=item Rxvt-unicode does not seem to understand the selected encoding?
929
930=item Unicode does not seem to work?
931
932If you encounter strange problems like typing an accented character but
933getting two unrelated other characters or similar, or if program output is
934subtly garbled, then you should check your locale settings.
935
936Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
937programs. Often rxvt-unicode is started in the C<C> locale, while the
938login script running within the rxvt-unicode window changes the locale to
939sth. else, e.h. C<en_GB.UTF-8>. Needless to say, this is not going to work.
940
941The best thing is to fix your startup environment, as you will likely run
942into other problems. If nothing works you can try this in your .profile.
943
944 printf '\e]701;%s\007' "$LC_CTYPE"
945
946If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
947supported on your systems. Some systems have a C<locale> comamnd which
948displays this. If it displays sth. like:
949
950 locale: Cannot set LC_CTYPE to default locale: ...
951
952Then the locale you specified is not supported on your system.
953
954If nothing works and you are sure that everything is set correctly then
955you will need to remember a little known fact: Some programs just don't
956support locales :(
957
958=item Why do the characters look ugly?
959
960=item How does rxvt-unicode choose fonts?
961
962Most fonts do not contain the full range of Unicode, which is
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
967B<rxvt-unicode> makes a best-effort try at finding a replacement
968font. Often the result is fine, but sometimes the chosen font looks
969bad. In that case, select a font of your taste and add it to the font
970list, e.g.:
971
972 @@RXVT_NAME@@ -fn basefont,font2,font3...
973
974When rxvt-unicode sees a character, it will first look at the base
975font. If the base font does not contain the character, it will go to the
976next font, and so on.
977
978The only limitation is that all the fonts must not be larger than the base
979font, as the base font defines the principial cell size, which must be the
980same due to the way terminals work.
981
982=item Why do some chinese characters look so different than others?
983
984This is because there is a difference between script and language --
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
994The workaround is easy: just tag a chinese font at the end of your font
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
999In the future it might be possible to switch preferences at runtime (the
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@@
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 1797
1277=back 1798=back
1278 1799
1279=head1 ENVIRONMENT 1800=head1 SEE ALSO
1280 1801
1281B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> 1802@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1282and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X 1803@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
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 1804
1288=head1 FILES 1805=head1 CURRENT PROJECT COORDINATOR
1289 1806
1290=over 4 1807=over 4
1291 1808
1292=item B</etc/utmp> 1809=item Project Coordinator
1293 1810
1294System file for login records. 1811Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1295 1812
1296=item B</usr/lib/X11/rgb.txt> 1813L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1297
1298Color names.
1299 1814
1300=back 1815=back
1301 1816
1302=head1 SEE ALSO 1817=head1 AUTHORS
1303
1304@@RXVT_NAME@@(7), 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
1314=head1 CURRENT PROJECT COORDINATOR
1315 1818
1316=over 4 1819=over 4
1317 1820
1318=item Project Coordinator 1821=item John Bovey
1319 1822
1320@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1823University of Kent, 1992, wrote the original Xvt.
1321 1824
1322=item Web page maintainter 1825=item Rob Nation <nation@rocket.sanders.lockheed.com>
1323 1826
1324@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@> 1827very heavily modified Xvt and came up with Rxvt
1325 1828
1326L<@@RXVT_WEBPAGE@@> 1829=item Angelo Haritsis <ah@doc.ic.ac.uk>
1830
1831wrote the Greek Keyboard Input (no longer in code)
1832
1833=item mj olesen <olesen@me.QueensU.CA>
1834
1835Wrote the menu system.
1836
1837Project Coordinator (changes.txt 2.11 to 2.21)
1838
1839=item Oezguer Kesim <kesim@math.fu-berlin.de>
1840
1841Project Coordinator (changes.txt 2.21a to 2.4.5)
1842
1843=item Geoff Wing <gcw@pobox.com>
1844
1845Rewrote screen display and text selection routines.
1846
1847Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1848
1849=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1850
1851Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1852extension, random hacks, numerous bugfixes and extensions.
1853
1854Project Coordinator (Changes 1.0 -)
1855
1856=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1857
1858pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1327 1859
1328=back 1860=back
1329 1861
1330=head1 AUTHORS
1331
1332=over 4
1333
1334=item John Bovey
1335
1336University of Kent, 1992, wrote the original Xvt.
1337
1338=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>
1339
1340very heavily modified Xvt and came up with Rxvt
1341
1342=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>
1343
1344wrote the Greek Keyboard Input (no longer in code)
1345
1346=item mj olesen L<< <olesen@me.QueensU.CA> >>
1347
1348Wrote the menu system.
1349
1350Project Coordinator (changes.txt 2.11 to 2.21)
1351
1352=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>
1353
1354Project Coordinator (changes.txt 2.21a to 2.4.5)
1355
1356=item Geoff Wing L<< <gcw@pobox.com> >>
1357
1358Rewrote screen display and text selection routines. Project Coordinator
1359(changes.txt 2.4.6 - rxvt-unicode)
1360
1361=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>
1362
1363Forked rxvt-unicode, rewrote most of the display code and internal
1364character handling to store text in unicode, improve xterm
1365compatibility and apply numerous other bugfixes and extensions.
1366
1367Project Coordinator (Changes 1.0 -)
1368
1369=back
1370

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines