X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2Flilypond-book.itely;h=1740048733772579b81713e1d036b603f0554283;hb=fb6833bb025d7b83b5b75067e16caae6a95f340e;hp=e3484788f3c4bcd6601d6b73a21964261b2c0b4e;hpb=37d72d28459b780761f912b6795ca213e9a5db9d;p=lilypond.git diff --git a/Documentation/user/lilypond-book.itely b/Documentation/user/lilypond-book.itely index e3484788f3..1740048733 100644 --- a/Documentation/user/lilypond-book.itely +++ b/Documentation/user/lilypond-book.itely @@ -1,10 +1,11 @@ -@c -*-texinfo-*- +@c -*- coding: utf-8; mode: texinfo; -*- + @ignore TODO: cleanup -** AARGH.e We also have tutorial.itely: Integrating text and music. +** AARGH. We also have tutorial.itely: Integrating text and music. Could also do with a cleanup. Lost inspiration to fix this manual where to describe what? @@ -12,39 +13,140 @@ TODO: cleanup @end ignore -@node Integrating text and music with lilypond-book -@chapter Integrating text and music with lilypond-book - -If you want to add pictures of music to a document, you can simply do -it the way you would do with other types of pictures. You write -LilyPond code, process it separately to embedded PostScript or -@code{png}, and include it as a picture into your La@TeX{} or -@code{html} source. +@c Note: keep this node named so that `info lilypond-book' brings you here. +@node LilyPond-book +@chapter @command{lilypond-book}: Integrating text and music -@command{lilypond-book} provides you with a way to automate this -process: This program extracts snippets of music from your document, -runs LilyPond on them, and outputs your document with the resulting -pictures substituted for the music you entered. The line width and -font size definitions for the music are adjusted to match the layout -of your document. +If you want to add pictures of music to a document, you can simply do it +the way you would do with other types of pictures. The pictures are +created separately, yielding PostScript output or PNG images, and those +are included into a La@TeX{} or HTML document. -It can work on La@TeX{}, @code{html} or texinfo documents. A tutorial -on using lilypond-book is in @ref{Integrating text and music}. In -case that you do not know La@TeX{}, then -@uref{http://www.ctan.org/tex-archive/info/lshort/english/,The not so -Short Introduction to LaTeX} provides a introction to using La@TeX{}. +@command{lilypond-book} provides a way to automate this process: This +program extracts snippets of music from your document, runs +@command{lilypond} on them, and outputs the document with pictures +substituted for the music. The line width and font size definitions for +the music are adjusted to match the layout of your document. +This procedure may be applied to La@TeX{}, HTML or Texinfo documents. @menu +* An example of a musicological document:: +* Integrating LaTeX and music:: * Integrating Texinfo and music:: -* Integrating La@TeX{} and music:: * Integrating HTML and music:: * Music fragment options:: * Invoking lilypond-book:: +* Filename extensions:: @end menu -TODO: explain how to use lilypond fonts in text. +@node An example of a musicological document +@section An example of a musicological document + +@cindex musicology +@cindex La@TeX{}, music in +@cindex HTML, music in +@cindex Texinfo, music in +Some texts contain music examples. These texts are musicological +treatises, songbooks, or manuals like this. Such texts can be made by +hand, simply by importing a PostScript figure into the word processor. +However, there is an automated procedure to reduce the amount of work +involved in HTML, La@TeX{}, and Texinfo documents. + +A script called @code{lilypond-book} will extract the music fragments, +format them, and put back the resulting notation. Here we show a small +example for use with La@TeX{}. The example also contains explanatory +text, so we will not comment on it further. + +@quotation +@verbatim +\documentclass[a4paper]{article} + +\begin{document} + +Documents for @command{lilypond-book} may freely mix music and text. +For example, + +\begin{lilypond} +\relative c' { + c2 g'2 \times 2/3 { f8 e d } c'2 g4 +} +\end{lilypond} + +Options are put in brackets. + +\begin[fragment,quote,staffsize=26,verbatim]{lilypond} + c'4 f16 +\end{lilypond} + +Larger examples can be put into a separate file, and introduced with +\verb+\lilypondfile+. + +\lilypondfile[quote,noindent]{screech-boink.ly} + +\end{document} +@end verbatim +@end quotation + +Under Unix, you can view the results as follows + +@example +cd input/tutorial +mkdir -p out/ +lilypond-book --output=out --psfonts lilybook.tex +@emph{lilypond-book (GNU LilyPond) 2.6.0} +@emph{Reading lilybook.tex...} +@emph{..lots of stuff deleted..} +@emph{Compiling out/lilybook.tex...} +cd out +latex lilybook +@emph{lots of stuff deleted} +xdvi lilybook +@end example + +To convert the file into a PDF document, run the following commands + +@example +dvips -o -Ppdf -h lilybook.psfonts lilybook +ps2pdf lilybook.ps +@end example + +Running @command{lilypond-book} and @command{latex} creates a lot of +temporary files, which would clutter up the working directory. To +remedy this, use the @code{--output=@var{dir}} option. It will create +the files in a separate subdirectory @file{dir}. + +Running dvips will produce many warnings about fonts. They are not +harmful; please ignore them. + +Finally the result of the La@TeX{} example shown above.@footnote{This +tutorial is processed with Texinfo, so the example gives slightly +different results in layout.} This finishes the tutorial section. + +@page + +Documents for @command{lilypond-book} may freely mix music and text. +For example, + +@lilypond +\relative c' { + c2 g'2 \times 2/3 { f8 e d } c'2 g4 +} +@end lilypond + +Options are put in brackets. + +@lilypond[fragment,quote,staffsize=26,verbatim] +c'4 f16 +@end lilypond + +Larger examples can be put into a separate file, and introduced with +@code{\lilypondfile}. + +@lilypondfile[quote,noindent]{screech-boink.ly} + +@page @cindex texinfo @cindex latex @@ -54,411 +156,539 @@ TODO: explain how to use lilypond fonts in text. @cindex documents, adding music to -@node Integrating Texinfo and music -@section Integrating Texinfo and music +@node Integrating LaTeX and music +@section Integrating La@TeX{} and music + +La@TeX{} is the de-facto standard for publishing layouts in the exact +sciences. It is built on top of the @TeX{} typesetting engine, +providing the best typography available anywhere. -You specify the LilyPond code like this: +See +@uref{http://@/www@/.ctan@/.org/@/tex@/-archive/@/info/@/lshort/@/english/, +@emph{The Not So Short Introduction to La@TeX{}}} for an overview on how +to use La@TeX{}. + +Music is entered using @example -@@lilypond[options, go, here] +\begin[options,go,here]@{lilypond@} YOUR LILYPOND CODE -@@end lilypond -@@lilypond[options, go, here]@{ YOUR LILYPOND CODE @} -@@lilypondfile[options, go, here]@{@var{filename}@} +\end@{lilypond@} @end example -Then you run lilypond-book on it, and the result is a file you can -process with texinfo. We show two simple examples here. First a -complete block: +@noindent +or @example -@@lilypond[26pt] - c' d' e' f' g'2 g' -@@end lilypond +\lilypondfile[options,go,here]@{@var{filename}@} @end example @noindent -produces this music: +or -@lilypond - c' d' e' f' g'2 g' +@example +\lilypond@{ YOUR LILYPOND CODE @} +@end example + +Running @command{lilypond-book} yields a file that can be further +processed with La@TeX{}. + +We show some examples here. The lilypond environment + +@example +\begin[quote,fragment,staffsize=26]@{lilypond@} + c' d' e' f' g'2 g'2 +\end@{lilypond@} +@end example + +@noindent +produces + +@lilypond[quote,fragment,staffsize=26] +c' d' e' f' g'2 g'2 @end lilypond -Then the short version: +The short version @example -@@lilypond[11pt]@{<>@} +\lilypond[quote,fragment,staffsize=11]@{@} @end example @noindent -and its music: +produces + +@lilypond[quote,fragment,staffsize=11]{} + +@noindent +Currently, you cannot include @code{@{} or @code{@}} within +@code{\lilypond@{@}}, so this command is only useful with the +@code{fragment} option. + +The default linewidth of the music will be adjusted by examining the +commands in the document preamble, the part of the document before +@code{\begin@{document@}}. The @command{lilypond-book} command sends +these to La@TeX{} to find out how wide the text is. The line width for +the music fragments is then adjusted to the text width. Note that this +heuristic algorithm can fail easily; in such cases it is necessary to +use the @code{linewidth} music fragment option. + +@cindex titling and lilypond-book +@cindex @code{\header} in La@TeX{} documents + +Each snippet will call the following macros if they have been defined by +the user: + +@code{\preLilyPondExample} called before the music + +@code{\postLilyPondExample} called after the music + +@code{\betweenLilyPondSystem[1]} is called between systems if +@code{lilypond-book} has split the snippet into several postscript +files. It must be defined as taking one parameter and will be +passed the number of files already included in this snippet. +The default is to simply insert a @code{\linebreak}. + +@ignore +Broken stuff. :( + +@cindex Latex, feta symbols +@cindex fetachar + +To include feta symbols (such as flat, segno, etc) in a LaTeX +document, use @code{\input@{titledefs@}} + +@example +\documentclass[a4paper]@{article@} + +\input@{titledefs@} + +\begin@{document@} + +\fetachar\fetasharp + +\end@{document@} +@end example + +The font symbol names are defined in the file feta20.tex; to find +the location of this file, use the command + +@example +kpsewhich feta20.tex +@end example + +@end ignore -@lilypond[11pt]{ <> } +@cindex outline fonts +@cindex type1 fonts +@cindex dvips +@cindex invoking dvips -@command{lilypond-book} knows the default margins and a few paper -sizes. One of these commands should be in the beginning of the document: +For printing the La@TeX{} document you need a DVI to PostScript +translator like @command{dvips}. To use @command{dvips} to produce +a PostScript file, add the following options to the @command{dvips} +command line: -@itemize @bullet -@item @code{@@afourpaper} -@item @code{@@afourlatex} -@item @code{@@afourwide} -@item @code{@@smallbook} -@end itemize +@example +-o -Ppdf -h @var{file}.psfonts +@end example @noindent -@code{@@pagesizes} are not yet supported. +where the @var{file}@command{psfonts} file is obtained from +@command{lilypond-book}, @xref{Invoking lilypond-book} for details. PDF +can then be produced with a PostScript to PDF translator like +@code{ps2pdf} (which is part of GhostScript). Running @command{dvips} +will produce some warnings about fonts; these are harmless and may +be ignored. -When producing texinfo, lilypond-book also generates bitmaps of the -music, so you can make a HTML document with embedded music. +@cindex international characters +@cindex latin1 -@node Integrating La@TeX{} and music -@section Integrating La@TeX{} and music +@node Integrating Texinfo and music +@section Integrating Texinfo and music +Texinfo is the standard format for documentation of the GNU project. An +example of a Texinfo document is this manual. The HTML, PDF, and Info +versions of the manual are made from the Texinfo document. - You specify LilyPond code like this: +In the input file, music is specified with @example -\begin[options, go, here]@{lilypond@} +@@lilypond[options,go,here] YOUR LILYPOND CODE -\end@{lilypond@} +@@end lilypond @end example +@noindent +or + @example -\lilypondfile[options, go,here]@{@var{filename}@} +@@lilypond[options,go,here]@{ YOUR LILYPOND CODE @} @end example @noindent or @example -\lilypond@{ YOUR LILYPOND CODE @} +@@lilypondfile[options,go,here]@{@var{filename}@} @end example -Then you run lilypond-book on it, and the result is a file you can -process with La@TeX{}. We show some examples here. +When @command{lilypond-book} is run on it, this results in a Texinfo +file (with extension @file{.texi}) containing @code{@@image} tags for +HTML and info output. For the printed edition, the raw @TeX{} output of +LilyPond is included in the main document. + +We show two simple examples here. A @code{lilypond} environment @example -\begin[26pt]@{lilypond@} - c' d' e' f' g'2 g'2 -\end@{lilypond@} +@@lilypond[fragment] +c' d' e' f' g'2 g' +@@end lilypond @end example @noindent -produces this music: +produces -@lilypond[26pt] - c' d' e' f' g'2 g'2 +@lilypond[fragment] +c' d' e' f' g'2 g' @end lilypond -Then the short version: +The short version @example -\lilypond[11pt]@{<>@} +@@lilypond[fragment,staffsize=11]@{@} @end example @noindent -and its music: - -@lilypond[11pt]{<>} +produces -You can use whatever commands you like in the document preamble, -the part of the document before @code{\begin@{document@}}. -@command{lilypond-book} will send it to La@TeX{} to find out how wide -the text is and adjust the linewidth variable in the paper definition of -your music according to that. +@lilypond[fragment,staffsize=11]{} -After @code{\begin@{document@}} you must be a little more careful -when you use commands that change the width of the text and how -many columns there are. @command{lilypond-book} knows about the -@code{\onecolumn} and @code{\twocolumn} commands and the @code{multicols} -environment from the multicol package. +Contrary to La@TeX{}, @code{@@lilypond@{...@}} does not generate an +in-line image. It always gets a paragraph of its own. -The music will be surrounded by @code{\preLilypondExample} and -@code{\postLilypondExample}. The variables are -defined to nothing by default, and the user can redefine them -to whatever he wants. +When using the Texinfo output format, @command{lilypond-book} also +generates bitmaps of the music (in PNG format), so you can make an HTML +document with embedded music. @node Integrating HTML and music @section Integrating HTML and music -You specify LilyPond code like this: +Music is entered using @example - - \key c \minor r8 c16 b c8 g as c16 b c8 d | g,4 + +\key c \minor c4 es g2 @end example @noindent -Then you run lilypond-book on it, and the result is a file you can -process with La@TeX{}. The final result look like +@command{lilypond-book} then produces an HTML file with appropriate image +tags for the music fragments: -@example - - \key c \minor r8 c16 b c8 g as c16 b c8 d | g,4 - -@end example - -@lilypond[relative1] - \key c \minor r8 c16 b c8 g as c16 b c8 d | g,4 +@lilypond[fragment,relative=2] +\key c \minor c4 es g2 @end lilypond -For inline pictures, use @code{} syntax, eg. +For inline pictures, use @code{}, where the options +are separated by a colon from the music, for example + @example -Some music in a line of text. +Some music in a line of text. @end example -A special feature not (yet) available in other output formats, is the -@code{} tag, for example +To include separate files, say + @example - trip.ly +@var{filename} @end example -This runs @file{trip.ly} through ly2dvi (See also @ref{Invoking -ly2dvi}), and substitutes a preview image in the output. The image -links to a separate HTML file, so clicking it will take the viewer to -a menu, with links to images, midi and printouts. -@cindex ly2dvi -@cindex titling in THML +@cindex titling in HTML @cindex preview image @cindex thumbnail + @node Music fragment options @section Music fragment options -The commands for lilypond-book have room to specify options. These -are all of the options: +In the following, a ``LilyPond command'' refers to any command described +in the previous sections which is handled by @command{lilypond-book} to +produce a music snippet. For simplicity, LilyPond commands are only +shown in La@TeX{} syntax. -@table @code -@item eps -This will create the music as eps graphics and include it into the -document with the @code{\includegraphics} command. It works in -La@TeX{} only. +Note that the option string is parsed from left to right; if an option +occurs multiple times, the last one is taken. -This enables you to place music examples in the running text (and not in -a separate paragraph). To avoid that La@TeX{} places the music on a line -of its own, there should be no empty lines between the normal text and -the LilyPond environment. For inline music, you probably also need a -smaller music font size (e.g.@: 11@dmn{pt} or 13@dmn{pt}) +The following options are available for LilyPond commands: -@item verbatim -CONTENTS is copied into the source enclosed in a verbatim block, -followed by any text given with the @code{intertext} option, then -the actual music is displayed. This option does not work with -the short version of the LilyPond blocks: +@table @code +@item staffsize=@var{ht} +Set staff size to @var{ht}, which is measured in points. + +@item raggedright +Produce ragged-right lines with natural spacing (i.e., @code{raggedright += ##t} is added to the LilyPond snippet). This is the default for the +@code{\lilypond@{@}} command if no @code{linewidth} option is present. +It is also the default for the @code{lilypond} environment if the +@code{fragment} option is set, and no line width is explicitly +specified. + +@item packed +Produce lines with packed spacing (i.e., @code{packed = ##t} is added +to the LilyPond snippet). + +@item linewidth +@itemx linewidth=@var{size}\@var{unit} +Set line width to @var{size}, using @var{unit} as units. @var{unit} is +one of the following strings: @code{cm}, @code{mm}, @code{in}, or +@code{pt}. This option affects LilyPond output (this is, the staff +length of the music snippet), not the text layout. + +If used without an argument, set line width to a default value (as +computed with a heuristic algorithm). + +If no @code{linewidth} option is given, @command{lilypond-book} tries to +guess a default for @code{lilypond} environments which don't use the +@code{raggedright} option. -@code{ @@lilypond@{ CONTENTS @} } and @code{ \lilypond@{ CONTENTS @} } +@item notime +Do not print the time signature, and turns off the timing (key signature, +bar lines) in the score. -@item smallverbatim -Like @code{verbatim}, but in a smaller font. +@item fragment +Make @command{lilypond-book} add some boilerplate code so that you can +simply enter, say, -@item intertext="@var{text}" -Used in conjunction with @code{verbatim} option: This puts -@var{text} between the code and the music (without indentation). +@example +c'4 +@end example -@item filename="@var{filename}" -Save the LilyPond code to @var{filename}. By default, a hash value -of the code is used. +@noindent +without @code{\layout}, @code{\score}, etc. -@item 11pt -@lilypond[11pt, eps] -\relative c' { - r16 [c d e][f d e c] [g'8 c][b-\prall c] | - [d16 g, a b][c a b g][d'8 g f-\prall g] -} -@end lilypond +@item nofragment +Don't add additional code to complete LilyPond code in music snippets. +Since this is the default, @code{nofragment} is redundant normally. -@item 13pt -@lilypond[13pt, eps] -\relative c' { - r16 [c d e][f d e c] [g'8 c][b-\prall c] | - [d16 g, a b][c a b g][d'8 g f-\prall g] -} -@end lilypond +@item indent=@var{size}\@var{unit} +Set indentation of the first music system to @var{size}, using +@var{unit} as units. @var{unit} is one of the following strings: +@code{cm}, @code{mm}, @code{in}, or @code{pt}. This option affects +LilyPond, not the text layout. -@item 16pt -@lilypond[16pt, eps] -\relative c' { - r16 [c d e][f d e c] [g'8 c][b-\prall c] | -} -@end lilypond +@item noindent +Set indentation of the first music system to zero. This option affects +LilyPond, not the text layout. Since no indentation is the default, +@code{noindent} is redundant normally. -@item 20pt -@lilypond[20pt, eps] -\relative c' { - r16 [c d e][f d e c] [g'8 c][b-\prall c] | -} -@end lilypond +@item quote +Reduce line length of a music snippet by @math{2*0.4}@dmn{in} and put +the output into a quotation block. The value `0.4@dmn{in}' can be +controlled with the @code{exampleindent} option. + +@item exampleindent +Set the amount by which the @code{quote} option indents a music snippet. + +@item relative +@itemx relative=@var{n} +Use relative octave mode. By default, notes are specified relative to +middle@tie{}C. The optional integer argument specifies the octave of +the starting note, where the default @code{1} is middle C. +@end table -@item 26pt -@lilypond[26pt, eps] -\relative c' { - r16 [c d e][f d e c] [g'8 c][b-\prall c] | -} -@end lilypond +LilyPond also uses @command{lilypond-book} to produce its own +documentation. To do that, some more obscure music fragment options are +available. -@item singleline -Produce a single, naturally spaced, unjustified line -(i.e., linewidth = @minus{}1). +@table @code +@item verbatim +The argument of a LilyPond command is copied to the output file and +enclosed in a verbatim block, followed by any text given with the +@code{intertext} option (not implemented yet); then the actual music is +displayed. This option does not work well with @code{\lilypond@{@}} if +it is part of a paragraph. + +@item texidoc +(Only for Texinfo output.) If @command{lilypond} is called with the +@option{--header=@/texidoc} option, and the file to be processed is +called @file{foo@/.ly}, it creates a file @file{foo@/.texidoc} if there +is a @code{texidoc} field in the @code{\header}. The @code{texidoc} +option makes @command{lilypond-book} include such files, adding its +contents as a documentation block right before the music snippet. + +Assuming the file @file{foo@/.ly} contains -@item multiline -The opposite of @code{singleline}: Justify and break lines. +@example +\header @{ + texidoc = "This file demonstrates a single note." +@} +@{ c'4 @} +@end example -@item linewidth=@var{size}@var{unit} -Set linewidth to @var{size}, where @var{unit} = cm, mm, in, or pt. -This option affects LilyPond output, not the text layout. +@noindent +and we have this in our Texinfo document @file{test.texinfo} -@item notime -Do not print time signature. +@example +@@lilypondfile[texidoc]@{foo.ly@} +@end example -@item fragment -@itemx nofragment -Override @command{lilypond-book} auto detection of what type of code is -in the LilyPond block, voice contents or complete code. +@noindent +the following command line gives the expected result -@item indent=@var{size}@var{unit} -Set indentation of the first music system to @var{size}, -where @var{unit} = cm, mm, in, or pt. This option affects LilyPond, -not the text layout. For single-line fragments the default is to -use no indentation. +@example +lilypond-book --process="lilypond --format=tex --tex \ + --header=texidoc test.texinfo +@end example -@item noindent -Set indentation of the first music system to zero. This option -affects LilyPond, not the text layout. +Most LilyPond test documents (in the @file{input} directory of the +distribution) are small @file{.ly} files which look exactly like this. -@item notexidoc -Do not include the .texidoc header. This is only for Texinfo output. +@item printfilename +If a LilyPond input file is included with @code{\lilypondfile}, print +the file name right before the music snippet. For HTML output, this is +a link. -@item quote -Instruct @command{lilypond-book} to put La@TeX{} and texinfo output -into a quotation block. +@item fontload +This option includes fonts in all of the generated EPS-files for this +snippet. This should be used if the snippet uses any font that LaTeX +cannot find on its own. -@item printfilename -Prints the file name before the music example. Useful in conjunction -with @code{\lilypondfile}. - -@item relative, relative @var{N} -Use relative octave mode. By default, notes are specified relative -central C. The optional integer argument specifies how many octaves -higher (positive number) or lower (negative number) to place the -starting note. @end table @node Invoking lilypond-book -@section Invoking lilypond-book - -When you run @command{lilypond-book} it will generate lots of small -files that LilyPond will process. To avoid all the garbage in -your source directory, you should either change to a temporary -directory, or use the @option{--outdir} command line options: +@section Invoking @command{lilypond-book} -@code{cd out && lilypond-book ../yourfile.tex} +@command{lilypond-book} produces a file with one of the following +extensions: @file{.tex}, @file{.texi}, or @file{.html}, depending on the +output format. Both @file{.tex} and @file{.texi} files need further +processing. -@code{lilypond-book --outdir=out yourfile.tex} +@command{lilypond-book} can also create a PSFONTS file, which is required +by @command{dvips} to produce Postscript and PDF files. You can call +this file whatever you want as long as you refer to the same file when +you call @command{dvips}. -For La@TeX{} input, the file to give to La@TeX{} has extension @file{.latex}. -Texinfo input will be written to a file with extension @file{.texi}. - -If you use @option{--outdir}, you should also @code{cd} to that directory -before running La@TeX{} or @command{makeinfo}. This may seem a little -kludgy, but both La@TeX{} and @command{makeinfo} expect picture files -(the music) to be in the current working directory. Moreover, if you do -this, La@TeX{} will not clutter your normal working directory with output -files. - -@cindex titling and lilypond-book -@cindex lilypond-book and titling -@cindex @code{\header} in La@TeX{} documents - -If you want to add titling from the @code{\header} section of the -files, you should add the following to the top of your La@TeX{} file: +To produce PDF output from the lilypond-book file (here called +@code{yourfile.lytex}), you should do @example -\input titledefs.tex -\def\preLilypondExample@{\def\mustmakelilypondtitle@{@}@} +lilypond-book --psfonts yourfile.lytex +latex yourfile.tex +dvips -o -h yourfile.psfonts -Ppdf yourfile.dvi +ps2pdf yourfile.ps @end example -@command{lilypond-book} accepts the following command line options: +To produce a Texinfo document (in any output format), follow the normal +procedures for Texinfo (this is, either call @command{texi2dvi} or +@command{makeinfo}, depending on the output format you want to +create). +@ifinfo +@xref{Format with texi2dvi, , , texinfo, GNU Texinfo}, and @ref{Creating +an Info File, , , texinfo, GNU Texinfo}. +@end ifinfo +@ifnotinfo +See the documentation of Texinfo for further details. +@end ifnotinfo -@table @code -@item @option{-f @var{format}}, @option{--format=@var{format}} -Specify the document type to process: @code{html}, @code{latex} or -@code{texi} (the default). @command{lilypond-book} usually figures this -out automatically. - -Note that the @code{texi} document type produces a DVI file; to -convert a texinfo document to @code{html}, you should use the additional -format @code{texi-html} instead of @code{texi} to convert lilypond -fragments to PNG images. -@item @option{--default-music-fontsize=@var{sz}pt} -Set the fontsize to use for LilyPond if no fontsize is given -as option. +@command{lilypond-book} accepts the following command line options: -@item @option{--force-music-fontsize=@var{sz}pt} -Force all LilyPond code to use this fontsize, overriding options -given to @code{\begin@{lilypond@}}. +@table @code +@item -f @var{format} +@itemx --format=@var{format} +Specify the document type to process: @code{html}, @code{latex}, or +@code{texi} (the default). If this option is missing, +@command{lilypond-book} tries to detect the format automatically. -@item @option{-I @var{dir}}, @option{--include=@var{dir}} -Add @var{DIR} to the include path. +The @code{texi} document type produces a Texinfo file with music +fragments in the DVI output only. For getting images in the HTML +version, the format @code{texi-html} must be used instead. -@item @option{-M}, @option{--dependencies} -Write dependencies to @file{filename.dep}. +[Note: Currently, @code{texi} is the same as @code{texi-html}.] -@item @option{--dep-prefix=@var{pref}} -Prepend @var{pref} before each @option{-M} dependency. +@item -F @var{filter} +@itemx --filter=@var{filter} +Pipe snippets through @var{filter}. @code{lilypond-book} will +not --filter and --process at the same time. -@item @option{-n}, @option{--no-lily} -Do not run LilyPond, but do generate the @code{.ly} files. +Example: +@example +lilypond-book --filter='convert-ly --from=2.0.0 -' my-book.tely +@end example -@item @option{--no-music} -Strip all LilyPond blocks from the file. +@item -h +@itemx --help +Print a short help message. -@item @option{--no-pictures} -Do not generate pictures when processing Texinfo. +@item -I @var{dir} +@itemx --include=@var{dir} +Add @var{dir} to the include path. -@item @option{--read-lys} -Do not write ly files. This way you can do +@item -o @var{dir} +@itemx --output=@var{dir} +Place generated files in directory @var{dir}. Running +@command{lilypond-book} generates lots of small files that LilyPond will +process. To avoid all that garbage in the source directory use the +@option{--output} command line option, and change to that directory +before running @command{latex} or @command{makeinfo}: @example -lilypond-book file.tely -convert-ly -lilypond-book --read-lys +lilypond-book --output=out yourfile.lytex +cd out +... @end example -@item @option{--outname=@var{file}} -The name of La@TeX{} file to output. If this option is not given, -the output name is derived from the input name. +@item -P @var{process} +@itemx --process=@var{command} +Process LilyPond snippets using @var{command}. The default command is +@code{lilypond}. @code{lilypond-book} will not --filter and --process +at the same time. -@item @option{--outdir=@var{dir}} -Place generated files in @var{dir}. +@itemx --psfonts +extract all PostScript fonts into @file{@var{file}.psfonts} for dvips. +This is necessary for @command{dvips -h @var{file}.psfonts}. -@item @option{--version} -Print version information. +@item -V +@itemx --verbose +Be verbose. -@item @option{--help} -Print a short help message. +@item -v +@itemx --version +Print version information. @end table - -@section Bugs - -The La@TeX{} @code{\includeonly@{...@}} command is ignored. - -The Texinfo command @code{pagesize} is on the TODO list for LilyPond -1.8, but changing the linewidth in other ways will not give you a -straight right margin. - -Almost all La@TeX{} commands that change margins and line widths are -ignored. - -There is no way to automatically apply @command{convert-ly} only to fragments -inside a lilypond-book file. - -@command{lilypond-book} processes all music fragments in one big run. The -state of the GUILE interpreter is not reset between fragments; this -means that global GUILE definitions, e.g., done with @code{#(define @dots{})} -and @code{#(set! @dots{})} can leak from one fragment into the next fragment. +@refbugs + +The Texinfo command @code{@@pagesizes} is not interpreted. Similarly, +La@TeX{} commands that change margins and line widths after the preamble +are ignored. + +Only the first @code{\score} of a LilyPond block is processed. + + +@node Filename extensions +@section Filename extensions + +You can use any filename extension for the input file, but if you do not +use the recommended extension for a particular format you may need to +manually specify the output format. @xref{Invoking lilypond-book}, for +details. Otherwise, @command{lilypond-book} automatically selects the +output format based on the input filename's extension. + +@quotation +@multitable @columnfractions .2 .5 +@item @strong{extension} @tab @strong{output format} +@item +@item @file{.html} @tab HTML +@item @file{.itely} @tab Texinfo +@item @file{.latex} @tab La@TeX{} +@item @file{.lytex} @tab La@TeX{} +@item @file{.tely} @tab Texinfo +@item @file{.tex} @tab La@TeX{} +@item @file{.texi} @tab Texinfo +@item @file{.texinfo} @tab Texinfo +@item @file{.xml} @tab HTML +@end multitable +@end quotation