build: install notmuch-emacs-mua.desktop file with emacs
[notmuch] / configure
1 #! /bin/sh
2
3 set -u
4
5 # Test whether this shell is capable of parameter substring processing.
6 ( option='a/b'; : ${option#*/} ) 2>/dev/null || {
7     echo "
8 The shell interpreting '$0' is lacking some required features.
9
10 To work around this problem you may try to execute:
11
12     ksh $0 $*
13  or
14     bash $0 $*
15 "
16     exit 1
17 }
18
19 # Store original IFS value so it can be changed (and restored) in many places.
20 readonly DEFAULT_IFS="$IFS"
21
22 srcdir=$(dirname "$0")
23
24 subdirs="util compat lib parse-time-string completion doc emacs"
25 subdirs="${subdirs} performance-test test test/test-databases"
26 subdirs="${subdirs} bindings"
27
28 # For a non-srcdir configure invocation (such as ../configure), create
29 # the directory structure and copy Makefiles.
30 if [ "$srcdir" != "." ]; then
31
32     for dir in . ${subdirs}; do
33         mkdir -p "$dir"
34         cp "$srcdir"/"$dir"/Makefile.local "$dir"
35         cp "$srcdir"/"$dir"/Makefile "$dir"
36     done
37
38     # Easiest way to get the test suite to work is to just copy the
39     # whole thing into the build directory.
40     cp -a "$srcdir"/test/* test
41
42     # Emacs only likes to generate compiled files next to the .el files
43     # by default so copy these as well (which is not ideal).
44     cp -a "$srcdir"/emacs/*.el emacs
45 fi
46
47 # Set several defaults (optionally specified by the user in
48 # environment variables)
49 CC=${CC:-cc}
50 CXX=${CXX:-c++}
51 CFLAGS=${CFLAGS:--g -O2}
52 CPPFLAGS=${CPPFLAGS:-}
53 CXXFLAGS_for_sh=${CXXFLAGS:-${CFLAGS}}
54 CXXFLAGS=${CXXFLAGS:-\$(CFLAGS)}
55 LDFLAGS=${LDFLAGS:-}
56 XAPIAN_CONFIG=${XAPIAN_CONFIG:-}
57 PYTHON=${PYTHON:-}
58
59 # We don't allow the EMACS or GZIP Makefile variables inherit values
60 # from the environment as we do with CC and CXX above. The reason is
61 # that these names as environment variables have existing uses other
62 # than the program name that we want. (EMACS is set to 't' when a
63 # shell is running within emacs and GZIP specifies arguments to pass
64 # on the gzip command line).
65
66 # Set the defaults for values the user can specify with command-line
67 # options.
68 PREFIX=/usr/local
69 LIBDIR=
70 WITH_DOCS=1
71 WITH_API_DOCS=1
72 WITH_EMACS=1
73 WITH_DESKTOP=1
74 WITH_BASH=1
75 WITH_RUBY=1
76 WITH_ZSH=1
77 WITH_RETRY_LOCK=1
78
79 usage ()
80 {
81     cat <<EOF
82 Usage: ./configure [options]...
83
84 This script configures notmuch to build on your system.
85
86 It verifies that dependencies are available, determines flags needed
87 to compile and link against various required libraries, and identifies
88 whether various system functions can be used or if locally-provided
89 replacements will be built instead.
90
91 Finally, it allows you to control various aspects of the build and
92 installation process.
93
94 First, some common variables can specified via environment variables:
95
96         CC              The C compiler to use
97         CFLAGS          Flags to pass to the C compiler
98         CPPFLAGS        Flags to pass to the C preprocessor
99         CXX             The C++ compiler to use
100         CXXFLAGS        Flags to pass to the C compiler
101         LDFLAGS         Flags to pass when linking
102
103 Each of these values can further be controlled by specifying them
104 later on the "make" command line.
105
106 Other environment variables can be used to control configure itself,
107 (and for which there is no equivalent build-time control):
108
109         XAPIAN_CONFIG   The program to use to determine flags for
110                         compiling and linking against the Xapian
111                         library. [$XAPIAN_CONFIG]
112         PYTHON          Name of python command to use in
113                         configure and the test suite.
114
115 Additionally, various options can be specified on the configure
116 command line.
117
118         --prefix=PREFIX Install files in PREFIX [$PREFIX]
119
120 By default, "make install" will install the resulting program to
121 $PREFIX/bin, documentation to $PREFIX/man, etc. You can
122 specify an installation prefix other than $PREFIX using
123 --prefix, for instance:
124
125         ./configure --prefix=\$HOME
126
127 Fine tuning of some installation directories is available:
128
129         --libdir=DIR            Install libraries to DIR [PREFIX/lib]
130         --includedir=DIR        Install header files to DIR [PREFIX/include]
131         --mandir=DIR            Install man pages to DIR [PREFIX/share/man]
132         --sysconfdir=DIR        Read-only single-machine data [PREFIX/etc]
133         --emacslispdir=DIR      Emacs code [PREFIX/share/emacs/site-lisp]
134         --emacsetcdir=DIR       Emacs miscellaneous files [PREFIX/share/emacs/site-lisp]
135         --bashcompletiondir=DIR Bash completions files [SYSCONFDIR/bash_completion.d]
136         --zshcompletiondir=DIR  Zsh completions files [PREFIX/share/zsh/functions/Completion/Unix]
137
138 Some features can be disabled (--with-feature=no is equivalent to
139 --without-feature) :
140
141         --without-bash-completion       Do not install bash completions files
142         --without-docs                  Do not install documentation
143         --without-api-docs              Do not install API man page
144         --without-emacs                 Do not install lisp file
145         --without-desktop               Do not install desktop file
146         --without-ruby                  Do not install ruby bindings
147         --without-zsh-completion        Do not install zsh completions files
148         --without-retry-lock            Do not use blocking xapian opens, even if available
149
150 Additional options are accepted for compatibility with other
151 configure-script calling conventions, but don't do anything yet:
152
153         --build=<cpu>-<vendor>-<os>     Currently ignored
154         --host=<cpu>-<vendor>-<os>      Currently ignored
155         --infodir=DIR                   Currently ignored
156         --datadir=DIR                   Currently ignored
157         --localstatedir=DIR             Currently ignored
158         --libexecdir=DIR                Currently ignored
159         --disable-maintainer-mode       Currently ignored
160         --disable-dependency-tracking   Currently ignored
161
162 EOF
163 }
164
165 # Parse command-line options
166 for option; do
167     if [ "${option}" = '--help' ] ; then
168         usage
169         exit 0
170     elif [ "${option%%=*}" = '--prefix' ] ; then
171         PREFIX="${option#*=}"
172     elif [ "${option%%=*}" = '--libdir' ] ; then
173         LIBDIR="${option#*=}"
174     elif [ "${option%%=*}" = '--includedir' ] ; then
175         INCLUDEDIR="${option#*=}"
176     elif [ "${option%%=*}" = '--mandir' ] ; then
177         MANDIR="${option#*=}"
178     elif [ "${option%%=*}" = '--sysconfdir' ] ; then
179         SYSCONFDIR="${option#*=}"
180     elif [ "${option%%=*}" = '--emacslispdir' ] ; then
181         EMACSLISPDIR="${option#*=}"
182     elif [ "${option%%=*}" = '--emacsetcdir' ] ; then
183         EMACSETCDIR="${option#*=}"
184     elif [ "${option%%=*}" = '--bashcompletiondir' ] ; then
185         BASHCOMPLETIONDIR="${option#*=}"
186     elif [ "${option%%=*}" = '--zshcompletiondir' ] ; then
187         ZSHCOMLETIONDIR="${option#*=}"
188     elif [ "${option%%=*}" = '--with-docs' ]; then
189         if [ "${option#*=}" = 'no' ]; then
190             WITH_DOCS=0
191             WITH_API_DOCS=0
192         else
193             WITH_DOCS=1
194         fi
195     elif [ "${option}" = '--without-docs' ] ; then
196         WITH_DOCS=0
197         WITH_API_DOCS=0
198     elif [ "${option%%=*}" = '--with-api-docs' ]; then
199         if [ "${option#*=}" = 'no' ]; then
200             WITH_API_DOCS=0
201         else
202             WITH_API_DOCS=1
203         fi
204     elif [ "${option}" = '--without-api-docs' ] ; then
205         WITH_API_DOCS=0
206     elif [ "${option%%=*}" = '--with-emacs' ]; then
207         if [ "${option#*=}" = 'no' ]; then
208             WITH_EMACS=0
209         else
210             WITH_EMACS=1
211         fi
212     elif [ "${option}" = '--without-emacs' ] ; then
213         WITH_EMACS=0
214     elif [ "${option%%=*}" = '--with-desktop' ]; then
215         if [ "${option#*=}" = 'no' ]; then
216             WITH_DESKTOP=0
217         else
218             WITH_DESKTOP=1
219         fi
220     elif [ "${option}" = '--without-desktop' ] ; then
221         WITH_DESKTOP=0
222     elif [ "${option%%=*}" = '--with-bash-completion' ]; then
223         if [ "${option#*=}" = 'no' ]; then
224             WITH_BASH=0
225         else
226             WITH_BASH=1
227         fi
228     elif [ "${option}" = '--without-bash-completion' ] ; then
229         WITH_BASH=0
230     elif [ "${option%%=*}" = '--with-ruby' ]; then
231         if [ "${option#*=}" = 'no' ]; then
232             WITH_RUBY=0
233         else
234             WITH_RUBY=1
235         fi
236     elif [ "${option}" = '--without-ruby' ] ; then
237         WITH_RUBY=0
238     elif [ "${option%%=*}" = '--with-retry-lock' ]; then
239         if [ "${option#*=}" = 'no' ]; then
240             WITH_RETRY_LOCK=0
241         else
242             WITH_RETRY_LOCK=1
243         fi
244     elif [ "${option}" = '--without-retry-lock' ] ; then
245         WITH_RETRY_LOCK=0
246     elif [ "${option%%=*}" = '--with-zsh-completion' ]; then
247         if [ "${option#*=}" = 'no' ]; then
248             WITH_ZSH=0
249         else
250             WITH_ZSH=1
251         fi
252     elif [ "${option}" = '--without-zsh-completion' ] ; then
253         WITH_ZSH=0
254     elif [ "${option%%=*}" = '--build' ] ; then
255         true
256     elif [ "${option%%=*}" = '--host' ] ; then
257         true
258     elif [ "${option%%=*}" = '--infodir' ] ; then
259         true
260     elif [ "${option%%=*}" = '--datadir' ] ; then
261         true
262     elif [ "${option%%=*}" = '--localstatedir' ] ; then
263         true
264     elif [ "${option%%=*}" = '--libexecdir' ] ; then
265         true
266     elif [ "${option}" = '--disable-maintainer-mode' ] ; then
267         true
268     elif [ "${option}" = '--disable-dependency-tracking' ] ; then
269         true
270     else
271         echo "Unrecognized option: ${option}"
272         echo "See:"
273         echo "  $0 --help"
274         echo ""
275         exit 1
276     fi
277 done
278
279 # We set this value early, (rather than just while printing the
280 # Makefile.config file later like most values), because we need to
281 # actually investigate this value compared to the ldconfig_paths value
282 # below.
283 if [ -z "$LIBDIR" ] ; then
284     libdir_expanded="${PREFIX}/lib"
285 else
286     # very non-general variable expansion
287     libdir_expanded=$(echo "$LIBDIR" | sed "s|\\${prefix}|${PREFIX}|g; s|\\$prefix/|${PREFIX}/|; s|//*|/|g")
288 fi
289
290 cat <<EOF
291 Welcome to Notmuch, a system for indexing, searching and tagging your email.
292
293 We hope that the process of building and installing notmuch is quick
294 and smooth so that you can soon be reading and processing your email
295 more efficiently than ever.
296
297 If anything goes wrong in the configure process, you can override any
298 decisions it makes by manually editing the Makefile.config file that
299 it creates. Also please do as much as you can to figure out what could
300 be different on your machine compared to those of the notmuch
301 developers. Then, please email those details to the Notmuch list
302 (notmuch@notmuchmail.org) so that we can hopefully make future
303 versions of notmuch easier for you to use.
304
305 We'll now investigate your system to verify that all required
306 dependencies are available:
307
308 EOF
309
310 errors=0
311 printf "int main(void){return 0;}\n" > minimal.c
312
313 printf "Sanity checking C compilation environment... "
314 if ${CC} ${CFLAGS} ${CPPFLAGS} minimal.c ${LDFLAGS} -o minimal > /dev/null 2>&1
315 then
316     printf "OK.\n"
317 else
318     printf "Fail.\n"
319     errors=$((errors + 1))
320 fi
321
322 printf "Sanity checking C++ compilation environment... "
323 if ${CXX} ${CXXFLAGS_for_sh} ${CPPFLAGS} minimal.c ${LDFLAGS} -o minimal > /dev/null 2>&1
324 then
325     printf "OK.\n"
326 else
327     printf "Fail.\n"
328     errors=$((errors + 1))
329 fi
330
331 if [ $errors -gt 0 ]; then
332     cat <<EOF
333 *** Error: Initial sanity checking of environment failed.  Please try
334 running configure in a clean environment, and if the problem persists,
335 report a bug.
336 EOF
337     rm -f minimal minimal.c
338     exit 1
339 fi
340
341 printf "Reading libnotmuch version from source... "
342 cat > _libversion.c <<EOF
343 #include <stdio.h>
344 #include "lib/notmuch.h"
345 int main(void) {
346     printf("libnotmuch_version_major=%d\n",
347                 LIBNOTMUCH_MAJOR_VERSION);
348     printf("libnotmuch_version_minor=%d\n",
349                 LIBNOTMUCH_MINOR_VERSION);
350     printf("libnotmuch_version_release=%d\n",
351                 LIBNOTMUCH_MICRO_VERSION);
352     return 0;
353 }
354 EOF
355 if ${CC} ${CFLAGS} _libversion.c -o _libversion > /dev/null 2>&1 && \
356        ./_libversion > _libversion.sh && . ./_libversion.sh
357 then
358     printf "OK.\n"
359 else
360     cat <<EOF
361
362 *** Error: Reading lib/notmuch.h failed.
363 Please try running configure again in a clean environment, and if the
364 problem persists, report a bug.
365 EOF
366     rm -f _libversion _libversion.c _libversion.sh
367     exit 1
368 fi
369
370 if pkg-config --version > /dev/null 2>&1; then
371     have_pkg_config=1
372 else
373     have_pkg_config=0
374 fi
375
376 printf "Checking for Xapian development files... "
377 have_xapian=0
378 for xapian_config in ${XAPIAN_CONFIG} xapian-config xapian-config-1.3; do
379     if ${xapian_config} --version > /dev/null 2>&1; then
380         xapian_version=$(${xapian_config} --version | sed -e 's/.* //')
381         printf "Yes (%s).\n" ${xapian_version}
382         have_xapian=1
383         xapian_cxxflags=$(${xapian_config} --cxxflags)
384         xapian_ldflags=$(${xapian_config} --libs)
385         break
386     fi
387 done
388 if [ ${have_xapian} = "0" ]; then
389     printf "No.\n"
390     errors=$((errors + 1))
391 fi
392
393 have_xapian_compact=0
394 have_xapian_field_processor=0
395 if [ ${have_xapian} = "1" ]; then
396     printf "Checking for Xapian compaction support... "
397     cat>_compact.cc<<EOF
398 #include <xapian.h>
399 class TestCompactor : public Xapian::Compactor { };
400 EOF
401     if ${CXX} ${CXXFLAGS_for_sh} ${xapian_cxxflags} -c _compact.cc -o _compact.o > /dev/null 2>&1
402     then
403         have_xapian_compact=1
404         printf "Yes.\n"
405     else
406         printf "No.\n"
407         errors=$((errors + 1))
408     fi
409
410     rm -f _compact.o _compact.cc
411
412     printf "Checking for Xapian FieldProcessor API... "
413     cat>_field_processor.cc<<EOF
414 #include <xapian.h>
415 class TitleFieldProcessor : public Xapian::FieldProcessor { };
416 EOF
417     if ${CXX} ${CXXFLAGS_for_sh} ${xapian_cxxflags} -c _field_processor.cc -o _field_processor.o > /dev/null 2>&1
418     then
419         have_xapian_field_processor=1
420         printf "Yes.\n"
421     else
422         printf "No. (optional)\n"
423     fi
424
425     rm -f _field_processor.o _field_processor.cc
426
427     default_xapian_backend=""
428     # DB_RETRY_LOCK is only supported on Xapian > 1.3.2
429     have_xapian_db_retry_lock=0
430     if [ $WITH_RETRY_LOCK = "1" ]; then
431         printf "Checking for Xapian lock retry support... "
432         cat>_retry.cc<<EOF
433 #include <xapian.h>
434 int flag = Xapian::DB_RETRY_LOCK;
435 EOF
436         if ${CXX} ${CXXFLAGS_for_sh} ${xapian_cxxflags} -c _retry.cc -o _retry.o > /dev/null 2>&1
437         then
438             have_xapian_db_retry_lock=1
439             printf "Yes.\n"
440         else
441             printf "No. (optional)\n"
442         fi
443         rm -f _retry.o _retry.cc
444     fi
445
446     printf "Testing default Xapian backend... "
447     cat >_default_backend.cc <<EOF
448 #include <xapian.h>
449 int main(int argc, char** argv) {
450    Xapian::WritableDatabase db("test.db",Xapian::DB_CREATE_OR_OPEN);
451 }
452 EOF
453     ${CXX} ${CXXFLAGS_for_sh} ${xapian_cxxflags} _default_backend.cc -o _default_backend ${xapian_ldflags}
454     ./_default_backend
455     if [ -f test.db/iamglass ]; then
456         default_xapian_backend=glass
457     else
458         default_xapian_backend=chert
459     fi
460     printf "%s\n" "${default_xapian_backend}";
461     rm -rf test.db _default_backend _default_backend.cc
462 fi
463
464 # we need to have a version >= 2.6.5 to avoid a crypto bug. We need
465 # 2.6.7 for permissive "From " header handling.
466 GMIME_MINVER=2.6.7
467
468 printf "Checking for GMime development files... "
469 if pkg-config --exists "gmime-2.6 >= $GMIME_MINVER"; then
470     printf "Yes.\n"
471     have_gmime=1
472     gmime_cflags=$(pkg-config --cflags gmime-2.6)
473     gmime_ldflags=$(pkg-config --libs gmime-2.6)
474 else
475     have_gmime=0
476     printf "No.\n"
477     errors=$((errors + 1))
478 fi
479
480 # GMime already depends on Glib >= 2.12, but we use at least one Glib
481 # function that only exists as of 2.22, (g_array_unref)
482 printf "Checking for Glib development files (>= 2.22)... "
483 have_glib=0
484 if pkg-config --exists 'glib-2.0 >= 2.22'; then
485     printf "Yes.\n"
486     have_glib=1
487     # these are included in gmime cflags and ldflags
488     # glib_cflags=$(pkg-config --cflags glib-2.0)
489     # glib_ldflags=$(pkg-config --libs glib-2.0)
490 else
491     printf "No.\n"
492     errors=$((errors + 1))
493 fi
494
495 if ! pkg-config --exists zlib; then
496   ${CC} ${zlib_cflags} -o compat/gen_zlib_pc \
497           "$srcdir"/compat/gen_zlib_pc.c ${zlib_ldflags} > /dev/null 2>&1 &&
498   compat/gen_zlib_pc > compat/zlib.pc &&
499   PKG_CONFIG_PATH="$PKG_CONFIG_PATH":compat &&
500   export PKG_CONFIG_PATH
501   rm -f compat/gen_zlib_pc
502 fi
503
504 printf "Checking for zlib (>= 1.2.5.2)... "
505 have_zlib=0
506 if pkg-config --atleast-version=1.2.5.2 zlib; then
507     printf "Yes.\n"
508     have_zlib=1
509     zlib_cflags=$(pkg-config --cflags zlib)
510     zlib_ldflags=$(pkg-config --libs zlib)
511 else
512     printf "No.\n"
513     errors=$((errors + 1))
514 fi
515
516 printf "Checking for talloc development files... "
517 if pkg-config --exists talloc; then
518     printf "Yes.\n"
519     have_talloc=1
520     talloc_cflags=$(pkg-config --cflags talloc)
521     talloc_ldflags=$(pkg-config --libs talloc)
522 else
523     printf "No.\n"
524     have_talloc=0
525     talloc_cflags=
526     errors=$((errors + 1))
527 fi
528
529 printf "Checking for python... "
530 have_python=0
531
532 for name in ${PYTHON} python python2 python3; do
533     if command -v $name > /dev/null; then
534         have_python=1
535         python=$name
536         printf "Yes (%s).\n" "$name"
537         break
538     fi
539 done
540
541 if [ $have_python -eq 0 ]; then
542     printf "No.\n"
543     errors=$((errors + 1))
544 fi
545
546 printf "Checking for valgrind development files... "
547 if pkg-config --exists valgrind; then
548     printf "Yes.\n"
549     have_valgrind=1
550     valgrind_cflags=$(pkg-config --cflags valgrind)
551 else
552     printf "No (but that's fine).\n"
553     have_valgrind=0
554     valgrind_cflags=
555 fi
556
557 printf "Checking for bash-completion (>= 1.90)... "
558 if pkg-config --atleast-version=1.90 bash-completion; then
559     printf "Yes.\n"
560 else
561     printf "No (will not install bash completion).\n"
562     WITH_BASH=0
563 fi
564
565 if [ -z "${EMACSLISPDIR-}" ]; then
566     EMACSLISPDIR="\$(prefix)/share/emacs/site-lisp"
567 fi
568
569 if [ -z "${EMACSETCDIR-}" ]; then
570     EMACSETCDIR="\$(prefix)/share/emacs/site-lisp"
571 fi
572
573 printf "Checking if emacs is available... "
574 if emacs --quick --batch > /dev/null 2>&1; then
575     printf "Yes.\n"
576     have_emacs=1
577 else
578     printf "No (so will not byte-compile emacs code)\n"
579     have_emacs=0
580 fi
581
582 have_doxygen=0
583 if [ $WITH_API_DOCS = "1" ] ; then
584     printf "Checking if doxygen is available... "
585     if command -v doxygen > /dev/null; then
586         printf "Yes.\n"
587         have_doxygen=1
588     else
589         printf "No (so will not install api docs)\n"
590     fi
591 fi
592
593 have_ruby_dev=0
594 if [ $WITH_RUBY = "1" ] ; then
595     printf "Checking for ruby development files... "
596     if ruby -e "require 'mkmf'"> /dev/null 2>&1; then
597         printf "Yes.\n"
598         have_ruby_dev=1
599     else
600         printf "No (skipping ruby bindings)\n"
601     fi
602 fi
603
604 have_sphinx=0
605 if [ $WITH_DOCS = "1" ] ; then
606     printf "Checking if sphinx is available and supports nroff output... "
607     if command -v sphinx-build > /dev/null && ${python} -m sphinx.writers.manpage > /dev/null 2>&1 ; then
608         printf "Yes.\n"
609         have_sphinx=1
610     else
611         printf "No (so will not install man pages).\n"
612     fi
613 fi
614
615 if [ $WITH_DESKTOP = "1" ]; then
616     printf "Checking if desktop-file-install is available... "
617     if command -v desktop-file-install > /dev/null; then
618         printf "Yes.\n"
619     else
620         printf "No (so will not install .desktop file).\n"
621         WITH_DESKTOP=0
622     fi
623 fi
624
625 libdir_in_ldconfig=0
626
627 printf "Checking which platform we are on... "
628 uname=$(uname)
629 if [ $uname = "Darwin" ] ; then
630     printf "Mac OS X.\n"
631     platform=MACOSX
632     linker_resolves_library_dependencies=0
633 elif [ $uname = "SunOS" ] ; then
634     printf "Solaris.\n"
635     platform=SOLARIS
636     linker_resolves_library_dependencies=0
637 elif [ $uname = "FreeBSD" ] ; then
638     printf "FreeBSD.\n"
639     platform=FREEBSD
640     linker_resolves_library_dependencies=0
641 elif [ $uname = "OpenBSD" ] ; then
642     printf "OpenBSD.\n"
643     platform=OPENBSD
644     linker_resolves_library_dependencies=0
645 elif [ $uname = "Linux" ] || [ $uname = "GNU" ] ; then
646     printf "%s\n" "$uname"
647     platform="$uname"
648     linker_resolves_library_dependencies=1
649
650     printf "Checking for %s in ldconfig... " "$libdir_expanded"
651     ldconfig_paths=$(/sbin/ldconfig -N -X -v 2>/dev/null | sed -n -e 's,^\(/.*\):\( (.*)\)\?$,\1,p')
652     # Separate ldconfig_paths only on newline (not on any potential
653     # embedded space characters in any filenames). Note, we use a
654     # literal newline in the source here rather than something like:
655     #
656     #   IFS=$(printf '\n')
657     #
658     # because the shell's command substitution deletes any trailing newlines.
659     IFS="
660 "
661     for path in $ldconfig_paths; do
662         if [ "$path" = "$libdir_expanded" ]; then
663             libdir_in_ldconfig=1
664         fi
665     done
666     IFS=$DEFAULT_IFS
667     if [ "$libdir_in_ldconfig" = '0' ]; then
668         printf "No (will set RPATH)\n"
669     else
670         printf "Yes\n"
671     fi
672 else
673     printf "Unknown.\n"
674     platform="$uname"
675     linker_resolves_library_dependencies=0
676     cat <<EOF
677
678 *** Warning: Unknown platform. Notmuch might or might not build correctly.
679
680 EOF
681 fi
682
683 printf "Checking byte order... "
684 cat> _byteorder.c <<EOF
685 #include <stdio.h>
686 #include <stdint.h>
687 uint32_t test = 0x34333231;
688 int main() { printf("%.4s\n", (const char*)&test); return 0; }
689 EOF
690 ${CC} ${CFLAGS} _byteorder.c -o _byteorder > /dev/null 2>&1
691 util_byte_order=$(./_byteorder)
692 echo $util_byte_order
693
694 rm -f _byteorder _byteorder.c
695
696 if [ $errors -gt 0 ]; then
697     cat <<EOF
698
699 *** Error: The dependencies of notmuch could not be satisfied. You will
700 need to install the following packages before being able to compile
701 notmuch:
702
703 EOF
704     if [ $have_python -eq 0 ]; then
705         echo "  python interpreter"
706     fi
707     if [ $have_xapian -eq 0 -o $have_xapian_compact -eq 0 ]; then
708         echo "  Xapian library (>= version 1.2.6, including development files such as headers)"
709         echo "  https://xapian.org/"
710     fi
711     if [ $have_zlib -eq 0 ]; then
712         echo "  zlib library (>= version 1.2.5.2, including development files such as headers)"
713         echo "  http://zlib.net/"
714         echo
715     fi
716     if [ $have_gmime -eq 0 ]; then
717         echo "  GMime 2.6 library >= $GMIME_MINVER"
718         echo "  (including development files such as headers)"
719         echo "  http://spruce.sourceforge.net/gmime/"
720         echo
721     fi
722     if [ $have_glib -eq 0 ]; then
723         echo "  Glib library >= 2.22 (including development files such as headers)"
724         echo "  http://ftp.gnome.org/pub/gnome/sources/glib/"
725         echo
726     fi
727     if [ $have_talloc -eq 0 ]; then
728         echo "  The talloc library (including development files such as headers)"
729         echo "  https://talloc.samba.org/"
730         echo
731     fi
732     cat <<EOF
733 With any luck, you're using a modern, package-based operating system
734 that has all of these packages available in the distribution. In that
735 case a simple command will install everything you need. For example:
736
737 On Debian and similar systems:
738
739         sudo apt-get install libxapian-dev libgmime-2.6-dev libtalloc-dev zlib1g-dev
740
741 Or on Fedora and similar systems:
742
743         sudo yum install xapian-core-devel gmime-devel libtalloc-devel zlib-devel
744
745 On other systems, similar commands can be used, but the details of the
746 package names may be different.
747
748 EOF
749     if [ $have_pkg_config -eq 0 ]; then
750 cat <<EOF
751 Note: the pkg-config program is not available. This configure script
752 uses pkg-config to find the compilation flags required to link against
753 the various libraries needed by notmuch. It's possible you simply need
754 to install pkg-config with a command such as:
755
756         sudo apt-get install pkg-config
757 Or:
758         sudo yum install pkgconfig
759
760 But if pkg-config is not available for your system, then you will need
761 to modify the configure script to manually set the cflags and ldflags
762 variables to the correct values to link against each library in each
763 case that pkg-config could not be used to determine those values.
764
765 EOF
766     fi
767 cat <<EOF
768 When you have installed the necessary dependencies, you can run
769 configure again to ensure the packages can be found, or simply run
770 "make" to compile notmuch.
771
772 EOF
773     exit 1
774 fi
775
776 printf "Checking for canonicalize_file_name... "
777 if ${CC} -o compat/have_canonicalize_file_name "$srcdir"/compat/have_canonicalize_file_name.c > /dev/null 2>&1
778 then
779     printf "Yes.\n"
780     have_canonicalize_file_name=1
781 else
782     printf "No (will use our own instead).\n"
783     have_canonicalize_file_name=0
784 fi
785 rm -f compat/have_canonicalize_file_name
786
787
788 printf "Checking for getline... "
789 if ${CC} -o compat/have_getline "$srcdir"/compat/have_getline.c > /dev/null 2>&1
790 then
791     printf "Yes.\n"
792     have_getline=1
793 else
794     printf "No (will use our own instead).\n"
795     have_getline=0
796 fi
797 rm -f compat/have_getline
798
799 printf "Checking for strcasestr... "
800 if ${CC} -o compat/have_strcasestr "$srcdir"/compat/have_strcasestr.c > /dev/null 2>&1
801 then
802     printf "Yes.\n"
803     have_strcasestr=1
804 else
805     printf "No (will use our own instead).\n"
806     have_strcasestr=0
807 fi
808 rm -f compat/have_strcasestr
809
810 printf "Checking for strsep... "
811 if ${CC} -o compat/have_strsep "$srcdir"/compat/have_strsep.c > /dev/null 2>&1
812 then
813     printf "Yes.\n"
814     have_strsep="1"
815 else
816     printf "No (will use our own instead).\n"
817     have_strsep="0"
818 fi
819 rm -f compat/have_strsep
820
821 printf "Checking for timegm... "
822 if ${CC} -o compat/have_timegm "$srcdir"/compat/have_timegm.c > /dev/null 2>&1
823 then
824     printf "Yes.\n"
825     have_timegm="1"
826 else
827     printf "No (will use our own instead).\n"
828     have_timegm="0"
829 fi
830 rm -f compat/have_timegm
831
832 printf "Checking for dirent.d_type... "
833 if ${CC} -o compat/have_d_type "$srcdir"/compat/have_d_type.c > /dev/null 2>&1
834 then
835     printf "Yes.\n"
836     have_d_type="1"
837 else
838     printf "No (will use stat instead).\n"
839     have_d_type="0"
840 fi
841 rm -f compat/have_d_type
842
843 printf "Checking for standard version of getpwuid_r... "
844 if ${CC} -o compat/check_getpwuid "$srcdir"/compat/check_getpwuid.c > /dev/null 2>&1
845 then
846     printf "Yes.\n"
847     std_getpwuid=1
848 else
849     printf "No (will define _POSIX_PTHREAD_SEMANTICS to get it).\n"
850     std_getpwuid=0
851 fi
852 rm -f compat/check_getpwuid
853
854 printf "Checking for standard version of asctime_r... "
855 if ${CC} -o compat/check_asctime "$srcdir"/compat/check_asctime.c > /dev/null 2>&1
856 then
857     printf "Yes.\n"
858     std_asctime=1
859 else
860     printf "No (will define _POSIX_PTHREAD_SEMANTICS to get it).\n"
861     std_asctime=0
862 fi
863 rm -f compat/check_asctime
864
865 printf "Checking for rpath support... "
866 if ${CC} -Wl,--enable-new-dtags -Wl,-rpath,/tmp/ -o minimal minimal.c >/dev/null 2>&1
867 then
868     printf "Yes.\n"
869     rpath_ldflags="-Wl,--enable-new-dtags -Wl,-rpath,\$(libdir)"
870 else
871     printf "No (nothing to worry about).\n"
872     rpath_ldflags=""
873 fi
874
875 printf "Checking for -Wl,--as-needed... "
876 if ${CC} -Wl,--as-needed -o minimal minimal.c >/dev/null 2>&1
877 then
878     printf "Yes.\n"
879     as_needed_ldflags="-Wl,--as-needed"
880 else
881     printf "No (nothing to worry about).\n"
882     as_needed_ldflags=""
883 fi
884
885 printf "Checking for -Wl,--no-undefined... "
886 if ${CC} -Wl,--no-undefined -o minimal minimal.c >/dev/null 2>&1
887 then
888     printf "Yes.\n"
889     no_undefined_ldflags="-Wl,--no-undefined"
890 else
891     printf "No (nothing to worry about).\n"
892     no_undefined_ldflags=""
893 fi
894
895 WARN_CXXFLAGS=""
896 printf "Checking for available C++ compiler warning flags... "
897 for flag in -Wall -Wextra -Wwrite-strings; do
898     if ${CC} $flag -o minimal minimal.c > /dev/null 2>&1
899     then
900         WARN_CXXFLAGS="${WARN_CXXFLAGS}${WARN_CXXFLAGS:+ }${flag}"
901     fi
902 done
903 printf "\n\t%s\n" "${WARN_CXXFLAGS}"
904
905 WARN_CFLAGS="${WARN_CXXFLAGS}"
906 printf "Checking for available C compiler warning flags... "
907 for flag in -Wmissing-declarations; do
908     if ${CC} $flag -o minimal minimal.c > /dev/null 2>&1
909     then
910         WARN_CFLAGS="${WARN_CFLAGS}${WARN_CFLAGS:+ }${flag}"
911     fi
912 done
913 printf "\n\t%s\n" "${WARN_CFLAGS}"
914
915 rm -f minimal minimal.c _libversion.c _libversion _libversion.sh
916
917 # construct the Makefile.config
918 cat > Makefile.config <<EOF
919 # This Makefile.config was automatically generated by the ./configure
920 # script of notmuch. If the configure script identified anything
921 # incorrectly, then you can edit this file to try to correct things,
922 # but be warned that if configure is run again it will destroy your
923 # changes, (and this could happen by simply calling "make" if the
924 # configure script is updated).
925
926 # The top-level directory for the source, (the directory containing
927 # the configure script). This may be different than the build
928 # directory (the current directory at the time configure was run).
929 srcdir = ${srcdir}
930
931 # subdirectories to build
932 subdirs = ${subdirs}
933
934 configure_options = $@
935
936 # We use vpath directives (rather than the VPATH variable) since the
937 # VPATH variable matches targets as well as prerequisites, (which is
938 # not useful since then a target left-over from a srcdir build would
939 # cause a target to not be built in the non-srcdir build).
940 #
941 # Also, we don't use a single "vpath % \$(srcdir)" here because we
942 # don't want the vpath to trigger for our emacs lisp compilation,
943 # (unless we first find a way to convince emacs to build the .elc
944 # target in a directory other than the directory of the .el
945 # prerequisite). In the meantime, we're actually copying in the .el
946 # files, (which is quite ugly).
947 vpath %.c \$(srcdir)
948 vpath %.cc \$(srcdir)
949 vpath Makefile.% \$(srcdir)
950 vpath %.py \$(srcdir)
951 vpath %.rst \$(srcdir)
952
953 # Library versions (used to make SONAME)
954 # The major version of the library interface. This will control the soname.
955 # As such, this number must be incremented for any incompatible change to
956 # the library interface, (such as the deletion of an API or a major
957 # semantic change that breaks formerly functioning code).
958 #
959 LIBNOTMUCH_VERSION_MAJOR = ${libnotmuch_version_major}
960
961 # The minor version of the library interface. This should be incremented at
962 # the time of release for any additions to the library interface,
963 # (and when it is incremented, the release version of the library should
964 #  be reset to 0).
965 LIBNOTMUCH_VERSION_MINOR = ${libnotmuch_version_minor}
966
967 # The release version the library interface. This should be incremented at
968 # the time of release if there have been no changes to the interface, (but
969 # simply compatible changes to the implementation).
970 LIBNOTMUCH_VERSION_RELEASE = ${libnotmuch_version_release}
971
972 # These are derived from the VERSION macros in lib/notmuch.h so
973 # if you have to change them, something is wrong.
974
975 # The C compiler to use
976 CC = ${CC}
977
978 # The C++ compiler to use
979 CXX = ${CXX}
980
981 # Command to execute emacs from Makefiles
982 EMACS = emacs --quick
983
984 # Default FLAGS for C compiler (can be overridden by user such as "make CFLAGS=-g")
985 CFLAGS = ${CFLAGS}
986
987 # Default FLAGS for C preprocessor (can be overridden by user such as "make CPPFLAGS=-I/usr/local/include")
988 CPPFLAGS = ${CPPFLAGS}
989
990 # Default FLAGS for C++ compiler (can be overridden by user such as "make CXXFLAGS=-g")
991 CXXFLAGS = ${CXXFLAGS}
992
993 # Default FLAGS for the linker (can be overridden by user such as "make LDFLAGS=-znow")
994 LDFLAGS = ${LDFLAGS}
995
996 # Flags to enable warnings when using the C++ compiler
997 WARN_CXXFLAGS=${WARN_CXXFLAGS}
998
999 # Flags to enable warnings when using the C compiler
1000 WARN_CFLAGS=${WARN_CFLAGS}
1001
1002 # Name of python interpreter
1003 PYTHON = ${python}
1004
1005 # The prefix to which notmuch should be installed
1006 # Note: If you change this value here, be sure to ensure that the
1007 # LIBDIR_IN_LDCONFIG value below is still set correctly.
1008 prefix = ${PREFIX}
1009
1010 # The directory to which libraries should be installed
1011 # Note: If you change this value here, be sure to ensure that the
1012 # LIBDIR_IN_LDCONFIG value below is still set correctly.
1013 libdir = ${LIBDIR:=\$(prefix)/lib}
1014
1015 # byte order within a 32 bit word. 1234 = little, 4321 = big, 0 = guess
1016 UTIL_BYTE_ORDER = ${util_byte_order}
1017
1018 # Whether libdir is in a path configured into ldconfig
1019 LIBDIR_IN_LDCONFIG = ${libdir_in_ldconfig}
1020
1021 # The directory to which header files should be installed
1022 includedir = ${INCLUDEDIR:=\$(prefix)/include}
1023
1024 # The directory to which man pages should be installed
1025 mandir = ${MANDIR:=\$(prefix)/share/man}
1026
1027 # The directory to which read-only (configuration) files should be installed
1028 sysconfdir = ${SYSCONFDIR:=\$(prefix)/etc}
1029
1030 # The directory to which emacs lisp files should be installed
1031 emacslispdir=${EMACSLISPDIR}
1032
1033 # The directory to which emacs miscellaneous (machine-independent) files should
1034 # be installed
1035 emacsetcdir=${EMACSETCDIR}
1036
1037 # Whether there's an emacs binary available for byte-compiling
1038 HAVE_EMACS = ${have_emacs}
1039
1040 # Whether there's a sphinx-build binary available for building documentation
1041 HAVE_SPHINX=${have_sphinx}
1042
1043 # Whether there's a doxygen binary available for building api documentation
1044 HAVE_DOXYGEN=${have_doxygen}
1045
1046 # The directory to which desktop files should be installed
1047 desktop_dir = \$(prefix)/share/applications
1048
1049 # The directory to which bash completions files should be installed
1050 bash_completion_dir = ${BASHCOMPLETIONDIR:=\$(sysconfdir)/bash_completion.d}
1051
1052 # The directory to which zsh completions files should be installed
1053 zsh_completion_dir = ${ZSHCOMLETIONDIR:=\$(prefix)/share/zsh/functions/Completion/Unix}
1054
1055 # Whether the canonicalize_file_name function is available (if not, then notmuch will
1056 # build its own version)
1057 HAVE_CANONICALIZE_FILE_NAME = ${have_canonicalize_file_name}
1058
1059 # Whether the getline function is available (if not, then notmuch will
1060 # build its own version)
1061 HAVE_GETLINE = ${have_getline}
1062
1063 # Are the ruby development files (and ruby) available? If not skip
1064 # building/testing ruby bindings.
1065 HAVE_RUBY_DEV = ${have_ruby_dev}
1066
1067 # Whether the strcasestr function is available (if not, then notmuch will
1068 # build its own version)
1069 HAVE_STRCASESTR = ${have_strcasestr}
1070
1071 # Whether the strsep function is available (if not, then notmuch will
1072 # build its own version)
1073 HAVE_STRSEP = ${have_strsep}
1074
1075 # Whether the timegm function is available (if not, then notmuch will
1076 # build its own version)
1077 HAVE_TIMEGM = ${have_timegm}
1078
1079 # Whether struct dirent has d_type (if not, then notmuch will use stat)
1080 HAVE_D_TYPE = ${have_d_type}
1081
1082 # Whether the Xapian version in use supports compaction
1083 HAVE_XAPIAN_COMPACT = ${have_xapian_compact}
1084
1085 # Whether the Xapian version in use supports field processors
1086 HAVE_XAPIAN_FIELD_PROCESSOR = ${have_xapian_field_processor}
1087
1088 # Whether the Xapian version in use supports DB_RETRY_LOCK
1089 HAVE_XAPIAN_DB_RETRY_LOCK = ${have_xapian_db_retry_lock}
1090
1091 # Whether the getpwuid_r function is standards-compliant
1092 # (if not, then notmuch will #define _POSIX_PTHREAD_SEMANTICS
1093 # to enable the standards-compliant version -- needed for Solaris)
1094 STD_GETPWUID = ${std_getpwuid}
1095
1096 # Whether the asctime_r function is standards-compliant
1097 # (if not, then notmuch will #define _POSIX_PTHREAD_SEMANTICS
1098 # to enable the standards-compliant version -- needed for Solaris)
1099 STD_ASCTIME = ${std_asctime}
1100
1101 # Supported platforms (so far) are: LINUX, MACOSX, SOLARIS, FREEBSD, OPENBSD
1102 PLATFORM = ${platform}
1103
1104 # Whether the linker will automatically resolve the dependency of one
1105 # library on another (if not, then linking a binary requires linking
1106 # directly against both)
1107 LINKER_RESOLVES_LIBRARY_DEPENDENCIES = ${linker_resolves_library_dependencies}
1108
1109 # Flags needed to compile and link against Xapian
1110 XAPIAN_CXXFLAGS = ${xapian_cxxflags}
1111 XAPIAN_LDFLAGS = ${xapian_ldflags}
1112
1113 # Which backend will Xapian use by default?
1114 DEFAULT_XAPIAN_BACKEND = ${default_xapian_backend}
1115
1116 # Flags needed to compile and link against GMime
1117 GMIME_CFLAGS = ${gmime_cflags}
1118 GMIME_LDFLAGS = ${gmime_ldflags}
1119
1120 # Flags needed to compile and link against zlib
1121 ZLIB_CFLAGS = ${zlib_cflags}
1122 ZLIB_LDFLAGS = ${zlib_ldflags}
1123
1124 # Flags needed to compile and link against talloc
1125 TALLOC_CFLAGS = ${talloc_cflags}
1126 TALLOC_LDFLAGS = ${talloc_ldflags}
1127
1128 # Flags needed to have linker set rpath attribute
1129 RPATH_LDFLAGS = ${rpath_ldflags}
1130
1131 # Flags needed to have linker link only to necessary libraries
1132 AS_NEEDED_LDFLAGS = ${as_needed_ldflags}
1133
1134 # Flags to have the linker flag undefined symbols in object files
1135 NO_UNDEFINED_LDFLAGS = ${no_undefined_ldflags}
1136
1137 # Whether valgrind header files are available
1138 HAVE_VALGRIND = ${have_valgrind}
1139
1140 # And if so, flags needed at compile time for valgrind macros
1141 VALGRIND_CFLAGS = ${valgrind_cflags}
1142
1143 # Support for emacs
1144 WITH_EMACS = ${WITH_EMACS}
1145
1146 # Support for desktop file
1147 WITH_DESKTOP = ${WITH_DESKTOP}
1148
1149 # Support for bash completion
1150 WITH_BASH = ${WITH_BASH}
1151
1152 # Support for zsh completion
1153 WITH_ZSH = ${WITH_ZSH}
1154
1155 # Combined flags for compiling and linking against all of the above
1156 COMMON_CONFIGURE_CFLAGS = \\
1157         \$(GMIME_CFLAGS) \$(TALLOC_CFLAGS) \$(ZLIB_CFLAGS)      \\
1158         -DHAVE_VALGRIND=\$(HAVE_VALGRIND) \$(VALGRIND_CFLAGS)   \\
1159         -DHAVE_GETLINE=\$(HAVE_GETLINE)                         \\
1160         -DHAVE_CANONICALIZE_FILE_NAME=\$(HAVE_CANONICALIZE_FILE_NAME) \\
1161         -DHAVE_STRCASESTR=\$(HAVE_STRCASESTR)                   \\
1162         -DHAVE_STRSEP=\$(HAVE_STRSEP)                           \\
1163         -DHAVE_TIMEGM=\$(HAVE_TIMEGM)                           \\
1164         -DHAVE_D_TYPE=\$(HAVE_D_TYPE)                           \\
1165         -DSTD_GETPWUID=\$(STD_GETPWUID)                         \\
1166         -DSTD_ASCTIME=\$(STD_ASCTIME)                           \\
1167         -DHAVE_XAPIAN_COMPACT=\$(HAVE_XAPIAN_COMPACT)           \\
1168         -DSILENCE_XAPIAN_DEPRECATION_WARNINGS                   \\
1169         -DHAVE_XAPIAN_FIELD_PROCESSOR=\$(HAVE_XAPIAN_FIELD_PROCESSOR) \\
1170         -DHAVE_XAPIAN_DB_RETRY_LOCK=\$(HAVE_XAPIAN_DB_RETRY_LOCK) \\
1171         -DUTIL_BYTE_ORDER=\$(UTIL_BYTE_ORDER)
1172
1173 CONFIGURE_CFLAGS = \$(COMMON_CONFIGURE_CFLAGS)
1174
1175 CONFIGURE_CXXFLAGS = \$(COMMON_CONFIGURE_CFLAGS) \$(XAPIAN_CXXFLAGS)
1176
1177 CONFIGURE_LDFLAGS =  \$(GMIME_LDFLAGS) \$(TALLOC_LDFLAGS) \$(ZLIB_LDFLAGS) \$(XAPIAN_LDFLAGS)
1178 EOF
1179
1180 # construct the sh.config
1181 cat > sh.config <<EOF
1182 # This sh.config was automatically generated by the ./configure
1183 # script of notmuch.
1184
1185 # Whether the Xapian version in use supports compaction
1186 NOTMUCH_HAVE_XAPIAN_COMPACT=${have_xapian_compact}
1187
1188 # Whether the Xapian version in use supports field processors
1189 NOTMUCH_HAVE_XAPIAN_FIELD_PROCESSOR=${have_xapian_field_processor}
1190
1191 # Whether the Xapian version in use supports lock retry
1192 NOTMUCH_HAVE_XAPIAN_DB_RETRY_LOCK=${have_xapian_db_retry_lock}
1193
1194 # Which backend will Xapian use by default?
1195 NOTMUCH_DEFAULT_XAPIAN_BACKEND=${default_xapian_backend}
1196
1197 # do we have man pages?
1198 NOTMUCH_HAVE_MAN=$((have_sphinx))
1199
1200 # Name of python interpreter
1201 NOTMUCH_PYTHON=${python}
1202
1203 # Are the ruby development files (and ruby) available? If not skip
1204 # building/testing ruby bindings.
1205 NOTMUCH_HAVE_RUBY_DEV=${have_ruby_dev}
1206 EOF
1207
1208 # Finally, after everything configured, inform the user how to continue.
1209 cat <<EOF
1210
1211 All required packages were found. You may now run the following
1212 commands to compile and install notmuch:
1213
1214         make
1215         sudo make install
1216
1217 EOF