]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/user/invoking.itexi
* scm/grob-description.scm (all-grob-descriptions): set
[lilypond.git] / Documentation / user / invoking.itexi
index a7662b419ebd1cceea22deb3c8beaeb303123f60..e8b7699644a1b8fdc1e390e50d6f13b5cb7cda55 100644 (file)
@@ -1,3 +1,4 @@
+@c -*-texinfo-*-
 @node Invoking LilyPond
 @chapter Invoking LilyPond
 
@@ -48,14 +49,27 @@ set various debugging options.
 
 
 
-@item -f,--format=@var{format} Output format for sheet music. Choices
-are @code{tex} (for @TeX{} output, to be processed with plain @TeX{},
-or through ly2dvi), @code{pdftex} for PDF@TeX{} input, @code{ps} (for
-PostScript), @code{scm} (for a Scheme dump), and @code{as} (for
-ASCII-art).
+@item -f,--format=@var{format}
+@c
+@c
+Output format for sheet music. Choices are @code{tex} (for @TeX{}
+output, to be processed with plain @TeX{}, or through ly2dvi),
+@code{pdftex} for PDF@TeX{} input, @code{ps} (for PostScript),
+@code{scm} (for a Scheme dump), @code{sk} (for Sketch) and @code{as}
+(for ASCII-art).
+
+@strong{This option is only for developers}. Only the @TeX{} output of
+these is usable for real work. More information can be found at
+@uref{http://lilypond.org/wiki?OutputFormats}.
+
+
+@cindex output format, setting
+@cindex Sketch output
+@cindex ASCII-art output
+@cindex PDFTeX output
+@cindex PostScript output
+@cindex Scheme dump
 
-Unless you have special requirements, you should use @TeX{}
-output. All other options are experimental.
 @item -h,--help
 Show a summary of usage.
 @item --include, -I=@var{directory}
@@ -245,8 +259,22 @@ files. The temporary directory is created in the current directory as @code{ly2d
 @item -o,--output=@var{file}
     Generate output to @var{file}.  The extension of @var{file} is ignored.
 @item -P,--postscript
-    Also generate PostScript output, using dvips.
-@item --preview
+    Also generate PostScript output, using dvips.  The postscript uses
+the standard @TeX{} bitmap fonts for your printer.
+@item --pdf
+    Also generate Portable Document Format (PDF). This option will
+generate a PS file using scalable fonts, and will run the PS file
+through @code{ps2pdf} producing a PDF file.
+
+@cindex PDF
+@cindex Scalable fonts
+    
+    If you use lilypond-book or your own wrapper files, don't use
+@code{\usepackage[[T1]@{fontenc@}} in the file header but don't forget
+@code{\usepackage[latin1]@{inputenc@}} if you use any other
+non-anglosaxian characters.
+
+    @item --preview
     Also generate a picture of the first system of the score.
 @item -s,--set=@var{key}=@var{val}
     Add @var{key}= @var{val} to the settings, overriding those specified
@@ -333,7 +361,11 @@ so you can add multiple packages using multiple @code{-s=latexpackages} options.
 @code{geometry}.
 
 @item latexoptions
-    Specify additional options for the La@TeX{} @code{\documentclass}. You can put any valid value here. This was designed to allow ly2dvi to produce output for double-sided paper, with balanced margins and pagenumbers on alternating sides. To achieve this specify @code{twoside}
+    Specify additional options for the La@TeX{}
+@code{\documentclass}. You can put any valid value here. This was
+designed to allow ly2dvi to produce output for double-sided paper,
+with balanced margins and pagenumbers on alternating sides. To achieve
+this specify @code{twoside}
 
 @item orientation
     Set orientation. Choices are @code{portrait} or @code{landscape}. Is
@@ -352,8 +384,8 @@ block.
 the @code{\paper} block.
 
 @item pagenumber
-   If set to @code{no}, no page numbers will be printed.
-
+   If set to @code{no}, no page numbers will be printed.  If set to a
+positive integer, start with this value as the first page number.
 
   
   @item fontenc
@@ -366,6 +398,14 @@ the @code{\paper} block.
 @table @code
 @item LANG
 selects the language for the warning messages of Ly2dvi and LilyPond.
+
+@item GUILE_MAX_SEGMENT_SIZE
+is an option for GUILE, the scheme interpreter; it sets the size of
+the chunks of memory allocated by GUILE.  By increasing this from its
+default 8388608, the performance of LilyPond on large scores is
+slightly improved.
+
+
 @end table