man pages

Started by David Fetterover 16 years ago5 messages
#1David Fetter
david@fetter.org

Folks,

I'd like to see about creating man pages for the following:

- libpq
- SPI
- the built-in functions

These being what I've clicked through way too many web links to find
information about. If there are other things that should have man
pages, please mention same.

How would that be handled in our current doc build system? I'd really
appreciate any hints, tips or pointers on man page creation in our
current system :)

Cheers,
David.
--
David Fetter <david@fetter.org> http://fetter.org/
Phone: +1 415 235 3778 AIM: dfetter666 Yahoo!: dfetter
Skype: davidfetter XMPP: david.fetter@gmail.com

Remember to vote!
Consider donating to Postgres: http://www.postgresql.org/about/donate

#2Andrew Chernow
ac@esilo.com
In reply to: David Fetter (#1)
Re: man pages

David Fetter wrote:

Folks,

I'd like to see about creating man pages for the following:

- libpq
- SPI
- the built-in functions

That would be really helpful and convenient. I've often wanted libpq man pages.

--
Andrew Chernow
eSilo, LLC
every bit counts
http://www.esilo.com/

#3Alvaro Herrera
alvherre@commandprompt.com
In reply to: David Fetter (#1)
Re: man pages

David Fetter wrote:

Folks,

I'd like to see about creating man pages for the following:

- libpq
- SPI
- the built-in functions

These being what I've clicked through way too many web links to find
information about. If there are other things that should have man
pages, please mention same.

We already have SPI manpages in HEAD. libpq would be very useful, I
agree; you should try to patch the SGML following the SPI example in
order to get those. It shouldn't be difficult.

As for builtin functions, I think that's going to be a very hard sell.
I'd focus on libpq at first :-)

--
Alvaro Herrera http://www.CommandPrompt.com/
The PostgreSQL Company - Command Prompt, Inc.

#4Tom Lane
tgl@sss.pgh.pa.us
In reply to: Alvaro Herrera (#3)
Re: man pages

Alvaro Herrera <alvherre@commandprompt.com> writes:

As for builtin functions, I think that's going to be a very hard sell.

Fresh out of the box, there are 2227 entries in pg_proc as of CVS HEAD.
I don't see making a man page for each one as being a useful activity
...

regards, tom lane

#5David Fetter
david@fetter.org
In reply to: Tom Lane (#4)
Re: man pages

On Sun, Oct 11, 2009 at 09:18:20PM -0400, Tom Lane wrote:

Alvaro Herrera <alvherre@commandprompt.com> writes:

As for builtin functions, I think that's going to be a very hard
sell.

Fresh out of the box, there are 2227 entries in pg_proc as of CVS
HEAD. I don't see making a man page for each one as being a useful
activity ...

How about a man page with all of them (or main sections of them) and a
bunch of symbolic links, as with *printf?

Cheers,
David.
--
David Fetter <david@fetter.org> http://fetter.org/
Phone: +1 415 235 3778 AIM: dfetter666 Yahoo!: dfetter
Skype: davidfetter XMPP: david.fetter@gmail.com

Remember to vote!
Consider donating to Postgres: http://www.postgresql.org/about/donate