419 lines
15 KiB
HTML
419 lines
15 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of ASPELL</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>ASPELL</H1>
|
|
Section: Aspell Abbreviated User's Manual (1)<BR>Updated: 2006-12-10<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
aspell - interactive spell checker
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<B>aspell</B>
|
|
|
|
<I>[options] <command></I>
|
|
|
|
<BR>
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
<B>aspell</B>
|
|
|
|
is a utility program that connects to the Aspell library so that it can
|
|
function as an
|
|
<B>ispell -a</B>
|
|
|
|
replacement, as an independent spell checker, as a test utility to test
|
|
out Aspell library features, and as a utility for managing dictionaries
|
|
used by the library.
|
|
<P>
|
|
|
|
The Aspell library contains an interface allowing other programs direct
|
|
access to its functions and therefore reducing the complex task of
|
|
spell checking to simple library calls. The default library does not
|
|
contain dictionary word lists. To add language dictionaries, please
|
|
check your distro first for modified dictionaries, otherwise look here
|
|
for base language dictionaries <<A HREF="http://aspell.net">http://aspell.net</A>>.
|
|
<P>
|
|
|
|
The following information describes the commands and options used by the
|
|
Aspell Utility.
|
|
<P>
|
|
|
|
This manual page is maintained separately from the
|
|
official documentation so it may be out of date or incomplete. The
|
|
official documentation is maintained as a Texinfo manual. See the
|
|
`<B>aspell</B>'
|
|
|
|
entry in
|
|
<B>info</B>
|
|
|
|
for more complete documentation.
|
|
<A NAME="lbAE"> </A>
|
|
<H2>COMMANDS</H2>
|
|
|
|
<I><command></I>
|
|
|
|
is one of:
|
|
<DL COMPACT>
|
|
<DT id="1"><B>usage</B>, <B>-?</B><DD>
|
|
Send a brief Aspell Utility usage message to standard output. This is
|
|
a short summary listing more common spell-check commands and options.
|
|
<DT id="2"><B>help</B>
|
|
|
|
<DD>
|
|
Send a detailed Aspell Utility help message to standard output. This is
|
|
a complete list showing all commands, options, filters and dictionaries.
|
|
<DT id="3"><B>version</B>, <B>-v</B><DD>
|
|
Print version number of Aspell Library and Utility to standard output.
|
|
<DT id="4"><B>check</B> <I><file></I>, <B>-c</B> <I><file></I><DD>
|
|
Spell-check a single file.
|
|
<DT id="5"><B>pipe</B>, <B>-a</B><DD>
|
|
Run Aspell in
|
|
<I>ispell -a</I>
|
|
|
|
compatibility mode.
|
|
<DT id="6"><B>list</B>
|
|
|
|
<DD>
|
|
Produce a list of misspelled words from standard input.
|
|
<DT id="7">[<B>dump</B>] <B>config</B><DD>
|
|
Dump all current configuration options to standard output.
|
|
<DT id="8"><B>config </B><I><key></I>
|
|
|
|
<DD>
|
|
Send the current value of
|
|
<I><key></I>
|
|
|
|
to standard output.
|
|
<DT id="9"><B>soundslike</B>
|
|
|
|
<DD>
|
|
Output the soundslike equivalent of each word entered.
|
|
<DT id="10"><B>munch</B>
|
|
|
|
<DD>
|
|
Generate possible root words and affixes from an input list of words.
|
|
<DT id="11"><B>expand</B> [<B>1-4</B>]<DD>
|
|
Expands the affix flags of each affix compressed word entered.
|
|
<DT id="12"><B>clean</B> [<B>strict</B>]<DD>
|
|
Cleans an input word list so that every line is a valid word.
|
|
<DT id="13"><B>munch-list</B> [<B>simple</B>] [<B>single</B>|<B>multi</B>] [<B>keep</B>]<DD>
|
|
Reduce the size of a word list via affix compression.
|
|
<DT id="14"><B>conv</B> <I><from> <to></I> [<I><norm-form></I>]<DD>
|
|
Converts
|
|
<I><from></I>
|
|
|
|
one encoding
|
|
<I><to></I>
|
|
|
|
another.
|
|
<DT id="15"><B>norm</B> (<I><norm-map></I>|<I><from> <norm-map> <to></I>) [<I><norm-form></I>]<DD>
|
|
Perform Unicode normalization.
|
|
<DT id="16">[<B>dump</B>] <B>dicts</B>|<B>filters</B>|<B>modes</B><DD>
|
|
Lists available dictionaries, filters, or modes.
|
|
<DT id="17"><B>dump</B>|<B>create</B>|<B>merge master</B>|<B>personal</B>|<B>repl</B> <I><wordlist></I><DD>
|
|
dump, create, or merge a master, personal, or replacement word list.
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>DICTIONARY OPTIONS</H2>
|
|
|
|
The following options may be used to control which dictionaries to use
|
|
and how they behave.
|
|
<DL COMPACT>
|
|
<DT id="18"><B>--master=</B><I><name></I>, <B>-d</B> <I><name></I><DD>
|
|
Base name of the dictionary to use. If this option is specified then
|
|
Aspell will either use this dictionary or die.
|
|
<DT id="19"><B>--dict-dir=</B><I><directory></I><DD>
|
|
Location of the main dictionary word list.
|
|
<DT id="20"><B>--lang=</B><I><string></I>, <B>-l</B> <I><string></I><DD>
|
|
Language to use. It follows the same format of the LANG environmental
|
|
variable on most systems. It consists of the two letter ISO 639 language
|
|
code and an optional two letter ISO 3166 country code after a dash or
|
|
underscore. The default value is based on the value of the LC_MESSAGES
|
|
locale.
|
|
<DT id="21"><B>--size=</B><I><string></I><DD>
|
|
The preferred size of the dictionary word list. This consists of a two
|
|
char digit code describing the size of the list, with typical values of:
|
|
10=tiny, 20=really small, 30=small, 40=med-small, 50=med, 60=med-large,
|
|
70=large, 80=huge, 90=insane.
|
|
<DT id="22"><B>--variety=</B><I><string></I><DD>
|
|
Any extra information to distinguish this variety of dictionary from
|
|
other dictionaries which may have the same <I>lang</I> and <I>size</I>.
|
|
<DT id="23"><B>--jargon=</B><I><string></I><DD>
|
|
Please use the <I>variety</I> option since it replaces <I>jargon</I> as a
|
|
better choice. <I>jargon</I> will be removed in the future.
|
|
<DT id="24"><B>--word-list-path=</B><I><list of directories></I><DD>
|
|
Search path for word list information files.
|
|
<DT id="25"><B>--personal=</B><I><file></I>, <B>-p</B> <I><file></I><DD>
|
|
Personal word list file name.
|
|
<DT id="26"><B>--repl=</B><I><file></I><DD>
|
|
Replacements list file name.
|
|
<DT id="27"><B>--extra-dicts=</B><I><list></I><DD>
|
|
Extra dictionaries to use.
|
|
<DT id="28"><B>--ignore-accents</B><DD>
|
|
This option is not yet implemented.
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>CHECKER OPTIONS</H2>
|
|
|
|
These options control the behavior of Aspell when checking documents.
|
|
<DL COMPACT>
|
|
<DT id="29"><B>--ignore=</B><I><integer></I>, <B>-W</B> <I><integer></I><DD>
|
|
Ignore words <=
|
|
<I><integer></I>
|
|
|
|
characters in length.
|
|
<DT id="30"><B>--ignore-case</B>, <B>--dont-ignore-case</B><DD>
|
|
Ignore case when checking words.
|
|
<DT id="31"><B>--ignore-repl</B>, <B>--dont-ignore-repl</B><DD>
|
|
Ignore commands to store replacement pairs.
|
|
<DT id="32"><B>--save-repl</B>, <B>--dont-save-repl</B><DD>
|
|
Save the replacement word list on save all.
|
|
<DT id="33"><B>--sug-mode=</B><I><mode></I><DD>
|
|
Suggestion
|
|
<I><mode></I>
|
|
|
|
= <B>ultra</B>|<B>fast</B>|<B>normal</B>|<B>bad-spellers</B>
|
|
</DL>
|
|
<A NAME="lbAH"> </A>
|
|
<H2>FILTER OPTIONS</H2>
|
|
|
|
These options modify the behavior of the various filters.
|
|
<DL COMPACT>
|
|
<DT id="34"><B>--add-filter=</B><I><list></I>, <B>--rem-filter=</B><I><list></I><DD>
|
|
Add or remove a filter.
|
|
<DT id="35"><B>--add-filter-path=</B><I><paths></I>, <B>--rem-filter-path=</B><I><paths></I><DD>
|
|
Add or remove paths searched for filters.
|
|
<DT id="36"><B>--mode=</B><I><string></I>, <B>-e</B>, <B>-H</B>, <B>-t</B>, <B>-n</B><DD>
|
|
Sets the filter mode. <I>Mode</I> is one of none, url, email, html, tex
|
|
or nroff. The alternative shortcut options are '-e' for email, '-H'
|
|
for Html/Sgml, '-t' for Tex or '-n' for Nroff.
|
|
<DT id="37"><B>--encoding=</B><I><string></I><DD>
|
|
encoding the document is expected to be in. The default depends on the
|
|
current locale.
|
|
<DT id="38"><B>--add-email-quote=</B><I><list></I>, <B>--rem-email-quote=</B><I><list></I><DD>
|
|
Add or Remove a list of email quote characters.
|
|
<DT id="39"><B>--email-margin=</B><I><integer></I><DD>
|
|
Number of chars that can appear before the quote char.
|
|
<DT id="40"><B>--add-html-check=</B><I><list></I>, <B>--rem-html-check=</B><I><list></I><DD>
|
|
Add or remove a list of HTML attributes to always check. For example,
|
|
look inside alt= tags.
|
|
<DT id="41"><B>--add-html-skip=</B><I><list></I>, <B>--rem-html-skip=</B><I><list></I><DD>
|
|
Add or remove a list of HTML attributes to always skip while spell
|
|
checking.
|
|
<DT id="42"><B>--add-sgml-check=</B><I><list></I>, <B>--rem-sgml-check=</B><I><list></I><DD>
|
|
Add or remove a list of SGML attributes to always check for spelling.
|
|
<DT id="43"><B>--add-sgml-skip=</B><I><list></I>, <B>--rem-sgml-skip=</B><I><list></I><DD>
|
|
Add or remove a list of SGML attributes to always skip while spell
|
|
checking.
|
|
<DT id="44"><B>--sgml-extension=</B><I><list></I><DD>
|
|
SGML file extensions.
|
|
<DT id="45"><B>--tex-check-comments</B>, <B>--dont-tex-check-comments</B><DD>
|
|
Check TeX comments.
|
|
<DT id="46"><B>--add-tex-command=</B><I><list></I>, <B>--rem-tex-command=</B><I><list></I><DD>
|
|
Add or Remove a list of TeX commands.
|
|
</DL>
|
|
<A NAME="lbAI"> </A>
|
|
<H2>RUN-TOGETHER WORD OPTIONS</H2>
|
|
|
|
These may be used to control the behavior of run-together words.
|
|
<DL COMPACT>
|
|
<DT id="47"><B>--run-together</B>, <B>--dont-run-together</B>, <B>-C</B>, <B>-B</B><DD>
|
|
Consider run-together words valid.
|
|
<DT id="48"><B>--run-together-limit=</B><I><integer></I><DD>
|
|
Maximum number of words that can be strung together.
|
|
<DT id="49"><B>--run-together-min=</B><I><integer></I><DD>
|
|
Minimal length of interior words.
|
|
</DL>
|
|
<A NAME="lbAJ"> </A>
|
|
<H2>MISC OPTIONS</H2>
|
|
|
|
Miscellaneous options that don't fall under any other category.
|
|
<DL COMPACT>
|
|
<DT id="50"><B>--conf=</B><I><file name></I><DD>
|
|
Main configuration file. This file overrides Aspell's global defaults.
|
|
<DT id="51"><B>--conf-dir=</B><I><directory></I><DD>
|
|
Location of main configuration file.
|
|
<DT id="52"><B>--data-dir=</B><I><directory></I><DD>
|
|
Location of language data files.
|
|
<DT id="53"><B>--keyboard=</B><I><keyboard></I><DD>
|
|
Use this keyboard layout for suggesting possible words. These spelling
|
|
errors happen if a user accidentally presses a key next to the intended
|
|
correct key.
|
|
<DT id="54"><B>--local-data-dir=</B><I><directory></I><DD>
|
|
Alternative location of language data files. This directory is searched
|
|
before data-dir.
|
|
<DT id="55"><B>--home-dir=</B><I><directory></I><DD>
|
|
Directory Location for personal wordlist files.
|
|
<DT id="56"><B>--per-conf=</B><I><file name></I><DD>
|
|
Personal configuration file. This file overrides options found in the
|
|
global config file.
|
|
</DL>
|
|
<A NAME="lbAK"> </A>
|
|
<H2>ASPELL UTILITY OPTIONS</H2>
|
|
|
|
These options are part of the
|
|
<I>aspell</I>
|
|
|
|
Utility and work independently of the library.
|
|
<DL COMPACT>
|
|
<DT id="57"><B>--backup</B>, <B>--dont-backup</B>, <B>-b</B>, <B>-x</B><DD>
|
|
The aspell utility creates a backup file by making a copy and appending
|
|
<I>.bak</I>
|
|
|
|
to file name. This only applies when the command is
|
|
<I>check <file></I>
|
|
|
|
and the backup file is only created if any spelling modifications take
|
|
place.
|
|
<DT id="58"><B>--byte-offsets</B>, <B>--dont-byte-offsets</B><DD>
|
|
Use byte offsets instead of character offsets.
|
|
<DT id="59"><B>--guess</B>, <B>--dont-guess</B>, <B>-m</B>, <B>-P</B><DD>
|
|
Create missing root/affix combinations not in the dictionary in
|
|
<B>pipe</B> mode.
|
|
<DT id="60"><B>--keymapping=aspell</B>, <B>--keymapping=ispell</B><DD>
|
|
The keymapping to use, either
|
|
<I>aspell</I>
|
|
|
|
for the default mapping or
|
|
<I>ispell</I>
|
|
|
|
to use the same mapping that the Ispell utility uses.
|
|
<DT id="61"><B>--reverse</B>, <B>--dont-reverse</B><DD>
|
|
Reverse the order of the suggestions list in pipe mode.
|
|
<DT id="62"><B>--suggest</B>, <B>--dont-suggest</B><DD>
|
|
Suggest possible replacements in pipe mode. If false, Aspell will simply
|
|
report the misspelling and make no attempt at suggestions or possible
|
|
corrections.
|
|
<DT id="63"><B>--time</B>, <B>--dont-time</B><DD>
|
|
Time the load time and suggest a time in pipe mode.
|
|
</DL>
|
|
<P>
|
|
|
|
In addition Aspell will try to make sense out of Ispell's command line
|
|
options so that it can function as a drop in replacement for Ispell. If
|
|
Aspell is run without any command line options it will display a brief
|
|
help screen and quit.
|
|
<A NAME="lbAL"> </A>
|
|
<H2>CONFIGURATION</H2>
|
|
|
|
Aspell can accept options via global or personal configuration files so
|
|
that you do not need to specify them each time at the command line. The
|
|
default global configuration file is
|
|
<I>/etc/aspell.conf</I>
|
|
|
|
or another file specified by option <I>--conf</I> and is checked first.
|
|
The default per user configuration file
|
|
<I>~/.aspell.conf</I>
|
|
|
|
located in the
|
|
<B>$HOME</B>
|
|
|
|
directory (or another file specified by option <I>--per-conf</I>) is
|
|
checked next and overrides options set in the global config file.
|
|
Options specified at either the command line or via an environmental
|
|
variable override those specified by either configuration file.
|
|
<P>
|
|
|
|
Each line of the configuration file has the format:
|
|
<P>
|
|
|
|
<DL COMPACT><DT id="64"><DD>
|
|
<B>option</B> <I>[value]</I>
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
where
|
|
<B>option</B>
|
|
|
|
is any one of the standard library options above without the leading
|
|
dashes. For example the following line will set the default language to
|
|
Swiss German:
|
|
<P>
|
|
|
|
<DL COMPACT><DT id="65"><DD>
|
|
<B>lang de_CH</B>
|
|
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
There may be any number of spaces between the option and the value,
|
|
however it can only be spaces, i.e. there is no '=' between the option
|
|
name and the value. Comments may also be included by preceding them
|
|
with a '#' as anything from a '#' to a newline is ignored. Blank lines
|
|
are also allowed. The <I>/etc/aspell.conf</I> file is a good example of
|
|
how to set these options and the Aspell Manual has more detailed info.
|
|
<A NAME="lbAM"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<P>
|
|
|
|
<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),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?1+word-list-compress">word-list-compress</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="lbAN"> </A>
|
|
<H2>SUPPORT</H2>
|
|
|
|
Support for Aspell can be found on the Aspell mailing lists.
|
|
Instructions for joining the various mailing lists (and an archive of
|
|
them) can be found off the Aspell home page at <<A HREF="http://aspell.net">http://aspell.net</A>>.
|
|
Bug reports should be submitted via GitHub Issues rather than being
|
|
posted to the mailing lists.
|
|
<A NAME="lbAO"> </A>
|
|
<H2>AUTHOR</H2>
|
|
|
|
This manual page was written by Brian Nelson <<A HREF="mailto:pyro@debian.org">pyro@debian.org</A>> based
|
|
on the Aspell User's Manual, Copyright © 2002 Kevin Atkinson.
|
|
Updated Nov 2006 by Jose Da Silva <<A HREF="mailto:digital@joescat.com">digital@joescat.com</A>>, and Dec 2006
|
|
by Kevin Atkinson <<A HREF="mailto:kevina@gnu.org">kevina@gnu.org</A>>.
|
|
<P>
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="66"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="67"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="68"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="69"><A HREF="#lbAE">COMMANDS</A><DD>
|
|
<DT id="70"><A HREF="#lbAF">DICTIONARY OPTIONS</A><DD>
|
|
<DT id="71"><A HREF="#lbAG">CHECKER OPTIONS</A><DD>
|
|
<DT id="72"><A HREF="#lbAH">FILTER OPTIONS</A><DD>
|
|
<DT id="73"><A HREF="#lbAI">RUN-TOGETHER WORD OPTIONS</A><DD>
|
|
<DT id="74"><A HREF="#lbAJ">MISC OPTIONS</A><DD>
|
|
<DT id="75"><A HREF="#lbAK">ASPELL UTILITY OPTIONS</A><DD>
|
|
<DT id="76"><A HREF="#lbAL">CONFIGURATION</A><DD>
|
|
<DT id="77"><A HREF="#lbAM">SEE ALSO</A><DD>
|
|
<DT id="78"><A HREF="#lbAN">SUPPORT</A><DD>
|
|
<DT id="79"><A HREF="#lbAO">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:07 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|