Documentation/user/invoking.itexi

   1 @node Invoking LilyPond
   2 @chapter Invoking LilyPond
   3 @cindex Invoking LilyPond
   4
   5
   6 @example
   7         @strong{lilypond} [OPTION]... [MUDELA-FILE]...
   8 @end example
   9
  10 @section Options
  11
  12 @table @samp
  13 @item -f,--format=
  14         Output format for sheet music. Choices are tex (for @TeX{}
  15         output), ps (for PostScript) and scm (for GUILE)
  16 @item -h,--help
  17  Show a summary of usage.
  18 @item --include, -I=DIRECTORY
  19     Add @file{DIRECTORY} to the search path for input files.
  20
  21 @item -i,--init=FILE
  22     Set init file to @file{FILE} (default: @file{init.ly}).
  23 @item -m,--no-paper
  24     Disable @TeX{} output. If you have a \midi definition, it will do the
  25     midi output only.
  26 @item -M,--dependencies
  27      Output rules to be included in Makefile.
  28 @item -o,--output=FILE
  29     Set the default output file to @file{FILE}.
  30 @item  -Q,--find-old-relative
  31   show all changes needed to convert a file to  relative octave syntax.
  32
  33 @item -s,--safe
  34     Disallow untrusted @code{\include} directives, backslashes in @TeX{}
  35 code and named output.
  36
  37 WARNING: the --safe option has not been reviewed for over a year; do
  38 not rely on for automatic lily invocation (eg. over the
  39 web). Volunteers are welcome.
  40
  41 @item -T,--no-timestamps
  42   don't timestamp the output
  43 @item -t,--test
  44     Switch on any experimental features.  Not for general public use.
  45 @item -v,--version
  46     Show version information
  47 @item -V,--verbose
  48   verbose
  49 @item -w,--warranty
  50     Show the warranty with which GNU LilyPond comes. (It comes with
  51     @strong{NO WARRANTY}!)
  52 @end table
  53
  54
  55 When invoked with a filename that has no extension, LilyPond will try
  56 adding `@file{.ly}' as an extension first.
  57
  58 When LilyPond processes @file{filename.ly} it will produce
  59 @file{filename.tex} as output (or @file{filename.ps} for
  60 PostScript output).  If @file{filename.ly} contains more than one
  61 @code{\score} block, then LilyPond will output the rest in numbered
  62 files, starting with @file{filename-1.tex}.  Several files can be
  63 specified; they will each be processed independently.  @footnote{The
  64 status of GUILE is not reset across invocations, so be careful not to
  65  change defaults settings from within Scheme .}
  66
  67 @section Environment variables
  68
  69 @table @samp
  70 @item LILYINCLUDE
  71     additional directories for finding lilypond data.  The
  72     format is like the format of @file{PATH}.
  73 @item LILYPONDPREFIX
  74         This specifies a directory where locale messages and
  75 data-files will be looked up by default. The directory should contain
  76 subdirectories called @file{ly/}, @file{ps/}, @file{tex/}, etc.
  77
  78 @item LANG
  79     selects the language for the warning messages of LilyPond.
  80 @end table
  81
  82