Issue 2327 in lilypond: Doc for preview command line option is hard to understand

[lilypond]

Status: Accepted
Owner: ----
Labels: Type-Documentation

New issue 2327 by address@hidden: Doc for preview command line option  
is hard to understand
http://code.google.com/p/lilypond/issues/detail?id=2327

Reported by Eluze:
http://lists.gnu.org/archive/html/bug-lilypond/2012-02/msg00694.html
http://article.gmane.org/gmane.comp.gnu.lilypond.bugs/33590


hi

in AU
http://lilypond.org/doc/v2.15/Documentation/usage-big-page#running-lilypond,
item "preview" you find:

"preview

This option is supported by all backends; pdf, png, ps, eps and svg, but not
scm and generates an output file containing the titles and the first system
of music. If \bookpart blocks are used, the titles and first system of every
\bookpart will appear in the output.

An additional file in the form myFile.preview.extension is generated, to
avoid this use the additional ‘-dprint-pages’ or ‘-dno-print-pages’ options
according to your requirements."



this *is* confusing:

in the 1st paragraph the "output file (only) containing the titles and the
first system of music" is explained, but in the 2nd paragraph there is an
"additional file in the form myFile.preview.extension"!

isn't that the same?


suggestion for a new wording:

"This option is supported by all backends: pdf, png, ps, eps and svg, but
not scm.

It generates an additional output file in the form myFile.preview.extension
containing the titles and the first system of music. If \book or \bookpart
blocks are used, the titles of \book, \bookpart or \score and the first
system of every \score will appear in the output (if the \paper variable
print-all-headers = ##t is set).

To suppress the usual output use the -dprint-pages or -dno-print-pages
options according to your requirements."

hope this will be a little clearer!

thanks
Eluze

I'll try to prepare this change in Git but have no experience yet.