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.12 by pcg, Mon Mar 29 21:02:10 2004 UTC vs.
Revision 1.68 by root, Sat Nov 13 00:48:11 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines