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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines