autoupdate
authorKarl Berry <karl@freefriends.org>
Mon, 2 Apr 2007 22:56:19 +0000 (22:56 +0000)
committerKarl Berry <karl@freefriends.org>
Mon, 2 Apr 2007 22:56:19 +0000 (22:56 +0000)
build-aux/gendocs.sh
doc/gendocs_template
modules/gendocs

index 27c0155..cf96b26 100755 (executable)
@@ -2,7 +2,7 @@
 # gendocs.sh -- generate a GNU manual in many formats.  This script is
 #   mentioned in maintain.texi.  See the help message below for usage details.
 
-scriptversion=2006-07-15.08
+scriptversion=2007-04-02.15
 
 # Copyright (C) 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
 #
@@ -30,19 +30,20 @@ srcdir=`pwd`
 scripturl="http://savannah.gnu.org/cgi-bin/viewcvs/~checkout~/texinfo/texinfo/util/gendocs.sh"
 templateurl="http://savannah.gnu.org/cgi-bin/viewcvs/~checkout~/texinfo/texinfo/util/gendocs_template"
 
+: ${SETLANG="env LANG= LC_MESSAGES= LC_ALL= LANGUAGE="}
 : ${MAKEINFO="makeinfo"}
 : ${TEXI2DVI="texi2dvi -t @finalout"}
 : ${DVIPS="dvips"}
-: ${DOCBOOK2TXT="docbook2txt"}
 : ${DOCBOOK2HTML="docbook2html"}
 : ${DOCBOOK2PDF="docbook2pdf"}
 : ${DOCBOOK2PS="docbook2ps"}
+: ${DOCBOOK2TXT="docbook2txt"}
 : ${GENDOCS_TEMPLATE_DIR="."}
 unset CDPATH
 
 version="gendocs.sh $scriptversion
 
-Copyright (C) 2006 Free Software Foundation, Inc.
+Copyright (C) 2007 Free Software Foundation, Inc.
 There is NO warranty.  You may redistribute this software
 under the terms of the GNU General Public License.
 For more information about these matters, see the files named COPYING."
@@ -83,9 +84,20 @@ times with different YOURMANUAL values, specifying a different output
 directory with -o each time.  Then write (by hand) an overall index.html
 with links to them all.
 
