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