Ville Skyttä > gmuck > gmuck

Download:
gmuck-1.12.tar.gz

Annotate this POD

View/Report Bugs
Source  

NAME ^

gmuck - The Generated MarkUp Checker

SYNOPSIS ^

  gmuck [OPTION...] [--] [FILE...]

DESCRIPTION ^

gmuck assists you in producing valid (X)HTML by checking CGI scripts, XSL stylesheets, templates, normal HTML files or [you name it] and reporting errors that it finds.

It is not a replacement for real validation tools, but is handy in quick checks and in situations where validation of the actual markup is troublesome.

gmuck is a line-oriented tool. Because of that, its structural checking capabilities are limited, but it makes an attempt to report syntactical errors as well as provides some lint-like features.

OPTIONS ^

String values in options are case insensitive. Options may be abbreviated, see Getopt::Long.

--[no]help

Output help message and exit. Default is disabled.

--mode=<mode>

Set the checking mode. Valid values are "XHTML", "HTML", "XML". Default is "XHTML". See "mode()" in HTML::GMUCK.

--tabwidth=<n>

TAB width for error messages. Default is 4. See "tab_width()" in HTML::GMUCK.

--stdin=<filename>

File name to use in error messages when the input is from STDIN. Default is "STDIN".

--quote=<char>

Preferred quote style. Valid values are "D" (double quote), "S" (single quote), "N" (none). Default is "D". See "quote()" in HTML::GMUCK.

--[no]quick

Enable or disable quick mode (max 1 failed check per line). Default is disabled.

--[no]verbose

Enable or disable verbose mode. Default is enabled.

--[no]binary

Enable or disable checking of binary files. The -B function of Perl is used to determine whether a file is binary or not. Default is disabled.

--[no]elements

Enable or disable element checks. Default is enabled. See "elements()" in HTML::GMUCK.

--[no]attributes

Enable or disable attribute checks. Default is enabled. See "attributes()" in HTML::GMUCK.

--[no]minattributes

Enable or disable minimized attribute checks. This option has effect only if attribute checks are enabled and the checking mode is "HTML". Default is enabled. See "min_attributes()" in HTML::GMUCK.

--[no]entities

Enable or disable entity checks. Default is enabled. See "entities()" in HTML::GMUCK.

--[no]doctype

Enable or disable DOCTYPE checks. Default is enabled. See "doctype()" in HTML::GMUCK.

--[no]mimetypes

Enable or disable MIME type checks. Default is enabled. See "mime_types()" in HTML::GMUCK.

--[no]deprecated

Enable or disable deprecation checks. Default is enabled. See "deprecated()" in HTML::GMUCK.

EXAMPLES ^

Check all files in the current directory with the default options (see above for the defaults):

  gmuck *

Check the files foo.cgi, bar.pl and baz.html in HTML mode, without reporting use of deprecated features (useful for HTML 4.01 Transitional):

  gmuck --mode=HTML --nodeprecated foo.cgi bar.pl baz.html

OUTPUT ^

The output generated by gmuck is parseable by eg. (X)Emacs' compile mode as well as probably some other editors.

All error messages, both from checks and ones related to gmuck execution will go to STDERR.

In verbose mode, informational messages go to STDOUT.

Error output lines are like:

  filename:line:column: [type] <element/@attribute> errormessage

SEE ALSO ^

HTML::GMUCK, Getopt::Long

AUTHOR ^

Ville Skyttä <ville.skytta at iki.fi>

COPYRIGHT ^

Copyright (C) 2001-2007 Ville Skyttä. All rights reserved.

This program is free software, you can redistribute it and/or modify it under the terms of The Artistic License or the GNU General Public License ("GPL") as published by the Free Software Foundation; either version 2 of the GPL, or (at your option) any later version.

syntax highlighting: