Fix docs cross-references

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

diff --git a/Documentation/user/lilypond-book.itely b/Documentation/user/lilypond-book.itely
index cb796ef2af8bef5713f25c3f4cbc2fb5e6653ee4..6ec15809b33680e687cf216b042686e222068117 100644 (file)
--- a/Documentation/user/lilypond-book.itely
+++ b/Documentation/user/lilypond-book.itely
@@ -7,6 +7,7 @@
     version that you are working on.  See TRANSLATION for details.
 @end ignore
 
     version that you are working on.  See TRANSLATION for details.
 @end ignore
 

+@c \version "2.11.38"

 
 @c Note: keep this node named so that `info lilypond-book' brings you here.
 @node LilyPond-book
 
 @c Note: keep this node named so that `info lilypond-book' brings you here.
 @node LilyPond-book


@@ -295,7 +296,7 @@ kpsewhich feta20.tex
 
 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

-breaking the staff and suppressing inclusion of the rest of the lilypond
+breaking the staff and suppressing inclusion of the rest of the LilyPond

 output.
 
 In @LaTeX{}, define @code{\betweenLilyPondSystem} in such a way that
 output.
 
 In @LaTeX{}, define @code{\betweenLilyPondSystem} in such a way that


@@ -617,6 +618,10 @@ Set the amount by which the @code{quote} option indents a music snippet.
 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.
 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.

+@code{relative} option only works when @code{fragment} option is set,
+so @code{fragment} is automatically implied by @code{relative},
+regardless of the presence of any @code{(no)fragment} option in the
+source.

 @end table
 
 LilyPond also uses @command{lilypond-book} to produce its own
 @end table
 
 LilyPond also uses @command{lilypond-book} to produce its own


@@ -635,8 +640,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.


@@ -695,6 +700,13 @@ lilypond-book --process="lilypond --format=tex --tex \
 Most LilyPond test documents (in the @file{input} directory of the
 distribution) are small @file{.ly} files which look exactly like this.
 
 Most LilyPond test documents (in the @file{input} directory of the
 distribution) are small @file{.ly} files which look exactly like this.
 

