~ubuntu-branches/ubuntu/precise/tmispell-voikko/precise

« back to all changes in this revision

Viewing changes to doc/tmispell.1

  • Committer: Bazaar Package Importer
  • Author(s): Timo Jyrinki
  • Date: 2006-10-18 20:04:10 UTC
  • Revision ID: james.westby@ubuntu.com-20061018200410-zd4fwc1xwkclmb51
Tags: upstream-0.6.1
ImportĀ upstreamĀ versionĀ 0.6.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH "TMISPELL" "1" "2006-07-30"
 
2
.SH NAME
 
3
tmispell \- ispell wrapper which uses Voikko for spell-checking
 
4
.SH SYNOPSIS
 
5
.B tmispell
 
6
.RB [ -F
 
7
.IR config_file ]
 
8
.RI [ ispell_options ]
 
9
.RI [ file " ...]"
 
10
.SH DESCRIPTION
 
11
.B Tmispell
 
12
is an
 
13
.BR ispell (1)
 
14
wrapper which uses Voikko spell-checking system to do the actual
 
15
spell-checking for Finnish language.
 
16
.PP
 
17
What makes
 
18
.B Tmispell
 
19
very useful is that many programs (e.g. email clients and word
 
20
processors) use Ispell for spell-checking. Since
 
21
.B Tmispell
 
22
is a transparent wrapper for Ispell, other programs that would normally
 
23
use Ispell will automatically use
 
24
.B Tmispell
 
25
(and therefore Voikko) without any changes needed. Additionally,
 
26
.B Tmispell
 
27
is able to launch the real Ispell if
 
28
.B Tmispell
 
29
does not support the selected language. It is not necessary to have the
 
30
real Ispell installed, though. Tmispell works fine without it, but
 
31
currently Finnish is the only supported language then.
 
32
.PP
 
33
.B Tmispell
 
34
can be used from command line exactly like Ispell. If
 
35
.B Tmispell
 
36
is correctly installed, the command
 
37
.nh
 
38
\(lqispell\(rq
 
39
.hy
 
40
actually starts
 
41
.BR Tmispell .
 
42
It can be used to spell-check any text
 
43
.IR file (s)
 
44
given as command line parameter. If a text file is given,
 
45
.B Tmispell
 
46
starts in interactive mode. Press \(lq?\(rq to get help on available
 
47
commands in interactive mode.
 
48
.SH OPTIONS
 
49
.TP
 
50
.BI -F " config_file"
 
51
Use the configuration file
 
52
.I config_file
 
53
instead of the default
 
54
.nh
 
55
.IR /etc/tmispell.conf .
 
56
.hy
 
57
.TP
 
58
.I ispell_options
 
59
.B Tmispell
 
60
should understand all the options that Ispell does. For more
 
61
information about Ispell's options, see
 
62
.nh
 
63
.BR ispell (1).
 
64
.hy
 
65
.SH FILES
 
66
.TP
 
67
.I /etc/tmispell.conf
 
68
The default configuration file for
 
69
.BR Tmispell .
 
70
For more information, see
 
71
.nh
 
72
.BR tmispell.conf (5).
 
73
.hy
 
74
.SH BUGS
 
75
In interactive mode UTF-8 multibyte characters are not handled
 
76
correctly.
 
77
.SH AUTHORS
 
78
The original
 
79
.B Tmispell
 
80
was programmed by
 
81
.nh
 
82
Pauli Virtanen <pauli.virtanen@hut.fi>
 
83
.hy
 
84
.br
 
85
Modifications and integration with Voikko spell-checking system by
 
86
.nh
 
87
Harri Pitk\(:anen <hatapitk@iki.fi>
 
88
.SH "SEE ALSO"
 
89
.BR tmispell.conf (5),
 
90
.BR ispell (1)
 
91
.PP
 
92
Voikko homepage: http://www.hunspell-fi.org/
 
93
.hy
 
94
\" vim: tw=72