--- rxvt-unicode/doc/rxvt.1.txt 2005/07/07 19:37:47 1.23 +++ rxvt-unicode/doc/rxvt.1.txt 2006/01/02 19:36:07 1.30 @@ -6,7 +6,7 @@ rxvt [options] [-e command [ args ]] DESCRIPTION - rxvt-unicode, version 5.6, is a colour vt102 terminal emulator intended + rxvt-unicode, version 6.2, is a colour vt102 terminal emulator intended as an *xterm*(1) replacement for users who do not require features such as Tektronix 4014 emulation and toolkit-style configurability. As a result, rxvt-unicode uses much less swap space -- a significant @@ -95,19 +95,27 @@ -j|+j Turn on/off jump scrolling; resource jumpScroll. - -ip|+ip + -ip|+ip | -tr|+tr Turn on/off inheriting parent window's pixmap. Alternative form is -tr; resource inheritPixmap. -fade *number* - Fade the text by the given percentage when focus is lost. resource - fading. + Fade the text by the given percentage when focus is lost. Small + values fade a little only, 100 completely replaces all colours by + the fade colour; resource fading. + + -fadecolor *colour* + Fade to this colour when fading is used (see -fade). The default + colour is black. resource fadeColor. -tint *colour* Tint the transparent background pixmap with the given colour when - transparency is enabled with -tr or -ip. See also the -sh option - that can be used to brighten or darken the image in addition to - tinting it. + transparency is enabled with -tr or -ip. This only works for + non-tiled backgrounds, currently. See also the -sh option that can + be used to brighten or darken the image in addition to tinting it; + resource *tintColor*. Example: + + rxvt -tr -tint blue -sh 40 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image in addition to tinting it (i.e. -tint must be @@ -169,6 +177,11 @@ characters are to be printed. See resource boldItalicFont for details. + -is|+is + Compile font-styles: Bold/Italic font styles imply high intensity + foreground/background (default). See resource intensityStyles for + details. + -name *name* Specify the application name under which resources are to be obtained, rather than the default executable file name. Name should @@ -261,6 +274,12 @@ run the program specified by the SHELL environment variable or, failing that, *sh(1)*. + Please note that you must specify a program with arguments. If you + want to run shell commands, you have to specify the shell, like + this: + + rxvt -e sh -c "shell commands" + -title *text* Window title (-T still respected); the default title is the basename of the program specified after the -e option, if any, otherwise the @@ -313,6 +332,12 @@ Turn on/off secondary screen scroll (default enabled); resource secondaryScroll. + -hold|+hold + Turn on/off hold window after exit support. If enabled, rxvt will + not immediately destroy its window when the program executed within + it exits. Instead, it will wait till it is being killed or closed by + the user; resource hold. + -keysym.*sym* *string* Remap a key symbol. See resource keysym. @@ -367,6 +392,9 @@ my $slave = $pty->slave; while (<$slave>) { print $slave "got <$_>\n" } + -perl *string* + Used by perl extension. See resource perl. + RESOURCES (available also as long-options) Note: `rxvt --help' gives a list of all resources (long options) compiled into your version. @@ -469,10 +497,16 @@ pixmap. fading: *number* - Fade the text by the given percentage when focus is lost. + Fade the text by the given percentage when focus is lost; option + -fade. + + fadeColor: *colour* + Fade to this colour, when fading is used (see fading:). The default + colour is black; option -fadecolor. tintColor: *colour* - Tint the transparent background pixmap with the given colour. + Tint the transparent background pixmap with the given colour; option + -tint. shading: *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent background @@ -516,7 +550,7 @@ names that are used in turn when trying to display Unicode characters. The first font defines the cell size for characters; other fonts might be smaller, but not larger. A reasonable default - font list is always appended to it. option -fn. + font list is always appended to it; option -fn. Each font can either be a standard X11 core font (XLFD) name, with optional prefix "x:" or a Xft font (Compile *xft*), prefixed with @@ -572,6 +606,13 @@ If set, but empty, then this specific style is disabled and the normal text font will being used for the given style. + intensityStyles: *boolean* + When font styles are not enabled, or this option is enabled (True, + option -is, the default), bold and italic font styles imply high + intensity foreground/backround colours. Disabling this option + (False, option +is) disables this behaviour, the high intensity + colours are not reachable. + selectstyle: *mode* Set mouse selection style to old which is 2.20, oldword which is xterm style with 2.20 old word selection, or anything else which @@ -738,7 +779,7 @@ The locale to use for opening the IM. You can use an "LC_CTYPE" of e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for the input extension to be able to input japanese characters while - staying in another locale. option -imlocale. + staying in another locale; option -imlocale. imFont: *fontset* Specify the font-set used for XIM styles "OverTheSpot" or @@ -751,19 +792,22 @@ tripleclickwords: *boolean* Change the meaning of triple-click selection with the left mouse button. Instead of selecting a full line it will extend the - selection to the end of the logical line only. option -tcw. + selection to the end of the logical line only; option -tcw. insecure: *boolean* Enables "insecure" mode. Rxvt-unicode offers some escape sequences that echo arbitrary strings like the icon name or the locale. This could be abused if somebody gets 8-bit-clean access to your display, - whether throuh a mail client displaying mail bodies unfiltered or - though write(1). Therefore, these sequences are disabled by default. - (Note that other terminals, including xterm, have these sequences - enabled by default). You can enable them by setting this boolean - resource or specifying -insecure as an option. At the moment, this - enabled display-answer, locale, findfont, icon label and window - title requests as well as dynamic menubar dispatch. + whether through a mail client displaying mail bodies unfiltered or + through write(1) or any other means. Therefore, these sequences are + disabled by default. (Note that many other terminals, including + xterm, have these sequences enabled by default, which doesn't make + it safer, though). + + You can enable them by setting this boolean resource or specifying + -insecure as an option. At the moment, this enables display-answer, + locale, findfont, icon label and window title requests as well as + dynamic menubar dispatch. modifier: *modifier* Set the key to be interpreted as the Meta key to: alt, meta, hyper, @@ -783,6 +827,12 @@ scrollback buffer and switching to/from the secondary screen will instead scroll the screen up. + hold: *bool* + Turn on/off hold window after exit support. If enabled, rxvt will + not immediately destroy its window when the program executed within + it exits. Instead, it will wait till it is being killed or closed by + the user. + keysym.*sym*: *string* Compile *frills*: Associate *string* with keysym *sym*. The intervening resource name keysym. cannot be omitted. @@ -868,6 +918,22 @@ URxvt.keysym.M-C-3: command:\033[8;25;80t URxvt.keysym.M-C-4: command:\033[8;48;110t + perl: *string* + Used by perl extension and is free for any use, as it is not + interpreted by rxvt-unicode itself; option perl. + + perl-eval: *string* + Perl code to be evaluated when all extensions have been loaded. See + the rxvtperl(3) manpage. + + perl-lib: *path* + Additional directory that holds extension scripts that are loaded + and enabled for this terminal instance, in addition to scripts + stored in /opt/rxvt/lib/urxvt/perl-ext/, which are global to all + terminal instances. + + See the rxvtperl(3) manpage. + THE SCROLLBAR Lines of text that scroll off the top of the rxvt window (resource: saveLines) and can be scrolled back using the scrollbar or by @@ -903,7 +969,9 @@ Starting a selection while pressing the Meta key (or Meta+Ctrl keys) (Compile: *frills*) will create a rectangular selection instead of a - normal one. + normal one. In this mode, every selected row becomes its own line in + the selection, and trailing whitespace is visually underlined and + removed from the selection. Insertion: Pressing and releasing the Middle mouse button (or Shift-Insert) in @@ -917,7 +985,7 @@ You can, however, switch fonts at runtime using escape sequences (and therefore using the menubar), e.g.: - printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" + printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" rxvt-unicode will automatically re-apply these fonts to the output so far. @@ -1095,13 +1163,6 @@ rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) -BUGS - Check the BUGS file for an up-to-date list. - - Cursor change support is not yet implemented. - - Click-and-drag doesn't work with X11 mouse report overriding. - CURRENT PROJECT COORDINATOR Project Coordinator Marc A. Lehmann