[comp.text] Creating `man' pages with tbl eqn

daveb@poa.NREL.ColoState.EDU (Dave Bigelow 491-5574) (10/24/90)

I have started a small documentation project which initially involves
placing some previously published troff documents (single pages up to
reports) into local `man' pages.  When I attempt to use the `catman'
utility however, equations and tables are not processed.  I can produce
an acceptable man page document by utilizing the tbl|eqn|nroff -ms
sequence of commands and piping the output to the appropriate catl
directory entry.  This works well when equations are on a single line
but does not work when equations span multiple lines.

A second problem I will be having is maintaining new draft troff
documents as man pages.  My intention is (was?) to utilize the a single
file to serve both as the manl directory entry and as a file from which a
final camera-ready report could be produced. If the catman utility however,
will not handle tables and equations properly, every revision of the
document will cause a corrupted man page to be produced.

Is there a patch available for the catman utility that comes with SUNOS4.1?
Has anyone solved this problem before?
Would a commercial version of tbl, eqn, troff help solve this problem?

Dave Bigelow        Internet:  daveb@panicum.nrel.ColoState.edu
303-491-5574        Bitnet:    bigelow@CSUGOLD

Natural Resource Ecology Laboratory
Colorado State University
Ft. Collins, CO 80523

Dave Bigelow        Internet:  daveb@panicum.nrel.ColoState.edu
303-491-5574        Bitnet:    bigelow@CSUGOLD

stolcke@ICSI.Berkeley.EDU (Andreas Stolcke) (10/25/90)

In article <10541@ccncsu.ColoState.EDU>, daveb@poa.NREL.ColoState.EDU (Dave Bigelow 491-5574) writes:
|> I have started a small documentation project which initially involves
|> placing some previously published troff documents (single pages up to
|> reports) into local `man' pages.  When I attempt to use the `catman'
|> utility however, equations and tables are not processed.  
|> [...]
|> Is there a patch available for the catman utility that comes with SUNOS4.1?
|> Has anyone solved this problem before?

I believe Sun has solved the problem for you already.  The man(7) page says:

  Conventions
     When formatting a manual page, man examines the  first  line
     to  determine  whether  it requires special processing.  For
     example a first line consisting of:
          '\" t

     indicates that the manual  page  must  be  run  through  the
     tbl(1) preprocessor.

Similarly, '\" et will invoke first eqn, then tbl.
This convention is honored by both man and catman.

-- 
Andreas Stolcke
International Computer Science Institute	stolcke@icsi.Berkeley.EDU
1957 Center St., Suite 600, Berkeley, CA 94704	(415) 642-4274 ext. 126