--- rxvt-unicode/doc/rxvt.1.html 2005/12/17 20:55:45 1.26 +++ rxvt-unicode/doc/rxvt.1.html 2006/01/20 16:02:20 1.49 @@ -48,7 +48,7 @@


DESCRIPTION

-

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

rxvt-unicode, version 7.1, 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 -- @@ -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. @@ -268,22 +268,31 @@
-fb fontlist
-Compile font-styles: The bold font list to use when bold characters are to -be printed. See resource boldFont for details. +Compile font-styles: The bold font list to use when bold characters +are to be printed. See resource boldFont for details.

-fi fontlist
-Compile font-styles: The italic font list to use when bold characters are to -be printed. See resource italicFont for details. +Compile font-styles: The italic font list to use when italic +characters are to be printed. See resource italicFont for details.

-fbi fontlist
-Compile font-styles: The bold italic font list to use when bold characters are to -be printed. See resource boldItalicFont for details. +Compile font-styles: The bold italic font list to use when bold +italic > characters are to be printed. See resource boldItalicFont +for details. +
+

+
-is|+is
+
+
+Compile font-styles: Bold/Italic font styles imply high intensity +foreground/background (default). See resource intensityStyles for +details.

-name name
@@ -408,6 +417,22 @@ decorations; resource borderLess.

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

+
-sbg
+
+
+Compile frills: Disable the usage of the built-in block graphics/line +drawing characters and just rely on what the specified fonts provide. Use +this if you have a good font and want to use its block graphic glyphs; +resource skipBuiltinGlyphs. +
+

-lsp number
@@ -436,6 +461,14 @@ run the program specified by the SHELL environment variable or, 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"
+

-title text
@@ -526,6 +559,15 @@ secondaryScroll.

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

-keysym.sym string
@@ -567,7 +609,7 @@ });

-
-pty-fd fileno
+
-pty-fd file descriptor
Tells rxvt NOT to execute any commands or create a new pty/tty @@ -581,6 +623,10 @@ 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):

@@ -602,6 +648,13 @@ my $slave = $pty->slave; while (<$slave>) { print $slave "got <$_>\n" } +

+
-pe string
+
+
+Comma-separated list of perl extension scripts to use (or not to use) in +this terminal instance. See resource perl-ext for details. +

@@ -609,34 +662,26 @@

RESOURCES (available also as long-options)

Note: `rxvt --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. 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 -/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, rxvt recognizes two class +names: Rxvt 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, 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 rxvtperl(3) manpage for additional settings by perl +extensions not documented here):

geometry: geom
@@ -809,30 +854,20 @@ 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
-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 @@ -849,7 +884,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, \
@@ -903,6 +938,16 @@
 text font will being used for the given style.

+
intensityStyles: boolean
+
+
+When font styles are not enabled, or this option is enabled (True, +option -is, the default), bold and italic font styles imply high +intensity foreground/backround colours. Disabling this option (False, +option +is) disables this behaviour, the high intensity colours are not +reachable. +
+

selectstyle: mode
@@ -979,7 +1024,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 @@ -1067,6 +1112,15 @@ WM, the rxvt-unicode window will not have window decorations; option -bl.

+
skipBuiltinGlyphs: boolean
+
+
+Compile frills: Disable the usage of the built-in block graphics/line +drawing characters and just rely on what the specified fonts provide. Use +this if you have a good font and want to use its block graphic glyphs; +option -sbg. +
+

termName: termname
@@ -1181,7 +1235,7 @@ 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. +another locale; option -imlocale.

imFont: fontset
@@ -1200,7 +1254,7 @@
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. +the end of the logical line only; option -tcw.

insecure: boolean
@@ -1217,8 +1271,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
@@ -1237,13 +1290,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 @@ -1252,6 +1305,15 @@ instead scroll the screen up.

+
hold: boolean
+
+
+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. +
+

keysym.sym: string
@@ -1286,10 +1348,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 rxvt's own +processing).

You can define a range of keysyms in one shot by providing a string @@ -1323,6 +1385,16 @@ 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) +manpage. For example, the selection extension (activated via +rxvt -pe selection) listens for selection:rot13 events:

+
+
+
+  URxvt.keysym.M-C-c: perl:selection:rot13
+
+

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 @@ -1365,6 +1437,101 @@ URxvt.keysym.M-C-3: command:\033[8;25;80t URxvt.keysym.M-C-4: command:\033[8;48;110t

+

+
perl-ext-common: string
+
+
perl-ext: string
+
+
+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. 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 +will be ignored when running setuid/setgid. +
+
+

See the rxvtperl(3) manpage.

+
+

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

+
selection-autotransform.idx >: perl-transform
+
+
+Selection auto-transform patterns, see the rxvtperl(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
+
+
+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. +

@@ -1409,8 +1576,10 @@

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

+(Compile: frills) will create a rectangular selection instead of a +normal one. In this mode, every selected row becomes its own line in the +selection, and trailing whitespace is visually underlined and removed from +the selection.

Insertion:
@@ -1427,10 +1596,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.

@@ -1601,19 +1773,6 @@ 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
@@ -1716,20 +1875,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. +