Re: reference pages for libpq - Mailing list pgsql-docs

From Peter Eisentraut
Subject Re: reference pages for libpq
Date
Msg-id Pine.LNX.4.30.0102102311380.775-100000@peter.localdomain
Whole thread Raw
In response to reference pages for libpq  ("Robert B. Easter" <reaster@comptechnews.com>)
List pgsql-docs
Robert B. Easter writes:

> I don't see any reference (man) pages for the C API library (libpq).  It's
> got ok html documentation but would it be a good idea to make man pages for
> that library too?  Personally, I really like man page docs for programming
> libraries.  However, I don't want to work on something no one else would want
> or that might just make documentation updating more difficult having two
> places to update if things change.

You could convert the function descriptions that are currently in an
<itemizedlist> into a sequence of <refentry>s.  From that you can make man
pages.  The flow in the HTML might become slightly awkward, though, so
some rewriting might be in order.  The libpgtcl chapter is currently
organized that way (although we don't make man pages from it).

I say try and see how it looks.

--
Peter Eisentraut      peter_e@gmx.net       http://yi.org/peter-e/


pgsql-docs by date:

Previous
From: Bruce Momjian
Date:
Subject: Re: reference pages for libpq
Next
From: Bruce Momjian
Date:
Subject: release date