.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "XML_SPELLCHECK 1"
.TH XML_SPELLCHECK 1 2023-07-25 "perl v5.38.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
xml_spellcheck \- spellcheck XML files
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  xml_spellcheck [options] <files>
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
xml_spellcheck lets you spell check the content of an XML file.
It extracts the text (the content of elements and optionally of
attributes), call a spell checker on it and then recreates the
XML document.
.SH OPTIONS
.IX Header "OPTIONS"
Note that all options can be abbreviated to the first letter
.IP "\-\-conf <configuration_file>" 4
.IX Item "--conf <configuration_file>"
Gets the options from a configuration file. NOT IMPLEMENTED YET.
.IP "\-\-spellchecker <spellchecker>" 4
.IX Item "--spellchecker <spellchecker>"
The command to use for spell checking, including any option
.Sp
By default \f(CW\*(C`aspell \-c\*(C'\fR is used
.IP "\-\-backup\-extension <extension>" 4
.IX Item "--backup-extension <extension>"
By default the original file is saved with a \f(CW\*(C`.bak\*(C'\fR extension. This option
changes the extension
.IP \-\-attributes 4
.IX Item "--attributes"
Spell check attribute content. By default attribute values are NOT
spell checked. NOT YET IMPLEMENTED
.IP "\-\-exclude_elements <list_of_excluded_elements>" 4
.IX Item "--exclude_elements <list_of_excluded_elements>"
A list of elements that should not be spell checked
.IP "\-\-include_elements <list_of_included_elements>" 4
.IX Item "--include_elements <list_of_included_elements>"
A list of elements that should be spell checked (by default all elements
are spell checked).
.Sp
\&\f(CW\*(C`\-\-exclude_elements\*(C'\fR and \f(CW\*(C`\-\-include_elements\*(C'\fR are mutually exclusive
.IP "\-\-pretty_print <optional_pretty_print_style>" 4
.IX Item "--pretty_print <optional_pretty_print_style>"
A pretty print style for the document, as defined in XML::Twig. If
the option is provided without a value then the \f(CW\*(C`indented\*(C'\fR style is
used
.IP \-\-version 4
.IX Item "--version"
Dislay the tool version and exit
.IP \-\-help 4
.IX Item "--help"
Display help message and exit
.IP \-\-man 4
.IX Item "--man"
Display longer help message and exit
.SH EXAMPLES
.IX Header "EXAMPLES"
.SH BUGS
.IX Header "BUGS"
.SH TODO
.IX Header "TODO"
.IP "\-\-conf option" 4
.IX Item "--conf option"
.PD 0
.IP "\-\-attribute option" 4
.IX Item "--attribute option"
.PD
.SH PRE-REQUISITE
.IX Header "PRE-REQUISITE"
XML::Twig, Getopt::Long, Pod::Usage, File::Temp
XML::Twig requires XML::Parser.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
XML::Twig
.SH "COPYRIGHT AND DISCLAIMER"
.IX Header "COPYRIGHT AND DISCLAIMER"
This program is Copyright 2003 by Michel Rodriguez
.PP
This program is free software; you can redistribute it and/or modify
it under the terms of the Perl Artistic License or the GNU General 
Public License as published by the Free Software Foundation either
version 2 of the License, or (at your option) any later version.
.PP
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MER\-
CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
Public License for more details.
.PP
If you do not have a copy of the GNU General Public License write to
the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139,
USA.
.SH AUTHOR
.IX Header "AUTHOR"
Michel Rodriguez <mirod@xmltwig.com>
.PP
xml_spellcheck is available at http://www.xmltwig.com/xmltwig/