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

Comparing rxvt-unicode/README.configure (file contents):
Revision 1.20 by root, Tue Jan 11 02:24:59 2005 UTC vs.
Revision 1.62 by root, Tue Jan 29 11:00:49 2008 UTC

1CONFIGURE OPTIONS 1CONFIGURE OPTIONS
2 General hint: if you get compile errors, then likely your configuration 2 General hint: if you get compile errors, then likely your configuration
3 hasn't been tested well. Either try with --enable-everything or use the 3 hasn't been tested well. Either try with "--enable-everything" or use
4 ./reconf script as a base for experiments. ./reconf is used by myself, 4 the default configuration (i.e. no "--enable-xxx" or "--disable-xxx"
5 so it should generally be a working config. Of course, you should always 5 switches). Of course, you should always report when a combination
6 report when a combination doesn't work, so it can be fixed. Marc Lehmann 6 doesn't work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
7 <rxvt@schmorp.de>. 7
8 All
8 9
9 --enable-everything 10 --enable-everything
10 Add support for all non-multichoice options listed in "./configure 11 Add (or remove) support for all non-multichoice options listed in
11 --help". Note that unlike other enable options this is order 12 "./configure --help".
12 dependant. You can specify this and then disable options which this
13 enables by *following* this with the appropriate commands.
14 13
15 --enable-xft 14 You can specify this and then disable options you do not like by
15 *following* this with the appropriate "--disable-..." arguments, or
16 you can start with a minimal configuration by specifying
17 "--disable-everything" and than adding just the "--enable-..."
18 arguments you want.
19
20 --enable-xft (default: enabled)
16 Add support for Xft (anti-aliases, among others) fonts. Xft fonts 21 Add support for Xft (anti-aliases, among others) fonts. Xft fonts
17 are slower and require lots of memory, but as long as you don't use 22 are slower and require lots of memory, but as long as you don't use
18 them, you don't pay for them. 23 them, you don't pay for them.
19 24
20 --enable-font-styles 25 --enable-font-styles (default: on)
21 Add support for bold, *italic* and *bold italic* font styles. The 26 Add support for bold, *italic* and *bold italic* font styles. The
22 fonts can be set manually or automatically. 27 fonts can be set manually or automatically.
23 28
24 --with-codesets=NAME,... 29 --with-codesets=NAME,... (default: all)
25 Compile in support for additional codeset (encoding) groups (eu, vn 30 Compile in support for additional codeset (encoding) groups ("eu",
26 are always compiled in, which includes most 8-bit character sets). 31 "vn" are always compiled in, which includes most 8-bit character
27 These codeset tables are currently only used for driving X11 core 32 sets). These codeset tables are used for driving X11 core fonts,
28 fonts, they are not required for Xft fonts. Compiling them in will 33 they are not required for Xft fonts, although having them compiled
29 make your binary bigger (together about 700kB), but it doesn't 34 in lets rxvt-unicode choose replacement fonts more intelligently.
30 increase memory usage unless you use an X11 font requiring one of 35 Compiling them in will make your binary bigger (all of together cost
31 these encodings. 36 about 700kB), but it doesn't increase memory usage unless you use a
37 font requiring one of these encodings.
32 38
33 all all available codeset groups 39 all all available codeset groups
34 zh common chinese encodings 40 zh common chinese encodings
35 zh_ext rarely used but very big chinese encodigs 41 zh_ext rarely used but very big chinese encodings
36 jp common japanese encodings 42 jp common japanese encodings
37 jp_ext rarely used but big japanese encodings 43 jp_ext rarely used but big japanese encodings
38 kr korean encodings 44 kr korean encodings
39 45 --enable-xim (default: on)
40 --enable-xim
41 Add support for XIM (X Input Method) protocol. This allows using 46 Add support for XIM (X Input Method) protocol. This allows using
42 alternative input methods (e.g. kinput2) and will also correctly set 47 alternative input methods (e.g. kinput2) and will also correctly set
43 up the input for people using dead keys or compose keys. 48 up the input for people using dead keys or compose keys.
44 49
45 --enable-unicode3 50 --enable-unicode3 (default: off)
51 Recommended to stay off unless you really need non-BMP characters.
52
46 Enable direct support for displaying unicode codepoints above 65535 53 Enable direct support for displaying unicode codepoints above 65535
47 (the basic multilingual page). This increases storage requirements 54 (the basic multilingual page). This increases storage requirements
48 per character from 2 to 4 bytes. X11 fonts do not yet support these 55 per character from 2 to 4 bytes. X11 fonts do not yet support these
49 extra characters, but Xft does. 56 extra characters, but Xft does.
50 57
51 Please note that rxvt-unicode can store unicode code points >65535 58 Please note that rxvt-unicode can store unicode code points >65535
52 even without this flag, but the number of such characters is limited 59 even without this flag, but the number of such characters is limited
53 to a view thousand (shared with combining characters, see next 60 to a few thousand (shared with combining characters, see next
54 switch), and right now rxvt-unicode cannot display them 61 switch), and right now rxvt-unicode cannot display them
55 (input/output and cut&paste still work, though). 62 (input/output and cut&paste still work, though).
56 63
57 --enable-combining 64 --enable-combining (default: on)
58 Enable automatic composition of combining characters into composite 65 Enable automatic composition of combining characters into composite
59 characters. This is required for proper viewing of text where 66 characters. This is required for proper viewing of text where
60 accents are encoded as seperate unicode characters. This is done by 67 accents are encoded as seperate unicode characters. This is done by
61 using precomposited characters when available or creating new 68 using precomposited characters when available or creating new
62 pseudo-characters when no precomposed form exists. 69 pseudo-characters when no precomposed form exists.
63 70
64 Without --enable-unicode3, the number of additional precomposed 71 Without --enable-unicode3, the number of additional precomposed
65 characters is rather limited (2048, if this is full, rxvt will use 72 characters is somewhat limited (the 6400 private use characters will
66 the private use area, extending the number of combinations to 8448).
67 With --enable-unicode3, no practical limit exists. This will also 73 be (ab-)used). With --enable-unicode3, no practical limit exists.
68 enable storage of characters >65535. 74
75 This option will also enable storage (but not display) of characters
76 beyond plane 0 (>65535) when --enable-unicode3 was not specified.
69 77
70 The combining table also contains entries for arabic presentation 78 The combining table also contains entries for arabic presentation
71 forms, but these are not currently used. Bug me if you want these to 79 forms, but these are not currently used. Bug me if you want these to
72 be used. 80 be used (and tell me how these are to be used...).
73 81
74 --enable-fallback(=CLASS) 82 --enable-fallback(=CLASS) (default: Rxvt)
75 When reading resource settings, also read settings for class CLASS 83 When reading resource settings, also read settings for class CLASS.
76 (default: Rxvt). To disable resource fallback use 84 To disable resource fallback use --disable-fallback.
77 --disable-fallback.
78 85
79 --with-res-name=NAME 86 --with-res-name=NAME (default: urxvt)
80 Use the given name (default: urxvt) as default application name when 87 Use the given name as default application name when reading
81 reading resources. Specify --with-res-name=rxvt to replace rxvt. 88 resources. Specify --with-res-name=rxvt to replace rxvt.
82 89
83 --with-res-class=CLASS 90 --with-res-class=CLASS (default: URxvt)
84 Use the given class (default: URxvt) as default application class 91 Use the given class as default application class when reading
85 when reading resources. Specify --with-res-class=Rxvt to replace 92 resources. Specify --with-res-class=Rxvt to replace rxvt.
86 rxvt.
87 93
88 --enable-utmp 94 --enable-utmp (default: on)
89 Write user and tty to utmp file (used by programs like w) at start 95 Write user and tty to utmp file (used by programs like w) at start
90 of rxvt execution and delete information when rxvt exits. 96 of rxvt execution and delete information when rxvt exits.
91 97
92 --enable-wtmp 98 --enable-wtmp (default: on)
93 Write user and tty to wtmp file (used by programs like last) at 99 Write user and tty to wtmp file (used by programs like last) at
94 start of rxvt execution and write logout when rxvt exits. This 100 start of rxvt execution and write logout when rxvt exits. This
95 option requires --enable-utmp to also be specified. 101 option requires --enable-utmp to also be specified.
96 102
97 --enable-lastlog 103 --enable-lastlog (default: on)
98 Write user and tty to lastlog file (used by programs like lastlogin) 104 Write user and tty to lastlog file (used by programs like lastlogin)
99 at start of rxvt execution. This option requires --enable-utmp to 105 at start of rxvt execution. This option requires --enable-utmp to
100 also be specified. 106 also be specified.
101 107
102 --enable-xpm-background 108 --enable-afterimage (default: on)
103 Add support for XPM background pixmaps. 109 Add support for libAfterImage to be used for transparency and
110 background images. It adds support for many file formats including
111 JPG, PNG, SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep
112 image XML
113 (<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
104 114
115 This option also adds such eye candy as blending an image over the
116 root background, as well as dynamic scaling and bluring of
117 background images.
118
119 Note that with this option enabled, rxvt's memory footprint might
120 increase by a few megabytes even if no extra features are used
121 (mostly due to third-party libraries used by libAI). Memory
122 footprint may somewhat be lowered if libAfterImage is configured
123 without support for SVG.
124
105 --enable-transparency 125 --enable-transparency (default: on)
106 Add support for inheriting parent backgrounds thus giving a fake 126 Add support for backgrounds, creating illusion of transparency in
107 transparency to the term. 127 the term.
108 128
109 --enable-fading 129 --enable-fading (default: on)
110 Add support for fading the text when focus is lost. 130 Add support for fading the text when focus is lost.
111 131
112 --enable-tinting
113 Add support for tinting of transparent backgrounds.
114
115 --enable-menubar
116 Add support for our menu bar system (this interacts badly with
117 dynamic locale switching currently).
118
119 --enable-rxvt-scroll 132 --enable-rxvt-scroll (default: on)
120 Add support for the original rxvt scrollbar. 133 Add support for the original rxvt scrollbar.
121 134
122 --enable-next-scroll 135 --enable-next-scroll (default: on)
123 Add support for a NeXT-like scrollbar. 136 Add support for a NeXT-like scrollbar.
124 137
125 --enable-xterm-scroll 138 --enable-xterm-scroll (default: on)
126 Add support for an Xterm-like scrollbar. 139 Add support for an Xterm-like scrollbar.
127 140
128 --enable-plain-scroll
129 Add support for a very unobtrusive, plain-looking scrollbar that is
130 the favourite of the rxvt-unicode author, having used it for many
131 years.
132
133 --enable-half-shadow
134 Make shadows on the scrollbar only half the normal width & height.
135 only applicable to rxvt scrollbars.
136
137 --enable-ttygid
138 Change tty device setting to group "tty" - only use this if your
139 system uses this type of security.
140
141 --disable-backspace-key 141 --disable-backspace-key
142 Disable any handling of the backspace key by us - let the X server 142 Removes any handling of the backspace key by us - let the X server
143 do it. 143 do it.
144 144
145 --disable-delete-key 145 --disable-delete-key
146 Disable any handling of the delete key by us - let the X server do 146 Removes any handling of the delete key by us - let the X server do
147 it. 147 it.
148 148
149 --disable-resources 149 --disable-resources
150 Remove all resources checking. 150 Removes any support for resource checking.
151
152 --enable-xgetdefault
153 Make resources checking via XGetDefault() instead of our small
154 version which only checks ~/.Xdefaults, or if that doesn't exist
155 then ~/.Xresources.
156
157 --enable-strings
158 Add support for our possibly faster memset() function and other
159 various routines, overriding your system's versions which may have
160 been hand-crafted in assembly or may require extra libraries to link
161 in. (this breaks ANSI-C rules and has problems on many GNU/Linux
162 systems).
163 151
164 --disable-swapscreen 152 --disable-swapscreen
165 Remove support for swap screen. 153 Remove support for secondary/swap screen.
166 154
167 --enable-frills 155 --enable-frills (default: on)
168 Add support for many small features that are not essential but nice 156 Add support for many small features that are not essential but nice
169 to have. Normally you want this, but for very small binaries you may 157 to have. Normally you want this, but for very small binaries you may
170 want to disable this. 158 want to disable this.
171 159
160 A non-exhaustive list of features enabled by "--enable-frills"
161 (possibly in combination with other switches) is:
162
163 MWM-hints
164 EWMH-hints (pid, utf8 names) and protocols (ping)
165 urgency hint
166 seperate underline colour (-underlineColor)
167 settable border widths and borderless switch (-w, -b, -bl)
168 visual depth selection (-depth)
169 settable extra linespacing /-lsp)
170 iso-14755 5.1 (basic) support
171 tripleclickwords (-tcw)
172 settable insecure mode (-insecure)
173 keysym remapping support
174 cursor blinking and underline cursor (-cb, -uc)
175 XEmbed support (-embed)
176 user-pty (-pty-fd)
177 hold on exit (-hold)
178 compile in built-in block graphics
179 skip builtin block graphics (-sbg)
180 separate highlightcolor support (-hc)
181
182 It also enables some non-essential features otherwise disabled, such
183 as:
184
185 some round-trip time optimisations
186 nearest color allocation on pseudocolor screens
187 UTF8_STRING support for selection
188 sgr modes 90..97 and 100..107
189 backindex and forwardindex escape sequences
190 view change/zero scrollback escape sequences
191 locale switching escape sequence
192 window op and some xterm/OSC escape sequences
193 rectangular selections
194 trailing space removal for selections
195 verbose X error handling
196
172 --enable-iso14755 197 --enable-iso14755 (default: on)
173 Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt). 198 Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt).
174 Basic support (section 5.1) is enabled by "--enable-frills", while 199 Basic support (section 5.1) is enabled by "--enable-frills", while
175 support for 5.2, 5.3 and 5.4 is enabled with this switch. 200 support for 5.2, 5.3 and 5.4 is enabled with this switch.
176 201
177 --enable-keepscrolling 202 --enable-keepscrolling (default: on)
178 Add support for continual scrolling of the display when you hold the 203 Add support for continual scrolling of the display when you hold the
179 mouse button down on a scrollbar arrow. 204 mouse button down on a scrollbar arrow.
180 205
206 --enable-selectionscrolling (default: on)
207 Add support for scrolling when the selection moves to the top or
208 bottom of the screen.
209
181 --enable-mousewheel 210 --enable-mousewheel (default: on)
182 Add support for scrolling via mouse wheel or buttons 4 & 5. 211 Add support for scrolling via mouse wheel or buttons 4 & 5.
183 212
184 --enable-slipwheeling 213 --enable-slipwheeling (default: on)
185 Add support for continual scrolling (using the mouse wheel as an 214 Add support for continual scrolling (using the mouse wheel as an
186 accelerator) while the control key is held down. This option 215 accelerator) while the control key is held down. This option
187 requires --enable-mousewheel to also be specified. 216 requires --enable-mousewheel to also be specified.
188 217
189 --disable-new-selection
190 Remove support for mouse selection style like that of xterm.
191
192 --enable-dmalloc
193 Use Gray Watson's malloc - which is good for debugging See
194 http://www.letters.com/dmalloc/ for details If you use either this
195 or the next option, you may need to edit src/Makefile after
196 compiling to point DINCLUDE and DLIB to the right places.
197
198 You can only use either this option and the following (should you
199 use either) .
200
201 --enable-dlmalloc
202 Use Doug Lea's malloc - which is good for a production version See
203 <http://g.oswego.edu/dl/html/malloc.html> for details.
204
205 --enable-smart-resize 218 --enable-smart-resize (default: off)
206 Add smart growth/shrink behaviour when changing font size via from 219 Add smart growth/shrink behaviour when resizing. This should keep
207 hot keys. This should keep in a fixed position the rxvt corner which 220 the window corner which is closest to a corner of the screen in a
208 is closest to a corner of the screen. 221 fixed position.
209 222
210 --enable-cursor-blink 223 --enable-text-blink (default: on)
211 Add support for a blinking cursor. 224 Add support for blinking text.
212 225
213 --enable-pointer-blank 226 --enable-pointer-blank (default: on)
214 Add support to have the pointer disappear when typing or inactive. 227 Add support to have the pointer disappear when typing or inactive.
215 228
216 --with-name=NAME 229 --enable-perl (default: on)
230 Enable an embedded perl interpreter. See the rxvtperl(3) manpage
231 (doc/rxvtperl.txt) for more info on this feature, or the files in
232 src/perl-ext/ for the extensions that are installed by default. The
233 perl interpreter that is used can be specified via the "PERL"
234 environment variable when running configure. Even when compiled in,
235 perl will *not* be initialised when all extensions have been
236 disabled "-pe "" --perl-ext-common """, so it should be safe to
237 enable from a resource standpoint.
238
239 --with-afterimage-config=DIR
240 Look for the libAfterImage config script in DIR.
241
242 --with-name=NAME (default: urxvt)
217 Set the basename for the installed binaries (default: urxvt, 243 Set the basename for the installed binaries, resulting in "urxvt",
218 resulting in urxvt, urxvtd etc.). Specify --with-name=rxvt to 244 "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt".
219 replace rxvt.
220 245
221 --with-term=NAME 246 --with-term=NAME (default: rxvt-unicode)
222 Change the environmental variable for the terminal to NAME (default 247 Change the environmental variable for the terminal to NAME.
223 "rxvt")
224 248
225 --with-terminfo=PATH 249 --with-terminfo=PATH
226 Change the environmental variable for the path to the terminfo tree 250 Change the environmental variable for the path to the terminfo tree
227 to PATH. 251 to PATH.
228 252
229 --with-x 253 --with-x
230 Use the X Window System (pretty much default, eh?). 254 Use the X Window System (pretty much default, eh?).
231 255
232 --with-xpm-includes=DIR
233 Look for the XPM includes in DIR.
234
235 --with-xpm-library=DIR
236 Look for the XPM library in DIR.
237
238 --with-xpm
239 Not needed - define via --enable-xpm-background.
240

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines