home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d5xx / d551 / cweb.lha / CWeb / cweb.man next >
Text File  |  1991-10-28  |  4KB  |  133 lines
  1.  
  2.      WEB(1L)                        7/12/90                         WEB(1L)
  3.  
  4.  
  5.  
  6.      ›1mNAME 
  7.           ›0mctangle, cweave - translate CWEB to C and/or TeX 
  8.  
  9.      ›1mSYNOPSIS 
  10.           ctangle ›0m[ -›1mbhp ›0m] [ +›1ms ›0m] webfile[.w] [changefile[.ch]] 
  11.           ›1mcweave ›0m[ -›1mbfhpx ›0m] [ +›1mags ›0m] webfile[.w] [changefile[.ch]] 
  12.  
  13.  
  14.      ›1mDESCRIPTION 
  15.           ›0mThe ›3mctangle ›0mprogram converts a CWEB source document into a C
  16.           program that  may  be compiled in the usual way.  The output
  17.           file includes #line specifications so that debugging can  be
  18.           done in terms of the CWEB source file.  
  19.  
  20.                The  ›3mcweave  ›0mprogram converts the same CWEB file into a
  21.           TeX file that may be formatted  and  printed  in  the  usual
  22.           way.   It takes appropriate care of typographic details like
  23.           page layout and the use of indentation,  italics,  boldface,
  24.           etc.,and  it supplies extensive cross-index information that
  25.           it gathers automatically.  
  26.  
  27.                CWEB allows you to prepare a single document containing
  28.           all the  information  that  is  needed  both  to  produce  a
  29.           compilable   C  program  and  to  produce  a  well-formatted
  30.           document describing the program in as  much  detail  as  the
  31.           writer may  desire.    The user of CWEB ought to be familiar
  32.           with TeX as well as C.  
  33.  
  34.                The command line should have either one or two names on
  35.           it.  The first is taken as the CWEB file (and .w is added if
  36.           there is no extension).  If that file cannot be opened,  the
  37.           extension .web is tried instead.  If there is a second name,
  38.           it  is  a  change  file  (and  .ch  is  added if there is no
  39.           extension).  The change file  overrides  parts  of  the  WEB
  40.           file, as described in the documentation.  
  41.  
  42.                Options  in  the  command line may be either turned off
  43.           with - (if they are on by default) or turned on with  +  (if
  44.           they are  off  by  default).    In  fact,  the  options  are
  45.           processed from left to right,  so  a  sequence  like  -f  +f
  46.           corresponds to +f (which is the default).  
  47.  
  48.                The  -›1mb  ›0moption  shows  a banner line on your terminal.
  49.           The -›1mh ›0moption shows a happy message if  the  processing  was
  50.           successful.   The  -›1mp ›0moption shows progress reports (starred
  51.           module numbers) as the processing takes place.  If  you  say
  52.           -bhp, you get nothing but error messages.  
  53.  
  54.                The  +›1ms  ›0moption prints statistics about memory usage at
  55.           the end of a run  (assuming  that  the  programs  have  been
  56.           compiled with the -DSTAT switch).  
  57.  
  58.                There  are two other options applicable to ›3mcweave ›0monly:
  59.           -›1mf ›0mmeans do not force a newline after every statement in the
  60.           formatted output.  -›1mx ›0mmeans omit  the  index  and  table  of
  61.           contents.  
  62.  
  63.  
  64.  
  65.                                       -1-
  66.  
  67.  
  68.      WEB(1L)                        7/12/90                         WEB(1L)
  69.  
  70.  
  71.                In  addition  to  these  options  the  Amiga version of
  72.           ›3mcweave ›0mhas two more options: +›1ma ›0mcauses  Amiga-specific  type
  73.           identifiers to  be  recognized as keywords (e.g. UWORD).  +›1mg
  74.           ›0mmeans that the german CWEB macros should be used instead  of
  75.           the english ones.  
  76.  
  77.                The  output C and TeX file names are formed by using .c
  78.           and .tex as extensions of the WEB file name.  
  79.  
  80.  
  81.      ›1mFILES 
  82.           ›0mcweb/cwebmac.tex: TeX macros used by cweave output.  
  83.           amiga/cwebmacg.tex: German TeX macros for cweave output.  
  84.           cweb/cwebman.tex: The user manual.  
  85.           cweb/examples/wc.w: An introductory example.  
  86.  
  87.      ›1mSEE ALSO 
  88.           ›0m›3mLiterate Programming ›0mby D.E. Knuth.  
  89.           ›3mWeaving a Program ›0mby Wayne Sewell 
  90.           tex(1), cc(1), web(1) 
  91.  
  92.      ›1mAUTHORS 
  93.           ›0mDon Knuth wrote WEB for TeX and Pascal. Silvio Levy designed
  94.           and developed CWEB by adapting the WEB conventions to C  and
  95.           by recoding everything in CWEB.  
  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.  
  130.  
  131.                                       -2-
  132.  
  133.