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=2013-10-10.09 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 --source ARG include ARG in tar archive of sources. 82 --split HOW make split HTML by node, section, chapter; default node. 83 84 --texi2html use texi2html to make HTML target, with all split versions. 85 --docbook convert through DocBook too (xml, txt, html, pdf). 86 87 --help display this help and exit successfully. 88 --version display version information and exit successfully. 89 90Simple example: $prog --email bug-gnu-emacs@gnu.org emacs \"GNU Emacs Manual\" 91 92Typical sequence: 93 cd PACKAGESOURCE/doc 94 wget \"$scripturl\" 95 wget \"$templateurl\" 96 $prog --email BUGLIST MANUAL \"GNU MANUAL - One-line description\" 97 98Output will be in a new subdirectory \"manual\" (by default; 99use -o OUTDIR to override). Move all the new files into your web CVS 100tree, as explained in the Web Pages node of maintain.texi. 101 102Please use the --email ADDRESS option so your own bug-reporting 103address will be used in the generated HTML pages. 104 105MANUAL-TITLE is included as part of the HTML <title> of the overall 106manual/index.html file. It should include the name of the package being 107documented. manual/index.html is created by substitution from the file 108$GENDOCS_TEMPLATE_DIR/gendocs_template. (Feel free to modify the 109generic template for your own purposes.) 110 111If you have several manuals, you'll need to run this script several 112times with different MANUAL values, specifying a different output 113directory with -o each time. Then write (by hand) an overall index.html 114with links to them all. 115 116If a manual's Texinfo sources are spread across several directories, 117first 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.) 119 120As implied above, by default monolithic Info files are generated. 121If you want split Info, or other Info options, use --info to override. 122 123You can set the environment variables MAKEINFO, TEXI2DVI, TEXI2HTML, 124and PERL to control the programs that get executed, and 125GENDOCS_TEMPLATE_DIR to control where the gendocs_template file is 126looked for. With --docbook, the environment variables DOCBOOK2HTML, 127DOCBOOK2PDF, and DOCBOOK2TXT are also consulted. 128 129By default, makeinfo and texi2dvi are run in the default (English) 130locale, since that's the language of most Texinfo manuals. If you 131happen to have a non-English manual and non-English web site, see the 132SETLANG setting in the source. 133 134Email bug reports or enhancement requests to bug-texinfo@gnu.org. 135" 136 137MANUAL_TITLE= 138PACKAGE= 139EMAIL=webmasters@gnu.org # please override with --email 140commonarg= # passed to all makeinfo/texi2html invcations. 141dirargs= # passed to all tools (-I dir). 142dirs= # -I's directories. 143htmlarg= 144infoarg=--no-split 145generate_ascii=true 146outdir=manual 147source_extra= 148split=node 149srcfile= 150 151while test $# -gt 0; do 152 case $1 in 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;; 165 166 --help) echo "$usage"; exit 0;; 167 --version) echo "$version"; exit 0;; 168 -*) 169 echo "$0: Unknown option \`$1'." >&2 170 echo "$0: Try \`--help' for more information." >&2 171 exit 1;; 172 *) 173 if test -z "$PACKAGE"; then 174 PACKAGE=$1 175 elif test -z "$MANUAL_TITLE"; then 176 MANUAL_TITLE=$1 177 else 178 echo "$0: extra non-option argument \`$1'." >&2 179 exit 1 180 fi;; 181 esac 182 shift 183done 184 185# makeinfo uses the dirargs, but texi2dvi doesn't. 186commonarg=" $dirargs $commonarg" 187 188# For most of the following, the base name is just $PACKAGE 189base=$PACKAGE 190 191if test -n "$srcfile"; then 192 # but here, we use the basename of $srcfile 193 base=`basename "$srcfile"` 194 case $base in 195 *.txi|*.texi|*.texinfo) base=`echo "$base"|sed 's/\.[texinfo]*$//'`;; 196 esac 197 PACKAGE=$base 198elif test -s "$srcdir/$PACKAGE.texinfo"; then 199 srcfile=$srcdir/$PACKAGE.texinfo 200elif test -s "$srcdir/$PACKAGE.texi"; then 201 srcfile=$srcdir/$PACKAGE.texi 202elif test -s "$srcdir/$PACKAGE.txi"; then 203 srcfile=$srcdir/$PACKAGE.txi 204else 205 echo "$0: cannot find .texinfo or .texi or .txi for $PACKAGE in $srcdir." >&2 206 exit 1 207fi 208 209if 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 212 exit 1 213fi 214 215# Function to return size of $1 in something resembling kilobytes. 216calcsize() 217{ 218 size=`ls -ksl $1 | awk '{print $1}'` 219 echo $size 220} 221 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. 226copy_images() 227{ 228 local odir 229 odir=$1 230 shift 231 $PERL -n -e " 232BEGIN { 233 \$me = '$prog'; 234 \$odir = '$odir'; 235 @dirs = qw($dirs); 236} 237" -e ' 238/<img src="(.*?)"/g && ++$need{$1}; 239 240END { 241 #print "$me: @{[keys %need]}\n"; # for debugging, show images found. 242 FILE: for my $f (keys %need) { 243 for my $d (@dirs) { 244 if (-f "$d/$f") { 245 use File::Basename; 246 my $dest = dirname ("$odir/$f"); 247 # 248 use File::Path; 249 -d $dest || mkpath ($dest) 250 || die "$me: cannot mkdir $dest: $!\n"; 251 # 252 use File::Copy; 253 copy ("$d/$f", $dest) 254 || die "$me: cannot copy $d/$f to $dest: $!\n"; 255 next FILE; 256 } 257 } 258 die "$me: $ARGV: cannot find image $f\n"; 259 } 260} 261' -- "$@" || exit 1 262} 263 264case $outdir in 265 /*) abs_outdir=$outdir;; 266 *) abs_outdir=$srcdir/$outdir;; 267esac 268 269echo "Making output for $srcfile" 270echo " in `pwd`" 271mkdir -p "$outdir/" 272 273cmd="$SETLANG $MAKEINFO -o $PACKAGE.info $commonarg $infoarg \"$srcfile\"" 274echo "Generating info... ($cmd)" 275rm -f $PACKAGE.info* # get rid of any strays 276eval "$cmd" 277tar czf "$outdir/$PACKAGE.info.tar.gz" $PACKAGE.info* 278ls -l "$outdir/$PACKAGE.info.tar.gz" 279info_tgz_size=`calcsize "$outdir/$PACKAGE.info.tar.gz"` 280# do not mv the info files, there's no point in having them available 281# separately on the web. 282 283cmd="$SETLANG $TEXI2DVI $dirargs \"$srcfile\"" 284printf "\nGenerating dvi... ($cmd)\n" 285eval "$cmd" 286# compress/finish dvi: 287gzip -f -9 $PACKAGE.dvi 288dvi_gz_size=`calcsize $PACKAGE.dvi.gz` 289mv $PACKAGE.dvi.gz "$outdir/" 290ls -l "$outdir/$PACKAGE.dvi.gz" 291 292cmd="$SETLANG $TEXI2DVI --pdf $dirargs \"$srcfile\"" 293printf "\nGenerating pdf... ($cmd)\n" 294eval "$cmd" 295pdf_size=`calcsize $PACKAGE.pdf` 296mv $PACKAGE.pdf "$outdir/" 297ls -l "$outdir/$PACKAGE.pdf" 298 299if $generate_ascii; then 300 opt="-o $PACKAGE.txt --no-split --no-headers $commonarg" 301 cmd="$SETLANG $MAKEINFO $opt \"$srcfile\"" 302 printf "\nGenerating ascii... ($cmd)\n" 303 eval "$cmd" 304 ascii_size=`calcsize $PACKAGE.txt` 305 gzip -f -9 -c $PACKAGE.txt >"$outdir/$PACKAGE.txt.gz" 306 ascii_gz_size=`calcsize "$outdir/$PACKAGE.txt.gz"` 307 mv $PACKAGE.txt "$outdir/" 308 ls -l "$outdir/$PACKAGE.txt" "$outdir/$PACKAGE.txt.gz" 309fi 310 311# Split HTML at level $1. Used for texi2html. 312html_split() 313{ 314 opt="--split=$1 --node-files $commonarg $htmlarg" 315 cmd="$SETLANG $TEXI2HTML --output $PACKAGE.html $opt \"$srcfile\"" 316 printf "\nGenerating html by $1... ($cmd)\n" 317 eval "$cmd" 318 split_html_dir=$PACKAGE.html 319 ( 320 cd ${split_html_dir} || exit 1 321 ln -sf ${PACKAGE}.html index.html 322 tar -czf "$abs_outdir/${PACKAGE}.html_$1.tar.gz" -- *.html 323 ) 324 eval html_$1_tgz_size=`calcsize "$outdir/${PACKAGE}.html_$1.tar.gz"` 325 rm -f "$outdir"/html_$1/*.html 326 mkdir -p "$outdir/html_$1/" 327 mv ${split_html_dir}/*.html "$outdir/html_$1/" 328 rmdir ${split_html_dir} 329} 330 331if test -z "$use_texi2html"; then 332 opt="--no-split --html -o $PACKAGE.html $commonarg $htmlarg" 333 cmd="$SETLANG $MAKEINFO $opt \"$srcfile\"" 334 printf "\nGenerating monolithic html... ($cmd)\n" 335 rm -rf $PACKAGE.html # in case a directory is left over 336 eval "$cmd" 337 html_mono_size=`calcsize $PACKAGE.html` 338 gzip -f -9 -c $PACKAGE.html >"$outdir/$PACKAGE.html.gz" 339 html_mono_gz_size=`calcsize "$outdir/$PACKAGE.html.gz"` 340 copy_images "$outdir/" $PACKAGE.html 341 mv $PACKAGE.html "$outdir/" 342 ls -l "$outdir/$PACKAGE.html" "$outdir/$PACKAGE.html.gz" 343 344 # Before Texinfo 5.0, makeinfo did not accept a --split=HOW option, 345 # it just always split by node. So if we're splitting by node anyway, 346 # leave it out. 347 if test "x$split" = xnode; then 348 split_arg= 349 else 350 split_arg=--split=$split 351 fi 352 # 353 opt="--html -o $PACKAGE.html $split_arg $commonarg $htmlarg" 354 cmd="$SETLANG $MAKEINFO $opt \"$srcfile\"" 355 printf "\nGenerating html by $split... ($cmd)\n" 356 eval "$cmd" 357 split_html_dir=$PACKAGE.html 358 copy_images $split_html_dir/ $split_html_dir/*.html 359 ( 360 cd $split_html_dir || exit 1 361 tar -czf "$abs_outdir/$PACKAGE.html_$split.tar.gz" -- * 362 ) 363 eval \ 364 html_${split}_tgz_size=`calcsize "$outdir/$PACKAGE.html_$split.tar.gz"` 365 rm -rf "$outdir/html_$split/" 366 mv $split_html_dir "$outdir/html_$split/" 367 du -s "$outdir/html_$split/" 368 ls -l "$outdir/$PACKAGE.html_$split.tar.gz" 369 370else # use texi2html: 371 opt="--output $PACKAGE.html $commonarg $htmlarg" 372 cmd="$SETLANG $TEXI2HTML $opt \"$srcfile\"" 373 printf "\nGenerating monolithic html with texi2html... ($cmd)\n" 374 rm -rf $PACKAGE.html # in case a directory is left over 375 eval "$cmd" 376 html_mono_size=`calcsize $PACKAGE.html` 377 gzip -f -9 -c $PACKAGE.html >"$outdir/$PACKAGE.html.gz" 378 html_mono_gz_size=`calcsize "$outdir/$PACKAGE.html.gz"` 379 mv $PACKAGE.html "$outdir/" 380 381 html_split node 382 html_split chapter 383 html_split section 384fi 385 386printf "\nMaking .tar.gz for sources...\n" 387d=`dirname $srcfile` 388( 389 cd "$d" 390 srcfiles=`ls -d *.texinfo *.texi *.txi *.eps $source_extra 2>/dev/null` || true 391 tar czfh "$abs_outdir/$PACKAGE.texi.tar.gz" $srcfiles 392 ls -l "$abs_outdir/$PACKAGE.texi.tar.gz" 393) 394texi_tgz_size=`calcsize "$outdir/$PACKAGE.texi.tar.gz"` 395 396if test -n "$docbook"; then 397 opt="-o - --docbook $commonarg" 398 cmd="$SETLANG $MAKEINFO $opt \"$srcfile\" >${srcdir}/$PACKAGE-db.xml" 399 printf "\nGenerating docbook XML... ($cmd)\n" 400 eval "$cmd" 401 docbook_xml_size=`calcsize $PACKAGE-db.xml` 402 gzip -f -9 -c $PACKAGE-db.xml >"$outdir/$PACKAGE-db.xml.gz" 403 docbook_xml_gz_size=`calcsize "$outdir/$PACKAGE-db.xml.gz"` 404 mv $PACKAGE-db.xml "$outdir/" 405 406 split_html_db_dir=html_node_db 407 opt="$commonarg -o $split_html_db_dir" 408 cmd="$DOCBOOK2HTML $opt \"${outdir}/$PACKAGE-db.xml\"" 409 printf "\nGenerating docbook HTML... ($cmd)\n" 410 eval "$cmd" 411 ( 412 cd ${split_html_db_dir} || exit 1 413 tar -czf "$abs_outdir/${PACKAGE}.html_node_db.tar.gz" -- *.html 414 ) 415 html_node_db_tgz_size=`calcsize "$outdir/${PACKAGE}.html_node_db.tar.gz"` 416 rm -f "$outdir"/html_node_db/*.html 417 mkdir -p "$outdir/html_node_db" 418 mv ${split_html_db_dir}/*.html "$outdir/html_node_db/" 419 rmdir ${split_html_db_dir} 420 421 cmd="$DOCBOOK2TXT \"${outdir}/$PACKAGE-db.xml\"" 422 printf "\nGenerating docbook ASCII... ($cmd)\n" 423 eval "$cmd" 424 docbook_ascii_size=`calcsize $PACKAGE-db.txt` 425 mv $PACKAGE-db.txt "$outdir/" 426 427 cmd="$DOCBOOK2PDF \"${outdir}/$PACKAGE-db.xml\"" 428 printf "\nGenerating docbook PDF... ($cmd)\n" 429 eval "$cmd" 430 docbook_pdf_size=`calcsize $PACKAGE-db.pdf` 431 mv $PACKAGE-db.pdf "$outdir/" 432fi 433 434printf "\nMaking index file...\n" 435if test -z "$use_texi2html"; then 436 CONDS="/%%IF *HTML_SECTION%%/,/%%ENDIF *HTML_SECTION%%/d;\ 437 /%%IF *HTML_CHAPTER%%/,/%%ENDIF *HTML_CHAPTER%%/d" 438else 439 # should take account of --split here. 440 CONDS="/%%ENDIF.*%%/d;/%%IF *HTML_SECTION%%/d;/%%IF *HTML_CHAPTER%%/d" 441fi 442 443curdate=`$SETLANG date '+%B %d, %Y'` 444sed \ 445 -e "s!%%TITLE%%!$MANUAL_TITLE!g" \ 446 -e "s!%%EMAIL%%!$EMAIL!g" \ 447 -e "s!%%PACKAGE%%!$PACKAGE!g" \ 448 -e "s!%%DATE%%!$curdate!g" \ 449 -e "s!%%HTML_MONO_SIZE%%!$html_mono_size!g" \ 450 -e "s!%%HTML_MONO_GZ_SIZE%%!$html_mono_gz_size!g" \ 451 -e "s!%%HTML_NODE_TGZ_SIZE%%!$html_node_tgz_size!g" \ 452 -e "s!%%HTML_SECTION_TGZ_SIZE%%!$html_section_tgz_size!g" \ 453 -e "s!%%HTML_CHAPTER_TGZ_SIZE%%!$html_chapter_tgz_size!g" \ 454 -e "s!%%INFO_TGZ_SIZE%%!$info_tgz_size!g" \ 455 -e "s!%%DVI_GZ_SIZE%%!$dvi_gz_size!g" \ 456 -e "s!%%PDF_SIZE%%!$pdf_size!g" \ 457 -e "s!%%ASCII_SIZE%%!$ascii_size!g" \ 458 -e "s!%%ASCII_GZ_SIZE%%!$ascii_gz_size!g" \ 459 -e "s!%%TEXI_TGZ_SIZE%%!$texi_tgz_size!g" \ 460 -e "s!%%DOCBOOK_HTML_NODE_TGZ_SIZE%%!$html_node_db_tgz_size!g" \ 461 -e "s!%%DOCBOOK_ASCII_SIZE%%!$docbook_ascii_size!g" \ 462 -e "s!%%DOCBOOK_PDF_SIZE%%!$docbook_pdf_size!g" \ 463 -e "s!%%DOCBOOK_XML_SIZE%%!$docbook_xml_size!g" \ 464 -e "s!%%DOCBOOK_XML_GZ_SIZE%%!$docbook_xml_gz_size!g" \ 465 -e "s,%%SCRIPTURL%%,$scripturl,g" \ 466 -e "s!%%SCRIPTNAME%%!$prog!g" \ 467 -e "$CONDS" \ 468$GENDOCS_TEMPLATE_DIR/gendocs_template >"$outdir/index.html" 469 470echo "Done, see $outdir/ subdirectory for new files." 471 472# Local variables: 473# eval: (add-hook 'write-file-hooks 'time-stamp) 474# time-stamp-start: "scriptversion=" 475# time-stamp-format: "%:y-%02m-%02d.%02H" 476# time-stamp-end: "$" 477# End: 478