1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
<?xml version='1.0' encoding='utf-8'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!--
Process this file with an XSLT processor: `xsltproc \
-''-nonet /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
manpages/docbook.xsl manpage.dbk'. A manual page
<package>.<section> will be generated. You may view the
manual page with: nroff -man <package>.<section> | less'. A
typical entry in a Makefile or Makefile.am is:
DB2MAN=/usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
manpages/docbook.xsl
XP=xsltproc -''-nonet
manpage.1: manpage.dbk
$(XP) $(DB2MAN) $<
The xsltproc binary is found in the xsltproc package. The
XSL files are in docbook-xsl. Please remember that if you
create the nroff version in one of the debian/rules file
targets (such as build), you will need to include xsltproc
and docbook-xsl in your Build-Depends control field.
-->
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
<!ENTITY dhfirstname "<firstname>Marc</firstname>">
<!ENTITY dhsurname "<surname>Dequ\[`e]nes</surname>">
<!-- Please adjust the date whenever revising the manpage. -->
<!ENTITY dhdate "<date>2005-01-02</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
<!ENTITY dhemail "<email>Duck@DuckCorp.org</email>">
<!ENTITY dhusername "Marc Dequ\[`e]nes (Duck)">
<!ENTITY dhucpackage "<refentrytitle>TEXVC</refentrytitle>">
<!ENTITY dhpackage "texvc">
<!ENTITY debian "<productname>Debian</productname>">
<!ENTITY gnu "<acronym>GNU</acronym>">
<!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
]>
<refentry>
<refentryinfo>
<address>
&dhemail;
</address>
<author>
&dhfirstname;
&dhsurname;
</author>
<copyright>
<year>2003</year>
<holder>&dhusername;</holder>
</copyright>
&dhdate;
</refentryinfo>
<refmeta>
&dhucpackage;
&dhsection;
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose>math equation PNG renderer</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage;</command>
<arg choice="req" rep="norepeat">tempdir</arg>
<arg choice="req" rep="norepeat">outputdir</arg>
<arg choice="req" rep="norepeat">texcode</arg>
<arg choice="req" rep="norepeat">encoding</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para><command>&dhpackage;</command> is designed to render math
equations written in latex code into PNG images.
</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>
<arg choice="req" rep="norepeat">tempdir</arg>
</term>
<listitem>
<para>directory where temporary files are created.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<arg choice="req" rep="norepeat">outputdir</arg>
</term>
<listitem>
<para>directory where the result image is stored.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<arg choice="req" rep="norepeat">texcode</arg>
</term>
<listitem>
<para>latex code string representing math equations.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<arg choice="req" rep="norepeat">encoding</arg>
</term>
<listitem>
<para>used encoding in latex code string.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>OUTPUT</title>
<para>Status codes and HTML/MathML transformations are returned on stdout.
A rasterized PNG file will be written to the output directory, named
for the MD5 hash code.
</para>
<para>texvc output format is like this:
<itemizedlist>
<listitem><para>+%5 ok, but not html or mathml</para></listitem>
<listitem><para>c%5%h ok, conservative html, no mathml</para></listitem>
<listitem><para>m%5%h ok, moderate html, no mathml</para></listitem>
<listitem><para>l%5%h ok, liberal html, no mathml</para></listitem>
<listitem><para>C%5%h\0%m ok, conservative html, with mathml</para></listitem>
<listitem><para>M%5%h\0%m ok, moderate html, with mathml</para></listitem>
<listitem><para>L%5%h\0%m ok, liberal html, with mathml</para></listitem>
<listitem><para>X%5%m ok, no html, with mathml</para></listitem>
<listitem><para>S syntax error</para></listitem>
<listitem><para>E lexing error</para></listitem>
<listitem><para>F%s unknown function %s</para></listitem>
<listitem><para>- other error</para></listitem>
</itemizedlist>
</para>
<para>
with the following codes:
<itemizedlist>
<listitem><para>\0 - null character</para></listitem>
<listitem><para>%5 - md5, 32 hex characters</para></listitem>
<listitem><para>%h - html code, without \0 characters</para></listitem>
<listitem><para>%m - mathml code, without \0 characters</para></listitem>
</itemizedlist>
</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>This manual page was written by &dhusername; &dhemail; for
the &debian; system (but may be used by others). Permission is
granted to copy, distribute and/or modify this document under
the terms of the &gnu; General Public License, Version 2 any
later version published by the Free Software Foundation.
</para>
<para>
On Debian systems, the complete text of the GNU General Public
License can be found in /usr/share/common-licenses/GPL.
</para>
</refsect1>
</refentry>
|
