--- rxvt-unicode/doc/rxvt.1.html 2006/01/13 12:40:46 1.45 +++ rxvt-unicode/doc/rxvt.1.html 2006/01/25 21:48:47 1.52 @@ -43,12 +43,12 @@


SYNOPSIS

-

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

+

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


DESCRIPTION

-

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

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


FREQUENTLY ASKED QUESTIONS

-

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

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.

@@ -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 urxvtd(1) (daemon) and -urxvtc(1) (client).

+drastically reduces memory usage. See rxvtd(1) (daemon) and +rxvtc(1) (client).

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


OPTIONS

-

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

The rxvt 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. `urxvt -h' gives a list of major compile-time options on +your system. `rxvt -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: `urxvt -help' gives a list of all +XIM on the Options line. Note: `rxvt -help' gives a list of all command-line options compiled into your version.

-

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

Note that rxvt 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: `urxvt --loginShell --color1 +far greater than those listed. For example: `rxvt --loginShell --color1 Orange'.

The following options are available:

@@ -133,6 +133,13 @@ DISPLAY environment variable is used.

+
-depth bitdepth
+
+
+Compile frills: Attempt to find a visual with the given bit depth; +resource depth. +
+

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

-sh
@@ -257,12 +264,12 @@
-   urxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
-   urxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
+ rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" + rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"

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

+section of rxvt(7).

-fb fontlist
@@ -417,6 +424,13 @@ decorations; resource borderLess.

+
-override-redirect
+
+
+Compile frills: Sets override-redirect on the window; resource +override-redirect. +
+

-sbg
@@ -446,7 +460,7 @@
-e command [arguments]
-Run the command with its command-line arguments in the urxvt +Run the command with its command-line arguments in the rxvt 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 +474,7 @@
-  urxvt -e sh -c "shell commands"
+ rxvt -e sh -c "shell commands"

-title text
@@ -555,7 +569,7 @@
-hold|+hold
-Turn on/off hold window after exit support. If enabled, urxvt +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. @@ -570,20 +584,20 @@
-embed windowid
-Tells urxvt to embed it's windows into an already-existing window, +Tells rxvt to embed it's windows into an already-existing window, which enables applications to easily embed a terminal.
-

Right now, urxvt will first unmap/map the specified window, so it -shouldn't be a top-level window. urxvt will also reconfigure it +

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 urxvt and leave it alone.

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

-

The window will not be destroyed when urxvt exits.

+

The window will not be destroyed when rxvt exits.

-

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

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 @@ -598,20 +612,20 @@ my $rxvt = new Gtk2::Socket; $rxvt->signal_connect_after (realize => sub { my $xid = $_[0]->window->get_xid; - system "urxvt -embed $xid &"; + system "rxvt -embed $xid &"; });

-pty-fd file descriptor
-Tells urxvt NOT to execute any commands or create a new pty/tty +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 urxvt as a generic terminal emulator +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, urxvt will not create any utmp/wtmp +

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.

@@ -632,7 +646,7 @@
    my $pty = new IO::Pty;
    fcntl $pty, F_SETFD, 0; # clear close-on-exec
-   system "urxvt -pty-fd " . (fileno $pty) . "&";
+   system "rxvt -pty-fd " . (fileno $pty) . "&";
    close $pty;
@@ -653,11 +667,11 @@


RESOURCES (available also as long-options)

-

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

Note: `rxvt --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. urxvt will consult the following files/resources in order, +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
@@ -665,17 +679,24 @@
   3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
   4. SCREEN_RESOURCES for the current screen
   5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
-

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

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

+
depth: bitdepth
+
+
+Compile frills: Attempt to find a visual with the given bit depth; +option -depth. +
+

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

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

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

Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with @@ -847,20 +868,10 @@ scale is 1000. [default 0x0+50+50]

-
menu: file[;tag]
-
-
-Read in the specified menu file (note the `.menu' extension is -optional) and also optionally specify a starting tag to find. See the -reference documentation for details on the syntax for the menuBar. -
-

path: path
-Specify the colon-delimited search path for finding files (XPM and -menus), in addition to the paths specified by the RXVTPATH and -PATH environment variables. +Specify the colon-delimited search path for finding XPM files.

font: fontlist
@@ -887,7 +898,7 @@
-   URxvt*font: 9x15bold,\
+   URxvt.font: 9x15bold,\
                -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
                -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
                [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
@@ -1027,7 +1038,7 @@
 
-   URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
+ URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)

This creates a new file in your home directory with the screen contents @@ -1213,8 +1224,18 @@

cutchars: string
-The characters used as delimiters for double-click word selection. The -built-in default: +The characters used as delimiters for double-click word selection +(whitespace delimiting is added automatically if resource is given). +
+
+

