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.73 by root, Thu Dec 15 18:14:08 2005 UTC vs.
Revision 1.164 by root, Sun Jun 15 13:54:15 2008 UTC

12emulator intended as an I<xterm>(1) replacement for users who do not 12emulator intended as an I<xterm>(1) replacement for users who do not
13require features such as Tektronix 4014 emulation and toolkit-style 13require features such as Tektronix 4014 emulation and toolkit-style
14configurability. As a result, B<rxvt-unicode> uses much less swap space -- 14configurability. As a result, B<rxvt-unicode> uses much less swap space --
15a significant advantage on a machine serving many X sessions. 15a significant advantage on a machine serving many X sessions.
16 16
17This document is also available on the World-Wide-Web at
18L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
19
17=head1 FREQUENTLY ASKED QUESTIONS 20=head1 FREQUENTLY ASKED QUESTIONS
18 21
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of 22See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20frequently asked questions and answer to them and some common 23frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at 24problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 25L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23 26
24=head1 RXVT-UNICODE VS. RXVT 27=head1 RXVT-UNICODE VS. RXVT
25 28
26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 29Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27internally. That means it can store and display most scripts in the 30internally. That means it can store and display most scripts in the
28world. Being a terminal emulator, however, some things are very difficult, 31world. Being a terminal emulator, however, some things are very difficult,
29especially cursive scripts such as arabic, vertically written scripts 32especially cursive scripts such as arabic, vertically written scripts
30like mongolian or scripts requiring extremely complex combining rules, 33like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devenagari. Don't expect pretty output when using these 34like tibetan or devanagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 35scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are left-to-right scripts, such 36fine, though. A somewhat difficult case are right-to-left scripts, such
34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 37as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35belong into the application, not the terminal emulator (too many things -- 38belong in the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 39such as cursor-movement while editing -- break otherwise), but that might
37change. 40change.
38 41
39If you are looking for a terminal that supports more exotic scripts, let 42If you are looking for a terminal that supports more exotic scripts, let
40me recommend C<mlterm>, which is a very userfriendly, lean and clean 43me recommend C<mlterm>, which is a very user friendly, lean and clean
41terminal emulator. In fact, the reason rxvt-unicode was born was solely 44terminal emulator. In fact, the reason rxvt-unicode was born was solely
42because the author couldn't get C<mlterm> to use one font for latin1 and 45because the author couldn't get C<mlterm> to use one font for latin1 and
43another for japanese. 46another for japanese.
44 47
45Therefore another design rationale was the use of multiple fonts to 48Therefore another design rationale was the use of multiple fonts to
46display characters: The idea of a single unicode font which many other 49display characters: The idea of a single unicode font which many other
47programs force onto it's users never made sense to me: You should be able 50programs force onto its users never made sense to me: You should be able
48to choose any font for any script freely. 51to choose any font for any script freely.
49 52
50Apart from that, rxvt-unicode is also much better internationalised than 53Apart from that, rxvt-unicode is also much better internationalised than
51it's predecessor, supports things such as XFT and ISO 14755 that are handy 54its predecessor, supports things such as XFT and ISO 14755 that are handy
52in i18n-environments, is faster, and has a lot less bugs than the original 55in i18n-environments, is faster, and has a lot bugs less than the original
53rxvt. This all in addition to dozens of other small improvements. 56rxvt. This all in addition to dozens of other small improvements.
54 57
55It is still faithfully following the original rxvt idea of being lean 58It is still faithfully following the original rxvt idea of being lean
56and nice on resources: for example, you can still configure rxvt-unicode 59and nice on resources: for example, you can still configure rxvt-unicode
57without most of it's features to get a lean binary. It also comes with 60without most of its features to get a lean binary. It also comes with
58a client/daemon pair that lets you open any number of terminal windows 61a client/daemon pair that lets you open any number of terminal windows
59from within a single process, which makes startup time very fast and 62from within a single process, which makes startup time very fast and
60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 63drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61@@RXVT_NAME@@c(1) (client). 64@@RXVT_NAME@@c(1) (client).
62 65
63It also makes technical information about escape sequences (which have 66It also makes technical information about escape sequences (which have
64been extended) easier accessible: see @@RXVT_NAME@@(7) for technical 67been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65reference documentation (escape sequences etc.). 68reference documentation (escape sequences etc.).
66 69
67=head1 OPTIONS 70=head1 OPTIONS
68 71
69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed 72The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
89 92
90Print out a message describing available options. 93Print out a message describing available options.
91 94
92=item B<-display> I<displayname> 95=item B<-display> I<displayname>
93 96
94Attempt to open a window on the named X display (B<-d> still 97Attempt to open a window on the named X display (the older form B<-d>
95respected). In the absence of this option, the display specified by the 98is still respected. but deprecated). In the absence of this option, the
96B<DISPLAY> environment variable is used. 99display specified by the B<DISPLAY> environment variable is used.
100
101=item B<-depth> I<bitdepth>
102
103Compile I<xft>: 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]
97 110
98=item B<-geometry> I<geom> 111=item B<-geometry> I<geom>
99 112
100Window geometry (B<-g> still respected); resource B<geometry>. 113Window geometry (B<-g> still respected); resource B<geometry>.
101 114
103 116
104Turn on/off simulated reverse video; resource B<reverseVideo>. 117Turn on/off simulated reverse video; resource B<reverseVideo>.
105 118
106=item B<-j>|B<+j> 119=item B<-j>|B<+j>
107 120
108Turn on/off jump scrolling; resource B<jumpScroll>. 121Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
109 122
110=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 123=item B<-ss>|B<+ss>
111 124
112Turn on/off inheriting parent window's pixmap. Alternative form is 125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
113B<-tr>; resource B<inheritPixmap>. 126
127=item B<-tr>|B<+tr>
128
129Turn on/off illusion of a transparent window background; resource B<transparent>.
130
131B<-ip> is still accepted as an obsolete alias but will be removed in
132future versions.
133
134I<Please address all transparency related issues to Sasha Vasko at
135sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
114 136
115=item B<-fade> I<number> 137=item B<-fade> I<number>
116 138
117Fade the text by the given percentage when focus is lost. Small values 139Fade the text by the given percentage when focus is lost. Small values
118fade a little only, 100 completely replaces all colours by the fade 140fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>. 141colour; resource B<fading>.
120 142
121=item B<-fadecolor> I<colour> 143=item B<-fadecolor> I<colour>
122 144
123Fade to this colour when fading is used (see B<-fade>). The default colour 145Fade to this colour when fading is used (see B<-fade>). The default colour
124is black. resource B<fadeColor>. 146is opaque black. resource B<fadeColor>.
125 147
126=item B<-tint> I<colour> 148=item B<-tint> I<colour>
127 149
128Tint the transparent background pixmap with the given colour when 150Tint the transparent background pixmap with the given colour when
129transparency is enabled with B<-tr> or B<-ip>. This only works for 151transparency is enabled with B<-tr>. This only works for
130non-tiled backgrounds, currently. See also the B<-sh> option that can be 152non-tiled backgrounds, currently. See also the B<-sh> option that can be
131used to brighten or darken the image in addition to tinting it; resource 153used to brighten or darken the image in addition to tinting it.
154Please note that certain tint colours can be applied on the server-side,
155thus yielding performance gain of two orders of magnitude. These colours are:
156blue, red, green, cyan, magenta, yellow, and those close to them. Also
157pure black and pure white colors essentially mean no tinting; resource
132I<tintColor>. Example: 158I<tintColor>. Example:
133 159
134 @@RXVT_NAME@@ -tr -tint blue -sh 40 160 @@RXVT_NAME@@ -tr -tint blue -sh 40
135 161
136=item B<-sh> 162=item B<-sh> I<number>
137 163
138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 164Darken (0 .. 100) or lighten (100 .. 200) the transparent
139background image in addition to tinting it (i.e. B<-tint> must be 165background image in addition to (or instead of) tinting it;
140specified, too, e.g. C<-tint white>). 166resource I<shading>.
167
168=item B<-blt> I<string>
169
170Specify background blending type. If background pixmap is specified
171at the same time as transparency - such pixmap will be blended over
172transparency image, using method specified. Supported values are :
173B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
174B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
175B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
176alpha-blending. Compile I<afterimage>; resource I<blendType>.
177
178=item B<-blr> I<HxV>
179
180Apply Gaussian Blur with the specified radii to the transparent
181background image. If single number is specified - both vertical and
182horizontal radii are considered to be the same. Setting one of the
183radii to 1 and another to a large number creates interesting effects
184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
185resource I<blurRadius>.
141 186
142=item B<-bg> I<colour> 187=item B<-bg> I<colour>
143 188
144Window background colour; resource B<background>. 189Window background colour; resource B<background>.
145 190
146=item B<-fg> I<colour> 191=item B<-fg> I<colour>
147 192
148Window foreground colour; resource B<foreground>. 193Window foreground colour; resource B<foreground>.
149 194
150=item B<-pixmap> I<file[;geom]> 195=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
151 196
152Compile I<XPM>: Specify XPM file for the background and also optionally 197Compile I<afterimage>: Specify image file for the background and also
153specify its scaling with a geometry string. Note you may need to 198optionally specify its scaling with a geometry string. Note you may need to
154add quotes to avoid special shell interpretation of the C<;> in the 199add quotes to avoid special shell interpretation of the C<;> in the
155command-line; resource B<backgroundPixmap>. 200command-line; for more details see resource B<backgroundPixmap>.
156 201
157=item B<-cr> I<colour> 202=item B<-cr> I<colour>
158 203
159The cursor colour; resource B<cursorColor>. 204The cursor colour; resource B<cursorColor>.
160 205
172resource B<borderColor>. 217resource B<borderColor>.
173 218
174=item B<-fn> I<fontlist> 219=item B<-fn> I<fontlist>
175 220
176Select the fonts to be used. This is a comma separated list of font names 221Select the fonts to be used. This is a comma separated list of font names
177that are used in turn when trying to display Unicode characters. The 222that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 223first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 224smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 225font list is always appended to it. See resource B<font> for more details.
181 226
182In short, to specify an X11 core font, just specify it's name or prefix it 227In short, to specify an X11 core font, just specify its name or prefix it
183with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, 228with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184e.g.: 229e.g.:
185 230
186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 231 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 232 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
189See also the question "How does rxvt-unicode choose fonts?" in the FAQ 234See also the question "How does rxvt-unicode choose fonts?" in the FAQ
190section of @@RXVT_NAME@@(7). 235section of @@RXVT_NAME@@(7).
191 236
192=item B<-fb> I<fontlist> 237=item B<-fb> I<fontlist>
193 238
194Compile font-styles: The bold font list to use when bold characters are to 239Compile I<font-styles>: The bold font list to use when B<bold> characters
195be printed. See resource B<boldFont> for details. 240are to be printed. See resource B<boldFont> for details.
196 241
197=item B<-fi> I<fontlist> 242=item B<-fi> I<fontlist>
198 243
199Compile font-styles: The italic font list to use when bold characters are to 244Compile I<font-styles>: The italic font list to use when I<italic>
200be printed. See resource B<italicFont> for details. 245characters are to be printed. See resource B<italicFont> for details.
201 246
202=item B<-fbi> I<fontlist> 247=item B<-fbi> I<fontlist>
203 248
204Compile font-styles: The bold italic font list to use when bold characters are to 249Compile I<font-styles>: The bold italic font list to use when B<< I<bold
205be printed. See resource B<boldItalicFont> for details. 250italic> >> characters are to be printed. See resource B<boldItalicFont>
251for details.
252
253=item B<-is>|B<+is>
254
255Compile I<font-styles>: Bold/Blink font styles imply high intensity
256foreground/background (default). See resource B<intensityStyles> for
257details.
206 258
207=item B<-name> I<name> 259=item B<-name> I<name>
208 260
209Specify the application name under which resources are to be obtained, 261Specify the application name under which resources are to be obtained,
210rather than the default executable file name. Name should not contain 262rather than the default executable file name. Name should not contain
226 278
227=item B<-sb>|B<+sb> 279=item B<-sb>|B<+sb>
228 280
229Turn on/off scrollbar; resource B<scrollBar>. 281Turn on/off scrollbar; resource B<scrollBar>.
230 282
283=item B<-sr>|B<+sr>
284
285Put scrollbar on right/left; resource B<scrollBar_right>.
286
287=item B<-st>|B<+st>
288
289Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
290resource B<scrollBar_floating>.
291
231=item B<-si>|B<+si> 292=item B<-si>|B<+si>
232 293
233Turn on/off scroll-to-bottom on TTY output inhibit; resource 294Turn on/off scroll-to-bottom on TTY output inhibit; resource
234B<scrollTtyOutput> has opposite effect. 295B<scrollTtyOutput> has opposite effect.
235 296
241=item B<-sw>|B<+sw> 302=item B<-sw>|B<+sw>
242 303
243Turn on/off scrolling with the scrollback buffer as new lines appear. 304Turn on/off scrolling with the scrollback buffer as new lines appear.
244This only takes effect if B<-si> is also given; resource 305This only takes effect if B<-si> is also given; resource
245B<scrollWithBuffer>. 306B<scrollWithBuffer>.
246
247=item B<-sr>|B<+sr>
248
249Put scrollbar on right/left; resource B<scrollBar_right>.
250
251=item B<-st>|B<+st>
252
253Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
254resource B<scrollBar_floating>.
255 307
256=item B<-ptab>|B<+ptab> 308=item B<-ptab>|B<+ptab>
257 309
258If enabled (default), "Horizontal Tab" characters are being stored as 310If enabled (default), "Horizontal Tab" characters are being stored as
259actual wide characters in the screen buffer, which makes it possible to 311actual wide characters in the screen buffer, which makes it possible to
290 342
291Compile I<frills>: Set MWM hints to request a borderless window, i.e. 343Compile I<frills>: Set MWM hints to request a borderless window, i.e.
292if honoured by the WM, the rxvt-unicode window will not have window 344if honoured by the WM, the rxvt-unicode window will not have window
293decorations; resource B<borderLess>. 345decorations; resource B<borderLess>.
294 346
347=item B<-override-redirect>
348
349Compile I<frills>: Sets override-redirect on the window; resource
350B<override-redirect>.
351
352=item B<-sbg>
353
354Compile I<frills>: Disable the usage of the built-in block graphics/line
355drawing characters and just rely on what the specified fonts provide. Use
356this if you have a good font and want to use its block graphic glyphs;
357resource B<skipBuiltinGlyphs>.
358
295=item B<-lsp> I<number> 359=item B<-lsp> I<number>
296 360
297Compile I<frills>: Lines (pixel height) to insert between each row of 361Compile I<frills>: Lines (pixel height) to insert between each row of
298the display. Useful to work around font rendering problems; resource 362the display. Useful to work around font rendering problems; resource
299B<linespace>. 363B<lineSpace>.
300 364
301=item B<-tn> I<termname> 365=item B<-tn> I<termname>
302 366
303This option specifies the name of the terminal type to be set in the 367This option specifies the name of the terminal type to be set in the
304B<TERM> environment variable. This terminal type must exist in the 368B<TERM> environment variable. This terminal type must exist in the
313given on the command line. If this option is used, it must be the last 377given on the command line. If this option is used, it must be the last
314on the command-line. If there is no B<-e> option then the default is to 378on the command-line. If there is no B<-e> option then the default is to
315run the program specified by the B<SHELL> environment variable or, 379run the program specified by the B<SHELL> environment variable or,
316failing that, I<sh(1)>. 380failing that, I<sh(1)>.
317 381
382Please note that you must specify a program with arguments. If you want to
383run shell commands, you have to specify the shell, like this:
384
385 @@RXVT_NAME@@ -e sh -c "shell commands"
386
318=item B<-title> I<text> 387=item B<-title> I<text>
319 388
320Window title (B<-T> still respected); the default title is the basename 389Window title (B<-T> still respected); the default title is the basename
321of the program specified after the B<-e> option, if any, otherwise the 390of the program specified after the B<-e> option, if any, otherwise the
322application name; resource B<title>. 391application name; resource B<title>.
353for more info. 422for more info.
354 423
355=item B<-tcw> 424=item B<-tcw>
356 425
357Change the meaning of triple-click selection with the left mouse 426Change the meaning of triple-click selection with the left mouse
427button. Only effective when the original (non-perl) selection code is
358button. Instead of selecting a full line it will extend the selection the 428in-use. Instead of selecting a full line it will extend the selection to
359end of the logical line only. resource B<tripleclickwords>. 429the end of the logical line only. resource B<tripleclickwords>.
360 430
361=item B<-insecure> 431=item B<-insecure>
362 432
363Enable "insecure" mode, which currently enables most of the escape 433Enable "insecure" mode, which currently enables most of the escape
364sequences that echo strings. See the resource B<insecure> for more 434sequences that echo strings. See the resource B<insecure> for more
378=item B<-ssr>|B<+ssr> 448=item B<-ssr>|B<+ssr>
379 449
380Turn on/off secondary screen scroll (default enabled); resource 450Turn on/off secondary screen scroll (default enabled); resource
381B<secondaryScroll>. 451B<secondaryScroll>.
382 452
453=item B<-hold>|B<+hold>
454
455Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
456will not immediately destroy its window when the program executed within
457it exits. Instead, it will wait till it is being killed or closed by the
458user; resource B<hold>.
459
460=item B<-cd> I<path>
461
462Sets the working directory for the shell (or the command specified via
463B<-e>). The I<path> must be an absolute path and it must exist for
464@@RXVT_NAME@@ to start; resource B<chdir>.
465
466=item B<-xrm> I<string>
467
468Works like the X Toolkit option of the same name, by adding the I<string>
469as if it were specified in a resource file. Resource values specified this
470way take precedence over all other resource specifications.
471
472Note that you need to use the I<same> syntax as in the .Xdefaults file,
473e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
474options can be specified as long-options on the commandline, so use
475of B<-xrm> is mostly limited to cases where you want to specify other
476resources (e.g. for input methods) or for compatibility with other
477programs.
478
383=item B<-keysym.>I<sym> I<string> 479=item B<-keysym.>I<sym> I<string>
384 480
385Remap a key symbol. See resource B<keysym>. 481Remap a key symbol. See resource B<keysym>.
386 482
387=item B<-embed> I<windowid> 483=item B<-embed> I<windowid>
388 484
389Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 485Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
390which enables applications to easily embed a terminal. 486which enables applications to easily embed a terminal.
391 487
392Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 488Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
393shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 489shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
394quite a bit, so don't expect it to keep some specific state. It's best to 490quite a bit, so don't expect it to keep some specific state. It's best to
397The window will not be destroyed when @@RXVT_NAME@@ exits. 493The window will not be destroyed when @@RXVT_NAME@@ exits.
398 494
399It might be useful to know that @@RXVT_NAME@@ will not close file 495It might be useful to know that @@RXVT_NAME@@ will not close file
400descriptors passed to it (except for stdin/out/err, of course), so you 496descriptors passed to it (except for stdin/out/err, of course), so you
401can use file descriptors to communicate with the programs within the 497can use file descriptors to communicate with the programs within the
402terminal. This works regardless of wether the C<-embed> option was used or 498terminal. This works regardless of whether the C<-embed> option was used or
403not. 499not.
404 500
405Here is a short Gtk2-perl snippet that illustrates how this option can be 501Here is a short Gtk2-perl snippet that illustrates how this option can be
406used (a longer example is in F<doc/embed>): 502used (a longer example is in F<doc/embed>):
407 503
409 $rxvt->signal_connect_after (realize => sub { 505 $rxvt->signal_connect_after (realize => sub {
410 my $xid = $_[0]->window->get_xid; 506 my $xid = $_[0]->window->get_xid;
411 system "@@RXVT_NAME@@ -embed $xid &"; 507 system "@@RXVT_NAME@@ -embed $xid &";
412 }); 508 });
413 509
414=item B<-pty-fd> I<fileno> 510=item B<-pty-fd> I<file descriptor>
415 511
416Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 512Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
417pair but instead use the given filehandle as the tty master. This is 513pair but instead use the given file descriptor as the tty master. This is
418useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 514useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
419without having to run a program within it. 515without having to run a program within it.
420 516
421If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 517If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
422entries and will not tinker with pty/tty permissions - you have to do that 518entries and will not tinker with pty/tty permissions - you have to do that
423yourself if you want that. 519yourself if you want that.
520
521As an extremely special case, specifying C<-1> will completely suppress
522pty/tty operations, which is probably only useful in conjunction with some
523perl extension that manages the terminal.
424 524
425Here is a example in perl that illustrates how this option can be used (a 525Here is a example in perl that illustrates how this option can be used (a
426longer example is in F<doc/pty-fd>): 526longer example is in F<doc/pty-fd>):
427 527
428 use IO::Pty; 528 use IO::Pty;
435 535
436 # now communicate with rxvt 536 # now communicate with rxvt
437 my $slave = $pty->slave; 537 my $slave = $pty->slave;
438 while (<$slave>) { print $slave "got <$_>\n" } 538 while (<$slave>) { print $slave "got <$_>\n" }
439 539
540=item B<-pe> I<string>
541
542Comma-separated list of perl extension scripts to use (or not to use) in
543this terminal instance. See resource B<perl-ext> for details.
544
440=back 545=back
441 546
442=head1 RESOURCES (available also as long-options) 547=head1 RESOURCES
443 548
444Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 549Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
445options) compiled into your version. 550options) compiled into your version. All resources are also available as
551long-options.
446 552
447There are two different methods that @@RXVT_NAME@@ can use to get the 553You can set and change the resources using X11 tools like B<xrdb>. Many
448Xresource data: using the X libraries (Xrm*-functions) or internal 554distribution do also load settings from the B<~/.Xresources> file when X
449Xresources reader (B<~/.Xdefaults>). For the first method (ie. 555starts. @@RXVT_NAME@@ will consult the following files/resources in order,
450B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 556with later settings overwriting earlier ones:
451resources using X11 tools like B<xrdb>. Many distribution do also load
452settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
453will consult the following files/resources in order, with later settings
454overwriting earlier ones:
455 557
456 1. system-wide app-defaults file, either locale-dependent OR global 558 1. system-wide app-defaults file, either locale-dependent OR global
457 2. app-defaults file in $XAPPLRESDIR 559 2. app-defaults file in $XAPPLRESDIR
458 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 560 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
459 4. SCREEN_RESOURCES for the current screen 561 4. SCREEN_RESOURCES for the current screen
460 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 562 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
563 6. resources specified via -xrm on the commandline
461 564
462If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
463lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
464set in XAPPLOADDIR/URxvt (compile-time defined: usually
465B</usr/lib/X11/app-defaults/URxvt>) and resources set in
466B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
467Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 565Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
468class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 566names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
469resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 567common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
470easily configured, while the class name B<URxvt> allows resources 568configured, while the class name B<URxvt> allows resources unique to
471unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 569B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
472shared between different B<@@RXVT_NAME@@> configurations. If no 570configurations. If no resources are specified, suitable defaults will
473resources are specified, suitable defaults will be used. Command-line 571be used. Command-line arguments can be used to override resource
474arguments can be used to override resource settings. The following 572settings. The following resources are supported (you might want to
475resources are allowed: 573check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
574extensions not documented here):
476 575
477=over 4 576=over 4
577
578=item B<depth:> I<bitdepth>
579
580Compile I<xft>: Attempt to find a visual with the given bit depth;
581option B<-depth>.
582
583=item B<buffered:> I<boolean>
584
585Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
586On some card/driver combination enabling it slightly decreases
587performance, on most it greatly helps it. The slowdown is small, so it
588should normally be enabled.
478 589
479=item B<geometry:> I<geom> 590=item B<geometry:> I<geom>
480 591
481Create the window with the specified X window geometry [default 80x24]; 592Create the window with the specified X window geometry [default 80x24];
482option B<-geometry>. 593option B<-geometry>.
519Use the specified colour to display underlined characters when the 630Use the specified colour to display underlined characters when the
520foreground colour is the default. 631foreground colour is the default.
521 632
522=item B<colorRV:> I<colour> 633=item B<colorRV:> I<colour>
523 634
524Use the specified colour as the background for reverse video 635Use the specified colour as the background for reverse video characters
525characters. 636when OPTION_HC is disabled (--disable-frills).
526 637
527=item B<underlineColor:> I<colour> 638=item B<underlineColor:> I<colour>
528 639
529If set, use the specified colour as the colour for the underline 640If set, use the specified colour as the colour for the underline
530itself. If unset, use the foreground colour. 641itself. If unset, use the foreground colour.
546option B<-rv>. B<False>: regular screen colours [default]; option 657option B<-rv>. B<False>: regular screen colours [default]; option
547B<+rv>. See note in B<COLORS AND GRAPHICS> section. 658B<+rv>. See note in B<COLORS AND GRAPHICS> section.
548 659
549=item B<jumpScroll:> I<boolean> 660=item B<jumpScroll:> I<boolean>
550 661
551B<True>: specify that jump scrolling should be used. When scrolling 662B<True>: specify that jump scrolling should be used. When receiving lots
552quickly, fewer screen updates are performed [default]; option B<-j>. 663of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
664has been read, resulting in fewer updates while still displaying every
665received line; option B<-j>.
666
553B<False>: specify that smooth scrolling should be used; option B<+j>. 667B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
668force a screen refresh on each new line it received; option B<+j>.
554 669
555=item B<inheritPixmap:> I<boolean> 670=item B<skipScroll:> I<boolean>
556 671
557B<True>: make the background inherit the parent windows' pixmap, giving 672B<True>: (the default) specify that skip scrolling should be used. When
558artificial transparency. B<False>: do not inherit the parent windows' 673receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
559pixmap. 674(around 60 times per second), resulting in far fewer updates. This can
675result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
676option B<-ss>.
677
678B<False>: specify that everything is to be displayed, even
679if the refresh is too fast for the human eye to read anything (or the
680monitor to display anything); option B<+ss>.
681
682=item B<transparent:> I<boolean>
683
684Turn on/off illusion of a transparent window background.
685
686B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
687future versions.
688
689I<Please address all transparency related issues to Sasha Vasko at
690sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
560 691
561=item B<fading:> I<number> 692=item B<fading:> I<number>
562 693
563Fade the text by the given percentage when focus is lost; option B<-fade>. 694Fade the text by the given percentage when focus is lost; option B<-fade>.
564 695
572Tint the transparent background pixmap with the given colour; option 703Tint the transparent background pixmap with the given colour; option
573B<-tint>. 704B<-tint>.
574 705
575=item B<shading:> I<number> 706=item B<shading:> I<number>
576 707
577Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 708Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
578image in addition to tinting it. 709in addition to tinting it; option B<-sh>.
710
711=item B<blendType:> I<string>
712
713Specify background blending type; option B<-blt>.
714
715=item B<blurRadius:> I<number>
716
717Apply Gaussian Blurr with the specified radius to the transparent
718background image; option B<-blr>.
579 719
580=item B<scrollColor:> I<colour> 720=item B<scrollColor:> I<colour>
581 721
582Use the specified colour for the scrollbar [default #B2B2B2]. 722Use the specified colour for the scrollbar [default #B2B2B2].
583 723
589=item B<borderColor:> I<colour> 729=item B<borderColor:> I<colour>
590 730
591The colour of the border around the text area and between the scrollbar 731The colour of the border around the text area and between the scrollbar
592and the text. 732and the text.
593 733
594=item B<backgroundPixmap:> I<file[;geom]> 734=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
595 735
596Use the specified XPM file (note the `.xpm' extension is optional) for 736Use the specified image file for the background and also
597the background and also optionally specify its scaling with a geometry 737optionally specify its scaling with a geometry string B<WxH+X+Y>,
598string B<WxH+X+Y>, in which B<"W" / "H"> specify the 738(default C<0x0+50+50>) in which B<"W" / "H"> specify the
599horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 739horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
600centre (percent). A scale of 0 displays the image with tiling. A scale 740centre (percent). A scale of 0 displays the image with tiling. A scale
601of 1 displays the image without any scaling. A scale of 2 to 9 741of 1 displays the image without any scaling. A scale of 2 to 9 specifies
602specifies an integer number of images in that direction. No image will 742an integer number of images in that direction. No image will be magnified
603be magnified beyond 10 times its original size. The maximum permitted 743beyond 10 times its original size. The maximum permitted scale is 1000.
604scale is 1000. [default 0x0+50+50] 744Additional operations can be specified after colon B<:op1:op2...>.
745Supported operations are:
605 746
606=item B<menu:> I<file[;tag]> 747 tile force background image to be tiled and not scaled. Equivalent to 0x0
748 propscale will scale image keeping proportions
749 auto will scale image to match window size. Equivalent to 100x100
750 hscale will scale image horizontally to the window size
751 vscale will scale image vertically to the window size
752 scale will scale image to match window size
753 root will tile image as if it was a root window background, auto-adjusting
754 whenever terminal window moves
607 755
608Read in the specified menu file (note the `.menu' extension is 756If used in conjunction with B<-tr> option, the specified pixmap will be
609optional) and also optionally specify a starting tag to find. See the 757blended over transparency image using either alpha-blending, or any
610reference documentation for details on the syntax for the menuBar. 758other blending type, specified with B<-blt "type"> option.
611 759
612=item B<path:> I<path> 760=item B<path:> I<path>
613 761
614Specify the colon-delimited search path for finding files (XPM and 762Specify the colon-delimited search path for finding background image files.
615menus), in addition to the paths specified by the B<RXVTPATH> and
616B<PATH> environment variables.
617 763
618=item B<font:> I<fontlist> 764=item B<font:> I<fontlist>
619 765
620Select the fonts to be used. This is a comma separated list of font 766Select the fonts to be used. This is a comma separated list of font names
621names that are used in turn when trying to display Unicode characters. 767that are checked in order when trying to find glyphs for characters. The
622The first font defines the cell size for characters; other fonts might 768first font defines the cell size for characters; other fonts might be
623be smaller, but not larger. A reasonable default font list is always 769smaller, but not (in general) larger. A (hopefully) reasonable default
624appended to it. option B<-fn>. 770font list is always appended to it; option B<-fn>.
625 771
626Each font can either be a standard X11 core font (XLFD) name, with 772Each font can either be a standard X11 core font (XLFD) name, with
627optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 773optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
628 774
629In addition, each font can be prefixed with additional hints and 775In addition, each font can be prefixed with additional hints and
631hint currently is C<codeset=codeset-name>, and this is only used for Xft 777hint currently is C<codeset=codeset-name>, and this is only used for Xft
632fonts. 778fonts.
633 779
634For example, this font resource 780For example, this font resource
635 781
636 URxvt*font: 9x15bold,\ 782 URxvt.font: 9x15bold,\
637 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 783 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
638 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 784 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
639 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 785 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
640 xft:Code2000:antialias=false 786 xft:Code2000:antialias=false
641 787
675not possible, replacement fonts of the desired shape will be tried. 821not possible, replacement fonts of the desired shape will be tried.
676 822
677If set, but empty, then this specific style is disabled and the normal 823If set, but empty, then this specific style is disabled and the normal
678text font will being used for the given style. 824text font will being used for the given style.
679 825
680=item B<selectstyle:> I<mode> 826=item B<intensityStyles:> I<boolean>
681 827
682Set mouse selection style to B<old> which is 2.20, B<oldword> which is 828When font styles are not enabled, or this option is enabled (B<True>,
683xterm style with 2.20 old word selection, or anything else which gives 829option B<-is>, the default), bold/blink font styles imply high
684xterm style selection. 830intensity foreground/background colours. Disabling this option (B<False>,
685 831option B<+is>) disables this behaviour, the high intensity colours are not
686=item B<scrollstyle:> I<mode> 832reachable.
687
688Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
689the author's favourite.
690 833
691=item B<title:> I<string> 834=item B<title:> I<string>
692 835
693Set window title string, the default title is the command-line 836Set window title string, the default title is the command-line
694specified after the B<-e> option, if any, otherwise the application 837specified after the B<-e> option, if any, otherwise the application
703=item B<mapAlert:> I<boolean> 846=item B<mapAlert:> I<boolean>
704 847
705B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 848B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
706de-iconify (map) on receipt of a bell character [default]. 849de-iconify (map) on receipt of a bell character [default].
707 850
851=item B<urgentOnBell:> I<boolean>
852
853B<True>: set the urgency hint for the wm on receipt of a bell character.
854B<False>: do not set the urgency hint [default].
855
708=item B<visualBell:> I<boolean> 856=item B<visualBell:> I<boolean>
709 857
710B<True>: use visual bell on receipt of a bell character; option B<-vb>. 858B<True>: use visual bell on receipt of a bell character; option B<-vb>.
711B<False>: no visual bell [default]; option B<+vb>. 859B<False>: no visual bell [default]; option B<+vb>.
712 860
730 878
731The string will be interpreted as if typed into the shell as-is. 879The string will be interpreted as if typed into the shell as-is.
732 880
733Example: 881Example:
734 882
735 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 883 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
736 884
737This creates a new file in your home directory with the screen contents 885This creates a new file in your home directory with the screen contents
738everytime you hit C<Print>. 886every time you hit C<Print>.
887
888=item B<scrollstyle:> I<mode>
889
890Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
891the author's favourite.
739 892
740=item B<scrollBar:> I<boolean> 893=item B<scrollBar:> I<boolean>
741 894
742B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 895B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
743disable the scrollbar; option B<+sb>. 896disable the scrollbar; option B<+sb>.
765 918
766=item B<scrollWithBuffer:> I<boolean> 919=item B<scrollWithBuffer:> I<boolean>
767 920
768B<True>: scroll with scrollback buffer when tty receives new lines (and 921B<True>: scroll with scrollback buffer when tty receives new lines (and
769B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 922B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
770with scrollback buffer when tty recieves new lines; option B<+sw>. 923with scrollback buffer when tty receives new lines; option B<+sw>.
771 924
772=item B<scrollTtyKeypress:> I<boolean> 925=item B<scrollTtyKeypress:> I<boolean>
773 926
774B<True>: scroll to bottom when a non-special key is pressed. Special keys 927B<True>: scroll to bottom when a non-special key is pressed. Special keys
775are those which are intercepted by rxvt-unicode for special handling and 928are those which are intercepted by rxvt-unicode for special handling and
794=item B<borderLess:> I<boolean> 947=item B<borderLess:> I<boolean>
795 948
796Set MWM hints to request a borderless window, i.e. if honoured by the 949Set MWM hints to request a borderless window, i.e. if honoured by the
797WM, the rxvt-unicode window will not have window decorations; option B<-bl>. 950WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
798 951
952=item B<skipBuiltinGlyphs:> I<boolean>
953
954Compile I<frills>: Disable the usage of the built-in block graphics/line
955drawing characters and just rely on what the specified fonts provide. Use
956this if you have a good font and want to use its block graphic glyphs;
957option B<-sbg>.
958
799=item B<termName:> I<termname> 959=item B<termName:> I<termname>
800 960
801Specifies the terminal type name to be set in the B<TERM> environment 961Specifies the terminal type name to be set in the B<TERM> environment
802variable; option B<-tn>. 962variable; option B<-tn>.
803 963
804=item B<linespace:> I<number> 964=item B<lineSpace:> I<number>
805 965
806Specifies number of lines (pixel height) to insert between each row of 966Specifies number of lines (pixel height) to insert between each row of
807the display [default 0]; option B<-lsp>. 967the display [default 0]; option B<-lsp>.
808 968
809=item B<meta8:> I<boolean> 969=item B<meta8:> I<boolean>
858pressed. If unset it will send the sequence traditionally associated 1018pressed. If unset it will send the sequence traditionally associated
859with the B<Execute> key. 1019with the B<Execute> key.
860 1020
861=item B<cutchars:> I<string> 1021=item B<cutchars:> I<string>
862 1022
863The characters used as delimiters for double-click word selection. The 1023The characters used as delimiters for double-click word selection
864built-in default: 1024(whitespace delimiting is added automatically if resource is given).
865 1025
1026When the perl selection extension is in use (the default if compiled
1027in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
1028characters will be created (if the resource exists, otherwise, no regex
1029will be created). In this mode, characters outside ISO-8859-1 can be used.
1030
1031When the selection extension is not used, only ISO-8859-1 characters can
1032be used. If not specified, the built-in default is used:
1033
866B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1034B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
867 1035
868=item B<preeditType:> I<style> 1036=item B<preeditType:> I<style>
869 1037
870B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1038B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
871 1039
876=item B<imLocale:> I<name> 1044=item B<imLocale:> I<name>
877 1045
878The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. 1046The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
879C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the 1047C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
880input extension to be able to input japanese characters while staying in 1048input extension to be able to input japanese characters while staying in
881another locale. option B<-imlocale>. 1049another locale; option B<-imlocale>.
882 1050
883=item B<imFont:> I<fontset> 1051=item B<imFont:> I<fontset>
884 1052
885Specify the font-set used for XIM styles C<OverTheSpot> or 1053Specify the font-set used for XIM styles C<OverTheSpot> or
886C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated 1054C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
891 1059
892=item B<tripleclickwords:> I<boolean> 1060=item B<tripleclickwords:> I<boolean>
893 1061
894Change the meaning of triple-click selection with the left mouse 1062Change the meaning of triple-click selection with the left mouse
895button. Instead of selecting a full line it will extend the selection to 1063button. Instead of selecting a full line it will extend the selection to
896the end of the logical line only. option B<-tcw>. 1064the end of the logical line only; option B<-tcw>.
897 1065
898=item B<insecure:> I<boolean> 1066=item B<insecure:> I<boolean>
899 1067
900Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1068Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
901echo arbitrary strings like the icon name or the locale. This could be 1069echo arbitrary strings like the icon name or the locale. This could be
905default. (Note that many other terminals, including xterm, have these 1073default. (Note that many other terminals, including xterm, have these
906sequences enabled by default, which doesn't make it safer, though). 1074sequences enabled by default, which doesn't make it safer, though).
907 1075
908You can enable them by setting this boolean resource or specifying 1076You can enable them by setting this boolean resource or specifying
909B<-insecure> as an option. At the moment, this enables display-answer, 1077B<-insecure> as an option. At the moment, this enables display-answer,
910locale, findfont, icon label and window title requests as well as dynamic 1078locale, findfont, icon label and window title requests.
911menubar dispatch.
912 1079
913=item B<modifier:> I<modifier> 1080=item B<modifier:> I<modifier>
914 1081
915Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 1082Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
916B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 1083B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
920 1087
921Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1088Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
922character is passed through. It may contain escape values as described 1089character is passed through. It may contain escape values as described
923in the entry on B<keysym> following. 1090in the entry on B<keysym> following.
924 1091
925=item B<secondaryScreen:> I<bool> 1092=item B<secondaryScreen:> I<boolean>
926 1093
927Turn on/off secondary screen (default enabled). 1094Turn on/off secondary screen (default enabled).
928 1095
929=item B<secondaryScroll:> I<bool> 1096=item B<secondaryScroll:> I<boolean>
930 1097
931Turn on/off secondary screen scroll (default enabled). If the this 1098Turn on/off secondary screen scroll (default enabled). If this
932option is enabled, scrolls on the secondary screen will change the 1099option is enabled, scrolls on the secondary screen will change the
933scrollback buffer and switching to/from the secondary screen will 1100scrollback buffer and, when secondaryScreen is off, switching
934instead scroll the screen up. 1101to/from the secondary screen will instead scroll the screen up.
1102
1103=item B<hold>: I<boolean>
1104
1105Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1106will not immediately destroy its window when the program executed within
1107it exits. Instead, it will wait till it is being killed or closed by the
1108user.
1109
1110=item B<chdir>: I<path>
1111
1112Sets the working directory for the shell (or the command specified via
1113B<-e>). The I<path> must be an absolute path and it must exist for
1114@@RXVT_NAME@@ to start. If it isn't specified then the current working
1115directory will be used; option B<-cd>.
935 1116
936=item B<keysym.>I<sym>: I<string> 1117=item B<keysym.>I<sym>: I<string>
937 1118
938Compile I<frills>: Associate I<string> with keysym I<sym>. The 1119Compile I<frills>: Associate I<string> with keysym I<sym>. The
939intervening resource name B<keysym.> cannot be omitted. 1120intervening resource name B<keysym.> cannot be omitted.
953searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1134searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
954omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1135omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
955keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1136keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
956performed in an exact manner; however, the closest match is assured. 1137performed in an exact manner; however, the closest match is assured.
957 1138
958I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1139I<string> may contain escape values (C<\n>: newline, C<\000>: octal
959C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1140number), see RESOURCES in C<man 7 X> for futher details.
960C<\000>: octal number) or verbatim control characters (C<^?>: delete,
961C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
962can start or end with whitespace.
963
964Please note that you need to double the C<\> when using
965C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
966use C<\033> instead of C<\e> (and so on), which will work with both Xt and
967@@RXVT_NAME@@'s own processing).
968 1141
969You can define a range of keysyms in one shot by providing a I<string> 1142You can define a range of keysyms in one shot by providing a I<string>
970with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1143with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
971should be a character not used by the strings. 1144should be a character not used by the strings.
972 1145
973Its usage can be demonstrated by an example: 1146Its usage can be demonstrated by an example:
974 1147
975 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1148 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
984is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1157is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
985example the following means "change the current locale to C<zh_CN.GBK> 1158example the following means "change the current locale to C<zh_CN.GBK>
986when Control-Meta-c is being pressed": 1159when Control-Meta-c is being pressed":
987 1160
988 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1161 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1162
1163If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1164is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1165manpage. For example, the F<selection> extension (activated via
1166C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1167
1168 URxvt.keysym.M-C-c: perl:selection:rot13
989 1169
990Due the the large number of modifier combinations, a defined key mapping 1170Due the the large number of modifier combinations, a defined key mapping
991will match if at I<at least> the specified identifiers are being set, and 1171will match if at I<at least> the specified identifiers are being set, and
992no other key mappings with those and more bits are being defined. That 1172no other key mappings with those and more bits are being defined. That
993means that defining a key map for C<a> will automatically provide 1173means that defining a key map for C<a> will automatically provide
1017info): 1197info):
1018 1198
1019 URxvt.keysym.M-C-3: command:\033[8;25;80t 1199 URxvt.keysym.M-C-3: command:\033[8;25;80t
1020 URxvt.keysym.M-C-4: command:\033[8;48;110t 1200 URxvt.keysym.M-C-4: command:\033[8;48;110t
1021 1201
1202=item B<perl-ext-common>: I<string>
1203
1204=item B<perl-ext>: I<string>
1205
1206Comma-separated list(s) of perl extension scripts (default: C<default>) to
1207use in this terminal instance; option B<-pe>.
1208
1209Extension names can be prefixed with a C<-> sign to prohibit using
1210them. This can be useful to selectively disable some extensions loaded
1211by default, or specified via the C<perl-ext-common> resource. For
1212example, C<default,-selection> will use all the default extension except
1213C<selection>.
1214
1215Extension names can also be followed by an argument in angle brackets
1216(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1217searchable scrollback to Alt/Meta-s). Mentioning the same extension
1218multiple times with different arguments will pass multiple arguments to
1219the extension.
1220
1221Each extension is looked up in the library directories, loaded if
1222necessary, and bound to the current terminal instance.
1223
1224If both of these resources are the empty string, then the perl
1225interpreter will not be initialized. The idea behind two options is that
1226B<perl-ext-common> will be used for extensions that should be available to
1227all instances, while B<perl-ext> is used for specific instances.
1228
1229=item B<perl-eval>: I<string>
1230
1231Perl code to be evaluated when all extensions have been registered. See
1232the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1233will be ignored when running setuid/setgid.
1234
1235=item B<perl-lib>: I<path>
1236
1237Colon-separated list of additional directories that hold extension
1238scripts. When looking for extensions specified by the C<perl> resource,
1239@@RXVT_NAME@@ will first look in these directories and then in
1240F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1241will be ignored when running setuid/setgid.
1242
1243See the @@RXVT_NAME@@perl(3) manpage.
1244
1245=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1246
1247Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1248details.
1249
1250=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1251
1252Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1253for details.
1254
1255=item B<searchable-scrollback:> I<keysym>
1256
1257Sets the hotkey that starts the incremental scrollback buffer search
1258(default: C<M-s>).
1259
1260=item B<urlLauncher>: I<string>
1261
1262Specifies the program to be started with a URL argument. Used by the
1263C<selection-popup> and C<matcher> perl extensions.
1264
1265=item B<transient-for>: I<windowid>
1266
1267Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1268
1269=item B<override-redirect>: I<boolean>
1270
1271Compile I<frills>: Sets override-redirect for the terminal window, making
1272it almost invisible to window managers; option B<-override-redirect>.
1273
1274=item B<iso14755_52:> I<boolean>
1275
1276Turn on/off ISO 14755 5.2 mode (default enabled).
1277
1022=back 1278=back
1023 1279
1024=head1 THE SCROLLBAR 1280=head1 THE SCROLLBAR
1025 1281
1026Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window 1282Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
1044application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1300application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1045(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1301(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1046up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1302up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1047respectively. 1303respectively.
1048 1304
1049=head1 TEXT SELECTION AND INSERTION 1305=head1 THE SELECTION: SELECTING AND PASTING TEXT
1050 1306
1051The behaviour of text selection and insertion mechanism is similar to 1307The behaviour of text selection and insertion/pasting mechanism is similar
1052I<xterm>(1). 1308to I<xterm>(1).
1053 1309
1054=over 4 1310=over 4
1055 1311
1056=item B<Selection>: 1312=item B<Selecting>:
1057 1313
1058Left click at the beginning of the region, drag to the end of the region 1314Left click at the beginning of the region, drag to the end of the region
1059and release; Right click to extend the marked region; Left double-click 1315and release; Right click to extend the marked region; Left double-click
1060to select a word; Left triple-click to select the entire logical line 1316to select a word; Left triple-click to select the entire logical line
1061(which can span multiple screen lines), unless modified by resource 1317(which can span multiple screen lines), unless modified by resource
1062B<tripleclickwords>. 1318B<tripleclickwords>.
1063 1319
1064Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1320Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1065(Compile: I<frills>) will create a rectangular selection instead of a normal 1321(Compile: I<frills>) will create a rectangular selection instead of a
1066one. 1322normal one. In this mode, every selected row becomes its own line in the
1323selection, and trailing whitespace is visually underlined and removed from
1324the selection.
1067 1325
1068=item B<Insertion>: 1326=item B<Pasting>:
1069 1327
1070Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1328Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1071an B<@@RXVT_NAME@@> window causes the current text selection to be 1329window causes the value of the PRIMARY selection (or CLIPBOARD with the
1072inserted as if it had been typed on the keyboard. 1330B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1331
1332Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1333inserted too.
1073 1334
1074=back 1335=back
1075 1336
1076=head1 CHANGING FONTS 1337=head1 CHANGING FONTS
1077 1338
1078Changing fonts (or font sizes, respectively) via the keypad is not yet 1339Changing fonts (or font sizes, respectively) via the keypad is not yet
1079supported in rxvt-unicode. Bug me if you need this. 1340supported in rxvt-unicode. Bug me if you need this.
1080 1341
1081You can, however, switch fonts at runtime using escape sequences (and 1342You can, however, switch fonts at runtime using escape sequences, e.g.:
1082therefore using the menubar), e.g.:
1083 1343
1084 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1344 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1345
1346You can use keyboard shortcuts, too:
1347
1348 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1349 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1085 1350
1086rxvt-unicode will automatically re-apply these fonts to the output so far. 1351rxvt-unicode will automatically re-apply these fonts to the output so far.
1087 1352
1088=head1 ISO 14755 SUPPORT 1353=head1 ISO 14755 SUPPORT
1089 1354
1090ISO 14755 is a standard for entering and viewing unicode characters 1355ISO 14755 is a standard for entering and viewing unicode characters
1091and character codes using the keyboard. It consists of 4 parts. The 1356and character codes using the keyboard. It consists of 4 parts. The
1092first part is available rxvt-unicode has been compiled with 1357first part is available if rxvt-unicode has been compiled with
1093C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1358C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1094with C<--enable-iso14755>. 1359with C<--enable-iso14755>.
1095 1360
1096=over 4 1361=over 4
1097 1362
1117This mode lets you input characters representing the keycap symbols of 1382This mode lets you input characters representing the keycap symbols of
1118your keyboard, if representable in the current locale encoding. 1383your keyboard, if representable in the current locale encoding.
1119 1384
1120Start by pressing C<Control> and C<Shift> together, then releasing 1385Start by pressing C<Control> and C<Shift> together, then releasing
1121them. The next special key (cursor keys, home etc.) you enter will not 1386them. The next special key (cursor keys, home etc.) you enter will not
1122invoke it's usual function but instead will insert the corresponding 1387invoke its usual function but instead will insert the corresponding
1123keycap symbol. The symbol will only be entered when the key has been 1388keycap symbol. The symbol will only be entered when the key has been
1124released, otherwise pressing e.g. C<Shift> would enter the symbol for 1389released, otherwise pressing e.g. C<Shift> would enter the symbol for
1125C<ISO Level 2 Switch>, although your intention might have been to enter a 1390C<ISO Level 2 Switch>, although your intention might have been to enter a
1126reverse tab (Shift-Tab). 1391reverse tab (Shift-Tab).
1127 1392
1160=head1 COLORS AND GRAPHICS 1425=head1 COLORS AND GRAPHICS
1161 1426
1162In addition to the default foreground and background colours, 1427In addition to the default foreground and background colours,
1163B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1428B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1164high-intensity bold/blink versions of the same). Here is a list of the 1429high-intensity bold/blink versions of the same). Here is a list of the
1165colours with their B<rgb.txt> names. 1430colours with their names.
1166 1431
1167=begin table 1432=begin table
1168 1433
1169 B<color0> (black) = Black 1434 B<color0> (black) = Black
1170 B<color1> (red) = Red3 1435 B<color1> (red) = Red3
1190It is also possible to specify the colour values of B<foreground>, 1455It is also possible to specify the colour values of B<foreground>,
1191B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1456B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1192a number 0-15, as a convenient shorthand to reference the colour name of 1457a number 0-15, as a convenient shorthand to reference the colour name of
1193color0-color15. 1458color0-color15.
1194 1459
1460In addition to the colours defined above, @@RXVT_NAME@@ offers an
1461additional 72 colours. The first 64 of those (with indices 16 to 79)
1462consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
146316>), followed by 8 additional shades of gray (with indices 80 to 87).
1464
1465Together, all those colours implement the 88 colour xterm colours. Only
1466the first 16 can be changed using resources currently, the rest can only
1467be changed via command sequences ("escape codes").
1468
1195Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1469Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1196always swapping the foreground/background colours. This is in contrast to 1470always swapping the foreground/background colours. This is in contrast to
1197I<xterm>(1) where the colours are only swapped if they have not otherwise 1471I<xterm>(1) where the colours are only swapped if they have not otherwise
1198been specified. For example, 1472been specified. For example,
1199 1473
1204would yield White on Black, while on I<xterm>(1) it would yield Black 1478would yield White on Black, while on I<xterm>(1) it would yield Black
1205on White. 1479on White.
1206 1480
1207=back 1481=back
1208 1482
1483=head2 ALPHA CHANNEL SUPPORT
1484
1485If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1486their act together, rxvt-unicode will do it's own alpha channel management:
1487
1488You can prefix any color with an opaquenes percentage enclosed in
1489brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1490(0-100) that specifies the opacity of the color, where C<0> is completely
1491transparent and C<100> is completely opaque. For example, C<[50]red> is a
1492half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1493is the recommended format to specify transparency values, and works with
1494all ways to specify a colour.
1495
1496For complete control, rxvt-unicode also supports
1497C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1498specifications, where the additional C<aaaa> component specifies opacity
1499(alpha) values. The minimum value of C<0000> is completely transparent,
1500while C<ffff> is completely opaque). The two example colours from
1501earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1502C<rgba:0000/ff00/0000/f332>.
1503
1504You probably need to specify B<"-depth 32">, too, to force a visual with
1505alpha channels, and have the luck that your X-server uses ARGB pixel
1506layout, as X is far from just supporting ARGB visuals out of the box, and
1507rxvt-unicode just fudges around.
1508
1509For example, the following selects an almost completely transparent black
1510background, and an almost opaque pink foreground:
1511
1512 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1513
1514When not using a background image, then the interpretation of the
1515alpha channel is up to your compositing manager (most interpret it as
1516transparency of course).
1517
1518When using a background pixmap or pseudo-transparency, then the background
1519colour will always behave as if it were completely transparent (so the
1520background image shows instead), regardless of how it was specified, while
1521other colours will either be transparent as specified (the background
1522image will show through) on servers supporting the RENDER extension, or
1523fully opaque on servers not supporting the RENDER EXTENSION.
1524
1525Please note that due to bugs in Xft, specifying alpha values might result
1526in garbage being displayed when the X-server does not support the RENDER
1527extension.
1528
1209=head1 ENVIRONMENT 1529=head1 ENVIRONMENT
1210 1530
1211B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1531B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1212 1532
1213=over 4 1533=over 4
1214 1534
1215=item B<TERM> 1535=item B<TERM>
1216 1536
1217Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1537Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1218resources or on the commandline. 1538resources or on the command line.
1219 1539
1220=item B<COLORTERM> 1540=item B<COLORTERM>
1221 1541
1222Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1542Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1223compiled with XPM support, and optionally with the added extension 1543compiled with background image support, and optionally with the added
1224C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1544extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1545screen.
1225 1546
1226=item B<COLORFGBG> 1547=item B<COLORFGBG>
1227 1548
1228Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1549Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1229the colour code used as default foreground/text colour (or the string 1550the colour code used as default foreground/text colour (or the string
1230C<default> to indicate that the default-colour escape sequence is to be 1551C<default> to indicate that the default-colour escape sequence is to be
1231used), C<bg> is the colour code used as default background colour (or the 1552used), C<bg> is the colour code used as default background colour (or the
1232string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1553string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1233was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1554was compiled with background image support. Libraries like C<ncurses>
1234(and do) use this information to optimize screen output. 1555and C<slang> can (and do) use this information to optimize screen output.
1235 1556
1236=item B<WINDOWID> 1557=item B<WINDOWID>
1237 1558
1238Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1559Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1239window, which usually has subwindows for the scrollbar, the terminal 1560window, which usually has subwindows for the scrollbar, the terminal
1245C<--with-terminfo=PATH>. 1566C<--with-terminfo=PATH>.
1246 1567
1247=item B<DISPLAY> 1568=item B<DISPLAY>
1248 1569
1249Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1570Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1250display in it's child processes. 1571display in its child processes if C<-display> isn't used to override. It
1572defaults to C<:0> if it doesn't exist.
1251 1573
1252=item B<SHELL> 1574=item B<SHELL>
1253 1575
1254The shell to be used for command execution, defaults to C</bin/sh>. 1576The shell to be used for command execution, defaults to C</bin/sh>.
1255
1256=item B<RXVTPATH>
1257
1258The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1259files.
1260
1261=item B<PATH>
1262
1263Used in the same way as C<RXVTPATH>.
1264 1577
1265=item B<RXVT_SOCKET> 1578=item B<RXVT_SOCKET>
1266 1579
1267The unix domain socket path used by @@RXVT_NAME@@c(1) and 1580The unix domain socket path used by @@RXVT_NAME@@c(1) and
1268@@RXVT_NAME@@d(1). 1581@@RXVT_NAME@@d(1).
1306 1619
1307=item Project Coordinator 1620=item Project Coordinator
1308 1621
1309Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1622Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1310 1623
1311L<http://software.schmorp.de/#rxvt-unicode> 1624L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1312 1625
1313=back 1626=back
1314 1627
1315=head1 AUTHORS 1628=head1 AUTHORS
1316 1629
1338 1651
1339Project Coordinator (changes.txt 2.21a to 2.4.5) 1652Project Coordinator (changes.txt 2.21a to 2.4.5)
1340 1653
1341=item Geoff Wing L<< <gcw@pobox.com> >> 1654=item Geoff Wing L<< <gcw@pobox.com> >>
1342 1655
1343Rewrote screen display and text selection routines. Project Coordinator 1656Rewrote screen display and text selection routines.
1657
1344(changes.txt 2.4.6 - rxvt-unicode) 1658Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1345 1659
1346=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1660=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1347 1661
1348Forked rxvt-unicode, rewrote most of the display code and internal 1662Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1349character handling to store text in unicode, improve xterm 1663extension, random hacks, numerous bugfixes and extensions.
1350compatibility and apply numerous other bugfixes and extensions.
1351 1664
1352Project Coordinator (Changes 1.0 -) 1665Project Coordinator (Changes 1.0 -)
1353 1666
1667=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1668
1669Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1670
1354=back 1671=back
1355 1672

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines