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

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

Diff Legend

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