ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.pod
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.177 by root, Sat May 30 08:53:48 2009 UTC vs.
Revision 1.191 by sf-exg, Wed Aug 18 22:48:08 2010 UTC

105This tries to create a new terminal, and if fails with exit status 2, 105This tries to create a new terminal, and if fails with exit status 2,
106meaning it couldn't connect to the daemon, it will start the daemon and 106meaning it couldn't connect to the daemon, it will start the daemon and
107re-run the command. Subsequent invocations of the script will re-use the 107re-run the command. Subsequent invocations of the script will re-use the
108existing daemon. 108existing daemon.
109 109
110=head3 How do I distinguish whether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc. 110=head3 How do I distinguish whether I'm running rxvt-unicode or a regular
111xterm? I need this to decide about setting colours etc.
111 112
112The original rxvt and rxvt-unicode always export the variable "COLORTERM", 113The original rxvt and rxvt-unicode always export the variable "COLORTERM",
113so you can check and see if that is set. Note that several programs, JED, 114so you can check and see if that is set. Note that several programs, JED,
114slrn, Midnight Commander automatically check this variable to decide 115slrn, Midnight Commander automatically check this variable to decide
115whether or not to use color. 116whether or not to use colour.
116 117
117=head3 How do I set the correct, full IP address for the DISPLAY variable? 118=head3 How do I set the correct, full IP address for the DISPLAY variable?
118 119
119If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled 120If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
120insecure mode then it is possible to use the following shell script 121insecure mode then it is possible to use the following shell script
361For the standard background colour, blinking will actually make 362For the standard background colour, blinking will actually make
362the text blink when compiled with C<--enable-text-blink>. Without 363the text blink when compiled with C<--enable-text-blink>. Without
363C<--enable-text-blink>, the blink attribute will be ignored. 364C<--enable-text-blink>, the blink attribute will be ignored.
364 365
365On ANSI colours, bold/blink attributes are used to set high-intensity 366On ANSI colours, bold/blink attributes are used to set high-intensity
366foreground/background colors. 367foreground/background colours.
367 368
368color0-7 are the low-intensity colors. 369color0-7 are the low-intensity colours.
369 370
370color8-15 are the corresponding high-intensity colors. 371color8-15 are the corresponding high-intensity colours.
371 372
372=head3 I don't like the screen colors. How do I change them? 373=head3 I don't like the screen colours. How do I change them?
373 374
374You can change the screen colors at run-time using F<~/.Xdefaults> 375You can change the screen colours at run-time using F<~/.Xdefaults>
375resources (or as long-options). 376resources (or as long-options).
376 377
377Here are values that are supposed to resemble a VGA screen, 378Here are values that are supposed to resemble a VGA screen,
378including the murky brown that passes for low-intensity yellow: 379including the murky brown that passes for low-intensity yellow:
379 380
393 URxvt.color12: #0000FF 394 URxvt.color12: #0000FF
394 URxvt.color13: #FF00FF 395 URxvt.color13: #FF00FF
395 URxvt.color14: #00FFFF 396 URxvt.color14: #00FFFF
396 URxvt.color15: #FFFFFF 397 URxvt.color15: #FFFFFF
397 398
398And here is a more complete set of non-standard colors. 399And here is a more complete set of non-standard colours.
399 400
400 URxvt.cursorColor: #dc74d1 401 URxvt.cursorColor: #dc74d1
401 URxvt.pointerColor: #dc74d1 402 URxvt.pointerColor: #dc74d1
402 URxvt.background: #0e0e0e 403 URxvt.background: #0e0e0e
403 URxvt.foreground: #4ad5e1 404 URxvt.foreground: #4ad5e1
557does not support this (for instance because it is not visual), then 558does not support this (for instance because it is not visual), then
558rxvt-unicode will continue without an input method. 559rxvt-unicode will continue without an input method.
559 560
560In this case either do not specify a B<preeditStyle> or specify more than 561In this case either do not specify a B<preeditStyle> or specify more than
561one pre-edit style, such as B<OverTheSpot,Root,None>. 562one pre-edit style, such as B<OverTheSpot,Root,None>.
563
564If it still doesn't work, then maybe your input method doesn't support
565compose sequences - to fall back to the built-in one, make sure you don't
566specify an input method via C<-im> or C<XMODIFIERS>.
562 567
563=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755 568=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
564 569
565Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on 570Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
566international keyboards) or simply use ISO 14755 support to your 571international keyboards) or simply use ISO 14755 support to your
714develop for myself mostly, so I actually use most of the extensions I 719develop for myself mostly, so I actually use most of the extensions I
715write. 720write.
716 721
717The selection stuff mainly makes the selection perl-error-message aware 722The selection stuff mainly makes the selection perl-error-message aware
718and tells it to convert perl error messages into vi-commands to load the 723and tells it to convert perl error messages into vi-commands to load the
719relevant file and go tot he error line number. 724relevant file and go to the error line number.
720 725
721 URxvt.scrollstyle: plain 726 URxvt.scrollstyle: plain
722 URxvt.secondaryScroll: true 727 URxvt.secondaryScroll: true
723 728
724As the documentation says: plain is the preferred scrollbar for the 729As the documentation says: plain is the preferred scrollbar for the
796purposes, it works, and gives a different look, as my normal (Non-bold) 801purposes, it works, and gives a different look, as my normal (Non-bold)
797font is already bold, and I want to see a difference between bold and 802font is already bold, and I want to see a difference between bold and
798normal fonts. 803normal fonts.
799 804
800Please note that I used the C<urxvt> instance name and not the C<URxvt> 805Please note that I used the C<urxvt> instance name and not the C<URxvt>
801class name. Thats because I use different configs for different purposes, 806class name. That is because I use different configs for different purposes,
802for example, my IRC window is started with C<-name IRC>, and uses these 807for example, my IRC window is started with C<-name IRC>, and uses these
803defaults: 808defaults:
804 809
805 IRC*title: IRC 810 IRC*title: IRC
806 IRC*geometry: 87x12+535+542 811 IRC*geometry: 87x12+535+542
817stuff while keeping a very small window. If somebody pastes something 822stuff while keeping a very small window. If somebody pastes something
818complicated (e.g. japanese), I temporarily switch to a larger font. 823complicated (e.g. japanese), I temporarily switch to a larger font.
819 824
820The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor 825The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
821C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname> 826C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname>
822file for different hosts, for example, on ym main desktop, I use: 827file for different hosts, for example, on my main desktop, I use:
823 828
824 URxvt.keysym.C-M-q: command:\033[3;5;5t 829 URxvt.keysym.C-M-q: command:\033[3;5;5t
825 URxvt.keysym.C-M-y: command:\033[3;5;606t 830 URxvt.keysym.C-M-y: command:\033[3;5;606t
826 URxvt.keysym.C-M-e: command:\033[3;1605;5t 831 URxvt.keysym.C-M-e: command:\033[3;1605;5t
827 URxvt.keysym.C-M-c: command:\033[3;1605;606t 832 URxvt.keysym.C-M-c: command:\033[3;1605;606t
1129runtime-switchable, too, so there is usually no drawback to enabling them, 1134runtime-switchable, too, so there is usually no drawback to enabling them,
1130except higher disk and possibly memory usage. The perl interpreter should 1135except higher disk and possibly memory usage. The perl interpreter should
1131be enabled, as important functionality (menus, selection, likely more in 1136be enabled, as important functionality (menus, selection, likely more in
1132the future) depends on it. 1137the future) depends on it.
1133 1138
1134You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources 1139You should not overwrite the C<perl-ext-common> and C<perl-ext> resources
1135system-wide (except maybe with C<defaults>). This will result in useful 1140system-wide (except maybe with C<defaults>). This will result in useful
1136behaviour. If your distribution aims at low memory, add an empty 1141behaviour. If your distribution aims at low memory, add an empty
1137C<perl-ext-common> resource to the app-defaults file. This will keep the 1142C<perl-ext-common> resource to the app-defaults file. This will keep the
1138perl interpreter disabled until the user enables it. 1143perl interpreter disabled until the user enables it.
1139 1144
1215The solution is to upgrade your system or switch to a better one. A 1220The solution is to upgrade your system or switch to a better one. A
1216possibly working workaround is to use a wcwidth implementation like 1221possibly working workaround is to use a wcwidth implementation like
1217 1222
1218http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c 1223http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
1219 1224
1220=head3 I want 256 colors
1221
1222Are you sure you need 256 colors? 88 colors should be enough for most
1223purposes. If you really need more, there is an unsupported patch for
1224it in the doc directory, but please do not ask for it to be applied.
1225
1226=head1 RXVT-UNICODE TECHNICAL REFERENCE 1225=head1 RXVT-UNICODE TECHNICAL REFERENCE
1227 1226
1228The rest of this document describes various technical aspects of 1227The rest of this document describes various technical aspects of
1229B<rxvt-unicode>. First the description of supported command sequences, 1228B<rxvt-unicode>. First the description of supported command sequences,
1230followed by pixmap support and last by a description of all features 1229followed by pixmap support and last by a description of all features
1329 1328
1330=item B<< C<ESC => >> 1329=item B<< C<ESC => >>
1331 1330
1332Application Keypad (SMKX). See also next sequence. 1331Application Keypad (SMKX). See also next sequence.
1333 1332
1334=item B<<< C<< ESC >> >>> 1333=item B<<< C<< ESC > >> >>>
1335 1334
1336Normal Keypad (RMKX) 1335Normal Keypad (RMKX)
1337 1336
1338B<Note:> If the numeric keypad is activated, eg, B<Num_Lock> has been 1337B<Note:> If the numeric keypad is activated, eg, B<Num_Lock> has been
1339pressed, numbers or control functions are generated by the numeric keypad 1338pressed, numbers or control functions are generated by the numeric keypad
1625 B<< C<Ps = 32 / 42> >> fg/bg Green 1624 B<< C<Ps = 32 / 42> >> fg/bg Green
1626 B<< C<Ps = 33 / 43> >> fg/bg Yellow 1625 B<< C<Ps = 33 / 43> >> fg/bg Yellow
1627 B<< C<Ps = 34 / 44> >> fg/bg Blue 1626 B<< C<Ps = 34 / 44> >> fg/bg Blue
1628 B<< C<Ps = 35 / 45> >> fg/bg Magenta 1627 B<< C<Ps = 35 / 45> >> fg/bg Magenta
1629 B<< C<Ps = 36 / 46> >> fg/bg Cyan 1628 B<< C<Ps = 36 / 46> >> fg/bg Cyan
1630 B<< C<Ps = 38;5 / 48;5> >> set fg/bg to color #m (ISO 8613-6) 1629 B<< C<Ps = 38;5 / 48;5> >> set fg/bg to colour #m (ISO 8613-6)
1631 B<< C<Ps = 37 / 47> >> fg/bg White 1630 B<< C<Ps = 37 / 47> >> fg/bg White
1632 B<< C<Ps = 39 / 49> >> fg/bg Default 1631 B<< C<Ps = 39 / 49> >> fg/bg Default
1633 B<< C<Ps = 90 / 100> >> fg/bg Bright Black 1632 B<< C<Ps = 90 / 100> >> fg/bg Bright Black
1634 B<< C<Ps = 91 / 101> >> fg/bg Bright Red 1633 B<< C<Ps = 91 / 101> >> fg/bg Bright Red
1635 B<< C<Ps = 92 / 102> >> fg/bg Bright Green 1634 B<< C<Ps = 92 / 102> >> fg/bg Bright Green
1881 1880
1882=item B<< C<Pm = 66> >> 1881=item B<< C<Pm = 66> >>
1883 1882
1884=begin table 1883=begin table
1885 1884
1886 B<< C<h> >> Application Keypad (DECPAM) == C<ESC => 1885 B<< C<h> >> Application Keypad (DECKPAM/DECPAM) == C<ESC =>
1887 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> 1886 B<< C<l> >> Normal Keypad (DECKPNM/DECPNM) == C<< ESC > >>
1888 1887
1889=end table 1888=end table
1890 1889
1891=item B<< C<Pm = 67> >> 1890=item B<< C<Pm = 67> >>
1892 1891
2021 B<< C<Ps = 4> >> B<< C<Pt> >> is a semi-colon separated sequence of one or more semi-colon separated B<number>/B<name> pairs, where B<number> is an index to a colour and B<name> is the name of a colour. Each pair causes the B<number>ed colour to be changed to B<name>. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white 2020 B<< C<Ps = 4> >> B<< C<Pt> >> is a semi-colon separated sequence of one or more semi-colon separated B<number>/B<name> pairs, where B<number> is an index to a colour and B<name> is the name of a colour. Each pair causes the B<number>ed colour to be changed to B<name>. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white
2022 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> 2021 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >>
2023 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> 2022 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >>
2024 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 2023 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
2025 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 2024 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
2026 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 2025 B<< C<Ps = 17> >> Change background colour of highlight characters to B<< C<Pt> >>
2027 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706] 2026 B<< C<Ps = 19> >> Change foreground colour of highlight characters to B<< C<Pt> >>
2028 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
2029 B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile AfterImage). 2027 B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile AfterImage).
2030 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. [deprecated, use 10] 2028 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. [deprecated, use 10]
2031 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 2029 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
2032 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. [deprecated, use 11] 2030 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. [deprecated, use 11]
2033 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >> 2031 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >>
2255 2253
2256=over 4 2254=over 4
2257 2255
2258=item --enable-everything 2256=item --enable-everything
2259 2257
2260Add (or remove) support for all non-multichoice options listed in "./configure 2258Add (or remove) support for all non-multichoice options listed
2261--help". 2259in C<./configure --help>, except for C<--enable-assert> and
2260C<--enable-256-color>.
2262 2261
2263You can specify this and then disable options you do not like by 2262You can specify this and then disable options you do not like by
2264I<following> this with the appropriate C<--disable-...> arguments, 2263I<following> this with the appropriate C<--disable-...> arguments,
2265or you can start with a minimal configuration by specifying 2264or you can start with a minimal configuration by specifying
2266C<--disable-everything> and than adding just the C<--enable-...> arguments 2265C<--disable-everything> and than adding just the C<--enable-...> arguments
2321 2320
2322=item --enable-combining (default: on) 2321=item --enable-combining (default: on)
2323 2322
2324Enable automatic composition of combining characters into 2323Enable automatic composition of combining characters into
2325composite characters. This is required for proper viewing of text 2324composite characters. This is required for proper viewing of text
2326where accents are encoded as seperate unicode characters. This is 2325where accents are encoded as separate unicode characters. This is
2327done by using precomposited characters when available or creating 2326done by using precomposited characters when available or creating
2328new pseudo-characters when no precomposed form exists. 2327new pseudo-characters when no precomposed form exists.
2329 2328
2330Without --enable-unicode3, the number of additional precomposed 2329Without --enable-unicode3, the number of additional precomposed
2331characters is somewhat limited (the 6400 private use characters will be 2330characters is somewhat limited (the 6400 private use characters will be
2433in combination with other switches) is: 2432in combination with other switches) is:
2434 2433
2435 MWM-hints 2434 MWM-hints
2436 EWMH-hints (pid, utf8 names) and protocols (ping) 2435 EWMH-hints (pid, utf8 names) and protocols (ping)
2437 urgency hint 2436 urgency hint
2438 seperate underline colour (-underlineColor) 2437 separate underline colour (-underlineColor)
2439 settable border widths and borderless switch (-w, -b, -bl) 2438 settable border widths and borderless switch (-w, -b, -bl)
2440 visual depth selection (-depth) 2439 visual depth selection (-depth)
2441 settable extra linespacing /-lsp) 2440 settable extra linespacing (-lsp)
2442 iso-14755 5.1 (basic) support 2441 iso-14755 5.1 (basic) support
2443 tripleclickwords (-tcw) 2442 tripleclickwords (-tcw)
2444 settable insecure mode (-insecure) 2443 settable insecure mode (-insecure)
2445 keysym remapping support 2444 keysym remapping support
2446 cursor blinking and underline cursor (-bc, -uc) 2445 cursor blinking and underline cursor (-bc, -uc)
2447 XEmbed support (-embed) 2446 XEmbed support (-embed)
2448 user-pty (-pty-fd) 2447 user-pty (-pty-fd)
2449 hold on exit (-hold) 2448 hold on exit (-hold)
2450 compile in built-in block graphics 2449 compile in built-in block graphics
2451 skip builtin block graphics (-sbg) 2450 skip builtin block graphics (-sbg)
2452 separate highlightcolor support (-hc) 2451 separate highlight colour (-highlightColor, -highlightTextColor)
2453 2452
2454It also enables some non-essential features otherwise disabled, such as: 2453It also enables some non-essential features otherwise disabled, such as:
2455 2454
2456 some round-trip time optimisations 2455 some round-trip time optimisations
2457 nearest color allocation on pseudocolor screens 2456 nearest colour allocation on pseudocolor screens
2458 UTF8_STRING support for selection 2457 UTF8_STRING support for selection
2459 sgr modes 90..97 and 100..107 2458 sgr modes 90..97 and 100..107
2460 backindex and forwardindex escape sequences 2459 backindex and forwardindex escape sequences
2461 view change/zero scrollback escape sequences 2460 view change/zero scrollback escape sequences
2462 locale switching escape sequence 2461 locale switching escape sequence
2514environment variable when running configure. Even when compiled in, 2513environment variable when running configure. Even when compiled in,
2515perl will I<not> be initialised when all extensions have been disabled 2514perl will I<not> be initialised when all extensions have been disabled
2516C<-pe "" --perl-ext-common "">, so it should be safe to enable from a 2515C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2517resource standpoint. 2516resource standpoint.
2518 2517
2518=item --enable-assert (default: off)
2519
2520Enables the assertions in the code, normally disabled. This switch is only
2521useful when developing rxvt-unicode.
2522
2523=item --enable-256-color (default: off)
2524
2525Force use of so-called 256 colour mode, to work around buggy applications
2526that do not support termcap/terminfo, or simply improve support for
2527applications hardcoding the xterm 256 colour table.
2528
2529This switch breaks termcap/terminfo compatibility to C<TERM=rxvt-unicode>,
2530and consequently sets C<TERM> to C<rxvt-unicode-256color> by default
2531(F<doc/etc/> contains termcap/terminfo definitions for both).
2532
2533It also results in higher memory usage and can slow down @@RXVT_NAME@@
2534dramatically when more than six fonts are in use by a terminal instance.
2535
2519=item --with-afterimage-config=DIR 2536=item --with-afterimage-config=DIR
2520 2537
2521Look for the libAfterImage config script in DIR. 2538Look for the libAfterImage config script in DIR.
2522 2539
2523=item --with-name=NAME (default: urxvt) 2540=item --with-name=NAME (default: urxvt)

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines