--- rxvt-unicode/doc/rxvt.1.txt 2006/01/08 00:20:12 1.38 +++ rxvt-unicode/doc/rxvt.1.txt 2006/01/29 21:45:47 1.54 @@ -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.4, 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 @@ -86,6 +86,10 @@ respected). In the absence of this option, the display specified by the DISPLAY environment variable is used. + -depth *bitdepth* + Compile *frills*: Attempt to find a visual with the given bit depth; + resource depth. + -geometry *geom* Window geometry (-g still respected); resource geometry. @@ -148,7 +152,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. @@ -254,6 +258,10 @@ if honoured by the WM, the rxvt-unicode window will not have window 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 @@ -409,13 +417,10 @@ 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 @@ -423,18 +428,19 @@ 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): + + depth: *bitdepth* + Compile *frills*: Attempt to find a visual with the given bit depth; + option -depth. geometry: *geom* Create the window with the specified X window geometry [default @@ -544,23 +550,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 @@ -573,7 +572,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, \ @@ -669,7 +668,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". @@ -780,8 +779,17 @@ associated with the Execute key. 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 `"'&()*,;<=>?@[]{|} @@ -822,8 +830,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, @@ -834,16 +841,16 @@ (control-E) character is passed through. It may contain escape values as described 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 option is enabled, scrolls on the secondary screen will change the scrollback buffer and switching to/from the secondary screen will instead scroll the screen up. - hold: *bool* + 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 @@ -876,10 +883,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 @@ -947,11 +954,17 @@ "default") to use in this terminal instance; option -pe. Extension names can be prefixed with a "-" sign to prohibit using - it. 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 + 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. @@ -963,16 +976,43 @@ 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* + 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 rxvt window (resource: saveLines) and can be scrolled back using the scrollbar or by @@ -1013,19 +1053,27 @@ removed from the selection. Insertion: - Pressing and releasing the Middle mouse button (or Shift-Insert) in - an rxvt 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. 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. @@ -1097,8 +1145,7 @@ COLORS AND GRAPHICS In addition to the default foreground and background colours, 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. + versions of the same). Here is a list of the colours with their names. color0 (black) = Black color1 (red) = Red3 @@ -1124,6 +1171,17 @@ 0-15, as a convenient shorthand to reference the colour name of color0-color15. + If Xft support has been compiled in and as long as Xft/Xrender/X don't + get their act together, rxvt-unicode will support + "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4 + digits/component), "#ARGB", "#AARRGGBB" and "#AAAARRRRGGGGBBBB" colour + specifications, in addition to the ones provided by X, where the + additional A component specifies alpha (opacity) values (0 is completely + transparent and the maximum is opaque). You probably need to specify + "-depth 32", too, and have the luck that your X-server uses ARGB pixel + layout, as X is far from just supporting ARGB visuals out of the box, + and rxvt-unicode just fudges around. + Note that -rv ("reverseVideo: True") simulates reverse video by always swapping the foreground/background colours. This is in contrast to *xterm*(1) where the colours are only swapped if they have not otherwise @@ -1170,13 +1228,6 @@ SHELL 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 The unix domain socket path used by rxvtc(1) and rxvtd(1). @@ -1227,13 +1278,16 @@ Project Coordinator (changes.txt 2.21a to 2.4.5) 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. +