.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.3.
.TH HFST-LOOKUP "1" "August 2018" "HFST" "User Commands"
.SH NAME
hfst-lookup \- =perform transducer lookup (apply)
.SH SYNOPSIS
.B hfst-lookup
[\fI\,OPTIONS\/\fR...] [\fI\,INFILE\/\fR]
.SH DESCRIPTION
perform transducer lookup (apply)
NOTE: hfst\-lookup does lookup from left to right as opposed to xfst and foma
.IP
lookup which is carried out from right to left. In order to do lookup
in a similar way as xfst and foma, use 'hfst\-flookup' instead.
.SS "Common options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
Print help message
.TP
\fB\-V\fR, \fB\-\-version\fR
Print version info
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Print verbosely while processing
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Only print fatal erros and requested output
.TP
\fB\-s\fR, \fB\-\-silent\fR
Alias of \fB\-\-quiet\fR
.SS "Input/Output options:"
.TP
\fB\-i\fR, \fB\-\-input\fR=\fI\,INFILE\/\fR
Read input transducer from INFILE
.TP
\fB\-o\fR, \fB\-\-output\fR=\fI\,OUTFILE\/\fR
Write output to OUTFILE
.HP
\fB\-p\fR, \fB\-\-pipe\-mode\fR[=\fI\,STREAM\/\fR] Control input and output streams
.SS "Lookup options:"
.TP
\fB\-I\fR, \fB\-\-input\-strings\fR=\fI\,SFILE\/\fR
Read lookup strings from SFILE
.TP
\fB\-O\fR, \fB\-\-output\-format\fR=\fI\,OFORMAT\/\fR
Use OFORMAT printing results sets
.TP
\fB\-e\fR, \fB\-\-epsilon\-format\fR=\fI\,EPS\/\fR
Print epsilon as EPS
.TP
\fB\-F\fR, \fB\-\-input\-format\fR=\fI\,IFORMAT\/\fR
Use IFORMAT parsing input
.TP
\fB\-x\fR, \fB\-\-statistics\fR
Print statistics
.TP
\fB\-X\fR, \fB\-\-xfst\fR=\fI\,VARIABLE\/\fR
Toggle xfst VARIABLE
.TP
\fB\-c\fR, \fB\-\-cycles\fR=\fI\,INT\/\fR
How many times to follow input epsilon cycles
(only for non\-lookup\-optimized transducers)
.TP
\fB\-n\fR, \fB\-\-max\-number\fR=\fI\,INT\/\fR
Maximum number of results printed for each input
(only for lookup\-optimized transducers)
.TP
\fB\-b\fR, \fB\-\-beam\fR=\fI\,B\/\fR
Output only analyses whose weight is within B from
the best analysis
.TP
\fB\-t\fR, \fB\-\-time\-cutoff\fR=\fI\,S\/\fR
Limit search after having used S seconds per input
(only for lookup\-optimized transducers)
.TP
\fB\-C\fR, \fB\-\-cascade\fR=\fI\,CASCADE\/\fR
How multiple transducers in input are handled
.TP
\fB\-P\fR, \fB\-\-progress\fR
Show neat progress bar if possible
.PP
If OUTFILE or INFILE is missing or \-, standard streams will be used.
Format of result depends on format of INFILE
OFORMAT is one of {xerox,cg,apertium}, xerox being default
IFORMAT is one of {text,spaced,apertium}, default being text,
unless OFORMAT is apertium
VARIABLEs relevant to lookup are {print\-pairs,print\-space,
quote\-special,show\-flags,obey\-flags}
Input epsilon cycles are followed by default INT=5 times.
Epsilon is printed by default as an empty string.
B must be a non\-negative float.
S must be a non\-negative float. The default, 0.0, indicates no cutoff.
If the input contains several transducers, a set containing
results from all transducers is printed for each input string.
.PP
CASCADE must be one of { union, priority\-union, composition }.
If not specified, defaults to {union}.
.PP
STREAM can be { input, output, both }. If not given, defaults to {both}.
If input file is not specified with \fB\-I\fR, input is read interactively line by
line from the user. If you redirect input from a file, use \fB\-\-pipe\-mode\fR=\fI\,input\/\fR.
\fB\-\-pipe\-mode\fR=\fI\,output\/\fR is ignored on non\-windows platforms.
.SS "Todo:"
.IP
Support \fB\-\-xfst\fR=\fI\,obey\-flags\/\fR for optimized lookup format.
Support \fB\-\-cycles\fR for optimized lookup format.
.SS "Known bugs:"
.IP
\&'quote\-special' quotes spaces that come from 'print\-space'
.SH "REPORTING BUGS"
Report bugs to <hfst\-bugs@helsinki.fi> or directly to our bug tracker at:
<https://github.com/hfst/hfst/issues>
.PP
hfst\-lookup home page:
<https://kitwiki.csc.fi/twiki/bin/view/KitWiki//HfstLookup>
.br
General help using HFST software:
<https://kitwiki.csc.fi/twiki/bin/view/KitWiki//HfstHome>
.SH COPYRIGHT
Copyright \(co 2017 University of Helsinki,
License GPLv3: GNU GPL version 3 <http://gnu.org/licenses/gpl.html>
.br
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.