Commit Graph

95 Commits

Author SHA1 Message Date
Shree
00abf57d02 Update documentation for unicharset_extractor 2019-05-31 08:20:19 +00:00
Stefan Weil
5f76a8495b Sort options alphabetically in tesseract man page
Signed-off-by: Stefan Weil <sw@weilnetz.de>
2019-03-16 10:19:00 +01:00
Stefan Weil
b55984fb88 Add description for new --dpi option in tesseract man page
Signed-off-by: Stefan Weil <sw@weilnetz.de>
2019-03-16 09:33:41 +01:00
Stefan Weil
26b4457b86 Add description for new --psm values in tesseract man page
Signed-off-by: Stefan Weil <sw@weilnetz.de>
2019-03-16 09:24:40 +01:00
Stefan Weil
a6981ae548 Improve man page for tesseract
Format it like the example
https://github.com/asciidoc/asciidoc/blob/master/doc/asciidoc.1.txt.

Replace tab characters by blanks.

Add also a chapter on environment variables.

Signed-off-by: Stefan Weil <sw@weilnetz.de>
2019-03-16 08:54:28 +01:00
Stefan Weil
6b3c81c909 Add rule for PDF documentation
Signed-off-by: Stefan Weil <sw@weilnetz.de>
2019-03-15 21:53:34 +01:00
Stefan Weil
e14797563b Update documentation for supported languages
kur_ara.traineddata was renamed to kmr.traineddata.

Signed-off-by: Stefan Weil <sw@weilnetz.de>
2019-03-15 11:07:54 +01:00
Stefan Weil
85d7feebf7 Add missing documentation for --help-extra
Signed-off-by: Stefan Weil <sw@weilnetz.de>
2019-03-15 09:36:10 +01:00
Chris Mayo
a9d3efb6e3 Document that configfile can be a file path
Useful for custom config or when pointing tessdata to alternate
traineddata.
2019-03-05 19:47:54 +00:00
russiaayya
c6cc54aa76
Change option -l to --lang 2019-02-27 12:55:34 -05:00
zdenop
48be357688
Merge pull request #2220 from cjmayo/man_config
Man page description of configs and parameters
2019-02-16 13:53:47 +01:00
Stefan Weil
6e37389fcd doc: Don't fail if manpages fail to build
Even with installed asciidoc and xsltproc the build will fail if
xsltproc cannot find the required stylesheet
http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl.

Ignore such errors until there is a better check in configure.

Signed-off-by: Stefan Weil <sw@weilnetz.de>
2019-02-15 22:19:52 +01:00
Felix Yan
d35f119c68
Fix a typo in Doxyfile 2019-02-15 04:07:35 +08:00
Raphael Graf
86b14c32a9 Avoid gmake-specific pattern substitution in Makefile.am.
Resolves #2226
2019-02-08 19:39:45 +01:00
Chris Mayo
c3b18cfd27 Improve description of configs and parameters in tesseract(1)
Try to make the relationship between configs, -c and --print-parameters
clearer by always using parameter and not variable.

Include the filenames created by each config.
2019-02-06 20:03:51 +00:00
Chris Mayo
da279e4216 Tidy tesseract(1)
A typo and missing full stops.
2019-02-05 19:58:40 +00:00
Stefan Weil
39ed30ad83 Fix build rule for manpages
This is similar to commit 2106cba0a9
which fixed doc/generate_manpages.sh.

Signed-off-by: Stefan Weil <sw@weilnetz.de>
2019-02-01 19:47:46 +01:00
Chris Mayo
2106cba0a9 Use universal location for docbook.xsl
xsltproc will use the system catalog to find the local path.
Pass --nonet option to ensure the Internet is not used.
2019-02-01 17:55:59 +01:00
Stefan Weil
a0e6586e63 Fix documentation for page segmentation mode 2
It never worked, so add a comment that the implementation is missing.
Add also a to-do comment.

Signed-off-by: Stefan Weil <sw@weilnetz.de>
2019-01-09 13:51:44 +01:00
Jake Sebright
e398601bf5 Include ALTO in list of supported output formats 2018-12-15 10:41:24 +01:00
zdenop
aefcbac840 add info about unicharambigs file v2; fixes #165 2018-10-21 20:18:48 +02:00
Zdenko Podobný
b0b5bd62f3 build doc only for tesseract engine 2018-10-12 19:01:17 +02:00
Stefan Weil
3315931859 Merge and enhance documentation on language and script models
Add also links to the user forum and to the Wiki and update the
history text.

Signed-off-by: Stefan Weil <sw@weilnetz.de>
2018-10-05 16:55:21 +02:00
Stefan Weil
383dcf70b5 Document some more config options for tesseract
Clarify also the name(s) of the generated OCR result file(s):
Tesseract does not create a file named outbase.txt by default.

Fix also a sentence in the language section.

Signed-off-by: Stefan Weil <sw@weilnetz.de>
2018-10-05 16:03:51 +02:00
Stefan Weil
b70a456788 Add Makefile rule to build HTML manpages
They can be built optionally by `make html` (only for automake builds).

Signed-off-by: Stefan Weil <sw@weilnetz.de>
2018-10-04 22:36:03 +02:00
Stefan Weil
3e9b0acc5c Update tesseract man page
- move Tesseract 4 release note to other release notes
- format command line options in text
- add link to release notes (wiki)
- add link to contributors (GitHub)

