3.4 lilypond-book aufrufen

lilypond-book erzeugt abhängig vom Ausgabeformat eine Datei mit einer der folgenden Dateierweiterungen: .tex, .texi, .html oder .xml. Alle .tex, .texi und .xml Dateien müssen noch mit den entsprechenden Programmen (LaTeX, DocBook, etc.) weiter verarbeitet werden, um druckfähige Dateien zu erhalten.

Formatabhängige Anweisungen

LaTeX

Es existieren zwei Methoden, Ihr LaTeX-Dokument weiter zu verarbeiten, um zu einer druck- oder publikationsfähigen Datei zu gelangen: Zum einen die direkte Erzeugung einer PDF-Datei mit PDFLaTeX, zum anderen die Erzeugung einer DVI daraus einer PostScript-Datei mittels LaTeX und einem DVI-nach-PostScript Konverters wie dvips. Die erste Methode ist einfacher und daher empfehlenswert.⁵ Welche Methode auch immer benutzt wird, die Konvertierung zwischen PostScript und PDF kann leicht mit Hilfsprogrammen wie ps2pdf und pdf2ps (aus dem Ghostscript-Paket) erfolgen.

Um eine PDF-Datei mittels PDFLaTeX zu erzeugen, kann folgendermaßen vorgegangen werden:

lilypond-book --pdf Ihre_Datei.pdftex
pdflatex Ihre_Datei.tex

Um eine PDF-Datei mittels LaTeX/dvips/ps2pdf zu erhalten, sind folgende Befehle nötig:

lilypond-book Ihre_Datei.lytex
latex Ihre_Datei.tex
dvips -Ppdf Ihre_Datei.dvi
ps2pdf Ihre_Datei.ps

Die .dvi-Datei, die beim Aufruf von latex erzeugt wird, scheint keine Notenköpfe zu enthalten, was in Ordnung ist. Wenn Sie die Datei wie beschrieben weiter verarbeiten, erscheinen die Notenköpfe korrekt in den .ps und .pdf Dateien.

Der Aufruf von dvips kann einige Warnungen über fehlende Schriftarten ausgeben. Auch dies ist in Ordnung und kann ignoriert werden.

Wenn Sie in der LaTeX-Datei das Papierformat auf Querformat eingestellt haben, vergessen Sie nicht die -t landscape-Option beim Aufruf von dvips.

Bekannte Probleme und Warnungen

Der Befehl \pageBreak funktioniert nicht innerhalb einer \begin{lilypond} … \end{lilypond}-Umgebung.

Auch viele Variablen der \paper-Umgebung funktionieren nicht innerhalb einer \begin{lilypond} … \end{lilypond}-Umgebung. Benutzen Sie \newcommand mit \betweenLilyPondSystem:

\newcommand{\betweenLilyPondSystem}[1]{\vspace{36mm}\linebreak}

Texinfo

Um ein von lilypond-book erzeugtes Texinfo-Dokument zu verarbeiten, gehen Sie wie für alle anderen Texinfo-Dokumente vor: Rufen Sie – abhängig vom gewünschten Ausgabeformat – eines der Programme texi2pdf, texi2dvi, texi2any oder texi2html auf.

Die Dokumentation von Texinfo liefert dazu nähere Informationen.

Optionen auf der Kommandozeile

lilypond-book unterstützt die folgenden Kommandozeilenoptionen:

-f Format

--format=Format

Gibt das Format des Eingabedokuments an: html, latex, texi (Standardeinstellung), texi-html oder docbook. Ist diese Option nicht angegeben, versucht lilypond-book das Format anhand des Dateinamens zu bestimmen. Im Moment bedeutet texi praktisch dasselbe wie texi-html.

-F Filter

--filter=Filter

Leitet die Musikfragmente durch das Programm filter anstatt sie mit LilyPond zu einer Grafik zu verarbeiten. --filter und --process kann nicht gleichzeitig benutzt werden. Beispielaufruf:

lilypond-book --filter='convert-ly --from=2.0.0 -' Mein-Buch.tely

-h

--help

Gibt eine kurze Hilfemeldung aus.

-I Pfad

--include=Pfad

Fügt Pfad zu den Include-Pfaden hinzu. lilypond-book sucht auch in allen Include-Pfaden nach bereits erstellten Grafiken für die Musikfragmente. Wird das aktuelle Fragment gefunden und hat sich seit der letzten Erstellung nicht geändert, wird es nicht erneut erzeugt. Bei manchen der Programme zur Weiterverarbeitung wie etwa texi2any oder latex muss dieselbe -I Pfad Option angegeben werden, damit das entsprechende Programm die Grafiken ebenso findet.

