--- rxvt-unicode/doc/rxvt.1.pod 2004/08/12 21:30:14 1.2 +++ rxvt-unicode/doc/rxvt.1.pod 2014/05/18 18:19:10 1.232 @@ -8,14 +8,64 @@ =head1 DESCRIPTION -B, version B<@@RXVTVERSION@@>, is a colour vt102 terminal +B, version B<@@RXVT_VERSION@@>, is a colour vt102 terminal emulator intended as an I(1) replacement for users who do not require features such as Tektronix 4014 emulation and toolkit-style configurability. As a result, B uses much less swap space -- a significant advantage on a machine serving many X sessions. -See also @@RXVT_NAME@@(7) for technical reference documentation (escape -sequences etc.). +This document is also available on the World-Wide-Web at +L. + +=head1 FREQUENTLY ASKED QUESTIONS + +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. + +=head1 RXVT-UNICODE VS. RXVT + +Unlike the original rxvt, B stores all text in Unicode +internally. That means it can store and display most scripts in the +world. Being a terminal emulator, however, some things are very difficult, +especially cursive scripts such as arabic, vertically written scripts +like mongolian or scripts requiring extremely complex combining rules, +like tibetan or devanagari. 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 right-to-left scripts, such +as hebrew: B adopts the view that bidirectional algorithms +belong in 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 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 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 +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 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) more accessible: see @@RXVT_NAME@@(7) for technical +reference documentation (escape sequences etc.). =head1 OPTIONS @@ -23,15 +73,15 @@ below. In keeping with the smaller-is-better philosophy, options may be eliminated or default values chosen at compile-time, so options and defaults listed may not accurately reflect the version installed on -your system. `rxvt -h' gives a list of major compile-time options on +your system. `@@RXVT_NAME@@ -h' gives a list of major compile-time options on the I line. Option descriptions may be prefixed with which compile option each is dependent upon. e.g. `Compile I:' requires -I on the I line. Note: `rxvt -help' gives a list of all +I on the I line. Note: `@@RXVT_NAME@@ -help' gives a list of all command-line options compiled into your version. Note that B<@@RXVT_NAME@@> permits the resource name to be used as a long-option (--/++ option) so the potential command-line options are -far greater than those listed. For example: `rxvt --loginShell --color1 +far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1 Orange'. The following options are available: @@ -44,9 +94,24 @@ =item B<-display> I -Attempt to open a window on the named X display (B<-d> still -respected). In the absence of this option, the display specified by the -B environment variable is used. +Attempt to open a window on the named X display (the older form B<-d> +is still respected. but deprecated). 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. + +[Please note that many X servers (and libXft) are buggy with +respect to C<-depth 32> and/or alpha channels, and will cause all sorts +of graphical corruption. This is harmless, but we can't do anything about +this, so watch out] + +=item B<-visual> I + +Compile I: Use the given visual (see e.g. C for possible +visual ids). =item B<-geometry> I @@ -58,29 +123,28 @@ =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<-ip>|B<+ip> +=item B<-ss>|B<+ss> -Turn on/off inheriting parent window's pixmap. Alternative form is -B<-tr>; resource B. +Turn on/off skip scrolling (allow multiple screens per refresh); resource B. =item B<-fade> I -Fade the text by the given percentage when focus is lost. +Fade the text by the given percentage when focus is lost. Small values +fade a little only, 100 completely replaces all colours by the fade +colour; resource B. -=item B<-tint> I +=item B<-fadecolor> I + +Fade to this colour when fading is used (see B<-fade>). The default colour +is opaque black. resource B. + +=item B<-icon> I -Tint the transparent background pixmap with the given colour when -transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> -option that can be used to brighten or darken the image in addition to -tinting it. - -=item B<-sh> - -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). +Compile I: Use the specified image as application icon. This +is used by many window managers, taskbars and pagers to represent the +application window; resource I. =item B<-bg> I @@ -90,13 +154,6 @@ Window foreground colour; resource B. -=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 add -quotes to avoid special shell interpretation of the `;' in the -command-line; resource B. - =item B<-cr> I The cursor colour; resource B. @@ -111,24 +168,48 @@ =item B<-bd> I -The colour of the border between the xterm scrollbar and the text; +The colour of the border around the text area and between the scrollbar and the text; resource B. -=item B<-fn> I +=item B<-fn> I + +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. See resource B for more details. + +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.: + + @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" + @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" + +See also the question "How does rxvt-unicode choose fonts?" in the FAQ +section of @@RXVT_NAME@@(7). + +=item B<-fb> I + +Compile I: The bold font list to use when B characters +are to be printed. See resource B for details. + +=item B<-fi> I + +Compile I: The italic font list to use when I +characters are to be printed. See resource B for details. -Select the fonts to be used. This is a comma seperated 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. resource B. - -=item B<-rb>|B<+rb> - -Enable "real bold" support. When this option is on, bold text will be -displayed using the first available bold font in the font list. Bold -fonts should thus be specified in the font list after their -corresponding regular fonts. If no bold font can be found, a regular -font will be used. resource B. +=item B<-fbi> I + +Compile I: The bold italic font list to use when B<< I >> characters are to be printed. See resource B +for details. + +=item B<-is>|B<+is> + +Compile I: Bold/Blink font styles imply high intensity +foreground/background (default). See resource B for +details. =item B<-name> I @@ -154,6 +235,15 @@ Turn on/off scrollbar; resource B. +=item B<-sr>|B<+sr> + +Put scrollbar on right/left; resource B. + +=item B<-st>|B<+st> + +Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; +resource B. + =item B<-si>|B<+si> Turn on/off scroll-to-bottom on TTY output inhibit; resource @@ -170,19 +260,22 @@ This only takes effect if B<-si> is also given; resource B. -=item B<-sr>|B<+sr> +=item B<-ptab>|B<+ptab> -Put scrollbar on right/left; resource B. - -=item B<-st>|B<+st> - -Display normal (non XTerm/NeXT) scrollbar without/with a trough; -resource B. +If enabled (default), "Horizontal Tab" characters are being stored as +actual wide characters in the screen buffer, which makes it possible to +select and paste them. Since a horizontal tab is a cursor movement and +not an actual glyph, this can sometimes be visually annoying as the cursor +on a tab character is displayed as a wide cursor; resource B. =item B<-bc>|B<+bc> Blink the cursor; resource B. +=item B<-uc>|B<+uc> + +Make the cursor underlined; resource B. + =item B<-iconic> Start iconified, if the window manager supports that option. @@ -207,13 +300,34 @@ =item B<-bl> Compile I: Set MWM hints to request a borderless window, i.e. -if honoured by the WM, the rxvt window will not have window -decorations; resource B. +if honoured by the WM, the rxvt-unicode window will not have window +decorations; resource B. If the window manager does not +support MWM hints (e.g. kwin), enables override-redirect mode. + +=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 +drawing characters and just rely on what the specified fonts provide. Use +this if you have a good font and want to use its block graphic glyphs; +resource B. =item B<-lsp> I -Compile I: Lines (pixel height) to insert between each row -of the display; resource B. +Compile I: Lines (pixel height) to insert between each row of +the display. Useful to work around font rendering problems; resource +B. + +=item B<-letsp> I + +Compile I: Amount to adjust the computed character width by +to control overall letter spacing. Negative values will tighten up the +letter spacing, positive values will space letters out more. Useful to +work around odd font metrics; resource B. =item B<-tn> I @@ -232,6 +346,11 @@ run the program specified by the B environment variable or, failing that, I. +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_NAME@@ -e sh -c "shell commands" + =item B<-title> I Window title (B<-T> still respected); the default title is the basename @@ -259,10 +378,22 @@ =item B<-imlocale> I -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. +The locale to use for opening the IM. You can use an C of e.g. +C for normal text processing but C for the +input extension to be able to input japanese characters while staying in +another locale. resource B. + +=item B<-imfont> I + +Set the font set to use for the X Input Method, see resource B +for more info. + +=item B<-tcw> + +Change the meaning of triple-click selection with the left mouse +button. Only effective when the original (non-perl) selection code is +in-use. Instead of selecting a full line it will extend the selection to +the end of the logical line only. resource B. =item B<-insecure> @@ -286,43 +417,143 @@ Turn on/off secondary screen scroll (default enabled); resource B. -=item B<-xrm> I +=item B<-hold>|B<+hold> + +Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ +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 B. + +=item B<-cd> I + +Sets the working directory for the shell (or the command specified via +B<-e>). The I must be an absolute path and it must exist for +@@RXVT_NAME@@ to start; resource B. + +=item B<-xrm> I + +Works like the X Toolkit option of the same name, by adding the I +as if it were specified in a resource file. Resource values specified this +way take precedence over all other resource specifications. + +Note that you need to use the I syntax as in the .Xdefaults file, +e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific +options can be specified as long-options on the commandline, so use +of B<-xrm> is mostly limited to cases where you want to specify other +resources (e.g. for input methods) or for compatibility with other +programs. + +=item B<-keysym.>I I + +Remap a key symbol. See resource B. + +=item B<-embed> I + +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 +shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it +quite a bit, so don't expect it to keep some specific state. It's best to +create an extra subwindow for @@RXVT_NAME@@ and leave it alone. + +The window will not be destroyed when @@RXVT_NAME@@ exits. + +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 whether the C<-embed> option was used or +not. -No effect on rxvt. Simply passes through an argument to be made -available in the instance's argument list. Appears in I in -some window managers. +Here is a short Gtk2-perl snippet that illustrates how this option can be +used (a longer example is in F): + + my $rxvt = new Gtk2::Socket; + $rxvt->signal_connect_after (realize => sub { + my $xid = $_[0]->window->get_xid; + system "@@RXVT_NAME@@ -embed $xid &"; + }); + +=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 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. + +If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp +entries and will not tinker with pty/tty permissions - you have to do that +yourself if you want that. + +As an extremely special case, specifying C<-1> will completely suppress +pty/tty operations, which is probably only useful in conjunction with some +perl extension that manages the terminal. + +Here is a example in perl that illustrates how this option can be used (a +longer example is in F): + + use IO::Pty; + use Fcntl; + + my $pty = new IO::Pty; + fcntl $pty, F_SETFD, 0; # clear close-on-exec + system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&"; + close $pty; + + # now communicate with rxvt + my $slave = $pty->slave; + while (<$slave>) { print $slave "got <$_>\n" } + +=item B<-pe> I + +Comma-separated list of perl extension scripts to use (or not to use) in +this terminal instance. See resource B for details. =back -=head1 RESOURCES (available also as long-options) +=head1 RESOURCES Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long -options) compiled into your version. +options) compiled into your version. All resources are also available as +long-options. -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. - -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: +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. app-defaults file in $XAPPLRESDIR + 2. $HOME/.Xdefaults + 3. RESOURCE_MANAGER property on root-window of screen 0 + 4. SCREEN_RESOURCES property on root-window of the current screen + 5. $XENVIRONMENT file OR $HOME/.Xdefaults- + 6. resources specified via -xrm on the commandline + +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 + +Compile I: Turn on/off double-buffering for xft (default enabled). +On some card/driver combination enabling it slightly decreases +performance, on most it greatly helps it. The slowdown is small, so it +should normally be enabled. + =item B I Create the window with the specified X window geometry [default 80x24]; @@ -345,23 +576,41 @@ high-intensity (bold = bright foreground, blink = bright background) colours. The canonical names are as follows: 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour -names used are listed in the B section. +names used are listed in the B section. + +Colours higher than 15 cannot be set using resources (yet), but can be +changed using an escape command (see @@RXVT_NAME@@(7)). + +Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with +88 colour support). Colours 80-87 are evenly spaces grey steps. =item B I -Use the specified colour to display bold characters when the foreground -colour is the default. This option will be ignored if B is -enabled. +=item B I + +Use the specified colour to display bold or italic characters when the +foreground colour is the default. If font styles are not available +(Compile I) and this option is unset, reverse video is used instead. =item B I Use the specified colour to display underlined characters when the foreground colour is the default. -=item B I +=item B I + +If set, use the specified colour as the colour for the underline +itself. If unset, use the foreground colour. -Use the specified colour as the background for reverse video -characters. +=item B I + +If set, use the specified colour as the background for highlighted +characters. If unset, use reverse video. + +=item B I + +If set and highlightColor is set, use the specified colour as the +foreground for highlighted characters. =item B I @@ -378,36 +627,42 @@ B: simulate reverse video by foreground and background colours; option B<-rv>. B: regular screen colours [default]; option -B<+rv>. See note in B section. +B<+rv>. See note in B section. =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>. - -=item B I - -B: make the background inherit the parent windows' pixmap, giving -artificial transparency. B: do not inherit the parent windows' -pixmap. +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 -Fade the text by the given percentage when focus is lost. - -=item B I - -Tint the transparent background pixmap with the given colour. +Fade the text by the given percentage when focus is lost; option B<-fade>. -=item B I +=item B I -Darken (0 .. 100) or lighten (-1 .. -100) the transparent background -image in addition to tinting it. +Fade to this colour, when fading is used (see B). The default +colour is black; option B<-fadecolor>. -=item B I +=item B I -Scale the tint colour by the given percentage. +Set the application icon pixmap; option B<-icon>. =item B I @@ -416,59 +671,82 @@ =item B I Use the specified colour for the scrollbar's trough area [default -#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. +#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar. -=item B I +=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] - -=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. +The colour of the border around the text area and between the scrollbar +and the text. -=item B I +=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. - -=item B I - -Select the fonts to be used. This is a comma seperated 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>. - -=item B I - -B: Enable "real bold" support. When this option is on, bold text -will be displayed using the first available bold font in the font list. -Bold fonts should thus be specified in the font list after their -corresponding regular fonts. If no bold font can be found, a regular -font will be used. option B<-rb>. B: Display bold text in a -regular font, using the color specified with B; option B<+rb>. - -=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. +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>. -=item B I +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. + +In addition, each font can be prefixed with additional hints and +specifications enclosed in square brackets (C<[]>). The only available +hint currently is C, and this is only used for Xft +fonts. + +For example, this font resource + + 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, \ + xft:Code2000:antialias=false + +specifies five fonts to be used. The first one is C<9x15bold> (actually +the iso8859-1 version of the second font), which is the base font (because +it is named first) and thus defines the character cell grid to be 9 pixels +wide and 15 pixels high. + +The second font is just used to add additional unicode characters not in +the base font, likewise the third, which is unfortunately non-bold, but +the bold version of the font does contain fewer characters, so this is a +useful supplement. + +The third font is an Xft font with aliasing turned off, and the characters +are limited to the B codeset (i.e. japanese kanji). The font +contains other characters, but we are not interested in them. + +The last font is a useful catch-all font that supplies most of the +remaining unicode characters. + +=item B I + +=item B I -Set scrollbar style to B<@@RXVT_NAME@@>, B, B, B or -B +=item B I + +The font list to use for displaying B, I or B<< I >> characters, respectively. + +If specified and non-empty, then the syntax is the same as for the +B-resource, and the given font list will be used as is, which makes +it possible to substitute completely different font styles for bold and +italic. + +If unset (the default), a suitable font list will be synthesized by +"morphing" the normal text font list into the desired shape. If that is +not possible, replacement fonts of the desired shape will be tried. + +If set, but empty, then this specific style is disabled and the normal +text font will being used for the given style. + +=item B I + +When font styles are not enabled, or this option is enabled (B, +option B<-is>, the default), bold/blink font styles imply high +intensity foreground/background colours. Disabling this option (B, +option B<+is>) disables this behaviour, the high intensity colours are not +reachable. =item B I @@ -487,6 +765,13 @@ 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]. + +@@RXVT_NAME@@ resets the urgency hint on every focus change. + =item B I B: use visual bell on receipt of a bell character; option B<-vb>. @@ -510,6 +795,24 @@ B to initiate a screen dump to the printer and B or B to include the scrollback as well. +The string will be interpreted as if typed into the shell as-is. + +Example: + + URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) + +This creates a new file in your home directory with the screen contents +every time you hit C. + +=item B I + +Set scrollbar style to B, B, B or B. B is +the author's favourite. + +=item B I + +Set the scrollbar width in pixels. + =item B I B: enable the scrollbar [default]; option B<-sb>. B: @@ -532,32 +835,23 @@ =item B I -B: scroll to bottom when tty receives output; option B<+si>. +B: scroll to bottom when tty receives output; option B<-si>. B: do not scroll to bottom when tty receives output; option -B<-si>. +B<+si>. =item B I -B: scroll with scrollback buffer when tty recieves new lines (and -B is False); option B<+sw>. B: do not scroll -with scrollback buffer when tty recieves new lines; option B<-sw>. +B: scroll with scrollback buffer when tty receives new lines (i.e. +try to show the same lines) and B is False; option +B<-sw>. B: do not scroll with scrollback buffer when tty receives +new lines; option B<+sw>. =item B I -B: scroll to bottom when a non-special key is pressed. Special -keys are those which are intercepted by rxvt for special handling and -are not passed onto the shell; option B<-sk>. B: do not scroll -to bottom when a non-special key is pressed; option B<+sk>. - -=item B I - -If enabled, use B<@@HOTKEY@@->I to toggle to a smaller font -[default B<@@HOTKEY@@-@@SMALLFONT@@>] - -=item B I - -If enabled, use B<@@HOTKEY@@->I to toggle to a bigger font -[default B<@@HOTKEY@@-@@BIGFONT@@>] +B: scroll to bottom when a non-special key is pressed. Special keys +are those which are intercepted by rxvt-unicode for special handling and +are not passed onto the shell; option B<-sk>. B: do not scroll to +bottom when a non-special key is pressed; option B<+sk>. =item B I @@ -577,14 +871,21 @@ =item B I Set MWM hints to request a borderless window, i.e. if honoured by the -WM, the rxvt window will not have window decorations; option B<-bl>. +WM, the rxvt-unicode window will not have window decorations; option B<-bl>. + +=item B I + +Compile I: Disable the usage of the built-in block graphics/line +drawing characters and just rely on what the specified fonts provide. Use +this if you have a good font and want to use its block graphic glyphs; +option B<-sbg>. =item B I Specifies the terminal type name to be set in the B environment variable; option B<-tn>. -=item B I +=item B I Specifies number of lines (pixel height) to insert between each row of the display [default 0]; option B<-lsp>. @@ -599,11 +900,21 @@ B: the mouse wheel scrolls a page full. B: the mouse wheel scrolls five lines [default]. +=item B I + +B: store tabs as wide characters. B: interpret tabs as cursor +movement only; option C<-ptab>. + =item B I B: blink the cursor. B: do not blink the cursor [default]; option B<-bc>. +=item B I + +B: Make the cursor underlined. B: Make the cursor a box [default]; +option B<-uc>. + =item B I B: blank the pointer when a key is pressed or after a set number @@ -620,12 +931,13 @@ =item B I -Specifies number of seconds before blanking the pointer [default 2]. +Specifies number of seconds before blanking the pointer [default 2]. Use a +large number (e.g. C<987654321>) to effectively disable the timeout. =item B I The string to send when the backspace key is pressed. If set to B -or unset it will send B (code 127) or, if shifted, B +or unset it will send B (code 127) or, with control, B (code 8) - which can be reversed with the appropriate DEC private mode escape sequence. @@ -637,10 +949,18 @@ =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. -B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> +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 `"'&()*,;<=>?@[]^{|} >> =item B I