patch::: 1.4.1.jcn2

[lilypond.git] / Documentation / user / invoking.itexi

diff --git a/Documentation/user/invoking.itexi b/Documentation/user/invoking.itexi
index 3883fef5ebb85a25c78621fc40dc3638b052dee3..93649dc3e173da176e266e185af66e967a025173 100644 (file)
--- a/Documentation/user/invoking.itexi
+++ b/Documentation/user/invoking.itexi
@@ -6,63 +6,79 @@
 @cindex options, command line
 @cindex switches
 
+Usage:
 
 @example
-        lilypond [OPTION]... [MUDELA-FILE]...
+        lilypond [@var{OPTION}@dots{} [@var{FILE}]@dots{}
 @end example
 
-@unnumberedsec Lilypond Command Options
+@unnumberedsec Options
 
 @table @code
-@item -f,--format=
-Output format for sheet music. Choices are tex (for @TeX{}
-output), ps (for PostScript) and scm (for a Scheme
-dump)
+
+@item -e,--evaluate=@var{code}
+  Evaluates the Scheme @var{code} before parsing @file{.ly}
+files. Multiple @code{-e} options may be given. They will be evaluated
+sequentially.
+
+@item -f,--format=@var{format}
+Output format for sheet music. Choices are @code{tex} (for @TeX{}
+output), @code{ps} (for PostScript), @code{scm} (for a Scheme
+dump), and @code{as} (for ASCII-art).
+
+@c TODO: TFMFONTS
+
+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 PostScript
+output with Ghostscript you have to set @code{GS_FONTPATH} to point to
+the directory containing LilyPond 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.
+@item --include, -I=@var{directory}
+Add @var{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 -i,--init=@var{file}
+Set init file to @var{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.
+Disable @TeX{} output. If you have a @code{\midi} definition midi output
+will be generated.
 @item -M,--dependencies
 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 -o,--output=@var{FILE}
+Set the default output file to @var{FILE}.
 @item -s,--safe
 Disallow untrusted @code{\include} directives, in-line
 Scheme evaluation, backslashes in @TeX{}, code.
 
-@strong{WARNING}: the @code{--safe} option has not been reviewed for
-over a year; do not rely on it for automatic invocation (e.g. over the
+@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.
 @item -v,--version
 Show version information 
 @item -V,--verbose
-Be verbose
+Be verbose: show full paths of all  files read, and give timing
+information.
+
 @item -w,--warranty
 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.
+When invoked with a filename that has no extension, LilyPond will try to
+add @file{.ly} as an extension first.
 
 When LilyPond processes @file{filename.ly} it will produce
 @file{filename.tex} as output (or @file{filename.ps} for PostScript