> From: Dermot.McCluskey at Sun.COM > Subject: Re: [docs-discuss] Guidance wanted for Tcl/Tk man pages > To: Douglas Stevenson <Douglas.Stevenson at Sun.COM> > Cc: docs-discuss at opensolaris.org > MIME-version: 1.0 > Content-transfer-encoding: 7BIT > X-Accept-Language: en-us, en > User-Agent: Mozilla/5.0 (X11; U; SunOS sun4u; en-US; rv:1.7) Gecko/20070109 > > Douglas Stevenson wrote: > > >There is a "mann" in the Solaris Express Developer Release, but it is currently > >empty. What type of interfaces are you documenting in this directory? > > > > > > mann contains the manpages for the built-in commands > of the Tcl and Tk shells, eg: puts, join, exit, array, open, > tk_messageBox, tcl_findLibrary, etc. >
These built-in commands would go into section 1, User Commands. For those commands that have the same name as a Solaris built-in, you could modify the existing page to add the new functionality, if that page has already been opensourced. > man3 contains manpages for the C APIs for libtcl.so and > libtk.so, eg: Tcl_Init, Tk_GetBitmap, panic, etc. > > What I would recommend would be creating two new sections: man3tcl for the C APIs for libtcl.so and man3tk for the C APIs for libtk.so. I would also recommend creating a man3lib man page for libtcl.3lib and libtk.3lib, briefly describing the library and listing its APIs. I can point you to an example if you'd like. > My preferred solution is to put *both* the current man3 > and mann manpages into new sections: man3tcl and > man3tk. > > Is this a reasonable thing to do? ie mixing C API and > shell command manpages in the same section? Not really. The only way we can really make sense of a man page set that numbers more than 5500 is to keep them in some sort of order. Mixing shell commands and C APIs would make it very difficult to do so. Thanks Doug > > - Dermot >
