[ViewVC] Diff of: cvs/rxvt-unicode/doc/rxvt.7.man.in

Comparing rxvt-unicode/doc/rxvt.7.man.in (file contents):
Revision 1.47 by root, Mon Jan 16 15:07:27 2006 UTC vs.
Revision 1.56 by root, Tue Jan 31 00:25:16 2006 UTC

 .\}
 .rm #[ #] #H #V #F C
 .\" ========================================================================
 .\"
 .IX Title "rxvt 7"
-.TH rxvt 7 "2006-01-16" "7.0" "RXVT-UNICODE"
+.TH rxvt 7 "2006-01-31" "7.5" "RXVT-UNICODE"
 .SH "NAME"
 RXVT REFERENCE \- FAQ, command sequences and other background information
 .SH "SYNOPSIS"
 .IX Header "SYNOPSIS"
 .Vb 2
 .SH "DESCRIPTION"
 .IX Header "DESCRIPTION"
 This document contains the \s-1FAQ\s0, the \s-1RXVT\s0 \s-1TECHNICAL\s0 \s-1REFERENCE\s0 documenting
 all escape sequences, and other background information.
 .PP
-The newest version of this document is
+The newest version of this document is also available on the World Wide Web at
-also available on the World Wide Web at
 <http://cvs.schmorp.de/browse/*checkout*/rxvt\-unicode/doc/rxvt.7.html>.
 .SH "FREQUENTLY ASKED QUESTIONS"
 .IX Header "FREQUENTLY ASKED QUESTIONS"
 .IP "The new selection selects pieces that are too big, how can I select single words?" 4
 .IX Item "The new selection selects pieces that are too big, how can I select single words?"
 other combination either by setting the \fBsearchable-scrollback\fR resource:
 .Sp
 .Vb 1
 \&   URxvt.searchable-scrollback: CM-s
 .Ve
