Documentation/user/invoking.itexi

   1
   2 @node Invoking LilyPond, , , Top
   3 @chapter Invoking LilyPond
   4 @cindex Invoking LilyPond
   5
   6
   7 @example
   8         @strong{lilypond} [OPTION]... [MUDELA-FILE]...
   9 @end example
  10
  11 @section Options
  12
  13 @table @samp
  14 @item -f,--format=
  15         Output format for sheet music. Choices are tex (for TeX
  16         output), ps (for PostScript) and scm (for GUILE)
  17 @item -I,--include=
  18     add @file{FILE} to the search path for input files.
  19 @item -m,--midi
  20     Disable TeX output. If you have a \midi definition, it will do the
  21     midi output only.
  22 @item -M,--dependencies
  23     Also output rules to be included in Makefile.
  24 @item -d,--debug
  25     Turn debugging info on.  GNU LilyPond reads the file @file{.dstreamrc},
  26     which lists what functions and classes may produce copious debugging
  27     output.
  28 @item -s,--safe
  29     Disallow untrusted @code{\include} directives, backslashes in TeX
  30 code and named output.
  31 @item -t,--test
  32     Switch on any experimental features.  Not for general public use.
  33 @item -w,--warranty
  34     Show the warranty with which GNU LilyPond comes. (It comes with
  35     @strong{NO WARRANTY}!)
  36 @item -o,--output=FILE
  37     Set the default output file to @file{FILE}.
  38 @item -h,--help
  39     Show a summary of usage.
  40 @item -i,--init=FILE
  41     Set init file to @file{FILE} (default: @file{init.ly}).
  42 @item --include, -I=DIRECTORY
  43     Add @file{DIRECTORY} to the search path for input files.
  44 @item --ignore-version, -V
  45     Make the incompatible mudela version warning non-fatal.
  46 @end table
  47
  48
  49
  50 When invoked with a filename that has no extension, LilyPond will try
  51 adding `@file{.ly}' as an extension first, then `@file{.fly}' and
  52 finally `@file{.sly}' extension.  If the filename ends with
  53 `@file{.fly}', LilyPond processes the file as music using
  54 `@file{init.fly}'.  In this case, LilyPond does something like:
  55
  56 @quotation
  57
  58 @example
  59 \score @{
  60   \notes\relative c @{
  61 1    \input "yourfile.fly"
  62   @}
  63   \paper@{@}
  64   \midi@{@}
  65 @}
  66 @end example
  67
  68 @end quotation
  69
  70 The result of `@file{.sly}' is similar except that a single unjustified
  71 line is produced.
  72
  73 If you invoke LilyPond with a file `@file{foo.}@var{ext}' that doesn't
  74 have the `@file{.ly}' extension, then LilyPond will look for a file
  75 called `@file{init.}@var{ext}' and process this file.  The file
  76 `@file{init.}@var{ext}' must contain the @code{\maininput} keyword or
  77 LilyPond will not read the user specified file.
  78
  79 When LilyPond processes @file{filename.ly} it will produce
  80 @file{filename.tex} as output.  If @file{filename.ly} contains a second
  81 @code{\paper} keyword, then LilyPond will produce @file{filename-1.tex}
  82 as well.  Subsequent @code{\paper} keywords will produce sequentially
  83 numbered file names.  Several files can be specified; they will each
  84 be processed independently.@footnote{Not entirely true: The status of
  85 GUILE is kept.}
  86
  87
  88
  89 @section Environment variables
  90
  91 @table @samp
  92 @item LILYINCLUDE
  93     additional directories for finding lilypond data.  The
  94     format is like the format of @file{PATH}.
  95 @item LILYPREFIX
  96         [FIXME]
  97 @item LANG
  98     selects the language for the warning messages of LilyPond.
  99 @end table
 100
 101