[Logwatch-Devel] the description about nonexistent option '--usage' should be deleted from manpage

MrC lists-logwatch at cappella.us
Sat Sep 1 18:16:15 MST 2007


Yu Zhiguo wrote:
> Hello,
> 
>     I find a bug in the manpage of logwatch.
>     Option '--usage' does not exist, so the description about this 
> nonexistent option should be deleted from manpage.

Hello Yu,

Since --usage is already documented, I added the option to logwatch 
instead.  The new version allows --usage.

If other's disagree with this change, I'll revert and remove --usage 
from the documentation.

MrC

> 
>     We cannot use option '--usage' to get the usage information, but option 
> "--help" can be used to get the usage information.
>     And in the code of logwatch, there are no relative codes about option 
> "--usage", so I think the description in the manpage should be deleted.
> 
>     [root at localhost ~]# logwatch --usage
>     Unknown option: usage
>     ^^^^^^^^^^^^^^^^^^
> 
> 
>     [root at localhost ~]# logwatch --help
> 
>     Usage: /usr/sbin/logwatch [--detail <level>] [--logfile <name>]
>        [--print] [--mailto <addr>] [--archives] [--range <range>] [--debug 
> <level>]
>        [--save <filename>] [--help] [--version] [--service <name>]
>        [--numeric] [--output <output_type>]
>        [--splithosts] [--multiemail]
> 
>     I have made a patch for the manpage of the latest stable release of 
> Logwatch (logwatch-7.3.6-1) .
> Could you confirm and apply it in the next release?
> 
>     Thanks a lot.
> 
> Regards
> Yu Zhiguo
> 
> =================The content of the patch=====================
> 
> --- logwatch-7.3.6.orig/logwatch.8 2007-07-29 20:04:40.000000000 +0800
> +++ logwatch-7.3.6/logwatch.8 2007-07-29 20:06:52.000000000 +0800
> @@ -25,7 +25,7 @@
>  .I hostname
>  .B ] [--splithosts] [--multiemail] [--output
>  .I output-type
> -.B ] [--numeric] [--version] [--help|--usage]
> +.B ] [--numeric] [--version] [--help]
>  .SH DESCRIPTION
>  .B Logwatch
>  is a customizable, pluggable log-monitoring system.  It will go
> @@ -100,10 +100,8 @@
>  then only logs from this hostname will be processed (where appropriate).
>  .IP "\fB--numeric\fR"
>  Inhibits additional name lookups, displaying IP addresses numerically.
> -.IP "\fB--usage\fR"
> -Displays usage information
>  .IP "\fB--help\fR"
> -same as --usage.
> +Displays usage information.
>  .SH FILES
>  .IP /usr/share/logwatch/
>  .RS
> 
> 
> 
> _______________________________________________
> Logwatch-Devel mailing list
> Logwatch-Devel at logwatch.org
> http://www2.list.logwatch.org:81/mailman/listinfo/logwatch-devel


More information about the Logwatch-Devel mailing list