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]
74 --emacslispdir=DIR Emacs code [PREFIX/share/emacs/site-lisp]
76 Additional options are accepted for compatibility with other
77 configure-script calling conventions, but don't do anything yet:
79 --build=<cpu>-<vendor>-<os> Currently ignored
80 --infodir=DIR Currently ignored
81 --localstatedir=DIR Currently ignored
82 --libexecdir=DIR Currently ignored
83 --disable-maintainer-mode Currently ignored
84 --disable-dependency-tracking Currently ignored
89 # Parse command-line options
91 if [ "${option}" = '--help' ] ; then
94 elif [ "${option%%=*}" = '--prefix' ] ; then
96 elif [ "${option%%=*}" = '--libdir' ] ; then
98 elif [ "${option%%=*}" = '--includedir' ] ; then
99 INCLUDEDIR="${option#*=}"
100 elif [ "${option%%=*}" = '--mandir' ] ; then
101 MANDIR="${option#*=}"
102 elif [ "${option%%=*}" = '--sysconfdir' ] ; then
103 SYSCONFDIR="${option#*=}"
104 elif [ "${option%%=*}" = '--emacslispdir' ] ; then
105 EMACSLISPDIR="${option#*=}"
106 elif [ "${option%%=*}" = '--build' ] ; then
107 build_option="${option#*=}"
108 case ${build_option} in
111 echo "Unrecognized value for --build option: ${build_option}"
112 echo "Should be: <cpu>-<vendor>-<os>"
118 build_cpu=${build_option%%-*}
119 build_option=${build_option#*-}
120 build_vendor=${build_option%%-*}
121 build_os=${build_option#*-}
122 elif [ "${option%%=*}" = '--infodir' ] ; then
124 elif [ "${option%%=*}" = '--localstatedir' ] ; then
126 elif [ "${option%%=*}" = '--libexecdir' ] ; then
128 elif [ "${option}" = '--disable-maintainer-mode' ] ; then
130 elif [ "${option}" = '--disable-dependency-tracking' ] ; then
133 echo "Unrecognized option: ${option}"
142 Welcome to Notmuch, a system for indexing, searching and tagging your email.
144 We hope that the process of building and installing notmuch is quick
145 and smooth so that you can soon be reading and processing your email
146 more efficiently than ever.
148 If anything goes wrong in the configure process, you can override any
149 decisions it makes by manually editing the Makefile.config file that
150 it creates. Also please do as much as you can to figure out what could
151 be different on your machine compared to those of the notmuch
152 developers. Then, please email those details to the Notmuch list
153 (notmuch@notmuchmail.org) so that we can hopefully make future
154 versions of notmuch easier for you to use.
156 We'll now investigate your system to verify that all required
157 dependencies are available:
163 if pkg-config --version > /dev/null 2>&1; then
169 printf "Checking for Xapian development files... "
171 for xapian_config in ${XAPIAN_CONFIG}; do
172 if ${xapian_config} --version > /dev/null 2>&1; then
175 xapian_cxxflags=$(${xapian_config} --cxxflags)
176 xapian_ldflags=$(${xapian_config} --libs)
180 if [ ${have_xapian} = "0" ]; then
182 errors=$((errors + 1))
185 printf "Checking for GMime 2.4 development files... "
186 if pkg-config --modversion gmime-2.4 > /dev/null 2>&1; then
189 gmime_cflags=$(pkg-config --cflags gmime-2.4)
190 gmime_ldflags=$(pkg-config --libs gmime-2.4)
191 elif pkg-config --modversion gmime-2.6 > /dev/null 2>&1; then
194 gmime_cflags=$(pkg-config --cflags gmime-2.6)
195 gmime_ldflags=$(pkg-config --libs gmime-2.6)
199 errors=$((errors + 1))
202 printf "Checking for talloc development files... "
203 if pkg-config --modversion talloc > /dev/null 2>&1; then
206 talloc_cflags=$(pkg-config --cflags talloc)
207 talloc_ldflags=$(pkg-config --libs talloc)
212 errors=$((errors + 1))
215 printf "Checking for valgrind development files... "
216 if pkg-config --modversion valgrind > /dev/null 2>&1; then
219 valgrind_cflags=$(pkg-config --cflags valgrind)
221 printf "No (but that's fine).\n"
225 if [ -z "${EMACSLISPDIR}" ]; then
226 if pkg-config --modversion emacs > /dev/null 2>&1; then
227 EMACSLISPDIR=$(pkg-config emacs --variable sitepkglispdir)
229 EMACSLISPDIR='$(prefix)/share/emacs/site-lisp'
233 printf "Checking if emacs is available... "
234 if emacs --quick --batch > /dev/null 2>&1; then
238 printf "No (so will not byte-compile emacs code)\n"
242 printf "Checking for Mac OS X (for shared library)... "
243 if [ `uname` = "Darwin" ] ; then
246 linker_resolves_library_dependencies=0
250 linker_resolves_library_dependencies=1
253 if [ $errors -gt 0 ]; then
256 *** Error: The dependencies of notmuch could not be satisfied. You will
257 need to install the following packages before being able to compile
261 if [ $have_xapian -eq 0 ]; then
262 echo " Xapian library (including development files such as headers)"
263 echo " http://xapian.org/"
265 if [ $have_gmime -eq 0 ]; then
266 echo " GMime 2.4 library (including development files such as headers)"
267 echo " http://spruce.sourceforge.net/gmime/"
269 if [ $have_talloc -eq 0 ]; then
270 echo " The talloc library (including development files such as headers)"
271 echo " http://talloc.samba.org/"
275 With any luck, you're using a modern, package-based operating system
276 that has all of these packages available in the distribution. In that
277 case a simple command will install everything you need. For example:
279 On Debian and similar systems:
281 sudo apt-get install libxapian-dev libgmime-2.4-dev libtalloc-dev
283 Or on Fedora and similar systems:
285 sudo yum install xapian-core-devel gmime-devel libtalloc-devel
287 On other systems, similar commands can be used, but the details of the
288 package names may be different.
291 if [ $have_pkg_config -eq 0 ]; then
293 Note: the pkg-config program is not available. This configure script
294 uses pkg-config to find the compilation flags required to link against
295 the various libraries needed by notmuch. It's possible you simply need
296 to install pkg-config with a command such as:
298 sudo apt-get install pkg-config
300 sudo yum install pkgconfig
302 But if pkg-config is not available for your system, then you will need
303 to modify the configure script to manually set the cflags and ldflags
304 variables to the correct values to link against each library in each
305 case that pkg-config could not be used to determine those values.
310 When you have installed the necessary dependencies, you can run
311 configure again to ensure the packages can be found, or simply run
312 "make" to compile notmuch.
318 printf "Checking for getline... "
319 if ${CC} -o compat/have_getline compat/have_getline.c > /dev/null 2>&1
324 printf "No (will use our own instead).\n"
327 rm -f compat/have_getline
329 printf "Checking for strcasestr... "
330 if ${CC} -o compat/have_strcasestr compat/have_strcasestr.c > /dev/null 2>&1
335 printf "No (will use our own instead).\n"
338 rm -f compat/have_strcasestr
342 All required packages were found. You may now run the following
343 commands to compile and install notmuch:
350 # construct the Makefile.config
351 cat > Makefile.config <<EOF
352 # This Makefile.config was automatically generated by the ./configure
353 # script of notmuch. If the configure script identified anything
354 # incorrectly, then you can edit this file to try to correct things,
355 # but be warned that if configure is run again it will destroy your
356 # changes, (and this could happen by simply calling "make" if the
357 # configure script is updated).
359 # The C compiler to use
362 # The C++ compiler to use
365 # Command to execute emacs from Makefiles
366 EMACS = emacs --quick
368 # Default FLAGS for C compiler (can be overridden by user such as "make CFLAGS=-g")
371 # Default FLAGS for C++ compiler (can be overridden by user such as "make CXXFLAGS=-g")
372 CXXFLAGS = ${CXXFLAGS}
374 # Flags to enable warnings when using the C++ compiler
375 WARN_CXXFLAGS=-Wall -Wextra -Wwrite-strings -Wswitch-enum
377 # Flags to enable warnings when using the C compiler
378 WARN_CFLAGS=\$(WARN_CXXFLAGS) -Wmissing-declarations
380 # The prefix to which notmuch should be installed
383 # The directory to which libraries should be installed
384 libdir = ${LIBDIR:=\$(prefix)/lib}
386 # The directory to which header files should be installed
387 includedir = ${INCLUDEDIR:=\$(prefix)/include}
389 # The directory to which man pages should be installed
390 mandir = ${MANDIR:=\$(prefix)/share/man}
392 # The directory to which read-only (configuration) filesshould be installed
393 sysconfdir = ${SYSCONFDIR:=\$(prefix)/etc}
395 # The directory to which emacs lisp files should be installed
396 emacslispdir=${EMACSLISPDIR}
398 # Whether there's an emacs binary available for byte-compiling
399 HAVE_EMACS = ${have_emacs}
401 # The directory to which desktop files should be installed
402 desktop_dir = \$(prefix)/share/applications
404 # The directory to which bash completions files should be installed
405 bash_completion_dir = \$(sysconfdir)/bash_completion.d
407 # The directory to which zsh completions files should be installed
408 zsh_completion_dir = \$(prefix)/share/zsh/functions/Completion/Unix
410 # Whether the getline function is available (if not, then notmuch will
411 # build its own version)
412 HAVE_GETLINE = ${have_getline}
414 # Whether the strcasestr function is available (if not, then notmuch will
415 # build its own version)
416 HAVE_STRCASESTR = ${have_strcasestr}
418 # Whether we are building on OS X. This will affect how we build the
420 MAC_OS_X = ${mac_os_x}
422 # Whether the linker will automatically resolve the dependency of one
423 # library on another (if not, then linking a binary requires linking
424 # directly against both)
425 LINKER_RESOLVES_LIBRARY_DEPENDENCIES = ${linker_resolves_library_dependencies}
427 # Flags needed to compile and link against Xapian
428 XAPIAN_CXXFLAGS = ${xapian_cxxflags}
429 XAPIAN_LDFLAGS = ${xapian_ldflags}
431 # Flags needed to compile and link against GMime-2.4
432 GMIME_CFLAGS = ${gmime_cflags}
433 GMIME_LDFLAGS = ${gmime_ldflags}
435 # Flags needed to compile and link against talloc
436 TALLOC_CFLAGS = ${talloc_cflags}
437 TALLOC_LDFLAGS = ${talloc_ldflags}
439 # Whether valgrind header files are available
440 HAVE_VALGRIND = ${have_valgrind}
442 # And if so, flags needed at compile time for valgrind macros
443 VALGRIND_CFLAGS = ${valgrind_cflags}
445 # Combined flags for compiling and linking against all of the above
446 CONFIGURE_CFLAGS = -DHAVE_GETLINE=\$(HAVE_GETLINE) \$(GMIME_CFLAGS) \\
447 \$(TALLOC_CFLAGS) -DHAVE_VALGRIND=\$(HAVE_VALGRIND) \\
448 \$(VALGRIND_CFLAGS) -DHAVE_STRCASESTR=\$(HAVE_STRCASESTR)
449 CONFIGURE_CXXFLAGS = -DHAVE_GETLINE=\$(HAVE_GETLINE) \$(GMIME_CFLAGS) \\
450 \$(TALLOC_CFLAGS) -DHAVE_VALGRIND=\$(HAVE_VALGRIND) \\
451 \$(VALGRIND_CFLAGS) \$(XAPIAN_CXXFLAGS) \\
452 -DHAVE_STRCASESTR=\$(HAVE_STRCASESTR)
453 CONFIGURE_LDFLAGS = \$(GMIME_LDFLAGS) \$(TALLOC_LDFLAGS) \$(XAPIAN_LDFLAGS)