home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 2 / FFMCD02.bin / new / dev / misc / cweb / cweb.man < prev    next >
Text File  |  1993-12-21  |  4KB  |  131 lines
  1.  
  2.  
  3. CWEB(1L)                   Unix Programmer's Manual                   CWEB(1L)
  4.  
  5.  
  6. NAME
  7.      ctangle, cweave - translate CWEB to C and/or TeX
  8.  
  9. SYNOPSIS
  10.      ctangle [ -bhp ] [ +s ] webfile[.w] [changefile[.ch]] [outputfile[.c]]
  11.      cweave [ -bfhpx ] [ +s ] webfile[.w] [changefile[.ch]] [outputfile[.tex]]
  12.  
  13.  
  14. DESCRIPTION
  15.      The ctangle program converts a CWEB source document into a C program that
  16.      may  be  compiled  in  the  usual  way.   The  output file includes #line
  17.      specifications so that debugging can be done in terms of the CWEB  source
  18.      file.
  19.  
  20.      The cweave program converts the same CWEB file into a TeX file  that  may
  21.      be  formatted and printed in the usual way.  It takes appropriate care of
  22.      typographic details like page layout and the use of indentation, italics,
  23.      boldface, etc., and it supplies extensive cross-index information that it
  24.      gathers automatically.
  25.  
  26.      CWEB  allows  you  to  prepare  a  single  document  containing  all  the
  27.      information  that is needed both to produce a compilable C program and to
  28.      produce a well-formatted document  describing  the  program  in  as  much
  29.      detail  as  the writer may desire.  The user of CWEB ought to be familiar
  30.      with TeX as well as C.
  31.  
  32.      The command line should have one, two, or three names on it.   The  first
  33.      is  taken as the CWEB file (and .w is added if there is no extension). If
  34.      that file cannot be opened, the extension .web is tried instead. (But  .w
  35.      is recommended, since .web usually implies Pascal.)  If there is a second
  36.      name, it is a change file (and .ch is added if there  is  no  extension).
  37.      The  change  file  overrides  parts  of the WEB file, as described in the
  38.      documentation. If there is a third name, it overrides the default name of
  39.      the  output  file,  which is ordinarily the same as the name of the input
  40.      file (but on the current directory) with the extension .c or .tex.
  41.  
  42.      Options in the command line may be either turned off with - (if they  are
  43.      on by default) or turned on with + (if they are off by default). In fact,
  44.      the options are processed from left to right, so a sequence  like  -f  +f
  45.      corresponds to +f (which is the default).
  46.  
  47.      The -b option suppresses the banner line that normally  appears  on  your
  48.      terminal  when  ctangle  or  cweave  begins. The -h option suppresses the
  49.      happy message that normally appears if the processing was successful. The
  50.      -p  option  suppresses  progress  reports (starred module numbers) as the
  51.      processing takes place. If you  say  -bhp,  you  get  nothing  but  error
  52.      messages.
  53.  
  54.      The +s option prints statistics about memory usage at the end  of  a  run
  55.      (assuming that the programs have been compiled with the -DSTAT switch).
  56.  
  57.      There are two other options applicable to cweave only:  -f means  do  not
  58.      force  a newline after every statement in the formatted output.  -x means
  59.      omit the index and table of contents.
  60.  
  61.  
  62.  
  63.  
  64.                                    6/15/92                                   1
  65.  
  66.  
  67.  
  68. CWEB(1L)                   Unix Programmer's Manual                   CWEB(1L)
  69.  
  70.  
  71. FILES
  72.      /usr/local/lib/tex/inputs/cwebmac.tex   TeX macros used by cweave output.
  73.      /usr/local/src/cweb/cwebman.tex      The user manual.
  74.      /usr/local/src/cweb/examples/wc.w   An introductory example.
  75.      /usr/local/lib/cweb    Directory for cweb "include" files.
  76.  
  77. SEE ALSO
  78.      Literate Programming by D.E. Knuth.
  79.      Weaving a Program by Wayne Sewell
  80.      tex(1), cc(1)
  81.  
  82. AUTHORS
  83.      Don Knuth wrote  WEB  for  TeX  and  Pascal.  Silvio  Levy  designed  and
  84.      developed  CWEB  by  adapting  the  WEB  conventions to C and by recoding
  85.      everything in CWEB.  Knuth began using CWEB and made further refinements.
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                    6/15/92                                   2
  130.  
  131.