RE: syslog config file format poll
"Rainer Gerhards" <[email protected]> Fri, 14 Sep 2007 08:12:17 +0200
| Newsgroups | gmane.comp.sysutils.loganalysis |
|---|---|
| Message-ID | <577465F99B41C842AAFBE9ED71E70ABA2789D0@grfint2.intern.adiscon.com> |
> > You need to include a decent manpage with the product as it ships, > isn't that obvious? > > We have a manual page on syslog-ng options, but not on the > configuration > file format. It basically duplicates information from the manual. > > The manual page has a more limited scope, thus it cannot be a complete > documentation, but then we'd be duplicating information between the > manual page and the reference manual. I don't like that. > > I'd argue about the obviousness of having to include a manual page. You > don't have a manual page for apache either (as an example). I'd like to second Bazsi's line of thought: man pages are pretty basic and it is hard to get *all* the information into a man page. I have to admit that for rsyslog I switched from man pages to html doc for that reason, also on the config format. Now, I, too, have included a contributed man page, but fear these two will become inconsistent. We are currently thinking about the best format (with auto-generation of man and html) - but it doesn't make much sense to write a 100page man page, so you need to switch format at one point or another... My 2cts... Rainer