diff options
-rw-r--r-- | .github/workflows/c-cpp.yml | 8 | ||||
-rw-r--r-- | src/.gitignore | 3 | ||||
-rw-r--r-- | src/Makefile.am | 9 | ||||
-rw-r--r-- | src/enchant-2.html | 162 | ||||
-rw-r--r-- | src/enchant-lsmod-2.html | 132 | ||||
-rw-r--r-- | src/enchant.html | 184 |
6 files changed, 493 insertions, 5 deletions
diff --git a/.github/workflows/c-cpp.yml b/.github/workflows/c-cpp.yml index 56e25dc..54f26c2 100644 --- a/.github/workflows/c-cpp.yml +++ b/.github/workflows/c-cpp.yml @@ -5,7 +5,7 @@ on: [ push, pull_request ] jobs: build: - runs-on: ubuntu-latest + runs-on: ubuntu-22.04 env: ASAN_FLAGS: "-fsanitize=address -fsanitize=undefined" @@ -13,7 +13,7 @@ jobs: - uses: actions/checkout@v2 with: { submodules: true } - name: Install dependencies - run: sudo apt-get -y install libglib2.0-dev libaspell-dev hspell libhunspell-dev libvoikko-dev voikko-fi aspell-en libunittest++-dev hunspell-fr + run: sudo apt-get -y install libglib2.0-dev libaspell-dev hspell libhunspell-dev libvoikko-dev voikko-fi aspell-en libunittest++-dev hunspell-fr groff - name: Install nuspell run: | sudo apt-get -y install libicu-dev ninja-build @@ -46,7 +46,7 @@ jobs: - name: Install dependencies run: | brew tap nuspell/nuspell - brew install automake dbus-glib hspell hunspell libvoikko unittest-cpp nuspell coreutils + brew install automake dbus-glib groff hspell hunspell libvoikko unittest-cpp nuspell coreutils - name: Bootstrap (gnulib and autoreconf) run: PATH="$(brew --prefix)/opt/m4/bin:${PATH}" ./bootstrap - name: configure @@ -76,7 +76,7 @@ jobs: release: false msystem: ${{matrix.sys}} install: >- - patch git + patch git groff mingw-w64-${{matrix.env}}-autotools mingw-w64-${{matrix.env}}-gcc mingw-w64-${{matrix.env}}-glib2 diff --git a/src/.gitignore b/src/.gitignore index fad1440..0e9dece 100644 --- a/src/.gitignore +++ b/src/.gitignore @@ -1,8 +1,11 @@ /enchant-[1-9] /enchant.[15] +/enchant.html /enchant-[1-9].1 +/enchant-[1-9].html /enchant-[1-9].exe /enchant-lsmod-[1-9] +/enchant-lsmod-[1-9].html /enchant-lsmod-[1-9].exe /enchant-lsmod.1 /enchant-lsmod-[1-9].1 diff --git a/src/Makefile.am b/src/Makefile.am index b40b174..96b45a2 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -24,11 +24,18 @@ noinst_HEADERS = debug.h pkgdata_DATA = enchant.ordering dist_man_MANS = enchant-@ENCHANT_MAJOR_VERSION@.1 enchant-lsmod-@ENCHANT_MAJOR_VERSION@.1 enchant.5 +nodist_doc_DATA = enchant-@ENCHANT_MAJOR_VERSION@.html enchant-lsmod-@ENCHANT_MAJOR_VERSION@.html enchant.html edit = sed \ -e 's|DATADIR|$(datadir)|g' -DISTCLEANFILES = $(dist_man_MANS) +DISTCLEANFILES = $(dist_man_MANS) $(nodist_doc_DATA) + +.1.html: + groff -mandoc -Thtml $< > $@ + +enchant.html: enchant.5 + groff -mandoc -Thtml $< > $@ enchant-@ENCHANT_MAJOR_VERSION@.1: $(builddir)/enchant.1 Makefile.am $(top_builddir)/config.status rm -f $@ $@.tmp diff --git a/src/enchant-2.html b/src/enchant-2.html new file mode 100644 index 0000000..4353067 --- /dev/null +++ b/src/enchant-2.html @@ -0,0 +1,162 @@ +<!-- Creator : groff version 1.22.4 --> +<!-- CreationDate: Sun Sep 25 10:09:02 2022 --> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" +"http://www.w3.org/TR/html4/loose.dtd"> +<html> +<head> +<meta name="generator" content="groff -Thtml, see www.gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<meta name="Content-Style" content="text/css"> +<style type="text/css"> + p { margin-top: 0; margin-bottom: 0; vertical-align: top } + pre { margin-top: 0; margin-bottom: 0; vertical-align: top } + table { margin-top: 0; margin-bottom: 0; vertical-align: top } + h1 { text-align: center } +</style> +<title>ENCHANT-2</title> + +</head> +<body> + +<h1 align="center">ENCHANT-2</h1> + +<a href="#NAME">NAME</a><br> +<a href="#SYNOPSIS">SYNOPSIS</a><br> +<a href="#DESCRIPTION">DESCRIPTION</a><br> +<a href="#FILES AND DIRECTORIES">FILES AND DIRECTORIES</a><br> +<a href="#SEE ALSO">SEE ALSO</a><br> +<a href="#AUTHOR">AUTHOR</a><br> + +<hr> + + +<h2>NAME +<a name="NAME"></a> +</h2> + + +<p style="margin-left:11%; margin-top: 1em">Enchant - a +spellchecker</p> + +<h2>SYNOPSIS +<a name="SYNOPSIS"></a> +</h2> + + +<p style="margin-left:11%; margin-top: 1em"><b>enchant-2 +-a</b>|<b>-l</b>|<b>-h</b>|<b>-v</b> [<b>-L</b>] [<b>-d</b> +<i>DICTIONARY</i>] [<i>FILE</i>]</p> + +<h2>DESCRIPTION +<a name="DESCRIPTION"></a> +</h2> + + +<p style="margin-left:11%; margin-top: 1em"><b>Enchant</b> +is an ispell-compatible spellchecker. <b><br> +-d</b> <i>DICTIONARY</i></p> + +<p style="margin-left:22%;">use the given dictionary</p> + +<p style="margin-left:11%;"><b>-p</b> <i>WORDLIST</i></p> + +<p style="margin-left:22%;">use the given personal +wordlist</p> + +<table width="100%" border="0" rules="none" frame="void" + cellspacing="0" cellpadding="0"> +<tr valign="top" align="left"> +<td width="11%"></td> +<td width="3%"> + + +<p><b>-a</b></p></td> +<td width="8%"></td> +<td width="66%"> + + +<p>list suggestions in ispell pipe mode format</p></td> +<td width="12%"> +</td></tr> +<tr valign="top" align="left"> +<td width="11%"></td> +<td width="3%"> + + +<p><b>-l</b></p></td> +<td width="8%"></td> +<td width="66%"> + + +<p>list only the misspellings</p></td> +<td width="12%"> +</td></tr> +<tr valign="top" align="left"> +<td width="11%"></td> +<td width="3%"> + + +<p><b>-L</b></p></td> +<td width="8%"></td> +<td width="66%"> + + +<p>display line numbers</p></td> +<td width="12%"> +</td></tr> +<tr valign="top" align="left"> +<td width="11%"></td> +<td width="3%"> + + +<p><b>-h</b></p></td> +<td width="8%"></td> +<td width="66%"> + + +<p>display help and exit</p></td> +<td width="12%"> +</td></tr> +<tr valign="top" align="left"> +<td width="11%"></td> +<td width="3%"> + + +<p><b>-v</b></p></td> +<td width="8%"></td> +<td width="66%"> + + +<p>display version information and exit</p></td> +<td width="12%"> +</td></tr> +</table> + +<h2>FILES AND DIRECTORIES +<a name="FILES AND DIRECTORIES"></a> +</h2> + + +<p style="margin-left:11%; margin-top: 1em">See +<b>enchant</b>(5) for details of configuration files and +personal word lists.</p> + +<h2>SEE ALSO +<a name="SEE ALSO"></a> +</h2> + + + +<p style="margin-left:11%; margin-top: 1em"><b>enchant-2</b>(5), +<b>aspell</b>(1), <b>enchant-lsmod-2</b>(1)</p> + +<h2>AUTHOR +<a name="AUTHOR"></a> +</h2> + + +<p style="margin-left:11%; margin-top: 1em">Written by Dom +Lachowicz and Reuben Thomas.</p> +<hr> +</body> +</html> diff --git a/src/enchant-lsmod-2.html b/src/enchant-lsmod-2.html new file mode 100644 index 0000000..0cced46 --- /dev/null +++ b/src/enchant-lsmod-2.html @@ -0,0 +1,132 @@ +<!-- Creator : groff version 1.22.4 --> +<!-- CreationDate: Sun Sep 25 10:09:02 2022 --> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" +"http://www.w3.org/TR/html4/loose.dtd"> +<html> +<head> +<meta name="generator" content="groff -Thtml, see www.gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<meta name="Content-Style" content="text/css"> +<style type="text/css"> + p { margin-top: 0; margin-bottom: 0; vertical-align: top } + pre { margin-top: 0; margin-bottom: 0; vertical-align: top } + table { margin-top: 0; margin-bottom: 0; vertical-align: top } + h1 { text-align: center } +</style> +<title>ENCHANT-LSMOD-2</title> + +</head> +<body> + +<h1 align="center">ENCHANT-LSMOD-2</h1> + +<a href="#NAME">NAME</a><br> +<a href="#SYNOPSIS">SYNOPSIS</a><br> +<a href="#DESCRIPTION">DESCRIPTION</a><br> +<a href="#SEE ALSO">SEE ALSO</a><br> +<a href="#AUTHOR">AUTHOR</a><br> + +<hr> + + +<h2>NAME +<a name="NAME"></a> +</h2> + + +<p style="margin-left:11%; margin-top: 1em">enchant-lsmod - +list provider and dictionary information</p> + +<h2>SYNOPSIS +<a name="SYNOPSIS"></a> +</h2> + + + +<p style="margin-left:11%; margin-top: 1em"><b>enchant-lsmod-2</b> +[[<b>-lang</b>|<b>-word-chars</b>] +[<b>language_tag</b>]|<b>-list-dicts</b>|<b>-help</b>|<b>-version</b>]</p> + +<h2>DESCRIPTION +<a name="DESCRIPTION"></a> +</h2> + + + +<p style="margin-left:11%; margin-top: 1em"><b>enchant-lsmod-2</b> +gives information about Enchant’s spell-checker +providers and the dictionaries each offers. See +<b>enchant-2</b>(1) for details about how the providers and +dictionaries are located. If no command-line options are +given, the available providers are listed.</p> + + +<p style="margin-left:11%; margin-top: 1em"><b>OPTIONS</b></p> + +<table width="100%" border="0" rules="none" frame="void" + cellspacing="0" cellpadding="0"> +<tr valign="top" align="left"> +<td width="11%"></td> +<td width="7%"> + + +<p><b>-lang</b></p></td> +<td width="4%"></td> +<td width="78%"> + + +<p>Show which provider and dictionary will be used for the +given language, or all languages if none is supplied.</p></td></tr> +</table> + +<p style="margin-left:11%;"><b>-word-chars</b></p> + +<p style="margin-left:22%;">Show the extra word characters +for the given language, if available. This is of little +interest to most users.</p> + +<p style="margin-left:11%;"><b>-list-dicts</b></p> + +<p style="margin-left:22%;">List the provider and +dictionary for all available languages.</p> + +<table width="100%" border="0" rules="none" frame="void" + cellspacing="0" cellpadding="0"> +<tr valign="top" align="left"> +<td width="11%"></td> +<td width="7%"> + + +<p><b>-help</b></p></td> +<td width="4%"></td> +<td width="24%"> + + +<p>Show brief help.</p></td> +<td width="54%"> +</td></tr> +</table> + +<p style="margin-left:11%;"><b>-version</b></p> + +<p style="margin-left:22%;">Prints the program’s +version.</p> + +<h2>SEE ALSO +<a name="SEE ALSO"></a> +</h2> + + + +<p style="margin-left:11%; margin-top: 1em"><b>enchant-2(1)</b></p> + +<h2>AUTHOR +<a name="AUTHOR"></a> +</h2> + + +<p style="margin-left:11%; margin-top: 1em">Written by Dom +Lachowicz and Reuben Thomas.</p> +<hr> +</body> +</html> diff --git a/src/enchant.html b/src/enchant.html new file mode 100644 index 0000000..d52bef7 --- /dev/null +++ b/src/enchant.html @@ -0,0 +1,184 @@ +<!-- Creator : groff version 1.22.4 --> +<!-- CreationDate: Sun Sep 25 10:09:39 2022 --> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" +"http://www.w3.org/TR/html4/loose.dtd"> +<html> +<head> +<meta name="generator" content="groff -Thtml, see www.gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<meta name="Content-Style" content="text/css"> +<style type="text/css"> + p { margin-top: 0; margin-bottom: 0; vertical-align: top } + pre { margin-top: 0; margin-bottom: 0; vertical-align: top } + table { margin-top: 0; margin-bottom: 0; vertical-align: top } + h1 { text-align: center } +</style> +<title>ENCHANT</title> + +</head> +<body> + +<h1 align="center">ENCHANT</h1> + +<a href="#NAME">NAME</a><br> +<a href="#ORDERING FILE">ORDERING FILE</a><br> +<a href="#PERSONAL WORD LISTS">PERSONAL WORD LISTS</a><br> +<a href="#FILES AND DIRECTORIES">FILES AND DIRECTORIES</a><br> +<a href="#SEE ALSO">SEE ALSO</a><br> +<a href="#AUTHOR">AUTHOR</a><br> + +<hr> + + +<h2>NAME +<a name="NAME"></a> +</h2> + + +<p style="margin-left:11%; margin-top: 1em">Enchant - +enchant ordering files and personal word lists</p> + +<h2>ORDERING FILE +<a name="ORDERING FILE"></a> +</h2> + + +<p style="margin-left:11%; margin-top: 1em">Enchant uses +global and per-user ordering files named +<i>enchant.ordering</i> to decide which spelling provider to +use for particular languages. The per-user file takes +precedence.</p> + +<p style="margin-left:11%; margin-top: 1em">The ordering +file takes the form <i>language_tag:<comma-separated list +of spelling providers></i>. The language tag is an IETF +BCP 47 language tag, typically of the form +<i>COUNTRY_LANGUAGE</i>. To see what dictionaries are +available, run <i>enchant-lsmod-2</i>. ’*’ is +used to mean “use this ordering for all languages, +unless instructed otherwise.” For example:</p> + + +<p style="margin-left:22%; margin-top: 1em">*:aspell,hunspell,nuspell +<br> +en:aspell,hunspell,nuspell <br> +en_GB:hunspell,nuspell,aspell <br> +fr:hunspell,nuspell,aspell</p> + +<h2>PERSONAL WORD LISTS +<a name="PERSONAL WORD LISTS"></a> +</h2> + + +<p style="margin-left:11%; margin-top: 1em">Personal word +lists are simple plain text files with one word per line. +Lines starting with a hash sign ’#’ are +ignored.</p> + +<p style="margin-left:11%; margin-top: 1em"><b>SHARING +PERSONAL WORD LISTS BETWEEN SPELL-CHECKERS</b> <br> +It is possible, and usually safe, to share Enchant’s +personal word lists with other spelling checkers that use +the same format (note that other spell-checkers may not +support comments!). The spell-checkers known to be +compatible are Hunspell, Nuspell and Ispell. (Although +Enchant does not support Ispell as a back-end, it’s +still fine to share word lists with it.) Other +spell-checkers supported by Enchant are either incompatible, +or have no personal word list mechanism. There may well be +yet other spell-checkers, unknown to Enchant, that use the +same format.</p> + +<p style="margin-left:11%; margin-top: 1em">Some +applications use Hunspell or Nuspell, but store the personal +word list under another name or in another location. Firefox +is one example. Firefox also seems to reorder its word list +when updating it; again, this is OK, as the result is still +in the same format. Anonther example is Thunderbird.</p> + +<p style="margin-left:11%; margin-top: 1em">To share word +lists with Enchant, find the other spelling checker’s +word list file, e.g. <i>~/.hunspell_fr_FR</i> or +<i>~/.config/nuspell/fr_FR</i>, and merge it with the +corresponding Enchant file, in this case +<i>~/.config/enchant/fr_FR.dic</i>. Use the following +command, replacing <i>ENCHANT-DICT</i> and <i>OTHER-DICT</i> +with the corresponding dictionary file names:</p> + +<p style="margin-left:22%; margin-top: 1em">cat +ENCHANT-DICT OTHER-DICT | sort -u > merged.txt</p> + +<p style="margin-left:11%; margin-top: 1em">Take a look at +merged.txt to check the merge has worked, then</p> + +<p style="margin-left:22%; margin-top: 1em">mv merged.txt +ENCHANT-DICT <br> +rm OTHER-DICT <br> +ln -s OTHER-DICT ENCHANT-DICT</p> + +<p style="margin-left:11%; margin-top: 1em">to replace the +other dictionary file with a link to the Enchant dictionary, +again filling in the name of the dictionary files.</p> + +<h2>FILES AND DIRECTORIES +<a name="FILES AND DIRECTORIES"></a> +</h2> + + +<p style="margin-left:11%; margin-top: 1em">Enchant looks +in the following places for files, in decreasing order of +precedence: <i><br> +ENCHANT_CONFIG_DIR</i></p> + +<p style="margin-left:22%;">(If the environment variable is +set.)</p> + +<p style="margin-left:11%;"><i>XDG_CONFIG_HOME/enchant</i> +(non-Windows systems)</p> + +<p style="margin-left:22%;">Default: +<i>~/.config/enchant</i></p> + + +<p style="margin-left:11%;"><i>CSIDL_LOCAL_APPDATA\enchant</i> +(Windows systems)</p> + +<p style="margin-left:22%;">Default: <i>C:\Documents and +Settings\</i>username<i>\Local Settings\Application +Data\enchant</i></p> + +<p style="margin-left:11%;"><i>DATADIR/enchant</i></p> + +<p style="margin-left:22%;">(Or the equivalent location +relative to the enchant library for a relocatable +build.)</p> + +<p style="margin-left:11%; margin-top: 1em">Dictionaries +are looked for in a subdirectory with the same name as the +provider; for example, <i>DATADIR/enchant/hunspell</i> and +<i>~/.config/enchant/hunspell</i>.</p> + +<p style="margin-left:11%; margin-top: 1em">Some providers +may also look in a standard system directory for their +dictionaries; the hunspell provider can be configured to do +so at build time.</p> + +<h2>SEE ALSO +<a name="SEE ALSO"></a> +</h2> + + + +<p style="margin-left:11%; margin-top: 1em"><b>enchant-2</b>(1), +<b>enchant-lsmod-2</b>(1)</p> + +<h2>AUTHOR +<a name="AUTHOR"></a> +</h2> + + +<p style="margin-left:11%; margin-top: 1em">Written by Dom +Lachowicz and Reuben Thomas.</p> +<hr> +</body> +</html> |