XML_SPELLCHECK(1p)

📦
version 3.54 · 6 versions
, in ubuntu resolute, ubuntu stonking

💖 XML_SPELLCHECK 💖

okay bestie, gather round, because today we're talking about xml_spellcheck, and it lives in section 1p of the manual (that's the "user contributed perl docs" corner of the library, iykyk). This little icon is a spell checker for XML files, and honestly? she's giving "quietly does the most" and I'm obsessed. 🎀

✨ NAME ✨

xml_spellcheck — spellcheck XML files 💅

🌸 SYNOPSIS 🌸

xml_spellcheck [options] <files>

like... that's it. options, then your files. simple. gorgeous. no notes. ✨

🦋 DESCRIPTION 🦋

So here's the whole vibe: xml_spellcheck lets you spell check the content of an XML file. Not the tags, not the markup chaos, just the words, bestie. 💖

The way it works is literally a three-step glow-up:

  1. it extracts the text — that's the content of elements, and optionally the content of attributes if you ask nicely
  2. it calls a spell checker on that text
  3. it recreates the XML document

extract, spell check, rebuild. main character energy fr fr. 🔥

💅 OPTIONS 💅

heads up bestie: all options can be abbreviated to the first letter 👑 so like, you don't have to type the whole thing if you don't want to. lowkey convenient.
  • --conf <configuration_file> — gets the options from a configuration file. NOT IMPLEMENTED YET. 😭 she's a concept, she's an idea, she's not here yet.
  • --spellchecker <spellchecker> — the command to use for spell checking, including any option. by default aspell -c is used. so that's the default, no cap. 🌈
  • --backup-extension <extension> — by default the original file is saved with a .bak extension. this option changes the extension. your original file is safe, she's backed up, she's protected. 🫶
  • --attributes — spell check attribute content. by default attribute values are NOT spell checked. and also NOT YET IMPLEMENTED. 💀
  • --exclude_elements <list_of_excluded_elements> — a list of elements that should not be spell checked. bye bestie, not you. 🙈
  • --include_elements <list_of_included_elements> — a list of elements that should be spell checked (by default all elements are spell checked). ✨
  • --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. so she gets a lil makeover, indented and everything. 🎀
  • --version — display the tool version and exit
  • --help — display help message and exit
  • --man — display longer help message and exit
🚨 mutual exclusivity alert 🚨 --exclude_elements and --include_elements are mutually exclusive. you pick one, bestie, you cannot have both, that's the rules. ✋

🌟 EXAMPLES 🌟

(okay so this section is literally empty in the original. nothing here. a beautiful blank canvas. the silence is iconic tbh. 🤫)

🐛 BUGS 🐛

(same situation bestie — nothing listed. she's bug-free as far as this page is concerned. manifesting that energy for all of us. 💜)

📝 TODO 📝

things that are coming (eventually, allegedly, someday, we believe):

  • --conf option
  • --attribute option

the vision is there, the code is loading... 🧚✨

🍓 PRE-REQUISITE 🍓

you're gonna need these installed, bestie, no skipping:

  • XML::Twig
  • Getopt::Long
  • Pod::Usage
  • File::Temp

and plot twist: XML::Twig requires XML::Parser. so like, get that too, or nothing works. 🙈

👑 SEE ALSO 👑

  • XML::Twig

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 MERCHANTABILITY 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.

okay real talk for a sec: that warranty disclaimer is not a joke and not a vibe, it means exactly what it says. no promises, no guarantees, she's free software doing her best. 🫶

🌈 AUTHOR 🌈

Michel Rodriguez <mirod@xmltwig.com>

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

and that's the whole page, bestie!! this doc came to you from perl v5.40.1 and it's dated 2025-12-18, under the manual name XML_SPELLCHECK(1p). mwah, go spell check something gorgeous. 💅💖🎀

📦 where this page comes from