-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathtexi2dvi
executable file
·1996 lines (1747 loc) · 58.4 KB
/
texi2dvi
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#! /bin/sh
# texi2dvi --- produce DVI (or PDF) files from Texinfo (or (La)TeX) sources.
#
# Copyright 1992-2019 Free Software Foundation, Inc.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License,
# or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
# Originally written by Noah Friedman.
#
# Please send bug reports, etc. to [email protected].
# If possible, please send a copy of the output of the script called with
# the `--debug' option when making a bug report.
test -f /bin/ksh && test -z "$RUNNING_KSH" \
&& { UNAMES=`uname -s`; test "x$UNAMES" = xULTRIX; } 2>/dev/null \
&& { RUNNING_KSH=true; export RUNNING_KSH; exec /bin/ksh $0 ${1+"$@"}; }
unset RUNNING_KSH
# No failure shall remain unpunished.
set -e
# In case the default sed doesn't suffice.
: ${SED=sed}
program=`echo $0 | $SED -e 's!.*/!!'`
build_mode=${TEXI2DVI_BUILD_MODE:-local}
build_dir=${TEXI2DVI_BUILD_DIRECTORY:-.}
orig_pwd=`pwd`
# Initialize variables for option overriding and otherwise.
# Don't use `unset' since old bourne shells don't have this command.
# Instead, assign them an empty value.
action=compile
debug=false
escape="\\"
expand=false # true for expansion via makeinfo
includes=
line_error=true # pass --file-line-error to TeX
max_iters=7 # when to quit
oname= # --output
out_lang=dvi
quiet=false # let the tools' message be displayed
set_language=
src_specials=
shell_escape=
latex2html=hevea # or set to tex4ht
textra= # Extra TeX commands to insert in the input file.
txiprereq=19990129 # minimum texinfo.tex version with macro expansion
verb=false # true for verbose mode
translate_file= # name of charset translation file
# 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
# directories in TEXINPUTS -- except for Cygwin and Msys, where COMSPEC
# 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=";"
else
path_sep=":"
fi
# Pacify verbose cds.
CDPATH=${ZSH_VERSION+.}$path_sep
# Now we define numerous functions, with no other executable code.
# The main program is at the end of the file.
# Standard help and version functions.
#
# usage - display usage and exit successfully.
usage ()
{
cat <<EOF
Usage: $program [OPTION]... FILE...
or: texi2pdf [OPTION]... FILE...
or: pdftexi2dvi [OPTION]... FILE...
Run each Texinfo or (La)TeX FILE through TeX in turn until all
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 ((La)TeX or Texinfo). To process
(e)plain TeX files, set the environment variable LATEX=tex.
When invoked as \`texi2pdf' or given the option --pdf generate PDF output.
Otherwise, generate DVI.
General options:
-D, --debug turn on shell debugging (set -x)
-h, --help display this help and exit successfully
-o, --output=OFILE leave output in OFILE; only one input FILE is allowed
-q, --quiet no output unless errors
-v, --version display version information and exit successfully
-V, --verbose report on what is done
--max-iterations=N don't process files more than N times [$max_iters]
--mostly-clean remove auxiliary files or directories from
previous runs (but not the output)
Output format:
--dvi output a DVI file [default]
--dvipdf output a PDF file via DVI (using a dvi-to-pdf program)
--html output an HTML file from LaTeX, using HeVeA
--info output an Info file from LaTeX, using HeVeA
-p, --pdf use pdftex or pdflatex for processing
--ps output a PostScript file via DVI (using dvips)
--text output a plain text file from LaTeX, using HeVeA
TeX tuning:
-E, --expand macro expansion using makeinfo
-I DIR search DIR for Texinfo files
-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
Build modes:
--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]
The MODE specifies where the TeX compilation takes place, and, as a
consequence, how auxiliary files are treated. The build mode can also
be set using the environment variable TEXI2DVI_BUILD_MODE.
Valid values of MODE are:
\`local' compile in the current directory, leaving all the auxiliary
files around. This is the traditional TeX use.
\`tidy' compile in a local *.t2d directory, where the auxiliary files
are left. Output files are copied back to the original file.
\`clean' same as \`tidy', but remove the auxiliary directory afterwards.
Every compilation therefore requires the full cycle.
The values of these environment variables are used to run the
corresponding commands, if they are set:
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 [email protected],
general questions and discussion to [email protected].
GNU Texinfo home page: <http://www.gnu.org/software/texinfo/>
General help using GNU software: <http://www.gnu.org/gethelp/>
EOF
exit 0
}
# version - Display version info and exit successfully.
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
}
# 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/[/\\]*$/\//'`
}
# 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=
}
# func_dirname FILE - Return the directory part of FILE.
func_dirname ()
{
dirname "$1" 2>/dev/null \
|| { echo "$1" | $SED 's!/[^/]*$!!;s!^$!.!'; }
}
# noext FILE - Return FILE with one extension removed:
# foo.bar.baz -> foo.bar
noext ()
{
echo "$1" | $SED -e 's/\.[^/.][^/.]*$//'
}
# absolute NAME - Return an absolute path to NAME.
absolute ()
{
case $1 in
[\\/]* | ?:[\\/]*)
# Absolute paths don't need to be expanded.
echo "$1"
;;
*) absolute_slashes=`echo "$1" | $SED -n 's,.*[^/]\(/*\)$,\1,p'`
absolute_rel=$orig_pwd/`func_dirname "$1"`
if test -d "$absolute_rel"; then
(cd "$absolute_rel" 2>/dev/null \
&& absolute_name=`pwd`/`basename "$1"`"$absolute_slashes"
echo "$absolute_name")
else
error 1 "not a directory: $absolute_rel"
fi
;;
esac
}
# ensure_dir DIR1 DIR2... - Make sure given directories exist.
ensure_dir ()
{
for dir
do
# 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
}
# error EXIT_STATUS LINE1 LINE2... - Report an error and exit with
# failure if EXIT_STATUS is non-null.
error ()
{
error_status="$1"
shift
report "$@"
if test "$error_status" != 0; then
exit $error_status
fi
}
# findprog PROG - Return true if PROG is somewhere in PATH, else false.
findprog ()
{
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
}
# report LINE1 LINE2... - Echo each argument to stderr.
report ()
{
for i in "$@"
do
echo >&2 "$0: $i"
done
}
# run COMMAND-LINE - Run COMMAND-LINE verbosely, catching errors as failures.
run ()
{
verbose "Running $@"
"$@" 2>&5 1>&2 \
|| error 1 "$1 failed"
}
# verbose WORD1 WORD2... - Echo concatenated WORDs to stderr, if $verb.
verbose ()
{
if $verb; then
echo >&2 "$0: $@"
fi
}
# Handling lists.
#
# 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=\""$@"\"
}
# list_concat_dirs LIST-NAME DIR-LIST - Append to LIST-NAME all the
# components (including empty ones) from the $path_sep-separated list
# DIR-LIST. Make the paths absolute.
list_concat_dirs ()
{
lcd_list="$1"
# 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.
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
IFS=$path_sep
set x `echo "$2" | eval $SED $lcd_replace_EMPTY`; shift
IFS=$save_IFS
for lcd_dir
do
case $lcd_dir in
EMPTY)
list_append $lcd_list ""
;;
*)
if test -d $lcd_dir; then
dir=`absolute "$lcd_dir"`
list_append $lcd_list "$lcd_dir"
fi
;;
esac
done
}
# 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
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
EMPTY)
af_result=$af_result$af_path_sep
;;
*)
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
af_path_sep=$path_sep
done
echo "$af_result"
}
# output_base_name FILE - Return the name of FILE, possibly renamed to
# satisfy --output. FILE is local, i.e., without any directory part.
output_base_name ()
{
case $oname in
'') 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
# 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
verbose "$0: Running $tex_cmd ..."
if (eval "$tex_cmd" >&5); then
case $out_lang in
dvi | pdf ) move_to_dest "$in_noext.$out_lang";;
esac
else
tex_failed=true
fi
}
# 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.