--- rxvt-unicode/doc/rxvt.1.html 2005/01/11 02:24:59 1.1 +++ rxvt-unicode/doc/rxvt.1.html 2005/10/25 20:04:58 1.24 @@ -49,7 +49,7 @@


DESCRIPTION

-

rxvt-unicode, version 4.8, 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 +58,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 +152,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 +162,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
@@ -196,8 +212,8 @@
Compile XPM: Specify XPM file for the background and also optionally -specify its scaling with a geometry string. Note you may need to add -quotes to avoid special shell interpretation of the `;' in the +specify its scaling with a geometry string. Note you may need to +add quotes to avoid special shell interpretation of the ; in the command-line; resource backgroundPixmap.

@@ -336,7 +352,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.

@@ -460,10 +476,25 @@
-imlocale string
-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. +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. resource imLocale. +
+

+
-imfont fontset
+
+
+Set the font set to use for the X Input Method, see resource imFont +for more info. +
+

+
-tcw
+
+
+Change the meaning of triple-click selection with the left mouse +button. Instead of selecting a full line it will extend the selection the +end of the logical line only. resource tripleclickwords.

-insecure
@@ -496,12 +527,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" }

@@ -514,8 +614,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 @@ -578,7 +686,7 @@

Use the specified colour to display bold or italic characters when the foreground colour is the default. If font styles are not available -(Compile styles) and this option is unset, reverse video is used instead. +(Compile styles) and this option is unset, reverse video is used instead.

colorUL: colour
@@ -644,13 +752,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
@@ -670,7 +786,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
@@ -721,7 +837,7 @@

Each font can either be a standard X11 core font (XLFD) name, with -optional prefix x: or a Xft font (Compile xft), prefixed with xft:.

+optional prefix x: or a Xft font (Compile xft), prefixed with xft:.

In addition, each font can be prefixed with additional hints and @@ -800,7 +916,7 @@

Set scrollbar style to rxvt, plain, next or xterm. plain is -the author's favourite.. +the author's favourite.

title: string
@@ -856,6 +972,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
@@ -897,8 +1027,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
@@ -1003,7 +1133,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
@@ -1048,12 +1179,31 @@
imLocale: name
-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 +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.

+
imFont: fontset
+
+
+Specify the font-set used for XIM styles OverTheSpot or +OffTheSpot. It must be a standard X font set (XLFD patterns separated +by commas), i.e. it's not in the same format as the other font lists used +in rxvt. The default will be set-up to chose *any* suitable found +found, preferably one or two pixels differing in size to the base font. +option -imfont. +
+

+
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. +
+

insecure: boolean
@@ -1103,14 +1253,115 @@
keysym.sym: string
-Associate string with keysym sym (0xFF00 - 0xFFFF). It may -contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: -newline, \r: return, \t: -tab, \000: octal number) or control characters (^?: delete, ^@: null, -^A ...) and may enclosed with double quotes so that it can start or end -with whitespace. The intervening resource name keysym. cannot be -omitted. This resource is only available when compiled with -KEYSYM_RESOURCE. +Compile frills: Associate string with keysym sym. The +intervening resource name keysym. cannot be omitted. +
+
+

The format of sym is ``(modifiers-)key'', where modifiers can be +any combination of ISOLevel3, AppKeypad, Control, NumLock, +Shift, Meta, Lock, Mod1, Mod2, Mod3, Mod4, Mod5, +and the abbreviated I, K, C, N, S, M, A, L, 1, +2, 3, 4, 5.

+
+
+

The NumLock, Meta and ISOLevel3 modifiers are usually aliased to +whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr +keys are being mapped. AppKeypad is a synthetic modifier mapped to the +current application keymap mode state.

+
+
+

The spellings of key can be obtained by using xev(1) command or +searching keysym macros from /usr/X11R6/include/X11/keysymdef.h and +omitting the prefix XK_. Alternatively you can specify key by its hex +keysym value (0x0000 - 0xFFFF). Note that the lookup of syms is not +performed in an exact manner; however, the closest match is assured.

+
+
+

string may contain escape values (\a: bell, \b: backspace, +\e, \E: escape, \n: newline, \r: carriage return, \t: tab, +\000: octal number) or verbatim control characters (^?: delete, +^@: null, ^A ...) and may be enclosed with double quotes so that it +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.

+
+
+

Its usage can be demonstrated by an example:

+
+
+
+  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:    \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 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: 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 can have some limited +font-switching at runtime:

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

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

@@ -1134,9 +1385,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.

@@ -1148,14 +1399,15 @@
Selection:
-Left click at the beginning of the region, drag to the end of the -region and release; Right click to extend the marked region; Left -double-click to select a word; Left triple-click to select the entire -line. +Left click at the beginning of the region, drag to the end of the region +and release; Right click to extend the marked region; Left double-click +to select a word; Left triple-click to select the entire logical line +(which can span multiple screen lines), unless modified by resource +tripleclickwords.

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

@@ -1187,8 +1439,8 @@ first part is available rxvt-unicode has been compiled with --enable-frills, the rest is available when rxvt-unicode was compiled with --enable-iso14755.

-
    -
  1. 1: Basic method
    +
+

With respect to conformance, rxvt-unicode is supposed to be compliant to both scenario A and B of ISO 14755, including part 5.2.


LOGIN STAMP

-

rxvt tries to write an entry into the utmp(5) file so -that it can be seen via the who(1) command, and can accept messages. -To allow this feature, rxvt must be installed setuid root on -some systems.

+

rxvt tries to write an entry into the utmp(5) file so that +it can be seen via the who(1) command, and can accept messages. To +allow this feature, rxvt may need to be installed setuid root +on some systems or setgid to root or to some other group on others.


@@ -1290,23 +1542,112 @@


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.

-

-

-
-

FILES

+

rxvt sets and/or uses the following environment variables:

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

+
COLORTERM
-System file for login records. +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. +
+

+

+

+
+

FILES

+
/usr/lib/X11/rgb.txt
@@ -1317,7 +1658,7 @@


SEE ALSO

-

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

+

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


@@ -1333,16 +1674,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

@@ -1390,7 +1725,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