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.2 by pcg, Wed Dec 17 23:21:56 2003 UTC vs.
Revision 1.81 by root, Wed Dec 31 14:19:08 2014 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 enable options marked with an asterisk listed 11 Add (or remove) support for all non-multichoice options listed in
3 in "./configure --help". Note that unlike other enable options this 12 "./configure --help", except for "--enable-assert" and
4 is order dependant. You can specify this and then disable options 13 "--enable-256-color".
5 which this enables by _following_ this with the appropriate 14
6 commands. 15 You can specify this and then disable options you do not like by
7--enable-xft 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)
8 add support for xft (anti-aliases, among others) fonts. xft fonts are 22 Add support for Xft (anti-aliased, among others) fonts. Xft fonts
9 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
10 you don't pay for them. 24 them, you don't pay for them.
11--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)
12 compile in support for additional codeset groups: 31 Compile in support for additional codeset (encoding) groups ("eu",
13 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
14 jp_ext rarely used but big japanese encodings 44 jp_ext rarely used but big japanese encodings
15 kr korean encodings 45 kr korean encodings
16 cn common chinese encodings 46 --enable-xim (default: on)
17 cn_ext rarely used but very big chinese encodigs 47 Add support for XIM (X Input Method) protocol. This allows using
18 vn vietnamese (not well-supported, though) 48 alternative input methods (e.g. kinput2) and will also correctly set
19 all all of the above. 49 up the input for people using dead keys or compose keys.
20--enable-unicode3 50
21 enable support for unicode codepoints above 65535 (the basic 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
22 multilingual page). This increases storage requirements per character 55 (the basic multilingual page). This increases storage requirements
23 from 2 to 4 bytes and is not too useful as font support in X11 and Xft 56 per character from 2 to 4 bytes. X11 fonts do not yet support these
24 is largely missing, although cut & paste will work correctly, as will 57 extra characters, but Xft does.
25 displaying, if you have the right font(s). 58
26--enable-utmp 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 separate unicode characters. This is done by
69 using precomposed 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)
27 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
28 start of rxvt execution and delete information when rxvt exits. 97 of rxvt execution and delete information when rxvt exits.
29--enable-wtmp 98
99 --enable-wtmp (default: on)
30 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
31 start of rxvt execution and write logout when rxvt exits. This 101 start of rxvt execution and write logout when rxvt exits. This
32 option requires --enable-utmp to also be specified. 102 option requires --enable-utmp to also be specified.
33--enable-lastlog 103
104 --enable-lastlog (default: on)
34 write user and tty to lastlog file (used by programs like 105 Write user and tty to lastlog file (used by programs like lastlogin)
35 ``lastlogin'') at start of rxvt execution. This option requires 106 at start of rxvt execution. This option requires --enable-utmp to
36 --enable-utmp to also be specified. 107 also be specified.
37--enable-xpm-background 108
38 add support for XPM background pixmaps 109 --enable-pixbuf (default: on)
39--enable-transparency 110 Add support for GDK-PixBuf to be used for background images. It adds
40 add support for inheriting parent backgrounds thus giving a fake 111 support for many file formats including JPG, PNG, TIFF, GIF, XPM,
41 transparency to the term 112 BMP, ICO and TGA.
42--enable-menubar 113
43 add support for our menu bar system 114 --enable-startup-notification (default: on)
44--enable-graphics 115 Add support for freedesktop startup notifications. This allows
45 add support for our graphics mode (see src/graphics) 116 window managers to display some kind of progress indicator during
46--enable-rxvt-scroll 117 startup.
118
119 --enable-transparency (default: on)
120 Add support for using the root pixmap as background to simulate
121 transparency. Note that this feature depends on libXrender and on
122 the availability of the RENDER extension in the X server.
123
124 --enable-fading (default: on)
125 Add support for fading the text when focus is lost.
126
127 --enable-rxvt-scroll (default: on)
47 add support for the original rxvt scrollbar 128 Add support for the original rxvt scrollbar.
48--enable-next-scroll 129
130 --enable-next-scroll (default: on)
49 add support for a NeXT-like scrollbar 131 Add support for a NeXT-like scrollbar.
50--enable-xterm-scroll 132
133 --enable-xterm-scroll (default: on)
51 add support for an Xterm-like scrollbar 134 Add support for an Xterm-like scrollbar.
52--enable-half-shadow 135
53 make shadows on the scrollbar only half the normal width & height.
54 only applicable to rxvt scrollbars
55--enable-xim
56 add support for XIM (X Input Method) protocol. This allows using
57 alternative input methods (e.g. kinput2) and will also correctly
58 set up the input for people using dead keys.
59--enable-greek
60 add support for greek keyboard
61--enable-ttygid
62 change tty device setting to group "tty" - only use this if
63 your system uses this type of security
64--disable-backspace-key 136 --disable-backspace-key
65 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
66 do it 138 do it.
139
67--disable-delete-key 140 --disable-delete-key
68 disable any handling of the delete key by us - let the X server 141 Removes any handling of the delete key by us - let the X server do
69 do it 142 it.
143
70--disable-resources 144 --disable-resources
71 remove all resources checking 145 Removes any support for resource checking.
72--enable-xgetdefault 146
73 make resources checking via XGetDefault() instead of our small
74 version which only checks ~/.Xdefaults, or if that doesn't exist
75 then ~/.Xresources
76--enable-strings
77 add support for our possibly faster memset() function and other
78 various routines, overriding your system's versions which may
79 have been hand-crafted in assembly or may require extra libraries
80 to link in. (This has header problems on some Linux systems).
81--disable-swapscreen 147 --disable-swapscreen
82 remove support for swap screen 148 Remove support for secondary/swap screen.
83--enable-frills 149
84 add support for some lesser used features 150 --enable-frills (default: on)
85--enable-linespace 151 Add support for many small features that are not essential but nice
86 add support to provide user specified line spacing between text rows 152 to have. Normally you want this, but for very small binaries you may
87--enable-keepscrolling 153 want to disable this.
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
194 --enable-iso14755 (default: on)
195 Enable extended ISO 14755 support (see rxvt(1)). Basic support
196 (section 5.1) is enabled by "--enable-frills", while support for
197 5.2, 5.3 and 5.4 is enabled with this switch.
198
199 --enable-keepscrolling (default: on)
88 add support for continual scrolling of the display when you hold 200 Add support for continual scrolling of the display when you hold the
89 the mouse button down on a scrollbar arrow 201 mouse button down on a scrollbar arrow.
90--enable-mousewheel 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
207 --enable-mousewheel (default: on)
91 add support for scrolling via mouse wheel or buttons 4 & 5 208 Add support for scrolling via mouse wheel or buttons 4 & 5.
92-enable-slipwheeling 209
210 --enable-slipwheeling (default: on)
93 add support for continual scrolling (using the mouse wheel as an 211 Add support for continual scrolling (using the mouse wheel as an
94 accelerator) while the control key is held down. This option 212 accelerator) while the control key is held down. This option
95 requires --enable-mousewheel to also be specified. 213 requires --enable-mousewheel to also be specified.
96--enable-old-selection 214
97 remove support for reverting the mouse selection style to that 215 --enable-smart-resize (default: off)
98 of v2.20 (and prior) 216 Add smart growth/shrink behaviour when resizing. This should keep
99--disable-new-selection
100 remove support for mouse selection style like that of xterm
101--enable-dmalloc
102 use Gray Watson's malloc - which is good for debugging
103 See http://www.letters.com/dmalloc/ for details
104 If you use either this or the next option, you may need to
105 edit src/Makefile after compiling to point DINCLUDE and DLIB to
106 the right places.
107 You can only use either this option and the following (should
108 you use either)
109--enable-dlmalloc
110 use Doug Lea's malloc - which is good for a production version
111 See http://g.oswego.edu/dl/html/malloc.html for details
112--enable-smart-resize
113 add smart growth/shrink behaviour when changing font size
114 via from hot keys. This should keep in a fixed position the
115 rxvt corner which is closest to a corner of the screen 217 the window corner which is closest to a corner of the screen in a
116--enable-256-color 218 fixed position.
117 add support for 256 colours rather than the base 16 colours 219
118--enable-cursor-blink 220 --enable-text-blink (default: on)
119 add support for a blinking cursor 221 Add support for blinking text.
120--enable-pointer-blank 222
223 --enable-pointer-blank (default: on)
121 add support to have the pointer disappear when typing or inactive 224 Add support to have the pointer disappear when typing or inactive.
122--with-term=NAME 225
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)
255 Set the basename for the installed binaries, resulting in "urxvt",
256 "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt".
257
258 --with-term=NAME (default: rxvt-unicode)
123 change the environmental variable for the terminal to NAME 259 Change the environmental variable for the terminal to NAME.
124 (default "xterm") 260
125--with-terminfo=PATH 261 --with-terminfo=PATH
126 change the environmental variable for the path to the terminfo 262 Change the environmental variable for the path to the terminfo tree
127 tree to PATH 263 to PATH.
264
128--with-x 265 --with-x
129 use the X Window System (pretty much default, eh?) 266 Use the X Window System (pretty much default, eh?).
130--with-xpm-includes=DIR 267
131 look for the XPM includes in DIR
132--with-xpm-library=DIR
133 look for the XPM library in DIR
134--with-xpm
135 not needed - define via --enable-xpm-background

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines