← Back to branch summary

~ubuntu-branches/ubuntu/wily/coq-doc/wily

« back to all changes in this revision

Viewing changes to man/coq-tex.1

  • Committer: Bazaar Package Importer
  • Author(s): Stéphane Glondu, Stéphane Glondu, Samuel Mimram
  • Date: 2010-01-07 22:50:39 UTC
  • mfrom: (1.2.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20100107225039-n3cq82589u0qt0s2
Tags: 8.2pl1-1
http://bugs.debian.org/563669
http://bugs.debian.org/543545
[ Stéphane Glondu ]
* New upstream release (Closes: #563669)
  - remove patches
* Packaging overhaul:
  - use git, advertise it in Vcs-* fields of debian/control
  - use debhelper 7 and dh with override
  - use source format 3.0 (quilt)
* debian/control:
  - set Maintainer to d-o-m, set Uploaders to Sam and myself
  - add Homepage field
  - bump Standards-Version to 3.8.3
* Register PDF documentation into doc-base
* Add debian/watch
* Update debian/copyright

[ Samuel Mimram ]
* Change coq-doc's description to mention that it provides documentation in
  pdf format, not postscript, closes: #543545.

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/coq-tex.1
 
1
.TH COQ-TEX 1 "29 March 1995"
 
2
 
 
3
.SH NAME
 
4
coq-tex \- Process Coq phrases embedded in LaTeX files
 
5
 
 
6
.SH SYNOPSIS
 
7
.B coq-tex
 
8
[
 
9
.BI \-o \ output-file
 
10
]
 
11
[
 
12
.BI \-n \ line-width
 
13
]
 
14
[
 
15
.BI \-image \ coq-image
 
16
]
 
17
[
 
18
.B \-w
 
19
]
 
20
[
 
21
.B \-v
 
22
]
 
23
[
 
24
.B \-sl
 
25
]
 
26
[
 
27
.B \-hrule
 
28
]
 
29
[
 
30
.B \-small
 
31
]
 
32
.I input-file ...
 
33
 
 
34
 
 
35
.SH DESCRIPTION
 
36
 
 
37
The
 
38
.B coq-tex
 
39
filter extracts Coq phrases embedded in LaTeX files, evaluates
 
40
them, and insert the outcome of the evaluation after each phrase.
 
41
 
 
42
Three LaTeX environments are provided to include Coq code in
 
43
the input files:
 
44
.TP
 
45
.B coq_example
 
46
The phrases between \\begin{coq_example} and \\end{coq_example} are
 
47
evaluated and copied into the output file. Each phrase is followed by
 
48
the response of the toplevel loop.
 
49
.TP
 
50
.B coq_example*
 
51
The phrases between \\begin{coq_example*} and \\end{coq_example*} are
 
52
evaluated and copied into the output file. The responses of the
 
53
toplevel loop are discarded.
 
54
.TP
 
55
.B coq_eval
 
56
The phrases between \\begin{coq_eval} and \\end{coq_eval} are
 
57
silently evaluated. They are not copied into the output file, and the
 
58
responses of the toplevel loop are discarded.
 
59
.PP
 
60
The resulting LaTeX code is stored in the file
 
61
.IR file \&.v.tex
 
62
if the input file has a name of the form
 
63
.IR file \&.tex,
 
64
otherwise the name of the output file is the name of the input file
 
65
with `.v.tex' appended.
 
66
 
 
67
The files produced by
 
68
.B coq-tex
 
69
can be directly processed by LaTeX. 
 
70
Both the Coq phrases and the toplevel output are typeset in
 
71
typewriter font.
 
72
 
 
73
.SH OPTIONS
 
74
 
 
75
.TP
 
76
.BI \-o \ output-file
 
77
Specify the name of a file where the LaTeX output is to be stored. A
 
78
dash `\-' causes the LaTeX output to be printed on standard output.
 
79
.TP
 
80
.BI \-n \ line-width
 
81
Set the line width. The default is 72 characters. The responses of the
 
82
toplevel loop are folded if they are longer than the line width. No
 
83
folding is performed on the Coq input text.
 
84
.TP
 
85
.BI \-image \ coq-image
 
86
Cause the file
 
87
.IR coq-image
 
88
to be executed to evaluate the Coq phrases. By default,
 
89
this is the command 
 
90
.IR coqtop
 
91
without specifying any path which is used to evaluate the Coq phrases.
 
92
.TP
 
93
.B \-w
 
94
Cause lines to be folded on a space character whenever possible,
 
95
avoiding word cuts in the output. By default, folding occurs at
 
96
the line width, regardless of word cuts.
 
97
.TP
 
98
.B \-v
 
99
Verbose mode. Prints the Coq answers on the standard output.
 
100
Useful to detect errors in Coq phrases.
 
101
.TP
 
102
.B \-sl
 
103
Slanted mode. The Coq answers are written in a slanted font.
 
104
.TP
 
105
.B \-hrule
 
106
Horizontal lines mode. The Coq parts are written between two
 
107
horizontal lines.
 
108
.TP
 
109
.B \-small
 
110
Small font mode. The Coq parts are written in a smaller font.
 
111
 
 
112
 
 
113
.SH CAVEATS
 
114
The \\begin... and \\end... phrases must sit on a line by themselves,
 
115
with no characters before the backslash or after the closing brace.
 
116
Each Coq phrase must be terminated by `.' at the end of a line.
 
117
Blank space is accepted between `.' and the newline, but any other
 
118
character will cause coq-tex to ignore the end of the phrase,
 
119
resulting in an incorrect shuffling of the responses into the phrases.
 
120
(The responses ``lag behind''.)
 
121
 
 
122
.SH SEE ALSO
 
123
 
 
124
.B coqtop
 
125
(1).