--- rxvt-unicode/doc/rxvt.1.html 2005/02/03 10:24:10 1.6 +++ rxvt-unicode/doc/rxvt.1.html 2005/10/25 20:22:39 1.25 @@ -29,7 +29,6 @@
  • ENVIRONMENT
  • FILES
  • SEE ALSO
  • -
  • BUGS
  • CURRENT PROJECT COORDINATOR
  • AUTHORS
  • @@ -49,7 +48,7 @@


    DESCRIPTION

    -

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

    rxvt-unicode, version 5.8, 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 -- @@ -58,8 +57,10 @@


    FREQUENTLY ASKED QUESTIONS

    -

    See rxvt(7) (try man 7 rxvt) for a list of frequently -asked questions and answer to them and some common problems.

    +

    See rxvt(7) (try man 7 rxvt) for a list of +frequently asked questions and answer to them and some common +problems. That document is also accessible on the World-Wide-Web at +http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html.


    @@ -150,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 @@ -160,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
    @@ -336,7 +351,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.

    @@ -511,12 +526,81 @@ secondaryScroll.

    -
    -xrm resourcestring
    +
    -keysym.sym string
    -No effect on rxvt-unicode. Simply passes through an argument to be made -available in the instance's argument list. Appears in WM_COMMAND in -some window managers. +Remap a key symbol. See resource keysym. +
    +

    +
    -embed windowid
    +
    +
    +Tells rxvt to embed it's windows into an already-existing window, +which enables applications to easily embed a terminal. +
    +
    +

    Right now, rxvt will first unmap/map the specified window, so it +shouldn't be a top-level window. rxvt will also reconfigure it +quite a bit, so don't expect it to keep some specific state. It's best to +create an extra subwindow for rxvt and leave it alone.

    +
    +
    +

    The window will not be destroyed when rxvt exits.

    +
    +
    +

    It might be useful to know that rxvt will not close file +descriptors passed to it (except for stdin/out/err, of course), so you +can use file descriptors to communicate with the programs within the +terminal. This works regardless of wether the -embed option was used or +not.

    +
    +
    +

    Here is a short Gtk2-perl snippet that illustrates how this option can be +used (a longer example is in doc/embed):

    +
    +
    +
    +   my $rxvt = new Gtk2::Socket;
    +   $rxvt->signal_connect_after (realize => sub {
    +      my $xid = $_[0]->window->get_xid;
    +      system "rxvt -embed $xid &";
    +   });
    +
    +

    +
    -pty-fd fileno
    +
    +
    +Tells rxvt NOT to execute any commands or create a new pty/tty +pair but instead use the given filehandle as the tty master. This is +useful if you want to drive rxvt as a generic terminal emulator +without having to run a program within it. +
    +
    +

    If this switch is given, rxvt will not create any utmp/wtmp +entries and will not tinker with pty/tty permissions - you have to do that +yourself if you want that.

    +
    +
    +

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

    +
    +
    +
    +   use IO::Pty;
    +   use Fcntl;
    +
    +
    +
    +   my $pty = new IO::Pty;
    +   fcntl $pty, F_SETFD, 0; # clear close-on-exec
    +   system "rxvt -pty-fd " . (fileno $pty) . "&";
    +   close $pty;
    +
    +
    +
    +   # now communicate with rxvt
    +   my $slave = $pty->slave;
    +   while (<$slave>) { print $slave "got <$_>\n" }

    @@ -529,8 +613,16 @@ Xresource data: using the X libraries (Xrm*-functions) or internal Xresources reader (~/.Xdefaults). For the first method (ie. rxvt -h lists XGetDefaults), you can set and change the -resources using X11 tools like xset. Many distribution do also load -settings from the ~/.Xresources file when X starts.

    +resources using X11 tools like xrdb. Many distribution do also load +settings from the ~/.Xresources file when X starts. rxvt +will consult the following files/resources in order, with later settings +overwriting earlier ones:

    +
    +  1. system-wide app-defaults file, either locale-dependent OR global
    +  2. app-defaults file in $XAPPLRESDIR
    +  3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
    +  4. SCREEN_RESOURCES for the current screen
    +  5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>

    If compiled with internal Xresources support (i.e. rxvt -h lists .Xdefaults) then rxvt accepts application defaults set in XAPPLOADDIR/URxvt (compile-time defined: usually @@ -659,13 +751,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
    @@ -685,7 +785,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
    @@ -815,7 +915,7 @@
    Set scrollbar style to rxvt, plain, next or xterm. plain is -the author's favourite.. +the author's favourite.

    title: string
    @@ -871,6 +971,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
    @@ -912,8 +1026,8 @@
    True: scroll with scrollback buffer when tty receives new lines (and -scrollTtyOutput is False); option +sw. False: do not scroll -with scrollback buffer when tty recieves new lines; option -sw. +scrollTtyOutput is False); option -sw. False: do not scroll +with scrollback buffer when tty recieves new lines; option +sw.

    scrollTtyKeypress: boolean
    @@ -1018,7 +1132,8 @@
    pointerBlankDelay: number
    -Specifies number of seconds before blanking the pointer [default 2]. +Specifies number of seconds before blanking the pointer [default 2]. Use a +large number (e.g. 987654321) to effectively disable the timeout.

    backspacekey: string
    @@ -1168,6 +1283,12 @@ can start or end with whitespace.

    +

    Please note that you need to double the \ when using +--enable-xgetdefault, as X itself does it's own de-escaping (you can +use \033 instead of \e (and so on), which will work with both Xt and +rxvt's own processing).

    +
    +

    You can define a range of keysyms in one shot by providing a string with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter `/' should be a character not used by the strings.

    @@ -1177,40 +1298,69 @@
    -  URxvt.keysym.M-C-0x61:    list|\e<M-C-|abc|>
    + URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>

    The above line is equivalent to the following three lines:

    -  URxvt.keysym.Meta-Control-0x61:    \e<M-C-a>
    -  URxvt.keysym.Meta-Control-0x62:    \e<M-C-b>
    -  URxvt.keysym.Meta-Control-0x63:    \e<M-C-c>
    + URxvt.keysym.Meta-Control-0x61: \033<M-C-a> + URxvt.keysym.Meta-Control-0x62: \033<M-C-b> + URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
    -

    If string takes the form of proto:STRING, the specified STRING +

    If string takes the form of command:STRING, the specified STRING is interpreted and executed as rxvt's control sequence. For example the following means ``change the current locale to zh_CN.GBK when Control-Meta-c is being pressed'':

    -  URxvt.keysym.M-C-c: proto:\033]701;zh_CN.GBK\007
    + URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 +
    +
    +

    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 +means that defining a key map for a will automatically provide +definitions for Meta-a, Shift-a and so on, unless some of those are defined +mappings themselves.

    +
    +
    +

    Unfortunately, this will override built-in key mappings. For example +if you overwrite the Insert key you will disable rxvt's +Shift-Insert mapping. To re-enable that, you can poke ``holes'' into the +user-defined keymap using the builtin: replacement:

    +
    +
    +
    +  URxvt.keysym.Insert: <my insert key sequence>
    +  URxvt.keysym.S-Insert: builtin:
    +
    +
    +

    The first line defines a mapping for Insert and any combination +of modifiers. The second line re-establishes the default mapping for +Shift-Insert.

    The following example will map Control-Meta-1 and Control-Meta-2 to -the fonts suxuseuro and 9x15bold, so you cna have some limited +the fonts suxuseuro and 9x15bold, so you can have some limited font-switching at runtime:

    -  URxvt.keysym.M-C-1: proto:\033]50;suxuseuro\007
    -  URxvt.keysym.M-C-2: proto:\033]50;9x15bold\007
    + URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 + URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
    -

    proto:\033]701;zh_CN.GBK\007 means: change the current locale to -zh_CN.GBK.

    +

    Other things are possible, e.g. resizing (see rxvt(7) for more +info):

    +
    +
    +
    +  URxvt.keysym.M-C-3: command:\033[8;25;80t
    +  URxvt.keysym.M-C-4: command:\033[8;48;110t

    @@ -1234,9 +1384,9 @@ (Alt) key while performing the desired mouse action.

    If mouse reporting mode is active, the normal scrollbar actions are disabled -- on the assumption that we are using a fullscreen -application. Instead, pressing Button1 and Button3 sends ESC[6~ -(Next) and ESC[5~ (Prior), respectively. Similarly, clicking on the -up and down arrows sends ESC[A (Up) and ESC[B (Down), +application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~ +(Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the +up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.

    @@ -1391,12 +1541,107 @@


    ENVIRONMENT

    -

    rxvt sets the environment variables TERM, COLORTERM -and COLORFGBG. The environment variable WINDOWID is set to the X -window id number of the rxvt window and it also uses and -sets the environment variable DISPLAY to specify which display -terminal to use. rxvt uses the environment variables -RXVTPATH and PATH to find XPM files.

    +

    rxvt sets and/or uses the following environment variables:

    +
    +
    TERM
    +
    +
    +Normally set to rxvt-unicode, unless overwritten at configure time, via +resources or on the commandline. +
    +

    +
    COLORTERM
    +
    +
    +Either rxvt, rxvt-xpm, depending on wether rxvt was +compiled with XPM support, and optionally with the added extension +-mono to indicate that rxvt-unicode runs on a monochrome screen. +
    +

    +
    COLORFGBG
    +
    +
    +Set to a string of the form fg;bg or fg;xpm;bg, where fg is +the colour code used as default foreground/text colour (or the string +default to indicate that the default-colour escape sequence is to be +used), bg is the colour code used as default background colour (or the +string default), and xpm is the string default if rxvt +was compiled with XPM support. Libraries like ncurses and slang can +(and do) use this information to optimize screen output. +
    +

    +
    WINDOWID
    +
    +
    +Set to the (decimal) X Window ID of the rxvt window (the toplevel +window, which usually has subwindows for the scrollbar, the terminal +window and so on). +
    +

    +
    TERMINFO
    +
    +
    +Set to the terminfo directory iff rxvt was configured with +--with-terminfo=PATH. +
    +

    +
    DISPLAY
    +
    +
    +Used by rxvt to connect to the display and set to the correct +display in it's child processes. +
    +

    +
    SHELL
    +
    +
    +The shell to be used for command execution, defaults to /bin/sh. +
    +

    +
    RXVTPATH
    +
    +
    +The path where rxvt looks for support files such as menu and xpm +files. +
    +

    +
    PATH
    +
    +
    +Used in the same way as RXVTPATH. +
    +

    +
    RXVT_SOCKET
    +
    +
    +The unix domain socket path used by rxvtc(1) and +rxvtd(1). +
    +
    +

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

    +
    +

    +
    HOME
    +
    +
    +Used to locate the default directory for the unix domain socket for +daemon communications and to locate various resource files (such as +.Xdefaults) +
    +

    +
    XAPPLRESDIR
    +
    +
    +Directory where various X resource files are being located. +
    +

    +
    XENVIRONMENT
    +
    +
    +If set and accessible, gives the name of a X resource file to be loaded by +rxvt. +
    +


    @@ -1412,14 +1657,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)


    @@ -1428,16 +1666,10 @@
    Project Coordinator
    -Marc A. Lehmann rxvt@schmorp.de -
    -

    -
    Web page maintainter
    -
    -
    -Marc A. Lehmann rxvt@schmorp.de +Marc A. Lehmann >
    -

    http://software.schmorp.de/

    +

    http://software.schmorp.de/#rxvt-unicode

    @@ -1485,7 +1717,7 @@ (changes.txt 2.4.6 - rxvt-unicode)

    -
    Marc Alexander Lehmann >
    +
    Marc Alexander Lehmann >
    Forked rxvt-unicode, rewrote most of the display code and internal