GNU LilyPond Programmbenutzung: 5.5 Make und Makefiles

## 5.5 Make und Makefiles

Fast alle Betriebssysteme, auf denen LilyPond benutzt werden kann, unterstützen ein Programm mit dem Namen `make`. Dieses Programm liest eine besondere Datei mit der Bezeichnung `Makefile`, die definiert, welche Dateien von welchen anderen Dateien abhängen und welche Befehle für das Betriebssystem nötig sind, um eine Datei aus einer anderen zu erstellen. Ein Makefile könnte etwa erklären, wie ‘`ballad.pdf`’ und ‘`ballad.midi`’ aus ‘`ballad.ly`’ erstellt werden können, indem LilyPond aufgerufen wird.

Es gibt Fällen, wenn es sich sehr stark empfiehlt, ein `Makefile` für das aktuelle Projekt zu erstellen, entweder zur eigenen Bequemlichkeit, oder aber auch als Hilfe für andere, die vielleicht einmal die Quelldateien lesen und verstehen wollen. Insbesondere bei großen Projekten mit vielen eingefügten Dateien und unterschiedlichen Ausgabeoptionen (etwa Partitur, einzelne Stimmen, Dirigierpartitur, Klavierauszug usw.), aber auch bei Projekten, die komplizierte Programmaufrufe zur Verarbeitung erfordern (wenn man etwa mit `lilypond-book` arbeitet), lohnt sich die Erstellung einer Make-Datei. Diese Dateien können sehr unterschiedliche ausfallen, und ihre Komplexität und Flexibilität kann den Bedürfnissen aber auch Kenntnissen des Schreibers angepasst werden. Das Programm GNU Make ist auf GNU/Linux Distributionen und MacOS X installiert, aber es ist auch für Windows erhältlich.

Das GNU Make Manual gibt eine vollständige Anleitung, wie `make` benutzt werden kann. Hier sollen nur einige kleine Blicke auf die vielfältigen Möglichkeiten geworfen werden.

Die Befehle, um Regeln in einer Make-Datei zu erstellen, unterscheidet sich zwischen den Betriebssystemen. Die verschiedenen Linuxe und MacOS X benutzen `bash`, während unter Windows `cmd` eingesetzt wird. Unter MacOS X muss man das System so konfigurieren, dass die Kommandozeile benutzt wird. Hier einige Beispiele für Make-Dateien, mit Versionen für Linux/MacOS und Windows.

Das erste Beispiel ist für ein Orchesterstück in vier Stätzen unt mit der folgenden Dateistruktur:

>     Symphony/
>     |-- MIDI/
>     |-- Makefile
>     |-- Notes/
>     |   |-- cello.ily
>     |   |-- figures.ily
>     |   |-- horn.ily
>     |   |-- oboe.ily
>     |   |-- trioString.ily
>     |   |-- viola.ily
>     |   |-- violinOne.ily
>     |   `-- violinTwo.ily
>     |-- PDF/
>     |-- Parts/
>     |   |-- symphony-cello.ly
>     |   |-- symphony-horn.ly
>     |   |-- symphony-oboes.ly
>     |   |-- symphony-viola.ly
>     |   |-- symphony-violinOne.ly
>     |   `-- symphony-violinTwo.ly
>     |-- Scores/
>     |   |-- symphony.ly
>     |   |-- symphonyI.ly
>     |   |-- symphonyII.ly
>     |   |-- symphonyIII.ly
>     |   `-- symphonyIV.ly
>     `-- symphonyDefs.ily

Die ‘`.ly`’-Dateien un den Verzeichnissen ‘`Scores`’ und ‘`Parts`’ erhalten ihrere Noten aus ‘`.ily`’-Dateien, die sich im ‘`Notes`’-Verzeichnis befinden:

>     %%% Kopfzeile der Datei "symphony-cello.ly"
>     \include ../definitions.ily
>     \include ../Notes/cello.ily

Die Make-Datei hat die Ziele `score` (das gesamte Stück als große Partitur), `movements` (die einzelnen Sätze als große Partitur) und `parts` (die einzelnen Stimmen für die Spieler). Es gibt auch das Ziel `archive`, welches ein Tar-Archiv der Quelldateien erstellt, etwa um die Quellen über das Internet oder per E-Mail zu verteilen. Hier die Make-Datei für GNU/Linux oder MacOS X. Sie sollte unter dem Namen `Makefile` im obersten Verzeichnis des Projektes gespeichert werden:

Achtung: Wenn ein Ziel oder eine Musterregel definiert ist, müssen die folgenden Zeilen mit Tabulatoren, nicht mit Leerzeichen beginnen.

>     # Namensstamm der Ausgabedateien
>     piece = symphony
>     # finde heraus, wieviele Prozessoren vorhanden sind
>     CPU_CORES=`cat /proc/cpuinfo | grep -m1 "cpu cores" | sed s/".*: "//`
>     # Der Befehl, um lilypond aufzurufen
>     LILY_CMD = lilypond -ddelete-intermediate-files \
>                         -dno-point-and-click -djob-count=$(CPU_CORES)

>     # Die Endungen, die im Makefile benutzt werden
>     .SUFFIXES: .ly .ily .pdf .midi

>     # Eingabe- und Ausgabedateien werden in den Verzeichnissen durchsucht,
>     # die sich in der VPATH-Variable befinden.  Alle sind Unterverzeichnisse
>     # des aktuellen Verzeichnisses (angegeben durch die GNU make-Variable
>     # `CURDIR').
>     VPATH = \
>       $(CURDIR)/Scores \
>       $(CURDIR)/PDF \
>       $(CURDIR)/Parts \
>       $(CURDIR)/Notes

>     # Die Musterregel, um PDF und MIDI-Dateien aus der LY-Eingabedatei
>     # zu erstellen.  Die .pdf-Ausgabedateien werden in das
>     # `PDF'-Unterverzeichnis abgelegt, die .midi-Dateien in das
>     # `MIDI'-Unterverzeichnis.
>     %.pdf %.midi: %.ly
>             $(LILY_CMD) $<; \           # this line begins with a tab
>             if test -f "$*.pdf"; then \
>                 mv "$*.pdf" PDF/; \
>             fi; \
>             if test -f "$*.midi"; then \
>                 mv "$*.midi" MIDI/; \
>             fi

>     notes = \
>       cello.ily \
>       horn.ily \
>       oboe.ily \
>       viola.ily \
>       violinOne.ily \
>       violinTwo.ily

>     # Abhängigkeiten der einzelnen Sätze.
>     $(piece)I.pdf: $(piece)I.ly $(notes)
>     $(piece)II.pdf: $(piece)II.ly $(notes)
>     $(piece)III.pdf: $(piece)III.ly $(notes)
>     $(piece)IV.pdf: $(piece)IV.ly $(notes)

>     # Abhängigkeiten der großen Partitur.
>     $(piece).pdf: $(piece).ly $(notes)

>     # Abhängigkeiten der Stimmen.
>     $(piece)-cello.pdf: $(piece)-cello.ly cello.ily
>     $(piece)-horn.pdf: $(piece)-horn.ly horn.ily
>     $(piece)-oboes.pdf: $(piece)-oboes.ly oboe.ily
>     $(piece)-viola.pdf: $(piece)-viola.ly viola.ily
>     $(piece)-violinOne.pdf: $(piece)-violinOne.ly violinOne.ily
>     $(piece)-violinTwo.pdf: $(piece)-violinTwo.ly violinTwo.ily

>     # `make score' eintippen, um die große Partitur mit allen vier
>     # Sätzen als eine Datei zu erstellen.
>     .PHONY: score
>     score: $(piece).pdf

