[ocrfeeder] Add man pages



commit 19a1f75bbf8fbfa618cdadfc00b3f6736034997d
Author: Joaquim Rocha <jrocha cookiemonster local igalia com>
Date:   Wed Mar 24 17:15:34 2010 +0100

    Add man pages

 resources/ocrfeeder-cli.1 |   40 ++++++++++++++++++++++++++++++++++++++++
 resources/ocrfeeder.1     |   38 ++++++++++++++++++++++++++++++++++++++
 setup.py                  |    3 +++
 3 files changed, 81 insertions(+), 0 deletions(-)
---
diff --git a/resources/ocrfeeder-cli.1 b/resources/ocrfeeder-cli.1
new file mode 100644
index 0000000..f49ab39
--- /dev/null
+++ b/resources/ocrfeeder-cli.1
@@ -0,0 +1,40 @@
+.TH ocrfeeder-cli 1 "2010\-03\-24"
+.SH NAME
+ocrfeeder-cli \- command line interface for OCRFeeder, a document layout analysis and optical character recognition system.
+.SH SYNOPSIS
+.B ocrfeeder-cli
+.I [OPTIONS]
+.SH DESCRIPTION
+This manual page documents briefly the
+.B ocrfeeder-cli
+command.
+.PP
+.B OCRFeeder
+Given the images it will automatically outline its contents, distinguish 
+between what's graphics and text and perform OCR over the latter. It generates 
+multiple formats being its main one ODT.
+
+.SH OPTIONS
+.TP
+.BI "\-\-images IMAGE1 IMAGE2 ..."
+Images to be recognized
+.TP
+.BI "\-\-format FORMAT"
+Format for the generated document (ODT or HTML)
+.TP
+.BI "\-\-o FILE_NAME"
+Name for the generated file
+.TP
+.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
+
+.SH FOLDERS
+.TP
+.I ~/.ocrfeeder/engines/
+Folder to hold the engines' configuration files
+.SH SEE ALSO
+.BR ocrfeeder (1)
+.SH AUTHOR
+This manpage has been written by
+Joaquim Rocha <jrocha igalia com>
diff --git a/resources/ocrfeeder.1 b/resources/ocrfeeder.1
new file mode 100644
index 0000000..8255864
--- /dev/null
+++ b/resources/ocrfeeder.1
@@ -0,0 +1,38 @@
+.TH ocrfeeder 1 "2010\-03\-24"
+.SH NAME
+ocrfeeder \- document layout analysis and optical character recognition system.
+.SH SYNOPSIS
+.B ocrfeeder
+.I [OPTIONS]
+.SH DESCRIPTION
+This manual page documents briefly the
+.B ocrfeeder
+command.
+.PP
+.B OCRFeeder
+Given the images it will automatically outline its contents, distinguish 
+between what's graphics and text and perform OCR over the latter. It generates 
+multiple formats being its main one ODT.
+
+.SH OPTIONS
+.TP
+.BI "\-\-images IMAGE1 IMAGE2 ..."
+Add the specified images to OCRFeeder after opening it
+.TP
+.BI "\-\-dir DIR"
+Add all images under the specified directory to OCRFeeder after opening it
+
+.SH FILES
+.TP
+.I ~/.ocrfeeder/preferences.xml
+OCRFeeder's configurations file
+
+.SH FOLDERS
+.TP
+.I ~/.ocrfeeder/engines/
+Folder to hold the engines' configuration files
+.SH SEE ALSO
+.BR ocrfeeder-cli (1)
+.SH AUTHOR
+This manpage has been written by
+Joaquim Rocha <jrocha igalia com>
diff --git a/setup.py b/setup.py
index b0137ad..d4875ec 100644
--- a/setup.py
+++ b/setup.py
@@ -33,5 +33,8 @@ setup(name = 'ocrfeeder',
                    ),
                    ('/usr/share/applications', ['resources/ocrfeeder.desktop']
                    ),
+                   ('/usr/share/man/man1', ['resources/ocrfeeder.1',
+                                            'resources/ocrfeeder-cli.1']
+                   ),
                    ] + get_locale_files()
      )



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