On Fri, 27 Sep 2013, David Lang wrote:
I made an experiment and created a light version of "call" statement doc,
linking it at least to some relevant places:
http://www.rsyslog.com/doc/rainerscript_call.html
this is linked to from
http://www.rsyslog.com/doc/rsyslog_conf_basic_structure.html but the back
link takes you to http://www.rsyslog.com/doc/rsyslog_conf_global.html
I think that one thing that would be really good is the equivalent of that
last page that lists every possible v7 parameter with just a link to the page
that describes it (if it could have a short description like the old
conf_global page does, so much the better, but even without any explination
it would help)
so, starting on this, this ugly command line looks like it finds all the places
where v6 style parameters are defined, filters out a couple false positives, and
then runs it through a horrid sed line to reformat it a bit.
grep -r eCmdHdlr * |grep '{' |grep -v cfsysline.c|sed -e s/" 0 }"/" optional "/
-e s/" 1 }"/" required "/ -e s/CNFPARAM_REQUIRED/"required "/ -e s/"^tools\/"//
-e s/"^plugins\/[^/]*\/"// -e s/"^runtime\/"// -e s/"{ "// -e s/"\.c:"/".html"/
-e s/"^"/"http:\/\/www.rsyslog.com\/doc\/"/ -e s/}// -e s/,//g
it's very ugly, but it may be a start on a master index
the nice thing is that 30 of the 44 URLs it generates are actually valid :-)
the ones that aren't fall into a few categories
1. documenation exists (it may be worth having a link at these URLs)
http://www.rsyslog.com/doc/action.html
http://www.rsyslog.com/doc/ruleset.html
http://www.rsyslog.com/doc/template.html
http://www.rsyslog.com/doc/queue.html
http://www.rsyslog.com/doc/lmcry_gcry.html
http://www.rsyslog.com/doc/lmsig_gt.html
2. global items
http://www.rsyslog.com/doc/glbl.html (the only place these parameters seem to be
mentioned in documentation is in their old style version)
http://www.rsyslog.com/doc/rsconf.html (no doc needed)
3. missing documentation
http://www.rsyslog.com/doc/immark.html
http://www.rsyslog.com/doc/mmrfc5424addhmac.html
4. contributed modules
'documentation' is a README file in the source directory
http://www.rsyslog.com/doc/imzmq3.html
http://www.rsyslog.com/doc/omzmq3.html
http://www.rsyslog.com/doc/omhiredis.html
documentation is a README.md file in the source directory
http://www.rsyslog.com/doc/omrabbitmq.html
David Lang
_______________________________________________
rsyslog mailing list
http://lists.adiscon.net/mailman/listinfo/rsyslog
http://www.rsyslog.com/professional-services/
What's up with rsyslog? Follow https://twitter.com/rgerhards
NOTE WELL: This is a PUBLIC mailing list, posts are ARCHIVED by a myriad of
sites beyond our control. PLEASE UNSUBSCRIBE and DO NOT POST if you DON'T LIKE
THAT.