+For localization purpose, if the Texinfo document contains
+@code{@@documentlanguage @var{LANG}} and @file{foo@/.ly} header
+contains a @code{texidoc@var{LANG}} field, and if @command{lilypond}
+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
 @item lilyquote
 (Only for Texinfo output.)  This option is similar to quote, but only
 the music snippet (and the optional verbatim block implied by


@@ -702,6 +714,19 @@ the music snippet (and the optional verbatim block implied by
 useful if you want to @code{quote} the music snippet but not the
 @code{texidoc} documentation block.
 
 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
+@option{--header=@/doctitle} option, and the file to be processed is
+called @file{foo@/.ly} and contains a @code{doctitle} field in the
+@code{\header}, it creates a file @file{foo@/.doctitle}.  When
+@code{doctitle} option is used, the contents of @file{foo@/.doctitle},
+which should be a single line of @var{text}, is inserted in the
+Texinfo document as @code{@@lydoctitle @var{text}}.
+@code{@@lydoctitle} should be a macro defined in the Texinfo document.
+The same remark about @code{texidoc} processing with localized
+languages also applies to @code{doctitle}.
+

 @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
 @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


@@ -724,9 +749,6 @@ extensions: @file{.tex}, @file{.texi}, @file{.html} or @file{.xml},
 depending on the output format.  All of @file{.tex}, @file{.texi} and
 @file{.xml} files need further processing.
 
 depending on the output format.  All of @file{.tex}, @file{.texi} and
 @file{.xml} files need further processing.
 

-@command{lilypond-book} can also create a @file{.psfonts} file, which is
-required by @command{dvips} to produce PostScript and PDF files.
-

 @subheading Format-specific instructions
 
 @subsubheading @LaTeX{}
 @subheading Format-specific instructions
 
 @subsubheading @LaTeX{}


@@ -756,9 +778,9 @@ To produce PDF output via @LaTeX{}/@command{dvips}/@command{ps2pdf}, you
 should do
 
 @example
 should do
 
 @example

-lilypond-book --psfonts yourfile.lytex
+lilypond-book yourfile.lytex

 latex yourfile.tex
 latex yourfile.tex

-dvips -o -h yourfile.psfonts -Ppdf yourfile.dvi
+dvips -Ppdf yourfile.dvi

 ps2pdf yourfile.ps
 @end example
 
 ps2pdf yourfile.ps
 @end example
 


@@ -767,7 +789,7 @@ The @file{.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 @file{.ps} and @file{.pdf} files.
 
  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
+Running @command{dvips} may produce some warnings about fonts; these

 are harmless and may be ignored.  If you are running @command{latex} in
 twocolumn mode, remember to add @code{-t landscape} to the
 @command{dvips} options.
 are harmless and may be ignored.  If you are running @command{latex} in
 twocolumn mode, remember to add @code{-t landscape} to the
 @command{dvips} options.


@@ -832,7 +854,7 @@ invoke further processing commands such as @command{makeinfo} or
 @itemx --output=@var{dir}
 Place generated files in directory @var{dir}.  Running
 @command{lilypond-book} generates lots of small files that LilyPond will
 @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
+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}.
 
 @option{--output} command line option, and change to that directory
 before running @command{latex} or @command{makeinfo}.
 


@@ -842,8 +864,30 @@ cd out
 ...
 @end example
 
 ...
 @end example
 

+@itemx --skip-lily-check
+Do not fail if no lilypond output is found.  It is used for LilyPond
+Info documentation without images.
+
+@itemx --skip-png-check
+Do not fail if no PNG images are found for EPS files.  It is used for
+LilyPond Info documentation without images.
+
+@itemx --lily-output-dir=@var{dir}
+Write lily-XXX files to directory @var{dir}, link into @code{--output}
+directory.  Use this option to save building time for documents in
+different directories which share a lot of identical snippets.
+
+@itemx --info-images-dir=@var{dir}
+Format Texinfo output so that Info will look for images of music in
+@var{dir}.
+
+@itemx --latex-program=@var{prog}
+Run executable @command{prog} instead of @command{latex}.  This is
+useful if your document is processed with @command{xelatex}, for
+example.
+

 @itemx --left-padding=@var{amount}
 @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.
 


@@ -862,10 +906,6 @@ Process LilyPond snippets using @var{command}.  The default command is
 @item --pdf
 Create PDF files for use with PDFLaTeX.
 
 @item --pdf
 Create PDF files for use with PDFLaTeX.
 

-@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.
 @item -V
 @itemx --verbose
 Be verbose.


@@ -934,7 +974,7 @@ the automated method with @command{lilypond-book}.
 @subsection Many quotes from a large score
 
 If you need to quote many fragments from a large score, you can also use
 @subsection Many quotes from a large score
 
 If you need to quote many fragments from a large score, you can also use

-the clip systems feature, see @ruser{Extracting fragments of notation}.
+the clip systems feature, see @ruser{Extracting fragments of music}.

 
 
 @node Inserting LilyPond output into OpenOffice.org
 
 
 @node Inserting LilyPond output into OpenOffice.org


@@ -952,10 +992,10 @@ LilyPond notation can be added to OpenOffice.org with
 To insert LilyPond output in other programs, use @code{lilypond}
 instead of @code{lilypond-book}.  Each example must be created
 individually and added to the document; consult the documentation for
 To insert LilyPond output in other programs, use @code{lilypond}
 instead of @code{lilypond-book}.  Each example must be created
 individually and added to the document; consult the documentation for

-that program.  Most programs will be able to insert lilypond output in
+that program.  Most programs will be able to insert LilyPond output in

 @file{PNG}, @file{EPS}, or @file{PDF} formats.
 
 @file{PNG}, @file{EPS}, or @file{PDF} formats.
 

-To reduce the white space around your lilypond score, use
+To reduce the white space around your LilyPond score, use

 the following options
 
 @example
 the following options
 
 @example