--- rxvt-unicode/doc/rxvt.1.txt 2005/10/25 20:22:39 1.25 +++ rxvt-unicode/doc/rxvt.1.txt 2006/01/03 21:15:22 1.33 @@ -6,7 +6,7 @@ rxvt [options] [-e command [ args ]] DESCRIPTION - rxvt-unicode, version 5.8, is a colour vt102 terminal emulator intended + rxvt-unicode, version 6.2, 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 -- a significant @@ -177,6 +177,11 @@ 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* Specify the application name under which resources are to be obtained, rather than the default executable file name. Name should @@ -269,6 +274,12 @@ 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* Window title (-T still respected); the default title is the basename of the program specified after the -e option, if any, otherwise the @@ -321,6 +332,12 @@ Turn on/off secondary screen scroll (default enabled); resource 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* Remap a key symbol. See resource keysym. @@ -375,6 +392,10 @@ my $slave = $pty->slave; while (<$slave>) { print $slave "got <$_>\n" } + -pe *string* + Colon-separated list of perl extension scripts to use in this + terminal instance. See resource perl-ext. + RESOURCES (available also as long-options) Note: `rxvt --help' gives a list of all resources (long options) compiled into your version. @@ -530,7 +551,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. + font list is always appended to it; option -fn. Each font can either be a standard X11 core font (XLFD) name, with optional prefix "x:" or a Xft font (Compile *xft*), prefixed with @@ -586,6 +607,13 @@ If set, but empty, then this specific style is disabled and the normal 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* Set mouse selection style to old which is 2.20, oldword which is xterm style with 2.20 old word selection, or anything else which @@ -752,7 +780,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. + staying in another locale; option -imlocale. imFont: *fontset* Specify the font-set used for XIM styles "OverTheSpot" or @@ -765,19 +793,22 @@ tripleclickwords: *boolean* 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. + selection to the end of the logical line only; option -tcw. insecure: *boolean* 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. + whether 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* Set the key to be interpreted as the Meta key to: alt, meta, hyper, @@ -797,6 +828,12 @@ scrollback buffer and switching to/from the secondary screen will 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* Compile *frills*: Associate *string* with keysym *sym*. The intervening resource name keysym. cannot be omitted. @@ -850,6 +887,13 @@ 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 @@ -882,6 +926,25 @@ URxvt.keysym.M-C-3: command:\033[8;25;80t URxvt.keysym.M-C-4: command:\033[8;48;110t + perl-ext: *string* + Colon-separated list 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; option -pe. + + perl-eval: *string* + Perl code to be evaluated when all extensions have been registered. + See the rxvtperl(3) manpage. + + 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/. + + See the rxvtperl(3) manpage. + THE SCROLLBAR Lines of text that scroll off the top of the rxvt window (resource: saveLines) and can be scrolled back using the scrollbar or by @@ -917,7 +980,9 @@ Starting a selection while pressing the Meta key (or Meta+Ctrl keys) (Compile: *frills*) will create a rectangular selection instead of a - normal one. + 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: Pressing and releasing the Middle mouse button (or Shift-Insert) in @@ -931,7 +996,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.