From acfcdb25d63913d7aaacc4163590638aeeab6d4c Mon Sep 17 00:00:00 2001 From: Kern Sibbald Date: Wed, 21 Sep 2016 11:13:28 +0200 Subject: [PATCH] doc: Make changes suggested by Carsten Leonhardt --- docs/README | 24 ++++++++++++++++++++++++ docs/manuals/en/console/web.makefile | 6 +++--- docs/manuals/en/developers/web.makefile | 6 +++--- docs/manuals/en/main/web.makefile | 6 +++--- docs/manuals/en/misc/web.makefile | 6 +++--- docs/manuals/en/problems/web.makefile | 2 +- docs/manuals/en/utility/web.makefile | 2 +- 7 files changed, 38 insertions(+), 14 deletions(-) diff --git a/docs/README b/docs/README index cb0140a9..f204e327 100644 --- a/docs/README +++ b/docs/README @@ -13,10 +13,30 @@ You normally should not edit that file, rather edit version.tex, see the end of this file for more on versions. +For latex2html to find latex/, you may need: + +export TEXINPUTS=`pwd`/latex + You must have at least the following packages loaded: latex2html te_latex tetex +libhtml-parser-perl +libhtml-treebuilder-libxml-perl + +instead of the full tex package, you can load: + +texlive-base +texlive-fonts-recommended +texlive-latex-recommended + +I tend to load pretty much everything with the following apt packages: + +dvipdfmx texlive latex2html + +and for rpms: + +tetex tetex-dvips tetx-fonds tetx-latex Web site: nothing to build, simply copy the files to the Web site, then load the documents in the appropriate @@ -35,6 +55,10 @@ English manual: named xxx which contains the web version of that particular manual. The pdf is in manuals/en/xxx/xxx.pdf + NOTE!!! Please note that running multiple simultaneous makes does + not work. I.e. "make -j3" will fail. If you have a solution, please + send it to me. Thanks. + German manual: cd make german diff --git a/docs/manuals/en/console/web.makefile b/docs/manuals/en/console/web.makefile index 12402a94..610675f9 100644 --- a/docs/manuals/en/console/web.makefile +++ b/docs/manuals/en/console/web.makefile @@ -10,7 +10,7 @@ HTML_TITLE="Console and Operators Guide" HTML_DEPTH=3 HTML_TITLES=6 HTML_VERSION=4.0 -LATEX_TO_HTML=latex2html -split ${HTML_DEPTH} -local_icons -t ${HTML_TITLE} -long_titles ${HTML_TITLES} -toc_stars -contents_in_nav -init_file latex2html-init.pl -no_antialias -no_antialias_text -white -notransparent ${DOC} -html_version ${HTML_VERSION} >tex.out 2>&1 +LATEX_TO_HTML=latex2html -split ${HTML_DEPTH} -local_icons -t ${HTML_TITLE} -long_titles ${HTML_TITLES} -toc_stars -contents_in_nav -init_file ./latex2html-init.pl -no_antialias -no_antialias_text -white -notransparent ${DOC} -html_version ${HTML_VERSION} >tex.out 2>&1 .SUFFIXES: .tex .html .PHONY: @@ -44,9 +44,9 @@ clean: web: pngimages @echo "Making web" - @rm -f next.png prev.png up.png + @rm -f next.png prev.png up.png @rm -f ${DOC}/xp-*.png - @rm -f ${DOC}/next.png ${DOC}/prev.png ${DOC}/up.png + @rm -f ${DOC}/next.png ${DOC}/prev.png ${DOC}/up.png @${LATEX_TO_HTML} @cp -f ${DOC}/${MAINDOC} ${DOC}/index.html @echo "Done making web" diff --git a/docs/manuals/en/developers/web.makefile b/docs/manuals/en/developers/web.makefile index 813c6f86..6d3aecfb 100644 --- a/docs/manuals/en/developers/web.makefile +++ b/docs/manuals/en/developers/web.makefile @@ -7,7 +7,7 @@ HTML_TITLE="Developer's Guide" HTML_DEPTH=3 HTML_TITLES=6 HTML_VERSION=4.0 -LATEX_TO_HTML=latex2html -split ${HTML_DEPTH} -local_icons -t ${HTML_TITLE} -long_titles ${HTML_TITLES} -toc_stars -contents_in_nav -init_file latex2html-init.pl -no_antialias -no_antialias_text -white -notransparent ${DOC} -html_version ${HTML_VERSION} >tex.out 2>&1 +LATEX_TO_HTML=latex2html -split ${HTML_DEPTH} -local_icons -t ${HTML_TITLE} -long_titles ${HTML_TITLES} -toc_stars -contents_in_nav -init_file ./latex2html-init.pl -no_antialias -no_antialias_text -white -notransparent ${DOC} -html_version ${HTML_VERSION} >tex.out 2>&1 .SUFFIXES: .tex .html .PHONY: @@ -42,9 +42,9 @@ clean: web: pngimages @echo "Making web" - @rm -f next.png prev.png up.png + @rm -f next.png prev.png up.png @rm -f ${DOC}/xp-*.png - @rm -f ${DOC}/next.png ${DOC}/prev.png ${DOC}/up.png + @rm -f ${DOC}/next.png ${DOC}/prev.png ${DOC}/up.png @${LATEX_TO_HTML} @cp -f ${DOC}/${MAINDOC} ${DOC}/index.html @echo "Done making web" diff --git a/docs/manuals/en/main/web.makefile b/docs/manuals/en/main/web.makefile index 5a20d521..fff6ccfd 100644 --- a/docs/manuals/en/main/web.makefile +++ b/docs/manuals/en/main/web.makefile @@ -7,7 +7,7 @@ HTML_TITLE="Main Reference" HTML_DEPTH=3 HTML_TITLES=6 HTML_VERSION=4.0 -LATEX_TO_HTML=latex2html -split ${HTML_DEPTH} -local_icons -t ${HTML_TITLE} -long_titles ${HTML_TITLES} -toc_stars -contents_in_nav -init_file latex2html-init.pl -no_antialias -no_antialias_text -white -notransparent ${DOC} -html_version ${HTML_VERSION} >tex.out 2>&1 +LATEX_TO_HTML=latex2html -split ${HTML_DEPTH} -local_icons -t ${HTML_TITLE} -long_titles ${HTML_TITLES} -toc_stars -contents_in_nav -init_file ./latex2html-init.pl -no_antialias -no_antialias_text -white -notransparent ${DOC} -html_version ${HTML_VERSION} >tex.out 2>&1 .SUFFIXES: .tex .html .PHONY: @@ -41,9 +41,9 @@ clean: web: pngimages @echo "Making web" - @rm -f next.png prev.png up.png + @rm -f next.png prev.png up.png @rm -f ${DOC}/xp-*.png - @rm -f ${DOC}/next.png ${DOC}/prev.png ${DOC}/up.png + @rm -f ${DOC}/next.png ${DOC}/prev.png ${DOC}/up.png @${LATEX_TO_HTML} @cp -f ${DOC}/${MAINDOC} ${DOC}/index.html @echo "Done making web" diff --git a/docs/manuals/en/misc/web.makefile b/docs/manuals/en/misc/web.makefile index 3a5a573e..28dd798a 100644 --- a/docs/manuals/en/misc/web.makefile +++ b/docs/manuals/en/misc/web.makefile @@ -7,7 +7,7 @@ HTML_TITLE="Miscellaneous Guide" HTML_DEPTH=3 HTML_TITLES=6 HTML_VERSION=4.0 -LATEX_TO_HTML=latex2html -split ${HTML_DEPTH} -local_icons -t ${HTML_TITLE} -long_titles ${HTML_TITLES} -toc_stars -contents_in_nav -init_file latex2html-init.pl -no_antialias -no_antialias_text -white -notransparent ${DOC} -html_version ${HTML_VERSION} >tex.out 2>&1 +LATEX_TO_HTML=latex2html -split ${HTML_DEPTH} -local_icons -t ${HTML_TITLE} -long_titles ${HTML_TITLES} -toc_stars -contents_in_nav -init_file ./latex2html-init.pl -no_antialias -no_antialias_text -white -notransparent ${DOC} -html_version ${HTML_VERSION} >tex.out 2>&1 .SUFFIXES: .tex .html @@ -43,9 +43,9 @@ clean: web: pngimages @echo "Making web" - @rm -f next.png prev.png up.png + @rm -f next.png prev.png up.png @rm -f ${DOC}/xp-*.png - @rm -f ${DOC}/next.png ${DOC}/prev.png ${DOC}/up.png + @rm -f ${DOC}/next.png ${DOC}/prev.png ${DOC}/up.png @${LATEX_TO_HTML} @cp -f ${DOC}/${MAINDOC} ${DOC}/index.html @echo "Done making web" diff --git a/docs/manuals/en/problems/web.makefile b/docs/manuals/en/problems/web.makefile index f6ea2adf..64ececf2 100644 --- a/docs/manuals/en/problems/web.makefile +++ b/docs/manuals/en/problems/web.makefile @@ -7,7 +7,7 @@ HTML_TITLE="Problem Resolution Guide" HTML_DEPTH=3 HTML_TITLES=6 HTML_VERSION=4.0 -LATEX_TO_HTML=latex2html -split ${HTML_DEPTH} -local_icons -t ${HTML_TITLE} -long_titles ${HTML_TITLES} -toc_stars -contents_in_nav -init_file latex2html-init.pl -no_antialias -no_antialias_text -white -notransparent ${DOC} -html_version ${HTML_VERSION} >tex.out 2>&1 +LATEX_TO_HTML=latex2html -split ${HTML_DEPTH} -local_icons -t ${HTML_TITLE} -long_titles ${HTML_TITLES} -toc_stars -contents_in_nav -init_file ./latex2html-init.pl -no_antialias -no_antialias_text -white -notransparent ${DOC} -html_version ${HTML_VERSION} >tex.out 2>&1 .SUFFIXES: .tex .html .PHONY: diff --git a/docs/manuals/en/utility/web.makefile b/docs/manuals/en/utility/web.makefile index 9007ca33..501b21d4 100644 --- a/docs/manuals/en/utility/web.makefile +++ b/docs/manuals/en/utility/web.makefile @@ -10,7 +10,7 @@ HTML_TITLE="Utility Programs" HTML_DEPTH=3 HTML_TITLES=6 HTML_VERSION=4.0 -LATEX_TO_HTML=latex2html -split ${HTML_DEPTH} -local_icons -t ${HTML_TITLE} -long_titles ${HTML_TITLES} -toc_stars -contents_in_nav -init_file latex2html-init.pl -no_antialias -no_antialias_text -white -notransparent ${DOC} -html_version ${HTML_VERSION} >tex.out 2>&1 +LATEX_TO_HTML=latex2html -split ${HTML_DEPTH} -local_icons -t ${HTML_TITLE} -long_titles ${HTML_TITLES} -toc_stars -contents_in_nav -init_file ./latex2html-init.pl -no_antialias -no_antialias_text -white -notransparent ${DOC} -html_version ${HTML_VERSION} >tex.out 2>&1 .SUFFIXES: .tex .html .PHONY: -- 2.39.5