Documentation/user/invoking.itexi

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