Re: How to improve the --help screen

Charlie Reitzel <[email protected]> Fri, 12 Jan 2007 11:20:03 -0500
Newsgroups gmane.comp.web.html-tidy.devel
Message-ID <[email protected]>
I understand the complaint - and noticed this recently myself when trying 
to lookup some option on the Linux command line.  I worry, however, that 
printing all the "config" options would overload the poor guy just trying 
to figure out how to specify the input and output files.

My only constructive suggestion is to make a note something like:
Tidy distinguishes between "Command Line" options and "Markup" 
options.  Command line args use the form "-blah blarg", and control things 
like file handling, loading config files, and so forth.  Markup options use 
the form "--foo bar", and are used to control parsing, cleanup and printing 
of HTML, XHTML and XML markup.  For more info on Markup options, run "tidy 
-help-config" or see http://tidy.sourceforge.net/docs/quickref.html.



Would something like this help?

At 05:03 PM 1/10/2007 +0100, Bjoern Hoehrmann wrote:
>   See <http://tidy.sf.net/issue/1632464>, apparently the way we have
>organized the help page isn't too helpful to discover all configuration
>options. Anyone got ideas how to organize it instead?

-------------------------------------------------------------------------
Take Surveys. Earn Cash. Influence the Future of IT
Join SourceForge.net's Techsay panel and you'll get the chance to share your
opinions on IT & business topics through brief surveys - and earn cash
http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV