version 1.1, 2014/07/30 08:16:46
|
version 1.1.1.2, 2021/03/17 01:01:01
|
Line 1
|
Line 1
|
#! /bin/sh |
#! /bin/sh |
# texi2dvi --- produce DVI (or PDF) files from Texinfo (or LaTeX) sources. | # texi2dvi --- produce DVI (or PDF) files from Texinfo (or (La)TeX) sources. |
# $Id$ | |
# |
# |
# Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2001, | # Copyright 1992-2019 Free Software Foundation, Inc. |
# 2002, 2003 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 | # it under the terms of the GNU General Public License as published by |
# the Free Software Foundation, either version 3 of the License, or | # the Free Software Foundation; either version 3 of the License, |
# (at your option) any later version. | # or (at your option) any later version. |
# |
# |
# This program is distributed in the hope that it will be useful, | # This program is distributed in the hope that it will be useful, |
# but WITHOUT ANY WARRANTY; without even the implied warranty of | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
# GNU General Public License for more details. | # GNU General Public License for more details. |
# |
# |
# You should have received a copy of the GNU General Public License | # You should have received a copy of the GNU General Public License |
# along with this program. If not, see <http://www.gnu.org/licenses/>. | # along with this program. If not, see <http://www.gnu.org/licenses/>. |
# |
# |
# Original author: Noah Friedman <friedman@gnu.org>. | # Originally written by Noah Friedman. |
# |
# |
# Please send bug reports, etc. to bug-texinfo@gnu.org. |
# Please send bug reports, etc. to bug-texinfo@gnu.org. |
# If possible, please send a copy of the output of the script called with |
# If possible, please send a copy of the output of the script called with |
# the `--debug' option when making a bug report. |
# the `--debug' option when making a bug report. |
|
|
# This string is expanded by rcs automatically when this file is checked out. | test -f /bin/ksh && test -z "$RUNNING_KSH" \ |
rcs_revision='$Revision$' | && { UNAMES=`uname -s`; test "x$UNAMES" = xULTRIX; } 2>/dev/null \ |
rcs_version=`set - $rcs_revision; echo $2` | && { RUNNING_KSH=true; export RUNNING_KSH; exec /bin/ksh $0 ${1+"$@"}; } |
program=`echo $0 | sed -e 's!.*/!!'` | unset RUNNING_KSH |
version="texi2dvi (GNU Texinfo 4.5) $rcs_version | |
|
|
Copyright (C) 2003 Free Software Foundation, Inc. | # No failure shall remain unpunished. |
There is NO warranty. You may redistribute this software | set -e |
under the terms of the GNU General Public License. | |
For more information about these matters, see the files named COPYING." | |
|
|
usage="Usage: $program [OPTION]... FILE... | # In case the default sed doesn't suffice. |
| : ${SED=sed} |
|
|
Run each Texinfo or LaTeX FILE through TeX in turn until all | program=`echo $0 | $SED -e 's!.*/!!'` |
cross-references are resolved, building all indices. The directory | |
containing each FILE is searched for included files. The suffix of FILE | |
is used to determine its language (LaTeX or Texinfo). | |
|
|
Makeinfo is used to perform Texinfo macro expansion before running TeX | build_mode=${TEXI2DVI_BUILD_MODE:-local} |
when needed. | build_dir=${TEXI2DVI_BUILD_DIRECTORY:-.} |
|
|
Operation modes: | orig_pwd=`pwd` |
-b, --batch no interaction | |
-c, --clean remove all auxiliary files | |
-D, --debug turn on shell debugging (set -x) | |
-h, --help display this help and exit successfully | |
-o, --output=OFILE leave output in OFILE (implies --clean); | |
Only one input FILE may be specified in this case | |
-q, --quiet no output unless errors (implies --batch) | |
-s, --silent same as --quiet | |
-v, --version display version information and exit successfully | |
-V, --verbose report on what is done | |
|
|
TeX tuning: |
|
-@ use @input instead of \input; for preloaded Texinfo |
|
-e, -E, --expand force macro expansion using makeinfo |
|
-I DIR search DIR for Texinfo files |
|
-l, --language=LANG specify the LANG of FILE (LaTeX or Texinfo) |
|
-p, --pdf use pdftex or pdflatex for processing |
|
-t, --texinfo=CMD insert CMD after @setfilename in copy of input file |
|
multiple values accumulate |
|
|
|
The values of the BIBTEX, LATEX (or PDFLATEX), MAKEINDEX, MAKEINFO, |
|
TEX (or PDFTEX), and TEXINDEX environment variables are used to run |
|
those commands, if they are set. |
|
|
|
Email bug reports to <bug-texinfo@gnu.org>, |
|
general questions and discussion to <help-texinfo@gnu.org>. |
|
Texinfo home page: http://www.gnu.org/software/texinfo/" |
|
|
|
# Initialize variables for option overriding and otherwise. |
# Initialize variables for option overriding and otherwise. |
# Don't use `unset' since old bourne shells don't have this command. |
# Don't use `unset' since old bourne shells don't have this command. |
# Instead, assign them an empty value. |
# Instead, assign them an empty value. |
batch=false # eval for batch mode | action=compile |
clean= | debug=false |
debug= | escape="\\" |
escape='\' | expand=false # true for expansion via makeinfo |
expand= # t for expansion via makeinfo | includes= |
miincludes= # makeinfo include path | line_error=true # pass --file-line-error to TeX |
oformat=dvi | max_iters=7 # when to quit |
oname= # --output |
oname= # --output |
quiet= # by default let the tools' message be displayed | out_lang=dvi |
| quiet=false # let the tools' message be displayed |
set_language= |
set_language= |
textra= | src_specials= |
tmpdir=${TMPDIR:-/tmp}/t2d$$ # avoid collisions on 8.3 filesystems. | shell_escape= |
txincludes= # TEXINPUTS extensions, with trailing colon | latex2html=hevea # or set to tex4ht |
txiprereq=19990129 # minimum texinfo.tex version to have macro expansion | textra= # Extra TeX commands to insert in the input file. |
verbose=false # echo for verbose mode | txiprereq=19990129 # minimum texinfo.tex version with macro expansion |
| verb=false # true for verbose mode |
| translate_file= # name of charset translation file |
|
|
orig_pwd=`pwd` | # We have to initialize IFS to space tab newline since we save and |
| # restore IFS and apparently POSIX allows stupid/broken behavior with |
| # empty-but-set IFS. |
| # http://lists.gnu.org/archive/html/automake-patches/2006-05/msg00008.html |
| # We need space, tab and newline, in precisely that order. And don't leave |
| # trailing blanks. |
| space=' ' |
| tab=' ' |
| newline=' |
| ' |
| IFS="$space$tab$newline" |
|
|
|
: ${EGREP=egrep} |
|
|
# Systems which define $COMSPEC or $ComSpec use semicolons to separate |
# Systems which define $COMSPEC or $ComSpec use semicolons to separate |
# directories in TEXINPUTS. | # directories in TEXINPUTS -- except for Cygwin and Msys, where COMSPEC |
if test -n "$COMSPEC$ComSpec"; then | # might be inherited, but : is used. |
| |
| # In the case of Msys, uname returns a value derived from MSYSTEM, as |
| # MSYSTEM is user configurable, it is not so safe to use it to detect |
| # Msys. It is safer to use OSTYPE, this is why we set MSYSTEM to |
| # $OSTYPE before calling uname |
| if test -n "$COMSPEC$ComSpec" \ |
| && MSYSTEM=$OSTYPE uname | $EGREP -iv 'cygwin|msys' >/dev/null; then |
path_sep=";" |
path_sep=";" |
else |
else |
path_sep=":" |
path_sep=":" |
fi |
fi |
|
|
|
|
# Pacify verbose cds. |
# Pacify verbose cds. |
CDPATH=${ZSH_VERSION+.}$path_sep |
CDPATH=${ZSH_VERSION+.}$path_sep |
|
|
# In case someone crazy insists on using grep -E. |
|
: ${EGREP=egrep} |
|
|
|
# Save this so we can construct a new TEXINPUTS path for each file. | # Now we define numerous functions, with no other executable code. |
TEXINPUTS_orig="$TEXINPUTS" | # The main program is at the end of the file. |
# Unfortunately makeindex does not read TEXINPUTS. | |
INDEXSTYLE_orig="$INDEXSTYLE" | |
export TEXINPUTS INDEXSTYLE | |
|
|
# Push a token among the arguments that will be used to notice when we | |
# ended options/arguments parsing. | # Standard help and version functions. |
# Use "set dummy ...; shift" rather than 'set - ..." because on | # |
# Solaris set - turns off set -x (but keeps set -e). | # usage - display usage and exit successfully. |
# Use ${1+"$@"} rather than "$@" because Digital Unix and Ultrix 4.3 | usage () |
# still expand "$@" to a single argument (the empty string) rather | { |
# than nothing at all. | cat <<EOF |
arg_sep="$$--$$" | Usage: $program [OPTION]... FILE... |
set dummy ${1+"$@"} "$arg_sep"; shift | or: texi2pdf [OPTION]... FILE... |
| or: pdftexi2dvi [OPTION]... FILE... |
|
|
# | Run each Texinfo or (La)TeX FILE through TeX in turn until all |
# Parse command line arguments. | cross-references are resolved, building all indices. The directory |
while test x"$1" != x"$arg_sep"; do | containing each FILE is searched for included files. The suffix of FILE |
| is used to determine its language ((La)TeX or Texinfo). To process |
| (e)plain TeX files, set the environment variable LATEX=tex. |
|
|
# Handle --option=value by splitting apart and putting back on argv. | When invoked as \`texi2pdf' or given the option --pdf generate PDF output. |
case "$1" in | Otherwise, generate DVI. |
--*=*) | |
opt=`echo "$1" | sed -e 's/=.*//'` | |
val=`echo "$1" | sed -e 's/[^=]*=//'` | |
shift | |
set dummy "$opt" "$val" ${1+"$@"}; shift | |
;; | |
esac | |
|
|
# This recognizes --quark as --quiet. So what. | General options: |
case "$1" in | -D, --debug turn on shell debugging (set -x) |
-@ ) escape=@;; | -h, --help display this help and exit successfully |
# Silently and without documentation accept -b and --b[atch] as synonyms. | -o, --output=OFILE leave output in OFILE; only one input FILE is allowed |
-b | --b*) batch=eval;; | -q, --quiet no output unless errors |
-q | -s | --q* | --s*) quiet=t; batch=eval;; | -v, --version display version information and exit successfully |
-c | --c*) clean=t;; | -V, --verbose report on what is done |
-D | --d*) debug=t;; | --max-iterations=N don't process files more than N times [$max_iters] |
-e | -E | --e*) expand=t;; | --mostly-clean remove auxiliary files or directories from |
-h | --h*) echo "$usage"; exit 0;; | previous runs (but not the output) |
-I | --I*) | |
shift | |
miincludes="$miincludes -I $1" | |
txincludes="$txincludes$1$path_sep" | |
;; | |
-l | --l*) shift; set_language=$1;; | |
-o | --o*) | |
shift | |
clean=t | |
case "$1" in | |
/* | ?:/*) oname=$1;; | |
*) oname="$orig_pwd/$1";; | |
esac;; | |
-p | --p*) oformat=pdf;; | |
-t | --t*) shift; textra="$textra\\ | |
$1";; | |
-v | --vers*) echo "$version"; exit 0;; | |
-V | --verb*) verbose=echo;; | |
--) # What remains are not options. | |
shift | |
while test x"$1" != x"$arg_sep"; do | |
set dummy ${1+"$@"} "$1"; shift | |
shift | |
done | |
break;; | |
-*) | |
echo "$0: Unknown or ambiguous option \`$1'." >&2 | |
echo "$0: Try \`--help' for more information." >&2 | |
exit 1;; | |
*) set dummy ${1+"$@"} "$1"; shift;; | |
esac | |
shift | |
done | |
# Pop the token | |
shift | |
|
|
# Interpret remaining command line args as filenames. | Output format: |
case $# in | --dvi output a DVI file [default] |
0) | --dvipdf output a PDF file via DVI (using a dvi-to-pdf program) |
echo "$0: Missing file arguments." >&2 | --html output an HTML file from LaTeX, using HeVeA |
echo "$0: Try \`--help' for more information." >&2 | --info output an Info file from LaTeX, using HeVeA |
exit 2 | -p, --pdf use pdftex or pdflatex for processing |
;; | --ps output a PostScript file via DVI (using dvips) |
1) ;; | --text output a plain text file from LaTeX, using HeVeA |
*) | |
if test -n "$oname"; then | |
echo "$0: Can't use option \`--output' with more than one argument." >&2 | |
exit 2 | |
fi | |
;; | |
esac | |
|
|
# Prepare the temporary directory. Remove it at exit, unless debugging. | TeX tuning: |
if test -z "$debug"; then | -E, --expand macro expansion using makeinfo |
trap "cd / && rm -rf $tmpdir" 0 1 2 15 | -I DIR search DIR for Texinfo files |
fi | -l, --language=LANG specify LANG for FILE, either latex or texinfo |
| --no-line-error do not pass --file-line-error to TeX |
| --shell-escape pass --shell-escape to TeX |
| --src-specials pass --src-specials to TeX |
| --translate-file=FILE use given charset translation file for TeX |
| -t, --command=CMD insert CMD in copy of input file |
|
|
# Create the temporary directory with strict rights | Build modes: |
(umask 077 && mkdir $tmpdir) || exit 1 | --build=MODE specify the treatment of auxiliary files [$build_mode] |
| --tidy same as --build=tidy |
| -c, --clean same as --build=clean |
| --build-dir=DIR specify where the tidy compilation is performed; |
| implies --tidy; |
| defaults to TEXI2DVI_BUILD_DIRECTORY [$build_dir] |
|
|
# Prepare the tools we might need. This may be extra work in some | The MODE specifies where the TeX compilation takes place, and, as a |
# cases, but improves the readibility of the script. | consequence, how auxiliary files are treated. The build mode can also |
utildir=$tmpdir/utils | be set using the environment variable TEXI2DVI_BUILD_MODE. |
mkdir $utildir || exit 1 | |
|
|
# A sed script that preprocesses Texinfo sources in order to keep the | Valid values of MODE are: |
# iftex sections only. We want to remove non TeX sections, and | \`local' compile in the current directory, leaving all the auxiliary |
# comment (with `@c texi2dvi') TeX sections so that makeinfo does not | files around. This is the traditional TeX use. |
# try to parse them. Nevertheless, while commenting TeX sections, | \`tidy' compile in a local *.t2d directory, where the auxiliary files |
# don't comment @macro/@end macro so that makeinfo does propagate | are left. Output files are copied back to the original file. |
# them. Unfortunately makeinfo --iftex --no-ifhtml --no-ifinfo | \`clean' same as \`tidy', but remove the auxiliary directory afterwards. |
# doesn't work well enough (yet) to use that, so work around with sed. | Every compilation therefore requires the full cycle. |
comment_iftex_sed=$utildir/comment.sed | |
cat <<EOF >$comment_iftex_sed | The values of these environment variables are used to run the |
/^@tex/,/^@end tex/{ | corresponding commands, if they are set: |
s/^/@c texi2dvi/ | |
| BIBER BIBTEX DVIPDF DVIPS EGREP HEVEA LATEX MAKEINDEX MAKEINFO |
| PDFLATEX PDFTEX SED T4HT TEX TEX4HT TEXINDEX TEXINDY THUMBPDF_CMD |
| |
| Regarding --dvipdf, if DVIPDF is not set in the environment, the |
| following programs are looked for (in this order): dvipdfmx dvipdfm |
| dvipdf dvi2pdf dvitopdf. |
| |
| If Texinfo is installed on your site, then the command |
| |
| info texi2dvi |
| |
| should give you access to more documentation. |
| |
| Report bugs to bug-texinfo@gnu.org, |
| general questions and discussion to help-texinfo@gnu.org. |
| GNU Texinfo home page: <http://www.gnu.org/software/texinfo/> |
| General help using GNU software: <http://www.gnu.org/gethelp/> |
| EOF |
| exit 0 |
} |
} |
/^@iftex/,/^@end iftex/{ | |
s/^/@c texi2dvi/ | |
/^@c texi2dvi@macro/,/^@c texi2dvi@end macro/{ | # version - Display version info and exit successfully. |
s/^@c texi2dvi// | version () |
} | { |
| cat <<EOF |
| texi2dvi (GNU Texinfo 6.7) |
| |
| Copyright (C) 2019 Free Software Foundation, Inc. |
| License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html> |
| This is free software: you are free to change and redistribute it. |
| There is NO WARRANTY, to the extent permitted by law. |
| EOF |
| exit 0 |
} |
} |
/^@html/,/^@end html/{ | |
s/^/@c (texi2dvi)/ | |
| # Generic auxiliary functions. |
| |
| # Used to access files and directories after we have changed directory |
| # (for --tidy). |
| rel= |
| |
| # Change directory, updating some relative paths. |
| cd_dir () |
| { |
| cd "$1" |
| |
| # Check if argument or input file is absolute, and if so, make all the path |
| # variables absolute. |
| use_absolute=false |
| case $1 in |
| [\\/]* | ?:[\\/]*) # absolute path |
| use_absolute=true ;; |
| esac |
| case $in_input in |
| [\\/]* | ?:[\\/]*) |
| use_absolute=true ;; |
| esac |
| |
| if $use_absolute ; then |
| for cdd_dir in work_build workdir t2ddir work_bak in_input in_dir; do |
| eval "$cdd_dir=\`absolute \$$cdd_dir\`" |
| done |
| return |
| fi |
| |
| # Replace each path component with ".." and add a single trailing slash. |
| rel=`echo "$1" | \$SED -e 's/[^/\\][^/\\]*/../g' -e 's/[/\\]*$/\//'` |
} |
} |
/^@ifhtml/,/^@end ifhtml/{ | |
s/^/@c (texi2dvi)/ | # cd_orig - Return to the original directory. |
| cd_orig () |
| { |
| # In case $orig_pwd is on a different drive (for DOS). |
| cd / |
| |
| # Return to the original directory so that |
| # - the next file is processed in correct conditions |
| # - the temporary file can be removed |
| cd "$orig_pwd" || exit 1 |
| |
| rel= |
} |
} |
/^@ifnottex/,/^@end ifnottex/{ | |
s/^/@c (texi2dvi)/ | |
| # func_dirname FILE - Return the directory part of FILE. |
| func_dirname () |
| { |
| dirname "$1" 2>/dev/null \ |
| || { echo "$1" | $SED 's!/[^/]*$!!;s!^$!.!'; } |
} |
} |
/^@ifinfo/,/^@end ifinfo/{ | |
/^@node/p | |
/^@menu/,/^@end menu/p | # noext FILE - Return FILE with one extension removed: |
t | # foo.bar.baz -> foo.bar |
s/^/@c (texi2dvi)/ | noext () |
| { |
| echo "$1" | $SED -e 's/\.[^/.][^/.]*$//' |
} |
} |
s/^@ifnotinfo/@c texi2dvi@ifnotinfo/ |
|
s/^@end ifnotinfo/@c texi2dvi@end ifnotinfo/ |
|
EOF |
|
# Uncommenting is simple: Remove any leading `@c texi2dvi'. |
|
uncomment_iftex_sed=$utildir/uncomment.sed |
|
cat <<EOF >$uncomment_iftex_sed |
|
s/^@c texi2dvi// |
|
EOF |
|
|
|
# A shell script that computes the list of xref files. |
|
# Takes the filename (without extension) of which we look for xref |
|
# files as argument. The index files must be reported last. |
|
get_xref_files=$utildir/get_xref.sh |
|
cat <<\EOF >$get_xref_files |
|
#! /bin/sh |
|
|
|
# Get list of xref files (indexes, tables and lists). | # absolute NAME - Return an absolute path to NAME. |
# Find all files having root filename with a two-letter extension, | absolute () |
# saves the ones that are really Texinfo-related files. .?o? catches | { |
# many files: .toc, .log, LaTeX tables and lists, FiXme's .lox, maybe more. | case $1 in |
for this_file in "$1".?o? "$1".aux "$1".?? "$1".idx; do | [\\/]* | ?:[\\/]*) |
# If file is empty, skip it. | # Absolute paths don't need to be expanded. |
test -s "$this_file" || continue | echo "$1" |
# If the file is not suitable to be an index or xref file, don't | ;; |
# process it. The file can't be if its first character is not a | *) absolute_slashes=`echo "$1" | $SED -n 's,.*[^/]\(/*\)$,\1,p'` |
# backslash or single quote. | absolute_rel=$orig_pwd/`func_dirname "$1"` |
first_character=`sed -n '1s/^\(.\).*$/\1/p;q' $this_file` | if test -d "$absolute_rel"; then |
if test "x$first_character" = "x\\" \ | (cd "$absolute_rel" 2>/dev/null \ |
|| test "x$first_character" = "x'"; then | && absolute_name=`pwd`/`basename "$1"`"$absolute_slashes" |
xref_files="$xref_files ./$this_file" | echo "$absolute_name") |
fi | else |
done | error 1 "not a directory: $absolute_rel" |
echo "$xref_files" | fi |
EOF | ;; |
chmod 500 $get_xref_files | esac |
| } |
|
|
# File descriptor usage: |
|
# 0 standard input |
|
# 1 standard output (--verbose messages) |
|
# 2 standard error |
|
# 3 some systems may open it to /dev/tty |
|
# 4 used on the Kubota Titan |
|
# 5 tools output (turned off by --quiet) |
|
|
|
# Tools' output. If quiet, discard, else redirect to the message flow. | # ensure_dir DIR1 DIR2... - Make sure given directories exist. |
if test "$quiet" = t; then | ensure_dir () |
exec 5>/dev/null | { |
else | for dir |
exec 5>&1 | do |
fi | # Beware that in parallel builds we may have several concurrent |
| # attempts to create the directory. So fail only if "mkdir" |
| # failed *and* the directory still does not exist. |
| test -d "$dir" \ |
| || mkdir "$dir" \ |
| || test -d "$dir" \ |
| || error 1 "cannot create directory: $dir" |
| done |
| } |
|
|
# Enable tracing |
|
test "$debug" = t && set -x |
|
|
|
# | # error EXIT_STATUS LINE1 LINE2... - Report an error and exit with |
# TeXify files. | # failure if EXIT_STATUS is non-null. |
| error () |
| { |
| error_status="$1" |
| shift |
| report "$@" |
| if test "$error_status" != 0; then |
| exit $error_status |
| fi |
| } |
|
|
for command_line_filename in ${1+"$@"}; do |
|
$verbose "Processing $command_line_filename ..." |
|
|
|
# If the COMMAND_LINE_FILENAME is not absolute (e.g., --debug.tex), | # findprog PROG - Return true if PROG is somewhere in PATH, else false. |
# prepend `./' in order to avoid that the tools take it as an option. | findprog () |
echo "$command_line_filename" | $EGREP '^(/|[A-z]:/)' >/dev/null \ | { |
|| command_line_filename="./$command_line_filename" | saveIFS="$IFS" |
| IFS=$path_sep # break path components at the path separator |
| for dir in $PATH; do |
| IFS=$saveIFS |
| # The basic test for an executable is `test -f $f && test -x $f'. |
| # (`test -x' is not enough, because it can also be true for directories.) |
| # We have to try this both for $1 and $1.exe. |
| # |
| # Note: On Cygwin and DJGPP, `test -x' also looks for .exe. On Cygwin, |
| # also `test -f' has this enhancement, but not on DJGPP. (Both are |
| # design decisions, so there is little chance to make them consistent.) |
| # Thusly, it seems to be difficult to make use of these enhancements. |
| # |
| if { test -f "$dir/$1" && test -x "$dir/$1"; } \ |
| || { test -f "$dir/$1.exe" && test -x "$dir/$1.exe"; }; then |
| return 0 |
| fi |
| done |
| return 1 |
| } |
|
|
# See if the file exists. If it doesn't we're in trouble since, even | # report LINE1 LINE2... - Echo each argument to stderr. |
# though the user may be able to reenter a valid filename at the tex | report () |
# prompt (assuming they're attending the terminal), this script won't | { |
# be able to find the right xref files and so forth. | for i in "$@" |
if test ! -r "$command_line_filename"; then | do |
echo "$0: Could not read $command_line_filename, skipping." >&2 | echo >&2 "$0: $i" |
continue | done |
fi | } |
|
|
# Get the name of the current directory. We want the full path |
|
# because in clean mode we are in tmp, in which case a relative |
|
# path has no meaning. |
|
filename_dir=`echo $command_line_filename | sed 's!/[^/]*$!!;s!^$!.!'` |
|
filename_dir=`cd "$filename_dir" >/dev/null && pwd` |
|
|
|
# Strip directory part but leave extension. | # run COMMAND-LINE - Run COMMAND-LINE verbosely, catching errors as failures. |
filename_ext=`basename "$command_line_filename"` | run () |
# Strip extension. | { |
filename_noext=`echo "$filename_ext" | sed 's/\.[^.]*$//'` | verbose "Running $@" |
ext=`echo "$filename_ext" | sed 's/^.*\.//'` | "$@" 2>&5 1>&2 \ |
| || error 1 "$1 failed" |
| } |
|
|
# _src. Use same basename since we want to generate aux files with |
|
# the same basename as the manual. If --expand, then output the |
|
# macro-expanded file to here, else copy the original file. |
|
tmpdir_src=$tmpdir/src |
|
filename_src=$tmpdir_src/$filename_noext.$ext |
|
|
|
# _xtr. The file with the user's extra commands. | # verbose WORD1 WORD2... - Echo concatenated WORDs to stderr, if $verb. |
tmpdir_xtr=$tmpdir/xtr | verbose () |
filename_xtr=$tmpdir_xtr/$filename_noext.$ext | { |
| if $verb; then |
| echo >&2 "$0: $@" |
| fi |
| } |
|
|
# _bak. Copies of the previous xref files (another round is run if |
|
# they differ from the new one). |
|
tmpdir_bak=$tmpdir/bak |
|
|
|
# Make all those directories and give up if we can't succeed. | # Handling lists. |
mkdir $tmpdir_src $tmpdir_xtr $tmpdir_bak || exit 1 | # |
| # list_append LIST-NAME ELEM - Append ELEM to (the contents of) LIST-NAME. |
| list_append () |
| { |
| list_name="$1" |
| shift |
| eval set X \$$list_name "$@" |
| shift |
| eval $list_name=\""$@"\" |
| } |
|
|
# Source file might include additional sources. |
|
# We want `.:$orig_pwd' before anything else. (We'll add `.:' later |
|
# after all other directories have been turned into absolute paths.) |
|
# `.' goes first to ensure that any old .aux, .cps, |
|
# etc. files in ${directory} don't get used in preference to fresher |
|
# files in `.'. Include orig_pwd in case we are in clean mode, where |
|
# we've cd'd to a temp directory. |
|
common="$orig_pwd$path_sep$filename_dir$path_sep$txincludes" |
|
TEXINPUTS="$common$TEXINPUTS_orig" |
|
INDEXSTYLE="$common$INDEXSTYLE_orig" |
|
|
|
# Convert relative paths to absolute paths, so we can run in another | # list_concat_dirs LIST-NAME DIR-LIST - Append to LIST-NAME all the |
# directory (e.g., in --clean mode, or during the macro-support | # components (including empty ones) from the $path_sep-separated list |
# detection.) | # DIR-LIST. Make the paths absolute. |
# | list_concat_dirs () |
# Empty path components are meaningful to tex. We rewrite them | { |
# as `EMPTY' so they don't get lost when we split on $path_sep. | lcd_list="$1" |
TEXINPUTS=`echo $TEXINPUTS |sed 's/^:/EMPTY:/;s/:$/:EMPTY/;s/::/:EMPTY:/g'` | # Empty path components are meaningful to tex. We rewrite them as |
INDEXSTYLE=`echo $INDEXSTYLE |sed 's/^:/EMPTY:/;s/:$/:EMPTY/;s/::/:EMPTY:/g'` | # `EMPTY' so they don't get lost when we split on $path_sep. |
| # Hopefully no one will have an actual directory named EMPTY. |
| lcd_replace_EMPTY="-e 's/^$path_sep/EMPTY$path_sep/g' \ |
| -e 's/$path_sep\$/${path_sep}EMPTY/g' \ |
| -e 's/$path_sep$path_sep/${path_sep}EMPTY${path_sep}/g'" |
save_IFS=$IFS |
save_IFS=$IFS |
IFS=$path_sep |
IFS=$path_sep |
set x $TEXINPUTS; shift | set x `echo "$2" | eval $SED $lcd_replace_EMPTY`; shift |
TEXINPUTS=. | IFS=$save_IFS |
for dir | for lcd_dir |
do |
do |
case $dir in | case $lcd_dir in |
EMPTY) |
EMPTY) |
TEXINPUTS=$TEXINPUTS$path_sep | list_append $lcd_list "" |
;; | ;; |
[\\/]* | ?:[\\/]*) # Absolute paths don't need to be expansed. | |
TEXINPUTS=$TEXINPUTS$path_sep$dir | |
;; | |
*) |
*) |
abs=`cd "$dir" && pwd` && TEXINPUTS=$TEXINPUTS$path_sep$abs | if test -d $lcd_dir; then |
;; | dir=`absolute "$lcd_dir"` |
| list_append $lcd_list "$lcd_dir" |
| fi |
| ;; |
esac |
esac |
done |
done |
set x $INDEXSTYLE; shift | } |
INDEXSTYLE=. | |
| |
| # list_prefix LIST-NAME SEP -> STRING - Return string with each element |
| # of LIST-NAME preceded by SEP. |
| list_prefix () |
| { |
| lp_separator="$2" |
| eval set X \$$1 |
| shift |
| lp_result='' |
| for i |
| do |
| lp_result="$lp_result \"$lp_separator\" \"$i\"" |
| done |
| echo "$lp_result" |
| } |
| |
| # list_infix LIST-NAME SEP -> STRING - Same as list_prefix, but a separator. |
| list_infix () |
| { |
| eval set X \$$1 |
| shift |
| save_IFS="$IFS" |
| IFS=$path_sep |
| echo "$*" |
| IFS=$save_IFS |
| } |
| |
| # list_dir_to_abs LIST-NAME - Convert list to using only absolute dir names. |
| # Currently unused, but should replace absolute_filenames some day. |
| list_dir_to_abs () |
| { |
| ldta_list="$1" |
| eval set X \$$ldta_list |
| shift |
| ldta_result='' |
for dir |
for dir |
do |
do |
|
dir=`absolute "$dir"` |
|
test -d "$dir" || continue |
|
ldta_result="$ldata_result \"$dir\"" |
|
done |
|
set X $ldta_result; shift |
|
eval $ldta_list=\"$@\" |
|
} |
|
|
|
|
|
# Language auxiliary functions. |
|
# |
|
# out_lang_set LANG - set $out_lang to LANG (dvi, pdf, etc.), or error. |
|
out_lang_set () |
|
{ |
|
case $1 in |
|
dvi|dvipdf|html|info|pdf|ps|text) out_lang=$1;; |
|
*) error 1 "invalid output format: $1";; |
|
esac |
|
} |
|
|
|
# out_lang_tex - Return the tex output language (DVI or PDF) for $out_lang. |
|
out_lang_tex () |
|
{ |
|
case $out_lang in |
|
dvi | ps | dvipdf ) echo dvi;; |
|
pdf ) echo $out_lang;; |
|
html | info | text ) echo $out_lang;; |
|
*) error 1 "invalid out_lang: $1";; |
|
esac |
|
} |
|
|
|
# out_lang_ext - Return the extension for $out_lang (pdf, dvi, etc.). |
|
out_lang_ext () |
|
{ |
|
case $out_lang in |
|
dvipdf ) echo pdf;; |
|
dvi | html | info | pdf | ps | text ) echo $out_lang;; |
|
*) error 1 "invalid out_lang: $1";; |
|
esac |
|
} |
|
|
|
|
|
# TeX file auxiliary functions. |
|
# |
|
# absolute_filenames TEX-PATH -> TEX-PATH - Convert relative paths to |
|
# absolute, so we can run in another directory (e.g., in tidy build |
|
# mode, or during the macro-support detection). |
|
absolute_filenames () |
|
{ |
|
# Empty path components are meaningful to tex. We rewrite them as |
|
# `EMPTY' so they don't get lost when we split on $path_sep. |
|
# Hopefully no one will have an actual directory named EMPTY. |
|
af_replace_empty="-e 's/^$path_sep/EMPTY$path_sep/g' \ |
|
-e 's/$path_sep\$/${path_sep}EMPTY/g' \ |
|
-e 's/$path_sep$path_sep/${path_sep}EMPTY${path_sep}/g'" |
|
af_result=`echo "$1" | eval $SED $af_replace_empty` |
|
save_IFS=$IFS |
|
IFS=$path_sep |
|
set x $af_result; shift |
|
af_result= |
|
af_path_sep= |
|
for dir |
|
do |
case $dir in |
case $dir in |
EMPTY) |
EMPTY) |
INDEXSTYLE=$INDEXSTYLE$path_sep | af_result=$af_result$af_path_sep |
;; |
;; |
[\\/]* | ?:[\\/]*) # Absolute paths don't need to be expansed. |
|
INDEXSTYLE=$INDEXSTYLE$path_sep$dir |
|
;; |
|
*) |
*) |
abs=`cd "$dir" && pwd` && INDEXSTYLE=$INDEXSTYLE$path_sep$abs | if test -d "$dir"; then |
| af_result=$af_result$af_path_sep`absolute "$dir"` |
| else |
| # Even if $dir is not a directory, preserve it in the path. |
| # It might contain metacharacters that TeX will expand in |
| # turn, e.g., /some/path/{a,b,c}. This will not get the |
| # implicit absolutification of the path, but we can't help that. |
| af_result=$af_result$af_path_sep$dir |
| fi |
;; |
;; |
esac |
esac |
|
af_path_sep=$path_sep |
done |
done |
IFS=$save_IFS | echo "$af_result" |
| } |
|
|
# If the user explicitly specified the language, use that. | |
# Otherwise, if the first line is \input texinfo, assume it's texinfo. | # output_base_name FILE - Return the name of FILE, possibly renamed to |
# Otherwise, guess from the file extension. | # satisfy --output. FILE is local, i.e., without any directory part. |
if test -n "$set_language"; then | output_base_name () |
language=$set_language | { |
elif sed 1q "$command_line_filename" | grep 'input texinfo' >/dev/null; then | case $oname in |
language=texinfo | '') echo "$1";; |
| *) obn_out_noext=`noext "$oname"` |
| obn_file_ext=`echo "$1" | $SED 's/^.*\.//'` |
| echo "$obn_out_noext.$obn_file_ext" |
| ;; |
| esac |
| } |
| |
| |
| # destdir - Return the directory where the output is expected. |
| destdir () |
| { |
| case $oname in |
| '') echo "$orig_pwd";; |
| *) dirname "$oname";; |
| esac |
| } |
| |
| |
| # move_to_dest FILE... - Move FILE(s) to the place where the user expects. |
| # Truly move it, that is, it must not remain in its build location |
| # unless that is also the output location. (Otherwise it might appear |
| # as an extra file in make distcheck.) |
| # |
| # FILE can be the principal output (in which case -o directly applies), |
| # or an auxiliary file with the same base name. |
| move_to_dest () |
| { |
| # echo "move_to_dest $*, tidy=$tidy, oname=$oname" |
| |
| # If we built in place and have no output name, there is nothing to |
| # do, so just return. |
| case $tidy:$oname in |
| false:) return;; |
| esac |
| |
| for file |
| do |
| test -f "$file" \ |
| || error 1 "no such file or directory: $file" |
| case $tidy:$oname in |
| true:) mtd_destdir=$orig_pwd |
| mtd_destfile=$mtd_destdir/$file;; |
| true:*) mtd_destfile=`output_base_name "$file"` |
| mtd_destdir=`dirname "$mtd_destfile"`;; |
| false:*) mtd_destfile=$oname |
| mtd_destdir=`dirname "$mtd_destfile"`;; |
| esac |
| |
| # We want to compare the source location and the output location, |
| # and if they are different, do the move. But if they are the |
| # same, we must preserve the source. Since we can't assume |
| # stat(1) or test -ef is available, resort to comparing the |
| # directory names, canonicalized with pwd. We can't use cmp -s |
| # since the output file might not actually change from run to run; |
| # e.g., TeX DVI output is timestamped to only the nearest minute. |
| mtd_destdir=`cd "$mtd_destdir" && pwd` |
| mtd_destbase=`basename "$mtd_destfile"` |
| |
| mtd_sourcedir=`dirname "$file"` |
| mtd_sourcedir=`cd "$mtd_sourcedir" && pwd` |
| mtd_sourcebase=`basename "$file"` |
| |
| if test "$mtd_sourcedir/$mtd_sourcebase" != "$mtd_destdir/$mtd_destbase" |
| then |
| verbose "Moving $file to $mtd_destfile" |
| rm -f "$mtd_destfile" |
| mv "$file" "$mtd_destfile" |
| fi |
| done |
| } |
| |
| |
| # Managing xref files. |
| # |
| # aux_file_p FILE - Echo FILE if FILE is an aux file. |
| aux_file_p () |
| { |
| test -f "$1" || return 0 |
| case $1 in |
| *.aux) echo "$1";; |
| *) return 0;; |
| esac |
| } |
| |
| # bibaux_file_p FILE - Echo FILE if FILE contains citation requests. |
| bibaux_file_p () |
| { |
| test -s "$1" || return 0 |
| if (grep '^\\bibstyle[{]' "$1" \ |
| && grep '^\\bibdata[{]' "$1" \ |
| ## The following line is suspicious: fails when there |
| ## are citations in sub aux files. We need to be |
| ## smarter in this case. |
| ## && grep '^\\citation[{]' "$f" |
| ) >&6 2>&1; |
| then |
| echo "$1" |
| fi |
| return 0 |
| } |
| |
| # index_file_p FILE - Echo FILE if FILE is an index file. |
| index_file_p () |
| { |
| test -f "$1" || return 0 |
| case $in_lang:$latex2html:`out_lang_tex`:`$SED '1q' "$1"` in |
| # When working with TeX4HT, *.idx are created by LaTeX. They must |
| # be processed to produce *.4ix, *.4dx files. The *.4dx file is |
| # passed to makeindex to produce the *.ind file. This sequence is |
| # handled by run_index, so we are only interested in the *.idx |
| # files, which have each "\indexentry" preceded by a |
| # "\beforeentry". |
| latex:tex4ht:html:"\\beforeentry {"*) echo $1;; |
| |
| # When index.sty is used, there is a space before the brace. |
| latex:*:*:"\\indexentry{"*|latex:*:*:"\\indexentry {"*) echo $1;; |
| |
| texinfo:*:*:"\\entry{"*) echo $1;; |
| texinfo:*:*:"@entry{"*) echo $1;; |
| # @entry is output from newer versions of texinfo.tex |
| esac |
| return 0 |
| } |
| |
| ########### not used currently |
| # xref_file_p FILE - Return success if FILE is an xref file (indexes, |
| # tables and lists). |
| xref_file_p () |
| { |
| test -f "$1" || return 1 |
| # If the file is not suitable to be an index or xref file, don't |
| # process it. It's suitable if the first character is a |
| # backslash or right quote or at, as long as the first line isn't |
| # \input texinfo. |
| case `$SED '1q' "$1"` in |
| "\\input texinfo"*) return 1;; |
| [\\''@]*) return 0;; |
| *) return 1;; |
| esac |
| } |
| |
| |
| # Used in generated_files_get |
| generated_files_get_from_log () |
| { |
| if test -f "$1.log"; then |
| # Usually the output is like: \openout1 = `foobar.tex'. |
| # (including the final period) |
| # but luatex outputs: \openout1 = foobar.tex |
| # (no quotes, no period). |
| # So we have to make the punctuation optional. |
| grep '^\\openout[0-9]' "$1.log" \ |
| | $SED -e "s/\\\\openout[^=]*= *[\`']*//" \ |
| -e "s/'\.$//" |
| fi |
| } |
| |
| # Used in generated_files_get |
| generated_files_get_from_fls () |
| { |
| if test -f "$1.fls"; then |
| grep '^OUTPUT ' "$1.fls" | cut -b 8- \ |
| | grep -v '\.dvi$' | grep -v '\.log$' | grep -v '\.pdf$' || true |
| fi |
| } |
| |
| # generated_files_get - Output the list of files generated by the TeX |
| # compilation. |
| generated_files_get () |
| { |
| $generated_files_get_method "$in_noext" |
| if test $generated_files_get_method = generated_files_get_from_fls; then |
| if test -r "$in_noext.fl"; then |
| report 'WARNING!! The fl index may typeset as garbage!' # goes to stderr |
| report 'Try upgrading your version of texinfo.tex, or else try setting' |
| report 'the environment variable TEXI2DVI_USE_RECORDER to '\''no'\''.' |
| report 'Once you'\''ve done that, delete the file with an '\''fl'\'' extension.' |
| fi |
| fi |
| } |
| |
| |
| # xref_files_save - set xref_files_orig from xref_files_new, and save xref |
| # files in $work_bak. |
| xref_files_save () |
| { |
| # Save copies of auxiliary files for later comparison. |
| xref_files_orig=$xref_files_new |
| if test -n "$xref_files_orig"; then |
| verbose "Backing up xref files: $xref_files_orig" |
| # The following line improves `cp $xref_files_orig "$work_bak"' |
| # by preserving the directory parts. Think of |
| # cp chap1/main.aux chap2/main.aux $work_bak. |
| # |
| # Users may have, e.g., --keep-old-files. Don't let this interfere. |
| # (Don't use unset for the sake of ancient shells.) |
| TAR_OPTIONS=; export TAR_OPTIONS |
| tar cf - $xref_files_orig | (cd "$rel$work_bak" && tar xf -) |
| fi |
| |
| # Remove auxiliary files in same directory as main input file. Otherwise, |
| # these will likely be read instead of those in the build dir. |
| if $tidy ; then |
| secondary_xref_files=`sorted_index_files` |
| for f in $xref_files_new $secondary_xref_files ; do |
| if test -f "$rel$in_dir/$f" ; then |
| remove $rel$in_dir/$f |
| fi |
| done |
| fi |
| } |
| |
| |
| # xref_files_changed - Return success if the xref files have changed |
| # since the previous run. |
| xref_files_changed () |
| { |
| # LaTeX (and the package changebar) report in the LOG file if it |
| # should be rerun. This is needed for files included from |
| # subdirs, since texi2dvi does not try to compare xref files in |
| # subdirs. Performing xref files test is still good since LaTeX |
| # does not report changes in xref files. |
| if grep "Rerun to get" "$in_noext.log" >&6 2>&1; then |
| return 0 |
| fi |
| # Similarly, check for biblatex report of whether rerunning is needed. |
| if grep "biblatex.*(re)run" "$in_noext.log" >&6 2>&1; then |
| return 0 |
| fi |
| |
| # If old and new lists don't have the same file list, |
| # then something has definitely changed. |
| xref_files_new=`generated_files_get` |
| verbose "Original xref files = $xref_files_orig" |
| verbose "New xref files = $xref_files_new" |
| if test "x$xref_files_orig" != "x$xref_files_new"; then |
| return 0 |
| fi |
| |
| # Compare each file until we find a difference. |
| for this_file in $xref_files_new; do |
| verbose "Comparing xref file `echo $this_file | $SED 's|\./||g'` ..." |
| # cmp -s returns nonzero exit status if files differ. |
| if cmp -s "$this_file" "$rel$work_bak/$this_file"; then :; else |
| verbose "xref file `echo $this_file | $SED 's|\./||g'` differed ..." |
| if $debug; then |
| diff -u "$rel$work_bak/$this_file" "$this_file" |
| fi |
| return 0 |
| fi |
| done |
| |
| secondary_xref_files=`sorted_index_files` |
| verbose "Secondary xref files = $secondary_xref_files" |
| for this_file in $secondary_xref_files; do |
| if test -f $this_file; then :; else |
| verbose "$this_file missing ..." |
| return 0 |
| fi |
| done |
| |
| # No change. |
| return 1 |
| } |
| |
| # Running the TeX suite. |
| # |
| # Set tex_cmd variable, for running TeX. |
| make_tex_cmd () |
| { |
| case $in_lang:$latex2html:`out_lang_tex` in |
| latex:*:dvi|latex:tex4ht:html) |
| tex=${LATEX:-latex};; |
| latex:*:pdf) |
| tex=${PDFLATEX:-pdflatex};; |
| texinfo:*:dvi) |
| # MetaPost also uses the TEX environment variable. If the user |
| # has set TEX=latex for that reason, don't bomb out. |
| case $TEX in |
| *latex) tex=tex;; # don't bother trying to find etex |
| *) tex=$TEX |
| esac;; |
| texinfo:*:pdf) tex=$PDFTEX;; |
| *) error 1 "$out_lang not supported for $in_lang";; |
| esac |
| |
| # Beware of aux files in subdirectories that require the |
| # subdirectory to exist. |
| case $in_lang:$tidy in |
| latex:true) |
| $SED -n 's|^[ ]*\\include{\(.*\)/.*}.*|\1|p' "$in_input" | |
| sort -u | |
| while read d |
| do |
| ensure_dir "$work_build/$d" |
| done |
| ;; |
| esac |
| |
| # Note that this will be used via an eval: quote properly. |
| tex_cmd="$tex" |
| |
| # If possible, make TeX report error locations in GNU format. |
| if $line_error; then |
| if test "${tex_help:+set}" != set; then |
| # Go to a temporary directory to try --help, since old versions that |
| # don't accept --help will generate a texput.log. |
| tex_help_dir=$t2ddir/tex_help |
| ensure_dir "$tex_help_dir" |
| tex_help=`cd "$tex_help_dir" >&6 && $tex --help </dev/null 2>&1 || true` |
| fi |
| # The mk program and perhaps others want to parse TeX's |
| # original error messages. |
| case $tex_help in |
| *file-line-error*) tex_cmd="$tex_cmd --file-line-error";; |
| esac |
| fi |
| |
| # Tell TeX about -recorder option, if specified |
| # recorder_option_maybe is in { " -recorder", "" } |
| tex_cmd="$tex_cmd$recorder_option_maybe" |
| |
| |
| # Tell TeX about TCX file, if specified. |
| test -n "$translate_file" \ |
| && tex_cmd="$tex_cmd --translate-file=$translate_file" |
| |
| # Tell TeX to make source specials (for backtracking from output to |
| # source, given a sufficiently smart editor), if specified. |
| test -n "$src_specials" && tex_cmd="$tex_cmd $src_specials" |
| |
| # Tell TeX to allow running external executables |
| test -n "$shell_escape" && tex_cmd="$tex_cmd $shell_escape" |
| |
| # Run without interaction. |
| # \batchmode does not show terminal output at all, so we don't |
| # want that. And even in batch mode, TeX insists on having input |
| # from the user. Close its stdin to make it impossible. |
| tex_cmd="$tex_cmd </dev/null '${escape}nonstopmode'" |
| } |
| |
| |
| # run_tex - Run TeX, taking care of errors and logs. |
| run_tex () |
| { |
| # Check for any unusual characters in the filename. |
| # However, >, \ and any whitespace characters are not supported |
| # filenames. |
| in_input_funnies=`echo "$in_input" \ |
| | $SED -e 's![^}#$%&^_{~]!!g' -e 's!\(.\)!\1\'' |
| !g' | uniq` |
| |
| if test -n "$in_input_funnies" ; then |
| # Make > an end group character, as it's unlikely to appear in |
| # a filename. |
| tex_cmd="$tex_cmd '${escape}bgroup${escape}catcode62=2${escape}relax'" |
| |
| # If the filename has funny characters, change the TeX category codes of |
| # some characters within a group, and use \expandafter to input the file |
| # outside of the group. |
| for w in $in_input_funnies ; do |
| tex_cmd="$tex_cmd '${escape}catcode\`${escape}$w=12${escape}relax'" |
| done |
| |
| # Set \toks0 to "\input FILENAME\relax" |
| tex_cmd="$tex_cmd '${escape}toks0${escape}bgroup${escape}input' '$rel$in_input' '${escape}relax>" |
| |
| # Expand \toks0 after the end of the group |
| tex_cmd="$tex_cmd${escape}expandafter${escape}egroup" |
| tex_cmd="$tex_cmd${escape}the${escape}toks0${escape}relax'" |
else |
else |
language= | # In the case of a simple filename, just pass the filename |
| # with no funny tricks. |
| tex_cmd="$tex_cmd '${escape}input' '$rel$in_input'" |
fi |
fi |
|
|
# Get the type of the file (latex or texinfo) from the given language | verbose "$0: Running $tex_cmd ..." |
# we just guessed, or from the file extension if not set yet. | if (eval "$tex_cmd" >&5); then |
case ${language:-$filename_ext} in | case $out_lang in |
[lL]a[tT]e[xX] | *.ltx | *.tex) | dvi | pdf ) move_to_dest "$in_noext.$out_lang";; |
# Assume a LaTeX file. LaTeX needs bibtex and uses latex for | esac |
# compilation. No makeinfo. | else |
bibtex=${BIBTEX:-bibtex} | tex_failed=true |
makeinfo= # no point in running makeinfo on latex source. | fi |
texindex=${MAKEINDEX:-makeindex} | } |
if test $oformat = dvi; then | |
tex=${LATEX:-latex} | |
| # run_bibtex - Run bibtex (or biber) on current file |
| # - if its input (AUX) exists, |
| # - or if some citations are missing (LOG contains `Citation'), |
| # - or if the LOG complains of a missing .bbl. |
| # |
| # Don't try to be too smart: |
| # 1. Running bibtex only if the bbl file exists and is older than |
| # the LaTeX file is wrong, since the document might include files |
| # that have changed. |
| # |
| # 2. Because there can be several AUX (if there are \include's), |
| # but a single LOG, looking for missing citations in LOG is |
| # easier, though we take the risk of matching false messages. |
| run_bibtex () |
| { |
| case $in_lang in |
| latex) bibtex=${BIBTEX:-bibtex};; |
| texinfo) return;; |
| esac |
| |
| # "Citation undefined" is for LaTeX, "Undefined citation" for btxmac.tex. |
| # The no .aux && \bibdata test is also for btxmac, in case it was the |
| # first run of a bibtex-using document. Otherwise, it's possible that |
| # bibtex would never be run. |
| if test -r "$in_noext.aux" \ |
| && test -r "$in_noext.log" \ |
| && ( (grep 'Warning:.*Citation.*undefined' "$in_noext.log" \ |
| || grep '.*Undefined citation' "$in_noext.log" \ |
| || grep 'No file .*\.bbl\.' "$in_noext.log") \ |
| || (grep 'No \.aux file' "$in_noext.log" \ |
| && grep '^\\bibdata' "$in_noext.aux") ) \ |
| >&6 2>&1; \ |
| then |
| bibtex_aux=`filter_files bibaux_file_p` |
| for f in $bibtex_aux; do |
| run $bibtex "$f" |
| done |
| fi |
| |
| # biber(+biblatex) check. |
| if test -r "$in_noext.bcf" \ |
| && grep '</bcf:controlfile>' "$in_noext.bcf" >/dev/null; then |
| run ${BIBER:-biber} "$in_noext" |
| fi |
| } |
| |
| |
| # filter_file PREDICATE - Go through the list of files in xref_files_new |
| # and use PREDICATE on each one to optionally print it or print other files |
| # based on the filename. |
| filter_files () |
| { |
| test -n "$xref_files_new" || return 0 |
| echo "$xref_files_new" | |
| # Filter existing files matching the criterion. |
| # |
| while read file; do |
| $1 "$file" |
| done | |
| sort | |
| # Some files are opened several times, e.g., listings.sty's *.vrb. |
| uniq |
| } |
| |
| # run_index - Run texindex (or makeindex or texindy) on current index |
| # files. If they already exist, and after running TeX a first time the |
| # index files don't change, then there's no reason to run TeX again. |
| # But we won't know that if the index files are out of date or nonexistent. |
| run_index () |
| { |
| index_files=`filter_files index_file_p` |
| test -n "$index_files" \ |
| || return 0 |
| |
| : ${MAKEINDEX:=makeindex} |
| : ${TEXINDEX:=texindex} |
| : ${TEXINDY:=texindy} |
| |
| case $in_lang:$latex2html:`out_lang_tex` in |
| latex:tex4ht:html) |
| for index_file in $index_files |
| do |
| index_noext=`noext "$index_file"` |
| run tex \ |
| '\def\filename{{'"$index_noext"'}{idx}{4dx}{ind}} |
| \input idxmake.4ht' |
| run $MAKEINDEX -o $index_noext.ind $index_noext.4dx |
| done |
| ;; |
| |
| latex:*) |
| if $TEXINDY --version >&6 2>&1; then |
| run $TEXINDY $index_files |
else |
else |
tex=${PDFLATEX:-pdflatex} | run $MAKEINDEX $index_files |
fi |
fi |
;; |
;; |
|
|
*) | texinfo:*) |
# Assume a Texinfo file. Texinfo files need makeinfo, texindex and tex. | run $TEXINDEX $index_files |
bibtex= | ;; |
texindex=${TEXINDEX:-texindex} | esac |
if test $oformat = dvi; then | } |
tex=${TEX:-tex} | |
else | |
tex=${PDFTEX:-pdftex} | # run_tex4ht - Run the last two phases of TeX4HT: tex4ht extracts the |
| # HTML from the instrumented DVI file, and t4ht converts the figures and |
| # installs the files when given -d. |
| # |
| # Because knowing exactly which files are created is complex (in |
| # addition the names are not simple to compute), which makes it |
| # difficult to install the output files in a second step, we |
| # tell t4ht to install the output files. |
| run_tex4ht () |
| { |
| case $in_lang:$latex2html:`out_lang_tex` in |
| latex:tex4ht:html) |
| : ${TEX4HT:=tex4ht} ${T4HT:=t4ht} |
| run "$TEX4HT" "-f/$in_noext" |
| # Do not remove the / after the destdir. |
| run "$T4HT" "-d`destdir`/" "-f/$in_noext" |
| ;; |
| esac |
| } |
| |
| |
| # run_thumbpdf - Run thumbpdf. |
| run_thumbpdf () |
| { |
| if test `out_lang_tex` = pdf \ |
| && test -r "$in_noext.log" \ |
| && grep 'thumbpdf\.sty' "$in_noext.log" >&6 2>&1; \ |
| then |
| thumbpdf=${THUMBPDF_CMD:-thumbpdf} |
| thumbcmd="$thumbpdf $in_dir/$in_noext" |
| verbose "Running $thumbcmd ..." |
| if $thumbcmd >&5; then |
| run_tex |
| else |
| report "$thumbpdf exited with bad status." \ |
| "Ignoring its output." |
| fi |
| fi |
| } |
| |
| |
| # run_dvipdf FILE.dvi - Convert FILE.dvi to FILE.pdf. |
| run_dvipdf () |
| { |
| # Find which dvi->pdf program is available. |
| if test -n "$DVIPDF"; then |
| dvipdf=$DVIPDF # user envvar, use it without checking |
| |
| elif test -z "$dvipdf"; then |
| for i in dvipdfmx dvipdfm dvipdf dvi2pdf dvitopdf; do |
| if findprog $i; then |
| dvipdf=$i |
fi |
fi |
# Unless required by the user, makeinfo expansion is wanted only | done |
# if texinfo.tex is too old. | fi |
if test "$expand" = t; then | # These tools have varying interfaces, some 'input output', others |
makeinfo=${MAKEINFO:-makeinfo} | # 'input -o output'. They all seem to accept 'input' only, |
else | # outputting using the expected file name. |
# Check if texinfo.tex performs macro expansion by looking for | run $dvipdf "$1" |
# its version. The version is a date of the form YEAR-MO-DA. | if test ! -f `echo "$1" | $SED -e 's/\.dvi$/.pdf/'`; then |
# We don't need to use [0-9] to match the digits since anyway | error 1 "cannot find output file" |
# the comparison with $txiprereq, a number, will fail with non | fi |
# digits. | } |
txiversion_tex=txiversion.tex | |
echo '\input texinfo.tex @bye' >$tmpdir/$txiversion_tex | # run_tex_suite - Run the TeX tools until a stable point is reached. |
# Run in the tmpdir to avoid leaving files. | run_tex_suite () |
eval `cd $tmpdir >/dev/null && | { |
$tex $txiversion_tex 2>/dev/null | | make_tex_cmd |
sed -n 's/^.*\[\(.*\)version \(....\)-\(..\)-\(..\).*$/txiformat=\1 txiversion="\2\3\4"/p'` | |
$verbose "texinfo.tex preloaded as \`$txiformat', version is \`$txiversion' ..." | # Move to the working directory. |
if test "$txiprereq" -le "$txiversion" >/dev/null 2>&1; then | if $tidy; then |
makeinfo= | verbose "cd $work_build" |
else | cd_dir "$work_build" || exit 1 |
makeinfo=${MAKEINFO:-makeinfo} | fi |
fi | |
# As long as we had to run TeX, offer the user this convenience | # Count the number of cycles. |
if test "$txiformat" = Texinfo; then | suite_cycle=0 |
escape=@ | |
fi | # Start by checking the log files for what files were created last |
fi | # time. This will mean that if they don't change, we finish in 1 cycle. |
| xref_files_new=`generated_files_get` |
| xref_files_save |
| |
| while :; do |
| # check for (probably) LaTeX loop (e.g. varioref) |
| if test $suite_cycle -eq "$max_iters"; then |
| error 0 "Maximum of $max_iters cycles exceeded" |
| break |
| fi |
| |
| # report progress |
| suite_cycle=`expr $suite_cycle + 1` |
| verbose "Cycle $suite_cycle for $command_line_filename" |
| |
| tex_failed=false |
| run_core_conversion |
| xref_files_changed || break |
| xref_files_save |
| |
| # We run bibtex first, because it's more likely for the indexes |
| # to change after bibtex is run than the reverse, though either |
| # would be rare. |
| run_bibtex |
| run_index |
| done |
| |
| if $tex_failed ; then |
| # TeX failed, and the xref files did not change. |
| error 1 "$tex exited with bad status, quitting." |
| fi |
| |
| # If we were using thumbpdf and producing PDF, then run thumbpdf |
| # and TeX one last time. |
| run_thumbpdf |
| |
| # If we are using tex4ht, call it. |
| run_tex4ht |
| |
| # Install the result if we didn't already (i.e., if the output is |
| # dvipdf or ps). |
| case $latex2html:$out_lang in |
| *:dvipdf) |
| run_dvipdf "$in_noext.`out_lang_tex`" |
| move_to_dest "$in_noext.`out_lang_ext`" |
;; |
;; |
|
*:ps) |
|
: ${DVIPS:=dvips} |
|
run $DVIPS -o "$in_noext.`out_lang_ext`" "$in_noext.`out_lang_tex`" |
|
move_to_dest "$in_noext.`out_lang_ext`" |
|
;; |
esac |
esac |
|
|
# Expand macro commands in the original source file using Makeinfo. | cd_orig |
# Always use `end' footnote style, since the `separate' style | } |
# generates different output (arguably this is a bug in -E). | |
# Discard main info output, the user asked to run TeX, not makeinfo. | |
| # TeX processing auxiliary tools. |
| # |
| # run_makeinfo - Expand macro commands in the original source file using |
| # Makeinfo. Always use `end' footnote style, since the `separate' style |
| # generates different output (arguably this is a bug in -E). Discard |
| # main info output, the user asked to run TeX, not makeinfo. |
| run_makeinfo () |
| { |
| test $in_lang = texinfo \ |
| || return 0 |
| |
| # Unless required by the user, makeinfo expansion is wanted only |
| # if texinfo.tex is too old. |
| if $expand; then |
| makeinfo=${MAKEINFO:-makeinfo} |
| else |
| # Check if texinfo.tex performs macro expansion by looking for |
| # its version. The version is a date of the form YEAR-MO-DA. |
| # We don't need to use [0-9] to match the digits since anyway |
| # the comparison with $txiprereq, a number, will fail with non-digits. |
| # Run in a temporary directory to avoid leaving files. |
| version_test_dir=$t2ddir/version_test |
| ensure_dir "$version_test_dir" |
| if ( |
| cd "$version_test_dir" |
| echo '\input texinfo.tex @bye' >txiversion.tex |
| # Be sure that if tex wants to fail, it is not interactive: |
| # close stdin. |
| $TEX txiversion.tex </dev/null >txiversion.out 2>txiversion.err |
| ); then :; else |
| report "texinfo.tex appears to be broken. |
| This may be due to the environment variable TEX set to something |
| other than (plain) tex, a corrupt texinfo.tex file, or |
| to tex itself simply not working." |
| cat "$version_test_dir/txiversion.out" |
| cat "$version_test_dir/txiversion.err" >&2 |
| error 1 "quitting." |
| fi |
| eval `$SED -n 's/^.*\[\(.*\)version \(....\)-\(..\)-\(..\).*$/txiformat=\1 txiversion="\2\3\4"/p' "$version_test_dir/txiversion.out"` |
| verbose "texinfo.tex preloaded as \`$txiformat', version is \`$txiversion' ..." |
| if test "$txiprereq" -le "$txiversion" >&6 2>&1; then |
| makeinfo= |
| else |
| makeinfo=${MAKEINFO:-makeinfo} |
| fi |
| # If TeX is preloaded, offer the user this convenience: |
| if test "$txiformat" = Texinfo; then |
| escape=@ |
| fi |
| fi |
| |
if test -n "$makeinfo"; then |
if test -n "$makeinfo"; then |
$verbose "Macro-expanding $command_line_filename to $filename_src ..." | # in_src: the file with macros expanded. |
sed -f $comment_iftex_sed "$command_line_filename" \ | # Use the same basename to generate the same aux file names. |
| $makeinfo --footnote-style=end -I "$filename_dir" $miincludes \ | work_src=$workdir/src |
| ensure_dir "$work_src" |
| in_src=$work_src/$in_base |
| run_mi_includes=`list_prefix includes -I` |
| verbose "Macro-expanding $command_line_filename to $in_src ..." |
| # eval $makeinfo because it might be defined as something complex |
| # (running missing) and then we end up with things like '"-I"', |
| # and "-I" (including the quotes) is not an option name. This |
| # happens with gettext 0.14.5, at least. |
| $SED "$comment_iftex" "$command_line_filename" \ |
| | eval $makeinfo --footnote-style=end -I "$in_dir" $run_mi_includes \ |
-o /dev/null --macro-expand=- \ |
-o /dev/null --macro-expand=- \ |
| sed -f $uncomment_iftex_sed >"$filename_src" | | $SED "$uncomment_iftex" >"$in_src" |
filename_input=$filename_src | # Continue only if everything succeeded. |
| if test $? -ne 0 \ |
| || test ! -r "$in_src"; then |
| verbose "Expansion failed, ignored..."; |
| else |
| in_input=$in_src |
| fi |
fi |
fi |
|
} |
|
|
# If makeinfo failed (or was not even run), use the original file as input. | # Unfortunately, makeinfo --iftex --no-ifinfo doesn't work well enough |
if test $? -ne 0 \ | # in versions before 5.0, as makeinfo can't parse the TeX commands |
|| test ! -r "$filename_src"; then | # inside @tex blocks, so work around with sed. |
$verbose "Reverting to $command_line_filename ..." | # |
filename_input=$filename_dir/$filename_ext | # This sed script preprocesses Texinfo sources in order to keep the |
fi | # iftex sections only. We want to remove non-TeX sections, and comment |
| # (with `@c _texi2dvi') TeX sections so that makeinfo does not try to |
| # parse them. Nevertheless, while commenting TeX sections, don't |
| # comment @macro/@end macro so that makeinfo does propagate them. |
| # Similarly, preserve the @top node to avoid makeinfo complaining about |
| # it being missed. Comment it out after preprocessing, so that it does |
| # not appear in the generated document. |
| # |
| # We assume that `@c _texi2dvi' or `@c (_texi2dvi)' starting a line is |
| # not present in the document. Additionally, conditionally defined |
| # macros inside the @top node may end up with the wrong value, although |
| # this is unlikely in practice. |
| # |
| comment_iftex=\ |
| '/^@tex/,/^@end tex/{ |
| s/^/@c _texi2dvi/ |
| } |
| /^@iftex/,/^@end iftex/{ |
| s/^/@c _texi2dvi/ |
| /^@c _texi2dvi@macro/,/^@c _texi2dvi@end macro/{ |
| s/^@c _texi2dvi// |
| } |
| } |
| /^@ifnottex/,/^@end ifnottex/{ |
| s/^/@c (_texi2dvi)/ |
| /^@c (_texi2dvi)@node Top/,/^@c (_texi2dvi)@end ifnottex/ { |
| /^@c (_texi2dvi)@end ifnottex/b |
| s/^@c (_texi2dvi)// |
| } |
| } |
| /^@ifinfo/,/^@end ifinfo/{ |
| /^@node/p |
| /^@menu/,/^@end menu/p |
| t |
| s/^/@c (_texi2dvi)/ |
| } |
| s/^@ifnotinfo/@c _texi2dvi@ifnotinfo/ |
| s/^@end ifnotinfo/@c _texi2dvi@end ifnotinfo/' |
|
|
# Used most commonly for @finalout, @smallbook, etc. | # Uncomment @iftex blocks by removing any leading `@c texi2dvi' (repeated |
| # copies can sneak in via macro invocations). Likewise, comment out |
| # the @top node inside a @ifnottex block. |
| uncomment_iftex=\ |
| 's/^@c _texi2dvi\(@c _texi2dvi\)*// |
| /^@c (_texi2dvi)@ifnottex/,/^@c (_texi2dvi)@end ifnottex/{ |
| s/^/@c (_texi2dvi)/ |
| }' |
| |
| |
| # insert_commands - Insert $textra commands at the beginning of the file. |
| # Recommended to be used for @finalout, @smallbook, etc. |
| insert_commands () |
| { |
if test -n "$textra"; then |
if test -n "$textra"; then |
$verbose "Inserting extra commands: $textra" | # _xtr. The file with the user's extra commands. |
sed '/^@setfilename/a\ | work_xtr=$workdir/xtr |
'"$textra" "$filename_input" >$filename_xtr | in_xtr=$work_xtr/$in_base |
filename_input=$filename_xtr | ensure_dir "$work_xtr" |
| verbose "Inserting extra commands: $textra" |
| case $in_lang in |
| latex) textra_cmd=1i;; |
| texinfo) |
| textra_cmd='/^\\input texinfo/a' |
| # insert after @setfilename line if present |
| if head -n 10 $in_input | grep '^@setfilename' ; then |
| textra_cmd='/^@setfilename/a' |
| fi |
| ;; |
| *) error 1 "internal error, unknown language: $in_lang";; |
| esac |
| $SED "$textra_cmd\\ |
| $textra" "$in_input" >"$in_xtr" |
| in_input=$in_xtr |
fi |
fi |
|
|
# If clean mode was specified, then move to the temporary directory. | case $in_lang:$latex2html:`out_lang_tex` in |
if test "$clean" = t; then | latex:tex4ht:html) |
$verbose "cd $tmpdir_src" | # _tex4ht. The file with the added \usepackage{tex4ht}. |
cd "$tmpdir_src" || exit 1 | work_tex4ht=$workdir/tex4ht |
| in_tex4ht=$work_tex4ht/$in_base |
| ensure_dir "$work_tex4ht" |
| verbose "Inserting \\usepackage{tex4ht}" |
| perl -pe 's<\\documentclass(?:\[.*\])?{.*}> |
| <$&\\usepackage[xhtml]{tex4ht}>' \ |
| "$in_input" >"$in_tex4ht" |
| in_input=$in_tex4ht |
| ;; |
| esac |
| } |
| |
| |
| # compute_language FILENAME - Return the short string for the language |
| # in which FILENAME is written: `texinfo' or `latex'. |
| compute_language () |
| { |
| # If the user explicitly specified the language, use that. |
| # Otherwise, if the first line is \input texinfo, assume it's texinfo. |
| # Otherwise, guess from the file extension. |
| if test -n "$set_language"; then |
| echo $set_language |
| elif $SED 1q "$1" | grep 'input texinfo' >&6; then |
| echo texinfo |
| else |
| # Get the type of the file (latex or texinfo) from the given language |
| # we just guessed, or from the file extension if not set yet. |
| case $1 in |
| *.ltx | *.tex | *.drv | *.dtx) echo latex;; |
| *) echo texinfo;; |
| esac |
fi |
fi |
|
} |
|
|
while :; do # will break out of loop below |
|
orig_xref_files=`$get_xref_files "$filename_noext"` |
|
|
|
# Save copies of originals for later comparison. | # run_hevea (MODE) - Convert to HTML/INFO/TEXT. |
if test -n "$orig_xref_files"; then | # |
$verbose "Backing up xref files: `echo $orig_xref_files | sed 's|\./||g'`" | # Don't pass `-noiso' to hevea: it's useless in HTML since anyway the |
cp $orig_xref_files $tmpdir_bak | # charset is set to latin1, and troublesome in other modes since |
fi | # accented characters loose their accents. |
| # |
| # Don't pass `-o DEST' to hevea because in that case it leaves all its |
| # auxiliary files there too... Too bad, because it means we will need |
| # to handle images some day. |
| run_hevea () |
| { |
| run_hevea_name="${HEVEA:-hevea}" |
| run_hevea_cmd="$run_hevea_name" |
|
|
# Run bibtex on current file. | case $1 in |
# - If its input (AUX) exists. | html) ;; |
# - If AUX contains both `\bibdata' and `\bibstyle'. | text|info) run_hevea_cmd="$run_hevea_cmd -$1";; |
# - If some citations are missing (LOG contains `Citation'). | *) error 1 "run_hevea_cmd: invalid argument: $1";; |
# or the LOG complains of a missing .bbl | esac |
# | |
# We run bibtex first, because I can see reasons for the indexes | # Compiling to the tmp directory enables to preserve a previous |
# to change after bibtex is run, but I see no reason for the | # successful compilation. |
# converse. | run_hevea_cmd="$run_hevea_cmd -fix -O -o '$out_base'" |
# | run_hevea_cmd="$run_hevea_cmd `list_prefix includes -I` -I '$orig_pwd' " |
# Don't try to be too smart. Running bibtex only if the bbl file | run_hevea_cmd="$run_hevea_cmd '$rel$in_input'" |
# exists and is older than the LaTeX file is wrong, since the | |
# document might include files that have changed. Because there | if $debug; then |
# can be several AUX (if there are \include's), but a single LOG, | run_hevea_cmd="$run_hevea_cmd -v -v" |
# looking for missing citations in LOG is easier, though we take | fi |
# the risk to match false messages. | |
if test -n "$bibtex" \ | verbose "running $run_hevea_cmd" |
&& test -r "$filename_noext.aux" \ | if eval "$run_hevea_cmd" >&5; then |
&& test -r "$filename_noext.log" \ | # hevea leaves trailing white spaces, this is annoying. |
&& (grep '^\\bibdata[{]' "$filename_noext.aux" \ | case $1 in text|info) |
&& grep '^\\bibstyle[{]' "$filename_noext.aux" \ | perl -pi -e 's/[ \t]+$//g' "$out_base"*;; |
&& (grep 'Warning:.*Citation.*undefined' "$filename_noext.log" \ | esac |
|| grep 'No file .*\.bbl\.' "$filename_noext.log")) \ | case $1 in |
>/dev/null 2>&1; \ | html|text) move_to_dest "$out_base";; |
then | info) # There can be foo.info-1, foo.info-2 etc. |
$verbose "Running $bibtex $filename_noext ..." | move_to_dest "$out_base"*;; |
if $bibtex "$filename_noext" >&5; then :; else | esac |
echo "$0: $bibtex exited with bad status, quitting." >&2 | else |
exit 1 | error 1 "$run_hevea_name exited with bad status, quitting." |
| fi |
| } |
| |
| |
| # run_core_conversion - Run TeX (or HeVeA). |
| run_core_conversion () |
| { |
| case $in_lang:$latex2html:`out_lang_tex` in |
| *:dvi|*:pdf|latex:tex4ht:html) |
| run_tex;; |
| latex:*:html|latex:*:text|latex:*:info) |
| run_hevea $out_lang;; |
| *) |
| error 1 "invalid input/output combination: $in_lang/$out_lang";; |
| esac |
| } |
| |
| |
| # compile - Run the full compilation chain, from pre-processing to |
| # installation of the output at its expected location. |
| compile () |
| { |
| # Set include path for tools: |
| # . Include current directory in case there are files there already, so |
| # we don't have more TeX runs than necessary. orig_pwd is used in case |
| # we are in clean build mode, where we have cd'd to a temp directory. |
| # . Include directory containing file, in case there are other |
| # files @include'd. |
| # . Keep a final path_sep to get the default (system) TeX |
| # directories included. |
| # . If we have any includes, put those at the end. |
| |
| common="$orig_pwd$path_sep$in_dir$path_sep" |
| # |
| txincludes=`list_infix includes $path_sep` |
| test -n "$txincludes" && common="$common$txincludes$path_sep" |
| # |
| for var in $tex_envvars; do |
| eval val="\$common\$${var}_orig" |
| # Convert relative paths to absolute paths, so we can run in another |
| # directory (e.g., in clean build mode, or during the macro-support |
| # detection). |
| val=`absolute_filenames "$val"` |
| eval $var="\"$val\"" |
| export $var |
| eval verbose \"$var=\'\$${var}\'\" |
| done |
| |
| # --expand |
| run_makeinfo |
| |
| # --command, --texinfo |
| insert_commands |
| |
| # Run until a fixed point is reached. |
| run_tex_suite |
| } |
| |
| # make_openout_test FLAGS EXTENSION |
| # - Run TeX with an input file that performs an \openout. Pass FLAGS to TeX. |
| # |
| make_openout_test () |
| { |
| recorder_option_maybe="$1" |
| make_tex_cmd |
| |
| ensure_dir "$workdir"/check_recorder |
| cd_dir "$workdir"/check_recorder |
| |
| cat > openout.tex <<EOF |
| \newwrite\ourwrite |
| \immediate\openout\ourwrite dum.dum |
| \bye |
| EOF |
| # \bye doesn't work for LaTeX, but it will cause latex |
| # to exit with an input error. |
| tex_cmd="$tex_cmd '${escape}input' ./openout.tex" |
| # ./ in case . isn't in path |
| verbose "$0: running $tex_cmd ..." |
| rm -fr "openout.$2" |
| (eval "$tex_cmd" >/dev/null 2>&1) |
| } |
| |
| # Check tex supports -recorder option |
| check_recorder_support () |
| { |
| verbose "Checking TeX recorder support..." |
| make_openout_test " -recorder" fls |
| if test -f openout.fls && grep '^OUTPUT dum.dum$' openout.fls > /dev/null |
| then |
| cd_orig |
| verbose "Checking TeX recorder support... yes" |
| return 0 |
| else |
| cd_orig |
| verbose "Checking TeX recorder support... no" |
| return 1 |
| fi |
| } |
| |
| # Check tex supports \openout traces in log |
| check_openout_in_log_support () |
| { |
| verbose "Checking TeX \openout in log support..." |
| make_openout_test "" log |
| if test -f openout.log \ |
| && grep '^\\openout..\? *= *`\?dum\.dum'\''\?' openout.log >/dev/null |
| then |
| cd_orig |
| verbose "Checking TeX \openout in log support... yes" |
| return 0 |
| else |
| cd_orig |
| verbose "Checking TeX \openout in log support... no" |
| return 1 |
| fi |
| } |
| |
| # Set that output auxiliary files are detected with the -recorder option, |
| # which creates a file JOBNAME.fls which is a machine-readable listing of |
| # files read and written during the job. |
| set_aux_files_from_fls () |
| { |
| recorder_option_maybe=" -recorder" |
| generated_files_get_method=generated_files_get_from_fls |
| } |
| |
| # Set that output auxiliary files are detected with searching for \openout |
| # in the log file. |
| set_aux_files_from_log () |
| { |
| recorder_option_maybe='' |
| generated_files_get_method=generated_files_get_from_log |
| } |
| |
| # Decide whether output auxiliary files are detected with the -recorder |
| # option, or by searching for \openout in the log file. |
| decide_aux_files_method () |
| { |
| # Select output file detection method |
| # Valid values of TEXI2DVI_USE_RECORDER are: |
| # yes use the -recorder option, no checks. |
| # no scan for \openout in the log file, no checks. |
| # yesmaybe check whether -recorder option is supported, and if yes |
| # use it, otherwise check for tracing \openout in the |
| # log file is supported, and if yes use it, else it is an |
| # error. |
| # nomaybe same as `yesmaybe', except that the \openout trace in |
| # log file is checked first. |
| # |
| # The default behaviour is `nomaybe'. |
| |
| test -n "$TEXI2DVI_USE_RECORDER" || TEXI2DVI_USE_RECORDER=nomaybe |
| |
| case $TEXI2DVI_USE_RECORDER in |
| yes) set_aux_files_from_fls;; |
| |
| no) set_aux_files_from_log;; |
| |
| yesmaybe) |
| if check_recorder_support; then |
| set_aux_files_from_fls |
| elif check_openout_in_log_support; then |
| set_aux_files_from_log |
| else |
| error 1 "TeX neither supports -recorder nor outputs \\openout lines in its log file" |
fi |
fi |
fi | ;; |
|
|
# What we'll run texindex on -- exclude non-index files. | nomaybe) |
# Since we know index files are last, it is correct to remove everything | if check_openout_in_log_support; then |
# before .aux and .?o?. But don't really do <anything>o<anything> | set_aux_files_from_log |
# -- don't match whitespace as <anything>. | elif check_recorder_support; then |
# Otherwise, if orig_xref_files contains something like | set_aux_files_from_fls |
# foo.xo foo.whatever | else |
# the space after the o will get matched. | error 1 "TeX neither supports -recorder nor outputs \\openout lines in its log file" |
index_files=`echo "$orig_xref_files" \ | |
| sed "s!.*\.aux!!g; | |
s!./$filename_noext\.[^ ]o[^ ]!!g; | |
s/^[ ]*//;s/[ ]*$//"` | |
# Run texindex (or makeindex) on current index files. If they | |
# already exist, and after running TeX a first time the index | |
# files don't change, then there's no reason to run TeX again. | |
# But we won't know that if the index files are out of date or | |
# nonexistent. | |
if test -n "$texindex" && test -n "$index_files"; then | |
$verbose "Running $texindex $index_files ..." | |
if $texindex $index_files 2>&5 1>&2; then :; else | |
echo "$0: $texindex exited with bad status, quitting." >&2 | |
exit 1 | |
fi |
fi |
fi | ;; |
| |
| *) error 1 "Invalid value of TEXI2DVI_USE_RECORDER environment variable : $TEXI2DVI_USE_RECORDER.";; |
|
|
# Finally, run TeX. | esac |
# Prevent $ESCAPE from being interpreted by the shell if it happens | } |
# to be `/'. | |
$batch tex_args="\\${escape}nonstopmode\ \\${escape}input" | |
cmd="$tex $tex_args $filename_input" | |
$verbose "Running $cmd ..." | |
if $cmd >&5; then :; else | |
echo "$0: $tex exited with bad status, quitting." >&2 | |
echo "$0: see $filename_noext.log for errors." >&2 | |
test "$clean" = t \ | |
&& cp "$filename_noext.log" "$orig_pwd" | |
exit 1 | |
fi | |
|
|
|
# remove FILE... |
|
remove () |
|
{ |
|
verbose "Removing" "$@" |
|
rm -rf "$@" |
|
} |
|
|
# Decide if looping again is needed. |
|
finished=t |
|
|
|
# LaTeX (and the package changebar) report in the LOG file if it | # all_files - Echo the names of all files generated, including those by |
# should be rerun. This is needed for files included from | # auxiliary tools like texindex. |
# subdirs, since texi2dvi does not try to compare xref files in | all_files () |
# subdirs. Performing xref files test is still good since LaTeX | { |
# does not report changes in xref files. | echo $in_noext.log |
if grep "Rerun to get" "$filename_noext.log" >/dev/null 2>&1; then | echo $in_noext.fls |
finished= | echo $xref_files_new |
fi | echo `sorted_index_files` |
| } |
|
|
# Check if xref files changed. | sorted_index_files () |
new_xref_files=`$get_xref_files "$filename_noext"` | { |
$verbose "Original xref files = `echo $orig_xref_files | sed 's|\./||g'`" | filter_files sorted_index_filter |
$verbose "New xref files = `echo $new_xref_files | sed 's|\./||g'`" | } |
|
|
# If old and new lists don't at least have the same file list, | # Print the name of a generated file based on FILE if there is one. |
# then one file or another has definitely changed. | sorted_index_filter () |
test "x$orig_xref_files" != "x$new_xref_files" && finished= | { |
| case $in_lang in |
| texinfo) |
| # texindex: texinfo.cp -> texinfo.cps |
| if test -n "`index_file_p $1`" ; then |
| echo $1s |
| fi |
| ;; |
| esac |
| } |
|
|
# File list is the same. We must compare each file until we find | |
# a difference. | # Not currently used - use with filter_files to add secondary files created by |
if test -n "$finished"; then | # bibtex |
for this_file in $new_xref_files; do | bibtex_secondary_files () |
$verbose "Comparing xref file `echo $this_file | sed 's|\./||g'` ..." | { |
# cmp -s returns nonzero exit status if files differ. | case $in_lang in |
if cmp -s "$this_file" "$tmpdir_bak/$this_file"; then :; else | latex) |
# We only need to keep comparing until we find one that | if test -n "`aux_file_p $1`"; then |
# differs, because we'll have to run texindex & tex again no | # bibtex: *.aux -> *.bbl and *.blg. |
# matter how many more there might be. | echo $1 | $SED 's/^\(.*\)\.aux$/\1.bbl/' |
finished= | echo $1 | $SED 's/^\(.*\)\.aux$/\1.blg/' |
$verbose "xref file `echo $this_file | sed 's|\./||g'` differed ..." | fi |
test "$debug" = t && diff -c "$tmpdir_bak/$this_file" "$this_file" | ;; |
break | esac |
fi | } |
| |
| # mostly_clean - Remove auxiliary files and directories. Changes back to |
| # the original directory. |
| mostly_clean () |
| { |
| cd_orig |
| set X "$t2ddir" |
| shift |
| $tidy || { |
| set X ${1+"$@"} `all_files` |
| shift |
| } |
| remove ${1+"$@"} |
| } |
| |
| |
| # cleanup - Remove what should be removed according to options. |
| # Called at the end of each compilation cycle, and at the end of |
| # the script. Changes the current directory. |
| cleanup () |
| { |
| case $clean:$tidy in |
| true:true) mostly_clean ;; # build mode is "clean" |
| false:false) cd_orig; remove "$t2ddir";; # build mode is "local" |
| esac |
| } |
| |
| |
| # input_file_name_decode - Decode COMMAND_LINE_FILENAME, and set the |
| # following shell variables: |
| # |
| # - COMMAND_LINE_FILENAME |
| # The filename given on the commmand line, but cleaned of TeX commands. |
| # - IN_DIR |
| # The directory containing the input file. |
| # - IN_BASE |
| # The input file base name (no directory part). |
| # - IN_NOEXT |
| # The input file name with neither file extensions nor directory part. |
| # - IN_INPUT |
| # The path to the input file for passing as a command-line argument |
| # to TeX. Defaults to COMMAND_LINE_FILENAME, but might change if the |
| # input is preprocessed. |
| input_file_name_decode () |
| { |
| case $command_line_filename in |
| *\\input{*}*) |
| # Let AUC-TeX error parser deal with line numbers. |
| line_error=false |
| command_line_filename=`\ |
| expr X"$command_line_filename" : X'.*input{\([^}]*\)}'` |
| ;; |
| esac |
| |
| # If the COMMAND_LINE_FILENAME is not absolute (e.g., --debug.tex), |
| # prepend `./' in order to avoid that the tools take it as an option. |
| echo "$command_line_filename" | LC_ALL=C $EGREP '^(/|[A-Za-z]:/)' >&6 \ |
| || command_line_filename="./$command_line_filename" |
| |
| # See if the file exists. If it doesn't we're in trouble since, even |
| # though the user may be able to reenter a valid filename at the tex |
| # prompt (assuming they're attending the terminal), this script won't |
| # be able to find the right xref files and so forth. |
| test -r "$command_line_filename" \ |
| || error 1 "cannot read $command_line_filename, skipping." |
| |
| # Get the name of the current directory. |
| in_dir=`func_dirname "$command_line_filename"` |
| |
| # Strip directory part but leave extension. |
| in_base=`basename "$command_line_filename"` |
| # Strip extension. |
| in_noext=`noext "$in_base"` |
| |
| # The normalized file name to compile. Must always point to the |
| # file to actually compile (in case of recoding, macro-expansion etc.). |
| in_input=$in_dir/$in_base |
| |
| |
| # Compute the output file name. |
| if test x"$oname" != x; then |
| out_name=$oname |
| else |
| out_name=$in_noext.`out_lang_ext` |
| fi |
| out_dir=`func_dirname "$out_name"` |
| out_dir_abs=`absolute "$out_dir"` |
| out_base=`basename "$out_name"` |
| out_noext=`noext "$out_base"` |
| } |
| |
| |
| # |
| #################### Main program starts ########################## |
| |
| # Initialize more variables. |
| # |
| # Save TEXINPUTS so we can construct a new TEXINPUTS path for each file. |
| # Likewise for bibtex and makeindex. |
| tex_envvars="BIBINPUTS BSTINPUTS DVIPSHEADERS INDEXSTYLE MFINPUTS MPINPUTS \ |
| TEXINPUTS TFMFONTS" |
| for var in $tex_envvars; do |
| eval ${var}_orig=\$$var |
| export $var |
| done |
| |
| # Push a token among the arguments that will be used to notice when we |
| # ended options/arguments parsing. |
| # Use "set dummy ...; shift" rather than 'set - ..." because on |
| # Solaris set - turns off set -x (but keeps set -e). |
| # Use ${1+"$@"} rather than "$@" because Digital Unix and Ultrix 4.3 |
| # still expand "$@" to a single argument (the empty string) rather |
| # than nothing at all. |
| arg_sep="$$--$$" |
| set dummy ${1+"$@"} "$arg_sep"; shift |
| |
| while test x"$1" != x"$arg_sep"; do |
| # Handle --option=value by splitting apart and putting back on argv. |
| case "$1" in |
| --*=*) |
| opt=`echo "$1" | $SED -e 's/=.*//'` |
| val=`echo "$1" | $SED -e 's/[^=]*=//'` |
| shift |
| set dummy "$opt" "$val" ${1+"$@"}; shift |
| ;; |
| esac |
| |
| case "$1" in |
| -@ ) escape=@;; |
| -~ ) verbose "Option -~ is obsolete: texi2dvi ignores it.";; |
| -b | --batch) ;; # Obsolete |
| --build) shift; build_mode=$1;; |
| --build-dir) shift; build_dir=$1; build_mode=tidy;; |
| -c | --clean) build_mode=clean;; |
| -D | --debug) debug=true;; |
| -e | -E | --expand) expand=true;; |
| -h | --help) usage;; |
| -I) shift; list_concat_dirs includes "$1";; |
| -l | --lang | --language) shift; set_language=$1;; |
| --mostly-clean) action=mostly-clean;; |
| --no-line-error) line_error=false;; |
| --max-iterations) shift; max_iters=$1;; |
| -o | --out | --output) |
| shift |
| # Make it absolute, just in case we also have --clean, or whatever. |
| oname=`absolute "$1"`;; |
| |
| # Output formats. |
| -O|--output-format) shift; out_lang_set "$1";; |
| --dvi|--dvipdf|--html|--info|--pdf|--ps|--text) |
| out_lang_set `echo "x$1" | $SED 's/^x--//'`;; |
| |
| -p) out_lang_set pdf;; |
| -q | -s | --quiet | --silent) quiet=true;; |
| --src-specials) src_specials=--src-specials;; |
| --shell-escape) shell_escape=--shell-escape;; |
| --tex4ht) latex2html=tex4ht;; |
| -t | --texinfo | --command ) shift; textra="$textra\\ |
| "`echo "$1" | $SED 's/\\\\/\\\\\\\\/g'`;; |
| --translate-file ) shift; translate_file="$1";; |
| --tidy) build_mode=tidy;; |
| -v | --vers*) version;; |
| -V | --verb*) verb=true;; |
| --) # What remains are not options. |
| shift |
| while test x"$1" != x"$arg_sep"; do |
| set dummy ${1+"$@"} "$1"; shift |
| shift |
done |
done |
fi | break;; |
| -*) |
| error 1 "Unknown or ambiguous option \`$1'." \ |
| "Try \`--help' for more information." |
| ;; |
| *) set dummy ${1+"$@"} "$1"; shift;; |
| esac |
| shift |
| done |
| # Pop the token |
| shift |
|
|
# If finished, exit the loop, else rerun the loop. | # $tidy: compile in a t2d directory. |
test -n "$finished" && break | # $clean: remove all the aux files. |
done | case $build_mode in |
| local) clean=false; tidy=false;; |
| tidy) clean=false; tidy=true;; |
| clean) clean=true; tidy=true;; |
| *) error 1 "invalid build mode: $build_mode";; |
| esac |
|
|
# If we were in clean mode, compilation was in a tmp directory. | # Interpret remaining command line args as filenames. |
# Copy the DVI (or PDF) file into the directory where the compilation | case $# in |
# has been done. (The temp dir is about to get removed anyway.) | 0) |
# We also return to the original directory so that | error 2 "Missing file arguments." "Try \`--help' for more information." |
# - the next file is processed in correct conditions | ;; |
# - the temporary file can be removed | 1) ;; |
if test -n "$clean"; then | *) |
if test -n "$oname"; then | if test -n "$oname"; then |
dest=$oname | error 2 "Can't use option \`--output' with more than one argument." |
else | |
dest=$orig_pwd | |
fi | |
$verbose "Copying $oformat file from `pwd` to $dest" | |
cp -p "./$filename_noext.$oformat" "$dest" | |
cd / # in case $orig_pwd is on a different drive (for DOS) | |
cd $orig_pwd || exit 1 | |
fi |
fi |
|
;; |
|
esac |
|
|
# Remove temporary files. | |
if test "x$debug" = "x"; then | # We can't do much without tex. |
$verbose "Removing $tmpdir_src $tmpdir_xtr $tmpdir_bak ..." | # End up with the TEX and PDFTEX variables set to what we are going to use. |
cd / | # |
rm -rf $tmpdir_src $tmpdir_xtr $tmpdir_bak | # If $TEX is set to a directory, don't use it. |
| test -n "$TEX" && test -d "$TEX" && unset TEX |
| |
| # But otherwise, use $TEX if it is set. |
| if test -z "$TEX"; then |
| if findprog tex; then :; else cat <<EOM >&2 |
| You don't have a working TeX binary (tex) installed anywhere in |
| your PATH, and texi2dvi cannot proceed without one. If you want to use |
| this script, you'll need to install TeX (if you don't have it) or change |
| your PATH or TEX environment variable (if you do). See the --help |
| output for more details. |
| |
| For information about obtaining TeX, please see http://tug.org/texlive, |
| or do a web search for TeX and your operating system or distro. |
| EOM |
| exit 1 |
fi |
fi |
|
|
|
# We want to use etex (or pdftex) if they are available, and the user |
|
# didn't explicitly specify. We don't check for elatex and pdfelatex |
|
# because (as of 2003), the LaTeX team has asked that new distributions |
|
# use etex by default anyway. |
|
# |
|
if findprog etex; then TEX=etex; else TEX=tex; fi |
|
fi |
|
|
|
# For many years, the pdftex binary has included the e-tex extensions, |
|
# but for those people with ancient TeX distributions ... |
|
if test -z "$PDFTEX"; then |
|
if findprog pdfetex; then PDFTEX=pdfetex; else PDFTEX=pdftex; fi |
|
fi |
|
|
|
|
|
# File descriptor usage: |
|
# 0 standard input |
|
# 1 standard output (--verbose messages) |
|
# 2 standard error |
|
# 5 tools output (turned off by --quiet) |
|
# 6 tracing/debugging (set -x output, etc.) |
|
|
|
# Main tools' output (TeX, etc.) that TeX users are used to seeing. |
|
# |
|
# If quiet, discard, else redirect to the message flow. |
|
if $quiet; then |
|
exec 5>/dev/null |
|
else |
|
exec 5>&1 |
|
fi |
|
|
|
|
|
# Enable tracing, and auxiliary tools output. |
|
# |
|
# This fd should be used where you'd typically use /dev/null to throw |
|
# output away. But sometimes it is convenient to see that output (e.g., |
|
# from a grep) to aid debugging. Especially debugging at distance, via |
|
# the user. |
|
# |
|
if $debug; then |
|
exec 6>&1 |
|
set -vx |
|
else |
|
exec 6>/dev/null |
|
fi |
|
|
|
|
|
# Main program main loop - TeXify each file in turn. |
|
for command_line_filename |
|
do |
|
verbose "Processing $command_line_filename ..." |
|
|
|
input_file_name_decode |
|
|
|
# `texinfo' or `latex'? |
|
in_lang=`compute_language "$command_line_filename"` |
|
|
|
# An auxiliary directory used for all the auxiliary tasks involved |
|
# in compiling this document. |
|
case $build_dir in |
|
'' | . ) t2ddir=$out_noext.t2d ;; |
|
*) # Avoid collisions between multiple occurrences of the same |
|
# file, so depend on the output path. Remove leading `./', |
|
# at least to avoid creating a file starting with `.!', i.e., |
|
# an invisible file. The sed expression is fragile if the cwd |
|
# has active characters. Transform / into ! so that we don't |
|
# need `mkdir -p'. It might be something to reconsider. |
|
t2ddir=$build_dir/`echo "$out_dir_abs/$out_noext.t2d" | |
|
$SED "s,^$orig_pwd/,,;s,^\./,,;s,/,!,g"` |
|
esac |
|
# Remove it at exit if clean mode. |
|
trap "cleanup" 0 1 2 15 |
|
|
|
ensure_dir "$build_dir" "$t2ddir" |
|
|
|
# Sometimes there are incompatibilities between auxiliary files for |
|
# DVI and PDF. The contents can also change whether we work on PDF |
|
# and/or DVI. So keep separate spaces for each. |
|
workdir=$t2ddir/`out_lang_tex` |
|
ensure_dir "$workdir" |
|
|
|
# _build. In a tidy build, where the auxiliary files are output. |
|
if $tidy; then |
|
work_build=$workdir/build |
|
else |
|
work_build=. |
|
fi |
|
|
|
# _bak. Copies of the previous auxiliary files (another round is |
|
# run if they differ from the new ones). |
|
work_bak=$workdir/bak |
|
|
|
# Make those directories. |
|
ensure_dir "$work_build" "$work_bak" |
|
|
|
# Decide how to find auxiliary files created by TeX. |
|
decide_aux_files_method |
|
|
|
case $action in |
|
compile) |
|
# Compile the document. |
|
compile |
|
cleanup |
|
;; |
|
|
|
mostly-clean) |
|
xref_files_new=`generated_files_get` |
|
mostly_clean |
|
;; |
|
esac |
done |
done |
|
|
$verbose "$0 done." | verbose "done." |
exit 0 # exit successfully, not however we ended the loop. |
exit 0 # exit successfully, not however we ended the loop. |
|
# Local Variables: |
|
# sh-basic-offset: 2 |
|
# sh-indentation: 2 |
|
# End: |