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