From owner-freebsd-questions@FreeBSD.ORG  Thu Jan 12 20:07:34 2006
Return-Path: <owner-freebsd-questions@FreeBSD.ORG>
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 B3C8816A41F
	for <freebsd-questions@freebsd.org>;
	Thu, 12 Jan 2006 20:07:34 +0000 (GMT)
	(envelope-from keramida@ceid.upatras.gr)
Received: from aiolos.otenet.gr (aiolos.otenet.gr [195.170.0.93])
	by mx1.FreeBSD.org (Postfix) with ESMTP id D4F9F43D7C
	for <freebsd-questions@freebsd.org>;
	Thu, 12 Jan 2006 20:07:33 +0000 (GMT)
	(envelope-from keramida@ceid.upatras.gr)
Received: from flame.pc (aris.bedc.ondsl.gr [62.103.39.226])
	by aiolos.otenet.gr (8.13.4/8.13.4/Debian-8) with SMTP id
	k0CK7UKL023951; Thu, 12 Jan 2006 22:07:31 +0200
Received: by flame.pc (Postfix, from userid 1001)
	id 4642D11759; Thu, 12 Jan 2006 22:05:54 +0200 (EET)
Date: Thu, 12 Jan 2006 22:05:54 +0200
From: Giorgos Keramidas <keramida@ceid.upatras.gr>
To: SPYRIDON PAPADOPOULOS <SP373@student.apu.ac.uk>
Message-ID: <20060112200554.GA1067@flame.pc>
References: <1137094538.8ba70fa0SP373@student.apu.ac.uk>
Mime-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <1137094538.8ba70fa0SP373@student.apu.ac.uk>
Cc: freebsd-questions@freebsd.org
Subject: Re: How to create a manual page in FreeBSD
X-BeenThere: freebsd-questions@freebsd.org
X-Mailman-Version: 2.1.5
Precedence: list
List-Id: User questions <freebsd-questions.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-questions>, 
	<mailto:freebsd-questions-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-questions>
List-Post: <mailto:freebsd-questions@freebsd.org>
List-Help: <mailto:freebsd-questions-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-questions>, 
	<mailto:freebsd-questions-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Thu, 12 Jan 2006 20:07:34 -0000

On 2006-01-12 19:35, SPYRIDON PAPADOPOULOS <SP373@student.apu.ac.uk> wrote:
> Hi all,
>
> Can anyone describe/give info, of how one can create a manual
> page for a custom program in FreeBSD. A manual page that would
> be accessible through the #man command. Is it possible?

Look at the existing manpages for examples, i.e.:

    /usr/src/bin/ls/ls.1

Then, you may get a good start for writing the groff source of a
manpage by copying and modifying one of the files:

$ ls -l /usr/share/examples/mdoc/*.?
-r--r--r--  1 root  wheel  - 3620 Jan 12 20:16 /usr/share/examples/mdoc/example.1
-r--r--r--  1 root  wheel  - 7658 Jan 12 20:16 /usr/share/examples/mdoc/example.3
-r--r--r--  1 root  wheel  - 3079 Jan 12 20:16 /usr/share/examples/mdoc/example.4
-r--r--r--  1 root  wheel  - 7757 Jan 12 20:16 /usr/share/examples/mdoc/example.9

The complete reference of all groff mdoc macros that you can use when
writing the document of the manpage is described in groff_mdoc(7):

    $ man groff_mdoc