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 # Major switch to toggle *all* network related protocols (IMAP,POP3,SMTP) and
21 # related/dependent stuff (GSSAPI,SSL)
24 # If WANT_SOCKETS, should the IPv6 family of functions be searched for and
25 # compiled into the program if found?
27 # TODO S-nail does not yet support IPv6 address notation, as in, e.g.,
28 # TODO imaps://user1@::1 (or @[::1]), but it will happily establish a
29 # TODO connection to imaps://user1@host1 if host1 listens via IPv6
32 # Support for SecureSocketLayer (TransportLayerSecurity, TLS), i.e.,
33 # encrypted socket connections.
34 # This needs OpenSSL libraries (<http://www.openssl.org>), though these should
35 # be installed by default on practically all operating systems today
38 # Support for IMAP protocol? (Reading of mails directly on the server)
40 # Support for GSSAPI-based authentication, i.e., Kerberos V5 for IMAP?
41 # (This is disabled by default because it brings in a bunch of dependencies,
42 # and most people don't need it.)
45 # Support for POP3 protocol? (Download of mails via POP over the network)
48 # Support for SMTP protocol? (Directly sending mails over the network)
51 # Several facilities use the MD5 message digest, but for some of them it is
52 # used for optional features (POP3: APOP authentification, IMAP: CRAM-MD5
53 # authentification, SMTP: CRAM-MD5 authentification).
54 # If you don't need those, you may exclude MD5 from S-nail.
55 # Note that WANT_MD5 is automatically turned off if its exclusion will only
56 # affect MIME boundary strings and Message-Id: fields
59 # Character set conversion enables reading and sending of mails in multiple
60 # character sets through usage of the iconv(3) library.
61 # Please read the manual section "Character sets" for the complete picture.
62 # This should usually be enabled
65 # IDNA (internationalized domain names for applications) offers users the
66 # possibility to use domain names in their native language, i.e., to use
67 # non-US-ASCII content, as in, e.g., <www.räksmörgåsa.example>, which the IDNA
68 # algorithm would convert to <www.xn--rksmrgsa-0zap8p.example>. :)
69 # This needs the GNU Libidn library (<https://www.gnu.org/software/libidn/>)
72 # Command line editing and -history.
73 # S-nail actually supports three different line editors:
74 # . WANT_LINE_EDITOR=1, WANT_EDITLINE=0, WANT_EDITLINE_READLINE=0
75 # If ISO C (ISO/IEC 9899:1990/Amendment 1:1995) is supported on the system
76 # then our builtin NCL (Nail Command Line editor) version will be used.
77 # This one is documented in the manual section "Line editor" (`./nail.1').
78 # The fully fledged external libraries may offer a slightly better user
79 # experience at the cost of needing more memory and CPU time; also note that
80 # the behaviour of S-nail in respect to signal handling may no longer be POSIX
82 # . WANT_LINE_EDITOR=1, WANT_EDITLINE=1, WANT_EDITLINE_READLINE=0
83 # Command line editing via BSD editline(3)
84 # . WANT_LINE_EDITOR=1, WANT_EDITLINE=1, WANT_EDITLINE_READLINE=1
85 # The GNU readline(3) compatible interface
88 WANT_EDITLINE_READLINE=0
90 # Interaction with a spam email filter is possible.
91 # Refer to all commands with a `spam' prefix, and see the manual section
92 # "Handling spam" (`./nail.1')
95 # If given an optional argument the `help' command will print a help string
96 # only for the mentioned command; those strings take up space and so one may
97 # disable this feature.
100 # A simple line-based quoting mechanism can be made available via the
101 # *quote-fold* mechanism.
102 # This will be turned off automatically if the required character
103 # classification is not available on the host.
104 # NOTE: this is EXPERIMENTAL and INCOMPLETE!
107 ## PATHS AND PROGRAMS ##
109 # General prefix where S-nail should be installed
112 # Fine tune individual locations, normally under $PREFIX
113 # . the place of the S-nail program
114 BINDIR="${PREFIX}/bin"
116 MANDIR="${PREFIX}/man"
117 # . of the exemplary resource file
118 SYSCONFDIR="${PREFIX}/etc"
120 # This variable is prepended to all the paths from above at installation time;
121 # this feature can be used for, e.g., package building: if $PREFIX is
122 # `/usr/local', but $DESTDIR is set to, say, `here', then S-nail will still
123 # think its $PREFIX is `/usr/local' whereis the build system will instead use
127 # The directory where the local mail system stores user mail (mbox) files.
128 # (Only of interest if the local mail system is used)
131 # Path to the local MTA (Mail Transport Agent).
132 # (Only of interest if the local mail system is used)
133 SENDMAIL=/usr/sbin/sendmail
135 # Today a lot of systems no longer use sendmail(1), but a different MTA.
136 # To ensure compatibility with sendmail(1), a system called mailwrapper(8) is
137 # used, which selects the required service by looking at the name by which the
138 # program actually has been invoked.
139 # This variable can be used to adjust this name as necessary
140 # (Only of interest if the local mail system is used)
141 SENDMAIL_PROGNAME=sendmail
143 # Fallback sh(1) path.
144 # Note that it is not guaranteed that *all* uses of the shell use this, but it
145 # may actually happen that execlp(2) will need to fallback to its own one.
146 # (Note: this is named XSHELL so that it doesn't clash with the POSIX
147 # standard $SHELL, which would effectively cause this setting to be ignored)
150 # The default *LISTER* (in the $PATH).
151 # (Note: this is named XLISTER so that it doesn't clash with the POSIX
152 # standard $LISTER, which would effectively cause this setting to be ignored)
155 # The default *PAGER* (in the $PATH).
156 # (Note: this is named XPAGER so that it doesn't clash with the POSIX standard
157 # $PAGER, which would effectively cause this setting to be ignored)
160 # Build+Install: the cmp(1) command (in the $PATH)
163 # Build+Install: the strip(1) program (in the $PATH)
166 # Build+Install: the nonstandard install(1) program (in the $PATH)
171 ## Normal users should not need to read any further
173 ## PATHS AND PROGRAMS, DEVELOPMENT ##
175 # For those who want to install S-nail(1) as nail(1), use an empty *SID*
178 # To ease the life of forkers and packagers one may even adjust the "nail"
179 # of nail(1). Note that $SID$NAIL must be longer than two characters
182 # The location of the exemplary resource template.
183 # Note it's not overwritten if it yet exists!
184 SYSCONFRC="${SYSCONFDIR}/${SID}${NAIL}.rc"
186 ## FEATURE SET, DEVELOPMENT ##
188 # We ship with our own small and efficient getopt(3) implementation;
189 # set this to always choose that one without even checking for another one
192 # A lot of use of alloca(3) -- use a slow and expensive heap approach instead?
195 # Enable debug-only code assertions
198 # vim:set fenc=utf-8 syntax=conf:s-it-mode