LilyPond — 使用方法

1.1 通常の使用方法

たいていのユーザは GUI から LilyPond を実行します。まだ実行したことがないのであれば チュートリアル を読んでください。 Lilypond ファイルを書くのに代替のエディタを使用するのであれば、そのエディタのドキュメントを読んでください。

1.2 コマンド ラインの使用方法

この節にはコマンド ラインで LilyPond を使用するための追加情報が含まれます。これにはプログラムに追加オプションを渡す必要があるかもしれません。さらに、いくつかの特別なプログラム (midi2ly など) はコマンド ラインからしか利用できません。

ここで ‘コマンド ライン’ とは、OS の中にあるコマンド ラインを意味します。Windows ユーザは ‘DOS シェル’ や ‘コマンド シェル’ ‘コマンド プロンプト’ という言葉の方が馴染みがあるかもしれません。MaxOS X ユーザは ‘ターミナル’ や ‘コンソール’ という言葉の方が馴染みがあるかもしれません。MaxOS X ユーザは追加のセットアップが必要かもしれません。MacOS X を参照してください。

OS のコマンド ラインの使用方法についての説明はこのマニュアルが扱う範囲ではありません。コマンド ラインに馴染みがない場合は、その内容を扱っている他のドキュメントをあたってください。

lilypond [option]… file…

#(define output-suffix "violin")
\score { … }
#(define output-suffix "cello")
\score { … }

lilypond *.ly

lilypond file.ly 1> stdout.txt
lilypond file.ly 2> stderr.txt
lilypond file.ly &> all.txt

find . -name '*.ly' -exec lilypond '{}' \;

forfiles /s /M *.ly /c "cmd /c lilypond @file"

forfiles /s /p C:\Documents\MyScores /M *.ly /c "cmd /c lilypond @file"

forfiles /s /p "C:\Documents\My Scores" /M *.ly /c "cmd /c lilypond @file"

command key=value

set? FONTCONFIG_FILE=$INSTALLER_PREFIX/etc/fonts/fonts.conf
prependdir GUILE_LOAD_PATH=$INSTALLER_PREFIX/share/guile/1.8

#!/bin/sh
## defaults set here

username=lily
home=/home
loopdevice=/dev/loop0
jaildir=/mnt/lilyloop
# the prefix (without the leading slash!)
lilyprefix=usr/local
# the directory where lilypond is installed on the system
lilydir=/$lilyprefix/lilypond/

userhome=$home/$username
loopfile=$userhome/loopfile
adduser $username
dd if=/dev/zero of=$loopfile bs=1k count=200000
mkdir $jaildir
losetup $loopdevice $loopfile
mkfs -t ext3 $loopdevice 200000
mount -t ext3 $loopdevice $jaildir
mkdir $jaildir/lilyhome
chown $username $jaildir/lilyhome
cd $jaildir

mkdir -p bin usr/bin usr/share usr/lib usr/share/fonts $lilyprefix tmp
chmod a+w tmp

cp -r -L $lilydir $lilyprefix
cp -L /bin/sh /bin/rm bin
cp -L /usr/bin/convert /usr/bin/gs usr/bin
cp -L /usr/share/fonts/truetype usr/share/fonts

# Now the library copying magic
for i in "$lilydir/usr/bin/lilypond" "$lilydir/usr/bin/guile" "/bin/sh"  \
  "/bin/rm" "/usr/bin/gs" "/usr/bin/convert"; do ldd $i | sed 's/.*=>  \
    \/\(.*\/\)\([^(]*\).*/mkdir -p \1 \&\& cp -L \/\1\2 \1\2/' | sed  \
      's/\t\/\(.*\/\)\(.*\) (.*)$/mkdir -p \1 \&\& cp -L \/\1\2 \1\2/'  \
        | sed '/.*=>.*/d'; done | sh -s

# The shared files for Ghostscript...
      cp -L -r /usr/share/ghostscript usr/share
# The shared files for ImageMagick
      cp -L -r /usr/lib/ImageMagick* usr/lib

### Now, assuming that you have test.ly in /mnt/lilyloop/lilyhome,
### you should be able to run:
### Note that /$lilyprefix/bin/lilypond is a script, which sets the
### LD_LIBRARY_PATH - this is crucial
      /$lilyprefix/bin/lilypond -jlily,lily,/mnt/lilyloop,/lilyhome test.ly

1.3 エラー メッセージ

ファイルのコンパイルの最中にはさまざまなエラー メッセージが表示される可能性があります。

Warning ¶

何か疑わしいことがあります。あなたが何か普通でないことをリクエストしている場合は、そのメッセージを理解して、それを無視することができます。しかしながら、Warning は通常、入力ファイルに何か問題があることを示しています。

Error

何か明らかに問題があります。カレントの処理ステップ (構文解析、構文解釈、フォーマット) は終了され、次のステップは飛ばされます。

Fatal error ¶

何か明らかに問題があり、LilyPond はコンパイルを続けられません。これが起きることは稀です。これが起こるのはたいてい、フォントのインストールに問題があるためです。

Scheme error ¶

Scheme コードの実行中に発生するこのエラーは Scheme インタプリタによって引き起こされます。冗長オプション (-V または --verbose) 付きで実行している場合、問題となっている関数呼び出しの呼び出し追跡が表示されます。

Programming error ¶

内部的な矛盾があります。このエラー メッセージはプログラマとデバッガを助けることを意図したものです。通常、それらは無視できます。時々、それらは非常に大きなメッセージとなり、他の出力を見えにくくします。

Aborted (core dumped)

これは、プログラムをクラッシュさせる深刻なプログラミング エラーを示しています。そのようなエラーは決定的なものだと考えられます。あなたがそのようなエラーでつまずいた場合、バグ レポートを送ってください。

警告とエラーを入力ファイルのある部分にリンクさせることが可能な場合、エラー メッセージは以下のような形式になります:

filename:lineno:columnno: message
offending input line

エラーが見つかった場所を示すために問題のある行に改行が挿入されます。例えば:

test.ly:2:19: error: not a duration: 5
  { c'4 e'
           5 g' }

これらの位置は LilyPond が警告やエラーが発生した位置を最善を尽くして推測したものですが、(ごく当たり前のことですが) 警告とエラーは何か予期しないことが起こったときに発生するものです。入力ファイルの示された行にエラーを見つけることができない場合は、示された位置の 1 行か 2 行上をチェックしてみてください。

診断は多くの処理段階のあらゆる時点で発生し得ることに注意してください。例えば、入力が複数回処理される（つまり、MIDI とレイアウト出力）または同じ音楽変数がコンテキストで使われると、同じメッセージが何回か現れることがあります。

エラーについての更なる情報が 一般的なエラー で提供されています。

1.4 一般的なエラー

以下で説明するエラーがしばしば発生しますが、その原因は明白でなかったり、見つけにくかったりします。目を通しておくと、それらのエラーに対処しやすくなります。

\override VerticalAxisGroup.staff-affinity = ##f

\score {
  % Invalid! Generates error: syntax error, unexpected \new
  \new Staff { … }
  \new Staff { … }
}

2.1 何故構文は変更されるのか？

入力ファイルを読みやすく、書きやすくするために、しばしば構文は変更されますが、時により既存の関数が、新しい機能や改善に合わせて変更されることがあります。

これが実際にあった例です:

\paper と \layout のプロパティ名は全て、first-second-third という形式で記述することになっています。しかしながら、バージョン 2.11.60 で printallheaders プロパティがこの規則に従っていないことが判明しました。放置すべきでしょうか？ (新しいユーザはつじつまの合わない入力形式で混乱するでしょう。) それとも、変更すべきでしょうか？ (既存の楽譜を持つユーザには煩わしいことです。)

このケースでは、プロパティ名を print-all-headers に変更することを決断しました。そして、昔のユーザは convert-ly コマンドによって既にある入力ファイルを自動的にアップデートすることができました。

しかし、convert-ly はすべての変更を処理できるわけではありません。例えば、バージョン 2.4.2 以前の LilyPond では、アクセント文字と非英語文字を LaTeX の記法を用いて入力していました。 例えば Christmas のフランス語は No\"el のように入力されていました。しかしながら、バージョン 2.6 以降の LilyPond では、特殊文字 ë を UTF-8 文字として直接 LilyPond ファイルに入力しなければならなくなりました。convert-ly はすべての LaTeX の特殊文字を UTF-8 文字に変換することはできません。手動で古い LilyPond 入力ファイルを更新する必要があります。

convert-ly コマンドの変換ルールは、テキストのパターンマッチングと置換によって動作しています (つまり、与えられた入力ファイルの中で何が変更されたかの文脈を‘理解’してはいないということです)。 これはいくつかの結果をもたらします:

• 変換の信頼性は、それぞれの適用されるルールセットの品質と、対応する変更の複雑さ次第です。変換が、追加・手動の修正を要求することがあります。ですから万が一のために、変換前の入力ファイルは比較のために残しておくべきです。
• より新しいバージョンへの構文の変更のみが可能です: LilyPond の昔のバージョンへ変換するルールセットは存在しません。そのため、入力ファイルを更新するのは、昔のバージョンの LilyPond がもうメンテナンスされていない時に限るべきです。繰り返しますが、万が一のために変換前の入力ファイルは残しておくべきです。Git のようなバージョン管理システムを使うと、複数のバージョンの入力ファイルを管理するのに役立つかもしれません。
• LilyPond は処理の際、余計に配置された、あるいは省略された空白に左右されません。しかし、convert-ly で用いられるルールはコードのスタイルにいくらかの仮定を置く場合があります。ですから、正常な変換を行うために、LilyPond のマニュアルで用いられるスタイルに従うことを推奨します。特にマニュアル自体、すべての例が convert-ly コマンドで更新されています。

2.2 convert-ly を呼び出す

convert-ly コマンドは古いバージョンを検出するために入力ファイルの version 番号を使用します。たいていの場合、あなたの入力ファイルを更新するには、その入力ファイルを保持しているディレクトリで以下を実行するだけで十分です:

convert-ly -e myfile.ly

これにより、myfile.ly はその場で更新され、オリジナル ファイルは myfile.ly~ に名前が変更されて保存されます。更新された入力ファイルの \version 番号も、必要な構文の更新に合わせて変更されます。

convert-ly コマンドが実行される時、変換が行われるバージョンの番号を出力します。バージョン番号が出力されなかった場合、そのファイルは既に更新されており、最新の LilyPond 構文を使用しています。

単一のディレクトリにある全ての入力ファイルを変換するには、以下のようにします:

convert-ly -e *.ly

Linux や MacOS X のユーザーは、適当なターミナルからこのコマンドを実行できますが、MacOS X のユーザーは、メニューの Compile > Update syntax からも直接コマンドを実行できます。

Windows ユーザーがコマンド ラインを用いる場合はこのようになります:

convert-ly.py -e *.ly

これを、コマンド プロンプトから実行します。コマンド プロンプトは通常、スタート > アクセサリ > コマンド プロンプトにありますが、Windows 8 ユーザーであるなら、検索ウィンドウに‘コマンド プロンプト’と入力することでも実行できます。

複数のサブディレクトリ内にある全ての入力ファイルを変換するには、以下のようにします:

find . -name '*.ly' -exec convert-ly -e '{}' \;

この例は、現在のディレクトリとその下にある全てのディレクトリに存在する入力ファイルを、再帰的に見つけ出し変換します。変換されたファイルはリネームされた元のファイルと同じディレクトリに配置されます。これは MacOS X でも動作するはずです (ターミナルからの実行のみとなりますが)。

Windows ユーザーは以下のようにします:

forfiles /s /M *.ly /c "cmd /c convert-ly.py -e @file"

代わりに、/p オプションを使って、入力ファイルを含む全てのサブフォルダを保持したトップレベルのフォルダを指定することができます:

forfiles /s /p C:\Documents\MyScores /M *.ly /c "cmd /c convert-ly.py -e @file"

トップレベルのフォルダへのパスにスペースが含まれる場合には、パス全体をダブルクォートで括る必要があります:

forfiles /s /p "C:\Documents\My Scores" /M *.ly /c "cmd /c convert-ly.py -e @file"

2.3 convert-ly のコマンド ライン オプション

一般に、このプログラムは以下のように呼び出されます:

convert-ly [option]… filename…

以下のオプションを与えることができます:

-d, --diff-version-update

ファイルが実際に変更された場合にのみ \version を更新します。 これを指定した場合のバージョン番号は、最後に実際に変換が行われた後のバージョンに対応します。不安定版のバージョン番号は、ターゲットのバージョン番号を超えない限り、次の安定版のバージョン番号に上げられます。このオプションを指定しないと、最後の変換を行おうとしたバージョンに更新されます。

-e, --edit

入力ファイルをその場で直接変換します。変換元のファイルは myfile.ly~ のように名前が変更されます。このバックアップファイルは、オペレーティングシステムによっては隠しファイルとして扱われているかもしれません。古い入力ファイルに ~ を付加する -e を使わずに、更新されたファイルの名前を別に指定したい場合は、代わりに出力をリダイレクトすることができます:

convert-ly myfile.ly > mynewfile.ly

Windows ユーザーは:

convert-ly.py myfile.ly > mynewfile.ly

-b, --backup-numbered

‘-e’ オプションと同時に用いた場合、前のバージョンのファイルが上書きされないように、バックアップファイルの名前に番号が付きます。バックアップファイルは、オペレーティングシステムによっては隠されているかもしれません。

-f, --from=from-patchlevel

変換元のバージョンをセットします。これがセットされていない場合、convert-ly は入力ファイルの中にある version 文字列を基に推測します。例: --from=2.10.25

-h, --help

ヘルプ (使い方) を表示します。

-l loglevel, --loglevel=loglevel

出力の饒舌さを loglevel にセットします。取り得る値は、大文字で、PROGRESS (デフォルト), NONE, WARN, ERROR, それに DEBUG です。

-n, --no-version

通常、convert-ly は \version インジケータを出力に付け加えます。このオプションを指定すると、それを抑制します。

-s, --show-rules

すべての変換を表示して、終了します。

-t, --to=to-patchlevel

変換先のバージョンを明示してセットします。明示されない場合は、デフォルトで最新バージョンにセットします。変換元のバージョンよりも高くなっている必要があります。

convert-ly --to=2.14.1 myfile.ly

texinfo ファイルの中にある LilyPond 断片を更新するには以下を使用してください:

convert-ly --from=… --to=… --no-version *.itely

2 つのバージョン間での LilyPond 構文の変更を調べるには、以下を使用してください:

convert-ly --from=… --to=… -s

2.4 convert-ly の問題点

Windows の ‘コマンド プロンプト’ ウィンドウからスペースを含むファイル名やパスを持つファイルに対してconvert-ly を実行する場合、入力ファイル名全体を 3 つ (!) のダブル クォートで囲む必要があります:

convert-ly """D:/My Scores/Ode.ly""" > "D:/My Scores/new Ode.ly"

convert-ly -e *.ly コマンドが展開時に長くなりすぎて失敗する場合、convert-ly コマンドをループさせてやります。以下の例は UNIX 用であり、カレント ディレクトリの中にあるすべての .ly ファイルを更新します:

for f in *.ly; do convert-ly -e $f; done;

Windows の ‘コマンド プロンプト’ ウィンドウでの上の例に対応するコマンドは以下の通りです:

for %x in (*.ly) do convert-ly -e """%x"""

言語の変更がすべて処理されるわけではありません。指定できる出力オプションは 1 つだけです。自動的に Scheme と更新することと LilyPond の Scheme インタフェイスを更新することはまったく異なります。Scheme コードの調整は手動で行う覚悟でいてください。

2.5 手動変換

理論的には、convert-ly のようなプログラムはすべての構文変更を処理できます。 After all, a computer program interprets the old version and the new version, so another computer program can translate one file into another².

しかしながら、LilyPond プロジェクトの資源には限りがあり、すべての変換を自動化することはできません。以下は既知の問題のリストです。

1.6->2.0:
 Doesn't always convert figured bass correctly, specifically things like {<
>}.  Mats' comment on working around this:
   To be able to run convert-ly
   on it, I first replaced all occurrences of '{<' to some dummy like '{#'
   and similarly I replaced '>}' with '&}'.  After the conversion, I could
   then change back from '{ #' to '{ <' and from '& }' to '> }'.
 Doesn't convert all text markup correctly.  In the old markup syntax,
 it was possible to group a number of markup commands together within
parentheses, e.g.
   -#'((bold italic) "string")
   This will incorrectly be converted into
   -\markup{{\bold italic} "string"}
   instead of the correct
   -\markup{\bold \italic "string"}
2.0->2.2:
 Doesn't handle \partCombine
 Doesn't do \addlyrics => \lyricsto, this breaks some scores with multiple
stanzas.
2.0->2.4:
 \magnify isn't changed to \fontsize.
    - \magnify #m => \fontsize #f, where f = 6ln(m)/ln(2)
 remove-tag isn't changed.
    - \applyMusic #(remove-tag '. . .) => \keepWithTag #'. . .
 first-page-number isn't changed.
    - first-page-number no => print-first-page-number = ##f
 Line breaks in header strings aren't converted.
    - \\\\  as line break in \header strings => \markup \center-align <
      "First Line" "Second Line" >
 Crescendo and decrescendo terminators aren't converted.
    - \rced => \!
    - \rc => \!
2.2->2.4:
 \turnOff (used in \set Staff.VoltaBracket = \turnOff) is not properly
converted.
2.4.2->2.5.9
 \markup{ \center-align <{ ... }> } should be converted to:
 \markup{ \center-align {\line { ... }} }
 but now, \line is missing.
2.4->2.6
 Special LaTeX characters such as $~$ in text are not converted to UTF8.
2.8
 \score{} must now begin with a music expression.  Anything else
 (particularly \header{}) must come after the music.

2.6 複数のバージョンに対応するコードを書く

いくつかの場面で、特にライブラリのコードを書く場合、破壊的な構文変更を含んだ複数の LilyPond バージョンをサポートすることは望ましいでしょう。これは、バージョンによって変更が必要な部分を、現在実行されている LilyPond のバージョンで分岐する条件文で囲むことで実現できます。Scheme 関数 ly:version? は比較演算子 op と、比較の対象となるバージョンを 3 つまでの整数のリストで表現した ver を引数に取ります。 整数の数が足りない場合は無視されます。例えば、'(2 20) は全ての 2.20 の系列のバージョンと等しくなります。このような表記が可能です:

#(cond
  ((ly:version? > '(2 20))
   (ly:message "This is code to run for LilyPond after 2.20"))
  ((ly:version? = '(2 19 57))
   (ly:message "This will only be executed with LilyPond 2.19.57"))
  (else (ly:message "This will be executed in any other version")))

通常、これは (訳注: バージョンによって) 別の構文が使えるようにするためにライブラリ関数に組み込まれますが、以下の例のように、比較を直接音楽の中に用いることもできます:

{
  c' d' e' f'
  #(if (ly:version? = '(2 21))
       #{ \override NoteHead.color = #red #}
       #{ \override NoteHead.color = #blue #})
  g' a' b' c''
}

注意: この関数は LilyPond 2.19.57 で導入されました。そのため、それより古いバージョンと比較することはできません。

3.1 音楽学のドキュメントの例

テキストのなかには楽譜の例を保持しているものがあります。そのようなテキストには、音楽学の専門書、歌集、このドキュメントのようなマニュアルがあります。そのようなテキストを手作業で作成することができます – PostScript 画像をワープロにインポートするといったようにです。しかしながら、HTML, LaTeX, Texinfo, それに DocBook ドキュメントの場合は、作業量を減らすための自動処理を利用することができます。

lilypond-book と呼ばれるスクリプトは楽譜の断片を抽出して、それらをフォーマットして、得られた楽譜をドキュメントに戻します。LaTeX に対するちょっとした使用例を示します。この例には説明文も含まれていますので、それ以上コメントすることはしません。

入力

\documentclass[a4paper]{article}

\begin{document}

\verb+lilypond-book+ のドキュメントでは自由に楽譜とテキストを
組み合わせることができます。
例えば、以下のように:

\begin{lilypond}
\relative {
  c'2 e2 \tuplet 3/2 { f8 a b } a2 e4
}
\end{lilypond}

オプションは角括弧の中に配置します。

\begin{lilypond}[fragment,quote,staffsize=26,verbatim]
  c'4 f16
\end{lilypond}

大きな楽譜例は別のファイルに配置して、\verb+\lilypondfile+ で
インポートすることができます。

\lilypondfile[quote,noindent]{screech-and-boink.ly}

(必要があれば、@file{screech-and-boink.ly} をこのファイルと同じディレクトリ
にある任意の @file{.ly} に置き換えてください。)

\end{document}

処理

上記のコードを lilybook.lytex というファイル名で保存して、ターミナルで以下を実行します:

lilypond-book --output=out --pdf lilybook.lytex
lilypond-book (GNU LilyPond) 2.25.21 
Reading lilybook.lytex...
…lots of stuff deleted…
Compiling lilybook.tex...
cd out
pdflatex lilybook
…lots of stuff deleted…
xpdf lilybook
(xpdf をお好みの PDF ビューアに置き換えてください)

lilypond-book と latex を実行すると多くの一時ファイルが作成されて、作業ディレクトリを散らかします。散らかされることを防ぐには --output=dir オプションを使います。このオプションを指定すると、一時ファイルはサブディレクトリ dir に作成されます。

以下に上記の LaTeX 例の結果を示します。³これでこのチュートリアル セクションを終わります。

出力

lilypond-book のドキュメントでは自由に楽譜とテキストを 組み合わせることができます。 例えば、以下のように:

オプションは角括弧の中に配置します。

c'4 f16

大きな楽譜例は別のファイルに配置して、\lilypondfile で インポートすることができます。

デフォルトあるいはカスタムの tagline が必要であれば、 楽譜コード断片全体を \book { } 構造で囲んでください。

\book{
  \header{
    title = "A scale in LilyPond"
  }

  \relative {
    c' d e f g a b c
  }
}

3.2 楽譜とテキストを統合する

LilyPond をさまざまな出力フォーマットと統合する方法を説明します。

\begin{lilypond}[options,go,here]
  YOUR LILYPOND CODE
\end{lilypond}

\lilypond[options,go,here]{ YOUR LILYPOND CODE }

\lilypondfile[options,go,here]{filename}

\musicxmlfile[options,go,here]{filename}

\begin{lilypond}[quote,fragment,staffsize=26]
  c' d' e' f' g'2 g'2
\end{lilypond}

\lilypond[quote,fragment,staffsize=11]{<c' e' g'>}

\def\betweenLilyPondSystem#1{\endinput}

\begin{lilypond}[fragment]
  c'1\( e'( c'~ \break c' d) e f\)
\end{lilypond}

\def\betweenLilyPondSystem#1{
    \ifnum#1<2\else\expandafter\endinput\fi
}

\let\betweenLilyPondSystem\undefined

\def\onlyFirstNSystems#1{
    \def\betweenLilyPondSystem##1{%
      \ifnum##1<#1\else\expandafter\endinput\fi}
}

\onlyFirstNSystems{3}
\begin{lilypond}…\end{lilypond}
\onlyFirstNSystems{1}
\begin{lilypond}…\end{lilypond}

@lilypond[options,go,here]
  YOUR LILYPOND CODE
@end lilypond

@lilypond[options,go,here]{ YOUR LILYPOND CODE }

@lilypondfile[options,go,here]{filename}

@musicxmlfile[options,go,here]{filename}

@lilypond[fragment]
c' d' e' f' g'2 g'
@end lilypond

@lilypond[fragment,staffsize=11]{<c' e' g'>}

<lilypond options go here>
  YOUR LILYPOND CODE
</lilypond>

<lilypond options go here: YOUR LILYPOND CODE />

<lilypondfile options go here>filename</lilypondfile>

<musicxmlfile options go here>filename</musicxmlfile>

<lilypond fragment relative=2>
\key c \minor c4 es g2
</lilypond>

Some music in <lilypond relative=2: a b c/> a line of text.

<lilypondfile option1 option2 …>filename</lilypondfile>

<mediaobject>
  <imageobject>
    <imagedata fileref="music1.ly" role="printfilename" />
  </imageobject>
</mediaobject>

<inlinemediaobject>
  <textobject>
    <programlisting language="lilypond" role="fragment verbatim staffsize=16 ragged-right relative=2">
\context Staff \with {
  \remove Time_signature_engraver
  \remove Clef_engraver}
  { c4( fis) }
    </programlisting>
  </textobject>
</inlinemediaobject>

3.3 楽譜断片オプション

以下では、‘LilyPond コマンド’ は、これまでのセクションで説明した楽譜断片を作り出すために lilypond-book によって処理される任意のコマンドを意味します。シンプルにするために、LaTeX 構文の LilyPond コマンドだけを示します。

オプション文字列は左から右の順で解析されるということに注意してください。あるオプションを複数指定した場合、最後のオプションが有効となります。

LilyPond コマンドで以下のオプションを使うことができます:

staffsize=ht

譜サイズを ht にセットします。単位はポイントです。

ragged-right

デフォルトの間隔を用いるため、行の右端が揃いません。つまり、LilyPond コード断片に ragged-right = ##t を追加します。明示的に noragged-right を指定しない限り、1 行の楽譜断片はデフォルトでは常に ragged-right で譜刻されます。

noragged-right

楽譜断片が 1 行の場合に、譜の長さを行幅まで広げます。つまり、LilyPond コード断片に ragged-right = ##f を追加します。

line-width

line-width=size\unit

行幅を size にセットします。unit は単位です。unit は以下の文字列のどれかです: cm, mm, in, あるいは pt。このオプションは LilyPond 出力 (つまり、楽譜断片の譜の幅に) に影響を与えますが、テキスト レイアウトには影響を与えません。

引数無しで使用した場合、行幅はデフォルト値にセットされます (試行錯誤的なアルゴリズムで算出される値です)。

line-width オプションが指定されなかった場合、lilypond-book は ragged-right オプションを使用しない lilypond 環境のデフォルトを推測しようと試みます。

papersize=string

string は scm/paper.scm で定義されている紙面サイズ – つまり、a5, quarto, 11x17 等 – です。

scm/paper.scm で定義されていない値は無視され、警告が発せられ、楽譜断片はデフォルトの a4 サイズで譜刻されます。

notime

拍子記号と小節線を譜刻しません。

fragment

lilypond-book が常用コードを追加するので、\layout, \score 等を入力する必要がなく、単に以下のように入力できます:

c'4

nofragment

楽譜断片の LilyPond コードに補完コードを追加しません。これがデフォルトなので、通常、nofragment は不要です。

indent=size\unit

楽譜の最初の段のインデントを size にセットします。unit は単位です。unit は以下の文字列のどれかです: cm, mm, in, あるいは pt。このオプションは LilyPond に影響を与えますが、テキスト レイアウトには影響を与えません。

noindent

楽譜の最初の段のインデントを 0 にセットします。このオプションは LilyPond に影響を与えますが、テキスト レイアウトには影響を与えません。これがデフォルトなので、通常、noindent は不要です。

quote

楽譜の両端に 0.4in のインデントを挿入して、引用ブロックで囲みます。値 ‘0.4in’ は exampleindent オプションで制御することができます。

exampleindent

quote オプションが楽譜断片に挿入するインデントの量をセットします。

relative

relative=n

相対オクターブ モードを使用します。デフォルトでは、音符はミドル C との相対関係で指定します。オプションで指定する整数の引数は開始音符のオクターブを指定します – デフォルトの 1 はミドル C です。relative オプションは fragment オプションがセットされている場合にのみ機能するため、relative オプションがセットされるとソースの中の (no)fragment オプション有無にかかわらず fragment が自動的、暗黙的にセットされます。

LilyPond もそれ自体のドキュメントを作り出すのに lilypond-book を使います。LilyPond のドキュメントを作るために、さらに細かな楽譜断片オプションが用意されています。

verbatim

LilyPond コマンドの引数をそのまま出力ファイルにコピーして、ブロックで囲み、その後に intertext オプションで与えられた任意のテキストが続きます (intertext オプションはまだ実装されていません)。それから実際の楽譜が表示されます。段落の一部となっている \lilypond{} でこのオプションを指定しても機能しません。

lilypondfile コマンドで verbatim を使用した場合、ソース ファイルの一部だけをそのままコピーして囲むことができます。ソース ファイルが ‘begin verbatim’ (引用符を除く) という文字列を含むコメントを保持している場合、最後の ‘begin verbatim’ より後のソースが引用されます。同様に、‘end verbatim’ を含むコメントがあれば、ソースの引用は最初の ‘end verbatim’ の前で終了します。以下のソース ファイル例で、楽譜コードは相対モードで解釈されますが、ソースの引用に relative ブロックは表示されません。つまり、

\relative { % begin verbatim
  c'4 e2 g4
  f2 e % end verbatim
}

上記のソースは以下のように引用されます。

  c4 e2 g4
  f2 e

ソースの引用の中にあるコメントと変数名を翻訳したけれども、ソース自体の中にあるコメントと変数名は翻訳したくない場合、環境変数 LYDOC_LOCALEDIR をディレクトリ パスにセットします – セットしたディレクトリはドメインに lilypond-doc を指定した.mo メッセージ カタログのツリーを保持する必要があります。

texidoc

(Texinfo 出力専用です) 入力ファイル foo.ly に対して --header=texidoc オプションを指定して lilypond を呼び出した場合、入力ファイルの \header に texidoc フィールドがあればファイル foo.texidoc が作成されます。texidoc オプションは lilypond-book にそのようなファイルをインクルードさせ、その内容を楽譜断片の直前 (ただし、quote オプションによって生成される example 環境の外側) にドキュメントとして追加させます。

ファイル foo.ly は以下を保持していて、

\header {
  texidoc = "This file demonstrates a single note."
}
{ c'4 }

Texinfo ドキュメント test.texinfo に以下の記述があると仮定すると、

@lilypondfile[texidoc]{foo.ly}

以下のコマンドで期待した結果を得られます。

lilypond-book --pdf --process="lilypond \
  --header=texidoc" test.texinfo

たいていの LilyPond テスト ドキュメント (配布ソースの input ディレクトリにあります) はこのような形の小さな .ly ファイルです。

ローカライズするために Texinfo ドキュメントが @documentlanguage LANG 保持していて、foo.ly のヘッダが texidocLANG フィールドを保持している場合、--header=texidocLANG を付けて lilypond を呼び出すと、foo.texidoc の代わりに foo.texidocLANG がインクルードされます。

doctitle

(Texinfo 出力専用です) このオプションは texidoc オプションと同じような働きをします: \header に doctitle フィールドを持つ入力ファイル foo.ly に対して --header=doctitle オプションを指定して lilypond を呼び出した場合、foo.doctitle が生成されます。doctitle オプションを使用した場合、foo.doctitle の内容 – 1 行のテキスト text である必要があります – は Texinfo ドキュメントに @lydoctitle text として挿入されます。@lydoctitle は Texinfo ドキュメントの中で定義されたマクロである必要があります。あとはローカライズされた言語に対する texidoc 処理と同じ説明になります。

nogettext

(Texinfo 出力専用です) 楽譜ソース引用の中にあるコメントと変数名を翻訳しません。

printfilename

\lilypondfile で LilyPond 入力ファイルをインクルードした場合、楽譜断片の直前にインクルードしたファイルの名前を表示します。HTML 出力では、これはリンクになります。ファイルのベース名だけが表示されます – つまり、ファイル パスのディレクトリ部分は取り除かれます。

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 だけが処理されます。

3.5 ファイル拡張子

入力ファイルに対して任意のファイル拡張子を使うことができます。しかしながら、ある形式のファイルに対して推奨する拡張子を使わなかった場合、手動で出力形式を指定する必要があるかもしれません – 詳細は lilypond-book を呼び出す を参照してください。推奨する拡張子を使えば、lilypond-book はその拡張子に基づいて自動的に出力形式を選択します。

拡張子	出力形式
.html	HTML
.htmly	HTML
.itely	Texinfo
.latex	LaTeX
.lytex	LaTeX
.lyxml	DocBook
.tely	Texinfo
.tex	LaTeX
.texi	Texinfo
.texinfo	Texinfo
.xml	HTML

入力ファイルの拡張子を lilypond-book が出力ファイルに付ける拡張子と同じで、入力ファイルが lilypond-book の作業ディレクトリに置かれている場合、--output オプションを使って lilypond-book を実行する必要があります。そうしないと、“Output would overwrite input file” のようなエラー メッセージが表示されて、終了します。

3.6 lilypond-book テンプレート

以下に示すテンプレートは lilypond-book で使います。lilypond-book に馴染みが無いのであれば、lilypond-book を実行する を読んで下さい。

LaTeX

LilyPond 断片を LaTeX ドキュメントに組み込むことができます。

\documentclass[]{article}

\begin{document}

通常の LaTeX テキスト。

\begin{lilypond}
\relative {
  a'4 b c d
}
\end{lilypond}

次の LaTeX テキスト。オプションは角括弧の中に入れます。

\begin{lilypond}[fragment,relative=2,quote,staffsize=26,verbatim]
d4 c b a
\end{lilypond}
\end{document}

Texinfo

LilyPond 断片を Texinfo に組み込むことができます。実際、このマニュアル全体が Texinfo で記述されています。

\input texinfo @node Top
@top

Texinfo テキスト

@lilypond
\relative {
  a4 b c d
}
@end lilypond

次の Texinfo テキスト。オプションは角括弧の中に入れます。

@lilypond[verbatim,fragment,ragged-right]
d4 c b a
@end lilypond

@bye

html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML>
<body>

<p>

以下のように、lilypond-book 用のドキュメントには自由に楽譜と
テキストを組み合わせることができます。
<lilypond>
\relative {
  a'4 b c d
}
</lilypond>
</p>

<p>
次の lilypond コードにはオプションをつけます

<lilypond fragment quote staffsize=26 verbatim>
a4 b c d
</lilypond>
</p>

</body>
</html>

xelatex

\documentclass{article}
\usepackage{ifxetex}
\ifxetex
%xetex specific stuff
\usepackage{xunicode,fontspec,xltxtra}
\setmainfont[Numbers=OldStyle]{Times New Roman}
\setsansfont{Arial}
\else
%This can be empty if you are not going to use pdftex
\usepackage[T1]{fontenc}
\usepackage[utf8]{inputenc}
\usepackage{mathptmx}%Times
\usepackage{helvet}%Helvetica
\fi
%Here you can insert all packages that pdftex also understands
\usepackage[ngerman,finnish,english]{babel}
\usepackage{graphicx}

\begin{document}
\title{A short document with LilyPond and xelatex}
\maketitle

Normal \textbf{font} commands inside the \emph{text} work,
because they \textsf{are supported by \LaTeX{} and XeteX.}
If you want to use specific commands like \verb+\XeTeX+, you
should include them again in a \verb+\ifxetex+ environment.
You can use this to print the \ifxetex \XeTeX{} command \else
XeTeX command \fi which is not known to normal \LaTeX .

In normal text you can easily use LilyPond commands, like this:

\begin{lilypond}
{a2 b c'8 c' c' c'}
\end{lilypond}

\noindent
and so on.

The fonts of snippets set with LilyPond will have to be set from
inside
of the snippet.  For this you should read the AU on how to use
lilypond-book.

\selectlanguage{ngerman}
Auch Umlaute funktionieren ohne die \LaTeX -Befehle, wie auch alle
anderen
seltsamen Zeichen: __ ______, wenn sie von der Schriftart
unterst__tzt werden.
\end{document}

3.7 目次を共有する

この機能はすでに OrchestralLily パッケージで用意されています:

https://repo.or.cz/w/orchestrallily.git

より自由度の高いテキスト処理をするために、lilypond から目次をエクスポートして、LaTeX に読み込ませる方法を好むユーザもいるかもしれません。

LilyPond から目次をエクスポートする

以下のコードは、複数の楽章を 1 つのファイルに出力するものと仮定しています。

#(define (oly:create-toc-file layout pages)
  (let* ((label-table (ly:output-def-lookup layout 'label-page-table)))
    (if (not (null? label-table))
      (let* ((format-line (lambda (toc-item)
             (let* ((label (car toc-item))
                    (text  (caddr toc-item))
                    (label-page (and (list? label-table)
                                     (assoc label label-table)))
                    (page (and label-page (cdr label-page))))
               (format #f "~a, section, 1, {~a}, ~a" page text label))))
             (formatted-toc-items (map format-line (toc-items)))
             (whole-string (string-join formatted-toc-items ",\n"))
             (output-name (ly:parser-output-name))
             (outfilename (format #f "~a.toc" output-name))
             (outfile (open-output-file outfilename)))
        (if (output-port? outfile)
            (display whole-string outfile)
            (ly:warning (G_ "Unable to open output file ~a for the TOC information") outfilename))
        (close-output-port outfile)))))

\paper {
  #(define (page-post-process layout pages) (oly:create-toc-file layout pages))
}

LaTeX に目次をインポートする

LaTeX ファイルのヘッダ中に以下を記述します:

\usepackage{pdfpages}
\includescore{nameofthescore}

ここで、\includescore は以下のように定義されています:

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% \includescore{PossibleExtension}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

% Read in the TOC entries for a PDF file from the corresponding .toc file.
% This requires some heave latex tweaking, since reading in things from a file
% and inserting it into the arguments of a macro is not (easily) possible

% Solution by Patrick Fimml on #latex on April 18, 2009:
% \readfile{filename}{\variable}
% reads in the contents of the file into \variable (undefined if file
% doesn't exist)
\newread\readfile@f
\def\readfile@line#1{%
{\catcode`\^^M=10\global\read\readfile@f to \readfile@tmp}%
\edef\do{\noexpand\g@addto@macro{\noexpand#1}{\readfile@tmp}}\do%
\ifeof\readfile@f\else%
\readfile@line{#1}%
\fi%
}
\def\readfile#1#2{%
\openin\readfile@f=#1 %
\ifeof\readfile@f%
\typeout{No TOC file #1 available!}%
\else%
\gdef#2{}%
\readfile@line{#2}%
\fi
\closein\readfile@f%
}%


\newcommand{\includescore}[1]{
\def\oly@fname{\oly@basename\@ifmtarg{#1}{}{_#1}}
\let\oly@addtotoc\undefined
\readfile{\oly@xxxxxxxxx}{\oly@addtotoc}
\ifx\oly@addtotoc\undefined
\includepdf[pages=-]{\oly@fname}
\else
\edef\includeit{\noexpand\includepdf[pages=-,addtotoc={\oly@addtotoc}]
{\oly@fname}}\includeit
\fi
}

3.8 テキストと楽譜を組み合わせる他の方法

lilypond-book を使わずにテキストと楽譜を組み合わせる方法を LilyPond 出力を他のプログラムで使用する で説明しています。

4.1 ポイント＆クリック

ポイント＆クリックは PDF ビューアの中で表記をクリックすることで入力の中の表記を見つけ出すことを可能にします。これは楽譜の中でエラーを引き起こす入力を見つけ出すことをより容易にします。

export LYEDITOR=atom

atom %(file)s:%(line)s:%(column)s

export LYEDITOR="code --goto %(file)s:%(line)s:%(column)s"

urlCommand     "lilypond-invoke-editor %s"

sudo apt-mark hold xpdf

gconftool-2 -t string -s /desktop/gnome/url-handlers/textedit/command "lilypond-invoke-editor %s"
gconftool-2 -s /desktop/gnome/url-handlers/textedit/needs_terminal false -t bool
gconftool-2 -t bool -s /desktop/gnome/url-handlers/textedit/enabled true

gnome-open textedit:///etc/issue:1:0:0

[Desktop Entry]
Version=1.0
Name=lilypond-invoke-editor
GenericName=Textedit URI handler
Comment=URI handler for textedit:
Exec=lilypond-invoke-editor %u
Terminal=false
Type=Application
MimeType=x-scheme-handler/textedit;
Categories=Editor
NoDisplay=true

xdg-desktop-menu install ./lilypond-invoke-editor.desktop
xdg-mime default lilypond-invoke-editor.desktop x-scheme-handler/textedit

gnome-open textedit:///etc/issue:1:0:0

# For Textedit links
/usr/local/bin/lilypond-invoke-editor Cx -> sanitized_helper,

sudo apparmor_parser -r -T -W /etc/apparmor.d/usr.bin.evince

\pointAndClickOff

\pointAndClickOn

lilypond -dno-point-and-click file.ly

4.2 テキスト エディタ サポート

いくつかのテキスト エディタの LilyPond サポート機能があります。

(setq load-path (append (list (expand-file-name "~/site-lisp")) load-path))

filetype off
set runtimepath+=/usr/local/share/lilypond/current/vim/
filetype on
syntax on

4.3 他のフォーマットから変換する

楽譜の記述を他のフォーマットからインポートするもできます。この章では、配布プログラムに含まれるインポート ツールについて説明します。 LilyPond 入力を作り出すツールは他にもあります。例えば GUI シーケンスと XML コンバータです。詳細は website を参照してください。

上で述べたツールは lilypond とは別のプログラムであり、コマンド ラインで実行します。詳細は コマンド ラインの使用方法 を参照してください。あなたが MacOS 10.3 や 10.4 を使っていて、これらのスクリプト (例えば convert-ly) を実行する際に問題が発生した場合は、MacOS X を参照してください。

既知の問題と警告

残念なことに我々にはこれらのプログラムを維持していくだけの余力はありません。“これからの課題” になっていると考えてください。パッチは適用されていますが、バグ レポートはほとんど解決されていません。

midi2ly [option]… midi-file

musicxml2ly [option]… file.xml

abc2ly [option]… abc-file

%%LY voices \set autoBeaming = ##f

%%LY slyrics more words

etf2ly [option]… etf-file

4.4 LilyPond 出力を他のプログラムで使用する

このセクションでは、lilypond-book を用いた自動手法ではない、テキストと楽譜を統合する手法を示します。

\paper{
  indent=0\mm
  line-width=120\mm
  oddFooterMarkup=##f
  oddHeaderMarkup=##f
  bookTitleMarkup = ##f
  scoreTitleMarkup = ##f
}

 … music … 

lilypond -dbackend=eps -dno-gs-load-fonts -dinclude-eps-fonts myfile.ly

lilypond -dbackend=eps -dno-gs-load-fonts -dinclude-eps-fonts --png myfile.ly

lilypond -dbackend=eps -dno-gs-load-fonts -dinclude-eps-fonts -dpixmap-format=pngalpha --png myfile.ly

4.5 独立した include

出力にある効果を生み出すために、LilyPond に \include することのできるファイルを作っているユーザがいます。以下にあるものは LilyPond に付属しているものです。入力ファイルに取り組む も参照してください。

5.1 一般的な提案

ここで、譜刻の際に起こる、最もよくある問題を回避 (あるいは修正) する手助けになりうる提案をいくつか挙げます:

• どんなに小さいファイルでも、すべての入力ファイルに必ず \version 番号を含めるべきです。これは、LilyPond のどのバージョンでファイルが作られたかを覚えておかなくて良くなりますし、convert-ly を使ってファイルを更新する の際に特に関わってきます (convert-ly は \version が含まれている必要があります)。あるいは他のユーザに入力ファイルを送る際 (例えばメーリング リストで助けを得るとき) にも重要です。テンプレートはすべて \version 情報を保持しているということに注意してください。
• 入力ファイル 1 行につき、1 小節の音楽を書きます。 これは入力ファイルに関するあらゆる問題のデバッグを簡単にします。
• 小節と小節番号のチェックとオクターブ チェックを含めます。入力ファイルにこのような‘チェック’を含めておくことで、ミスを特定するのが早くなります。チェックをどのぐらいの頻度で追加するかは、その音楽の複雑さ次第です。簡単な音楽であれば、戦略上重要なポイントにいくつか追加するだけで十分でしょう。しかし、多くの声部や譜を持つようなもっと複雑な音楽であれば、おそらく各小節にチェックを入れたほうが良いでしょう。
• 入力ファイルにコメントをつけます。コメントとして音楽テーマへの参照 (‘ヴァイオリンの第 2 テーマ’, ‘第 4 変奏’) など) や、単純に小節番号を追加することは、入力ファイルの中の場所を特定するのを簡単にします。特に後で何かを変更しなければならない場合や、LilyPond 入力ファイルを他の人に渡す際には特に役立ちます。
• セクションの開始時に明示的に演奏時間を付け加えます。例えば、ただ c d e f と書く代わりに c4 d e f と書くことで、後で音楽を再配置するのが簡単になります。
• 波括弧と並列表記にインデントを施します。問題はしばしば、どちらかの括弧が‘足りない’ことが原因です。波括弧の‘始まり’と‘終わり’ (あるいは << と >>) に明確なインデントを追加することで、このような問題を避けやすくなります。例えば以下の入力:

  \new Staff {
    \relative {
      r4 g'8 g c8 c4 d |
      e4 r8 |
      % Ossia section
      <<
        { f8 c c | }
        \new Staff {
          f8 f c |
        }
      >>
      r4 |
    }
  }
  

  は以下の入力より括弧の対応を追いかけやすいです:

  \new Staff { \relative { r4 g'8 g c4 c8 d | e4 r8
  % Ossia section
  << { f8 c c } \new Staff { f8 f c } >> r4 | } }
  

• \layout ブロックにオーバライドを追加することによって、音楽とスタイルを分割します:

  \score {
    …music…
    \layout {
     \override TabStaff.Stemstencil = ##f
   }
  }
  

  このオーバライドは新しいコンテキストを生成しませんが、コンテキストが生成された際に適用されます。変数と関数を用いて入力の手間を省くやスタイル シートも参照してください。

5.2 既存の音楽を譜刻する

既存の楽譜からの音楽を入力している (つまり、既存の楽譜の楽曲を譜刻している) のなら、

• 1 回につき 1 つのシステム (訳者: システムとは譜の集まりのこと。例えば、ピアノ譜での 1 システムとは、右手譜 1 小節とそれに対応する左手譜 1 小節) を入力し (しかし、それでもテキスト 1 行につき 1 小節だけにします)、それを終えたときに各システムをチェックします。処理をスピード アップさせるために showLastLength プロパティや showFirstLength プロパティを使うことになるかもしれません – Skipping corrected music を参照してください。
• mBreak = { \break } を定義して、写している楽譜が改行するたびに \mBreak を入力ファイルに挿入します。これにより、LilyPond の音楽とオリジナルの音楽を比較することがずっと容易になります。入力した楽譜の校正が終わったときに、それらの改行すべてを削除するために mBreak = { } を定義することになるかもしれません。これにより、LilyPond は LilyPond が最適と思う場所に改行を入れることができるようになります。
• 移調楽器のパートは変数に入力します。移調楽器の音符は以下で囲むことを推奨します:

  \transpose c natural-pitch {…}
  

  (natural-pitch はその楽器のオープン ピッチです) これにより、変数の中の音楽は C で効率的に記述することができます。変数を使用していれば、必要なときに移調しなおすこともできます (例えば、楽譜をコンサート ピッチで譜刻したり、トロンボーン パートをト音記号からヘ音記号に変換したり、など)。音楽をすべて変数の中に首尾一貫したピッチで記述しておけば、移調のミスは起こりにくくなります。

  また、移調が C との間で行われるだけ – つまり、他に使用する調が楽器のナチュラル ピッチだけ: B-フラット トランペットなら bes、A-フラット クラリネットなら aes – であるとしても、音楽を変数に格納しておくべきです。

5.3 大きなプロジェクト

大きなプロジェクトに取り組んでいるとき、LilyPond 入力ファイルの構造をすっきりさせておくことが不可欠です。

• 各ボイスに対して変数を使用して、定義の中の構造を最小限にします。\score セクションの構造が最も変更される可能性が高い箇所です。一方、violin 定義は LilyPond のバージョンが新しくなっても変更される可能性はまずありません。

  violin = \relative {
  g'4 c'8. e16
  }
  …
  \score {
    \new GrandStaff {
      \new Staff {
        \violin
      }
    }
  }
  

• 調整を音楽定義から分離します。このことは前にも触れましたが、大きなプロジェクトでは絶対に不可欠なことです。fthenp の定義を変更する必要が生じた場合、変更は 1 回で済み、violin の内部にはまったく手を触れる必要がありません。

  fthenp = _\markup{
    \dynamic f \italic \small { 2nd } \hspace #0.1 \dynamic p }
  violin = \relative {
  g'4\fthenp c'8. e16
  }
  

5.4 トラブルシュート

遅かれ早かれ、あなたは LilyPond がコンパイルできないファイルを書くことになります。LilyPond が返すメッセージはエラーを見つけ出す手助けになるかもしれませんが、多くの場合、問題の原因を探し出すために調査を行う必要があります。

この目的のための最も強力なツールは 1 行コメント (% で記述します) とブロック コメント (%{…%} で記述します) です。問題がどこにあるかわからない場合、入力ファイルの大きな一部分をコメント アウトすることから始めます。あるセクションをコメント アウトして、そのファイルを再びコンパイルしてみます。コンパイルが通ったのなら、問題は今コメント アウトした部分の中にあります。コンパイルが通らなかった場合は、コンパイルが通るようになるまでコメント アウトしたままにしておきます。

極端な場合、最終的に以下のようになるかもしれません:

\score {
  <<
    % \melody
    % \harmony
    % \bass
  >>
  \layout{}
}

(言い換えると、何の音楽も持たないファイルです)

こうなったとしても、あきらめないでください。少しだけコメントを外して – 例えば、バス パートを – コンパイルが通るかどうか試してみます。コンパイルが通らなかった場合は、バスの音楽をすべてコメント アウトします (しかし、\score の中の \bass はコメントを外したままにしておきます)。

bass = \relative {
%{
  c'4 c c c
  d d d d
%}
}

そして、問題を起こしている行を見つけ出すまで、bass パートから少しずつコメントを外していきます。

もう 1 つの非常に有用なデバッグ テクニックは Tiny examples を構築することです。

5.5 Make と Makefile

LilyPond を実行できるほとんどすべてのプラットフォームが make というソフトウェアをサポートします。このソフトウェアは Makefile という名前の特殊なファイルを読み込みます。ファイル Makefile は、ファイルの依存関係と、あるファイルから別のファイルを作り出すためにオペレーティング システムに渡す必要があるコマンドを定義します。例えば、Makefile は LilyPond を実行して ballad.ly から ballad.pdf と ballad.midi を作り出す方法を記述します。

自身の便利さのためかソース ファイルにアクセスしてくれる他の人のために、自身のプロジェクト用に Makefile を作成することが良い場合があります。これが当てはまるのは、多くのインクルード ファイルと複数の出力オプション (例えば、フル スコア、パート スコア、指揮譜、ピアノ譜など) を持つ 非常に大きなプロジェクト、あるいは、ビルドするために複雑なコマンドを必要とするプロジェクト (lilypond-book プロジェクトなど) です。Makefile の複雑さと自由度は、必要性と作者のスキルに応じて、さまざまです。プログラム GNU Make は GNU/Linux ディストリビューションと MacOS X にインストールされていて、Windows でも利用可能です。

make の使い方についてのすべての詳細は GNU Make マニュアル を参照してください。これから示すのは make でできることのほんの一例です。

Makefile の中に規則を定義するためのコマンドは、プラットフォームによって異なります。例えば、さまざまな種類がある GNU/Linux と MacOS は bash を使いますが、Windows は cmd を使います。MacOS X では、コマンド ライン インタプリタを使用するためにシステムをコンフィグレーションする必要があるということに注意してください。ここで、Makefile の例をいくつか GNU/Linux/MacOS 用と Windows 用の両方のバージョンで示します。

最初の例は、4 楽章のオーケストラのためのもので、以下のようなディレクトリ構造を持ちます:

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

Scores ディレクトリと Parts ディレクトリの中にある .ly ファイルは音符を Notes ディレクトリの中にある .ily ファイルから取得します:

%%% top of file "symphony-cello.ly"
\include ../symphonyDefs.ily
\include ../Notes/cello.ily

この Makefile はターゲットとして score (フル スコアの楽曲全体)、movements (フル スコアの個々の楽章)、それに parts (演奏者のための個々のパート) を持ちます。さらに、web や email で配布するのに適したソース ファイルの tarball (訳者: 複数のファイルをコマンド tar で 1 つのファイルにまとめたもの) を作成するターゲット archive もあります。ここでは GNU/Linux や MacOS X 用の Makefile を示します。これをプロジェクトのトップ ディレクトリに Makefile という名前で保存する必要があります:

# 出力ファイル名
piece = symphony
# いくつプロセッサがあるかを決定します
CPU_CORES=`cat /proc/cpuinfo | grep -m1 "cpu cores" | sed s/".*: "//`
# lilypond を実行するコマンド
LILY_CMD = lilypond -ddelete-intermediate-files \
                    -dno-point-and-click -djob-count=$(CPU_CORES)

# この Makefile で使用される拡張子
.SUFFIXES: .ly .ily .pdf .midi

# 入力ファイルと出力ファイルのサーチは VPATH 変数でリストアップされている
# ディレクトリの中で行われます。それらのディレクトリはすべて (GNU make 変数
# `CURDIR' によって与えられる) カレント ディレクトリのサブディレクトリです。
VPATH = \
  $(CURDIR)/Scores \
  $(CURDIR)/PDF \
  $(CURDIR)/Parts \
  $(CURDIR)/Notes

# LY 入力ファイルから PDF ファイルと MIDI ファイルを作成するための
# パターン ルール。.pdf 出力ファイルは `PDF' サブディレクトリの中に
# 配置され、.midi ファイルは `MIDI' サブディレクトリの中に配置されます。
%.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

# 楽章の依存関係
$(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

# 4 つすべての楽章のフル スコアを 1 つのファイルとして生成するには
# `make score' とタイプします。
.PHONY: score
score: $(piece).pdf

# すべてのパートを生成するには `make parts' とタイプします。
# 楽器 `foo' のためのパートを生成するには `make foo.pdf' とタイプします。
# 例: `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

# 4 つの楽章を別個のファイルとして生成するには `make movements' とタイプします。
.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/*

Windows プラットフォームには特別な面倒さがあります。Windows 用の GNU Make をダウンロードしてインストールした後、システム環境変数に正しいパスを設定して、DOS シェルが Make プログラムを見つけられるようにする必要があります。これを行うには、"マイ コンピュータ" を右クリックして、プロパティ を選択し、それから 詳細設定 を選択します。それから 環境変数 をクリックして、システム環境変数 パネルの中にある Path をハイライトしてから 編集 をクリックして、GNU Make の実行ファイルへのパスを追加します。そのパスは以下のようになります (訳者: GNU Make のインストールのされ方によって異なります):

C:\Program Files\GnuWin32\bin

Linux/MacOS X とは異なるシェル コマンドを扱い、いくつかのデフォルト システム ディレクトリの中に存在するファイル空間を扱うために、Makefile 自体を変更する必要があります。Windows は tar コマンドを持たないため、archive ターゲットは除去されます。また、Windows が持つ MIDI ファイルのデフォルト拡張子は異なります。

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

#get the 8.3 name of CURDIR (workaround for spaces 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) $<      # this line begins with a tab
        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

次の Makefile は、LaTeX で処理する lilypond-book ドキュメント用です。このドキュメントは目次を持ちます。目次を作成するには、リンクを更新するために latex コマンドを 2 回実行する必要があります。.pdf 出力ファイルは out ディレクトリに保存され、HTML 出力ファイルは htmlout ディレクトリに保存されます。

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: make this thing work on Windows

この Makefile は Windows では機能しません。Windows ユーザの代替手段として、ビルド コマンドを保持する簡単なバッチ ファイルを作成する方法があります。これは Makefile のように依存関係を保持できませんが、少なくともビルド処理を単一のコマンドに縮小します。以下のコードを build.bat あるいは build.cmd として保存してください。このバッチ ファイルは DOS プロンプトから実行することができ、単にそのアイコンをダブル クリックすることでも実行することができます。

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

参照

アプリケーションの使用方法: コマンド ラインの使用方法, lilypond-book を実行する