]> diplodocus.org Git - nmh/blob - docs/contrib/build_nmh
Moved nmh and mh-chart man pages from section 1 to section 7.
[nmh] / docs / contrib / build_nmh
1 #! /bin/sh
2 #
3 # Configures and builds nmh.
4 # * This script must be invoked from an nmh source directory.
5 # * This script retrieves configuration from the first existing nmh
6 # installation on your $PATH, if any, as well as any $EDITOR/$VISUAL
7 # and $PAGER environment variable settings.
8 # * Unless the -y option is provided, this script then interactively
9 # walks you through confirmation of common configuration settings.
10 #
11 # Typical usage:
12 # The first time you invoke this script, use the -i option to install
13 # nmh in the specified location. The script will walk you through the
14 # common nmh configuration settings. The -v option will cause display
15 # of brief progress indicators. Be sure to add the bin directory of
16 # the install location to your $PATH, if not already there.
17 # Subsequently, invoke this script with the -y option, to use the
18 # relevant configuration settings from the installed nmh without
19 # confirmation.
20 #
21 # Option summary:
22 # First time use:
23 # -i to install nmh
24 # -v to display progress
25 # Subsequent uses, assuming installed nmh bin directory is on $PATH:
26 # -y to accept all configuration options without confirmation
27 # Output control:
28 # -l <logfile name>, default 'build_nmh.log'
29 # Advanced/developer use:
30 # -c to run 'make distcheck' instead of 'make check'
31 # -d to build nmh with debug enabled
32 # -s to use 'make superclean': requires recent autoconf and automake,
33 # see docs/README.developers
34 # -r to build rpm
35 #
36 # On Fedora, at least these rpms must be installed:
37 # gdbm-devel
38 # ncurses-devel
39 # cyrus-sasl-devel, if using sasl
40 # openssl-devel, if using TLS
41 # autoconf and automake, with -s (see docs/README.developers for versions)
42 # rpm-build, with -r
43
44
45 ####
46 #### OS-specific setup.
47 ####
48 which=which
49 ldd=ldd
50
51 ####
52 #### Interpret command arguments.
53 ####
54 check=check
55 debug=0
56 install=0
57 logfile=build_nmh.log
58 build_rpm=0
59 superclean=0
60 verbose=0
61 yes=0
62 usage="usage: $0
63 [-c to run 'make distcheck' instead of 'make check']
64 [-d to build nmh with debug enabled]
65 [-i to install nmh]
66 [-l <logfile name>, default '$logfile']
67 [-r to build rpm]
68 [-s to use 'make superclean': requires recent autoconf and automake]
69 [-v to display progress]
70 [-y to accept all configuration options without confirmation]"
71
72 while getopts 'cdil:rsvy?' arg; do
73 case $arg in
74 c ) check=distcheck ;;
75 d ) debug=1 ;;
76 i ) install=1 ;;
77 l ) logfile=$OPTARG ;;
78 r ) build_rpm=1 ;;
79 s ) superclean=1 ;;
80 v ) verbose=1 ;;
81 y ) yes=1 ;;
82 '?') echo "$usage"; exit 0 ;;
83 esac
84 done
85 shift `expr $OPTIND - 1`
86
87 #### No command line arguments are supported.
88 if [ $# -gt 0 ]; then
89 echo "usage: $0"
90 exit 1
91 fi
92
93 #### Check to see that we're in a nmh source directory.
94 if grep 'the authors of nmh' COPYRIGHT >/dev/null; then
95 :
96 else
97 echo "$0: not in nmh source directory"
98 exit 1
99 fi
100
101 ####
102 #### Set up configure options. Handle options that can have embedded
103 #### spaces (currently just smtpservers) specially.
104 ####
105
106 #### Here are the config options that we will try to detect, then
107 #### confirm, and finally set.
108 config_prefix=/usr/local/nmh
109 config_locking=
110 config_mts=smtp
111 config_smtpservers=localhost
112 config_sasl=n
113 config_tls=n
114 config_editor=vi
115 for i in more less most cat; do
116 if which $i >/dev/null 2>&1; then
117 config_pager=$i
118 break
119 fi
120 done
121 config_debug=n
122
123 if install-mh -check >/dev/null 2>&1; then
124 # Determine config options from installed nmh.
125 mhparam=`which mhparam`
126 mhbin=`dirname "$mhparam"`
127
128 config_prefix=`cd $mhbin/.. && pwd`
129
130 mtsconf=`dirname "$mhbin"`/etc/mts.conf
131 if [ -f "$mtsconf" ]; then
132 mts_entry=`grep '^mts:' $mtsconf`
133 if [ "$mts_entry" ]; then
134 mts=`echo $mts_entry | sed -e 's/^mts: *//'`
135 if [ "$mts" -a "$mts" != smtp ]; then
136 config_mts="$mts"
137 fi
138 fi
139
140 mtsconfservers=`grep '^servers:' $mtsconf`
141 if [ "$mtsconfservers" ]; then
142 servers=`echo $mtsconfservers | sed -e 's/^servers: *//' -e 's/ /\\\ /g'`
143 [ "$servers" ] && config_smtpservers="$servers"
144 fi
145 fi
146
147 if $ldd $mhbin/inc | grep sasl >/dev/null; then
148 config_sasl=y
149 fi
150
151 if $ldd $mhbin/inc | grep ssl >/dev/null; then
152 config_tls=y
153 fi
154 fi
155
156 if [ "$EDITOR" ]; then
157 config_editor="$EDITOR"
158 elif [ "$VISUAL" ]; then
159 config_editor="$VISUAL"
160 fi
161
162 [ "$PAGER" ] && config_pager="$PAGER"
163
164 [ $debug -ge 1 ] && config_debug=y
165
166 if [ $yes -eq 0 ]; then
167 #### Confirm each config setting with user.
168 printf 'Install prefix [%s]: ' $config_prefix
169 read prefix
170 [ "$prefix" ] && config_prefix="$prefix"
171
172 printf 'Locking type (dot|fcntl|flock|lockf) [determined by configure]: '
173 read locking
174 [ "$locking" ] && config_locking="$locking"
175
176 printf 'MTS (smtp|sendmail) [%s]: ' $config_mts
177 read mts
178 [ "$mts" ] && config_mts="$mts"
179
180 if [ "$config_mts" = smtp ]; then
181 printf 'SMTP server(s), space separated [%s]: ' $config_smtpservers
182 read response
183 servers=`echo $response | sed -e 's/ /\\\ /g'`
184 [ "$servers" ] && config_smtpservers="$servers"
185 fi
186
187 printf 'Cyrus SASL support [%s]: ' $config_sasl
188 read response
189 if [ "$response" = y -o "$response" = Y ]; then
190 config_sasl=y
191 elif [ "$response" = n -o "$response" = N ]; then
192 config_sasl=n
193 fi
194
195 printf 'TLS support [%s]: ' $config_tls
196 read response
197 if [ "$response" = y -o "$response" = Y ]; then
198 config_tls=y
199 elif [ "$response" = n -o "$response" = N ]; then
200 config_tls=n
201 fi
202
203 printf 'Default editor [%s]: ' $config_editor
204 read editor
205 [ "$editor" ] && config_editor=$editor
206
207 printf 'Pager [%s]: ' $config_pager
208 read pager
209 [ "$pager" ] && config_pager=$pager
210
211 #### Don't confirm debug here: obey the -d option to this script.
212 fi
213
214 smtpservers=
215 config_opts="--prefix=$config_prefix"
216
217 [ "$config_locking" ] && \
218 config_opts="$config_opts --with-locking=$config_locking"
219 [ "$config_mts" -a "$config_mts" != smtp ] && \
220 config_opts="$config_opts --with-mts=$config_mts"
221 [ "$config_smtpservers" -a "$config_smtpservers" != localhost ] && \
222 smtpservers="--with-smtpservers=$config_smtpservers"
223 [ "$config_sasl" = y ] && \
224 config_opts="$config_opts --with-cyrus-sasl"
225 [ "$config_tls" = y ] && \
226 config_opts="$config_opts --with-tls"
227 [ "$config_editor" ] && \
228 config_opts="$config_opts --with-editor=$config_editor"
229 [ "$config_pager" ] && \
230 config_opts="$config_opts --with-pager=$config_pager"
231 [ $config_debug = y ] && \
232 config_opts="$config_opts --enable-debug"
233
234
235 #### dotlocking, the usual default, requires chgrp and chmod of inc.
236 installpriv=
237 if [ $install -ge 1 -a `id -u` -ne 0 ]; then
238 if [ "$config_locking" = dot ]; then
239 echo "$0: "'install requires chgrp and chmod 2755'
240 echo 'so will sudo to install. Terminate with Ctrl-C if unacceptable.'
241 installpriv=sudo
242 fi
243 fi
244
245
246 ####
247 #### Clean up, and set up with autoconfig if necessary.
248 ####
249 if [ -f Makefile ]; then
250 [ $verbose -ge 1 ] && echo cleaning . . .
251 if [ $superclean -ge 1 ]; then
252 make superclean >/dev/null
253 else
254 make distclean >/dev/null
255 fi
256 fi
257
258 /bin/rm -f $logfile
259 if [ -f configure -a -f Makefile.in ]; then
260 :
261 else
262 [ $verbose -ge 1 ] && echo autoconfiguring . . .
263 ./autogen.sh >>$logfile 2>&1
264 fi
265
266
267 ####
268 #### Build.
269 ####
270 [ $verbose -ge 1 ] && echo configuring . . .
271 echo ./configure $config_opts ${smtpservers:+"$smtpservers"} >>$logfile 2>&1
272 ./configure $config_opts ${smtpservers:+"$smtpservers"} >>$logfile 2>&1
273 status=$?
274
275 if [ $status -eq 0 ]; then
276 [ $verbose -ge 1 ] && echo building . . .
277 make >>$logfile 2>&1
278 status=$?
279
280 if [ $status -eq 0 ]; then
281 [ $verbose -ge 1 ] && echo testing . . .
282 checkoutput=`make $check 2>>$logfile`
283 status=$?
284
285 tests_summary=`echo "$checkoutput" | grep tests`
286 if [ "$tests_summary" ]; then
287 echo '===================' >>$logfile
288 echo $tests_summary >>$logfile
289 echo '===================' >>$logfile
290 [ "$check" = distcheck ] && \
291 echo "$checkoutput" | tail -n 4 >>$logfile
292 fi
293
294 if [ $status -eq 0 ]; then
295 if [ $install -ge 1 ]; then
296 [ $verbose -ge 1 ] && echo installing . . .
297 ($installpriv make install) >/dev/null 2>>$logfile
298 status=$?
299 fi
300
301 if [ $status -eq 0 -a $build_rpm -ge 1 ]; then
302 [ $verbose -ge 1 ] && echo building rpm . . .
303 make rpm >/dev/null 2>>$logfile
304 status=$?
305 fi
306 fi
307 fi
308 fi
309
310 grep 'Error' $logfile
311 grep 'warn' $logfile
312 if [ $status -ne 0 ]; then
313 echo build failed!
314 echo build log is in $logfile
315 fi
316 [ $status -eq 0 -a $verbose -ge 1 ] && echo build completed successfully
317
318 exit $status