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