| [ << lilypond-book ] | [Top][Contents][Index][ ? ] | [ External programs >> ] | ||
| [ < Music fragment options ] | [ Up : lilypond-book ] | [ Filename extensions > ] | ||
3.4 Invoking lilypond-book
lilypond-book produces a file with one of the following
extensions: ‘.tex’, ‘.texi’, ‘.html’ or ‘.xml’,
depending on the output format. All of ‘.tex’, ‘.texi’ and
‘.xml’ files need further processing.
Format-specific instructions
LaTeX
There are two ways of processing your LaTeX document for printing or
publishing: getting a PDF file directly with PDFLaTeX, or getting a
PostScript file with LaTeX via a DVI to PostScript translator like
dvips. The first way is simpler and recommended1, and whichever
way you use, you can easily convert between PostScript and PDF with
tools, like ps2pdf and pdf2ps included in
Ghostscript package.
To produce a PDF file through PDFLaTeX, use
lilypond-book --pdf yourfile.lytex pdflatex yourfile.tex
To produce PDF output via LaTeX/dvips/ps2pdf, you
should do
lilypond-book yourfile.lytex latex yourfile.tex dvips -Ppdf yourfile.dvi ps2pdf yourfile.ps
The ‘.dvi’ file created by this process will not contain note heads. This is normal; if you follow the instructions, they will be included in the ‘.ps’ and ‘.pdf’ files.
Running dvips may produce some warnings about fonts; these
are harmless and may be ignored. If you are running latex in
twocolumn mode, remember to add -t landscape to the
dvips options.
Texinfo
To produce a Texinfo document (in any output format), follow the normal
procedures for Texinfo; this is, either call texi2pdf or
texi2dvi or makeinfo, depending on the output format
you want to create.
See the documentation of Texinfo for further details.
Command line options
lilypond-book accepts the following command line options:
-
-f format -
--format=format Specify the document type to process:
html,latex,texi(the default) ordocbook. If this option is missing,lilypond-booktries to detect the format automatically, see Filename extensions. Currently,texiis the same astexi-html.-
-F filter -
--filter=filter Pipe snippets through filter.
lilypond-bookwill not –filter and –process at the same time. For example,lilypond-book --filter='convert-ly --from=2.0.0 -' my-book.tely
-
-h -
--help Print a short help message.
-
-I dir -
--include=dir Add dir to the include path.
lilypond-bookalso looks for already compiled snippets in the include path, and does not write them back to the output directory, so in some cases it is necessary to invoke further processing commands such asmakeinfoorlatexwith the same-I diroptions.-
-o dir -
--output=dir Place generated files in directory dir. Running
lilypond-bookgenerates lots of small files that LilyPond will process. To avoid all that garbage in the source directory, use the ‘--output’ command line option, and change to that directory before runninglatexormakeinfo.lilypond-book --output=out yourfile.lytex cd out ...
-
--skip-lily-check Do not fail if no lilypond output is found. It is used for LilyPond Info documentation without images.
-
--skip-png-check Do not fail if no PNG images are found for EPS files. It is used for LilyPond Info documentation without images.
-
--lily-output-dir=dir Write lily-XXX files to directory dir, link into
--outputdirectory. Use this option to save building time for documents in different directories which share a lot of identical snippets.-
--info-images-dir=dir Format Texinfo output so that Info will look for images of music in dir.
-
--latex-program=prog Run executable
proginstead oflatex. This is useful if your document is processed withxelatex, for example.-
--left-padding=amount Pad EPS boxes by this much. amount is measured in millimeters, and is 3.0 by default. This option should be used if the lines of music stick out of the right margin.
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 Process LilyPond snippets using command. The default command is
lilypond.lilypond-bookwill not--filterand--processat the same time.-
--pdf Create PDF files for use with PDFLaTeX.
-
--use-source-file-names Write snippet output files with the same base name as their source file. This option works only for snippets included with
lilypondfileand only if directories implied by--output-dirand--lily-output-diroptions are different.-
-V -
--verbose Be verbose.
-
-v -
--version Print version information.
Known issues and warnings
The Texinfo command @pagesizes is not interpreted. Similarly,
LaTeX commands that change margins and line widths after the preamble
are ignored.
Only the first \score of a LilyPond block is processed.
Footnotes
[1] Note that PDFLaTeX and LaTeX may not be both usable to compile any LaTeX document, that is why we explain the two ways.
| [ << lilypond-book ] | [Top][Contents][Index][ ? ] | [ External programs >> ] | ||
| [ < Music fragment options ] | [ Up : lilypond-book ] | [ Filename extensions > ] | ||