X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2Finvoking.itexi;h=96f19453cbf239f490a1be02eee9acb04a690fbd;hb=d1639a6fd5bc462e4b18f27aa959c69c81756ac7;hp=c8c67759651d23d6bd15d941403492233c99b85f;hpb=462ddeacef82187d5b85eb92c167f08561ad311a;p=lilypond.git diff --git a/Documentation/user/invoking.itexi b/Documentation/user/invoking.itexi index c8c6775965..96f19453cb 100644 --- a/Documentation/user/invoking.itexi +++ b/Documentation/user/invoking.itexi @@ -1,81 +1,104 @@ +@node Invoking LilyPond -@node Invoking LilyPond, , , Top @chapter Invoking LilyPond @cindex Invoking LilyPond +@cindex command line options +@cindex options, command line +@cindex switches @example - @strong{lilypond} [OPTION]... [MUDELA-FILE]... + lilypond [OPTION]... [MUDELA-FILE]... @end example -@section Options +@unnumberedsec Command Options -@table @samp +@table @code @item -f,--format= - Output format for sheet music. Choices are tex (for TeX - output), ps (for PostScript) and scm (for GUILE) -@item -I,--include= - add @file{FILE} to the search path for input files. -@item -m,--midi - Disable TeX output. If you have a \midi definition, it will do the - midi output only. +Output format for sheet music. Choices are tex (for @TeX{} +output), ps (for PostScript) and scm (for a Scheme +dump). + +For processing both the @TeX{} and the PostScript output, you must +have appropriate environment variables set. For @TeX{}, you have to +set @code{MFINPUTS} and @code{TEXINPUTS} to point to the directory +containing LilyPond metafont and .tex files. For processing the +PostScript with Ghostscript, you have to set @code{GS_FONTPATH} to +point to the directory containing LilyPond @file{pfa} files. + +Scripts to do this are included in +@file{buildscripts/out/lilypond-profile} (for sh shells) and +@file{buildscripts/out/lilypond-login} (for C-shells), and should +normally be run as part of your login process. + + +@item -h,--help +Show a summary of usage. +@item --include, -I=DIRECTORY +Add @file{DIRECTORY} to the search path for input files. +@cindex file searching +@cindex search path +@item -i,--init=FILE +Set init file to @file{FILE} (default: @file{init.ly}). +@item -m,--no-paper +@cindex MIDI +Disable @TeX{} output. If you have a @code{\midi} definition, it will do the +midi output only. @item -M,--dependencies - Also output rules to be included in Makefile. -@item -d,--debug - Turn debugging info on. GNU LilyPond reads the file @file{.dstreamrc}, - which lists what functions and classes may produce copious debugging - output. +Output rules to be included in Makefile. +@item -o,--output=FILE +Set the default output file to @file{FILE}. +@item -Q,--find-old-relative +show all changes needed to convert a file to relative octave syntax. + @item -s,--safe - Disallow untrusted @code{\include} directives, backslashes in TeX -code and named output. +Disallow untrusted @code{\include} directives, in-line +Scheme evaluation, backslashes in @TeX{}, code. + +@strong{WARNING}: the @code{--safe} option has not been reviewed for a +long time; do not rely on it for automatic invocation (e.g. over the +web). Volunteers are welcome to do a new audit. + +@item -T,--no-timestamps +don't timestamp the output + @item -t,--test - Switch on any experimental features. Not for general public use. +Switch on any experimental features. Not for general public use. +@item -v,--version +Show version information +@item -V,--verbose +Be verbose @item -w,--warranty - Show the warranty with which GNU LilyPond comes. (It comes with - @strong{NO WARRANTY}!) -@item -o,--output=FILE - Set the default output file to @file{FILE}. -@item -h,--help - Show a summary of usage. -@item -i,--init=FILE - Set init file to @file{FILE} (default: @file{init.ly}). -@item --include, -I=DIRECTORY - Add @file{DIRECTORY} to the search path for input files. -@item --ignore-version, -V - Make the incompatible mudela version warning non-fatal. +Show the warranty with which GNU LilyPond comes. (It comes with +@strong{NO WARRANTY}!) @end table - When invoked with a filename that has no extension, LilyPond will try adding `@file{.ly}' as an extension first. -If you invoke LilyPond with a file `@file{foo.}@var{ext}' that doesn't -have the `@file{.ly}' extension, then LilyPond will look for a file -called `@file{init.}@var{ext}' and process this file. The file -`@file{init.}@var{ext}' must contain the @code{\maininput} keyword or -LilyPond will not read the user specified file. - When LilyPond processes @file{filename.ly} it will produce -@file{filename.tex} as output. If @file{filename.ly} contains a second -@code{\paper} keyword, then LilyPond will produce @file{filename-1.tex} -as well. Subsequent @code{\paper} keywords will produce sequentially -numbered file names. Several files can be specified; they will each -be processed independently.@footnote{Not entirely true: The status of -GUILE is kept.} - - +@file{filename.tex} as output (or @file{filename.ps} for PostScript +output). If @file{filename.ly} contains more than one @code{\score} +block, then LilyPond will output the rest in numbered files, starting +with @file{filename-1.tex}. Several files can be specified; they will +each be processed independently. @footnote{The status of GUILE is not +reset across invocations, so be careful not to change any default +settings from within Scheme .} @section Environment variables -@table @samp +@table @code @item LILYINCLUDE - additional directories for finding lilypond data. The - format is like the format of @file{PATH}. -@item LILYPREFIX - [FIXME] +additional directories for finding lilypond data. The +format is like the format of @file{PATH}. +@item LILYPONDPREFIX +This specifies a directory where locale messages and +data files will be looked up by default. The directory should contain +subdirectories called @file{ly/}, @file{ps/}, @file{tex/}, etc. + @item LANG - selects the language for the warning messages of LilyPond. +selects the language for the warning messages of LilyPond. @end table