]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/usage/lilypond-book.itely
Merge remote branch 'origin' into release/unstable
[lilypond.git] / Documentation / usage / lilypond-book.itely
index 2fd6d4fe0a3bcb5d5d2ecb40390628855271e5a5..2a6ab5039678d0bb320145b91353cb8eec1ee1c6 100644 (file)
@@ -203,35 +203,36 @@ to use @LaTeX{}.
 @code{lilypond-book} provides the following commands and environments to include
 music in @LaTeX{} files:
 
-@itemize @bullet
-@item the @code{\lilypond@{...@}} command, where you can directly enter short lilypond code
-@item the @code{\begin@{lilypond@}...\end@{lilypond@}} environment, where you can directly enter longer lilypond code
-@item the @code{\lilypondfile@{...@}} command to insert a lilypond file
-@item the @code{\musicxmlfile@{...@}} command to insert a MusicXML file, which will be processed by @code{musicxml2ly} and @code{lilypond}.
+@itemize
+
+@item
+the @code{\lilypond@{...@}} command, where you can directly enter short
+lilypond code
+
+@item
+the @code{\begin@{lilypond@}...\end@{lilypond@}} environment, where you
+can directly enter longer lilypond code
+
+@item
+the @code{\lilypondfile@{...@}} command to insert a lilypond file
+
+@item
+the @code{\musicxmlfile@{...@}} command to insert a MusicXML file, which
+will be processed by @code{musicxml2ly} and @code{lilypond}.
+
 @end itemize
 
-In the input file, music is specified with
+In the input file, music is specified with any of the following commands:
 
 @example
 \begin@{lilypond@}[options,go,here]
   YOUR LILYPOND CODE
 \end@{lilypond@}
-@end example
 
-@noindent
-or
-
-@example
 \lilypond[options,go,here]@{ YOUR LILYPOND CODE @}
-@end example
-or
 
-@example
 \lilypondfile[options,go,here]@{@var{filename}@}
-@end example
-or
 
-@example
 \musicxmlfile[options,go,here]@{@var{filename}@}
 @end example
 
@@ -416,37 +417,36 @@ versions of the manual are made from the Texinfo document.
 @code{lilypond-book} provides the following commands and environments to include
 music into Texinfo files:
 
-@itemize @bullet
-@item the @code{@@lilypond@{...@}} command, where you can directly enter short lilypond code
-@item the @code{@@lilypond...@@end lilypond} environment, where you can directly enter longer lilypond code
-@item the @code{@@lilypondfile@{...@}} command to insert a lilypond file
-@item the @code{@@musicxmlfile@{...@}} command to insert a MusicXML file, which will be processed by @code{musicxml2ly} and @code{lilypond}.
+@itemize
+
+@item
+the @code{@@lilypond@{...@}} command, where you can directly enter short
+lilypond code
+
+@item
+the @code{@@lilypond...@@end lilypond} environment, where you can directly
+enter longer lilypond code
+
+@item
+the @code{@@lilypondfile@{...@}} command to insert a lilypond file
+
+@item
+the @code{@@musicxmlfile@{...@}} command to insert a MusicXML file, which
+will be processed by @code{musicxml2ly} and @code{lilypond}.
+
 @end itemize
 
-In the input file, music is specified with
+In the input file, music is specified with any of the following commands
 
 @example
 @@lilypond[options,go,here]
   YOUR LILYPOND CODE
 @@end lilypond
-@end example
 
-@noindent
-or
-
-@example
 @@lilypond[options,go,here]@{ YOUR LILYPOND CODE @}
-@end example
-
-@noindent
-or
 
-@example
 @@lilypondfile[options,go,here]@{@var{filename}@}
-@end example
-or
 
-@example
 @@musicxmlfile[options,go,here]@{@var{filename}@}
 @end example
 
@@ -495,15 +495,48 @@ in-line image.  It always gets a paragraph of its own.
 @code{lilypond-book} provides the following commands and environments to include
 music in HTML files:
 
-@itemize @bullet
-@item the @code{<lilypond .... />} command, where you can directly enter short lilypond code
-@item the @code{<lilyond>...</lilypond>} environment, where you can directly enter longer lilypond code
-@item the @code{<lilypondfile>...</lilypondfile>} command to insert a lilypond file
-@item the @code{<musicxmlfile>...</musicxmlfile>} command to insert a MusicXML file, which will be processed by @code{musicxml2ly} and @code{lilypond}.
+@itemize
+
+@item
+the @code{<lilypond ... />} command, where you can directly enter short lilypond code
+
+@item
+the @code{<lilyond>...</lilypond>} environment, where you can directly enter longer
+lilypond code
+
+@item
+the @code{<lilypondfile>...</lilypondfile>} command to insert a lilypond file
+
+@item
+the @code{<musicxmlfile>...</musicxmlfile>} command to insert a MusicXML file, which
+will be processed by @code{musicxml2ly} and @code{lilypond}.
+
 @end itemize
 
