ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/README.configure
Revision: 1.56
Committed: Wed Aug 1 18:38:15 2007 UTC (16 years, 10 months ago) by root
Branch: MAIN
CVS Tags: rel-8_3
Changes since 1.55: +29 -22 lines
Log Message:
fix lots of configure bugs

File Contents

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