Re: [Bug-ocrad] ocrad: manual - unclear options -o and -x

[Antonio Diaz Diaz]

Hello Jari et al,

Jari Aalto wrote:
> Here is slightly more verbose description that would be nice
> to get with --help option. I hope something like this would
> be acceptable.

All the information added by your patch is already shown by the --help 
output of the soon to be released ocrad 0.25-pre2, except the text for 
'-o' which is incorrect. Ocrad also makes transformations on images and 
produces image output in pnm format. It is therefore incorrect (and not 
very clear) to describe '-o' as "save the extract from image to output 
<file>" as you propose.

I attach the complete output of --help of ocrad 0.25-pre2. I guess the 
Debian bug can be closed as soon as 0.25-pre2 is packaged.


Best regards,
Antonio.

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.

For best results the characters should be at least 20 pixels high. If
they are smaller, try the --scale option. Scanning the image at 300 dpi
usually produces a character size good enough for ocrad.
Merged, very bold or very light (broken) characters are normally not
recognized correctly. Try to avoid them.

Usage: ./ocrad [options] [files]

Options:
  -h, --help               display this help and exit
  -V, --version            output version information and exit
  -a, --append             append text to output file
  -c, --charset=<name>     try '--charset=help' for a list of names
  -e, --filter=<name>      try '--filter=help' for a list of names
  -f, --force              force overwrite of output file
  -F, --format=<fmt>       output format (byte, utf8)
  -i, --invert             invert image levels (white on black)
  -l, --layout             perform layout analysis
  -o, --output=<file>      place the output into <file>
  -q, --quiet              suppress all messages
  -s, --scale=[-]<n>       scale input image by [1/]<n>
  -t, --transform=<name>   try '--transform=help' for a list of names
  -T, --threshold=<n%>     threshold for binarization (0-100%)
  -u, --cut=<l,t,w,h>      cut input image by given rectangle
  -v, --verbose            be verbose
  -x, --export=<file>      export results in ORF format to <file>

If no files are specified, ocrad reads the image from standard input.
If the -o option is not specified, ocrad sends text to standard output.

Exit status: 0 for a normal exit, 1 for environmental problems (file
not found, invalid flags, I/O errors, etc), 2 to indicate a corrupt or
invalid input file, 3 for an internal consistency error (eg, bug) which
caused ocrad to panic.

Report bugs to address@hidden
Ocrad home page: http://www.gnu.org/software/ocrad/ocrad.html
General help using GNU software: http://www.gnu.org/gethelp