man_page.txt   [plain text]


.TH TIDY 1 "December 1, 2002"
.SH NAME
tidy \- validate, correct, and pretty-print HTML files
.SH SYNOPSIS
.B tidy
.I [option ...] [file ...] [option ...] [file ...]
.SH DESCRIPTION
.P
Tidy reads HTML, XHTML and XML files and writes cleaned up
markup.  For HTML varians, it detects and corrects many common
coding errors and strives to produce visually equivalent 
markup that is both W3C complaint and works on most browsers.
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.
.P
If no markup file is specified, Tidy reads the standard
input.  If no output file is specified, Tidy writes markup
to the standard output.  If no error file is specified, Tidy
writes messages to the standard error.
.SH OPTIONS
.B
.B Processing directives
.TP 15
.B -indent  or -i
to indent element content
.TP 15
.B -omit
to omit optional end tags
.TP 15
.B -wrap <column>   
to wrap text at the specified <column> (default is 68)
.TP 15
.B -upper   or -u   
to force tags to upper case (default is lower case)
.TP 15
.B -clean   or -c   
to replace FONT, NOBR and CENTER tags by CSS
.TP 15
.B -bare    or -b   
to strip out smart quotes and em dashes, etc.
.TP 15
.B -numeric or -n   
to output numeric rather than named entities
.TP 15
.B -errors  or -e   
to only show errors
.TP 15
.B -quiet   or -q   
to suppress nonessential output
.TP 15
.B -xml             
to specify the input is well formed XML
.TP 15
.B -asxml           
to convert HTML to well formed XHTML
.TP 15
.B -asxhtml         
to convert HTML to well formed XHTML
.TP 15
.B -ashtml          
to force XHTML to well formed HTML
.TP 15
.B -access \<level\>  
to do additional accessibility checks (\<level\> = 1, 2, 3)
.TP 15
.B Character encodings
.TP 15
.B -raw             
to output values above 127 without conversion to entities
.TP 15
.B -ascii           
to use US-ASCII for output, ISO-8859-1 for input
.TP 15
.B -latin1          
to use ISO-8859-1 for both input and output
.TP 15
.B -iso2022         
to use ISO-2022 for both input and output
.TP 15
.B -utf8            
to use UTF-8 for both input and output
.TP 15
.B -mac             
to use MacRoman for input, US-ASCII for output
.TP 15
.B -utf16le         
to use UTF-16LE for both input and output
.TP 15
.B -utf16be         
to use UTF-16BE for both input and output
.TP 15
.B -utf16           
to use UTF-16 for both input and output
.TP 15
.B -win1252         
to use Windows-1252 for input, US-ASCII for output
.TP 15
.B -big5            
to use Big5 for both input and output
.TP 15
.B -shiftjis        
to use Shift_JIS for both input and output
.TP 15
.B -language \<lang\> 
to set the two-letter language code <lang> (for future use)
.TP 15
.B File manipulation
.TP 15
.B -output or -o <file>   
to write output to the specified <file>
.TP 15
.B -f      <file>   
to write errors to the specified <file>
.TP 15
.B -config <file>   
to set configuration options from the specified <file>
.TP 15
.B -modify or -m    
to modify the original input files
.TP 15
.B Miscellaneous
.TP 15
.B -version  or -v  
to show the version of Tidy
.TP 15
.B -help, -h or -?  
to list the command line options
.TP 15
.B -help-config     
to list all configuration options
.TP 15
.B -show-config     
to list the current configuration settings
.SH USAGE
.P
Use --blah blarg for any configuration option "blah" with argument "blarg"
.P
Input/Output default to stdin/stdout respectively
Single letter options apart from -f and -o may be combined
as in:  tidy -f errs.txt -imu foo.html
For further info on HTML see http://www.w3.org/MarkUp
.P
For more information about HTML Tidy, visit the project home page at
http://tidy.sourceforge.net.  Here, you will find links to documentation,
mailing lists (with searchable archives) and links to report bugs.
.SH ENVIRONMENT
.TP 15
.B HTML_TIDY
Name of the default configuration file.  This should be an absolute path,
since you will probably invoke
.B tidy
from different directories.  The value of HTML_TIDY will be parsed after the
compiled-in default (defined with -DCONFIG_FILE), but before any of the
files specified using
.BR -config .
.SH "EXIT STATUS"
.IP 0
All input files were processed successfully.
.IP 1
There were warnings.
.IP 2
There were errors.
.SH "SEE ALSO"
.P
HTML Tidy Project Page at http://tidy.sourceforge.net
.P
Dave Raggett's Tidy Overview at http://www.w3.org/People/Raggett/tidy/
.P
Tidy Quick Reference at http://tidy.sourceforge.net/docs/quickref.html
.P
For information about TidyLib, see http://tidy.sourceforge.net/libintro.html
.SH AUTHORS
.P
Dave Raggett <dsr@w3.org>.
.P
Terry Teague <terry_teague@users.sourceforge.net>.
.P
Bjoern Hoehrmann <bjoern@hoehrmann.de>
.P
Charles Reitzel <creitzel@rcn.com>
.P
This manual page was written by Matej Vela <vela@debian.org> and updated
by Charles Reitzel.