Issue 5166/2: Doc: Delete note for svg backend which become unnecessary

[lilypond.git] / Documentation / usage / running.itely

diff --git a/Documentation/usage/running.itely b/Documentation/usage/running.itely
index f072d3648e74734f5a3815706702c9e07beb6995..4eeabc80dc587e6c033cebe160b6d8e66ffe3bb5 100644 (file)
--- a/Documentation/usage/running.itely
+++ b/Documentation/usage/running.itely
@@ -246,6 +246,10 @@ which formats should be written.  Choices for @code{format} are
 
 Example: @code{lilypond -fpng @var{filename}.ly}
 
 
 Example: @code{lilypond -fpng @var{filename}.ly}
 

+@noindent
+For @code{svg} and @code{eps} formats use the @code{-dbackend} option.
+See @ref{Advanced command line options for LilyPond}.
+

 @item -h, --help
 Show a summary of usage.
 
 @item -h, --help
 Show a summary of usage.
 


@@ -411,8 +415,10 @@ Show the warranty with which GNU LilyPond comes.  (It comes with
 
 @table @code
 
 
 @table @code
 

-@item -d@var{[option-name]}=@var{[value]},--define-default=@var{[option-name]}=@var{[value]}
-This sets the equivalent internal Scheme function to @var{value}.
+@item -d@var{[option-name]}=@var{[value]},
+--define-default=@var{[option-name]}=@var{[value]}
+This sets the equivalent internal Scheme function to @var{value}.  For
+example;

 
 @example
 -dbackend=svg
 
 @example
 -dbackend=svg


@@ -420,7 +426,7 @@ This sets the equivalent internal Scheme function to @var{value}.
 
 If a @var{value} is not supplied, then the default value is used.  The
 prefix @code{no-} may be added to @var{option-name} to switch @q{off} an
 
 If a @var{value} is not supplied, then the default value is used.  The
 prefix @code{no-} may be added to @var{option-name} to switch @q{off} an

-option, e.g.
+option.  For example;

 
 @cindex point and click, command line
 
 
 @cindex point and click, command line
 


@@ -445,69 +451,49 @@ default values:
 
 @item @code{anti-alias-factor}
 @tab @code{1}
 
 @item @code{anti-alias-factor}
 @tab @code{1}

-@tab Render at higher resolution (using given factor) and scale down
-result to prevent @q{jaggies} in @code{PNG} images.
+@tab Render at a higher resolution (using the given factor) and scale
+down the result to prevent @q{jaggies} in @code{PNG} images.

 
 @item @code{aux-files}
 @tab @code{#t}
 
 @item @code{aux-files}
 @tab @code{#t}

-@tab Create @code{.tex}, @code{.texi}, @code{.count} files in the
-@code{EPS} backend.
+@tab Create @code{.tex}, @code{.texi} and @code{.count} files when used
+with the @code{eps} backend option.

 
 @item @code{backend}
 @tab @code{ps}
 
 @item @code{backend}
 @tab @code{ps}

-@tab Select backend.  Postscript files (default) include @code{TTF},
-@code{Type1} and @code{OTF} fonts.  No subsetting of these fonts is
-done.  Using @q{oriental} character sets can lead to very large files.
+@tab This is the default setting.  Postscript files (default) include
+@code{TTF}, @code{Type1} and @code{OTF} fonts.  No @q{subsetting} of
+these fonts is done.  Be aware that using @q{oriental} character sets
+can lead to very large file sizes.

 
 @item
 @tab @code{eps}
 
 @item
 @tab @code{eps}

-@tab Encapsulated PostScript.  This dumps every page (system) as a
-separate @file{EPS} file, without fonts, and as one collated @file{EPS}
-file with all pages (systems) including fonts.  Used as default by
-@command{lilypond-book}.
+@tab Used as default by the @command{lilypond-book} command.  This dumps
+every page as both a single file with all pages and fonts included and
+as separate encapsulated postscript files for each page but without fonts
+included.

 
 @item
 @tab @code{null}
 
 @item
 @tab @code{null}

-@tab Do not output a printed score; has the same effect as
+@tab Do not output a printed score.  This has the same effect as

 @code{-dno-print-pages}.
 
 @item
 @tab @code{scm}
 @code{-dno-print-pages}.
 
 @item
 @tab @code{scm}

-@tab Dump of the raw, internal Scheme-based drawing commands.
+@tab This dumps out the raw, internal Scheme-based drawing commands.

 
 @item
 @tab @code{svg}
 @tab Scalable Vector Graphics.
 
 @item
 @tab @code{svg}
 @tab Scalable Vector Graphics.

-This creates a single SVG file for every page of output.
-Font information is not embedded so the SVG viewer will require
-the fonts be available for optimal rendering.
-It is recommended that you do not use @q{font aliases}
-or @q{font lists} in case your SVG viewer is not able to handle them.
-Also see the @code{svg-woff} option.
-@end multitable
-
-@noindent
-@strong{Note for svg backend:}
-LilyPond's default fonts (@code{LilyPond Serif}, @code{LilyPond Sans Serif}
-and @code{LilyPond Monospace}) are just @emph{local} font aliases;
-so when using the @code{svg} backend command it is required that
-you explicitly set the default fonts;
+A single SVG file is created for every page of output.  Music glyphs
+are encoded as vector graphics, but text fonts are @emph{not} embedded
+in the SVG files.  Any SVG viewer will therefore need the relevant text
+fonts to be available to it for proper rendering of both text and
+lyrics.  It is recommended to not use font @q{lists} or @q{aliases}
+in case an SVG viewer is unable to handle them.  When using
+@emph{Web Open Font Format} (WOFF) files the additional
+@code{--svg-woff} switch is required.

 
 

-@quotation
-@verbatim
-\paper  {
-  #(define fonts
-    (make-pango-font-tree "TeX Gyre Schola"
-                          "TeX Gyre Heros"
-                          "TeX Gyre Cursor"
-                          (/ staff-height pt 20)))
-}
-@end verbatim
-@end quotation
-
-Also see @ruser{Entire document fonts}.
-
-@multitable @columnfractions .33 .16 .51

 @item @code{check-internal-types}
 @tab @code{#f}
 @tab Check every property assignment for types.
 @item @code{check-internal-types}
 @tab @code{#f}
 @tab Check every property assignment for types.


@@ -570,11 +556,19 @@ compilation.
 @tab @code{#f}
 @tab Dump output signatures of each system. Used for regression testing.
 
 @tab @code{#f}
 @tab Dump output signatures of each system. Used for regression testing.
 

+@item @code{embed-source-code}
+@tab @code{#f}
+@tab Embed the LilyPond source files inside the generated PDF document.
+

 @item @code{eps-box-padding}
 @tab @code{#f}
 @tab Pad left edge of the output EPS bounding box by the given amount
 (in mm).
 
 @item @code{eps-box-padding}
 @tab @code{#f}
 @tab Pad left edge of the output EPS bounding box by the given amount
 (in mm).
 

+@item @code{font-export-dir}
+@tab @code{#f [dir]}
+@tab Directory for exporting fonts as PostScript files.
+

 @item @code{gs-load-fonts}
 @tab @code{#f}
 @tab Load fonts via Ghostscript.
 @item @code{gs-load-fonts}
 @tab @code{#f}
 @tab Load fonts via Ghostscript.


@@ -583,6 +577,10 @@ compilation.
 @tab @code{#f}
 @tab Load only the LilyPond fonts via Ghostscript.
 
 @tab @code{#f}
 @tab Load only the LilyPond fonts via Ghostscript.
 

+@item @code{gs-never-embed-fonts}
+@tab @code{#f}
+@tab Make Ghostscript embed only TrueType fonts and no other font format.
+

 @item @code{gui}
 @tab @code{#f}
 @tab Runs silently and redirect all output to a log file.
 @item @code{gui}
 @tab @code{#f}
 @tab Runs silently and redirect all output to a log file.


@@ -773,12 +771,13 @@ size increases in PDF files.
 
 @item @code{svg-woff}
 @tab @code{#f}
 
 @item @code{svg-woff}
 @tab @code{#f}

-@tab Use woff font files in SVG backend.
-By using the woff file properly,
-you do not have to install the fonts which are used by SVG files
-to SVG viewer environment.
-However, LilyPond does not contain woff font file for text.
-woff font file is required.
+@tab This option is required when using Web Open Font Format (WOFF) font
+files with the backend @code{svg} command.  A single SVG file is created
+for every page of output.  Apart from LilyPond's own music glyphs, no
+other font information will be included.  Any SVG viewer will therefore
+require the fonts be available to it for the proper rendering of both
+text and lyrics.  It is also recommended not to use any font @q{aliases}
+or @q{lists} in case the SVG viewer cannot handle them.

 
 @item @code{trace-memory-frequency}
 @tab @code{#f}
 
 @item @code{trace-memory-frequency}
 @tab @code{#f}


@@ -1193,8 +1192,7 @@ staves are introduced in parallel, i.e. simultaneously:
 @end lilypond
 
 @node Warning this voice needs a voiceXx or shiftXx setting
 @end lilypond
 
 @node Warning this voice needs a voiceXx or shiftXx setting

-@unnumberedsubsec Warning this voice needs a @code{@bs{}voiceXx}
- or @code{@bs{}shiftXx} setting
+@unnumberedsubsec Warning this voice needs a @code{@bs{}voiceXx} or @code{@bs{}shiftXx} setting

 
 If notes from two different voices with stems in the same direction
 occur at the same musical moment, but the voices have no
 
 If notes from two different voices with stems in the same direction
 occur at the same musical moment, but the voices have no