--- rxvt-unicode/doc/rxvt.1.html 2007/06/24 22:12:18 1.67 +++ rxvt-unicode/doc/rxvt.1.html 2007/10/27 12:09:02 1.70 @@ -6,7 +6,7 @@ - + @@ -47,12 +47,12 @@

SYNOPSIS

Top

-

rxvt [options] [-e command [ args ]]

+

urxvt [options] [-e command [ args ]]

DESCRIPTION

Top

-

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

rxvt-unicode, version 8.4, 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 -- @@ -61,7 +61,7 @@

FREQUENTLY ASKED QUESTIONS

Top

-

See rxvt(7) (try man 7 rxvt) for a list of +

See urxvt(7) (try man 7 urxvt) 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/rxvt-unicode/doc/rxvt.7.html.

@@ -74,7 +74,7 @@ world. Being a terminal emulator, however, some things are very difficult, especially cursive scripts such as arabic, vertically written scripts like mongolian or scripts requiring extremely complex combining rules, -like tibetan or devenagari. Don't expect pretty output when using these +like tibetan or devanagari. Don't expect pretty output when using these scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work fine, though. A somewhat difficult case are right-to-left scripts, such as hebrew: rxvt-unicode adopts the view that bidirectional algorithms @@ -99,27 +99,27 @@ without most of its features to get a lean binary. It also comes with a client/daemon pair that lets you open any number of terminal windows from within a single process, which makes startup time very fast and -drastically reduces memory usage. See rxvtd(1) (daemon) and -rxvtc(1) (client).

+drastically reduces memory usage. See urxvtd(1) (daemon) and +urxvtc(1) (client).

It also makes technical information about escape sequences (which have -been extended) more accessible: see rxvt(7) for technical +been extended) more accessible: see urxvt(7) for technical reference documentation (escape sequences etc.).

OPTIONS

Top

-

