diff options
Diffstat (limited to 'doc')
| -rwxr-xr-x | doc/gendocs.sh | 77 | ||||
| -rw-r--r-- | doc/gendocs_template | 30 |
2 files changed, 59 insertions, 48 deletions
diff --git a/doc/gendocs.sh b/doc/gendocs.sh index 5247034..992d9fc 100755 --- a/doc/gendocs.sh +++ b/doc/gendocs.sh @@ -2,15 +2,15 @@ # 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=2008-03-05.14 +scriptversion=2009-09-09.22 -# Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008 +# Copyright 2003, 2004, 2005, 2006, 2007, 2008, 2009 # Free Software Foundation, Inc. # -# This program is free software; you can redistribute it and/or modify +# This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by -# the Free Software Foundation; either version 3 of the License, -# or (at your option) any later version. +# the Free Software Foundation; either version 3 of the License, or +# (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of @@ -19,7 +19,7 @@ scriptversion=2008-03-05.14 # # You should have received a copy of the GNU General Public License # along with this program. If not, see <http://www.gnu.org/licenses/>. -# +# # Original author: Mohit Agarwal. # Send bug reports and any other correspondence to bug-texinfo@gnu.org. @@ -44,7 +44,7 @@ unset use_texi2html version="gendocs.sh $scriptversion -Copyright (C) 2007 Free Software Foundation, Inc. +Copyright 2009 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." @@ -57,24 +57,28 @@ See the GNU Maintainers document for a more extensive discussion: Options: -o OUTDIR write files into OUTDIR, instead of manual/. + --email ADR use ADR as contact in generated web pages. --docbook convert to DocBook too (xml, txt, html, pdf and ps). --html ARG pass indicated ARG to makeinfo or texi2html for HTML targets. --texi2html use texi2html to generate HTML targets. --help display this help and exit successfully. --version display version information and exit successfully. -Simple example: $prog emacs \"GNU Emacs Manual\" +Simple example: $prog --email bug-gnu-emacs@gnu.org emacs \"GNU Emacs Manual\" Typical sequence: - cd YOURPACKAGESOURCE/doc + cd PACKAGESOURCE/doc wget \"$scripturl\" wget \"$templateurl\" - $prog YOURMANUAL \"GNU YOURMANUAL - One-line description\" + $prog --email BUGLIST MANUAL \"GNU MANUAL - One-line description\" Output will be in a new subdirectory \"manual\" (by default, use -o OUTDIR to override). Move all the new files into your web CVS tree, as explained in the Web Pages node of maintain.texi. +Please use the --email ADDRESS option to specify your bug-reporting +address in the generated HTML pages. + MANUAL-TITLE is included as part of the HTML <title> of the overall manual/index.html file. It should include the name of the package being documented. manual/index.html is created by substitution from the file @@ -82,11 +86,11 @@ $GENDOCS_TEMPLATE_DIR/gendocs_template. (Feel free to modify the generic template for your own purposes.) If you have several manuals, you'll need to run this script several -times with different YOURMANUAL values, specifying a different output +times with different MANUAL 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, +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.) @@ -94,11 +98,11 @@ 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. (With --docbook, the environment variables DOCBOOK2HTML, DOCBOOK2PDF, DOCBOOK2PS, and -DOCBOOK2TXT are also respected.) +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 +non-English manual and non-English web site, see the SETLANG setting in the source. Email bug reports or enhancement requests to bug-texinfo@gnu.org. @@ -110,21 +114,23 @@ calcsize() echo $size } -outdir=manual -html= -PACKAGE= MANUAL_TITLE= +PACKAGE= +EMAIL=webmasters@gnu.org # please override with --email +htmlarg= +outdir=manual while test $# -gt 0; do case $1 in + --email) shift; EMAIL=$1;; --help) echo "$usage"; exit 0;; --version) echo "$version"; exit 0;; -o) shift; outdir=$1;; --docbook) docbook=yes;; - --html) shift; html=$1;; + --html) shift; htmlarg=$1;; --texi2html) use_texi2html=1;; -*) - echo "$0: Unknown or ambiguous option \`$1'." >&2 + echo "$0: Unknown option \`$1'." >&2 echo "$0: Try \`--help' for more information." >&2 exit 1;; *) @@ -157,6 +163,11 @@ if test ! -r $GENDOCS_TEMPLATE_DIR/gendocs_template; then exit 1 fi +case $outdir in + /*) dotdot_outdir="$outdir";; + *) dotdot_outdir="../$outdir";; +esac + echo Generating output formats for $srcfile cmd="$SETLANG $MAKEINFO -o $PACKAGE.info \"$srcfile\"" @@ -198,15 +209,17 @@ gzip -f -9 -c $PACKAGE.txt >$outdir/$PACKAGE.txt.gz ascii_gz_size=`calcsize $outdir/$PACKAGE.txt.gz` mv $PACKAGE.txt $outdir/ -html_split() { - cmd="$SETLANG $TEXI2HTML --output $PACKAGE.html --split=$1 $html --node-files \"$srcfile\"" +html_split() +{ + opt="--split=$1 $htmlarg --node-files" + cmd="$SETLANG $TEXI2HTML --output $PACKAGE.html $opt \"$srcfile\"" echo "Generating html by $1... ($cmd)" eval "$cmd" split_html_dir=$PACKAGE.html ( cd ${split_html_dir} || exit 1 ln -sf ${PACKAGE}.html index.html - tar -czf ../$outdir/${PACKAGE}.html_$1.tar.gz -- *.html + tar -czf $dotdot_outdir/${PACKAGE}.html_$1.tar.gz -- *.html ) eval html_$1_tgz_size=`calcsize $outdir/${PACKAGE}.html_$1.tar.gz` rm -f $outdir/html_$1/*.html @@ -216,7 +229,8 @@ html_split() { } if test -z "$use_texi2html"; then - cmd="$SETLANG $MAKEINFO --no-split --html -o $PACKAGE.html $html \"$srcfile\"" + opt="--no-split --html -o $PACKAGE.html $htmlarg" + cmd="$SETLANG $MAKEINFO $opt \"$srcfile\"" echo "Generating monolithic html... ($cmd)" rm -rf $PACKAGE.html # in case a directory is left over eval "$cmd" @@ -225,21 +239,21 @@ if test -z "$use_texi2html"; then html_mono_gz_size=`calcsize $outdir/$PACKAGE.html.gz` mv $PACKAGE.html $outdir/ - cmd="$SETLANG $MAKEINFO --html -o $PACKAGE.html $html \"$srcfile\"" + cmd="$SETLANG $MAKEINFO --html -o $PACKAGE.html $htmlarg \"$srcfile\"" echo "Generating html by node... ($cmd)" eval "$cmd" split_html_dir=$PACKAGE.html ( cd ${split_html_dir} || exit 1 - tar -czf ../$outdir/${PACKAGE}.html_node.tar.gz -- *.html + tar -czf $dotdot_outdir/${PACKAGE}.html_node.tar.gz -- *.html ) - html_node_tgz_size=`calcsize $outdir/${PACKAGE}.html_node.tar.gz` + html_node_tgz_size=`calcsize $outdir/${PACKAGE}.html_node.tar.gz` rm -f $outdir/html_node/*.html mkdir -p $outdir/html_node/ mv ${split_html_dir}/*.html $outdir/html_node/ rmdir ${split_html_dir} else - cmd="$SETLANG $TEXI2HTML --output $PACKAGE.html $html \"$srcfile\"" + cmd="$SETLANG $TEXI2HTML --output $PACKAGE.html $htmlarg \"$srcfile\"" echo "Generating monolithic html... ($cmd)" rm -rf $PACKAGE.html # in case a directory is left over eval "$cmd" @@ -273,7 +287,7 @@ if test -n "$docbook"; then split_html_db_dir=html_node_db ( cd ${split_html_db_dir} || exit 1 - tar -czf ../$outdir/${PACKAGE}.html_node_db.tar.gz -- *.html + tar -czf $dotdot_outdir/${PACKAGE}.html_node_db.tar.gz -- *.html ) html_node_db_tgz_size=`calcsize $outdir/${PACKAGE}.html_node_db.tar.gz` rm -f $outdir/html_node_db/*.html @@ -301,7 +315,7 @@ if test -n "$docbook"; then mv $PACKAGE-db.pdf $outdir/ fi -echo Writing index file... +echo "Writing index file..." if test -z "$use_texi2html"; then CONDS="/%%IF *HTML_SECTION%%/,/%%ENDIF *HTML_SECTION%%/d;\ /%%IF *HTML_CHAPTER%%/,/%%ENDIF *HTML_CHAPTER%%/d" @@ -311,8 +325,9 @@ fi curdate=`$SETLANG date '+%B %d, %Y'` sed \ -e "s!%%TITLE%%!$MANUAL_TITLE!g" \ - -e "s!%%DATE%%!$curdate!g" \ + -e "s!%%EMAIL%%!$EMAIL!g" \ -e "s!%%PACKAGE%%!$PACKAGE!g" \ + -e "s!%%DATE%%!$curdate!g" \ -e "s!%%HTML_MONO_SIZE%%!$html_mono_size!g" \ -e "s!%%HTML_MONO_GZ_SIZE%%!$html_mono_gz_size!g" \ -e "s!%%HTML_NODE_TGZ_SIZE%%!$html_node_tgz_size!g" \ @@ -336,7 +351,7 @@ sed \ -e "$CONDS" \ $GENDOCS_TEMPLATE_DIR/gendocs_template >$outdir/index.html -echo "Done! See $outdir/ subdirectory for new files." +echo "Done, see $outdir/ subdirectory for new files." # Local variables: # eval: (add-hook 'write-file-hooks 'time-stamp) diff --git a/doc/gendocs_template b/doc/gendocs_template index be93a63..ee6a5c5 100644 --- a/doc/gendocs_template +++ b/doc/gendocs_template @@ -15,7 +15,7 @@ <p>This manual (%%PACKAGE%%) is available in the following formats:</p> <ul> -<li><a href="%%PACKAGE%%.html">HTML +<li><a href="%%PACKAGE%%.html">HTML (%%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> @@ -28,7 +28,7 @@ chapter.</li> %%ENDIF HTML_CHAPTER%% <li><a href="%%PACKAGE%%.html.gz">HTML compressed - (%%HTML_MONO_GZ_SIZE%%K gzipped characters)</a> - entirely on + (%%HTML_MONO_GZ_SIZE%%K gzipped characters)</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> - @@ -59,7 +59,7 @@ (%%TEXI_TGZ_SIZE%%K bytes gzipped tar file).</a></li> </ul> -<p>You can <a href="http://www.gnu.org/order/">buy printed copies of +<p>You can <a href="http://shop.fsf.org/">buy printed copies of some manuals</a> (among other items) from the Free Software Foundation; this helps support FSF activities.</p> @@ -69,30 +69,26 @@ script</a>.)</p> <!-- If needed, change the copyright block at the bottom. In general, --> <!-- all pages on the GNU web server should have the section about --> <!-- verbatim copying. Please do NOT remove this without talking --> -<!-- with the webmasters first. --> +<!-- with the webmasters first. --> <!-- Please make sure the copyright date is consistent with the document --> <!-- and that it is like this "2001, 2002" not this "2001-2002." --> </div><!-- for id="content", starts in the include above --> -<!--#include virtual="/server/footer-min.html" --> +<!--#include virtual="/server/footer.html" --> <div id="footer"> <p> -Please send FSF & GNU inquiries to -<a href="mailto:gnu@gnu.org"><em>gnu@gnu.org</em></a>. -There are also <a href="/contact/">other ways to contact</a> -the FSF. -<br /> +Please send FSF & GNU inquiries to +<a href="mailto:gnu@gnu.org"><gnu@gnu.org></a>. +There are also <a href="/contact/">other ways to contact</a> +the FSF.<br /> Please send broken links and other corrections or suggestions to -<a href="mailto:webmasters@gnu.org"><em>webmasters@gnu.org</em></a>. +<a href="mailto:%%EMAIL%%"><%%EMAIL%%></a>. </p> -<p> -Copyright © 2007 Free Software Foundation, Inc., -</p> -<address>51 Franklin Street, Fifth Floor, Boston, MA 02111, USA</address> +<p>Copyright © 2009 Free Software Foundation, Inc.</p> + <p>Verbatim copying and distribution of this entire article is -permitted in any medium, provided this notice is preserved. -</p> +permitted in any medium, provided this notice is preserved.</p> </div> </div> |