FWEB

A WEB system of structured documentation

for multiple languages

NOTE: Because of last-minute translation problems with texi2html operating on the macro-expanded version of fweb.texi, user-defined macro expansion has temporarily been turned off in this html version. Multitable is also giving trouble, as is @samp in section names. These are probably problems with texi2html; sorry for the inconvenience.

@FWEB{}

This Texinfo documentation describes @FWEB{} Version 1.61.

• To learn about new features of this version, see section Version 1.61.
• For a quick introduction to, and review of the structure of an @FWEB{} source file, see section The structure of a web.
• If you used to receive e-mail information about @FWEB{} but don't any longer, it's probably because you need to update your e-mail address in the fweb-users mailing list. Subscription instructions can be found in section SUPPORT.
• Bug reports and suggestions are much appreciated, but are no longer acknowledged individually. See section SUPPORT.
• The next major release, @FWEB{} Version 2.00, is planned for no earlier than January 1, 2000.

This documentation is now accessible on the World-Wide Web from

http://w3.pppl.gov/~krommes/fweb_toc.html.

Other sources of information about @FWEB{} are the archival files of the fweb-users and fweb-installers mailing lists. To learn how to obtain those, see section SUPPORT.

If you are learning @FWEB{} for the first time, you will probably find that this (unfinished) manual is not sufficiently pedagogical. For background, please refer to Knuth's book cited in section INTRODUCTION to @FWEB{}. You should also browse through section WEB CONCEPTS, in particular section The structure of a web.

• @FWEB{}
• @FWEB{} Copying Permissions
• INTRODUCTION to @FWEB{}
  • History of WEB and literate programming
  • Features of @FWEB{}
• WEB CONCEPTS
  • The @FWEB{} processors: @FWEAVE{} and @FTANGLE{}
  • The structure of a web
    • A simple example
    • The TeX part
    • The definition part
    • The code part
    • The limbo section
  • Modules
    • The unnamed module
    • Named modules
  • Phases of processing
    • The phases of @FTANGLE{}
    • The phases of @FWEAVE{}
• FILES
  • Input files
    • Automatic file-name completion
  • Output files
  • Change files
