Re: man3 Documentation

On 2026-Aug-05, Peter Eisentraut wrote:

> On 04.08.26 20:52, Tristan Partin wrote:
> > Out of curiosity, I was trying to understand what man pages we generate.
> > I found man pgaes for the executables in man1 and a ton of documentation
> > in man7 related to SQL commands. The contents in man3 was a bit
> > perplexing. We only document a set of dblink SQL functions and a set of
> > SPI C functions.
>
> Man pages are produced for all refentry markup. If you want to add more,
> you would have to format the material to fit into that schema. I think
> proposals for more man pages could be considered.

A few months ago I looked into changing the libpq documentation to
refentry format specifically to get a manpage for each function.
Eventually I decided not to do anything because most of them were way
too short and it looked a bit odd, and the current format is too
different from what the end shape would have to be. But maybe it's not
that bad. In principle I +1 the idea for libpq.

Not sure what else would be appropriate to turn into refentry, but I'd
say let's start with one section.

--
Álvaro Herrera PostgreSQL Developer — https://www.EnterpriseDB.com/