From: Andreas K. <and...@Ac...> - 2001-11-09 20:54:28
|
> -----Original Message----- > From: tcl...@li... > [mailto:tcl...@li...]On Behalf Of Joe > English > Sent: Friday, November 09, 2001 12:48 PM > To: tcl...@li... > Subject: Re: [Tcllib-devel] How frequently do the htmlized tcllib docs > get updated? > > > > Andreas Kupries wrote: > > > > Oh. Which nroff commands are not handled ? > > Mostly the macro definitions; excerpts from 'man.macros' are included > inline, and there are several macros (.de i1, .de i2, ...) used > to keep the the SYNOPSIS in sync with the rest of the manpage. I am quite sure that the manpages I wrote do not use these commands. Because of this I come to the conclusion that I did not write the comm.n manpage but that this is the original manpage by J. R. LoVerso This is reinforced by the contents. > The other unrecognized requests aren't too hard to add. > > FWIW, the Tcl core docs for commands with lots of suboptions > conventionally > just use > > .SH SYNOPSIS > .nf > \fBcommand\fP \fIoption ...\fP ? \fI arg arg... \fB > .SH DESCRIPTION > ... > instead of listing all the subcommands explicitly in the SYNOPSIS. > I've modified the manpage, expanding all the macro definitions > and updating it to use this style; it now passes through my converter > relatively unscathed. Results at: > > <URL: http://tcllib.sourceforge.net/doc/comm.html > > > original version at: > > <URL: http://tcllib.sourceforge.net/doc/comm.n.html > > > If this is acceptable, I'll commit the modified version. It looks good to me. When you commit the modified version please enter and assign a doc bug to me as well, as reminder that the contents have to be updated too (comm is now in the namspace comm, etc.) -- Andreas Kupries <and...@Ac...> Developer @ http://www.ActiveState.com |