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 subdirs="util compat lib parse-time-string completion doc emacs"
30 subdirs="${subdirs} performance-test test test/test-databases"
31 subdirs="${subdirs} bindings"
33 # For a non-srcdir configure invocation (such as ../configure), create
34 # the directory structure and copy Makefiles.
35 if [ "$srcdir" != "." ]; then
37 for dir in . ${subdirs}; do
39 cp "$srcdir"/"$dir"/Makefile.local "$dir"
40 cp "$srcdir"/"$dir"/Makefile "$dir"
43 # Emacs only likes to generate compiled files next to the .el files
44 # by default so copy these as well (which is not ideal).
45 cp -a "$srcdir"/emacs/*.el emacs
47 # We were not able to create fully working Makefile using ruby mkmf.rb
48 # so ruby bindings source files are copied as well (ditto -- not ideal).
50 cp -a "$srcdir"/bindings/ruby/*.[ch] bindings/ruby
51 cp -a "$srcdir"/bindings/ruby/extconf.rb bindings/ruby
54 # Set several defaults (optionally specified by the user in
55 # environment variables)
56 BASHCMD=${BASHCMD:-bash}
60 CFLAGS=${CFLAGS:--g -O2}
61 CPPFLAGS=${CPPFLAGS:-}
62 CXXFLAGS_for_sh=${CXXFLAGS:-${CFLAGS}}
63 CXXFLAGS=${CXXFLAGS:-\$(CFLAGS)}
65 XAPIAN_CONFIG=${XAPIAN_CONFIG:-}
69 # We don't allow the EMACS or GZIP Makefile variables inherit values
70 # from the environment as we do with CC and CXX above. The reason is
71 # that these names as environment variables have existing uses other
72 # than the program name that we want. (EMACS is set to 't' when a
73 # shell is running within emacs and GZIP specifies arguments to pass
74 # on the gzip command line).
76 # Set the defaults for values the user can specify with command-line
93 Usage: ./configure [options]...
95 This script configures notmuch to build on your system.
97 It verifies that dependencies are available, determines flags needed
98 to compile and link against various required libraries, and identifies
99 whether various system functions can be used or if locally-provided
100 replacements will be built instead.
102 Finally, it allows you to control various aspects of the build and
103 installation process.
105 First, some common variables can specified via environment variables:
107 CC The C compiler to use
108 CFLAGS Flags to pass to the C compiler
109 CPPFLAGS Flags to pass to the C preprocessor
110 CXX The C++ compiler to use
111 CXXFLAGS Flags to pass to the C compiler
112 LDFLAGS Flags to pass when linking
114 Each of these values can further be controlled by specifying them
115 later on the "make" command line.
117 Other environment variables can be used to control configure itself,
118 (and for which there is no equivalent build-time control):
120 XAPIAN_CONFIG The program to use to determine flags for
121 compiling and linking against the Xapian
122 library. [$XAPIAN_CONFIG]
123 PYTHON Name of python command to use in
124 configure and the test suite.
125 RUBY Name of ruby command to use in
126 configure and the test suite.
128 Additionally, various options can be specified on the configure
131 --prefix=PREFIX Install files in PREFIX [$PREFIX]
133 By default, "make install" will install the resulting program to
134 $PREFIX/bin, documentation to $PREFIX/man, etc. You can
135 specify an installation prefix other than $PREFIX using
136 --prefix, for instance:
138 ./configure --prefix=\$HOME
140 Fine tuning of some installation directories is available:
142 --libdir=DIR Install libraries to DIR [PREFIX/lib]
143 --includedir=DIR Install header files to DIR [PREFIX/include]
144 --mandir=DIR Install man pages to DIR [PREFIX/share/man]
145 --infodir=DIR Install man pages to DIR [PREFIX/share/man]
146 --sysconfdir=DIR Read-only single-machine data [PREFIX/etc]
147 --emacslispdir=DIR Emacs code [PREFIX/share/emacs/site-lisp]
148 --emacsetcdir=DIR Emacs miscellaneous files [PREFIX/share/emacs/site-lisp]
149 --bashcompletiondir=DIR Bash completions files [PREFIX/share/bash-completion/completions]
150 --zshcompletiondir=DIR Zsh completions files [PREFIX/share/zsh/functions/Completion/Unix]
152 Some features can be disabled (--with-feature=no is equivalent to
155 --without-bash-completion Do not install bash completions files
156 --without-docs Do not install documentation
157 --without-api-docs Do not install API man page
158 --without-emacs Do not install lisp file
159 --without-desktop Do not install desktop file
160 --without-ruby Do not install ruby bindings
161 --without-zsh-completion Do not install zsh completions files
162 --without-retry-lock Do not use blocking xapian opens, even if available
164 Additional options are accepted for compatibility with other
165 configure-script calling conventions, but don't do anything yet:
167 --build=<cpu>-<vendor>-<os> Currently ignored
168 --host=<cpu>-<vendor>-<os> Currently ignored
169 --datadir=DIR Currently ignored
170 --localstatedir=DIR Currently ignored
171 --libexecdir=DIR Currently ignored
172 --disable-maintainer-mode Currently ignored
173 --disable-dependency-tracking Currently ignored
178 # Parse command-line options
180 if [ "${option}" = '--help' ] ; then
183 elif [ "${option%%=*}" = '--prefix' ] ; then
184 PREFIX="${option#*=}"
185 elif [ "${option%%=*}" = '--libdir' ] ; then
186 LIBDIR="${option#*=}"
187 elif [ "${option%%=*}" = '--includedir' ] ; then
188 INCLUDEDIR="${option#*=}"
189 elif [ "${option%%=*}" = '--mandir' ] ; then
190 MANDIR="${option#*=}"
191 elif [ "${option%%=*}" = '--infodir' ] ; then
192 INFODIR="${option#*=}"
193 elif [ "${option%%=*}" = '--sysconfdir' ] ; then
194 SYSCONFDIR="${option#*=}"
195 elif [ "${option%%=*}" = '--emacslispdir' ] ; then
196 EMACSLISPDIR="${option#*=}"
197 elif [ "${option%%=*}" = '--emacsetcdir' ] ; then
198 EMACSETCDIR="${option#*=}"
199 elif [ "${option%%=*}" = '--bashcompletiondir' ] ; then
200 BASHCOMPLETIONDIR="${option#*=}"
201 elif [ "${option%%=*}" = '--zshcompletiondir' ] ; then
202 ZSHCOMLETIONDIR="${option#*=}"
203 elif [ "${option%%=*}" = '--with-docs' ]; then
204 if [ "${option#*=}" = 'no' ]; then
210 elif [ "${option}" = '--without-docs' ] ; then
213 elif [ "${option%%=*}" = '--with-api-docs' ]; then
214 if [ "${option#*=}" = 'no' ]; then
219 elif [ "${option}" = '--without-api-docs' ] ; then
221 elif [ "${option%%=*}" = '--with-emacs' ]; then
222 if [ "${option#*=}" = 'no' ]; then
227 elif [ "${option}" = '--without-emacs' ] ; then
229 elif [ "${option%%=*}" = '--with-desktop' ]; then
230 if [ "${option#*=}" = 'no' ]; then
235 elif [ "${option}" = '--without-desktop' ] ; then
237 elif [ "${option%%=*}" = '--with-bash-completion' ]; then
238 if [ "${option#*=}" = 'no' ]; then
243 elif [ "${option}" = '--without-bash-completion' ] ; then
245 elif [ "${option%%=*}" = '--with-rpath' ]; then
246 if [ "${option#*=}" = 'no' ]; then
251 elif [ "${option}" = '--without-rpath' ] ; then
253 elif [ "${option%%=*}" = '--with-ruby' ]; then
254 if [ "${option#*=}" = 'no' ]; then
259 elif [ "${option}" = '--without-ruby' ] ; then
261 elif [ "${option%%=*}" = '--with-retry-lock' ]; then
262 if [ "${option#*=}" = 'no' ]; then
267 elif [ "${option}" = '--without-retry-lock' ] ; then
269 elif [ "${option%%=*}" = '--with-zsh-completion' ]; then
270 if [ "${option#*=}" = 'no' ]; then
275 elif [ "${option}" = '--without-zsh-completion' ] ; then
277 elif [ "${option%%=*}" = '--build' ] ; then
279 elif [ "${option%%=*}" = '--host' ] ; then
281 elif [ "${option%%=*}" = '--datadir' ] ; then
283 elif [ "${option%%=*}" = '--localstatedir' ] ; then
285 elif [ "${option%%=*}" = '--libexecdir' ] ; then
287 elif [ "${option}" = '--disable-maintainer-mode' ] ; then
289 elif [ "${option}" = '--disable-dependency-tracking' ] ; then
292 echo "Unrecognized option: ${option}"
300 # We set this value early, (rather than just while printing the
301 # Makefile.config file later like most values), because we need to
302 # actually investigate this value compared to the ldconfig_paths value
304 if [ -z "$LIBDIR" ] ; then
305 libdir_expanded="${PREFIX}/lib"
307 # very non-general variable expansion
308 libdir_expanded=$(printf %s "$LIBDIR" | sed "s|\${prefix}|${PREFIX}|; s|\$prefix\>|${PREFIX}|; s|//*|/|g")
312 Welcome to Notmuch, a system for indexing, searching and tagging your email.
314 We hope that the process of building and installing notmuch is quick
315 and smooth so that you can soon be reading and processing your email
316 more efficiently than ever.
318 If anything goes wrong in the configure process, you can override any
319 decisions it makes by manually editing the Makefile.config file that
320 it creates. Also please do as much as you can to figure out what could
321 be different on your machine compared to those of the notmuch
322 developers. Then, please email those details to the Notmuch list
323 (notmuch@notmuchmail.org) so that we can hopefully make future
324 versions of notmuch easier for you to use.
326 We'll now investigate your system to verify that all required
327 dependencies are available:
332 printf "int main(void){return 0;}\n" > minimal.c
334 printf "Sanity checking C compilation environment... "
335 test_cmdline="${CC} ${CFLAGS} ${CPPFLAGS} minimal.c ${LDFLAGS} -o minimal"
336 if ${test_cmdline} > /dev/null 2>&1
341 errors=$((errors + 1))
342 printf Executed:; printf ' %s' ${test_cmdline}; echo
346 printf "Sanity checking C++ compilation environment... "
347 test_cmdline="${CXX} ${CXXFLAGS_for_sh} ${CPPFLAGS} minimal.c ${LDFLAGS} -o minimal"
348 if ${test_cmdline} > /dev/null 2>&1
353 errors=$((errors + 1))
354 printf Executed:; printf ' %s' ${test_cmdline}; echo
359 if [ $errors -gt 0 ]; then
361 *** Error: Initial sanity checking of environment failed. Please try
362 running configure in a clean environment, and if the problem persists,
365 rm -f minimal minimal.c
369 printf "Reading libnotmuch version from source... "
370 cat > _libversion.c <<EOF
372 #include "lib/notmuch.h"
374 printf("libnotmuch_version_major=%d\n",
375 LIBNOTMUCH_MAJOR_VERSION);
376 printf("libnotmuch_version_minor=%d\n",
377 LIBNOTMUCH_MINOR_VERSION);
378 printf("libnotmuch_version_release=%d\n",
379 LIBNOTMUCH_MICRO_VERSION);
383 if ${CC} ${CFLAGS} -I"$srcdir" _libversion.c -o _libversion > /dev/null 2>&1 \
384 && ./_libversion > _libversion.sh && . ./_libversion.sh
390 *** Error: Reading lib/notmuch.h failed.
391 Please try running configure again in a clean environment, and if the
392 problem persists, report a bug.
394 rm -f _libversion _libversion.c _libversion.sh
398 if pkg-config --version > /dev/null 2>&1; then
404 printf "Checking for Xapian development files... "
406 for xapian_config in ${XAPIAN_CONFIG} xapian-config xapian-config-1.3; do
407 if ${xapian_config} --version > /dev/null 2>&1; then
408 xapian_version=$(${xapian_config} --version | sed -e 's/.* //')
409 printf "Yes (%s).\n" ${xapian_version}
411 xapian_cxxflags=$(${xapian_config} --cxxflags)
412 xapian_ldflags=$(${xapian_config} --libs)
416 if [ ${have_xapian} = "0" ]; then
418 errors=$((errors + 1))
421 have_xapian_compact=0
422 have_xapian_field_processor=0
423 if [ ${have_xapian} = "1" ]; then
424 printf "Checking for Xapian compaction support... "
427 class TestCompactor : public Xapian::Compactor { };
429 if ${CXX} ${CXXFLAGS_for_sh} ${xapian_cxxflags} -c _compact.cc -o _compact.o > /dev/null 2>&1
431 have_xapian_compact=1
435 errors=$((errors + 1))
438 rm -f _compact.o _compact.cc
440 printf "Checking for Xapian FieldProcessor API... "
441 cat>_field_processor.cc<<EOF
443 class TitleFieldProcessor : public Xapian::FieldProcessor { };
445 if ${CXX} ${CXXFLAGS_for_sh} ${xapian_cxxflags} -c _field_processor.cc -o _field_processor.o > /dev/null 2>&1
447 have_xapian_field_processor=1
450 printf "No. (optional)\n"
453 rm -f _field_processor.o _field_processor.cc
455 default_xapian_backend=""
456 # DB_RETRY_LOCK is only supported on Xapian > 1.3.2
457 have_xapian_db_retry_lock=0
458 if [ $WITH_RETRY_LOCK = "1" ]; then
459 printf "Checking for Xapian lock retry support... "
462 int flag = Xapian::DB_RETRY_LOCK;
464 if ${CXX} ${CXXFLAGS_for_sh} ${xapian_cxxflags} -c _retry.cc -o _retry.o > /dev/null 2>&1
466 have_xapian_db_retry_lock=1
469 printf "No. (optional)\n"
471 rm -f _retry.o _retry.cc
474 printf "Testing default Xapian backend... "
475 cat >_default_backend.cc <<EOF
477 int main(int argc, char** argv) {
478 Xapian::WritableDatabase db("test.db",Xapian::DB_CREATE_OR_OPEN);
481 ${CXX} ${CXXFLAGS_for_sh} ${xapian_cxxflags} _default_backend.cc -o _default_backend ${xapian_ldflags}
483 if [ -f test.db/iamglass ]; then
484 default_xapian_backend=glass
486 default_xapian_backend=chert
488 printf "%s\n" "${default_xapian_backend}";
489 rm -rf test.db _default_backend _default_backend.cc
494 printf "Checking for GMime development files... "
495 if pkg-config --exists "gmime-3.0 > $GMIME_MINVER"; then
498 gmime_cflags=$(pkg-config --cflags gmime-3.0)
499 gmime_ldflags=$(pkg-config --libs gmime-3.0)
501 printf "Checking for GMime session key extraction support... "
503 cat > _check_session_keys.c <<EOF
504 #include <gmime/gmime.h>
508 GError *error = NULL;
509 GMimeParser *parser = NULL;
510 GMimeMultipartEncrypted *body = NULL;
511 GMimeDecryptResult *decrypt_result = NULL;
512 GMimeObject *output = NULL;
515 parser = g_mime_parser_new ();
516 g_mime_parser_init_with_stream (parser, g_mime_stream_file_open("test/corpora/crypto/basic-encrypted.eml", "r", &error));
517 if (error) return !! fprintf (stderr, "failed to instantiate parser with test/corpora/crypto/basic-encrypted.eml\n");
519 body = GMIME_MULTIPART_ENCRYPTED(g_mime_message_get_mime_part (g_mime_parser_construct_message (parser, NULL)));
520 if (body == NULL) return !! fprintf (stderr, "did not find a multipart encrypted message\n");
522 output = g_mime_multipart_encrypted_decrypt (body, GMIME_DECRYPT_EXPORT_SESSION_KEY, NULL, &decrypt_result, &error);
523 if (error || output == NULL) return !! fprintf (stderr, "decryption failed\n");
525 if (decrypt_result == NULL) return !! fprintf (stderr, "no GMimeDecryptResult found\n");
526 if (decrypt_result->session_key == NULL) return !! fprintf (stderr, "GMimeDecryptResult has no session key\n");
528 printf ("%s\n", decrypt_result->session_key);
532 if ${CC} ${CFLAGS} ${gmime_cflags} ${gmime_ldflags} _check_session_keys.c -o _check_session_keys > /dev/null 2>&1 \
533 && TEMP_GPG=$(mktemp -d) \
534 && GNUPGHOME=${TEMP_GPG} gpg --batch --quiet --import < test/gnupg-secret-key.asc \
535 && SESSION_KEY=$(GNUPGHOME=${TEMP_GPG} ./_check_session_keys) \
536 && [ $SESSION_KEY = 9:0BACD64099D1468AB07C796F0C0AC4851948A658A15B34E803865E9FC635F2F5 ]
542 *** Error: Could not extract session keys from encrypted message.
544 This is likely due to your GMime having been built against a old
547 Please try to rebuild your version of GMime against a more recent
548 version of GPGME (at least GPGME 1.8.0). Your current GPGME version
549 is: $(gpgme-config --version)
551 rm -rf _check_session_keys.c _check_session_keys "$TEMP_GPG"
552 errors=$((errors + 1))
557 errors=$((errors + 1))
560 # GMime already depends on Glib >= 2.12, but we use at least one Glib
561 # function that only exists as of 2.22, (g_array_unref)
562 printf "Checking for Glib development files (>= 2.22)... "
564 if pkg-config --exists 'glib-2.0 >= 2.22'; then
567 # these are included in gmime cflags and ldflags
568 # glib_cflags=$(pkg-config --cflags glib-2.0)
569 # glib_ldflags=$(pkg-config --libs glib-2.0)
572 errors=$((errors + 1))
575 if ! pkg-config --exists zlib; then
576 ${CC} -o compat/gen_zlib_pc "$srcdir"/compat/gen_zlib_pc.c >/dev/null 2>&1 &&
577 compat/gen_zlib_pc > compat/zlib.pc &&
578 PKG_CONFIG_PATH="$PKG_CONFIG_PATH":compat &&
579 export PKG_CONFIG_PATH
580 rm -f compat/gen_zlib_pc
583 printf "Checking for zlib (>= 1.2.5.2)... "
585 if pkg-config --atleast-version=1.2.5.2 zlib; then
588 zlib_cflags=$(pkg-config --cflags zlib)
589 zlib_ldflags=$(pkg-config --libs zlib)
592 errors=$((errors + 1))
595 printf "Checking for talloc development files... "
596 if pkg-config --exists talloc; then
599 talloc_cflags=$(pkg-config --cflags talloc)
600 talloc_ldflags=$(pkg-config --libs talloc)
605 errors=$((errors + 1))
608 printf "Checking for bash... "
609 if command -v ${BASHCMD} > /dev/null; then
611 bash_absolute=$(command -v ${BASHCMD})
612 printf "Yes (%s).\n" "$bash_absolute"
615 printf "No. (%s not found)\n" "${BASHCMD}"
618 printf "Checking for perl... "
619 if command -v ${PERL} > /dev/null; then
621 perl_absolute=$(command -v ${PERL})
622 printf "Yes (%s).\n" "$perl_absolute"
625 printf "No. (%s not found)\n" "${PERL}"
628 printf "Checking for python... "
631 for name in ${PYTHON} python3 python python2; do
632 if command -v $name > /dev/null; then
635 printf "Yes (%s).\n" "$name"
640 if [ $have_python -eq 0 ]; then
642 errors=$((errors + 1))
645 printf "Checking for valgrind development files... "
646 if pkg-config --exists valgrind; then
649 valgrind_cflags=$(pkg-config --cflags valgrind)
651 printf "No (but that's fine).\n"
656 printf "Checking for bash-completion (>= 1.90)... "
657 if pkg-config --atleast-version=1.90 bash-completion; then
660 printf "No (will not install bash completion).\n"
664 if [ -z "${EMACSLISPDIR-}" ]; then
665 EMACSLISPDIR="\$(prefix)/share/emacs/site-lisp"
668 if [ -z "${EMACSETCDIR-}" ]; then
669 EMACSETCDIR="\$(prefix)/share/emacs/site-lisp"
672 printf "Checking if emacs (>= 24) is available... "
673 if emacs --quick --batch --eval '(if (< emacs-major-version 24) (kill-emacs 1))' > /dev/null 2>&1; then
677 printf "No (so will not byte-compile emacs code)\n"
682 if [ $WITH_API_DOCS = "1" ] ; then
683 printf "Checking if doxygen is available... "
684 if command -v doxygen > /dev/null; then
688 printf "No (so will not install api docs)\n"
693 if [ $WITH_RUBY = "1" ] ; then
694 printf "Checking for ruby development files... "
695 if ${RUBY} -e "require 'mkmf'"> /dev/null 2>&1; then
699 printf "No (skipping ruby bindings)\n"
706 if [ $WITH_DOCS = "1" ] ; then
707 printf "Checking if sphinx is available and supports nroff output... "
708 if command -v sphinx-build > /dev/null && ${python} -m sphinx.writers.manpage > /dev/null 2>&1 ; then
712 printf "No (so will not install man pages).\n"
714 printf "Checking if makeinfo is available... "
715 if command -v makeinfo > /dev/null; then
719 printf "No (so will not build info pages).\n"
721 printf "Checking if install-info is available... "
722 if command -v install-info > /dev/null; then
726 printf "No (so will not install info pages).\n"
730 if [ $WITH_DESKTOP = "1" ]; then
731 printf "Checking if desktop-file-install is available... "
732 if command -v desktop-file-install > /dev/null; then
735 printf "No (so will not install .desktop file).\n"
740 printf "Checking for cppcheck... "
741 if command -v cppcheck > /dev/null; then
751 printf "Checking which platform we are on... "
753 if [ $uname = "Darwin" ] ; then
756 linker_resolves_library_dependencies=0
757 elif [ $uname = "SunOS" ] ; then
760 linker_resolves_library_dependencies=0
761 elif [ $uname = "FreeBSD" ] ; then
764 linker_resolves_library_dependencies=0
765 elif [ $uname = "OpenBSD" ] ; then
768 linker_resolves_library_dependencies=0
769 elif [ $uname = "Linux" ] || [ $uname = "GNU" ] ; then
770 printf "%s\n" "$uname"
772 linker_resolves_library_dependencies=1
774 printf "Checking for %s in ldconfig... " "$libdir_expanded"
775 ldconfig_paths=$(/sbin/ldconfig -N -X -v 2>/dev/null | sed -n -e 's,^\(/.*\):\( (.*)\)\?$,\1,p')
776 # Separate ldconfig_paths only on newline (not on any potential
777 # embedded space characters in any filenames). Note, we use a
778 # literal newline in the source here rather than something like:
782 # because the shell's command substitution deletes any trailing newlines.
785 for path in $ldconfig_paths; do
786 if [ "$path" -ef "$libdir_expanded" ]; then
791 if [ "$libdir_in_ldconfig" = '0' ]; then
792 printf "No (will set RPATH)\n"
799 linker_resolves_library_dependencies=0
802 *** Warning: Unknown platform. Notmuch might or might not build correctly.
807 if [ $errors -gt 0 ]; then
810 *** Error: The dependencies of notmuch could not be satisfied. You will
811 need to install the following packages before being able to compile
815 if [ $have_python -eq 0 ]; then
816 echo " python interpreter"
818 if [ $have_xapian -eq 0 -o $have_xapian_compact -eq 0 ]; then
819 echo " Xapian library (>= version 1.2.6, including development files such as headers)"
820 echo " https://xapian.org/"
822 if [ $have_zlib -eq 0 ]; then
823 echo " zlib library (>= version 1.2.5.2, including development files such as headers)"
824 echo " https://zlib.net/"
827 if [ $have_gmime -eq 0 ]; then
828 echo " GMime library >= $GMIME_MINVER"
829 echo " (including development files such as headers)"
830 echo " https://github.com/jstedfast/gmime/"
833 if [ $have_glib -eq 0 ]; then
834 echo " Glib library >= 2.22 (including development files such as headers)"
835 echo " https://ftp.gnome.org/pub/gnome/sources/glib/"
838 if [ $have_talloc -eq 0 ]; then
839 echo " The talloc library (including development files such as headers)"
840 echo " https://talloc.samba.org/"
844 With any luck, you're using a modern, package-based operating system
845 that has all of these packages available in the distribution. In that
846 case a simple command will install everything you need. For example:
848 On Debian and similar systems:
850 sudo apt-get install libxapian-dev libgmime-3.0-dev libtalloc-dev zlib1g-dev
852 Or on Fedora and similar systems:
854 sudo yum install xapian-core-devel gmime-devel libtalloc-devel zlib-devel
856 On other systems, similar commands can be used, but the details of the
857 package names may be different.
860 if [ $have_pkg_config -eq 0 ]; then
862 Note: the pkg-config program is not available. This configure script
863 uses pkg-config to find the compilation flags required to link against
864 the various libraries needed by notmuch. It's possible you simply need
865 to install pkg-config with a command such as:
867 sudo apt-get install pkg-config
869 sudo yum install pkgconfig
871 But if pkg-config is not available for your system, then you will need
872 to modify the configure script to manually set the cflags and ldflags
873 variables to the correct values to link against each library in each
874 case that pkg-config could not be used to determine those values.
879 When you have installed the necessary dependencies, you can run
880 configure again to ensure the packages can be found, or simply run
881 "make" to compile notmuch.
887 printf "Checking for canonicalize_file_name... "
888 if ${CC} -o compat/have_canonicalize_file_name "$srcdir"/compat/have_canonicalize_file_name.c > /dev/null 2>&1
891 have_canonicalize_file_name=1
893 printf "No (will use our own instead).\n"
894 have_canonicalize_file_name=0
896 rm -f compat/have_canonicalize_file_name
899 printf "Checking for getline... "
900 if ${CC} -o compat/have_getline "$srcdir"/compat/have_getline.c > /dev/null 2>&1
905 printf "No (will use our own instead).\n"
908 rm -f compat/have_getline
910 printf "Checking for strcasestr... "
911 if ${CC} -o compat/have_strcasestr "$srcdir"/compat/have_strcasestr.c > /dev/null 2>&1
916 printf "No (will use our own instead).\n"
919 rm -f compat/have_strcasestr
921 printf "Checking for strsep... "
922 if ${CC} -o compat/have_strsep "$srcdir"/compat/have_strsep.c > /dev/null 2>&1
927 printf "No (will use our own instead).\n"
930 rm -f compat/have_strsep
932 printf "Checking for timegm... "
933 if ${CC} -o compat/have_timegm "$srcdir"/compat/have_timegm.c > /dev/null 2>&1
938 printf "No (will use our own instead).\n"
941 rm -f compat/have_timegm
943 printf "Checking for dirent.d_type... "
944 if ${CC} -o compat/have_d_type "$srcdir"/compat/have_d_type.c > /dev/null 2>&1
949 printf "No (will use stat instead).\n"
952 rm -f compat/have_d_type
954 printf "Checking for standard version of getpwuid_r... "
955 if ${CC} -o compat/check_getpwuid "$srcdir"/compat/check_getpwuid.c > /dev/null 2>&1
960 printf "No (will define _POSIX_PTHREAD_SEMANTICS to get it).\n"
963 rm -f compat/check_getpwuid
965 printf "Checking for standard version of asctime_r... "
966 if ${CC} -o compat/check_asctime "$srcdir"/compat/check_asctime.c > /dev/null 2>&1
971 printf "No (will define _POSIX_PTHREAD_SEMANTICS to get it).\n"
974 rm -f compat/check_asctime
976 printf "Checking for rpath support... "
977 if [ $WITH_RPATH = "1" ] && ${CC} -Wl,--enable-new-dtags -Wl,-rpath,/tmp/ -o minimal minimal.c >/dev/null 2>&1
980 rpath_ldflags="-Wl,--enable-new-dtags -Wl,-rpath,\$(libdir)"
982 printf "No (nothing to worry about).\n"
986 printf "Checking for -Wl,--as-needed... "
987 if ${CC} -Wl,--as-needed -o minimal minimal.c >/dev/null 2>&1
990 as_needed_ldflags="-Wl,--as-needed"
992 printf "No (nothing to worry about).\n"
996 printf "Checking for -Wl,--no-undefined... "
997 if ${CC} -Wl,--no-undefined -o minimal minimal.c >/dev/null 2>&1
1000 no_undefined_ldflags="-Wl,--no-undefined"
1002 printf "No (nothing to worry about).\n"
1003 no_undefined_ldflags=""
1007 printf "Checking for available C++ compiler warning flags... "
1008 for flag in -Wall -Wextra -Wwrite-strings; do
1009 if ${CC} $flag -o minimal minimal.c > /dev/null 2>&1
1011 WARN_CXXFLAGS="${WARN_CXXFLAGS}${WARN_CXXFLAGS:+ }${flag}"
1014 printf "\n\t%s\n" "${WARN_CXXFLAGS}"
1016 WARN_CFLAGS="${WARN_CXXFLAGS}"
1017 printf "Checking for available C compiler warning flags... "
1018 for flag in -Wmissing-declarations; do
1019 if ${CC} $flag -o minimal minimal.c > /dev/null 2>&1
1021 WARN_CFLAGS="${WARN_CFLAGS}${WARN_CFLAGS:+ }${flag}"
1024 printf "\n\t%s\n" "${WARN_CFLAGS}"
1026 rm -f minimal minimal.c _libversion.c _libversion _libversion.sh
1028 # construct the Makefile.config
1029 cat > Makefile.config <<EOF
1030 # This Makefile.config was automatically generated by the ./configure
1031 # script of notmuch. If the configure script identified anything
1032 # incorrectly, then you can edit this file to try to correct things,
1033 # but be warned that if configure is run again it will destroy your
1034 # changes, (and this could happen by simply calling "make" if the
1035 # configure script is updated).
1037 # The top-level directory for the source, (the directory containing
1038 # the configure script). This may be different than the build
1039 # directory (the current directory at the time configure was run).
1041 NOTMUCH_SRCDIR = ${NOTMUCH_SRCDIR}
1043 # subdirectories to build
1044 subdirs = ${subdirs}
1046 configure_options = $@
1048 # We use vpath directives (rather than the VPATH variable) since the
1049 # VPATH variable matches targets as well as prerequisites, (which is
1050 # not useful since then a target left-over from a srcdir build would
1051 # cause a target to not be built in the non-srcdir build).
1053 # Also, we don't use a single "vpath % \$(srcdir)" here because we
1054 # don't want the vpath to trigger for our emacs lisp compilation,
1055 # (unless we first find a way to convince emacs to build the .elc
1056 # target in a directory other than the directory of the .el
1057 # prerequisite). In the meantime, we're actually copying in the .el
1058 # files, (which is quite ugly).
1059 vpath %.c \$(srcdir)
1060 vpath %.cc \$(srcdir)
1061 vpath Makefile.% \$(srcdir)
1062 vpath %.py \$(srcdir)
1063 vpath %.rst \$(srcdir)
1065 # Library versions (used to make SONAME)
1066 # The major version of the library interface. This will control the soname.
1067 # As such, this number must be incremented for any incompatible change to
1068 # the library interface, (such as the deletion of an API or a major
1069 # semantic change that breaks formerly functioning code).
1071 LIBNOTMUCH_VERSION_MAJOR = ${libnotmuch_version_major}
1073 # The minor version of the library interface. This should be incremented at
1074 # the time of release for any additions to the library interface,
1075 # (and when it is incremented, the release version of the library should
1077 LIBNOTMUCH_VERSION_MINOR = ${libnotmuch_version_minor}
1079 # The release version the library interface. This should be incremented at
1080 # the time of release if there have been no changes to the interface, (but
1081 # simply compatible changes to the implementation).
1082 LIBNOTMUCH_VERSION_RELEASE = ${libnotmuch_version_release}
1084 # These are derived from the VERSION macros in lib/notmuch.h so
1085 # if you have to change them, something is wrong.
1087 # The C compiler to use
1090 # The C++ compiler to use
1093 # Command to execute emacs from Makefiles
1094 EMACS = emacs --quick
1096 # Default FLAGS for C compiler (can be overridden by user such as "make CFLAGS=-g")
1099 # Default FLAGS for C preprocessor (can be overridden by user such as "make CPPFLAGS=-I/usr/local/include")
1100 CPPFLAGS = ${CPPFLAGS}
1102 # Default FLAGS for C++ compiler (can be overridden by user such as "make CXXFLAGS=-g")
1103 CXXFLAGS = ${CXXFLAGS}
1105 # Default FLAGS for the linker (can be overridden by user such as "make LDFLAGS=-znow")
1106 LDFLAGS = ${LDFLAGS}
1108 # Flags to enable warnings when using the C++ compiler
1109 WARN_CXXFLAGS=${WARN_CXXFLAGS}
1111 # Flags to enable warnings when using the C compiler
1112 WARN_CFLAGS=${WARN_CFLAGS}
1114 # Name of python interpreter
1117 # Name of ruby interpreter
1120 # The prefix to which notmuch should be installed
1121 # Note: If you change this value here, be sure to ensure that the
1122 # LIBDIR_IN_LDCONFIG value below is still set correctly.
1125 # The directory to which libraries should be installed
1126 # Note: If you change this value here, be sure to ensure that the
1127 # LIBDIR_IN_LDCONFIG value below is still set correctly.
1128 libdir = ${LIBDIR:=\$(prefix)/lib}
1130 # Whether libdir is in a path configured into ldconfig
1131 LIBDIR_IN_LDCONFIG = ${libdir_in_ldconfig}
1133 # The directory to which header files should be installed
1134 includedir = ${INCLUDEDIR:=\$(prefix)/include}
1136 # The directory to which man pages should be installed
1137 mandir = ${MANDIR:=\$(prefix)/share/man}
1139 # The directory to which man pages should be installed
1140 infodir = ${INFODIR:=\$(prefix)/share/info}
1142 # The directory to which read-only (configuration) files should be installed
1143 sysconfdir = ${SYSCONFDIR:=\$(prefix)/etc}
1145 # The directory to which emacs lisp files should be installed
1146 emacslispdir=${EMACSLISPDIR}
1148 # The directory to which emacs miscellaneous (machine-independent) files should
1150 emacsetcdir=${EMACSETCDIR}
1152 # Whether bash exists, and if so where
1153 HAVE_BASH = ${have_bash}
1154 BASH_ABSOLUTE = ${bash_absolute}
1156 # Whether perl exists, and if so where
1157 HAVE_PERL = ${have_perl}
1158 PERL_ABSOLUTE = ${perl_absolute}
1160 # Whether there's an emacs binary available for byte-compiling
1161 HAVE_EMACS = ${have_emacs}
1163 # Whether there's a sphinx-build binary available for building documentation
1164 HAVE_SPHINX=${have_sphinx}
1166 # Whether there's a makeinfo binary available for building info format documentation
1167 HAVE_MAKEINFO=${have_makeinfo}
1169 # Whether there's an install-info binary available for installing info format documentation
1170 HAVE_INSTALL_INFO=${have_install_info}
1172 # Whether there's a doxygen binary available for building api documentation
1173 HAVE_DOXYGEN=${have_doxygen}
1175 # The directory to which desktop files should be installed
1176 desktop_dir = \$(prefix)/share/applications
1178 # The directory to which bash completions files should be installed
1179 bash_completion_dir = ${BASHCOMPLETIONDIR:=\$(prefix)/share/bash-completion/completions}
1181 # The directory to which zsh completions files should be installed
1182 zsh_completion_dir = ${ZSHCOMLETIONDIR:=\$(prefix)/share/zsh/functions/Completion/Unix}
1184 # Whether the canonicalize_file_name function is available (if not, then notmuch will
1185 # build its own version)
1186 HAVE_CANONICALIZE_FILE_NAME = ${have_canonicalize_file_name}
1188 # Whether the cppcheck static checker is available
1189 HAVE_CPPCHECK = ${have_cppcheck}
1191 # Whether the getline function is available (if not, then notmuch will
1192 # build its own version)
1193 HAVE_GETLINE = ${have_getline}
1195 # Are the ruby development files (and ruby) available? If not skip
1196 # building/testing ruby bindings.
1197 HAVE_RUBY_DEV = ${have_ruby_dev}
1199 # Whether the strcasestr function is available (if not, then notmuch will
1200 # build its own version)
1201 HAVE_STRCASESTR = ${have_strcasestr}
1203 # Whether the strsep function is available (if not, then notmuch will
1204 # build its own version)
1205 HAVE_STRSEP = ${have_strsep}
1207 # Whether the timegm function is available (if not, then notmuch will
1208 # build its own version)
1209 HAVE_TIMEGM = ${have_timegm}
1211 # Whether struct dirent has d_type (if not, then notmuch will use stat)
1212 HAVE_D_TYPE = ${have_d_type}
1214 # Whether the Xapian version in use supports compaction
1215 HAVE_XAPIAN_COMPACT = ${have_xapian_compact}
1217 # Whether the Xapian version in use supports field processors
1218 HAVE_XAPIAN_FIELD_PROCESSOR = ${have_xapian_field_processor}
1220 # Whether the Xapian version in use supports DB_RETRY_LOCK
1221 HAVE_XAPIAN_DB_RETRY_LOCK = ${have_xapian_db_retry_lock}
1223 # Whether the getpwuid_r function is standards-compliant
1224 # (if not, then notmuch will #define _POSIX_PTHREAD_SEMANTICS
1225 # to enable the standards-compliant version -- needed for Solaris)
1226 STD_GETPWUID = ${std_getpwuid}
1228 # Whether the asctime_r function is standards-compliant
1229 # (if not, then notmuch will #define _POSIX_PTHREAD_SEMANTICS
1230 # to enable the standards-compliant version -- needed for Solaris)
1231 STD_ASCTIME = ${std_asctime}
1233 # Supported platforms (so far) are: LINUX, MACOSX, SOLARIS, FREEBSD, OPENBSD
1234 PLATFORM = ${platform}
1236 # Whether the linker will automatically resolve the dependency of one
1237 # library on another (if not, then linking a binary requires linking
1238 # directly against both)
1239 LINKER_RESOLVES_LIBRARY_DEPENDENCIES = ${linker_resolves_library_dependencies}
1241 # Flags needed to compile and link against Xapian
1242 XAPIAN_CXXFLAGS = ${xapian_cxxflags}
1243 XAPIAN_LDFLAGS = ${xapian_ldflags}
1245 # Which backend will Xapian use by default?
1246 DEFAULT_XAPIAN_BACKEND = ${default_xapian_backend}
1248 # Flags needed to compile and link against GMime
1249 GMIME_CFLAGS = ${gmime_cflags}
1250 GMIME_LDFLAGS = ${gmime_ldflags}
1252 # Flags needed to compile and link against zlib
1253 ZLIB_CFLAGS = ${zlib_cflags}
1254 ZLIB_LDFLAGS = ${zlib_ldflags}
1256 # Flags needed to compile and link against talloc
1257 TALLOC_CFLAGS = ${talloc_cflags}
1258 TALLOC_LDFLAGS = ${talloc_ldflags}
1260 # Flags needed to have linker set rpath attribute
1261 RPATH_LDFLAGS = ${rpath_ldflags}
1263 # Flags needed to have linker link only to necessary libraries
1264 AS_NEEDED_LDFLAGS = ${as_needed_ldflags}
1266 # Flags to have the linker flag undefined symbols in object files
1267 NO_UNDEFINED_LDFLAGS = ${no_undefined_ldflags}
1269 # Whether valgrind header files are available
1270 HAVE_VALGRIND = ${have_valgrind}
1272 # And if so, flags needed at compile time for valgrind macros
1273 VALGRIND_CFLAGS = ${valgrind_cflags}
1276 WITH_EMACS = ${WITH_EMACS}
1278 # Support for desktop file
1279 WITH_DESKTOP = ${WITH_DESKTOP}
1281 # Support for bash completion
1282 WITH_BASH = ${WITH_BASH}
1284 # Support for zsh completion
1285 WITH_ZSH = ${WITH_ZSH}
1287 # Combined flags for compiling and linking against all of the above
1288 COMMON_CONFIGURE_CFLAGS = \\
1289 \$(GMIME_CFLAGS) \$(TALLOC_CFLAGS) \$(ZLIB_CFLAGS) \\
1290 -DHAVE_VALGRIND=\$(HAVE_VALGRIND) \$(VALGRIND_CFLAGS) \\
1291 -DHAVE_GETLINE=\$(HAVE_GETLINE) \\
1292 -DWITH_EMACS=\$(WITH_EMACS) \\
1293 -DHAVE_CANONICALIZE_FILE_NAME=\$(HAVE_CANONICALIZE_FILE_NAME) \\
1294 -DHAVE_STRCASESTR=\$(HAVE_STRCASESTR) \\
1295 -DHAVE_STRSEP=\$(HAVE_STRSEP) \\
1296 -DHAVE_TIMEGM=\$(HAVE_TIMEGM) \\
1297 -DHAVE_D_TYPE=\$(HAVE_D_TYPE) \\
1298 -DSTD_GETPWUID=\$(STD_GETPWUID) \\
1299 -DSTD_ASCTIME=\$(STD_ASCTIME) \\
1300 -DHAVE_XAPIAN_COMPACT=\$(HAVE_XAPIAN_COMPACT) \\
1301 -DSILENCE_XAPIAN_DEPRECATION_WARNINGS \\
1302 -DHAVE_XAPIAN_FIELD_PROCESSOR=\$(HAVE_XAPIAN_FIELD_PROCESSOR) \\
1303 -DHAVE_XAPIAN_DB_RETRY_LOCK=\$(HAVE_XAPIAN_DB_RETRY_LOCK)
1305 CONFIGURE_CFLAGS = \$(COMMON_CONFIGURE_CFLAGS)
1307 CONFIGURE_CXXFLAGS = \$(COMMON_CONFIGURE_CFLAGS) \$(XAPIAN_CXXFLAGS)
1309 CONFIGURE_LDFLAGS = \$(GMIME_LDFLAGS) \$(TALLOC_LDFLAGS) \$(ZLIB_LDFLAGS) \$(XAPIAN_LDFLAGS)
1312 # construct the sh.config
1313 cat > sh.config <<EOF
1314 # This sh.config was automatically generated by the ./configure
1315 # script of notmuch.
1317 NOTMUCH_SRCDIR='${NOTMUCH_SRCDIR}'
1319 # Whether the Xapian version in use supports compaction
1320 NOTMUCH_HAVE_XAPIAN_COMPACT=${have_xapian_compact}
1322 # Whether the Xapian version in use supports field processors
1323 NOTMUCH_HAVE_XAPIAN_FIELD_PROCESSOR=${have_xapian_field_processor}
1325 # Whether the Xapian version in use supports lock retry
1326 NOTMUCH_HAVE_XAPIAN_DB_RETRY_LOCK=${have_xapian_db_retry_lock}
1328 # Which backend will Xapian use by default?
1329 NOTMUCH_DEFAULT_XAPIAN_BACKEND=${default_xapian_backend}
1331 # do we have man pages?
1332 NOTMUCH_HAVE_MAN=$((have_sphinx))
1334 # Whether bash exists, and if so where
1335 NOTMUCH_HAVE_BASH=${have_bash}
1336 NOTMUCH_BASH_ABSOLUTE=${bash_absolute}
1338 # Whether perl exists, and if so where
1339 NOTMUCH_HAVE_PERL=${have_perl}
1340 NOTMUCH_PERL_ABSOLUTE=${perl_absolute}
1342 # Name of python interpreter
1343 NOTMUCH_PYTHON=${python}
1345 # Name of ruby interpreter
1346 NOTMUCH_RUBY=${RUBY}
1348 # Are the ruby development files (and ruby) available? If not skip
1349 # building/testing ruby bindings.
1350 NOTMUCH_HAVE_RUBY_DEV=${have_ruby_dev}
1352 # Platform we are run on
1353 PLATFORM=${platform}
1356 # Finally, after everything configured, inform the user how to continue.
1359 All required packages were found. You may now run the following
1360 commands to compile and install notmuch: