CLI: --help mandatory, #115

OCR-D · Apr 6, 2020 · f6e3578 · f6e3578
1 parent af759b8
commit f6e3578
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,10 @@ Versioned according to [Semantic Versioning](http://semver.org/).
 
 ## Unreleased
 
+Changed:
+
+  * CLI tools must implement `-h/--help`, #115
+
 ## [3.4.2] - 2020-01-08
 
 Changed:

diff --git a/cli.md b/cli.md
@@ -41,7 +41,6 @@ Input METS URL. Default: `mets.xml`
 
 Working Directory. Default: current working directory.
 
-
 ### `-g, --page-id ID`
 
 **MULTI-VALUE**
@@ -72,6 +71,12 @@ other implementation-specific means of logging configuration. For example, with
 Instead of processing METS, output the [ocrd-tool](ocrd_tool) description for
 this executable, in particular its parameters.
 
+### `-h, --help`
+
+Print a concise description of the tool, the command line options and
+parameters it accepts as well as the input/output groups. This information should
+be generated from [`ocrd-tool.json`](ocrd_tool) as much as possible.
+
 ## Return value
 
 Successful execution should signal `0`. Any non-zero return value is considered a failure.