5 # Test whether this shell is capable of parameter substring processing.
6 ( option='a/b'; : ${option#*/} ) 2>/dev/null || {
8 The shell interpreting '$0' is lacking some required features.
10 To work around this problem you may try to execute:
19 # Store original IFS value so it can be changed (and restored) in many places.
20 readonly DEFAULT_IFS="$IFS"
22 # The top-level directory for the source. This ./configure and all Makefiles
23 # are good with ${srcdir} usually being relative. Some components (e.g. tests)
24 # are executed in subdirectories and for those it is simpler to use
25 # ${NOTMUCH_SRCDIR} which holds absolute path to the source.
26 srcdir=$(dirname "$0")
27 NOTMUCH_SRCDIR=$(cd "$srcdir" && pwd)
29 case $NOTMUCH_SRCDIR in ( *\'* | *['\"`$']* )
30 echo "Definitely unsafe characters in source path '$NOTMUCH_SRCDIR'".
34 case $PWD in ( *\'* | *['\"`$']* )
35 echo "Definitely unsafe characters in current directory '$PWD'".
39 # In case of whitespace, builds may work, tests definitely will not.
40 case $NOTMUCH_SRCDIR in ( *["$IFS"]* )
41 echo "Whitespace in source path '$NOTMUCH_SRCDIR' not supported".
45 case $PWD in ( *["$IFS"]* )
46 echo "Whitespace in current directory '$PWD' not supported".
50 subdirs="util compat lib parse-time-string completion doc emacs"
51 subdirs="${subdirs} performance-test test test/test-databases"
52 subdirs="${subdirs} bindings"
54 # For a non-srcdir configure invocation (such as ../configure), create
55 # the directory structure and copy Makefiles.
56 if [ "$srcdir" != "." ]; then
58 for dir in . ${subdirs}; do
60 cp "$srcdir"/"$dir"/Makefile.local "$dir"
61 cp "$srcdir"/"$dir"/Makefile "$dir"
64 # Emacs only likes to generate compiled files next to the .el files
65 # by default so copy these as well (which is not ideal).
66 cp -a "$srcdir"/emacs/*.el emacs
68 # We were not able to create fully working Makefile using ruby mkmf.rb
69 # so ruby bindings source files are copied as well (ditto -- not ideal).
71 cp -a "$srcdir"/bindings/ruby/*.[ch] bindings/ruby
72 cp -a "$srcdir"/bindings/ruby/extconf.rb bindings/ruby
74 # Use the same hack to replicate python-cffi source for
75 # out-of-tree builds (again, not ideal).
76 mkdir bindings/python-cffi
77 cp -a "$srcdir"/bindings/python-cffi/tests \
78 "$srcdir"/bindings/python-cffi/notmuch2 \
79 "$srcdir"/bindings/python-cffi/setup.py \
83 # Set several defaults (optionally specified by the user in
84 # environment variables)
85 BASHCMD=${BASHCMD:-bash}
89 CFLAGS=${CFLAGS:--g -O2}
90 CPPFLAGS=${CPPFLAGS:-}
91 CXXFLAGS_for_sh=${CXXFLAGS:-${CFLAGS}}
92 CXXFLAGS=${CXXFLAGS:-\$(CFLAGS)}
94 XAPIAN_CONFIG=${XAPIAN_CONFIG:-}
98 # We don't allow the EMACS or GZIP Makefile variables inherit values
99 # from the environment as we do with CC and CXX above. The reason is
100 # that these names as environment variables have existing uses other
101 # than the program name that we want. (EMACS is set to 't' when a
102 # shell is running within emacs and GZIP specifies arguments to pass
103 # on the gzip command line).
105 # Set the defaults for values the user can specify with command-line
122 Usage: ./configure [options]...
124 This script configures notmuch to build on your system.
126 It verifies that dependencies are available, determines flags needed
127 to compile and link against various required libraries, and identifies
128 whether various system functions can be used or if locally-provided
129 replacements will be built instead.
131 Finally, it allows you to control various aspects of the build and
132 installation process.
134 First, some common variables can specified via environment variables:
136 CC The C compiler to use
137 CFLAGS Flags to pass to the C compiler
138 CPPFLAGS Flags to pass to the C preprocessor
139 CXX The C++ compiler to use
140 CXXFLAGS Flags to pass to the C compiler
141 LDFLAGS Flags to pass when linking
143 Each of these values can further be controlled by specifying them
144 later on the "make" command line.
146 Other environment variables can be used to control configure itself,
147 (and for which there is no equivalent build-time control):
149 XAPIAN_CONFIG The program to use to determine flags for
150 compiling and linking against the Xapian
151 library. [$XAPIAN_CONFIG]
152 PYTHON Name of python command to use in
153 configure and the test suite.
154 RUBY Name of ruby command to use in
155 configure and the test suite.
157 Additionally, various options can be specified on the configure
160 --prefix=PREFIX Install files in PREFIX [$PREFIX]
162 By default, "make install" will install the resulting program to
163 $PREFIX/bin, documentation to $PREFIX/man, etc. You can
164 specify an installation prefix other than $PREFIX using
165 --prefix, for instance:
167 ./configure --prefix=\$HOME
169 Fine tuning of some installation directories is available:
171 --libdir=DIR Install libraries to DIR [PREFIX/lib]
172 --includedir=DIR Install header files to DIR [PREFIX/include]
173 --mandir=DIR Install man pages to DIR [PREFIX/share/man]
174 --infodir=DIR Install man pages to DIR [PREFIX/share/man]
175 --sysconfdir=DIR Read-only single-machine data [PREFIX/etc]
176 --emacslispdir=DIR Emacs code [PREFIX/share/emacs/site-lisp]
177 --emacsetcdir=DIR Emacs miscellaneous files [PREFIX/share/emacs/site-lisp]
178 --bashcompletiondir=DIR Bash completions files [PREFIX/share/bash-completion/completions]
179 --zshcompletiondir=DIR Zsh completions files [PREFIX/share/zsh/site-functions]
181 Some features can be disabled (--with-feature=no is equivalent to
184 --without-bash-completion Do not install bash completions files
185 --without-docs Do not install documentation
186 --without-api-docs Do not install API man page
187 --without-emacs Do not install lisp file
188 --without-desktop Do not install desktop file
189 --without-ruby Do not install ruby bindings
190 --without-zsh-completion Do not install zsh completions files
191 --without-retry-lock Do not use blocking xapian opens, even if available
193 Additional options are accepted for compatibility with other
194 configure-script calling conventions, but don't do anything yet:
196 --build=<cpu>-<vendor>-<os> Currently ignored
197 --host=<cpu>-<vendor>-<os> Currently ignored
198 --datadir=DIR Currently ignored
199 --localstatedir=DIR Currently ignored
200 --libexecdir=DIR Currently ignored
201 --disable-maintainer-mode Currently ignored
202 --disable-dependency-tracking Currently ignored
207 # Parse command-line options
209 if [ "${option}" = '--help' ] ; then
212 elif [ "${option%%=*}" = '--prefix' ] ; then
213 PREFIX="${option#*=}"
214 elif [ "${option%%=*}" = '--libdir' ] ; then
215 LIBDIR="${option#*=}"
216 elif [ "${option%%=*}" = '--includedir' ] ; then
217 INCLUDEDIR="${option#*=}"
218 elif [ "${option%%=*}" = '--mandir' ] ; then
219 MANDIR="${option#*=}"
220 elif [ "${option%%=*}" = '--infodir' ] ; then
221 INFODIR="${option#*=}"
222 elif [ "${option%%=*}" = '--sysconfdir' ] ; then
223 SYSCONFDIR="${option#*=}"
224 elif [ "${option%%=*}" = '--emacslispdir' ] ; then
225 EMACSLISPDIR="${option#*=}"
226 elif [ "${option%%=*}" = '--emacsetcdir' ] ; then
227 EMACSETCDIR="${option#*=}"
228 elif [ "${option%%=*}" = '--bashcompletiondir' ] ; then
229 BASHCOMPLETIONDIR="${option#*=}"
230 elif [ "${option%%=*}" = '--zshcompletiondir' ] ; then
231 ZSHCOMLETIONDIR="${option#*=}"
232 elif [ "${option%%=*}" = '--with-docs' ]; then
233 if [ "${option#*=}" = 'no' ]; then
239 elif [ "${option}" = '--without-docs' ] ; then
242 elif [ "${option%%=*}" = '--with-api-docs' ]; then
243 if [ "${option#*=}" = 'no' ]; then
248 elif [ "${option}" = '--without-api-docs' ] ; then
250 elif [ "${option%%=*}" = '--with-emacs' ]; then
251 if [ "${option#*=}" = 'no' ]; then
256 elif [ "${option}" = '--without-emacs' ] ; then
258 elif [ "${option%%=*}" = '--with-desktop' ]; then
259 if [ "${option#*=}" = 'no' ]; then
264 elif [ "${option}" = '--without-desktop' ] ; then
266 elif [ "${option%%=*}" = '--with-bash-completion' ]; then
267 if [ "${option#*=}" = 'no' ]; then
272 elif [ "${option}" = '--without-bash-completion' ] ; then
274 elif [ "${option%%=*}" = '--with-rpath' ]; then
275 if [ "${option#*=}" = 'no' ]; then
280 elif [ "${option}" = '--without-rpath' ] ; then
282 elif [ "${option%%=*}" = '--with-ruby' ]; then
283 if [ "${option#*=}" = 'no' ]; then
288 elif [ "${option}" = '--without-ruby' ] ; then
290 elif [ "${option%%=*}" = '--with-retry-lock' ]; then
291 if [ "${option#*=}" = 'no' ]; then
296 elif [ "${option}" = '--without-retry-lock' ] ; then
298 elif [ "${option%%=*}" = '--with-zsh-completion' ]; then
299 if [ "${option#*=}" = 'no' ]; then
304 elif [ "${option}" = '--without-zsh-completion' ] ; then
306 elif [ "${option%%=*}" = '--build' ] ; then
308 elif [ "${option%%=*}" = '--host' ] ; then
310 elif [ "${option%%=*}" = '--datadir' ] ; then
312 elif [ "${option%%=*}" = '--localstatedir' ] ; then
314 elif [ "${option%%=*}" = '--libexecdir' ] ; then
316 elif [ "${option}" = '--disable-maintainer-mode' ] ; then
318 elif [ "${option}" = '--disable-dependency-tracking' ] ; then
321 echo "Unrecognized option: ${option}"
329 # We set this value early, (rather than just while printing the
330 # Makefile.config file later like most values), because we need to
331 # actually investigate this value compared to the ldconfig_paths value
333 if [ -z "$LIBDIR" ] ; then
334 libdir_expanded="${PREFIX}/lib"
336 # very non-general variable expansion
337 libdir_expanded=$(printf %s "$LIBDIR" | sed "s|\${prefix}|${PREFIX}|; s|\$prefix\>|${PREFIX}|; s|//*|/|g")
341 Welcome to Notmuch, a system for indexing, searching and tagging your email.
343 We hope that the process of building and installing notmuch is quick
344 and smooth so that you can soon be reading and processing your email
345 more efficiently than ever.
347 If anything goes wrong in the configure process, you can override any
348 decisions it makes by manually editing the Makefile.config file that
349 it creates. Also please do as much as you can to figure out what could
350 be different on your machine compared to those of the notmuch
351 developers. Then, please email those details to the Notmuch list
352 (notmuch@notmuchmail.org) so that we can hopefully make future
353 versions of notmuch easier for you to use.
355 We'll now investigate your system to verify that all required
356 dependencies are available:
361 printf "int main(void){return 0;}\n" > minimal.c
363 printf "Sanity checking C compilation environment... "
364 test_cmdline="${CC} ${CFLAGS} ${CPPFLAGS} minimal.c ${LDFLAGS} -o minimal"
365 if ${test_cmdline} > /dev/null 2>&1
370 errors=$((errors + 1))
371 printf Executed:; printf ' %s' ${test_cmdline}; echo
375 printf "Sanity checking C++ compilation environment... "
376 test_cmdline="${CXX} ${CXXFLAGS_for_sh} ${CPPFLAGS} minimal.c ${LDFLAGS} -o minimal"
377 if ${test_cmdline} > /dev/null 2>&1
382 errors=$((errors + 1))
383 printf Executed:; printf ' %s' ${test_cmdline}; echo
388 if [ $errors -gt 0 ]; then
390 *** Error: Initial sanity checking of environment failed. Please try
391 running configure in a clean environment, and if the problem persists,
394 rm -f minimal minimal.c
398 printf "Reading libnotmuch version from source... "
399 cat > _libversion.c <<EOF
401 #include "lib/notmuch.h"
403 printf("libnotmuch_version_major=%d\n",
404 LIBNOTMUCH_MAJOR_VERSION);
405 printf("libnotmuch_version_minor=%d\n",
406 LIBNOTMUCH_MINOR_VERSION);
407 printf("libnotmuch_version_release=%d\n",
408 LIBNOTMUCH_MICRO_VERSION);
412 if ${CC} ${CFLAGS} -I"$srcdir" _libversion.c -o _libversion > /dev/null 2>&1 \
413 && ./_libversion > _libversion.sh && . ./_libversion.sh
419 *** Error: Reading lib/notmuch.h failed.
420 Please try running configure again in a clean environment, and if the
421 problem persists, report a bug.
423 rm -f _libversion _libversion.c _libversion.sh
427 if pkg-config --version > /dev/null 2>&1; then
435 printf "Checking for Xapian development files (>= 1.4.0)... "
437 for xapian_config in ${XAPIAN_CONFIG} xapian-config; do
438 if ${xapian_config} --version > /dev/null 2>&1; then
439 xapian_version=$(${xapian_config} --version | sed -e 's/.* //')
440 case $xapian_version in
441 1.[4-9]* | 1.[1-9][0-9]* | [2-9]* | [1-9][0-9]*)
442 printf "Yes (%s).\n" ${xapian_version}
444 xapian_cxxflags=$(${xapian_config} --cxxflags)
445 xapian_ldflags=$(${xapian_config} --libs)
447 *) printf "Xapian $xapian_version not supported... "
452 if [ ${have_xapian} = "0" ]; then
454 errors=$((errors + 1))
457 if [ ${have_xapian} = "1" ]; then
458 default_xapian_backend=""
459 printf "Testing default Xapian backend... "
460 cat >_default_backend.cc <<EOF
462 int main(int argc, char** argv) {
463 Xapian::WritableDatabase db("test.db",Xapian::DB_CREATE_OR_OPEN);
466 ${CXX} ${CXXFLAGS_for_sh} ${xapian_cxxflags} _default_backend.cc -o _default_backend ${xapian_ldflags}
468 if [ -f test.db/iamglass ]; then
469 default_xapian_backend=glass
471 default_xapian_backend=chert
473 printf "%s\n" "${default_xapian_backend}";
474 rm -rf test.db _default_backend _default_backend.cc
479 printf "Checking for GMime development files (>= $GMIME_MINVER)... "
480 if pkg-config --exists "gmime-3.0 >= $GMIME_MINVER"; then
483 gmime_cflags=$(pkg-config --cflags gmime-3.0)
484 gmime_ldflags=$(pkg-config --libs gmime-3.0)
486 printf "Checking for GMime session key extraction support... "
488 cat > _check_session_keys.c <<EOF
489 #include <gmime/gmime.h>
493 GError *error = NULL;
494 GMimeParser *parser = NULL;
495 GMimeMultipartEncrypted *body = NULL;
496 GMimeDecryptResult *decrypt_result = NULL;
497 GMimeObject *output = NULL;
500 parser = g_mime_parser_new ();
501 g_mime_parser_init_with_stream (parser, g_mime_stream_file_open("$srcdir/test/corpora/crypto/basic-encrypted.eml", "r", &error));
502 if (error) return !! fprintf (stderr, "failed to instantiate parser with test/corpora/crypto/basic-encrypted.eml\n");
504 body = GMIME_MULTIPART_ENCRYPTED(g_mime_message_get_mime_part (g_mime_parser_construct_message (parser, NULL)));
505 if (body == NULL) return !! fprintf (stderr, "did not find a multipart encrypted message\n");
507 output = g_mime_multipart_encrypted_decrypt (body, GMIME_DECRYPT_EXPORT_SESSION_KEY, NULL, &decrypt_result, &error);
508 if (error || output == NULL) return !! fprintf (stderr, "decryption failed\n");
510 if (decrypt_result == NULL) return !! fprintf (stderr, "no GMimeDecryptResult found\n");
511 if (decrypt_result->session_key == NULL) return !! fprintf (stderr, "GMimeDecryptResult has no session key\n");
513 printf ("%s\n", decrypt_result->session_key);
517 if ! TEMP_GPG=$(mktemp -d "${TMPDIR:-/tmp}/notmuch.XXXXXX"); then
518 printf 'No.\nCould not make tempdir for testing session-key support.\n'
519 errors=$((errors + 1))
520 elif ${CC} ${CFLAGS} ${gmime_cflags} _check_session_keys.c ${gmime_ldflags} -o _check_session_keys \
521 && GNUPGHOME=${TEMP_GPG} gpg --batch --quiet --import < "$srcdir"/test/gnupg-secret-key.asc \
522 && SESSION_KEY=$(GNUPGHOME=${TEMP_GPG} ./_check_session_keys) \
523 && [ $SESSION_KEY = 9:0BACD64099D1468AB07C796F0C0AC4851948A658A15B34E803865E9FC635F2F5 ]
529 *** Error: Could not extract session keys from encrypted message.
531 This is likely due to your GMime having been built against a old
534 Please try to rebuild your version of GMime against a more recent
535 version of GPGME (at least GPGME 1.8.0).
537 if command -v gpgme-config >/dev/null; then
538 printf 'Your current GPGME development version is: %s\n' "$(gpgme-config --version)"
540 printf 'You do not have the GPGME development libraries installed.\n'
542 errors=$((errors + 1))
544 if [ -n "$TEMP_GPG" -a -d "$TEMP_GPG" ]; then
548 # see https://github.com/jstedfast/gmime/pull/90
549 # should be fixed in GMime in 3.2.7, but some distros might patch
550 printf "Checking for GMime X.509 certificate validity... "
552 cat > _check_x509_validity.c <<EOF
554 #include <gmime/gmime.h>
557 GError *error = NULL;
558 GMimeParser *parser = NULL;
559 GMimeApplicationPkcs7Mime *body = NULL;
560 GMimeSignatureList *sig_list = NULL;
561 GMimeSignature *sig = NULL;
562 GMimeCertificate *cert = NULL;
563 GMimeObject *output = NULL;
564 GMimeValidity validity = GMIME_VALIDITY_UNKNOWN;
568 parser = g_mime_parser_new ();
569 g_mime_parser_init_with_stream (parser, g_mime_stream_file_open("$srcdir/test/corpora/pkcs7/smime-onepart-signed.eml", "r", &error));
570 if (error) return !! fprintf (stderr, "failed to instantiate parser with test/corpora/pkcs7/smime-onepart-signed.eml\n");
572 body = GMIME_APPLICATION_PKCS7_MIME(g_mime_message_get_mime_part (g_mime_parser_construct_message (parser, NULL)));
573 if (body == NULL) return !! fprintf (stderr, "did not find a application/pkcs7 message\n");
575 sig_list = g_mime_application_pkcs7_mime_verify (body, GMIME_VERIFY_NONE, &output, &error);
576 if (error || output == NULL) return !! fprintf (stderr, "verify failed\n");
578 if (sig_list == NULL) return !! fprintf (stderr, "no GMimeSignatureList found\n");
579 len = g_mime_signature_list_length (sig_list);
580 if (len != 1) return !! fprintf (stderr, "expected 1 signature, got %d\n", len);
581 sig = g_mime_signature_list_get_signature (sig_list, 0);
582 if (sig == NULL) return !! fprintf (stderr, "no GMimeSignature found at position 0\n");
583 cert = g_mime_signature_get_certificate (sig);
584 if (cert == NULL) return !! fprintf (stderr, "no GMimeCertificate found\n");
585 validity = g_mime_certificate_get_id_validity (cert);
586 if (validity != GMIME_VALIDITY_FULL) return !! fprintf (stderr, "Got validity %d, expected %d\n", validity, GMIME_VALIDITY_FULL);
591 if ! TEMP_GPG=$(mktemp -d "${TMPDIR:-/tmp}/notmuch.XXXXXX"); then
592 printf 'No.\nCould not make tempdir for testing X.509 certificate validity support.\n'
593 errors=$((errors + 1))
594 elif ${CC} ${CFLAGS} ${gmime_cflags} _check_x509_validity.c ${gmime_ldflags} -o _check_x509_validity \
595 && echo disable-crl-checks > "$TEMP_GPG/gpgsm.conf" \
596 && echo "4D:E0:FF:63:C0:E9:EC:01:29:11:C8:7A:EE:DA:3A:9A:7F:6E:C1:0D S" >> "$TEMP_GPG/trustlist.txt" \
597 && GNUPGHOME=${TEMP_GPG} gpgsm --batch --quiet --import < "$srcdir"/test/smime/ca.crt
599 if GNUPGHOME=${TEMP_GPG} ./_check_x509_validity; then
600 gmime_x509_cert_validity=1
603 gmime_x509_cert_validity=0
605 if pkg-config --exists "gmime-3.0 >= 3.2.7"; then
607 *** Error: GMime fails to calculate X.509 certificate validity, and
608 is later than 3.2.7, which should have fixed this issue.
610 Please follow up on https://github.com/jstedfast/gmime/pull/90 with
613 errors=$((errors + 1))
617 printf 'No.\nFailed to set up gpgsm for testing X.509 certificate validity support.\n'
618 errors=$((errors + 1))
620 if [ -n "$TEMP_GPG" -a -d "$TEMP_GPG" ]; then
626 errors=$((errors + 1))
629 # GMime already depends on Glib >= 2.12, but we use at least one Glib
630 # function that only exists as of 2.22, (g_array_unref)
631 printf "Checking for Glib development files (>= 2.22)... "
633 if pkg-config --exists 'glib-2.0 >= 2.22'; then
636 # these are included in gmime cflags and ldflags
637 # glib_cflags=$(pkg-config --cflags glib-2.0)
638 # glib_ldflags=$(pkg-config --libs glib-2.0)
641 errors=$((errors + 1))
644 if ! pkg-config --exists zlib; then
645 ${CC} -o compat/gen_zlib_pc "$srcdir"/compat/gen_zlib_pc.c >/dev/null 2>&1 &&
646 compat/gen_zlib_pc > compat/zlib.pc &&
647 PKG_CONFIG_PATH=${PKG_CONFIG_PATH:+$PKG_CONFIG_PATH:}compat &&
648 export PKG_CONFIG_PATH
649 rm -f compat/gen_zlib_pc
652 printf "Checking for zlib (>= 1.2.5.2)... "
654 if pkg-config --atleast-version=1.2.5.2 zlib; then
657 zlib_cflags=$(pkg-config --cflags zlib)
658 zlib_ldflags=$(pkg-config --libs zlib)
661 errors=$((errors + 1))
664 printf "Checking for talloc development files... "
665 if pkg-config --exists talloc; then
668 talloc_cflags=$(pkg-config --cflags talloc)
669 talloc_ldflags=$(pkg-config --libs talloc)
674 errors=$((errors + 1))
677 printf "Checking for bash... "
678 if command -v ${BASHCMD} > /dev/null; then
680 bash_absolute=$(command -v ${BASHCMD})
681 printf "Yes (%s).\n" "$bash_absolute"
684 printf "No. (%s not found)\n" "${BASHCMD}"
687 printf "Checking for perl... "
688 if command -v ${PERL} > /dev/null; then
690 perl_absolute=$(command -v ${PERL})
691 printf "Yes (%s).\n" "$perl_absolute"
694 printf "No. (%s not found)\n" "${PERL}"
697 printf "Checking for python... "
700 for name in ${PYTHON} python3 python python2; do
701 if command -v $name > /dev/null; then
704 printf "Yes (%s).\n" "$name"
709 if [ $have_python -eq 0 ]; then
711 errors=$((errors + 1))
715 if [ $have_python -eq 1 ]; then
716 printf "Checking for python3 (>= 3.5)..."
717 if "$python" -c 'import sys, sysconfig; assert sys.version_info >= (3,5)'; >/dev/null 2>&1; then
721 printf "No (will not install CFFI-based python bindings).\n"
726 have_python3_pytest=0
727 if [ $have_python3 -eq 1 ]; then
728 printf "Checking for python3 cffi and setuptools... "
729 if "$python" -c 'import cffi,setuptools; cffi.FFI().verify()' >/dev/null 2>&1; then
733 printf "No (will not install CFFI-based python bindings).\n"
735 rm -rf __pycache__ # cffi.FFI().verify() uses this space
737 printf "Checking for python3 pytest (>= 3.0)... "
739 printf "[pytest]\nminversion=3.0\n" > $conf
740 if pytest-3 -c $conf --version >/dev/null 2>&1; then
742 have_python3_pytest=1
744 printf "No (will not test CFFI-based python bindings).\n"
749 printf "Checking for valgrind development files... "
750 if pkg-config --exists valgrind; then
753 valgrind_cflags=$(pkg-config --cflags valgrind)
755 printf "No (but that's fine).\n"
760 printf "Checking for bash-completion (>= 1.90)... "
761 if pkg-config --atleast-version=1.90 bash-completion; then
764 printf "No (will not install bash completion).\n"
768 if [ -z "${EMACSLISPDIR-}" ]; then
769 EMACSLISPDIR="\$(prefix)/share/emacs/site-lisp"
772 if [ -z "${EMACSETCDIR-}" ]; then
773 EMACSETCDIR="\$(prefix)/share/emacs/site-lisp"
776 if [ $WITH_EMACS = "1" ]; then
777 printf "Checking if emacs (>= 24) is available... "
778 if emacs --quick --batch --eval '(if (< emacs-major-version 24) (kill-emacs 1))' > /dev/null 2>&1; then
781 printf "No (disabling emacs related parts of build)\n"
787 if [ $WITH_API_DOCS = "1" ] ; then
788 printf "Checking if doxygen is available... "
789 if command -v doxygen > /dev/null; then
793 printf "No (so will not install api docs)\n"
798 if [ $WITH_RUBY = "1" ] ; then
799 printf "Checking for ruby development files... "
800 if ${RUBY} -e "require 'mkmf'"> /dev/null 2>&1; then
804 printf "No (skipping ruby bindings)\n"
811 if [ $WITH_DOCS = "1" ] ; then
812 printf "Checking if sphinx is available and supports nroff output... "
813 if command -v sphinx-build > /dev/null && ${python} -m sphinx.writers.manpage > /dev/null 2>&1 ; then
817 printf "No (so will not install man pages).\n"
819 printf "Checking if makeinfo is available... "
820 if command -v makeinfo > /dev/null; then
824 printf "No (so will not build info pages).\n"
826 printf "Checking if install-info is available... "
827 if command -v install-info > /dev/null; then
831 printf "No (so will not install info pages).\n"
835 if [ $WITH_DESKTOP = "1" ]; then
836 printf "Checking if desktop-file-install is available... "
837 if command -v desktop-file-install > /dev/null; then
840 printf "No (so will not install .desktop file).\n"
845 printf "Checking for cppcheck... "
846 if command -v cppcheck > /dev/null; then
856 printf "Checking which platform we are on... "
858 if [ $uname = "Darwin" ] ; then
861 linker_resolves_library_dependencies=0
862 elif [ $uname = "SunOS" ] ; then
865 linker_resolves_library_dependencies=0
866 elif [ $uname = "FreeBSD" ] ; then
869 linker_resolves_library_dependencies=0
870 elif [ $uname = "OpenBSD" ] ; then
873 linker_resolves_library_dependencies=0
874 elif [ $uname = "Linux" ] || [ $uname = "GNU" ] ; then
875 printf "%s\n" "$uname"
877 linker_resolves_library_dependencies=1
879 printf "Checking for %s in ldconfig... " "$libdir_expanded"
880 ldconfig_paths=$(/sbin/ldconfig -N -X -v 2>/dev/null | sed -n -e 's,^\(/.*\):\( (.*)\)\?$,\1,p')
881 # Separate ldconfig_paths only on newline (not on any potential
882 # embedded space characters in any filenames). Note, we use a
883 # literal newline in the source here rather than something like:
887 # because the shell's command substitution deletes any trailing newlines.
890 for path in $ldconfig_paths; do
891 if [ "$path" -ef "$libdir_expanded" ]; then
896 if [ "$libdir_in_ldconfig" = '0' ]; then
897 printf "No (will set RPATH)\n"
904 linker_resolves_library_dependencies=0
907 *** Warning: Unknown platform. Notmuch might or might not build correctly.
912 if [ $errors -gt 0 ]; then
915 *** Error: The dependencies of notmuch could not be satisfied. You will
916 need to install the following packages before being able to compile
920 if [ $have_python -eq 0 ]; then
921 echo " python interpreter"
923 if [ $have_xapian -eq 0 ]; then
924 echo " Xapian library (>= version 1.4.0, including development files such as headers)"
925 echo " https://xapian.org/"
927 if [ $have_zlib -eq 0 ]; then
928 echo " zlib library (>= version 1.2.5.2, including development files such as headers)"
929 echo " https://zlib.net/"
932 if [ $have_gmime -eq 0 ]; then
933 echo " GMime library >= $GMIME_MINVER"
934 echo " (including development files such as headers)"
935 echo " https://github.com/jstedfast/gmime/"
938 if [ $have_glib -eq 0 ]; then
939 echo " Glib library >= 2.22 (including development files such as headers)"
940 echo " https://ftp.gnome.org/pub/gnome/sources/glib/"
943 if [ $have_talloc -eq 0 ]; then
944 echo " The talloc library (including development files such as headers)"
945 echo " https://talloc.samba.org/"
949 With any luck, you're using a modern, package-based operating system
950 that has all of these packages available in the distribution. In that
951 case a simple command will install everything you need. For example:
953 On Debian and similar systems:
955 sudo apt-get install libxapian-dev libgmime-3.0-dev libtalloc-dev zlib1g-dev
957 Or on Fedora and similar systems:
959 sudo yum install xapian-core-devel gmime-devel libtalloc-devel zlib-devel
961 On other systems, similar commands can be used, but the details of the
962 package names may be different.
965 if [ $have_pkg_config -eq 0 ]; then
967 Note: the pkg-config program is not available. This configure script
968 uses pkg-config to find the compilation flags required to link against
969 the various libraries needed by notmuch. It's possible you simply need
970 to install pkg-config with a command such as:
972 sudo apt-get install pkg-config
974 sudo yum install pkgconfig
976 But if pkg-config is not available for your system, then you will need
977 to modify the configure script to manually set the cflags and ldflags
978 variables to the correct values to link against each library in each
979 case that pkg-config could not be used to determine those values.
984 When you have installed the necessary dependencies, you can run
985 configure again to ensure the packages can be found, or simply run
986 "make" to compile notmuch.
992 printf "Checking for canonicalize_file_name... "
993 if ${CC} -o compat/have_canonicalize_file_name "$srcdir"/compat/have_canonicalize_file_name.c > /dev/null 2>&1
996 have_canonicalize_file_name=1
998 printf "No (will use our own instead).\n"
999 have_canonicalize_file_name=0
1001 rm -f compat/have_canonicalize_file_name
1004 printf "Checking for getline... "
1005 if ${CC} -o compat/have_getline "$srcdir"/compat/have_getline.c > /dev/null 2>&1
1010 printf "No (will use our own instead).\n"
1013 rm -f compat/have_getline
1015 printf "Checking for strcasestr... "
1016 if ${CC} -o compat/have_strcasestr "$srcdir"/compat/have_strcasestr.c > /dev/null 2>&1
1021 printf "No (will use our own instead).\n"
1024 rm -f compat/have_strcasestr
1026 printf "Checking for strsep... "
1027 if ${CC} -o compat/have_strsep "$srcdir"/compat/have_strsep.c > /dev/null 2>&1
1032 printf "No (will use our own instead).\n"
1035 rm -f compat/have_strsep
1037 printf "Checking for timegm... "
1038 if ${CC} -o compat/have_timegm "$srcdir"/compat/have_timegm.c > /dev/null 2>&1
1043 printf "No (will use our own instead).\n"
1046 rm -f compat/have_timegm
1048 cat <<EOF > _time_t.c
1051 static_assert(sizeof(time_t) >= 8, "sizeof(time_t) < 8");
1054 printf "Checking for 64 bit time_t... "
1055 if ${CC} -c _time_t.c -o /dev/null
1064 printf "Checking for dirent.d_type... "
1065 if ${CC} -o compat/have_d_type "$srcdir"/compat/have_d_type.c > /dev/null 2>&1
1070 printf "No (will use stat instead).\n"
1073 rm -f compat/have_d_type
1075 printf "Checking for standard version of getpwuid_r... "
1076 if ${CC} -o compat/check_getpwuid "$srcdir"/compat/check_getpwuid.c > /dev/null 2>&1
1081 printf "No (will define _POSIX_PTHREAD_SEMANTICS to get it).\n"
1084 rm -f compat/check_getpwuid
1086 printf "Checking for standard version of asctime_r... "
1087 if ${CC} -o compat/check_asctime "$srcdir"/compat/check_asctime.c > /dev/null 2>&1
1092 printf "No (will define _POSIX_PTHREAD_SEMANTICS to get it).\n"
1095 rm -f compat/check_asctime
1097 printf "Checking for rpath support... "
1098 if [ $WITH_RPATH = "1" ] && ${CC} -Wl,--enable-new-dtags -Wl,-rpath,/tmp/ -o minimal minimal.c >/dev/null 2>&1
1101 rpath_ldflags="-Wl,--enable-new-dtags -Wl,-rpath,\$(libdir)"
1103 printf "No (nothing to worry about).\n"
1107 printf "Checking for -Wl,--as-needed... "
1108 if ${CC} -Wl,--as-needed -o minimal minimal.c >/dev/null 2>&1
1111 as_needed_ldflags="-Wl,--as-needed"
1113 printf "No (nothing to worry about).\n"
1114 as_needed_ldflags=""
1117 printf "Checking for -Wl,--no-undefined... "
1118 if ${CC} -Wl,--no-undefined -o minimal minimal.c >/dev/null 2>&1
1121 no_undefined_ldflags="-Wl,--no-undefined"
1123 printf "No (nothing to worry about).\n"
1124 no_undefined_ldflags=""
1128 printf "Checking for available C++ compiler warning flags... "
1129 for flag in -Wall -Wextra -Wwrite-strings; do
1130 if ${CC} $flag -o minimal minimal.c > /dev/null 2>&1
1132 WARN_CXXFLAGS="${WARN_CXXFLAGS}${WARN_CXXFLAGS:+ }${flag}"
1135 printf "\n\t%s\n" "${WARN_CXXFLAGS}"
1137 WARN_CFLAGS="${WARN_CXXFLAGS}"
1138 printf "Checking for available C compiler warning flags... "
1139 for flag in -Wmissing-declarations; do
1140 if ${CC} $flag -o minimal minimal.c > /dev/null 2>&1
1142 WARN_CFLAGS="${WARN_CFLAGS}${WARN_CFLAGS:+ }${flag}"
1145 printf "\n\t%s\n" "${WARN_CFLAGS}"
1147 rm -f minimal minimal.c _time_t.c _libversion.c _libversion _libversion.sh _check_session_keys.c _check_session_keys _check_x509_validity.c _check_x509_validity
1149 # construct the Makefile.config
1150 cat > Makefile.config <<EOF
1151 # This Makefile.config was automatically generated by the ./configure
1152 # script of notmuch. If the configure script identified anything
1153 # incorrectly, then you can edit this file to try to correct things,
1154 # but be warned that if configure is run again it will destroy your
1155 # changes, (and this could happen by simply calling "make" if the
1156 # configure script is updated).
1158 # The top-level directory for the source, (the directory containing
1159 # the configure script). This may be different than the build
1160 # directory (the current directory at the time configure was run).
1162 NOTMUCH_SRCDIR = ${NOTMUCH_SRCDIR}
1164 # subdirectories to build
1165 subdirs = ${subdirs}
1167 configure_options = $@
1169 # We use vpath directives (rather than the VPATH variable) since the
1170 # VPATH variable matches targets as well as prerequisites, (which is
1171 # not useful since then a target left-over from a srcdir build would
1172 # cause a target to not be built in the non-srcdir build).
1174 # Also, we don't use a single "vpath % \$(srcdir)" here because we
1175 # don't want the vpath to trigger for our emacs lisp compilation,
1176 # (unless we first find a way to convince emacs to build the .elc
1177 # target in a directory other than the directory of the .el
1178 # prerequisite). In the meantime, we're actually copying in the .el
1179 # files, (which is quite ugly).
1180 vpath %.c \$(srcdir)
1181 vpath %.cc \$(srcdir)
1182 vpath Makefile.% \$(srcdir)
1183 vpath %.py \$(srcdir)
1184 vpath %.rst \$(srcdir)
1186 # Library versions (used to make SONAME)
1187 # The major version of the library interface. This will control the soname.
1188 # As such, this number must be incremented for any incompatible change to
1189 # the library interface, (such as the deletion of an API or a major
1190 # semantic change that breaks formerly functioning code).
1192 LIBNOTMUCH_VERSION_MAJOR = ${libnotmuch_version_major}
1194 # The minor version of the library interface. This should be incremented at
1195 # the time of release for any additions to the library interface,
1196 # (and when it is incremented, the release version of the library should
1198 LIBNOTMUCH_VERSION_MINOR = ${libnotmuch_version_minor}
1200 # The release version the library interface. This should be incremented at
1201 # the time of release if there have been no changes to the interface, (but
1202 # simply compatible changes to the implementation).
1203 LIBNOTMUCH_VERSION_RELEASE = ${libnotmuch_version_release}
1205 # These are derived from the VERSION macros in lib/notmuch.h so
1206 # if you have to change them, something is wrong.
1208 # The C compiler to use
1211 # The C++ compiler to use
1214 # Command to execute emacs from Makefiles
1215 EMACS = emacs --quick
1217 # Default FLAGS for C compiler (can be overridden by user such as "make CFLAGS=-g")
1220 # Default FLAGS for C preprocessor (can be overridden by user such as "make CPPFLAGS=-I/usr/local/include")
1221 CPPFLAGS = ${CPPFLAGS}
1223 # Default FLAGS for C++ compiler (can be overridden by user such as "make CXXFLAGS=-g")
1224 CXXFLAGS = ${CXXFLAGS}
1226 # Default FLAGS for the linker (can be overridden by user such as "make LDFLAGS=-znow")
1227 LDFLAGS = ${LDFLAGS}
1229 # Flags to enable warnings when using the C++ compiler
1230 WARN_CXXFLAGS=${WARN_CXXFLAGS}
1232 # Flags to enable warnings when using the C compiler
1233 WARN_CFLAGS=${WARN_CFLAGS}
1235 # Name of python interpreter
1238 # Name of ruby interpreter
1241 # The prefix to which notmuch should be installed
1242 # Note: If you change this value here, be sure to ensure that the
1243 # LIBDIR_IN_LDCONFIG value below is still set correctly.
1246 # The directory to which libraries should be installed
1247 # Note: If you change this value here, be sure to ensure that the
1248 # LIBDIR_IN_LDCONFIG value below is still set correctly.
1249 libdir = ${LIBDIR:=\$(prefix)/lib}
1251 # Whether libdir is in a path configured into ldconfig
1252 LIBDIR_IN_LDCONFIG = ${libdir_in_ldconfig}
1254 # The directory to which header files should be installed
1255 includedir = ${INCLUDEDIR:=\$(prefix)/include}
1257 # The directory to which man pages should be installed
1258 mandir = ${MANDIR:=\$(prefix)/share/man}
1260 # The directory to which man pages should be installed
1261 infodir = ${INFODIR:=\$(prefix)/share/info}
1263 # The directory to which read-only (configuration) files should be installed
1264 sysconfdir = ${SYSCONFDIR:=\$(prefix)/etc}
1266 # The directory to which emacs lisp files should be installed
1267 emacslispdir=${EMACSLISPDIR}
1269 # The directory to which emacs miscellaneous (machine-independent) files should
1271 emacsetcdir=${EMACSETCDIR}
1273 # Whether bash exists, and if so where
1274 HAVE_BASH = ${have_bash}
1275 BASH_ABSOLUTE = ${bash_absolute}
1277 # Whether perl exists, and if so where
1278 HAVE_PERL = ${have_perl}
1279 PERL_ABSOLUTE = ${perl_absolute}
1281 # Whether there's a sphinx-build binary available for building documentation
1282 HAVE_SPHINX=${have_sphinx}
1284 # Whether there's a makeinfo binary available for building info format documentation
1285 HAVE_MAKEINFO=${have_makeinfo}
1287 # Whether there's an install-info binary available for installing info format documentation
1288 HAVE_INSTALL_INFO=${have_install_info}
1290 # Whether there's a doxygen binary available for building api documentation
1291 HAVE_DOXYGEN=${have_doxygen}
1293 # The directory to which desktop files should be installed
1294 desktop_dir = \$(prefix)/share/applications
1296 # The directory to which bash completions files should be installed
1297 bash_completion_dir = ${BASHCOMPLETIONDIR:=\$(prefix)/share/bash-completion/completions}
1299 # The directory to which zsh completions files should be installed
1300 zsh_completion_dir = ${ZSHCOMLETIONDIR:=\$(prefix)/share/zsh/site-functions}
1302 # Whether the canonicalize_file_name function is available (if not, then notmuch will
1303 # build its own version)
1304 HAVE_CANONICALIZE_FILE_NAME = ${have_canonicalize_file_name}
1306 # Whether the cppcheck static checker is available
1307 HAVE_CPPCHECK = ${have_cppcheck}
1309 # Whether the getline function is available (if not, then notmuch will
1310 # build its own version)
1311 HAVE_GETLINE = ${have_getline}
1313 # Are the ruby development files (and ruby) available? If not skip
1314 # building/testing ruby bindings.
1315 HAVE_RUBY_DEV = ${have_ruby_dev}
1317 # Is the python cffi package available?
1318 HAVE_PYTHON3_CFFI = ${have_python3_cffi}
1320 # Is the python pytest package available?
1321 HAVE_PYTHON3_PYTEST = ${have_python3_pytest}
1323 # Whether the strcasestr function is available (if not, then notmuch will
1324 # build its own version)
1325 HAVE_STRCASESTR = ${have_strcasestr}
1327 # Whether the strsep function is available (if not, then notmuch will
1328 # build its own version)
1329 HAVE_STRSEP = ${have_strsep}
1331 # Whether the timegm function is available (if not, then notmuch will
1332 # build its own version)
1333 HAVE_TIMEGM = ${have_timegm}
1335 # Whether struct dirent has d_type (if not, then notmuch will use stat)
1336 HAVE_D_TYPE = ${have_d_type}
1338 # Whether to have Xapian retry lock
1339 HAVE_XAPIAN_DB_RETRY_LOCK = ${WITH_RETRY_LOCK}
1341 # Whether the getpwuid_r function is standards-compliant
1342 # (if not, then notmuch will #define _POSIX_PTHREAD_SEMANTICS
1343 # to enable the standards-compliant version -- needed for Solaris)
1344 STD_GETPWUID = ${std_getpwuid}
1346 # Whether the asctime_r function is standards-compliant
1347 # (if not, then notmuch will #define _POSIX_PTHREAD_SEMANTICS
1348 # to enable the standards-compliant version -- needed for Solaris)
1349 STD_ASCTIME = ${std_asctime}
1351 # Supported platforms (so far) are: LINUX, MACOSX, SOLARIS, FREEBSD, OPENBSD
1352 PLATFORM = ${platform}
1354 # Whether the linker will automatically resolve the dependency of one
1355 # library on another (if not, then linking a binary requires linking
1356 # directly against both)
1357 LINKER_RESOLVES_LIBRARY_DEPENDENCIES = ${linker_resolves_library_dependencies}
1359 # Flags needed to compile and link against Xapian
1360 XAPIAN_CXXFLAGS = ${xapian_cxxflags}
1361 XAPIAN_LDFLAGS = ${xapian_ldflags}
1363 # Flags needed to compile and link against GMime
1364 GMIME_CFLAGS = ${gmime_cflags}
1365 GMIME_LDFLAGS = ${gmime_ldflags}
1367 # Flags needed to compile and link against zlib
1368 ZLIB_CFLAGS = ${zlib_cflags}
1369 ZLIB_LDFLAGS = ${zlib_ldflags}
1371 # Flags needed to compile and link against talloc
1372 TALLOC_CFLAGS = ${talloc_cflags}
1373 TALLOC_LDFLAGS = ${talloc_ldflags}
1375 # Flags needed to have linker set rpath attribute
1376 RPATH_LDFLAGS = ${rpath_ldflags}
1378 # Flags needed to have linker link only to necessary libraries
1379 AS_NEEDED_LDFLAGS = ${as_needed_ldflags}
1381 # Flags to have the linker flag undefined symbols in object files
1382 NO_UNDEFINED_LDFLAGS = ${no_undefined_ldflags}
1384 # Whether valgrind header files are available
1385 HAVE_VALGRIND = ${have_valgrind}
1387 # And if so, flags needed at compile time for valgrind macros
1388 VALGRIND_CFLAGS = ${valgrind_cflags}
1391 WITH_EMACS = ${WITH_EMACS}
1393 # Support for desktop file
1394 WITH_DESKTOP = ${WITH_DESKTOP}
1396 # Support for bash completion
1397 WITH_BASH = ${WITH_BASH}
1399 # Support for zsh completion
1400 WITH_ZSH = ${WITH_ZSH}
1402 # Combined flags for compiling and linking against all of the above
1403 COMMON_CONFIGURE_CFLAGS = \\
1404 \$(GMIME_CFLAGS) \$(TALLOC_CFLAGS) \$(ZLIB_CFLAGS) \\
1405 -DHAVE_VALGRIND=\$(HAVE_VALGRIND) \$(VALGRIND_CFLAGS) \\
1406 -DHAVE_GETLINE=\$(HAVE_GETLINE) \\
1407 -DWITH_EMACS=\$(WITH_EMACS) \\
1408 -DHAVE_CANONICALIZE_FILE_NAME=\$(HAVE_CANONICALIZE_FILE_NAME) \\
1409 -DHAVE_STRCASESTR=\$(HAVE_STRCASESTR) \\
1410 -DHAVE_STRSEP=\$(HAVE_STRSEP) \\
1411 -DHAVE_TIMEGM=\$(HAVE_TIMEGM) \\
1412 -DHAVE_D_TYPE=\$(HAVE_D_TYPE) \\
1413 -DSTD_GETPWUID=\$(STD_GETPWUID) \\
1414 -DSTD_ASCTIME=\$(STD_ASCTIME) \\
1415 -DSILENCE_XAPIAN_DEPRECATION_WARNINGS \\
1416 -DHAVE_XAPIAN_DB_RETRY_LOCK=\$(HAVE_XAPIAN_DB_RETRY_LOCK)
1418 CONFIGURE_CFLAGS = \$(COMMON_CONFIGURE_CFLAGS)
1420 CONFIGURE_CXXFLAGS = \$(COMMON_CONFIGURE_CFLAGS) \$(XAPIAN_CXXFLAGS)
1422 CONFIGURE_LDFLAGS = \$(GMIME_LDFLAGS) \$(TALLOC_LDFLAGS) \$(ZLIB_LDFLAGS) \$(XAPIAN_LDFLAGS)
1425 # construct the sh.config
1426 cat > sh.config <<EOF
1427 # This sh.config was automatically generated by the ./configure
1428 # script of notmuch.
1430 NOTMUCH_SRCDIR='${NOTMUCH_SRCDIR}'
1432 # Whether to have Xapian retry lock
1433 NOTMUCH_HAVE_XAPIAN_DB_RETRY_LOCK=${WITH_RETRY_LOCK}
1435 # Which backend will Xapian use by default?
1436 NOTMUCH_DEFAULT_XAPIAN_BACKEND=${default_xapian_backend}
1438 # Whether GMime can verify X.509 certificate validity
1439 NOTMUCH_GMIME_X509_CERT_VALIDITY=${gmime_x509_cert_validity}
1441 # do we have man pages?
1442 NOTMUCH_HAVE_MAN=$((have_sphinx))
1444 # Whether bash exists, and if so where
1445 NOTMUCH_HAVE_BASH=${have_bash}
1446 NOTMUCH_BASH_ABSOLUTE=${bash_absolute}
1448 # Whether time_t is 64 bits (or more)
1449 NOTMUCH_HAVE_64BIT_TIME_T=${have_64bit_time_t}
1451 # Whether perl exists, and if so where
1452 NOTMUCH_HAVE_PERL=${have_perl}
1453 NOTMUCH_PERL_ABSOLUTE=${perl_absolute}
1455 # Name of python interpreter
1456 NOTMUCH_PYTHON=${python}
1458 # Name of ruby interpreter
1459 NOTMUCH_RUBY=${RUBY}
1461 # Are the ruby development files (and ruby) available? If not skip
1462 # building/testing ruby bindings.
1463 NOTMUCH_HAVE_RUBY_DEV=${have_ruby_dev}
1465 # Is the python cffi package available?
1466 NOTMUCH_HAVE_PYTHON3_CFFI=${have_python3_cffi}
1468 # Is the python pytest package available?
1469 NOTMUCH_HAVE_PYTHON3_PYTEST=${have_python3_pytest}
1471 # Platform we are run on
1472 PLATFORM=${platform}
1475 # Finally, after everything configured, inform the user how to continue.
1478 All required packages were found. You may now run the following
1479 commands to compile and install notmuch: