aboutsummaryrefslogtreecommitdiffstats
path: root/fsa/doc/docbook/fsadump.xml
blob: a81ea5b4b87f0fea37331bd8d41aa1f39cd219f9 (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
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
<!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="fsadump">

<refmeta>
<refentrytitle>fsadump</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>

<refnamediv>
<refname>fsadump</refname>
<refpurpose>dump the contents of finite state automata files</refpurpose>
</refnamediv>

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


<refsect1><title>Description</title>
<para>
<command>fsadump</command> dumps the contents of fsa files to standard
out in one of several different formats (some of which can be directly
used as input for <command>makefsa</command>).
</para>
<refsect2><title>Options</title>
<para>
<variablelist>
<varlistentry>
<term><option>-e</option></term>
<listitem>
<para>
text output format, with empty meta info (default)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-t</option></term>
<listitem>
<para>
text output format
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-b</option></term>
<listitem>
<para>
binary output format, with base64 encoded meta info
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-B</option></term>
<listitem>
<para>
binary output format with raw meta info
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-n</option></term>
<listitem>
<para>
text ouptut with numerical meta info
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-p</option></term>
<listitem>
<para>
text output format, with the perfect hash value instead of meta info
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-d</option></term>
<listitem>
<para>
dot output format (for visualization using graphviz)
</para>
</listitem>
</varlistentry>
<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>Output formats</title>
<para>
<variablelist>
<varlistentry>
<term>Text output format with empty meta info (<option>-e</option>)</term>
<listitem>
<para>
The input strings are terminated with '\n', and may not contain '\0',
'\0xff' or '\n' characters. This is the default.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Text output format (<option>-t</option>)</term>
<listitem>
<para>
Lines are terminated with '\n', input string and meta info are
separated by '\t'. Input and meta strings may not contain '\0',
'\0xff', '\n' or '\t' characters. A terminating '\0' (if found) is
removed from the end of the meta info.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Text output format with numerical info (<option>-n</option>)</term>
<listitem>
<para>
Lines are terminated with '\n', input string and meta info are
separated by '\t'. Input strings may not contain '\0', '\0xff', '\n'
or '\t' characters. Meta strings are unsigned integers ([0-9]+), which
will be are retrieved from the binary representation in the
automaton. Valid data sizes are 1, 2 or 4 bytes, for sizes other than
these only the first 2 or 4 bytes are used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Binary output format, with base64 encoded meta info (<option>-b</option>)</term>
<listitem>
<para>
Both the input string and meta info are terminated by '\0'. The input
string must not contain the reserved characters '\0' and '\0xff'. The
meta info is base64 encoded, as it may contain any character.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Binary output format with raw meta info (<option>-B</option>)</term>
<listitem>
<para>
Both the input string and meta info are terminated by '\0'. The input
string must not contain the reserved characters '\0' and '\0xff'. The
meta info must not contain '\0'.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Text output format, with the perfect hash value instead of meta
info (<option>-p</option>)</term>
<listitem>
<para>
The format is the same as for text output with numerical info, but the
perfect hash value for each string is used instead of meta info.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Dot output format for visualization using GraphViz (<option>-d</option>)</term>
<listitem>
<para>
Output a dot format graph, with the start and final states marked and
edges labeled with transition symbols. The <command>dot</command> tool
can be used to generate graphical output (e.g. PostScript) of the
graph. Use this format for small automata only (a few hundred states
or less), as the graph soon becomes quite complex.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>

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

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

</refentry>