tesseract/doc/Makefile.am

# doc/Makefile.am

if ASCIIDOC

man_MANS = \
  combine_lang_model.1 \
  combine_tessdata.1  \
  dawg2wordlist.1 \
  lstmeval.1 \
  lstmtraining.1 \
  merge_unicharsets.1 \
  set_unicharset_properties.1 \
  tesseract.1 \
  text2image.1 \
  unicharset.5 \
  unicharset_extractor.1 \
  wordlist2dawg.1

if !DISABLED_LEGACY_ENGINE
man_MANS += \
  ambiguous_words.1 \
  classifier_tester.1 \
  cntraining.1 \
  mftraining.1 \
  shapeclustering.1 \
  unicharambigs.5
endif

man_xslt = http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl

EXTRA_DIST = $(man_MANS) Doxyfile

.PHONY: html

html: ${man_MANS:%=%.html}
pdf: ${man_MANS:%=%.pdf}

SUFFIXES = .asc .html .pdf

.asc:
	-asciidoc -b docbook -d manpage -o - $< | \
	xsltproc --nonet $(man_xslt) -

.asc.html:
	asciidoc -b html5 -o $@ $<

.asc.pdf:
	asciidoc -b docbook -d manpage -o $*.dbk $<
	docbook2pdf $*.dbk

MAINTAINERCLEANFILES = $(man_MANS) Doxyfile

endif
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 20:44:14 +08:00			`# doc/Makefile.am`
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 2794410c9b5095f1b6607f68584b1fe5b7a32f7c. Signed-off-by: Stefan Weil <sw@weilnetz.de> 2017-05-02 13:35:51 +08:00
Don't try to build manpages if asciidoc is missing Commit f9157fd91db9140adacc4d7cd9af5677e4f0163e 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-10 01:06:59 +08:00			`if ASCIIDOC`

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-13 02:08:16 +08:00			`man_MANS = \`
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-05 04:26:35 +08:00			`combine_lang_model.1 \`
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-13 02:08:16 +08:00			`combine_tessdata.1 \`
			`dawg2wordlist.1 \`
			`lstmeval.1 \`
			`lstmtraining.1 \`
			`merge_unicharsets.1 \`
			`set_unicharset_properties.1 \`
			`tesseract.1 \`
			`text2image.1 \`
Improve disabled legacy engine build 2020-10-10 06:33:27 +08:00			`unicharset.5 \`
Add an option to compile tesseract without the code of the legacy OCR engine 2018-07-03 23:49:42 +08:00			`unicharset_extractor.1 \`
Fix whitespace issues * Remove whitespace (blanks, tabs, cr) at line endings Signed-off-by: Stefan Weil <sw@weilnetz.de> 2017-09-17 00:47:04 +08:00			`wordlist2dawg.1`
Add an option to compile tesseract without the code of the legacy OCR engine 2018-07-03 23:49:42 +08:00
			`if !DISABLED_LEGACY_ENGINE`
			`man_MANS += \`
			`ambiguous_words.1 \`
			`classifier_tester.1 \`
			`cntraining.1 \`
			`mftraining.1 \`
			`shapeclustering.1 \`
Improve disabled legacy engine build 2020-10-10 06:33:27 +08:00			`unicharambigs.5`
Add an option to compile tesseract without the code of the legacy OCR engine 2018-07-03 23:49:42 +08:00			`endif`

Fix build rule for manpages This is similar to commit 2106cba0a98a90451df835f3ab7b2aaf54826442 which fixed doc/generate_manpages.sh. Signed-off-by: Stefan Weil <sw@weilnetz.de> 2019-02-02 02:47:46 +08:00			`man_xslt = http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl`

Add an option to compile tesseract without the code of the legacy OCR engine 2018-07-03 23:49:42 +08:00			`EXTRA_DIST = $(man_MANS) Doxyfile`
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 17:27:17 +08:00
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-05 04:26:35 +08:00			`.PHONY: html`

Avoid gmake-specific pattern substitution in Makefile.am. Resolves #2226 2019-02-09 02:16:56 +08:00			`html: ${man_MANS:%=%.html}`
Add rule for PDF documentation Signed-off-by: Stefan Weil <sw@weilnetz.de> 2019-03-16 03:56:53 +08:00			`pdf: ${man_MANS:%=%.pdf}`
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-05 04:26:35 +08:00
Add rule for PDF documentation Signed-off-by: Stefan Weil <sw@weilnetz.de> 2019-03-16 03:56:53 +08:00			`SUFFIXES = .asc .html .pdf`
Avoid gmake-specific pattern substitution in Makefile.am. Resolves #2226 2019-02-09 02:16:56 +08:00
			`.asc:`
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:13:45 +08:00			`-asciidoc -b docbook -d manpage -o - $< \| \`
Fix build rule for manpages This is similar to commit 2106cba0a98a90451df835f3ab7b2aaf54826442 which fixed doc/generate_manpages.sh. Signed-off-by: Stefan Weil <sw@weilnetz.de> 2019-02-02 02:47:46 +08:00			`xsltproc --nonet $(man_xslt) -`
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 17:27:17 +08:00
Avoid gmake-specific pattern substitution in Makefile.am. Resolves #2226 2019-02-09 02:16:56 +08:00			`.asc.html:`
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-05 04:26:35 +08:00			`asciidoc -b html5 -o $@ $<`

Add rule for PDF documentation Signed-off-by: Stefan Weil <sw@weilnetz.de> 2019-03-16 03:56:53 +08:00			`.asc.pdf:`
			`asciidoc -b docbook -d manpage -o $*.dbk $<`
			`docbook2pdf $*.dbk`

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 17:27:17 +08:00			`MAINTAINERCLEANFILES = $(man_MANS) Doxyfile`
Don't try to build manpages if asciidoc is missing Commit f9157fd91db9140adacc4d7cd9af5677e4f0163e 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-10 01:06:59 +08:00
			`endif`