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.
5 scriptversion=2013-03-08.15
7 # Copyright 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013
8 # Free Software Foundation, Inc.
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.
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.
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/>.
23 # Original author: Mohit Agarwal.
24 # Send bug reports and any other correspondence to bug-texinfo@gnu.org.
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
31 # An up-to-date copy is also maintained in Gnulib (gnu.org/software/gnulib).
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.
42 scripturl="http://savannah.gnu.org/cgi-bin/viewcvs/~checkout~/texinfo/texinfo/util/gendocs.sh"
43 templateurl="http://savannah.gnu.org/cgi-bin/viewcvs/~checkout~/texinfo/texinfo/util/gendocs_template"
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="."}
53 : ${TEXI2HTML="texi2html"}
57 version="gendocs.sh $scriptversion
59 Copyright 2013 Free Software Foundation, Inc.
60 There is NO warranty. You may redistribute this software
61 under the terms of the GNU General Public License.
62 For more information about these matters, see the files named COPYING."
64 usage="Usage: $prog [OPTION]... PACKAGE MANUAL-TITLE
66 Generate output in various formats from PACKAGE.texinfo (or .texi or
67 .txi) source. See the GNU Maintainers document for a more extensive
69 http://www.gnu.org/prep/maintain_toc.html
72 --email ADR use ADR as contact in generated web pages; always give this.
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 --source ARG include ARG in tar archive of sources.
82 --split HOW make split HTML by node, section, chapter; default node.
84 --texi2html use texi2html to make HTML target, with all split versions.
85 --docbook convert through DocBook too (xml, txt, html, pdf).
87 --help display this help and exit successfully.
88 --version display version information and exit successfully.
90 Simple example: $prog --email bug-gnu-emacs@gnu.org emacs \"GNU Emacs Manual\"
96 $prog --email BUGLIST MANUAL \"GNU MANUAL - One-line description\"
98 Output will be in a new subdirectory \"manual\" (by default;
99 use -o OUTDIR to override). Move all the new files into your web CVS
100 tree, as explained in the Web Pages node of maintain.texi.
102 Please use the --email ADDRESS option so your own bug-reporting
103 address will be used in the generated HTML pages.
105 MANUAL-TITLE is included as part of the HTML <title> of the overall
106 manual/index.html file. It should include the name of the package being
107 documented. manual/index.html is created by substitution from the file
108 $GENDOCS_TEMPLATE_DIR/gendocs_template. (Feel free to modify the
109 generic template for your own purposes.)
111 If you have several manuals, you'll need to run this script several
112 times with different MANUAL values, specifying a different output
113 directory with -o each time. Then write (by hand) an overall index.html
114 with links to them all.
116 If a manual's Texinfo sources are spread across several directories,
117 first copy or symlink all Texinfo sources into a single directory.
118 (Part of the script's work is to make a tar.gz of the sources.)
120 As implied above, by default monolithic Info files are generated.
121 If you want split Info, or other Info options, use --info to override.
123 You can set the environment variables MAKEINFO, TEXI2DVI, TEXI2HTML,
124 and PERL to control the programs that get executed, and
125 GENDOCS_TEMPLATE_DIR to control where the gendocs_template file is
126 looked for. With --docbook, the environment variables DOCBOOK2HTML,
127 DOCBOOK2PDF, and DOCBOOK2TXT are also consulted.
129 By default, makeinfo and texi2dvi are run in the default (English)
130 locale, since that's the language of most Texinfo manuals. If you
131 happen to have a non-English manual and non-English web site, see the
132 SETLANG setting in the source.
134 Email bug reports or enhancement requests to bug-texinfo@gnu.org.
139 EMAIL=webmasters@gnu.org # please override with --email
140 commonarg= # passed to all makeinfo/texi2html invcations.
141 dirargs= # passed to all tools (-I dir).
142 dirs= # -I's directories.
151 while test $# -gt 0; do
153 -s) shift; srcfile=$1;;
154 -o) shift; outdir=$1;;
155 -I) shift; dirargs="$dirargs -I '$1'"; dirs="$dirs $1";;
156 --common) shift; commonarg=$1;;
157 --docbook) docbook=yes;;
158 --email) shift; EMAIL=$1;;
159 --html) shift; htmlarg=$1;;
160 --info) shift; infoarg=$1;;
161 --no-ascii) generate_ascii=false;;
162 --source) shift; source_extra=$1;;
163 --split) shift; split=$1;;
164 --texi2html) use_texi2html=1;;
166 --help) echo "$usage"; exit 0;;
167 --version) echo "$version"; exit 0;;
169 echo "$0: Unknown option \`$1'." >&2
170 echo "$0: Try \`--help' for more information." >&2
173 if test -z "$PACKAGE"; then
175 elif test -z "$MANUAL_TITLE"; then
178 echo "$0: extra non-option argument \`$1'." >&2
185 # makeinfo uses the dirargs, but texi2dvi doesn't.
186 commonarg=" $dirargs $commonarg"
188 # For most of the following, the base name is just $PACKAGE
191 if test -n "$srcfile"; then
192 # but here, we use the basename of $srcfile
193 base=`basename "$srcfile"`
195 *.txi|*.texi|*.texinfo) base=`echo "$base"|sed 's/\.[texinfo]*$//'`;;
198 elif test -s "$srcdir/$PACKAGE.texinfo"; then
199 srcfile=$srcdir/$PACKAGE.texinfo
200 elif test -s "$srcdir/$PACKAGE.texi"; then
201 srcfile=$srcdir/$PACKAGE.texi
202 elif test -s "$srcdir/$PACKAGE.txi"; then
203 srcfile=$srcdir/$PACKAGE.txi
205 echo "$0: cannot find .texinfo or .texi or .txi for $PACKAGE in $srcdir." >&2
209 if test ! -r $GENDOCS_TEMPLATE_DIR/gendocs_template; then
210 echo "$0: cannot read $GENDOCS_TEMPLATE_DIR/gendocs_template." >&2
211 echo "$0: it is available from $templateurl." >&2
215 # Function to return size of $1 in something resembling kilobytes.
218 size=`ls -ksl $1 | awk '{print $1}'`
222 # copy_images OUTDIR HTML-FILE...
223 # -------------------------------
224 # Copy all the images needed by the HTML-FILEs into OUTDIR. Look
225 # for them in the -I directories.
238 /<img src="(.*?)"/g && ++$need{$1};
241 #print "$me: @{[keys %need]}\n"; # for debugging, show images found.
242 FILE: for my $f (keys %need) {
246 my $dest = dirname ("$odir/$f");
249 -d $dest || mkpath ($dest)
250 || die "$me: cannot mkdir $dest: $!\n";
253 copy ("$d/$f", $dest)
254 || die "$me: cannot copy $d/$f to $dest: $!\n";
258 die "$me: $ARGV: cannot find image $f\n";
265 /*) abs_outdir=$outdir;;
266 *) abs_outdir=$srcdir/$outdir;;
269 echo "Making output for $srcfile"
273 cmd="$SETLANG $MAKEINFO -o $PACKAGE.info $commonarg $infoarg \"$srcfile\""
274 echo "Generating info... ($cmd)"
276 tar czf "$outdir/$PACKAGE.info.tar.gz" $PACKAGE.info*
277 ls -l "$outdir/$PACKAGE.info.tar.gz"
278 info_tgz_size=`calcsize "$outdir/$PACKAGE.info.tar.gz"`
279 # do not mv the info files, there's no point in having them available
280 # separately on the web.
282 cmd="$SETLANG $TEXI2DVI $dirargs \"$srcfile\""
283 printf "\nGenerating dvi... ($cmd)\n"
285 # compress/finish dvi:
286 gzip -f -9 $PACKAGE.dvi
287 dvi_gz_size=`calcsize $PACKAGE.dvi.gz`
288 mv $PACKAGE.dvi.gz "$outdir/"
289 ls -l "$outdir/$PACKAGE.dvi.gz"
291 cmd="$SETLANG $TEXI2DVI --pdf $dirargs \"$srcfile\""
292 printf "\nGenerating pdf... ($cmd)\n"
294 pdf_size=`calcsize $PACKAGE.pdf`
295 mv $PACKAGE.pdf "$outdir/"
296 ls -l "$outdir/$PACKAGE.pdf"
298 if $generate_ascii; then
299 opt="-o $PACKAGE.txt --no-split --no-headers $commonarg"
300 cmd="$SETLANG $MAKEINFO $opt \"$srcfile\""
301 printf "\nGenerating ascii... ($cmd)\n"
303 ascii_size=`calcsize $PACKAGE.txt`
304 gzip -f -9 -c $PACKAGE.txt >"$outdir/$PACKAGE.txt.gz"
305 ascii_gz_size=`calcsize "$outdir/$PACKAGE.txt.gz"`
306 mv $PACKAGE.txt "$outdir/"
307 ls -l "$outdir/$PACKAGE.txt" "$outdir/$PACKAGE.txt.gz"
310 # Split HTML at level $1. Used for texi2html.
313 opt="--split=$1 --node-files $commonarg $htmlarg"
314 cmd="$SETLANG $TEXI2HTML --output $PACKAGE.html $opt \"$srcfile\""
315 printf "\nGenerating html by $1... ($cmd)\n"
317 split_html_dir=$PACKAGE.html
319 cd ${split_html_dir} || exit 1
320 ln -sf ${PACKAGE}.html index.html
321 tar -czf "$abs_outdir/${PACKAGE}.html_$1.tar.gz" -- *.html
323 eval html_$1_tgz_size=`calcsize "$outdir/${PACKAGE}.html_$1.tar.gz"`
324 rm -f "$outdir"/html_$1/*.html
325 mkdir -p "$outdir/html_$1/"
326 mv ${split_html_dir}/*.html "$outdir/html_$1/"
327 rmdir ${split_html_dir}
330 if test -z "$use_texi2html"; then
331 opt="--no-split --html -o $PACKAGE.html $commonarg $htmlarg"
332 cmd="$SETLANG $MAKEINFO $opt \"$srcfile\""
333 printf "\nGenerating monolithic html... ($cmd)\n"
334 rm -rf $PACKAGE.html # in case a directory is left over
336 html_mono_size=`calcsize $PACKAGE.html`
337 gzip -f -9 -c $PACKAGE.html >"$outdir/$PACKAGE.html.gz"
338 html_mono_gz_size=`calcsize "$outdir/$PACKAGE.html.gz"`
339 copy_images "$outdir/" $PACKAGE.html
340 mv $PACKAGE.html "$outdir/"
341 ls -l "$outdir/$PACKAGE.html" "$outdir/$PACKAGE.html.gz"
343 # Before Texinfo 5.0, makeinfo did not accept a --split=HOW option,
344 # it just always split by node. So if we're splitting by node anyway,
346 if test "x$split" = xnode; then
349 split_arg=--split=$split
352 opt="--html -o $PACKAGE.html $split_arg $commonarg $htmlarg"
353 cmd="$SETLANG $MAKEINFO $opt \"$srcfile\""
354 printf "\nGenerating html by $split... ($cmd)\n"
356 split_html_dir=$PACKAGE.html
357 copy_images $split_html_dir/ $split_html_dir/*.html
359 cd $split_html_dir || exit 1
360 tar -czf "$abs_outdir/$PACKAGE.html_$split.tar.gz" -- *
363 html_${split}_tgz_size=`calcsize "$outdir/$PACKAGE.html_$split.tar.gz"`
364 rm -rf "$outdir/html_$split/"
365 mv $split_html_dir "$outdir/html_$split/"
366 du -s "$outdir/html_$split/"
367 ls -l "$outdir/$PACKAGE.html_$split.tar.gz"
369 else # use texi2html:
370 opt="--output $PACKAGE.html $commonarg $htmlarg"
371 cmd="$SETLANG $TEXI2HTML $opt \"$srcfile\""
372 printf "\nGenerating monolithic html with texi2html... ($cmd)\n"
373 rm -rf $PACKAGE.html # in case a directory is left over
375 html_mono_size=`calcsize $PACKAGE.html`
376 gzip -f -9 -c $PACKAGE.html >"$outdir/$PACKAGE.html.gz"
377 html_mono_gz_size=`calcsize "$outdir/$PACKAGE.html.gz"`
378 mv $PACKAGE.html "$outdir/"
385 printf "\nMaking .tar.gz for sources...\n"
389 srcfiles=`ls -d *.texinfo *.texi *.txi *.eps $source_extra 2>/dev/null` || true
390 tar czfh "$abs_outdir/$PACKAGE.texi.tar.gz" $srcfiles
391 ls -l "$abs_outdir/$PACKAGE.texi.tar.gz"
393 texi_tgz_size=`calcsize "$outdir/$PACKAGE.texi.tar.gz"`
395 if test -n "$docbook"; then
396 opt="-o - --docbook $commonarg"
397 cmd="$SETLANG $MAKEINFO $opt \"$srcfile\" >${srcdir}/$PACKAGE-db.xml"
398 printf "\nGenerating docbook XML... ($cmd)\n"
400 docbook_xml_size=`calcsize $PACKAGE-db.xml`
401 gzip -f -9 -c $PACKAGE-db.xml >"$outdir/$PACKAGE-db.xml.gz"
402 docbook_xml_gz_size=`calcsize "$outdir/$PACKAGE-db.xml.gz"`
403 mv $PACKAGE-db.xml "$outdir/"
405 split_html_db_dir=html_node_db
406 opt="$commonarg -o $split_html_db_dir"
407 cmd="$DOCBOOK2HTML $opt \"${outdir}/$PACKAGE-db.xml\""
408 printf "\nGenerating docbook HTML... ($cmd)\n"
411 cd ${split_html_db_dir} || exit 1
412 tar -czf "$abs_outdir/${PACKAGE}.html_node_db.tar.gz" -- *.html
414 html_node_db_tgz_size=`calcsize "$outdir/${PACKAGE}.html_node_db.tar.gz"`
415 rm -f "$outdir"/html_node_db/*.html
416 mkdir -p "$outdir/html_node_db"
417 mv ${split_html_db_dir}/*.html "$outdir/html_node_db/"
418 rmdir ${split_html_db_dir}
420 cmd="$DOCBOOK2TXT \"${outdir}/$PACKAGE-db.xml\""
421 printf "\nGenerating docbook ASCII... ($cmd)\n"
423 docbook_ascii_size=`calcsize $PACKAGE-db.txt`
424 mv $PACKAGE-db.txt "$outdir/"
426 cmd="$DOCBOOK2PDF \"${outdir}/$PACKAGE-db.xml\""
427 printf "\nGenerating docbook PDF... ($cmd)\n"
429 docbook_pdf_size=`calcsize $PACKAGE-db.pdf`
430 mv $PACKAGE-db.pdf "$outdir/"
433 printf "\nMaking index file...\n"
434 if test -z "$use_texi2html"; then
435 CONDS="/%%IF *HTML_SECTION%%/,/%%ENDIF *HTML_SECTION%%/d;\
436 /%%IF *HTML_CHAPTER%%/,/%%ENDIF *HTML_CHAPTER%%/d"
438 # should take account of --split here.
439 CONDS="/%%ENDIF.*%%/d;/%%IF *HTML_SECTION%%/d;/%%IF *HTML_CHAPTER%%/d"
442 curdate=`$SETLANG date '+%B %d, %Y'`
444 -e "s!%%TITLE%%!$MANUAL_TITLE!g" \
445 -e "s!%%EMAIL%%!$EMAIL!g" \
446 -e "s!%%PACKAGE%%!$PACKAGE!g" \
447 -e "s!%%DATE%%!$curdate!g" \
448 -e "s!%%HTML_MONO_SIZE%%!$html_mono_size!g" \
449 -e "s!%%HTML_MONO_GZ_SIZE%%!$html_mono_gz_size!g" \
450 -e "s!%%HTML_NODE_TGZ_SIZE%%!$html_node_tgz_size!g" \
451 -e "s!%%HTML_SECTION_TGZ_SIZE%%!$html_section_tgz_size!g" \
452 -e "s!%%HTML_CHAPTER_TGZ_SIZE%%!$html_chapter_tgz_size!g" \
453 -e "s!%%INFO_TGZ_SIZE%%!$info_tgz_size!g" \
454 -e "s!%%DVI_GZ_SIZE%%!$dvi_gz_size!g" \
455 -e "s!%%PDF_SIZE%%!$pdf_size!g" \
456 -e "s!%%ASCII_SIZE%%!$ascii_size!g" \
457 -e "s!%%ASCII_GZ_SIZE%%!$ascii_gz_size!g" \
458 -e "s!%%TEXI_TGZ_SIZE%%!$texi_tgz_size!g" \
459 -e "s!%%DOCBOOK_HTML_NODE_TGZ_SIZE%%!$html_node_db_tgz_size!g" \
460 -e "s!%%DOCBOOK_ASCII_SIZE%%!$docbook_ascii_size!g" \
461 -e "s!%%DOCBOOK_PDF_SIZE%%!$docbook_pdf_size!g" \
462 -e "s!%%DOCBOOK_XML_SIZE%%!$docbook_xml_size!g" \
463 -e "s!%%DOCBOOK_XML_GZ_SIZE%%!$docbook_xml_gz_size!g" \
464 -e "s,%%SCRIPTURL%%,$scripturl,g" \
465 -e "s!%%SCRIPTNAME%%!$prog!g" \
467 $GENDOCS_TEMPLATE_DIR/gendocs_template >"$outdir/index.html"
469 echo "Done, see $outdir/ subdirectory for new files."
472 # eval: (add-hook 'write-file-hooks 'time-stamp)
473 # time-stamp-start: "scriptversion="
474 # time-stamp-format: "%:y-%02m-%02d.%02H"
475 # time-stamp-end: "$"