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

Comparing rxvt-unicode/doc/rxvt.7.man.in (file contents):
Revision 1.101 by root, Tue Mar 16 00:54:46 2010 UTC vs.
Revision 1.102 by sf-exg, Sat Jul 24 14:20:48 2010 UTC

122.\} 122.\}
123.rm #[ #] #H #V #F C 123.rm #[ #] #H #V #F C
124.\" ======================================================================== 124.\" ========================================================================
125.\" 125.\"
126.IX Title "@@RXVT_NAME@@ 7" 126.IX Title "@@RXVT_NAME@@ 7"
127.TH @@RXVT_NAME@@ 7 "2010-02-06" "@@RXVT_VERSION@@" "RXVT-UNICODE" 127.TH @@RXVT_NAME@@ 7 "2010-07-24" "@@RXVT_VERSION@@" "RXVT-UNICODE"
128.\" For nroff, turn off justification. Always turn off hyphenation; it makes 128.\" For nroff, turn off justification. Always turn off hyphenation; it makes
129.\" way too many mistakes in technical documents. 129.\" way too many mistakes in technical documents.
130.if n .ad l 130.if n .ad l
131.nh 131.nh
132.SH "NAME" 132.SH "NAME"
244This tries to create a new terminal, and if fails with exit status 2, 244This tries to create a new terminal, and if fails with exit status 2,
245meaning it couldn't connect to the daemon, it will start the daemon and 245meaning it couldn't connect to the daemon, it will start the daemon and
246re-run the command. Subsequent invocations of the script will re-use the 246re-run the command. Subsequent invocations of the script will re-use the
247existing daemon. 247existing daemon.
248.PP 248.PP
249\fIHow do I distinguish whether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.\fR 249\fIHow do I distinguish whether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colours etc.\fR
250.IX Subsection "How do I distinguish whether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc." 250.IX Subsection "How do I distinguish whether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colours etc."
251.PP 251.PP
252The original rxvt and rxvt-unicode always export the variable \*(L"\s-1COLORTERM\s0\*(R", 252The original rxvt and rxvt-unicode always export the variable \*(L"\s-1COLORTERM\s0\*(R",
253so you can check and see if that is set. Note that several programs, \s-1JED\s0, 253so you can check and see if that is set. Note that several programs, \s-1JED\s0,
254slrn, Midnight Commander automatically check this variable to decide 254slrn, Midnight Commander automatically check this variable to decide
255whether or not to use color. 255whether or not to use colour.
256.PP 256.PP
257\fIHow do I set the correct, full \s-1IP\s0 address for the \s-1DISPLAY\s0 variable?\fR 257\fIHow do I set the correct, full \s-1IP\s0 address for the \s-1DISPLAY\s0 variable?\fR
258.IX Subsection "How do I set the correct, full IP address for the DISPLAY variable?" 258.IX Subsection "How do I set the correct, full IP address for the DISPLAY variable?"
259.PP 259.PP
260If you've compiled rxvt-unicode with \s-1DISPLAY_IS_IP\s0 and have enabled 260If you've compiled rxvt-unicode with \s-1DISPLAY_IS_IP\s0 and have enabled
536For the standard background colour, blinking will actually make 536For the standard background colour, blinking will actually make
537the text blink when compiled with \f(CW\*(C`\-\-enable\-text\-blink\*(C'\fR. Without 537the text blink when compiled with \f(CW\*(C`\-\-enable\-text\-blink\*(C'\fR. Without
538\&\f(CW\*(C`\-\-enable\-text\-blink\*(C'\fR, the blink attribute will be ignored. 538\&\f(CW\*(C`\-\-enable\-text\-blink\*(C'\fR, the blink attribute will be ignored.
539.PP 539.PP
540On \s-1ANSI\s0 colours, bold/blink attributes are used to set high-intensity 540On \s-1ANSI\s0 colours, bold/blink attributes are used to set high-intensity
541foreground/background colors. 541foreground/background colours.
542.PP 542.PP
543color0\-7 are the low-intensity colors. 543color0\-7 are the low-intensity colours.
544.PP 544.PP
545color8\-15 are the corresponding high-intensity colors. 545color8\-15 are the corresponding high-intensity colours.
546.PP 546.PP
547\fII don't like the screen colors. How do I change them?\fR 547\fII don't like the screen colours. How do I change them?\fR
548.IX Subsection "I don't like the screen colors. How do I change them?" 548.IX Subsection "I don't like the screen colours. How do I change them?"
549.PP 549.PP
550You can change the screen colors at run-time using \fI~/.Xdefaults\fR 550You can change the screen colours at run-time using \fI~/.Xdefaults\fR
551resources (or as long-options). 551resources (or as long-options).
552.PP 552.PP
553Here are values that are supposed to resemble a \s-1VGA\s0 screen, 553Here are values that are supposed to resemble a \s-1VGA\s0 screen,
554including the murky brown that passes for low-intensity yellow: 554including the murky brown that passes for low-intensity yellow:
555.PP 555.PP
571\& URxvt.color13: #FF00FF 571\& URxvt.color13: #FF00FF
572\& URxvt.color14: #00FFFF 572\& URxvt.color14: #00FFFF
573\& URxvt.color15: #FFFFFF 573\& URxvt.color15: #FFFFFF
574.Ve 574.Ve
575.PP 575.PP
576And here is a more complete set of non-standard colors. 576And here is a more complete set of non-standard colours.
577.PP 577.PP
578.Vb 10 578.Vb 10
579\& URxvt.cursorColor: #dc74d1 579\& URxvt.cursorColor: #dc74d1
580\& URxvt.pointerColor: #dc74d1 580\& URxvt.pointerColor: #dc74d1
581\& URxvt.background: #0e0e0e 581\& URxvt.background: #0e0e0e
1501.PP 1501.PP
1502The solution is to upgrade your system or switch to a better one. A 1502The solution is to upgrade your system or switch to a better one. A
1503possibly working workaround is to use a wcwidth implementation like 1503possibly working workaround is to use a wcwidth implementation like
1504.PP 1504.PP
1505http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c 1505http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
1506.PP
1507\fII want 256 colors\fR
1508.IX Subsection "I want 256 colors"
1509.PP
1510Are you sure you need 256 colors? 88 colors should be enough for most
1511purposes. If you really need more, there is an unsupported patch for
1512it in the doc directory, but please do not ask for it to be applied.
1513.SH "RXVT-UNICODE TECHNICAL REFERENCE" 1506.SH "RXVT-UNICODE TECHNICAL REFERENCE"
1514.IX Header "RXVT-UNICODE TECHNICAL REFERENCE" 1507.IX Header "RXVT-UNICODE TECHNICAL REFERENCE"
1515The rest of this document describes various technical aspects of 1508The rest of this document describes various technical aspects of
1516\&\fBrxvt-unicode\fR. First the description of supported command sequences, 1509\&\fBrxvt-unicode\fR. First the description of supported command sequences,
1517followed by pixmap support and last by a description of all features 1510followed by pixmap support and last by a description of all features
1605Restore Cursor 1598Restore Cursor
1606.ie n .IP "\fB\fB""ESC =""\fB\fR" 4 1599.ie n .IP "\fB\fB""ESC =""\fB\fR" 4
1607.el .IP "\fB\f(CBESC =\fB\fR" 4 1600.el .IP "\fB\f(CBESC =\fB\fR" 4
1608.IX Item "ESC =" 1601.IX Item "ESC ="
1609Application Keypad (\s-1SMKX\s0). See also next sequence. 1602Application Keypad (\s-1SMKX\s0). See also next sequence.
1610.ie n .IP "\fB\fB""ESC""\fB\fR" 4 1603.ie n .IP "\fB\fB""ESC >""\fB\fR" 4
1611.el .IP "\fB\f(CBESC\fB\fR" 4 1604.el .IP "\fB\f(CBESC >\fB\fR" 4
1612.IX Item "ESC" 1605.IX Item "ESC >"
1613Normal Keypad (\s-1RMKX\s0) 1606Normal Keypad (\s-1RMKX\s0)
1614.Sp 1607.Sp
1615\&\fBNote:\fR If the numeric keypad is activated, eg, \fBNum_Lock\fR has been 1608\&\fBNote:\fR If the numeric keypad is activated, eg, \fBNum_Lock\fR has been
1616pressed, numbers or control functions are generated by the numeric keypad 1609pressed, numbers or control functions are generated by the numeric keypad
1617(see Key Codes). 1610(see Key Codes).
1889Ps = 32 / 42 fg/bg Green 1882Ps = 32 / 42 fg/bg Green
1890Ps = 33 / 43 fg/bg Yellow 1883Ps = 33 / 43 fg/bg Yellow
1891Ps = 34 / 44 fg/bg Blue 1884Ps = 34 / 44 fg/bg Blue
1892Ps = 35 / 45 fg/bg Magenta 1885Ps = 35 / 45 fg/bg Magenta
1893Ps = 36 / 46 fg/bg Cyan 1886Ps = 36 / 46 fg/bg Cyan
1894Ps = 38;5 / 48;5 set fg/bg to color #m (ISO 8613-6) 1887Ps = 38;5 / 48;5 set fg/bg to colour #m (ISO 8613-6)
1895Ps = 37 / 47 fg/bg White 1888Ps = 37 / 47 fg/bg White
1896Ps = 39 / 49 fg/bg Default 1889Ps = 39 / 49 fg/bg Default
1897Ps = 90 / 100 fg/bg Bright Black 1890Ps = 90 / 100 fg/bg Bright Black
1898Ps = 91 / 101 fg/bg Bright Red 1891Ps = 91 / 101 fg/bg Bright Red
1899Ps = 92 / 102 fg/bg Bright Green 1892Ps = 92 / 102 fg/bg Bright Green
2125.ie n .IP "\fB\fB""Pm = 66""\fB\fR" 4 2118.ie n .IP "\fB\fB""Pm = 66""\fB\fR" 4
2126.el .IP "\fB\f(CBPm = 66\fB\fR" 4 2119.el .IP "\fB\f(CBPm = 66\fB\fR" 4
2127.IX Item "Pm = 66" 2120.IX Item "Pm = 66"
2128.TS 2121.TS
2129l l . 2122l l .
2130h Application Keypad (DECPAM) == ESC = 2123h Application Keypad (DECKPAM/DECPAM) == ESC =
2131l Normal Keypad (DECPNM) == ESC > 2124l Normal Keypad (DECKPNM/DECPNM) == ESC >
2132.TE 2125.TE
2133.PD 0 2126.PD 0
2134.ie n .IP "\fB\fB""Pm = 67""\fB\fR" 4 2127.ie n .IP "\fB\fB""Pm = 67""\fB\fR" 4
2135.el .IP "\fB\f(CBPm = 67\fB\fR" 4 2128.el .IP "\fB\f(CBPm = 67\fB\fR" 4
2136.IX Item "Pm = 67" 2129.IX Item "Pm = 67"
2251Ps = 4 Pt is a semi-colon separated sequence of one or more semi-colon separated number/name pairs, where number is an index to a colour and name is the name of a colour. Each pair causes the numbered colour to be changed to 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 2244Ps = 4 Pt is a semi-colon separated sequence of one or more semi-colon separated number/name pairs, where number is an index to a colour and name is the name of a colour. Each pair causes the numbered colour to be changed to 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
2252Ps = 10 Change colour of text foreground to Pt 2245Ps = 10 Change colour of text foreground to Pt
2253Ps = 11 Change colour of text background to Pt 2246Ps = 11 Change colour of text background to Pt
2254Ps = 12 Change colour of text cursor foreground to Pt 2247Ps = 12 Change colour of text cursor foreground to Pt
2255Ps = 13 Change colour of mouse foreground to Pt 2248Ps = 13 Change colour of mouse foreground to Pt
2256Ps = 17 Change colour of highlight characters to Pt 2249Ps = 17 Change background colour of highlight characters to Pt
2257Ps = 18 Change colour of bold characters to Pt [deprecated, see 706] 2250Ps = 19 Change foreground colour of highlight characters to Pt
2258Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707]
2259Ps = 20 Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile AfterImage). 2251Ps = 20 Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile AfterImage).
2260Ps = 39 Change default foreground colour to Pt. [deprecated, use 10] 2252Ps = 39 Change default foreground colour to Pt. [deprecated, use 10]
2261Ps = 46 Change Log File to Pt unimplemented 2253Ps = 46 Change Log File to Pt unimplemented
2262Ps = 49 Change default background colour to Pt. [deprecated, use 11] 2254Ps = 49 Change default background colour to Pt. [deprecated, use 11]
2263Ps = 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 2255Ps = 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
2445work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>. 2437work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2446.PP 2438.PP
2447All 2439All
2448.IP "\-\-enable\-everything" 4 2440.IP "\-\-enable\-everything" 4
2449.IX Item "--enable-everything" 2441.IX Item "--enable-everything"
2450Add (or remove) support for all non-multichoice options listed in 2442Add (or remove) support for all non-multichoice options listed
2451\&\f(CW\*(C`./configure \-\-help\*(C'\fR, except for \f(CW\*(C`\-\-enable\-assert\*(C'\fR. 2443in \f(CW\*(C`./configure \-\-help\*(C'\fR, except for \f(CW\*(C`\-\-enable\-assert\*(C'\fR and
2444\&\f(CW\*(C`\-\-enable\-256\-color\*(C'\fR.
2452.Sp 2445.Sp
2453You can specify this and then disable options you do not like by 2446You can specify this and then disable options you do not like by
2454\&\fIfollowing\fR this with the appropriate \f(CW\*(C`\-\-disable\-...\*(C'\fR arguments, 2447\&\fIfollowing\fR this with the appropriate \f(CW\*(C`\-\-disable\-...\*(C'\fR arguments,
2455or you can start with a minimal configuration by specifying 2448or you can start with a minimal configuration by specifying
2456\&\f(CW\*(C`\-\-disable\-everything\*(C'\fR and than adding just the \f(CW\*(C`\-\-enable\-...\*(C'\fR arguments 2449\&\f(CW\*(C`\-\-disable\-everything\*(C'\fR and than adding just the \f(CW\*(C`\-\-enable\-...\*(C'\fR arguments
2602\& EWMH\-hints (pid, utf8 names) and protocols (ping) 2595\& EWMH\-hints (pid, utf8 names) and protocols (ping)
2603\& urgency hint 2596\& urgency hint
2604\& separate underline colour (\-underlineColor) 2597\& separate underline colour (\-underlineColor)
2605\& settable border widths and borderless switch (\-w, \-b, \-bl) 2598\& settable border widths and borderless switch (\-w, \-b, \-bl)
2606\& visual depth selection (\-depth) 2599\& visual depth selection (\-depth)
2607\& settable extra linespacing /\-lsp) 2600\& settable extra linespacing (\-lsp)
2608\& iso\-14755 5.1 (basic) support 2601\& iso\-14755 5.1 (basic) support
2609\& tripleclickwords (\-tcw) 2602\& tripleclickwords (\-tcw)
2610\& settable insecure mode (\-insecure) 2603\& settable insecure mode (\-insecure)
2611\& keysym remapping support 2604\& keysym remapping support
2612\& cursor blinking and underline cursor (\-bc, \-uc) 2605\& cursor blinking and underline cursor (\-bc, \-uc)
2613\& XEmbed support (\-embed) 2606\& XEmbed support (\-embed)
2614\& user\-pty (\-pty\-fd) 2607\& user\-pty (\-pty\-fd)
2615\& hold on exit (\-hold) 2608\& hold on exit (\-hold)
2616\& compile in built\-in block graphics 2609\& compile in built\-in block graphics
2617\& skip builtin block graphics (\-sbg) 2610\& skip builtin block graphics (\-sbg)
2618\& separate highlightcolor support (\-hc) 2611\& separate highlight colour (\-highlightColor, \-highlightTextColor)
2619.Ve 2612.Ve
2620.Sp 2613.Sp
2621It also enables some non-essential features otherwise disabled, such as: 2614It also enables some non-essential features otherwise disabled, such as:
2622.Sp 2615.Sp
2623.Vb 11 2616.Vb 11
2624\& some round\-trip time optimisations 2617\& some round\-trip time optimisations
2625\& nearest color allocation on pseudocolor screens 2618\& nearest colour allocation on pseudocolor screens
2626\& UTF8_STRING support for selection 2619\& UTF8_STRING support for selection
2627\& sgr modes 90..97 and 100..107 2620\& sgr modes 90..97 and 100..107
2628\& backindex and forwardindex escape sequences 2621\& backindex and forwardindex escape sequences
2629\& view change/zero scrollback escape sequences 2622\& view change/zero scrollback escape sequences
2630\& locale switching escape sequence 2623\& locale switching escape sequence
2677resource standpoint. 2670resource standpoint.
2678.IP "\-\-enable\-assert (default: off)" 4 2671.IP "\-\-enable\-assert (default: off)" 4
2679.IX Item "--enable-assert (default: off)" 2672.IX Item "--enable-assert (default: off)"
2680Enables the assertions in the code, normally disabled. This switch is only 2673Enables the assertions in the code, normally disabled. This switch is only
2681useful when developing rxvt-unicode. 2674useful when developing rxvt-unicode.
2675.IP "\-\-enable\-256\-color (default: off)" 4
2676.IX Item "--enable-256-color (default: off)"
2677Force use of so-called 256 colour mode, to work around buggy applications
2678that do not support termcap/terminfo, or simply improve support for
2679applications hardcoding the xterm 256 colour table.
2680.Sp
2681This switch breaks termcap/terminfo compatibility to \f(CW\*(C`TERM=rxvt\-unicode\*(C'\fR,
2682and consequently sets \f(CW\*(C`TERM\*(C'\fR to \f(CW\*(C`rxvt\-unicode\-256color\*(C'\fR by default
2683(\fIdoc/etc/\fR contains termcap/terminfo definitions for both).
2684.Sp
2685It also results in higher memory usage and can slow down @@RXVT_NAME@@
2686dramatically when more than six fonts are in use by a terminal instance.
2682.IP "\-\-with\-afterimage\-config=DIR" 4 2687.IP "\-\-with\-afterimage\-config=DIR" 4
2683.IX Item "--with-afterimage-config=DIR" 2688.IX Item "--with-afterimage-config=DIR"
2684Look for the libAfterImage config script in \s-1DIR\s0. 2689Look for the libAfterImage config script in \s-1DIR\s0.
2685.IP "\-\-with\-name=NAME (default: urxvt)" 4 2690.IP "\-\-with\-name=NAME (default: urxvt)" 4
2686.IX Item "--with-name=NAME (default: urxvt)" 2691.IX Item "--with-name=NAME (default: urxvt)"

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines