/usr/share/doc/aspell-doc/aspell.html/Specifying-Options.html is in aspell-doc 0.60.7~20110707-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This is the user's manual for Aspell
GNU Aspell is a spell checker designed to eventually replace Ispell.
It can either be used as a library or as an independent spell checker.
Copyright © 2000-2011 Kevin Atkinson.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1 or
any later version published by the Free Software Foundation; with no
Invariant Sections, no Front-Cover Texts and no Back-Cover Texts. A
copy of the license is included in the section entitled "GNU Free
Documentation License". -->
<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Aspell 0.60.7-pre: Specifying Options</title>
<meta name="description" content="Aspell 0.60.7-pre spell checker user’s manual.">
<meta name="keywords" content="GNU Aspell 0.60.7-pre: Specifying Options">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link href="index.html#Top" rel="start" title="Top">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Customizing-Aspell.html#Customizing-Aspell" rel="up" title="Customizing Aspell">
<link href="The-Options.html#The-Options" rel="next" title="The Options">
<link href="Customizing-Aspell.html#Customizing-Aspell" rel="prev" title="Customizing Aspell">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>
</head>
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Specifying-Options"></a>
<div class="header">
<p>
Next: <a href="The-Options.html#The-Options" accesskey="n" rel="next">The Options</a>, Up: <a href="Customizing-Aspell.html#Customizing-Aspell" accesskey="u" rel="up">Customizing Aspell</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<hr>
<a name="Specifying-Options-1"></a>
<h3 class="section">4.1 Specifying Options</h3>
<a name="At-the-Command-Line"></a>
<h4 class="subsection">4.1.1 At the Command Line</h4>
<p>All options specified at the command line have the following basic format:
</p>
<div class="example">
<pre class="example">--<var>option</var>[=<var>value</var>]
</pre></div>
<p>where the ‘<samp>=</samp>’ can be replaced by whitespace.
</p>
<p>Some options also have single letter abbreviations of the form:
</p>
<div class="example">
<pre class="example"><var>letter</var> [<var>optional_whitespace</var> <var>value</var>]
</pre></div>
<p>Any non-ASCII characters are expected to be in the encoding
specified by the current locale.
</p>
<p>To reset an option to the default value, prefix the option with a
‘<samp>reset-</samp>’ and don’t specify a value.
</p>
<a name="Value-options"></a>
<h4 class="subsubsection">4.1.1.1 Value options</h4>
<p>To specify a value option simply specify the option with its
corresponding value. For example to set the filter mode to TeX use
‘<samp>--mode=tex</samp>’.
</p>
<p>If a value option has a single letter shortcut simply specify the single
letter shortcut with its corresponding value. For example to use a the
accented version of the American English dictionary use ‘<samp>-d
en_US-w_accents</samp>’.
</p>
<a name="Boolean-options"></a>
<h4 class="subsubsection">4.1.1.2 Boolean options</h4>
<p>To enable a boolean option simply specify the option without any
corresponding value, or prefix it with an ‘<samp>enable-</samp>’. For example
to create a backup file use ‘<samp>--backup</samp>’. To disable a boolean
option prefix the option name with a ‘<samp>dont-</samp>’ or ‘<samp>disable-</samp>’.
To avoid creating a backup file use ‘<samp>--dont-backup</samp>’. Boolean options
can also be set directly like a value option where the value is either
"true" or "false", for example ‘<samp>--backup=true</samp>’.
</p>
<p>If a boolean option has a single letter abbreviation simply give the
letter corresponding to either enabling or disabling the option
without any corresponding value. For example, to consider run-together
words valid use ‘<samp>-C</samp>’ or to consider them invalid use
‘<samp>-B</samp>’
</p>
<a name="List-options"></a>
<h4 class="subsubsection">4.1.1.3 List options</h4>
<p>To add a value to the list, prefix the option name with an
‘<samp>add-</samp>’ and then specify the value to add. For example, to add
the URL filter use ‘<samp>--add-filter url</samp>’. To remove a value from
a list option, prefix the option name with a ‘<samp>rem-</samp>’ and then
specify the value to remove. For example, to remove the URL filter use
‘<samp>--rem-filter url</samp>’. To remove all items from a list prefix the
option name with a ‘<samp>clear-</samp>’ without specify any value. For
example, to remove all filters use ‘<samp>--clear-filter</samp>’.
</p>
<p>A list option can also be set directly, in which case it will be set to
a single value. To directly set a list option to multiple values prefix
the option name with a ‘<samp>lset-</samp>’ and separate each value with a
‘<samp>:</samp>’. For example, to use the URL and TeX filter use
‘<samp>--lset-filter url:tex</samp>’.
</p>
<a name="Via-a-Configuration-File"></a>
<h4 class="subsection">4.1.2 Via a Configuration File</h4>
<p>Aspell can also accept options via a personal or global configuration
file. The exact files to used are specified by the options
<samp>per-conf</samp> and <samp>conf</samp> respectively but the personal
configuration file is normally <samp>.aspell.conf</samp> located in the
<code>HOME</code> directory and the global one is normally <samp>aspell.conf</samp>
which is located in the <samp>etc</samp> directory which is normally
<samp>/usr/etc</samp> or <samp>/usr/local/etc</samp>. To find out the particular
values for your particular system use <code>aspell dump config</code>.
</p>
<p>Each line of the configuration file has the format:
</p>
<div class="example">
<pre class="example"><var>option</var> [<var>value</var>]
</pre></div>
<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 ‘<samp>=</samp>’ between the
option name and the value and there are no preceding ‘<samp>--</samp>’ as
used on the command line.
</p>
<p>Comments may also be included by preceding them with a ‘<samp>#</samp>’ as
anything from a ‘<samp>#</samp>’ to a newline is ignored. Blank lines are also
allowed.
</p>
<p>To include a literal ‘<samp>#</samp>’ use ‘<samp>\#</samp>’. To include a literal
‘<samp>\</samp>’ use ‘<samp>\\</samp>’. Any other non-alpha character can also be
protected by a ‘<samp>\</samp>’ if necessary.
</p>
<p>Any non-ASCII characters are expected to be in UTF-8.
</p>
<p>To reset an option to the default value prefix the option with a
‘<samp>reset-</samp>’ and don’t specify a value.
</p>
<p>Values set in the personal configuration file override those in the
global file. Options specified at either the command line or via an
environment variable override those specified by either configuration
file.
</p>
<blockquote>
<p><b>Note:</b> Filters and corresponding options also may be assembled
inside a special meta filter file named <samp><var>metafilter</var>.flt</samp>. A
filter has to be loaded via adding a <code>add-filter <var>filtername</var></code>
line to the meta filter file before its options may be specified.
</p></blockquote>
<a name="Value-options-1"></a>
<h4 class="subsubsection">4.1.2.1 Value options</h4>
<p>To specify a value option simply include the option followed by the
corresponding value. For example to set the default language to
German use <samp>lang german</samp>.
</p>
<a name="Boolean-options-1"></a>
<h4 class="subsubsection">4.1.2.2 Boolean options</h4>
<p>To specify a boolean option simply include the option followed by a
‘<samp>true</samp>’ to enable it or a ‘<samp>false</samp>’ to disable it. For example
to allow run-together words use ‘<samp>run-together true</samp>’.
</p>
<a name="List-options-1"></a>
<h4 class="subsubsection">4.1.2.3 List options</h4>
<p>To add a value to the list, prefix the option name with an
‘<samp>add-</samp>’ and then specify the value to add. For example to add
the URL filter use ‘<samp>add-filter url</samp>’. To remove a value from
a list option prefix the option name with a ‘<samp>rem-</samp>’ and then
specify the value to remove. For example, to remove the URL filter use
‘<samp>rem-filter url</samp>’. To remove all items from a list prefix the
option name with a ‘<samp>clear-</samp>’ without specifying any value. For
example, to remove all filters use ‘<samp>clear-filter</samp>’.
</p>
<p>A list option can also be set directly, in which case it will be set to
a single value. To directly set a list option to multiple values prefix
the option name with a ‘<samp>lset-</samp>’ and separate each value with a
‘<samp>:</samp>’. For example, to use the URL and TeX filter use
‘<samp>lset-filter url:tex</samp>’. To include a literal ‘<samp>:</samp>’ use
‘<samp>\:</samp>’.
</p>
<a name="Setting-Options-via-an-Environment-Variable"></a>
<h4 class="subsection">4.1.3 Setting Options via an Environment Variable</h4>
<p>The environment variable <code>ASPELL_CONF</code> may also be used and it
overrides any options set in the configuration file. The format of
the string is exactly the same as the configuration file except that
semicolons (‘<samp>;</samp>’) are used instead of newlines.
</p>
<hr>
<div class="header">
<p>
Next: <a href="The-Options.html#The-Options" accesskey="n" rel="next">The Options</a>, Up: <a href="Customizing-Aspell.html#Customizing-Aspell" accesskey="u" rel="up">Customizing Aspell</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
</body>
</html>
|