aboutsummaryrefslogtreecommitdiffstats
path: root/fsa/doc/docbook/fsainfo.xml
blob: 08fa9aa96fdf9d63fcf9b158dac5be539d741e1e (plain) (blame)
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
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<!-- Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. -->
<refentry id="fsainfo">

<refmeta>
<refentrytitle>fsainfo</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>

<refnamediv>
<refname>fsainfo</refname>
<refpurpose>display information about finite state automata files</refpurpose>
</refnamediv>

<refsynopsisdiv>
<cmdsynopsis>
  <command>fsainfo</command>
  <arg>OPTIONS</arg>
  <arg choice='plain'>fsa_file</arg>
</cmdsynopsis>
</refsynopsisdiv>


<refsect1><title>Description</title>
<para>
<command>fsainfo</command> displays information about fsa files,
mainly based on the fsa header. In addition,
<command>fsainfo</command> tries to load the fsa file and reports
whether loading succeeded. The following information is presented:
</para>
<para>
<variablelist>
<varlistentry>
<term>Header size</term>
<listitem>
<para>
Size of the fsa header (usually 256 bytes).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Magic</term>
<listitem>
<para>
Magic number identifying fsa files (2038637673). Files with wrong
magic will not be attempted to load.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Version</term>
<listitem>
<para>
Version of the fsa library used for building the fsa file (e.g. 1.0.2).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Serial number</term>
<listitem>
<para>
Serial number of the fsa file.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Checksum</term>
<listitem>
<para>
Checksum for verifying the integrity of the fsa file. If the checksum
verification fails, the fsa file will refuse to load.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>FSA size</term>
<listitem>
<para>
Size of the automaton (in number of cells and bytes).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Start state</term>
<listitem>
<para>
Index of the start state.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Data size</term>
<listitem>
<para>
Size of data storage used for storing meta information for final states.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Data item type</term>
<listitem>
<para>
Type of meta data items (fixed or variable size).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Fixed item size</term>
<listitem>
<para>
Size of meta data items, if fixed size.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Perfect hash</term>
<listitem>
<para>
Indication whether the fsa was built with perfect hash (yes/no).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Perfect hash size</term>
<listitem>
<para>
Perfect hash size, if the fsa was built with perfect hash.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Total size</term>
<listitem>
<para>
Full size of the fsa file (header + automaton + meta data + perfect hash).
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<refsect2><title>Options</title>
<para>
<variablelist>
<varlistentry>
<term><option>-h</option></term>
<listitem>
<para>
display usage help
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-V</option></term>
<listitem>
<para>
display version number
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect2>
</refsect1>

<refsect1><title>See also</title>
<para>
makefsa, fsadump.
</para>
</refsect1>

<refsect1><title>Author</title>
<para>
Written by Peter Boros.
</para>
</refsect1>

</refentry>