1 #@ make.rc can be used adjust the set of features, paths, etc.
2 #@ You should have read "INSTALL" first.
4 #@ . Specifying settings on the command line will take precedence over
5 #@ the variables in here (correctly triggering build updates as
7 #@ . Choosing one of the predefined CONFIG= sets overwrites a lot of
8 #@ items that can be set in here / from the command line.
9 #@ . This file is parsed by the shell: it is in sh(1), not in make(1)
10 #@ syntax. Evaluation occurs *after* it has been read, so command
11 #@ line overwrites take effect. To use multiline values, escape the
12 #@ newlines on any but the last line with a backslash, as in "LINE \".
13 #@ The parsing is sequential top-to-bottom (nonetheless) so that shell
14 #@ snippets in a value can refer only to stuff yet defined.
15 #@ . Boolean values can be set via 1/0, true/false, yes/no and on/off
16 #@ (case doesn't matter), other values result in an error.
17 #@ . However, the value "require" is also a true boolean, but will in
18 #@ addition cause configuration to fail if the requested feature is
19 #@ missing. This special behaviour is only tested by a logical subset
21 #@ . You may NOT comment out anything in here -- if you want to disable
22 #@ a feature, set it to a false boolean.
24 ## IDENTITIES, PATHS AND PROGRAMS ##
26 # The user ID our small privilege-separated helper program will be
27 # SETUID to, shall it be included ($WANT_DOTLOCK).
28 # The actual installation make targets will require the chown(1) program
29 # (as below) and require sufficient privileges to perform the SETUID to
30 # $PRIVSEP_USER, then.
33 # General prefix where S-nail should be installed.
36 # Fine tune individual locations, normally under $PREFIX.
37 # . the place of the S-nail program.
38 BINDIR="${PREFIX}/bin"
39 # . the place of the privilege-separated helper program, the name
40 # of which is [$SID$NAIL]-privsep (see below for $SID & $NAIL).
41 # (Only with $WANT_DOTLOCK.)
42 LIBEXECDIR="${PREFIX}/libexec"
44 MANDIR="${PREFIX}/share/man"
45 # . of the exemplary resource file.
46 SYSCONFDIR="${PREFIX}/etc"
48 # The variable $DESTDIR is prepended to all the paths from above at
49 # installation time; this feature can be used for, e.g., package
50 # building: if $PREFIX is "/usr/local", but $DESTDIR is set to "here",
51 # then S-nail will still think its $PREFIX is "/usr/local" whereis the
52 # build system will instead use "here/usr/local".
53 # NOTE: it cannot be set in here, but must be given on the command line
54 # when invoking the "install" make(1) (directly or indirectly).
55 # (That is, if you uncomment it, it'll be update-tracked...)
58 # Where the local mail system stores user mail (mbox) files.
60 if [ -d /var/spool/mail ]; then \
61 echo /var/spool/mail;\
66 ## TODO In v15 we will have a clean separation in between options (OPT_) and
67 ## TODO values (VAL_). This is better than the current WANT_ and XYZ mess.
68 ## TODO Start today with a few
70 # Path to the local MTA (Mail Transport Agent).
72 if [ -x /usr/bin/sendmail ]; then \
73 echo /usr/bin/sendmail;\
74 elif [ -x /usr/lib/sendmail ]; then \
75 echo /usr/lib/sendmail;\
77 echo /usr/sbin/sendmail;\
80 # Today a lot of systems no longer use sendmail(1), but a different MTA.
81 # To ensure compatibility with sendmail(1), a system called
82 # mailwrapper(8) is often used, which selects the required service by
83 # looking at the name by which the program actually has been invoked.
84 # This variable can be used to adjust this name as necessary.
85 VAL_SENDMAIL_PROGNAME=sendmail
87 # Default *SHELL* (sh(1) path).
88 # Sometimes we simply invoke a command directly via execlp(2) instead of
89 # indirectly through *SHELL* -- in these cases execlp(2) may fallback to
90 # it's own builtin sh(1) path
93 # Some more default fallback values, some of which are standardized
94 # and (thus)/or documented in the manual (changes not reflected there!)
95 VAL_DEAD=~/dead.letter
105 # The following tools may be provided a.k.a. overwritten,
106 # `command -v NAME` is used to query the utility otherwise:
107 # MAKE=, STRIP=, awk=, cat=, chmod=, cp=, cmp=, cksum=,
108 # grep=, mkdir=, mv=, rm=, sed=, sort=, tee=, tr=
109 # Usually in administrator paths:
110 # chown= [$WANT_DOTLOCK]
111 # Note that awk(1), rm(1) and tr(1) are needed before this file is read,
112 # all other utilities will be checked afterwards only. For
113 # cross-compilation setting $MAKE and $STRIP may be necessary. Due to
114 # the evaluation order of the build system all those programs are
115 # usually needed, but by setting any of the variables to true(1), as in
116 # chown=/usr/bin/true, availability of unneeded programs can be faked.
117 # We require uname(1) -s, command(1) -v, echo(1), etc.
118 # uname(1) can be circumvented by setting $OS.
122 # Shall S-nail try to automatically detect a compiler and provide a set
123 # of known-good compiler flags? If so additions may still be provided
124 # by setting $ADDCFLAGS and $ADDLDFLAGS to whatever is desired.
125 # Thus: set this to false and use your normal $CC / $CFLAGS / $LDFLAGS,
126 # otherwise pass additional flags via $ADDCFLAGS / $ADDLDFLAGS:
127 # $ make ADDCFLAGS=-std=c99 tangerine
128 # Whatever you do, the configuration is fixated and updates will force
129 # rebuilds. And far below in this file there is $WANT_FORCED_STACKPROT,
130 # too, which can be used to cause injection of stack protectors.
133 # It is possible to compile S-nail as a "single-source", meaning that
134 # all source files are injected into a single compilation unit, which is
135 # then compiled. This allows the compiler to perform much more
136 # optimizations, and also reduces the management overhead that is used
137 # for / needed by the linker.
140 # Character set conversion enables reading and sending of mails in
141 # multiple character sets through usage of the iconv(3) library. Please
142 # read the manual section "Character sets" for the complete picture.
143 # This should usually be enabled; it can be "require"d.
146 # Major switch to toggle *all* network related protocols
147 # (POP3,SMTP) and related/dependent stuff (GSS-API,SSL);
151 # If $WANT_SOCKETS: support for Secure Socket Layer (Transport Layer
152 # Security, TLS), i.e., encrypted socket connections; can be "require"d.
153 # This needs the OpenSSL libraries (<http://www.openssl.org>).
156 # If $WANT_SSL: shall S-nail (try to) use mechanisms to support more
157 # digest and cipher algorithms than the few that are documented? For
158 # S/MIME *smime-cipher* for example this will cause
159 # EVP_get_cipherbyname(3) to be tried shall the (S-nail-) builtin
160 # knowledge not suffice to understand the user request. Will create
161 # a large statically linked binary; dynamically linked the costs only
162 # arise once the extended lookup is actually needed (the first time).
163 # This can be "require"d.
164 WANT_SSL_ALL_ALGORITHMS=yes
166 # If $WANT_SOCKETS: support for SMTP protocol?
167 # (Directly sending mails over the network) Can be "require"d.
170 # If $WANT_SOCKETS: support for POP3 protocol?
171 # (Download of mails via POP protocol) Can be "require"d.
174 # If $WANT_SOCKETS: support for GSS-API (Generic Security Services
175 # Application Programming Interface) based authentication, e.g.,
176 # Kerberos v5? Available for SMTP; can be "require"d.
179 # Enabling the MD5 message digest adds support for several
180 # authentication possibilities: POP3 (APOP), SMTP (CRAM-MD5).
181 # If you don't need those, you may turn them off by excluding MD5.
184 # If $WANT_SOCKETS: support for parsing of user and password credentials
185 # from the ~/.netrc file ($NETRC; see *netrc-lookup* manual entry).
188 # If $WANT_SOCKETS: passwords can also be looked up through an external
189 # "agent" in order to allow for encrypted password storage (see
190 # *agent-shell-lookup*).
191 # [Obsolete] Even though marked *v15-compat* this feature has been
192 # obsoleted; please use an encrypted .netrc file (via *netrc-pipe*) or
193 # encrypt a complete resource file and load this like, e.g.,
194 # source "gpg -qd ~/.mailprivate.gpg | "
197 # IDNA (internationalized domain names for applications) offers users
198 # the possibility to use domain names in their native language, i.e., to
199 # use non-US-ASCII content, as in, e.g., <www.räksmörgåsa.example>,
200 # which the IDNA algorithm would convert to
201 # <www.xn--rksmrgsa-0zap8p.example>. :) This either needs idnkit
202 # (<https://www.nic.ad.jp/ja/idn/idnkit/download/>) or the GNU Libidn
203 # library (<https://www.gnu.org/software/libidn/>). It can be
207 # IMAP-style SEARCH expressions can be supported. This addressing mode
208 # is available with all types of folders; for folders not located on
209 # IMAP servers, or for servers unable to execute the SEARCH command, the
210 # search is performed locally.
213 # Regular expression (re_format(7)) support for searches, conditional
214 # expressions etc., we use the extended ones, then; can be "require"d.
217 # Line editing and -history (manual "On terminal and line editor").
218 # One may choose in between different line editors. Note that (1) only
219 # the builtin MLE (may) map(s) 1:1 to the behaviour as is documented in
220 # the manual and (2) these are tested in the shown order:
222 # The GNU readline(3) compatible interface; can be "require"d.
224 # If ISO C (ISO/IEC 9899:1990/Amendment 1:1995) is supported on the
225 # system then our builtin MLE (Mailx-Line-Editor) version can be used.
226 # An enabled & available WANT_TERMCAP may affect and improve the MLE.
230 # All line editors optionally support history management.
232 # The MLE optionally supports `(un)?bind'ing of key sequences
233 WANT_KEY_BINDINGS=yes
235 # Use termcap(5) for terminal control; can be "require"d.
236 # Today most environments ship a termcap(5) that in fact is part of
237 # terminfo(5), and acts as a converting wrapper for this library.
238 # To avoid this redundancy we also support terminfo(5), and use it
239 # instead if we find it (assuming that termcap(5) is a stub, then).
240 # Note that terminfo(5) offers access to more key sequences, e.g.,
241 # kLFT5, for which no termcap(5) entry exists.
242 # terminfo(5) support can (thus) be "require"d.
244 WANT_TERMCAP_PREFER_TERMINFO=yes
246 # Enable the `errors' command; S-nail is a console-based application and
247 # thus errors may fly by pretty fast as other operations are in
248 # progress; or $PAGERs are started and clear errors off the screen. If
249 # enabled errors are duplicated as they happen and the `errors' command
250 # will show them when asked to.
253 # Interaction with a spam email filter is possible.
254 # Refer to all commands and variables with a "spam" prefix, and
255 # see the manual example section "Handling spam".
257 # Support for interaction with spamassassin(1)s spamc(1).
259 # Direct communication with spamassassin(1)s spamd(1).
260 # Needs unix(4) domain sockets (checked). Can be "require"d.
261 # . WANT_SPAM_FILTER:
262 # Generic filter hook which can be used with e.g. bogofilter(1)
263 # and sylfilter(1): see documentation for the *spam-filter-**
264 # variables for expected application behaviour.
269 # If given an optional argument the `help' command will print a help
270 # string only for the mentioned command; those strings take up space and
271 # so one may disable this feature.
274 # A simple line-based quoting mechanism can be made available via the
275 # *quote-fold* mechanism. This will be turned off automatically if the
276 # required character classification is not available on the host.
277 # TODO shouldn't wrap lines when only WS or a NL-escaping \ follows
280 # We do have a very primitive HTML tagsoup filter which can be used to
281 # convert HTML to plain text for display purposes. If enabled it'll be
282 # used for all MIME types which have the @h@ or @H@ type markers (more
283 # on this in the manual section "THE mime.types FILES"). And which
284 # don't have any user defined MIME type handler, of course.
285 WANT_FILTER_HTML_TAGSOUP=yes
287 # A simple form of coloured output can optionally be produced.
290 # File dotlocking is performed for "system mailbox" (%[USER] and
291 # %:ANYFILE) MBOX files: when synchronizing any such FILE a FILE.lock
292 # file will be created in the directory of FILE, for the duration of the
294 # Set $WANT_DOTLOCK to support this traditional mail spool file locking.
295 # $MAILSPOOL(s) where normal system mailboxes reside are usually not
296 # writable by normal users, except that a user may read and write his
297 # own mailbox. But this means that a program run by the user cannot
298 # create a .lock file! The solution is to install a privilege-separated
299 # mini-program that has the sole purpose and functionality of managing
300 # the dotlock file in such situations -- and only then, as a last
301 # ressort. With it dotlock files can be created for any mailbox for
302 # which the invoking user has read (or read-write) permissions, and
303 # under the UID and GID of the mailbox itself! We call it -privsep.
304 # $WANT_DOTLOCK can be "require"d.
308 ## Normal users should not need to read any further
310 ## PATHS AND PROGRAMS, DEVELOPMENT ##
312 # To ease the life of forkers and packagers "our" name can be changed.
313 # The name is build by concatenating $SID and $NAIL, i.e.,
314 # $(SID)$(NAIL). Note that the final string must be longer than two
315 # characters and may not contain any whitespace.
319 # The name of the exemplary resource template.
320 # Note 1: not overwritten by "make install" if yet existent!
321 SYSCONFRC="${SID}${NAIL}.rc"
323 ## FEATURE SET, DEVELOPMENT ##
325 # Use debug compiler flags, enable some additional commands and code
326 # assertions. Note that setting this also enables our own memory
327 # canaries, which require a rather large amount of runtime memory, and
328 # forcefully disables alloca(3) stack memory usage (see $WANT_NOALLOCA
329 # below), so as to be able to track usage of "stack memory" via our
333 # Experimental code etc.
334 # Note: this will be forcefully set (again) if $WANT_DEBUG=yes.
337 # We use the crypto libraries' MD5 implementation if possible, unless..
340 # The codebase makes a lot of use of alloca(3), and this will remain
341 # since S-nail will continue to be compliant to ISO C89, which has no
342 # variable ("flexible", sigh) arrays, etc. For testing purposes it is
343 # however nice to use the much slower normal S-nail heap memory
345 # Note: this will be forcefully set (again) if $WANT_DEBUG=yes.
346 WANT_NOALLOCA="${WANT_DEBUG}"
348 # If $WANT_DEBUG is true we'll use a simple memory wrapper with
349 # canaries. This interferes with memory debuggers like valgrind(1) or
350 # the LLVM -fsanitize stuff. Enable this to not use our wrapper.
353 # Our functions are instrumented with Not-Yet-Dead chirps, which print
354 # a function call trace when the program crashes. Whereas NYD will be
355 # used automatically when either of $WANT_DEBUG and $WANT_DEVEL is
356 # defined, an extended level of NYD is compiled in only on explicit
358 # TODO Separation in between NYD and NYD2 not yet fully done.
361 # With $WANT_AUTOCC we will use stack protector guards shall the
362 # detected compiler support them; this goes in line with our own (heap)
363 # memory canaries and will detect buffer overflows. It is usually only
364 # useful during development, i.e., in a debug environment that tests all
365 # aspects of a program.
366 WANT_FORCED_STACKPROT=`\
367 if feat_yes DEVEL || feat_yes DEBUG; then \
373 # vim:set tw=72: s-it-mode