# 2. Makefileに変数TEXTARGETS と「include latex.mk」を記述する
# 3. texソースファイルと同じディレクトリーで、make コマンドを実行する
#
-# == 機能 ==
-# - 読み込むべき中間ファイルがないことや相互参照未定義の警告がある場合、LaTeX処理を最大4回繰り返す
-# - \includegraphics命令がTeXファイルに含まれる場合、グラフィックファイルを挿入
-# -- 挿入されたグラフィックファイルが更新されたときは、処理を開始
-# -- 挿入されたグラフィックファイルがないときは、処理を中止
-# -- 挿入されたグラフィックファイルに対するバウンディング情報ファイル(.xbb)を作成
-# - \include、\input命令がTeXファイルに含まれる場合、TeXファイルを挿入
-# -- 挿入されたTeXファイルが更新されたときは、処理を開始
-# -- 挿入されたTeXファイルがないときは、処理を中止
-# - \makeindex命令が含まれる場合、mendexで索引を作成
-# - \bibliography命令が含まれる場合、BiBTeXで文献一覧を作成
-#
-# == 擬似ターゲット ==
-# - tex-clean: TeX中間ファイル(auxなど)を削除。ターゲットに.dviが含まれていないときは.dviファイルを削除
-# - xbb-clean: バウンディング情報ファイル(.xbb)を削除
-# - tex-distclean: TeX中間ファイル、バウンディング情報ファイル、ターゲットファイル(PDF、.dvi)を削除
-#
# === Makefile -- sample ===
# TEXTARGETS := report.tex
#
#
# include latex.mk
-#debug
-#SHELL = /bin/sh -x
-
-.PHONY: tex-warning tex-clean tex-distclean
+######################################################################
+# 使用するシェルコマンドの定義
+######################################################################
# シェルコマンド
CAT := cat
CP := cp
ECHO := /bin/echo
GREP := grep
+MKDIR := mkdir
SED := sed
SEQ := seq
MENDEX := mendex
KPSEWHICH := kpsewhich
-#LaTeXオプション
+# LaTeXオプション
LATEXFLAG ?=
DVIPDFMXFLAG ?=
EXTRACTBBFLAGS ?=
BIBTEXFLAG ?=
MENDEXFLAG ?=
-tex-warning:
- @$(ECHO) "check current directory, or set TEXTARGET in Makefile."
-
-# ファイル名から拡張子を除いた部分
-BASE = $(basename $<)
+# シェルコマンドをデバッグするときは、DEBUGSH変数を設定してmakeを実行する
+# 例: DEBUGSH=1 make
+ifdef DEBUGSH
+ SHELL := /bin/sh -x
+endif
-# .aux、.fls以外のTeX中間ファイルの拡張子
-# .lof: 図リスト(\tableoffigures)
-# .lot: 表リスト(\tableoftables)
-# .out: hyperrefパッケージ
-# .toc: 目次(\tableofcontents)
-TEX_INT := .lof .lot .out .toc
-# 索引中間ファイルの拡張子
-# .idx: auxから作成
-# .ind: idxから作成
-IND_INT := .idx .ind
-# BiBTeX中間ファイルの拡張子
-# .bbl: auxから作成
-BIB_INT := .bbl .blg
-# .log: ログ
+######################################################################
+# 拡張子
+######################################################################
+
+# .aux、.fls以外のLaTeX中間ファイルの拡張子
+# .bbl: 文献リスト。作成方法はパターンルールで定義
+# .glo: 用語集。\glossaryがあればTeX処理で生成
+# .idx: 索引。\makeindexがあればTeX処理で生成
+# .ind: 索引。作成方法はパターンルールで定義
+# .lof: 図リスト。\listoffiguresがあればTeX処理で生成
+# .lot: 表リスト。\listoftablesがあればTeX処理で生成
+# .out: PDFブックマーク。hyperrefパッケージをbookmarksオプションtrue(初期値)で呼び出していれば、TeX処理で生成
+# .toc: 目次。\tableofcontentsがあればTeX処理で生成
+LATEXINTEXT := .bbl .glo .idx .ind .lof .lot .out .toc
+
+# ログファイルの拡張子
+# .log: TeXログ
# .ilg: 索引ログ
# .blg: BiBTeXログ
-LOG := .log .ilg .blg
+LOGEXT := .log .ilg .blg
+
+# すべてのTeX中間ファイルの拡張子
+ALLINTEXT := .aux .dvi $(LATEXINTEXT) $(LOGEXT) .fls .d .*_prev
-ALL_INTERFILES = $(addprefix *,.aux $(TEX_INT) $(IND_INT) $(BIB_INT) $(LOG) .fls .d .*_prev)
+# 画像ファイルの拡張子
+GRAPHICSEXT := .pdf .eps .jpg .jpeg .png .bmp
# make完了後、中間ファイルを残す
-.SECONDARY: $(wildcard ALL_INTERFILES)
+.SECONDARY: $(foreach t,$(TEXTARGETS),$(addprefix $(basename $t),$(ALLINTEXT)))
+
+######################################################################
+# TeX処理の定義
+######################################################################
# ファイル名から拡張子を除いた部分
BASE = $(basename $<)
+# LaTeX処理(コンパイル)
+LATEXCMD = $(LATEX) -interaction=batchmode $(LATEXFLAG) $(BASE).tex
+
+COMPILE.tex = $(ECHO) $(LATEXCMD); $(LATEXCMD) >/dev/null 2>&1 || ($(SED) -n -e '/^!/,/^$$/p' $(BASE).log; exit 1)
+
+# 相互参照未定義の警告
+WARN_UNDEFREF := There were undefined references.
+
+# LaTeX処理
+# ログファイルに警告がある場合は警告がなくなるまで、最大CNTで指定された回数分、処理を実行する
+CNT := 3
+
+COMPILES.tex = \
+ for i in `$(SEQ) 1 $(CNT)`; do $(GREP) -F "$(WARN_UNDEFREF)" $(BASE).log && $(COMPILE.tex) || (test $$? -eq 1 && exit 0 || exit $$?); done
+
+# DVI -> PDF
+# 出力結果は.logファイルへ出力
+DVIPDFCMD = $(DVIPDFMX) $(DVIPDFMXFLAG) $(BASE).dvi
+COMPILE.dvi = \
+ $(ECHO) $(DVIPDFCMD); $(DVIPDFCMD) >>$(BASE).log 2>&1 || \
+ ($(SED) -n -e '/^Output written on toc_hyperref.dvi/,$$p' $(BASE).log; exit 1)
+
+######################################################################
+# .dファイルの生成と読み込み
+# .dファイルには、LaTeX処理での依存関係が記述される
+######################################################################
+
# .flsファイルから、INPUTファイルを取得。ただし、$TEXMFDISTのファイルを除く
# 取得は、1回のmake実行につき1回だけ行われる
INPUTFILES = $(INPUTFILESre)
$(GREP) -v `$(KPSEWHICH) -expand-var '$$TEXMFROOT'` \
))))
-# $(BASE).texで読み込まれる中間ファイルを$(BASE).flsから取得する
+# $(BASE).texで読み込まれる中間ファイルを.flsから取得する
# .idxは、.indへ置換
-INTERFILES = \
+LATEXINTFILES = \
$(sort $(subst .idx,.ind, \
- $(filter $(addprefix $(BASE),$(TEX_INT) $(IND_INT) $(BIB_INT)),$(INPUTFILES) $(OUTPUTFILES)) \
+ $(filter $(addprefix $(BASE),$(LATEXINTEXT)),$(INPUTFILES) $(OUTPUTFILES)) \
))
-INTERFILES_PREV = $(addsuffix _prev,$(INTERFILES))
+LATEXINTFILES_PREV = $(addsuffix _prev,$(LATEXINTFILES))
-# TeXファイル - .tex
+# \includeや\inputで読み込まれるTeXファイルを.flsから取得する
TEXFILES = $(filter %.tex,$(INPUTFILES))
-# 対応する画像ファイルの拡張子
-GRAPHICSEXT := .pdf .eps .jpg .jpeg .png .bmp
-
-# $(BASE).texで読み込まれる画像ファイルを取得する
+# \includegraphicsで読み込まれる画像ファイルを$(BASE).texと$(TEXFILES)、および.flsファイルから取得する
GRAPHICFILES = $(GRAPHICFILESre)
GRAPHICFILESre = $(eval GRAPHICFILES := \
$(shell \
$(SED) -e '/^\s*%/d' -e 's/\([^\]\)\s*%.*/\1/g' $(BASE).tex $(TEXFILES) | \
$(SED) -e '/\\begin{verbatim}/,/\\end{verbatim}/d' | \
- $(SED) -n -e 's/\\includegraphics\(\[[^]]*\]\)\{0,1\}{[^}]*}/&\n/pg' | \
- $(SED) -n -e 's/.*{\([^}]*\)}$$/\1/p' \
+ $(SED) -e 's/\\verb|[^|]*|//g' | \
+ $(SED) -e 's/}/}%/g' | $(SED) -e 'y/}%/}\n/' | \
+ $(SED) -n -e 's/.*\\includegraphics\(\[[^]]*\]\)\{0,1\}{\([^}]*\)}$$/\2/pg' \
) \
$(filter $(addprefix %,$(GRAPHICSEXT)),$(INPUTFILES)) \
-))
+ ))
-# そのほかの読み込みファイル
-OTHERFILES = \
- $(sort $(filter-out %.aux $(INTERFILES) $(TEXFILES) $(GRAPHICFILES),$(INPUTFILES)))
+# .flsから取得した、そのほかの読み込みファイル(.styなど)
+OTHERFILES = $(sort $(filter-out %.aux $(LATEXINTFILES) $(TEXFILES) $(GRAPHICFILES),$(INPUTFILES)))
# \bibliography命令で読み込まれる文献データベースファイルをTeXファイルから検索する
BIBDB = $(BIBDBre)
BIBDBre = $(eval BIBDB := \
$(addsuffix .bib,$(basename $(sort $(shell \
- $(SED) -e '/^\s*%/d' -e 's/\([^\]\)\s*%.*/\1/g' $(BASE).tex $(TEXFILES) | \
- $(SED) -e '/\\begin{verbatim}/,/\\end{verbatim}/d' | \
- $(SED) -n -e 's/\\bibliography\(\[[^]]*\]\)\{0,1\}{[^}]*}/&\n/pg' | \
- $(SED) -n -e 's/.*{\([^}]*\)}$$/\1/p' | \
- $(SED) -e 's/,/ /g' \
+ $(SED) -e '/^\s*%/d' -e 's/\([^\]\)\s*%.*/\1/g' $(BASE).tex $(TEXFILES) | \
+ $(SED) -e '/\\begin{verbatim}/,/\\end{verbatim}/d' | \
+ $(SED) -e 's/}/}%/g' | $(SED) -e 'y/}%/}\n/' | \
+ $(SED) -n -e 's/.*\\bibliography\(\[[^]]*\]\)\{0,1\}{\([^}]*\)}$$/\2/pg' | \
+ $(SED) -e 's/,/ /g' \
)))))
-# LaTeX処理(コンパイル)
-LATEXCMD = $(LATEX) -interaction=batchmode $(LATEXFLAG) $(BASE).tex
-COMPILE.tex = $(ECHO) $(LATEXCMD); $(LATEXCMD) >/dev/null 2>&1 || ($(SED) -n -e '/^!/,/^$$/p' $(BASE).log; exit 1)
-
-# 相互参照未定義の警告
-WARN_UNDEFREF := 'There were undefined references\.'
-
-# LaTeX処理
-# ログファイルに警告がある場合は警告がなくなるまで、最大CNTで指定された回数分、処理を実行する
-CNT := 3
-COMPILES.tex = \
- @(for i in `$(SEQ) 1 $(CNT)`; do \
- if test -s $@ -a -s $(BASE).log; then \
- $(GREP) -e $(WARN_UNDEFREF) $(BASE).log || exit 0; \
- else \
- $(ECHO) '$@ and/or $(BASE).log does not exist.'; \
- fi; \
- $(COMPILE.tex); \
- done)
-
-# DVI -> PDF
-# 出力結果は.logファイルへ出力
-DVIPDFCMD = $(DVIPDFMX) $(DVIPDFMXFLAG) $(BASE).dvi
-COMPILE.dvi = $(ECHO) $(DVIPDFCMD); $(DVIPDFCMD) >>$(BASE).log 2>&1 || ($(SED) -n -e '/^Output written on toc_hyperref.dvi/,$$p' $(BASE).log; exit 1)
-
-# 索引中間ファイル(.ind)作成
-MENDEXCMD = $(MENDEX) $(MENDEXFLAG) $(BASE).idx
-COMPILE.idx = $(ECHO) $(MENDEXCMD); $(MENDEXCMD) >/dev/null 2>&1 || ($(CAT) $(BASE).ilg; exit 1)
-
-# 文献リスト中間ファイル(.bbl)作成
-BIBTEXCMD = $(BIBTEX) $(BIBTEXFLAG) $(BASE).aux
-COMPILE.bib = $(ECHO) $(BIBTEXCMD); $(BIBTEXCMD) >/dev/null 2>&1 || ($(CAT) $(BASE).blg; exit 1)
-
-# ターゲットファイルと必須ファイルを比較し、内容が異なる場合はターゲットファイルの内容を必須ファイルに置き換える
-CMPPREV = $(CMP) $@ $< || $(CP) -p -v $< $@
+# .flsファイル作成用の一時ディレクトリー
+FLSDIR := .fls.temp
# $(BASE).flsファイルの作成
-FLSCMD = $(LATEX) -interaction=nonstopmode -recorder $(BASE).tex
-CREATE.fls = \
+FLSCMD = $(LATEX) -interaction=nonstopmode -recorder -output-directory=$(FLSDIR) $(BASE).tex
+
+GENERETE.fls = \
+ test ! -e $(FLSDIR) && $(MKDIR) $(FLSDIR); \
$(FLSCMD) 1>/dev/null 2>&1; \
- test -e $(BASE).fls && $(ECHO) '$(BASE).fls is created.'; \
- $(RM) $(addprefix $(BASE),.aux .dvi .log $(TEX_INT) $(IND_INT) $(BIB_INT))
+ $(SED) -e 's|$(FLSDIR)/||g' $(FLSDIR)/$(BASE).fls >$(BASE).fls; \
+ test -e $(BASE).fls && \
+ ($(ECHO) '$(BASE).fls is generated.'; $(RM) -r $(FLSDIR)) || \
+ ($(ECHO) '$(BASE).fls is not generated.' 1>&2; exit 1)
# 依存関係を.dファイルに書き出す
%.d: %.fls
- @$(ECHO) '$@ is created by scanning $(BASE).tex and $(BASE).fls.'
+ # Makefile変数の展開
+ @$(foreach i,0 1,$(ECHO) "Makefiles variable -- LATEXINTFILES=$(LATEXINTFILES) TEXFILES=$(TEXFILES) GRAPHICFILES=$(GRAPHICFILES) BIBDB=$(BIBDB)" $(if $(filter 0,$i),>/dev/null);)
# .dファイルの依存関係
@$(ECHO) '$(BASE).d: $(BASE).tex $(BASE).fls' >$@
- # \includeまたは\input命令で読み込まれるTeXファイルの依存関係
+ # 中間ファイルの依存関係
+ $(if $(sort $(LATEXINTFILES) $(BIBDB)),@( \
+ $(ECHO); \
+ $(ECHO) '# LaTeX Intermediate Files'; \
+ $(ECHO) '#'; \
+ $(ECHO) '# $$(COMPILE.tex) := $(LATEXCMD)'; \
+ $(ECHO) '# $$(COMPILES.tex) := $(subst $(COMPILE.tex),$(LATEXCMD),$(COMPILES.tex))'; \
+ $(ECHO) '#'; \
+ $(ECHO) '$(BASE).dvi:: $(sort $(LATEXINTFILES_PREV) $(if $(BIBDB),$(BASE).bbl_prev))'; \
+ $(ECHO) ' @$$(COMPILE.tex)'; \
+ $(ECHO); \
+ $(ECHO) '$(BASE).dvi:: $(BASE).aux'; \
+ $(ECHO) ' @$$(COMPILES.tex)'; \
+ ) >>$@)
+ # \includeや\inputで読み込まれるTeXファイルの依存関係
$(if $(TEXFILES),@( \
$(ECHO); \
$(ECHO) '# Files called from \include or \input - .tex'; \
$(ECHO) '$(BASE).aux: $(TEXFILES)'; \
) >>$@)
- # そのほかのファイル(TEXMFROOT以外にあるスタイルファイルなど)の依存関係
- $(if $(OTHERFILES),@( \
- $(ECHO); \
- $(ECHO) '# Other files'; \
- $(ECHO) '$(BASE).aux: $(OTHERFILES)'; \
- ) >>$@)
# 画像ファイルの依存関係
$(if $(GRAPHICFILES),@( \
$(ECHO); \
$(ECHO) '$(BASE).aux: $(addsuffix .xbb,$(basename $(filter-out %.eps,$(GRAPHICFILES))))'; \
) \
) >>$@)
- # 文献処理用ファイルの依存関係
+ # 文献リストファイルの依存関係
$(if $(BIBDB),@( \
$(ECHO); \
$(ECHO) '# Bibliography files: .aux, BIBDB -> .bbl -> .div'; \
$(ECHO) '$(BASE).bbl: $(BIBDB) $(BASE).tex'; \
) >>$@)
- # 中間ファイルの依存関係
- $(if $(sort $(INTERFILES) $(BIBDB)),@( \
- $(ECHO); \
- $(ECHO) '# LaTeX Intermediate Files'; \
- $(ECHO) '$(BASE).dvi:: $(sort $(INTERFILES_PREV) $(if $(BIBDB),$(BASE).bbl_prev))'; \
- $(ECHO) ' @$$(COMPILE.tex)'; \
+ # そのほかのファイル(TEXMFROOT以外にあるスタイルファイルなど)の依存関係
+ $(if $(OTHERFILES),@( \
$(ECHO); \
- $(ECHO) '$(BASE).dvi:: $(BASE).aux'; \
- $(ECHO) ' @$$(COMPILES.tex)'; \
+ $(ECHO) '# Other files'; \
+ $(ECHO) '$(BASE).aux: $(OTHERFILES)'; \
) >>$@)
+ @$(ECHO) '$@ is generated by scanning $(BASE).tex and $(BASE).fls.'
# 変数TEXTARGETSで指定されたターゲットファイルに対応する
# .dファイルをインクルードし、依存関係を取得する
-include $(addsuffix .d,$(basename $(TEXTARGETS)))
endif
-# auxファイル作成
+######################################################################
+# dviおよびPDFファイルを生成するパターンルール
+# TeX -> dvi -> PDF
+######################################################################
+
+# TeX -> aux
%.aux: %.tex
@$(COMPILE.tex)
+# aux -> dvi
%.dvi: %.aux
@$(COMPILES.tex)
+# tex -> dvi
%.dvi: %.tex
@$(COMPILE.tex)
@$(COMPILES.tex)
-# PDFファイル作成
+# dvi -> PDF
%.pdf: %.dvi
@$(COMPILE.dvi)
-# バウンディング情報ファイル作成
-# pdf、jpeg/jpg、pngファイルに対応
-extractbb:
- $(MAKE) -s $(addsuffix .xbb,$(basename $(wildcard $(addprefix *,.pdf .jpg .jpeg .png))))
+######################################################################
+# ファイルリストファイル(.fls)作成
+######################################################################
-%.xbb: %.pdf
- $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
-
-%.xbb: %.jpeg
- $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
+%.fls: %.tex
+ @-$(GENERETE.fls)
-%.xbb: %.jpg
- $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
+######################################################################
+# LaTeX中間ファイルを生成するパターンルール
+######################################################################
-%.xbb: %.png
- $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
+# ターゲットファイルと必須ファイルを比較し、内容が異なる場合はターゲットファイルの内容を必須ファイルに置き換える
+CMPPREV = $(CMP) $@ $< && $(ECHO) '$@ is up to date.' || $(CP) -p -v $< $@
-# ファイル一覧作成
-%.fls: %.tex
- @-$(CREATE.fls)
+# 図リスト
+%.lof: %.tex
+ @$(MAKE) -s $(BASE).aux
-%.fls_prev: %.fls
+%.lof_prev: %.lof
@$(CMPPREV)
-# 目次中間ファイル作成
-%.toc: %.tex
+# 表リスト
+%.lot: %.tex
@$(MAKE) -s $(BASE).aux
-%.toc_prev: %.toc
+%.lot_prev: %.lot
@$(CMPPREV)
-# 図リスト中間ファイル作成
-%.lof: %.tex
+# PDFブックマーク
+%.out: %.tex
@$(MAKE) -s $(BASE).aux
-%.lof_prev: %.lof
+%.out_prev: %.out
@$(CMPPREV)
-# 表リスト中間ファイル作成
-%.lot: %.tex
+# 目次
+%.toc: %.tex
@$(MAKE) -s $(BASE).aux
-%.lot_prev: %.lot
+%.toc_prev: %.toc
@$(CMPPREV)
-# 索引中間ファイル作成
+######################################################################
+# 索引用中間ファイルを生成するパターンルール
+######################################################################
+
+# 索引用中間ファイル作成コマンド
+MENDEXCMD = $(MENDEX) $(MENDEXFLAG) $(BASE).idx
+
+COMPILE.idx = $(ECHO) $(MENDEXCMD); $(MENDEXCMD) >/dev/null 2>&1 || ($(CAT) $(BASE).ilg; exit 1)
+
+# .tex -> .idx
%.idx: %.tex
@$(MAKE) -s $(BASE).aux
%.idx_prev: %.idx
@$(CMPPREV)
+# .idx -> .ind
%.ind: %.idx_prev
@$(COMPILE.idx)
%.ind_prev: %.ind
@$(CMPPREV)
-# BiBTeX中間ファイル作成
+######################################################################
+# 文献リスト用中間ファイルを生成するパターンルール
+######################################################################
+# 文献リスト用中間ファイル作成コマンド
+BIBTEXCMD = $(BIBTEX) $(BIBTEXFLAG) $(BASE).aux
+
+COMPILE.bib = $(ECHO) $(BIBTEXCMD); $(BIBTEXCMD) >/dev/null 2>&1 || ($(CAT) $(BASE).blg; exit 1)
+
+# TeX -> .aux -> .bib
%.bbl: %.tex
@$(MAKE) -s $(BASE).aux
@$(COMPILE.bib)
%.bbl_prev: %.bbl
@$(CMPPREV)
-# hyperref中間ファイル作成
-%.out: %.tex
- @$(MAKE) -s $(BASE).aux
+######################################################################
+# バウンディング情報ファイルを生成するパターンルール
+######################################################################
+%.xbb: %.pdf
+ $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
-%.out_prev: %.out
- @$(CMPPREV)
+%.xbb: %.jpeg
+ $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
+
+%.xbb: %.jpg
+ $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
+
+%.xbb: %.png
+ $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
+
+%.xbb: %.bmp
+ $(EXTRACTBB) $(EXTRACTBBFLAGS) $<
+
+######################################################################
+# ターゲット
+######################################################################
+
+# 警告
+tex-warn:
+ @$(ECHO) "check current directory, or set TEXTARGET in Makefile."
+
+# すべての画像ファイルに対してextractbbを実行
+tex-xbb:
+ $(MAKE) -s $(addsuffix .xbb,$(basename $(wildcard $(addprefix *,$(GRAPHICSEXT)))))
-# tex-cleanターゲット
+# 中間ファイルの削除
tex-clean:
- $(RM) $(ALL_INTERFILES)
+ $(RM) $(addprefix *,$(ALLINTEXT))
+ $(RM) -r $(FLSDIR)
ifeq (,$(filter %.dvi,$(TEXTARGETS)))
$(RM) *.dvi
endif
-# xbb-cleanターゲット
-xbb-clean:
+# .xbbファイルの削除
+tex-xbb-clean:
$(RM) *.xbb
-# tex-distcleanターゲット
-tex-distclean: tex-clean xbb-clean
+# 生成されたすべてのファイルの削除
+tex-distclean: tex-clean tex-xbb-clean
ifneq (,$(filter %.dvi,$(TEXTARGETS)))
$(RM) *.dvi
endif