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

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.3 by root, Mon Jan 17 01:44:51 2005 UTC vs.
Revision 1.66 by root, Sat Jun 2 04:58:58 2007 UTC

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

Diff Legend

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