Open topic with navigation

# edktool Syntax

Syntax for `edktool` is as follows:

    Usage: edktool  {
         generate    -i <inputfile> [-o <outputfile>] [-e <entityname>]
         compile     [-i] <inputfile> [-e <entity>[,<entity>...]]
                     [-l <licensefile>] [-o <outputfile>] [-p] |
         list        <grammarfile> [-a] [-q]  |
         extract     [-l <licensefile>] -i <inputfile> [-c <configfile>]
                     [-g <grammarfile>[,<grammarfile>...]]
                     [-e <entity>[,<entity>...]] [-o <outputfile>] [-m] [-q]
                     [-r <redactionfile>] [-p] |
         measure     -e <expectedfile> -a <actualfile> [-o <resultsfile>] [-q]  |
         assess      [-l <licensefile>] [-o <resultsfile>] [-c <configfile>] [-a]
                     [-m <matched entities>] [-g <grammarfile>[,<grammarfile>...]]
                     [-e <entity>[,<entity>...]] [-v <valid input>]
                     [-w <invalid input>] [-x] [-q]  |
         permissions -d <directory> [-l <licensefile>] [-a] [-q]  |
         help        [<option>] }

    Options:
      generate or g          Generates an uncompiled XML (source) file
         -i inputfile        The plaintext file containing one match per line
         -o outputfile       The destination for the output XML file
         -e entityname       The name for the single entity in the XML output
      compile or c           Compiles a grammar file
         -i inputfile        Input grammar file
         -e entities         Entities to be included in the grammar
         -l licensefile      The file containing the license key
         -o outputfile       Output grammar file
         -p                  Treat the input file as plaintext rather than XML

      list or l              Lists the available entities in a grammar file
            grammarfile      The grammar file
         -a                  Show additional info - such as license requirements
         -q                  "Quiet Mode" suppresses all descriptive messages

      extract or e           Extract entities from a file
         -l licensefile      The file containing the license key
         -i inputfile        The file on which entity extraction will be performed
         -c configfile       A configuration file controlling the extraction
         -g grammarfiles     Grammar files to use, if "-c" is not used
         -e entities         The entities to extract, if "-c" is not used
         -o outputfile       The file containing the results of the extraction
         -m                  Produce match results for IDOL input files
         -q                  "Quiet Mode" suppresses all descriptive messages
         -r redactionfile    A copy of the input file, with all matches redacted
         -p                 Treat the resource file as plaintext rather than XML

      measure or m           Measures precision and recall between extraction runs
         -e expectedfile     The expected results file from "edktool extract"
         -a actualfile       The actual results file from a separate extraction run
         -o resultsfile      The results: precision, recall and differences
         -q                  "Quiet Mode" suppresses all descriptive messages

      assess or a            Measures precision and recall, using user-defined data
         -l licensefile      The file containing the license key
         -a                  Show all results, including true matches
         -c configfile       A configuration file controlling the assessment
         -g grammarfiles     Grammar files to use, if "-c" is not used
         -e entities         The entities to extract, if "-c" is not used
         -x                  Sets comparison mode to "exact", if "-c" is not used
         -m "match entities" Entities to check results against, if "-c" is not used
         -v "valid input"    The file containing valid input, if "-c" is not used
         -w "invalid input"  The file containing invalid input, if "-c" is not used
         -o resultsfile      The results: false matches, precision and recall
         -q                  "Quiet Mode" suppresses all descriptive messages

      permissions or p       Displays all licensed grammar files in a directory
         -d directory        A directory containing some eduction grammar files
         -l licensefile      The file containing the license key
         -a                  Show additional information
         -q                  "Quiet Mode" suppresses all descriptive messages

      help or h              Displays edktool help
            option           More detailed help on the edktool option

NOTE:

If you do not specify a license key at the command line, `edktool` assumes that the location of the license file is `licensekey.dat`. If the license is kept in this location, you do not need to specify the -l <licensefile> parameter.

© Copyright 2013-2018 Micro Focus or one of its affiliates | Send documentation feedback Close Send documentation feedback To open the configured email client on this computer, open an email window. Otherwise, copy the information below to a web mail client, and send this email to swpdl.idoldocsfeedback@microfocus.com. We appreciate your feedback! Product: Topic Title: Help Topic: Feedback:

_FT_HTML5_bannerTitle.htm