Docbook to Man pages

Matthew East mdke at ubuntu.com
Mon Aug 14 06:56:42 UTC 2006


-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1



* Jordan Mantha:
> On 8/13/06, Dan McGarry <it.psl at fsp.org.vu> wrote:
>> Matthew East wrote:
>>> Or to ship an ubuntu-server-docs package with the HTML files. Are you
>>> quite sure a "man page" is necessary, it sounds to me like more work
>>> than it is worth. I'm confident we can prepare HTML which looks good in
>>> a text based browser.
>> For a server installation, I'd suggest that man pages are highly
>> desirable. They are the de facto standard for usage documentation on the
>>   console.
> 
> I don't think creating man pages out of the Server Guide is a good
> idea. man pages are fine for small app docs but trying to read a whole
> server guide via man would be less than ideal, IMO. HTML allows you to
> jump around better and linking is nice. If we have any links to
> onlince resources too HTML would be an advantage. Finding what you
> want in a man page can be pretty difficult if it is very large.

Quite right. Look at apache, for example. The HTML docs shipped are much
more useful (/usr/share/doc/apache2-doc/manual/) than the limited and
hard to find man pages supplied.

Matt
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.2.2 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iD8DBQFE4B6qtSaF0w5rBv8RAmdMAJ4qJdg8j3rO4seNtcULEQg6540DXgCfXdMD
BjF9tXh4vvrUz4NVLxHbZkA=
=K5MN
-----END PGP SIGNATURE-----





More information about the ubuntu-doc mailing list