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.29 by root, Mon Jan 2 15:11:05 2006 UTC vs.
Revision 1.71 by root, Fri Nov 23 13:11:31 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 6.2, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 8.6, 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. That document is also 17 and answer to them and some common problems. That document is also
18 accessible on the World-Wide-Web at 18 accessible on the World-Wide-Web at
19 <http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 19 <http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
20 20
21RXVT-UNICODE VS. RXVT 21RXVT-UNICODE VS. RXVT
22 Unlike the original rxvt, rxvt-unicode stores all text in Unicode 22 Unlike the original rxvt, rxvt-unicode stores all text in Unicode
23 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
24 world. Being a terminal emulator, however, some things are very 24 world. Being a terminal emulator, however, some things are very
25 difficult, especially cursive scripts such as arabic, vertically written 25 difficult, especially cursive scripts such as arabic, vertically written
26 scripts like mongolian or scripts requiring extremely complex combining 26 scripts like mongolian or scripts requiring extremely complex combining
27 rules, like tibetan or devenagari. Don't expect pretty output when using 27 rules, like tibetan or devanagari. Don't expect pretty output when using
28 these scripts. Most other scripts, latin, cyrillic, kanji, thai etc. 28 these scripts. Most other scripts, latin, cyrillic, kanji, thai etc.
29 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
30 scripts, such as hebrew: rxvt-unicode adopts the view that bidirectional 30 scripts, such as hebrew: rxvt-unicode adopts the view that bidirectional
31 algorithms belong into the application, not the terminal emulator (too 31 algorithms belong into the application, not the terminal emulator (too
32 many things -- such as cursor-movement while editing -- break 32 many things -- such as cursor-movement while editing -- break
33 otherwise), but that might change. 33 otherwise), but that might change.
34 34
35 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
36 me recommend "mlterm", which is a very userfriendly, lean and clean 36 me recommend "mlterm", which is a very user friendly, lean and clean
37 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
38 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
39 another for japanese. 39 another for japanese.
40 40
41 Therefore another design rationale was the use of multiple fonts to 41 Therefore another design rationale was the use of multiple fonts to
42 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
43 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
44 able to choose any font for any script freely. 44 to choose any font for any script freely.
45 45
46 Apart from that, rxvt-unicode is also much better internationalised than 46 Apart from that, rxvt-unicode is also much better internationalised than
47 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
48 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
49 original rxvt. This all in addition to dozens of other small 49 original rxvt. This all in addition to dozens of other small
50 improvements. 50 improvements.
51 51
52 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
53 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
54 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
55 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
56 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
57 drastically reduces memory usage. See rxvtd(1) (daemon) and rxvtc(1) 57 drastically reduces memory usage. See rxvtd(1) (daemon) and rxvtc(1)
58 (client). 58 (client).
59 59
60 It also makes technical information about escape sequences (which have 60 It also makes technical information about escape sequences (which have
61 been extended) easier accessible: see rxvt(7) for technical reference 61 been extended) more accessible: see rxvt(7) for technical reference
62 documentation (escape sequences etc.). 62 documentation (escape sequences etc.).
63 63
64OPTIONS 64OPTIONS
65 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
66 keeping with the smaller-is-better philosophy, options may be eliminated 66 keeping with the smaller-is-better philosophy, options may be eliminated
… …
84 -display *displayname* 84 -display *displayname*
85 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
86 respected). In the absence of this option, the display specified by 86 respected). In the absence of this option, the display specified by
87 the DISPLAY environment variable is used. 87 the DISPLAY environment variable is used.
88 88
89 -depth *bitdepth*
90 Compile *xft*: Attempt to find a visual with the given bit depth;
91 resource depth.
92
89 -geometry *geom* 93 -geometry *geom*
90 Window geometry (-g still respected); resource geometry. 94 Window geometry (-g still respected); resource geometry.
91 95
92 -rv|+rv 96 -rv|+rv
93 Turn on/off simulated reverse video; resource reverseVideo. 97 Turn on/off simulated reverse video; resource reverseVideo.
94 98
95 -j|+j 99 -j|+j
96 Turn on/off jump scrolling; resource jumpScroll. 100 Turn on/off jump scrolling (allow multiple lines per refresh);
101 resource jumpScroll.
97 102
98 -ip|+ip | -tr|+tr 103 -ss|+ss
99 Turn on/off inheriting parent window's pixmap. Alternative form is 104 Turn on/off skip scrolling (allow multiple screens per refresh);
100 -tr; resource inheritPixmap. 105 resource skipScroll.
106
107 -tr|+tr
108 Turn on/off illusion of a transparent window background. Obsolete
109 form of it is -ip and it should not be used anymore; resource
110 transparent.
111
112 *Please note that old resource name of inheritPixmap is obsolete and
113 should be changed to transparent. Backwards compatibility support
114 for inheritPixmap will be phased out in future versions of rxvt!*
115
116 *Please address all transparency related issues to Sasha Vasko at
117 sasha@aftercode.net. Read the FAQ (man 7 rxvt)!*
101 118
102 -fade *number* 119 -fade *number*
103 Fade the text by the given percentage when focus is lost. Small 120 Fade the text by the given percentage when focus is lost. Small
104 values fade a little only, 100 completely replaces all colours by 121 values fade a little only, 100 completely replaces all colours by
105 the fade colour; resource fading. 122 the fade colour; resource fading.
106 123
107 -fadecolor *colour* 124 -fadecolor *colour*
108 Fade to this colour when fading is used (see -fade). The default 125 Fade to this colour when fading is used (see -fade). The default
109 colour is black. resource fadeColor. 126 colour is opaque black. resource fadeColor.
110 127
111 -tint *colour* 128 -tint *colour*
112 Tint the transparent background pixmap with the given colour when 129 Tint the transparent background pixmap with the given colour when
113 transparency is enabled with -tr or -ip. This only works for 130 transparency is enabled with -tr. This only works for non-tiled
114 non-tiled backgrounds, currently. See also the -sh option that can 131 backgrounds, currently. See also the -sh option that can be used to
115 be used to brighten or darken the image in addition to tinting it; 132 brighten or darken the image in addition to tinting it. Please note
133 that certain tint colours can be applied on the server-side, thus
134 yielding performance gain of two orders of magnitude. These colours
135 are: blue, red, green, cyan, magenta, yellow, and those close to
136 them. Also pure black and pure white colors essentially mean no
116 resource *tintColor*. Example: 137 tinting; resource *tintColor*. Example:
117 138
118 rxvt -tr -tint blue -sh 40 139 rxvt -tr -tint blue -sh 40
119 140
120 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent 141 -sh *number*
121 background image in addition to tinting it (i.e. -tint must be 142 Darken (0 .. 100) or lighten (100 .. 200) the transparent background
122 specified, too, e.g. "-tint white"). 143 image in addition to (or instead of) tinting it; resource *shading*.
144
145 -blt *string*
146 Specify background blending type. If background pixmap is specified
147 at the same time as transparency - such pixmap will be blended over
148 transparency image, using method specified. Supported values are :
149 add, alphablend, allanon - color values averaging, colorize, darken,
150 diff, dissipate, hue, lighten, overlay, saturate, screen, sub, tint,
151 value. The default is alpha-blending. Compile *afterimage*; resource
152 *blendType*.
153
154 -blr *HxV*
155 Apply Gaussian Blur with the specified radii to the transparent
156 background image. If single number is specified - both vertical and
157 horizontal radii are considered to be the same. Setting one of the
158 radii to 1 and another to a large number creates interesting effects
159 on some backgrounds. Maximum radius value is 128. Compile
160 *afterimage*; resource *blurRadius*.
123 161
124 -bg *colour* 162 -bg *colour*
125 Window background colour; resource background. 163 Window background colour; resource background.
126 164
127 -fg *colour* 165 -fg *colour*
128 Window foreground colour; resource foreground. 166 Window foreground colour; resource foreground.
129 167
130 -pixmap *file[;geom]* 168 -pixmap *file[;geom[:op1][:op2][...]]*
131 Compile *XPM*: Specify XPM file for the background and also 169 Compile *afterimage*: Specify image file for the background and also
132 optionally specify its scaling with a geometry string. Note you may 170 optionally specify its scaling with a geometry string. Note you may
133 need to add quotes to avoid special shell interpretation of the ";" 171 need to add quotes to avoid special shell interpretation of the ";"
134 in the command-line; resource backgroundPixmap. 172 in the command-line; for more details see resource backgroundPixmap.
135 173
136 -cr *colour* 174 -cr *colour*
137 The cursor colour; resource cursorColor. 175 The cursor colour; resource cursorColor.
138 176
139 -pr *colour* 177 -pr *colour*
… …
146 The colour of the border around the text area and between the 184 The colour of the border around the text area and between the
147 scrollbar and the text; resource borderColor. 185 scrollbar and the text; resource borderColor.
148 186
149 -fn *fontlist* 187 -fn *fontlist*
150 Select the fonts to be used. This is a comma separated list of font 188 Select the fonts to be used. This is a comma separated list of font
151 names that are used in turn when trying to display Unicode 189 names that are checked in order when trying to find glyphs for
152 characters. The first font defines the cell size for characters; 190 characters. The first font defines the cell size for characters;
153 other fonts might be smaller, but not (in general) larger. A 191 other fonts might be smaller, but not (in general) larger. A
154 (hopefully) reasonable default font list is always appended to it. 192 (hopefully) reasonable default font list is always appended to it.
155 See resource font for more details. 193 See resource font for more details.
156 194
157 In short, to specify an X11 core font, just specify it's name or 195 In short, to specify an X11 core font, just specify its name or
158 prefix it with "x:". To specify an XFT-font, you need to prefix it 196 prefix it with "x:". To specify an XFT-font, you need to prefix it
159 with "xft:", e.g.: 197 with "xft:", e.g.:
160 198
161 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 199 rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
162 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono" 200 rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
163 201
164 See also the question "How does rxvt-unicode choose fonts?" in the 202 See also the question "How does rxvt-unicode choose fonts?" in the
165 FAQ section of rxvt(7). 203 FAQ section of rxvt(7).
166 204
167 -fb *fontlist* 205 -fb *fontlist*
168 Compile font-styles: The bold font list to use when bold characters 206 Compile *font-styles*: The bold font list to use when bold
169 are to be printed. See resource boldFont for details. 207 characters are to be printed. See resource boldFont for details.
170 208
171 -fi *fontlist* 209 -fi *fontlist*
172 Compile font-styles: The italic font list to use when bold 210 Compile *font-styles*: The italic font list to use when *italic*
173 characters are to be printed. See resource italicFont for details. 211 characters are to be printed. See resource italicFont for details.
174 212
175 -fbi *fontlist* 213 -fbi *fontlist*
176 Compile font-styles: The bold italic font list to use when bold 214 Compile *font-styles*: The bold italic font list to use when *bold
177 characters are to be printed. See resource boldItalicFont for 215 italic* characters are to be printed. See resource boldItalicFont
178 details. 216 for details.
179 217
180 -is|+is 218 -is|+is
181 Compile font-styles: Bold/Italic font styles imply high intensity 219 Compile *font-styles*: Bold/Italic font styles imply high intensity
182 foreground/background (default). See resource intensityStyles for 220 foreground/background (default). See resource intensityStyles for
183 details. 221 details.
184 222
185 -name *name* 223 -name *name*
186 Specify the application name under which resources are to be 224 Specify the application name under which resources are to be
… …
252 290
253 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e. 291 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e.
254 if honoured by the WM, the rxvt-unicode window will not have window 292 if honoured by the WM, the rxvt-unicode window will not have window
255 decorations; resource borderLess. 293 decorations; resource borderLess.
256 294
295 -override-redirect
296 Compile *frills*: Sets override-redirect on the window; resource
297 override-redirect.
298
299 -sbg
300 Compile *frills*: Disable the usage of the built-in block
301 graphics/line drawing characters and just rely on what the specified
302 fonts provide. Use this if you have a good font and want to use its
303 block graphic glyphs; resource skipBuiltinGlyphs.
304
257 -lsp *number* 305 -lsp *number*
258 Compile *frills*: Lines (pixel height) to insert between each row of 306 Compile *frills*: Lines (pixel height) to insert between each row of
259 the display. Useful to work around font rendering problems; resource 307 the display. Useful to work around font rendering problems; resource
260 linespace. 308 lineSpace.
261 309
262 -tn *termname* 310 -tn *termname*
263 This option specifies the name of the terminal type to be set in the 311 This option specifies the name of the terminal type to be set in the
264 TERM environment variable. This terminal type must exist in the 312 TERM environment variable. This terminal type must exist in the
265 *termcap(5)* database and should have *li#* and *co#* entries; 313 *termcap(5)* database and should have *li#* and *co#* entries;
… …
309 Set the font set to use for the X Input Method, see resource imFont 357 Set the font set to use for the X Input Method, see resource imFont
310 for more info. 358 for more info.
311 359
312 -tcw 360 -tcw
313 Change the meaning of triple-click selection with the left mouse 361 Change the meaning of triple-click selection with the left mouse
362 button. Only effective when the original (non-perl) selection code
314 button. Instead of selecting a full line it will extend the 363 is in-use. Instead of selecting a full line it will extend the
315 selection the end of the logical line only. resource 364 selection the end of the logical line only. resource
316 tripleclickwords. 365 tripleclickwords.
317 366
318 -insecure 367 -insecure
319 Enable "insecure" mode, which currently enables most of the escape 368 Enable "insecure" mode, which currently enables most of the escape
… …
336 Turn on/off hold window after exit support. If enabled, rxvt will 385 Turn on/off hold window after exit support. If enabled, rxvt will
337 not immediately destroy its window when the program executed within 386 not immediately destroy its window when the program executed within
338 it exits. Instead, it will wait till it is being killed or closed by 387 it exits. Instead, it will wait till it is being killed or closed by
339 the user; resource hold. 388 the user; resource hold.
340 389
390 -xrm *string*
391 Works like the X Toolkit option of the same name, by adding the
392 *string* as if it were specified in a resource file. Resource values
393 specified this way take precedence over all other resource
394 specifications.
395
396 Note that you need to use the *same* syntax as in the .Xdefaults
397 file, e.g. "*.background: black". Also note that all rxvt-specific
398 options can be specified as long-options on the commandline, so use
399 of -xrm is mostly limited to cases where you want to specify other
400 resources (e.g. for input methods) or for compatibility with other
401 programs.
402
341 -keysym.*sym* *string* 403 -keysym.*sym* *string*
342 Remap a key symbol. See resource keysym. 404 Remap a key symbol. See resource keysym.
343 405
344 -embed *windowid* 406 -embed *windowid*
345 Tells rxvt to embed it's windows into an already-existing window, 407 Tells rxvt to embed its windows into an already-existing window,
346 which enables applications to easily embed a terminal. 408 which enables applications to easily embed a terminal.
347 409
348 Right now, rxvt will first unmap/map the specified window, so it 410 Right now, rxvt will first unmap/map the specified window, so it
349 shouldn't be a top-level window. rxvt will also reconfigure it quite 411 shouldn't be a top-level window. rxvt will also reconfigure it quite
350 a bit, so don't expect it to keep some specific state. It's best to 412 a bit, so don't expect it to keep some specific state. It's best to
… …
353 The window will not be destroyed when rxvt exits. 415 The window will not be destroyed when rxvt exits.
354 416
355 It might be useful to know that rxvt will not close file descriptors 417 It might be useful to know that rxvt will not close file descriptors
356 passed to it (except for stdin/out/err, of course), so you can use 418 passed to it (except for stdin/out/err, of course), so you can use
357 file descriptors to communicate with the programs within the 419 file descriptors to communicate with the programs within the
358 terminal. This works regardless of wether the "-embed" option was 420 terminal. This works regardless of whether the "-embed" option was
359 used or not. 421 used or not.
360 422
361 Here is a short Gtk2-perl snippet that illustrates how this option 423 Here is a short Gtk2-perl snippet that illustrates how this option
362 can be used (a longer example is in doc/embed): 424 can be used (a longer example is in doc/embed):
363 425
… …
365 $rxvt->signal_connect_after (realize => sub { 427 $rxvt->signal_connect_after (realize => sub {
366 my $xid = $_[0]->window->get_xid; 428 my $xid = $_[0]->window->get_xid;
367 system "rxvt -embed $xid &"; 429 system "rxvt -embed $xid &";
368 }); 430 });
369 431
370 -pty-fd *fileno* 432 -pty-fd *file descriptor*
371 Tells rxvt NOT to execute any commands or create a new pty/tty pair 433 Tells rxvt NOT to execute any commands or create a new pty/tty pair
372 but instead use the given filehandle as the tty master. This is 434 but instead use the given file descriptor as the tty master. This is
373 useful if you want to drive rxvt as a generic terminal emulator 435 useful if you want to drive rxvt as a generic terminal emulator
374 without having to run a program within it. 436 without having to run a program within it.
375 437
376 If this switch is given, rxvt will not create any utmp/wtmp entries 438 If this switch is given, rxvt will not create any utmp/wtmp entries
377 and will not tinker with pty/tty permissions - you have to do that 439 and will not tinker with pty/tty permissions - you have to do that
378 yourself if you want that. 440 yourself if you want that.
441
442 As an extremely special case, specifying -1 will completely suppress
443 pty/tty operations.
379 444
380 Here is a example in perl that illustrates how this option can be 445 Here is a example in perl that illustrates how this option can be
381 used (a longer example is in doc/pty-fd): 446 used (a longer example is in doc/pty-fd):
382 447
383 use IO::Pty; 448 use IO::Pty;
… …
390 455
391 # now communicate with rxvt 456 # now communicate with rxvt
392 my $slave = $pty->slave; 457 my $slave = $pty->slave;
393 while (<$slave>) { print $slave "got <$_>\n" } 458 while (<$slave>) { print $slave "got <$_>\n" }
394 459
460 -pe *string*
461 Comma-separated list of perl extension scripts to use (or not to
462 use) in this terminal instance. See resource perl-ext for details.
463
395RESOURCES (available also as long-options) 464RESOURCES (available also as long-options)
396 Note: `rxvt --help' gives a list of all resources (long options) 465 Note: `rxvt --help' gives a list of all resources (long options)
397 compiled into your version. 466 compiled into your version.
398 467
399 There are two different methods that rxvt can use to get the Xresource
400 data: using the X libraries (Xrm*-functions) or internal Xresources
401 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
402 XGetDefaults), you can set and change the resources using X11 tools like 468 You can set and change the resources using X11 tools like xrdb. Many
403 xrdb. Many distribution do also load settings from the ~/.Xresources 469 distribution do also load settings from the ~/.Xresources file when X
404 file when X starts. rxvt will consult the following files/resources in 470 starts. rxvt will consult the following files/resources in order, with
405 order, with later settings overwriting earlier ones: 471 later settings overwriting earlier ones:
406 472
407 1. system-wide app-defaults file, either locale-dependent OR global 473 1. system-wide app-defaults file, either locale-dependent OR global
408 2. app-defaults file in $XAPPLRESDIR 474 2. app-defaults file in $XAPPLRESDIR
409 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 475 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
410 4. SCREEN_RESOURCES for the current screen 476 4. SCREEN_RESOURCES for the current screen
411 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 477 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
478 6. resources specified via -xrm on the commandline
412 479
413 If compiled with internal Xresources support (i.e. rxvt -h lists 480 Note that when reading X resources, rxvt recognizes two class names:
414 .Xdefaults) then rxvt accepts application defaults set in 481 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
415 XAPPLOADDIR/URxvt (compile-time defined: usually 482 and the original *rxvt* to be easily configured, while the class name
416 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 483 URxvt allows resources unique to rxvt, to be shared between different
417 ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X
418 resources, rxvt recognizes two class names: XTerm and URxvt. The class
419 name Rxvt allows resources common to both rxvt and the original *rxvt*
420 to be easily configured, while the class name URxvt allows resources
421 unique to rxvt, notably colours and key-handling, to be shared between
422 different rxvt configurations. If no resources are specified, suitable 484 rxvt configurations. If no resources are specified, suitable defaults
423 defaults will be used. Command-line arguments can be used to override 485 will be used. Command-line arguments can be used to override resource
424 resource settings. The following resources are allowed: 486 settings. The following resources are supported (you might want to check
487 the rxvtperl(3) manpage for additional settings by perl extensions not
488 documented here):
489
490 depth: *bitdepth*
491 Compile *xft*: Attempt to find a visual with the given bit depth;
492 option -depth.
425 493
426 geometry: *geom* 494 geometry: *geom*
427 Create the window with the specified X window geometry [default 495 Create the window with the specified X window geometry [default
428 80x24]; option -geometry. 496 80x24]; option -geometry.
429 497
… …
461 Use the specified colour to display underlined characters when the 529 Use the specified colour to display underlined characters when the
462 foreground colour is the default. 530 foreground colour is the default.
463 531
464 colorRV: *colour* 532 colorRV: *colour*
465 Use the specified colour as the background for reverse video 533 Use the specified colour as the background for reverse video
466 characters. 534 characters when OPTION_HC is disabled (--disable-frills).
467 535
468 underlineColor: *colour* 536 underlineColor: *colour*
469 If set, use the specified colour as the colour for the underline 537 If set, use the specified colour as the colour for the underline
470 itself. If unset, use the foreground colour. 538 itself. If unset, use the foreground colour.
471 539
… …
482 True: simulate reverse video by foreground and background colours; 550 True: simulate reverse video by foreground and background colours;
483 option -rv. False: regular screen colours [default]; option +rv. See 551 option -rv. False: regular screen colours [default]; option +rv. See
484 note in COLORS AND GRAPHICS section. 552 note in COLORS AND GRAPHICS section.
485 553
486 jumpScroll: *boolean* 554 jumpScroll: *boolean*
487 True: specify that jump scrolling should be used. When scrolling 555 True: specify that jump scrolling should be used. When receiving
488 quickly, fewer screen updates are performed [default]; option -j. 556 lots of lines, rxvt will only scroll once a whole screen height of
557 lines has been read, resulting in fewer updates while still
558 displaying every received line; option -j.
559
489 False: specify that smooth scrolling should be used; option +j. 560 False: specify that smooth scrolling should be used. rxvt will force
561 a screen refresh on each new line it received; option +j.
562
563 skipScroll: *boolean*
564 True: (the default) specify that skip scrolling should be used. When
565 receiving lots of lines, rxvt will only scroll once in a while
566 (around 60 times per second), resulting in far fewer updates. This
567 can result in rxvt not ever displaying some of the lines it
568 receives; option -ss.
569
570 False: specify that everything is to be displayed, even if the
571 refresh is too fast for the human eye to read anything (or the
572 monitor to display anything); option +ss.
490 573
491 inheritPixmap: *boolean* 574 inheritPixmap: *boolean*
492 True: make the background inherit the parent windows' pixmap, giving 575 True: make the background inherit the parent windows' pixmap, giving
493 artificial transparency. False: do not inherit the parent windows' 576 artificial transparency. False: do not inherit the parent windows'
494 pixmap. 577 pixmap.
495 578
579 *Please note that transparency of any kind if completely unsupported
580 by the author. Don't bug him with installation questions!*
581
496 fading: *number* 582 fading: *number*
497 Fade the text by the given percentage when focus is lost; option 583 Fade the text by the given percentage when focus is lost; option
498 -fade. 584 -fade.
499 585
500 fadeColor: *colour* 586 fadeColor: *colour*
… …
505 Tint the transparent background pixmap with the given colour; option 591 Tint the transparent background pixmap with the given colour; option
506 -tint. 592 -tint.
507 593
508 shading: *number* 594 shading: *number*
509 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 595 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
510 image in addition to tinting it. 596 image in addition to tinting it; option -sh.
597
598 blendType: *string*
599 Specify background blending type; option -blt.
600
601 blurRadius: *number*
602 Apply Gaussian Blurr with the specified radius to the transparent
603 background image; option -blr.
511 604
512 scrollColor: *colour* 605 scrollColor: *colour*
513 Use the specified colour for the scrollbar [default #B2B2B2]. 606 Use the specified colour for the scrollbar [default #B2B2B2].
514 607
515 troughColor: *colour* 608 troughColor: *colour*
… …
518 611
519 borderColor: *colour* 612 borderColor: *colour*
520 The colour of the border around the text area and between the 613 The colour of the border around the text area and between the
521 scrollbar and the text. 614 scrollbar and the text.
522 615
523 backgroundPixmap: *file[;geom]* 616 backgroundPixmap: *file[;geom[:op1][:op2][...]]*
524 Use the specified XPM file (note the `.xpm' extension is optional) 617 Use the specified image file for the background and also optionally
525 for the background and also optionally specify its scaling with a 618 specify its scaling with a geometry string WxH+X+Y, (default
526 geometry string WxH+X+Y, in which "W" / "H" specify the 619 "0x0+50+50") in which "W" / "H" specify the horizontal/vertical
527 horizontal/vertical scale (percent) and "X" / "Y" locate the image 620 scale (percent), and "X" / "Y" locate the image centre (percent). A
528 centre (percent). A scale of 0 displays the image with tiling. A
529 scale of 1 displays the image without any scaling. A scale of 2 to 9 621 scale of 0 displays the image with tiling. A scale of 1 displays the
530 specifies an integer number of images in that direction. No image 622 image without any scaling. A scale of 2 to 9 specifies an integer
531 will be magnified beyond 10 times its original size. The maximum 623 number of images in that direction. No image will be magnified
532 permitted scale is 1000. [default 0x0+50+50] 624 beyond 10 times its original size. The maximum permitted scale is
625 1000. Additional operations can be specified after colon
626 :op1:op2.... Supported operations are:
533 627
534 menu: *file[;tag]* 628 tile force background image to be tiled and not scaled. Equivalent to 0x0,
535 Read in the specified menu file (note the `.menu' extension is 629 propscale will scale image keeping proportions,
536 optional) and also optionally specify a starting tag to find. See 630 auto will scale image to match window size. Equivalent to 100x100;
537 the reference documentation for details on the syntax for the 631 hscale will scale image horizontally to the window size;
538 menuBar. 632 vscale will scale image vertically to the window size;
633 scale will scale image to match window size;
634 root will tile image as if it was a root window background, auto-adjusting
635 whenever terminal window moves.
636
637 If used in conjunction with -tr option, the specified pixmap will be
638 blended over transparency image using either alpha-blending, or any
639 other blending type, specified with -blt "type" option.
539 640
540 path: *path* 641 path: *path*
541 Specify the colon-delimited search path for finding files (XPM and 642 Specify the colon-delimited search path for finding background image
542 menus), in addition to the paths specified by the RXVTPATH and PATH 643 files.
543 environment variables.
544 644
545 font: *fontlist* 645 font: *fontlist*
546 Select the fonts to be used. This is a comma separated list of font 646 Select the fonts to be used. This is a comma separated list of font
547 names that are used in turn when trying to display Unicode 647 names that are checked in order when trying to find glyphs for
548 characters. The first font defines the cell size for characters; 648 characters. The first font defines the cell size for characters;
549 other fonts might be smaller, but not larger. A reasonable default 649 other fonts might be smaller, but not (in general) larger. A
550 font list is always appended to it. option -fn. 650 (hopefully) reasonable default font list is always appended to it;
651 option -fn.
551 652
552 Each font can either be a standard X11 core font (XLFD) name, with 653 Each font can either be a standard X11 core font (XLFD) name, with
553 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 654 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
554 "xft:". 655 "xft:".
555 656
… …
558 available hint currently is "codeset=codeset-name", and this is only 659 available hint currently is "codeset=codeset-name", and this is only
559 used for Xft fonts. 660 used for Xft fonts.
560 661
561 For example, this font resource 662 For example, this font resource
562 663
563 URxvt*font: 9x15bold,\ 664 URxvt.font: 9x15bold,\
564 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 665 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
565 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 666 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
566 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 667 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
567 xft:Code2000:antialias=false 668 xft:Code2000:antialias=false
568 669
… …
604 normal text font will being used for the given style. 705 normal text font will being used for the given style.
605 706
606 intensityStyles: *boolean* 707 intensityStyles: *boolean*
607 When font styles are not enabled, or this option is enabled (True, 708 When font styles are not enabled, or this option is enabled (True,
608 option -is, the default), bold and italic font styles imply high 709 option -is, the default), bold and italic font styles imply high
609 intensity foreground/backround colours. Disabling this option 710 intensity foreground/background colours. Disabling this option
610 (False, option +is) disables this behaviour, the high intensity 711 (False, option +is) disables this behaviour, the high intensity
611 colours are not reachable. 712 colours are not reachable.
612 713
613 selectstyle: *mode* 714 selectstyle: *mode*
614 Set mouse selection style to old which is 2.20, oldword which is 715 Set mouse selection style to old which is 2.20, oldword which is
615 xterm style with 2.20 old word selection, or anything else which 716 xterm style with 2.20 old word selection, or anything else which
616 gives xterm style selection. 717 gives xterm style selection. Only effective when the original
718 (non-perl) selection code is in use.
617 719
618 scrollstyle: *mode* 720 scrollstyle: *mode*
619 Set scrollbar style to rxvt, plain, next or xterm. plain is the 721 Set scrollbar style to rxvt, plain, next or xterm. plain is the
620 author's favourite. 722 author's favourite.
621 723
… …
631 733
632 mapAlert: *boolean* 734 mapAlert: *boolean*
633 True: de-iconify (map) on receipt of a bell character. False: no 735 True: de-iconify (map) on receipt of a bell character. False: no
634 de-iconify (map) on receipt of a bell character [default]. 736 de-iconify (map) on receipt of a bell character [default].
635 737
738 urgentOnBell: *boolean*
739 True: set the urgency hint for the wm on receipt of a bell
740 character. False: do not set the urgency hint [default].
741
636 visualBell: *boolean* 742 visualBell: *boolean*
637 True: use visual bell on receipt of a bell character; option -vb. 743 True: use visual bell on receipt of a bell character; option -vb.
638 False: no visual bell [default]; option +vb. 744 False: no visual bell [default]; option +vb.
639 745
640 loginShell: *boolean* 746 loginShell: *boolean*
… …
654 760
655 The string will be interpreted as if typed into the shell as-is. 761 The string will be interpreted as if typed into the shell as-is.
656 762
657 Example: 763 Example:
658 764
659 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 765 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
660 766
661 This creates a new file in your home directory with the screen 767 This creates a new file in your home directory with the screen
662 contents everytime you hit "Print". 768 contents every time you hit "Print".
663 769
664 scrollBar: *boolean* 770 scrollBar: *boolean*
665 True: enable the scrollbar [default]; option -sb. False: disable the 771 True: enable the scrollbar [default]; option -sb. False: disable the
666 scrollbar; option +sb. 772 scrollbar; option +sb.
667 773
… …
682 do not scroll to bottom when tty receives output; option +si. 788 do not scroll to bottom when tty receives output; option +si.
683 789
684 scrollWithBuffer: *boolean* 790 scrollWithBuffer: *boolean*
685 True: scroll with scrollback buffer when tty receives new lines (and 791 True: scroll with scrollback buffer when tty receives new lines (and
686 scrollTtyOutput is False); option -sw. False: do not scroll with 792 scrollTtyOutput is False); option -sw. False: do not scroll with
687 scrollback buffer when tty recieves new lines; option +sw. 793 scrollback buffer when tty receives new lines; option +sw.
688 794
689 scrollTtyKeypress: *boolean* 795 scrollTtyKeypress: *boolean*
690 True: scroll to bottom when a non-special key is pressed. Special 796 True: scroll to bottom when a non-special key is pressed. Special
691 keys are those which are intercepted by rxvt-unicode for special 797 keys are those which are intercepted by rxvt-unicode for special
692 handling and are not passed onto the shell; option -sk. False: do 798 handling and are not passed onto the shell; option -sk. False: do
… …
707 borderLess: *boolean* 813 borderLess: *boolean*
708 Set MWM hints to request a borderless window, i.e. if honoured by 814 Set MWM hints to request a borderless window, i.e. if honoured by
709 the WM, the rxvt-unicode window will not have window decorations; 815 the WM, the rxvt-unicode window will not have window decorations;
710 option -bl. 816 option -bl.
711 817
818 skipBuiltinGlyphs: *boolean*
819 Compile *frills*: Disable the usage of the built-in block
820 graphics/line drawing characters and just rely on what the specified
821 fonts provide. Use this if you have a good font and want to use its
822 block graphic glyphs; option -sbg.
823
712 termName: *termname* 824 termName: *termname*
713 Specifies the terminal type name to be set in the TERM environment 825 Specifies the terminal type name to be set in the TERM environment
714 variable; option -tn. 826 variable; option -tn.
715 827
716 linespace: *number* 828 lineSpace: *number*
717 Specifies number of lines (pixel height) to insert between each row 829 Specifies number of lines (pixel height) to insert between each row
718 of the display [default 0]; option -lsp. 830 of the display [default 0]; option -lsp.
719 831
720 meta8: *boolean* 832 meta8: *boolean*
721 True: handle Meta (Alt) + keypress to set the 8th bit. False: handle 833 True: handle Meta (Alt) + keypress to set the 8th bit. False: handle
… …
759 The string to send when the delete key (not the keypad delete key) 871 The string to send when the delete key (not the keypad delete key)
760 is pressed. If unset it will send the sequence traditionally 872 is pressed. If unset it will send the sequence traditionally
761 associated with the Execute key. 873 associated with the Execute key.
762 874
763 cutchars: *string* 875 cutchars: *string*
764 The characters used as delimiters for double-click word selection. 876 The characters used as delimiters for double-click word selection
765 The built-in default: 877 (whitespace delimiting is added automatically if resource is given).
766 878
879 When the perl selection extension is in use (the default if compiled
880 in, see the rxvtperl(3) manpage), a suitable regex using these
881 characters will be created (if the resource exists, otherwise, no
882 regex will be created). In this mode, characters outside ISO-8859-1
883 can be used.
884
885 When the selection extension is not used, only ISO-8859-1 characters
886 can be used. If not specified, the built-in default is used:
887
767 BACKSLASH `"'&()*,;<=>?@[]{|} 888 BACKSLASH `"'&()*,;<=>?@[]^{|}
768 889
769 preeditType: *style* 890 preeditType: *style*
770 OverTheSpot, OffTheSpot, Root; option -pt. 891 OverTheSpot, OffTheSpot, Root; option -pt.
771 892
772 inputMethod: *name* 893 inputMethod: *name*
… …
774 895
775 imLocale: *name* 896 imLocale: *name*
776 The locale to use for opening the IM. You can use an "LC_CTYPE" of 897 The locale to use for opening the IM. You can use an "LC_CTYPE" of
777 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for 898 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for
778 the input extension to be able to input japanese characters while 899 the input extension to be able to input japanese characters while
779 staying in another locale. option -imlocale. 900 staying in another locale; option -imlocale.
780 901
781 imFont: *fontset* 902 imFont: *fontset*
782 Specify the font-set used for XIM styles "OverTheSpot" or 903 Specify the font-set used for XIM styles "OverTheSpot" or
783 "OffTheSpot". It must be a standard X font set (XLFD patterns 904 "OffTheSpot". It must be a standard X font set (XLFD patterns
784 separated by commas), i.e. it's not in the same format as the other 905 separated by commas), i.e. it's not in the same format as the other
… …
787 to the base font. option -imfont. 908 to the base font. option -imfont.
788 909
789 tripleclickwords: *boolean* 910 tripleclickwords: *boolean*
790 Change the meaning of triple-click selection with the left mouse 911 Change the meaning of triple-click selection with the left mouse
791 button. Instead of selecting a full line it will extend the 912 button. Instead of selecting a full line it will extend the
792 selection to the end of the logical line only. option -tcw. 913 selection to the end of the logical line only; option -tcw.
793 914
794 insecure: *boolean* 915 insecure: *boolean*
795 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 916 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
796 that echo arbitrary strings like the icon name or the locale. This 917 that echo arbitrary strings like the icon name or the locale. This
797 could be abused if somebody gets 8-bit-clean access to your display, 918 could be abused if somebody gets 8-bit-clean access to your display,
… …
801 xterm, have these sequences enabled by default, which doesn't make 922 xterm, have these sequences enabled by default, which doesn't make
802 it safer, though). 923 it safer, though).
803 924
804 You can enable them by setting this boolean resource or specifying 925 You can enable them by setting this boolean resource or specifying
805 -insecure as an option. At the moment, this enables display-answer, 926 -insecure as an option. At the moment, this enables display-answer,
806 locale, findfont, icon label and window title requests as well as 927 locale, findfont, icon label and window title requests.
807 dynamic menubar dispatch.
808 928
809 modifier: *modifier* 929 modifier: *modifier*
810 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 930 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
811 super, mod1, mod2, mod3, mod4, mod5; option -mod. 931 super, mod1, mod2, mod3, mod4, mod5; option -mod.
812 932
813 answerbackString: *string* 933 answerbackString: *string*
814 Specify the reply rxvt-unicode sends to the shell when an ENQ 934 Specify the reply rxvt-unicode sends to the shell when an ENQ
815 (control-E) character is passed through. It may contain escape 935 (control-E) character is passed through. It may contain escape
816 values as described in the entry on keysym following. 936 values as described in the entry on keysym following.
817 937
818 secondaryScreen: *bool* 938 secondaryScreen: *boolean*
819 Turn on/off secondary screen (default enabled). 939 Turn on/off secondary screen (default enabled).
820 940
821 secondaryScroll: *bool* 941 secondaryScroll: *boolean*
822 Turn on/off secondary screen scroll (default enabled). If the this 942 Turn on/off secondary screen scroll (default enabled). If this
823 option is enabled, scrolls on the secondary screen will change the 943 option is enabled, scrolls on the secondary screen will change the
824 scrollback buffer and switching to/from the secondary screen will 944 scrollback buffer and switching to/from the secondary screen will
825 instead scroll the screen up. 945 instead scroll the screen up.
826 946
827 hold: *bool* 947 hold: *boolean*
828 Turn on/off hold window after exit support. If enabled, rxvt will 948 Turn on/off hold window after exit support. If enabled, rxvt will
829 not immediately destroy its window when the program executed within 949 not immediately destroy its window when the program executed within
830 it exits. Instead, it will wait till it is being killed or closed by 950 it exits. Instead, it will wait till it is being killed or closed by
831 the user. 951 the user.
832 952
… …
849 omitting the prefix XK_. Alternatively you can specify *key* by its 969 omitting the prefix XK_. Alternatively you can specify *key* by its
850 hex keysym value (0x0000 - 0xFFFF). Note that the lookup of *sym*s 970 hex keysym value (0x0000 - 0xFFFF). Note that the lookup of *sym*s
851 is not performed in an exact manner; however, the closest match is 971 is not performed in an exact manner; however, the closest match is
852 assured. 972 assured.
853 973
854 *string* may contain escape values ("\a": bell, "\b": backspace, 974 *string* may contain escape values ("\n": newline, "\000": octal
855 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 975 number), see RESOURCES in "man 7 X" for futher details.
856 "\000": octal number) or verbatim control characters ("^?": delete,
857 "^@": null, "^A" ...) and may be enclosed with double quotes so that
858 it can start or end with whitespace.
859
860 Please note that you need to double the "\" when using
861 "--enable-xgetdefault", as X itself does it's own de-escaping (you
862 can use "\033" instead of "\e" (and so on), which will work with
863 both Xt and rxvt's own processing).
864 976
865 You can define a range of keysyms in one shot by providing a 977 You can define a range of keysyms in one shot by providing a
866 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 978 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimiter
867 `/' should be a character not used by the strings. 979 `/' should be a character not used by the strings.
868 980
869 Its usage can be demonstrated by an example: 981 Its usage can be demonstrated by an example:
870 982
871 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 983 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
… …
880 is interpreted and executed as rxvt's control sequence. For example 992 is interpreted and executed as rxvt's control sequence. For example
881 the following means "change the current locale to "zh_CN.GBK" when 993 the following means "change the current locale to "zh_CN.GBK" when
882 Control-Meta-c is being pressed": 994 Control-Meta-c is being pressed":
883 995
884 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 996 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
997
998 If *string* takes the form "perl:STRING", then the specified STRING
999 is passed to the "on_keyboard_command" perl handler. See the
1000 rxvtperl(3) manpage. For example, the selection extension (activated
1001 via "rxvt -pe selection") listens for "selection:rot13" events:
1002
1003 URxvt.keysym.M-C-c: perl:selection:rot13
885 1004
886 Due the the large number of modifier combinations, a defined key 1005 Due the the large number of modifier combinations, a defined key
887 mapping will match if at *at least* the specified identifiers are 1006 mapping will match if at *at least* the specified identifiers are
888 being set, and no other key mappings with those and more bits are 1007 being set, and no other key mappings with those and more bits are
889 being defined. That means that defining a key map for "a" will 1008 being defined. That means that defining a key map for "a" will
… …
913 info): 1032 info):
914 1033
915 URxvt.keysym.M-C-3: command:\033[8;25;80t 1034 URxvt.keysym.M-C-3: command:\033[8;25;80t
916 URxvt.keysym.M-C-4: command:\033[8;48;110t 1035 URxvt.keysym.M-C-4: command:\033[8;48;110t
917 1036
1037 perl-ext-common: *string*
1038 perl-ext: *string*
1039 Comma-separated list(s) of perl extension scripts (default:
1040 "default") to use in this terminal instance; option -pe.
1041
1042 Extension names can be prefixed with a "-" sign to prohibit using
1043 them. This can be useful to selectively disable some extensions
1044 loaded by default, or specified via the "perl-ext-common" resource.
1045 For example, "default,-selection" will use all the default extension
1046 except "selection".
1047
1048 Extension names can also be followed by an argument in angle
1049 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
1050 for searchable scrollback to Alt/Meta-s). Mentioning the same
1051 extension multiple times with different arguments will pass multiple
1052 arguments to the extension.
1053
1054 Each extension is looked up in the library directories, loaded if
1055 necessary, and bound to the current terminal instance.
1056
1057 If both of these resources are the empty string, then the perl
1058 interpreter will not be initialized. The idea behind two options is
1059 that perl-ext-common will be used for extensions that should be
1060 available to all instances, while perl-ext is used for specific
1061 instances.
1062
1063 perl-eval: *string*
1064 Perl code to be evaluated when all extensions have been registered.
1065 See the rxvtperl(3) manpage. Due to security reasons, this resource
1066 will be ignored when running setuid/setgid.
1067
1068 perl-lib: *path*
1069 Colon-separated list of additional directories that hold extension
1070 scripts. When looking for extensions specified by the "perl"
1071 resource, rxvt will first look in these directories and then in
1072 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
1073 will be ignored when running setuid/setgid.
1074
1075 See the rxvtperl(3) manpage.
1076
1077 selection.pattern-*idx*: *perl-regex*
1078 Additional selection patterns, see the rxvtperl(3) manpage for
1079 details.
1080
1081 selection-autotransform.*idx*: *perl-transform*
1082 Selection auto-transform patterns, see the rxvtperl(3) manpage for
1083 details.
1084
1085 searchable-scrollback: *keysym*
1086 Sets the hotkey that starts the incremental scrollback buffer search
1087 (default: "M-s").
1088
1089 urlLauncher: *string*
1090 Specifies the program to be started with a URL argument. Used by the
1091 "selection-popup" and "matcher" perl extensions.
1092
1093 transient-for: *windowid*
1094 Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given
1095 window id.
1096
1097 override-redirect: *boolean*
1098 Compile *frills*: Sets override-redirect for the terminal window,
1099 making it almost invisible to window managers; option
1100 -override-redirect.
1101
1102 iso14755_52: *boolean*
1103 Turn on/off ISO 14755 5.2 mode (default enabled).
1104
918THE SCROLLBAR 1105THE SCROLLBAR
919 Lines of text that scroll off the top of the rxvt window (resource: 1106 Lines of text that scroll off the top of the rxvt window (resource:
920 saveLines) and can be scrolled back using the scrollbar or by 1107 saveLines) and can be scrolled back using the scrollbar or by
921 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1108 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
922 fairly intuitive. The xterm-scrollbar is without arrows and its 1109 fairly intuitive. The xterm-scrollbar is without arrows and its
… …
935 disabled -- on the assumption that we are using a fullscreen 1122 disabled -- on the assumption that we are using a fullscreen
936 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~ 1123 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
937 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the 1124 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
938 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively. 1125 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
939 1126
940TEXT SELECTION AND INSERTION 1127THE SELECTION: SELECTING AND PASTING TEXT
941 The behaviour of text selection and insertion mechanism is similar to 1128 The behaviour of text selection and insertion/pasting mechanism is
942 *xterm*(1). 1129 similar to *xterm*(1).
943 1130
944 Selection: 1131 Selecting:
945 Left click at the beginning of the region, drag to the end of the 1132 Left click at the beginning of the region, drag to the end of the
946 region and release; Right click to extend the marked region; Left 1133 region and release; Right click to extend the marked region; Left
947 double-click to select a word; Left triple-click to select the 1134 double-click to select a word; Left triple-click to select the
948 entire logical line (which can span multiple screen lines), unless 1135 entire logical line (which can span multiple screen lines), unless
949 modified by resource tripleclickwords. 1136 modified by resource tripleclickwords.
… …
952 (Compile: *frills*) will create a rectangular selection instead of a 1139 (Compile: *frills*) will create a rectangular selection instead of a
953 normal one. In this mode, every selected row becomes its own line in 1140 normal one. In this mode, every selected row becomes its own line in
954 the selection, and trailing whitespace is visually underlined and 1141 the selection, and trailing whitespace is visually underlined and
955 removed from the selection. 1142 removed from the selection.
956 1143
957 Insertion: 1144 Pasting:
958 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1145 Pressing and releasing the Middle mouse button in an rxvt window
959 an rxvt window causes the current text selection to be inserted as 1146 causes the value of the PRIMARY selection (or CLIPBOARD with the
960 if it had been typed on the keyboard. 1147 Meta modifier) to be inserted as if it had been typed on the
1148 keyboard.
1149
1150 Pressing Shift-Insert causes the value of the PRIMARY selection to
1151 be inserted too.
961 1152
962CHANGING FONTS 1153CHANGING FONTS
963 Changing fonts (or font sizes, respectively) via the keypad is not yet 1154 Changing fonts (or font sizes, respectively) via the keypad is not yet
964 supported in rxvt-unicode. Bug me if you need this. 1155 supported in rxvt-unicode. Bug me if you need this.
965 1156
966 You can, however, switch fonts at runtime using escape sequences (and 1157 You can, however, switch fonts at runtime using escape sequences, e.g.:
967 therefore using the menubar), e.g.:
968 1158
969 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1159 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1160
1161 You can use keyboard shortcuts, too:
1162
1163 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1164 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
970 1165
971 rxvt-unicode will automatically re-apply these fonts to the output so 1166 rxvt-unicode will automatically re-apply these fonts to the output so
972 far. 1167 far.
973 1168
974ISO 14755 SUPPORT 1169ISO 14755 SUPPORT
975 ISO 14755 is a standard for entering and viewing unicode characters and 1170 ISO 14755 is a standard for entering and viewing unicode characters and
976 character codes using the keyboard. It consists of 4 parts. The first 1171 character codes using the keyboard. It consists of 4 parts. The first
977 part is available rxvt-unicode has been compiled with "--enable-frills", 1172 part is available if rxvt-unicode has been compiled with
978 the rest is available when rxvt-unicode was compiled with 1173 "--enable-frills", the rest is available when rxvt-unicode was compiled
979 "--enable-iso14755". 1174 with "--enable-iso14755".
980 1175
981 * 5.1: Basic method 1176 * 5.1: Basic method
982 This allows you to enter unicode characters using their hexcode. 1177 This allows you to enter unicode characters using their hexcode.
983 1178
984 Start by pressing and holding both "Control" and "Shift", then enter 1179 Start by pressing and holding both "Control" and "Shift", then enter
… …
998 This mode lets you input characters representing the keycap symbols 1193 This mode lets you input characters representing the keycap symbols
999 of your keyboard, if representable in the current locale encoding. 1194 of your keyboard, if representable in the current locale encoding.
1000 1195
1001 Start by pressing "Control" and "Shift" together, then releasing 1196 Start by pressing "Control" and "Shift" together, then releasing
1002 them. The next special key (cursor keys, home etc.) you enter will 1197 them. The next special key (cursor keys, home etc.) you enter will
1003 not invoke it's usual function but instead will insert the 1198 not invoke its usual function but instead will insert the
1004 corresponding keycap symbol. The symbol will only be entered when 1199 corresponding keycap symbol. The symbol will only be entered when
1005 the key has been released, otherwise pressing e.g. "Shift" would 1200 the key has been released, otherwise pressing e.g. "Shift" would
1006 enter the symbol for "ISO Level 2 Switch", although your intention 1201 enter the symbol for "ISO Level 2 Switch", although your intention
1007 might have been to enter a reverse tab (Shift-Tab). 1202 might have been to enter a reverse tab (Shift-Tab).
1008 1203
… …
1037 setgid to root or to some other group on others. 1232 setgid to root or to some other group on others.
1038 1233
1039COLORS AND GRAPHICS 1234COLORS AND GRAPHICS
1040 In addition to the default foreground and background colours, rxvt can 1235 In addition to the default foreground and background colours, rxvt can
1041 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 1236 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
1042 versions of the same). Here is a list of the colours with their rgb.txt 1237 versions of the same). Here is a list of the colours with their names.
1043 names.
1044 1238
1045 color0 (black) = Black 1239 color0 (black) = Black
1046 color1 (red) = Red3 1240 color1 (red) = Red3
1047 color2 (green) = Green3 1241 color2 (green) = Green3
1048 color3 (yellow) = Yellow3 1242 color3 (yellow) = Yellow3
… …
1064 It is also possible to specify the colour values of foreground, 1258 It is also possible to specify the colour values of foreground,
1065 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1259 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1066 0-15, as a convenient shorthand to reference the colour name of 1260 0-15, as a convenient shorthand to reference the colour name of
1067 color0-color15. 1261 color0-color15.
1068 1262
1263 In addition to the colours defined above, rxvt offers an additional 72
1264 colours. The first 64 of those (with indices 16 to 79) consist of a
1265 4*4*4 RGB colour cube (i.e. *index = r * 16 + g * 4 + b + 16*), followed
1266 by 8 additional shades of gray (with indices 80 to 87).
1267
1268 Together, all those colours implement the 88 colour xterm colours. Only
1269 the first 16 can be changed using resources currently, the rest can only
1270 be changed via command sequences ("escape codes").
1271
1069 Note that -rv ("reverseVideo: True") simulates reverse video by always 1272 Note that -rv ("reverseVideo: True") simulates reverse video by always
1070 swapping the foreground/background colours. This is in contrast to 1273 swapping the foreground/background colours. This is in contrast to
1071 *xterm*(1) where the colours are only swapped if they have not otherwise 1274 *xterm*(1) where the colours are only swapped if they have not otherwise
1072 been specified. For example, 1275 been specified. For example,
1073 1276
1074 rxvt -fg Black -bg White -rv 1277 rxvt -fg Black -bg White -rv
1075 would yield White on Black, while on *xterm*(1) it would yield Black 1278 would yield White on Black, while on *xterm*(1) it would yield Black
1076 on White. 1279 on White.
1077 1280
1281 ALPHA CHANNEL SUPPORT
1282 If Xft support has been compiled in and as long as Xft/Xrender/X don't
1283 get their act together, rxvt-unicode will support
1284 "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4
1285 digits/component) colour specifications, in addition to the ones
1286 provided by X, where the additional A component specifies opacity
1287 (alpha) values. The minimum value of 0 is completely transparent). You
1288 can also prefix any color with "[percent]", where "percent" is a decimal
1289 percentage (0-100) that specifies the opacity of the color, where 0 is
1290 completely transparent and 100 is completelxy opaque.
1291
1292 You probably need to specify "-depth 32", too, and have the luck that
1293 your X-server uses ARGB pixel layout, as X is far from just supporting
1294 ARGB visuals out of the box, and rxvt-unicode just fudges around.
1295
1296 For example, the following selects an almost completely transparent red
1297 background, and an almost opaque pink foreground:
1298
1299 rxvt -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1300
1301 *Please note that transparency of any kind if completely unsupported by
1302 the author. Don't bug him with installation questions!*
1303
1078ENVIRONMENT 1304ENVIRONMENT
1079 rxvt sets and/or uses the following environment variables: 1305 rxvt sets and/or uses the following environment variables:
1080 1306
1081 TERM 1307 TERM
1082 Normally set to "rxvt-unicode", unless overwritten at configure 1308 Normally set to "rxvt-unicode", unless overwritten at configure
1083 time, via resources or on the commandline. 1309 time, via resources or on the command line.
1084 1310
1085 COLORTERM 1311 COLORTERM
1086 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled 1312 Either "rxvt", "rxvt-xpm", depending on whether rxvt was compiled
1087 with XPM support, and optionally with the added extension "-mono" to 1313 with background image support, and optionally with the added
1088 indicate that rxvt-unicode runs on a monochrome screen. 1314 extension "-mono" to indicate that rxvt-unicode runs on a monochrome
1315 screen.
1089 1316
1090 COLORFGBG 1317 COLORFGBG
1091 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is 1318 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1092 the colour code used as default foreground/text colour (or the 1319 the colour code used as default foreground/text colour (or the
1093 string "default" to indicate that the default-colour escape sequence 1320 string "default" to indicate that the default-colour escape sequence
1094 is to be used), "bg" is the colour code used as default background 1321 is to be used), "bg" is the colour code used as default background
1095 colour (or the string "default"), and "xpm" is the string "default" 1322 colour (or the string "default"), and "xpm" is the string "default"
1096 if rxvt was compiled with XPM support. Libraries like "ncurses" and 1323 if rxvt was compiled with background image support. Libraries like
1097 "slang" can (and do) use this information to optimize screen output. 1324 "ncurses" and "slang" can (and do) use this information to optimize
1325 screen output.
1098 1326
1099 WINDOWID 1327 WINDOWID
1100 Set to the (decimal) X Window ID of the rxvt window (the toplevel 1328 Set to the (decimal) X Window ID of the rxvt window (the toplevel
1101 window, which usually has subwindows for the scrollbar, the terminal 1329 window, which usually has subwindows for the scrollbar, the terminal
1102 window and so on). 1330 window and so on).
… …
1105 Set to the terminfo directory iff rxvt was configured with 1333 Set to the terminfo directory iff rxvt was configured with
1106 "--with-terminfo=PATH". 1334 "--with-terminfo=PATH".
1107 1335
1108 DISPLAY 1336 DISPLAY
1109 Used by rxvt to connect to the display and set to the correct 1337 Used by rxvt to connect to the display and set to the correct
1110 display in it's child processes. 1338 display in its child processes.
1111 1339
1112 SHELL 1340 SHELL
1113 The shell to be used for command execution, defaults to "/bin/sh". 1341 The shell to be used for command execution, defaults to "/bin/sh".
1114
1115 RXVTPATH
1116 The path where rxvt looks for support files such as menu and xpm
1117 files.
1118
1119 PATH
1120 Used in the same way as "RXVTPATH".
1121 1342
1122 RXVT_SOCKET 1343 RXVT_SOCKET
1123 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1344 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1124 1345
1125 Default $HOME/.rxvt-unicode-*<nodename*. 1346 Default $HOME/.rxvt-unicode-*<nodename*.
… …
1146 1367
1147CURRENT PROJECT COORDINATOR 1368CURRENT PROJECT COORDINATOR
1148 Project Coordinator 1369 Project Coordinator
1149 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1370 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1150 1371
1151 <http://software.schmorp.de/#rxvt-unicode> 1372 <http://software.schmorp.de/pkg/rxvt-unicode.html>
1152 1373
1153AUTHORS 1374AUTHORS
1154 John Bovey 1375 John Bovey
1155 University of Kent, 1992, wrote the original Xvt. 1376 University of Kent, 1992, wrote the original Xvt.
1156 1377
… …
1167 1388
1168 Oezguer Kesim <kesim@math.fu-berlin.de> 1389 Oezguer Kesim <kesim@math.fu-berlin.de>
1169 Project Coordinator (changes.txt 2.21a to 2.4.5) 1390 Project Coordinator (changes.txt 2.21a to 2.4.5)
1170 1391
1171 Geoff Wing <gcw@pobox.com> 1392 Geoff Wing <gcw@pobox.com>
1172 Rewrote screen display and text selection routines. Project 1393 Rewrote screen display and text selection routines.
1394
1173 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1395 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1174 1396
1175 Marc Alexander Lehmann <rxvt-unicode@schmorp.de> 1397 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1176 Forked rxvt-unicode, rewrote most of the display code and internal 1398 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1177 character handling to store text in unicode, improve xterm 1399 perl extension, random hacks, numerous bugfixes and extensions.
1178 compatibility and apply numerous other bugfixes and extensions.
1179 1400
1180 Project Coordinator (Changes 1.0 -) 1401 Project Coordinator (Changes 1.0 -)
1181 1402
1403 Emanuele Giaquinta <e.giaquinta@glauco.it>
1404 Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1405

Diff Legend

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