When the selection extension is in use (the default if compiled in, see +the rxvtperl(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 +be used. If not specified, the built-in default is used:

BACKSLASH ```'&()*,;<=?@[]{|} >>

@@ -1247,7 +1268,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 urxvt. The default will be set-up to chose *any* suitable found +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.
@@ -1274,8 +1295,7 @@

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.

+locale, findfont, icon label and window title requests.

modifier: modifier
@@ -1294,13 +1314,13 @@ in the entry on keysym following.

-
secondaryScreen: bool
+
secondaryScreen: boolean
Turn on/off secondary screen (default enabled).

-
secondaryScroll: bool
+
secondaryScroll: boolean
Turn on/off secondary screen scroll (default enabled). If the this @@ -1309,10 +1329,10 @@ instead scroll the screen up.

-
hold: bool
+
hold: boolean
-Turn on/off hold window after exit support. If enabled, urxvt +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. @@ -1354,7 +1374,7 @@

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 +\e (and so on), which will work with both Xt and rxvt's own processing).

@@ -1380,7 +1400,7 @@

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

@@ -1390,9 +1410,9 @@

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

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

@@ -1408,7 +1428,7 @@
 

Unfortunately, this will override built-in key mappings. For example -if you overwrite the Insert key you will disable urxvt's +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:

@@ -1433,7 +1453,7 @@ URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
-

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

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

@@ -1479,7 +1499,7 @@
Perl code to be evaluated when all extensions have been registered. See -the urxvtperl(3) manpage. Due to security reasons, this resource +the rxvtperl(3) manpage. Due to security reasons, this resource will be ignored when running setuid/setgid.

@@ -1488,25 +1508,25 @@
Colon-separated list of additional directories that hold extension scripts. When looking for extensions specified by the perl resource, -urxvt will first look in these directories and then in -/usr/local/lib/urxvt/perl/. Due to security reasons, this 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 urxvtperl(3) manpage.

+

See the rxvtperl(3) manpage.

selection.pattern-idx >: perl-regex
-Additional selection patterns, see the urxvtperl(3) manpage for +Additional selection patterns, see the rxvtperl(3) manpage for details.

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

@@ -1527,16 +1547,23 @@
transient-for: windowid
-Sets the WM_TRANSIENT_FOR property to the given window iw. +Compile frills: Sets the WM_TRANSIENT_FOR property to the given window id. +
+

+
override-redirect: boolean
+
+
+Compile frills: Sets override-redirect for the terminal window, making +it almost invisible to window managers; option -override-redirect.


THE SCROLLBAR

-

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

Lines of text that scroll off the top of the rxvt window (resource: saveLines) and can be scrolled back using the scrollbar -or by keystrokes. The normal urxvt scrollbar has arrows and +or by keystrokes. The normal rxvt 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. @@ -1582,9 +1609,13 @@

Insertion:
-Pressing and releasing the Middle mouse button (or Shift-Insert) in -an urxvt window causes the current text selection to be -inserted as if it had been typed on the keyboard. +Pressing and releasing the Middle mouse button in an rxvt +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 +inserted too.

@@ -1593,10 +1624,13 @@

CHANGING FONTS

Changing fonts (or font sizes, respectively) via the keypad is not yet supported in rxvt-unicode. Bug me if you need this.

-

You can, however, switch fonts at runtime using escape sequences (and -therefore using the menubar), e.g.:

+

You can, however, switch fonts at runtime using escape sequences, e.g.:

    printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
+

You can use keyboard shortcuts, too:

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

rxvt-unicode will automatically re-apply these fonts to the output so far.

@@ -1659,16 +1693,16 @@


LOGIN STAMP

-

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

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, urxvt may need to be installed setuid root +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.


COLORS AND GRAPHICS

In addition to the default foreground and background colours, -urxvt can display up to 16 colours (8 ANSI colours plus +rxvt 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.

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

-
urxvt -fg Black -bg White -rv
+
rxvt -fg Black -bg White -rv
would yield White on Black, while on xterm(1) it would yield Black @@ -1710,7 +1744,7 @@


ENVIRONMENT

-

urxvt sets and/or uses the following environment variables:

+

rxvt sets and/or uses the following environment variables:

TERM
@@ -1722,7 +1756,7 @@
COLORTERM
-Either rxvt, rxvt-xpm, depending on wether urxvt was +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.
@@ -1734,7 +1768,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 urxvt +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.
@@ -1742,7 +1776,7 @@
WINDOWID
-Set to the (decimal) X Window ID of the urxvt window (the toplevel +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).
@@ -1750,14 +1784,14 @@
TERMINFO
-Set to the terminfo directory iff urxvt was configured with +Set to the terminfo directory iff rxvt was configured with --with-terminfo=PATH.

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

@@ -1767,24 +1801,11 @@ The shell to be used for command execution, defaults to /bin/sh.

-
RXVTPATH
-
-
-The path where urxvt 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 urxvtc(1) and -urxvtd(1). +The unix domain socket path used by rxvtc(1) and +rxvtd(1).

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

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

@@ -1826,7 +1847,7 @@


SEE ALSO

-

urxvt(7), urxvtc(1), urxvtd(1), 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)


@@ -1882,20 +1903,30 @@
Geoff Wing >
-Rewrote screen display and text selection routines. Project Coordinator -(changes.txt 2.4.6 - rxvt-unicode) +Rewrote screen display and text selection routines. + +
+
+
+
+Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)

Marc Alexander Lehmann >
-Forked rxvt-unicode, rewrote most of the display code and internal -character handling to store text in unicode, improve xterm -compatibility and apply numerous other bugfixes and extensions. +Forked rxvt-unicode, unicode support, rewrote almost all the code, perl +extension, random hacks, numerous bugfixes and extensions.

Project Coordinator (Changes 1.0 -)

+

+
Emanuele Giaquinta >
+
+
+Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. +