Bug#305443: Re: Bug#305443: smtp-auth documentation is incomplete

[Drew Parsons]

On Sun, 2005-05-01 at 18:18 +0200, Marc Haber wrote:

> I see. I always forget that there is client authentication as well.
> That feature is never used by me.
> 

Ah, that explains the confusion.

> I have added
...
> # You can set AUTH_CLIENT_ALLOW_NOTLS_PASSWORDS to allow unencrypted
> # clear text password authentication on all connections.
> 
> to client side authentication.
> 
> To allow setting of macros, nonsplit config will now read
> /etc/exim4/exim4.conf.localmacros before
> /etc/exim4/exim4.conf.template, and README.Debian now has the two
> paragraphs:
> 
> +Our configuration can be controlled in a limited way by setting
> +macros. That way, you can switch on and off certain parts of the
> +default configuration without having to touch the dpkg-conffiles.
> +While touching dpkg-conffiles itself is explitly allowed and wanted,
> +it can be quite a nuisance to be asked on package upgrade whether one
> +wants to use the locally changed file or the file changed by the
> +package maintainer.
> +
> +Whenever you see an .ifdef or .ifndef clause in the configuration
> +file, you can control the appropriate clause by setting the macro in a
> +local configuration file. For split configuration, you can drop the
> +local configuration file anywhere in /etc/exim4/conf.d/main. Just make
> +sure it gets read before the macro is first used. 000_localmacros is a
> +possible name, guaranteeing first order. For a non-split
> +configuration, /etc/exim4/exim4.conf.localmacros gets read before
> +/etc/exim4/exim4.conf.template. See the exim specification, chapter
> +6.4, for details how macro expansion works.
> 

Yes, this looks good now.


> Macros can unfortunately only be _set_ in the main part of exim
> configuration.
> 

> Is are the changes I did sufficient in your opinion?
> 

Yes, that should cover it I think.  

My only final suggestion is to include a trival example in README.Debian
(or commented out in /etc/exim4/conf.d/main/000_localmacros if you want
to create the sample file):

e.g. to switch on a basic on/off definition, use 
MY_MACRO_DEFINITION=1

You've referred to Sect. 6.4 in the full docs, of course, but adding
this little bit of redundant example makes it that much easier to
understand what needs to be done, I think. Especially when it's only one
of these simple macros (like AUTH_CLIENT_ALLOW_NOTLS_PASSWORDS in my
case) which is needed. The full docs can be read if the user should need
to set one of the complex macros.

Thanks,

Drew