man-pages/man1/word-list-compress.1.html
2021-03-31 01:06:50 +01:00

168 lines
5.4 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of WORD-LIST-COMPRESS</TITLE>
</HEAD><BODY>
<H1>WORD-LIST-COMPRESS</H1>
Section: Aspell Abbreviated User's Manual (1)<BR>Updated: 2005-09-05<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
word-list-compress - word list compressor/decompressor for GNU Aspell
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<B>word-list-compress</B>
<B>c</B>[<B>ompress</B>] | <B>d</B>[<B>ecompress</B>]
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<B>word-list-compress</B>
compresses or decompresses sorted word lists for use with the GNU Aspell
spell checker.
<A NAME="lbAE">&nbsp;</A>
<H2>COMMANDS</H2>
<DL COMPACT>
<DT id="1"><B>-c</B>, <B>c</B>, <B>compress</B><DD>
compress the plain text word list read from standard input.
<DT id="2"><B>-d</B>, <B>d</B>, <B>decompress</B><DD>
decompress the compressed word list read from standard input.
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>EXAMPLES</H2>
Here are a few examples of how you can use
<I>word-list-compress</I>
<DL COMPACT>
<DT id="3">word-list-compress <B>d</B> &lt;wordlist.cwl &gt;wordlist.txt<DD>
Decompress file wordlist.cwl to text file wordlist.txt
<DT id="4">word-list-compress <B>c</B> &lt;wordlist.wl &gt;wordlist.cwl 2&gt;errors.txt<DD>
Compress wordlist.wl to wordlist.cwl and send any error messages to a
text file named errors.txt
<DT id="5">LC_COLLATE=C sort -u &lt;wordlist.txt <B>|</B> word-list-compress c &gt;wordlist.cwl<DD>
Sort a word list, then pipe it to
<I>word-list-compress</I>
to create a compressed binary wordlist.cwl file.
<DT id="6">word-list-compress d &lt;words.cwl <B>|</B> aspell create master ./words.rws<DD>
Decompress a wordlist, then pipe it to
<I><A HREF="/cgi-bin/man/man2html?1+aspell">aspell</A>(1)</I>
to create a spelling list. Please check the
<I><A HREF="/cgi-bin/man/man2html?1+aspell">aspell</A>(1)</I>
info manual for proper usage and options.
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>TIPS</H2>
<I>Word-list-compress</I>
is best used with sorted word list type files. It is not a general
purpose compression program since the resulting files may actually
increase in size.
<P>
<I>Word-list-compress</I>
accepts up to 255 text characters in the range of {0x21...0xFF}. If your
word list requires a larger character set for certain languages or
longer length for multi-word, scientific, medical, technical or other
use, then it is recommended that you compress your word list using
<I><A HREF="/cgi-bin/man/man2html?1+prezip-bin">prezip-bin</A>(1)</I>
<A NAME="lbAH">&nbsp;</A>
<H2>DIAGNOSTICS</H2>
<I>Word-list-compress</I>
normally exits with a return code of 0. If it encounters an error,
a message is sent to standard error output (stderr), and
<I>word-list-compress</I>
exits with a non-zero return value. Error messages are listed below:
<DL COMPACT>
<DT id="7"><B>(display help/usage message)</B><DD>
Unknown command given on the command line so
<I>word-list-compress</I>
displays a usage message to standard error output.
<DT id="8"><B>Corrupt Input</B><DD>
This is only for the decompression command <B>d</B>. The input file is
of an unknown format or the input file/stream is corrupted. You may
have some valid output, but
<I>word-list-compress</I>
could not complete the process. If the input file is a compressed
wordlist but you have no output file, then it may be a newer
<I><A HREF="/cgi-bin/man/man2html?1+prezip-bin">prezip-bin</A>(1)</I>
version of compressed file, if so, try decompressing the file with
<I><A HREF="/cgi-bin/man/man2html?1+prezip-bin">prezip-bin</A>(1)</I>
instead.
<DT id="9"><B>Output Data Error</B><DD>
The output is full, write protected, or has an error and can no longer
be written to.
</DL>
<A NAME="lbAI">&nbsp;</A>
<H2>SEE ALSO</H2>
<P>
<B><A HREF="/cgi-bin/man/man2html?1+aspell">aspell</A></B>(1),
<B><A HREF="/cgi-bin/man/man2html?1+aspell-import">aspell-import</A></B>(1),
<B><A HREF="/cgi-bin/man/man2html?1+prezip-bin">prezip-bin</A></B>(1),
<B><A HREF="/cgi-bin/man/man2html?1+run-with-aspell">run-with-aspell</A></B>(1)
<P>
Aspell is fully documented in its Texinfo manual. See the
`<B>aspell</B>'
entry in
<B>info</B>
for more complete documentation.
<A NAME="lbAJ">&nbsp;</A>
<H2>REPORTING BUGS</H2>
For help, see the Aspell homepage at &lt;<A HREF="http://aspell.net">http://aspell.net</A>&gt; and send bug
reports/comments to the Aspell user list at the above address.
<A NAME="lbAK">&nbsp;</A>
<H2>AUTHOR</H2>
This manual page was written by Aaron Lehmann &lt;<A HREF="mailto:aaronl@vitelus.com">aaronl@vitelus.com</A>&gt;,
Brian Nelson &lt;<A HREF="mailto:pyro@debian.org">pyro@debian.org</A>&gt; and Jose Da Silva &lt;<A HREF="mailto:digital@joescat.com">digital@joescat.com</A>&gt;.
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="10"><A HREF="#lbAB">NAME</A><DD>
<DT id="11"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="12"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="13"><A HREF="#lbAE">COMMANDS</A><DD>
<DT id="14"><A HREF="#lbAF">EXAMPLES</A><DD>
<DT id="15"><A HREF="#lbAG">TIPS</A><DD>
<DT id="16"><A HREF="#lbAH">DIAGNOSTICS</A><DD>
<DT id="17"><A HREF="#lbAI">SEE ALSO</A><DD>
<DT id="18"><A HREF="#lbAJ">REPORTING BUGS</A><DD>
<DT id="19"><A HREF="#lbAK">AUTHOR</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:29 GMT, March 31, 2021
</BODY>
</HTML>