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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines