ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.txt
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.3 by root, Mon Jan 17 01:44:51 2005 UTC vs.
Revision 1.67 by root, Sun Jun 24 22:12:18 2007 UTC

… …
4 4
5SYNOPSIS 5SYNOPSIS
6 rxvt [options] [-e command [ args ]] 6 rxvt [options] [-e command [ args ]]
7 7
8DESCRIPTION 8DESCRIPTION
9 rxvt-unicode, version 4.8, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 8.2, is a colour vt102 terminal emulator intended
10 as an *xterm*(1) replacement for users who do not require features such 10 as an *xterm*(1) replacement for users who do not require features such
11 as Tektronix 4014 emulation and toolkit-style configurability. As a 11 as Tektronix 4014 emulation and toolkit-style configurability. As a
12 result, rxvt-unicode uses much less swap space -- a significant 12 result, rxvt-unicode uses much less swap space -- a significant
13 advantage on a machine serving many X sessions. 13 advantage on a machine serving many X sessions.
14 14
15FREQUENTLY ASKED QUESTIONS 15FREQUENTLY ASKED QUESTIONS
16 See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions 16 See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions
17 and answer to them and some common problems. 17 and answer to them and some common problems. That document is also
18 accessible on the World-Wide-Web at
19 <http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
18 20
19RXVT-UNICODE VS. RXVT 21RXVT-UNICODE VS. RXVT
20 Unlike the original rxvt, rxvt-unicode stores all text in Unicode 22 Unlike the original rxvt, rxvt-unicode stores all text in Unicode
21 internally. That means it can store and display most scripts in the 23 internally. That means it can store and display most scripts in the
22 world. Being a terminal emulator, however, some things are very 24 world. Being a terminal emulator, however, some things are very
23 difficult, especially cursive scripts such as arabic, vertically written 25 difficult, especially cursive scripts such as arabic, vertically written
24 scripts like mongolian or scripts requiring extremely complex combining 26 scripts like mongolian or scripts requiring extremely complex combining
25 rules, like tibetan or devenagari. Don't expect pretty output when using 27 rules, like tibetan or devenagari. Don't expect pretty output when using
26 these scripts. Most other scripts, latin, cyrillic, kanji, thai etc. 28 these scripts. Most other scripts, latin, cyrillic, kanji, thai etc.
27 should work fine, though. A somewhat difficult case are left-to-right 29 should work fine, though. A somewhat difficult case are right-to-left
28 scripts, such as hebrew: rxvt-unicode adopts the view that bidirectional 30 scripts, such as hebrew: rxvt-unicode adopts the view that bidirectional
29 algorithms belong into the application, not the terminal emulator (too 31 algorithms belong into the application, not the terminal emulator (too
30 many things -- such as cursor-movement while editing -- break 32 many things -- such as cursor-movement while editing -- break
31 otherwise), but that might change. 33 otherwise), but that might change.
32 34
33 If you are looking for a terminal that supports more exotic scripts, let 35 If you are looking for a terminal that supports more exotic scripts, let
34 me recommend "mlterm", which is a very userfriendly, lean and clean 36 me recommend "mlterm", which is a very user friendly, lean and clean
35 terminal emulator. In fact, the reason rxvt-unicode was born was solely 37 terminal emulator. In fact, the reason rxvt-unicode was born was solely
36 because the author couldn't get "mlterm" to use one font for latin1 and 38 because the author couldn't get "mlterm" to use one font for latin1 and
37 another for japanese. 39 another for japanese.
38 40
39 Therefore another design rationale was the use of multiple fonts to 41 Therefore another design rationale was the use of multiple fonts to
40 display characters: The idea of a single unicode font which many other 42 display characters: The idea of a single unicode font which many other
41 programs force onto it's users never made sense to me: You should be 43 programs force onto its users never made sense to me: You should be able
42 able to choose any font for any script freely. 44 to choose any font for any script freely.
43 45
44 Apart from that, rxvt-unicode is also much better internationalised than 46 Apart from that, rxvt-unicode is also much better internationalised than
45 it's predecessor, supports things such as XFT and ISO 14755 that are 47 its predecessor, supports things such as XFT and ISO 14755 that are
46 handy in i18n-environments, is faster, and has a lot less bugs than the 48 handy in i18n-environments, is faster, and has a lot bugs less than the
47 original rxvt. This all in addition to dozens of other small 49 original rxvt. This all in addition to dozens of other small
48 improvements. 50 improvements.
49 51
50 It is still faithfully following the original rxvt idea of being lean 52 It is still faithfully following the original rxvt idea of being lean
51 and nice on resources: for example, you can still configure rxvt-unicode 53 and nice on resources: for example, you can still configure rxvt-unicode
52 without most of it's features to get a lean binary. It also comes with a 54 without most of its features to get a lean binary. It also comes with a
53 client/daemon pair that lets you open any number of terminal windows 55 client/daemon pair that lets you open any number of terminal windows
54 from within a single process, which makes startup time very fast and 56 from within a single process, which makes startup time very fast and
55 drastically reduces memory usage. See rxvtd(1) (daemon) and rxvtc(1) 57 drastically reduces memory usage. See rxvtd(1) (daemon) and rxvtc(1)
56 (client). 58 (client).
57 59
58 It also makes technical information about escape sequences (which have 60 It also makes technical information about escape sequences (which have
59 been extended) easier accessible: see rxvt(7) for technical reference 61 been extended) more accessible: see rxvt(7) for technical reference
60 documentation (escape sequences etc.). 62 documentation (escape sequences etc.).
61 63
62OPTIONS 64OPTIONS
63 The rxvt options (mostly a subset of *xterm*'s) are listed below. In 65 The rxvt options (mostly a subset of *xterm*'s) are listed below. In
64 keeping with the smaller-is-better philosophy, options may be eliminated 66 keeping with the smaller-is-better philosophy, options may be eliminated
… …
82 -display *displayname* 84 -display *displayname*
83 Attempt to open a window on the named X display (-d still 85 Attempt to open a window on the named X display (-d still
84 respected). In the absence of this option, the display specified by 86 respected). In the absence of this option, the display specified by
85 the DISPLAY environment variable is used. 87 the DISPLAY environment variable is used.
86 88
89 -depth *bitdepth*
90 Compile *xft*: Attempt to find a visual with the given bit depth;
91 resource depth.
92
87 -geometry *geom* 93 -geometry *geom*
88 Window geometry (-g still respected); resource geometry. 94 Window geometry (-g still respected); resource geometry.
89 95
90 -rv|+rv 96 -rv|+rv
91 Turn on/off simulated reverse video; resource reverseVideo. 97 Turn on/off simulated reverse video; resource reverseVideo.
92 98
93 -j|+j 99 -j|+j
94 Turn on/off jump scrolling; resource jumpScroll. 100 Turn on/off jump scrolling (allow multiple lines per refresh);
101 resource jumpScroll.
95 102
96 -ip|+ip 103 -ss|+ss
104 Turn on/off skip scrolling (allow multiple screens per refresh);
105 resource skipScroll.
106
107 -ip|+ip | -tr|+tr
97 Turn on/off inheriting parent window's pixmap. Alternative form is 108 Turn on/off inheriting parent window's pixmap. Alternative form is
98 -tr; resource inheritPixmap. 109 -tr; resource inheritPixmap.
99 110
111 *Please note that transparency of any kind if completely unsupported
112 by the author. Don't bug him with installation questions! Read the
113 FAQ (man 7 rxvt)!*
114
100 -fade *number* 115 -fade *number*
101 Fade the text by the given percentage when focus is lost. resource 116 Fade the text by the given percentage when focus is lost. Small
102 fading. 117 values fade a little only, 100 completely replaces all colours by
118 the fade colour; resource fading.
119
120 -fadecolor *colour*
121 Fade to this colour when fading is used (see -fade). The default
122 colour is opaque black. resource fadeColor.
103 123
104 -tint *colour* 124 -tint *colour*
105 Tint the transparent background pixmap with the given colour when 125 Tint the transparent background pixmap with the given colour when
106 transparency is enabled with -tr or -ip. See also the -sh option 126 transparency is enabled with -tr or -ip. This only works for
127 non-tiled backgrounds, currently. See also the -sh option that can
107 that can be used to brighten or darken the image in addition to 128 be used to brighten or darken the image in addition to tinting it;
108 tinting it. 129 resource *tintColor*. Example:
109 130
131 rxvt -tr -tint blue -sh 40
132
133 -sh *number*
110 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent 134 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
111 background image in addition to tinting it (i.e. -tint must be 135 image in addition to (or instead of) tinting it; resource *shading*.
112 specified, too, e.g. "-tint white"). 136
137 -blt *string*
138 Specify background blending type. If background pixmap is specified
139 at the same time as transparency - such pixmap will be blended over
140 transparency image, using method specified. Supported values are :
141 add, alphablend, allanon - color values averaging, colorize, darken,
142 diff, dissipate, hue, lighten, overlay, saturate, screen, sub, tint,
143 value. The default is alpha-blending; resource *blendType*.
144
145 -blr *number*
146 Apply Gaussian Blur with the specified radius to the transparent
147 background image; resource *blurRadius*.
113 148
114 -bg *colour* 149 -bg *colour*
115 Window background colour; resource background. 150 Window background colour; resource background.
116 151
117 -fg *colour* 152 -fg *colour*
118 Window foreground colour; resource foreground. 153 Window foreground colour; resource foreground.
119 154
120 -pixmap *file[;geom]* 155 -pixmap *file[;geom]*
121 Compile *XPM*: Specify XPM file for the background and also 156 Compile *afterimage*: Specify image file for the background and also
122 optionally specify its scaling with a geometry string. Note you may 157 optionally specify its scaling with a geometry string. Note you may
123 need to add quotes to avoid special shell interpretation of the ";" 158 need to add quotes to avoid special shell interpretation of the ";"
124 in the command-line; resource backgroundPixmap. 159 in the command-line; for more details see resource backgroundPixmap.
125 160
126 -cr *colour* 161 -cr *colour*
127 The cursor colour; resource cursorColor. 162 The cursor colour; resource cursorColor.
128 163
129 -pr *colour* 164 -pr *colour*
… …
136 The colour of the border around the text area and between the 171 The colour of the border around the text area and between the
137 scrollbar and the text; resource borderColor. 172 scrollbar and the text; resource borderColor.
138 173
139 -fn *fontlist* 174 -fn *fontlist*
140 Select the fonts to be used. This is a comma separated list of font 175 Select the fonts to be used. This is a comma separated list of font
141 names that are used in turn when trying to display Unicode 176 names that are checked in order when trying to find glyphs for
142 characters. The first font defines the cell size for characters; 177 characters. The first font defines the cell size for characters;
143 other fonts might be smaller, but not (in general) larger. A 178 other fonts might be smaller, but not (in general) larger. A
144 (hopefully) reasonable default font list is always appended to it. 179 (hopefully) reasonable default font list is always appended to it.
145 See resource font for more details. 180 See resource font for more details.
146 181
147 In short, to specify an X11 core font, just specify it's name or 182 In short, to specify an X11 core font, just specify its name or
148 prefix it with "x:". To specify an XFT-font, you need to prefix it 183 prefix it with "x:". To specify an XFT-font, you need to prefix it
149 with "xft:", e.g.: 184 with "xft:", e.g.:
150 185
151 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 186 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
152 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" 187 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
153 188
154 See also the question "How does rxvt-unicode choose fonts?" in the 189 See also the question "How does rxvt-unicode choose fonts?" in the
155 FAQ section of rxvt(7). 190 FAQ section of rxvt(7).
156 191
157 -fb *fontlist* 192 -fb *fontlist*
158 Compile font-styles: The bold font list to use when bold characters 193 Compile *font-styles*: The bold font list to use when bold
159 are to be printed. See resource boldFont for details. 194 characters are to be printed. See resource boldFont for details.
160 195
161 -fi *fontlist* 196 -fi *fontlist*
162 Compile font-styles: The italic font list to use when bold 197 Compile *font-styles*: The italic font list to use when *italic*
163 characters are to be printed. See resource italicFont for details. 198 characters are to be printed. See resource italicFont for details.
164 199
165 -fbi *fontlist* 200 -fbi *fontlist*
166 Compile font-styles: The bold italic font list to use when bold 201 Compile *font-styles*: The bold italic font list to use when *bold
167 characters are to be printed. See resource boldItalicFont for 202 italic* characters are to be printed. See resource boldItalicFont
203 for details.
204
205 -is|+is
206 Compile *font-styles*: Bold/Italic font styles imply high intensity
207 foreground/background (default). See resource intensityStyles for
168 details. 208 details.
169 209
170 -name *name* 210 -name *name*
171 Specify the application name under which resources are to be 211 Specify the application name under which resources are to be
172 obtained, rather than the default executable file name. Name should 212 obtained, rather than the default executable file name. Name should
… …
202 242
203 -sr|+sr 243 -sr|+sr
204 Put scrollbar on right/left; resource scrollBar_right. 244 Put scrollbar on right/left; resource scrollBar_right.
205 245
206 -st|+st 246 -st|+st
207 Display normal (non XTerm/NeXT) scrollbar without/with a trough; 247 Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
208 resource scrollBar_floating. 248 resource scrollBar_floating.
209 249
210 -ptab|+ptab 250 -ptab|+ptab
211 If enabled (default), "Horizontal Tab" characters are being stored 251 If enabled (default), "Horizontal Tab" characters are being stored
212 as actual wide characters in the screen buffer, which makes it 252 as actual wide characters in the screen buffer, which makes it
… …
236 externalBorder. 276 externalBorder.
237 277
238 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e. 278 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e.
239 if honoured by the WM, the rxvt-unicode window will not have window 279 if honoured by the WM, the rxvt-unicode window will not have window
240 decorations; resource borderLess. 280 decorations; resource borderLess.
281
282 -override-redirect
283 Compile *frills*: Sets override-redirect on the window; resource
284 override-redirect.
285
286 -sbg
287 Compile *frills*: Disable the usage of the built-in block
288 graphics/line drawing characters and just rely on what the specified
289 fonts provide. Use this if you have a good font and want to use its
290 block graphic glyphs; resource skipBuiltinGlyphs.
241 291
242 -lsp *number* 292 -lsp *number*
243 Compile *frills*: Lines (pixel height) to insert between each row of 293 Compile *frills*: Lines (pixel height) to insert between each row of
244 the display. Useful to work around font rendering problems; resource 294 the display. Useful to work around font rendering problems; resource
245 linespace. 295 linespace.
… …
257 on the command line. If this option is used, it must be the last on 307 on the command line. If this option is used, it must be the last on
258 the command-line. If there is no -e option then the default is to 308 the command-line. If there is no -e option then the default is to
259 run the program specified by the SHELL environment variable or, 309 run the program specified by the SHELL environment variable or,
260 failing that, *sh(1)*. 310 failing that, *sh(1)*.
261 311
312 Please note that you must specify a program with arguments. If you
313 want to run shell commands, you have to specify the shell, like
314 this:
315
316 rxvt -e sh -c "shell commands"
317
262 -title *text* 318 -title *text*
263 Window title (-T still respected); the default title is the basename 319 Window title (-T still respected); the default title is the basename
264 of the program specified after the -e option, if any, otherwise the 320 of the program specified after the -e option, if any, otherwise the
265 application name; resource title. 321 application name; resource title.
266 322
… …
277 333
278 -im *text* 334 -im *text*
279 Compile *XIM*: input method name. resource inputMethod. 335 Compile *XIM*: input method name. resource inputMethod.
280 336
281 -imlocale *string* 337 -imlocale *string*
282 The locale to use for opening the IM. You can use an LC_CTYPE of 338 The locale to use for opening the IM. You can use an "LC_CTYPE" of
283 e.g. de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the 339 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for
284 input extension to be able to input japanese characters while 340 the input extension to be able to input japanese characters while
285 staying in another locale. 341 staying in another locale. resource imLocale.
342
343 -imfont *fontset*
344 Set the font set to use for the X Input Method, see resource imFont
345 for more info.
346
347 -tcw
348 Change the meaning of triple-click selection with the left mouse
349 button. Only effective when the original (non-perl) selection code
350 is in-use. Instead of selecting a full line it will extend the
351 selection the end of the logical line only. resource
352 tripleclickwords.
286 353
287 -insecure 354 -insecure
288 Enable "insecure" mode, which currently enables most of the escape 355 Enable "insecure" mode, which currently enables most of the escape
289 sequences that echo strings. See the resource insecure for more 356 sequences that echo strings. See the resource insecure for more
290 info. 357 info.
… …
299 366
300 -ssr|+ssr 367 -ssr|+ssr
301 Turn on/off secondary screen scroll (default enabled); resource 368 Turn on/off secondary screen scroll (default enabled); resource
302 secondaryScroll. 369 secondaryScroll.
303 370
304 -xrm *resourcestring* 371 -hold|+hold
305 No effect on rxvt-unicode. Simply passes through an argument to be 372 Turn on/off hold window after exit support. If enabled, rxvt will
306 made available in the instance's argument list. Appears in 373 not immediately destroy its window when the program executed within
307 *WM_COMMAND* in some window managers. 374 it exits. Instead, it will wait till it is being killed or closed by
375 the user; resource hold.
376
377 -keysym.*sym* *string*
378 Remap a key symbol. See resource keysym.
379
380 -embed *windowid*
381 Tells rxvt to embed its windows into an already-existing window,
382 which enables applications to easily embed a terminal.
383
384 Right now, rxvt will first unmap/map the specified window, so it
385 shouldn't be a top-level window. rxvt will also reconfigure it quite
386 a bit, so don't expect it to keep some specific state. It's best to
387 create an extra subwindow for rxvt and leave it alone.
388
389 The window will not be destroyed when rxvt exits.
390
391 It might be useful to know that rxvt will not close file descriptors
392 passed to it (except for stdin/out/err, of course), so you can use
393 file descriptors to communicate with the programs within the
394 terminal. This works regardless of whether the "-embed" option was
395 used or not.
396
397 Here is a short Gtk2-perl snippet that illustrates how this option
398 can be used (a longer example is in doc/embed):
399
400 my $rxvt = new Gtk2::Socket;
401 $rxvt->signal_connect_after (realize => sub {
402 my $xid = $_[0]->window->get_xid;
403 system "rxvt -embed $xid &";
404 });
405
406 -pty-fd *file descriptor*
407 Tells rxvt NOT to execute any commands or create a new pty/tty pair
408 but instead use the given file descriptor as the tty master. This is
409 useful if you want to drive rxvt as a generic terminal emulator
410 without having to run a program within it.
411
412 If this switch is given, rxvt will not create any utmp/wtmp entries
413 and will not tinker with pty/tty permissions - you have to do that
414 yourself if you want that.
415
416 As an extremely special case, specifying -1 will completely suppress
417 pty/tty operations.
418
419 Here is a example in perl that illustrates how this option can be
420 used (a longer example is in doc/pty-fd):
421
422 use IO::Pty;
423 use Fcntl;
424
425 my $pty = new IO::Pty;
426 fcntl $pty, F_SETFD, 0; # clear close-on-exec
427 system "rxvt -pty-fd " . (fileno $pty) . "&";
428 close $pty;
429
430 # now communicate with rxvt
431 my $slave = $pty->slave;
432 while (<$slave>) { print $slave "got <$_>\n" }
433
434 -pe *string*
435 Comma-separated list of perl extension scripts to use (or not to
436 use) in this terminal instance. See resource perl-ext for details.
308 437
309RESOURCES (available also as long-options) 438RESOURCES (available also as long-options)
310 Note: `rxvt --help' gives a list of all resources (long options) 439 Note: `rxvt --help' gives a list of all resources (long options)
311 compiled into your version. 440 compiled into your version.
312 441
313 There are two different methods that rxvt can use to get the Xresource
314 data: using the X libraries (Xrm*-functions) or internal Xresources
315 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
316 XGetDefaults), you can set and change the resources using X11 tools like 442 You can set and change the resources using X11 tools like xrdb. Many
317 xset. Many distribution do also load settings from the ~/.Xresources 443 distribution do also load settings from the ~/.Xresources file when X
318 file when X starts. 444 starts. rxvt will consult the following files/resources in order, with
445 later settings overwriting earlier ones:
319 446
320 If compiled with internal Xresources support (i.e. rxvt -h lists 447 1. system-wide app-defaults file, either locale-dependent OR global
321 .Xdefaults) then rxvt accepts application defaults set in 448 2. app-defaults file in $XAPPLRESDIR
322 XAPPLOADDIR/URxvt (compile-time defined: usually 449 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
323 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 450 4. SCREEN_RESOURCES for the current screen
324 ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X 451 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
325 resources, rxvt recognizes two class names: XTerm and URxvt. The class 452
326 name Rxvt allows resources common to both rxvt and the original *rxvt* 453 Note that when reading X resources, rxvt recognizes two class names:
327 to be easily configured, while the class name URxvt allows resources 454 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
328 unique to rxvt, notably colours and key-handling, to be shared between 455 and the original *rxvt* to be easily configured, while the class name
456 URxvt allows resources unique to rxvt, to be shared between different
329 different rxvt configurations. If no resources are specified, suitable 457 rxvt configurations. If no resources are specified, suitable defaults
330 defaults will be used. Command-line arguments can be used to override 458 will be used. Command-line arguments can be used to override resource
331 resource settings. The following resources are allowed: 459 settings. The following resources are supported (you might want to check
460 the rxvtperl(3) manpage for additional settings by perl extensions not
461 documented here):
462
463 depth: *bitdepth*
464 Compile *xft*: Attempt to find a visual with the given bit depth;
465 option -depth.
332 466
333 geometry: *geom* 467 geometry: *geom*
334 Create the window with the specified X window geometry [default 468 Create the window with the specified X window geometry [default
335 80x24]; option -geometry. 469 80x24]; option -geometry.
336 470
… …
368 Use the specified colour to display underlined characters when the 502 Use the specified colour to display underlined characters when the
369 foreground colour is the default. 503 foreground colour is the default.
370 504
371 colorRV: *colour* 505 colorRV: *colour*
372 Use the specified colour as the background for reverse video 506 Use the specified colour as the background for reverse video
373 characters. 507 characters when OPTION_HC is disabled (--disable-frills).
374 508
375 underlineColor: *colour* 509 underlineColor: *colour*
376 If set, use the specified colour as the colour for the underline 510 If set, use the specified colour as the colour for the underline
377 itself. If unset, use the foreground colour. 511 itself. If unset, use the foreground colour.
378 512
… …
389 True: simulate reverse video by foreground and background colours; 523 True: simulate reverse video by foreground and background colours;
390 option -rv. False: regular screen colours [default]; option +rv. See 524 option -rv. False: regular screen colours [default]; option +rv. See
391 note in COLORS AND GRAPHICS section. 525 note in COLORS AND GRAPHICS section.
392 526
393 jumpScroll: *boolean* 527 jumpScroll: *boolean*
394 True: specify that jump scrolling should be used. When scrolling 528 True: specify that jump scrolling should be used. When receiving
395 quickly, fewer screen updates are performed [default]; option -j. 529 lots of lines, rxvt will only scroll once a whole screen height of
530 lines has been read, resulting in fewer updates while still
531 displaying every received line; option -j.
532
396 False: specify that smooth scrolling should be used; option +j. 533 False: specify that smooth scrolling should be used. rxvt will force
534 a screen refresh on each new line it received; option +j.
535
536 skipScroll: *boolean*
537 True: (the default) specify that skip scrolling should be used. When
538 receiving lots of lines, rxvt will only scroll once in a while
539 (around 60 times per second), resulting in far fewer updates. This
540 can result in rxvt not ever displaying some of the lines it
541 receives; option -ss.
542
543 False: specify that everything is to be displayed, even if the
544 refresh is too fast for the human eye to read anything (or the
545 monitor to display anything); option +ss.
397 546
398 inheritPixmap: *boolean* 547 inheritPixmap: *boolean*
399 True: make the background inherit the parent windows' pixmap, giving 548 True: make the background inherit the parent windows' pixmap, giving
400 artificial transparency. False: do not inherit the parent windows' 549 artificial transparency. False: do not inherit the parent windows'
401 pixmap. 550 pixmap.
402 551
552 *Please note that transparency of any kind if completely unsupported
553 by the author. Don't bug him with installation questions!*
554
403 fading: *number* 555 fading: *number*
404 Fade the text by the given percentage when focus is lost. 556 Fade the text by the given percentage when focus is lost; option
557 -fade.
558
559 fadeColor: *colour*
560 Fade to this colour, when fading is used (see fading:). The default
561 colour is black; option -fadecolor.
405 562
406 tintColor: *colour* 563 tintColor: *colour*
407 Tint the transparent background pixmap with the given colour. 564 Tint the transparent background pixmap with the given colour; option
565 -tint.
408 566
409 shading: *number* 567 shading: *number*
410 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 568 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
411 image in addition to tinting it. 569 image in addition to tinting it; option -sh.
570
571 blendType: *string*
572 Specify background blending type; option -blt.
573
574 blurRadius: *number*
575 Apply Gaussian Blurr with the specified radius to the transparent
576 background image; option -blr.
412 577
413 scrollColor: *colour* 578 scrollColor: *colour*
414 Use the specified colour for the scrollbar [default #B2B2B2]. 579 Use the specified colour for the scrollbar [default #B2B2B2].
415 580
416 troughColor: *colour* 581 troughColor: *colour*
417 Use the specified colour for the scrollbar's trough area [default 582 Use the specified colour for the scrollbar's trough area [default
418 #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 583 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
419 584
420 borderColor: *colour* 585 borderColor: *colour*
421 The colour of the border around the text area and between the 586 The colour of the border around the text area and between the
422 scrollbar and the text. 587 scrollbar and the text.
423 588
424 backgroundPixmap: *file[;geom]* 589 backgroundPixmap: *file[;geom]*
425 Use the specified XPM file (note the `.xpm' extension is optional) 590 Use the specified image file for the background and also optionally
426 for the background and also optionally specify its scaling with a 591 specify its scaling with a geometry string WxH+X+Y, in which "W" /
427 geometry string WxH+X+Y, in which "W" / "H" specify the
428 horizontal/vertical scale (percent) and "X" / "Y" locate the image 592 "H" specify the horizontal/vertical scale (percent), and "X" / "Y"
429 centre (percent). A scale of 0 displays the image with tiling. A 593 locate the image centre (percent). A scale of 0 displays the image
430 scale of 1 displays the image without any scaling. A scale of 2 to 9 594 with tiling. A scale of 1 displays the image without any scaling. A
431 specifies an integer number of images in that direction. No image 595 scale of 2 to 9 specifies an integer number of images in that
432 will be magnified beyond 10 times its original size. The maximum 596 direction. No image will be magnified beyond 10 times its original
433 permitted scale is 1000. [default 0x0+50+50] 597 size. The maximum permitted scale is 1000. Special string of "auto"
434 598 used as a geometry will cause image to be automatically scaled to
435 menu: *file[;tag]* 599 match window size. If used in conjunction with -tr option -
436 Read in the specified menu file (note the `.menu' extension is 600 specified pixmap will be blended over transparency image using
437 optional) and also optionally specify a starting tag to find. See 601 either alpha-blending, or any other blending type, specified with
438 the reference documentation for details on the syntax for the 602 -blt "type" option. [default 0x0+50+50]
439 menuBar.
440 603
441 path: *path* 604 path: *path*
442 Specify the colon-delimited search path for finding files (XPM and 605 Specify the colon-delimited search path for finding XPM files.
443 menus), in addition to the paths specified by the RXVTPATH and PATH
444 environment variables.
445 606
446 font: *fontlist* 607 font: *fontlist*
447 Select the fonts to be used. This is a comma separated list of font 608 Select the fonts to be used. This is a comma separated list of font
448 names that are used in turn when trying to display Unicode 609 names that are checked in order when trying to find glyphs for
449 characters. The first font defines the cell size for characters; 610 characters. The first font defines the cell size for characters;
450 other fonts might be smaller, but not larger. A reasonable default 611 other fonts might be smaller, but not (in general) larger. A
451 font list is always appended to it. option -fn. 612 (hopefully) reasonable default font list is always appended to it;
613 option -fn.
452 614
453 Each font can either be a standard X11 core font (XLFD) name, with 615 Each font can either be a standard X11 core font (XLFD) name, with
454 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 616 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
455 "xft:". 617 "xft:".
456 618
… …
459 available hint currently is "codeset=codeset-name", and this is only 621 available hint currently is "codeset=codeset-name", and this is only
460 used for Xft fonts. 622 used for Xft fonts.
461 623
462 For example, this font resource 624 For example, this font resource
463 625
464 URxvt*font: 9x15bold,\ 626 URxvt.font: 9x15bold,\
465 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 627 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
466 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 628 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
467 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 629 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
468 xft:Code2000:antialias=false 630 xft:Code2000:antialias=false
469 631
… …
502 tried. 664 tried.
503 665
504 If set, but empty, then this specific style is disabled and the 666 If set, but empty, then this specific style is disabled and the
505 normal text font will being used for the given style. 667 normal text font will being used for the given style.
506 668
669 intensityStyles: *boolean*
670 When font styles are not enabled, or this option is enabled (True,
671 option -is, the default), bold and italic font styles imply high
672 intensity foreground/background colours. Disabling this option
673 (False, option +is) disables this behaviour, the high intensity
674 colours are not reachable.
675
507 selectstyle: *mode* 676 selectstyle: *mode*
508 Set mouse selection style to old which is 2.20, oldword which is 677 Set mouse selection style to old which is 2.20, oldword which is
509 xterm style with 2.20 old word selection, or anything else which 678 xterm style with 2.20 old word selection, or anything else which
510 gives xterm style selection. 679 gives xterm style selection. Only effective when the original
680 (non-perl) selection code is in use.
511 681
512 scrollstyle: *mode* 682 scrollstyle: *mode*
513 Set scrollbar style to rxvt, plain, next or xterm. plain is the 683 Set scrollbar style to rxvt, plain, next or xterm. plain is the
514 author's favourite.. 684 author's favourite.
515 685
516 title: *string* 686 title: *string*
517 Set window title string, the default title is the command-line 687 Set window title string, the default title is the command-line
518 specified after the -e option, if any, otherwise the application 688 specified after the -e option, if any, otherwise the application
519 name; option -title. 689 name; option -title.
… …
525 695
526 mapAlert: *boolean* 696 mapAlert: *boolean*
527 True: de-iconify (map) on receipt of a bell character. False: no 697 True: de-iconify (map) on receipt of a bell character. False: no
528 de-iconify (map) on receipt of a bell character [default]. 698 de-iconify (map) on receipt of a bell character [default].
529 699
700 urgentOnBell: *boolean*
701 True: set the urgency hint for the wm on receipt of a bell
702 character. False: do not set the urgency hint [default].
703
530 visualBell: *boolean* 704 visualBell: *boolean*
531 True: use visual bell on receipt of a bell character; option -vb. 705 True: use visual bell on receipt of a bell character; option -vb.
532 False: no visual bell [default]; option +vb. 706 False: no visual bell [default]; option +vb.
533 707
534 loginShell: *boolean* 708 loginShell: *boolean*
… …
544 print-pipe: *string* 718 print-pipe: *string*
545 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use 719 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use
546 Print to initiate a screen dump to the printer and Ctrl-Print or 720 Print to initiate a screen dump to the printer and Ctrl-Print or
547 Shift-Print to include the scrollback as well. 721 Shift-Print to include the scrollback as well.
548 722
723 The string will be interpreted as if typed into the shell as-is.
724
725 Example:
726
727 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
728
729 This creates a new file in your home directory with the screen
730 contents every time you hit "Print".
731
549 scrollBar: *boolean* 732 scrollBar: *boolean*
550 True: enable the scrollbar [default]; option -sb. False: disable the 733 True: enable the scrollbar [default]; option -sb. False: disable the
551 scrollbar; option +sb. 734 scrollbar; option +sb.
552 735
553 scrollBar_right: *boolean* 736 scrollBar_right: *boolean*
… …
566 True: scroll to bottom when tty receives output; option -si. False: 749 True: scroll to bottom when tty receives output; option -si. False:
567 do not scroll to bottom when tty receives output; option +si. 750 do not scroll to bottom when tty receives output; option +si.
568 751
569 scrollWithBuffer: *boolean* 752 scrollWithBuffer: *boolean*
570 True: scroll with scrollback buffer when tty receives new lines (and 753 True: scroll with scrollback buffer when tty receives new lines (and
571 scrollTtyOutput is False); option +sw. False: do not scroll with 754 scrollTtyOutput is False); option -sw. False: do not scroll with
572 scrollback buffer when tty recieves new lines; option -sw. 755 scrollback buffer when tty receives new lines; option +sw.
573 756
574 scrollTtyKeypress: *boolean* 757 scrollTtyKeypress: *boolean*
575 True: scroll to bottom when a non-special key is pressed. Special 758 True: scroll to bottom when a non-special key is pressed. Special
576 keys are those which are intercepted by rxvt-unicode for special 759 keys are those which are intercepted by rxvt-unicode for special
577 handling and are not passed onto the shell; option -sk. False: do 760 handling and are not passed onto the shell; option -sk. False: do
… …
592 borderLess: *boolean* 775 borderLess: *boolean*
593 Set MWM hints to request a borderless window, i.e. if honoured by 776 Set MWM hints to request a borderless window, i.e. if honoured by
594 the WM, the rxvt-unicode window will not have window decorations; 777 the WM, the rxvt-unicode window will not have window decorations;
595 option -bl. 778 option -bl.
596 779
780 skipBuiltinGlyphs: *boolean*
781 Compile *frills*: Disable the usage of the built-in block
782 graphics/line drawing characters and just rely on what the specified
783 fonts provide. Use this if you have a good font and want to use its
784 block graphic glyphs; option -sbg.
785
597 termName: *termname* 786 termName: *termname*
598 Specifies the terminal type name to be set in the TERM environment 787 Specifies the terminal type name to be set in the TERM environment
599 variable; option -tn. 788 variable; option -tn.
600 789
601 linespace: *number* 790 linespace: *number*
… …
629 pointerColor2: *colour* 818 pointerColor2: *colour*
630 Mouse pointer background colour. 819 Mouse pointer background colour.
631 820
632 pointerBlankDelay: *number* 821 pointerBlankDelay: *number*
633 Specifies number of seconds before blanking the pointer [default 2]. 822 Specifies number of seconds before blanking the pointer [default 2].
823 Use a large number (e.g. 987654321) to effectively disable the
824 timeout.
634 825
635 backspacekey: *string* 826 backspacekey: *string*
636 The string to send when the backspace key is pressed. If set to DEC 827 The string to send when the backspace key is pressed. If set to DEC
637 or unset it will send Delete (code 127) or, if shifted, Backspace 828 or unset it will send Delete (code 127) or, if shifted, Backspace
638 (code 8) - which can be reversed with the appropriate DEC private 829 (code 8) - which can be reversed with the appropriate DEC private
… …
642 The string to send when the delete key (not the keypad delete key) 833 The string to send when the delete key (not the keypad delete key)
643 is pressed. If unset it will send the sequence traditionally 834 is pressed. If unset it will send the sequence traditionally
644 associated with the Execute key. 835 associated with the Execute key.
645 836
646 cutchars: *string* 837 cutchars: *string*
647 The characters used as delimiters for double-click word selection. 838 The characters used as delimiters for double-click word selection
648 The built-in default: 839 (whitespace delimiting is added automatically if resource is given).
840
841 When the perl selection extension is in use (the default if compiled
842 in, see the rxvtperl(3) manpage), a suitable regex using these
843 characters will be created (if the resource exists, otherwise, no
844 regex will be created). In this mode, characters outside ISO-8859-1
845 can be used.
846
847 When the selection extension is not used, only ISO-8859-1 characters
848 can be used. If not specified, the built-in default is used:
649 849
650 BACKSLASH `"'&()*,;<=>?@[]{|} 850 BACKSLASH `"'&()*,;<=>?@[]{|}
651 851
652 preeditType: *style* 852 preeditType: *style*
653 OverTheSpot, OffTheSpot, Root; option -pt. 853 OverTheSpot, OffTheSpot, Root; option -pt.
654 854
655 inputMethod: *name* 855 inputMethod: *name*
656 *name* of inputMethod to use; option -im. 856 *name* of inputMethod to use; option -im.
657 857
658 imLocale: *name* 858 imLocale: *name*
659 The locale to use for opening the IM. You can use an LC_CTYPE of 859 The locale to use for opening the IM. You can use an "LC_CTYPE" of
660 e.g. de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the 860 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for
661 input extension to be able to input japanese characters while 861 the input extension to be able to input japanese characters while
662 staying in another locale. option -imlocale. 862 staying in another locale; option -imlocale.
863
864 imFont: *fontset*
865 Specify the font-set used for XIM styles "OverTheSpot" or
866 "OffTheSpot". It must be a standard X font set (XLFD patterns
867 separated by commas), i.e. it's not in the same format as the other
868 font lists used in rxvt. The default will be set-up to chose *any*
869 suitable found found, preferably one or two pixels differing in size
870 to the base font. option -imfont.
871
872 tripleclickwords: *boolean*
873 Change the meaning of triple-click selection with the left mouse
874 button. Instead of selecting a full line it will extend the
875 selection to the end of the logical line only; option -tcw.
663 876
664 insecure: *boolean* 877 insecure: *boolean*
665 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 878 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
666 that echo arbitrary strings like the icon name or the locale. This 879 that echo arbitrary strings like the icon name or the locale. This
667 could be abused if somebody gets 8-bit-clean access to your display, 880 could be abused if somebody gets 8-bit-clean access to your display,
668 whether throuh a mail client displaying mail bodies unfiltered or 881 whether through a mail client displaying mail bodies unfiltered or
669 though write(1). Therefore, these sequences are disabled by default. 882 through write(1) or any other means. Therefore, these sequences are
670 (Note that other terminals, including xterm, have these sequences 883 disabled by default. (Note that many other terminals, including
671 enabled by default). You can enable them by setting this boolean 884 xterm, have these sequences enabled by default, which doesn't make
672 resource or specifying -insecure as an option. At the moment, this 885 it safer, though).
673 enabled display-answer, locale, findfont, icon label and window 886
674 title requests as well as dynamic menubar dispatch. 887 You can enable them by setting this boolean resource or specifying
888 -insecure as an option. At the moment, this enables display-answer,
889 locale, findfont, icon label and window title requests.
675 890
676 modifier: *modifier* 891 modifier: *modifier*
677 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 892 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
678 super, mod1, mod2, mod3, mod4, mod5; option -mod. 893 super, mod1, mod2, mod3, mod4, mod5; option -mod.
679 894
680 answerbackString: *string* 895 answerbackString: *string*
681 Specify the reply rxvt-unicode sends to the shell when an ENQ 896 Specify the reply rxvt-unicode sends to the shell when an ENQ
682 (control-E) character is passed through. It may contain escape 897 (control-E) character is passed through. It may contain escape
683 values as described in the entry on keysym following. 898 values as described in the entry on keysym following.
684 899
685 secondaryScreen: *bool* 900 secondaryScreen: *boolean*
686 Turn on/off secondary screen (default enabled). 901 Turn on/off secondary screen (default enabled).
687 902
688 secondaryScroll: *bool* 903 secondaryScroll: *boolean*
689 Turn on/off secondary screen scroll (default enabled). If the this 904 Turn on/off secondary screen scroll (default enabled). If this
690 option is enabled, scrolls on the secondary screen will change the 905 option is enabled, scrolls on the secondary screen will change the
691 scrollback buffer and switching to/from the secondary screen will 906 scrollback buffer and switching to/from the secondary screen will
692 instead scroll the screen up. 907 instead scroll the screen up.
908
909 hold: *boolean*
910 Turn on/off hold window after exit support. If enabled, rxvt will
911 not immediately destroy its window when the program executed within
912 it exits. Instead, it will wait till it is being killed or closed by
913 the user.
693 914
694 keysym.*sym*: *string* 915 keysym.*sym*: *string*
695 Compile *frills*: Associate *string* with keysym *sym*. The 916 Compile *frills*: Associate *string* with keysym *sym*. The
696 intervening resource name keysym. cannot be omitted. 917 intervening resource name keysym. cannot be omitted.
697 918
… …
700 Meta, Lock, Mod1, Mod2, Mod3, Mod4, Mod5, and the abbreviated I, K, 921 Meta, Lock, Mod1, Mod2, Mod3, Mod4, Mod5, and the abbreviated I, K,
701 C, N, S, M, A, L, 1, 2, 3, 4, 5. 922 C, N, S, M, A, L, 1, 2, 3, 4, 5.
702 923
703 The NumLock, Meta and ISOLevel3 modifiers are usually aliased to 924 The NumLock, Meta and ISOLevel3 modifiers are usually aliased to
704 whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 925 whatever modifier the NumLock key, Meta/Alt keys or ISO Level3
705 Shift/AltGr keys are being mapped. AppKeypad is a artificial 926 Shift/AltGr keys are being mapped. AppKeypad is a synthetic modifier
706 modifier mapped to the current application keymap mode state. 927 mapped to the current application keymap mode state.
707 928
708 The spellings of *key* can be obtained by using xev(1) command or 929 The spellings of *key* can be obtained by using xev(1) command or
709 searching keysym macros from /usr/X11R6/include/X11/keysymdef.h and 930 searching keysym macros from /usr/X11R6/include/X11/keysymdef.h and
710 omitting the prefix XK_. Alternatively you can specify *key* by its 931 omitting the prefix XK_. Alternatively you can specify *key* by its
711 hex keysym value (0x0000 - 0xFFFF). Note that the lookup of *sym*s 932 hex keysym value (0x0000 - 0xFFFF). Note that the lookup of *sym*s
… …
714 935
715 *string* may contain escape values ("\a": bell, "\b": backspace, 936 *string* may contain escape values ("\a": bell, "\b": backspace,
716 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 937 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
717 "\000": octal number) or verbatim control characters ("^?": delete, 938 "\000": octal number) or verbatim control characters ("^?": delete,
718 "^@": null, "^A" ...) and may be enclosed with double quotes so that 939 "^@": null, "^A" ...) and may be enclosed with double quotes so that
719 it can start or end with whitespace. 940 it can start or end with whitespace. This feature is deprecated and
941 will be removed.
942
943 Please note that you need to double the "\" in resource files, as
944 Xlib itself does its own de-escaping (you can use "\033" instead of
945 "\e" (and so on), which will work with both Xt and rxvt's own
946 processing).
720 947
721 You can define a range of keysyms in one shot by providing a 948 You can define a range of keysyms in one shot by providing a
722 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 949 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimiter
723 `/' should be a character not used by the strings. 950 `/' should be a character not used by the strings.
724 951
725 Its usage can be demonstrated by an example: 952 Its usage can be demonstrated by an example:
726 953
727 URxvt.keysym.M-C-0x61: list|\e<M-C-|abc|> 954 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
728 955
729 The above line is equivalent to the following three lines: 956 The above line is equivalent to the following three lines:
730 957
731 URxvt.keysym.Meta-Control-0x61: \e<M-C-a> 958 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
732 URxvt.keysym.Meta-Control-0x62: \e<M-C-b> 959 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
733 URxvt.keysym.Meta-Control-0x63: \e<M-C-c> 960 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
734 961
735 If *string* takes the form of "proto:STRING", the specified STRING 962 If *string* takes the form of "command:STRING", the specified STRING
736 is interpreted and executed as rxvt's control sequence. For example, 963 is interpreted and executed as rxvt's control sequence. For example
737 "proto:\033]701;zh_CN.GBK\007" means: change the current locale to 964 the following means "change the current locale to "zh_CN.GBK" when
738 "zh_CN.GBK". 965 Control-Meta-c is being pressed":
966
967 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
968
969 If *string* takes the form "perl:STRING", then the specified STRING
970 is passed to the "on_keyboard_command" perl handler. See the
971 rxvtperl(3) manpage. For example, the selection extension (activated
972 via "rxvt -pe selection") listens for "selection:rot13" events:
973
974 URxvt.keysym.M-C-c: perl:selection:rot13
975
976 Due the the large number of modifier combinations, a defined key
977 mapping will match if at *at least* the specified identifiers are
978 being set, and no other key mappings with those and more bits are
979 being defined. That means that defining a key map for "a" will
980 automatically provide definitions for "Meta-a", "Shift-a" and so on,
981 unless some of those are defined mappings themselves.
982
983 Unfortunately, this will override built-in key mappings. For example
984 if you overwrite the "Insert" key you will disable rxvt's
985 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
986 the user-defined keymap using the "builtin:" replacement:
987
988 URxvt.keysym.Insert: <my insert key sequence>
989 URxvt.keysym.S-Insert: builtin:
990
991 The first line defines a mapping for "Insert" and *any* combination
992 of modifiers. The second line re-establishes the default mapping for
993 "Shift-Insert".
994
995 The following example will map Control-Meta-1 and Control-Meta-2 to
996 the fonts "suxuseuro" and "9x15bold", so you can have some limited
997 font-switching at runtime:
998
999 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1000 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1001
1002 Other things are possible, e.g. resizing (see rxvt(7) for more
1003 info):
1004
1005 URxvt.keysym.M-C-3: command:\033[8;25;80t
1006 URxvt.keysym.M-C-4: command:\033[8;48;110t
1007
1008 perl-ext-common: *string*
1009 perl-ext: *string*
1010 Comma-separated list(s) of perl extension scripts (default:
1011 "default") to use in this terminal instance; option -pe.
1012
1013 Extension names can be prefixed with a "-" sign to prohibit using
1014 them. This can be useful to selectively disable some extensions
1015 loaded by default, or specified via the "perl-ext-common" resource.
1016 For example, "default,-selection" will use all the default extension
1017 except "selection".
1018
1019 Extension names can also be followed by an argument in angle
1020 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
1021 for searchable scrollback to Alt/Meta-s). Mentioning the same
1022 extension multiple times with different arguments will pass multiple
1023 arguments to the extension.
1024
1025 Each extension is looked up in the library directories, loaded if
1026 necessary, and bound to the current terminal instance.
1027
1028 If both of these resources are the empty string, then the perl
1029 interpreter will not be initialized. The idea behind two options is
1030 that perl-ext-common will be used for extensions that should be
1031 available to all instances, while perl-ext is used for specific
1032 instances.
1033
1034 perl-eval: *string*
1035 Perl code to be evaluated when all extensions have been registered.
1036 See the rxvtperl(3) manpage. Due to security reasons, this resource
1037 will be ignored when running setuid/setgid.
1038
1039 perl-lib: *path*
1040 Colon-separated list of additional directories that hold extension
1041 scripts. When looking for extensions specified by the "perl"
1042 resource, rxvt will first look in these directories and then in
1043 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
1044 will be ignored when running setuid/setgid.
1045
1046 See the rxvtperl(3) manpage.
1047
1048 selection.pattern-*idx*: *perl-regex*
1049 Additional selection patterns, see the rxvtperl(3) manpage for
1050 details.
1051
1052 selection-autotransform.*idx*: *perl-transform*
1053 Selection auto-transform patterns, see the rxvtperl(3) manpage for
1054 details.
1055
1056 searchable-scrollback: *keysym*
1057 Sets the hotkey that starts the incremental scrollback buffer search
1058 (default: "M-s").
1059
1060 urlLauncher: *string*
1061 Specifies the program to be started with a URL argument. Used by the
1062 "selection-popup" and "matcher" perl extensions.
1063
1064 transient-for: *windowid*
1065 Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given
1066 window id.
1067
1068 override-redirect: *boolean*
1069 Compile *frills*: Sets override-redirect for the terminal window,
1070 making it almost invisible to window managers; option
1071 -override-redirect.
1072
1073 iso14755_52: *boolean*
1074 Turn on/off ISO 14755 5.2 mode (default enabled).
739 1075
740THE SCROLLBAR 1076THE SCROLLBAR
741 Lines of text that scroll off the top of the rxvt window (resource: 1077 Lines of text that scroll off the top of the rxvt window (resource:
742 saveLines) and can be scrolled back using the scrollbar or by 1078 saveLines) and can be scrolled back using the scrollbar or by
743 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1079 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
… …
753 normal text selection/insertion, hold either the Shift or the Meta (Alt) 1089 normal text selection/insertion, hold either the Shift or the Meta (Alt)
754 key while performing the desired mouse action. 1090 key while performing the desired mouse action.
755 1091
756 If mouse reporting mode is active, the normal scrollbar actions are 1092 If mouse reporting mode is active, the normal scrollbar actions are
757 disabled -- on the assumption that we are using a fullscreen 1093 disabled -- on the assumption that we are using a fullscreen
758 application. Instead, pressing Button1 and Button3 sends ESC[6~ (Next) 1094 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
759 and ESC[5~ (Prior), respectively. Similarly, clicking on the up and down 1095 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
760 arrows sends ESC[A (Up) and ESC[B (Down), respectively. 1096 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
761 1097
762TEXT SELECTION AND INSERTION 1098THE SELECTION: SELECTING AND PASTING TEXT
763 The behaviour of text selection and insertion mechanism is similar to 1099 The behaviour of text selection and insertion/pasting mechanism is
764 *xterm*(1). 1100 similar to *xterm*(1).
765 1101
766 Selection: 1102 Selecting:
767 Left click at the beginning of the region, drag to the end of the 1103 Left click at the beginning of the region, drag to the end of the
768 region and release; Right click to extend the marked region; Left 1104 region and release; Right click to extend the marked region; Left
769 double-click to select a word; Left triple-click to select the 1105 double-click to select a word; Left triple-click to select the
770 entire line. 1106 entire logical line (which can span multiple screen lines), unless
1107 modified by resource tripleclickwords.
771 1108
772 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 1109 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
773 (Compile: *frills*) will create a rectangular selection instead of a 1110 (Compile: *frills*) will create a rectangular selection instead of a
774 normal one. 1111 normal one. In this mode, every selected row becomes its own line in
1112 the selection, and trailing whitespace is visually underlined and
1113 removed from the selection.
775 1114
776 Insertion: 1115 Pasting:
777 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1116 Pressing and releasing the Middle mouse button in an rxvt window
778 an rxvt window causes the current text selection to be inserted as 1117 causes the value of the PRIMARY selection (or CLIPBOARD with the
779 if it had been typed on the keyboard. 1118 Meta modifier) to be inserted as if it had been typed on the
1119 keyboard.
1120
1121 Pressing Shift-Insert causes the value of the PRIMARY selection to
1122 be inserted too.
780 1123
781CHANGING FONTS 1124CHANGING FONTS
782 Changing fonts (or font sizes, respectively) via the keypad is not yet 1125 Changing fonts (or font sizes, respectively) via the keypad is not yet
783 supported in rxvt-unicode. Bug me if you need this. 1126 supported in rxvt-unicode. Bug me if you need this.
784 1127
785 You can, however, switch fonts at runtime using escape sequences (and 1128 You can, however, switch fonts at runtime using escape sequences, e.g.:
786 therefore using the menubar), e.g.:
787 1129
788 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1130 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1131
1132 You can use keyboard shortcuts, too:
1133
1134 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1135 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
789 1136
790 rxvt-unicode will automatically re-apply these fonts to the output so 1137 rxvt-unicode will automatically re-apply these fonts to the output so
791 far. 1138 far.
792 1139
793ISO 14755 SUPPORT 1140ISO 14755 SUPPORT
… …
795 character codes using the keyboard. It consists of 4 parts. The first 1142 character codes using the keyboard. It consists of 4 parts. The first
796 part is available rxvt-unicode has been compiled with "--enable-frills", 1143 part is available rxvt-unicode has been compiled with "--enable-frills",
797 the rest is available when rxvt-unicode was compiled with 1144 the rest is available when rxvt-unicode was compiled with
798 "--enable-iso14755". 1145 "--enable-iso14755".
799 1146
800 5.1: Basic method 1147 * 5.1: Basic method
801 This allows you to enter unicode characters using their hexcode. 1148 This allows you to enter unicode characters using their hexcode.
802 1149
803 Start by pressing and holding both "Control" and "Shift", then enter 1150 Start by pressing and holding both "Control" and "Shift", then enter
804 hex-digits (between one and six). Releasing "Control" and "Shift" 1151 hex-digits (between one and six). Releasing "Control" and "Shift"
805 will commit the character as if it were typed directly. While 1152 will commit the character as if it were typed directly. While
… …
811 address, which you cannot type. Fortunately, the card has the e-mail 1158 address, which you cannot type. Fortunately, the card has the e-mail
812 address printed as hexcodes, e.g. "671d 65e5". You can enter this 1159 address printed as hexcodes, e.g. "671d 65e5". You can enter this
813 easily by pressing "Control" and "Shift", followed by 1160 easily by pressing "Control" and "Shift", followed by
814 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys. 1161 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys.
815 1162
816 5.2: Keyboard symbols entry method 1163 * 5.2: Keyboard symbols entry method
817 This mode lets you input characters representing the keycap symbols 1164 This mode lets you input characters representing the keycap symbols
818 of your keyboard, if representable in the current locale encoding. 1165 of your keyboard, if representable in the current locale encoding.
819 1166
820 Start by pressing "Control" and "Shift" together, then releasing 1167 Start by pressing "Control" and "Shift" together, then releasing
821 them. The next special key (cursor keys, home etc.) you enter will 1168 them. The next special key (cursor keys, home etc.) you enter will
822 not invoke it's usual function but instead will insert the 1169 not invoke its usual function but instead will insert the
823 corresponding keycap symbol. The symbol will only be entered when 1170 corresponding keycap symbol. The symbol will only be entered when
824 the key has been released, otherwise pressing e.g. "Shift" would 1171 the key has been released, otherwise pressing e.g. "Shift" would
825 enter the symbol for "ISO Level 2 Switch", although your intention 1172 enter the symbol for "ISO Level 2 Switch", although your intention
826 might have been to enter a reverse tab (Shift-Tab). 1173 might have been to enter a reverse tab (Shift-Tab).
827 1174
828 5.3: Screen-selection entry method 1175 * 5.3: Screen-selection entry method
829 While this is implemented already (it's basically the selection 1176 While this is implemented already (it's basically the selection
830 mechanism), it could be extended by displaying a unicode character 1177 mechanism), it could be extended by displaying a unicode character
831 map. 1178 map.
832 1179
833 5.4: Feedback method for identifying displayed characters for later 1180 * 5.4: Feedback method for identifying displayed characters for later
834 input 1181 input
835 This method lets you display the unicode character code associated 1182 This method lets you display the unicode character code associated
836 with characters already displayed. 1183 with characters already displayed.
837 1184
838 You enter this mode by holding down "Control" and "Shift" together, 1185 You enter this mode by holding down "Control" and "Shift" together,
… …
850 both scenario A and B of ISO 14755, including part 5.2. 1197 both scenario A and B of ISO 14755, including part 5.2.
851 1198
852LOGIN STAMP 1199LOGIN STAMP
853 rxvt tries to write an entry into the *utmp*(5) file so that it can be 1200 rxvt tries to write an entry into the *utmp*(5) file so that it can be
854 seen via the *who(1)* command, and can accept messages. To allow this 1201 seen via the *who(1)* command, and can accept messages. To allow this
855 feature, rxvt must be installed setuid root on some systems. 1202 feature, rxvt may need to be installed setuid root on some systems or
1203 setgid to root or to some other group on others.
856 1204
857COLORS AND GRAPHICS 1205COLORS AND GRAPHICS
858 In addition to the default foreground and background colours, rxvt can 1206 In addition to the default foreground and background colours, rxvt can
859 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 1207 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
860 versions of the same). Here is a list of the colours with their rgb.txt 1208 versions of the same). Here is a list of the colours with their names.
861 names.
862 1209
863 color0 (black) = Black 1210 color0 (black) = Black
864 color1 (red) = Red3 1211 color1 (red) = Red3
865 color2 (green) = Green3 1212 color2 (green) = Green3
866 color3 (yellow) = Yellow3 1213 color3 (yellow) = Yellow3
… …
882 It is also possible to specify the colour values of foreground, 1229 It is also possible to specify the colour values of foreground,
883 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1230 background, cursorColor, cursorColor2, colorBD, colorUL as a number
884 0-15, as a convenient shorthand to reference the colour name of 1231 0-15, as a convenient shorthand to reference the colour name of
885 color0-color15. 1232 color0-color15.
886 1233
1234 In addition to the colours defined above, rxvt offers an additional 72
1235 colours. The first 64 of those (with indices 16 to 79) consist of a
1236 4*4*4 RGB colour cube (i.e. *index = r * 16 + g * 4 + b + 16*), followed
1237 by 8 additional shades of gray (with indices 80 to 87).
1238
1239 Together, all those colours implement the 88 colour xterm colours. Only
1240 the first 16 can be changed using resources currently, the rest can only
1241 be changed via command sequences ("escape codes").
1242
887 Note that -rv ("reverseVideo: True") simulates reverse video by always 1243 Note that -rv ("reverseVideo: True") simulates reverse video by always
888 swapping the foreground/background colours. This is in contrast to 1244 swapping the foreground/background colours. This is in contrast to
889 *xterm*(1) where the colours are only swapped if they have not otherwise 1245 *xterm*(1) where the colours are only swapped if they have not otherwise
890 been specified. For example, 1246 been specified. For example,
891 1247
892 rxvt -fg Black -bg White -rv 1248 rxvt -fg Black -bg White -rv
893 would yield White on Black, while on *xterm*(1) it would yield Black 1249 would yield White on Black, while on *xterm*(1) it would yield Black
894 on White. 1250 on White.
895 1251
1252 ALPHA CHANNEL SUPPORT
1253 If Xft support has been compiled in and as long as Xft/Xrender/X don't
1254 get their act together, rxvt-unicode will support
1255 "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4
1256 digits/component) colour specifications, in addition to the ones
1257 provided by X, where the additional A component specifies opacity
1258 (alpha) values. The minimum value of 0 is completely transparent). You
1259 can also prefix any color with "[percent]", where "percent" is a decimal
1260 percentage (0-100) that specifies the opacity of the color, where 0 is
1261 completely transparent and 100 is completelxy opaque.
1262
1263 You probably need to specify "-depth 32", too, and have the luck that
1264 your X-server uses ARGB pixel layout, as X is far from just supporting
1265 ARGB visuals out of the box, and rxvt-unicode just fudges around.
1266
1267 For example, the following selects an almost completely transparent red
1268 background, and an almost opaque pink foreground:
1269
1270 rxvt -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1271
1272 *Please note that transparency of any kind if completely unsupported by
1273 the author. Don't bug him with installation questions!*
1274
896ENVIRONMENT 1275ENVIRONMENT
897 rxvt sets the environment variables TERM, COLORTERM and COLORFGBG. The 1276 rxvt sets and/or uses the following environment variables:
898 environment variable WINDOWID is set to the X window id number of the 1277
899 rxvt window and it also uses and sets the environment variable DISPLAY 1278 TERM
900 to specify which display terminal to use. rxvt uses the environment 1279 Normally set to "rxvt-unicode", unless overwritten at configure
901 variables RXVTPATH and PATH to find XPM files. 1280 time, via resources or on the command line.
1281
1282 COLORTERM
1283 Either "rxvt", "rxvt-xpm", depending on whether rxvt was compiled
1284 with XPM support, and optionally with the added extension "-mono" to
1285 indicate that rxvt-unicode runs on a monochrome screen.
1286
1287 COLORFGBG
1288 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1289 the colour code used as default foreground/text colour (or the
1290 string "default" to indicate that the default-colour escape sequence
1291 is to be used), "bg" is the colour code used as default background
1292 colour (or the string "default"), and "xpm" is the string "default"
1293 if rxvt was compiled with XPM support. Libraries like "ncurses" and
1294 "slang" can (and do) use this information to optimize screen output.
1295
1296 WINDOWID
1297 Set to the (decimal) X Window ID of the rxvt window (the toplevel
1298 window, which usually has subwindows for the scrollbar, the terminal
1299 window and so on).
1300
1301 TERMINFO
1302 Set to the terminfo directory iff rxvt was configured with
1303 "--with-terminfo=PATH".
1304
1305 DISPLAY
1306 Used by rxvt to connect to the display and set to the correct
1307 display in its child processes.
1308
1309 SHELL
1310 The shell to be used for command execution, defaults to "/bin/sh".
1311
1312 RXVT_SOCKET
1313 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1314
1315 Default $HOME/.rxvt-unicode-*<nodename*.
1316
1317 HOME
1318 Used to locate the default directory for the unix domain socket for
1319 daemon communications and to locate various resource files (such as
1320 ".Xdefaults")
1321
1322 XAPPLRESDIR
1323 Directory where various X resource files are being located.
1324
1325 XENVIRONMENT
1326 If set and accessible, gives the name of a X resource file to be
1327 loaded by rxvt.
902 1328
903FILES 1329FILES
904 /etc/utmp
905 System file for login records.
906
907 /usr/lib/X11/rgb.txt 1330 /usr/lib/X11/rgb.txt
908 Color names. 1331 Color names.
909 1332
910SEE ALSO 1333SEE ALSO
911 rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1334 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
912 1335 tty(4), utmp(5)
913BUGS
914 Check the BUGS file for an up-to-date list.
915
916 Cursor change support is not yet implemented.
917
918 Click-and-drag doesn't work with X11 mouse report overriding.
919 1336
920CURRENT PROJECT COORDINATOR 1337CURRENT PROJECT COORDINATOR
921 Project Coordinator 1338 Project Coordinator
922 Marc A. Lehmann rxvt@schmorp.de 1339 Marc A. Lehmann <rxvt-unicode@schmorp.de>
923 1340
924 Web page maintainter
925 Marc A. Lehmann rxvt@schmorp.de
926
927 <http://software.schmorp.de/> 1341 <http://software.schmorp.de/pkg/rxvt-unicode.html>
928 1342
929AUTHORS 1343AUTHORS
930 John Bovey 1344 John Bovey
931 University of Kent, 1992, wrote the original Xvt. 1345 University of Kent, 1992, wrote the original Xvt.
932 1346
… …
943 1357
944 Oezguer Kesim <kesim@math.fu-berlin.de> 1358 Oezguer Kesim <kesim@math.fu-berlin.de>
945 Project Coordinator (changes.txt 2.21a to 2.4.5) 1359 Project Coordinator (changes.txt 2.21a to 2.4.5)
946 1360
947 Geoff Wing <gcw@pobox.com> 1361 Geoff Wing <gcw@pobox.com>
948 Rewrote screen display and text selection routines. Project 1362 Rewrote screen display and text selection routines.
1363
949 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1364 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
950 1365
951 Marc Alexander Lehmann <rxvt@schmorp.de> 1366 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
952 Forked rxvt-unicode, rewrote most of the display code and internal 1367 Forked rxvt-unicode, unicode support, rewrote almost all the code,
953 character handling to store text in unicode, improve xterm 1368 perl extension, random hacks, numerous bugfixes and extensions.
954 compatibility and apply numerous other bugfixes and extensions.
955 1369
956 Project Coordinator (Changes 1.0 -) 1370 Project Coordinator (Changes 1.0 -)
957 1371
1372 Emanuele Giaquinta <e.giaquinta@glauco.it>
1373 Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1374

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines