--- rxvt-unicode/doc/rxvt.1.pod 2006/01/16 15:07:27 1.97 +++ rxvt-unicode/doc/rxvt.1.pod 2007/06/18 13:38:12 1.132 @@ -19,7 +19,7 @@ See @@RXVT_NAME@@(7) (try C) for a list of frequently asked questions and answer to them and some common problems. That document is also accessible on the World-Wide-Web at -L. +L. =head1 RXVT-UNICODE VS. RXVT @@ -30,38 +30,38 @@ like mongolian or scripts requiring extremely complex combining rules, like tibetan or devenagari. Don't expect pretty output when using these scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work -fine, though. A somewhat difficult case are left-to-right scripts, such +fine, though. A somewhat difficult case are right-to-left scripts, such as hebrew: B adopts the view that bidirectional algorithms belong into the application, not the terminal emulator (too many things -- such as cursor-movement while editing -- break otherwise), but that might change. If you are looking for a terminal that supports more exotic scripts, let -me recommend C, which is a very userfriendly, lean and clean +me recommend C, which is a very user friendly, lean and clean terminal emulator. In fact, the reason rxvt-unicode was born was solely because the author couldn't get C to use one font for latin1 and another for japanese. Therefore another design rationale was the use of multiple fonts to display characters: The idea of a single unicode font which many other -programs force onto it's users never made sense to me: You should be able +programs force onto its users never made sense to me: You should be able to choose any font for any script freely. Apart from that, rxvt-unicode is also much better internationalised than -it's predecessor, supports things such as XFT and ISO 14755 that are handy -in i18n-environments, is faster, and has a lot less bugs than the original +its predecessor, supports things such as XFT and ISO 14755 that are handy +in i18n-environments, is faster, and has a lot bugs less than the original rxvt. This all in addition to dozens of other small improvements. It is still faithfully following the original rxvt idea of being lean and nice on resources: for example, you can still configure rxvt-unicode -without most of it's features to get a lean binary. It also comes with +without most of its features to get a lean binary. It also comes with a client/daemon pair that lets you open any number of terminal windows from within a single process, which makes startup time very fast and drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and @@RXVT_NAME@@c(1) (client). It also makes technical information about escape sequences (which have -been extended) easier accessible: see @@RXVT_NAME@@(7) for technical +been extended) more accessible: see @@RXVT_NAME@@(7) for technical reference documentation (escape sequences etc.). =head1 OPTIONS @@ -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. @@ -105,13 +110,21 @@ =item B<-j>|B<+j> -Turn on/off jump scrolling; resource B. +Turn on/off jump scrolling (allow multiple lines per refresh); resource B. + +=item B<-ss>|B<+ss> + +Turn on/off skip scrolling (allow multiple screens per refresh); resource B. =item B<-ip>|B<+ip> | B<-tr>|B<+tr> 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 +134,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 @@ -133,11 +146,26 @@ @@RXVT_NAME@@ -tr -tint blue -sh 40 -=item B<-sh> +=item B<-sh> I -I Darken (0 .. 100) or lighten (-1 .. -100) the transparent -background image in addition to tinting it (i.e. B<-tint> must be -specified, too, e.g. C<-tint white>). +Darken (0 .. 100) or lighten (-1 .. -100) the transparent +background image in addition to (or instead of) tinting it; +resource I. + +=item B<-blt> I + +Specify background blending type. If background pixmap is specified +at the same time as transparency - such pixmap will be blended over +transparency image, using method specified. Supported values are : +B, B, B - color values averaging, B, +B, B, B, B, B, B, +B, B, B, B, B. The default is +alpha-blending; resource I. + +=item B<-blr> I + +Apply Gaussian Blur with the specified radius to the transparent +background image; resource I. =item B<-bg> I @@ -149,10 +177,10 @@ =item B<-pixmap> I -Compile I: Specify XPM file for the background and also optionally -specify its scaling with a geometry string. Note you may need to +Compile I: Specify image file for the background and also +optionally specify its scaling with a geometry string. Note you may need to add quotes to avoid special shell interpretation of the C<;> in the -command-line; resource B. +command-line; for more details see resource B. =item B<-cr> I @@ -179,7 +207,7 @@ smaller, but not (in general) larger. A (hopefully) reasonable default font list is always appended to it. See resource B for more details. -In short, to specify an X11 core font, just specify it's name or prefix it +In short, to specify an X11 core font, just specify its name or prefix it with C. To specify an XFT-font, you need to prefix it with C, e.g.: @@ -299,6 +327,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 @@ -374,7 +407,8 @@ =item B<-tcw> Change the meaning of triple-click selection with the left mouse -button. Instead of selecting a full line it will extend the selection the +button. Only effective when the original (non-perl) selection code is +in-use. Instead of selecting a full line it will extend the selection the end of the logical line only. resource B. =item B<-insecure> @@ -412,7 +446,7 @@ =item B<-embed> I -Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, +Tells @@RXVT_NAME@@ to embed its windows into an already-existing window, which enables applications to easily embed a terminal. Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it @@ -425,7 +459,7 @@ It might be useful to know that @@RXVT_NAME@@ will not close file descriptors passed to it (except for stdin/out/err, of course), so you can use file descriptors to communicate with the programs within the -terminal. This works regardless of wether the C<-embed> option was used or +terminal. This works regardless of whether the C<-embed> option was used or not. Here is a short Gtk2-perl snippet that illustrates how this option can be @@ -440,7 +474,7 @@ =item B<-pty-fd> I Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty -pair but instead use the given filehandle as the tty master. This is +pair but instead use the given file descriptor as the tty master. This is useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator without having to run a program within it. @@ -502,6 +536,11 @@ =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]; @@ -547,8 +586,8 @@ =item B I -Use the specified colour as the background for reverse video -characters. +Use the specified colour as the background for reverse video characters +when OPTION_HC is disabled (--disable-frills). =item B I @@ -574,9 +613,25 @@ =item B I -B: specify that jump scrolling should be used. When scrolling -quickly, fewer screen updates are performed [default]; option B<-j>. -B: specify that smooth scrolling should be used; option B<+j>. +B: specify that jump scrolling should be used. When receiving lots +of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines +has been read, resulting in fewer updates while still displaying every +received line; option B<-j>. + +B: specify that smooth scrolling should be used. @@RXVT_NAME@@ will +force a screen refresh on each new line it received; option B<+j>. + +=item B I + +B: (the default) specify that skip scrolling should be used. When +receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while +(around 60 times per second), resulting in far fewer updates. This can +result in @@RXVT_NAME@@ not ever displaying some of the lines it receives; +option B<-ss>. + +B: specify that everything is to be displayed, even +if the refresh is too fast for the human eye to read anything (or the +monitor to display anything); option B<+ss>. =item B I @@ -584,6 +639,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>. @@ -600,8 +658,17 @@ =item B I -Darken (0 .. 100) or lighten (-1 .. -100) the transparent background -image in addition to tinting it. +Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image +in addition to tinting it; option B<-sh>. + +=item B I + +Specify background blending type; option B<-blt>. + +=item B I + +Apply Gaussian Blurr with the specified radius to the transparent +background image; option B<-blr>. =item B I @@ -619,15 +686,20 @@ =item B I -Use the specified XPM file (note the `.xpm' extension is optional) for -the background and also optionally specify its scaling with a geometry -string B, in which B<"W" / "H"> specify the -horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image -centre (percent). A scale of 0 displays the image with tiling. A scale -of 1 displays the image without any scaling. A scale of 2 to 9 -specifies an integer number of images in that direction. No image will -be magnified beyond 10 times its original size. The maximum permitted -scale is 1000. [default 0x0+50+50] +Use the specified image file for the background and also optionally +specify its scaling with a geometry string B, +in which B<"W" / "H"> specify the horizontal/vertical scale (percent), +and B<"X" / "Y"> locate the image centre (percent). +A scale of 0 displays the image with tiling. A scale of 1 displays the +image without any scaling. A scale of 2 to 9 specifies an integer +number of images in that direction. No image will be magnified beyond +10 times its original size. The maximum permitted scale is 1000. +Special string of B<"auto"> used as a geometry will cause image to be +automatically scaled to match window size. +If used in conjunction with B<-tr> option - specified pixmap will be +blended over transparency image using either alpha-blending, or any +other blending type, specified with B<-blt "type"> option. +[default 0x0+50+50] =item B I @@ -699,15 +771,16 @@ When font styles are not enabled, or this option is enabled (B, option B<-is>, the default), bold and italic font styles imply high -intensity foreground/backround colours. Disabling this option (B, +intensity foreground/background colours. Disabling this option (B, option B<+is>) disables this behaviour, the high intensity colours are not reachable. =item B I -Set mouse selection style to B which is 2.20, B which is -xterm style with 2.20 old word selection, or anything else which gives -xterm style selection. +Set mouse selection style to B which is 2.20, B which +is xterm style with 2.20 old word selection, or anything else which +gives xterm style selection. Only effective when the original (non-perl) +selection code is in use. =item B I @@ -731,6 +804,11 @@ B: de-iconify (map) on receipt of a bell character. B: no de-iconify (map) on receipt of a bell character [default]. +=item B I + +B: set the urgency hint for the wm on receipt of a bell character. +B: do not set the urgency hint [default]. + =item B I B: use visual bell on receipt of a bell character; option B<-vb>. @@ -761,7 +839,7 @@ 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. +every time you hit C. =item B I @@ -793,7 +871,7 @@ B: scroll with scrollback buffer when tty receives new lines (and B is False); option B<-sw>. B: do not scroll -with scrollback buffer when tty recieves new lines; option B<+sw>. +with scrollback buffer when tty receives new lines; option B<+sw>. =item B I @@ -893,8 +971,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 perl 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 `"'&()*,;<=>?@[]{|} >> @@ -954,18 +1040,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 +Turn on/off secondary screen scroll (default enabled). If 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 @@ -998,15 +1084,16 @@ C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, C<\000>: octal number) or verbatim control characters (C<^?>: delete, C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it -can start or end with whitespace. +can start or end with whitespace. B. 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 +Xlib itself does its 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 `/' +with pattern B, where the delimiter `/' should be a character not used by the strings. Its usage can be demonstrated by an example: @@ -1080,7 +1167,7 @@ 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 +searchable scrollback to Alt/Meta-s). Mentioning the same extension multiple times with different arguments will pass multiple arguments to the extension. @@ -1126,11 +1213,20 @@ =item B: I Specifies the program to be started with a URL argument. Used by the -C and C perl extensions. +C and C perl extensions. =item B: I -Sets the WM_TRANSIENT_FOR property to the given window iw. +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>. + +=item B I + +Turn on/off ISO 14755 5.2 mode (default enabled). =back @@ -1159,14 +1255,14 @@ up and down arrows sends B (Up) and B (Down), respectively. -=head1 TEXT SELECTION AND INSERTION +=head1 THE SELECTION: SELECTING AND PASTING TEXT -The behaviour of text selection and insertion mechanism is similar to -I(1). +The behaviour of text selection and insertion/pasting mechanism is similar +to I(1). =over 4 -=item B: +=item B: Left click at the beginning of the region, drag to the end of the region and release; Right click to extend the marked region; Left double-click @@ -1180,11 +1276,14 @@ selection, and trailing whitespace is visually underlined and removed from the selection. -=item B: +=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 +B 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 @@ -1238,7 +1337,7 @@ Start by pressing C and C together, then releasing them. The next special key (cursor keys, home etc.) you enter will not -invoke it's usual function but instead will insert the corresponding +invoke its usual function but instead will insert the corresponding keycap symbol. The symbol will only be entered when the key has been released, otherwise pressing e.g. C would enter the symbol for C, although your intention might have been to enter a @@ -1281,7 +1380,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 @@ -1311,6 +1410,15 @@ a number 0-15, as a convenient shorthand to reference the colour name of color0-color15. +In addition to the colours defined above, @@RXVT_NAME@@ offers an +additional 72 colours. The first 64 of those (with indices 16 to 79) +consist of a 4*4*4 RGB colour cube (i.e. I), followed by 8 additional shades of gray (with indices 80 to 87). + +Together, all those colours implement the 88 colour xterm colours. Only +the first 16 can be changed using resources currently, the rest can only +be changed via command sequences ("escape codes"). + 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 @@ -1325,6 +1433,30 @@ =back +=head2 ALPHA CHANNEL SUPPORT + +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) colour specifications, +in addition to the ones provided by X, where the additional A component +specifies opacity (alpha) values. The minimum value of C<0> is completely +transparent). You can also prefix any color with C<[percent]>, where +C is a decimal percentage (0-100) that specifies the opacity of +the color, where C<0> is completely transparent and C<100> is completelxy +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. + +For example, the following selects an almost completely transparent red +background, and an almost opaque pink foreground: + + @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" + +I + =head1 ENVIRONMENT B<@@RXVT_NAME@@> sets and/or uses the following environment variables: @@ -1334,11 +1466,11 @@ =item B Normally set to C, unless overwritten at configure time, via -resources or on the commandline. +resources or on the command line. =item B -Either C, C, depending on wether @@RXVT_NAME@@ was +Either C, C, depending on whether @@RXVT_NAME@@ was compiled with XPM support, and optionally with the added extension C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. @@ -1366,21 +1498,12 @@ =item B Used by @@RXVT_NAME@@ to connect to the display and set to the correct -display in it's child processes. +display in its child processes. =item B 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 @@ -1427,7 +1550,7 @@ Marc A. Lehmann L<< >> -L +L =back @@ -1459,16 +1582,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