Re: [Bug-ocrad] Re: Bug#602478: ocrad: manual -- Unclear options -o and -x

[Jari Aalto]

2011-01-26 19:39 Antonio Diaz Diaz <address@hidden>:
> Hello,
>
> Ocrad is able to produce other types of output, not only text. So the
> current generic description of -o is more appropiate than the proposed
> "text only" replacement.
>
> "OCR Results File" is the name of a format originally used to
> interface ocrad with kooka, and has its own chapter in the manual, but
> to avoid confusions I have replaced the description of -x to "export
> results in ORF format to <file>".
>
> I'll also extend the description of ocrad in the --help output, but
> not so much as proposed. For example, I think something like "Always
> see with your own eyes the pnm file before blaming ocrad for the
> results" is out of place in a description.
>

The patch to extend the DESCRIPTION part in main.cc was primarily lifted
from README with a few adjustments:

    GNU Ocrad is an OCR (Optical Character Recognition) program based on a
    feature extraction method. It reads images in pbm (bitmap), pgm
    (greyscale) or ppm (color) formats and produces text in byte (8-bit) or
    UTF-8 formats. The pbm, pgm and ppm formats are collectively known as
    pnm.

    Ocrad includes a layout analyser able to separate the columns or blocks
    of text normally found on printed pages.

    See the file INSTALL for compilation and installation instructions.

    Try "ocrad --help" for usage instructions.

    Caveats.
    For better results the characters should be at least 20 pixels high.
    Merged characters are always a problem. Try to avoid them.
    Very bold or very light (broken) characters are also a problem.
    Always see with your own eyes the pnm file before blaming ocrad for the
    results. Remember the saying, "garbage in, garbage out".

    ...

If the --help provides this options (thus also in manual page; help2man); I
believe the above section can be shrinked to something like:

    After compiling, please see program's --help option or the info pages
    for more information.

Thanks,
Jari