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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines