[Git][java-team/epubcheck][master] 2 commits: d/rules: Make sure to update the version for man page

Fri Sep 11 07:40:23 BST 2020


Mathieu Malaterre pushed to branch master at Debian Java Maintainers / epubcheck


Commits:
7b7f75ce by Mathieu Malaterre at 2020-09-11T08:39:38+02:00
d/rules: Make sure to update the version for man page

- - - - -
583451f2 by Mathieu Malaterre at 2020-09-11T08:39:51+02:00
d/manpages: Manually fix manpage. Closes: #935955

- - - - -


2 changed files:

- debian/epubcheck.1
- debian/rules


Changes:

=====================================
debian/epubcheck.1
=====================================
@@ -1,5 +1,5 @@
-.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.43.3.
-.TH EPUBCHECK "1" "September 2014" "epubcheck 4.0.0" "User Commands"
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.8.
+.TH EPUBCHECK "1" "September 2020" "epubcheck 4.2.4" "User Commands"
 .SH NAME
 epubcheck \- Validation tool for EPUB
 .SH SYNOPSIS
@@ -7,28 +7,101 @@ epubcheck file.epub
 .SH DESCRIPTION
 All detected errors are simply printed to stderr
 .PP
-When running this tool, the first argument should be the name (with the path) of the file to check.
-If checking a non\-epub file, the epub version of the file must be specified using \fB\-v\fR and the type of the file using \fB\-mode\fR.
+EPUBCheck v4.1.0
+.PP
+When running this tool, the first argument should be the name (with the path)
+of the file to check.
+.PP
+To specify a validation profile (to run checks against a specific EPUB 3 profile
+or extension specification), use the \fB\-profile\fR option:
+.PP
+Validation profiles supported:
+
+\fB\-\-profile\fR default  // the default validation profile
+
+\fB\-\-profile\fR dict     // validates against the EPUB Dictionaries and Glossaries specification
+
+\fB\-\-profile\fR edupub   // validates against the EDUPUB Profile
+
+\fB\-\-profile\fR idx      // validates against the EPUB Indexes specification
+
+\fB\-\-profile\fR preview  // validates against the EPUB Previews specification
+.PP
+If checking a non\-epub file, the epub version of the file must
+be specified using \fB\-v\fR and the type of the file using \fB\-mode\fR.
 The default version is: 3.0.
 .PP
 Modes and versions supported:
-\fB\-mode\fR opf \fB\-v\fR 2.0    // For single OPF file validation (EPUB 2)
-\fB\-mode\fR opf \fB\-v\fR 3.0    // For single OPF file validation (EPUB 3)
-\fB\-mode\fR xhtml \fB\-v\fR 2.0  // For single XHTML file validation (EPUB 2)
-\fB\-mode\fR xhtml \fB\-v\fR 3.0  // For single XHTML file validation (EPUB 3)
-\fB\-mode\fR svg \fB\-v\fR 2.0    // For single SVG file validation (EPUB 2)
-\fB\-mode\fR svg \fB\-v\fR 3.0    // For single SVG file validation (EPUB 3)
-\fB\-mode\fR nav \fB\-v\fR 3.0    // For single 'Navigation Document' validation
-\fB\-mode\fR mo  \fB\-v\fR 3.0    // For single 'Media Overlays' validation
-\fB\-mode\fR exp           // For validating expanded EPUB archives
-.PP
-This tool also accepts the following flags:
-\fB\-save\fR         = saves the epub created from the expanded epub (\fB\-mode\fR exp)
-\fB\-quiet\fR        = no message sent to stdout, only errors in stderr
-\fB\-out\fR <file>   = output an assessment XML document in file (experimental)
-\-? or \fB\-help\fR   = displays this help message
-.PP
-Epubcheck Version 4.0.0
+
+\fB\-\-mode\fR opf \fB\-v\fR 2.0
+
+\fB\-\-mode\fR opf \fB\-v\fR 3.0
+
+\fB\-\-mode\fR xhtml \fB\-v\fR 2.0
+
+\fB\-\-mode\fR xhtml \fB\-v\fR 3.0
+
+\fB\-\-mode\fR svg \fB\-v\fR 2.0
+
+\fB\-\-mode\fR svg \fB\-v\fR 3.0
+
+\fB\-\-mode\fR nav \fB\-v\fR 3.0
+
+\fB\-\-mode\fR mo  \fB\-v\fR 3.0  // for Media Overlays validation
+
+\fB\-\-mode\fR exp         // for expanded EPUB archives
+.PP
+This tool also accepts the following options:
+
+\fB\-\-save\fR           = saves the epub created from the expanded epub
+
+\fB\-\-out\fR <file>     = output an assessment XML document file (use \- to output to console)
+
+\fB\-\-xmp\fR <file>     = output an assessment XMP document file (use \- to output to console)
+
+\fB\-\-json\fR <file>    = output an assessment JSON document file (use \- to output to console)
+
+\fB\-m\fR <file>        = same as \fB\-\-mode\fR
+
+\fB\-p\fR <profile>     = same as \fB\-\-profile\fR
+
+\fB\-o\fR <file>        = same as \fB\-\-out\fR
+
+\fB\-x\fR <file>        = same as \fB\-\-xmp\fR
+
+\fB\-j\fR <file>        = same as \fB\-\-json\fR
+
+\fB\-\-failonwarnings[\fR+|\-] = By default, the tool returns a 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
+.IP
+1 if either warnings or errors are present and 0 only when there are no errors or warnings.
+.PP
+\fB\-q\fR, \fB\-\-quiet\fR      = no message on console, except errors, only in the output
+
+\fB\-f\fR, \fB\-\-fatal\fR      = include only fatal errors in the output
+
+\fB\-e\fR, \fB\-\-error\fR      = include only error and fatal severity messages in ouput
+
+\fB\-w\fR, \fB\-\-warn\fR       = include fatal, error, and warn severity messages in output
+
+\fB\-u\fR, \fB\-\-usage\fR      = include ePub feature usage information in output
+.IP
+(default is OFF); if enabled, usage information will
+always be included in the output file
+.PP
+\fB\-\-locale\fR <locale>  = output localized messages according to the provided IETF BCP 47 language tag string.
+.PP
+\fB\-l\fR, \fB\-\-listChecks\fR [<file>]     = list message ids and severity levels to the custom message file named <file>
+.IP
+or the console
+.PP
+\fB\-c\fR, \fB\-\-customMessages\fR [<file>] = override message severity levels as defined in the custom message file named <file>
+.PP
+\fB\-\-version\fR        = displays the EPUBCheck version
+.PP
+\fB\-h\fR, \-? or \fB\-\-help\fR = displays this help message
+.PP
+epubcheck completed
 .SH AUTHOR
 .IP \[bu] 2
 Peter Sorotokin


=====================================
debian/rules
=====================================
@@ -7,7 +7,9 @@ override_dh_fixperms::
 	dh_fixperms
 	chmod +x debian/epubcheck/usr/share/java/epubcheck.jar
 
+VER_FULL = $(shell dpkg-parsechangelog | grep '^Version' | cut -d' ' -f2 | cut -f1 -d-)
+
 debian/epubcheck.1: debian/epubcheck.1.in
 	help2man --include=$< --output=$@ \
 		--no-info --help-option="-help" \
-			`basename $@ .1` --version-string=4.1.0
+			`basename $@ .1` --version-string=$(VER_FULL)



View it on GitLab: https://salsa.debian.org/java-team/epubcheck/-/compare/f34ae4e7620d28e81f0528c4b20e917b59f9255d...583451f25182685f73a978fecea70d1bf1365f6c

-- 
View it on GitLab: https://salsa.debian.org/java-team/epubcheck/-/compare/f34ae4e7620d28e81f0528c4b20e917b59f9255d...583451f25182685f73a978fecea70d1bf1365f6c
You're receiving this email because of your account on salsa.debian.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://alioth-lists.debian.net/pipermail/pkg-java-commits/attachments/20200911/1da8bc78/attachment.html>
