summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorReuben Thomas <rrt@sc3d.org>2017-08-07 21:00:15 +0100
committerReuben Thomas <rrt@sc3d.org>2017-08-07 21:02:59 +0100
commit3e20d1f9cfffd57ee749eecc6aadb27c80cda8e6 (patch)
tree2938fbc5521536a2af2e7244df931e8ff1638cea /src
parent49e2c347d3b78e7de2922f1bf765028c7f336511 (diff)
downloadenchant-3e20d1f9cfffd57ee749eecc6aadb27c80cda8e6.tar.gz
Fixes #146: add a man page for enchant-lsmod
Diffstat (limited to 'src')
-rw-r--r--src/Makefile.am2
-rw-r--r--src/enchant-lsmod.134
-rw-r--r--src/enchant.13
3 files changed, 37 insertions, 2 deletions
diff --git a/src/Makefile.am b/src/Makefile.am
index 21d94f6..ed239bf 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -23,7 +23,7 @@ libenchant_include_HEADERS = enchant.h enchant-provider.h enchant++.h
pkgdata_DATA = enchant.ordering
-dist_man_MANS = enchant.1
+dist_man_MANS = enchant.1 enchant-lsmod.1
LDADD = libenchant.la $(ENCHANT_LIBS) $(top_builddir)/lib/libgnu.la
bin_PROGRAMS = enchant-lsmod enchant
diff --git a/src/enchant-lsmod.1 b/src/enchant-lsmod.1
new file mode 100644
index 0000000..ca986ac
--- /dev/null
+++ b/src/enchant-lsmod.1
@@ -0,0 +1,34 @@
+.TH ENCHANT-LSMOD 1 "August 2017"
+.SH NAME
+Enchant \- list provider and dictionary information
+.SH SYNOPSIS
+.ll +8
+.B enchant-lsmod
+[[\fB\-lang\fR|\fB-word-chars\fR] [\fBlanguage_tag\fR]|\fB\-list-dicts\fR|\fB\-help\fR|\fB\-version\fR]
+.ll -8
+.br
+.SH DESCRIPTION
+.B enchant-lsmod
+gives information about Enchant's spell-checker providers and the dictionaries each offers.
+See \fBenchant\fR(1) for details about how the providers and dictionaries are located.
+If no command-line options are given, the available providers are listed.
+.SS OPTIONS
+.TP
+.B "\-lang"
+Show which provider and dictionary will be used for the given language, or all languages if none is supplied.
+.TP
+.B "\-word\-chars"
+Show the extra word characters for the given language, if available. This is of little interest to most users.
+.TP
+.B "\-list\-dicts"
+List the provider and dictionary for all available languages.
+.TP
+.B "\-help"
+Show brief help.
+.TP
+.B "\-version"
+Prints the program's version.
+.SH "SEE ALSO"
+.BR enchant(1)
+.SH "AUTHOR"
+Written by Dom Lachowicz and Reuben Thomas.
diff --git a/src/enchant.1 b/src/enchant.1
index 3113819..0197eb0 100644
--- a/src/enchant.1
+++ b/src/enchant.1
@@ -58,6 +58,7 @@ provider; for example, \fI/usr/share/enchant/hunspell\fR and
build time to look in a different system directory, which is useful when there is a
standard place to put dictionaries for that provider.
.SH "SEE ALSO"
-.BR aspell(1)
+.BR aspell (1),
+.BR enchant-lsmod (1)
.SH "AUTHOR"
Written by Dom Lachowicz and Reuben Thomas.