home *** CD-ROM | disk | FTP | other *** search
/ NetNews Usenet Archive 1992 #20 / NN_1992_20.iso / spool / comp / unix / misc / 3569 < prev    next >
Encoding:
Text File  |  1992-09-08  |  2.4 KB  |  69 lines
  1. Path: sparky!uunet!gatech!bloom-beacon!eru.mt.luth.se!lunic!sunic!ericom!eos.ericsson.se!etxmesa
  2. From: etxmesa@eos.ericsson.se (Michael Salmon)
  3. Newsgroups: comp.unix.misc
  4. Subject: Re: man macro manual?
  5. Message-ID: <1992Sep8.070255.2425@ericsson.se>
  6. Date: 8 Sep 92 07:02:55 GMT
  7. References: <Bu6z2u.3tq@mtholyoke.edu> <1992Sep7.101314.3759@ericsson.se> <1992Sep7.211517.26876@tous.oau.org>
  8. Sender: news@ericsson.se
  9. Reply-To: etxmesa@eos.ericsson.se (Michael Salmon)
  10. Organization: Ericsson Telecom AB
  11. Lines: 55
  12. Nntp-Posting-Host: eos6c02.ericsson.se
  13.  
  14. In article <1992Sep7.211517.26876@tous.oau.org>, 
  15. rbt@tous.oau.org (Robert B. Tate) writes:
  16. |> In article <1992Sep7.101314.3759@ericsson.se> 
  17. |> etxmesa@eos.ericsson.se (Michael Salmon) writes:
  18. |> >In article <Bu6z2u.3tq@mtholyoke.edu>, 
  19. |> >jbotz@mtholyoke.edu (Jurgen Botz) writes:
  20. |> >|> Where can I find a manual for the tmac.an macros?  Does it exist or
  21. |> >|> is being able to figure them out a requirement for being qualified
  22. |> >|> to write man pages?
  23. |> >
  24. |> >Try:
  25. |> > eos6c02 ~ 43 > man 7 man
  26. [...]
  27. |> This is really LESS than usefull! If you already know what man is and how
  28. |> to use it, it will remind you, but what about HOW to USE the macros in
  29. |> the tmac.an? What do they mean? Where to use them? What order to do a
  30. |> proper man page? Not all of use are experts in roff macros!
  31.  
  32. From the same manual page:
  33.  
  34.      A typical manual page for a SunOS  command  or  function  is
  35.      laid out as follows:
  36.  
  37.      .TH TITLE [1-8]
  38.           The name of the  command  or  function  in  upper-case,
  39.           which  serves as the title of the manual page.  This is
  40.           followed by the number  of  the  section  in  which  it
  41.           appears.
  42.  
  43.      .SH NAME The name, or list of names, by which the command is
  44.           called,  followed by a dash and then a one-line summary
  45.           of the action performed.  All in roman font, this  sec-
  46.           tion  contains  no troff(1) commands or escapes, and no
  47.           macro requests.  It is used to generate  the  whatis(1)
  48.           database.
  49.  
  50.      .SH SYNOPSIS
  51.  
  52.           Commands:
  53.  
  54. Please read what I typed, "man 7 man" note that I read from section 7,
  55. not section 1 which is where the man command is to be found. If you
  56. don't understand the manual sections then I suggest you try "man man"
  57. or "man intro" before trying to write a manual page.
  58.  
  59. -- 
  60.  
  61. Michael Salmon
  62.  
  63. #include    <standard.disclaimer>
  64. #include    <witty.saying>
  65. #include    <fancy.pseudo.graphics>
  66.  
  67. Ericsson Telecom AB
  68. Stockholm
  69.