--- rxvt-unicode/doc/rxvt.1.html 2005/04/22 02:09:39 1.21 +++ rxvt-unicode/doc/rxvt.1.html 2006/01/10 04:26:54 1.40 @@ -29,7 +29,6 @@
  • ENVIRONMENT
  • FILES
  • SEE ALSO
    • -
  • BUGS
  • CURRENT PROJECT COORDINATOR
  • AUTHORS
    • @@ -49,7 +48,7 @@

    DESCRIPTION

    -

    rxvt-unicode, version 5.5, is a colour vt102 terminal +

    rxvt-unicode, version 6.3, 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 -- @@ -152,7 +151,7 @@ Turn on/off jump scrolling; resource jumpScroll.

    -
    -ip|+ip
    +
    -ip|+ip | -tr|+tr
    Turn on/off inheriting parent window's pixmap. Alternative form is @@ -162,16 +161,30 @@
    -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
    @@ -255,22 +268,31 @@
    -fb fontlist
    -Compile font-styles: The bold font list to use when bold characters are to -be printed. See resource boldFont for details. +Compile font-styles: The bold font list to use when bold characters +are to be printed. See resource boldFont for details.

    -fi fontlist
    -Compile font-styles: The italic font list to use when bold characters are to -be printed. See resource italicFont for details. +Compile font-styles: The italic font list to use when italic +characters are to be printed. See resource italicFont for details.

    -fbi fontlist
    -Compile font-styles: The bold italic font list to use when bold characters are to -be printed. See resource boldItalicFont for details. +Compile font-styles: The bold italic font list to use when bold +italic > 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
    @@ -338,7 +360,7 @@
    -st|+st
    -Display normal (non XTerm/NeXT) scrollbar without/with a trough; +Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; resource scrollBar_floating.

    @@ -395,6 +417,15 @@ decorations; resource borderLess.

    +
    -sbg
    +
    +
    +Compile frills: Disable the usage of the built-in block graphics/line +drawing characters and just rely on what the specified fonts provide. Use +this if you have a good font and want to use its block graphic glyphs; +resource skipBuiltinGlyphs. +
    +

    -lsp number
    @@ -423,6 +454,14 @@ 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
    @@ -513,6 +552,15 @@ 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
    @@ -554,7 +602,7 @@ });

    -
    -pty-fd fileno
    +
    -pty-fd file descriptor
    Tells rxvt NOT to execute any commands or create a new pty/tty @@ -568,6 +616,10 @@ yourself if you want that.

    +

    As an extremely special case, specifying -1 will completely suppress +pty/tty operations.

    +
    +

    Here is a example in perl that illustrates how this option can be used (a longer example is in doc/pty-fd):

    @@ -589,6 +641,13 @@ my $slave = $pty->slave; while (<$slave>) { print $slave "got <$_>\n" } +

    +
    -pe string
    +
    +
    +Comma-separated list of perl extension scripts to use (or not to use) in +this terminal instance. See resource perl-ext for details. +

    @@ -738,13 +797,21 @@
    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
    @@ -764,7 +831,7 @@
    Use the specified colour for the scrollbar's trough area [default -#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. +#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.

    borderColor: colour
    @@ -811,7 +878,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. +appended to it; option -fn.

    Each font can either be a standard X11 core font (XLFD) name, with @@ -882,6 +949,16 @@ 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
    @@ -894,7 +971,7 @@
    Set scrollbar style to rxvt, plain, next or xterm. plain is -the author's favourite.. +the author's favourite.

    title: string
    @@ -950,6 +1027,20 @@ Print to initiate a screen dump to the printer and Ctrl-Print or Shift-Print to include the scrollback as well. +
    +

    The string will be interpreted as if typed into the shell as-is.

    +
    +
    +

    Example:

    +
    +
    +
    +   URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
    +
    +
    +

    This creates a new file in your home directory with the screen contents +everytime you hit Print.

    +

    scrollBar: boolean
    @@ -1032,6 +1123,15 @@ WM, the rxvt-unicode window will not have window decorations; option -bl.

    +
    skipBuiltinGlyphs: boolean
    +
    +
    +Compile frills: Disable the usage of the built-in block graphics/line +drawing characters and just rely on what the specified fonts provide. Use +this if you have a good font and want to use its block graphic glyphs; +option -sbg. +
    +

    termName: termname
    @@ -1146,7 +1246,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. +another locale; option -imlocale.

    imFont: fontset
    @@ -1165,7 +1265,7 @@
    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. +the end of the logical line only; option -tcw.

    insecure: boolean
    @@ -1174,13 +1274,16 @@ 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. +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
    @@ -1214,6 +1317,15 @@ 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
    @@ -1285,6 +1397,16 @@ URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
    +

    If string takes the form perl:STRING, then the specified STRING +is passed to the on_keyboard_command perl handler. See the rxvtperl(3) +manpage. For example, the selection extension (activated via +rxvt -pe selection) listens for selection:rot13 events:

    +
    +
    +
    +  URxvt.keysym.M-C-c: perl:selection:rot13
    +
    +

    Due the the large number of modifier combinations, a defined key mapping will match if at at least the specified identifiers are being set, and no other key mappings with those and more bits are being defined. That @@ -1327,6 +1449,66 @@ URxvt.keysym.M-C-3: command:\033[8;25;80t URxvt.keysym.M-C-4: command:\033[8;48;110t

    +

    +
    perl-ext-common: string
    +
    +
    perl-ext: string
    +
    +
    +Comma-separated list(s) of perl extension scripts (default: default) to +use in this terminal instance; option -pe. +
    +
    +

    Extension names can be prefixed with a - sign to prohibit using +them. This can be useful to selectively disable some extensions loaded +by default, or specified via the perl-ext-common resource. For +example, default,-selection will use all the default extension except +selection.

    +
    +
    +

    Extension names can also be followed by an argument in angle brackets +(e.g. searchable-scrollback<M-s>, which binds the hotkey for +searchable scorllback to Alt/Meta-s). Mentioning the same extension +multiple times with different arguments will pass multiple arguments to +the extension.

    +
    +
    +

    Each extension is looked up in the library directories, loaded if +necessary, and bound to the current terminal instance.

    +
    +
    +

    If both of these resources are the empty string, then the perl +interpreter will not be initialized. The idea behind two options is that +perl-ext-common will be used for extensions that should be available to +all instances, while perl-ext is used for specific instances.

    +
    +

    +
    perl-eval: string
    +
    +
    +Perl code to be evaluated when all extensions have been registered. See +the rxvtperl(3) manpage. Due to security reasons, this resource +will be ignored when running setuid/setgid. +
    +

    +
    perl-lib: path
    +
    +
    +Colon-separated list of additional directories that hold extension +scripts. When looking for extensions specified by the perl resource, +rxvt will first look in these directories and then in +/opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource +will be ignored when running setuid/setgid. +
    +
    +

    See the rxvtperl(3) manpage.

    +
    +

    +
    transient-for: windowid
    +
    +
    +Sets the WM_TRANSIENT_FOR property to the given window iw. +

    @@ -1371,8 +1553,10 @@

    Starting a selection while pressing the Meta key (or Meta+Ctrl keys) -(Compile: frills) will create a rectangular selection instead of a normal -one.

    +(Compile: frills) will create a rectangular selection instead of a +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:
    @@ -1392,7 +1576,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.

    @@ -1583,7 +1767,7 @@ rxvtd(1).
    -

    Default $HOME/.rxvt-unicode-<nodename.

    +

    Default $HOME/.rxvt-unicode-<nodename >>>.

    HOME
    @@ -1622,14 +1806,7 @@

    SEE ALSO

    -

    rxvt(7), 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.

    +

    rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)