From owner-freebsd-ports  Tue Aug  6 19:27:41 1996
Return-Path: owner-ports
Received: (from root@localhost)
          by freefall.freebsd.org (8.7.5/8.7.3) id TAA23630
          for ports-outgoing; Tue, 6 Aug 1996 19:27:41 -0700 (PDT)
Received: from relay.nuxi.com (nuxi.cs.ucdavis.edu [128.120.56.38])
          by freefall.freebsd.org (8.7.5/8.7.3) with ESMTP id TAA23625
          for <freebsd-ports@freebsd.org>; Tue, 6 Aug 1996 19:27:36 -0700 (PDT)
Received: (from obrien@localhost) by relay.nuxi.com (8.7.5/8.6.12) id TAA02633 for freebsd-ports@freebsd.org; Tue, 6 Aug 1996 19:27:52 -0700 (PDT)
From: "David E. O'Brien" <obrien@Nuxi.cs.ucdavis.edu>
Message-Id: <199608070227.TAA02633@relay.nuxi.com>
Subject: Re: Writing man pages
To: freebsd-ports@freebsd.org (FreeBSD ports list)
Date: Tue, 6 Aug 1996 19:27:51 -0700 (PDT)
In-Reply-To: <Pine.OSF.3.95.960805145912.11075J-100000@ginger.eng.umd.edu> from Chuck Robey at "Aug 5, 96 03:00:10 pm"
X-PGP-Fingerprint: B7 4D 3E E9 11 39 5F A3  90 76 5D 69 58 D9 98 7A
X-Pgp-Keyid: 34F9F9D5
X-Mailer: ELM [version 2.4ME+ PL22 (25)]
MIME-Version: 1.0
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 7bit
Sender: owner-ports@freebsd.org
X-Loop: FreeBSD.org
Precedence: bulk

> On Mon, 5 Aug 1996, James FitzGibbon wrote:
>
> > Question: if the author of a program provides no manpage-style
> > documentation, is it customary for the porter to create one ?  If so, can
> > someone point be to a resource on writing man pages ?
> 
> Well, it'd be kinda unusual, yes, but appreciated!  The only stuff I know
> is in the mdoc and mdoc.sample man pages, and perusing other man pages to
> see how it's done.

You also can look at /usr/share/misc{mdoc.template,man.template}

Filling in the blanks of /usr/share/misc/mdoc.template would probably be
the place to start.

-- David    (obrien@cs.ucdavis.edu)