Re: UNIX manual page development tool

Subject: Re: UNIX manual page development tool
From: Megan Golding <mgolding -at- secureworks -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: 17 Sep 2001 10:09:44 -0400

Max wants a tool to use for developing UNIX manual pages.


If you're up for a little learning, I'd suggest writing man pages with
DocBook and translating them to man (with readily available scripts).
Beware: if you've never worked with DocBook, there is a significant
infestment in setup time to get you editing environment working.

HOWTO Install:

Whether you're using Windows, Linux, or UNIX, tools for creating
documents with DocBook are available. Cygwin is the most commonly used
in Windows.


I recently wrote man pages with DocBook and found the process very easy.
I used a template for the basic manpage parts (synopsis, options, etc.)
and filled in the blanks with my information.


As is so typical in Open Source projects, there are several ways to
convert your document from DocBook to man (which is troff markup). I
used docbook2man, which is part of the docbook-utils package on my Linux


So, I start with a document written in DocBook, run docbook2man, and end
up with a man file.

Please let me know if you have specific questions about this solution.

Megan Golding
Technical Writer
SecureWorks, Inc.


A landmark hotel, one of America's most beautiful cities, and
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe.

+++ Miramo -- Database/XML publishing automation. See us at +++
+++ Seybold SFO, Sept. 25-27, in the Adobe Partners Pavilion +++
+++ More info: +++

You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit for more resources and info.

UNIX manual page development tool: From: Max Zimani

Previous by Author: RE: Ratio - Development to Documentation Hours
Next by Author: Problem with creating PDF of Word doc that includes equations
Previous by Thread: UNIX manual page development tool
Next by Thread: Re: UNIX manual page development tool

What this post helpful? Share it with friends and colleagues:

Sponsored Ads