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.2 by root, Sun Jan 16 15:59:45 2005 UTC vs.
Revision 1.48 by root, Thu Jan 19 19:26:31 2006 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 7.1, 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/*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
91 Turn on/off simulated reverse video; resource reverseVideo. 93 Turn on/off simulated reverse video; resource reverseVideo.
92 94
93 -j|+j 95 -j|+j
94 Turn on/off jump scrolling; resource jumpScroll. 96 Turn on/off jump scrolling; resource jumpScroll.
95 97
96 -ip|+ip 98 -ip|+ip | -tr|+tr
97 Turn on/off inheriting parent window's pixmap. Alternative form is 99 Turn on/off inheriting parent window's pixmap. Alternative form is
98 -tr; resource inheritPixmap. 100 -tr; resource inheritPixmap.
99 101
100 -fade *number* 102 -fade *number*
101 Fade the text by the given percentage when focus is lost. resource 103 Fade the text by the given percentage when focus is lost. Small
102 fading. 104 values fade a little only, 100 completely replaces all colours by
105 the fade colour; resource fading.
106
107 -fadecolor *colour*
108 Fade to this colour when fading is used (see -fade). The default
109 colour is black. resource fadeColor.
103 110
104 -tint *colour* 111 -tint *colour*
105 Tint the transparent background pixmap with the given colour when 112 Tint the transparent background pixmap with the given colour when
106 transparency is enabled with -tr or -ip. See also the -sh option 113 transparency is enabled with -tr or -ip. This only works for
114 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 115 be used to brighten or darken the image in addition to tinting it;
108 tinting it. 116 resource *tintColor*. Example:
117
118 rxvt -tr -tint blue -sh 40
109 119
110 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent 120 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent
111 background image in addition to tinting it (i.e. -tint must be 121 background image in addition to tinting it (i.e. -tint must be
112 specified, too, e.g. "-tint white"). 122 specified, too, e.g. "-tint white").
113 123
118 Window foreground colour; resource foreground. 128 Window foreground colour; resource foreground.
119 129
120 -pixmap *file[;geom]* 130 -pixmap *file[;geom]*
121 Compile *XPM*: Specify XPM file for the background and also 131 Compile *XPM*: Specify XPM file for the background and also
122 optionally specify its scaling with a geometry string. Note you may 132 optionally specify its scaling with a geometry string. Note you may
123 need to add quotes to avoid special shell interpretation of the `;' 133 need to add quotes to avoid special shell interpretation of the ";"
124 in the command-line; resource backgroundPixmap. 134 in the command-line; resource backgroundPixmap.
125 135
126 -cr *colour* 136 -cr *colour*
127 The cursor colour; resource cursorColor. 137 The cursor colour; resource cursorColor.
128 138
136 The colour of the border around the text area and between the 146 The colour of the border around the text area and between the
137 scrollbar and the text; resource borderColor. 147 scrollbar and the text; resource borderColor.
138 148
139 -fn *fontlist* 149 -fn *fontlist*
140 Select the fonts to be used. This is a comma separated list of font 150 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 151 names that are checked in order when trying to find glyphs for
142 characters. The first font defines the cell size for characters; 152 characters. The first font defines the cell size for characters;
143 other fonts might be smaller, but not (in general) larger. A 153 other fonts might be smaller, but not (in general) larger. A
144 (hopefully) reasonable default font list is always appended to it. 154 (hopefully) reasonable default font list is always appended to it.
145 See resource font for more details. 155 See resource font for more details.
146 156
153 163
154 See also the question "How does rxvt-unicode choose fonts?" in the 164 See also the question "How does rxvt-unicode choose fonts?" in the
155 FAQ section of rxvt(7). 165 FAQ section of rxvt(7).
156 166
157 -fb *fontlist* 167 -fb *fontlist*
158 Compile font-styles: The bold font list to use when bold characters 168 Compile *font-styles*: The bold font list to use when bold
159 are to be printed. See resource boldFont for details. 169 characters are to be printed. See resource boldFont for details.
160 170
161 -fi *fontlist* 171 -fi *fontlist*
162 Compile font-styles: The italic font list to use when bold 172 Compile *font-styles*: The italic font list to use when *italic*
163 characters are to be printed. See resource italicFont for details. 173 characters are to be printed. See resource italicFont for details.
164 174
165 -fbi *fontlist* 175 -fbi *fontlist*
166 Compile font-styles: The bold italic font list to use when bold 176 Compile *font-styles*: The bold italic font list to use when *bold
167 characters are to be printed. See resource boldItalicFont for 177 italic* characters are to be printed. See resource boldItalicFont
178 for details.
179
180 -is|+is
181 Compile *font-styles*: Bold/Italic font styles imply high intensity
182 foreground/background (default). See resource intensityStyles for
168 details. 183 details.
169 184
170 -name *name* 185 -name *name*
171 Specify the application name under which resources are to be 186 Specify the application name under which resources are to be
172 obtained, rather than the default executable file name. Name should 187 obtained, rather than the default executable file name. Name should
202 217
203 -sr|+sr 218 -sr|+sr
204 Put scrollbar on right/left; resource scrollBar_right. 219 Put scrollbar on right/left; resource scrollBar_right.
205 220
206 -st|+st 221 -st|+st
207 Display normal (non XTerm/NeXT) scrollbar without/with a trough; 222 Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
208 resource scrollBar_floating. 223 resource scrollBar_floating.
209 224
210 -ptab|+ptab 225 -ptab|+ptab
211 If enabled (default), "Horizontal Tab" characters are being stored 226 If enabled (default), "Horizontal Tab" characters are being stored
212 as actual wide characters in the screen buffer, which makes it 227 as actual wide characters in the screen buffer, which makes it
236 externalBorder. 251 externalBorder.
237 252
238 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e. 253 -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 254 if honoured by the WM, the rxvt-unicode window will not have window
240 decorations; resource borderLess. 255 decorations; resource borderLess.
256
257 -override-redirect
258 Compile *frills*: Sets override-redirect on the window; resource
259 override-redirect.
260
261 -sbg
262 Compile *frills*: Disable the usage of the built-in block
263 graphics/line drawing characters and just rely on what the specified
264 fonts provide. Use this if you have a good font and want to use its
265 block graphic glyphs; resource skipBuiltinGlyphs.
241 266
242 -lsp *number* 267 -lsp *number*
243 Compile *frills*: Lines (pixel height) to insert between each row of 268 Compile *frills*: Lines (pixel height) to insert between each row of
244 the display. Useful to work around font rendering problems; resource 269 the display. Useful to work around font rendering problems; resource
245 linespace. 270 linespace.
257 on the command line. If this option is used, it must be the last on 282 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 283 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, 284 run the program specified by the SHELL environment variable or,
260 failing that, *sh(1)*. 285 failing that, *sh(1)*.
261 286
287 Please note that you must specify a program with arguments. If you
288 want to run shell commands, you have to specify the shell, like
289 this:
290
291 rxvt -e sh -c "shell commands"
292
262 -title *text* 293 -title *text*
263 Window title (-T still respected); the default title is the basename 294 Window title (-T still respected); the default title is the basename
264 of the program specified after the -e option, if any, otherwise the 295 of the program specified after the -e option, if any, otherwise the
265 application name; resource title. 296 application name; resource title.
266 297
277 308
278 -im *text* 309 -im *text*
279 Compile *XIM*: input method name. resource inputMethod. 310 Compile *XIM*: input method name. resource inputMethod.
280 311
281 -imlocale *string* 312 -imlocale *string*
282 The locale to use for opening the IM. You can use an LC_CTYPE of 313 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 314 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 315 the input extension to be able to input japanese characters while
285 staying in another locale. 316 staying in another locale. resource imLocale.
317
318 -imfont *fontset*
319 Set the font set to use for the X Input Method, see resource imFont
320 for more info.
321
322 -tcw
323 Change the meaning of triple-click selection with the left mouse
324 button. Instead of selecting a full line it will extend the
325 selection the end of the logical line only. resource
326 tripleclickwords.
286 327
287 -insecure 328 -insecure
288 Enable "insecure" mode, which currently enables most of the escape 329 Enable "insecure" mode, which currently enables most of the escape
289 sequences that echo strings. See the resource insecure for more 330 sequences that echo strings. See the resource insecure for more
290 info. 331 info.
299 340
300 -ssr|+ssr 341 -ssr|+ssr
301 Turn on/off secondary screen scroll (default enabled); resource 342 Turn on/off secondary screen scroll (default enabled); resource
302 secondaryScroll. 343 secondaryScroll.
303 344
304 -xrm *resourcestring* 345 -hold|+hold
305 No effect on rxvt-unicode. Simply passes through an argument to be 346 Turn on/off hold window after exit support. If enabled, rxvt will
306 made available in the instance's argument list. Appears in 347 not immediately destroy its window when the program executed within
307 *WM_COMMAND* in some window managers. 348 it exits. Instead, it will wait till it is being killed or closed by
349 the user; resource hold.
350
351 -keysym.*sym* *string*
352 Remap a key symbol. See resource keysym.
353
354 -embed *windowid*
355 Tells rxvt to embed it's windows into an already-existing window,
356 which enables applications to easily embed a terminal.
357
358 Right now, rxvt will first unmap/map the specified window, so it
359 shouldn't be a top-level window. rxvt will also reconfigure it quite
360 a bit, so don't expect it to keep some specific state. It's best to
361 create an extra subwindow for rxvt and leave it alone.
362
363 The window will not be destroyed when rxvt exits.
364
365 It might be useful to know that rxvt will not close file descriptors
366 passed to it (except for stdin/out/err, of course), so you can use
367 file descriptors to communicate with the programs within the
368 terminal. This works regardless of wether the "-embed" option was
369 used or not.
370
371 Here is a short Gtk2-perl snippet that illustrates how this option
372 can be used (a longer example is in doc/embed):
373
374 my $rxvt = new Gtk2::Socket;
375 $rxvt->signal_connect_after (realize => sub {
376 my $xid = $_[0]->window->get_xid;
377 system "rxvt -embed $xid &";
378 });
379
380 -pty-fd *file descriptor*
381 Tells rxvt NOT to execute any commands or create a new pty/tty pair
382 but instead use the given filehandle as the tty master. This is
383 useful if you want to drive rxvt as a generic terminal emulator
384 without having to run a program within it.
385
386 If this switch is given, rxvt will not create any utmp/wtmp entries
387 and will not tinker with pty/tty permissions - you have to do that
388 yourself if you want that.
389
390 As an extremely special case, specifying -1 will completely suppress
391 pty/tty operations.
392
393 Here is a example in perl that illustrates how this option can be
394 used (a longer example is in doc/pty-fd):
395
396 use IO::Pty;
397 use Fcntl;
398
399 my $pty = new IO::Pty;
400 fcntl $pty, F_SETFD, 0; # clear close-on-exec
401 system "rxvt -pty-fd " . (fileno $pty) . "&";
402 close $pty;
403
404 # now communicate with rxvt
405 my $slave = $pty->slave;
406 while (<$slave>) { print $slave "got <$_>\n" }
407
408 -pe *string*
409 Comma-separated list of perl extension scripts to use (or not to
410 use) in this terminal instance. See resource perl-ext for details.
308 411
309RESOURCES (available also as long-options) 412RESOURCES (available also as long-options)
310 Note: `rxvt --help' gives a list of all resources (long options) 413 Note: `rxvt --help' gives a list of all resources (long options)
311 compiled into your version. 414 compiled into your version.
312 415
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 416 You can set and change the resources using X11 tools like xrdb. Many
317 xset. Many distribution do also load settings from the ~/.Xresources 417 distribution do also load settings from the ~/.Xresources file when X
318 file when X starts. 418 starts. rxvt will consult the following files/resources in order, with
419 later settings overwriting earlier ones:
319 420
320 If compiled with internal Xresources support (i.e. rxvt -h lists 421 1. system-wide app-defaults file, either locale-dependent OR global
321 .Xdefaults) then rxvt accepts application defaults set in 422 2. app-defaults file in $XAPPLRESDIR
322 XAPPLOADDIR/URxvt (compile-time defined: usually 423 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
323 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 424 4. SCREEN_RESOURCES for the current screen
324 ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X 425 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
325 resources, rxvt recognizes two class names: XTerm and URxvt. The class 426
326 name Rxvt allows resources common to both rxvt and the original *rxvt* 427 Note that when reading X resources, rxvt recognizes two class names:
327 to be easily configured, while the class name URxvt allows resources 428 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 429 and the original *rxvt* to be easily configured, while the class name
430 URxvt allows resources unique to rxvt, to be shared between different
329 different rxvt configurations. If no resources are specified, suitable 431 rxvt configurations. If no resources are specified, suitable defaults
330 defaults will be used. Command-line arguments can be used to override 432 will be used. Command-line arguments can be used to override resource
331 resource settings. The following resources are allowed: 433 settings. The following resources are supported (you might want to check
434 the rxvtperl(3) manpage for additional settings by perl extensions not
435 documented here):
332 436
333 geometry: *geom* 437 geometry: *geom*
334 Create the window with the specified X window geometry [default 438 Create the window with the specified X window geometry [default
335 80x24]; option -geometry. 439 80x24]; option -geometry.
336 440
359 463
360 colorBD: *colour* 464 colorBD: *colour*
361 colorIT: *colour* 465 colorIT: *colour*
362 Use the specified colour to display bold or italic characters when 466 Use the specified colour to display bold or italic characters when
363 the foreground colour is the default. If font styles are not 467 the foreground colour is the default. If font styles are not
364 available (Compile styles) and this option is unset, reverse video 468 available (Compile *styles*) and this option is unset, reverse video
365 is used instead. 469 is used instead.
366 470
367 colorUL: *colour* 471 colorUL: *colour*
368 Use the specified colour to display underlined characters when the 472 Use the specified colour to display underlined characters when the
369 foreground colour is the default. 473 foreground colour is the default.
399 True: make the background inherit the parent windows' pixmap, giving 503 True: make the background inherit the parent windows' pixmap, giving
400 artificial transparency. False: do not inherit the parent windows' 504 artificial transparency. False: do not inherit the parent windows'
401 pixmap. 505 pixmap.
402 506
403 fading: *number* 507 fading: *number*
404 Fade the text by the given percentage when focus is lost. 508 Fade the text by the given percentage when focus is lost; option
509 -fade.
510
511 fadeColor: *colour*
512 Fade to this colour, when fading is used (see fading:). The default
513 colour is black; option -fadecolor.
405 514
406 tintColor: *colour* 515 tintColor: *colour*
407 Tint the transparent background pixmap with the given colour. 516 Tint the transparent background pixmap with the given colour; option
517 -tint.
408 518
409 shading: *number* 519 shading: *number*
410 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 520 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
411 image in addition to tinting it. 521 image in addition to tinting it.
412 522
413 scrollColor: *colour* 523 scrollColor: *colour*
414 Use the specified colour for the scrollbar [default #B2B2B2]. 524 Use the specified colour for the scrollbar [default #B2B2B2].
415 525
416 troughColor: *colour* 526 troughColor: *colour*
417 Use the specified colour for the scrollbar's trough area [default 527 Use the specified colour for the scrollbar's trough area [default
418 #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 528 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
419 529
420 borderColor: *colour* 530 borderColor: *colour*
421 The colour of the border around the text area and between the 531 The colour of the border around the text area and between the
422 scrollbar and the text. 532 scrollbar and the text.
423 533
430 scale of 1 displays the image without any scaling. A scale of 2 to 9 540 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 541 specifies an integer number of images in that direction. No image
432 will be magnified beyond 10 times its original size. The maximum 542 will be magnified beyond 10 times its original size. The maximum
433 permitted scale is 1000. [default 0x0+50+50] 543 permitted scale is 1000. [default 0x0+50+50]
434 544
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* 545 path: *path*
442 Specify the colon-delimited search path for finding files (XPM and 546 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 547
446 font: *fontlist* 548 font: *fontlist*
447 Select the fonts to be used. This is a comma separated list of font 549 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 550 names that are checked in order when trying to find glyphs for
449 characters. The first font defines the cell size for characters; 551 characters. The first font defines the cell size for characters;
450 other fonts might be smaller, but not larger. A reasonable default 552 other fonts might be smaller, but not (in general) larger. A
451 font list is always appended to it. option -fn. 553 (hopefully) reasonable default font list is always appended to it;
554 option -fn.
452 555
453 Each font can either be a standard X11 core font (XLFD) name, with 556 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 557 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
455 "xft:". 558 "xft:".
456 559
457 In addition, each font can be prefixed with additional hints and 560 In addition, each font can be prefixed with additional hints and
458 specifications enclosed in square brackets ("[]"). The only 561 specifications enclosed in square brackets ("[]"). The only
459 available hint currently is "codeset=codeset-name", and this is only 562 available hint currently is "codeset=codeset-name", and this is only
460 used for Xft fonts. 563 used for Xft fonts.
461 564
462 For example, this font resource 565 For example, this font resource
463 566
464 URxvt*font: 9x15bold,\ 567 URxvt.font: 9x15bold,\
465 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 568 -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, \ 569 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
467 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 570 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
468 xft:Code2000:antialias=false 571 xft:Code2000:antialias=false
469 572
502 tried. 605 tried.
503 606
504 If set, but empty, then this specific style is disabled and the 607 If set, but empty, then this specific style is disabled and the
505 normal text font will being used for the given style. 608 normal text font will being used for the given style.
506 609
610 intensityStyles: *boolean*
611 When font styles are not enabled, or this option is enabled (True,
612 option -is, the default), bold and italic font styles imply high
613 intensity foreground/backround colours. Disabling this option
614 (False, option +is) disables this behaviour, the high intensity
615 colours are not reachable.
616
507 selectstyle: *mode* 617 selectstyle: *mode*
508 Set mouse selection style to old which is 2.20, oldword which is 618 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 619 xterm style with 2.20 old word selection, or anything else which
510 gives xterm style selection. 620 gives xterm style selection.
511 621
512 scrollstyle: *mode* 622 scrollstyle: *mode*
513 Set scrollbar style to rxvt, plain, next or xterm. plain is the 623 Set scrollbar style to rxvt, plain, next or xterm. plain is the
514 author's favourite.. 624 author's favourite.
515 625
516 title: *string* 626 title: *string*
517 Set window title string, the default title is the command-line 627 Set window title string, the default title is the command-line
518 specified after the -e option, if any, otherwise the application 628 specified after the -e option, if any, otherwise the application
519 name; option -title. 629 name; option -title.
544 print-pipe: *string* 654 print-pipe: *string*
545 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use 655 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 656 Print to initiate a screen dump to the printer and Ctrl-Print or
547 Shift-Print to include the scrollback as well. 657 Shift-Print to include the scrollback as well.
548 658
659 The string will be interpreted as if typed into the shell as-is.
660
661 Example:
662
663 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
664
665 This creates a new file in your home directory with the screen
666 contents everytime you hit "Print".
667
549 scrollBar: *boolean* 668 scrollBar: *boolean*
550 True: enable the scrollbar [default]; option -sb. False: disable the 669 True: enable the scrollbar [default]; option -sb. False: disable the
551 scrollbar; option +sb. 670 scrollbar; option +sb.
552 671
553 scrollBar_right: *boolean* 672 scrollBar_right: *boolean*
566 True: scroll to bottom when tty receives output; option -si. False: 685 True: scroll to bottom when tty receives output; option -si. False:
567 do not scroll to bottom when tty receives output; option +si. 686 do not scroll to bottom when tty receives output; option +si.
568 687
569 scrollWithBuffer: *boolean* 688 scrollWithBuffer: *boolean*
570 True: scroll with scrollback buffer when tty receives new lines (and 689 True: scroll with scrollback buffer when tty receives new lines (and
571 scrollTtyOutput is False); option +sw. False: do not scroll with 690 scrollTtyOutput is False); option -sw. False: do not scroll with
572 scrollback buffer when tty recieves new lines; option -sw. 691 scrollback buffer when tty recieves new lines; option +sw.
573 692
574 scrollTtyKeypress: *boolean* 693 scrollTtyKeypress: *boolean*
575 True: scroll to bottom when a non-special key is pressed. Special 694 True: scroll to bottom when a non-special key is pressed. Special
576 keys are those which are intercepted by rxvt-unicode for special 695 keys are those which are intercepted by rxvt-unicode for special
577 handling and are not passed onto the shell; option -sk. False: do 696 handling and are not passed onto the shell; option -sk. False: do
592 borderLess: *boolean* 711 borderLess: *boolean*
593 Set MWM hints to request a borderless window, i.e. if honoured by 712 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; 713 the WM, the rxvt-unicode window will not have window decorations;
595 option -bl. 714 option -bl.
596 715
716 skipBuiltinGlyphs: *boolean*
717 Compile *frills*: Disable the usage of the built-in block
718 graphics/line drawing characters and just rely on what the specified
719 fonts provide. Use this if you have a good font and want to use its
720 block graphic glyphs; option -sbg.
721
597 termName: *termname* 722 termName: *termname*
598 Specifies the terminal type name to be set in the TERM environment 723 Specifies the terminal type name to be set in the TERM environment
599 variable; option -tn. 724 variable; option -tn.
600 725
601 linespace: *number* 726 linespace: *number*
629 pointerColor2: *colour* 754 pointerColor2: *colour*
630 Mouse pointer background colour. 755 Mouse pointer background colour.
631 756
632 pointerBlankDelay: *number* 757 pointerBlankDelay: *number*
633 Specifies number of seconds before blanking the pointer [default 2]. 758 Specifies number of seconds before blanking the pointer [default 2].
759 Use a large number (e.g. 987654321) to effectively disable the
760 timeout.
634 761
635 backspacekey: *string* 762 backspacekey: *string*
636 The string to send when the backspace key is pressed. If set to DEC 763 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 764 or unset it will send Delete (code 127) or, if shifted, Backspace
638 (code 8) - which can be reversed with the appropriate DEC private 765 (code 8) - which can be reversed with the appropriate DEC private
654 781
655 inputMethod: *name* 782 inputMethod: *name*
656 *name* of inputMethod to use; option -im. 783 *name* of inputMethod to use; option -im.
657 784
658 imLocale: *name* 785 imLocale: *name*
659 The locale to use for opening the IM. You can use an LC_CTYPE of 786 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 787 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 788 the input extension to be able to input japanese characters while
662 staying in another locale. option -imlocale. 789 staying in another locale; option -imlocale.
790
791 imFont: *fontset*
792 Specify the font-set used for XIM styles "OverTheSpot" or
793 "OffTheSpot". It must be a standard X font set (XLFD patterns
794 separated by commas), i.e. it's not in the same format as the other
795 font lists used in rxvt. The default will be set-up to chose *any*
796 suitable found found, preferably one or two pixels differing in size
797 to the base font. option -imfont.
798
799 tripleclickwords: *boolean*
800 Change the meaning of triple-click selection with the left mouse
801 button. Instead of selecting a full line it will extend the
802 selection to the end of the logical line only; option -tcw.
663 803
664 insecure: *boolean* 804 insecure: *boolean*
665 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 805 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
666 that echo arbitrary strings like the icon name or the locale. This 806 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, 807 could be abused if somebody gets 8-bit-clean access to your display,
668 whether throuh a mail client displaying mail bodies unfiltered or 808 whether through a mail client displaying mail bodies unfiltered or
669 though write(1). Therefore, these sequences are disabled by default. 809 through write(1) or any other means. Therefore, these sequences are
670 (Note that other terminals, including xterm, have these sequences 810 disabled by default. (Note that many other terminals, including
671 enabled by default). You can enable them by setting this boolean 811 xterm, have these sequences enabled by default, which doesn't make
672 resource or specifying -insecure as an option. At the moment, this 812 it safer, though).
673 enabled display-answer, locale, findfont, icon label and window 813
674 title requests as well as dynamic menubar dispatch. 814 You can enable them by setting this boolean resource or specifying
815 -insecure as an option. At the moment, this enables display-answer,
816 locale, findfont, icon label and window title requests.
675 817
676 modifier: *modifier* 818 modifier: *modifier*
677 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 819 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
678 super, mod1, mod2, mod3, mod4, mod5; option -mod. 820 super, mod1, mod2, mod3, mod4, mod5; option -mod.
679 821
680 answerbackString: *string* 822 answerbackString: *string*
681 Specify the reply rxvt-unicode sends to the shell when an ENQ 823 Specify the reply rxvt-unicode sends to the shell when an ENQ
682 (control-E) character is passed through. It may contain escape 824 (control-E) character is passed through. It may contain escape
683 values as described in the entry on keysym following. 825 values as described in the entry on keysym following.
684 826
685 secondaryScreen: *bool* 827 secondaryScreen: *boolean*
686 Turn on/off secondary screen (default enabled). 828 Turn on/off secondary screen (default enabled).
687 829
688 secondaryScroll: *bool* 830 secondaryScroll: *boolean*
689 Turn on/off secondary screen scroll (default enabled). If the this 831 Turn on/off secondary screen scroll (default enabled). If the this
690 option is enabled, scrolls on the secondary screen will change the 832 option is enabled, scrolls on the secondary screen will change the
691 scrollback buffer and switching to/from the secondary screen will 833 scrollback buffer and switching to/from the secondary screen will
692 instead scroll the screen up. 834 instead scroll the screen up.
693 835
836 hold: *boolean*
837 Turn on/off hold window after exit support. If enabled, rxvt will
838 not immediately destroy its window when the program executed within
839 it exits. Instead, it will wait till it is being killed or closed by
840 the user.
841
694 keysym.*sym*: *string* 842 keysym.*sym*: *string*
695 Associate *string* with keysym *sym*. The intervening resource name 843 Compile *frills*: Associate *string* with keysym *sym*. The
696 keysym. cannot be omitted. This resource is only available when 844 intervening resource name keysym. cannot be omitted.
697 compiled with KEYSYM_RESOURCE.
698 845
699 The format of *sym* is "*(mask-)key*", where *mask* can be any 846 The format of *sym* is "*(modifiers-)key*", where *modifiers* can be
700 combination of Control, NumLock, Shift, Meta, Lock, Mod1, Mod2, 847 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, 848 Meta, Lock, Mod1, Mod2, Mod3, Mod4, Mod5, and the abbreviated I, K,
849 C, N, S, M, A, L, 1, 2, 3, 4, 5.
850
851 The NumLock, Meta and ISOLevel3 modifiers are usually aliased to
852 whatever modifier the NumLock key, Meta/Alt keys or ISO Level3
853 Shift/AltGr keys are being mapped. AppKeypad is a synthetic modifier
854 mapped to the current application keymap mode state.
855
702 5. The spellings of *key* can be obtained by using xev(1) command or 856 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 857 searching keysym macros from /usr/X11R6/include/X11/keysymdef.h and
704 omit the prefix XK_. Alternatively you can specify *key* by its hex 858 omitting the prefix XK_. Alternatively you can specify *key* by its
705 keysym value (0x0000 - 0xFFFF). Note that the lookup of *sym*s is 859 hex keysym value (0x0000 - 0xFFFF). Note that the lookup of *sym*s
706 not performed in an exact manner; however, the closest match is 860 is not performed in an exact manner; however, the closest match is
707 assured. 861 assured.
708 862
709 *string* may contain escape values (\a: bell, \b: backspace, \e, \E: 863 *string* may contain escape values ("\a": bell, "\b": backspace,
710 escape, \n: newline, \r: return, \t: tab, \000: octal number) or 864 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
711 control characters (^?: delete, ^@: null, ^A ...) and may enclosed 865 "\000": octal number) or verbatim control characters ("^?": delete,
866 "^@": null, "^A" ...) and may be enclosed with double quotes so that
712 with double quotes so that it can start or end with whitespace. 867 it can start or end with whitespace.
868
869 Please note that you need to double the "\" in resource files, as
870 Xlib itself does it's own de-escaping (you can use "\033" instead of
871 "\e" (and so on), which will work with both Xt and rxvt's own
872 processing).
713 873
714 You can define a range of keysyms in one shot by providing a 874 You can define a range of keysyms in one shot by providing a
715 *string* with pattern list/STRING1/STRING2/STRING3, where the 875 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
716 delimeter `/' should be a character not used by the STRINGs. 876 `/' should be a character not used by the strings.
717 877
718 Its usage can be demonstrated by an example: URxvt.keysym.M-C-0x61: 878 Its usage can be demonstrated by an example:
719 list.abc.\e<M-C-.> 879
880 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
720 881
721 The above line is equivalent to the following three lines: 882 The above line is equivalent to the following three lines:
883
722 URxvt.keysym.Meta-Control-0x61: \e<M-C-a> 884 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
723 URxvt.keysym.Meta-Control-0x62: \e<M-C-b> 885 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
724 URxvt.keysym.Meta-Control-0x63: \e<M-C-c> 886 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
725 887
726 If *string* takes the form of proto:STRING, the specified STRING is 888 If *string* takes the form of "command:STRING", the specified STRING
727 interpreted and executed as rxvt's control sequence. For example, 889 is interpreted and executed as rxvt's control sequence. For example
728 "proto:\033]701;zh_CN.GBK\007" means changing the current locale to 890 the following means "change the current locale to "zh_CN.GBK" when
729 zh_CN.GBK. 891 Control-Meta-c is being pressed":
892
893 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
894
895 If *string* takes the form "perl:STRING", then the specified STRING
896 is passed to the "on_keyboard_command" perl handler. See the
897 rxvtperl(3) manpage. For example, the selection extension (activated
898 via "rxvt -pe selection") listens for "selection:rot13" events:
899
900 URxvt.keysym.M-C-c: perl:selection:rot13
901
902 Due the the large number of modifier combinations, a defined key
903 mapping will match if at *at least* the specified identifiers are
904 being set, and no other key mappings with those and more bits are
905 being defined. That means that defining a key map for "a" will
906 automatically provide definitions for "Meta-a", "Shift-a" and so on,
907 unless some of those are defined mappings themselves.
908
909 Unfortunately, this will override built-in key mappings. For example
910 if you overwrite the "Insert" key you will disable rxvt's
911 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
912 the user-defined keymap using the "builtin:" replacement:
913
914 URxvt.keysym.Insert: <my insert key sequence>
915 URxvt.keysym.S-Insert: builtin:
916
917 The first line defines a mapping for "Insert" and *any* combination
918 of modifiers. The second line re-establishes the default mapping for
919 "Shift-Insert".
920
921 The following example will map Control-Meta-1 and Control-Meta-2 to
922 the fonts "suxuseuro" and "9x15bold", so you can have some limited
923 font-switching at runtime:
924
925 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
926 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
927
928 Other things are possible, e.g. resizing (see rxvt(7) for more
929 info):
930
931 URxvt.keysym.M-C-3: command:\033[8;25;80t
932 URxvt.keysym.M-C-4: command:\033[8;48;110t
933
934 perl-ext-common: *string*
935 perl-ext: *string*
936 Comma-separated list(s) of perl extension scripts (default:
937 "default") to use in this terminal instance; option -pe.
938
939 Extension names can be prefixed with a "-" sign to prohibit using
940 them. This can be useful to selectively disable some extensions
941 loaded by default, or specified via the "perl-ext-common" resource.
942 For example, "default,-selection" will use all the default extension
943 except "selection".
944
945 Extension names can also be followed by an argument in angle
946 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
947 for searchable scorllback to Alt/Meta-s). Mentioning the same
948 extension multiple times with different arguments will pass multiple
949 arguments to the extension.
950
951 Each extension is looked up in the library directories, loaded if
952 necessary, and bound to the current terminal instance.
953
954 If both of these resources are the empty string, then the perl
955 interpreter will not be initialized. The idea behind two options is
956 that perl-ext-common will be used for extensions that should be
957 available to all instances, while perl-ext is used for specific
958 instances.
959
960 perl-eval: *string*
961 Perl code to be evaluated when all extensions have been registered.
962 See the rxvtperl(3) manpage. Due to security reasons, this resource
963 will be ignored when running setuid/setgid.
964
965 perl-lib: *path*
966 Colon-separated list of additional directories that hold extension
967 scripts. When looking for extensions specified by the "perl"
968 resource, rxvt will first look in these directories and then in
969 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
970 will be ignored when running setuid/setgid.
971
972 See the rxvtperl(3) manpage.
973
974 selection.pattern-*idx*: *perl-regex*
975 Additional selection patterns, see the rxvtperl(3) manpage for
976 details.
977
978 selection-autotransform.*idx*: *perl-transform*
979 Selection auto-transform patterns, see the rxvtperl(3) manpage for
980 details.
981
982 searchable-scrollback: *keysym*
983 Sets the hotkey that starts the incremental scrollback buffer search
984 (default: "M-s").
985
986 urlLauncher: *string*
987 Specifies the program to be started with a URL argument. Used by the
988 "selection-popup" and "mark-urls" perl extensions.
989
990 transient-for: *windowid*
991 Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given
992 window id.
993
994 override-redirect: *boolean*
995 Compile *frills*: Sets override-redirect for the terminal window,
996 making it almost invisible to window managers; option
997 -override-redirect.
730 998
731THE SCROLLBAR 999THE SCROLLBAR
732 Lines of text that scroll off the top of the rxvt window (resource: 1000 Lines of text that scroll off the top of the rxvt window (resource:
733 saveLines) and can be scrolled back using the scrollbar or by 1001 saveLines) and can be scrolled back using the scrollbar or by
734 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1002 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
744 normal text selection/insertion, hold either the Shift or the Meta (Alt) 1012 normal text selection/insertion, hold either the Shift or the Meta (Alt)
745 key while performing the desired mouse action. 1013 key while performing the desired mouse action.
746 1014
747 If mouse reporting mode is active, the normal scrollbar actions are 1015 If mouse reporting mode is active, the normal scrollbar actions are
748 disabled -- on the assumption that we are using a fullscreen 1016 disabled -- on the assumption that we are using a fullscreen
749 application. Instead, pressing Button1 and Button3 sends ESC[6~ (Next) 1017 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
750 and ESC[5~ (Prior), respectively. Similarly, clicking on the up and down 1018 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
751 arrows sends ESC[A (Up) and ESC[B (Down), respectively. 1019 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
752 1020
753TEXT SELECTION AND INSERTION 1021TEXT SELECTION AND INSERTION
754 The behaviour of text selection and insertion mechanism is similar to 1022 The behaviour of text selection and insertion mechanism is similar to
755 *xterm*(1). 1023 *xterm*(1).
756 1024
757 Selection: 1025 Selection:
758 Left click at the beginning of the region, drag to the end of the 1026 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 1027 region and release; Right click to extend the marked region; Left
760 double-click to select a word; Left triple-click to select the 1028 double-click to select a word; Left triple-click to select the
761 entire line. 1029 entire logical line (which can span multiple screen lines), unless
1030 modified by resource tripleclickwords.
762 1031
763 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 1032 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
764 (Compile: frills) will create a rectangular selection instead of a 1033 (Compile: *frills*) will create a rectangular selection instead of a
765 normal one. 1034 normal one. In this mode, every selected row becomes its own line in
1035 the selection, and trailing whitespace is visually underlined and
1036 removed from the selection.
766 1037
767 Insertion: 1038 Insertion:
768 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1039 Pressing and releasing the Middle mouse button (or Shift-Insert) in
769 an rxvt window causes the current text selection to be inserted as 1040 an rxvt window causes the current text selection to be inserted as
770 if it had been typed on the keyboard. 1041 if it had been typed on the keyboard.
771 1042
772CHANGING FONTS 1043CHANGING FONTS
773 Changing fonts (or font sizes, respectively) via the keypad is not yet 1044 Changing fonts (or font sizes, respectively) via the keypad is not yet
774 supported in rxvt-unicode. Bug me if you need this. 1045 supported in rxvt-unicode. Bug me if you need this.
775 1046
776 You can, however, switch fonts at runtime using escape sequences (and 1047 You can, however, switch fonts at runtime using escape sequences, e.g.:
777 therefore using the menubar), e.g.:
778 1048
779 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1049 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1050
1051 You can use keyboard shortcuts, too:
1052
1053 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1054 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
780 1055
781 rxvt-unicode will automatically re-apply these fonts to the output so 1056 rxvt-unicode will automatically re-apply these fonts to the output so
782 far. 1057 far.
783 1058
784ISO 14755 SUPPORT 1059ISO 14755 SUPPORT
786 character codes using the keyboard. It consists of 4 parts. The first 1061 character codes using the keyboard. It consists of 4 parts. The first
787 part is available rxvt-unicode has been compiled with "--enable-frills", 1062 part is available rxvt-unicode has been compiled with "--enable-frills",
788 the rest is available when rxvt-unicode was compiled with 1063 the rest is available when rxvt-unicode was compiled with
789 "--enable-iso14755". 1064 "--enable-iso14755".
790 1065
791 5.1: Basic method 1066 * 5.1: Basic method
792 This allows you to enter unicode characters using their hexcode. 1067 This allows you to enter unicode characters using their hexcode.
793 1068
794 Start by pressing and holding both "Control" and "Shift", then enter 1069 Start by pressing and holding both "Control" and "Shift", then enter
795 hex-digits (between one and six). Releasing "Control" and "Shift" 1070 hex-digits (between one and six). Releasing "Control" and "Shift"
796 will commit the character as if it were typed directly. While 1071 will commit the character as if it were typed directly. While
802 address, which you cannot type. Fortunately, the card has the e-mail 1077 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 1078 address printed as hexcodes, e.g. "671d 65e5". You can enter this
804 easily by pressing "Control" and "Shift", followed by 1079 easily by pressing "Control" and "Shift", followed by
805 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys. 1080 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys.
806 1081
807 5.2: Keyboard symbols entry method 1082 * 5.2: Keyboard symbols entry method
808 This mode lets you input characters representing the keycap symbols 1083 This mode lets you input characters representing the keycap symbols
809 of your keyboard, if representable in the current locale encoding. 1084 of your keyboard, if representable in the current locale encoding.
810 1085
811 Start by pressing "Control" and "Shift" together, then releasing 1086 Start by pressing "Control" and "Shift" together, then releasing
812 them. The next special key (cursor keys, home etc.) you enter will 1087 them. The next special key (cursor keys, home etc.) you enter will
814 corresponding keycap symbol. The symbol will only be entered when 1089 corresponding keycap symbol. The symbol will only be entered when
815 the key has been released, otherwise pressing e.g. "Shift" would 1090 the key has been released, otherwise pressing e.g. "Shift" would
816 enter the symbol for "ISO Level 2 Switch", although your intention 1091 enter the symbol for "ISO Level 2 Switch", although your intention
817 might have been to enter a reverse tab (Shift-Tab). 1092 might have been to enter a reverse tab (Shift-Tab).
818 1093
819 5.3: Screen-selection entry method 1094 * 5.3: Screen-selection entry method
820 While this is implemented already (it's basically the selection 1095 While this is implemented already (it's basically the selection
821 mechanism), it could be extended by displaying a unicode character 1096 mechanism), it could be extended by displaying a unicode character
822 map. 1097 map.
823 1098
824 5.4: Feedback method for identifying displayed characters for later 1099 * 5.4: Feedback method for identifying displayed characters for later
825 input 1100 input
826 This method lets you display the unicode character code associated 1101 This method lets you display the unicode character code associated
827 with characters already displayed. 1102 with characters already displayed.
828 1103
829 You enter this mode by holding down "Control" and "Shift" together, 1104 You enter this mode by holding down "Control" and "Shift" together,
841 both scenario A and B of ISO 14755, including part 5.2. 1116 both scenario A and B of ISO 14755, including part 5.2.
842 1117
843LOGIN STAMP 1118LOGIN STAMP
844 rxvt tries to write an entry into the *utmp*(5) file so that it can be 1119 rxvt 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 1120 seen via the *who(1)* command, and can accept messages. To allow this
846 feature, rxvt must be installed setuid root on some systems. 1121 feature, rxvt may need to be installed setuid root on some systems or
1122 setgid to root or to some other group on others.
847 1123
848COLORS AND GRAPHICS 1124COLORS AND GRAPHICS
849 In addition to the default foreground and background colours, rxvt can 1125 In addition to the default foreground and background colours, rxvt can
850 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink 1126 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 1127 versions of the same). Here is a list of the colours with their rgb.txt
883 rxvt -fg Black -bg White -rv 1159 rxvt -fg Black -bg White -rv
884 would yield White on Black, while on *xterm*(1) it would yield Black 1160 would yield White on Black, while on *xterm*(1) it would yield Black
885 on White. 1161 on White.
886 1162
887ENVIRONMENT 1163ENVIRONMENT
888 rxvt sets the environment variables TERM, COLORTERM and COLORFGBG. The 1164 rxvt sets and/or uses the following environment variables:
889 environment variable WINDOWID is set to the X window id number of the 1165
890 rxvt window and it also uses and sets the environment variable DISPLAY 1166 TERM
891 to specify which display terminal to use. rxvt uses the environment 1167 Normally set to "rxvt-unicode", unless overwritten at configure
892 variables RXVTPATH and PATH to find XPM files. 1168 time, via resources or on the commandline.
1169
1170 COLORTERM
1171 Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled
1172 with XPM support, and optionally with the added extension "-mono" to
1173 indicate that rxvt-unicode runs on a monochrome screen.
1174
1175 COLORFGBG
1176 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1177 the colour code used as default foreground/text colour (or the
1178 string "default" to indicate that the default-colour escape sequence
1179 is to be used), "bg" is the colour code used as default background
1180 colour (or the string "default"), and "xpm" is the string "default"
1181 if rxvt was compiled with XPM support. Libraries like "ncurses" and
1182 "slang" can (and do) use this information to optimize screen output.
1183
1184 WINDOWID
1185 Set to the (decimal) X Window ID of the rxvt window (the toplevel
1186 window, which usually has subwindows for the scrollbar, the terminal
1187 window and so on).
1188
1189 TERMINFO
1190 Set to the terminfo directory iff rxvt was configured with
1191 "--with-terminfo=PATH".
1192
1193 DISPLAY
1194 Used by rxvt to connect to the display and set to the correct
1195 display in it's child processes.
1196
1197 SHELL
1198 The shell to be used for command execution, defaults to "/bin/sh".
1199
1200 RXVT_SOCKET
1201 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1202
1203 Default $HOME/.rxvt-unicode-*<nodename*.
1204
1205 HOME
1206 Used to locate the default directory for the unix domain socket for
1207 daemon communications and to locate various resource files (such as
1208 ".Xdefaults")
1209
1210 XAPPLRESDIR
1211 Directory where various X resource files are being located.
1212
1213 XENVIRONMENT
1214 If set and accessible, gives the name of a X resource file to be
1215 loaded by rxvt.
893 1216
894FILES 1217FILES
895 /etc/utmp
896 System file for login records.
897
898 /usr/lib/X11/rgb.txt 1218 /usr/lib/X11/rgb.txt
899 Color names. 1219 Color names.
900 1220
901SEE ALSO 1221SEE ALSO
902 rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1222 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
903 1223 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 1224
911CURRENT PROJECT COORDINATOR 1225CURRENT PROJECT COORDINATOR
912 Project Coordinator 1226 Project Coordinator
913 Marc A. Lehmann rxvt@schmorp.de 1227 Marc A. Lehmann <rxvt-unicode@schmorp.de>
914 1228
915 Web page maintainter
916 Marc A. Lehmann rxvt@schmorp.de
917
918 <http://software.schmorp.de/> 1229 <http://software.schmorp.de/#rxvt-unicode>
919 1230
920AUTHORS 1231AUTHORS
921 John Bovey 1232 John Bovey
922 University of Kent, 1992, wrote the original Xvt. 1233 University of Kent, 1992, wrote the original Xvt.
923 1234
934 1245
935 Oezguer Kesim <kesim@math.fu-berlin.de> 1246 Oezguer Kesim <kesim@math.fu-berlin.de>
936 Project Coordinator (changes.txt 2.21a to 2.4.5) 1247 Project Coordinator (changes.txt 2.21a to 2.4.5)
937 1248
938 Geoff Wing <gcw@pobox.com> 1249 Geoff Wing <gcw@pobox.com>
939 Rewrote screen display and text selection routines. Project 1250 Rewrote screen display and text selection routines.
1251
940 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1252 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
941 1253
942 Marc Alexander Lehmann <rxvt@schmorp.de> 1254 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
943 Forked rxvt-unicode, rewrote most of the display code and internal 1255 Forked rxvt-unicode, unicode support, rewrote almost all the code,
944 character handling to store text in unicode, improve xterm 1256 perl extension, random hacks, numerous bugfixes and extensions.
945 compatibility and apply numerous other bugfixes and extensions.
946 1257
947 Project Coordinator (Changes 1.0 -) 1258 Project Coordinator (Changes 1.0 -)
948 1259
1260 Emanuele Giaquinta <e.giaquinta@glauco.it>
1261 Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugxifing.
1262

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines