word-list-compress(1)

1WORD-LIST-COMPRESS(1)  Aspell Abbreviated User's Manual  WORD-LIST-COMPRESS(1)
2
3
4

NAME

6       word-list-compress - word list compressor/decompressor for GNU Aspell
7

SYNOPSIS

9       word-list-compress c[ompress] | d[ecompress]
10

DESCRIPTION

12       word-list-compress compresses or decompresses sorted word lists for use
13       with the GNU Aspell spell checker.
14

COMMANDS

16       -c, c, compress
17              compress the plain text word list read from standard input.
18
19       -d, d, decompress
20              decompress the compressed word list read from standard input.
21

EXAMPLES

23       Here are a few examples of how you can use word-list-compress
24
25       word-list-compress d <wordlist.cwl >wordlist.txt
26              Decompress file wordlist.cwl to text file wordlist.txt
27
28       word-list-compress c <wordlist.wl >wordlist.cwl 2>errors.txt
29              Compress wordlist.wl to wordlist.cwl and send any error messages
30              to a text file named errors.txt
31
32       LC_COLLATE=C sort -u <wordlist.txt | word-list-compress c >wordlist.cwl
33              Sort a word list, then pipe it to word-list-compress to create a
34              compressed binary wordlist.cwl file.
35
36       word-list-compress d <words.cwl | aspell create master ./words.rws
37              Decompress a wordlist, then pipe it to  aspell(1)  to  create  a
38              spelling  list.   Please  check  the  aspell(1)  info manual for
39              proper usage and options.
40

TIPS

42       Word-list-compress is best used with sorted word list type  files.   It
43       is  not a general purpose compression program since the resulting files
44       may actually increase in size.
45
46       Word-list-compress accepts up to 255 text characters in  the  range  of
47       {0x21...0xFF}.   If  your word list requires a larger character set for
48       certain languages or longer length for multi-word, scientific, medical,
49       technical  or  other use, then it is recommended that you compress your
50       word list using prezip-bin(1)
51

DIAGNOSTICS

53       Word-list-compress normally exits with a  return  code  of  0.   If  it
54       encounters  an  error,  a  message  is  sent  to  standard error output
55       (stderr), and word-list-compress exits with a  non-zero  return  value.
56       Error messages are listed below:
57
58       (display help/usage message)
59              Unknown  command given on the command line so word-list-compress
60              displays a usage message to standard error output.
61
62       Corrupt Input
63              This is only for the decompression command d.  The input file is
64              of an unknown format or the input file/stream is corrupted.  You
65              may have some valid output,  but  word-list-compress  could  not
66              complete  the  process.   If  the  input  file  is  a compressed
67              wordlist but you have no output file, then it  may  be  a  newer
68              prezip-bin(1) version of compressed file, if so, try decompress‐
69              ing the file with prezip-bin(1) instead.
70
71       Output Data Error
72              The output is full, write protected, or has an error and can  no
73              longer be written to.
74

REPORTING BUGS

82       For help, see the Aspell homepage at <http://aspell.net> and  send  bug
83       reports/comments to the Aspell user list at the above address.
84

AUTHOR

86       This  manual  page  was  written by Aaron Lehmann <aaronl@vitelus.com>,
87       Brian Nelson <pyro@debian.org> and Jose Da Silva <digital@joescat.com>.
88
89
90
91GNU                               2005-09-05             WORD-LIST-COMPRESS(1)