1 .\" tidy man page for the Tidy Sourceforge project

     2 .TH tidy 1 "1 Feb 2007" "HTML Tidy 1.0.0" "User commands"

     3 

     4 .SH NAME

     5 \fBtidy\fR - validate, correct, and pretty-print HTML files

     6 .br

     7 .SH SYNOPSIS

     8 \fBtidy\fR [option ...] [file ...] [option ...] [file ...]

     9 .SH DESCRIPTION

    10 Tidy reads HTML, XHTML and XML files and writes cleaned up markup.  For

    11 HTML variants, it detects and corrects many common coding errors and

    12 strives to produce visually equivalent markup that is both W3C

    13 compliant and works on most browsers. A common use of Tidy is to

    14 convert plain HTML to XHTML.  For generic XML files, Tidy is limited to

    15 correcting basic well-formedness errors and pretty printing.

    16 .LP

    17 If no input file is specified, Tidy reads the standard input.  If no

    18 output file is specified, Tidy writes the tidied markup to the standard

    19 output.  If no error file is specified, Tidy writes messages to the

    20 standard error.

    21 For command line options that expect a numerical argument, a default is

    22 assumed if no meaningful value can be found.

    23 .SH OPTIONS

    24 

    25 .SS File manipulation

    26 

    27 .TP

    28 \fB-output <file>\fR, \fB-o <file>\fR

    29 write output to the specified <file>

    30 (\fIoutput-file: <file>\fR)

    31 .TP

    32 \fB-config <file>\fR

    33 set configuration options from the specified <file>

    34 

    35 .TP

    36 \fB-file <file>\fR, \fB-f <file>\fR

    37 write errors to the specified <file>

    38 (\fIerror-file: <file>\fR)

    39 .TP

    40 \fB-modify\fR, \fB-m\fR

    41 modify the original input files

    42 (\fIwrite-back: yes\fR)

    43 .SS Processing directives

    44 

    45 .TP

    46 \fB-indent\fR, \fB-i\fR

    47 indent element content

    48 (\fIindent: auto\fR)

    49 .TP

    50 \fB-wrap <column>\fR, \fB-w <column>\fR

    51 wrap text at the specified <column>. 0 is assumed if <column> is

    52 missing. When this option is omitted, the default of the configuration

    53 option "wrap" applies.

    54 (\fIwrap: <column>\fR)

    55 .TP

    56 \fB-upper\fR, \fB-u\fR

    57 force tags to upper case

    58 (\fIuppercase-tags: yes\fR)

    59 .TP

    60 \fB-clean\fR, \fB-c\fR

    61 replace FONT, NOBR and CENTER tags by CSS

    62 (\fIclean: yes\fR)

    63 .TP

    64 \fB-bare\fR, \fB-b\fR

    65 strip out smart quotes and em dashes, etc.

    66 (\fIbare: yes\fR)

    67 .TP

    68 \fB-numeric\fR, \fB-n\fR

    69 output numeric rather than named entities

    70 (\fInumeric-entities: yes\fR)

    71 .TP

    72 \fB-errors\fR, \fB-e\fR

    73 only show errors

    74 (\fImarkup: no\fR)

    75 .TP

    76 \fB-quiet\fR, \fB-q\fR

    77 suppress nonessential output

    78 (\fIquiet: yes\fR)

    79 .TP

    80 \fB-omit\fR

    81 omit optional end tags

    82 (\fIhide-endtags: yes\fR)

    83 .TP

    84 \fB-xml\fR

    85 specify the input is well formed XML

    86 (\fIinput-xml: yes\fR)

    87 .TP

    88 \fB-asxml\fR, \fB-asxhtml\fR

    89 convert HTML to well formed XHTML

    90 (\fIoutput-xhtml: yes\fR)

    91 .TP

    92 \fB-ashtml\fR

    93 force XHTML to well formed HTML

    94 (\fIoutput-html: yes\fR)

    95 .TP

    96 \fB-access <level>\fR

    97 do additional accessibility checks (<level> = 0, 1, 2, 3). 0 is assumed

    98 if <level> is missing.

    99 (\fIaccessibility-check: <level>\fR)

   100 .SS Character encodings

   101 

   102 .TP

   103 \fB-raw\fR

   104 output values above 127 without conversion to entities

   105 

   106 .TP

   107 \fB-ascii\fR

   108 use ISO-8859-1 for input, US-ASCII for output

   109 

   110 .TP

   111 \fB-latin0\fR

   112 use ISO-8859-15 for input, US-ASCII for output

   113 

   114 .TP

   115 \fB-latin1\fR

   116 use ISO-8859-1 for both input and output

   117 

   118 .TP

   119 \fB-iso2022\fR

   120 use ISO-2022 for both input and output

   121 

   122 .TP

   123 \fB-utf8\fR

   124 use UTF-8 for both input and output

   125 

   126 .TP

   127 \fB-mac\fR

   128 use MacRoman for input, US-ASCII for output

   129 

   130 .TP

   131 \fB-win1252\fR

   132 use Windows-1252 for input, US-ASCII for output

   133 

   134 .TP

   135 \fB-ibm858\fR

   136 use IBM-858 (CP850+Euro) for input, US-ASCII for output

   137 

   138 .TP

   139 \fB-utf16le\fR

   140 use UTF-16LE for both input and output

   141 

   142 .TP

   143 \fB-utf16be\fR

   144 use UTF-16BE for both input and output

   145 

   146 .TP

   147 \fB-utf16\fR

   148 use UTF-16 for both input and output

   149 

   150 .TP

   151 \fB-big5\fR

   152 use Big5 for both input and output

   153 

   154 .TP

   155 \fB-shiftjis\fR

   156 use Shift_JIS for both input and output

   157 

   158 .TP

   159 \fB-language <lang>\fR

   160 set the two-letter language code <lang> (for future use)

   161 (\fIlanguage: <lang>\fR)

   162 .SS Miscellaneous

   163 

   164 .TP

   165 \fB-version\fR, \fB-v\fR

   166 show the version of Tidy

   167 

   168 .TP

   169 \fB-help\fR, \fB-h\fR, \fB-?\fR

   170 list the command line options

   171 

   172 .TP

   173 \fB-xml-help\fR

   174 list the command line options in XML format

   175 

   176 .TP

   177 \fB-help-config\fR

   178 list all configuration options

   179 

   180 .TP

   181 \fB-xml-config\fR

   182 list all configuration options in XML format

   183 

   184 .TP

   185 \fB-show-config\fR

   186 list the current configuration settings

   187 

   188 .SH USAGE

   189 .LP

   190 Use \fB--\fR\fIoptionX valueX\fR for the detailed configuration option

   191 "optionX" with argument "valueX".  See also below under \fBDetailed

   192 Configuration Options\fR as to how to conveniently group all such

   193 options in a single config file.

   194 .LP

   195 Input/Output default to stdin/stdout respectively. Single letter

   196 options apart from \fB-f\fR and \fB-o\fR may be combined as in:

   197 .LP

   198 .in 1i

   199 \fBtidy -f errs.txt -imu foo.html\fR

   200 .LP

   201 For further info on HTML see \fIhttp://www.w3.org/MarkUp\fR.

   202 .LP

   203 For more information about HTML Tidy, visit the project home page at

   204 \fIhttp://tidy.sourceforge.net\fR.  Here, you will find links to

   205 documentation, mailing lists (with searchable archives) and links to

   206 report bugs.

   207 .SH ENVIRONMENT

   208 .TP

   209 .B HTML_TIDY

   210 Name of the default configuration file.  This should be an absolute

   211 path, since you will probably invoke \fBtidy\fR from different

   212 directories.  The value of HTML_TIDY will be parsed after the

   213 compiled-in default (defined with -DTIDY_CONFIG_FILE), but before any

   214 of the files specified using \fB-config\fR.

   215 .SH "EXIT STATUS"

   216 .IP 0

   217 All input files were processed successfully.

   218 .IP 1

   219 There were warnings.

   220 .IP 2

   221 There were errors.

   222 

   223 .SH ______________________________

   224 .SH "  "

   225 .SH "DETAILED CONFIGURATION OPTIONS"

   226 This section describes the Detailed (i.e., "expanded") Options, which

   227 may be specified by preceding each option with \fB--\fR at the command

   228 line, followed by its desired value, OR by placing the options and

   229 values in a configuration file, and telling tidy to read that file with

   230 the \fB-config\fR standard option.

   231 .SH SYNOPSIS

   232 \fBtidy --\fR\fIoption1 \fRvalue1 \fB--\fIoption2 \fRvalue2 [standard

   233 options ...]

   234 .br

   235 \fBtidy -config \fIconfig-file \fR[standard options ...]

   236 .SH WARNING

   237 The options detailed here do not include the "standard" command-line

   238 options (i.e., those preceded by a single '\fB-\fR') described above in

   239 the first section of this man page.

   240 .SH DESCRIPTION

   241 A list of options for configuring the behavior of Tidy, which can be

   242 passed either on the command line, or specified in a configuration

   243 file.

   244 .LP

   245 A Tidy configuration file is simply a text file, where each option

   246 is listed on a separate line in the form

   247 .LP

   248 .in 1i

   249 \fBoption1\fR: \fIvalue1\fR

   250 .br

   251 \fBoption2\fR: \fIvalue2\fR

   252 .br

   253 etc.

   254 .LP

   255 The permissible values for a given option depend on the option's

   256 \fBType\fR.  There are five types: \fIBoolean\fR, \fIAutoBool\fR,

   257 \fIDocType\fR, \fIEnum\fR, and \fIString\fR. Boolean types allow any of

   258 \fIyes/no, y/n, true/false, t/f, 1/0\fR.  AutoBools allow \fIauto\fR in

   259 addition to the values allowed by Booleans.  Integer types take

   260 non-negative integers.  String types generally have no defaults, and

   261 you should provide them in non-quoted form (unless you wish the output

   262 to contain the literal quotes).

   263 .LP

   264 Enum, Encoding, and DocType "types" have a fixed repertoire of items;

   265 consult the \fIExample\fR[s] provided below for the option[s] in

   266 question.

   267 .LP

   268 You only need to provide options and values for those whose defaults

   269 you wish to override, although you may wish to include some

   270 already-defaulted options and values for the sake of documentation and

   271 explicitness.

   272 .LP

   273 Here is a sample config file, with at least one example of each of the

   274 five Types:

   275 .LP

   276 \fI

   277     // sample Tidy configuration options

   278     output-xhtml: yes

   279     add-xml-decl: no

   280     doctype: strict

   281     char-encoding: ascii

   282     indent: auto

   283     wrap: 76

   284     repeated-attributes: keep-last

   285     error-file: errs.txt

   286 \fR

   287 .LP

   288 Below is a summary and brief description of each of the options. They

   289 are listed alphabetically within each category.  There are five

   290 categories: \fIHTML, XHTML, XML\fR options, \fIDiagnostics\fR options,

   291 \fIPretty Print\fR options, \fICharacter Encoding\fR options, and

   292 \fIMiscellaneous\fR options.

   293 .LP

   294 .SH OPTIONS

   295 

   296 .SS HTML, XHTML, XML options:

   297 

   298 .TP

   299 \fBadd-xml-decl\fR

   300 

   301 Type:    \fIBoolean\fR

   302 .br

   303 Default: \fIno\fR

   304 .br

   305 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   306 

   307 This option specifies if Tidy should add the XML declaration when

   308 outputting XML or XHTML. Note that if the input already includes an

   309 <?xml ... ?> declaration then this option will be ignored. If the

   310 encoding for the output is different from "ascii", one of the utf

   311 encodings or "raw", the declaration is always added as required by the

   312 XML standard.

   313 

   314 

   315 .rj 1

   316 \fBSee also\fR: \fIchar-encoding\fR, \fIoutput-encoding\fR

   317 .TP

   318 \fBadd-xml-space\fR

   319 

   320 Type:    \fIBoolean\fR

   321 .br

   322 Default: \fIno\fR

   323 .br

   324 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   325 

   326 This option specifies if Tidy should add xml:space="preserve" to

   327 elements such as <PRE>, <STYLE> and <SCRIPT> when generating XML. This

   328 is needed if the whitespace in such elements is to be parsed

   329 appropriately without having access to the DTD.

   330 .TP

   331 \fBalt-text\fR

   332 

   333 Type:    \fIString\fR

   334 .br

   335 Default: \fI-\fR

   336 .br

   337 Default: \fI-\fR

   338 

   339 This option specifies the default "alt=" text Tidy uses for <IMG>

   340 attributes. This feature is dangerous as it suppresses further

   341 accessibility warnings. You are responsible for making your documents

   342 accessible to people who can not see the images!

   343 .TP

   344 \fBassume-xml-procins\fR

   345 

   346 Type:    \fIBoolean\fR

   347 .br

   348 Default: \fIno\fR

   349 .br

   350 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   351 

   352 This option specifies if Tidy should change the parsing of processing

   353 instructions to require ?> as the terminator rather than >. This option

   354 is automatically set if the input is in XML.

   355 .TP

   356 \fBbare\fR

   357 

   358 Type:    \fIBoolean\fR

   359 .br

   360 Default: \fIno\fR

   361 .br

   362 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   363 

   364 This option specifies if Tidy should strip Microsoft specific HTML from

   365 Word 2000 documents, and output spaces rather than non-breaking spaces

   366 where they exist in the input.

   367 .TP

   368 \fBclean\fR

   369 

   370 Type:    \fIBoolean\fR

   371 .br

   372 Default: \fIno\fR

   373 .br

   374 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   375 

   376 This option specifies if Tidy should strip out surplus presentational

   377 tags and attributes replacing them by style rules and structural markup

   378 as appropriate. It works well on the HTML saved by Microsoft Office

   379 products.

   380 .TP

   381 \fBcss-prefix\fR

   382 

   383 Type:    \fIString\fR

   384 .br

   385 Default: \fI-\fR

   386 .br

   387 Default: \fI-\fR

   388 

   389 This option specifies the prefix that Tidy uses for styles rules. By

   390 default, "c" will be used.

   391 .TP

   392 \fBdoctype\fR

   393 

   394 Type:    \fIDocType\fR

   395 .br

   396 Default: \fIauto\fR

   397 .br

   398 Example: \fIomit, auto, strict, transitional, user\fR

   399 

   400 This option specifies the DOCTYPE declaration generated by Tidy. If set

   401 to "omit" the output won't contain a DOCTYPE declaration. If set to

   402 "auto" (the default) Tidy will use an educated guess based upon the

   403 contents of the document. If set to "strict", Tidy will set the DOCTYPE

   404 to the strict DTD. If set to "loose", the DOCTYPE is set to the loose

   405 (transitional) DTD. Alternatively, you can supply a string for the

   406 formal public identifier (FPI).

   407 .br

   408 

   409 .br

   410 For example:

   411 .br

   412 doctype: "-//ACME//DTD HTML 3.14159//EN"

   413 .br

   414 

   415 .br

   416 If you specify the FPI for an XHTML document, Tidy will set the system

   417 identifier to the empty string. For an HTML document, Tidy adds a

   418 system identifier only if one was already present in order to preserve

   419 the processing mode of some browsers. Tidy leaves the DOCTYPE for

   420 generic XML documents unchanged. \fI--doctype omit\fR implies

   421 \fI--numeric-entities yes\fR.

   422 .TP

   423 \fBdrop-empty-paras\fR

   424 

   425 Type:    \fIBoolean\fR

   426 .br

   427 Default: \fIyes\fR

   428 .br

   429 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   430 

   431 This option specifies if Tidy should discard empty paragraphs.

   432 .TP

   433 \fBdrop-font-tags\fR

   434 

   435 Type:    \fIBoolean\fR

   436 .br

   437 Default: \fIno\fR

   438 .br

   439 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   440 

   441 This option specifies if Tidy should discard <FONT> and <CENTER> tags

   442 without creating the corresponding style rules. This option can be set

   443 independently of the clean option.

   444 .TP

   445 \fBdrop-proprietary-attributes\fR

   446 

   447 Type:    \fIBoolean\fR

   448 .br

   449 Default: \fIno\fR

   450 .br

   451 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   452 

   453 This option specifies if Tidy should strip out proprietary attributes,

   454 such as MS data binding attributes.

   455 .TP

   456 \fBenclose-block-text\fR

   457 

   458 Type:    \fIBoolean\fR

   459 .br

   460 Default: \fIno\fR

   461 .br

   462 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   463 

   464 This option specifies if Tidy should insert a <P> element to enclose

   465 any text it finds in any element that allows mixed content for HTML

   466 transitional but not HTML strict.

   467 .TP

   468 \fBenclose-text\fR

   469 

   470 Type:    \fIBoolean\fR

   471 .br

   472 Default: \fIno\fR

   473 .br

   474 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   475 

   476 This option specifies if Tidy should enclose any text it finds in the

   477 body element within a <P> element. This is useful when you want to take

   478 existing HTML and use it with a style sheet.

   479 .TP

   480 \fBescape-cdata\fR

   481 

   482 Type:    \fIBoolean\fR

   483 .br

   484 Default: \fIno\fR

   485 .br

   486 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   487 

   488 This option specifies if Tidy should convert <![CDATA[]]> sections to

   489 normal text.

   490 .TP

   491 \fBfix-backslash\fR

   492 

   493 Type:    \fIBoolean\fR

   494 .br

   495 Default: \fIyes\fR

   496 .br

   497 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   498 

   499 This option specifies if Tidy should replace backslash characters

   500 "\fI\\\fR" in URLs by forward slashes "\fI/\fR".

   501 .TP

   502 \fBfix-bad-comments\fR

   503 

   504 Type:    \fIBoolean\fR

   505 .br

   506 Default: \fIyes\fR

   507 .br

   508 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   509 

   510 This option specifies if Tidy should replace unexpected hyphens with

   511 "=" characters when it comes across adjacent hyphens. The default is

   512 yes. This option is provided for users of Cold Fusion which uses the

   513 comment syntax: <!--- --->

   514 .TP

   515 \fBfix-uri\fR

   516 

   517 Type:    \fIBoolean\fR

   518 .br

   519 Default: \fIyes\fR

   520 .br

   521 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   522 

   523 This option specifies if Tidy should check attribute values that carry

   524 URIs for illegal characters and if such are found, escape them as HTML

   525 4 recommends.

   526 .TP

   527 \fBhide-comments\fR

   528 

   529 Type:    \fIBoolean\fR

   530 .br

   531 Default: \fIno\fR

   532 .br

   533 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   534 

   535 This option specifies if Tidy should print out comments.

   536 .TP

   537 \fBhide-endtags\fR

   538 

   539 Type:    \fIBoolean\fR

   540 .br

   541 Default: \fIno\fR

   542 .br

   543 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   544 

   545 This option specifies if Tidy should omit optional end-tags when

   546 generating the pretty printed markup. This option is ignored if you are

   547 outputting to XML.

   548 .TP

   549 \fBindent-cdata\fR

   550 

   551 Type:    \fIBoolean\fR

   552 .br

   553 Default: \fIno\fR

   554 .br

   555 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   556 

   557 This option specifies if Tidy should indent <![CDATA[]]> sections.

   558 .TP

   559 \fBinput-xml\fR

   560 

   561 Type:    \fIBoolean\fR

   562 .br

   563 Default: \fIno\fR

   564 .br

   565 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   566 

   567 This option specifies if Tidy should use the XML parser rather than the

   568 error correcting HTML parser.

   569 .TP

   570 \fBjoin-classes\fR

   571 

   572 Type:    \fIBoolean\fR

   573 .br

   574 Default: \fIno\fR

   575 .br

   576 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   577 

   578 This option specifies if Tidy should combine class names to generate a

   579 single new class name, if multiple class assignments are detected on an

   580 element.

   581 

   582 

   583 .rj 1

   584 \fBSee also\fR: \fIjoin-styles\fR, \fIrepeated-attributes\fR

   585 .TP

   586 \fBjoin-styles\fR

   587 

   588 Type:    \fIBoolean\fR

   589 .br

   590 Default: \fIyes\fR

   591 .br

   592 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   593 

   594 This option specifies if Tidy should combine styles to generate a

   595 single new style, if multiple style values are detected on an element.

   596 

   597 

   598 .rj 1

   599 \fBSee also\fR: \fIjoin-classes\fR, \fIrepeated-attributes\fR

   600 .TP

   601 \fBliteral-attributes\fR

   602 

   603 Type:    \fIBoolean\fR

   604 .br

   605 Default: \fIno\fR

   606 .br

   607 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   608 

   609 This option specifies if Tidy should ensure that whitespace characters

   610 within attribute values are passed through unchanged.

   611 .TP

   612 \fBlogical-emphasis\fR

   613 

   614 Type:    \fIBoolean\fR

   615 .br

   616 Default: \fIno\fR

   617 .br

   618 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   619 

   620 This option specifies if Tidy should replace any occurrence of <I> by

   621 <EM> and any occurrence of <B> by <STRONG>. In both cases, the

   622 attributes are preserved unchanged. This option can be set

   623 independently of the clean and drop-font-tags options.

   624 .TP

   625 \fBlower-literals\fR

   626 

   627 Type:    \fIBoolean\fR

   628 .br

   629 Default: \fIyes\fR

   630 .br

   631 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   632 

   633 This option specifies if Tidy should convert the value of an attribute

   634 that takes a list of predefined values to lower case. This is required

   635 for XHTML documents.

   636 .TP

   637 \fBmerge-divs\fR

   638 

   639 Type:    \fIAutoBool\fR

   640 .br

   641 Default: \fIauto\fR

   642 .br

   643 Example: \fIauto, y/n, yes/no, t/f, true/false, 1/0\fR

   644 

   645 Can be used to modify behavior of -c (--clean yes) option. This option

   646 specifies if Tidy should merge nested <div> such as

   647 "<div><div>...</div></div>". If set to "auto", the attributes of the

   648 inner <div> are moved to the outer one. As well, nested <div> with ID

   649 attributes are not merged. If set to "yes", the attributes of the inner

   650 <div> are discarded with the exception of "class" and "style".

   651 

   652 

   653 .rj 1

   654 \fBSee also\fR: \fIclean\fR

   655 .TP

   656 \fBncr\fR

   657 

   658 Type:    \fIBoolean\fR

   659 .br

   660 Default: \fIyes\fR

   661 .br

   662 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   663 

   664 This option specifies if Tidy should allow numeric character

   665 references.

   666 .TP

   667 \fBnew-blocklevel-tags\fR

   668 

   669 Type:    \fITag names\fR

   670 .br

   671 Default: \fI-\fR

   672 .br

   673 Example: \fItagX, tagY, ...\fR

   674 

   675 This option specifies new block-level tags. This option takes a space

   676 or comma separated list of tag names. Unless you declare new tags, Tidy

   677 will refuse to generate a tidied file if the input includes previously

   678 unknown tags. Note you can't change the content model for elements such

   679 as <TABLE>, <UL>, <OL> and <DL>.

   680 

   681 

   682 .rj 1

   683 \fBSee also\fR: \fInew-empty-tags\fR, \fInew-inline-tags\fR,

   684 \fInew-pre-tags\fR

   685 .TP

   686 \fBnew-empty-tags\fR

   687 

   688 Type:    \fITag names\fR

   689 .br

   690 Default: \fI-\fR

   691 .br

   692 Example: \fItagX, tagY, ...\fR

   693 

   694 This option specifies new empty inline tags. This option takes a space

   695 or comma separated list of tag names. Unless you declare new tags, Tidy

   696 will refuse to generate a tidied file if the input includes previously

   697 unknown tags. Remember to also declare empty tags as either inline or

   698 blocklevel.

   699 

   700 

   701 .rj 1

   702 \fBSee also\fR: \fInew-blocklevel-tags\fR, \fInew-inline-tags\fR,

   703 \fInew-pre-tags\fR

   704 .TP

   705 \fBnew-inline-tags\fR

   706 

   707 Type:    \fITag names\fR

   708 .br

   709 Default: \fI-\fR

   710 .br

   711 Example: \fItagX, tagY, ...\fR

   712 

   713 This option specifies new non-empty inline tags. This option takes a

   714 space or comma separated list of tag names. Unless you declare new

   715 tags, Tidy will refuse to generate a tidied file if the input includes

   716 previously unknown tags.

   717 

   718 

   719 .rj 1

   720 \fBSee also\fR: \fInew-blocklevel-tags\fR, \fInew-empty-tags\fR,

   721 \fInew-pre-tags\fR

   722 .TP

   723 \fBnew-pre-tags\fR

   724 

   725 Type:    \fITag names\fR

   726 .br

   727 Default: \fI-\fR

   728 .br

   729 Example: \fItagX, tagY, ...\fR

   730 

   731 This option specifies new tags that are to be processed in exactly the

   732 same way as HTML's <PRE> element. This option takes a space or comma

   733 separated list of tag names. Unless you declare new tags, Tidy will

   734 refuse to generate a tidied file if the input includes previously

   735 unknown tags. Note you can not as yet add new CDATA elements (similar

   736 to <SCRIPT>).

   737 

   738 

   739 .rj 1

   740 \fBSee also\fR: \fInew-blocklevel-tags\fR, \fInew-empty-tags\fR,

   741 \fInew-inline-tags\fR

   742 .TP

   743 \fBnumeric-entities\fR

   744 

   745 Type:    \fIBoolean\fR

   746 .br

   747 Default: \fIno\fR

   748 .br

   749 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   750 

   751 This option specifies if Tidy should output entities other than the

   752 built-in HTML entities (&, <, > and ") in the numeric

   753 rather than the named entity form.

   754 

   755 

   756 .rj 1

   757 \fBSee also\fR: \fIdoctype\fR

   758 .TP

   759 \fBoutput-html\fR

   760 

   761 Type:    \fIBoolean\fR

   762 .br

   763 Default: \fIno\fR

   764 .br

   765 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   766 

   767 This option specifies if Tidy should generate pretty printed output,

   768 writing it as HTML.

   769 .TP

   770 \fBoutput-xhtml\fR

   771 

   772 Type:    \fIBoolean\fR

   773 .br

   774 Default: \fIno\fR

   775 .br

   776 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   777 

   778 This option specifies if Tidy should generate pretty printed output,

   779 writing it as extensible HTML. This option causes Tidy to set the

   780 DOCTYPE and default namespace as appropriate to XHTML. If a DOCTYPE or

   781 namespace is given they will checked for consistency with the content

   782 of the document. In the case of an inconsistency, the corrected values

   783 will appear in the output. For XHTML, entities can be written as named

   784 or numeric entities according to the setting of the "numeric-entities"

   785 option. The original case of tags and attributes will be preserved,

   786 regardless of other options.

   787 .TP

   788 \fBoutput-xml\fR

   789 

   790 Type:    \fIBoolean\fR

   791 .br

   792 Default: \fIno\fR

   793 .br

   794 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   795 

   796 This option specifies if Tidy should pretty print output, writing it as

   797 well-formed XML. Any entities not defined in XML 1.0 will be written as

   798 numeric entities to allow them to be parsed by a XML parser. The

   799 original case of tags and attributes will be preserved, regardless of

   800 other options.

   801 .TP

   802 \fBquote-ampersand\fR

   803 

   804 Type:    \fIBoolean\fR

   805 .br

   806 Default: \fIyes\fR

   807 .br

   808 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   809 

   810 This option specifies if Tidy should output unadorned & characters as

   811 &.

   812 .TP

   813 \fBquote-marks\fR

   814 

   815 Type:    \fIBoolean\fR

   816 .br

   817 Default: \fIno\fR

   818 .br

   819 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   820 

   821 This option specifies if Tidy should output " characters as " as

   822 is preferred by some editing environments. The apostrophe character '

   823 is written out as ' since many web browsers don't yet support

   824 '.

   825 .TP

   826 \fBquote-nbsp\fR

   827 

   828 Type:    \fIBoolean\fR

   829 .br

   830 Default: \fIyes\fR

   831 .br

   832 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   833 

   834 This option specifies if Tidy should output non-breaking space

   835 characters as entities, rather than as the Unicode character value 160

   836 (decimal).

   837 .TP

   838 \fBrepeated-attributes\fR

   839 

   840 Type:    \fIenum\fR

   841 .br

   842 Default: \fIkeep-last\fR

   843 .br

   844 Example: \fIkeep-first, keep-last\fR

   845 

   846 This option specifies if Tidy should keep the first or last attribute,

   847 if an attribute is repeated, e.g. has two align attributes.

   848 

   849 

   850 .rj 1

   851 \fBSee also\fR: \fIjoin-classes\fR, \fIjoin-styles\fR

   852 .TP

   853 \fBreplace-color\fR

   854 

   855 Type:    \fIBoolean\fR

   856 .br

   857 Default: \fIno\fR

   858 .br

   859 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   860 

   861 This option specifies if Tidy should replace numeric values in color

   862 attributes by HTML/XHTML color names where defined, e.g. replace

   863 "#ffffff" with "white".

   864 .TP

   865 \fBshow-body-only\fR

   866 

   867 Type:    \fIBoolean\fR

   868 .br

   869 Default: \fIno\fR

   870 .br

   871 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   872 

   873 This option specifies if Tidy should print only the contents of the

   874 body tag as an HTML fragment. Useful for incorporating existing whole

   875 pages as a portion of another page.

   876 .TP

   877 \fBuppercase-attributes\fR

   878 

   879 Type:    \fIBoolean\fR

   880 .br

   881 Default: \fIno\fR

   882 .br

   883 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   884 

   885 This option specifies if Tidy should output attribute names in upper

   886 case. The default is no, which results in lower case attribute names,

   887 except for XML input, where the original case is preserved.

   888 .TP

   889 \fBuppercase-tags\fR

   890 

   891 Type:    \fIBoolean\fR

   892 .br

   893 Default: \fIno\fR

   894 .br

   895 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   896 

   897 This option specifies if Tidy should output tag names in upper case.

   898 The default is no, which results in lower case tag names, except for

   899 XML input, where the original case is preserved.

   900 .TP

   901 \fBword-2000\fR

   902 

   903 Type:    \fIBoolean\fR

   904 .br

   905 Default: \fIno\fR

   906 .br

   907 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   908 

   909 This option specifies if Tidy should go to great pains to strip out all

   910 the surplus stuff Microsoft Word 2000 inserts when you save Word

   911 documents as "Web pages". Doesn't handle embedded images or VML. You

   912 should consider using Word's "Save As: Web Page, Filtered".

   913 .SS Diagnostics options:

   914 

   915 .TP

   916 \fBaccessibility-check\fR

   917 

   918 Type:    \fIenum\fR

   919 .br

   920 Default: \fI0 (Tidy Classic)\fR

   921 .br

   922 Example: \fI0 (Tidy Classic), 1 (Priority 1 Checks), 2 (Priority 2

   923 Checks), 3 (Priority 3 Checks)\fR

   924 

   925 This option specifies what level of accessibility checking, if any,

   926 that Tidy should do. Level 0 is equivalent to Tidy Classic's

   927 accessibility checking. For more information on Tidy's accessibility

   928 checking, visit the Adaptive Technology Resource Centre at the

   929 University of Toronto at

   930 \fIhttp://www.aprompt.ca/Tidy/accessibilitychecks.html\fR.

   931 .TP

   932 \fBshow-errors\fR

   933 

   934 Type:    \fIInteger\fR

   935 .br

   936 Default: \fI6\fR

   937 .br

   938 Example: \fI0, 1, 2, ...\fR

   939 

   940 This option specifies the number Tidy uses to determine if further

   941 errors should be shown. If set to 0, then no errors are shown.

   942 .TP

   943 \fBshow-warnings\fR

   944 

   945 Type:    \fIBoolean\fR

   946 .br

   947 Default: \fIyes\fR

   948 .br

   949 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   950 

   951 This option specifies if Tidy should suppress warnings. This can be

   952 useful when a few errors are hidden in a flurry of warnings.

   953 .SS Pretty Print options:

   954 

   955 .TP

   956 \fBbreak-before-br\fR

   957 

   958 Type:    \fIBoolean\fR

   959 .br

   960 Default: \fIno\fR

   961 .br

   962 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   963 

   964 This option specifies if Tidy should output a line break before each

   965 <BR> element.

   966 .TP

   967 \fBindent\fR

   968 

   969 Type:    \fIAutoBool\fR

   970 .br

   971 Default: \fIno\fR

   972 .br

   973 Example: \fIauto, y/n, yes/no, t/f, true/false, 1/0\fR

   974 

   975 This option specifies if Tidy should indent block-level tags. If set to

   976 "auto", this option causes Tidy to decide whether or not to indent the

   977 content of tags such as TITLE, H1-H6, LI, TD, TD, or P depending on

   978 whether or not the content includes a block-level element. You are

   979 advised to avoid setting indent to yes as this can expose layout bugs

   980 in some browsers.

   981 

   982 

   983 .rj 1

   984 \fBSee also\fR: \fIindent-spaces\fR

   985 .TP

   986 \fBindent-attributes\fR

   987 

   988 Type:    \fIBoolean\fR

   989 .br

   990 Default: \fIno\fR

   991 .br

   992 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

   993 

   994 This option specifies if Tidy should begin each attribute on a new

   995 line.

   996 .TP

   997 \fBindent-spaces\fR

   998 

   999 Type:    \fIInteger\fR

  1000 .br

  1001 Default: \fI2\fR

  1002 .br

  1003 Example: \fI0, 1, 2, ...\fR

  1004 

  1005 This option specifies the number of spaces Tidy uses to indent content,

  1006 when indentation is enabled.

  1007 

  1008 

  1009 .rj 1

  1010 \fBSee also\fR: \fIindent\fR

  1011 .TP

  1012 \fBmarkup\fR

  1013 

  1014 Type:    \fIBoolean\fR

  1015 .br

  1016 Default: \fIyes\fR

  1017 .br

  1018 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

  1019 

  1020 This option specifies if Tidy should generate a pretty printed version

  1021 of the markup. Note that Tidy won't generate a pretty printed version

  1022 if it finds significant errors (see force-output).

  1023 .TP

  1024 \fBpunctuation-wrap\fR

  1025 

  1026 Type:    \fIBoolean\fR

  1027 .br

  1028 Default: \fIno\fR

  1029 .br

  1030 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

  1031 

  1032 This option specifies if Tidy should line wrap after some Unicode or

  1033 Chinese punctuation characters.

  1034 .TP

  1035 \fBsplit\fR

  1036 

  1037 Type:    \fIBoolean\fR

  1038 .br

  1039 Default: \fIno\fR

  1040 .br

  1041 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

  1042 

  1043 Currently not used. Tidy Classic only.

  1044 .TP

  1045 \fBtab-size\fR

  1046 

  1047 Type:    \fIInteger\fR

  1048 .br

  1049 Default: \fI8\fR

  1050 .br

  1051 Example: \fI0, 1, 2, ...\fR

  1052 

  1053 This option specifies the number of columns that Tidy uses between

  1054 successive tab stops. It is used to map tabs to spaces when reading the

  1055 input. Tidy never outputs tabs.

  1056 .TP

  1057 \fBvertical-space\fR

  1058 

  1059 Type:    \fIBoolean\fR

  1060 .br

  1061 Default: \fIno\fR

  1062 .br

  1063 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

  1064 

  1065 This option specifies if Tidy should add some empty lines for

  1066 readability.

  1067 .TP

  1068 \fBwrap\fR

  1069 

  1070 Type:    \fIInteger\fR

  1071 .br

  1072 Default: \fI68\fR

  1073 .br

  1074 Example: \fI0 (no wrapping), 1, 2, ...\fR

  1075 

  1076 This option specifies the right margin Tidy uses for line wrapping.

  1077 Tidy tries to wrap lines so that they do not exceed this length. Set

  1078 wrap to zero if you want to disable line wrapping.

  1079 .TP

  1080 \fBwrap-asp\fR

  1081 

  1082 Type:    \fIBoolean\fR

  1083 .br

  1084 Default: \fIyes\fR

  1085 .br

  1086 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

  1087 

  1088 This option specifies if Tidy should line wrap text contained within

  1089 ASP pseudo elements, which look like: <% ... %>.

  1090 .TP

  1091 \fBwrap-attributes\fR

  1092 

  1093 Type:    \fIBoolean\fR

  1094 .br

  1095 Default: \fIno\fR

  1096 .br

  1097 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

  1098 

  1099 This option specifies if Tidy should line wrap attribute values, for

  1100 easier editing. This option can be set independently of

  1101 wrap-script-literals.

  1102 

  1103 

  1104 .rj 1

  1105 \fBSee also\fR: \fIwrap-script-literals\fR

  1106 .TP

  1107 \fBwrap-jste\fR

  1108 

  1109 Type:    \fIBoolean\fR

  1110 .br

  1111 Default: \fIyes\fR

  1112 .br

  1113 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

  1114 

  1115 This option specifies if Tidy should line wrap text contained within

  1116 JSTE pseudo elements, which look like: <# ... #>.

  1117 .TP

  1118 \fBwrap-php\fR

  1119 

  1120 Type:    \fIBoolean\fR

  1121 .br

  1122 Default: \fIyes\fR

  1123 .br

  1124 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR

  1125 

  1126 This option specifies if Tidy should line wrap text contained within

  1127 PHP pseudo elements, which look like: <?php ... ?>.

  1128 .TP

  1129 \fBwrap-script-literals\fR

  1130 

  1131 Type:    \fIBoolean\fR

  1132 .br

  1133 Default: \fIno\fR

  1134 .br

  1135 Example: \fIy/n, yes/no, t/f, true/false, 1/0\fR