]> git.donarmstrong.com Git - lilypond.git/commitdiff
AU: Updated CLI preview option for lilypond
authorJames Lowe <pkx166h@gmail.com>
Thu, 1 Mar 2012 21:39:55 +0000 (21:39 +0000)
committerJames Lowe <pkx166h@gmail.com>
Fri, 9 Mar 2012 10:40:17 +0000 (10:40 +0000)
Issue 2327

Reworded section on 'preview' based on Eluze's suggestion.

Documentation/usage/running.itely

index 82d804c839f48019cf0898e0f9580df16975ec94..871f52e8764dd0bd1a41be9e4dc0f08a9f5be83f 100644 (file)
@@ -273,13 +273,15 @@ Example: @code{lilypond -dbackend=svg @var{filename}.ly}
 @cindex preview, command line
 
 This option is supported by all backends; @code{pdf}, @code{png},
-@code{ps}, @code{eps} and @code{svg}, but not @code{scm} and generates
-an output file containing the titles and the first system of music.  If
-@code{\bookpart} blocks are used, the titles and first system of every
-@code{\bookpart} will appear in the output.
-
-An additional file in the form @code{myFile.preview.extension} is
-generated, to avoid this use the additional @option{-dprint-pages} or
+@code{ps}, @code{eps} and @code{svg}, but not @code{scm}.  It generates
+an output file, in the form @code{myFile.preview.extension}, containing
+the titles and the first system of music.  If @code{\book} or
+@code{\bookpart} blocks are used, the titles of @code{\book},
+@code{\bookpart} or @code{\score} will appear in the output, including
+the first system of every @code{\score} block if the @code{\paper}
+variable @code{print-all-headers} is set to @code{#t}.
+
+To suppress the usual output, use the @option{-dprint-pages} or
 @option{-dno-print-pages} options according to your requirements.
 
 @item gui