1.3 Manual Generation

The MonetDB code base is a large collection of files, scattered over the system modules. Each source file is written in a literal programming style, which physically binds documentation with the relevant code sections. The utility program Mx processes the files marked *.mx to extract the code sections for system compilation or to prepare for a pretty printed listing.

The reference manual is based on Texinfo formatted documentation to simplify generation for different rendering platforms. The components for the reference manual are extracted by

     Mx -i -B -H1 <filename>.mx

which generates the file <filename>.bdy.texi. These pieces are collected and glued together in a manual framework, running makeinfo to produce the desired output format. The Texinfo information is currently limited to the documentation, it could also be extended to process the code.

A printable version of an *.mx file can be produced using the commands:

     Mx  <filename>.mx
     pdflatex <filename>.tex

The typographical conventions used in this manual are straightforward. Monospaced text is used to designate names in the code base and examples. Italics is used in explanations to indicate where a user supplied value should be substituted.

Snippets of code are illustrated in small caps font. The interaction with textual client interfaces uses the default prompt-setting of the underlying operating system.

Keywords in the MonetDB interface languages are case sensitive; SQL keywords are not case sensitive. No distinction is made in this manual.