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

Comparing cvsroot/rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.2 by root, Sun Jan 16 15:59:45 2005 UTC vs.
Revision 1.61 by root, Mon Jul 17 19:20:29 2006 UTC

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

Diff Legend

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