Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

xml_spellcheck(1p) [debian man page]

XML_SPELLCHECK(1p)					User Contributed Perl Documentation					XML_SPELLCHECK(1p)

NAME

       xml_spellcheck - spellcheck XML files

SYNOPSIS

	 xml_spellcheck [options] <files>

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.

OPTIONS

       Note that all options can be abbreviated to the first letter

       --conf <configuration_file>
	   Gets the options from a configuration file. NOT IMPLEMENTED YET.

       --spellchecker <spellchecker>
	   The command to use for spell checking, including any option

	   By default "aspell -c" is used

       --backup-extension <extension>
	   By default the original file is saved with a ".bak" extension. This option changes the extension

       --attributes
	   Spell check attribute content. By default attribute values are NOT spell checked. NOT YET IMPLEMENTED

       --exclude_elements <list_of_excluded_elements>
	   A list of elements that should not be spell checked

       --include_elements <list_of_included_elements>
	   A list of elements that should be spell checked (by default all elements are spell checked).

	   "--exclude_elements" and "--include_elements" are mutually exclusive

       --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 "indented" style is
	   used

       --version
	   Dislay the tool version and exit

       --help
	   Display help message and exit

       --man
	   Display longer help message and exit

EXAMPLES

BUGS

TODO

       --conf option
       --attribute option

PRE-REQUISITE
       XML::Twig, Getopt::Long, Pod::Usage, File::Temp XML::Twig requires XML::Parser.

SEE ALSO

       XML::Twig

COPYRIGHT AND DISCLAIMER

       This program is Copyright 2003 by Michel Rodriguez

       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.

       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.

       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.

AUTHOR

       Michel Rodriguez <mirod@xmltwig.com>

       xml_spellcheck is available at http://www.xmltwig.com/xmltwig/

perl v5.12.4							    2010-09-20							XML_SPELLCHECK(1p)

Check Out this Related Man Page

XML::Mini::Element::Entity(3pm) 			User Contributed Perl Documentation			   XML::Mini::Element::Entity(3pm)

NAME

       XML::Mini::Element::Entity - represents XML entities in XML::Mini parser

DESCRIPTION

       The XML::Mini::Element::Entity is used internally to represent <!ENTITY name "stuff">.

       You shouldn't need to use it directly, see XML::Mini::Element's entity() method.

AUTHOR

       Copyright (C) 2002-2008 Patrick Deegan, Psychogenic Inc.

       Programs that use this code are bound to the terms and conditions of the GNU GPL (see the LICENSE file).  If you wish to include these
       modules in non-GPL code, you need prior written authorisation from the authors.

       This library is released under the terms of the GNU GPL version 3, making it available only for free programs ("free" here being used in
       the sense of the GPL, see http://www.gnu.org for more details).	Anyone wishing to use this library within a proprietary or otherwise non-
       GPLed program MUST contact psychogenic.com to acquire a distinct license for their application.	This approach encourages the use of free
       software while allowing for proprietary solutions that support further development.

   LICENSE
	   XML::Mini::Element module, part of the XML::Mini XML parser/generator package.
	   Copyright (C) 2002-2008 Patrick Deegan
	   All rights reserved

	   XML::Mini is free software: you can redistribute it and/or modify
	   it under the terms of the GNU General Public License as published by
	   the Free Software Foundation, either version 3 of the License, or
	   (at your option) any later version.

	   XML::Mini is distributed in the hope that it will be useful,
	   but WITHOUT ANY WARRANTY; without even the implied warranty of
	   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	   GNU General Public License for more details.

	   You should have received a copy of the GNU General Public License
	   along with XML::Mini.  If not, see <http://www.gnu.org/licenses/>.

       Official XML::Mini site: http://minixml.psychogenic.com

       Contact page for author available on http://www.psychogenic.com/

SEE ALSO

       XML::Mini, XML::Mini::Document, XML::Mini::Element

       http://minixml.psychogenic.com

perl v5.10.0							    2009-09-20					   XML::Mini::Element::Entity(3pm)
Man Page