Creating man pages

Creating man pages

Post by Steve Conni » Fri, 13 Aug 1993 02:47:32



Here is a quick question I'm sure that someone can answer.

Are there any utilites that are available to help someone create
a man page in nroff format?  Or are we forced to know all the
nroff/troff macros?

  TIA,
  -Steve

--

Applicon, Inc      ,  ~~//    ,        /etc/mknod $HOME/.wittysaying p
                   ~~~~~ ~~~~~    

 
 
 

Creating man pages

Post by Part » Fri, 03 Sep 1993 22:45:49



> Are there any utilites that are available to help someone create
> a man page in nroff format?  Or are we forced to know all the
> nroff/troff macros?

I don't know of any such utility, what I do is: get an exiting man page
of one command, and changing the text, keeping the layout-making commands
as they are, deleting unnecessary parts and so on. Worked pretty well for
me for some simple utilities that do not require very elaborate tables
to get explained.

--

EDV-Zentrum, Universitaet fuer Bodenkultur    Phone: (+43 1) 36 92 924 - 233
Nussdorfer Laende 11                          Fax:   (+43 1) 36 92 924 - 200
A-1190 Wien, Austria                          (-:  Make laugh, not war!  :-)

 
 
 

1. How to create MAN pages?

All,

Could someone describe the step by step process of creating a man page
and / or point me to some documentation?

I am running FBSD 2.1R and have not been able to find any details on
the topic of creating man pages in any of the documentation.

I also have the following questions:

1.  What directory should the source text for man pages be placed in
the FreeBSD system?  Is there a convention for this?

2.  Is there a template or program that I should use to create the
source text?  I am thinking in terms of I enter the text and the
program or template supplies the formatting codes.

3.  If I must use a text editor such as vi to manually embed
formatting codes into the source text, where do I find a list of these
codes and their meanings?

4.  Is the man program a formatter/viewer, or just a viewer?  If the
latter, what formatting program do I use to produce the formatted man
page?

5.  What directory should the formatted man page be placed in?  Is
there a convention for this?

6.  Can the man page text be stored in compressed format?  If yes,
which compression program do I use?  Does the man program decompress
it automatically upon access?

I would greatly appreciate any clues to get me started.

--
Harold

2. keyboard problem in DEC ...

3. Creating man page

4. Find . command & permissions denied?

5. Creating man pages for my app.

6. Redirection of ~user in Netscape Server

7. Create man-pages ?

8. lp request termination with multiple interfaces on one printer

9. creating man pages

10. Suggestions for creating man pages please

11. Creating Man Pages

12. How do I create man page text