-l Logstufe

--loglevel=Logstufe

Passt die Ausführlichkeit der Ausgabe entsprechend Logstufe an. Mögliche Werte sind NONE, ERROR, WARN, PROGRESS (Standard) und DEBUG. Wenn diese Option nicht genutzt wird und die Umgebungsvariable LILYPOND_BOOK_LOGLEVEL definiert ist, wird ihr Wert als Logstufe eingesetzt.

-o Verzeichnis

--output=Verzeichnis

Erzeugt die Ausgabedateien in Verzeichnis. Der Aufruf von lilypond-book erzeugt zahlreiche kleine Dateien, die von LilyPond, latex, texi2any etc. dann weiter benützt werden. Um zu vermeiden, dass das Quellenverzeichnis durch diese Dateien unübersichtlich wird, kann die --output Option benutzt werden. Vor dem Aufruf von latex oder texi2any sollten Sie in dieses Verzeichnis wechseln.

lilypond-book --output=out IhreDatei.lytex
cd out
...

--skip-lily-check

Nicht mit einer Fehlermeldung abbrechen, wenn keine Ausgabe von LilyPond gefunden wird. Dies wird benutzt für Dokumentation ohne Grafiken.

--skip-png-check

Nicht mit einer Fehlermeldung abbrechen, wenn für die EPS-Dateien keine PNG-Grafiken gefunden werden. Dies wird benutzt für Dokumentation ohne Grafiken.

--lily-output-dir=Verzeichnis

Schreibt lily-XXX Dateien nach Verzeichnis und erzeugt im mit --output angegebenen Verzeichnis Verknüpfungen darauf. Diese Option ist nützlich, um Zeit zu sparen, wenn Dokumente in verschiedenen Verzeichnissen viele identische Musikfragmente enthalten.

--lily-loglevel=Logstufe

Passt die Ausführlichkeit der Ausgabe entsprechend Logstufe an. Mögliche Werte sind NONE, ERROR, WARN, PROGRESS (Standard) und DEBUG. Wenn diese Option nicht genutzt wird und die Umgebungsvariable LILYPOND_LOGLEVEL definiert ist, wird ihr Wert als Logstufe eingesetzt.

--info-images-dir=Verzeichnis

Formatiert die Texinfo-Ausgabe dergestalt, dass Info in Verzeichnis nach den Grafiken zu den Musikfragmenten sucht.

--latex-program=Programm

Führt Programm anstelle von latex aus. Dies ist nützlichen, wenn das Dokument mit einer anderen LaTeX-Variante wie etwa xelatex verarbeitet werden soll.

--left-padding=Einrückung

Fügt Einrückung als zusätzlichen Einzug in die EPS-Box ein. Einrückung wird in Millimetern angegeben, die Standardeinstellung ist 3.0 Millimeter. Diese Option kann benutzt werden, wenn die Notenzeilen über den Rand des Dokuments hinausstehen.

Die Breite eines eng ausgeschnittenen Notensystems kann variieren aufgrund von Notationselementen, die über den linken Rand hinausstehen, wie etwa Taktzahlen und Bezeichnungen der Instrumente. Diese Option verkürzt die Notenzeile und verschiebt sie um denselben Betrag nach rechts.

-P Befehl

--process=Befehl

Verarbeitet LilyPond-Fragmente mit Befehl anstelle des Standardbefehls lilypond. --filter und --process können mit lilypond-book nicht gleichzeitig benutzt werden.

--pdf

Erzeugt PDF-Dateien mit PDFLaTeX.

--redirect-lilypond-output

Standardmäßig wird die Ausgabe auf der Kommandozeile ausgegeben. Diese Option leitet die Ausgabe in eine Log-Datei im selben Verzeichnis wie die Quelldatei um.

--use-source-file-names

Schreibe Schnipsel-Ausgabedateien mit den gleichen Basisnamen wie die Quelldateien. Diese Option funktioniert mit Schnipseln, die mit lilypondfile eingfügt wurden und auch nur, wenn die Verzeichnisse --output-dir und --lily-output-dir unterschiedlich sind.

-V

--verbose

Gibt ausführliche informative Meldungen aus. Äquivalent zu --loglevel=DEBUG.

-v

--version

Gibt die Versionsnummer aus.

Bekannte Probleme und Warnungen

Der Texinfo-Befehl @pagesizes wird ignoriert. Ebenso werden LaTeX-Befehle ignoriert, die den Seitenrand oder die Zeilenlänge nach der Dokumentpräambel verändern.

Nur der erste \score-Block eines LilyPond-Fragments wird verarbeitet.