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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.105 by root, Tue Jan 31 21:00:26 2006 UTC vs.
Revision 1.116 by root, Wed Feb 22 10:42:49 2006 UTC

 =head3 How can I start @@URXVT_NAME@@d in a race-free way?
 Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the
 display, create the listening socket and then fork.
+=head3 How can I start @@URXVT_NAME@@d automatically when I run URXVT_NAME@@c?
+If you want to start @@URXVT_NAME@@d automatically whenever you run
+@@URXVT_NAME@@c and the daemon isn't running yet, use this script:
+   #!/bin/sh
+   @@URXVT_NAME@@c "$@"
+   if [ $? -eq 2 ]; then
+      @@URXVT_NAME@@d -q -o -f
+      @@URXVT_NAME@@c "$@"
+   fi
+This tries to create a new terminal, and if fails with exit status 2,
+meaning it couldn't connect to the daemon, it will start the daemon and
+re-run the command. Subsequent invocations of the script will re-use the
+existing daemon.
 =head3 How do I distinguish wether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.
 The original rxvt and rxvt-unicode always export the variable "COLORTERM",
 so you can check and see if that is set. Note that several programs, JED,
     text    data     bss     drs     rss filename
    98398    1664      24   15695    1824 rxvt --disable-everything
   188985    9048   66616   18222    1788 urxvt --disable-everything
