Documentation/user/invoking.itexi

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