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.1 by root, Thu Aug 12 20:42:12 2004 UTC vs.
Revision 1.260 by root, Fri Dec 23 21:46:46 2022 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines