pg.ddx.io pgsql-docs@postgresql.org mailing list archive
help / color / mirror / Atom feedreference pages for libpq
3+ messages / 3 participants
[nested] [flat]
* reference pages for libpq
@ 2001-02-10 21:14 Robert B. Easter <reaster@comptechnews.com>
0 siblings, 2 replies; 3+ messages in thread
From: Robert B. Easter @ 2001-02-10 21:14 UTC (permalink / raw)
To: pgsql-docs
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
^ permalink raw reply [nested|flat] 3+ messages in thread
* Re: reference pages for libpq
@ 2001-02-10 21:27 Bruce Momjian <pgman@candle.pha.pa.us>
parent: Robert B. Easter <reaster@comptechnews.com>
1 sibling, 0 replies; 3+ messages in thread
From: Bruce Momjian @ 2001-02-10 21:27 UTC (permalink / raw)
To: Robert B. Easter <reaster@comptechnews.com>; +Cc: pgsql-docs
[ 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
^ permalink raw reply [nested|flat] 3+ messages in thread
* Re: reference pages for libpq
@ 2001-02-10 22:20 Peter Eisentraut <peter_e@gmx.net>
parent: Robert B. Easter <reaster@comptechnews.com>
1 sibling, 0 replies; 3+ messages in thread
From: Peter Eisentraut @ 2001-02-10 22:20 UTC (permalink / raw)
To: Robert B. Easter <reaster@comptechnews.com>; +Cc: 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/
^ permalink raw reply [nested|flat] 3+ messages in thread
end of thread, other threads:[~2001-02-10 22:20 UTC | newest]
Thread overview: 3+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2001-02-10 21:14 reference pages for libpq Robert B. Easter <reaster@comptechnews.com>
2001-02-10 21:27 ` Bruce Momjian <pgman@candle.pha.pa.us>
2001-02-10 22:20 ` Peter Eisentraut <peter_e@gmx.net>
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox