[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: Manpage for program without manpage



> Hi All,
> 
> I created a manpage to refer to if no manpage is available. It is
> called nampuf (No apropriate manpage for this program, utility or
> function; Need a manpage for this program, utility or funcion). 
> Perhaps this can be included in one of the essential packages.

I have added a couple of comments to the source version...

> Erick.

David.


> source nampuf.5:
> .\" Hey, Emacs!  This is an -*- nroff -*- source file.
> .TH nampuf 5 "2th Febuary 1996" "Debian Project" "Debian GNU/Linux"
> .SH NAME (1)
> nampuf \- No apropriate manpage for this program, utility or function.
> .SH NAME (2)
> nampuf \- Need a manpage for this program, utility or function.
> .SH DESCRIPTION
> This
> .B program, utility or function
> \-\- further revert to as 
Word correction:  ``revert'' should be ``referred''.


> .B nampuf
> \-\- does not have a useful manpage.  Please do not report this as a
> bug, as this might have been done many times. Instead, if you are a
> competent and accurate writer and are willing to spend the time
> reading the source code and writing good manpages please write a
> better man page for
> .B nampuf
> than this one.
> 
> Try the following options if you want more information. 
> .B nampuf
> replaced by the real name of the program, utility or function you need
> information on.
> 
> nampuf \-\-help|\-h|-?
> .TP
> info nampuf
> .TP
> whatis|apropos nampuf
> .TP
> check directory's /usr/doc/nampuf, /usr/lib/nampuf
Why are we looking in ``/usr/lib/nampuf''?  Why are we not looking in
``/usr/doc/examples/nampuf''?


> .TP
> dpkg \-\-listfiles|\-\-search nampuf
> .TP
> find / \-name '*nampuf*'
> .PP
> If you still didn't find anything usefull you might consider posting a
> call for help to debian-user@pixar.com.
> 
> If \-\-after all this\-\- the meaning of
> .B nampuf
> changes from 
> .B NAME (1)
> to
> .B NAME (2)
> you might write the manpage yourself.
This bit is unclear.  Perhaps you mean ``changes from NAME (2) to NAME (1)'',
although this is not much better.


> .SH SEE ALSO
> .BR info (1),
> .BR whatis (1),
> .BR apropos (1),
> .BR dpkg (8),
> .BR find (1).
> .SH AUTHOR
> Erick Branderhorst <branderhorst@heel.fgg.eur.nl>; One line stolen
> from Ian Jackson <ijackson@gnu.ai.mit.edu>.
> .SH COPYRIGHT
> This manpage is free software; see the GNU General Public Licence
> version 2 or later for copying conditions. There is no warranty.
> --
> Erick Branderhorst@heel.fgg.eur.nl +31-10-4635142


-- 
  David H. Silber     dhs@firefly.com     Project: Debian GNU/Linux (dbackup)
  <http://www.access.digex.net/~dhs/>     Wanted:  Spare time.

			     Programmer for hire.


Reply to: