2
# texi2dvi --- smartly produce DVI files from texinfo sources
3
# $Id: texi2dvi,v 1.3 2000/05/29 17:35:54 andreas Exp $
5
# Copyright (C) 1992, 93, 94, 95, 96, 97, 98 Free Software Foundation, Inc.
7
# This program is free software; you can redistribute it and/or modify
8
# it under the terms of the GNU General Public License as published by
9
# the Free Software Foundation; either version 2, or (at your option)
12
# This program is distributed in the hope that it will be useful,
13
# but WITHOUT ANY WARRANTY; without even the implied warranty of
14
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15
# GNU General Public License for more details.
17
# You should have received a copy of the GNU General Public License
18
# along with this program; if not, you can either send email to this
19
# program's maintainer or write to: The Free Software Foundation,
20
# Inc.; 59 Temple Place, Suite 330; Boston, MA 02111-1307, USA.
24
# Author: Noah Friedman <friedman@gnu.org>
26
# Please send bug reports, etc. to bug-texinfo@gnu.org.
27
# If possible, please send a copy of the output of the script called with
28
# the `--debug' option when making a bug report.
30
# In the interest of general portability, some common bourne shell
31
# constructs were avoided because they weren't guaranteed to be available
32
# in some earlier implementations. I've tried to make this program as
33
# portable as possible. Welcome to unix, where the lowest common
34
# denominator is rapidly diminishing.
36
# Among the more interesting lossages I noticed among Bourne shells:
37
# * No shell functions.
38
# * No `unset' builtin.
39
# * `shift' cannot take a numeric argument, and signals an error if
40
# there are no arguments to shift.
44
# Name by which this script was invoked.
45
progname=`echo "$0" | sed -e 's/[^\/]*\///g'`
47
# This string is expanded by rcs automatically when this file is checked out.
48
rcs_revision='$Revision: 1.3 $'
49
version=`set - $rcs_revision; echo $2`
51
# To prevent hairy quoting and escaping later.
55
usage="Usage: $0 [OPTION]... FILE...
56
Run a Texinfo document through TeX.
59
-b, --batch No interaction (\nonstopmode in TeX).
60
-c, --clean Remove all auxiliary files.
61
-D, --debug Turn on shell debugging ($bq${bq}set -x$eq$eq).
62
-t, --texinfo CMD Insert CMD after @setfilename before running TeX.
63
--verbose Report on what is done.
64
-h, --help Display this help and exit.
65
-v, --version Display version information and exit.
67
The values of the TEX, TEXINDEX, and MAKEINFO environment variables are
68
used to run those commands, if they are set.
70
Email bug reports to bug-texinfo@gnu.org."
72
# Initialize variables.
73
# Don't use `unset' since old bourne shells don't have this command.
74
# Instead, assign them an empty value.
75
# Some of these, like TEX and TEXINDEX, may be inherited from the environment.
76
backup_extension=.bak # these files get deleted if all goes well.
83
makeinfo="${MAKEINFO-makeinfo}"
84
texindex="${TEXINDEX-texindex}"
87
# Save this so we can construct a new TEXINPUTS path for each file.
88
TEXINPUTS_orig="$TEXINPUTS"
91
# Parse command line arguments.
92
# Make sure that all wildcarded options are long enough to be unambiguous.
93
# It's a good idea to document the full long option name in each case.
94
# Long options which take arguments will need a `*' appended to the
95
# canonical name to match the value appended after the `=' character.
97
test $# -eq 0 && break
100
-b | --batch | --b* ) batch=t; shift ;;
101
-c | --clean | --c* ) clean=t; shift ;;
102
-D | --debug | --d* ) debug=t; shift ;;
103
-h | --help | --h* ) echo "$usage"; exit 0 ;;
104
# OK, we should do real option parsing here, but be lazy for now.
105
-t | --texinfo | --t*) shift; textra="$textra $1"; shift ;;
107
echo "$progname (GNU Texinfo 3.12) $version"
108
echo "Copyright (C) 1998 Free Software Foundation, Inc.
109
There is NO warranty. You may redistribute this software
110
under the terms of the GNU General Public License.
111
For more information about these matters, see the files named COPYING."
113
--verb* ) verbose=echo; shift ;;
114
-- ) # Stop option processing
119
--*=* ) arg=`echo "$1" | sed -e 's/=.*//'` ;;
123
echo "$progname: Unknown or ambiguous option $bq$arg$eq."
124
echo "$progname: Try $bq--help$eq for more information."
130
# See if there are any command line args left (which will be interpreted as
131
# filename arguments).
132
if test $# -eq 0; then
134
echo "$progname: At least one file name is required as an argument."
135
echo "$progname: Try $bq--help$eq for more information."
139
test "$debug" = t && set -x
142
for command_line_filename in ${1+"$@"}; do
143
$verbose "Processing $command_line_filename ..."
145
# See if file exists. If it doesn't we're in trouble since, even
146
# though the user may be able to reenter a valid filename at the tex
147
# prompt (assuming they're attending the terminal), this script won't
148
# be able to find the right index files and so forth.
149
if test ! -r "${command_line_filename}"; then
150
echo "$0: Could not read ${command_line_filename}." >&2
154
# Roughly equivalent to `dirname ...`, but more portable
155
directory="`echo ${command_line_filename} | sed 's/\/[^\/]*$//'`"
156
filename_texi="`basename ${command_line_filename}`"
157
# Strip off the last extension part (probably .texinfo or .texi)
158
filename_noext="`echo ${filename_texi} | sed 's/\.[^.]*$//'`"
160
# Use same basename since we want to generate aux files with the same
161
# basename as the manual. Use extension .texi for the temp file so
162
# that TeX will ignore it. Thus, we must use a subdirectory.
164
# Output the macro-expanded file to here. The vastly abbreviated
165
# temporary directory name is so we don't have collisions on 8.3 or
166
# 14-character filesystems.
167
tmp_dir=${TMPDIR-/tmp}/txi2d.$$
168
filename_tmp=$tmp_dir/$filename_noext.texi
169
# Output the file with the user's extra commands to here.
170
tmp_dir2=${tmp_dir}.2
171
filename_tmp2=$tmp_dir2/$filename_noext.texi
172
mkdir $tmp_dir $tmp_dir2
173
# Always remove the temporary directories.
174
trap "rm -rf $tmp_dir $tmp_dir2" 1 2 15
176
# If directory and file are the same, then it's probably because there's
177
# no pathname component. Set dirname to `.', the current directory.
178
if test "z${directory}" = "z${command_line_filename}"; then
182
# Source file might @include additional texinfo sources. Put `.' and
183
# directory where source file(s) reside in TEXINPUTS before anything
184
# else. `.' goes first to ensure that any old .aux, .cps, etc. files in
185
# ${directory} don't get used in preference to fresher files in `.'.
186
TEXINPUTS=".:${directory}:${TEXINPUTS_orig}"
188
# Expand macro commands in the original source file using Makeinfo;
189
# the macro syntax bfox implemented is impossible to implement in TeX.
190
# Always use `end' footnote style, since the `separate' style
191
# generates different output (arguably this is a bug in -E).
192
# Discard main info output, the user asked to run TeX, not makeinfo.
193
# Redirect output to /dev/null to throw away `Making info file...' msg.
194
$verbose "Macro-expanding $command_line_filename to $filename_tmp ..."
195
$makeinfo --footnote-style=end -E $filename_tmp -o /dev/null \
196
$command_line_filename >/dev/null
198
# But if there were no macros, or makeinfo failed for some reason,
199
# just use the original file. (It shouldn't make any difference, but
201
if test $? -ne 0 || cmp -s $filename_tmp $command_line_filename; then
202
$verbose "Reverting to $command_line_filename ..."
203
cp -p $command_line_filename $filename_tmp
205
filename_input=$filename_tmp
206
dirname_input=$tmp_dir
208
# Used most commonly for @finalout, @smallbook, etc.
209
if test -n "$textra"; then
210
$verbose "Inserting extra commands: $textra."
211
sed '/^@setfilename/a\
212
'"$textra" $filename_input >$filename_tmp2
213
filename_input=$filename_tmp2
214
dirname_input=$tmp_dir2
217
# If clean mode was specified, then move to the temporary directory.
218
if test "$clean" = t; then
219
$verbose "cd $dirname_input"
220
cd $dirname_input || exit 1
221
filename_input=`basename $filename_input`
224
while true; do # will break out of loop below
225
# "Unset" variables that might have values from previous iterations and
226
# which won't be completely reset later.
227
definite_index_files=
229
# Find all files having root filename with a two-letter extension,
230
# determine whether they're really index files, and save them. Foo.aux
231
# is actually the cross-references file, but we need to keep track of
233
possible_index_files="`eval echo ${filename_noext}.?? ${filename_noext}.aux`"
234
for this_file in ${possible_index_files}; do
235
# If file is empty, forget it.
236
test -s "${this_file}" || continue
238
# Examine first character of file. If it's not suitable to be an
239
# index or xref file, don't process it.
240
first_character="`sed -n '1s/^\(.\).*$/\1/p;q' ${this_file}`"
241
if test "x${first_character}" = "x\\" \
242
|| test "x${first_character}" = "x'"; then
243
definite_index_files="${definite_index_files} ${this_file}"
246
orig_index_files="${definite_index_files}"
247
orig_index_files_sans_aux="`echo ${definite_index_files} \
248
| sed 's/'${filename_noext}'\.aux//;
249
s/^[ ]*//;s/[ ]*$//;'`"
251
# Now save copies of original index files so we have some means of
253
$verbose "Backing up current index files: $orig_index_files ..."
254
for index_file_to_save in ${orig_index_files}; do
255
cp "${index_file_to_save}" "${index_file_to_save}${backup_extension}"
258
# Run texindex on current index files. If they already exist, and
259
# after running TeX a first time the index files don't change, then
260
# there's no reason to run TeX again. But we won't know that if the
261
# index files are out of date or nonexistent.
262
if test -n "${orig_index_files_sans_aux}"; then
263
$verbose "Running $texindex $orig_index_files_sans_aux ..."
264
${texindex} ${orig_index_files_sans_aux}
268
if test "$batch" = t; then
269
tex_mode='\nonstopmode'
273
$verbose "Running $tex $filename_input ..."
274
cmd="$tex $tex_mode \\input $filename_input"
277
# Check if index files changed.
279
definite_index_files=
280
# Get list of new index files.
281
possible_index_files="`eval echo ${filename_noext}.?? ${filename_noext}.aux`"
282
for this_file in ${possible_index_files}; do
283
# If file is empty, forget it.
284
test -s "${this_file}" || continue
286
# Examine first character of file. If it's not a backslash or
287
# single quote, then it's definitely not an index or xref file.
288
# (Will have to check for @ when we switch to Texinfo syntax in
289
# all these files...)
290
first_character="`sed -n '1s/^\(.\).*$/\1/p;q' ${this_file}`"
291
if test "x${first_character}" = "x\\" \
292
|| test "x${first_character}" = "x'"; then
293
definite_index_files="${definite_index_files} ${this_file}"
296
new_index_files="${definite_index_files}"
297
new_index_files_sans_aux="`echo ${definite_index_files} \
298
| sed 's/'${filename_noext}'\.aux//;
299
s/^[ ]*//;s/[ ]*$//;'`"
301
# If old and new list don't at least have the same file list, then one
302
# file or another has definitely changed.
303
$verbose "Original index files =$orig_index_files"
304
$verbose "New index files =$new_index_files"
305
if test "z${orig_index_files}" != "z${new_index_files}"; then
306
index_files_changed_p=t
308
# File list is the same. We must compare each file until we find a
310
index_files_changed_p=
311
for this_file in ${new_index_files}; do
312
$verbose "Comparing index file $this_file ..."
313
# cmp -s will return nonzero exit status if files differ.
314
cmp -s "${this_file}" "${this_file}${backup_extension}"
315
if test $? -ne 0; then
316
# We only need to keep comparing until we find *one* that
317
# differs, because we'll have to run texindex & tex no
319
index_files_changed_p=t
320
$verbose "Index file $this_file differed:"
321
test $verbose = echo \
322
&& diff -c "${this_file}${backup_extension}" "${this_file}"
328
# If index files have changed since TeX has been run, or if the aux
329
# file wasn't present originally, run texindex and TeX again.
330
if test "${index_files_changed_p}"; then :; else
331
# Nothing changed. We're done with TeX.
336
# If we were in clean mode, compilation was in a tmp directory.
337
# Copy the DVI file into the directory where the compilation
338
# has been done. (The temp dir is about to get removed anyway.)
339
# We also return to the original directory so that
340
# - the next file is processed in correct conditions
341
# - the temporary file can be removed
342
if test -n "$clean"; then
343
$verbose "Copying DVI file from `pwd` to $orig_pwd"
344
cp -p $filename_noext.dvi $orig_pwd
345
cd $orig_pwd || exit 1
348
# Generate list of files to delete, then call rm once with the entire
349
# list. This is significantly faster than multiple executions of rm.
351
for file in ${orig_index_files}; do
352
file_list="${file_list} ${file}${backup_extension}"
354
if test -n "${file_list}"; then
355
$verbose "Removing $file_list $tmp_dir $tmp_dir2 ..."
357
rm -rf $tmp_dir $tmp_dir2
362
true # exit successfully.
added
removed
readline/doc/texi2dvi
