summarylogtreecommitdiffstats
path: root/epubcheck.1
blob: 21ba039554f1a8a33ee531f27cdfce563125caf0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
.\" Enhanced version of file generated by help2man 1.47.10
.TH EPUBCHECK 1 "2019-05-20" "epubcheck 4.2.1" "Epubcheck Manual"	
.SH NAME
\fBepubcheck\fR - a tool to validate EPUB files
.SH SYNOPSIS
\fBepubcheck\fR [ \fB\-\-profile\fR \fIprofile\fR  ] [ \fB\-\-mode\fR \fImode\fR ] [ \fIoptions\fR ] [ file ]
.SH DESCRIPTION
\fBepubcheck\fR is a tool to validate EPUB 2 and EPUB 3 files. It can detect many types of errors in EPUB. OCF container structure, OPF and OPS mark-up, and internal reference 
consistency are checked. 
.PP
\fBepubcheck\fR can be run as a standalone command-line tool or used as a Java library.
.SH OPTIONS
.BR
.SS "General options"
.BR
.TP 
\fB\-s\fR, \fB\-\-save\fR 
Saves the EPUB created from the validation check of an expanded EPUB archive
.TP
\fB\-o\fR, \fB\-\-out\fR \fIfile\fR
Output an assessment XML document file (use \- to output to console)
.TP
\fB\-x\fR, \fB\-\-xmp\fR \fIfile\FR
Output an assessment XMP document file (use \- to output to console)
.TP
\fB\-j\fR, \fB\-\-json\fR \fIfile\fR
Output an assessment JSON document file (use \- to output to console)
.TP
\fB\-m\fR, \fB\-\-mode\fR \fImode\fR 
Specify the mode (required for validating non-EPUB files)
.TP
\fB\-p\fR, \fB\-\-profile\fR \fIprofile\fR
Specify the profile to validate against
.TP
\fB\-\-failonwarnings\fR
By default, the tool returns 1 if errors are found in the file or 0 if no errors are found.
Using \fB\-\-failonwarnings\fR will cause the process to exit with a status of 1 if either warnings or errors are present and 0 only when there are no errors or warnings.
.TP
\fB\-q\fR, \fB\-\-quiet\fR      
No message on console, except errors, only in the output
.TP
\fB\-f\fR, \fB\-\-fatal\fR      
Include only fatal errors in the output
.TP
\fB\-e\fR, \fB\-\-error\fR     
Include only error and fatal severity messages in ouput
.TP
\fB\-w\fR, \fB\-\-warn\fR       
Include fatal, error, and warn severity messages in output
.TP
\fB\-u\fR, \fB\-\-usage\fR      
Include ePub feature usage information in output (default is OFF); if enabled, usage information will
always be included in the output file
.TP
\fB\-\-locale\fR
Output localized messages according to the provided IETF BCP 47 language tag string
.TP
\fB\-l\fR, \fB\-\-listChecks\fR \fIfile\fR 
List message ids and severity levels to the custom message file named \fIfile\fR or the console
.TP
\fB\-c\fR, \fB\-\-customMessages\fR \fIfile\fR 
Override message severity levels as defined in the custom message file named \fIfile\fR
.TP
\fB\-h\fR, \fB\-?\fR or \fB\-\-help\fR 
Displays help message
.BR
.SS "Modes"
.BR
.PP
If checking a non\-epub file, the type of the file must be specified using \fB\-\-mode\fR and the epub version of the file must
be specified using \fB\-v\fR. The default version is 3.0.
.TP
\fB\-\-mode\fR \fIopf\fR \fB\-v\fR \fI2.0\fR
For single OPF file validation (EPUB 2)
.TP
\fB\-\-mode\fR \fIopf\fR \fB\-v\fR \fI3.0\fR
For single OPF file validation (EPUB 3)
.TP
\fB\-\-mode\fR \fIxhtml\fR \fB\-v\fR \fI2.0\fR
For single XHTML file validation (EPUB 2)
.TP
\fB\-\-mode\fR \fIxhtml\fR \fB\-v\fR \fI3.0\fR
For single XHTML file validation (EPUB 3)
.TP
\fB\-\-mode\fR \fIsvg\fR \fB\-v\fR \fI2.0\fR
For single SVG file validation (EPUB 2)
.TP
\fB\-\-mode\fR \fIsvg\fR \fB\-v\fR \fI3.0\fR
For single SVG file validation (EPUB 3)
.TP
\fB\-\-mode\fR \fInav\fR \fB\-v\fR \fI3.0\fR
For single 'Navigation Document' validation
.TP
\fB\-\-mode\fR \fImo\fR  \fB\-v\fR \fI3.0\fR
For single 'Media Overlays' validation
.TP
\fB\-\-mode\fR \fIexp\fR
For validating expanded EPUB archives
.BR
.SS "Validation profiles"
.BR
.PP
To specify a validation profile (to run checks against a specific EPUB 3 profile
or extension specification), use the \fB\-\-profile\fR option.
.TP
\fB\-\-profile\fR \fIdefault\fR
The default validation profile
.TP
\fB\-\-profile\fR \fIdict\fR 
Validates against the EPUB Dictionaries and Glossaries specification
.TP
\fB\-\-profile\fR \fIedupub\fR 
Validates against the EDUPUB Profile
.TP
\fB\-\-profile\fR \fIidx\fR
Validates against the EPUB Indexes specification
.TP
\fB\-\-profile\fR \fIpreview\fR
Validates against the EPUB Previews specification
.SH EXAMPLES
.TP
\fBepubcheck\fR \fIfilename\fR
Perfom a simple validation check on an EPUB file
.TP
\fBepubcheck \-\-mode\fR \fIexp filename\fR
Perform a vaidation check on an expanded EPUB archive (add \fB\-\-save\fR to save the built epub)
.TP
\fBepubcheck \-\-mode\fR \fIxhtml\fR \fB\-v\fR \fI3.0 filename\fR
Perform a validation check on a single xhtml file from an EPUB 3
.SH AUTHORS
.PP
\fBepubcheck\fR development can be followed at: \fIhttps://github.com/IDPF/epubcheck\fR
.PP
This man page was compiled from various sources by James Thomas \fI<dairy_water at yahoo dot co dot uk>\fR