From: Eric Mahurin <eric_mahurin@...>
Date: 2005-06-25T10:34:42+09:00
Subject: Re: [ANN] Application-0.6.0

--- Jim Freeze <jim@freeze.org> wrote:

> > What I meant was that you should have short description for
> the
> > usage and a long description for the man page.  For
> example,
> > compare gzip -h (usage) vs. man gzip (full docs).  One has
> a
> > few words per option and the other a full paragraph per
> option.
> 
> Yes, but that seems like going overboard. What I mean is that
> seems like it could get busy quick. I suppose one way to
> clean
> that up would be to use the std description for both #usage
> and #man, but if they define a description for #man, then
> use it.
> 
> So, how about something like:
> 
>   option :names           => "--my-option",
>          :opt_description => "this is used in usage (and
> maybe man)",
>          :arg_description => "the_argument",
>          # use text below in man page if they exist
>          :man_opt_description => "this is a longer
> description "+
>                                  "indended for the man
> page.",
>          :man_arg_description =>
> "do_we_really_need_this_for_arg?"

perfect!



		
____________________________________________________ 
Yahoo! Sports 
Rekindle the Rivalries. Sign up for Fantasy Football 
http://football.fantasysports.yahoo.com