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.10 by pcg, Sat Mar 6 00:12:01 2004 UTC vs.
Revision 1.73 by sf-exg, Sat Nov 19 11:00:20 2011 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines