3.4 lilypond-book を呼び出す

lilypond-book は出力形式に応じて以下の拡張子の 1 つを持つファイルを生成します: .tex, .texi, .html, あるいは .xml。.tex, .texi, それに .xml のファイルは更なる処理を必要とします。

各出力形式に特有の説明

LaTeX

印刷や公開のために LaTeX ドキュメントを処理する方法は 2 つあります: PDFLaTeX を用いて直接 PDF ファイルを得ることができ、dvips のような PostScript への変換プログラムを用いて DVI 経由で PostScript ファイルを得ることができます。1 つ目の方法は簡単で、お勧めです⁴。どのような方法を採るにせよ、Ghostscript パッケージに含まれる ps2pdf と pdf2ps のようなツールを用いて PostScript と PDF 間の変換は容易に行うことができます。

PDFLaTeX を用いて PDF ファイルを作り出すには、以下のようにします:

lilypond-book --pdf yourfile.lytex
pdflatex yourfile.tex

LaTeX/dvips/ps2pdf 経由で PDF ファイルを作り出すには、以下のようにします:

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

このプロセスで作成される .dvi ファイルは符頭を保持していません。それで通常です – 以下の手順に従うと、.ps ファイルや .pdf ファイルには符頭が含まれます。

dvips を実行するとフォントに関する警告が発せられます: それらは無害で無視できます。latex を 2 列モードで実行するのであれば、忘れずに dvips のオプションに -t landscape を付け加えてください。

以下のような環境:

\begin{lilypond} … \end{lilypond}

は LaTeX では解釈されません。代わりに、lilypond-book がこれらの‘環境’を専用ファイルに抽出し、LilyPond を呼び出します。そして出力結果の画像を用いて \begin{lilypond}…\end{lilypond} マクロが‘画像のインクルード’コマンドに置き換えられた .tex ファイルを生成します。LaTeX はこの時に実行します (\linewidth などの計算を行うために LaTeX はその前に‘空の’ドキュメントで実行されているのですが)。

既知の問題と警告

\pageBreak コマンドは \begin{lilypond} … \end{lilypond} 環境の中では機能しません。

多くの \paper ブロック変数も \begin{lilypond} … \end{lilypond} 環境の中では機能しません。ドキュメント前文の中で \betweenLilyPondSystem を持つ \newcommand を使ってください。

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

Texinfo

(任意の出力形式の) Texinfo ドキュメントを作り出すには、Texinfo の通常の手順を踏みます。つまり、作り出そうとしている出力形式に応じて texi2pdf か texi2dvi のどちらかを呼び出します。 詳細は Texinfo のドキュメントを参照してください。

コマンド ライン オプション

lilypond-book は以下のコマンド ライン オプションを受け付けます:

-f format

--format=format

処理するドキュメントのタイプを指定します: html, latex, texi (デフォルト), あるいは docbook です。このオプションが無い場合、lilypond-book は形式を自動的に検出しようとします – ファイル拡張子 を参照してください。今のところ、texi は texi-html と同じです。

-F filter

--filter=filter

楽譜ソース断片を filter に通します。lilypond-book は --filter と --process を一度に実行することはしません。例を挙げます:

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

-h

--help

短いヘルプ メッセージを表示します。

-I dir

--include=dir

インクルード パスに dir を追加します。lilypond-book はインクルード パスの中でコンパイル済みの楽譜断片を見つけると、それらを出力ディレクトリに書き出しません。そのため、lilypond-book を呼び出してから更に texi2any や latex 等のコマンドを同じ -I dir オプションを付けて呼び出す必要がある場合があります。

-l loglevel

--loglevel=loglevel

出力の饒舌さを loglevel にセットします。取り得る値は NONE, ERROR, WARN, PROGRESS (デフォルト), それに DEBUG です。このオプションを使わなかった場合、環境変数 LILYPOND_BOOK_LOGLEVEL がセットされ、その値が loglevel として使われます。

-o dir

--output=dir

生成されるファイルをディレクトリ dir に保存します。lilypond-book を実行すると LilyPond が処理するための多くの小さなファイルが生成されます。そのようなゴミがソース ディレクトリに混入することを防ぐには、--output コマンド ライン オプションを使用して出力ディレクトリを変更して、latex や texi2any を実行する前にそのディレクトリに移動します。

lilypond-book --output=out yourfile.lytex
cd out
…

--skip-lily-check

lilypond 出力が見つからなくても処理を終了しません。画像を持たない LilyPond Info ドキュメントを作成するために使います。

--skip-png-check

EPS ファイルを作成するための PNG 画像が見つからなくても処理を終了しません。画像を持たない LilyPond Info ドキュメントを作成するために使います。

--lily-output-dir=dir

lily-XXX ファイルをディレクトリ dir に書き出し、--output ディレクトリにリンクさせます。このオプションは別々のディレクトリの中にあり、多くの楽譜断片を共有するドキュメントをビルドする時間を節約するために使います。

--lily-loglevel=loglevel

呼び出された lilypond の出力の饒舌さを loglevel にセットします。取り得る値は NONE, ERROR, WARN, BASIC, PROGRESS, INFO (デフォルト), それに DEBUG です。このオプションを使わなかった場合、環境変数 LILYPOND_LOGLEVEL がセットされ、その値が loglevel として使われます。

--info-images-dir=dir

Texinfo 出力をフォーマットして、Info が dir の中にある楽譜画像を探すようにします。

--latex-program=prog

latex の代わりに実行可能な prog を実行します。これは、例えばドキュメントを xelatex で処理する場合に有用です。

--left-padding=amount

EPS ボックスのパディングを指定します。amount の単位はミリメートルで、デフォルト値は 3.0 です。このオプションは楽譜が右マージンに食い込む場合に使います。

The width of a tightly clipped system can vary, due to notation elements that stick into the left margin, such as bar numbers and instrument names. This option will shorten each line and move each line to the right by the same amount.

-P command

--process=command

LilyPond コード断片を command を用いて処理します。デフォルトのコマンドは lilypond です。lilypond-book は --filter と --process を一度に実行することはしません。

--pdf

PDFLaTeX で PDF ファイルを作成します。

--redirect-lilypond-output

デフォルトでは、出力はターミナルに表示されます。このオプションは全ての出力をソース ファイルと同じディレクトリにあるログ ファイルにリダイレクトします。

--use-source-file-names

楽譜断片出力ファイルにソース ファイルと同じベース名を付けます。このオプションは lilypondfile でインクルードされた楽譜断片に対してのみ、更に --output-dir オプションと --lily-output-dir オプションで指定されたディレクトリが異なる場合にのみ機能します。

-V

--verbose

出力を饒舌にします。これは --loglevel=DEBUG と等価です。

-v

--version

バージョン情報を表示します。

既知の問題と警告

Texinfo コマンド @pagesizes は解釈されません。同様に、ドキュメント前文以降にあるマージンと行幅を変更する LaTeX コマンドも無視されます。

LilyPond ブロックの最初の \score だけが処理されます。