Re: pgAgent manpage

On 30/12/05 15:20, "Raphaël Enrici" <blacknoz(at)club-internet(dot)fr> wrote:

>> I've got no problems with that at all. Can you prepare both XML files and a
>> suitable makefile?
>
> Ok, I'm preparing the files. Until I'm ready can you recheck the pgAgent
> manpage I sent (in particular the synopsis) please.

Sure. The only changes I'd suggest are summed up in the following line:

A full documentation of pgAgent is available in pgadmin3's online

Which reads better as

Full documentation for pgAgent is available in pgAdmin III's online

'A full documentation' doesn't work, as documentation implies plural
'documents', whilst A is singular.

The other is simply me with my marketing hat on - please use the full
'pgAdmin III' in text, and pgadmin3 for path/filenames etc.

>> I guess we might also need a macro to make sure
>> docbook-xml is actually installed - I can probably help with that if
>> required, though it would probably be guesswork to a certain extent!
>
> As far as I know a patched version of docbook2x-man is deistributed
> directly with PostgreSQL, maybe it would be interesting to take a look
> to how they are organizing the stuff?

Not as far as I've ever found (ever tried building the docs on a clean
Slackware for example?), but regardless, the PostgreSQL docs are Docbook
SGML, not XML.

>> I've never seen a localised man page, though I guess they probably do exist
>> - so so we use doc/man or doc/en_US/man?
>
> I confirm they do exist :) On my system all C manpages are installed in
> /usr/share/man/man[1|2|...] and localised ones are installed in
> /usr/share/man/(fr_FR|es_ES|...)/man[1|2|...]
>
> I would use doc/man and doc/man/fr_FR & so on. It should be investigated
> though. One more time, let's take a look to how it's done for PostgreSQL.

There are no localised docs shipped with PostgreSQL. We should not mix
conventions in our source tarballs though, even if they do install into
different places - let's put them all under doc/xx_XX/man.

Regards, Dave.