+.IP "Why doesn't rxvt-unicode read my resources?" 4
+.IX Item "Why doesn't rxvt-unicode read my resources?"
+Well, why, indeed? It does, in a way very similar to other X
+applications. Most importantly, this means that if you or your \s-1OS\s0 loads
+resources into the X display (the right way to do it), rxvt-unicode will
+ignore any resource files in your home directory. It will only read
+\&\fI$HOME/.Xdefaults\fR when no resources are attached to the display.
+.Sp
+If you have or use an \fI$HOME/.Xresources\fR file, chances are that
+resources are loaded into your X\-server. In this case, you have to
+re-login after every change (or run \fIxrdb \-merge \f(CI$HOME\fI/.Xresources\fR).
+.Sp
+Also consider the form resources have to use:
+.Sp
+.Vb 1
+\&  URxvt.resource: value
+.Ve
+.Sp
+If you want to use another form (there are lots of different ways of
+specifying resources), make sure you understand wether and why it
+works. If unsure, use the form above.
+.IP "I can't get transparency working, what am I doing wrong?" 4
+.IX Item "I can't get transparency working, what am I doing wrong?"
+First of all, transparency isn't officially supported in rxvt\-unicode, so
+you are mostly on your own. Do not bug the author about it (but you may
+bug everybody else). Also, if you can't get it working consider it a rite
+of passage: ... and you failed.
+.Sp
+Here are four ways to get transparency. \fBDo\fR read the manpage and option
+descriptions for the programs mentioned and rxvt\-unicode. Really, do it!
+.Sp
+1. Use inheritPixmap:
+.Sp
+.Vb 2
+\&   Esetroot wallpaper.jpg
+\&   @@RXVT_NAME@@ -ip -tint red -sh 40
+.Ve
+.Sp
+That works. If you think it doesn't, you lack transparency and tinting
+support, or you are unable to read.
+.Sp
+2. Use a simple pixmap and emulate pseudo\-transparency. This enables you
+to use effects other than tinting and shading: Just shade/tint/whatever
+your picture with gimp:
+.Sp
+.Vb 2
+\&   convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm
+\&   @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
+.Ve
+.Sp
+That works. If you think it doesn't, you lack \s-1XPM\s0 and Perl support, or you
+are unable to read.
+.Sp
+3. Use an \s-1ARGB\s0 visual:
+.Sp
+.Vb 1
+\&   @@RXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
+.Ve
+.Sp
+This requires \s-1XFT\s0 support, and the support of your X\-server. If that
+doesn't work for you, blame Xorg and Keith Packard. \s-1ARGB\s0 visuals aren't
+there yet, no matter what they claim. Rxvt-Unicode contains the neccessary
+bugfixes and workarounds for Xft and Xlib to make it work, but that
+doesn't mean that your \s-1WM\s0 has the required kludges in place.
+.Sp
+4. Use xcompmgr and let it do the job:
+.Sp
+.Vb 2
+\&  xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \e
+\&        -set _NET_WM_WINDOW_OPACITY 0xc0000000
+.Ve
+.Sp
+Then click on a window you want to make transparent. Replace \f(CW0xc0000000\fR
+by other values to change the degree of opacity. If it doesn't work and
+your server crashes, you got to keep the pieces.
 .IP "Isn't rxvt supposed to be small? Don't all those features bloat?" 4
 .IX Item "Isn't rxvt supposed to be small? Don't all those features bloat?"
 I often get asked about this, and I think, no, they didn't cause extra
 bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
 that the urxvt binary is larger (due to some encoding tables always being
 .Sp
 No large bloated libraries (of course, none were linked in statically),
 except maybe libX11 :)
 .IP "Does it support tabs, can I have a tabbed rxvt\-unicode?" 4
 .IX Item "Does it support tabs, can I have a tabbed rxvt-unicode?"
-rxvt-unicode does not directly support tabs. It will work fine with
+Beginning with version 7.3, there is a perl extension that implements a
-tabbing functionality of many window managers or similar tabbing programs,
+simple tabbed terminal. It is installed by default, so any of these should
-and its embedding-features allow it to be embedded into other programs,
+give you tabs:
-as witnessed by \fIdoc/rxvt\-tabbed\fR or the upcoming \f(CW\*(C`Gtk2::URxvt\*(C'\fR perl
+.Sp
-module, which features a tabbed urxvt (murxvt) terminal as an example
+.Vb 1
-embedding application.
+\&   @@RXVT_NAME@@ -pe tabbed
+.Ve
+.Sp
+.Vb 1
+\&   URxvt.perl-ext-common: default,tabbed
+.Ve
+.Sp
+It will also work fine with tabbing functionality of many window managers
+or similar tabbing programs, and its embedding-features allow it to be
+embedded into other programs, as witnessed by \fIdoc/rxvt\-tabbed\fR or
+the upcoming \f(CW\*(C`Gtk2::URxvt\*(C'\fR perl module, which features a tabbed urxvt
+(murxvt) terminal as an example embedding application.
 .IP "How do I know which rxvt-unicode version I'm using?" 4
 .IX Item "How do I know which rxvt-unicode version I'm using?"
 The version number is displayed with the usage (\-h). Also the escape
 sequence \f(CW\*(C`ESC [ 8 n\*(C'\fR sets the window title to the version number. When
 using the @@RXVT_NAME@@c client, the version displayed is that of the
 daemon.
 .IP "I am using Debian GNU/Linux and have a problem..." 4
 .IX Item "I am using Debian GNU/Linux and have a problem..."
 The Debian GNU/Linux package of rxvt-unicode in sarge contains large
-patches that considerably change the behaviour of rxvt\-unicode. Before
+patches that considerably change the behaviour of rxvt-unicode (but
-reporting a bug to the original rxvt-unicode author please download and
+unfortunately this notice has been removed). Before reporting a bug to
-install the genuine version (<http://software.schmorp.de#rxvt\-unicode>)
+the original rxvt-unicode author please download and install the genuine
-and try to reproduce the problem. If you cannot, chances are that the
+version (<http://software.schmorp.de#rxvt\-unicode>) and try to reproduce
-problems are specific to Debian GNU/Linux, in which case it should be
+the problem. If you cannot, chances are that the problems are specific to
+Debian GNU/Linux, in which case it should be reported via the Debian Bug
-reported via the Debian Bug Tracking System (use \f(CW\*(C`reportbug\*(C'\fR to report
+Tracking System (use \f(CW\*(C`reportbug\*(C'\fR to report the bug).
-the bug).
 .Sp
 For other problems that also affect the Debian package, you can and
 probably should use the Debian \s-1BTS\s0, too, because, after all, it's also a
 bug in the Debian version and it serves as a reminder for other users that
 might encounter the same issue.
 one with \f(CW\*(C`\-\-disable\-everything\*(C'\fR (very useful) and a maximal one with
 \&\f(CW\*(C`\-\-enable\-everything\*(C'\fR (less useful, it will be very big due to a lot of
 encodings built-in that increase download times and are rarely used).
 .IP "I need to make it setuid/setgid to support utmp/ptys on my \s-1OS\s0, is this safe?" 4
 .IX Item "I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?"
-Likely not. While I honestly try to make it secure, and am probably not
+It should be, starting with release 7.1. You are encouraged to properly
-bad at it, I think it is simply unreasonable to expect all of freetype
+install urxvt with privileges necessary for your \s-1OS\s0 now.
-+ fontconfig + xft + xlib + perl + ... + rxvt-unicode itself to all be
-secure. Also, rxvt-unicode disables some options when it detects that it
-runs setuid or setgid, which is not nice. Besides, with the embedded perl
-interpreter the possibility for security problems easily multiplies.
 .Sp
-Elevated privileges are only required for utmp and pty operations on some
+When rxvt-unicode detects that it runs setuid or setgid, it will fork
-systems (for example, GNU/Linux doesn't need any extra privileges for
+into a helper process for privileged operations (pty handling on some
-ptys, but some need it for utmp support). It is planned to mvoe this into
+systems, utmp/wtmp/lastlog handling on others) and drop privileges
-a forked handler process, but this is not yet done.
+immediately. This is much safer than most other terminals that keep
+privileges while running (but is more relevant to urxvt, as it contains
+things as perl interpreters, which might be \*(L"helpful\*(R" to attackers).
 .Sp
-So, while setuid/setgid operation is supported and not a problem on your
+This forking is done as the very first within \fImain()\fR, which is very early
-typical single-user-no-other-logins unix desktop, always remember that
+and reduces possible bugs to initialisation code run before \fImain()\fR, or
-its an awful lot of code, most of which isn't checked for security issues
+things like the dynamic loader of your system, which should result in very
-regularly.
+little risk.
 .IP "When I log-in to another system it tells me about missing terminfo data?" 4
 .IX Item "When I log-in to another system it tells me about missing terminfo data?"
 The terminal description used by rxvt-unicode is not as widely available
 as that for xterm, or even rxvt (for which the same problem often arises).
 .Sp
 .IX Header "RXVT TECHNICAL REFERENCE"
 .SH "DESCRIPTION"
 .IX Header "DESCRIPTION"
 The rest of this document describes various technical aspects of
 \&\fBrxvt-unicode\fR. First the description of supported command sequences,
-followed by menu and pixmap support and last by a description of all
+followed by pixmap support and last by a description of all features
-features selectable at \f(CW\*(C`configure\*(C'\fR time.
+selectable at \f(CW\*(C`configure\*(C'\fR time.
 .SH "Definitions"
 .IX Header "Definitions"
 .ie n .IP "\fB\fB""c""\fB\fR" 4
 .el .IP "\fB\f(CBc\fB\fR" 4
 .IX Item "c"
 Ps = 12	Change colour of text cursor foreground to Pt
 Ps = 13	Change colour of mouse foreground to Pt
 Ps = 17	Change colour of highlight characters to Pt
 Ps = 18	Change colour of bold characters to Pt [deprecated, see 706]
 Ps = 19	Change colour of underlined characters to Pt [deprecated, see 707]
-Ps = 20	Change default background to Pt
+Ps = 20	Change background pixmap parameters (see section XPM) (Compile XPM).
 Ps = 39	Change default foreground colour to Pt.
 Ps = 46	Change Log File to Pt unimplemented
 Ps = 49	Change default background colour to Pt.
 Ps = 50	Set fontset to Pt, with the following special values of Pt (rxvt) #+n change up n #-n change down n if n is missing of 0, a value of 1 is used empty change to font0 n change to font n
 Ps = 55	Log all scrollback buffer and all of screen to Pt
 Ps = 701	Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills).
+Ps = 702	Request version if Pt is ?, returning rxvt-unicode, the resource name, the major and minor version numbers, e.g. ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST.
 Ps = 704	Change colour of italic characters to Pt
 Ps = 705	Change background pixmap tint colour to Pt (Compile transparency).
 Ps = 706	Change colour of bold characters to Pt
 Ps = 707	Change colour of underlined characters to Pt
 Ps = 710	Set normal fontset to Pt. Same as Ps = 50.
 Add support for \s-1XIM\s0 (X Input Method) protocol. This allows using
 alternative input methods (e.g. kinput2) and will also correctly
 set up the input for people using dead keys or compose keys.
 .IP "\-\-enable\-unicode3 (default: off)" 4
 .IX Item "--enable-unicode3 (default: off)"
+Recommended to stay off unless you really need non-BMP characters.
+.Sp
 Enable direct support for displaying unicode codepoints above
 65535 (the basic multilingual page). This increases storage
 requirements per character from 2 to 4 bytes. X11 fonts do not yet
 support these extra characters, but Xft does.
 .Sp
 composite characters. This is required for proper viewing of text
 where accents are encoded as seperate unicode characters. This is
 done by using precomposited characters when available or creating
 new pseudo-characters when no precomposed form exists.
 .Sp
-Without \-\-enable\-unicode3, the number of additional precomposed characters
+Without \-\-enable\-unicode3, the number of additional precomposed
-is rather limited (2048, if this is full, rxvt-unicode will use the
+characters is somewhat limited (the 6400 private use characters will be
-private use area, extending the number of combinations to 8448). With
-\&\-\-enable\-unicode3, no practical limit exists.
+(ab\-)used). With \-\-enable\-unicode3, no practical limit exists.
 .Sp
 This option will also enable storage (but not display) of characters
 beyond plane 0 (>65535) when \-\-enable\-unicode3 was not specified.
 .Sp
 The combining table also contains entries for arabic presentation forms,
 but these are not currently used. Bug me if you want these to be used (and
 tell me how these are to be used...).
 .IP "\-\-enable\-fallback(=CLASS) (default: Rxvt)" 4
 .IX Item "--enable-fallback(=CLASS) (default: Rxvt)"
-When reading resource settings, also read settings for class \s-1CLASS\s0. To disable resource fallback use \-\-disable\-fallback.
+When reading resource settings, also read settings for class \s-1CLASS\s0. To
+disable resource fallback use \-\-disable\-fallback.
 .IP "\-\-with\-res\-name=NAME (default: urxvt)" 4
 .IX Item "--with-res-name=NAME (default: urxvt)"
 Use the given name as default application name when
 reading resources. Specify \-\-with\-res\-name=rxvt to replace rxvt.
 .IP "\-\-with\-res\-class=CLASS /default: URxvt)" 4
 .IP "\-\-enable\-plain\-scroll (default: on)" 4
 .IX Item "--enable-plain-scroll (default: on)"
 Add support for a very unobtrusive, plain-looking scrollbar that
 is the favourite of the rxvt-unicode author, having used it for
 many years.
-.IP "\-\-enable\-half\-shadow (default: off)" 4
-.IX Item "--enable-half-shadow (default: off)"
-Make shadows on the scrollbar only half the normal width & height.
-only applicable to rxvt scrollbars.
 .IP "\-\-enable\-ttygid (default: off)" 4
 .IX Item "--enable-ttygid (default: off)"
 Change tty device setting to group \*(L"tty\*(R" \- only use this if
 your system uses this type of security.
 .IP "\-\-disable\-backspace\-key" 4
 disable this.
 .Sp
 A non-exhaustive list of features enabled by \f(CW\*(C`\-\-enable\-frills\*(C'\fR (possibly
 in combination with other switches) is:
 .Sp
-.Vb 17
+.Vb 15
 \&  MWM-hints
 \&  EWMH-hints (pid, utf8 names) and protocols (ping)
 \&  seperate underline colour (-underlineColor)
 \&  settable border widths and borderless switch (-w, -b, -bl)
+\&  visual depth selection (-depth)
 \&  settable extra linespacing /-lsp)
 \&  iso-14755-2 and -3, and visual feedback
-\&  backindex and forwardindex escape sequence
-\&  window op and some xterm/OSC escape sequences
 \&  tripleclickwords (-tcw)
 \&  settable insecure mode (-insecure)
 \&  keysym remapping support
 \&  cursor blinking and underline cursor (-cb, -uc)
 \&  XEmbed support (-embed)
 \&  user-pty (-pty-fd)
 \&  hold on exit (-hold)
 \&  skip builtin block graphics (-sbg)
+.Ve
+.Sp
+It also enabled some non-essential features otherwise disabled, such as:
+.Sp
+.Vb 11
+\&  some round-trip time optimisations
+\&  nearest color allocation on pseudocolor screens
+\&  UTF8_STRING supporr for selection
 \&  sgr modes 90..97 and 100..107
+\&  backindex and forwardindex escape sequences
+\&  view change/zero scorllback esacpe sequences
+\&  locale switching escape sequence
+\&  window op and some xterm/OSC escape sequences
+\&  rectangular selections
+\&  trailing space removal for selections
+\&  verbose X error handling
 .Ve
 .IP "\-\-enable\-iso14755 (default: on)" 4
 .IX Item "--enable-iso14755 (default: on)"
 Enable extended \s-1ISO\s0 14755 support (see @@RXVT_NAME@@(1), or
 \&\fIdoc/rxvt.1.txt\fR). Basic support (section 5.1) is enabled by
 keys. This should keep the window corner which is closest to a corner of
 the screen in a fixed position.
 .IP "\-\-enable\-pointer\-blank (default: on)" 4
 .IX Item "--enable-pointer-blank (default: on)"
 Add support to have the pointer disappear when typing or inactive.
-.IP "\-\-enable\-perl (default: off)" 4
+.IP "\-\-enable\-perl (default: on)" 4
-.IX Item "--enable-perl (default: off)"
+.IX Item "--enable-perl (default: on)"
 Enable an embedded perl interpreter. See the \fB@@RXVT_NAME@@\f(BIperl\fB\|(3)\fR
 manpage (\fIdoc/rxvtperl.txt\fR) for more info on this feature, or the files
 in \fIsrc/perl\-ext/\fR for the extensions that are installed by default. The
 perl interpreter that is used can be specified via the \f(CW\*(C`PERL\*(C'\fR environment
 variable when running configure.

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing rxvt-unicode/doc/rxvt.7.man.in (file contents): Revision 1.47 by root, Mon Jan 16 15:07:27 2006 UTC vs. Revision 1.56 by root, Tue Jan 31 00:25:16 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.7.man.in (file contents):
Revision 1.47 by root, Mon Jan 16 15:07:27 2006 UTC vs.
Revision 1.56 by root, Tue Jan 31 00:25:16 2006 UTC