+If a manual's texinfo sources are spread across several directories,
+first copy or symlink all Texinfo sources into a single directory.
+(Part of the script's work is to make a tar.gz of the sources.)
+
 You can set the environment variables MAKEINFO, TEXI2DVI, and DVIPS to
 control the programs that get executed, and GENDOCS_TEMPLATE_DIR to
-control where the gendocs_template file is looked for.
+control where the gendocs_template file is looked for.  (With --docbook,
+the environment variables DOCBOOK2HTML, DOCBOOK2PDF, DOCBOOK2PS, and
+DOCBOOK2TXT are also respected.) 
+
+By default, makeinfo is run in the default (English) locale, since
+that's the language of most Texinfo manuals.  If you happen to have a
+non-English manual and non-English web site, check the SETLANG setting
+in the source.
 
 Email bug reports or enhancement requests to bug-texinfo@gnu.org.
 "
@@ -144,7 +156,7 @@ fi
 
 echo Generating output formats for $srcfile
 
-cmd="${MAKEINFO} -o $PACKAGE.info \"$srcfile\""
+cmd="$SETLANG $MAKEINFO -o $PACKAGE.info \"$srcfile\""
 echo "Generating info files... ($cmd)"
 eval "$cmd"
 mkdir -p $outdir/
@@ -175,7 +187,7 @@ eval "$cmd"
 pdf_size=`calcsize $PACKAGE.pdf`
 mv $PACKAGE.pdf $outdir/
 
-cmd="${MAKEINFO} -o $PACKAGE.txt --no-split --no-headers \"$srcfile\""
+cmd="$SETLANG $MAKEINFO -o $PACKAGE.txt --no-split --no-headers \"$srcfile\""
 echo "Generating ASCII... ($cmd)"
 eval "$cmd"
 ascii_size=`calcsize $PACKAGE.txt`
@@ -183,7 +195,7 @@ gzip -f -9 -c $PACKAGE.txt >$outdir/$PACKAGE.txt.gz
 ascii_gz_size=`calcsize $outdir/$PACKAGE.txt.gz`
 mv $PACKAGE.txt $outdir/
 
-cmd="${MAKEINFO} --no-split --html -o $PACKAGE.html $html \"$srcfile\""
+cmd="$SETLANG $MAKEINFO --no-split --html -o $PACKAGE.html $html \"$srcfile\""
 echo "Generating monolithic html... ($cmd)"
 rm -rf $PACKAGE.html  # in case a directory is left over
 eval "$cmd"
@@ -192,7 +204,7 @@ gzip -f -9 -c $PACKAGE.html >$outdir/$PACKAGE.html.gz
 html_mono_gz_size=`calcsize $outdir/$PACKAGE.html.gz`
 mv $PACKAGE.html $outdir/
 
-cmd="${MAKEINFO} --html -o $PACKAGE.html $html \"$srcfile\""
+cmd="$SETLANG $MAKEINFO --html -o $PACKAGE.html $html \"$srcfile\""
 echo "Generating html by node... ($cmd)"
 eval "$cmd"
 split_html_dir=$PACKAGE.html
@@ -212,7 +224,7 @@ tar cvzfh $outdir/$PACKAGE.texi.tar.gz $srcfiles
 texi_tgz_size=`calcsize $outdir/$PACKAGE.texi.tar.gz`
 
 if test -n "$docbook"; then
-  cmd="${MAKEINFO} -o - --docbook \"$srcfile\" > ${srcdir}/$PACKAGE-db.xml"
+  cmd="$SETLANG $MAKEINFO -o - --docbook \"$srcfile\" > ${srcdir}/$PACKAGE-db.xml"
   echo "Generating docbook XML... $(cmd)"
   eval "$cmd"
   docbook_xml_size=`calcsize $PACKAGE-db.xml`
index 9e9717d..d744e4c 100755 (executable)
 
 <ul>
   <li><a href="%%PACKAGE%%.html">HTML 
-      (%%HTML_MONO_SIZE%%K characters)</a> - entirely on one web page.</li>
+      (%%HTML_MONO_SIZE%%K bytes)</a> - entirely on one web page.</li>
   <li><a href="html_node/index.html">HTML</a> - with one web page per
       node.</li>
   <li><a href="%%PACKAGE%%.html.gz">HTML compressed
-      (%%HTML_MONO_GZ_SIZE%%K gzipped characters)</a> - entirely on 
+      (%%HTML_MONO_GZ_SIZE%%K bytes gzipped)</a> - entirely on 
       one web page.</li>
   <li><a href="%%PACKAGE%%.html_node.tar.gz">HTML compressed
       (%%HTML_NODE_TGZ_SIZE%%K gzipped tar file)</a> -
       with one web page per node.</li>
   <li><a href="%%PACKAGE%%.info.tar.gz">Info document
-      (%%INFO_TGZ_SIZE%%K characters gzipped tar file)</a>.</li>
+      (%%INFO_TGZ_SIZE%%K bytes gzipped tar file)</a>.</li>
   <li><a href="%%PACKAGE%%.txt">ASCII text
-      (%%ASCII_SIZE%%K characters)</a>.</li>
+      (%%ASCII_SIZE%%K bytes)</a>.</li>
   <li><a href="%%PACKAGE%%.txt.gz">ASCII text compressed
-      (%%ASCII_GZ_SIZE%%K gzipped characters)</a>.</li>
+      (%%ASCII_GZ_SIZE%%K bytes gzipped)</a>.</li>
   <li><a href="%%PACKAGE%%.dvi.gz">TeX dvi file
-      (%%DVI_GZ_SIZE%%K characters gzipped)</a>.</li>
+      (%%DVI_GZ_SIZE%%K bytes gzipped)</a>.</li>
   <li><a href="%%PACKAGE%%.ps.gz">PostScript file
-      (%%PS_GZ_SIZE%%K characters gzipped)</a>.</li>
+      (%%PS_GZ_SIZE%%K bytes gzipped)</a>.</li>
   <li><a href="%%PACKAGE%%.pdf">PDF file
-      (%%PDF_SIZE%%K characters)</a>.</li>
+      (%%PDF_SIZE%%K bytes)</a>.</li>
   <li><a href="%%PACKAGE%%.texi.tar.gz">Texinfo source
-      (%%TEXI_TGZ_SIZE%%K characters gzipped tar file)</a></li>
+      (%%TEXI_TGZ_SIZE%%K bytes gzipped tar file)</a></li>
 </ul>
 
 <p>(This page generated by the <a href="%%SCRIPTURL%%">%%SCRIPTNAME%%
index daf72f6..d70449d 100644 (file)
@@ -1,5 +1,6 @@
 Description:
-Generate manuals in several formats from Texinfo sources,
+Generate manuals in several formats from Texinfo sources.
+Can be used for http://www.gnu.org/software/PKG/manual/ directories.
 
 Files:
 build-aux/gendocs.sh