--- rxvt-unicode/doc/rxvt.1.html 2006/01/04 21:37:55 1.36 +++ rxvt-unicode/doc/rxvt.1.html 2006/01/13 12:40:46 1.45 @@ -43,12 +43,12 @@


SYNOPSIS

-

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

+

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


DESCRIPTION

-

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

rxvt-unicode, version 7.0, 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 -- @@ -57,7 +57,7 @@


FREQUENTLY ASKED QUESTIONS

-

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/*checkout*/rxvt-unicode/doc/rxvt.7.html.

@@ -95,27 +95,27 @@ without most of it's 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) easier accessible: see rxvt(7) for technical +been extended) easier accessible: see urxvt(7) for technical reference documentation (escape sequences etc.).


OPTIONS

-

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:

@@ -184,7 +184,7 @@
-   rxvt -tr -tint blue -sh 40
+ urxvt -tr -tint blue -sh 40

-sh
@@ -245,7 +245,7 @@
Select the fonts to be used. This is a comma separated list of font names -that are used in turn when trying to display Unicode characters. The +that are checked in order when trying to find glyphs for characters. The first font defines the cell size for characters; other fonts might be smaller, but not (in general) larger. A (hopefully) reasonable default font list is always appended to it. See resource font for more details. @@ -257,12 +257,12 @@
-   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
@@ -446,7 +446,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 @@ -460,7 +460,7 @@
-  rxvt -e sh -c "shell commands"
+ urxvt -e sh -c "shell commands"

-title text
@@ -555,7 +555,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. @@ -570,20 +570,20 @@
-embed windowid
-Tells rxvt to embed it's windows into an already-existing window, +Tells urxvt 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 +

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.

+create an extra subwindow for urxvt and leave it alone.

-

The window will not be destroyed when rxvt exits.

+

The window will not be destroyed when urxvt exits.

-

It might be useful to know that rxvt will not close file +

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 wether the -embed option was used or @@ -598,24 +598,28 @@ 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 fileno
+
-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 filehandle 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 +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):

@@ -628,7 +632,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;
@@ -641,44 +645,36 @@
-pe string
-Colon-separated list of perl extension scripts to use in this terminal -instance. See resource perl-ext. +Comma-separated list of perl extension scripts to use (or not to use) in +this terminal instance. See resource perl-ext for details.


RESOURCES (available also as long-options)

-

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.

-

There are two different methods that rxvt can use to get the -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 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:

+

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. 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
   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 -/usr/lib/X11/app-defaults/URxvt) and resources set in -~/.Xdefaults, or ~/.Xresources if ~/.Xdefaults does not exist. -Note that when reading X resources, rxvt recognizes two -class names: XTerm and URxvt. The class name Rxvt allows -resources common to both rxvt and the original rxvt to be -easily configured, while the class name URxvt allows resources -unique to rxvt, notably colours and key-handling, to be -shared between different rxvt 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 allowed:

+

Note that when reading X resources, urxvt recognizes two class +names: Rxvt and URxvt. The class name Rxvt allows resources +common to both urxvt and the original rxvt to be easily +configured, while the class name URxvt allows resources unique to +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 urxvtperl(3) manpage for additional settings by perl +extensions not documented here):

geometry: geom
@@ -713,7 +709,7 @@

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 @@ -870,11 +866,11 @@

font: fontlist
-Select the fonts to be used. This is a comma separated list of font -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. +Select the fonts to be used. This is a comma separated list of font names +that are checked in order when trying to find glyphs for characters. The +first font defines the cell size for characters; other fonts might be +smaller, but not (in general) larger. A (hopefully) reasonable default +font list is always appended to it; option -fn.

Each font can either be a standard X11 core font (XLFD) name, with @@ -1251,7 +1247,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.

@@ -1316,7 +1312,7 @@
hold: bool
-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. @@ -1356,10 +1352,10 @@ 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).

+

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

You can define a range of keysyms in one shot by providing a string @@ -1384,7 +1380,7 @@

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'':

@@ -1394,9 +1390,9 @@

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:

@@ -1412,7 +1408,7 @@
 

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:

@@ -1437,7 +1433,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):

@@ -1451,20 +1447,40 @@
perl-ext: string
-Colon-separated list(s) of perl extension scripts to use in this terminal -instance. Each extension is looked up in the library directories, loaded -if necessary, and bound to the current terminal instance. If this -resource is empty or missing, 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; option -pe. +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. +Perl code to be evaluated when all extensions have been registered. See +the urxvtperl(3) manpage. Due to security reasons, this resource +will be ignored when running setuid/setgid.

perl-lib: path
@@ -1472,20 +1488,55 @@
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/. +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 urxvtperl(3) manpage for +details. +
+

+
selection-autotransform.idx >: perl-transform
+
+
+Selection auto-transform patterns, see the urxvtperl(3) manpage +for details. +
+

+
searchable-scrollback: keysym
+
+
+Sets the hotkey that starts the incremental scrollback buffer search +(default: M-s). +
+

+
urlLauncher: string
+
+
+Specifies the program to be started with a URL argument. Used by the +selection-popup and mark-urls perl extensions. +
+

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


THE SCROLLBAR

-

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. @@ -1532,7 +1583,7 @@

Pressing and releasing the Middle mouse button (or Shift-Insert) in -an rxvt window causes the current text selection to be +an urxvt window causes the current text selection to be inserted as if it had been typed on the keyboard.

@@ -1608,16 +1659,16 @@


LOGIN STAMP

-

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

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 rgb.txt names.

@@ -1648,7 +1699,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 @@ -1659,7 +1710,7 @@


ENVIRONMENT

-

rxvt sets and/or uses the following environment variables:

+

urxvt sets and/or uses the following environment variables:

TERM
@@ -1671,7 +1722,7 @@
COLORTERM
-Either rxvt, rxvt-xpm, depending on wether rxvt was +Either rxvt, rxvt-xpm, depending on wether urxvt was compiled with XPM support, and optionally with the added extension -mono to indicate that rxvt-unicode runs on a monochrome screen.
@@ -1683,7 +1734,7 @@ 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 +string default), and xpm is the string default if urxvt was compiled with XPM support. Libraries like ncurses and slang can (and do) use this information to optimize screen output.
@@ -1691,7 +1742,7 @@
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).
@@ -1699,14 +1750,14 @@
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 it's child processes.

@@ -1719,7 +1770,7 @@
RXVTPATH
-The path where rxvt looks for support files such as menu and xpm +The path where urxvt looks for support files such as menu and xpm files.

@@ -1732,8 +1783,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 >>>.

@@ -1757,7 +1808,7 @@
If set and accessible, gives the name of a X resource file to be loaded by -rxvt. +urxvt.

@@ -1775,7 +1826,7 @@


SEE ALSO

-

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)