--- rxvt-unicode/doc/rxvt.1.txt 2006/01/04 21:37:55 1.36 +++ rxvt-unicode/doc/rxvt.1.txt 2006/01/16 15:07:27 1.46 @@ -6,7 +6,7 @@ rxvt [options] [-e command [ args ]] DESCRIPTION - rxvt-unicode, version 6.3, is a colour vt102 terminal emulator intended + 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 -- a significant @@ -148,7 +148,7 @@ -fn *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 + 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. @@ -373,7 +373,7 @@ system "rxvt -embed $xid &"; }); - -pty-fd *fileno* + -pty-fd *file descriptor* 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 rxvt as a generic terminal emulator @@ -383,6 +383,9 @@ 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): @@ -399,20 +402,17 @@ 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. + 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 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 @@ -420,18 +420,15 @@ 4. SCREEN_RESOURCES for the current screen 5. $XENVIRONMENT file OR $HOME/.Xdefaults- - 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* Create the window with the specified X window geometry [default @@ -541,23 +538,16 @@ will be magnified beyond 10 times its original size. The maximum permitted 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 + 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 larger. A reasonable default - font list is always appended to it; option -fn. + 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 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with @@ -570,7 +560,7 @@ For example, this font resource - 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, \ @@ -666,7 +656,7 @@ Example: - 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 everytime you hit "Print". @@ -819,8 +809,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* Set the key to be interpreted as the Meta key to: alt, meta, hyper, @@ -873,10 +862,10 @@ "^@": null, "^A" ...) and may be enclosed with double quotes so that it 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* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter @@ -940,27 +929,63 @@ perl-ext-common: *string* 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 + 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", 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; option -pe. + instances. perl-eval: *string* Perl code to be evaluated when all extensions have been registered. - See the rxvtperl(3) manpage. + 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/. + /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* + 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 (resource: saveLines) and can be scrolled back using the scrollbar or by @@ -1009,11 +1034,15 @@ 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.