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.43 by root, Sun Jan 16 19:22:16 2005 UTC vs.
Revision 1.251 by root, Sat Jul 3 04:04:12 2021 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines