3 # Set several defaults (optionally specified by the user in
4 # environemnt variables)
8 CXXFLAGS=${CXXFLAGS:-\$(CFLAGS)}
9 XAPIAN_CONFIG=${XAPIAN_CONFIG:-xapian-config-1.1 xapian-config}
11 # We don't allow the EMACS or GZIP Makefile variables inherit values
12 # from the environment as we do with CC and CXX above. The reason is
13 # that these names as environment variables have existing uses other
14 # than the program name that we want. (EMACS is set to 't' when a
15 # shell is running within emacs and GZIP specifies arguments to pass
16 # on the gzip command line).
18 # Set the defaults for values the user can specify with command-line
26 Usage: ./configure [options]...
28 This script configures notmuch to build on your system.
30 It verifies that dependencies are available, determines flags needed
31 to compile and link against various required libraries, and identifies
32 whether various system functions can be used or if locally-provided
33 replacements will be built instead.
35 Finally, it allows you to control various aspects of the build and
38 First, some common variables can specified via environment variables:
40 CC The C compiler to use
41 CFLAGS Flags to pass to the C compiler
42 CXX The C++ compiler to use
43 CXXFLAGS Flags to pass to the C compiler
44 LDFLAGS Flags to pass when linking
46 Each of these values can further be controlled by specifying them
47 later on the "make" command line.
49 Other environment variables can be used to control configure itself,
50 (and for which there is no equivalent build-time control):
52 XAPIAN_CONFIG The program to use to determine flags for
53 compiling and linking against the Xapian
54 library. [$XAPIAN_CONFIG]
56 Additionally, various options can be specified on the configure
59 --prefix=PREFIX Install files in PREFIX [$PREFIX]
61 By default, "make install" will install the resulting program to
62 $PREFIX/bin, documentation to $PREFIX/man, etc. You can
63 specify an installation prefix other than $PREFIX using
64 --prefix, for instance:
66 ./configure --prefix=\$HOME
68 Fine tuning of some installation directories is available:
70 --libdir=DIR Install libraries to DIR [PREFIX/lib]
71 --includedir=DIR Install header files to DIR [PREFIX/include]
72 --mandir=DIR Install man pages to DIR [PREFIX/share/man]
73 --sysconfdir=DIR Read-only single-machine data [PREFIX/etc]
75 Additional options are accepted for compatibility with other
76 configure-script calling conventions, but don't do anything yet:
78 --build=<cpu>-<vendor>-<os> Currently ignored
83 # Parse command-line options
85 if [ "${option}" = '--help' ] ; then
88 elif [ "${option%%=*}" = '--prefix' ] ; then
90 elif [ "${option%%=*}" = '--libdir' ] ; then
92 elif [ "${option%%=*}" = '--includedir' ] ; then
93 INCLUDEDIR="${option#*=}"
94 elif [ "${option%%=*}" = '--mandir' ] ; then
96 elif [ "${option%%=*}" = '--sysconfdir' ] ; then
97 SYSCONFDIR="${option#*=}"
98 elif [ "${option%%=*}" = '--build' ] ; then
99 build_option="${option#*=}"
100 case ${build_option} in
103 echo "Unrecognized value for --build option: ${build_option}"
104 echo "Should be: <cpu>-<vendor>-<os>"
110 build_cpu=${build_option%%-*}
111 build_option=${build_option#*-}
112 build_vendor=${build_option%%-*}
113 build_os=${build_option#*-}
115 echo "Unrecognized option: ${option}"
124 Welcome to Notmuch, a system for indexing, searching and tagging your email.
126 We hope that the process of building and installing notmuch is quick
127 and smooth so that you can soon be reading and processing your email
128 more efficiently than ever.
130 If anything goes wrong in the configure process, you can override any
131 decisions it makes by manually editing the Makefile.config file that
132 it creates. Also please do as much as you can to figure out what could
133 be different on your machine compared to those of the notmuch
134 developers. Then, please email those details to the Notmuch list
135 (notmuch@notmuchmail.org) so that we can hopefully make future
136 versions of notmuch easier for you to use.
138 We'll now investigate your system to verify that all required
139 dependencies are available:
145 if pkg-config --version > /dev/null 2>&1; then
151 printf "Checking for Xapian development files... "
153 for xapian_config in ${XAPIAN_CONFIG}; do
154 if ${xapian_config} --version > /dev/null 2>&1; then
157 xapian_cxxflags=$(${xapian_config} --cxxflags)
158 xapian_ldflags=$(${xapian_config} --libs)
162 if [ ${have_xapian} = "0" ]; then
164 errors=$((errors + 1))
167 printf "Checking for GMime 2.4 development files... "
168 if pkg-config --modversion gmime-2.4 > /dev/null 2>&1; then
171 gmime_cflags=$(pkg-config --cflags gmime-2.4)
172 gmime_ldflags=$(pkg-config --libs gmime-2.4)
176 errors=$((errors + 1))
179 printf "Checking for talloc development files... "
180 if pkg-config --modversion talloc > /dev/null 2>&1; then
183 talloc_cflags=$(pkg-config --cflags talloc)
184 talloc_ldflags=$(pkg-config --libs talloc)
189 errors=$((errors + 1))
192 printf "Checking for valgrind development files... "
193 if pkg-config --modversion valgrind > /dev/null 2>&1; then
196 valgrind_cflags=$(pkg-config --cflags valgrind)
198 printf "No (but that's fine).\n"
202 if pkg-config --modversion emacs > /dev/null 2>&1; then
203 emacs_lispdir=$(pkg-config emacs --variable sitepkglispdir)
205 emacs_lispdir='$(prefix)/share/emacs/site-lisp'
208 printf "Checking if emacs is available... "
209 if emacs --quick --batch > /dev/null 2>&1; then
213 printf "No (so will not byte-compile emacs code)\n"
217 if [ $errors -gt 0 ]; then
220 *** Error: The dependencies of notmuch could not be satisfied. You will
221 need to install the following packages before being able to compile
225 if [ $have_xapian -eq 0 ]; then
226 echo " Xapian library (including development files such as headers)"
227 echo " http://xapian.org/"
229 if [ $have_gmime -eq 0 ]; then
230 echo " GMime 2.4 library (including development files such as headers)"
231 echo " http://spruce.sourceforge.net/gmime/"
233 if [ $have_talloc -eq 0 ]; then
234 echo " The talloc library (including development files such as headers)"
235 echo " http://talloc.samba.org/"
239 With any luck, you're using a modern, package-based operating system
240 that has all of these packages available in the distribution. In that
241 case a simple command will install everything you need. For example:
243 On Debian and similar systems:
245 sudo apt-get install libxapian-dev libgmime-2.4-dev libtalloc-dev
247 Or on Fedora and similar systems:
249 sudo yum install xapian-core-devel gmime-devel libtalloc-devel
251 On other systems, similar commands can be used, but the details of the
252 package names may be different.
255 if [ $have_pkg_config -eq 0 ]; then
257 Note: the pkg-config program is not available. This configure script
258 uses pkg-config to find the compilation flags required to link against
259 the various libraries needed by notmuch. It's possible you simply need
260 to install pkg-config with a command such as:
262 sudo apt-get install pkg-config
264 sudo yum install pkgconfig
266 But if pkg-config is not available for your system, then you will need
267 to modify the configure script to manually set the cflags and ldflags
268 variables to the correct values to link against each library in each
269 case that pkg-config could not be used to determine those values.
274 When you have installed the necessary dependencies, you can run
275 configure again to ensure the packages can be found, or simply run
276 "make" to compile notmuch.
282 printf "Checking for getline... "
283 if ${CC} -o compat/have_getline compat/have_getline.c > /dev/null 2>&1
288 printf "No (will use our own instead).\n"
291 rm -f compat/have_getline
295 All required packages were found. You may now run the following
296 commands to compile and install notmuch:
303 # construct the Makefile.config
304 cat > Makefile.config <<EOF
305 # This Makefile.config was automatically generated by the ./configure
306 # script of notmuch. If the configure script identified anything
307 # incorrectly, then you can edit this file to try to correct things,
308 # but be warned that if configure is run again it will destroy your
309 # changes, (and this could happen by simply calling "make" if the
310 # configure script is updated).
312 # The C compiler to use
315 # The C++ compiler to use
318 # Command to execute emacs from Makefiles
319 EMACS = emacs --quick
321 # Default FLAGS for C compiler (can be overridden by user such as "make CFLAGS=-g")
324 # Default FLAGS for C++ compiler (can be overridden by user such as "make CXXFLAGS=-g")
325 CXXFLAGS = ${CXXFLAGS}
327 # Flags to enable warnings when using the C++ compiler
328 WARN_CXXFLAGS=-Wall -Wextra -Wwrite-strings -Wswitch-enum
330 # Flags to enable warnings when using the C compiler
331 WARN_CFLAGS=\$(WARN_CXXFLAGS) -Wmissing-declarations
333 # The prefix to which notmuch should be installed
336 # The directory to which libraries should be installed
337 libdir = ${LIBDIR:=\$(prefix)/lib}
339 # The directory to which header files should be installed
340 includedir = ${INCLUDEDIR:=\$(prefix)/lib}
342 # The directory to which man pages should be installed
343 mandir = ${MANDIR:=\$(prefix)/share/man}
345 # The directory to which read-only (configuration) filesshould be installed
346 sysconfdir = ${SYSCONFDIR:=\$(prefix)/etc}
348 # The directory to which emacs lisp files should be installed
349 emacs_lispdir=${emacs_lispdir}
351 # Whether there's an emacs binary available for byte-compiling
352 HAVE_EMACS = ${have_emacs}
354 # The directory to which desktop files should be installed
355 desktop_dir = \$(prefix)/share/applications
357 # The directory to which bash completions files should be installed
358 bash_completion_dir = \$(sysconfdir)/bash_completion.d
360 # The directory to which zsh completions files should be installed
361 zsh_completion_dir = \$(prefix)/share/zsh/functions/Completion/Unix
363 # Whether the getline function is available (if not, then notmuch will
364 # build its own version)
365 HAVE_GETLINE = ${have_getline}
367 # Flags needed to compile and link against Xapian
368 XAPIAN_CXXFLAGS = ${xapian_cxxflags}
369 XAPIAN_LDFLAGS = ${xapian_ldflags}
371 # Flags needed to compile and link against GMime-2.4
372 GMIME_CFLAGS = ${gmime_cflags}
373 GMIME_LDFLAGS = ${gmime_ldflags}
375 # Flags needed to compile and link against talloc
376 TALLOC_CFLAGS = ${talloc_cflags}
377 TALLOC_LDFLAGS = ${talloc_ldflags}
379 # Whether valgrind header files are available
380 HAVE_VALGRIND = ${have_valgrind}
382 # And if so, flags needed at compile time for valgrind macros
383 VALGRIND_CFLAGS = ${valgrind_cflags}
385 # Combined flags for compiling and linking against all of the above
386 CONFIGURE_CFLAGS = -DHAVE_GETLINE=\$(HAVE_GETLINE) \$(GMIME_CFLAGS) \\
387 \$(TALLOC_CFLAGS) -DHAVE_VALGRIND=\$(HAVE_VALGRIND) \\
389 CONFIGURE_CXXFLAGS = -DHAVE_GETLINE=\$(HAVE_GETLINE) \$(GMIME_CFLAGS) \\
390 \$(TALLOC_CFLAGS) -DHAVE_VALGRIND=\$(HAVE_VALGRIND) \\
391 \$(VALGRIND_CFLAGS) \$(XAPIAN_CXXFLAGS)
392 CONFIGURE_LDFLAGS = \$(GMIME_LDFLAGS) \$(TALLOC_LDFLAGS) \$(XAPIAN_LDFLAGS)