reference pages for libpq

Started by Robert B. Easterabout 25 years ago3 messagesdocs
Jump to latest
#1Robert B. Easter
reaster@comptechnews.com

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.

--
------------------------------------------------
Robert B. Easter reaster@comptechnews.com
Linux Consultant http://www.comptechserv.com
Homepage: http://www.comptechnews.com/~reaster

#2Bruce Momjian
bruce@momjian.us
In reply to: Robert B. Easter (#1)
Re: reference pages for libpq

[ Charset ISO-8859-1 unsupported, converting... ]

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.

Some felt it more properly belonged in the programmers guide.

-- 
  Bruce Momjian                        |  http://candle.pha.pa.us
  pgman@candle.pha.pa.us               |  (610) 853-3000
  +  If your life is a hard drive,     |  830 Blythe Avenue
  +  Christ can be your backup.        |  Drexel Hill, Pennsylvania 19026
#3Peter Eisentraut
peter_e@gmx.net
In reply to: Robert B. Easter (#1)
Re: reference pages for libpq

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/