manual/word-list-compress.1

   1 .TH WORD\-LIST\-COMPRESS 1 "2005-09-05" "GNU" "Aspell Abbreviated User's Manual"
   2 .SH NAME
   3 word\-list\-compress \- word list compressor/decompressor for GNU Aspell
   4 .SH SYNOPSIS
   5 .B word-list-compress
   6 \fBc\fR[\fBompress\fR] | \fBd\fR[\fBecompress\fR]
   7 .SH DESCRIPTION
   8 .B word-list-compress
   9 compresses or decompresses sorted word lists for use with the GNU Aspell
  10 spell checker.
  11 .SH COMMANDS
  12 .TP
  13 \fB\-c\fR, \fBc\fR, \fBcompress\fR
  14 compress the plain text word list read from standard input.
  15 .TP
  16 \fB\-d\fR, \fBd\fR, \fBdecompress\fR
  17 decompress the compressed word list read from standard input.
  18 .SH EXAMPLES
  19 Here are a few examples of how you can use
  20 .I word\-list\-compress
  21 .TP
  22 word\-list\-compress \fBd\fR <wordlist.cwl >wordlist.txt
  23 Decompress file wordlist.cwl to text file wordlist.txt
  24 .TP
  25 word\-list\-compress \fBc\fR <wordlist.wl >wordlist.cwl 2>errors.txt
  26 Compress wordlist.wl to wordlist.cwl and send any error messages to a
  27 text file named errors.txt
  28 .TP
  29 LC_COLLATE\=C sort \-u <wordlist.txt \fB|\fR word\-list\-compress c >wordlist.cwl
  30 Sort a word list, then pipe it to
  31 .I word\-list\-compress
  32 to create a compressed binary wordlist.cwl file.
  33 .TP
  34 word\-list\-compress d <words.cwl \fB|\fR aspell create master ./words.rws
  35 Decompress a wordlist, then pipe it to
  36 .I aspell(1)
  37 to create a spelling list.  Please check the
  38 .I aspell(1)
  39 info manual for proper usage and options.
  40 .SH TIPS
  41 .I Word\-list\-compress
  42 is best used with sorted word list type files.  It is not a general
  43 purpose compression program since the resulting files may actually
  44 increase in size.
  45 .PP
  46 .I Word\-list\-compress
  47 accepts up to 255 text characters in the range of {0x21...0xFF}. If your
  48 word list requires a larger character set for certain languages or
  49 longer length for multi\-word, scientific, medical, technical or other
  50 use, then it is recommended that you compress your word list using
  51 .I prezip\-bin(1)
  52 .
  53 .SH DIAGNOSTICS
  54 .I Word\-list\-compress
  55 normally exits with a return code of 0. If it encounters an error,
  56 a message is sent to standard error output (stderr), and
  57 .I word\-list\-compress
  58 exits with a non-zero return value.  Error messages are listed below:
  59 .TP
  60 \fB(display help/usage message)\fR
  61 Unknown command given on the command line so
  62 .I word\-list\-compress
  63 displays a usage message to standard error output.
  64 .TP
  65 \fBCorrupt Input\fR
  66 This is only for the decompression command \fBd\fR.  The input file is
  67 of an unknown format or the input file/stream is corrupted.  You may
  68 have some valid output, but
  69 .I word\-list\-compress
  70 could not complete the process.  If the input file is a compressed
  71 wordlist but you have no output file, then it may be a newer
  72 .I prezip\-bin(1)
  73 version of compressed file, if so, try decompressing the file with
  74 .I prezip\-bin(1)
  75 instead.
  76 .TP
  77 \fBOutput Data Error\fR
  78 The output is full, write protected, or has an error and can no longer
  79 be written to.
  80 .SH SEE ALSO
  81 .PP
  82 .BR aspell (1),
  83 .BR aspell\-import (1),
  84 .BR prezip\-bin (1),
  85 .BR run\-with\-aspell (1)
  86 .PP
  87 Aspell is fully documented in its Texinfo manual.  See the
  88 .RB "`\|" aspell "\|'"
  89 entry in
  90 .B info
  91 for more complete documentation.
  92 .SH REPORTING BUGS
  93 For help, see the Aspell homepage at <http://aspell.net> and send bug
  94 reports/comments to the Aspell user list at the above address.
  95 .SH AUTHOR
  96 This manual page was written by Aaron Lehmann <aaronl@vitelus.com>,
  97 Brian Nelson <pyro@debian.org> and Jose Da Silva <digital@joescat.com>.