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.
  52
  53 If you invoke LilyPond with a file `@file{foo.}@var{ext}' that doesn't
  54 have the `@file{.ly}' extension, then LilyPond will look for a file
  55 called `@file{init.}@var{ext}' and process this file.  The file
  56 `@file{init.}@var{ext}' must contain the @code{\maininput} keyword or
  57 LilyPond will not read the user specified file.
  58
  59 When LilyPond processes @file{filename.ly} it will produce
  60 @file{filename.tex} as output.  If @file{filename.ly} contains a second
  61 @code{\paper} keyword, then LilyPond will produce @file{filename-1.tex}
  62 as well.  Subsequent @code{\paper} keywords will produce sequentially
  63 numbered file names.  Several files can be specified; they will each
  64 be processed independently.@footnote{Not entirely true: The status of
  65 GUILE is kept.}
  66
  67
  68
  69 @section Environment variables
  70
  71 @table @samp
  72 @item LILYINCLUDE
  73     additional directories for finding lilypond data.  The
  74     format is like the format of @file{PATH}.
  75 @item LILYPREFIX
  76         [FIXME]
  77 @item LANG
  78     selects the language for the warning messages of LilyPond.
  79 @end table
  80
  81