]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/user/invoking.itely
*** empty log message ***
[lilypond.git] / Documentation / user / invoking.itely
index 78965707c7eb486ea7df68636e20dafeb2274351..e698d13a3aefdab83d3db4c540c0eb928530ff4d 100644 (file)
@@ -1,4 +1,4 @@
-@c -*- coding: latin-1; mode: texinfo; -*-
+@c -*- coding: utf-8; mode: texinfo; -*-
 @node Running LilyPond
 @chapter Running LilyPond
 
 @node Running LilyPond
 @chapter Running LilyPond
 
@@ -6,11 +6,13 @@ This chapter details the technicalities of running LilyPond.
 
 
 @menu
 
 
 @menu
-* Invoking lilypond::
-* Error messages::
-* Updating files with convert-ly::
-* Reporting bugs::
-* Editor support::
+* Invoking lilypond::           
+* Error messages::              
+* Updating files with convert-ly::  
+* Reporting bugs::              
+* Editor support::              
+* File structure::              
+* Including LilyPond files::    
 @end menu
 
 @node Invoking lilypond
 @end menu
 
 @node Invoking lilypond
@@ -51,9 +53,7 @@ The following options are supported:
 @item -e,--evaluate=@var{expr}
 Evaluate the Scheme @var{expr} before parsing any @file{.ly} files.
 Multiple @code{-e} options may be given, they will be evaluated
 @item -e,--evaluate=@var{expr}
 Evaluate the Scheme @var{expr} before parsing any @file{.ly} files.
 Multiple @code{-e} options may be given, they will be evaluated
-sequentially.  The function @code{ly:set-option} allows access to
-some internal variables.  Use @code{-e '(ly:option-usage)'} for more
-information.
+sequentially.  
 
 @item -f,--format=@var{format}
 which formats should be written.  Choices are @code{svg}, @code{ps},
 
 @item -f,--format=@var{format}
 which formats should be written.  Choices are @code{svg}, @code{ps},
@@ -82,7 +82,7 @@ extents of strings of text.
 @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 lilypond-book.
 
 @item svg
  for SVG (Scalable Vector Graphics)
 
 @item svg
  for SVG (Scalable Vector Graphics)
@@ -94,6 +94,25 @@ This mode  is used by default by lilypond-book.
  
 @cindex output format, setting
 
  
 @cindex output format, setting
 
