*** empty log message ***
[dana/urxvt.git] / README.configure
1 General hint: if you get compile errors, then likely your configuration
2 hasn't been tested well. Either try with --enable-everything or use the
3 ./reconf script as a base for experiments. ./reconf is used by myself,
4 so it should generally be a working config. Of course, you should always
5 report when a combination doesn't work, so it can be fixed. Marc Lehmann
6 <rxvt@schmorp.de>.
7
8 --enable-everything
9         add support for all non-multichoice options listed in "./configure
10         --help".  Note that unlike other enable options this is order
11         dependant.  You can specify this and then disable options which
12         this enables by _following_ this with the appropriate commands.
13 --enable-xft
14         add support for xft (anti-aliases, among others) fonts. xft fonts are
15         slower and require lots of memory, but as long as you don't use them,
16         you don't pay for them.
17 --with-codesets=NAME,...
18         compile in support for additional codeset groups:
19         jp      common japanese encodings
20         jp_ext  rarely used but big japanese encodings
21         kr      korean encodings
22         cn      common chinese encodings
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
27         alternative input methods (e.g. kinput2) and will also correctly
28         set up the input for people using dead keys or compose keys.
29 --enable-unicode3
30         enable support for unicode codepoints above 65535 (the basic
31         multilingual page). This increases storage requirements per
32         character from 2 to 4 bytes. X11 fonts do not yet support these
33         extra characters, but Xft does.
34 --enable-combining
35         enable automatic composition of combining characters into
36         composite characters. This is required for proper viewing of text
37         where accents are encoded as seperate unicode characters. This is
38         done by using precomposited characters when available or creating
39         new pseudo-characters when no precomposed form exists. Without
40         --enable-unicode3, the number of additional precomposed characters
41         is rather limited (2048, if this is full, rxvt will use the
42         private use area, extending the number of combinations to
43         8448). With --enable-unicode3, no practical limit exists. This
44         will also enable storage of characters >16bit. They currently
45         won't display properly, but they will paste correctly.
46         The combining table also contains entries for arabic presentation
47         forms, but these are not currently used. Bug me if you want
48         these to be used.
49 --enable-fallback(=CLASS)
50         when reading resource settings, also read settings for class CLASS
51         (default: Rxvt). To disable resource fallback use --disable-fallback.
52 --with-res-name=NAME
53         use the given name (default: urxvt) as default application name
54         when reading resources.  Specify --with-res-name=rxvt to replace
55         rxvt.
56 --with-res-class=CLASS
57         use the given class (default: URxvt) as default application class
58         when reading resources.  Specify --with-res-class=Rxvt to replace
59         rxvt.
60 --enable-utmp
61         write user and tty to utmp file (used by programs like ``w'') at
62         start of rxvt execution and delete information when rxvt exits.
63 --enable-wtmp
64         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
66         option requires --enable-utmp to also be specified.
67 --enable-lastlog
68         write user and tty to lastlog file (used by programs like
69         ``lastlogin'') at start of rxvt execution.  This option requires
70         --enable-utmp to also be specified.
71 --enable-xpm-background
72         add support for XPM background pixmaps
73 --enable-transparency
74         add support for inheriting parent backgrounds thus giving a fake
75         transparency to the term
76 --enable-tinting
77         add support for tinting of transparent backgrounds.
78 --enable-menubar
79         add support for our menu bar system (this interacts badly with
80         dynamic locale switching currently)
81 --enable-rxvt-scroll
82         add support for the original rxvt scrollbar
83 --enable-next-scroll
84         add support for a NeXT-like scrollbar
85 --enable-xterm-scroll
86         add support for an Xterm-like scrollbar
87 --enable-plain-scroll
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
98         disable any handling of the backspace key by us - let the X server
99         do it
100 --disable-delete-key
101         disable any handling of the delete key by us - let the X server
102         do it
103 --disable-resources
104         remove all resources checking
105 --enable-xgetdefault
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
116         remove support for swap screen
117 --enable-frills
118         add support for some lesser used features
119 --enable-linespace
120         add support to provide user specified line spacing between text rows
121 --enable-keepscrolling
122         add support for continual scrolling of the display when you hold
123         the mouse button down on a scrollbar arrow
124 --enable-mousewheel
125         add support for scrolling via mouse wheel or buttons 4 & 5
126 --enable-slipwheeling
127         add support for continual scrolling (using the mouse wheel as an
128         accelerator) while the control key is held down.  This option
129         requires --enable-mousewheel to also be specified.
130 --enable-old-selection
131         remove support for reverting the mouse selection style to that
132         of v2.20 (and prior)
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
150 --enable-256-color
151         add support for 256 colours rather than the base 16 colours
152 --enable-cursor-blink
153         add support for a blinking cursor
154 --enable-pointer-blank
155         add support to have the pointer disappear when typing or inactive
156 --with-name=NAME
157         set the basename for the installed binaries (default: urxvt, resulting
158         in urxvt, urxvtd etc.). Specify --with-name=rxvt to replace rxvt.
159 --with-term=NAME
160         change the environmental variable for the terminal to NAME
161         (default "rxvt")
162 --with-terminfo=PATH
163         change the environmental variable for the path to the terminfo
164         tree to PATH
165 --with-x
166         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