On Tue, 2009-07-28 at 13:17 -0700, Daniel Hain wrote: > Sebastien Roy wrote: > > > >> > >> 4.5. Interfaces > >> > >> 4.5.1 Exported Interfaces: > >> Interface Status > >> Description > >> ------- ----- > >> --------- > >> /usr/lib/libgs.so Volatile > >> Ghostscript shared library > >> /usr/lib/libgs.so.8 Volatile > >> Ghostscript shared library > >> /usr/lib/libgs.so.8.64 Volatile > >> Ghostscript shared library > >> /usr/include/ghostscript Volatile > >> Ghostscript header files directory > >> /usr/include/ghostscript/iapi.h Volatile > >> Ghostscript header files > >> /usr/include/ghostscript/ierrors.h Volatile > >> Ghostscript header files > >> /usr/include/ghostscript/gdevdsp.h Volatile > >> Ghostscript header files > >> /usr/bin/gsx Volatile GTK+ > >> frontend to libgs.so > >> /usr/bin/gsc Volatile > >> command-line frontend to libgs.so > >> > > > > Given that this is a Public API, where is its documentation? > > > > There are no man pages for these libraries and executables. But there is > a man page for 'gs' which has already been delivered with the earlier > version of Ghostscript. > > The description of the 8.64 API is online at > http://pages.cs.wisc.edu/~ghost/doc/svn/API.htm > and is located at > /usr/share/ghostscript/8.63/doc/API.htm > in the existing version available on OpenSolaris.
I see. What is the intended use of /usr/bin/gsx and /usr/bin/gsc, then? Are these implementation details of the API? If so, they should be Project Private. Note that I find the existing documentation under /usr/share/ghostscript/<version>/doc/ a mess, but pragmatically speaking, I don't think it's worth fixing. > > They are part of the Ghostscript package and are not modified by this case. Right, but because this is the case that defines the API as Volatile, the expectation is that the documentation be available to consumers, which is why I'm asking. -Seb
