Learning about how to write a well written manual page, just want to
point out the examples provided by the FreeBSD
Project, located under
the base system in /usr/share/examples/mdoc
.
For those who are not (yet!) under FreeBSD Operating System, you can browse the publicly available CVS repository via the web interface.
If not already in the system man path or the environmental variable ${MANPATH}, you can display your new manual page using:
$ tbl example.1 | groff -S -Wall -mtty-char -man -Tlatin1 | col | more
Or:
$ zcat example.1.gz | tbl | groff -S -Wall -mtty-char -man -Tlatin1 | col | more