Signed-off-by: Stefan Weil <sw@weilnetz.de>
2018-10-04 22:10:22 +02:00
Shree Devi Kumar
0c39d3446b Update tesseract man page about both OCR engines in tesseract 4 2018-10-04 04:01:26 +00:00
Stefan Weil
a387e1f71e Add documentation for lists of images to the tesseract man page
Signed-off-by: Stefan Weil <sw@weilnetz.de>
2018-09-19 09:32:02 +02:00
Stefan Weil
6a28cce96b Fix whitespace issues
* Remove whitespace (blanks, tabs, cr) at line endings

Signed-off-by: Stefan Weil <sw@weilnetz.de>
2018-08-01 13:19:52 +02:00
Amit D
62c7b796da
Merge branch 'master' into disable-legacy 2018-07-04 11:14:33 +03:00
amitdo
aa9f4b4861 Add an option to compile tesseract without the code of the legacy OCR engine 2018-07-03 18:49:42 +03:00
Charles Li
84f315db6c
Update tesseract.1.asc
Minor typo in options section for --user-patterns
2018-07-02 13:27:45 -07:00
Stefan Weil
509a6f0ce0 Fix some typos (most found by codespell)
Signed-off-by: Stefan Weil <sw@weilnetz.de>
2018-05-27 18:49:43 +02:00
Stefan Weil
ef31eaa7d7 Don't try to build manpages if asciidoc is missing
Commit f9157fd91d changed the rules for
the documentation, so make always tried to build it and failed if
asciidoc was missing since that commit.

Now configure tests whether asciidoc is available and builds the
documentation conditionally. It also reports that to the user.

Signed-off-by: Stefan Weil <sw@weilnetz.de>
2018-04-09 19:07:54 +02:00
Stefan Weil
f9157fd91d configure: Don't use AM_MAINTAINER_MODE by default
That macro disables automated updates when configure.ac or a Makefile.am
changes. Normally those updates are wanted because users typically
forget running ./autogen.sh.

See also the GNU documentation why AM_MAINTAINER_MODE should not be used:
https://www.gnu.org/software/automake/manual/html_node/maintainer_002dmode.html

Signed-off-by: Stefan Weil <sw@weilnetz.de>
2018-04-08 14:44:14 +02:00
Stefan Weil
365611f24a doc: Fix asciidoc escapes for C++ (#1427)
Signed-off-by: Stefan Weil <sw@weilnetz.de>
2018-03-25 21:02:33 +02:00
Stefan Weil
15638a5ce4 doc: Add missing language to list (#1368)
tessdata_fast includes bre.traineddata.

Signed-off-by: Stefan Weil <sw@weilnetz.de>
2018-03-13 18:58:53 +01:00
Stefan Weil
bdf6629722 Update version in README and manpages (#1381)
Signed-off-by: Stefan Weil <sw@weilnetz.de>
2018-03-12 21:39:29 +01:00
Shreeshrii
df58108972 Manpages (#1378)
* Add missing man pages

* Update lstmeval.1.asc

* Update combine_lang_model.1.asc

* Update lstmtraining.1.asc

* Update merge_unicharsets.1.asc

* Update set_unicharset_properties.1.asc

* Update text2image.1.asc

* Update text2image.1.asc

* Update combine_lang_model.1.asc
2018-03-12 19:08:15 +01:00
Stefan Weil
08ef815fe5 doc: Remove unsupported traineddata from list (#1367)
The languages dan_frak, deu_frak and slk_frak were contributions.
They are not part of tessdata_fast.

Signed-off-by: Stefan Weil <sw@weilnetz.de>
2018-03-10 08:41:58 +01:00
Shreeshrii
40f43111e0 Add list of scripts to manpage for tesseract (#1347) 2018-02-24 09:37:25 +01:00
Shreeshrii
bb89dc3594 Add info regarding LSTM components and options (#1346) 2018-02-23 21:59:50 +01:00
zdenop
44588a3c7c
add commas to language list 2018-02-23 11:27:55 +01:00
Zdenko Podobný
035325dfd0 Update language list based on tessdata_fast; fix #1343 2018-02-23 11:19:18 +01:00
Stefan Weil
9f888f044a Fix typo in documentation (#1330)
Signed-off-by: Stefan Weil <sw@weilnetz.de>
2018-02-21 08:39:47 +01:00
Stefan Weil
2f48d69bcd doc: Fix use of MAINTAINER_MODE
It must also include man_MANS – otherwise make tries to build the
man pages also in non maintainer mode without having a rule for that.

This fixes commit 2794410c9b.

Signed-off-by: Stefan Weil <sw@weilnetz.de>
2017-05-02 07:37:18 +02:00
Stefan Weil
2794410c9b doc: Remove generated files and add rules to build manpages
Those files can be built by doc/generate_manpages.sh.

The manpages are needed for the installation,
so add Makefile rules for them.

Git must ignore the generated manpages.

Signed-off-by: Stefan Weil <sw@weilnetz.de>
2017-04-30 11:27:17 +02:00
zdenop
13b7900ebf Merge pull request #778 from cjmayo/singleopts
tidy tesseract(1) adding missing options
2017-04-28 18:58:40 +02:00
Stefan Weil
151a76ef26 doc: Remove unsupported font name
Fix this warning from doxygen:

    warning: doxygen no longer ships with the FreeSans font.
    You may want to clear or change DOT_FONTNAME.
    Otherwise you run the risk that the wrong font is being used for dot generated graphs.

Signed-off-by: Stefan Weil <sw@weilnetz.de>
2017-04-28 16:13:41 +02:00
Chris Mayo
b231aee212 tidy tesseract(1) adding missing options
Together with:
- fix "C\++"
- align executable --print-parameters message
2017-03-23 20:02:50 +00:00