Skip site navigation (1)Skip section navigation (2)
Date:      Wed, 8 Jun 2005 11:24:04 -0400
From:      Charles Swiger <cswiger@mac.com>
To:        brian.barto@spectrum-health.org
Cc:        freebsd-questions@freebsd.org
Subject:   Re: How to create a man page?
Message-ID:  <81E714F7-A355-4DB8-B40B-BD13126BDE3E@mac.com>
In-Reply-To: <B6532FAEDD53D94ABDBFB24C35EF77300A34EFE0@dcmsmsg01.spectrum-health.org>
References:  <B6532FAEDD53D94ABDBFB24C35EF77300A34EFE0@dcmsmsg01.spectrum-health.org>

next in thread | previous in thread | raw e-mail | index | archive | help
On Jun 8, 2005, at 9:53 AM, brian.barto@spectrum-health.org wrote:
> Hi all. I am writing a program with hopes to submit it for  
> inclusion to the
> ports collection. My last step is to include a man page for my  
> program. Man
> pages look to be some sort of markup language. What is the standard  
> way to
> create a man page? Is there some sort of wysiwyg or some other  
> program that
> makes them easy to create?

If your program implements the standard --version and --help long  
options, the misc/help2man port will create an adequate manpage from  
the information your program provides.  Someone who knows NROFF can  
do a better job writing of the manpage by hand, but it's at least a  
starting point.

-- 
-Chuck




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?81E714F7-A355-4DB8-B40B-BD13126BDE3E>