Merge branch 'master' of ssh://jneem@git.sv.gnu.org/srv/git/lilypond into tmp

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

diff --git a/Documentation/user/running.itely b/Documentation/user/running.itely
index d2f7c50e59322cf171c5750322bda6c823cffd01..1addc89ab8e900d1e1c5144c52d7e625ce122a23 100644 (file)
--- a/Documentation/user/running.itely
+++ b/Documentation/user/running.itely
@@ -7,7 +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.57"
+@c \version "2.11.61"

 
 
 @node Running LilyPond
 
 
 @node Running LilyPond


@@ -42,8 +42,8 @@ as @code{midi2ly}) which are only available on the command-line.
 By @q{command-line}, we mean the command line in the operating system.
 Windows users might be more familiar with the terms @q{DOS shell} or
 @q{command shell}; MacOS@tie{}X users might be more familiar with the terms
 By @q{command-line}, we mean the command line in the operating system.
 Windows users might be more familiar with the terms @q{DOS shell} or
 @q{command shell}; MacOS@tie{}X users might be more familiar with the terms

-@q{terminal} or @q{console}.  They should also consult @ref{MacOS X
-on the command-line}.
+@q{terminal} or @q{console}.  They should also consult @ref{Setup
+for MacOS X}.

 
 Describing how to use this part of an operating system is outside the
 scope of this manual; please consult other documentation on this topic
 
 Describing how to use this part of an operating system is outside the
 scope of this manual; please consult other documentation on this topic


@@ -51,15 +51,15 @@ if you are unfamiliar with the command-line.
 
 @menu
 * Invoking lilypond::
 
 @menu
 * Invoking lilypond::

-* Command line options::
+* Command line options for lilypond::

 * Environment variables::
 @end menu
 
 @node Invoking lilypond
 * Environment variables::
 @end menu
 
 @node Invoking lilypond

-@subsection Invoking lilypond
+@subsection Invoking @command{lilypond}

 
 

-@cindex Invoking LilyPond
-@cindex command line options
+@cindex Invoking @command{lilypond}
+@cindex command line options for @command{lilypond}

 @cindex options, command line
 @cindex switches
 
 @cindex options, command line
 @cindex switches
 


@@ -99,8 +99,8 @@ will output @var{base}@file{-violin.pdf} and
 @var{base}@file{-cello-1.pdf}.
 
 
 @var{base}@file{-cello-1.pdf}.
 
 

-@node Command line options
-@subsection Command line options
+@node Command line options for lilypond
+@subsection Command line options for @command{lilypond}

 
 The following options are supported:
 
 
 The following options are supported:
 


@@ -130,9 +130,9 @@ at the top of the @code{.ly} file.
 
 @item -f,--format=@var{format}
 which formats should be written.  Choices for @code{format} are
 
 @item -f,--format=@var{format}
 which formats should be written.  Choices for @code{format} are

-@code{svg}, @code{ps}, @code{pdf}, @code{png}, @code{tex}, @code{dvi}.
+@code{svg}, @code{ps}, @code{pdf}, and @code{png}.

 
 

-Example: @code{lilypond -fpng filename.ly}
+Example: @code{lilypond -fpng @var{filename}.ly}

 
 
 
 
 
 


