From owner-freebsd-questions@FreeBSD.ORG Wed Jun 8 15:24:08 2005 Return-Path: X-Original-To: freebsd-questions@freebsd.org Delivered-To: freebsd-questions@freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 1541616A41C for ; Wed, 8 Jun 2005 15:24:08 +0000 (GMT) (envelope-from cswiger@mac.com) Received: from smtpout.mac.com (smtpout.mac.com [17.250.248.73]) by mx1.FreeBSD.org (Postfix) with ESMTP id DFB3843D49 for ; Wed, 8 Jun 2005 15:24:07 +0000 (GMT) (envelope-from cswiger@mac.com) Received: from mac.com (smtpin08-en2 [10.13.10.153]) by smtpout.mac.com (Xserve/8.12.11/smtpout16/MantshX 4.0) with ESMTP id j58FO7Qp005342; Wed, 8 Jun 2005 08:24:07 -0700 (PDT) Received: from [192.168.1.6] (pool-68-161-69-6.ny325.east.verizon.net [68.161.69.6]) (authenticated bits=0) by mac.com (Xserve/smtpin08/MantshX 4.0) with ESMTP id j58FO5Dp021378; Wed, 8 Jun 2005 08:24:06 -0700 (PDT) In-Reply-To: References: Mime-Version: 1.0 (Apple Message framework v730) Content-Type: text/plain; charset=US-ASCII; delsp=yes; format=flowed Message-Id: <81E714F7-A355-4DB8-B40B-BD13126BDE3E@mac.com> Content-Transfer-Encoding: 7bit From: Charles Swiger Date: Wed, 8 Jun 2005 11:24:04 -0400 To: brian.barto@spectrum-health.org X-Mailer: Apple Mail (2.730) Cc: freebsd-questions@freebsd.org Subject: Re: How to create a man page? X-BeenThere: freebsd-questions@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: User questions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 08 Jun 2005 15:24:08 -0000 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