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 in LIBDIR [PREFIX/lib]
72 Additional options are accepted for compatibility with other
73 configure-script calling conventions, but don't do anything yet:
75 --build=<cpu>-<vendor>-<os> Currently ignored
80 # Parse command-line options
82 if [ "${option}" = '--help' ] ; then
85 elif [ "${option%%=*}" = '--prefix' ] ; then
87 elif [ "${option%%=*}" = '--libdir' ] ; then
89 elif [ "${option%%=*}" = '--build' ] ; then
90 build_option="${option#*=}"
91 case ${build_option} in
94 echo "Unrecognized value for --build option: ${build_option}"
95 echo "Should be: <cpu>-<vendor>-<os>"
101 build_cpu=${build_option%%-*}
102 build_option=${build_option#*-}
103 build_vendor=${build_option%%-*}
104 build_os=${build_option#*-}
106 echo "Unrecognized option: ${option}."
115 Welcome to Notmuch, a system for indexing, searching and tagging your email.
117 We hope that the process of building and installing notmuch is quick
118 and smooth so that you can soon be reading and processing your email
119 more efficiently than ever.
121 If anything goes wrong in the configure process, you can override any
122 decisions it makes by manually editing the Makefile.config file that
123 it creates. Also please do as much as you can to figure out what could
124 be different on your machine compared to those of the notmuch
125 developers. Then, please email those details to the Notmuch list
126 (notmuch@notmuchmail.org) so that we can hopefully make future
127 versions of notmuch easier for you to use.
129 We'll now investigate your system to verify that all required
130 dependencies are available:
136 if pkg-config --version > /dev/null 2>&1; then
142 printf "Checking for Xapian development files... "
144 for xapian_config in ${XAPIAN_CONFIG}; do
145 if ${xapian_config} --version > /dev/null 2>&1; then
148 xapian_cxxflags=$(${xapian_config} --cxxflags)
149 xapian_ldflags=$(${xapian_config} --libs)
153 if [ ${have_xapian} = "0" ]; then
155 errors=$((errors + 1))
158 printf "Checking for GMime 2.4 development files... "
159 if pkg-config --modversion gmime-2.4 > /dev/null 2>&1; then
162 gmime_cflags=$(pkg-config --cflags gmime-2.4)
163 gmime_ldflags=$(pkg-config --libs gmime-2.4)
167 errors=$((errors + 1))
170 printf "Checking for talloc development files... "
171 if pkg-config --modversion talloc > /dev/null 2>&1; then
174 talloc_cflags=$(pkg-config --cflags talloc)
175 talloc_ldflags=$(pkg-config --libs talloc)
180 errors=$((errors + 1))
183 printf "Checking for valgrind development files... "
184 if pkg-config --modversion valgrind > /dev/null 2>&1; then
187 valgrind_cflags=$(pkg-config --cflags valgrind)
189 printf "No (but that's fine).\n"
193 if pkg-config --modversion emacs > /dev/null 2>&1; then
194 emacs_lispdir=$(pkg-config emacs --variable sitepkglispdir)
196 emacs_lispdir='$(prefix)/share/emacs/site-lisp'
199 printf "Checking if emacs is available... "
200 if emacs --quick --batch > /dev/null 2>&1; then
204 printf "No (so will not byte-compile emacs code)\n"
208 if [ $errors -gt 0 ]; then
211 *** Error: The dependencies of notmuch could not be satisfied. You will
212 need to install the following packages before being able to compile
216 if [ $have_xapian -eq 0 ]; then
217 echo " Xapian library (including development files such as headers)"
218 echo " http://xapian.org/"
220 if [ $have_gmime -eq 0 ]; then
221 echo " GMime 2.4 library (including development files such as headers)"
222 echo " http://spruce.sourceforge.net/gmime/"
224 if [ $have_talloc -eq 0 ]; then
225 echo " The talloc library (including development files such as headers)"
226 echo " http://talloc.samba.org/"
230 With any luck, you're using a modern, package-based operating system
231 that has all of these packages available in the distribution. In that
232 case a simple command will install everything you need. For example:
234 On Debian and similar systems:
236 sudo apt-get install libxapian-dev libgmime-2.4-dev libtalloc-dev
238 Or on Fedora and similar systems:
240 sudo yum install xapian-core-devel gmime-devel libtalloc-devel
242 On other systems, similar commands can be used, but the details of the
243 package names may be different.
246 if [ $have_pkg_config -eq 0 ]; then
248 Note: the pkg-config program is not available. This configure script
249 uses pkg-config to find the compilation flags required to link against
250 the various libraries needed by notmuch. It's possible you simply need
251 to install pkg-config with a command such as:
253 sudo apt-get install pkg-config
255 sudo yum install pkgconfig
257 But if pkg-config is not available for your system, then you will need
258 to modify the configure script to manually set the cflags and ldflags
259 variables to the correct values to link against each library in each
260 case that pkg-config could not be used to determine those values.
265 When you have installed the necessary dependencies, you can run
266 configure again to ensure the packages can be found, or simply run
267 "make" to compile notmuch.
273 printf "Checking for getline... "
274 if ${CC} -o compat/have_getline compat/have_getline.c > /dev/null 2>&1
279 printf "No (will use our own instead).\n"
282 rm -f compat/have_getline
286 All required packages were found. You may now run the following
287 commands to compile and install notmuch:
294 # construct the Makefile.config
295 cat > Makefile.config <<EOF
296 # This Makefile.config was automatically generated by the ./configure
297 # script of notmuch. If the configure script identified anything
298 # incorrectly, then you can edit this file to try to correct things,
299 # but be warned that if configure is run again it will destroy your
300 # changes, (and this could happen by simply calling "make" if the
301 # configure script is updated).
303 # The C compiler to use
306 # The C++ compiler to use
309 # Command to execute emacs from Makefiles
310 EMACS = emacs --quick
312 # Default FLAGS for C compiler (can be overridden by user such as "make CFLAGS=-g")
315 # Default FLAGS for C++ compiler (can be overridden by user such as "make CXXFLAGS=-g")
316 CXXFLAGS = ${CXXFLAGS}
318 # Flags to enable warnings when using the C++ compiler
319 WARN_CXXFLAGS=-Wall -Wextra -Wwrite-strings -Wswitch-enum
321 # Flags to enable warnings when using the C compiler
322 WARN_CFLAGS=\$(WARN_CXXFLAGS) -Wmissing-declarations
324 # The prefix to which notmuch should be installed
327 # The directory to which notmuch libraries should be installed
328 libdir = ${LIBDIR:=\$(prefix)/lib}
330 # The directory to which emacs lisp files should be installed
331 emacs_lispdir=${emacs_lispdir}
333 # Whether there's an emacs binary available for byte-compiling
334 HAVE_EMACS = ${have_emacs}
336 # The directory to which desktop files should be installed
337 desktop_dir = \$(prefix)/share/applications
339 # The directory to which bash completions files should be installed
340 bash_completion_dir = /etc/bash_completion.d
342 # The directory to which zsh completions files should be installed
343 zsh_completion_dir = \$(prefix)/share/zsh/functions/Completion/Unix
345 # Whether the getline function is available (if not, then notmuch will
346 # build its own version)
347 HAVE_GETLINE = ${have_getline}
349 # Flags needed to compile and link against Xapian
350 XAPIAN_CXXFLAGS = ${xapian_cxxflags}
351 XAPIAN_LDFLAGS = ${xapian_ldflags}
353 # Flags needed to compile and link against GMime-2.4
354 GMIME_CFLAGS = ${gmime_cflags}
355 GMIME_LDFLAGS = ${gmime_ldflags}
357 # Flags needed to compile and link against talloc
358 TALLOC_CFLAGS = ${talloc_cflags}
359 TALLOC_LDFLAGS = ${talloc_ldflags}
361 # Whether valgrind header files are available
362 HAVE_VALGRIND = ${have_valgrind}
364 # And if so, flags needed at compile time for valgrind macros
365 VALGRIND_CFLAGS = ${valgrind_cflags}
367 # Combined flags for compiling and linking against all of the above
368 CONFIGURE_CFLAGS = -DHAVE_GETLINE=\$(HAVE_GETLINE) \$(GMIME_CFLAGS) \\
369 \$(TALLOC_CFLAGS) -DHAVE_VALGRIND=\$(HAVE_VALGRIND) \\
371 CONFIGURE_CXXFLAGS = -DHAVE_GETLINE=\$(HAVE_GETLINE) \$(GMIME_CFLAGS) \\
372 \$(TALLOC_CFLAGS) -DHAVE_VALGRIND=\$(HAVE_VALGRIND) \\
373 \$(VALGRIND_CFLAGS) \$(XAPIAN_CXXFLAGS)
374 CONFIGURE_LDFLAGS = \$(GMIME_LDFLAGS) \$(TALLOC_LDFLAGS) \$(XAPIAN_LDFLAGS)