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.26 by root, Sat Dec 17 20:55:45 2005 UTC vs.
Revision 1.70 by root, Mon Nov 19 12:02:35 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 5.9, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 8.4, 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
216 for details.
217
218 -is|+is
219 Compile *font-styles*: Bold/Italic font styles imply high intensity
220 foreground/background (default). See resource intensityStyles for
178 details. 221 details.
179 222
180 -name *name* 223 -name *name*
181 Specify the application name under which resources are to be 224 Specify the application name under which resources are to be
182 obtained, rather than the default executable file name. Name should 225 obtained, rather than the default executable file name. Name should
… …
247 290
248 -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.
249 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
250 decorations; resource borderLess. 293 decorations; resource borderLess.
251 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
252 -lsp *number* 305 -lsp *number*
253 Compile *frills*: Lines (pixel height) to insert between each row of 306 Compile *frills*: Lines (pixel height) to insert between each row of
254 the display. Useful to work around font rendering problems; resource 307 the display. Useful to work around font rendering problems; resource
255 linespace. 308 lineSpace.
256 309
257 -tn *termname* 310 -tn *termname*
258 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
259 TERM environment variable. This terminal type must exist in the 312 TERM environment variable. This terminal type must exist in the
260 *termcap(5)* database and should have *li#* and *co#* entries; 313 *termcap(5)* database and should have *li#* and *co#* entries;
… …
267 on the command line. If this option is used, it must be the last on 320 on the command line. If this option is used, it must be the last on
268 the command-line. If there is no -e option then the default is to 321 the command-line. If there is no -e option then the default is to
269 run the program specified by the SHELL environment variable or, 322 run the program specified by the SHELL environment variable or,
270 failing that, *sh(1)*. 323 failing that, *sh(1)*.
271 324
325 Please note that you must specify a program with arguments. If you
326 want to run shell commands, you have to specify the shell, like
327 this:
328
329 rxvt -e sh -c "shell commands"
330
272 -title *text* 331 -title *text*
273 Window title (-T still respected); the default title is the basename 332 Window title (-T still respected); the default title is the basename
274 of the program specified after the -e option, if any, otherwise the 333 of the program specified after the -e option, if any, otherwise the
275 application name; resource title. 334 application name; resource title.
276 335
… …
298 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
299 for more info. 358 for more info.
300 359
301 -tcw 360 -tcw
302 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
303 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
304 selection the end of the logical line only. resource 364 selection the end of the logical line only. resource
305 tripleclickwords. 365 tripleclickwords.
306 366
307 -insecure 367 -insecure
308 Enable "insecure" mode, which currently enables most of the escape 368 Enable "insecure" mode, which currently enables most of the escape
… …
319 379
320 -ssr|+ssr 380 -ssr|+ssr
321 Turn on/off secondary screen scroll (default enabled); resource 381 Turn on/off secondary screen scroll (default enabled); resource
322 secondaryScroll. 382 secondaryScroll.
323 383
384 -hold|+hold
385 Turn on/off hold window after exit support. If enabled, rxvt will
386 not immediately destroy its window when the program executed within
387 it exits. Instead, it will wait till it is being killed or closed by
388 the user; resource hold.
389
324 -keysym.*sym* *string* 390 -keysym.*sym* *string*
325 Remap a key symbol. See resource keysym. 391 Remap a key symbol. See resource keysym.
326 392
327 -embed *windowid* 393 -embed *windowid*
328 Tells rxvt to embed it's windows into an already-existing window, 394 Tells rxvt to embed its windows into an already-existing window,
329 which enables applications to easily embed a terminal. 395 which enables applications to easily embed a terminal.
330 396
331 Right now, rxvt will first unmap/map the specified window, so it 397 Right now, rxvt will first unmap/map the specified window, so it
332 shouldn't be a top-level window. rxvt will also reconfigure it quite 398 shouldn't be a top-level window. rxvt will also reconfigure it quite
333 a bit, so don't expect it to keep some specific state. It's best to 399 a bit, so don't expect it to keep some specific state. It's best to
… …
336 The window will not be destroyed when rxvt exits. 402 The window will not be destroyed when rxvt exits.
337 403
338 It might be useful to know that rxvt will not close file descriptors 404 It might be useful to know that rxvt will not close file descriptors
339 passed to it (except for stdin/out/err, of course), so you can use 405 passed to it (except for stdin/out/err, of course), so you can use
340 file descriptors to communicate with the programs within the 406 file descriptors to communicate with the programs within the
341 terminal. This works regardless of wether the "-embed" option was 407 terminal. This works regardless of whether the "-embed" option was
342 used or not. 408 used or not.
343 409
344 Here is a short Gtk2-perl snippet that illustrates how this option 410 Here is a short Gtk2-perl snippet that illustrates how this option
345 can be used (a longer example is in doc/embed): 411 can be used (a longer example is in doc/embed):
346 412
… …
348 $rxvt->signal_connect_after (realize => sub { 414 $rxvt->signal_connect_after (realize => sub {
349 my $xid = $_[0]->window->get_xid; 415 my $xid = $_[0]->window->get_xid;
350 system "rxvt -embed $xid &"; 416 system "rxvt -embed $xid &";
351 }); 417 });
352 418
353 -pty-fd *fileno* 419 -pty-fd *file descriptor*
354 Tells rxvt NOT to execute any commands or create a new pty/tty pair 420 Tells rxvt NOT to execute any commands or create a new pty/tty pair
355 but instead use the given filehandle as the tty master. This is 421 but instead use the given file descriptor as the tty master. This is
356 useful if you want to drive rxvt as a generic terminal emulator 422 useful if you want to drive rxvt as a generic terminal emulator
357 without having to run a program within it. 423 without having to run a program within it.
358 424
359 If this switch is given, rxvt will not create any utmp/wtmp entries 425 If this switch is given, rxvt will not create any utmp/wtmp entries
360 and will not tinker with pty/tty permissions - you have to do that 426 and will not tinker with pty/tty permissions - you have to do that
361 yourself if you want that. 427 yourself if you want that.
428
429 As an extremely special case, specifying -1 will completely suppress
430 pty/tty operations.
362 431
363 Here is a example in perl that illustrates how this option can be 432 Here is a example in perl that illustrates how this option can be
364 used (a longer example is in doc/pty-fd): 433 used (a longer example is in doc/pty-fd):
365 434
366 use IO::Pty; 435 use IO::Pty;
… …
373 442
374 # now communicate with rxvt 443 # now communicate with rxvt
375 my $slave = $pty->slave; 444 my $slave = $pty->slave;
376 while (<$slave>) { print $slave "got <$_>\n" } 445 while (<$slave>) { print $slave "got <$_>\n" }
377 446
447 -pe *string*
448 Comma-separated list of perl extension scripts to use (or not to
449 use) in this terminal instance. See resource perl-ext for details.
450
378RESOURCES (available also as long-options) 451RESOURCES (available also as long-options)
379 Note: `rxvt --help' gives a list of all resources (long options) 452 Note: `rxvt --help' gives a list of all resources (long options)
380 compiled into your version. 453 compiled into your version.
381 454
382 There are two different methods that rxvt can use to get the Xresource
383 data: using the X libraries (Xrm*-functions) or internal Xresources
384 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
385 XGetDefaults), you can set and change the resources using X11 tools like 455 You can set and change the resources using X11 tools like xrdb. Many
386 xrdb. Many distribution do also load settings from the ~/.Xresources 456 distribution do also load settings from the ~/.Xresources file when X
387 file when X starts. rxvt will consult the following files/resources in 457 starts. rxvt will consult the following files/resources in order, with
388 order, with later settings overwriting earlier ones: 458 later settings overwriting earlier ones:
389 459
390 1. system-wide app-defaults file, either locale-dependent OR global 460 1. system-wide app-defaults file, either locale-dependent OR global
391 2. app-defaults file in $XAPPLRESDIR 461 2. app-defaults file in $XAPPLRESDIR
392 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 462 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
393 4. SCREEN_RESOURCES for the current screen 463 4. SCREEN_RESOURCES for the current screen
394 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 464 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
395 465
396 If compiled with internal Xresources support (i.e. rxvt -h lists 466 Note that when reading X resources, rxvt recognizes two class names:
397 .Xdefaults) then rxvt accepts application defaults set in 467 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
398 XAPPLOADDIR/URxvt (compile-time defined: usually 468 and the original *rxvt* to be easily configured, while the class name
399 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 469 URxvt allows resources unique to rxvt, to be shared between different
400 ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X
401 resources, rxvt recognizes two class names: XTerm and URxvt. The class
402 name Rxvt allows resources common to both rxvt and the original *rxvt*
403 to be easily configured, while the class name URxvt allows resources
404 unique to rxvt, notably colours and key-handling, to be shared between
405 different rxvt configurations. If no resources are specified, suitable 470 rxvt configurations. If no resources are specified, suitable defaults
406 defaults will be used. Command-line arguments can be used to override 471 will be used. Command-line arguments can be used to override resource
407 resource settings. The following resources are allowed: 472 settings. The following resources are supported (you might want to check
473 the rxvtperl(3) manpage for additional settings by perl extensions not
474 documented here):
475
476 depth: *bitdepth*
477 Compile *xft*: Attempt to find a visual with the given bit depth;
478 option -depth.
408 479
409 geometry: *geom* 480 geometry: *geom*
410 Create the window with the specified X window geometry [default 481 Create the window with the specified X window geometry [default
411 80x24]; option -geometry. 482 80x24]; option -geometry.
412 483
… …
444 Use the specified colour to display underlined characters when the 515 Use the specified colour to display underlined characters when the
445 foreground colour is the default. 516 foreground colour is the default.
446 517
447 colorRV: *colour* 518 colorRV: *colour*
448 Use the specified colour as the background for reverse video 519 Use the specified colour as the background for reverse video
449 characters. 520 characters when OPTION_HC is disabled (--disable-frills).
450 521
451 underlineColor: *colour* 522 underlineColor: *colour*
452 If set, use the specified colour as the colour for the underline 523 If set, use the specified colour as the colour for the underline
453 itself. If unset, use the foreground colour. 524 itself. If unset, use the foreground colour.
454 525
… …
465 True: simulate reverse video by foreground and background colours; 536 True: simulate reverse video by foreground and background colours;
466 option -rv. False: regular screen colours [default]; option +rv. See 537 option -rv. False: regular screen colours [default]; option +rv. See
467 note in COLORS AND GRAPHICS section. 538 note in COLORS AND GRAPHICS section.
468 539
469 jumpScroll: *boolean* 540 jumpScroll: *boolean*
470 True: specify that jump scrolling should be used. When scrolling 541 True: specify that jump scrolling should be used. When receiving
471 quickly, fewer screen updates are performed [default]; option -j. 542 lots of lines, rxvt will only scroll once a whole screen height of
543 lines has been read, resulting in fewer updates while still
544 displaying every received line; option -j.
545
472 False: specify that smooth scrolling should be used; option +j. 546 False: specify that smooth scrolling should be used. rxvt will force
547 a screen refresh on each new line it received; option +j.
548
549 skipScroll: *boolean*
550 True: (the default) specify that skip scrolling should be used. When
551 receiving lots of lines, rxvt will only scroll once in a while
552 (around 60 times per second), resulting in far fewer updates. This
553 can result in rxvt not ever displaying some of the lines it
554 receives; option -ss.
555
556 False: specify that everything is to be displayed, even if the
557 refresh is too fast for the human eye to read anything (or the
558 monitor to display anything); option +ss.
473 559
474 inheritPixmap: *boolean* 560 inheritPixmap: *boolean*
475 True: make the background inherit the parent windows' pixmap, giving 561 True: make the background inherit the parent windows' pixmap, giving
476 artificial transparency. False: do not inherit the parent windows' 562 artificial transparency. False: do not inherit the parent windows'
477 pixmap. 563 pixmap.
478 564
565 *Please note that transparency of any kind if completely unsupported
566 by the author. Don't bug him with installation questions!*
567
479 fading: *number* 568 fading: *number*
480 Fade the text by the given percentage when focus is lost; option 569 Fade the text by the given percentage when focus is lost; option
481 -fade. 570 -fade.
482 571
483 fadeColor: *colour* 572 fadeColor: *colour*
… …
488 Tint the transparent background pixmap with the given colour; option 577 Tint the transparent background pixmap with the given colour; option
489 -tint. 578 -tint.
490 579
491 shading: *number* 580 shading: *number*
492 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 581 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
493 image in addition to tinting it. 582 image in addition to tinting it; option -sh.
583
584 blendType: *string*
585 Specify background blending type; option -blt.
586
587 blurRadius: *number*
588 Apply Gaussian Blurr with the specified radius to the transparent
589 background image; option -blr.
494 590
495 scrollColor: *colour* 591 scrollColor: *colour*
496 Use the specified colour for the scrollbar [default #B2B2B2]. 592 Use the specified colour for the scrollbar [default #B2B2B2].
497 593
498 troughColor: *colour* 594 troughColor: *colour*
… …
501 597
502 borderColor: *colour* 598 borderColor: *colour*
503 The colour of the border around the text area and between the 599 The colour of the border around the text area and between the
504 scrollbar and the text. 600 scrollbar and the text.
505 601
506 backgroundPixmap: *file[;geom]* 602 backgroundPixmap: *file[;geom[:op1][:op2][...]]*
507 Use the specified XPM file (note the `.xpm' extension is optional) 603 Use the specified image file for the background and also optionally
508 for the background and also optionally specify its scaling with a 604 specify its scaling with a geometry string WxH+X+Y, (default
509 geometry string WxH+X+Y, in which "W" / "H" specify the 605 "0x0+50+50") in which "W" / "H" specify the horizontal/vertical
510 horizontal/vertical scale (percent) and "X" / "Y" locate the image 606 scale (percent), and "X" / "Y" locate the image centre (percent). A
511 centre (percent). A scale of 0 displays the image with tiling. A
512 scale of 1 displays the image without any scaling. A scale of 2 to 9 607 scale of 0 displays the image with tiling. A scale of 1 displays the
513 specifies an integer number of images in that direction. No image 608 image without any scaling. A scale of 2 to 9 specifies an integer
514 will be magnified beyond 10 times its original size. The maximum 609 number of images in that direction. No image will be magnified
515 permitted scale is 1000. [default 0x0+50+50] 610 beyond 10 times its original size. The maximum permitted scale is
611 1000. Additional operations can be specified after colon
612 :op1:op2.... Supported operations are:
516 613
517 menu: *file[;tag]* 614 tile force background image to be tiled and not scaled. Equivalent to 0x0,
518 Read in the specified menu file (note the `.menu' extension is 615 propscale will scale image keeping proportions,
519 optional) and also optionally specify a starting tag to find. See 616 auto will scale image to match window size. Equivalent to 100x100;
520 the reference documentation for details on the syntax for the 617 hscale will scale image horizontally to the window size;
521 menuBar. 618 vscale will scale image vertically to the window size;
619 scale will scale image to match window size;
620 root will tile image as if it was a root window background, auto-adjusting
621 whenever terminal window moves.
622
623 If used in conjunction with -tr option, the specified pixmap will be
624 blended over transparency image using either alpha-blending, or any
625 other blending type, specified with -blt "type" option.
522 626
523 path: *path* 627 path: *path*
524 Specify the colon-delimited search path for finding files (XPM and 628 Specify the colon-delimited search path for finding background image
525 menus), in addition to the paths specified by the RXVTPATH and PATH 629 files.
526 environment variables.
527 630
528 font: *fontlist* 631 font: *fontlist*
529 Select the fonts to be used. This is a comma separated list of font 632 Select the fonts to be used. This is a comma separated list of font
530 names that are used in turn when trying to display Unicode 633 names that are checked in order when trying to find glyphs for
531 characters. The first font defines the cell size for characters; 634 characters. The first font defines the cell size for characters;
532 other fonts might be smaller, but not larger. A reasonable default 635 other fonts might be smaller, but not (in general) larger. A
533 font list is always appended to it. option -fn. 636 (hopefully) reasonable default font list is always appended to it;
637 option -fn.
534 638
535 Each font can either be a standard X11 core font (XLFD) name, with 639 Each font can either be a standard X11 core font (XLFD) name, with
536 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 640 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
537 "xft:". 641 "xft:".
538 642
… …
541 available hint currently is "codeset=codeset-name", and this is only 645 available hint currently is "codeset=codeset-name", and this is only
542 used for Xft fonts. 646 used for Xft fonts.
543 647
544 For example, this font resource 648 For example, this font resource
545 649
546 URxvt*font: 9x15bold,\ 650 URxvt.font: 9x15bold,\
547 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 651 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
548 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 652 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
549 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 653 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
550 xft:Code2000:antialias=false 654 xft:Code2000:antialias=false
551 655
… …
584 tried. 688 tried.
585 689
586 If set, but empty, then this specific style is disabled and the 690 If set, but empty, then this specific style is disabled and the
587 normal text font will being used for the given style. 691 normal text font will being used for the given style.
588 692
693 intensityStyles: *boolean*
694 When font styles are not enabled, or this option is enabled (True,
695 option -is, the default), bold and italic font styles imply high
696 intensity foreground/background colours. Disabling this option
697 (False, option +is) disables this behaviour, the high intensity
698 colours are not reachable.
699
589 selectstyle: *mode* 700 selectstyle: *mode*
590 Set mouse selection style to old which is 2.20, oldword which is 701 Set mouse selection style to old which is 2.20, oldword which is
591 xterm style with 2.20 old word selection, or anything else which 702 xterm style with 2.20 old word selection, or anything else which
592 gives xterm style selection. 703 gives xterm style selection. Only effective when the original
704 (non-perl) selection code is in use.
593 705
594 scrollstyle: *mode* 706 scrollstyle: *mode*
595 Set scrollbar style to rxvt, plain, next or xterm. plain is the 707 Set scrollbar style to rxvt, plain, next or xterm. plain is the
596 author's favourite. 708 author's favourite.
597 709
… …
607 719
608 mapAlert: *boolean* 720 mapAlert: *boolean*
609 True: de-iconify (map) on receipt of a bell character. False: no 721 True: de-iconify (map) on receipt of a bell character. False: no
610 de-iconify (map) on receipt of a bell character [default]. 722 de-iconify (map) on receipt of a bell character [default].
611 723
724 urgentOnBell: *boolean*
725 True: set the urgency hint for the wm on receipt of a bell
726 character. False: do not set the urgency hint [default].
727
612 visualBell: *boolean* 728 visualBell: *boolean*
613 True: use visual bell on receipt of a bell character; option -vb. 729 True: use visual bell on receipt of a bell character; option -vb.
614 False: no visual bell [default]; option +vb. 730 False: no visual bell [default]; option +vb.
615 731
616 loginShell: *boolean* 732 loginShell: *boolean*
… …
630 746
631 The string will be interpreted as if typed into the shell as-is. 747 The string will be interpreted as if typed into the shell as-is.
632 748
633 Example: 749 Example:
634 750
635 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 751 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
636 752
637 This creates a new file in your home directory with the screen 753 This creates a new file in your home directory with the screen
638 contents everytime you hit "Print". 754 contents every time you hit "Print".
639 755
640 scrollBar: *boolean* 756 scrollBar: *boolean*
641 True: enable the scrollbar [default]; option -sb. False: disable the 757 True: enable the scrollbar [default]; option -sb. False: disable the
642 scrollbar; option +sb. 758 scrollbar; option +sb.
643 759
… …
658 do not scroll to bottom when tty receives output; option +si. 774 do not scroll to bottom when tty receives output; option +si.
659 775
660 scrollWithBuffer: *boolean* 776 scrollWithBuffer: *boolean*
661 True: scroll with scrollback buffer when tty receives new lines (and 777 True: scroll with scrollback buffer when tty receives new lines (and
662 scrollTtyOutput is False); option -sw. False: do not scroll with 778 scrollTtyOutput is False); option -sw. False: do not scroll with
663 scrollback buffer when tty recieves new lines; option +sw. 779 scrollback buffer when tty receives new lines; option +sw.
664 780
665 scrollTtyKeypress: *boolean* 781 scrollTtyKeypress: *boolean*
666 True: scroll to bottom when a non-special key is pressed. Special 782 True: scroll to bottom when a non-special key is pressed. Special
667 keys are those which are intercepted by rxvt-unicode for special 783 keys are those which are intercepted by rxvt-unicode for special
668 handling and are not passed onto the shell; option -sk. False: do 784 handling and are not passed onto the shell; option -sk. False: do
… …
683 borderLess: *boolean* 799 borderLess: *boolean*
684 Set MWM hints to request a borderless window, i.e. if honoured by 800 Set MWM hints to request a borderless window, i.e. if honoured by
685 the WM, the rxvt-unicode window will not have window decorations; 801 the WM, the rxvt-unicode window will not have window decorations;
686 option -bl. 802 option -bl.
687 803
804 skipBuiltinGlyphs: *boolean*
805 Compile *frills*: Disable the usage of the built-in block
806 graphics/line drawing characters and just rely on what the specified
807 fonts provide. Use this if you have a good font and want to use its
808 block graphic glyphs; option -sbg.
809
688 termName: *termname* 810 termName: *termname*
689 Specifies the terminal type name to be set in the TERM environment 811 Specifies the terminal type name to be set in the TERM environment
690 variable; option -tn. 812 variable; option -tn.
691 813
692 linespace: *number* 814 lineSpace: *number*
693 Specifies number of lines (pixel height) to insert between each row 815 Specifies number of lines (pixel height) to insert between each row
694 of the display [default 0]; option -lsp. 816 of the display [default 0]; option -lsp.
695 817
696 meta8: *boolean* 818 meta8: *boolean*
697 True: handle Meta (Alt) + keypress to set the 8th bit. False: handle 819 True: handle Meta (Alt) + keypress to set the 8th bit. False: handle
… …
735 The string to send when the delete key (not the keypad delete key) 857 The string to send when the delete key (not the keypad delete key)
736 is pressed. If unset it will send the sequence traditionally 858 is pressed. If unset it will send the sequence traditionally
737 associated with the Execute key. 859 associated with the Execute key.
738 860
739 cutchars: *string* 861 cutchars: *string*
740 The characters used as delimiters for double-click word selection. 862 The characters used as delimiters for double-click word selection
741 The built-in default: 863 (whitespace delimiting is added automatically if resource is given).
742 864
865 When the perl selection extension is in use (the default if compiled
866 in, see the rxvtperl(3) manpage), a suitable regex using these
867 characters will be created (if the resource exists, otherwise, no
868 regex will be created). In this mode, characters outside ISO-8859-1
869 can be used.
870
871 When the selection extension is not used, only ISO-8859-1 characters
872 can be used. If not specified, the built-in default is used:
873
743 BACKSLASH `"'&()*,;<=>?@[]{|} 874 BACKSLASH `"'&()*,;<=>?@[]^{|}
744 875
745 preeditType: *style* 876 preeditType: *style*
746 OverTheSpot, OffTheSpot, Root; option -pt. 877 OverTheSpot, OffTheSpot, Root; option -pt.
747 878
748 inputMethod: *name* 879 inputMethod: *name*
… …
750 881
751 imLocale: *name* 882 imLocale: *name*
752 The locale to use for opening the IM. You can use an "LC_CTYPE" of 883 The locale to use for opening the IM. You can use an "LC_CTYPE" of
753 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for 884 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for
754 the input extension to be able to input japanese characters while 885 the input extension to be able to input japanese characters while
755 staying in another locale. option -imlocale. 886 staying in another locale; option -imlocale.
756 887
757 imFont: *fontset* 888 imFont: *fontset*
758 Specify the font-set used for XIM styles "OverTheSpot" or 889 Specify the font-set used for XIM styles "OverTheSpot" or
759 "OffTheSpot". It must be a standard X font set (XLFD patterns 890 "OffTheSpot". It must be a standard X font set (XLFD patterns
760 separated by commas), i.e. it's not in the same format as the other 891 separated by commas), i.e. it's not in the same format as the other
… …
763 to the base font. option -imfont. 894 to the base font. option -imfont.
764 895
765 tripleclickwords: *boolean* 896 tripleclickwords: *boolean*
766 Change the meaning of triple-click selection with the left mouse 897 Change the meaning of triple-click selection with the left mouse
767 button. Instead of selecting a full line it will extend the 898 button. Instead of selecting a full line it will extend the
768 selection to the end of the logical line only. option -tcw. 899 selection to the end of the logical line only; option -tcw.
769 900
770 insecure: *boolean* 901 insecure: *boolean*
771 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 902 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
772 that echo arbitrary strings like the icon name or the locale. This 903 that echo arbitrary strings like the icon name or the locale. This
773 could be abused if somebody gets 8-bit-clean access to your display, 904 could be abused if somebody gets 8-bit-clean access to your display,
… …
777 xterm, have these sequences enabled by default, which doesn't make 908 xterm, have these sequences enabled by default, which doesn't make
778 it safer, though). 909 it safer, though).
779 910
780 You can enable them by setting this boolean resource or specifying 911 You can enable them by setting this boolean resource or specifying
781 -insecure as an option. At the moment, this enables display-answer, 912 -insecure as an option. At the moment, this enables display-answer,
782 locale, findfont, icon label and window title requests as well as 913 locale, findfont, icon label and window title requests.
783 dynamic menubar dispatch.
784 914
785 modifier: *modifier* 915 modifier: *modifier*
786 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 916 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
787 super, mod1, mod2, mod3, mod4, mod5; option -mod. 917 super, mod1, mod2, mod3, mod4, mod5; option -mod.
788 918
789 answerbackString: *string* 919 answerbackString: *string*
790 Specify the reply rxvt-unicode sends to the shell when an ENQ 920 Specify the reply rxvt-unicode sends to the shell when an ENQ
791 (control-E) character is passed through. It may contain escape 921 (control-E) character is passed through. It may contain escape
792 values as described in the entry on keysym following. 922 values as described in the entry on keysym following.
793 923
794 secondaryScreen: *bool* 924 secondaryScreen: *boolean*
795 Turn on/off secondary screen (default enabled). 925 Turn on/off secondary screen (default enabled).
796 926
797 secondaryScroll: *bool* 927 secondaryScroll: *boolean*
798 Turn on/off secondary screen scroll (default enabled). If the this 928 Turn on/off secondary screen scroll (default enabled). If this
799 option is enabled, scrolls on the secondary screen will change the 929 option is enabled, scrolls on the secondary screen will change the
800 scrollback buffer and switching to/from the secondary screen will 930 scrollback buffer and switching to/from the secondary screen will
801 instead scroll the screen up. 931 instead scroll the screen up.
932
933 hold: *boolean*
934 Turn on/off hold window after exit support. If enabled, rxvt will
935 not immediately destroy its window when the program executed within
936 it exits. Instead, it will wait till it is being killed or closed by
937 the user.
802 938
803 keysym.*sym*: *string* 939 keysym.*sym*: *string*
804 Compile *frills*: Associate *string* with keysym *sym*. The 940 Compile *frills*: Associate *string* with keysym *sym*. The
805 intervening resource name keysym. cannot be omitted. 941 intervening resource name keysym. cannot be omitted.
806 942
… …
819 omitting the prefix XK_. Alternatively you can specify *key* by its 955 omitting the prefix XK_. Alternatively you can specify *key* by its
820 hex keysym value (0x0000 - 0xFFFF). Note that the lookup of *sym*s 956 hex keysym value (0x0000 - 0xFFFF). Note that the lookup of *sym*s
821 is not performed in an exact manner; however, the closest match is 957 is not performed in an exact manner; however, the closest match is
822 assured. 958 assured.
823 959
824 *string* may contain escape values ("\a": bell, "\b": backspace, 960 *string* may contain escape values ("\n": newline, "\000": octal
825 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 961 number), see RESOURCES in "man 7 X" for futher details.
826 "\000": octal number) or verbatim control characters ("^?": delete,
827 "^@": null, "^A" ...) and may be enclosed with double quotes so that
828 it can start or end with whitespace.
829
830 Please note that you need to double the "\" when using
831 "--enable-xgetdefault", as X itself does it's own de-escaping (you
832 can use "\033" instead of "\e" (and so on), which will work with
833 both Xt and rxvt's own processing).
834 962
835 You can define a range of keysyms in one shot by providing a 963 You can define a range of keysyms in one shot by providing a
836 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 964 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimiter
837 `/' should be a character not used by the strings. 965 `/' should be a character not used by the strings.
838 966
839 Its usage can be demonstrated by an example: 967 Its usage can be demonstrated by an example:
840 968
841 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 969 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
… …
850 is interpreted and executed as rxvt's control sequence. For example 978 is interpreted and executed as rxvt's control sequence. For example
851 the following means "change the current locale to "zh_CN.GBK" when 979 the following means "change the current locale to "zh_CN.GBK" when
852 Control-Meta-c is being pressed": 980 Control-Meta-c is being pressed":
853 981
854 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 982 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
983
984 If *string* takes the form "perl:STRING", then the specified STRING
985 is passed to the "on_keyboard_command" perl handler. See the
986 rxvtperl(3) manpage. For example, the selection extension (activated
987 via "rxvt -pe selection") listens for "selection:rot13" events:
988
989 URxvt.keysym.M-C-c: perl:selection:rot13
855 990
856 Due the the large number of modifier combinations, a defined key 991 Due the the large number of modifier combinations, a defined key
857 mapping will match if at *at least* the specified identifiers are 992 mapping will match if at *at least* the specified identifiers are
858 being set, and no other key mappings with those and more bits are 993 being set, and no other key mappings with those and more bits are
859 being defined. That means that defining a key map for "a" will 994 being defined. That means that defining a key map for "a" will
… …
883 info): 1018 info):
884 1019
885 URxvt.keysym.M-C-3: command:\033[8;25;80t 1020 URxvt.keysym.M-C-3: command:\033[8;25;80t
886 URxvt.keysym.M-C-4: command:\033[8;48;110t 1021 URxvt.keysym.M-C-4: command:\033[8;48;110t
887 1022
1023 perl-ext-common: *string*
1024 perl-ext: *string*
1025 Comma-separated list(s) of perl extension scripts (default:
1026 "default") to use in this terminal instance; option -pe.
1027
1028 Extension names can be prefixed with a "-" sign to prohibit using
1029 them. This can be useful to selectively disable some extensions
1030 loaded by default, or specified via the "perl-ext-common" resource.
1031 For example, "default,-selection" will use all the default extension
1032 except "selection".
1033
1034 Extension names can also be followed by an argument in angle
1035 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
1036 for searchable scrollback to Alt/Meta-s). Mentioning the same
1037 extension multiple times with different arguments will pass multiple
1038 arguments to the extension.
1039
1040 Each extension is looked up in the library directories, loaded if
1041 necessary, and bound to the current terminal instance.
1042
1043 If both of these resources are the empty string, then the perl
1044 interpreter will not be initialized. The idea behind two options is
1045 that perl-ext-common will be used for extensions that should be
1046 available to all instances, while perl-ext is used for specific
1047 instances.
1048
1049 perl-eval: *string*
1050 Perl code to be evaluated when all extensions have been registered.
1051 See the rxvtperl(3) manpage. Due to security reasons, this resource
1052 will be ignored when running setuid/setgid.
1053
1054 perl-lib: *path*
1055 Colon-separated list of additional directories that hold extension
1056 scripts. When looking for extensions specified by the "perl"
1057 resource, rxvt will first look in these directories and then in
1058 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
1059 will be ignored when running setuid/setgid.
1060
1061 See the rxvtperl(3) manpage.
1062
1063 selection.pattern-*idx*: *perl-regex*
1064 Additional selection patterns, see the rxvtperl(3) manpage for
1065 details.
1066
1067 selection-autotransform.*idx*: *perl-transform*
1068 Selection auto-transform patterns, see the rxvtperl(3) manpage for
1069 details.
1070
1071 searchable-scrollback: *keysym*
1072 Sets the hotkey that starts the incremental scrollback buffer search
1073 (default: "M-s").
1074
1075 urlLauncher: *string*
1076 Specifies the program to be started with a URL argument. Used by the
1077 "selection-popup" and "matcher" perl extensions.
1078
1079 transient-for: *windowid*
1080 Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given
1081 window id.
1082
1083 override-redirect: *boolean*
1084 Compile *frills*: Sets override-redirect for the terminal window,
1085 making it almost invisible to window managers; option
1086 -override-redirect.
1087
1088 iso14755_52: *boolean*
1089 Turn on/off ISO 14755 5.2 mode (default enabled).
1090
888THE SCROLLBAR 1091THE SCROLLBAR
889 Lines of text that scroll off the top of the rxvt window (resource: 1092 Lines of text that scroll off the top of the rxvt window (resource:
890 saveLines) and can be scrolled back using the scrollbar or by 1093 saveLines) and can be scrolled back using the scrollbar or by
891 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1094 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
892 fairly intuitive. The xterm-scrollbar is without arrows and its 1095 fairly intuitive. The xterm-scrollbar is without arrows and its
… …
905 disabled -- on the assumption that we are using a fullscreen 1108 disabled -- on the assumption that we are using a fullscreen
906 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~ 1109 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
907 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the 1110 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
908 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively. 1111 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
909 1112
910TEXT SELECTION AND INSERTION 1113THE SELECTION: SELECTING AND PASTING TEXT
911 The behaviour of text selection and insertion mechanism is similar to 1114 The behaviour of text selection and insertion/pasting mechanism is
912 *xterm*(1). 1115 similar to *xterm*(1).
913 1116
914 Selection: 1117 Selecting:
915 Left click at the beginning of the region, drag to the end of the 1118 Left click at the beginning of the region, drag to the end of the
916 region and release; Right click to extend the marked region; Left 1119 region and release; Right click to extend the marked region; Left
917 double-click to select a word; Left triple-click to select the 1120 double-click to select a word; Left triple-click to select the
918 entire logical line (which can span multiple screen lines), unless 1121 entire logical line (which can span multiple screen lines), unless
919 modified by resource tripleclickwords. 1122 modified by resource tripleclickwords.
920 1123
921 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 1124 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
922 (Compile: *frills*) will create a rectangular selection instead of a 1125 (Compile: *frills*) will create a rectangular selection instead of a
923 normal one. 1126 normal one. In this mode, every selected row becomes its own line in
1127 the selection, and trailing whitespace is visually underlined and
1128 removed from the selection.
924 1129
925 Insertion: 1130 Pasting:
926 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1131 Pressing and releasing the Middle mouse button in an rxvt window
927 an rxvt window causes the current text selection to be inserted as 1132 causes the value of the PRIMARY selection (or CLIPBOARD with the
928 if it had been typed on the keyboard. 1133 Meta modifier) to be inserted as if it had been typed on the
1134 keyboard.
1135
1136 Pressing Shift-Insert causes the value of the PRIMARY selection to
1137 be inserted too.
929 1138
930CHANGING FONTS 1139CHANGING FONTS
931 Changing fonts (or font sizes, respectively) via the keypad is not yet 1140 Changing fonts (or font sizes, respectively) via the keypad is not yet
932 supported in rxvt-unicode. Bug me if you need this. 1141 supported in rxvt-unicode. Bug me if you need this.
933 1142
934 You can, however, switch fonts at runtime using escape sequences (and 1143 You can, however, switch fonts at runtime using escape sequences, e.g.:
935 therefore using the menubar), e.g.:
936 1144
937 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1145 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1146
1147 You can use keyboard shortcuts, too:
1148
1149 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1150 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
938 1151
939 rxvt-unicode will automatically re-apply these fonts to the output so 1152 rxvt-unicode will automatically re-apply these fonts to the output so
940 far. 1153 far.
941 1154
942ISO 14755 SUPPORT 1155ISO 14755 SUPPORT
943 ISO 14755 is a standard for entering and viewing unicode characters and 1156 ISO 14755 is a standard for entering and viewing unicode characters and
944 character codes using the keyboard. It consists of 4 parts. The first 1157 character codes using the keyboard. It consists of 4 parts. The first
945 part is available rxvt-unicode has been compiled with "--enable-frills", 1158 part is available if rxvt-unicode has been compiled with
946 the rest is available when rxvt-unicode was compiled with 1159 "--enable-frills", the rest is available when rxvt-unicode was compiled
947 "--enable-iso14755". 1160 with "--enable-iso14755".
948 1161
949 * 5.1: Basic method 1162 * 5.1: Basic method
950 This allows you to enter unicode characters using their hexcode. 1163 This allows you to enter unicode characters using their hexcode.
951 1164
952 Start by pressing and holding both "Control" and "Shift", then enter 1165 Start by pressing and holding both "Control" and "Shift", then enter
… …
966 This mode lets you input characters representing the keycap symbols 1179 This mode lets you input characters representing the keycap symbols
967 of your keyboard, if representable in the current locale encoding. 1180 of your keyboard, if representable in the current locale encoding.
968 1181
969 Start by pressing "Control" and "Shift" together, then releasing 1182 Start by pressing "Control" and "Shift" together, then releasing
970 them. The next special key (cursor keys, home etc.) you enter will 1183 them. The next special key (cursor keys, home etc.) you enter will
971 not invoke it's usual function but instead will insert the 1184 not invoke its usual function but instead will insert the
972 corresponding keycap symbol. The symbol will only be entered when 1185 corresponding keycap symbol. The symbol will only be entered when
973 the key has been released, otherwise pressing e.g. "Shift" would 1186 the key has been released, otherwise pressing e.g. "Shift" would
974 enter the symbol for "ISO Level 2 Switch", although your intention 1187 enter the symbol for "ISO Level 2 Switch", although your intention
975 might have been to enter a reverse tab (Shift-Tab). 1188 might have been to enter a reverse tab (Shift-Tab).
976 1189
… …
1005 setgid to root or to some other group on others. 1218 setgid to root or to some other group on others.
1006 1219
1007COLORS AND GRAPHICS 1220COLORS AND GRAPHICS
1008 In addition to the default foreground and background colours, rxvt can 1221 In addition to the default foreground and background colours, rxvt can
1009 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 1222 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
1010 versions of the same). Here is a list of the colours with their rgb.txt 1223 versions of the same). Here is a list of the colours with their names.
1011 names.
1012 1224
1013 color0 (black) = Black 1225 color0 (black) = Black
1014 color1 (red) = Red3 1226 color1 (red) = Red3
1015 color2 (green) = Green3 1227 color2 (green) = Green3
1016 color3 (yellow) = Yellow3 1228 color3 (yellow) = Yellow3
… …
1032 It is also possible to specify the colour values of foreground, 1244 It is also possible to specify the colour values of foreground,
1033 background, cursorColor, cursorColor2, colorBD, colorUL as a number 1245 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1034 0-15, as a convenient shorthand to reference the colour name of 1246 0-15, as a convenient shorthand to reference the colour name of
1035 color0-color15. 1247 color0-color15.
1036 1248
1249 In addition to the colours defined above, rxvt offers an additional 72
1250 colours. The first 64 of those (with indices 16 to 79) consist of a
1251 4*4*4 RGB colour cube (i.e. *index = r * 16 + g * 4 + b + 16*), followed
1252 by 8 additional shades of gray (with indices 80 to 87).
1253
1254 Together, all those colours implement the 88 colour xterm colours. Only
1255 the first 16 can be changed using resources currently, the rest can only
1256 be changed via command sequences ("escape codes").
1257
1037 Note that -rv ("reverseVideo: True") simulates reverse video by always 1258 Note that -rv ("reverseVideo: True") simulates reverse video by always
1038 swapping the foreground/background colours. This is in contrast to 1259 swapping the foreground/background colours. This is in contrast to
1039 *xterm*(1) where the colours are only swapped if they have not otherwise 1260 *xterm*(1) where the colours are only swapped if they have not otherwise
1040 been specified. For example, 1261 been specified. For example,
1041 1262
1042 rxvt -fg Black -bg White -rv 1263 rxvt -fg Black -bg White -rv
1043 would yield White on Black, while on *xterm*(1) it would yield Black 1264 would yield White on Black, while on *xterm*(1) it would yield Black
1044 on White. 1265 on White.
1045 1266
1267 ALPHA CHANNEL SUPPORT
1268 If Xft support has been compiled in and as long as Xft/Xrender/X don't
1269 get their act together, rxvt-unicode will support
1270 "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4
1271 digits/component) colour specifications, in addition to the ones
1272 provided by X, where the additional A component specifies opacity
1273 (alpha) values. The minimum value of 0 is completely transparent). You
1274 can also prefix any color with "[percent]", where "percent" is a decimal
1275 percentage (0-100) that specifies the opacity of the color, where 0 is
1276 completely transparent and 100 is completelxy opaque.
1277
1278 You probably need to specify "-depth 32", too, and have the luck that
1279 your X-server uses ARGB pixel layout, as X is far from just supporting
1280 ARGB visuals out of the box, and rxvt-unicode just fudges around.
1281
1282 For example, the following selects an almost completely transparent red
1283 background, and an almost opaque pink foreground:
1284
1285 rxvt -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1286
1287 *Please note that transparency of any kind if completely unsupported by
1288 the author. Don't bug him with installation questions!*
1289
1046ENVIRONMENT 1290ENVIRONMENT
1047 rxvt sets and/or uses the following environment variables: 1291 rxvt sets and/or uses the following environment variables:
1048 1292
1049 TERM 1293 TERM
1050 Normally set to "rxvt-unicode", unless overwritten at configure 1294 Normally set to "rxvt-unicode", unless overwritten at configure
1051 time, via resources or on the commandline. 1295 time, via resources or on the command line.
1052 1296
1053 COLORTERM 1297 COLORTERM
1054 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled 1298 Either "rxvt", "rxvt-xpm", depending on whether rxvt was compiled
1055 with XPM support, and optionally with the added extension "-mono" to 1299 with background image support, and optionally with the added
1056 indicate that rxvt-unicode runs on a monochrome screen. 1300 extension "-mono" to indicate that rxvt-unicode runs on a monochrome
1301 screen.
1057 1302
1058 COLORFGBG 1303 COLORFGBG
1059 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is 1304 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1060 the colour code used as default foreground/text colour (or the 1305 the colour code used as default foreground/text colour (or the
1061 string "default" to indicate that the default-colour escape sequence 1306 string "default" to indicate that the default-colour escape sequence
1062 is to be used), "bg" is the colour code used as default background 1307 is to be used), "bg" is the colour code used as default background
1063 colour (or the string "default"), and "xpm" is the string "default" 1308 colour (or the string "default"), and "xpm" is the string "default"
1064 if rxvt was compiled with XPM support. Libraries like "ncurses" and 1309 if rxvt was compiled with background image support. Libraries like
1065 "slang" can (and do) use this information to optimize screen output. 1310 "ncurses" and "slang" can (and do) use this information to optimize
1311 screen output.
1066 1312
1067 WINDOWID 1313 WINDOWID
1068 Set to the (decimal) X Window ID of the rxvt window (the toplevel 1314 Set to the (decimal) X Window ID of the rxvt window (the toplevel
1069 window, which usually has subwindows for the scrollbar, the terminal 1315 window, which usually has subwindows for the scrollbar, the terminal
1070 window and so on). 1316 window and so on).
… …
1073 Set to the terminfo directory iff rxvt was configured with 1319 Set to the terminfo directory iff rxvt was configured with
1074 "--with-terminfo=PATH". 1320 "--with-terminfo=PATH".
1075 1321
1076 DISPLAY 1322 DISPLAY
1077 Used by rxvt to connect to the display and set to the correct 1323 Used by rxvt to connect to the display and set to the correct
1078 display in it's child processes. 1324 display in its child processes.
1079 1325
1080 SHELL 1326 SHELL
1081 The shell to be used for command execution, defaults to "/bin/sh". 1327 The shell to be used for command execution, defaults to "/bin/sh".
1082
1083 RXVTPATH
1084 The path where rxvt looks for support files such as menu and xpm
1085 files.
1086
1087 PATH
1088 Used in the same way as "RXVTPATH".
1089 1328
1090 RXVT_SOCKET 1329 RXVT_SOCKET
1091 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1330 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1092 1331
1093 Default $HOME/.rxvt-unicode-*<nodename*. 1332 Default $HOME/.rxvt-unicode-*<nodename*.
… …
1114 1353
1115CURRENT PROJECT COORDINATOR 1354CURRENT PROJECT COORDINATOR
1116 Project Coordinator 1355 Project Coordinator
1117 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1356 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1118 1357
1119 <http://software.schmorp.de/#rxvt-unicode> 1358 <http://software.schmorp.de/pkg/rxvt-unicode.html>
1120 1359
1121AUTHORS 1360AUTHORS
1122 John Bovey 1361 John Bovey
1123 University of Kent, 1992, wrote the original Xvt. 1362 University of Kent, 1992, wrote the original Xvt.
1124 1363
… …
1135 1374
1136 Oezguer Kesim <kesim@math.fu-berlin.de> 1375 Oezguer Kesim <kesim@math.fu-berlin.de>
1137 Project Coordinator (changes.txt 2.21a to 2.4.5) 1376 Project Coordinator (changes.txt 2.21a to 2.4.5)
1138 1377
1139 Geoff Wing <gcw@pobox.com> 1378 Geoff Wing <gcw@pobox.com>
1140 Rewrote screen display and text selection routines. Project 1379 Rewrote screen display and text selection routines.
1380
1141 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1381 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1142 1382
1143 Marc Alexander Lehmann <rxvt-unicode@schmorp.de> 1383 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1144 Forked rxvt-unicode, rewrote most of the display code and internal 1384 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1145 character handling to store text in unicode, improve xterm 1385 perl extension, random hacks, numerous bugfixes and extensions.
1146 compatibility and apply numerous other bugfixes and extensions.
1147 1386
1148 Project Coordinator (Changes 1.0 -) 1387 Project Coordinator (Changes 1.0 -)
1149 1388
1389 Emanuele Giaquinta <e.giaquinta@glauco.it>
1390 Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1391

Diff Legend

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