The rxvt options (mostly a subset of xterm's) are listed +

The urxvt options (mostly a subset of xterm's) are listed below. In keeping with the smaller-is-better philosophy, options may be eliminated or default values chosen at compile-time, so options and defaults listed may not accurately reflect the version installed on -your system. `rxvt -h' gives a list of major compile-time options on +your system. `urxvt -h' gives a list of major compile-time options on the Options line. Option descriptions may be prefixed with which compile option each is dependent upon. e.g. `Compile XIM:' requires -XIM on the Options line. Note: `rxvt -help' gives a list of all +XIM on the Options line. Note: `urxvt -help' gives a list of all command-line options compiled into your version.

-

Note that rxvt permits the resource name to be used as a +

Note that urxvt permits the resource name to be used as a long-option (--/++ option) so the potential command-line options are -far greater than those listed. For example: `rxvt --loginShell --color1 +far greater than those listed. For example: `urxvt --loginShell --color1 Orange'.

The following options are available:

@@ -154,13 +154,15 @@

Turn on/off skip scrolling (allow multiple screens per refresh); resource skipScroll.

-
-ip|+ip | -tr|+tr
+
-tr|+tr
-

Turn on/off inheriting parent window's pixmap. Alternative form is --tr; resource inheritPixmap.

-

Please note that transparency of any kind if completely unsupported by -the author. Don't bug him with installation questions! Read the FAQ (man 7 -rxvt)!

+

Turn on/off illusion of a transparent window background. Obsolete form of it is +-ip and it should not be used anymore; resource transparent.

+

Please note that old resource name of inheritPixmap is obsolete and should be +changed to transparent. Backwards compatibility support for inheritPixmap will +be phased out in future versions of rxvt!

+

Please address all transparency related issues to Sasha Vasko at +sasha@aftercode.net. Read the FAQ (man 7 urxvt)!

-fade number
@@ -176,34 +178,41 @@
-tint colour

Tint the transparent background pixmap with the given colour when -transparency is enabled with -tr or -ip. This only works for +transparency is enabled with -tr. 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 +used to brighten or darken the image in addition to tinting it. +Please note that certain tint colours can be applied on the server-side, +thus yielding performance gain of two orders of magnitude. These colours are: +blue, red, green, cyan, magenta, yellow, and those close to them; resource tintColor. Example:

-
   rxvt -tr -tint blue -sh 40
+
   urxvt -tr -tint blue -sh 40
 
 
-
-sh number
+
-sh number

Darken (0 .. 100) or lighten (-1 .. -100) the transparent -background image in addition to (or instead of) tinting it; +background image in addition to (or instead of) tinting it; resource shading.

-blt string
-

Specify background blending type. If background pixmap is specified -at the same time as transparency - such pixmap will be blended over +

Specify background blending type. If background pixmap is specified +at the same time as transparency - such pixmap will be blended over transparency image, using method specified. Supported values are : -add, alphablend, allanon - color values averaging, colorize, -darken, diff, dissipate, hue, lighten, overlay, -saturate, screen, sub, tint, value. The default is -alpha-blending; resource blendType.

-
-
-blr number
-
-

Apply Gaussian Blur with the specified radius to the transparent -background image; resource blurRadius.

+add, alphablend, allanon - color values averaging, colorize, +darken, diff, dissipate, hue, lighten, overlay, +saturate, screen, sub, tint, value. The default is +alpha-blending. Compile afterimage; resource blendType.

+
+
-blr HxV
+
+

Apply Gaussian Blur with the specified radii to the transparent +background image. If single number is specified - both vertical and +horizontal radii are considered to be the same. Setting one of the +radii to 1 and another to a large number creates interesting effects +on some backgrounds. Maximum radius value is 128. Compile afterimage; +resource blurRadius.

-bg colour
@@ -247,12 +256,12 @@

In short, to specify an X11 core font, just specify its name or prefix it with x:. To specify an XFT-font, you need to prefix it with xft:, e.g.:

-
   rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
-   rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
+
   urxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
+   urxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
 
 

See also the question "How does rxvt-unicode choose fonts?" in the FAQ -section of rxvt(7).

+section of urxvt(7).

-fb fontlist
@@ -380,7 +389,7 @@

Compile frills: Lines (pixel height) to insert between each row of the display. Useful to work around font rendering problems; resource -linespace.

+lineSpace.

-tn termname
@@ -391,7 +400,7 @@
-e command [arguments]
-

Run the command with its command-line arguments in the rxvt +

Run the command with its command-line arguments in the urxvt window; also sets the window title and icon name to be the basename of the program being executed if neither -title (-T) nor -n are given on the command line. If this option is used, it must be the last @@ -400,7 +409,7 @@ 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"
+
  urxvt -e sh -c "shell commands"
 
 
@@ -472,7 +481,7 @@
-hold|+hold
-

Turn on/off hold window after exit support. If enabled, rxvt +

Turn on/off hold window after exit support. If enabled, urxvt 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.

@@ -483,14 +492,14 @@
-embed windowid
-

Tells rxvt to embed its windows into an already-existing window, +

Tells urxvt to embed its 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 +

Right now, urxvt will first unmap/map the specified window, so it +shouldn't be a top-level window. urxvt 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 +create an extra subwindow for urxvt and leave it alone.

+

The window will not be destroyed when urxvt exits.

+

It might be useful to know that urxvt 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 whether the -embed option was used or @@ -500,18 +509,18 @@

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

Tells rxvt NOT to execute any commands or create a new pty/tty +

Tells urxvt NOT to execute any commands or create a new pty/tty pair but instead use the given file descriptor as the tty master. This is -useful if you want to drive rxvt as a generic terminal emulator +useful if you want to drive urxvt 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 +

If this switch is given, urxvt 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.

As an extremely special case, specifying -1 will completely suppress @@ -523,7 +532,7 @@ my $pty = new IO::Pty; fcntl $pty, F_SETFD, 0; # clear close-on-exec - system "rxvt -pty-fd " . (fileno $pty) . "&"; + system "urxvt -pty-fd " . (fileno $pty) . "&"; close $pty; # now communicate with rxvt @@ -542,11 +551,11 @@

RESOURCES (available also as long-options)

Top

-

Note: `rxvt --help' gives a list of all resources (long +

Note: `urxvt --help' gives a list of all resources (long options) compiled into your version.

You can set and change the 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, +starts. urxvt 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
@@ -555,15 +564,15 @@
   5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
 
 
-

Note that when reading X resources, rxvt recognizes two class +

Note that when reading X resources, urxvt recognizes two class names: Rxvt and URxvt. The class name Rxvt allows resources -common to both rxvt and the original rxvt to be easily +common to both urxvt and the original rxvt to be easily configured, while the class name URxvt allows resources unique to -rxvt, to be shared between different rxvt +urxvt, to be shared between different urxvt configurations. If no resources are specified, suitable defaults will be used. Command-line arguments can be used to override resource settings. The following resources are supported (you might want to -check the rxvtperl(3) manpage for additional settings by perl +check the urxvtperl(3) manpage for additional settings by perl extensions not documented here):

depth: bitdepth
@@ -595,7 +604,7 @@ 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour names used are listed in the COLORS AND GRAPHICS section.

Colours higher than 15 cannot be set using resources (yet), but can be -changed using an escape command (see rxvt(7)).

+changed using an escape command (see urxvt(7)).

Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 88 colour support). Colours 80-87 are evenly spaces grey steps.

@@ -641,18 +650,18 @@
jumpScroll: boolean

True: specify that jump scrolling should be used. When receiving lots -of lines, rxvt will only scroll once a whole screen height of lines +of lines, urxvt will only scroll once a whole screen height of lines has been read, resulting in fewer updates while still displaying every received line; option -j.

-

False: specify that smooth scrolling should be used. rxvt will +

False: specify that smooth scrolling should be used. urxvt will force a screen refresh on each new line it received; option +j.

skipScroll: boolean

True: (the default) specify that skip scrolling should be used. When -receiving lots of lines, rxvt will only scroll once in a while +receiving lots of lines, urxvt will only scroll once in a while (around 60 times per second), resulting in far fewer updates. This can -result in rxvt not ever displaying some of the lines it receives; +result in urxvt not ever displaying some of the lines it receives; option -ss.

False: specify that everything is to be displayed, even if the refresh is too fast for the human eye to read anything (or the @@ -727,7 +736,7 @@

path: path
-

Specify the colon-delimited search path for finding XPM files.

+

Specify the colon-delimited search path for finding background image files.

font: fontlist
@@ -923,7 +932,7 @@

Specifies the terminal type name to be set in the TERM environment variable; option -tn.

-
linespace: number
+
lineSpace: number

Specifies number of lines (pixel height) to insert between each row of the display [default 0]; option -lsp.

@@ -985,7 +994,7 @@

The characters used as delimiters for double-click word selection (whitespace delimiting is added automatically if resource is given).

When the perl selection extension is in use (the default if compiled -in, see the rxvtperl(3) manpage), a suitable regex using these +in, see the urxvtperl(3) manpage), a suitable regex using these characters will be created (if the resource exists, otherwise, no regex will be created). In this mode, characters outside ISO-8859-1 can be used.

When the selection extension is not used, only ISO-8859-1 characters can @@ -1012,7 +1021,7 @@

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

@@ -1060,7 +1069,7 @@
hold: boolean
-

Turn on/off hold window after exit support. If enabled, rxvt +

Turn on/off hold window after exit support. If enabled, urxvt 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.

@@ -1083,16 +1092,8 @@ 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. This feature is deprecated and will -be removed.

-

Please note that you need to double the \ in resource files, as -Xlib itself does its own de-escaping (you can use \033 instead of -\e (and so on), which will work with both Xt and rxvt's own -processing).

+

string may contain escape values (\n: newline, \000: octal +number), see RESOURCES in man 7 X for futher details.

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

@@ -1107,16 +1108,16 @@

If string takes the form of command:STRING, the specified STRING -is interpreted and executed as rxvt's control sequence. For +is interpreted and executed as urxvt'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
 
 

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

+urxvt -pe selection) listens for selection:rot13 events:

  URxvt.keysym.M-C-c: perl:selection:rot13
 
 
@@ -1127,7 +1128,7 @@ 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 +if you overwrite the Insert key you will disable urxvt'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>
@@ -1144,7 +1145,7 @@
   URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
 
 
-

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

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

  URxvt.keysym.M-C-3: command:\033[8;25;80t
   URxvt.keysym.M-C-4: command:\033[8;48;110t
@@ -1176,26 +1177,26 @@
 	
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 +the urxvtperl(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 +urxvt will first look in these directories and then in +/usr/local/lib/urxvt/perl/. Due to security reasons, this resource will be ignored when running setuid/setgid.

-

See the rxvtperl(3) manpage.

+

See the urxvtperl(3) manpage.

selection.pattern-idx: perl-regex
-

Additional selection patterns, see the rxvtperl(3) manpage for +

Additional selection patterns, see the urxvtperl(3) manpage for details.

selection-autotransform.idx: perl-transform
-

Selection auto-transform patterns, see the rxvtperl(3) manpage +

Selection auto-transform patterns, see the urxvtperl(3) manpage for details.

searchable-scrollback: keysym
@@ -1226,9 +1227,9 @@

THE SCROLLBAR

Top

-

Lines of text that scroll off the top of the rxvt window +

Lines of text that scroll off the top of the urxvt window (resource: saveLines) and can be scrolled back using the scrollbar -or by keystrokes. The normal rxvt scrollbar has arrows and +or by keystrokes. The normal urxvt scrollbar has arrows and its behaviour is fairly intuitive. The xterm-scrollbar is without arrows and its behaviour mimics that of xterm

Scroll down with Button1 (xterm-scrollbar) or Shift-Next. @@ -1269,7 +1270,7 @@

Pasting:
-

Pressing and releasing the Middle mouse button in an rxvt +

Pressing and releasing the Middle mouse button in an urxvt window causes the value of the PRIMARY selection (or CLIPBOARD with the Meta modifier) to be inserted as if it had been typed on the keyboard.

Pressing Shift-Insert causes the value of the PRIMARY selection to be @@ -1298,7 +1299,7 @@

ISO 14755 is a standard for entering and viewing unicode characters and character codes using the keyboard. It consists of 4 parts. The -first part is available rxvt-unicode has been compiled with +first part is available if rxvt-unicode has been compiled with --enable-frills, the rest is available when rxvt-unicode was compiled with --enable-iso14755.

@@ -1354,23 +1355,23 @@

LOGIN STAMP

Top

-

rxvt tries to write an entry into the utmp(5) file so that +

urxvt 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 +allow this feature, urxvt may need to be installed setuid root on some systems or setgid to root or to some other group on others.

COLORS AND GRAPHICS

Top

In addition to the default foreground and background colours, -rxvt can display up to 16 colours (8 ANSI colours plus +urxvt can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink versions of the same). Here is a list of the colours with their names.

-

It is also possible to specify the colour values of foreground, +
color0(black)= Black
color1(red)= Red3
color2(green)= Green3
color3(yellow)= Yellow3
color4(blue)= Blue3
color5(magenta)= Magenta3
color6(cyan)= Cyan3
color7(white)= AntiqueWhite
color8(bright black)= Grey25
color9(bright red)= Red
color10(bright green)= Green
color11(bright yellow)= Yellow
color12(bright blue)= Blue
color13(bright magenta)= Magenta
color14(bright cyan)= Cyan
color15(bright white)= White
foreground= Black
background= White

It is also possible to specify the colour values of foreground, background, cursorColor, cursorColor2, colorBD, colorUL as a number 0-15, as a convenient shorthand to reference the colour name of color0-color15.

-

In addition to the colours defined above, rxvt offers an +

In addition to the colours defined above, urxvt offers an additional 72 colours. The first 64 of those (with indices 16 to 79) consist of a 4*4*4 RGB colour cube (i.e. index = r * 16 + g * 4 + b + 16), followed by 8 additional shades of gray (with indices 80 to 87).

@@ -1382,7 +1383,7 @@ xterm(1) where the colours are only swapped if they have not otherwise been specified. For example,

-
rxvt -fg Black -bg White -rv
+
urxvt -fg Black -bg White -rv

would yield White on Black, while on xterm(1) it would yield Black on White.

@@ -1406,7 +1407,7 @@ ARGB visuals out of the box, and rxvt-unicode just fudges around.

For example, the following selects an almost completely transparent red background, and an almost opaque pink foreground:

-
   rxvt -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
+
   urxvt -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
 
 

Please note that transparency of any kind if completely unsupported by @@ -1415,7 +1416,7 @@

ENVIRONMENT

Top

-

rxvt sets and/or uses the following environment variables:

+

urxvt sets and/or uses the following environment variables:

TERM
@@ -1424,9 +1425,10 @@
COLORTERM
-

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

+

Either rxvt, rxvt-xpm, depending on whether urxvt was +compiled with background image support, and optionally with the added +extension -mono to indicate that rxvt-unicode runs on a monochrome +screen.

COLORFGBG
@@ -1434,24 +1436,24 @@ 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.

+string default), and xpm is the string default if urxvt +was compiled with background image 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 +

Set to the (decimal) X Window ID of the urxvt 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 +

Set to the terminfo directory iff urxvt was configured with --with-terminfo=PATH.

DISPLAY
-

Used by rxvt to connect to the display and set to the correct +

Used by urxvt to connect to the display and set to the correct display in its child processes.

SHELL
@@ -1460,8 +1462,8 @@
RXVT_SOCKET
-

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

+

The unix domain socket path used by urxvtc(1) and +urxvtd(1).

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

HOME
@@ -1477,7 +1479,7 @@
XENVIRONMENT

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

+urxvt.

@@ -1494,7 +1496,7 @@

SEE ALSO

Top

-

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

+

urxvt(7), urxvtc(1), urxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)

CURRENT PROJECT COORDINATOR

Top