--- rxvt-unicode/doc/rxvt.1.pod 2006/01/08 08:43:11 1.89 +++ rxvt-unicode/doc/rxvt.1.pod 2006/01/29 22:38:43 1.110 @@ -95,6 +95,11 @@ respected). In the absence of this option, the display specified by the B environment variable is used. +=item B<-depth> I + +Compile I: Attempt to find a visual with the given bit depth; +resource B. + =item B<-geometry> I Window geometry (B<-g> still respected); resource B. @@ -112,6 +117,9 @@ Turn on/off inheriting parent window's pixmap. Alternative form is B<-tr>; resource B. +I + =item B<-fade> I Fade the text by the given percentage when focus is lost. Small values @@ -121,7 +129,7 @@ =item B<-fadecolor> I Fade to this colour when fading is used (see B<-fade>). The default colour -is black. resource B. +is opaque black. resource B. =item B<-tint> I @@ -174,7 +182,7 @@ =item B<-fn> I 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 B for more details. @@ -299,6 +307,11 @@ if honoured by the WM, the rxvt-unicode window will not have window decorations; resource B. +=item B<-override-redirect> + +Compile I: Sets override-redirect on the window; resource +B. + =item B<-sbg> Compile I: Disable the usage of the built-in block graphics/line @@ -478,14 +491,10 @@ Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long options) compiled into your version. -There are two different methods that @@RXVT_NAME@@ can use to get the -Xresource data: using the X libraries (Xrm*-functions) or internal -Xresources reader (B<~/.Xdefaults>). For the first method (ie. -B<@@RXVT_NAME@@ -h> lists B), you can set and change the -resources using X11 tools like B. Many distribution do also load -settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@ -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 B. Many +distribution do also load settings from the B<~/.Xresources> file when X +starts. @@RXVT_NAME@@ 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 @@ -493,23 +502,24 @@ 4. SCREEN_RESOURCES for the current screen 5. $XENVIRONMENT file OR $HOME/.Xdefaults- -If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> -lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults -set in XAPPLOADDIR/URxvt (compile-time defined: usually -B) and resources set in -B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist. -Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two -class names: B and B. The class name B allows -resources common to both B<@@RXVT_NAME@@> and the original I to be -easily configured, while the class name B allows resources -unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be -shared between different B<@@RXVT_NAME@@> 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, B<@@RXVT_NAME@@> recognizes two class +names: B and B. The class name B allows resources +common to both B<@@RXVT_NAME@@> and the original I to be easily +configured, while the class name B allows resources unique to +B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@> +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 @@RXVT_NAME@@perl(3) manpage for additional settings by perl +extensions not documented here): =over 4 +=item B I + +Compile I: Attempt to find a visual with the given bit depth; +option B<-depth>. + =item B I Create the window with the specified X window geometry [default 80x24]; @@ -592,6 +602,9 @@ artificial transparency. B: do not inherit the parent windows' pixmap. +I + =item B I Fade the text by the given percentage when focus is lost; option B<-fade>. @@ -637,25 +650,17 @@ be magnified beyond 10 times its original size. The maximum permitted scale is 1000. [default 0x0+50+50] -=item B I - -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. - =item B I -Specify the colon-delimited search path for finding files (XPM and -menus), in addition to the paths specified by the B and -B environment variables. +Specify the colon-delimited search path for finding XPM files. =item B I -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 B<-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 B<-fn>. Each font can either be a standard X11 core font (XLFD) name, with optional prefix C or a Xft font (Compile I), prefixed with C. @@ -667,7 +672,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, \ @@ -774,7 +779,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 C. @@ -909,8 +914,16 @@ =item B I -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 @@RXVT_NAME@@perl(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: B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> @@ -956,8 +969,7 @@ You can enable them by setting this boolean resource or specifying B<-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. =item B I @@ -971,18 +983,18 @@ character is passed through. It may contain escape values as described in the entry on B following. -=item B I +=item B I Turn on/off secondary screen (default enabled). -=item B I +=item B I 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. -=item B: I +=item B: I Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ will not immediately destroy its window when the program executed within @@ -1017,10 +1029,10 @@ C<^@>: null, C<^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 C<\> when using -C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can -use C<\033> instead of C<\e> (and so on), which will work with both Xt and -@@RXVT_NAME@@'s own processing). +Please note that you need to double the C<\> in resource files, as +Xlib itself does it's own de-escaping (you can use C<\033> instead of +C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own +processing). You can define a range of keysyms in one shot by providing a I with pattern B, where the delimeter `/' @@ -1090,11 +1102,17 @@ use in this terminal instance; option B<-pe>. Extension names can be prefixed with a C<-> sign to prohibit using -it. This can be useful to selectively disable some extensions loaded +them. This can be useful to selectively disable some extensions loaded by default, or specified via the C resource. For example, C will use all the default extension except C. +Extension names can also be followed by an argument in angle brackets +(e.g. C<< 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. @@ -1119,6 +1137,35 @@ See the @@RXVT_NAME@@perl(3) manpage. +=item B<< selection.pattern-I >>: I + +Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for +details. + +=item B<< selection-autotransform.I >>: I + +Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage +for details. + +=item B I + +Sets the hotkey that starts the incremental scrollback buffer search +(default: C). + +=item B: I + +Specifies the program to be started with a URL argument. Used by the +C and C perl extensions. + +=item B: I + +Compile I: Sets the WM_TRANSIENT_FOR property to the given window id. + +=item B: I + +Compile I: Sets override-redirect for the terminal window, making +it almost invisible to window managers; option B<-override-redirect>. + =back =head1 THE SCROLLBAR @@ -1169,9 +1216,12 @@ =item B: -Pressing and releasing the Middle mouse button (or B) in -an B<@@RXVT_NAME@@> 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 B<@@RXVT_NAME@@> +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 B causes the value of the PRIMARY selection to be +inserted too. =back @@ -1180,11 +1230,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. =head1 ISO 14755 SUPPORT @@ -1264,7 +1318,7 @@ In addition to the default foreground and background colours, B<@@RXVT_NAME@@> 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 B names. +colours with their names. =begin table @@ -1294,6 +1348,19 @@ a number 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 C +(recommended, but B have 4 digits/component), C<#ARGB>, C<#AARRGGBB> +and C<#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 B<"-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. + +I + Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by always swapping the foreground/background colours. This is in contrast to I(1) where the colours are only swapped if they have not otherwise @@ -1355,15 +1422,6 @@ The shell to be used for command execution, defaults to C. -=item B - -The path where @@RXVT_NAME@@ looks for support files such as menu and xpm -files. - -=item B - -Used in the same way as C. - =item B The unix domain socket path used by @@RXVT_NAME@@c(1) and @@ -1442,16 +1500,20 @@ =item Geoff Wing L<< >> -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) =item Marc Alexander Lehmann L<< >> -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 -) +=item Emanuele Giaquinta L<< >> + +Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. + =back