home *** CD-ROM | disk | FTP | other *** search
/ Amiga Developer CD v1.2 / amidev_cd_12.iso / devcon / milan_1991 / devcon91.3 / debug / devel / autodoc.doc < prev    next >
Text File  |  1992-09-01  |  2KB  |  55 lines
  1. .Autodoc - August 21 1989
  2.  
  3. NAME 
  4.     autodoc - Extracts and sorts autodocs from the given files to stdout.
  5.  
  6. SYNOPSIS
  7.     autodoc [ -tnum ] [ -i ] [ -a ] [ -s ] [ -C ] [ -lnum ] [ -w ]
  8.     [ -c ] [ -f ] [ -r ] [ -Ffile ] [ -I ] file1 [file2] [...]
  9.  
  10. DESCRIPTION
  11.     autodoc extracts autodocs from files "file1", "file2", ... 
  12.     Sorts the output to stdout.
  13.  
  14.     Options offered by autodoc are the following:
  15.  
  16.     -tnum    Convert tabs into num spaces.
  17.     -i    Extract ONLY internal autodocs (autodocs that have an 'i' 
  18.         as the 6th character in a line that begins an autodoc).
  19.     -a    Process autodocs that begin with asterisk in the first column.
  20.     -s    Process autodocs that begin with semicolon in the first column.
  21.     -C    Process autodocs in C language form.
  22.     -lnum    Set the line length to num. (default = 78 chars).
  23.     -w    Turn off word wrap. Chop lines longer than line length.
  24.     -c    Convert C comments. From backslash asterisk to slash asterisk.
  25.         This allows comments in autodocs without nesting comments.
  26.     -f    Disable form feeds between autodoc entries.
  27.     -r    Output autodocs in troff format (currently not implemented).
  28.     -Ffile  Use the file 'file' as the temporary file. (default = tmpfile).
  29.     -I    Include a TABLE OF CONTENTS as the first part of the output.
  30.  
  31.  
  32. USAGE
  33.  
  34.     autodoc sends formatted file to standard output. User could redirect
  35.     this output to a file.
  36.  
  37.         autodoc file1 > file2
  38.  
  39.  
  40.     Ex. to extract ALL possible autodocs except internal autodocs and print
  41.     with a table of contents.
  42.  
  43.         autodoc -a -s -C -I file1 > outfile 
  44.  
  45.     This filter must be used only with text files.
  46.  
  47.  
  48. SEE ALSO
  49.  
  50.  
  51. AUTHOR
  52.  
  53.     Bill Koester
  54.  
  55.