1COQ-TEX(1)                  General Commands Manual                 COQ-TEX(1)
2
3
4

NAME

6       coq-tex - Process Coq phrases embedded in LaTeX files
7
8

SYNOPSIS

10       coq-tex  [ -o output-file ] [ -n line-width ] [ -image coq-image ] [ -w
11       ] [ -v ] [ -sl ] [ -hrule ] [ -small ] input-file ...
12
13
14

DESCRIPTION

16       The coq-tex filter extracts Coq phrases embedded in LaTeX files, evalu‐
17       ates them, and insert the outcome of the evaluation after each phrase.
18
19       Three  LaTeX environments are provided to include Coq code in the input
20       files:
21
22       coq_example
23              The phrases between  \begin{coq_example}  and  \end{coq_example}
24              are  evaluated  and  copied into the output file. Each phrase is
25              followed by the response of the toplevel loop.
26
27       coq_example*
28              The phrases between \begin{coq_example*} and  \end{coq_example*}
29              are  evaluated and copied into the output file. The responses of
30              the toplevel loop are discarded.
31
32       coq_eval
33              The phrases  between  \begin{coq_eval}  and  \end{coq_eval}  are
34              silently  evaluated.  They  are not copied into the output file,
35              and the responses of the toplevel loop are discarded.
36
37       The resulting LaTeX code is stored in the file file.v.tex if the  input
38       file  has a name of the form file.tex, otherwise the name of the output
39       file is the name of the input file with `.v.tex' appended.
40
41       The files produced by coq-tex can be directly processed by LaTeX.  Both
42       the Coq phrases and the toplevel output are typeset in typewriter font.
43
44

OPTIONS

46       -o output-file
47              Specify  the  name  of  a  file  where the LaTeX output is to be
48              stored. A dash `-' causes the LaTeX  output  to  be  printed  on
49              standard output.
50
51       -n line-width
52              Set  the line width. The default is 72 characters. The responses
53              of the toplevel loop are folded if they are longer than the line
54              width. No folding is performed on the Coq input text.
55
56       -image coq-image
57              Cause  the  file  coq-image  to  be executed to evaluate the Coq
58              phrases. By default, this is the command coqtop without specify‐
59              ing any path which is used to evaluate the Coq phrases.
60
61       -w     Cause lines to be folded on a space character whenever possible,
62              avoiding word cuts in the output. By default, folding occurs  at
63              the line width, regardless of word cuts.
64
65       -v     Verbose  mode.  Prints  the  Coq answers on the standard output.
66              Useful to detect errors in Coq phrases.
67
68       -sl    Slanted mode. The Coq answers are written in a slanted font.
69
70       -hrule Horizontal lines mode. The Coq parts  are  written  between  two
71              horizontal lines.
72
73       -small Small font mode. The Coq parts are written in a smaller font.
74
75
76

CAVEATS

78       The  \begin...  and  \end...  phrases must sit on a line by themselves,
79       with no characters before the backslash or  after  the  closing  brace.
80       Each  Coq phrase must be terminated by `.' at the end of a line.  Blank
81       space is accepted between `.' and the newline, but any other  character
82       will  cause  coq-tex  to  ignore the end of the phrase, resulting in an
83       incorrect shuffling of the responses into the phrases.  (The  responses
84       ``lag behind''.)
85
86

SEE ALSO

88       coqtop (1).
89
90
91
92                                 29 March 1995                      COQ-TEX(1)