File: grcompiler.1.xml

package info (click to toggle)
grcompiler 5.2.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 24,020 kB
  • sloc: cpp: 48,200; ansic: 7,670; sh: 4,427; makefile: 197; xml: 190; perl: 127; sed: 21
file content (254 lines) | stat: -rw-r--r-- 6,544 bytes parent folder | download | duplicates (3)
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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<refentry>
  <refentryinfo>
    <releaseinfo>$Revision: 4.2 $</releaseinfo>

    <date>$Date: 2012-05-29 11:36:50 $</date>
  </refentryinfo>

  <refmeta>
    <refentrytitle>grcompiler</refentrytitle>

    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>grcompiler</refname>

    <refpurpose>Compile GDL into a TrueType Font</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>grcompiler</command>

      <arg><option>-c</option></arg>

      <arg><option>-d</option></arg>

      <arg><option>-D</option></arg>

      <arg><option>-g</option></arg>

      <arg><option>-n</option><replaceable>number</replaceable></arg>

      <arg><option>-v</option><replaceable>number</replaceable></arg>

      <arg><option>-w</option><replaceable>number</replaceable></arg>

      <arg><option>-wall</option></arg>

      <arg><option>-q</option></arg>

      <arg choice="plain">gdl-file</arg>

      <arg choice="plain">font-file</arg>

      <arg>output-file</arg>

      <arg>output-fontname</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para>Grcompiler compiles a Graphite Description Language description of
    the smarts for a font along with a TrueType Font to create a graphite font
    with graphite tables in it.</para>

    <variablelist>
      <varlistentry>
        <term><option>-c</option></term>

        <listitem>
          <para>
          Enable compression of Graphite tables. 
          This forces a version 5.0 Silf and version 3.0 Glat.
          </para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-d</option></term>

        <listitem>
          <para>Generate XML debugger file.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-D</option></term>

        <listitem>
          <para>Generate all debugger files.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-g</option></term>

        <listitem>
          <para>Permit and ignore invalid glyph definitions.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-n</option> <parameter>number</parameter></term>

        <listitem>
          <para>Set name table start location.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-q</option></term>

        <listitem>
          <para>Quiet mode (no messages except on error).</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-v</option> <parameter>number</parameter></term>

        <listitem>
          <para>Set Silf table version number.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-w</option> <parameter>number</parameter></term>

        <listitem>
          <para>Ignore warning with the given number. This option may be
          repeated.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-wall</option></term>

        <listitem>
          <para>Display all warnings.</para>
        </listitem>
      </varlistentry>

    </variablelist>
  </refsect1>

  <refsect1>
    <title>Environment</title>

    <para>grcompiler makes use of the following environment variables</para>

    <para><glosslist>
        <glossentry>
          <glossterm>GDLPP</glossterm>

          <glossdef>
            <para>Specifies the command to execute to run the GDL
            preprocessor</para>
          </glossdef>
        </glossentry>
      </glosslist></para>
  </refsect1>

  <refsect1>
    <title>Files</title>

    <para><glosslist>
        <glossentry>
          <glossterm>gdlerr.txt</glossterm>

          <glossdef>
            <para>Warnings and errors are output to this file.</para>
          </glossdef>
        </glossentry>

        <glossentry>
          <glossterm>dbg_classes.txt</glossterm>

          <glossdef>
            <para>Debug file that specifies the classes stored in the font in
            terms of their GDL source and containing glyph ids in hex.</para>
          </glossdef>
        </glossentry>

        <glossentry>
          <glossterm>dbg_cmap.txt</glossterm>

          <glossdef>
            <para>Debug file giving Unicode to glyph mapping of all the glyphs
            in the font and vice versa.</para>
          </glossdef>
        </glossentry>

        <glossentry>
          <glossterm>dbg_enginecode.txt</glossterm>

          <glossdef>
            <para>Debug file containing the action code and constraint code
            associated with each pass and rule in a pass.</para>
          </glossdef>
        </glossentry>

        <glossentry>
          <glossterm>dbg_fsm.txt</glossterm>

          <glossdef>
            <para>Debug file that gives the finite state machines of each pass
            and the rules referenced. For each pass, a mapping is given
            between glyph and column number.</para>
          </glossdef>
        </glossentry>

        <glossentry>
          <glossterm>dbg_glyphattrs.txt</glossterm>

          <glossdef>
            <para>Debug file containing all the glyph attributes and their
            names, along with values specified for each glyph.</para>
          </glossdef>
        </glossentry>

        <glossentry>
          <glossterm>dbg_parsetree.txt</glossterm>

          <glossdef>
            <para>Debug file giving the complete parse tree of the GDL source
            file.</para>
          </glossdef>
        </glossentry>

        <glossentry>
          <glossterm>dbg_ruleprec.txt</glossterm>

          <glossdef>
            <para>Debug file that lists the rules in precedence order (order
            in which they will be tested) for each pass.</para>
          </glossdef>
        </glossentry>

        <glossentry>
          <glossterm>$_temp.gdl</glossterm>

          <glossdef>
            <para>Debug file containing the output of gdlpp</para>
          </glossdef>
        </glossentry>
      </glosslist></para>
  </refsect1>
  <refsect1>
  	<title>Author</title>
  	<simpara>
  		<ulink url="http://graphite.sil.org">Graphite project</ulink>
  	</simpara><simpara>
  		<orgname>SIL International</orgname>
  		<email>graphite_nrsi@sil.org</email>
    </simpara>
    
  </refsect1>
</refentry>