3 # Set several defaults (optionally specified by the user in
4 # environemnt variables)
8 CXXFLAGS=${CXXFLAGS:-\$(CFLAGS)}
9 XAPIAN_CONFIG=${XAPIAN_CONFIG:-xapian-config-1.1 xapian-config}
11 # We don't allow the EMACS or GZIP Makefile variables inherit values
12 # from the environment as we do with CC and CXX above. The reason is
13 # that these names as environment variables have existing uses other
14 # than the program name that we want. (EMACS is set to 't' when a
15 # shell is running within emacs and GZIP specifies arguments to pass
16 # on the gzip command line).
18 # Set the defaults for values the user can specify with command-line
26 Usage: ./configure [options]...
28 This script configures notmuch to build on your system.
30 It verifies that dependencies are available, determines flags needed
31 to compile and link against various required libraries, and identifies
32 whether various system functions can be used or if locally-provided
33 replacements will be built instead.
35 Finally, it allows you to control various aspects of the build and
38 First, some common variables can specified via environment variables:
40 CC The C compiler to use
41 CFLAGS Flags to pass to the C compiler
42 CXX The C++ compiler to use
43 CXXFLAGS Flags to pass to the C compiler
44 LDFLAGS Flags to pass when linking
46 Each of these values can further be controlled by specifying them
47 later on the "make" command line.
49 Other environment variables can be used to control configure itself,
50 (and for which there is no equivalent build-time control):
52 XAPIAN_CONFIG The program to use to determine flags for
53 compiling and linking against the Xapian
54 library. [$XAPIAN_CONFIG]
56 Additionally, various options can be specified on the configure
59 --prefix=PREFIX Install files in PREFIX [$PREFIX]
61 By default, "make install" will install the resulting program to
62 $PREFIX/bin, documentation to $PREFIX/man, etc. You can
63 specify an installation prefix other than $PREFIX using
64 --prefix, for instance:
66 ./configure --prefix=\$HOME
68 Fine tuning of some installation directories is available:
70 --libdir=DIR Install libraries to DIR [PREFIX/lib]
71 --includedir=DIR Install header files to DIR [PREFIX/include]
72 --mandir=DIR Install man pages to DIR [PREFIX/share/man]
74 Additional options are accepted for compatibility with other
75 configure-script calling conventions, but don't do anything yet:
77 --build=<cpu>-<vendor>-<os> Currently ignored
82 # Parse command-line options
84 if [ "${option}" = '--help' ] ; then
87 elif [ "${option%%=*}" = '--prefix' ] ; then
89 elif [ "${option%%=*}" = '--libdir' ] ; then
91 elif [ "${option%%=*}" = '--includedir' ] ; then
92 INCLUDEDIR="${option#*=}"
93 elif [ "${option%%=*}" = '--mandir' ] ; then
95 elif [ "${option%%=*}" = '--build' ] ; then
96 build_option="${option#*=}"
97 case ${build_option} in
100 echo "Unrecognized value for --build option: ${build_option}"
101 echo "Should be: <cpu>-<vendor>-<os>"
107 build_cpu=${build_option%%-*}
108 build_option=${build_option#*-}
109 build_vendor=${build_option%%-*}
110 build_os=${build_option#*-}
112 echo "Unrecognized option: ${option}"
121 Welcome to Notmuch, a system for indexing, searching and tagging your email.
123 We hope that the process of building and installing notmuch is quick
124 and smooth so that you can soon be reading and processing your email
125 more efficiently than ever.
127 If anything goes wrong in the configure process, you can override any
128 decisions it makes by manually editing the Makefile.config file that
129 it creates. Also please do as much as you can to figure out what could
130 be different on your machine compared to those of the notmuch
131 developers. Then, please email those details to the Notmuch list
132 (notmuch@notmuchmail.org) so that we can hopefully make future
133 versions of notmuch easier for you to use.
135 We'll now investigate your system to verify that all required
136 dependencies are available:
142 if pkg-config --version > /dev/null 2>&1; then
148 printf "Checking for Xapian development files... "
150 for xapian_config in ${XAPIAN_CONFIG}; do
151 if ${xapian_config} --version > /dev/null 2>&1; then
154 xapian_cxxflags=$(${xapian_config} --cxxflags)
155 xapian_ldflags=$(${xapian_config} --libs)
159 if [ ${have_xapian} = "0" ]; then
161 errors=$((errors + 1))
164 printf "Checking for GMime 2.4 development files... "
165 if pkg-config --modversion gmime-2.4 > /dev/null 2>&1; then
168 gmime_cflags=$(pkg-config --cflags gmime-2.4)
169 gmime_ldflags=$(pkg-config --libs gmime-2.4)
173 errors=$((errors + 1))
176 printf "Checking for talloc development files... "
177 if pkg-config --modversion talloc > /dev/null 2>&1; then
180 talloc_cflags=$(pkg-config --cflags talloc)
181 talloc_ldflags=$(pkg-config --libs talloc)
186 errors=$((errors + 1))
189 printf "Checking for valgrind development files... "
190 if pkg-config --modversion valgrind > /dev/null 2>&1; then
193 valgrind_cflags=$(pkg-config --cflags valgrind)
195 printf "No (but that's fine).\n"
199 if pkg-config --modversion emacs > /dev/null 2>&1; then
200 emacs_lispdir=$(pkg-config emacs --variable sitepkglispdir)
202 emacs_lispdir='$(prefix)/share/emacs/site-lisp'
205 printf "Checking if emacs is available... "
206 if emacs --quick --batch > /dev/null 2>&1; then
210 printf "No (so will not byte-compile emacs code)\n"
214 if [ $errors -gt 0 ]; then
217 *** Error: The dependencies of notmuch could not be satisfied. You will
218 need to install the following packages before being able to compile
222 if [ $have_xapian -eq 0 ]; then
223 echo " Xapian library (including development files such as headers)"
224 echo " http://xapian.org/"
226 if [ $have_gmime -eq 0 ]; then
227 echo " GMime 2.4 library (including development files such as headers)"
228 echo " http://spruce.sourceforge.net/gmime/"
230 if [ $have_talloc -eq 0 ]; then
231 echo " The talloc library (including development files such as headers)"
232 echo " http://talloc.samba.org/"
236 With any luck, you're using a modern, package-based operating system
237 that has all of these packages available in the distribution. In that
238 case a simple command will install everything you need. For example:
240 On Debian and similar systems:
242 sudo apt-get install libxapian-dev libgmime-2.4-dev libtalloc-dev
244 Or on Fedora and similar systems:
246 sudo yum install xapian-core-devel gmime-devel libtalloc-devel
248 On other systems, similar commands can be used, but the details of the
249 package names may be different.
252 if [ $have_pkg_config -eq 0 ]; then
254 Note: the pkg-config program is not available. This configure script
255 uses pkg-config to find the compilation flags required to link against
256 the various libraries needed by notmuch. It's possible you simply need
257 to install pkg-config with a command such as:
259 sudo apt-get install pkg-config
261 sudo yum install pkgconfig
263 But if pkg-config is not available for your system, then you will need
264 to modify the configure script to manually set the cflags and ldflags
265 variables to the correct values to link against each library in each
266 case that pkg-config could not be used to determine those values.
271 When you have installed the necessary dependencies, you can run
272 configure again to ensure the packages can be found, or simply run
273 "make" to compile notmuch.
279 printf "Checking for getline... "
280 if ${CC} -o compat/have_getline compat/have_getline.c > /dev/null 2>&1
285 printf "No (will use our own instead).\n"
288 rm -f compat/have_getline
292 All required packages were found. You may now run the following
293 commands to compile and install notmuch:
300 # construct the Makefile.config
301 cat > Makefile.config <<EOF
302 # This Makefile.config was automatically generated by the ./configure
303 # script of notmuch. If the configure script identified anything
304 # incorrectly, then you can edit this file to try to correct things,
305 # but be warned that if configure is run again it will destroy your
306 # changes, (and this could happen by simply calling "make" if the
307 # configure script is updated).
309 # The C compiler to use
312 # The C++ compiler to use
315 # Command to execute emacs from Makefiles
316 EMACS = emacs --quick
318 # Default FLAGS for C compiler (can be overridden by user such as "make CFLAGS=-g")
321 # Default FLAGS for C++ compiler (can be overridden by user such as "make CXXFLAGS=-g")
322 CXXFLAGS = ${CXXFLAGS}
324 # Flags to enable warnings when using the C++ compiler
325 WARN_CXXFLAGS=-Wall -Wextra -Wwrite-strings -Wswitch-enum
327 # Flags to enable warnings when using the C compiler
328 WARN_CFLAGS=\$(WARN_CXXFLAGS) -Wmissing-declarations
330 # The prefix to which notmuch should be installed
333 # The directory to which libraries should be installed
334 libdir = ${LIBDIR:=\$(prefix)/lib}
336 # The directory to which header files should be installed
337 includedir = ${INCLUDEDIR:=\$(prefix)/lib}
339 # The directory to which man pages should be installed
340 mandir = ${MANDIR:=\$(prefix)/share/man}
342 # The directory to which emacs lisp files should be installed
343 emacs_lispdir=${emacs_lispdir}
345 # Whether there's an emacs binary available for byte-compiling
346 HAVE_EMACS = ${have_emacs}
348 # The directory to which desktop files should be installed
349 desktop_dir = \$(prefix)/share/applications
351 # The directory to which bash completions files should be installed
352 bash_completion_dir = /etc/bash_completion.d
354 # The directory to which zsh completions files should be installed
355 zsh_completion_dir = \$(prefix)/share/zsh/functions/Completion/Unix
357 # Whether the getline function is available (if not, then notmuch will
358 # build its own version)
359 HAVE_GETLINE = ${have_getline}
361 # Flags needed to compile and link against Xapian
362 XAPIAN_CXXFLAGS = ${xapian_cxxflags}
363 XAPIAN_LDFLAGS = ${xapian_ldflags}
365 # Flags needed to compile and link against GMime-2.4
366 GMIME_CFLAGS = ${gmime_cflags}
367 GMIME_LDFLAGS = ${gmime_ldflags}
369 # Flags needed to compile and link against talloc
370 TALLOC_CFLAGS = ${talloc_cflags}
371 TALLOC_LDFLAGS = ${talloc_ldflags}
373 # Whether valgrind header files are available
374 HAVE_VALGRIND = ${have_valgrind}
376 # And if so, flags needed at compile time for valgrind macros
377 VALGRIND_CFLAGS = ${valgrind_cflags}
379 # Combined flags for compiling and linking against all of the above
380 CONFIGURE_CFLAGS = -DHAVE_GETLINE=\$(HAVE_GETLINE) \$(GMIME_CFLAGS) \\
381 \$(TALLOC_CFLAGS) -DHAVE_VALGRIND=\$(HAVE_VALGRIND) \\
383 CONFIGURE_CXXFLAGS = -DHAVE_GETLINE=\$(HAVE_GETLINE) \$(GMIME_CFLAGS) \\
384 \$(TALLOC_CFLAGS) -DHAVE_VALGRIND=\$(HAVE_VALGRIND) \\
385 \$(VALGRIND_CFLAGS) \$(XAPIAN_CXXFLAGS)
386 CONFIGURE_LDFLAGS = \$(GMIME_LDFLAGS) \$(TALLOC_LDFLAGS) \$(XAPIAN_LDFLAGS)