New XML-based man page build

Started by Peter Eisentrautover 17 years ago5 messagesdocs
Jump to latest
#1Peter Eisentraut
peter_e@gmx.net

Following up to the recent discussion that our man page build is weird,
ancient, and only works with patched tools, I have implemented support
for using a newer toolchain based on docbook2x(.sf.net). You can try it
out by installing docbook2x and running "make manx".

Right now, I can only verify that it works on Debian. Installing this
package from sources might be pretty complicated.

The build works nicely and quickly, and if we fix up a few small
formatting artifacts and sort out the installation issues, we could
switch to using this as our standard build method.

#2Alvaro Herrera
alvherre@2ndquadrant.com
In reply to: Peter Eisentraut (#1)
Re: New XML-based man page build

Peter Eisentraut wrote:

Following up to the recent discussion that our man page build is weird,
ancient, and only works with patched tools, I have implemented support
for using a newer toolchain based on docbook2x(.sf.net). You can try it
out by installing docbook2x and running "make manx".

I just tried it and it works great. This is also Debian so I can't say
how hard it is to install docbook2x.

The build works nicely and quickly, and if we fix up a few small
formatting artifacts and sort out the installation issues, we could
switch to using this as our standard build method.

What artifacts do you see? The only one I can find is that in SEE ALSO
the references to other man pages look like this:

SEE ALSO
ALTER TEXT SEARCH CONFIGURATION(), DROP TEXT SEARCH CONFIGURATION()

We should replace the spaces with _ and add the "l" section in parens.

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

#3Devrim GÜNDÜZ
devrim@gunduz.org
In reply to: Alvaro Herrera (#2)
Re: New XML-based man page build

On Mon, 2008-11-10 at 13:59 -0300, Alvaro Herrera wrote:

Peter Eisentraut wrote:

Following up to the recent discussion that our man page build is weird,
ancient, and only works with patched tools, I have implemented support
for using a newer toolchain based on docbook2x(.sf.net). You can try it
out by installing docbook2x and running "make manx".

I just tried it and it works great. This is also Debian so I can't say
how hard it is to install docbook2x.

On Fedora, package is called docbook-2X , and I had to build the docs
with:

make manx DOCBOOK2MAN=/usr/bin/db2x_docbook2man

Regards,
--
Devrim GÜNDÜZ, RHCE
devrim~gunduz.org, devrim~PostgreSQL.org, devrim.gunduz~linux.org.tr
http://www.gunduz.org

#4Peter Eisentraut
peter_e@gmx.net
In reply to: Devrim GÜNDÜZ (#3)
Re: New XML-based man page build

Devrim GÜNDÜZ wrote:

On Fedora, package is called docbook-2X , and I had to build the docs
with:

make manx DOCBOOK2MAN=/usr/bin/db2x_docbook2man

I have added a configure check so that this should work out of the box now.

#5Devrim GÜNDÜZ
devrim@gunduz.org
In reply to: Peter Eisentraut (#4)
Re: New XML-based man page build

On Wed, 2008-11-26 at 13:32 +0200, Peter Eisentraut wrote:

make manx DOCBOOK2MAN=/usr/bin/db2x_docbook2man

I have added a configure check so that this should work out of the box
now.

Thanks.
--
Devrim GÜNDÜZ, RHCE
devrim~gunduz.org, devrim~PostgreSQL.org, devrim.gunduz~linux.org.tr
http://www.gunduz.org