-Music is entered using
+In the input file, music is specified with any of the following commands:
+
+\begin@{lilypond@}[options,go,here]
+  YOUR LILYPOND CODE
+\end@{lilypond@}
+
+\lilypond[options,go,here]@{ YOUR LILYPOND CODE @}
 
+\lilypondfile[options,go,here]@{@var{filename}@}
+
+\musicxmlfile[options,go,here]@{@var{filename}@}
+@example
+<lilypond options go here>
+  YOUR LILYPOND CODE
+</lilypond>
+
+<lilypond options go here: YOUR LILYPOND CODE />
+
+<lilypondfile options go here>@var{filename}</lilypondfile>
+
+<musicxmlfile options go here>@var{filename}</musicxmlfile>
+@end example
+
+For example, you can write
 @example
 <lilypond fragment relative=2>
 \key c \minor c4 es g2
@@ -634,11 +667,9 @@ Set staff size to @var{ht}, which is measured in points.
 
 @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{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.
+@code{ragged-right = ##t} is added to the LilyPond snippet.  Single-line
+snippets will always be typeset by default as ragged-right, unless
+@code{noragged-right} is explicitly given.
 
 @item noragged-right
 For single-line snippets, allow the staff length to be stretched to
@@ -770,7 +801,9 @@ as a domain.
 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.
+contents as a documentation block right before the music snippet (but
+outside the @code{example} environment generated by a @code{quote}
+option).
 
 Assuming the file @file{foo.ly} contains
 
@@ -806,13 +839,6 @@ is called with @option{--header=@/texidoc@var{LANG}}, then
 @file{foo.texidoc@var{LANG}} will be included instead of
 @file{foo.texidoc}.
 
-@item lilyquote
-(Only for Texinfo output.)  This option is similar to quote, but only
-the music snippet (and the optional verbatim block implied by
-@code{verbatim} option) is put into a quotation block.  This option is
-useful if you want to @code{quote} the music snippet but not the
-@code{texidoc} documentation block.
-
 @item doctitle
 (Only for Texinfo output.) This option works similarly to
 @code{texidoc} option: if @command{lilypond} is called with the
@@ -948,6 +974,13 @@ them back to the output directory, so in some cases it is necessary to
 invoke further processing commands such as @command{makeinfo} or
 @command{latex} with the same @option{-I @var{dir}} options.
 
+@item -l @var{loglevel}
+@itemx --loglevel=@var{loglevel}
+Set the output verbosity to @var{loglevel}. Possible values are @code{NONE},
+@code{ERROR}, @code{WARNING}, @code{PROGRESS} (default) and @code{DEBUG}. If
+this option is not used, and the environment variable
+@code{LILYPOND_BOOK_LOGLEVEL} is set, its value is used as the loglevel.
+
 @item -o @var{dir}
 @itemx --output=@var{dir}
 Place generated files in directory @var{dir}.  Running
@@ -975,6 +1008,14 @@ Write lily-XXX files to directory @var{dir}, link into @option{--output}
 directory.  Use this option to save building time for documents in
 different directories which share a lot of identical snippets.
 
+@itemx --lily-loglevel=@var{loglevel}
+Set the output verbosity of the invoked @command{lilypond} calls to @var{loglevel}.
+Possible values are @code{NONE}, @code{ERROR}, @code{WARNING}, @code{BASIC_PROGRESS},
+@code{PROGRESS}, @code{INFO} (default) and @code{DEBUG}. If
+this option is not used, and the environment variable
+@code{LILYPOND_LOGLEVEL} is set, its value is used as the loglevel.
+
+
 @itemx --info-images-dir=@var{dir}
 Format Texinfo output so that Info will look for images of music in
 @var{dir}.
@@ -1015,13 +1056,15 @@ and only if directories implied by @option{--output-dir} and
 
 @item -V
 @itemx --verbose
-Be verbose.
+Be verbose. This is equivalent to @code{--loglevel=DEBUG}.
 
 @item -v
 @itemx --version
 Print version information.
 @end table
 
+
+
 @knownissues
 
 The Texinfo command @code{@@pagesizes} is not interpreted.  Similarly,