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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines