{
    "content": [
        {
            "type": "text",
            "text": "# word-list-compress (man)\n\n## NAME\n\nword-list-compress - word list compressor/decompressor for GNU Aspell\n\n## SYNOPSIS\n\nword-list-compress c[ompress] | d[ecompress]\n\n## DESCRIPTION\n\nword-list-compress  compresses  or decompresses sorted word lists for use with the GNU Aspell\nspell checker.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **COMMANDS** (2 subsections)\n- **EXAMPLES**\n- **TIPS**\n- **DIAGNOSTICS** (3 subsections)\n- **SEE ALSO**\n- **REPORTING BUGS**\n- **AUTHOR**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "word-list-compress",
        "section": "",
        "mode": "man",
        "summary": "word-list-compress - word list compressor/decompressor for GNU Aspell",
        "synopsis": "word-list-compress c[ompress] | d[ecompress]",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [
            {
                "flag": "-c",
                "long": null,
                "arg": null,
                "description": "compress the plain text word list read from standard input."
            },
            {
                "flag": "-d",
                "long": null,
                "arg": null,
                "description": "decompress the compressed word list read from standard input."
            }
        ],
        "examples": [
            "Here are a few examples of how you can use word-list-compress",
            "word-list-compress d <wordlist.cwl >wordlist.txt",
            "Decompress file wordlist.cwl to text file wordlist.txt",
            "word-list-compress c <wordlist.wl >wordlist.cwl 2>errors.txt",
            "Compress wordlist.wl to wordlist.cwl and send any error messages to a text file  named",
            "errors.txt",
            "LCCOLLATE=C sort -u <wordlist.txt | word-list-compress c >wordlist.cwl",
            "Sort  a  word  list,  then pipe it to word-list-compress to create a compressed binary",
            "wordlist.cwl file.",
            "word-list-compress d <words.cwl | aspell create master ./words.rws",
            "Decompress a wordlist, then pipe it to aspell(1) to create a  spelling  list.   Please",
            "check the aspell(1) info manual for proper usage and options."
        ],
        "see_also": [
            {
                "name": "aspell",
                "section": "1",
                "url": "https://www.chedong.com/phpMan.php/man/aspell/1/json"
            },
            {
                "name": "aspell-import",
                "section": "1",
                "url": "https://www.chedong.com/phpMan.php/man/aspell-import/1/json"
            },
            {
                "name": "prezip-bin",
                "section": "1",
                "url": "https://www.chedong.com/phpMan.php/man/prezip-bin/1/json"
            },
            {
                "name": "run-with-aspell",
                "section": "1",
                "url": "https://www.chedong.com/phpMan.php/man/run-with-aspell/1/json"
            }
        ],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 3,
                "subsections": []
            },
            {
                "name": "COMMANDS",
                "lines": 1,
                "subsections": [
                    {
                        "name": "-c",
                        "lines": 2,
                        "flag": "-c"
                    },
                    {
                        "name": "-d",
                        "lines": 2,
                        "flag": "-d"
                    }
                ]
            },
            {
                "name": "EXAMPLES",
                "lines": 17,
                "subsections": []
            },
            {
                "name": "TIPS",
                "lines": 8,
                "subsections": []
            },
            {
                "name": "DIAGNOSTICS",
                "lines": 4,
                "subsections": [
                    {
                        "name": "(display help/usage message)",
                        "lines": 3
                    },
                    {
                        "name": "Corrupt Input",
                        "lines": 6
                    },
                    {
                        "name": "Output Data Error",
                        "lines": 2
                    }
                ]
            },
            {
                "name": "SEE ALSO",
                "lines": 5,
                "subsections": []
            },
            {
                "name": "REPORTING BUGS",
                "lines": 3,
                "subsections": []
            },
            {
                "name": "AUTHOR",
                "lines": 6,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "word-list-compress - word list compressor/decompressor for GNU Aspell\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "word-list-compress c[ompress] | d[ecompress]\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "word-list-compress  compresses  or decompresses sorted word lists for use with the GNU Aspell\nspell checker.\n",
                "subsections": []
            },
            "COMMANDS": {
                "content": "",
                "subsections": [
                    {
                        "name": "-c",
                        "content": "compress the plain text word list read from standard input.\n",
                        "flag": "-c"
                    },
                    {
                        "name": "-d",
                        "content": "decompress the compressed word list read from standard input.\n",
                        "flag": "-d"
                    }
                ]
            },
            "EXAMPLES": {
                "content": "Here are a few examples of how you can use word-list-compress\n\nword-list-compress d <wordlist.cwl >wordlist.txt\nDecompress file wordlist.cwl to text file wordlist.txt\n\nword-list-compress c <wordlist.wl >wordlist.cwl 2>errors.txt\nCompress wordlist.wl to wordlist.cwl and send any error messages to a text file  named\nerrors.txt\n\nLCCOLLATE=C sort -u <wordlist.txt | word-list-compress c >wordlist.cwl\nSort  a  word  list,  then pipe it to word-list-compress to create a compressed binary\nwordlist.cwl file.\n\nword-list-compress d <words.cwl | aspell create master ./words.rws\nDecompress a wordlist, then pipe it to aspell(1) to create a  spelling  list.   Please\ncheck the aspell(1) info manual for proper usage and options.\n",
                "subsections": []
            },
            "TIPS": {
                "content": "Word-list-compress  is  best used with sorted word list type files.  It is not a general pur‐\npose compression program since the resulting files may actually increase in size.\n\nWord-list-compress accepts up to 255 text characters in the range of {0x21...0xFF}.  If  your\nword  list  requires  a  larger  character  set  for  certain  languages or longer length for\nmulti-word, scientific, medical, technical or other use, then it is recommended that you com‐\npress your word list using prezip-bin(1)\n",
                "subsections": []
            },
            "DIAGNOSTICS": {
                "content": "Word-list-compress normally exits with a return code of 0.  If it encounters an error, a mes‐\nsage is sent to standard error output (stderr), and word-list-compress exits with a  non-zero\nreturn value.  Error messages are listed below:\n",
                "subsections": [
                    {
                        "name": "(display help/usage message)",
                        "content": "Unknown  command given on the command line so word-list-compress displays a usage mes‐\nsage to standard error output.\n"
                    },
                    {
                        "name": "Corrupt Input",
                        "content": "This is only for the decompression command d.  The input file is of an unknown  format\nor  the  input  file/stream  is  corrupted.   You  may  have  some  valid  output, but\nword-list-compress could not complete the process.  If the input file is a  compressed\nwordlist  but you have no output file, then it may be a newer prezip-bin(1) version of\ncompressed file, if so, try decompressing the file with prezip-bin(1) instead.\n"
                    },
                    {
                        "name": "Output Data Error",
                        "content": "The output is full, write protected, or has an error and can no longer be written to.\n"
                    }
                ]
            },
            "SEE ALSO": {
                "content": "aspell(1), aspell-import(1), prezip-bin(1), run-with-aspell(1)\n\nAspell is fully documented in its Texinfo manual.  See the `aspell' entry in  info  for  more\ncomplete documentation.\n",
                "subsections": []
            },
            "REPORTING BUGS": {
                "content": "For help, see the Aspell homepage at <http://aspell.net> and send bug reports/comments to the\nAspell user list at the above address.\n",
                "subsections": []
            },
            "AUTHOR": {
                "content": "This manual page was written by Aaron Lehmann <aaronl@vitelus.com>,  Brian  Nelson  <pyro@de‐\nbian.org> and Jose Da Silva <digital@joescat.com>.\n\n\n\nGNU                                          2005-09-05                        WORD-LIST-COMPRESS(1)",
                "subsections": []
            }
        }
    }
}