-When you C<--enable-everything> (which _is_ unfair, as this involves xft
+When you C<--enable-everything> (which I<is> unfair, as this involves xft
 and full locale/XIM support which are quite bloaty inside libX11 and my
 libc), the two diverge, but not unreasnobaly so.
     text    data     bss     drs     rss filename
   163431    2152      24   20123    2060 rxvt --enable-everything
 Then click on a window you want to make transparent. Replace C<0xc0000000>
 by other values to change the degree of opacity. If it doesn't work and
 your server crashes, you got to keep the pieces.
-=head3 Why do some chinese characters look so different than others?
-This is because there is a difference between script and language --
-rxvt-unicode does not know which language the text that is output is,
-as it only knows the unicode character codes. If rxvt-unicode first
-sees a japanese/chinese character, it might choose a japanese font for
-display. Subsequent japanese characters will use that font. Now, many
-chinese characters aren't represented in japanese fonts, so when the first
-non-japanese character comes up, rxvt-unicode will look for a chinese font
--- unfortunately at this point, it will still use the japanese font for
-chinese characters that are also in the japanese font.
-The workaround is easy: just tag a chinese font at the end of your font
-list (see the previous question). The key is to view the font list as
-a preference list: If you expect more japanese, list a japanese font
-first. If you expect more chinese, put a chinese font first.
-In the future it might be possible to switch language preferences at
-runtime (the internal data structure has no problem with using different
-fonts for the same character at the same time, but no interface for this
-has been designed yet).
-Until then, you might get away with switching fonts at runtime (see L<Can
-I switch the fonts at runtime?> later in this document).
 =head3 Why does rxvt-unicode sometimes leave pixel droppings?
 Most fonts were not designed for terminal use, which means that character
 size varies a lot. A font that is otherwise fine for terminal use might
 contain some characters that are simply too wide. Rxvt-unicode will avoid
 =head3 Can I switch the fonts at runtime?
 Yes, using an escape sequence. Try something like this, which has the same
 effect as using the C<-fn> switch, and takes effect immediately:
-   printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
+   printf '\33]50;%s\007' "9x15bold,xft:Kochi Gothic"
 This is useful if you e.g. work primarily with japanese (and prefer a
 japanese font), but you have to switch to chinese temporarily, where
 japanese fonts would only be in your way.
    URxvt.color12:  #0000FF
    URxvt.color13:  #FF00FF
    URxvt.color14:  #00FFFF
    URxvt.color15:  #FFFFFF
-And here is a more complete set of non-standard colors described (not by
+And here is a more complete set of non-standard colors.
-me) as "pretty girly".
    URxvt.cursorColor:  #dc74d1
    URxvt.pointerColor: #dc74d1
    URxvt.background:   #0e0e0e
    URxvt.foreground:   #4ad5e1
    URxvt.color6:       #73f7ff
    URxvt.color14:      #73f7ff
    URxvt.color7:       #e1dddd
    URxvt.color15:      #e1dddd
+They have been described (not by me) as "pretty girly".
 =head3 Why do some characters look so much different than others?
 See next entry.
 =head3 How does rxvt-unicode choose fonts?
 Most fonts do not contain the full range of Unicode, which is
 fine. Chances are that the font you (or the admin/package maintainer of
 your system/os) have specified does not cover all the characters you want
 to display.
 B<rxvt-unicode> makes a best-effort try at finding a replacement
 font. Often the result is fine, but sometimes the chosen font looks
 bad/ugly/wrong. Some fonts have totally strange characters that don't
 resemble the correct glyph at all, and rxvt-unicode lacks the artificial
 intelligence to detect that a specific glyph is wrong: it has to believe
 the font that the characters it claims to contain indeed look correct.
 In that case, select a font of your taste and add it to the font list,
 e.g.:
    @@URXVT_NAME@@ -fn basefont,font2,font3...
 When rxvt-unicode sees a character, it will first look at the base
 font. If the base font does not contain the character, it will go to the
 next font, and so on. Specifying your own fonts will also speed up this
 search and use less resources within rxvt-unicode and the X-server.
 The only limitation is that none of the fonts may be larger than the base
 font, as the base font defines the terminal character cell size, which
 must be the same due to the way terminals work.
+=head3 Why do some chinese characters look so different than others?
+This is because there is a difference between script and language --
+rxvt-unicode does not know which language the text that is output is,
+as it only knows the unicode character codes. If rxvt-unicode first
+sees a japanese/chinese character, it might choose a japanese font for
+display. Subsequent japanese characters will use that font. Now, many
+chinese characters aren't represented in japanese fonts, so when the first
+non-japanese character comes up, rxvt-unicode will look for a chinese font
+-- unfortunately at this point, it will still use the japanese font for
+chinese characters that are also in the japanese font.
+The workaround is easy: just tag a chinese font at the end of your font
+list (see the previous question). The key is to view the font list as
+a preference list: If you expect more japanese, list a japanese font
+first. If you expect more chinese, put a chinese font first.
+In the future it might be possible to switch language preferences at
+runtime (the internal data structure has no problem with using different
+fonts for the same character at the same time, but no interface for this
+has been designed yet).
+Until then, you might get away with switching fonts at runtime (see L<Can
+I switch the fonts at runtime?> later in this document).
 =head2 Keyboard, Mouse & User Interaction
 =head3 The new selection selects pieces that are too big, how can I select single words?
 =head2 Terminal Configuration
+=head3 Can I see a typical configuration?
+The default configuration tries to be xterm-like, which I don't like that
+much, but it's least surprise to regular users.
+As a rxvt or rxvt-unicode user, you are practically supposed to invest
+time into customising your terminal. To get you started, here is the
+author's .Xdefaults entries, with comments on what they do. It's certainly
+not I<typical>, but what's typical...
+   URxvt.cutchars: "()*,<>[]{}|'
+   URxvt.print-pipe: cat >/tmp/xxx
+These are just for testing stuff.
+   URxvt.imLocale: ja_JP.UTF-8
+   URxvt.preeditType: OnTheSpot,None
+This tells rxvt-unicode to use a special locale when communicating with
+the X Input Method, and also tells it to only use the OnTheSpot pre-edit
+type, which requires the C<xim-onthespot> perl extension but rewards me
+with correct-looking fonts.
+   URxvt.perl-lib: /root/lib/urxvt
+   URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard
+   URxvt.selection.pattern-0: ( at .*? line \\d+)
+   URxvt.selection.pattern-1: ^(/[^:]+):\
+   URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
+   URxvt.selection-autotransform.1: s/^ at (.*?) line (\\d+)$/:e \\Q$1\\E\\x0d:$2\\x0d/
+This is my perl configuration. The first two set the perl library
+directory and also tells urxvt to use a large number of extensions. I
+develop for myself mostly, so I actually use most of the extensions I
+write.
+The selection stuff mainly makes the selection perl-error-message aware
+and tells it to convert pelr error mssages into vi-commands to load the
+relevant file and go tot he error line number.
+   URxvt.scrollstyle:      plain
+   URxvt.secondaryScroll:  true
+As the documentation says: plain is the preferred scrollbar for the
+author. The C<secondaryScroll> confgiures urxvt to scroll in full-screen
+apps, like screen, so lines scorlled out of screen end up in urxvt's
+scrollback buffer.
+   URxvt.background:       #000000
+   URxvt.foreground:       gray90
+   URxvt.color7:           gray90
+   URxvt.colorBD:          #ffffff
+   URxvt.cursorColor:      #e0e080
+   URxvt.throughColor:     #8080f0
+   URxvt.highlightColor:   #f0f0f0
+Some colours. Not sure which ones are being used or even non-defaults, but
+these are in my .Xdefaults. Most notably, they set foreground/background
+to light gray/black, and also make sure that the colour 7 matches the
+default foreground colour.
+   URxvt.underlineColor:   yellow
+Another colour, makes underline lines look different. Sometimes hurts, but
+is mostly a nice effect.
+   URxvt.geometry:         154x36
+   URxvt.loginShell:       false
+   URxvt.meta:             ignore
+   URxvt.utmpInhibit:      true
+Uh, well, should be mostly self-explanatory. By specifying some defaults
+manually, I can quickly switch them for testing.
+   URxvt.saveLines:        8192
+A large scrollback buffer is essential. Really.
+   URxvt.mapAlert:         true
+The only case I use it is for my IRC window, which I like to keep
+iconified till people msg me (which beeps).
+   URxvt.visualBell:       true
+The audible bell is often annoying, especially when in a crowd.
+   URxvt.insecure:         true
+Please don't hack my mutt! Ooops...
+   URxvt.pastableTabs:     false
+I once thought this is a great idea.
+   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, \
+                           xft:Bitstream Vera Sans Mono:autohint=true, \
+                           xft:Code2000:antialias=false
+   urxvt.boldFont:         -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
+   urxvt.italicFont:       xft:Bitstream Vera Sans Mono:italic:autohint=true
+   urxvt.boldItalicFont:   xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
+I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
+overwhelmed. A special note: the C<9x15bold> mentioend above is actually
+the version from XFree-3.3, as XFree-4 replaced it by a totally different
+font (different glyphs for C<;> and many other harmless characters),
+while the second font is actually the C<9x15bold> from XFree4/XOrg. The
+bold version has less chars than the medium version, so I use it for rare
+characters, too. Whene ditign sources with vim, I use italic for comments
+and other stuff, which looks quite good with Bitstream Vera anti-aliased.
+Terminus is a quite bad font (many very wrong glyphs), but for most of my
+purposes, it works, and gives a different look, as my normal (Non-bold)
+font is already bold, and I want to see a difference between bold and
+normal fonts.
+Please note that I used the C<urxvt> instance name and not the C<URxvt>
+class name. Thats because I use different configs for different purposes,
+for example, my IRC window is started with C<-name IRC>, and uses these
+defaults:
+   IRC*title:              IRC
+   IRC*geometry:           87x12+535+542
+   IRC*saveLines:          0
+   IRC*mapAlert:           true
+   IRC*font:               suxuseuro
+   IRC*boldFont:           suxuseuro
+   IRC*colorBD:            white
+   IRC*keysym.M-C-1:       command:\033]710;suxuseuro\007\033]711;suxuseuro\007
+   IRC*keysym.M-C-2:       command:\033]710;9x15bold\007\033]711;9x15bold\007
+C<Alt-Shift-1> and C<Alt-Shift-2> switch between two different font
+sizes. C<suxuseuro> allows me to keep an eye (and actually read)
+stuff while keeping a very small window. If somebody pastes something
+complicated (e.g. japanese), I temporarily switch to a larger font.
+The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
+C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname>
+file for different hosts, for example, on ym main desktop, I use:
+   URxvt.keysym.C-M-q: command:\033[3;5;5t
+   URxvt.keysym.C-M-y: command:\033[3;5;606t
+   URxvt.keysym.C-M-e: command:\033[3;1605;5t
+   URxvt.keysym.C-M-c: command:\033[3;1605;606t
+   URxvt.keysym.C-M-p: perl:test
+The first for keysym definitions allow me to quickly bring some windows
+in the layout I like most. Ion users might start laughing but will stop
+immediately when I tell them that I use my own Fvwm2 module for much the
+same effect as Ion provides, and I only very rarely use the above key
+combinations :->
 =head3 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 OS loads
 resources into the X display (the right way to do it), rxvt-unicode will
 something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work.
 The best thing is to fix your startup environment, as you will likely run
 into other problems. If nothing works you can try this in your .profile.
-  printf '\e]701;%s\007' "$LC_CTYPE"
+  printf '\33]701;%s\007' "$LC_CTYPE"
 If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
 supported on your systems. Some systems have a C<locale> command which
 displays this (also, C<perl -e0> can be used to check locale settings, as
 it will complain loudly if it cannot set the locale). If it displays something
 =head3 Can I switch locales at runtime?
 Yes, using an escape sequence. Try something like this, which sets
 rxvt-unicode's idea of C<LC_CTYPE>.
-  printf '\e]701;%s\007' ja_JP.SJIS
+  printf '\33]701;%s\007' ja_JP.SJIS
 See also the previous answer.
 Sometimes this capability is rather handy when you want to work in
 one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
 (e.g. UTF-8). For example, I use this script to start C<xjdic>, which
 first switches to a locale supported by xjdic and back later:
-   printf '\e]701;%s\007' ja_JP.SJIS
+   printf '\33]701;%s\007' ja_JP.SJIS
    xjdic -js
-   printf '\e]701;%s\007' de_DE.UTF-8
+   printf '\33]701;%s\007' de_DE.UTF-8
 You can also use xterm's C<luit> program, which usually works fine, except
 for some locales where character width differs between program- and
 rxvt-unicode-locales.
+=head3 I have problems getting my input method working.
+Try a search engine, as this is slightly different for every input method server.
+Here is a checklist:
+=over 4
+=item - Make sure your locale I<and> the imLocale are supported on your OS.
+Try C<locale -a> or check the documentation for your OS.
+=item - Make sure your locale or imLocale matches a locale supported by your XIM.
+For example, B<kinput2> does not support UTF-8 locales, you should use
+C<ja_JP.EUC-JP> or equivalent.
+=item - Make sure your XIM server is actually running.
+=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
+When you want to use e.g. B<kinput2>, it must be set to
+C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. Youc an see what input
+method servers are running with this command:
+   xprop -root XIM_SERVERS
+=item
+=back
 =head3 My input method wants <some encoding> but I want UTF-8, what can I do?
 You can specify separate locales for the input method and the rest of the
 terminal, using the resource C<imlocale>:
    URxvt.imlocale: ja_JP.EUC-JP
 Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
-use your input method. Please note, however, that you will not be able to
+use your input method. Please note, however, that, depending on your Xlib
-input characters outside C<EUC-JP> in a normal way then, as your input
+version, you may not be able to input characters outside C<EUC-JP> in a
-method limits you.
+normal way then, as your input method limits you.
 =head3 Rxvt-unicode crashes when the X Input Method changes or exits.
 Unfortunately, this is unavoidable, as the XIM protocol is racy by
 design. Applications can avoid some crashes at the expense of memory
 encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
 to 8-bit encodings.
 =head1 RXVT-UNICODE TECHNICAL REFERENCE
-=head1 DESCRIPTION
 The rest of this document describes various technical aspects of
 B<rxvt-unicode>. First the description of supported command sequences,
 followed by pixmap support and last by a description of all features
 selectable at C<configure> time.
-=head1 Definitions
+=head2 Definitions
 =over 4
 =item B<< C<c> >>
 A text parameter composed of printable characters.
 =back
-=head1 Values
+=head2 Values
 =over 4
 =item B<< C<ENQ> >>
 Space Character
 =back
-=head1 Escape Sequences
+=head2 Escape Sequences
 =over 4
 =item B<< C<ESC # 8> >>
 =back
 X<CSI>
-=head1 CSI (Command Sequence Introducer) Sequences
+=head2 CSI (Command Sequence Introducer) Sequences
 =over 4
 =item B<< C<ESC [ Ps @> >>
 =back
 X<PrivateModes>
-=head1 DEC Private Modes
+=head2 DEC Private Modes
 =over 4
 =item B<< C<ESC [ ? Pm h> >>
 =back
 X<XTerm>
-=head1 XTerm Operating System Commands
+=head2 XTerm Operating System Commands
 =over 4
 =item B<< C<ESC ] Ps;Pt ST> >>
 	B<< C<Ps = 777> >>	Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
 =end table
 =back
-X<XPM>
 =head1 XPM
 For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
 of B<< C<Pt> >> can be the name of the background pixmap followed by a
 Remove support for mouse selection style like that of xterm.
 =item --enable-dmalloc (default: off)
 Use Gray Watson's malloc - which is good for debugging See
-http://www.letters.com/dmalloc/ for details If you use either this or the
+L<http://www.letters.com/dmalloc/> for details If you use either this or the
 next option, you may need to edit src/Makefile after compiling to point
 DINCLUDE and DLIB to the right places.
 You can only use either this option and the following (should
 you use either) .

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents): Revision 1.105 by root, Tue Jan 31 21:00:26 2006 UTC vs. Revision 1.116 by root, Wed Feb 22 10:42:49 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.105 by root, Tue Jan 31 21:00:26 2006 UTC vs.
Revision 1.116 by root, Wed Feb 22 10:42:49 2006 UTC