{ "content": [ { "type": "text", "text": "# gendict(1) (man)\n\n**Summary:** gendict - Compiles word list into ICU string trie dictionary\n\n**Synopsis:** gendict [ --uchars | --bytes --transform transform ] [ -h, -?, --help ] [ -V, --version ] [\n\n## Flags\n\n| Flag | Long | Arg | Description |\n|------|------|-----|-------------|\n| -? | --help | — | Print help about usage and exit. |\n| -V | --version | — | Print the version of gendict and exit. |\n| -c | --copyright | — | Embeds the standard ICU copyright into the output-file. |\n| -v | --verbose | — | Display extra informative messages during execution. |\n| -i | --icudatadir | — | Look for any necessary ICU data files in directory. For example, the file pnames.icu must be located when ICU's data is |\n| — | --uchars | — | Set the output trie type to UChar. Mutually exclusive with --bytes. |\n| — | --bytes | — | Set the output trie type to Bytes. Mutually exclusive with --uchars. |\n| — | --transform | — | Set the transform type. Should only be specified with --bytes. Currently supported transforms are: offset-, |\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **SYNOPSIS** (1 lines) — 1 subsections\n - -c --copyright -v --verbose -i --icudatadir (1 lines)\n- **DESCRIPTION** (6 lines)\n- **OPTIONS** (1 lines) — 10 subsections\n - -h -? --help (2 lines)\n - -V --version (2 lines)\n - -c --copyright (2 lines)\n - -v --verbose (2 lines)\n - -i --icudatadir (5 lines)\n - --uchars (2 lines)\n - --bytes (2 lines)\n - --transform (7 lines)\n - input-file (2 lines)\n - output-file (2 lines)\n- **CAVEATS** (4 lines)\n- **ENVIRONMENT** (4 lines)\n- **AUTHORS** (2 lines)\n- **VERSION** (2 lines)\n- **COPYRIGHT** (2 lines)\n- **SEE ALSO** (1 lines) — 1 subsections\n - http://www.icu-project.org/userguide/boundaryAnalysis.html (1 lines)\n\n## Full Content\n\n### NAME\n\ngendict - Compiles word list into ICU string trie dictionary\n\n### SYNOPSIS\n\ngendict [ --uchars | --bytes --transform transform ] [ -h, -?, --help ] [ -V, --version ] [\n\n#### -c --copyright -v --verbose -i --icudatadir\n\n### DESCRIPTION\n\ngendict reads the word list from dictionary-file and creates a string trie dictionary file.\nNormally this data file has the .dict extension.\n\nWords begin at the beginning of a line and are terminated by the first whitespace. Lines\nthat begin with whitespace are ignored.\n\n### OPTIONS\n\n#### -h -? --help\n\nPrint help about usage and exit.\n\n#### -V --version\n\nPrint the version of gendict and exit.\n\n#### -c --copyright\n\nEmbeds the standard ICU copyright into the output-file.\n\n#### -v --verbose\n\nDisplay extra informative messages during execution.\n\n#### -i --icudatadir\n\nLook for any necessary ICU data files in directory. For example, the file pnames.icu\nmust be located when ICU's data is not built as a shared library. The default ICU\ndata directory is specified by the environment variable ICUDATA. Most configurations\nof ICU do not require this argument.\n\n#### --uchars\n\nSet the output trie type to UChar. Mutually exclusive with --bytes.\n\n#### --bytes\n\nSet the output trie type to Bytes. Mutually exclusive with --uchars.\n\n#### --transform\n\nSet the transform type. Should only be specified with --bytes. Currently supported\ntransforms are: offset-, which specifies an offset to subtract from all\ninput characters. It should be noted that the offset transform also maps U+200D to\n0xFF and U+200C to 0xFE, in order to offer compatibility to languages that require\nthese characters. A transform must be specified for a bytes trie, and when applied to\nthe non-value characters in the input-file must produce output between 0x00 and 0xFF.\n\n#### input-file\n\nThe source file to read.\n\n#### output-file\n\nThe file to write the output dictionary to.\n\n### CAVEATS\n\nThe input-file is assumed to be encoded in UTF-8. The integers in the input-file that are\nused as values must be made up of ASCII digits. They may be specified either in hex, by using\na 0x prefix, or in decimal. Either --bytes or --uchars must be specified.\n\n### ENVIRONMENT\n\nICUDATA Specifies the directory containing ICU data. Defaults to ${prefix}/share/icu/70.1/.\nSome tools in ICU depend on the presence of the trailing slash. It is thus impor‐\ntant to make sure that it is present if ICUDATA is set.\n\n### AUTHORS\n\nMaxime Serrano\n\n### VERSION\n\n1.0\n\n### COPYRIGHT\n\nCopyright (C) 2012 International Business Machines Corporation and others\n\n### SEE ALSO\n\n#### http://www.icu-project.org/userguide/boundaryAnalysis.html\n\nICU MANPAGE 1 June 2012 GENDICT(1)\n\n" } ], "structuredContent": { "command": "gendict", "section": "1", "mode": "man", "summary": "gendict - Compiles word list into ICU string trie dictionary", "synopsis": "gendict [ --uchars | --bytes --transform transform ] [ -h, -?, --help ] [ -V, --version ] [", "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [ { "flag": "-?", "long": "--help", "arg": null, "description": "Print help about usage and exit." }, { "flag": "-V", "long": "--version", "arg": null, "description": "Print the version of gendict and exit." }, { "flag": "-c", "long": "--copyright", "arg": null, "description": "Embeds the standard ICU copyright into the output-file." }, { "flag": "-v", "long": "--verbose", "arg": null, "description": "Display extra informative messages during execution." }, { "flag": "-i", "long": "--icudatadir", "arg": null, "description": "Look for any necessary ICU data files in directory. For example, the file pnames.icu must be located when ICU's data is not built as a shared library. The default ICU data directory is specified by the environment variable ICUDATA. Most configurations of ICU do not require this argument." }, { "flag": "", "long": "--uchars", "arg": null, "description": "Set the output trie type to UChar. Mutually exclusive with --bytes." }, { "flag": "", "long": "--bytes", "arg": null, "description": "Set the output trie type to Bytes. Mutually exclusive with --uchars." }, { "flag": "", "long": "--transform", "arg": null, "description": "Set the transform type. Should only be specified with --bytes. Currently supported transforms are: offset-, which specifies an offset to subtract from all input characters. It should be noted that the offset transform also maps U+200D to 0xFF and U+200C to 0xFE, in order to offer compatibility to languages that require these characters. A transform must be specified for a bytes trie, and when applied to the non-value characters in the input-file must produce output between 0x00 and 0xFF." } ], "examples": [], "see_also": [], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 1, "subsections": [ { "name": "-c --copyright -v --verbose -i --icudatadir", "lines": 1, "flag": "-i", "long": "--icudatadir" } ] }, { "name": "DESCRIPTION", "lines": 6, "subsections": [] }, { "name": "OPTIONS", "lines": 1, "subsections": [ { "name": "-h -? --help", "lines": 2, "flag": "-?", "long": "--help" }, { "name": "-V --version", "lines": 2, "flag": "-V", "long": "--version" }, { "name": "-c --copyright", "lines": 2, "flag": "-c", "long": "--copyright" }, { "name": "-v --verbose", "lines": 2, "flag": "-v", "long": "--verbose" }, { "name": "-i --icudatadir", "lines": 5, "flag": "-i", "long": "--icudatadir" }, { "name": "--uchars", "lines": 2, "long": "--uchars" }, { "name": "--bytes", "lines": 2, "long": "--bytes" }, { "name": "--transform", "lines": 7, "long": "--transform" }, { "name": "input-file", "lines": 2 }, { "name": "output-file", "lines": 2 } ] }, { "name": "CAVEATS", "lines": 4, "subsections": [] }, { "name": "ENVIRONMENT", "lines": 4, "subsections": [] }, { "name": "AUTHORS", "lines": 2, "subsections": [] }, { "name": "VERSION", "lines": 2, "subsections": [] }, { "name": "COPYRIGHT", "lines": 2, "subsections": [] }, { "name": "SEE ALSO", "lines": 1, "subsections": [ { "name": "http://www.icu-project.org/userguide/boundaryAnalysis.html", "lines": 1 } ] } ] } }