1 #@ conf.rc can be used adjust the set of desired features, paths, etc.
2 #@ You should have read `INSTALL' first.
4 #@ . This file is parsed by the shell: it is in sh(1), not in make(1) syntax.
5 #@ . Choosing one of the predefined CONFIG= sets overwrites a lot of items
6 #@ that can be set in here
7 #@ . Specifying settings on the command line will take precedence over the
8 #@ variables in here (correctly triggering build updates as necessary)
9 #@ . Using one of the predefined CONFIG= sets overrides anything else
10 #@ . You may NOT comment out anything in here -- if you want to disable a
11 #@ feature, simply set it to `0'. (It won't work properly otherwise!)
15 # The variables in here can be used to adjust the feature set of S-nail.
16 # Only if a variable is set to `1' it is treated as being `set'.
17 # Only a `set' variable will cause the possibly necessary feature tests to be
18 # performed, so as to detect wether the wanted feature really can be used
20 # S-nail automatically detects compilers and has a set of known compiler flags
21 # which work well. Since users should be able to define their own $CC, $CFLAGS
22 # and $LDFLAGS, however, it only uses the detected environment if the user
23 # forces their usage via setting WANT_AUTOCC=1. (Except for $CC, which is
24 # always set if it's empty or set to "cc".)
25 # Note: it is possible to add to the detected values by setting ADDCFLAGS="xy"
26 # and/or ADDLDFLAGS="xy" -- "configuration-has-changed" detection will work on
27 # the final $CC / $CFLAGS / $LDFLAGS, and thus will include those additions
30 # It is possible to compile S-nail as a "single-source", meaning that all
31 # source files are injected into a single compilation unit, which is then
32 # compiled. This allows the compiler to perform much more optimizations, and
33 # also reduces the management overhead that is used for / needed by the linker.
34 # Of course compiling such a large source requires a lot of memory by itself
35 # NOTE: experimental in that the feature is quite new -- it is thus not known
36 # wether some compilers may generate buggy code when compiling single-source
39 # Major switch to toggle *all* network related protocols (IMAP,POP3,SMTP) and
40 # related/dependent stuff (GSSAPI,SSL)
43 # If WANT_SOCKETS, should the IPv6 family of functions be searched for and
44 # compiled into the program if found?
46 # TODO S-nail does not yet support IPv6 address notation, as in, e.g.,
47 # TODO imaps://user1@::1 (or @[::1]), but it will happily establish a
48 # TODO connection to imaps://user1@host1 if host1 listens via IPv6
51 # Support for SecureSocketLayer (TransportLayerSecurity, TLS), i.e.,
52 # encrypted socket connections.
53 # This needs OpenSSL libraries (<http://www.openssl.org>; these should be
54 # installed by default on practically all operating systems today, though)
57 # Support for IMAP protocol? (Reading of mails directly on the server)
59 # Support for GSSAPI-based authentication, i.e., Kerberos V5 for IMAP?
60 # (This is disabled by default because it brings in a bunch of dependencies,
61 # and most people don't need it.)
64 # Support for POP3 protocol? (Download of mails via POP over the network)
67 # Support for SMTP protocol? (Directly sending mails over the network)
70 # Several facilities use the MD5 message digest, but for some of them it is
71 # only used for optional features (POP3: APOP authentification, IMAP: CRAM-MD5
72 # authentification, SMTP: CRAM-MD5 authentification).
73 # If you don't need those, you may exclude MD5 from S-nail.
74 # Note that WANT_MD5 is automatically turned off if its exclusion will only
75 # affect MIME boundary strings and Message-Id: fields
78 # Character set conversion enables reading and sending of mails in multiple
79 # character sets through usage of the iconv(3) library.
80 # Please read the manual section "Character sets" for the complete picture.
81 # This should usually be enabled
84 # IDNA (internationalized domain names for applications) offers users the
85 # possibility to use domain names in their native language, i.e., to use
86 # non-US-ASCII content, as in, e.g., <www.räksmörgåsa.example>, which the IDNA
87 # algorithm would convert to <www.xn--rksmrgsa-0zap8p.example>. :)
88 # This needs the GNU Libidn library (<https://www.gnu.org/software/libidn/>)
91 # Regular expression (re_format(7)) support for IMAP-style searches,
92 # (then) triggerable by using a slash as the second character _of the complete
93 # search expression_: e.g., `(/from .*bsd.*)'.
96 # Command line editing and -history.
97 # S-nail actually supports three different command line editors, one builtin
98 # and two fully fledged external libraries which may offer a slightly better
99 # user experience at the cost of more memory usage and CPU time; also the
100 # interactive behaviour may not be one-to-one to what is documented.
101 # Note that these are tested in shown order, and each desired one must be
104 # The GNU readline(3) compatible interface
106 # Command line editing via BSD editline(3)
108 # If ISO C (ISO/IEC 9899:1990/Amendment 1:1995) is supported on the system
109 # then our builtin NCL (Nail Command Line editor) version can be used.
110 # It is documented in the manual section "Command line editor" (in ./nail.1)
114 # For all command line editors we optionally support history management
116 # For the NCL command line editor we optionally support "expand-on-tabulator".
117 # Turning it off shrinks the binary. Please see the respective manual entry
120 # Interaction with a spam email filter is possible.
121 # Refer to all commands with a `spam' prefix, and see the manual section
122 # "Handling spam" (`./nail.1')
125 # If given an optional argument the `help' command will print a help string
126 # only for the mentioned command; those strings take up space and so one may
127 # disable this feature
130 # A simple line-based quoting mechanism can be made available via the
131 # *quote-fold* mechanism.
132 # This will be turned off automatically if the required character
133 # classification is not available on the host.
134 # TODO shouldn't wrap lines when only WS or a NL-escaping \ follows
137 ## PATHS AND PROGRAMS ##
139 # General prefix where S-nail should be installed
142 # Fine tune individual locations, normally under $PREFIX
143 # . the place of the S-nail program
144 BINDIR="${PREFIX}/bin"
146 MANDIR="${PREFIX}/man"
147 # . of the exemplary resource file
148 SYSCONFDIR="${PREFIX}/etc"
150 # This variable is prepended to all the paths from above at installation time;
151 # this feature can be used for, e.g., package building: if $PREFIX is
152 # `/usr/local', but $DESTDIR is set to, say, `here', then S-nail will still
153 # think its $PREFIX is `/usr/local' whereis the build system will instead use
157 # The directory where the local mail system stores user mail (mbox) files.
158 # (Only of interest if the local mail system is used)
161 # Path to the local MTA (Mail Transport Agent).
162 # (Only of interest if the local mail system is used)
163 SENDMAIL=/usr/sbin/sendmail
165 # Today a lot of systems no longer use sendmail(1), but a different MTA.
166 # To ensure compatibility with sendmail(1), a system called mailwrapper(8) is
167 # used, which selects the required service by looking at the name by which the
168 # program actually has been invoked.
169 # This variable can be used to adjust this name as necessary
170 # (Only of interest if the local mail system is used)
171 SENDMAIL_PROGNAME=sendmail
173 # Fallback sh(1) path.
174 # Note that it is not guaranteed that *all* uses of the shell use this, but it
175 # may actually happen that execlp(2) will need to fallback to its own one.
176 # (Note: this is named XSHELL so that it doesn't clash with the POSIX
177 # standard $SHELL, which would effectively cause this setting to be ignored)
180 # The default *LISTER* (in the $PATH).
181 # (Note: this is named XLISTER so that it doesn't clash with the POSIX
182 # standard $LISTER, which would effectively cause this setting to be ignored)
185 # The default *PAGER* (in the $PATH).
186 # (Note: this is named XPAGER so that it doesn't clash with the POSIX standard
187 # $PAGER, which would effectively cause this setting to be ignored)
190 # The following tools may be provided a.k.a. overwritten, `command -pv NAME`
191 # is used to query the utility otherwise:
192 # MAKE=, STRIP=, awk=, cat=, chmod=, cp=, cmp=, grep=, mkdir=, mv=, tee=
194 # Note that rm(1) and sed(1) are needed before this file is read, all other
195 # utilities will be checked afterwards only.
196 # For cross-compilation setting MAKE= and STRIP= may be necessary
200 ## Normal users should not need to read any further
202 ## PATHS AND PROGRAMS, DEVELOPMENT ##
204 # To ease the life of forkers and packagers "our" name can be changed.
205 # The name is build by concatenating $SID and $NAIL, i.e., $(SID)$(NAIL).
206 # Note that the final string must be longer than two characters and may not
207 # contain any whitespace
211 # The location of the exemplary resource template.
212 # Note 1: it's not overwritten if it yet exists!
213 # Note 2: `make install' assumes it's under $SYSCONFDIR!
214 SYSCONFRC="${SYSCONFDIR}/${SID}${NAIL}.rc"
216 ## FEATURE SET, DEVELOPMENT ##
218 # Use debug compiler flags, enable some additional commands (like `sstats',
219 # `smemtrace'), some code assertions, possibly experimental code etc.
220 # Note that setting this also enables our own memory canaries, which require
221 # a rather large amount of runtime memory, and forcefully disables alloca(3)
222 # stack memory usage (see WANT_NOALLOCA below), so as to be able to track usage
223 # of stack memory via our memory canaries
226 # We ship with our own small and efficient getopt(3) implementation;
227 # set this to always choose that without even checking for another one
230 # The codebase makes a lot of use of alloca(3), and this will remain since
231 # S-nail will continue to be compliant to ISO C89, which has no variable
232 # arrays, etc. For testing purposes it is however nice to use the much slower
233 # normal S-nail heap memory allocator instead.
234 # Note: this will be forcefully set (again) if WANT_DEBUG=1
235 WANT_NOALLOCA="${WANT_DEBUG}"
237 # vim:set fenc=utf-8 syntax=conf:s-it-mode