+@item -d,--define-default=@var{var}=@var{val}
+This sets the internal program option @var{var} to the Scheme value
+@var{val}. If @var{val} is not supplied, then @var{#t} is used. To
+switch off an option, @code{no-} may be prefixed to @var{var}, eg.
+@example
+-dno-point-and-click
+@end example
+
+@noindent
+is the same as
+@example
+-dpoint-and-click='#f'
+@end example
+
+@cindex point and click
+
+Setting the @code{help} option will print a summary of the options
+available, and exit.
+
 @item -h,--help
 Show a summary of usage.
 
 @item -h,--help
 Show a summary of usage.
 
@@ -115,10 +134,14 @@ Generate PostScript.
 
 @item --dvi
 Generate DVI files.  In this case, the @TeX{} backend should be
 
 @item --dvi
 Generate DVI files.  In this case, the @TeX{} backend should be
-specified, i.e., @code{-f tex}.
+specified, i.e., @code{-b tex}.
 
 @item --png
 
 @item --png
-Generate pictures of each page, in PNG format.  This implies @code{--ps}.
+Generate pictures of each page, in PNG format.  This implies
+@code{--ps}.  The resolution in DPI of the image may be set with
+@example
+-dresolution=110 
+@end example
 
 @item --pdf
 Generate PDF.  This implies @code{--ps}.
 
 @item --pdf
 Generate PDF.  This implies @code{--ps}.
@@ -174,7 +197,7 @@ being compiled.  For a softer but secure alternative you can use the
 
 
 @item -j,--jail=@var{user},@var{group},@var{jail},@var{dir}
 
 
 @item -j,--jail=@var{user},@var{group},@var{jail},@var{dir}
-Run LilyPond in a jail.
+Run LilyPond in a chroot jail.
 
 The @code{--jail} option provides a more flexible alternative to 
 @code{--safe} when LilyPond formatting is available through a web
 
 The @code{--jail} option provides a more flexible alternative to 
 @code{--safe} when LilyPond formatting is available through a web
@@ -216,15 +239,6 @@ real root filesystem.  The entire content of the LilyPond installation
 (e.g., @file{/usr/share/lilypond})
 should be copied.
 
 (e.g., @file{/usr/share/lilypond})
 should be copied.
 
-@ignore
-FIXME:  fact-check; delete very soon.  -gp
-, and the content of the @file{fonts},
-@file{dvips} and @file{web2c} directories of the @TeX{} installation
-(usually under @file{/usr/share/texmf}) should be copied, too.  If your
-@TeX{} installation uses @file{ls-R} caches, copy also the cache inside the root
-of the installation.
-@end ignore
-
 If problems arise, the simplest way to trace them down is to run
 LilyPond using @command{strace}, which will allow you to determine which
 files are missing.
 If problems arise, the simplest way to trace them down is to run
 LilyPond using @command{strace}, which will allow you to determine which
 files are missing.
@@ -256,56 +270,11 @@ Show the warranty with which GNU LilyPond comes. (It comes with
 
 @section Environment variables
 
 
 @section Environment variables
 
-For processing both the @TeX{} and the PostScript output, the
-appropriate environment variables must be set.  The following scripts
-do this:
-
-@itemize @bullet
-@item @file{buildscripts/@/out/@/lilypond@/-profile}
-(for SH shells)
-@item @file{buildscripts/@/out/@/lilypond@/-login} (for C-shells)
-@end itemize
-
-They should normally be sourced as part of the login process.  If these
-scripts are not run from the system wide login process, then you must
-run them yourself.
-
-@cindex installing LilyPond
-
-If you use sh, bash, or a similar shell, then add the following to
-your @file{.profile}:
-@example
-. @var{/the/path/to/}lilypond-profile
-@end example
-
-If you use csh, tcsh or a similar shell, then add the following to
-your @file{~/.login}:
-@example
-source @var{/the/path/to/}lilypond-login
-@end example
 
 
-Of course, in both cases, you should substitute the proper location of
-either script.
-
-These scripts set the following variables:
-@table @code
-@item TEXMF
-To make sure that @TeX{} and lilypond find data files (among
-others @file{.tex}, @file{.mf}, and @file{.tfm}),
-you have to set @code{TEXMF} to point to the lilypond data
-file tree.  A typical setting would be
-@example
-@{/usr/share/lilypond/2.4.0,@{!!/usr/share/texmf@}@}
-@end example
-
-@end table
-
-
-@cindex PostScript
-@cindex TEXMF
-@cindex printing postscript
+@cindex LANG
+@cindex LILYPONDPREFIX
 
 
-The binary itself recognizes the following environment variables:
+@code{Lilypond} recognizes the following environment variables:
 @table @code
 @item LILYPONDPREFIX
 This specifies a directory where locale messages and
 @table @code
 @item LILYPONDPREFIX
 This specifies a directory where locale messages and
@@ -314,10 +283,15 @@ subdirectories called @file{ly/}, @file{ps/}, @file{tex/}, etc.
 
 @item LANG
 This selects the language for the warning messages.
 
 @item LANG
 This selects the language for the warning messages.
+
+@item LILYPOND_GC_YIELD
+With this variable the memory footprint and performance can be
+adjusted. It is a percentage tunes memory management behavior. With
+higher values, the program uses more memory, with smaller values, it
+uses more CPU time. The default value is @code{70}.
+
 @end table
 
 @end table
 
-@cindex LANG
-@cindex LILYPONDPREFIX
 
 @node Error messages
 @section Error messages
 
 @node Error messages
 @section Error messages
@@ -398,15 +372,19 @@ above the indicated position.
 @node Updating files with convert-ly
 @section Updating with @command{convert-ly}
 
 @node Updating files with convert-ly
 @section Updating with @command{convert-ly}
 
+@cindex Updating a LilyPond file
+@cindex @code{convert-ly}
+
 The LilyPond input syntax is routinely changed to simplify it or improve
 it in different ways.  As a side effect of this, the LilyPond interpreter
 often is no longer compatible with older input files.  To remedy this,
 the program @command{convert-ly} can be used to deal with most of the
 syntax changes between LilyPond versions.
 
 The LilyPond input syntax is routinely changed to simplify it or improve
 it in different ways.  As a side effect of this, the LilyPond interpreter
 often is no longer compatible with older input files.  To remedy this,
 the program @command{convert-ly} can be used to deal with most of the
 syntax changes between LilyPond versions.
 
-It uses @code{\version} statements in the input files to detect the old
-version number.  In most cases, to upgrade your input file it is sufficient
-to run
+It uses @code{\version} statements in the input files to detect the
+old version number.  In most cases, to upgrade your input file it is
+sufficient to run@footnote{MacOS X users may execute this command
+under the menu entry @samp{Compile > Update syntax}.}
 
 @example
 convert-ly -e myfile.ly
 
 @example
 convert-ly -e myfile.ly
@@ -415,6 +393,10 @@ convert-ly -e myfile.ly
 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.
 
+@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
+usually lower than the version of @command{convert-ly} itself.
+
 To upgrade LilyPond fragments in texinfo files, use
 
 @example
 To upgrade LilyPond fragments in texinfo files, use
 
 @example
@@ -446,9 +428,6 @@ Do an inline edit of the input file.  Overrides @code{--output}.
 Set the version to convert from.  If this is not set, @command{convert-ly}
 will guess this, on the basis of @code{\version} strings in the file.
 
 Set the version to convert from.  If this is not set, @command{convert-ly}
 will guess this, on the basis of @code{\version} strings in the file.
 
-@item -o,--output=@var{file}
-Set the output file to write.  
-
 @item -n,--no-version
 Normally, @command{convert-ly} adds a @code{\version} indicator 
 to the output.  Specifying this option suppresses this.  
 @item -n,--no-version
 Normally, @command{convert-ly} adds a @code{\version} indicator 
 to the output.  Specifying this option suppresses this.  
@@ -464,9 +443,6 @@ available version.
 Print usage help.
 @end table
 
 Print usage help.
 @end table
 
-@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
-usually lower than the version of @command{convert-ly} itself.
 
 @refbugs
 
 
 @refbugs
 
@@ -479,17 +455,17 @@ specified.
 
 @ignore
 Copy and paste from CVS, last updated
 
 @ignore
 Copy and paste from CVS, last updated
-Feb 14, 2005
+Aug 18, 2005
 
 http://savannah.gnu.org/cgi-bin/viewcvs/*checkout*/lilypond/lily-bugs/bugs/convert-ly.txt?rev=HEAD&content-type=text/plain
 @end ignore
 @verbatim
 
 
 http://savannah.gnu.org/cgi-bin/viewcvs/*checkout*/lilypond/lily-bugs/bugs/convert-ly.txt?rev=HEAD&content-type=text/plain
 @end ignore
 @verbatim
 
-There are a few things that the convert-ly cannot handle.  Here's a list of limitations
+There are a few things that the convert-ly cannot handle. Here's a list of limitations
 that the community has complained about.
 
 This bug report structure has been chosen because convert-ly has a structure that doesn't
 that the community has complained about.
 
 This bug report structure has been chosen because convert-ly has a structure that doesn't
-allow to smoothly implement all needed changes.  Thus this is just a wishlist, placed
+allow to smoothly implement all needed changes. Thus this is just a wishlist, placed
 here for reference.
 
 1.6->2.0:
 here for reference.
 
 1.6->2.0:
@@ -498,16 +474,38 @@ here for reference.
    on it, I first replaced all occurencies of '{<' to some dummy like '{#'
    and similarly I replaced '>}' with '&}'. After the conversion, I could
    then change back from '{ #' to '{ <' and from '& }' to '> }'.
    on it, I first replaced all occurencies of '{<' to some dummy like '{#'
    and similarly I replaced '>}' with '&}'. After the conversion, I could
    then change back from '{ #' to '{ <' and from '& }' to '> }'.
- Doesn't convert all text markup correctly. Only very simple cases are fixed.
+ Doesn't convert all text markup correctly. In the old markup syntax,
+ it was possible to group a number of markup commands together within parentheses, e.g.
+   -#'((bold italic) "string")
+   This will incorrectly be converted into
+   -\markup{{\bold italic} "string"}
+   instead of the correct
+   -\markup{\bold \italic "string"}
 2.0->2.2:
  Doesn't handle \partcombine
  Doesn't do \addlyrics => \lyricsto, this breaks some scores with multiple stanzas.
 2.0->2.2:
  Doesn't handle \partcombine
  Doesn't do \addlyrics => \lyricsto, this breaks some scores with multiple stanzas.
+2.0->2.4:
+ \magnify isn't changed to \fontsize.
+    - \magnify #m => \fontsize #f, where f = 6ln(m)/ln(2)
+ remove-tag isn't changed.
+    - \applyMusic #(remove-tag '. . .) => \keepWithTag #'. . .
+ firstpagenumber isn't changed.
+    - firstpagenumber no => printfirstpagenumber = ##f
+ Line breaks in header strings aren't converted.
+    - \\\\  as line break in \header strings => \markup \center-align <
+      "First Line" "Second Line" >
+ Crescendo and decrescendo terminators aren't converted.
+    - \rced => \!
+    - \rc => \!
 2.2->2.4:
  \turnOff (used in \set Staff.VoltaBracket = \turnOff) is not properly converted.
 2.4.2->2.5.9
  \markup{ \center-align <{ ... }> } should be converted to:
  \markup{ \center-align {\line { ... }} }
  but now, \line is missing.
 2.2->2.4:
  \turnOff (used in \set Staff.VoltaBracket = \turnOff) is not properly converted.
 2.4.2->2.5.9
  \markup{ \center-align <{ ... }> } should be converted to:
  \markup{ \center-align {\line { ... }} }
  but now, \line is missing.
+2.4->2.6
+ Special LaTeX characters such as $~$ in text are not converted to UTF8.
+
 @end verbatim
 
 
 @end verbatim
 
 
@@ -524,11 +522,15 @@ reproduce the problem.  Make it small, so we can easily debug the
 problem.  Don't forget to tell which version of LilyPond you use!  Send
 the report to @email{bug-lilypond@@gnu.org}.
 
 problem.  Don't forget to tell which version of LilyPond you use!  Send
 the report to @email{bug-lilypond@@gnu.org}.
 
+@ignore
+@c the bug database is not up to date enough. 
+
 When you've found a bug, have a look at our
 When you've found a bug, have a look at our
-@uref{http://@/lilypond@/.org/@/doc/@/v2.3/@/bugs/,bug database} to see if
+@uref{http://@/lilypond@/.org/@/doc/@/v2.5/@/bugs/,bug database} to see if
 it has already been reported.  You could also try to do a few searches
 on the mailing list for the bug.  Sometimes the bug will have already
 been reported and a fix or workaround is already known.
 it has already been reported.  You could also try to do a few searches
 on the mailing list for the bug.  Sometimes the bug will have already
 been reported and a fix or workaround is already known.
+@end ignore
 
 Here is an example of a good bug report:
 
 
 Here is an example of a good bug report:
 
@@ -536,16 +538,16 @@ Here is an example of a good bug report:
 It seems that placement of accidentals is broken.  In the
 following example, the accidental touches the note head.
 
 It seems that placement of accidentals is broken.  In the
 following example, the accidental touches the note head.
 
-Using Mac OSX 10.3.5, fink package lilypond-unstable
+Using Mac OSX 10.3.7, fink package lilypond-devel
 
 
-\version "2.3.22"
+\version "2.5.18"
 \relative c''@{
    a4 b cis d
 @}
 @end example
 
 @lilypond[quote]
 \relative c''@{
    a4 b cis d
 @}
 @end example
 
 @lilypond[quote]
-\version "2.3.22"
+\version "2.5.18"
 \relative c''{
   \override Accidental #'extra-offset = #'(1.0 . 0)
   a4 b cis d
 \relative c''{
   \override Accidental #'extra-offset = #'(1.0 . 0)
   a4 b cis d
@@ -572,7 +574,7 @@ and syntax coloring, handy compile short-cuts and reading LilyPond
 manuals using Info.  If @file{lilypond-mode} is not installed on your
 platform, then read the
 @ifhtml
 manuals using Info.  If @file{lilypond-mode} is not installed on your
 platform, then read the
 @ifhtml
-@uref{../../../topdocs/out-www/INSTALL.html,installation instructions}.
+@uref{source/Documentation/topdocs/out-www/INSTALL.html,installation instructions}.
 @end ifhtml
 @ifnothtml
 installation instructions.
 @end ifhtml
 @ifnothtml
 installation instructions.
@@ -583,7 +585,7 @@ installation instructions.
 For @uref{http://@/www@/.vim@/.org,VIM}, a @file{vimrc} is supplied, along
 with syntax coloring tools.  For more information, refer to the
 @ifhtml
 For @uref{http://@/www@/.vim@/.org,VIM}, a @file{vimrc} is supplied, along
 with syntax coloring tools.  For more information, refer to the
 @ifhtml
-@uref{../../../topdocs/out-www/INSTALL.html,installation instructions}.
+@uref{source/Documentation/topdocs/out-www/INSTALL.html,installation instructions}.
 @end ifhtml
 @ifnothtml
 installation instructions.
 @end ifhtml
 @ifnothtml
 installation instructions.
@@ -592,7 +594,7 @@ installation instructions.
 
 @item JEdit
 
 
 @item JEdit
 
-The @uref{http://@/www@/.jedit@/.org/,jEdit} editor has a LilyPond plugin.
+The @uref{http://@/www@/.jedit@/.org@/,jEdit} editor has a LilyPond plugin.
 This plugin includes a DVI viewer, integrated help and viewing via
 GhostScript.  It can be installed by doing @key{Plugins > Plugin
 Manager}, and selecting @code{LilyTool} from the @key{Install} tab.
 This plugin includes a DVI viewer, integrated help and viewing via
 GhostScript.  It can be installed by doing @key{Plugins > Plugin
 Manager}, and selecting @code{LilyTool} from the @key{Install} tab.
@@ -603,3 +605,165 @@ All these editors can be made to jump into the input file to the source
 of a symbol in the graphical output.  See @ref{Point and click}.
 
 
 of a symbol in the graphical output.  See @ref{Point and click}.
 
 
+@node File structure
+@section File structure
+
+The major part of this manual is concerned with entering various
+forms of music in LilyPond.  However, many music expressions are not
+valid input on their own, for example, a @code{.ly} file containing
+only a note
+@example
+c'4
+@end example
+
+@noindent
+will result in a parsing error.  Instead, music should be inside other
+expressions, which may be put in a file by themselves.  Such
+expressions are called toplevel expressions.  This section enumerates
+them all.
+
+A @code{.ly} file contains any number of toplevel expressions, where a
+toplevel expression is one of the following
+
+@itemize @bullet
+@item
+An output definition, such as @code{\paper}, @code{\midi}, and
+@code{\layout}.  Such a definition at the toplevel changes the default
+settings for the block entered.
+
+@item
+A @code{\header} block.  This sets the global header block.  This
+is the block containing the definitions for book-wide settings, like
+composer, title, etc. 
+
+@item
+An @code{\addquote} statement.  See @ref{Quoting other voices}
+for more information.
+
+@item
+A @code{\score} block.  This score will be collected with other
+toplevel scores, and combined as a single @code{\book}.
+
+This behavior can be changed by setting the variable
+@code{toplevel-score-handler} at toplevel.  The default handler is
+defined in the init file @file{scm/@/lily@/.scm}.
+
+The @code{\score} must begin with music, and may contain only
+one music block.
+
+@item
+A @code{\book} block logically combines multiple movements
+(i.e., multiple @code{\score} blocks) in one document.  A number of
+@code{\scores} creates a single output file, where all movement are
+concatenated.
+
+This behavior can be changed by setting the variable
+@code{toplevel-book-handler} at toplevel.  The default handler is
+defined in the init file @file{scm/@/lily@/.scm}.
+
+@item
+A compound music expression, such as
+@example
+@{ c'4 d' e'2 @}
+@end example
+
+This will add the piece in a @code{\score} and format it in a
+single book together with all other toplevel @code{\score}s and music
+expressions.
+This behavior can be changed by setting the variable
+@code{toplevel-music-handler} at toplevel.  The default handler is
+defined in the init file @file{scm/@/lily@/.scm}.
+
+@item
+A markup text, a verse for example
+@example
+\markup @{
+   2.  The first line verse two.
+@}
+@end example
+
+Markup texts are rendered above, between or below the scores or music
+expressions, wherever they appear.
+
+@item
+An indentifier, such as
+@example
+foo = @{ c4 d e d @}
+@end example
+
+This can be used later on in the file by entering @code{\foo}.  The
+name of an identifier should have alphabetic characters only; no
+numbers, underscores or dashes.
+
+@end itemize
+
+The following example shows three things that may be entered at
+toplevel
+
+@example
+\layout @{
+  % movements are non-justified by default    
+  raggedright = ##t
+@}
+
+\header @{
+   title = "Do-re-mi"
+@}
+   
+@{ c'4 d' e2 @}
+@end example
+
+
+At any point in a file, any of the following lexical instructions can
+be entered:
+
+@itemize @bullet
+@item @code{\version}
+@item @code{\include}
+@item @code{\renameinput}
+@end itemize 
+
+
+@node Including LilyPond files
+@section Including LilyPond files
+
+@cindex @code{\include}
+@cindex including files
+
+A large project may be split up into separate files.  To refer to another
+file, use
+
+@example
+\include "otherfile.ly"
+@end example
+
+The line @code{\include "file.ly"} is equivalent to pasting the contents
+of file.ly into the current file at the place where you have the
+\include.  For example, for a large project you might write separate files
+for each instrument part and create a ``full score'' file which brings
+together the individual instrument files.
+
+The initialization of LilyPond is done in a number of files that are
+included by default when you start the program, normally transparent to the
+user.  Run lilypond --verbose to see a list of paths and files that Lily
+finds.
+
+Files placed in directory @file{PATH/TO/share/lilypond/VERSION/ly/} (where
+VERSION is in the form ``2.6.1'') are on the path and available to
+@code{\include}.  Files in the
+current working directory are available to \include, but a file of the same
+name in LilyPond's installation takes precedence.  Files are
+available to \include from directories in the search path specified as an
+option when invoking @code{lilypond --include=DIR} which adds DIR to the search
+path.
+
+The @code{\include} statement can use full path information, but with the Unix
+convention @code{"/"} rather than the DOS/Windows @code{"\"}.  For example,
+if @file{stuff.ly} is located one directory higher than the current working
+directory, use
+
+@example
+\include "../stuff.ly"
+@end example
+