Even less shell globbing (Ivan Tham)
[s-mailx.git] / make.rc
blob28c6225577bbf8f1d11b9ba0c3e43cee568f552f
1 #@ make.rc describes the set of used features and (default) values used etc.
2 #@ You should have read INSTALL first.
3 #@ Notes:
4 #@ . Choosing a predefined CONFIG= disallows further option fine-tuning.
5 #@   (With some exceptions, e.g., OPT_DEBUG.)
6 #@ . Features / options have an OPT_ prefix and need to be assigned
7 #@   a boolean value, as in OPT_SSL=yes.  Booleans are 1/0, y/n,
8 #@   true/false, yes/no and on/off (case doesn't matter).
9 #@   The value "require" is also a true boolean, but will in addition
10 #@   cause configuration to fail if the requested condition cannot be
11 #@   satisfied.  This value is only available for a subset of options.
12 #@ . Values use VAL_ instead, and are assigned strings.
13 #@   E.g., VAL_PREFIX=/usr/local.
14 #@   Variables which are only used during configuration, building,
15 #@   and / or installation have no prefix, e.g., DESTDIR, VERBOSE, awk.
16 #@ . Specifying settings on the command line will take precedence over
17 #@   the variables in here (correctly triggering build updates as
18 #@   necessary, too).
19 #@ . This file is parsed by the shell: it is in sh(1), not in make(1)
20 #@   syntax.  Evaluation occurs *after* it has been read, so command
21 #@   line overwrites take effect.  To use multiline values, escape the
22 #@   newlines on all lines but the last with a reverse solidus (back-
23 #@   slash), as in "LINE \".
24 #@   To embed a shell variable unexpanded, use two: "XY=\\${HOME}".
25 #@   The parsing is sequential top-to-bottom (nonetheless), so that
26 #@   shell snippets in a value can refer only to stuff yet defined.
27 #@ . You may NOT comment out anything in here -- if you want to disable
28 #@   a feature, set it to a false boolean.
30 ## IDENTITIES, PATHS AND PROGRAMS ##
32 # Contact info (*contact-mail* and *contact-web*, respectively).
33 VAL_CONTACT_MAIL=s-mailx@lists.sdaoden.eu
34 VAL_CONTACT_WEB=https://www.sdaoden.eu/code.html
36 # The user ID our small privilege-separated helper program will be
37 # SETUID to, shall it be included ($OPT_DOTLOCK).
38 # Installation will then require the chown(1) program (as below) and
39 # sufficient privileges to perform a SETUID to this user ID.
40 VAL_PRIVSEP_USER=root
42 # General prefix where S-nail should be installed.
43 VAL_PREFIX=/usr/local
45 # Fine tune individual locations, normally under $VAL_PREFIX.
46 # . the place of the S-nail program.
47 VAL_BINDIR="${VAL_PREFIX}/bin"
48 # . the place of the privilege-separated helper program, the name
49 #   of which is [$VAL_SID$VAL_MAILX]-privsep (see below for $VAL_SID &
50 #   $VAL_MAILX).
51 #   (Only with $OPT_DOTLOCK.)
52 VAL_LIBEXECDIR="${VAL_PREFIX}/libexec"
53 # . of the manual.
54 VAL_MANDIR="${VAL_PREFIX}/share/man"
55 # . of the exemplary resource file.
56 VAL_SYSCONFDIR="${VAL_PREFIX}/etc"
58 # The variable $DESTDIR is prepended to all the paths from above at
59 # installation time; this feature can be used for, e.g., package
60 # building: if $VAL_PREFIX is "/usr/local", but $DESTDIR is set to "here",
61 # then S-nail will still think its $VAL_PREFIX is "/usr/local" whereis the
62 # build system will instead use "here/usr/local".
63 # NOTE: it cannot be set in here, but must be given on the command line
64 # when invoking the "install" make(1) (directly or indirectly).
65 # (That is, if you uncomment it, it'll be update-tracked...)
66 #DESTDIR=
68 # Where the local mail system stores user $MAIL files.
69 VAL_MAIL=`\
70    if [ -d /var/spool/mail ]; then \
71       echo /var/spool/mail;\
72    else \
73       echo /var/mail;\
74    fi`
76 # Path to the local MTA (Mail-Transfer-Agent).
77 VAL_MTA=`\
78    if [ -x /usr/bin/sendmail ]; then \
79       echo /usr/bin/sendmail;\
80    elif [ -x /usr/lib/sendmail ]; then \
81       echo /usr/lib/sendmail;\
82    else \
83       echo /usr/sbin/sendmail;\
84    fi`
86 # Today a lot of systems no longer use sendmail(1), but a different MTA.
87 # To ensure compatibility with sendmail(1), a system called
88 # mailwrapper(8) is often used, which selects the required service by
89 # looking at the name by which the program actually has been invoked.
90 # This variable can be used to adjust this name as necessary.
91 VAL_MTA_ARGV0=sendmail
93 # Default *SHELL* (sh(1) path).
94 # Sometimes we simply invoke a command directly via execlp(2) instead of
95 # indirectly through *SHELL* -- in these cases execlp(2) may fallback to
96 # it's own built-in sh(1) path
97 VAL_SHELL=/bin/sh
99 # Some more default fallback values, some of which are standardized
100 # and (thus)/or documented in the manual (changes not reflected there!).
101 # Note that default paths are often not (shell) quoted when displayed
102 VAL_DEAD_BASENAME=dead.letter
103 VAL_DEAD="~/${VAL_DEAD_BASENAME}"
104 VAL_EDITOR=ed
105 VAL_LISTER=ls
106 VAL_MAILRC=~/.mailrc
107 VAL_MBOX=~/mbox
108 VAL_NETRC=~/.netrc
109 VAL_PAGER=more
110 VAL_TMPDIR=/tmp
111 VAL_VISUAL=vi
113 # Default locations of mime.types(5)
114 VAL_MIME_TYPES_USR=~/.mime.types
115 VAL_MIME_TYPES_SYS=/etc/mime.types
117 # The following tools may be provided a.k.a. overwritten,
118 # `command -v NAME` is used to query the utility otherwise:
119 #  MAKE=, STRIP=, awk=, basename=, cat=, chmod=, cp=, cmp=, cksum=,
120 #     grep=, mkdir=, mv=, rm=, sed=, sort=, tee=, tr=
121 # Usually in administrator paths:
122 #  chown= [$OPT_DOTLOCK]
123 # Note that awk(1), rm(1) and tr(1) are needed before this file is read,
124 # all other utilities will be checked afterwards only.  For
125 # cross-compilation setting $MAKE and $STRIP may be necessary.  Due to
126 # the evaluation order of the build system all those programs are
127 # usually needed, but by setting any of the variables to true(1), as in
128 # chown=/usr/bin/true, availability of unneeded programs can be faked.
129 # We require uname(1) -s, command(1) -v, echo(1), etc.
130 # uname(1) can be circumvented by setting $OS (and $OSENV, $OSFULLSPEC).
131 # $OS must be all-lowercase.
133 ## FEATURE SET ##
135 # Some operating systems only support the C/POSIX (7-bit, but eight bit
136 # bytes are passed through unchanged) and UTF-8 based locales, e.g.,
137 # Plan9, Musl based Linux variants and newer OpenBSD.  For such
138 # environments we can avoid a lot of tests and may enable support for
139 # features which would otherwise not be available.
140 # Note that $OS is available as normalized all-lowercase upon evaluation
141 OPT_ALWAYS_UNICODE_LOCALE=`\
142    if [ "${OS}" = openbsd ]; then \
143       echo yes;\
144    else \
145       echo no;\
146    fi`
148 # For cross-compilation purposes it may be useful to not actually run
149 # systemcall etc. tests (link and run the executable) but only to
150 # perform the link tests necessary to detect host environment.
151 OPT_CROSS_BUILD=no
153 # Whether package system, for example pkgsrc(7) on NetBSD and more,
154 # OpenCSW on SunOS/Solaris, etc., specific paths shall be automatically
155 # included in $C_INCLUDE_PATH and $LD_LIBRARY_PATH when seen?
156 OPT_USE_PKGSYS=yes
158 # Shall S-nail try to automatically detect a compiler and detect and
159 # provide a set of known-good compiler flags?  It will use $CC if this
160 # variable is set, otherwise a compiler is actively searched for.
161 # If this option is chosen additions to flags may still be provided
162 # by setting $EXTRA_CFLAGS and $EXTRA_LDFLAGS to whatever is desired.
163 # Thus: set this to false and use your normal $CC / $CFLAGS / $LDFLAGS,
164 # otherwise pass additional flags via $EXTRA_CFLAGS / $EXTRA_LDFLAGS:
165 #     $ make EXTRA_CFLAGS=-std=c99 tangerine
166 # Whatever you do, the configuration is fixated and updates will force
167 # rebuilds.  And far below in this file there is $OPT_FORCED_STACKPROT,
168 # too, which can be used to cause injection of stack protectors, but
169 # which normally happens for development and debug builds only.
170 # (Remember, file is parsed from top to bottom, sorry.)
171 OPT_AUTOCC=yes
173 # It is possible to compile S-nail as a "single-source", meaning that
174 # all source files are injected into a single compilation unit, which is
175 # then compiled.  This allows the compiler to perform much more
176 # optimizations, and also reduces the management overhead that is used
177 # for / needed by the linker.
178 OPT_AMALGAMATION=no
180 # Character set conversion enables reading and sending of mails in
181 # multiple character sets through usage of the iconv(3) library.  Please
182 # read the manual section "Character sets" for the complete picture.
183 # This should usually be enabled; it can be "require"d.
184 OPT_ICONV=yes
186 # Major switch to toggle *all* network related protocols
187 # (POP3,SMTP,IMAP) and related/dependent stuff (GSS-API,SSL);
188 # can be "require"d.
189 OPT_SOCKETS=yes
191 # If $OPT_SOCKETS: support for Secure Socket Layer (Transport Layer
192 # Security, TLS), i.e., encrypted socket connections; can be "require"d.
193 # This needs the OpenSSL libraries (<http://www.openssl.org>).
194 # This needs the OpenSSL (https://www.openssl.org) or LibreSSL
195 # (http://www.libressl.org) libraries.
196 OPT_SSL=yes
198 # If $OPT_SSL: shall S-nail (try to) use mechanisms to support more
199 # digest and cipher algorithms than the few that are documented?  For
200 # S/MIME *smime-cipher* for example this will cause
201 # EVP_get_cipherbyname(3) to be tried shall the (S-nail-) built-in
202 # knowledge not suffice to understand the user request.  Will create
203 # a large statically linked binary; dynamically linked the costs only
204 # arise once the extended lookup is actually needed (the first time).
205 # Some SSL libraries will always support all algorithms.
206 # This can be "require"d.
207 OPT_SSL_ALL_ALGORITHMS=yes
209 # If $OPT_SOCKETS: support for SMTP protocol?
210 # (Directly sending mails over the network)  Can be "require"d.
211 OPT_SMTP=yes
213 # If $OPT_SOCKETS: support for POP3 protocol?
214 # (Download of mails via POP protocol)  Can be "require"d.
215 OPT_POP3=yes
217 # If $OPT_SOCKETS: support for IMAP protocol?
218 # Requires $WANT_ICONV.
219 # (Reading of mails directly on the server)  Can be "require"d.
220 OPT_IMAP=yes
222 # If $OPT_SOCKETS: support for GSS-API (Generic Security Services
223 # Application Programming Interface) based authentication, e.g.,
224 # Kerberos v5?  Available for IMAP and SMTP; can be "require"d.
225 OPT_GSSAPI=yes
227 # Enabling the MD5 message digest adds support for several
228 # authentication possibilities: POP3 (APOP), IMAP and SMTP (CRAM-MD5).
229 # If you don't need those, you may turn them off by excluding MD5.
230 OPT_MD5=yes
232 # If $OPT_SOCKETS: support for parsing of user and password credentials
233 # from the ~/.netrc file ($NETRC; see *netrc-lookup* manual entry).
234 OPT_NETRC=yes
236 # If $OPT_SOCKETS: passwords can also be looked up through an external
237 # "agent" in order to allow for encrypted password storage (see
238 # *agent-shell-lookup*).
239 # [Obsolete] Even though marked *v15-compat* this feature has been
240 # obsoleted; please use an encrypted .netrc file (via *netrc-pipe*) or
241 # encrypt a complete resource file and load this like, e.g.,
242 #     source "gpg -qd ~/.mailprivate.gpg | "
243 OPT_AGENT=yes
245 # IDNA (internationalized domain names for applications) offers users
246 # the possibility to use domain names in their native language, i.e., to
247 # use non-US-ASCII content, as in, e.g., <www.räksmörgåsa.example>,
248 # which the IDNA algorithm would convert to
249 # <www.xn--rksmrgsa-0zap8p.example>.  :)  This either needs idnkit
250 # (https://www.nic.ad.jp/ja/idn/idnkit/download/) or the GNU Libidn
251 # library (https://www.gnu.org/software/libidn/).  It can be
252 # "require"d.
253 OPT_IDNA=yes
255 # IMAP-style SEARCH expressions can be supported.  This addressing mode
256 # is available with all types of folders; for folders not located on
257 # IMAP servers, or for servers unable to execute the SEARCH command, the
258 # search is performed locally.
259 OPT_IMAP_SEARCH=yes
261 # Regular expression (re_format(7)) support for searches, conditional
262 # expressions etc., we use the extended ones, then; can be "require"d.
263 OPT_REGEX=yes
265 # Line editing and -history (manual "On terminal and line editor").
266 # . OPT_MLE
267 #   If ISO C (ISO/IEC 9899:1990/Amendment 1:1995) is supported on the
268 #   system then our built-in MLE (Mailx-Line-Editor) version can be used.
269 #   An enabled & available OPT_TERMCAP may affect and improve the MLE.
270 #   Can be "require"d.
271 OPT_MLE=yes
272 # Add support for history management.
273 OPT_HISTORY=yes
274 # Add support for `(un)?bind'ing of key sequences
275 OPT_KEY_BINDINGS=yes
277 # Use termcap(5) for terminal control; can be "require"d.
278 # Today most environments ship a termcap(5) that in fact is part of
279 # terminfo(5), and acts as a converting wrapper for this library.
280 # To avoid this redundancy we also support terminfo(5), and use it
281 # instead if we find it (assuming that termcap(5) is a stub, then).
282 # Note that terminfo(5) offers access to more key sequences, e.g.,
283 # kLFT5, for which no termcap(5) entry exists.
284 # terminfo(5) support can (thus) be "require"d.
285 OPT_TERMCAP=yes
286 OPT_TERMCAP_VIA_TERMINFO=yes
288 # Enable the `errors' command; S-nail is a console-based application and
289 # thus errors may fly by pretty fast as other operations are in
290 # progress; or $PAGERs are started and clear errors off the screen.  If
291 # enabled errors are duplicated as they happen and the `errors' command
292 # will show them when asked to.
293 OPT_ERRORS=yes
295 # Interaction with a spam email filter is possible.
296 # Refer to all commands and variables with a "spam" prefix, and
297 # see the manual example section "Handling spam".
298 # . OPT_SPAM_SPAMC:
299 #   Support for interaction with spamassassin(1)s spamc(1).
300 # . [Obsolete] OPT_SPAM_SPAMD:
301 #   Direct communication with spamassassin(1)s spamd(1).
302 #   Needs unix(4) domain sockets (checked).  Can be "require"d.
303 # . OPT_SPAM_FILTER:
304 #   Generic filter hook which can be used with e.g. bogofilter(1)
305 #   and sylfilter(1): see documentation for the *spam-filter-**
306 #   variables for expected application behaviour.
307 OPT_SPAM_SPAMC=no
308 OPT_SPAM_SPAMD=no
309 OPT_SPAM_FILTER=yes
311 # We may include help strings for commands, increasing size a bit
312 OPT_DOCSTRINGS=yes
314 # A simple line-based quoting mechanism can be made available via the
315 # *quote-fold* mechanism.  This will be turned off automatically if the
316 # required character classification is not available on the host.
317 # Can be "require"d.
318 # TODO shouldn't wrap lines when only WS or a NL-escaping \ follows
319 OPT_QUOTE_FOLD=yes
321 # We do have a very primitive HTML tagsoup filter which can be used to
322 # convert HTML to plain text for display purposes.  If enabled it'll be
323 # used for all MIME types which have the @h@ or @H@ type markers (more
324 # on this in the manual section "The mime.types FILES").  And which
325 # don't have any user defined MIME type handler, of course.
326 OPT_FILTER_HTML_TAGSOUP=yes
328 # A simple form of coloured output can optionally be produced.
329 OPT_COLOUR=yes
331 # File dotlocking is performed for "system mailbox" (%[USER] and
332 # %:ANYFILE) MBOX files: when synchronizing any such FILE a FILE.lock
333 # file will be created in the directory of FILE, for the duration of the
334 # synchronization.
335 # Set $OPT_DOTLOCK to support this traditional mail spool file locking.
336 # $VAL_MAIL(s) where normal system mailboxes reside are usually not
337 # writable by normal users, except that a user may read and write his
338 # own mailbox.  But this means that a program run by the user cannot
339 # create a .lock file!  The solution is to install a privilege-separated
340 # mini-program that has the sole purpose and functionality of managing
341 # the dotlock file in such situations -- and only then, as a last
342 # ressort.  With it dotlock files can be created for any mailbox for
343 # which the invoking user has read (or read-write) permissions, and
344 # under the UID and GID of the mailbox itself!  We call it -privsep.
345 # $OPT_DOTLOCK can be "require"d.
346 OPT_DOTLOCK=yes
348 ##  --  >8  --  8<  --  ##
349 ## Normal users should not need to read any further
351 ## PATHS AND PROGRAMS, DEVELOPMENT ##
353 # To ease the life of forkers and packagers "our" name can be changed.
354 # The name is build by concatenating $VAL_SID and $VAL_MAILX, i.e.,
355 # $(VAL_SID)$(VAL_MAILX).  Note that the final string must be longer
356 # than two characters and may not contain any whitespace.
357 VAL_SID=s-
358 VAL_MAILX=nail
360 # The name of the exemplary resource template.
361 # Note 1: not overwritten by "make install" if yet existent!
362 VAL_SYSCONFRC="${VAL_SID}${VAL_MAILX}.rc"
364 ## FEATURE SET, DEVELOPMENT ##
366 # Use debug compiler flags, enable some additional commands and code
367 # assertions.  Note that setting this also enables our own memory
368 # canaries, which require a rather large amount of runtime memory.
369 OPT_DEBUG=no
371 # Experimental code etc.
372 # Note: this forcefully enables OPT_DEBUG
373 OPT_DEVEL=no
375 # We use the crypto libraries' MD5 implementation if possible, unless..
376 OPT_NOEXTMD5=no
378 # With $OPT_AUTOCC we can make use of the ASan AddressSanitizer and ASan
379 # MemorySanitizer of Google
380 # (https://github.com/google/sanitizers/wiki/AddressSanitizer).
381 # These are definetely only useful for debugging.
382 # Also, external libraries are often problematic (e.g., ncursesw), and
383 # ASAN_MEMORY of the tried clang 4.0.0 (4.0.0-2 of ArchLinux) was faulty.
384 # Can be "require"d.
385 OPT_ASAN_ADDRESS=no
386 OPT_ASAN_MEMORY=no
388 # With $OPT_AUTOCC we will use stack protector guards shall the
389 # detected compiler support them; this goes in line with our own (heap)
390 # memory canaries and will detect buffer overflows.  It is usually only
391 # useful during development, i.e., in a debug environment that tests all
392 # aspects of a program.  But today it is often used even in shipout code.
393 OPT_FORCED_STACKPROT=`\
394    if feat_yes DEVEL || feat_yes DEBUG; then \
395       echo yes;\
396    else \
397       echo no;\
398    fi`
400 # If $OPT_DEBUG is true we'll use a simple memory wrapper with
401 # canaries.  This interferes with memory debuggers like valgrind(1) or
402 # the LLVM -fsanitize stuff.  Enable this to not use our wrapper.
403 OPT_NOMEMDBG=`\
404    if feat_yes ASAN_MEMORY || feat_yes ASAN_ADDRESS; then \
405       echo yes;\
406    else \
407       echo no;\
408    fi`
410 # Our functions are instrumented with Not-Yet-Dead chirps, which print
411 # a function call trace when the program crashes.  Whereas NYD will be
412 # used automatically when either of $OPT_DEBUG and $OPT_DEVEL is
413 # defined, an extended level of NYD is compiled in only on explicit
414 # request.
415 # TODO Separation in between NYD and NYD2 not yet fully done.
416 OPT_NYD2=no
418 # vim:set tw=72: s-it-mode