]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/user/lilypond-book.itely
Fix some bugs in the dynamic engraver and PostScript backend
[lilypond.git] / Documentation / user / lilypond-book.itely
index ab6c59a539a65a857e771c3f2ffb8ae106777f03..d4e93f9081a9cd170ce7b8d794ade7598d7ef596 100644 (file)
@@ -1,4 +1,4 @@
-@c -*- coding: latin-1; mode: texinfo; -*-
+c -*- coding: utf-8; mode: texinfo; -*-
 
 
 @ignore
@@ -31,13 +31,13 @@ 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 HTML and music::
-* Music fragment options::
-* Invoking lilypond-book::
-* Filename extensions::
+* An example of a musicological document::  
+* Integrating LaTeX and music::  
+* Integrating Texinfo and music::  
+* Integrating HTML and music::  
+* Music fragment options::      
+* Invoking lilypond-book::      
+* Filename extensions::         
 @end menu
 
 
@@ -62,6 +62,7 @@ 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.
@@ -93,8 +94,8 @@ Under Unix, you can view the results as follows
 @example
 cd input/tutorial
 mkdir -p out/
-lilypond-book --output=out lilybook.tex
-@emph{lilypond-book (GNU LilyPond) 2.5.0}
+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...}
@@ -107,7 +108,7 @@ xdvi lilybook
 To convert the file into a PDF document, run the following commands
 
 @example
-dvips -Ppdf -u+lilypond -u+ec-mftrace lilybook
+dvips -o -Ppdf -h lilybook.psfonts lilybook
 ps2pdf lilybook.ps
 @end example
 
@@ -116,6 +117,9 @@ 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.
@@ -147,7 +151,7 @@ Larger examples can be put into a separate file, and introduced with
 @cindex texinfo
 @cindex latex
 @cindex texinfo
-@cindex @code{texi}
+@findex texi
 @cindex html
 @cindex documents, adding music to
 
@@ -220,16 +224,16 @@ 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
+The default line width 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.
+use the @code{line-width} music fragment option.
 
 @cindex titling and lilypond-book
-@cindex @code{\header} in La@TeX{} documents
+@findex \header in La@TeX{} documents
 
 Each snippet will call the following macros if they have been defined by
 the user:
@@ -241,7 +245,12 @@ the user:
 @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. 
+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
 
@@ -267,6 +276,8 @@ the location of this file, use the command
 kpsewhich feta20.tex
 @end example
 
+@end ignore
+
 @cindex outline fonts
 @cindex type1 fonts
 @cindex dvips
@@ -278,12 +289,16 @@ a PostScript file, add the following options to the @command{dvips}
 command line:
 
 @example
--Ppdf -u+lilypond.map -u+ec-mftrace.map
+-o -Ppdf -h @var{file}.psfonts
 @end example
 
 @noindent
-PDF can then be produced with a PostScript to PDF translator like
-@code{ps2pdf} (which is part of GhostScript).
+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.
 
 @cindex international characters
 @cindex latin1
@@ -411,10 +426,10 @@ The following options are available for LilyPond commands:
 @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
+@item ragged-right
+Produce ragged-right lines with natural spacing (i.e., @code{ragged-right
 = ##t} is added to the LilyPond snippet).  This is the default for the
-@code{\lilypond@{@}} command if no @code{linewidth} option is present.
+@code{\lilypond@{@}} command if no @code{line-width} 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.
@@ -423,8 +438,8 @@ specified.
 Produce lines with packed spacing (i.e., @code{packed = ##t} is added
 to the LilyPond snippet).
 
-@item linewidth
-@itemx linewidth=@var{size}\@var{unit}
+@item line-width
+@itemx line-width=@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
@@ -433,12 +448,13 @@ 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
+If no @code{line-width} option is given, @command{lilypond-book} tries to
 guess a default for @code{lilypond} environments which don't use the
-@code{raggedright} option.
+@code{ragged-right} option.
 
 @item notime
-Do not print the time signature.
+Do not print the time signature, and turns off the timing (key signature,
+bar lines) in the score.
 
 @item fragment
 Make @command{lilypond-book} add some boilerplate code so that you can
@@ -549,14 +565,25 @@ extensions: @file{.tex}, @file{.texi}, or @file{.html}, depending on the
 output format.  Both @file{.tex} and @file{.texi} files need further
 processing.
 
-To produce PDF output from the @file{.tex} file, you should do
+@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}.
+
+To produce PDF output from the lilypond-book file (here called
+@code{yourfile.lytex}), you should do
 
 @example
+lilypond-book --psfonts yourfile.lytex
 latex yourfile.tex
-dvips -Ppdf -u+ec-mftrace.map -u+lilypond.map yourfile.dvi
+dvips -o -h yourfile.psfonts -Ppdf yourfile.dvi
 ps2pdf yourfile.ps
 @end example
 
+The @file{.dvi} file created by this process will not contain
+noteheads.  This is normal; if you follow the instructions, they
+will be included in the @file{.ps} and @file{.pdf} files.
+
 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
@@ -623,6 +650,10 @@ Process LilyPond snippets using @var{command}.  The default command is
 @code{lilypond}.  @code{lilypond-book} will not --filter and --process
 at the same time.
 
+@itemx --psfonts
+extract all PostScript fonts into @file{@var{file}.psfonts} for dvips.
+This is necessary for @command{dvips -h @var{file}.psfonts}.
+
 @item -V
 @itemx --verbose
 Be verbose.
@@ -640,11 +671,6 @@ are ignored.
 
 Only the first @code{\score} of a LilyPond block is processed.
 
-@c CHECKME--FIXME
-The size of a music block is limited to 1.5 KB, due to technical
-problems with the Python regular expression engine.  For longer files,
-use @code{\lilypondfile}.
-
 
 @node Filename extensions
 @section Filename extensions