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

Diff Legend

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