• RUNNING @FWEB{}
  • Command-line syntax
  • Command-line options
    • Negating options
    • `-1': Turn on brief debugging mode (@FWEAVE{})
    • `-2': Turn on verbose debugging mode (@FWEAVE{})
    • `-@': Display the control-code mappings
    • `-A': Turn on ASCII translations
    • `-B': Turn off audible beeps
    • `-b': Number blocks (@FWEAVE{})
    • `-C': Set the color mode
    • `-c': Set global language to C
    • `-c++': Set global language to C++
    • `-D': Display reserved words
    • `-d': Convert do...enddo
    • `-E': Change the delimiter of a file-name extension
    • `-e': Turn on automatic file-name completion
    • `-F': Compare output files with old versions (@FTANGLE{})
    • `-f': Turn off module references for identifiers (@FWEAVE{})
    • `-H': Scan C/C++ include files (@FWEAVE{})
    • `-h': Get help
    • `-I': Append to search list for include files
    • `-i': Don't print `@I' include files (@FWEAVE{})
    • `-i!': Don't read `@I' include files
    • `-j': Inhibit multiple includes
    • `-k': Don't recognize lower-case forms of keywords
    • `-L': Select global language
    • `-l': Echo input line
    • `-M': Set output message level
    • `-m': Define @FWEB{} macro (@FTANGLE{})
    • `-m4': Understand m4 built-in commands
    • `-m;': Append pseudo-semicolons
    • `-n': Set global language to FORTRAN--77
    • `-n9': Set global language to FORTRAN--90
    • `-n@;': Supply automatic pseudo-semicolons [FORTRAN]
    • `-n;': Supply automatic semicolons [FORTRAN]
    • `-n:': Put statement label on separate line [FORTRAN]
    • `-nb': Number ifs and dos [FORTRAN] (@FWEAVE{})
    • `-nC': Ignore single-line comments [FORTRAN]
    • `-np': Print semicolons [FORTRAN] (@FWEAVE{})
    • `-n\': Free-form syntax continued by backslash
    • `-n&': Free-form syntax continued by ampersand
    • `-n/': Recognize short comments [FORTRAN]
    • `-n!': Make `!' denote short comment [FORTRAN]
    • `-n)': Reverse array indices [FORTRAN] (@FTANGLE{})
    • `-o': Don't overload operators
    • `-q': Don't translate RATFOR
    • `-P': Select TeX processor
    • `-p': Buffer up a style-file entry
    • `-r': Set global language to RATFOR--77
    • `-r9': Set global language to RATFOR--90
    • `-rg': Set goto parameters
    • `-rk': Suppress comments about RATFOR translation (@FTANGLE{})
    • `-rK': Write comments about RATFOR translation (@FTANGLE{})
    • `-r@;': Turn on auto-semi mode using pseudo-semis [RATFOR]
    • `-r;': Turn on auto-semi mode using actual semis [RATFOR]
    • `-rb': Number ifs and dos [RATFOR]
    • `-r/': Recognize short comments [RATFOR]
    • `-r!': Make `!' denote short comment [RATFOR]
    • `-r)': Reverse array indices [RATFOR] (@FTANGLE{})
    • `-s': Print statistics
    • `-T': Flag-setting options for @FTANGLE{}
      • `-TD': Permit processing of deferred macro definitions
      • `-Tb': Permit built-functions to be redefined
      • `-Tm': Permit user macros to be redefined
      • `-Tv': Don't print header info
      • `-T%': Don't retain trailing comments (TeX)
      • `-T#': Don't insert `#line' command after `@%'
    • `-t': Truncate identifiers
    • `-U': Convert reserved output tokens to lower case (@FTANGLE{})
    • `-u': Undefine @FWEB{} macro (@FTANGLE{})
    • `-V': Print @FWEB{} version number
    • `-v': Make all comments verbatim (@FTANGLE{})
    • `-W': Flag-setting options for @FWEAVE{}
      • `-W@': Set module warning flag.
      • `-W1': Cross-reference single-character identifiers
      • `-W[': Process bracketed array indices
      • `-WH': Send additional arguments to the C preprocessor
      • `-WdfFlmvw': Don't print various things in woven output
    • `-w': Change name of macro package (@FWEAVE{})
    • `-x': Eliminate or reduce cross-reference information (@FWEAVE{}).
    • `-X': Print selected cross-reference information (@FWEAVE{})
    • `-y': Allocate dynamic memory
    • `-Z': Display default style-file parameters
    • `-z': Change name of style file
    • `-.': Don't recognize dot constants
    • `-\': Explicitly escape continued strings
    • `-(': Continue parenthesized strings with backslashes
    • `-:': Set starting automatic statement number
    • `->': Redirect output (@FTANGLE{})
    • `-=': Redirect output (@FTANGLE{})
    • `-#': Turn off comments about line and section numbers (@FTANGLE{})
    • `-+': Don't interpret compound assignment operators
    • `-/': Recognize short comments (FORTRAN & RATFOR)
    • `-!': Make `!' denote short comment (FORTRAN & RATFOR)
    • Information options
• @FWEB{} COMMANDS
  • Debugging commands
    • `@0': Turn off debugging
    • `@1': Display irreducible scraps
    • `@2': Display detailed reductions of the scraps
  • Literal control characters
    • `@@': The character `@'
    • `@|': Literal vertical bar, or optional line break
  • Beginning of section
    • `@ ': Begin minor section
    • `@*', `@*n': Begin major section
  • Beginning of code part
    • `@<': Begin module name
    • `@>': End module name
    • `@A': Begin code part of unnamed section
    • `@a': Begin code part of unnamed section, and mark
  • Control codes b--z
    • `@B': Suppress insertion of breakpoint command
    • `@b': Insert a breakpoint command
    • `@c': Set language to C
    • `@c++': Set language to C++
    • `@D': Define outer macro
    • `@d': Define outer macro, and mark
    • `@E': Treat next identifier as ordinary expression (@FWEAVE{})
    • `@f': Format identifier or module name
    • `@i': Include file (unconditional)
    • `@I': Include file (conditional)
    • `@K': Extract global RCS-like keyword
    • `@k': Access local RCS-like keyword
    • `@L': Set language
    • `@l': Specify limbo text
    • `@M': Define @FWEB{} macro
    • `@m': Define @FWEB{} macro, and mark
    • `@N': Turn on N mode
    • `@n': Set language to FORTRAN--77
    • `@n9': Set language to FORTRAN--90
    • `@O': Open output file (global scope)
    • `@o': Open output file (local scope)
    • `@q': Turn off module and line info locally
    • `@R': Treat next identifier as integer-like reserved
    • `@r': Set language to RATFOR--77
    • `@r9': Set language to RATFOR--90
    • `@u': Undefine outer macro
    • `@v': Overload operator
    • `@W': Overload identifier
    • `@x': Terminate ignorable material, or begin material to be changed
    • `@y': Begin change material
    • `@z': Begin ignorable material, or terminate change
  • Conversion to ASCII
    • `@'': Convert character to ASCII
    • `@"': Convert string to ASCII
  • Forward referencing
    • `@[': Mark as defined
  • Comments
    • `@/*': Begin long verbatim comment
    • `@//': Begin short verbatim comment
    • `@%': Ignorable comment
    • `@?': Begin compiler directive
    • `@(': Begin meta-comment
    • `@)': End meta-comment
  • Special left brace
  • Index entries
    • `@_': Force index entry to be underlined
    • `@-': Delete index entry
    • `@+': Force index entry
    • `@^': Make index entry (Roman type)
    • `@.': Make index entry (typewriter type)
    • `@9': Make index entry (user-defined format)
  • Control text
    • `@t': Put control text into a TeX \hbox (@FWEAVE{})
    • `@=': Pass control text verbatim to the output
  • Spacing
    • `@,': Insert a thin space
    • `@/': Force a line break, preserving indentation.
    • `@\': Force a line break, then indent
    • `@|': Literal vertical bar, or optional line break
    • `@#': Blank line
    • `@~': Cancel line break
    • `@&': Join items
  • Pseudo (invisible) operators
    • `@e': Pseudo-expression
    • `@;': Pseudo-semicolon
    • `@:': Pseudo-colon
  • Miscellaneous commands
    • `@!': Inhibit macro expansion
• COMMENTING STYLES
  • Invisible comments
  • Visible comments
  • Temporary comments
• MACROS and PREPROCESSING
  • Outer macros
  • @FWEB{} macros
    • Various features of @FWEB{} macros
      • @FWEB{} macros with variable arguments
      • Recursion
      • Protecting macros against redefinition
    • Special tokens
      • ANSI C-compatible tokens
      • Extensions to ANSI C macro syntax
    • Built-in functions
      • Strings and quotes
      • Redefining built-in functions
      • $A: Convert to ASCII
      • $ABS: Absolute value
      • $ASSERT: Assert a condition
      • $AUTHOR: Value of RCS global keyword Author
      • $COMMENT: Generate a comment
      • $DATE: Today's date
      • $DATE_TIME: Value of RCS global keyword Date
      • $DAY: The day
      • $DECR: Decrement a macro
      • $DEFINE: Deferred macro definition
      • $DO: Macro do loop
      • $DUMPDEF: Dump macro definitions to the terminal
      • $E: Base of the natural logarithms
      • $ERROR: Send error message to output
      • $EVAL: Evaluate a macro expression
      • $EXP: Exponential function
      • $GETENV: Get value of environment variable
      • $HEADER: Value of RCS global keyword Header
      • $HOME: The user's home directory
      • $ID: Value of RCS global keyword Id
      • $IF: Two-way conditional
      • $IFCASE: n-way conditional
      • $IFDEF: Two-way conditional
      • $IFNDEF: Two-way conditional
      • $IFELSE: Two-way conditional
      • $INCR: Increment a macro
      • $INPUT_LINE: Line number that begins current section
      • $KEYWORD: Value of global RCS-like keyword
      • $L: Change to lower case
      • $L_KEYWORD: Value of local RCS-like keyword
      • $LANGUAGE: Identifier for current language
      • $LANGUAGE_NUM: Number of current language
      • $LEN: Length of string
      • $LOCKER: Value of RCS global keyword Locker
      • $LOG: Natural logarithm
      • $LOG10: Logarithm to the base 10
      • $M: Define a deferred macro
      • $MAX: Maximum of a list
      • $MIN: Minimum
      • $MODULE_NAME: Name of present web module
      • $MODULES: Total number of independent modules
      • $NAME: Value of RCS global keyword Name
      • $OUTPUT_LINE: Current line number of tangled output
      • $P: The C preprocessor symbol
      • $PI: Pi
      • $POW: Exponentiation
      • $PP: The C preprocessor symbol
      • $RCSFILE: Value of RCS global keyword $RCSfile
      • $REVISION: Value of RCS global keyword Revision
      • $ROUTINE: Current function (RATFOR only)
      • $SECTION_NUM: Number of current @FWEB{} section
      • $SECTIONS: Maximum section number
      • $SOURCE: Value of RCS global keyword Source
      • $SQRT: Square root
      • $STATE: Value of RCS global keyword State
      • $STRING: Expand, then stringize
      • $STUB: Trap for missing module
      • $TIME: The time
      • $TRANSLIT: Transliteration
      • $U: Change to upper case
      • $UNDEF: Undefine a macro
      • $UNQUOTE: Remove quotes from string
      • $UNSTRING: Convert string into characters
      • $VERBATIM: (Obsolete)
      • $VERSION: Present @FWEB{} version number
    • Debugging with macros
  • Preprocessing
• LANGUAGES
  • Setting the language
  • Special hints and considerations for each language
    • Special considerations for C
    • Special considerations for C++
    • Special considerations for FORTRAN
      • Items for both FORTRAN-77 and FORTRAN-90
      • Items specific to FORTRAN-77 and fixed-form FORTRAN-90
      • Items specific to FORTRAN-90
    • Special considerations for RATFOR
    • Special considerations for TeX
    • Special considerations for the VERBATIM language
• RATFOR
  • RATFOR syntax
  • RATFOR commands
    • RATFOR--77 commands
    • Additional RATFOR--90 commands
  • Caveats about RATFOR
• DOCUMENTATION
  • Typesetting
    • @FWEAVE{}'s OUTPUT
    • The macro package `fwebmac.sty'
      • User macros
      • Fonts
    • LaTeX support
      • LaTeX's document class
      • Using REVTeX
      • LaTeX packages related to @FWEB{}
      • Sections in LaTeX
      • LaTeX's index.
      • LaTeX's Table of Contents
      • Customizing LaTeX's output
    • Page references
    • Page headers
    • Section numbering schemes
      • Package fwebinsert: Inserting @FWEAVE{}'s output into a LaTeX document
  • Pretty-printing
    • Pseudo-operators
    • Alternatives for various input tokens
    • Overloading operators and identifiers
      • Overloading operators
      • Overloading identifiers
• @FWEB{}'s INDEX.
  • @FWEB{}'s self-generated index
  • Creating a stand-alone index with makeindex
    • Creating a stand-alone index: Summary
    • Creating a stand-alone index: Details
  • Using the idxmerge utility to merge indexes
    • Using idxmerge: Summary
    • Using idxmerge: Details
• CUSTOMIZATION
  • Environment variables
  • Initialization
    • The initialization file
    • Memory allocation
      • `-yb': Maximum bytes for identifiers, index entries, and module names
      • `-ybs': Size of the change buffer, in bytes
      • `-ycb': Size of line buffer for C output, in bytes
      • `-ycf': Size of a Ratfor buffer, in bytes
      • `-ycg': Size of another Ratfor buffer, in bytes
      • `-yd': Increment for expanding the dots table
      • `-ydt': Maximum number of deferred macro tokens
      • `-ydx': Maximum number of deferred macro texts
      • `-yid': Maximum depth of file inclusion
      • `-yif': Maximum number of unique include-file names
      • `-ykt': Stack size for @FTANGLE{}
      • `-ykw': Stack size for @FWEAVE{}
      • `-yll': Line length for @FWEAVE{}'s output, in bytes
      • `-yln': Maximum length of module names or strings, in bytes
      • `-ylb': Maximum number of nested loops in RATFOR
      • `-ylx': Maximum length of expressions that can be expanded with the post-increment operators of FORTRAN or RATFOR
      • `-ym': Maximum number of sections
      • `-yma': Maximum number of arguments to @FWEB{} macros
      • `-ymb': Size of the buffer for expanding @FWEB{} macros
      • `-yn': Maximum number of identifiers and module names
      • `-ynf': Maximum number of open output files
      • `-yop': Maximum number of entries in the table for operator overloading.
      • `-yr': Maximum number of cross-references
      • `-ys': Maximum number of scraps
      • `-ysb': Size of style-file input-line buffer
      • `-ytt': Maximum number of tokens that @FTANGLE{} can process
      • `-ytw': Maximum tokens in the current section being processed by @FWEAVE{}.
      • `-yx': Maximum number of texts
      • `-yxb': Size of line buffer for TeX and verbatim output
  • The Style file
    • Customizing @FWEAVE{}'s index
      • index.???
      • delim_?
      • group_skip
      • item_0
      • language.???
      • lethead.???
      • underline.???
    • Customizing the module list
    • Customizing the Table of Contents
    • Customizing cross-reference subscripts
    • Customizing the behavior of `fwebmac.sty' macros
      • format.???
      • indent.???
      • LaTeX.???
    • Remapping control codes
    • Color output
    • Miscellaneous style-file parameters
      • ASCII_Fcn
      • cchar
      • cdir_start
      • line_char.l (@FTANGLE{})
      • line_length.l (@FTANGLE{})
      • meta.???.?, meta.???.hdr.? (@FTANGLE{})
      • outer.???
      • protect.?
      • suffix.?
      • macros
      • limbo.begin, limbo.end
      • meta.??? (@FWEAVE{})
      • preamble.???
      • dot_constant.???.?
      • null_file
    • Automatic file name completion
• USAGE TIPS and SUGGESTIONS
  • Converting an existing code to @FWEB{}
  • Programming tips and other suggestions
  • Features for scientific programming
• NEW FEATURES
  • Version 1.61
    • Updates to documentation (v1.61)
    • Redefined commands (v1.61)
    • New features (v1.61)
    • Significant bugs (v1.61)
  • Version 1.53
  • Version 1.52
  • Version 1.50
  • Version 1.40
• SUPPORT
• Installing @FWEB{}
• Concept index
• Option and command index
• Parameter index

This document was generated on 17 November 1998 using the texi2html translator version 1.54.