tty.c: GCC 4.9 warnings
[s-mailx.git] / conf.rc
blob685b0baa1425bd9b327e75f4fbfafb5c0a409da2
1 #@ conf.rc can be used adjust the set of desired features, paths, etc.
2 #@ You should have read `INSTALL' first.
3 #@ Notes:
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!)
13 ## FEATURE SET ##
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
28 # Thus: set this to 0 and use your normal $CC / $CFLAGS / $LDFLAGS, set this to
29 # 1 and pass additional flags via ADDCFLAGS / ADDLDFLAGS.
30 # Whatever you do, the configuration is fixated and updates will force rebuilds
31 WANT_AUTOCC=1
33 # It is possible to compile S-nail as a "single-source", meaning that all
34 # source files are injected into a single compilation unit, which is then
35 # compiled.  This allows the compiler to perform much more optimizations, and
36 # also reduces the management overhead that is used for / needed by the linker.
37 # Of course compiling such a large source requires a lot of memory by itself
38 # NOTE: experimental in that the feature is quite new -- it is thus not known
39 # wether some compilers may generate buggy code when compiling single-source
40 WANT_AMALGAMATION=0
42 # Major switch to toggle *all* network related protocols (IMAP,POP3,SMTP) and
43 # related/dependent stuff (GSS-API,SSL)
44 WANT_SOCKETS=1
46 # If WANT_SOCKETS, should the IPv6 family of functions be searched for and
47 # compiled into the program if found?
48 # TODO NOTE:
49 # TODO S-nail does not yet support IPv6 address notation, as in, e.g.,
50 # TODO imaps://user1@::1 (or @[::1]), but it will happily establish a
51 # TODO connection to imaps://user1@host1 if host1 listens via IPv6
52 WANT_IPV6=1
54 # Support for SecureSocketLayer (TransportLayerSecurity, TLS), i.e.,
55 # encrypted socket connections.
56 # This needs OpenSSL libraries (<http://www.openssl.org>; these should be
57 # installed by default on practically all operating systems today, though)
58 WANT_SSL=1
60 # Support for IMAP protocol?  (Reading of mails directly on the server)
61 WANT_IMAP=1
63 # Support for POP3 protocol?  (Download of mails via POP over the network)
64 WANT_POP3=1
66 # Support for SMTP protocol?  (Directly sending mails over the network)
67 WANT_SMTP=1
69 # Support for GSS-API (Generic Security Services Application Programming
70 # Interface) based authentication, e.g., Kerberos v5?
71 # This is disabled by default because it brings in a bunch of dependencies,
72 # and most people don't need it.
73 WANT_GSSAPI=0
75 # Several facilities use the MD5 message digest, but for some of them it is
76 # only used for optional features (POP3: APOP authentification, IMAP: CRAM-MD5
77 # authentification, SMTP: CRAM-MD5 authentification).
78 # If you don't need those, you may exclude MD5 from S-nail.
79 # Note that WANT_MD5 is automatically turned off if its exclusion will only
80 # affect MIME boundary strings and Message-Id: fields
81 WANT_MD5=1
83 # Character set conversion enables reading and sending of mails in multiple
84 # character sets through usage of the iconv(3) library.
85 # Please read the manual section "Character sets" for the complete picture.
86 # This should usually be enabled
87 WANT_ICONV=1
89 # IDNA (internationalized domain names for applications) offers users the
90 # possibility to use domain names in their native language, i.e., to use
91 # non-US-ASCII content, as in, e.g., <www.räksmörgåsa.example>, which the IDNA
92 # algorithm would convert to <www.xn--rksmrgsa-0zap8p.example>.  :)
93 # This needs the GNU Libidn library (<https://www.gnu.org/software/libidn/>)
94 WANT_IDNA=1
96 # IMAP-style SEARCH expressions can be supported.
97 # This addressing mode is available with all types of folders; for folders not
98 # located on IMAP servers, or for servers unable to execute the SEARCH command,
99 # the search is performed locally
100 WANT_IMAP_SEARCH=1
102 # Regular expression (re_format(7)) support for searches.
103 WANT_REGEX=1
105 # Command line editing and -history.
106 # S-nail actually supports three different command line editors, one builtin
107 # and two fully fledged external libraries which may offer a slightly better
108 # user experience at the cost of more memory usage and CPU time; also the
109 # interactive behaviour may not be one-to-one to what is documented.
110 # Note that these are tested in shown order, and each desired one must be
111 # enabled by itself!
112 # . WANT_READLINE
113 #   The GNU readline(3) compatible interface
114 # . WANT_EDITLINE
115 #   Command line editing via BSD editline(3)
116 # . WANT_NCL
117 #   If ISO C (ISO/IEC 9899:1990/Amendment 1:1995) is supported on the system
118 #   then our builtin NCL (Nail Command Line editor) version can be used.
119 #   It is documented in the manual section "Command line editor" (in ./nail.1)
120 WANT_READLINE=0
121 WANT_EDITLINE=0
122 WANT_NCL=1
123 # For all command line editors we optionally support history management
124 WANT_HISTORY=1
125 # For the NCL command line editor we optionally support "expand-on-tabulator".
126 # Turning it off shrinks the binary.  Please see the respective manual entry
127 WANT_TABEXPAND=1
129 # Interaction with a spam email filter is possible.
130 # Refer to all commands with a `spam' prefix, and see the manual section
131 # "Handling spam" (`./nail.1')
132 WANT_SPAM=1
134 # If given an optional argument the `help' command will print a help string
135 # only for the mentioned command; those strings take up space and so one may
136 # disable this feature
137 WANT_DOCSTRINGS=1
139 # A simple line-based quoting mechanism can be made available via the
140 # *quote-fold* mechanism.
141 # This will be turned off automatically if the required character
142 # classification is not available on the host.
143 # TODO shouldn't wrap lines when only WS or a NL-escaping \ follows
144 WANT_QUOTE_FOLD=1
146 # A simple form of coloured output can optionally be produced (see manual)
147 WANT_COLOUR=1
149 ## PATHS AND PROGRAMS ##
151 # General prefix where S-nail should be installed
152 PREFIX=/usr/local
154 # Fine tune individual locations, normally under $PREFIX
155 # . the place of the S-nail program
156 BINDIR="${PREFIX}/bin"
157 # . of the manual
158 MANDIR="${PREFIX}/man"
159 # . of the exemplary resource file
160 SYSCONFDIR="${PREFIX}/etc"
162 # This variable is prepended to all the paths from above at installation time;
163 # this feature can be used for, e.g., package building: if $PREFIX is
164 # `/usr/local', but $DESTDIR is set to, say, `here', then S-nail will still
165 # think its $PREFIX is `/usr/local' whereis the build system will instead use
166 # `here/usr/local'
167 DESTDIR=
169 # The directory where the local mail system stores user mail (mbox) files.
170 # (Only of interest if the local mail system is used)
171 MAILSPOOL=/var/mail
173 # Path to the local MTA (Mail Transport Agent).
174 # (Only of interest if the local mail system is used)
175 SENDMAIL=/usr/sbin/sendmail
177 # Today a lot of systems no longer use sendmail(1), but a different MTA.
178 # To ensure compatibility with sendmail(1), a system called mailwrapper(8) is
179 # used, which selects the required service by looking at the name by which the
180 # program actually has been invoked.
181 # This variable can be used to adjust this name as necessary
182 # (Only of interest if the local mail system is used)
183 SENDMAIL_PROGNAME=sendmail
185 # Fallback sh(1) path.
186 # Note that it is not guaranteed that *all* uses of the shell use this, but it
187 # may actually happen that execlp(2) will need to fallback to its own one.
188 # (Note: this is named XSHELL so that it doesn't clash with the POSIX
189 # standard $SHELL, which would effectively cause this setting to be ignored)
190 XSHELL=/bin/sh
192 # The default *LISTER* (in the $PATH).
193 # (Note: this is named XLISTER so that it doesn't clash with the POSIX
194 # standard $LISTER, which would effectively cause this setting to be ignored)
195 XLISTER=ls
197 # The default *PAGER* (in the $PATH).
198 # (Note: this is named XPAGER so that it doesn't clash with the POSIX standard
199 # $PAGER, which would effectively cause this setting to be ignored)
200 XPAGER=more
202 # The following tools may be provided a.k.a. overwritten, `command -v NAME`
203 # is used to query the utility otherwise:
204 #  MAKE=, STRIP=, awk=, cat=, chmod=, cp=, cmp=, grep=, mkdir=, mv=, tee=
205 #  rm=, sed=
206 # Note that rm(1) and sed(1) are needed before this file is read, all other
207 # utilities will be checked afterwards only.
208 # For cross-compilation setting MAKE= and STRIP= may be necessary
210 ##  --  >8  --  8<  --  ##
212 ## Normal users should not need to read any further
214 ## PATHS AND PROGRAMS, DEVELOPMENT ##
216 # To ease the life of forkers and packagers "our" name can be changed.
217 # The name is build by concatenating $SID and $NAIL, i.e., $(SID)$(NAIL).
218 # Note that the final string must be longer than two characters and may not
219 # contain any whitespace
220 NAIL=nail
221 SID=s-
223 # The location of the exemplary resource template.
224 # Note 1: it's not overwritten if it yet exists!
225 # Note 2: `make install' assumes it's under $SYSCONFDIR!
226 SYSCONFRC="${SYSCONFDIR}/${SID}${NAIL}.rc"
228 ## FEATURE SET, DEVELOPMENT ##
230 # Use debug compiler flags, enable some additional commands (like `sstats',
231 # `smemtrace'), some code assertions, possibly experimental code etc.
232 # Note that setting this also enables our own memory canaries, which require
233 # a rather large amount of runtime memory, and forcefully disables alloca(3)
234 # stack memory usage (see WANT_NOALLOCA below), so as to be able to track usage
235 # of stack memory via our memory canaries
236 WANT_DEBUG=0
238 # We ship with our own small and efficient getopt(3) implementation;
239 # set this to always choose that without even checking for another one
240 WANT_NOGETOPT=0
242 # The codebase makes a lot of use of alloca(3), and this will remain since
243 # S-nail will continue to be compliant to ISO C89, which has no variable
244 # arrays, etc.  For testing purposes it is however nice to use the much slower
245 # normal S-nail heap memory allocator instead.
246 # Note: this will be forcefully set (again) if WANT_DEBUG=1
247 WANT_NOALLOCA="${WANT_DEBUG}"
249 # vim:set fenc=utf-8 syntax=conf:s-it-mode