home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / utilities / text / man36.lha / Man3.6 / ManPages / Template < prev    next >
Encoding:
Text File  |  1995-02-13  |  1.2 KB  |  67 lines
  1.  
  2. NAME
  3.  
  4.     <<The name of the program>>
  5.  
  6.  
  7. FORMAT
  8.  
  9.     <<Fill in the format of the Shell command like:
  10.       ASSIGN [<name>:{dir}] [LIST] [EXISTS] [DISMOUNT] [DEFER] [PATH].
  11.       If the program only works from Workbench, insert ONLY WORKBENCH.
  12.       Additionally you can add the template, which is given if you 
  13.       type '<name> ?' in your Shell.>>
  14.  
  15.  
  16. TOOLTYPES
  17.  
  18.     <<Use this template for a program that supports
  19.     tool types, else insert NONE.>>
  20.  
  21.  
  22. PURPOSE
  23.  
  24.     <<1 or 2 sentences that describe the program>>
  25.  
  26.  
  27. SPECIFICATION
  28.  
  29.     <<Give detailed information about the program's sense, results,
  30.       and the possibilities to break it.>>
  31.  
  32.  
  33. OPTIONS
  34.  
  35.     <<Give detailed information about every command line option
  36.       and every tool type.>>
  37.  
  38.  
  39. EXAMPLE
  40.  
  41.     <<If neccessary, give one or two examples using options of the
  42.       program.>>
  43.  
  44.  
  45. BUGS
  46.  
  47.     <<Did you find any bugs?  What were they?  Did you discuss them with
  48.       the author/company?  Are patches or workarounds available?>>
  49.  
  50.  
  51. AUTHOR
  52.  
  53.     <<Insert name, address, and e-mail address of the author.>>
  54.  
  55.  
  56. COPYRIGHT NOTICE
  57.  
  58.     This man page was written by:
  59.  
  60.     <<Please insert your name, address, and e-mail address->>
  61.  
  62.  
  63. SEE ALSO
  64.  
  65.     <<Fill in other program´s names which are related to the program
  66.       you describe.>>
  67.