--- rxvt-unicode/doc/rxvt.1.html 2005/10/25 20:22:39 1.25 +++ rxvt-unicode/doc/rxvt.1.html 2006/01/11 02:13:55 1.41 @@ -48,7 +48,7 @@


DESCRIPTION

-

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

rxvt-unicode, version 6.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 -- @@ -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,15 @@ decorations; resource borderLess.

+
-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 +454,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 +552,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 +602,7 @@ });

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

@@ -832,7 +878,7 @@ 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. +appended to it; option -fn.

Each font can either be a standard X11 core font (XLFD) name, with @@ -903,6 +949,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
@@ -1067,6 +1123,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 +1246,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 +1265,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
@@ -1209,13 +1274,16 @@ Enables ``insecure'' mode. Rxvt-unicode offers some escape sequences that echo arbitrary strings like the icon name or the locale. This could be abused if somebody gets 8-bit-clean access to your display, whether -throuh a mail client displaying mail bodies unfiltered or though -write(1). Therefore, these sequences are disabled by default. (Note -that other terminals, including xterm, have these sequences -enabled by default). You can enable them by setting this boolean -resource or specifying -insecure as an option. At the moment, this -enabled display-answer, locale, findfont, icon label and window title -requests as well as dynamic menubar dispatch. +through a mail client displaying mail bodies unfiltered or through +write(1) or any other means. Therefore, these sequences are disabled by +default. (Note that many other terminals, including xterm, have these +sequences enabled by default, which doesn't make it safer, though). + +
+

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.

modifier: modifier
@@ -1249,6 +1317,15 @@ instead scroll the screen up.

+
hold: bool
+
+
+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
@@ -1320,6 +1397,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 @@ -1362,6 +1449,73 @@ 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.

+
+

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

@@ -1406,8 +1560,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,7 +1583,7 @@

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

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

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