Merge branch 'master' of ssh+git://git.sv.gnu.org/srv/git/lilypond

[lilypond.git] / Documentation / user / lilypond-book.itely

diff --git a/Documentation/user/lilypond-book.itely b/Documentation/user/lilypond-book.itely
index 01b80a37abb0e60282bb8042cb58353395df8b86..1c46d4a1aebcfe977fb6195bc632dd8a7e9c6ed7 100644 (file)
--- a/Documentation/user/lilypond-book.itely
+++ b/Documentation/user/lilypond-book.itely
@@ -105,9 +105,10 @@ directory as this file.)
 Save the code above to a file called @file{lilybook.lytex}, then in a
 terminal run
 
 Save the code above to a file called @file{lilybook.lytex}, then in a
 terminal run
 

+@c keep space after @version{} so TeX doesn't choke

 @example
 lilypond-book --output=out --pdf lilybook.lytex
 @example
 lilypond-book --output=out --pdf lilybook.lytex

-@emph{lilypond-book (GNU LilyPond) 2.11.37}
+@emph{lilypond-book (GNU LilyPond) @version{} }

 @emph{Reading lilybook.lytex...}
 @emph{..lots of stuff deleted..}
 @emph{Compiling lilybook.tex...}
 @emph{Reading lilybook.lytex...}
 @emph{..lots of stuff deleted..}
 @emph{Compiling lilybook.tex...}


@@ -290,7 +291,7 @@ kpsewhich feta20.tex
 
 @end ignore
 
 
 @end ignore
 

-@commonprop
+@snippets

 
 Sometimes it is useful to display music elements (such as ties and slurs)
 as if they continued after the end of the fragment.  This can be done by
 
 Sometimes it is useful to display music elements (such as ties and slurs)
 as if they continued after the end of the fragment.  This can be done by


@@ -634,8 +635,8 @@ If @code{verbatim} is used in a @code{lilypondfile} command, it is
 possible to enclose verbatim only a part of the source file.  If the
 source file contain a comment containing @samp{begin verbatim} (without
 quotes), quoting the source in the verbatim block will start after the
 possible to enclose verbatim only a part of the source file.  If the
 source file contain a comment containing @samp{begin verbatim} (without
 quotes), quoting the source in the verbatim block will start after the

-last occurence of such a comment; similarly, quoting the source verbatim
-will stop just before the first occurence of a comment containing
+last occurrence of such a comment; similarly, quoting the source verbatim
+will stop just before the first occurrence of a comment containing

 @samp{end verbatim}, it there is any.  In the following source file
 example, the music will be interpreted in relative mode, but the
 verbatim quote will not show the @code{relative} block, i.e.
 @samp{end verbatim}, it there is any.  In the following source file
 example, the music will be interpreted in relative mode, but the
 verbatim quote will not show the @code{relative} block, i.e.


@@ -655,6 +656,10 @@ will be printed with a verbatim block like
   f2 e
 @end example
 
   f2 e
 @end example
 

+@item addversion
+(Only for Texinfo output.)  Prepend line @code{\version
+@@w@{"@@version@{@}"@}} to @code{verbatim} output.
+

 @item texidoc
 (Only for Texinfo output.)  If @command{lilypond} is called with the
 @option{--header=@/texidoc} option, and the file to be processed is
 @item texidoc
 (Only for Texinfo output.)  If @command{lilypond} is called with the
 @option{--header=@/texidoc} option, and the file to be processed is


@@ -699,8 +704,9 @@ useful if you want to @code{quote} the music snippet but not the
 
 @item printfilename
 If a LilyPond input file is included with @code{\lilypondfile}, print
 
 @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.
+the file name right before the music snippet.  For HTML output, this
+is a link.  Only the base name of the file is printed, i.e. the
+directory part of the file path is stripped.

 
 @item fontload
 This option includes fonts in all of the generated EPS-files for this
 
 @item fontload
 This option includes fonts in all of the generated EPS-files for this


@@ -758,7 +764,7 @@ ps2pdf yourfile.ps
 
 @noindent
 The @file{.dvi} file created by this process will not contain
 
 @noindent
 The @file{.dvi} file created by this process will not contain

-noteheads.  This is normal; if you follow the instructions, they
+ note heads.  This is normal; if you follow the instructions, they

 will be included in the @file{.ps} and @file{.pdf} files.
 
 Running @command{dvips} will produce some warnings about fonts; these
 will be included in the @file{.ps} and @file{.pdf} files.
 
 Running @command{dvips} will produce some warnings about fonts; these


@@ -816,7 +822,11 @@ Print a short help message.
 
 @item -I @var{dir}
 @itemx --include=@var{dir}
 
 @item -I @var{dir}
 @itemx --include=@var{dir}

-Add @var{dir} to the include path.
+Add @var{dir} to the include path.  @command{lilypond-book} also 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 as @command{makeinfo} or
+@command{latex} with the same @code{-I @var{dir}} options.

 
 @item -o @var{dir}
 @itemx --output=@var{dir}
 
 @item -o @var{dir}
 @itemx --output=@var{dir}


@@ -833,7 +843,7 @@ cd out
 @end example
 
 @itemx --left-padding=@var{amount}
 @end example
 
 @itemx --left-padding=@var{amount}

-Pad EPS boxes by this much. @var{amount} is measured in milimeters,
+Pad EPS boxes by this much. @var{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.
 
 and is 3.0 by default.  This option should be used if the lines of
 music stick out of the right margin.
 


@@ -865,7 +875,7 @@ Be verbose.
 Print version information.
 @end table
 
 Print version information.
 @end table
 

-@refbugs
+@knownissues

 
 The Texinfo command @code{@@pagesizes} is not interpreted.  Similarly,
 @LaTeX{} commands that change margins and line widths after the preamble
 
 The Texinfo command @code{@@pagesizes} is not interpreted.  Similarly,
 @LaTeX{} commands that change margins and line widths after the preamble