You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@spamassassin.apache.org by Justin Mason <jm...@jmason.org> on 2004/09/11 07:04:37 UTC
Re: svn commit: rev 43688 - spamassassin/trunk/spamd
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
Isn't the SYNOPSIS used for spamd's usage message? If so, I
think removing the defaults from that message is a bad thing...
- --j.
mss@apache.org writes:
> Author: mss
> Date: Fri Sep 10 13:11:49 2004
> New Revision: 43688
>
> Modified:
> spamassassin/trunk/spamd/spamd.raw
> Log:
> POD fix: Truncated SYNOPSIS lines to 80 chars. Mostly by removing
> the default values -- they are in the long description of the option
> and adding default values for *all* description would make the
> SYNOPSIS long and complex. So everybody who wants to know the
> defaults should read the man page. (I'm thinking about breaking the
> SYNOPSIS into several parts to make it less confusing.)
>
> Modified: spamassassin/trunk/spamd/spamd.raw
> ==============================================================================
> --- spamassassin/trunk/spamd/spamd.raw (original)
> +++ spamassassin/trunk/spamd/spamd.raw Fri Sep 10 13:11:49 2004
> @@ -1912,23 +1912,25 @@
>
> -c, --create-prefs Create user preferences files
> -C path, --configpath=path Path for default config files
> - --siteconfigpath=path Path for site configs (def: /etc/mail/spamassassin)
> + --siteconfigpath=path Path for site configs
> -d, --daemonize Daemonize
> -h, --help Print usage message.
> - -i [ipaddr], --listen-ip=ipaddr Listen on the IP ipaddr (default: 127.0.0.1)
> - -p port, --port Listen on specified port (default: 783)
> - -m num, --max-children=num Allow maximum num children (default: 5)
> - --max-conn-per-child=num Maximum connections accepted by child before exiting
> + -i [ipaddr], --listen-ip=ipaddr Listen on the IP ipaddr
> + -p port, --port Listen on specified port
> + -m num, --max-children=num Allow maximum num children
> + --max-conn-per-child=num Maximum connections accepted by child
> + before it is respawned
> -q, --sql-config Enable SQL config (only useful with -x)
> -Q, --setuid-with-sql Enable SQL config (only useful with -x,
> enables use of -H)
> --ldap-config Enable LDAP config (only useful with -x)
> --setuid-with-ldap Enable LDAP config (only useful with -x,
> enables use of -a and -H)
> - --virtual-config-dir=dir Enable pattern based Virtual configs (needs -x)
> + --virtual-config-dir=dir Enable pattern based Virtual configs
> + (needs -x)
> -r pidfile, --pidfile Write the process id to pidfile
> - -s facility, --syslog=facility Specify the syslog facility (default: mail)
> - --syslog-socket=type How to connect to syslogd (default: unix)
> + -s facility, --syslog=facility Specify the syslog facility
> + --syslog-socket=type How to connect to syslogd
> -u username, --username=username Run as username
> -v, --vpopmail Enable vpopmail config
> -x, --nouser-config Disable user config files
> @@ -1938,7 +1940,7 @@
> -D, --debug Print debugging messages
> -L, --local Use local tests only (no DNS)
> -P, --paranoid Die upon user errors
> - -H dir, --helper-home-dir=dir Specify a different HOME directory, path optional
> + -H [dir], --helper-home-dir[=dir] Specify a different HOME directory
> --ssl Run an SSL server
> --server-key keyfile Specify an SSL keyfile
> --server-cert certfile Specify an SSL certificate
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.4 (GNU/Linux)
Comment: Exmh CVS
iD8DBQFBQodkQTcbUG5Y7woRAigbAKDAfa9V1uST0Up50L5SnHzqo04k3gCfb91y
p0vFVDaEiCHqHQXRvLi1Es8=
=eURH
-----END PGP SIGNATURE-----
Re: svn commit: rev 43688 - spamassassin/trunk/spamd
Posted by "Malte S. Stretz" <ms...@gmx.net>.
On Saturday 11 September 2004 07:04 CET Justin Mason wrote:
> Isn't the SYNOPSIS used for spamd's usage message? If so, I
> think removing the defaults from that message is a bad thing...
Yes it is (that's why I shortened it to 80 chars), IMO everybody who's
interested in the defaults can have a look at the man page. The output is
already pretty long and complex without the default values. I'm fine with
adding the defaults again, but then we should note the default values for
*all* options, not just for a few random ones.
To fight the complexity of the help output I though about splitting it into
several categories, something like "General Options", "Config Options",
etc. Or, alternatively to show only the basic options in the SYNOPSIS and
for all the advanced and rarely used ones (like --virtual-config-dir and
--server-key) show just a text "for more advanced options have a look at
the man page". What do you think is better?
Cheers,
Malte
--
[SGT] Simon G. Tatham: "How to Report Bugs Effectively"
<http://www.chiark.greenend.org.uk/~sgtatham/bugs.html>
[ESR] Eric S. Raymond: "How To Ask Questions The Smart Way"
<http://www.catb.org/~esr/faqs/smart-questions.html>