~ubuntu-branches/ubuntu/gutsy/tidy/gutsy

« back to all changes in this revision

Viewing changes to debian/tidy.1

  • Committer: Bazaar Package Importer
  • Author(s): Jason Thomas
  • Date: 2005-04-20 11:22:49 UTC
  • mfrom: (0.2.1 upstream) (1.1.2 hoary)
  • Revision ID: james.westby@ubuntu.com-20050420112249-mygnr5vcrutwsen3
Tags: 20050415-1
New upstream release 

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.29.
 
2
.TH TIDY "1" "January 2003" "HTML Tidy for Linux" "User Commands"
 
3
.SH NAME
 
4
HTML Tidy \- Utility to clean up and pretty print HTML/XHTML/XML
 
5
.SH SYNOPSIS
 
6
\&tidy [option...] [file...] [option...] [file...]
 
7
.SH DESCRIPTION
 
8
Utility to clean up and pretty print HTML/XHTML/XML
 
9
see http://tidy.sourceforge.net/
 
10
.PP
 
11
Options for HTML Tidy for Linux/x86 released on 1st January 2003:
 
12
.PP
 
13
File manipulation
 
14
\fB\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\fR
 
15
.HP
 
16
\fB\-out\fR or \fB\-o\fR <file> specify the output markup file
 
17
.TP
 
18
\fB\-config\fR <file>
 
19
set configuration options from the specified <file>
 
20
.TP
 
21
\fB\-f\fR
 
22
<file>    write errors to the specified <file>
 
23
.TP
 
24
\fB\-modify\fR or \fB\-m\fR
 
25
modify the original input files
 
26
.PP
 
27
Processing directives
 
28
\fB\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\fR
 
29
.TP
 
30
\fB\-indent\fR
 
31
or \fB\-i\fR    indent element content
 
32
.TP
 
33
\fB\-wrap\fR <column>
 
34
wrap text at the specified <column> (default is 68)
 
35
.TP
 
36
\fB\-upper\fR
 
37
or \fB\-u\fR    force tags to upper case (default is lower case)
 
38
.TP
 
39
\fB\-clean\fR
 
40
or \fB\-c\fR    replace FONT, NOBR and CENTER tags by CSS
 
41
.TP
 
42
\fB\-bare\fR
 
43
or \fB\-b\fR    strip out smart quotes and em dashes, etc.
 
44
.TP
 
45
\fB\-numeric\fR or \fB\-n\fR
 
46
output numeric rather than named entities
 
47
.TP
 
48
\fB\-errors\fR
 
49
or \fB\-e\fR    only show errors
 
50
.TP
 
51
\fB\-quiet\fR
 
52
or \fB\-q\fR    suppress nonessential output
 
53
.TP
 
54
\fB\-omit\fR
 
55
omit optional end tags
 
56
.TP
 
57
\fB\-xml\fR
 
58
specify the input is well formed XML
 
59
.TP
 
60
\fB\-asxml\fR
 
61
convert HTML to well formed XHTML
 
62
.TP
 
63
\fB\-asxhtml\fR
 
64
convert HTML to well formed XHTML
 
65
.TP
 
66
\fB\-ashtml\fR
 
67
force XHTML to well formed HTML
 
68
.TP
 
69
\fB\-access\fR <level>
 
70
do additional accessibility checks (<level> = 1, 2, 3)
 
71
.PP
 
72
Character encodings
 
73
\fB\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\fR
 
74
.TP
 
75
\fB\-raw\fR
 
76
output values above 127 without conversion to entities
 
77
.TP
 
78
\fB\-ascii\fR
 
79
use US-ASCII for output, ISO-8859-1 for input
 
80
.TP
 
81
\fB\-latin0\fR
 
82
use US-ASCII for output, ISO-8859-1 for input
 
83
.TP
 
84
\fB\-latin1\fR
 
85
use ISO-8859-1 for both input and output
 
86
.TP
 
87
\fB\-iso2022\fR
 
88
use ISO-2022 for both input and output
 
89
.TP
 
90
\fB\-utf8\fR
 
91
use UTF-8 for both input and output
 
92
.TP
 
93
\fB\-mac\fR
 
94
use MacRoman for input, US-ASCII for output
 
95
.TP
 
96
\fB\-win1252\fR
 
97
use Windows-1252 for input, US-ASCII for output
 
98
.TP
 
99
\fB\-ibm858\fR
 
100
use IBM-858 (CP850+Euro) for input, US-ASCII for output
 
101
.TP
 
102
\fB\-utf16le\fR
 
103
use UTF-16LE for both input and output
 
104
.TP
 
105
\fB\-utf16be\fR
 
106
use UTF-16BE for both input and output
 
107
.TP
 
108
\fB\-utf16\fR
 
109
use UTF-16 for both input and output
 
110
.TP
 
111
\fB\-big5\fR
 
112
use Big5 for both input and output
 
113
.TP
 
114
\fB\-shiftjis\fR
 
115
use Shift_JIS for both input and output
 
116
.TP
 
117
\fB\-language\fR <lang>
 
118
set the two-letter language code <lang> (for future use)
 
119
.PP
 
120
Miscellaneous
 
121
\fB\-\-\-\-\-\-\-\-\-\-\-\-\-\fR
 
122
.TP
 
123
\fB\-version\fR
 
124
or \fB\-v\fR   show the version of Tidy
 
125
.TP
 
126
\fB\-help\fR, \fB\-h\fR or -?
 
127
list the command line options
 
128
.TP
 
129
\fB\-help\-config\fR
 
130
list all configuration options
 
131
.TP
 
132
\fB\-show\-config\fR
 
133
list the current configuration settings
 
134
.PP
 
135
Use \fB\-\-blah\fR blarg for any configuration option "blah" with argument "blarg"
 
136
.PP
 
137
Input/Output default to stdin/stdout respectively
 
138
Single letter options apart from \fB\-f\fR may be combined
 
139
as in:  tidy \fB\-f\fR errs.txt \fB\-imu\fR foo.html
 
140
For further info on HTML see http://www.w3.org/MarkUp
 
141
 
 
142
 
 
143
.SH ENVIRONMENT
 
144
.TP
 
145
.B HTML_TIDY
 
146
Name of the default configuration file.  This should be an absolute path,
 
147
since you will probably invoke
 
148
.B tidy
 
149
from different directories.  The value of HTML_TIDY will be parsed after the
 
150
compiled-in default (/etc/tidy.conf), but before any of the
 
151
files specified using
 
152
.BR -config .
 
153
The value of HTML_TIDY overrides $HOME/.tidyrc
 
154
.SH "EXIT STATUS"
 
155
.IP 0
 
156
All input files were processed successfully.
 
157
.IP 1
 
158
There were warnings.
 
159
.IP 2
 
160
There were errors.
 
161
.SH FILES
 
162
/etc/tidy.conf - global configuration file
 
163
.br
 
164
$HOME/.tidyrc - user configuration file
 
165
.SH "SEE ALSO"
 
166
Tidy HTML documentation in tidy-doc package.