On Tue, 22 Feb 2005 15:42:45 -0000, Dave Korn wrote:
> ----Original Message----
> >From: cygwin-owner On Behalf Of Raul Miller
> > Both the man page and the usage information on cygpath indicate
> > that it only accepts a single file name argument.  These should
> > probably be updated.
> 
>   A fair point.  Attached :)
> 
>   Hmm.  Anyone out there know about utils.sgml better than me?  I have two
> questions:
> 
> 1)  Does it matter that the usage line is now longer than 80 chars?

Not really, but why not just put some on second line?
 
> 2)  What's with the CDATA section ?

A CDATA section is for enclosing text that might otherwise be interpreted as
formatting commands (i.e., special chars like > < & ), sort-of like
<pre> in HTML.
Use it for code examples.
 
> <example><title>Example <command>cygpath</command> usage</title>
> <screen>
> <![CDATA[
> #!/bin/sh
> if [ "${1}" = "" ];
>         then
>                 XPATH=".";
>         else
>                 XPATH="$(cygpath -w "${1}")";
> fi
> explorer $XPATH &
> ]]>
> </screen>
> </example>
> 
>   When I look at the generated manpage in info or man, the opening <![CDATA[
> tag is displayed, but the closing ]]> tag has disapperared.  I think it's
> probably not meant to be this way?

How are you generating man pages from that DocBook example? There is a way
to get man pages from <refentry> I think, but we don't use it for
Cygwin. I just wrote
a hacked-up perl script to turn utils.sgml into man pages.

--
Unsubscribe info:      http://cygwin.com/ml/#unsubscribe-simple
Problem reports:       http://cygwin.com/problems.html
Documentation:         http://cygwin.com/docs.html
FAQ:                   http://cygwin.com/faq/

Reply via email to