home *** CD-ROM | disk | FTP | other *** search
/ Otherware / Otherware_1_SB_Development.iso / amiga / utility / text / tex31.lzh / TeX / man / weave.doc < prev   
Encoding:
Text File  |  1990-12-21  |  3.8 KB  |  133 lines
  1.  
  2.  
  3.  
  4. WEB(1)                   USER COMMANDS                     WEB(1)
  5.  
  6.  
  7.  
  8. NAME
  9.      tangle, weave - translate WEB to Pascal and/or TeX
  10.  
  11. SYNOPSIS
  12.      tangle webfile[.web] [changefile[.ch]]
  13.      weave [-x] webfile[.web] [changefile[.ch]]
  14.  
  15. DESCRIPTION
  16.      The tangle program converts a WEB  source  document  into  a
  17.      Pascal  program  that  may be compiled in the usual way with
  18.      the on-line Pascal compiler (e.g., pc(1)).  The output  file
  19.      is  all in lower case and packed into lines of 72 characters
  20.      or less, with the only concession to readability  being  the
  21.      termination  of  lines  at  semicolons when this can be done
  22.      conveniently.
  23.  
  24.      The WEB language allows you to  prepare  a  single  document
  25.      containing  all  the information that is needed both to pro-
  26.      duce a compilable Pascal program  and  to  produce  a  well-
  27.      formatted  document describing the program in as much detail
  28.      as the writer may desire.  The user of WEB must be  familiar
  29.      with  both  TeX  and Pascal.  WEB also provides a relatively
  30.      simple, although adequate, macro  facility  that  permits  a
  31.      Pascal  program  to  be  written  in small easily-understood
  32.      modules.
  33.  
  34.      The command line should have either one or two names on  it.
  35.      The  first  is  taken  as the WEB file (and .web is added if
  36.      there is no extension).  If there is another name, it  is  a
  37.      change  file  (and  .ch  is added if there is no extension).
  38.      The  change  file  overrides  parts  of  the  WEB  file,  as
  39.      described in the WEB system documentation.
  40.  
  41.      The output files are a Pascal file and a string  pool  file,
  42.      whose  names  are formed by adding .p and .pool respectively
  43.      to the root of the WEB file name.
  44.  
  45.      The weave program is used to create a TeX file  for  viewing
  46.      the  WEB  program.  It takes appropriate care of typographic
  47.      details like page layout and the use of  indentation,  ital-
  48.      ics,  boldface,  etc., and it supplies extensive cross-index
  49.      information that it gathers automatically.  The command line
  50.      arguments  are the same as for tangle except for the option:
  51.      -x says to omit the index, module name list,  and  table  of
  52.      contents  pages.  (A CONTENTS.tex file will still be written
  53.      when the TeX file is processed, however, unless some  macros
  54.      in webmac.tex are redefined.)
  55.  
  56.      The output TeX file name is formed by  adding  .tex  to  the
  57.      root of the WEB file name.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                       Last change: 5/27/90                      1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. WEB(1)                   USER COMMANDS                     WEB(1)
  71.  
  72.  
  73.  
  74.      There are several macros that probably should  be  redefined
  75.      by the programmer at the beginning of the WEB file.  It is a
  76.      good idea to set \title to the name of the program.  And, to
  77.      cause   output   of   only  changed  modules,  one  can  say
  78.      \let\maybe=\iffalse (usually as  the  first  change  in  the
  79.      change file).
  80.  
  81. FILES
  82.      TeX:inputs/webmac.tex   TeX macros used by weave output.
  83.  
  84. SEE ALSO
  85.      The   WEB   System   of   Structured    Documentation    and
  86.      LiterateProgramming, by D.E. Knuth.
  87.      WeavingaProgram, by Wayne Sewell
  88.      tex(1), pc(1)
  89.      pxp(1) (for formatting tangle output when debugging)
  90.      TeX: The Program and METAFONT: The Program,volumesBandD Com-
  91.      puters  and Typesetting series, published by Addison-Wesley,
  92.      are by far the largest extant examples of WEB programs.
  93.  
  94. AUTHORS
  95.      WEB was designed by Donald E. Knuth,  based  on  an  earlier
  96.      system called DOC (implemented by Ignacio Zabala).  The tan-
  97.      gle and weave programs are themselves written  in  WEB.  The
  98.      system  was  originally ported to Unix at Stanford by Howard
  99.      Trickey, and at Cornell by Pavel Curtis.
  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.                       Last change: 5/27/90                      2
  130.  
  131.  
  132.  
  133.