[ocrfeeder] Update manpages to reflect all available command-line options



commit f75e4eda19e6d99d086c9406d8d15a1c18142f42
Author: Alberto Garcia <agarcia igalia com>
Date:   Fri Nov 19 17:35:10 2010 +0100

    Update manpages to reflect all available command-line options

 resources/ocrfeeder-cli.1 |   24 +++++++++++++++++-------
 resources/ocrfeeder.1     |   15 ++++++++++++---
 2 files changed, 29 insertions(+), 10 deletions(-)
---
diff --git a/resources/ocrfeeder-cli.1 b/resources/ocrfeeder-cli.1
index f49ab39..c133202 100644
--- a/resources/ocrfeeder-cli.1
+++ b/resources/ocrfeeder-cli.1
@@ -1,4 +1,4 @@
-.TH ocrfeeder-cli 1 "2010\-03\-24"
+.TH ocrfeeder-cli 1 "2010\-11\-19"
 .SH NAME
 ocrfeeder-cli \- command line interface for OCRFeeder, a document layout analysis and optical character recognition system.
 .SH SYNOPSIS
@@ -15,17 +15,26 @@ between what's graphics and text and perform OCR over the latter. It generates
 multiple formats being its main one ODT.
 
 .SH OPTIONS
+.SS "Generic program information"
 .TP
-.BI "\-\-images IMAGE1 IMAGE2 ..."
-Images to be recognized
+.BI \-\^\-version
+Show program version number and exit
 .TP
-.BI "\-\-format FORMAT"
-Format for the generated document (ODT or HTML)
+.BI \-h "\fR, " \-\^\-help
+Show help message and exit
+.SS "Required options"
 .TP
-.BI "\-\-o FILE_NAME"
+.BI \-o " OUTPUT_FILE\fR, " \-\^\-output= "OUTPUT_FILE"
 Name for the generated file
+.SS "Other options"
+.TP
+.BI \-i " IMAGE1 [IMAGE2 ...]\fR, " \-\^\-images= "IMAGE1 [IMAGE2 ...]"
+Images to be recognized
+.TP
+.BI \-f " FORMAT\fR, " \-\^\-format= "FORMAT"
+Format for the generated document (odt or html)
 .TP
-.BI "\-\-window-size WINDOW_SIZE"
+.BI \-\^\-window-size= "WINDOW_SIZE"
 Desired window size of OCRFeeder's segmentation algorithm. If 
 this option is not used, the window size will be calculated automatically
 
@@ -38,3 +47,4 @@ Folder to hold the engines' configuration files
 .SH AUTHOR
 This manpage has been written by
 Joaquim Rocha <jrocha igalia com>
+and Alberto Garcia <agarcia igalia com>
diff --git a/resources/ocrfeeder.1 b/resources/ocrfeeder.1
index 8255864..3420f1f 100644
--- a/resources/ocrfeeder.1
+++ b/resources/ocrfeeder.1
@@ -1,4 +1,4 @@
-.TH ocrfeeder 1 "2010\-03\-24"
+.TH ocrfeeder 1 "2010\-11\-19"
 .SH NAME
 ocrfeeder \- document layout analysis and optical character recognition system.
 .SH SYNOPSIS
@@ -15,11 +15,19 @@ between what's graphics and text and perform OCR over the latter. It generates
 multiple formats being its main one ODT.
 
 .SH OPTIONS
+.SS "Generic program information"
 .TP
-.BI "\-\-images IMAGE1 IMAGE2 ..."
+.BI \-\^\-version
+Show program's version number and exit
+.TP
+.BI \-h "\fR, " \-\^\-help
+Show help message and exit
+.SS "Other options"
+.TP
+.BI \-i " IMAGE1 [IMAGE2 ...]\fR, " \-\^\-images= "IMAGE1 [IMAGE2 ...]"
 Add the specified images to OCRFeeder after opening it
 .TP
-.BI "\-\-dir DIR"
+.BI \-d " DIRECTORY\fR, " \-\^\-dir= "DIRECTORY"
 Add all images under the specified directory to OCRFeeder after opening it
 
 .SH FILES
@@ -36,3 +44,4 @@ Folder to hold the engines' configuration files
 .SH AUTHOR
 This manpage has been written by
 Joaquim Rocha <jrocha igalia com>
+and Alberto Garcia <agarcia igalia com>



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]