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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines