1 @node Invoking LilyPond
3 @chapter Invoking LilyPond
4 @cindex Invoking LilyPond
5 @cindex command line options
6 @cindex options, command line
11 lilypond [OPTION]... [MUDELA-FILE]...
14 @unnumberedsec Command Options
18 Output format for sheet music. Choices are tex (for @TeX{}
19 output), ps (for PostScript) and scm (for a Scheme
22 For processing both the @TeX{} and the PostScript output, you must
23 have appropriate environment variables set. For @TeX{}, you have to
24 set @code{MFINPUTS} and @code{TEXINPUTS} to point to the directory
25 containing LilyPond metafont and .tex files. For processing the
26 PostScript with Ghostscript, you have to set @code{GS_FONTPATH} to
27 point to the directory containing LilyPond @file{pfa} files.
29 Scripts to do this are included in
30 @file{buildscripts/out/lilypond-profile} (for sh shells) and
31 @file{buildscripts/out/lilypond-login} (for C-shells), and should
32 normally be run as part of your login process.
36 Show a summary of usage.
37 @item --include, -I=DIRECTORY
38 Add @file{DIRECTORY} to the search path for input files.
39 @cindex file searching
42 Set init file to @file{FILE} (default: @file{init.ly}).
45 Disable @TeX{} output. If you have a @code{\midi} definition, it will do the
47 @item -M,--dependencies
48 Output rules to be included in Makefile.
49 @item -o,--output=FILE
50 Set the default output file to @file{FILE}.
51 @item -Q,--find-old-relative
52 show all changes needed to convert a file to relative octave syntax.
55 Disallow untrusted @code{\include} directives, in-line
56 Scheme evaluation, backslashes in @TeX{}, code.
58 @strong{WARNING}: the @code{--safe} option has not been reviewed for a
59 long time; do not rely on it for automatic invocation (e.g. over the
60 web). Volunteers are welcome to do a new audit.
62 @item -T,--no-timestamps
63 don't timestamp the output
66 Switch on any experimental features. Not for general public use.
68 Show version information
72 Show the warranty with which GNU LilyPond comes. (It comes with
73 @strong{NO WARRANTY}!)
77 When invoked with a filename that has no extension, LilyPond will try
78 adding `@file{.ly}' as an extension first.
80 When LilyPond processes @file{filename.ly} it will produce
81 @file{filename.tex} as output (or @file{filename.ps} for PostScript
82 output). If @file{filename.ly} contains more than one @code{\score}
83 block, then LilyPond will output the rest in numbered files, starting
84 with @file{filename-1.tex}. Several files can be specified; they will
85 each be processed independently. @footnote{The status of GUILE is not
86 reset across invocations, so be careful not to change any default
87 settings from within Scheme .}
89 @section Environment variables
93 additional directories for finding lilypond data. The
94 format is like the format of @file{PATH}.
96 This specifies a directory where locale messages and
97 data files will be looked up by default. The directory should contain
98 subdirectories called @file{ly/}, @file{ps/}, @file{tex/}, etc.
101 selects the language for the warning messages of LilyPond.