@@ -168,7 +168,7 @@ This option sets the default paper-size,
 
 @noindent
 Note that the string must be enclosed in escaped quotes ( @code{\"} ).
 
 @noindent
 Note that the string must be enclosed in escaped quotes ( @code{\"} ).

-
+@c Match " in previous line to help context-sensitive editors

 
 @item safe
 Do not trust the @code{.ly} input.
 
 @item safe
 Do not trust the @code{.ly} input.


@@ -198,7 +198,7 @@ disables the use of backslashes in @TeX{} strings.
 In safe mode, it is not possible to import LilyPond variables
 into Scheme.
 
 In safe mode, it is not possible to import LilyPond variables
 into Scheme.
 

-safe does @emph{not} detect resource overuse.  It is still possible to
+@code{-dsafe} does @emph{not} detect resource overuse.  It is still possible to

 make the program hang indefinitely, for example by feeding cyclic data
 structures into the backend.  Therefore, if using LilyPond on a
 publicly accessible webserver, the process should be limited in both
 make the program hang indefinitely, for example by feeding cyclic data
 structures into the backend.  Therefore, if using LilyPond on a
 publicly accessible webserver, the process should be limited in both


@@ -208,20 +208,13 @@ The safe mode will prevent many useful LilyPond snippets from being
 compiled.  The @code{--jail} is a more secure alternative, but
 requires more work to set up.
 
 compiled.  The @code{--jail} is a more secure alternative, but
 requires more work to set up.
 

+@cindex output format, setting

 @item backend
 the output format to use for the back-end.  Choices for @code{format} are
 @table @code
 @item backend
 the output format to use for the back-end.  Choices for @code{format} are
 @table @code

-@item tex
-for @TeX{} output, to be processed with La@TeX{}.  If present, the file
-@file{file.textmetrics} is read to determine text extents.
-@item texstr
-dump text strings to @file{.texstr} file, which can be run through
-(La)@TeX{}, resulting in a @code{.textmetrics} file, which contains the
-extents of strings of text.  @strong{Warning:} this functionality is
-currently missing due to heavy restructuring of the source code.

 @item ps
 @item ps

- for PostScript.

 @cindex PostScript output
 @cindex PostScript output

+ for PostScript.

 
   Postscript files include TTF, Type1 and OTF fonts.  No subsetting of
   these fonts is done.  When using oriental character sets, this can
 
   Postscript files include TTF, Type1 and OTF fonts.  No subsetting of
   these fonts is done.  When using oriental character sets, this can


@@ -232,25 +225,26 @@ currently missing due to heavy restructuring of the source code.
 @file{EPS} file, without fonts, and as one collated @file{EPS} file with
 all pages (systems) including fonts.
 
 @file{EPS} file, without fonts, and as one collated @file{EPS} file with
 all pages (systems) including fonts.
 

-This mode is used by default by lilypond-book.
+This mode is used by default by @command{lilypond-book}.

 
 @item svg
 
 @item svg

+@cindex SVG (Scalable Vector Graphics)

  for SVG (Scalable Vector Graphics).  This dumps every page as a separate
 @file{SVG} file, with embedded fonts.
  for SVG (Scalable Vector Graphics).  This dumps every page as a separate
 @file{SVG} file, with embedded fonts.

-@cindex SVG (Scalable Vector Graphics)

   You need a SVG viewer which supports embedded fonts, or a SVG
   viewer which is able to replace the embedded fonts with OTF fonts.
   Under UNIX, you may use @uref{http://www.inkscape.org,Inkscape}
   You need a SVG viewer which supports embedded fonts, or a SVG
   viewer which is able to replace the embedded fonts with OTF fonts.
   Under UNIX, you may use @uref{http://www.inkscape.org,Inkscape}

-  (version 0.42 or later), after copying the OTF fonts in directory
-  @file{PATH/TO/share/lilypond/VERSION/fonts/otf/} to @file{~/.fonts/}.
+  (version 0.42 or later), after copying the OTF fonts from the LilyPond directory
+  (typically @file{/usr/share/lilypond/VERSION/fonts/otf/}) to @file{~/.fonts/}.

 @item scm
 @item scm

- for a dump of the raw, internal Scheme-based drawing commands.

 @cindex Scheme dump
 @cindex Scheme dump

+ for a dump of the raw, internal Scheme-based drawing commands.
+
+@item null
+ do not output a printed score; has the same effect as @code{-dno-print-pages}.

 @end table
 
 @end table
 

-Example: @code{lilypond -dbackend=svg filename.ly}
-
-@cindex output format, setting
+Example: @code{lilypond -dbackend=svg @var{filename}.ly}

 
 @item preview
 Generate an output file containing the titles and the first system
 
 @item preview
 Generate an output file containing the titles and the first system


@@ -266,8 +260,8 @@ useful in combination with @code{-dpreview}.
 @item -h,--help
 Show a summary of usage.
 
 @item -h,--help
 Show a summary of usage.
 

-@item -H,--header=FIELD
-Dump a header field to file BASENAME.FIELD
+@item -H,--header=@var{FIELD}
+Dump a header field to file @file{BASENAME.@var{FIELD}}.

 
 @item --include, -I=@var{directory}
 Add @var{directory} to the search path for input files.
 
 @item --include, -I=@var{directory}
 Add @var{directory} to the search path for input files.


@@ -279,16 +273,11 @@ Set init file to @var{file} (default: @file{init.ly}).
 
 @item -o,--output=@var{FILE}
 Set the default output file to @var{FILE}.  The appropriate
 
 @item -o,--output=@var{FILE}
 Set the default output file to @var{FILE}.  The appropriate

-suffix will be added (ie @code{.pdf} for pdf, @code{.tex}
-for tex, etc).
+suffix will be added (e.g. @code{.pdf} for pdf)

 
 @item --ps
 Generate PostScript.
 
 
 @item --ps
 Generate PostScript.
 

-@item --dvi
-Generate DVI files.  In this case, the @TeX{} backend should be
-specified, i.e., @code{-dbackend=tex}.
-

 @item --png
 Generate pictures of each page, in PNG format.  This implies
 @code{--ps}.  The resolution in DPI of the image may be set with
 @item --png
 Generate pictures of each page, in PNG format.  This implies
 @code{--ps}.  The resolution in DPI of the image may be set with


@@ -473,7 +462,7 @@ above the indicated position.
 
 
 @node Updating files with convert-ly
 
 
 @node Updating files with convert-ly

-@section Updating with @command{convert-ly}
+@section Updating files with @command{convert-ly}

 
 @cindex Updating a LilyPond file
 @cindex convert-ly
 
 @cindex Updating a LilyPond file
 @cindex convert-ly


@@ -499,7 +488,13 @@ MacOS@tie{}X users may execute this command under the menu entry
 If there are no changes to myfile.ly and file called myfile.ly.NEW
 is created, then myfile.ly is already updated.
 
 If there are no changes to myfile.ly and file called myfile.ly.NEW
 is created, then myfile.ly is already updated.
 

-@subsection Command line options
+@menu
+* Command line options for convert-ly::
+* Problems with convert-ly::
+@end menu
+
+@node Command line options for convert-ly
+@subsection Command line options for @command{convert-ly}

 
 @command{convert-ly} always converts up to the last syntax change handled by
 it.  This means that the @code{\version} number left in the file is
 
 @command{convert-ly} always converts up to the last syntax change handled by
 it.  This means that the @code{\version} number left in the file is


@@ -558,11 +553,6 @@ Print usage help.
 @end table
 
 
 @end table
 
 

-@menu
-* Problems with convert-ly::    
-@end menu
-
-

 @node Problems with convert-ly
 @subsection Problems with @code{convert-ly}
 
 @node Problems with convert-ly
 @subsection Problems with @code{convert-ly}