--- rxvt-unicode/doc/rxvt.1.pod 2006/01/02 19:36:07 1.77 +++ rxvt-unicode/doc/rxvt.1.pod 2015/06/16 11:58:26 1.244 @@ -14,12 +14,15 @@ configurability. As a result, B uses much less swap space -- a significant advantage on a machine serving many X sessions. +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. +L. =head1 RXVT-UNICODE VS. RXVT @@ -28,40 +31,40 @@ 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 devenagari. Don't expect pretty output when using these +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 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 -- +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 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 @@ -91,9 +94,25 @@ =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) instead of the default, and also allocate a private +colormap. All visual types except for DirectColor are supported. =item B<-geometry> I @@ -105,12 +124,11 @@ =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> | B<-tr>|B<+tr> +=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 @@ -121,23 +139,13 @@ =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 +=item B<-icon> I -Tint the transparent background pixmap with the given colour when -transparency is enabled with B<-tr> or B<-ip>. This only works for -non-tiled backgrounds, currently. See also the B<-sh> option that can be -used to brighten or darken the image in addition to tinting it; resource -I. Example: - - @@RXVT_NAME@@ -tr -tint blue -sh 40 - -=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, e.g. C<-tint white>). +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 @@ -147,13 +155,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 C<;> in the -command-line; resource B. - =item B<-cr> I The cursor colour; resource B. @@ -174,12 +175,12 @@ =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. -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.: @@ -191,22 +192,23 @@ =item B<-fb> I -Compile font-styles: The bold font list to use when bold characters are to -be printed. See resource B for details. +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 font-styles: The italic font list to use when bold characters are to -be printed. See resource B for details. +Compile I: The italic font list to use when I +characters are to be printed. See resource B for details. =item B<-fbi> I -Compile font-styles: The bold italic font list to use when bold characters are to -be printed. See resource B for details. +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 font-styles: Bold/Italic font styles imply high intensity +Compile I: Bold/Blink font styles imply high intensity foreground/background (default). See resource B for details. @@ -220,6 +222,10 @@ Start as a login-shell/sub-shell; resource B. +=item B<-mc> I + +Specify the maximum time between multi-click selections. + =item B<-ut>|B<+ut> Compile I: Inhibit/enable writing a utmp entry; resource @@ -234,6 +240,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 @@ -250,15 +265,6 @@ This only takes effect if B<-si> is also given; 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<-ptab>|B<+ptab> If enabled (default), "Horizontal Tab" characters are being stored as @@ -271,6 +277,10 @@ 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. @@ -296,13 +306,38 @@ Compile I: Set MWM hints to request a borderless window, i.e. if honoured by the WM, the rxvt-unicode window will not have window -decorations; resource B. +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<-dockapp> + +Sets the initial state of the window to WithdrawnState, which makes +window managers that support this extension treat it as a dockapp. + +=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. Useful to work around font rendering problems; resource -B. +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 @@ -347,6 +382,9 @@ Compile I: input style for input method; B, B, B; resource B. +If the perl extension C is used (which is the default), +then additionally the C preedit type is available. + =item B<-im> I Compile I: input method name. resource B. @@ -366,8 +404,9 @@ =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 -end of the logical line only. resource B. +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> @@ -398,13 +437,32 @@ 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 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 @@ -417,7 +475,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 @@ -429,10 +487,10 @@ system "@@RXVT_NAME@@ -embed $xid &"; }); -=item B<-pty-fd> I +=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. @@ -440,6 +498,10 @@ 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): @@ -455,49 +517,56 @@ my $slave = $pty->slave; while (<$slave>) { print $slave "got <$_>\n" } -=item B<-perl> I +=item B<-pe> I -Used by perl extension. See resource B. +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. @@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 - 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults - 4. SCREEN_RESOURCES for the current screen +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 -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 + +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]; @@ -520,7 +589,7 @@ 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)). @@ -541,16 +610,21 @@ Use the specified colour to display underlined characters when the foreground colour is the default. -=item B I - -Use the specified colour as the background for reverse video -characters. - =item B I If set, use the specified colour as the colour for the underline itself. If unset, use the foreground colour. +=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 Use the specified colour for the cursor. The default is to use the @@ -566,19 +640,29 @@ 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 @@ -589,15 +673,9 @@ Fade to this colour, when fading is used (see B). The default colour is black; option B<-fadecolor>. -=item B I - -Tint the transparent background pixmap with the given colour; option -B<-tint>. +=item B I -=item B I - -Darken (0 .. 100) or lighten (-1 .. -100) the transparent background -image in addition to tinting it. +Set the application icon pixmap; option B<-icon>. =item B I @@ -613,37 +691,13 @@ The colour of the border around the text area and between the scrollbar and the text. -=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. - -=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 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. @@ -655,7 +709,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, \ @@ -668,7 +722,7 @@ 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 less characters, so this is a +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 @@ -702,22 +756,11 @@ =item B I 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, +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 - -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. - -=item B I - -Set scrollbar style to B, B, B or B. B is -the author's favourite. - =item B I Set window title string, the default title is the command-line @@ -735,6 +778,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>. @@ -746,6 +796,11 @@ the shell; option B<-ls>. B: start as a normal sub-shell [default]; option B<+ls>. +=item B I + +Specify the maximum time in milliseconds between multi-click select +events. The default is 500 milliseconds; option B<-mc>. + =item B I B: inhibit writing record into the system log file B; @@ -762,10 +817,19 @@ 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. +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 @@ -795,9 +859,10 @@ =item B I -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>. +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 @@ -826,12 +891,19 @@ Set MWM hints to request a borderless window, i.e. if honoured by the 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>. @@ -856,6 +928,11 @@ 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 @@ -870,6 +947,12 @@ Mouse pointer background colour. +=item B I + +Compile I: Specifies the name of the mouse pointer shape +[default B]. See the macros in the B include +file for possible values (omit the C prefix). + =item B I Specifies number of seconds before blanking the pointer [default 2]. Use a @@ -878,7 +961,7 @@ =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. @@ -890,14 +973,22 @@ =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 `"'&()*,;<=>?@[]{|} >> +B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> =item B I