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.18 by root, Sun Aug 15 18:59:05 2004 UTC vs.
Revision 1.79 by root, Fri Dec 26 22:52:22 2014 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 (encoding) groups. These 31 Compile in support for additional codeset (encoding) groups ("eu",
32 "vn" are always compiled in, which includes most 8-bit character
22 codeset tables are currently only used for driving X11 core fonts, 33 sets). These codeset tables are used for driving X11 core fonts,
23 they are not required for Xft fonts. Compiling them in will make 34 they are not required for Xft fonts, although having them compiled
24 your binary bigger (together about 700kB), but it doesn't increase 35 in lets rxvt-unicode choose replacement fonts more intelligently.
25 memory usage unless you use an X11 font requiring one of these 36 Compiling them in will make your binary bigger (all of together cost
26 encodings. 37 about 700kB), but it doesn't increase memory usage unless you use a
38 font requiring one of these encodings.
27 39
28 all all available codeset groups 40 all all available codeset groups
29 cn common chinese encodings 41 zh common chinese encodings
30 cn_ext rarely used but very big chinese encodigs 42 zh_ext rarely used but very big chinese encodings
31 jp common japanese encodings 43 jp common japanese encodings
32 jp_ext rarely used but big japanese encodings 44 jp_ext rarely used but big japanese encodings
33 kr korean encodings 45 kr korean encodings
34 46 --enable-xim (default: on)
35 --enable-xim
36 Add support for XIM (X Input Method) protocol. This allows using 47 Add support for XIM (X Input Method) protocol. This allows using
37 alternative input methods (e.g. kinput2) and will also correctly set 48 alternative input methods (e.g. kinput2) and will also correctly set
38 up the input for people using dead keys or compose keys. 49 up the input for people using dead keys or compose keys.
39 50
40 --enable-unicode3 51 --enable-unicode3 (default: off)
52 Recommended to stay off unless you really need non-BMP characters.
53
41 Enable direct support for displaying unicode codepoints above 65535 54 Enable direct support for displaying unicode codepoints above 65535
42 (the basic multilingual page). This increases storage requirements 55 (the basic multilingual page). This increases storage requirements
43 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
44 extra characters, but Xft does. 57 extra characters, but Xft does.
45 58
46 Please note that rxvt-unicode can store unicode code points >65535 59 Please note that rxvt-unicode can store unicode code points >65535
47 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
48 to a view thousand (shared with combining characters, see next 61 to a few thousand (shared with combining characters, see next
49 switch), and right now rxvt-unicode cannot display them 62 switch), and right now rxvt-unicode cannot display them
50 (input/output and cut&paste still work, though). 63 (input/output and cut&paste still work, though).
51 64
52 --enable-combining 65 --enable-combining (default: on)
53 Enable automatic composition of combining characters into composite 66 Enable automatic composition of combining characters into composite
54 characters. This is required for proper viewing of text where 67 characters. This is required for proper viewing of text where
55 accents are encoded as seperate unicode characters. This is done by 68 accents are encoded as separate unicode characters. This is done by
56 using precomposited characters when available or creating new 69 using precomposed characters when available or creating new
57 pseudo-characters when no precomposed form exists. 70 pseudo-characters when no precomposed form exists.
58 71
59 Without --enable-unicode3, the number of additional precomposed 72 Without --enable-unicode3, the number of additional precomposed
60 characters is rather limited (2048, if this is full, rxvt will use 73 characters is somewhat limited (the 6400 private use characters will
61 the private use area, extending the number of combinations to 8448).
62 With --enable-unicode3, no practical limit exists. This will also 74 be (ab-)used). With --enable-unicode3, no practical limit exists.
63 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.
64 78
65 The combining table also contains entries for arabic presentation 79 The combining table also contains entries for arabic presentation
66 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
67 be used. 81 be used (and tell me how these are to be used...).
68 82
69 --enable-fallback(=CLASS) 83 --enable-fallback[=CLASS] (default: Rxvt)
70 When reading resource settings, also read settings for class CLASS 84 When reading resource settings, also read settings for class CLASS.
71 (default: Rxvt). To disable resource fallback use 85 To disable resource fallback use --disable-fallback.
72 --disable-fallback.
73 86
74 --with-res-name=NAME 87 --with-res-name=NAME (default: urxvt)
75 Use the given name (default: urxvt) as default application name when 88 Use the given name as default application name when reading
76 reading resources. Specify --with-res-name=rxvt to replace rxvt. 89 resources. Specify --with-res-name=rxvt to replace rxvt.
77 90
78 --with-res-class=CLASS 91 --with-res-class=CLASS (default: URxvt)
79 Use the given class (default: URxvt) as default application class 92 Use the given class as default application class when reading
80 when reading resources. Specify --with-res-class=Rxvt to replace 93 resources. Specify --with-res-class=Rxvt to replace rxvt.
81 rxvt.
82 94
83 --enable-utmp 95 --enable-utmp (default: on)
84 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
85 of rxvt execution and delete information when rxvt exits. 97 of rxvt execution and delete information when rxvt exits.
86 98
87 --enable-wtmp 99 --enable-wtmp (default: on)
88 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
89 start of rxvt execution and write logout when rxvt exits. This 101 start of rxvt execution and write logout when rxvt exits. This
90 option requires --enable-utmp to also be specified. 102 option requires --enable-utmp to also be specified.
91 103
92 --enable-lastlog 104 --enable-lastlog (default: on)
93 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)
94 at start of rxvt execution. This option requires --enable-utmp to 106 at start of rxvt execution. This option requires --enable-utmp to
95 also be specified. 107 also be specified.
96 108
97 --enable-xpm-background 109 --enable-pixbuf (default: on)
98 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.
99 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
100 --enable-transparency 119 --enable-transparency (default: on)
101 Add support for inheriting parent backgrounds thus giving a fake 120 Add support for using the root pixmap as background to simulate
102 transparency to the term. 121 transparency. Note that this feature depends on libXrender and on
122 the availability of the RENDER extension in the X server.
103 123
104 --enable-fading 124 --enable-fading (default: on)
105 Add support for fading the text when focus is lost. 125 Add support for fading the text when focus is lost.
106 126
107 --enable-tinting
108 Add support for tinting of transparent backgrounds.
109
110 --enable-menubar
111 Add support for our menu bar system (this interacts badly with
112 dynamic locale switching currently).
113
114 --enable-rxvt-scroll 127 --enable-rxvt-scroll (default: on)
115 Add support for the original rxvt scrollbar. 128 Add support for the original rxvt scrollbar.
116 129
117 --enable-next-scroll 130 --enable-next-scroll (default: on)
118 Add support for a NeXT-like scrollbar. 131 Add support for a NeXT-like scrollbar.
119 132
120 --enable-xterm-scroll 133 --enable-xterm-scroll (default: on)
121 Add support for an Xterm-like scrollbar. 134 Add support for an Xterm-like scrollbar.
122 135
123 --enable-plain-scroll
124 Add support for a very unobtrusive, plain-looking scrollbar that is
125 the favourite of the rxvt-unicode author, having used it for many
126 years.
127
128 --enable-half-shadow
129 Make shadows on the scrollbar only half the normal width & height.
130 only applicable to rxvt scrollbars.
131
132 --enable-ttygid
133 Change tty device setting to group "tty" - only use this if your
134 system uses this type of security.
135
136 --disable-backspace-key 136 --disable-backspace-key
137 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
138 do it. 138 do it.
139 139
140 --disable-delete-key 140 --disable-delete-key
141 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
142 it. 142 it.
143 143
144 --disable-resources 144 --disable-resources
145 Remove all resources checking. 145 Removes any support for resource checking.
146
147 --enable-xgetdefault
148 Make resources checking via XGetDefault() instead of our small
149 version which only checks ~/.Xdefaults, or if that doesn't exist
150 then ~/.Xresources.
151
152 --enable-strings
153 Add support for our possibly faster memset() function and other
154 various routines, overriding your system's versions which may have
155 been hand-crafted in assembly or may require extra libraries to link
156 in. (this breaks ANSI-C rules and has problems on many GNU/Linux
157 systems).
158 146
159 --disable-swapscreen 147 --disable-swapscreen
160 Remove support for swap screen. 148 Remove support for secondary/swap screen.
161 149
162 --enable-frills 150 --enable-frills (default: on)
163 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
164 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
165 want to disable this. 153 want to disable this.
166 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
167 --enable-iso14755 194 --enable-iso14755 (default: on)
168 Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt). 195 Enable extended ISO 14755 support (see rxvt(1)). Basic support
169 Basic support (section 5.1) is enabled by "--enable-frills", while 196 (section 5.1) is enabled by "--enable-frills", while support for
170 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.
171 198
172 --enable-linespace
173 Add support to provide user specified line spacing between text
174 rows.
175
176 --enable-keepscrolling 199 --enable-keepscrolling (default: on)
177 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
178 mouse button down on a scrollbar arrow. 201 mouse button down on a scrollbar arrow.
179 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
180 --enable-mousewheel 207 --enable-mousewheel (default: on)
181 Add support for scrolling via mouse wheel or buttons 4 & 5. 208 Add support for scrolling via mouse wheel or buttons 4 & 5.
182 209
183 --enable-slipwheeling 210 --enable-slipwheeling (default: on)
184 Add support for continual scrolling (using the mouse wheel as an 211 Add support for continual scrolling (using the mouse wheel as an
185 accelerator) while the control key is held down. This option 212 accelerator) while the control key is held down. This option
186 requires --enable-mousewheel to also be specified. 213 requires --enable-mousewheel to also be specified.
187 214
188 --disable-new-selection
189 Remove support for mouse selection style like that of xterm.
190
191 --enable-dmalloc
192 Use Gray Watson's malloc - which is good for debugging See
193 http://www.letters.com/dmalloc/ for details If you use either this
194 or the next option, you may need to edit src/Makefile after
195 compiling to point DINCLUDE and DLIB to the right places.
196
197 You can only use either this option and the following (should you
198 use either) .
199
200 --enable-dlmalloc
201 Use Doug Lea's malloc - which is good for a production version See
202 <http://g.oswego.edu/dl/html/malloc.html> for details.
203
204 --enable-smart-resize 215 --enable-smart-resize (default: off)
205 Add smart growth/shrink behaviour when changing font size via from 216 Add smart growth/shrink behaviour when resizing. This should keep
206 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
207 is closest to a corner of the screen. 218 fixed position.
208 219
209 --enable-256-color 220 --enable-text-blink (default: on)
210 Add support for 256 colours rather than the base 16 colours.
211
212 This option will likely go away in the future. Speak up if you don't
213 want this.
214
215 --enable-cursor-blink
216 Add support for a blinking cursor. 221 Add support for blinking text.
217 222
218 --enable-pointer-blank 223 --enable-pointer-blank (default: on)
219 Add support to have the pointer disappear when typing or inactive. 224 Add support to have the pointer disappear when typing or inactive.
220 225
221 --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)
222 Set the basename for the installed binaries (default: urxvt, 255 Set the basename for the installed binaries, resulting in "urxvt",
223 resulting in urxvt, urxvtd etc.). Specify --with-name=rxvt to 256 "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt".
224 replace rxvt.
225 257
226 --with-term=NAME 258 --with-term=NAME (default: rxvt-unicode)
227 Change the environmental variable for the terminal to NAME (default 259 Change the environmental variable for the terminal to NAME.
228 "rxvt")
229 260
230 --with-terminfo=PATH 261 --with-terminfo=PATH
231 Change the environmental variable for the path to the terminfo tree 262 Change the environmental variable for the path to the terminfo tree
232 to PATH. 263 to PATH.
233 264
234 --with-x 265 --with-x
235 Use the X Window System (pretty much default, eh?). 266 Use the X Window System (pretty much default, eh?).
236 267
237 --with-xpm-includes=DIR
238 Look for the XPM includes in DIR.
239
240 --with-xpm-library=DIR
241 Look for the XPM library in DIR.
242
243 --with-xpm
244 Not needed - define via --enable-xpm-background.
245

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines