home *** CD-ROM | disk | FTP | other *** search
/ NetNews Usenet Archive 1992 #20 / NN_1992_20.iso / spool / comp / unix / misc / 3560 < prev    next >
Encoding:
Text File  |  1992-09-08  |  2.7 KB  |  78 lines
  1. Newsgroups: comp.unix.misc
  2. Path: sparky!uunet!usc!sol.ctr.columbia.edu!eff!news.oc.com!convex!tchrist
  3. From: Tom Christiansen <tchrist@convex.COM>
  4. Subject: Re: man macro manual?
  5. Originator: tchrist@pixel.convex.com
  6. Sender: usenet@news.eng.convex.com (news access account)
  7. Message-ID: <1992Sep7.235156.273@news.eng.convex.com>
  8. Date: Mon, 7 Sep 1992 23:51:56 GMT
  9. Reply-To: tchrist@convex.COM (Tom Christiansen)
  10. References: <Bu6z2u.3tq@mtholyoke.edu> <1992Sep7.101314.3759@ericsson.se> <1992Sep7.211517.26876@tous.oau.org>
  11. Nntp-Posting-Host: pixel.convex.com
  12. Organization: Convex Computer Corporation, Colorado Springs, CO
  13. X-Disclaimer: This message was written by a user at CONVEX Computer
  14.               Corp. The opinions expressed are those of the user and
  15.               not necessarily those of CONVEX.
  16. Lines: 60
  17.  
  18. From the keyboard of rbt@tous.oau.org (Robert B. Tate):
  19. :This is really LESS than usefull! If you already know what man is and how
  20. :to use it, it will remind you, but what about HOW to USE the macros in
  21. :the tmac.an? What do they mean? Where to use them? What order to do a
  22. :proper man page? Not all of use are experts in roff macros!
  23.  
  24. .TH NAME SECTION 
  25. .\" NAME should be all caps, SECTION should be 1-8, maybe w/ subsection
  26. .\" other parms are allowed: see man(7)
  27. .SH NAME
  28. foo, bar \- programs to do something
  29. .SH SYNOPSIS
  30. a short usage summary
  31. .SH DESCRIPTION
  32. long drawn out discussion of the program.  it's a good idea
  33. to break this up into subsections using the .SS macros, like
  34. .SS "Section Selection"
  35. .SS "Online Problem Reports"
  36. .SH OPTIONS
  37. Some people make this separate from the description.
  38. .SH "RETURN VALUE"
  39. What the program or function returns if successful.
  40. .SH ERRORS
  41. Return codes, either exit status or errno settings.
  42. .SH EXAMPLES
  43. give some example uses of the program
  44. .SH ENVIRONMENT
  45. envariables this program might care about
  46. .SH FILES
  47. all files used by the program.  typical usage is like this:
  48. .br
  49. .nf
  50. .\" set tabstop to longest possible filename, plus a bit
  51. .ta \w'/usr/lib/perl/getopts.pl   'u
  52. \fI/usr/man\fR  default man tree
  53. \fI/usr/man/man*/*.*\fR unformatted (nroff source) man pages
  54. .SH "SEE ALSO"
  55. other man pages to check out, like man(1), man(7), makewhatis(8), catman(8)
  56. .SH NOTES
  57. miscellaneous commentary
  58. .SH CAVEATS
  59. things to take special care with.  sometimes called WARNINGS.
  60. .SH DIAGNOSTICS
  61. all the possible error messages the program can print out, and
  62. what they mean.
  63. .SH BUGS
  64. things that are broken
  65. .SH RESTRICTIONS
  66. bugs you don't plan to fix :-)
  67. .SH AUTHOR
  68. who wrote it (or AUTHORS if multiple)
  69. .SH HISTORY
  70. programs derived from other sources sometimes have this.
  71.  
  72.  
  73. -- 
  74.     Tom Christiansen      tchrist@convex.com      convex!tchrist
  75.  
  76.  
  77. Every absurdity has a champion who will defend it.
  78.