>     # `make parts' tippen, um alle Stimmen zu erstellen.
>     # `make foo.pdf' tippen, um die Stimme für das Instrument `foo' zu erstellen.
>     # Beispiel: `make symphony-cello.pdf'.
>     .PHONY: parts
>     parts: $(piece)-cello.pdf \
>            $(piece)-violinOne.pdf \
>            $(piece)-violinTwo.pdf \
>            $(piece)-viola.pdf \
>            $(piece)-oboes.pdf \
>            $(piece)-horn.pdf

>     # `make movements' tippen um Dateien für die vier Sätze einzeln zu erstellen.
>     .PHONY: movements
>     movements: $(piece)I.pdf \
>                $(piece)II.pdf \
>                $(piece)III.pdf \
>                $(piece)IV.pdf

>     all: score parts movements

>     archive:
>             tar -cvvf stamitz.tar \       # this line begins with a tab
>             --exclude=*pdf --exclude=*~ \
>             --exclude=*midi --exclude=*.tar \
>             ../Stamitz/*

Unter Windows ergeben sich bestimmte Komplikationen. Nachdem man GNU Make für Windows heruntergeladen und installiert hat, muss man den richtigen Pfad in den Umgebungsvariablen des Systems setzen, damit die DOS-Kommandozeile das Make-Programm finden kann. Um das vorzunehmen, kann mit der rechten Maustaste auf "Arbeitsplatz" klicken, dann `Eigenschaften` und `Erweitert` geklickt werden. Hier wählt man `Umgebungsvariablen`. In der Liste `Systemvariablen` wählt man `Path` und mit einem Klick auf `Bearbeiten` kann man den Pfad zu der `.exe`-Datei von GNU Make hinzufügen, der etwa wie folgt aussieht:

>     C:\Program Files\GnuWin32\bin

Die Make-Datei selber muss auch angepasst werden, um unterschiedliche Shell-Befehle zu verwenden und mit Leerzeichen umgehen zu können, die sich in einigen Standardverzeichnissen unter Windows befinden. Das `archive`-Ziel wird entfernt, da Windows den `tar`-Befehl nicht kennt, und Windows benutzt auch eine andere Dateiendung für midi-Dateien.

>     ## WINDOWS VERSION
>     ##
>     piece = symphony
>     LILY_CMD = lilypond -ddelete-intermediate-files \
>                         -dno-point-and-click \
>                         -djob-count=$(NUMBER_OF_PROCESSORS)

>     # 8.3 Bezeichnung für CURDIR erhalten (Workaround wg. Leerzeichen in PATH)
>     workdir = $(shell for /f "tokens=*" %%b in ("$(CURDIR)") \
>               do @echo %%~sb)

>     .SUFFIXES: .ly .ily .pdf .mid

>     VPATH = \
>       $(workdir)/Scores \
>       $(workdir)/PDF \
>       $(workdir)/Parts \
>       $(workdir)/Notes

>     %.pdf %.mid: %.ly
>             $(LILY_CMD) $<      # diese Zeile beginnt mit Tabulator
>             if exist "$*.pdf"  move /Y "$*.pdf"  PDF/ # begin with tab
>             if exist "$*.mid" move /Y "$*.mid" MIDI/  # begin with tab

>     notes = \
>       cello.ily \
>       figures.ily \
>       horn.ily \
>       oboe.ily \
>       trioString.ily \
>       viola.ily \
>       violinOne.ily \
>       violinTwo.ily

>     $(piece)I.pdf: $(piece)I.ly $(notes)
>     $(piece)II.pdf: $(piece)II.ly $(notes)
>     $(piece)III.pdf: $(piece)III.ly $(notes)
>     $(piece)IV.pdf: $(piece)IV.ly $(notes)

>     $(piece).pdf: $(piece).ly $(notes)

>     $(piece)-cello.pdf: $(piece)-cello.ly cello.ily
>     $(piece)-horn.pdf: $(piece)-horn.ly horn.ily
>     $(piece)-oboes.pdf: $(piece)-oboes.ly oboe.ily
>     $(piece)-viola.pdf: $(piece)-viola.ly viola.ily
>     $(piece)-violinOne.pdf: $(piece)-violinOne.ly violinOne.ily
>     $(piece)-violinTwo.pdf: $(piece)-violinTwo.ly violinTwo.ily

>     .PHONY: score
>     score: $(piece).pdf

>     .PHONY: parts
>     parts: $(piece)-cello.pdf \
>            $(piece)-violinOne.pdf \
>            $(piece)-violinTwo.pdf \
>            $(piece)-viola.pdf \
>            $(piece)-oboes.pdf \
>            $(piece)-horn.pdf

>     .PHONY: movements
>     movements: $(piece)I.pdf \
>                $(piece)II.pdf \
>                $(piece)III.pdf \
>                $(piece)IV.pdf

>     all: score parts movements

Die nächste Make-Datei ist für ein `lilypond-book`-Dokument, das in LaTeX gesetzt wird. Das Projekt hat einen Index, welcher erfordert, dass der Befehl `latex` zweimal aufgerufen wird, um die Verweise zu aktualisieren. Ausgabedateien werden in einem `out`-Verzeichnis für die .pdf-Dateien gespeichert und in `htmlout` für die html-Dateien.

>     SHELL=/bin/sh
>     FILE=myproject
>     OUTDIR=out
>     WEBDIR=htmlout
>     VIEWER=acroread
>     BROWSER=firefox
>     LILYBOOK_PDF=lilypond-book --output=$(OUTDIR) --pdf $(FILE).lytex
>     LILYBOOK_HTML=lilypond-book --output=$(WEBDIR) $(FILE).lytex
>     PDF=cd $(OUTDIR) && pdflatex $(FILE)
>     HTML=cd $(WEBDIR) && latex2html $(FILE)
>     INDEX=cd $(OUTDIR) && makeindex $(FILE)
>     PREVIEW=$(VIEWER) $(OUTDIR)/$(FILE).pdf &

>     all: pdf web keep

>     pdf:
>             $(LILYBOOK_PDF)  # begin with tab
>             $(PDF)           # begin with tab
>             $(INDEX)         # begin with tab
>             $(PDF)           # begin with tab
>             $(PREVIEW)       # begin with tab

>     web:
>             $(LILYBOOK_HTML) # begin with tab
>             $(HTML)          # begin with tab
>             cp -R $(WEBDIR)/$(FILE)/ ./  # begin with tab
>             $(BROWSER) $(FILE)/$(FILE).html &  # begin with tab

>     keep: pdf
>             cp $(OUTDIR)/$(FILE).pdf $(FILE).pdf  # begin with tab

>     clean:
>             rm -rf $(OUTDIR) # begin with tab

>     web-clean:
>             rm -rf $(WEBDIR) # begin with tab

>     archive:
>             tar -cvvf myproject.tar \ # begin this line with tab
>             --exclude=out/* \
>             --exclude=htmlout/* \
>             --exclude=myproject/* \
>             --exclude=*midi \
>             --exclude=*pdf \
>             --exclude=*~ \
>             ../MyProject/*

TODO: soll auch unter Windows funktionieren

Die vorige Make-Datei funktioniert nicht unter Windows. Als Alternative für Windows-Benutzer könnte man eine einfache batch-Datei erstellen, welche die erforderlichen Befehl enthält. Sie kümmert sich nicht um Abhängigkeiten, wie es eine Make-Datei kann, aber wenigstens wird die Kompilation auf einen einzigen Befehl beschränkt. Das folgende kann als Datei `build.bat` oder `build.cmd` gespeichert werden. Die Batch-Datei kann auf der Kommandozeile aufgerufen werden oder einfach doppelt angeklickt werden.

>     lilypond-book --output=out --pdf myproject.lytex
>     cd out
>     pdflatex myproject
>     makeindex myproject
>     pdflatex myproject
>     cd ..
>     copy out\myproject.pdf MyProject.pdf

#### Siehe auch

Programmbenutzung: Benutzung auf der Kommandozeile, lilypond-book.

Andere Sprachen: English, español, français, magyar, italiano, 日本語.

#### LilyPond – Usage