summaryrefslogtreecommitdiffabout
path: root/doc/gendocs.sh
authorSergey Poznyakoff <gray@gnu.org>2015-03-01 20:47:09 (GMT)
committer Sergey Poznyakoff <gray@gnu.org>2015-03-01 20:47:09 (GMT)
commit3e205088b3b3434ba17bf08b39f2a5fa1fc6a3b0 (patch) (unidiff)
tree47f9257ffb4bd5f62743966918950e9586d90c75 /doc/gendocs.sh
parentad8c9359649fa7123efc46a98c6cec0dd44f34c8 (diff)
downloadgamma-3e205088b3b3434ba17bf08b39f2a5fa1fc6a3b0.tar.gz
gamma-3e205088b3b3434ba17bf08b39f2a5fa1fc6a3b0.tar.bz2
Switch to Texinfo 5.0
* doc/Config: Rewrite. * doc/Makefile.am: Use Makeinfo 5 instead of texi2htm * doc/gendocs_template: Ps is not built * imprimatur: Upgrade.
Diffstat (limited to 'doc/gendocs.sh') (more/less context) (ignore whitespace changes)
-rwxr-xr-xdoc/gendocs.sh490
1 files changed, 490 insertions, 0 deletions
diff --git a/doc/gendocs.sh b/doc/gendocs.sh
new file mode 100755
index 0000000..8ac3a06
--- a/dev/null
+++ b/doc/gendocs.sh
@@ -0,0 +1,490 @@
1#!/bin/sh -e
2# gendocs.sh -- generate a GNU manual in many formats. This script is
3# mentioned in maintain.texi. See the help message below for usage details.
4
5scriptversion=2015-02-28.17
6
7# Copyright 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013
8# Free Software Foundation, Inc.
9#
10# This program is free software: you can redistribute it and/or modify
11# it under the terms of the GNU General Public License as published by
12# the Free Software Foundation; either version 3 of the License, or
13# (at your option) any later version.
14#
15# This program is distributed in the hope that it will be useful,
16# but WITHOUT ANY WARRANTY; without even the implied warranty of
17# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18# GNU General Public License for more details.
19#
20# You should have received a copy of the GNU General Public License
21# along with this program. If not, see <http://www.gnu.org/licenses/>.
22#
23# Original author: Mohit Agarwal.
24# Send bug reports and any other correspondence to bug-texinfo@gnu.org.
25#
26# The latest version of this script, and the companion template, is
27# available from Texinfo CVS:
28# http://savannah.gnu.org/cgi-bin/viewcvs/texinfo/texinfo/util/gendocs.sh
29# http://savannah.gnu.org/cgi-bin/viewcvs/texinfo/texinfo/util/gendocs_template
30#
31# An up-to-date copy is also maintained in Gnulib (gnu.org/software/gnulib).
32
33# TODO:
34# - image importation was only implemented for HTML generated by
35# makeinfo. But it should be simple enough to adjust.
36# - images are not imported in the source tarball. All the needed
37# formats (PDF, PNG, etc.) should be included.
38
39prog=`basename "$0"`
40srcdir=`pwd`
41
42scripturl="http://savannah.gnu.org/cgi-bin/viewcvs/~checkout~/texinfo/texinfo/util/gendocs.sh"
43templateurl="http://savannah.gnu.org/cgi-bin/viewcvs/~checkout~/texinfo/texinfo/util/gendocs_template"
44
45: ${SETLANG="env LANG= LC_MESSAGES= LC_ALL= LANGUAGE="}
46: ${MAKEINFO="makeinfo"}
47: ${TEXI2DVI="texi2dvi -t @finalout"}
48: ${DOCBOOK2HTML="docbook2html"}
49: ${DOCBOOK2PDF="docbook2pdf"}
50: ${DOCBOOK2TXT="docbook2txt"}
51: ${GENDOCS_TEMPLATE_DIR="."}
52: ${PERL='perl'}
53: ${TEXI2HTML="texi2html"}
54unset CDPATH
55unset use_texi2html
56
57version="gendocs.sh $scriptversion
58
59Copyright 2013 Free Software Foundation, Inc.
60There is NO warranty. You may redistribute this software
61under the terms of the GNU General Public License.
62For more information about these matters, see the files named COPYING."
63
64usage="Usage: $prog [OPTION]... PACKAGE MANUAL-TITLE
65
66Generate output in various formats from PACKAGE.texinfo (or .texi or
67.txi) source. See the GNU Maintainers document for a more extensive
68discussion:
69 http://www.gnu.org/prep/maintain_toc.html
70
71Options:
72 --email ADR use ADR as contact in generated web pages; always give this.
73
74 -s SRCFILE read Texinfo from SRCFILE, instead of PACKAGE.{texinfo|texi|txi}
75 -o OUTDIR write files into OUTDIR, instead of manual/.
76 -I DIR append DIR to the Texinfo search path.
77 --common ARG pass ARG in all invocations.
78 --html ARG pass ARG to makeinfo or texi2html for HTML targets.
79 --info ARG pass ARG to makeinfo for Info, instead of --no-split.
80 --no-ascii skip generating the plain text output.
81 --no-copy-images
82 don't try to copy images referenced by img HTML tags,
83 --source ARG include ARG in tar archive of sources.
84 --split HOW make split HTML by node, section, chapter; default node.
85
86 --texi2html use texi2html to make HTML target, with all split versions.
87 --docbook convert through DocBook too (xml, txt, html, pdf).
88
89 --help display this help and exit successfully.
90 --version display version information and exit successfully.
91
92Simple example: $prog --email bug-gnu-emacs@gnu.org emacs \"GNU Emacs Manual\"
93
94Typical sequence:
95 cd PACKAGESOURCE/doc
96 wget \"$scripturl\"
97 wget \"$templateurl\"
98 $prog --email BUGLIST MANUAL \"GNU MANUAL - One-line description\"
99
100Output will be in a new subdirectory \"manual\" (by default;
101use -o OUTDIR to override). Move all the new files into your web CVS
102tree, as explained in the Web Pages node of maintain.texi.
103
104Please use the --email ADDRESS option so your own bug-reporting
105address will be used in the generated HTML pages.
106
107MANUAL-TITLE is included as part of the HTML <title> of the overall
108manual/index.html file. It should include the name of the package being
109documented. manual/index.html is created by substitution from the file
110$GENDOCS_TEMPLATE_DIR/gendocs_template. (Feel free to modify the
111generic template for your own purposes.)
112
113If you have several manuals, you'll need to run this script several
114times with different MANUAL values, specifying a different output
115directory with -o each time. Then write (by hand) an overall index.html
116with links to them all.
117
118If a manual's Texinfo sources are spread across several directories,
119first copy or symlink all Texinfo sources into a single directory.
120(Part of the script's work is to make a tar.gz of the sources.)
121
122As implied above, by default monolithic Info files are generated.
123If you want split Info, or other Info options, use --info to override.
124
125You can set the environment variables MAKEINFO, TEXI2DVI, TEXI2HTML,
126and PERL to control the programs that get executed, and
127GENDOCS_TEMPLATE_DIR to control where the gendocs_template file is
128looked for. With --docbook, the environment variables DOCBOOK2HTML,
129DOCBOOK2PDF, and DOCBOOK2TXT are also consulted.
130
131By default, makeinfo and texi2dvi are run in the default (English)
132locale, since that's the language of most Texinfo manuals. If you
133happen to have a non-English manual and non-English web site, see the
134SETLANG setting in the source.
135
136Email bug reports or enhancement requests to bug-texinfo@gnu.org.
137"
138
139MANUAL_TITLE=
140PACKAGE=
141EMAIL=webmasters@gnu.org # please override with --email
142commonarg= # passed to all makeinfo/texi2html invcations.
143dirargs= # passed to all tools (-I dir).
144dirs= # -I's directories.
145htmlarg=
146infoarg=--no-split
147generate_ascii=true
148outdir=manual
149source_extra=
150split=default
151srcfile=
152no_copy_images=
153
154while test $# -gt 0; do
155 case $1 in
156 -s) shift; srcfile=$1;;
157 -o) shift; outdir=$1;;
158 -I) shift; dirargs="$dirargs -I '$1'"; dirs="$dirs $1";;
159 --common) shift; commonarg=$1;;
160 --docbook) docbook=yes;;
161 --email) shift; EMAIL=$1;;
162 --html) shift; htmlarg=$1;;
163 --info) shift; infoarg=$1;;
164 --no-ascii) generate_ascii=false;;
165 --source) shift; source_extra=$1;;
166 --split) shift; split=$1;;
167 --texi2html) use_texi2html=1;;
168 --no-copy-images) no_copy_images=1;;
169 --help) echo "$usage"; exit 0;;
170 --version) echo "$version"; exit 0;;
171 -*)
172 echo "$0: Unknown option \`$1'." >&2
173 echo "$0: Try \`--help' for more information." >&2
174 exit 1;;
175 *)
176 if test -z "$PACKAGE"; then
177 PACKAGE=$1
178 elif test -z "$MANUAL_TITLE"; then
179 MANUAL_TITLE=$1
180 else
181 echo "$0: extra non-option argument \`$1'." >&2
182 exit 1
183 fi;;
184 esac
185 shift
186done
187
188# makeinfo uses the dirargs, but texi2dvi doesn't.
189commonarg=" $dirargs $commonarg"
190
191# For most of the following, the base name is just $PACKAGE
192base=$PACKAGE
193
194if test -n "$srcfile"; then
195 # but here, we use the basename of $srcfile
196 base=`basename "$srcfile"`
197 case $base in
198 *.txi|*.texi|*.texinfo) base=`echo "$base"|sed 's/\.[texinfo]*$//'`;;
199 esac
200 PACKAGE=$base
201elif test -s "$srcdir/$PACKAGE.texinfo"; then
202 srcfile=$srcdir/$PACKAGE.texinfo
203elif test -s "$srcdir/$PACKAGE.texi"; then
204 srcfile=$srcdir/$PACKAGE.texi
205elif test -s "$srcdir/$PACKAGE.txi"; then
206 srcfile=$srcdir/$PACKAGE.txi
207else
208 echo "$0: cannot find .texinfo or .texi or .txi for $PACKAGE in $srcdir." >&2
209 exit 1
210fi
211
212if test ! -r $GENDOCS_TEMPLATE_DIR/gendocs_template; then
213 echo "$0: cannot read $GENDOCS_TEMPLATE_DIR/gendocs_template." >&2
214 echo "$0: it is available from $templateurl." >&2
215 exit 1
216fi
217
218# Function to return size of $1 in something resembling kilobytes.
219calcsize()
220{
221 size=`ls -ksl $1 | awk '{print $1}'`
222 echo $size
223}
224
225# copy_images OUTDIR HTML-FILE...
226# -------------------------------
227# Copy all the images needed by the HTML-FILEs into OUTDIR. Look
228# for them in the -I directories.
229copy_images()
230{
231 test -n "$no_copy_images" && return
232 local odir
233 odir=$1
234 shift
235 $PERL -n -e "
236BEGIN {
237 \$me = '$prog';
238 \$odir = '$odir';
239 @dirs = qw($dirs);
240}
241" -e '
242/<img src="(.*?)"/g && ++$need{$1};
243
244END {
245 #print "$me: @{[keys %need]}\n"; # for debugging, show images found.
246 FILE: for my $f (keys %need) {
247 for my $d (@dirs) {
248 if (-f "$d/$f") {
249 use File::Basename;
250 my $dest = dirname ("$odir/$f");
251 #
252 use File::Path;
253 -d $dest || mkpath ($dest)
254 || die "$me: cannot mkdir $dest: $!\n";
255 #
256 use File::Copy;
257 copy ("$d/$f", $dest)
258 || die "$me: cannot copy $d/$f to $dest: $!\n";
259 next FILE;
260 }
261 }
262 die "$me: $ARGV: cannot find image $f\n";
263 }
264}
265' -- "$@" || exit 1
266}
267
268case $outdir in
269 /*) abs_outdir=$outdir;;
270 *) abs_outdir=$srcdir/$outdir;;
271esac
272
273echo "Making output for $srcfile"
274echo " in `pwd`"
275mkdir -p "$outdir/"
276
277cmd="$SETLANG $MAKEINFO -o $PACKAGE.info $commonarg $infoarg \"$srcfile\""
278echo "Generating info... ($cmd)"
279rm -f $PACKAGE.info* # get rid of any strays
280eval "$cmd"
281tar czf "$outdir/$PACKAGE.info.tar.gz" $PACKAGE.info*
282ls -l "$outdir/$PACKAGE.info.tar.gz"
283info_tgz_size=`calcsize "$outdir/$PACKAGE.info.tar.gz"`
284# do not mv the info files, there's no point in having them available
285# separately on the web.
286
287cmd="$SETLANG $TEXI2DVI $dirargs \"$srcfile\""
288printf "\nGenerating dvi... ($cmd)\n"
289eval "$cmd"
290# compress/finish dvi:
291gzip -f -9 $PACKAGE.dvi
292dvi_gz_size=`calcsize $PACKAGE.dvi.gz`
293mv $PACKAGE.dvi.gz "$outdir/"
294ls -l "$outdir/$PACKAGE.dvi.gz"
295
296cmd="$SETLANG $TEXI2DVI --pdf $dirargs \"$srcfile\""
297printf "\nGenerating pdf... ($cmd)\n"
298eval "$cmd"
299pdf_size=`calcsize $PACKAGE.pdf`
300mv $PACKAGE.pdf "$outdir/"
301ls -l "$outdir/$PACKAGE.pdf"
302
303if $generate_ascii; then
304 opt="-o $PACKAGE.txt --no-split --no-headers $commonarg"
305 cmd="$SETLANG $MAKEINFO $opt \"$srcfile\""
306 printf "\nGenerating ascii... ($cmd)\n"
307 eval "$cmd"
308 ascii_size=`calcsize $PACKAGE.txt`
309 gzip -f -9 -c $PACKAGE.txt >"$outdir/$PACKAGE.txt.gz"
310 ascii_gz_size=`calcsize "$outdir/$PACKAGE.txt.gz"`
311 mv $PACKAGE.txt "$outdir/"
312 ls -l "$outdir/$PACKAGE.txt" "$outdir/$PACKAGE.txt.gz"
313fi
314
315# Split HTML at level $2 using program $1. Used for texi2html.
316html_split()
317{
318 opt="--split=$2 --node-files $commonarg $htmlarg"
319 cmd="$SETLANG $1 --output $PACKAGE.html $opt \"$srcfile\""
320 printf "\nGenerating html by $2... ($cmd)\n"
321 eval "$cmd"
322 split_html_dir=$PACKAGE.html
323 (
324 cd ${split_html_dir} || exit 1
325 if test ! -e index.html; then
326 if test -f ${PACKAGE}.html; then
327 ln -sf ${PACKAGE}.html index.html
328 else
329 echo >&2 "$0: ${split_html_dir}/${PACKAGE}.html does not exist"
330 fi
331 fi
332 tar -czf "$abs_outdir/${PACKAGE}.html_$2.tar.gz" -- *.html
333 )
334 eval html_$2_tgz_size=`calcsize "$outdir/${PACKAGE}.html_$2.tar.gz"`
335 rm -f "$outdir"/html_$2/*.html
336 mkdir -p "$outdir/html_$2/"
337 mv ${split_html_dir}/*.html "$outdir/html_$2/"
338 rmdir ${split_html_dir}
339}
340
341if test -z "$use_texi2html"; then
342 opt="--no-split --html -o $PACKAGE.html $commonarg $htmlarg"
343 cmd="$SETLANG $MAKEINFO $opt \"$srcfile\""
344 printf "\nGenerating monolithic html... ($cmd)\n"
345 rm -rf $PACKAGE.html # in case a directory is left over
346 eval "$cmd"
347 html_mono_size=`calcsize $PACKAGE.html`
348 gzip -f -9 -c $PACKAGE.html >"$outdir/$PACKAGE.html.gz"
349 html_mono_gz_size=`calcsize "$outdir/$PACKAGE.html.gz"`
350 copy_images "$outdir/" $PACKAGE.html
351 mv $PACKAGE.html "$outdir/"
352 ls -l "$outdir/$PACKAGE.html" "$outdir/$PACKAGE.html.gz"
353
354 version=`makeinfo --version|sed -n '1s/.* \([0-9][0-9]*\)\.[0-9.]*/\1/p'`
355 case $version in
356 [0-9]*) ;;
357 *) version=4;;
358 esac
359 # Before Texinfo 5.0, makeinfo did not accept a --split=HOW option,
360 # it just always split by node. So if we're splitting by node anyway,
361 # leave it out.
362 if test $version -lt 5 -o "x$split" != xdefault; then
363 split_arg=--split=$split
364 opt="--html -o $PACKAGE.html $split_arg $commonarg $htmlarg"
365 cmd="$SETLANG $MAKEINFO $opt \"$srcfile\""
366 printf "\nGenerating html by $split... ($cmd)\n"
367 eval "$cmd"
368 split_html_dir=$PACKAGE.html
369 copy_images $split_html_dir/ $split_html_dir/*.html
370 (
371 cd $split_html_dir || exit 1
372 tar -czf "$abs_outdir/$PACKAGE.html_$split.tar.gz" -- *
373 )
374 eval \
375 html_${split}_tgz_size=`calcsize "$outdir/$PACKAGE.html_$split.tar.gz"`
376 rm -rf "$outdir/html_$split/"
377 mv $split_html_dir "$outdir/html_$split/"
378 du -s "$outdir/html_$split/"
379 ls -l "$outdir/$PACKAGE.html_$split.tar.gz"
380 CONDS="/%%IF *HTML_SECTION%%/,/%%ENDIF *HTML_SECTION%%/d;\
381 /%%IF *HTML_CHAPTER%%/,/%%ENDIF *HTML_CHAPTER%%/d"
382 else
383 html_split "$MAKEINFO --html" node
384 html_split "$MAKEINFO --html" chapter
385 html_split "$MAKEINFO --html" section
386 # should take account of --split here.
387 CONDS="/%%ENDIF.*%%/d;/%%IF *HTML_SECTION%%/d;/%%IF *HTML_CHAPTER%%/d"
388 fi
389else # use texi2html:
390 opt="--output $PACKAGE.html $commonarg $htmlarg"
391 cmd="$SETLANG $TEXI2HTML $opt \"$srcfile\""
392 printf "\nGenerating monolithic html with texi2html... ($cmd)\n"
393 rm -rf $PACKAGE.html # in case a directory is left over
394 eval "$cmd"
395 html_mono_size=`calcsize $PACKAGE.html`
396 gzip -f -9 -c $PACKAGE.html >"$outdir/$PACKAGE.html.gz"
397 html_mono_gz_size=`calcsize "$outdir/$PACKAGE.html.gz"`
398 mv $PACKAGE.html "$outdir/"
399
400 html_split "$TEXI2HTML" node
401 html_split "$TEXI2HTML" chapter
402 html_split "$TEXI2HTML" section
403 CONDS="/%%ENDIF.*%%/d;/%%IF *HTML_SECTION%%/d;/%%IF *HTML_CHAPTER%%/d"
404fi
405
406printf "\nMaking .tar.gz for sources...\n"
407d=`dirname $srcfile`
408(
409 cd "$d"
410 srcfiles=`ls -d *.texinfo *.texi *.txi *.eps $source_extra 2>/dev/null` || true
411 tar czfh "$abs_outdir/$PACKAGE.texi.tar.gz" $srcfiles
412 ls -l "$abs_outdir/$PACKAGE.texi.tar.gz"
413)
414texi_tgz_size=`calcsize "$outdir/$PACKAGE.texi.tar.gz"`
415
416if test -n "$docbook"; then
417 opt="-o - --docbook $commonarg"
418 cmd="$SETLANG $MAKEINFO $opt \"$srcfile\" >${srcdir}/$PACKAGE-db.xml"
419 printf "\nGenerating docbook XML... ($cmd)\n"
420 eval "$cmd"
421 docbook_xml_size=`calcsize $PACKAGE-db.xml`
422 gzip -f -9 -c $PACKAGE-db.xml >"$outdir/$PACKAGE-db.xml.gz"
423 docbook_xml_gz_size=`calcsize "$outdir/$PACKAGE-db.xml.gz"`
424 mv $PACKAGE-db.xml "$outdir/"
425
426 split_html_db_dir=html_node_db
427 opt="$commonarg -o $split_html_db_dir"
428 cmd="$DOCBOOK2HTML $opt \"${outdir}/$PACKAGE-db.xml\""
429 printf "\nGenerating docbook HTML... ($cmd)\n"
430 eval "$cmd"
431 (
432 cd ${split_html_db_dir} || exit 1
433 tar -czf "$abs_outdir/${PACKAGE}.html_node_db.tar.gz" -- *.html
434 )
435 html_node_db_tgz_size=`calcsize "$outdir/${PACKAGE}.html_node_db.tar.gz"`
436 rm -f "$outdir"/html_node_db/*.html
437 mkdir -p "$outdir/html_node_db"
438 mv ${split_html_db_dir}/*.html "$outdir/html_node_db/"
439 rmdir ${split_html_db_dir}
440
441 cmd="$DOCBOOK2TXT \"${outdir}/$PACKAGE-db.xml\""
442 printf "\nGenerating docbook ASCII... ($cmd)\n"
443 eval "$cmd"
444 docbook_ascii_size=`calcsize $PACKAGE-db.txt`
445 mv $PACKAGE-db.txt "$outdir/"
446
447 cmd="$DOCBOOK2PDF \"${outdir}/$PACKAGE-db.xml\""
448 printf "\nGenerating docbook PDF... ($cmd)\n"
449 eval "$cmd"
450 docbook_pdf_size=`calcsize $PACKAGE-db.pdf`
451 mv $PACKAGE-db.pdf "$outdir/"
452fi
453
454printf "\nMaking index file...\n"
455
456curdate=`$SETLANG date '+%B %d, %Y'`
457sed \
458 -e "s!%%TITLE%%!$MANUAL_TITLE!g" \
459 -e "s!%%EMAIL%%!$EMAIL!g" \
460 -e "s!%%PACKAGE%%!$PACKAGE!g" \
461 -e "s!%%DATE%%!$curdate!g" \
462 -e "s!%%HTML_MONO_SIZE%%!$html_mono_size!g" \
463 -e "s!%%HTML_MONO_GZ_SIZE%%!$html_mono_gz_size!g" \
464 -e "s!%%HTML_NODE_TGZ_SIZE%%!$html_node_tgz_size!g" \
465 -e "s!%%HTML_SECTION_TGZ_SIZE%%!$html_section_tgz_size!g" \
466 -e "s!%%HTML_CHAPTER_TGZ_SIZE%%!$html_chapter_tgz_size!g" \
467 -e "s!%%INFO_TGZ_SIZE%%!$info_tgz_size!g" \
468 -e "s!%%DVI_GZ_SIZE%%!$dvi_gz_size!g" \
469 -e "s!%%PDF_SIZE%%!$pdf_size!g" \
470 -e "s!%%ASCII_SIZE%%!$ascii_size!g" \
471 -e "s!%%ASCII_GZ_SIZE%%!$ascii_gz_size!g" \
472 -e "s!%%TEXI_TGZ_SIZE%%!$texi_tgz_size!g" \
473 -e "s!%%DOCBOOK_HTML_NODE_TGZ_SIZE%%!$html_node_db_tgz_size!g" \
474 -e "s!%%DOCBOOK_ASCII_SIZE%%!$docbook_ascii_size!g" \
475 -e "s!%%DOCBOOK_PDF_SIZE%%!$docbook_pdf_size!g" \
476 -e "s!%%DOCBOOK_XML_SIZE%%!$docbook_xml_size!g" \
477 -e "s!%%DOCBOOK_XML_GZ_SIZE%%!$docbook_xml_gz_size!g" \
478 -e "s,%%SCRIPTURL%%,$scripturl,g" \
479 -e "s!%%SCRIPTNAME%%!$prog!g" \
480 -e "$CONDS" \
481$GENDOCS_TEMPLATE_DIR/gendocs_template >"$outdir/index.html"
482
483echo "Done, see $outdir/ subdirectory for new files."
484
485# Local variables:
486# eval: (add-hook 'write-file-hooks 'time-stamp)
487# time-stamp-start: "scriptversion="
488# time-stamp-format: "%:y-%02m-%02d.%02H"
489# time-stamp-end: "$"
490# End:

Return to:

Send suggestions and report system problems to the System administrator.