.\" tidy man page for the HTML Tidy .TH TIDY 1 "" "HTML Tidy" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l .SH NAME \fBtidy\fR - check, correct, and pretty-print HTML(5) files .SH SYNOPSIS \fBtidy\fR [option ...] [file ...] [option ...] [file ...] .SH DESCRIPTION Tidy reads HTML, XHTML, and XML files and writes cleaned-up markup. For HTML variants, it detects, reports, and corrects many common coding errors and strives to produce visually equivalent markup that is both conformant to the HTML specifications and that works in most browsers. .LP A common use of Tidy is to convert plain HTML to XHTML. For generic XML files, Tidy is limited to correcting basic well-formedness errors and pretty printing. .LP If no input file is specified, Tidy reads the standard input. If no output file is specified, Tidy writes the tidied markup to the standard output. If no error file is specified, Tidy writes messages to the standard error. For command line options that expect a numerical argument, a default is assumed if no meaningful value can be found. .SH OPTIONS .SH USAGE .LP Use \fB--\fR\fIoptionX valueX\fR for the detailed configuration option "optionX" with argument "valueX". See also below under \fBDetailed Configuration Options\fR as to how to conveniently group all such options in a single config file. .LP Input/Output default to stdin/stdout respectively. Single letter options apart from \fB-f\fR and \fB-o\fR may be combined as in: .LP .in 1i \fBtidy -f errs.txt -imu foo.html\fR .SH ENVIRONMENT .TP .B HTML_TIDY Name of the default configuration file. This should be an absolute path, since you will probably invoke \fBtidy\fR from different directories. The value of HTML_TIDY will be parsed after the compiled-in default (defined with -DTIDY_CONFIG_FILE), but before any of the files specified using \fB-config\fR. .SH "EXIT STATUS" .IP 0 All input files were processed successfully. .IP 1 There were warnings. .IP 2 There were errors. .SH ______________________________ .SH " " .SH "DETAILED CONFIGURATION OPTIONS" This section describes the Detailed (i.e., "expanded") Options, which may be specified by preceding each option with \fB--\fR at the command line, followed by its desired value, OR by placing the options and values in a configuration file, and telling tidy to read that file with the \fB-config\fR standard option. .SH SYNOPSIS \fBtidy --\fR\fIoption1 \fRvalue1 \fB--\fIoption2 \fRvalue2 [standard options ...] .br \fBtidy -config \fIconfig-file \fR[standard options ...] .SH WARNING The options detailed here do not include the "standard" command-line options (i.e., those preceded by a single '\fB-\fR') described above in the first section of this man page. .SH DESCRIPTION A list of options for configuring the behavior of Tidy, which can be passed either on the command line, or specified in a configuration file. .LP A Tidy configuration file is simply a text file, where each option is listed on a separate line in the form .LP .in 1i \fBoption1\fR: \fIvalue1\fR .br \fBoption2\fR: \fIvalue2\fR .br etc. .LP The permissible values for a given option depend on the option's \fBType\fR. There are five types: \fIBoolean\fR, \fIAutoBool\fR, \fIDocType\fR, \fIEnum\fR, and \fIString\fR. Boolean types allow any of \fIyes/no, y/n, true/false, t/f, 1/0\fR. AutoBools allow \fIauto\fR in addition to the values allowed by Booleans. Integer types take non-negative integers. String types generally have no defaults, and you should provide them in non-quoted form (unless you wish the output to contain the literal quotes). .LP Enum, Encoding, and DocType "types" have a fixed repertoire of items; consult the \fIExample\fR[s] provided below for the option[s] in question. .LP You only need to provide options and values for those whose defaults you wish to override, although you may wish to include some already-defaulted options and values for the sake of documentation and explicitness. .LP Here is a sample config file, with at least one example of each of the five Types: .LP \fI // sample Tidy configuration options output-xhtml: yes add-xml-decl: no doctype: strict char-encoding: ascii indent: auto wrap: 76 repeated-attributes: keep-last error-file: errs.txt \fR .LP Below is a summary and brief description of each of the options. They are listed alphabetically within each category. There are five categories: \fIHTML, XHTML, XML\fR options, \fIDiagnostics\fR options, \fIPretty Print\fR options, \fICharacter Encoding\fR options, and \fIMiscellaneous\fR options. .LP .SH OPTIONS .SS File manipulation file-manip .SS Processing directives process-directives .SS Character encodings char-encoding .SS Miscellaneous misc .TP \fB\fR , (\fI \fR) .SS HTML, XHTML, XML options: markup .SS Diagnostics options: diagnostics .SS Pretty Print options: print .SS Character Encoding options: encoding .SS Miscellaneous options: misc .TP \fB\fR Type: .br .br .rj 1 \fBSee also\fR: \fI\fR , Default: Default: - Example: Default: - .SH SEE ALSO For more information about HTML Tidy: .RS 4 .LP http://www.html-tidy.org/ .RE .LP For more information on HTML: .RS 4 .LP \fBHTML: Edition for Web Authors\fR (the latest HTML specification) .br http://dev.w3.org/html5/spec-author-view .LP \fBHTML: The Markup Language\fR (an HTML language reference) .br http://dev.w3.org/html5/markup/ .RE .LP For bug reports and comments: .RS 4 .LP https://github.com/htacg/tidy-html5/issues/ .RE .LP Or send questions and comments to \fBpublic-htacg@w3.org\fR. .LP Validate your HTML documents using the \fBW3C Nu Markup Validator\fR: .RS 4 .LP http://validator.w3.org/nu/ .RE .SH AUTHOR \fBTidy\fR was written by \fBDave Raggett\fR <dsr@w3.org>, and subsequently maintained by a team at http://tidy.sourceforge.net/, and now maintained by \fBHTACG\fR (http://www.htacg.org). .LP The sources for \fBHTML Tidy\fR are available at https://github.com/htacg/tidy-html5/ under the MIT Licence. at \fI\fR \fI\fR .sp 1 .sp 1 .sp 1 .sp 1 \fB\fR