@node Normal usage
@section Normal usage
-Most users run LilyPond through a GUI; see
-FIXME FIXME FIXME
-@c @rlearning{First steps} if
-you have not read this already.
+Most users run LilyPond through a GUI; see @rlearning{First steps}
+if you have not read this already.
@node Command-line usage
By @q{command-line}, we mean the command line in the operating system.
Windows users might be more familiar with the terms @q{DOS shell} or
-@q{command shell}; MacOS@tie{}X users might be more familiar with the terms
-@q{terminal} or @q{console}. They should also consult
-FIXME @c @ref{Setup for MacOS X}.
+@q{command shell}. MacOS@tie{}X users might be more familiar with the terms
+@q{terminal} or @q{console}. Some additional setup is required
+for MacOS@tie{}X users; please see @rgeneral{MacOS X}.
Describing how to use this part of an operating system is outside the
scope of this manual; please consult other documentation on this topic
@end menu
@node Invoking lilypond
-@subsection Invoking @command{lilypond}
+@unnumberedsubsec Invoking @command{lilypond}
-@cindex Invoking @command{lilypond}
-@cindex command line options for @command{lilypond}
-@cindex options, command line
-@cindex switches
-
-
-The @command{lilypond} executable may be called as follows from the command line.
+The @command{lilypond} executable may be called as follows from
+the command line.
@example
lilypond [@var{option}]@dots{} @var{file}@dots{}
GUILE is not reset after processing a @code{.ly} file, so be careful
not to change any system defaults from within Scheme.}
-If @file{filename.ly} contains more than one @code{\score}
+If @file{filename.ly} contains more than one @code{\book}
block, then the rest of the scores will be output in numbered files,
starting with @file{filename-1.pdf}. In addition, the value of
@code{output-suffix} will be inserted between the basename and the
@node Command line options for lilypond
-@subsection Command line options for @command{lilypond}
+@unnumberedsubsec Command line options for @command{lilypond}
+
+@cindex Invoking @command{lilypond}
+@cindex command line options for @command{lilypond}
+@cindex options, command line
+@cindex switches
The following options are supported:
Here are a few interesting options.
+@cindex help, command line
+
@table @samp
@item help
Running @code{lilypond -dhelp} will print all of the @code{-d} options
available.
+@cindex paper-size, command line
+
@item paper-size
This option sets the default paper-size,
@example
Note that the string must be enclosed in escaped quotes ( @code{\"} ).
@c Match " in previous line to help context-sensitive editors
+@cindex safe, command line
+
@item safe
Do not trust the @code{.ly} input.
lead to huge files.
@item eps
+
+@cindex Postscript, encapulated
+@cindex EPS (Encapsulated PostScript)
+
for encapsulated PostScript. This dumps every page (system) as a separate
@file{EPS} file, without fonts, and as one collated @file{EPS} file with
all pages (systems) including fonts.
This mode is used by default by @command{lilypond-book}.
@item svg
+
@cindex SVG (Scalable Vector Graphics)
+
for SVG (Scalable Vector Graphics).
- This creates a single SVG file containing the entire music output
- with no embedded fonts. It is recommended to install the Century
+ This creates a single SVG file, without embedded fonts, for every
+ page of output. It is recommended to install the Century
Schoolbook fonts, included with your LilyPond installation, for
optimal rendering. Under UNIX, simply copy these fonts from the
LilyPond directory (typically
SVG editor or user agent.
@item scm
+
@cindex Scheme dump
+
for a dump of the raw, internal Scheme-based drawing commands.
@item null
Example: @code{lilypond -dbackend=svg @var{filename}.ly}
@item preview
+@cindex preview, command line
Generate an output file containing the titles and the first system
@item print-pages
Set the default output file to @var{FILE}. The appropriate
suffix will be added (e.g. @code{.pdf} for pdf)
+@cindex PostScript output
+
@item --ps
Generate PostScript.
+@cindex Portable Network Graphics (PNG) output
+
@item --png
Generate pictures of each page, in PNG format. This implies
@code{--ps}. The resolution in DPI of the image may be set with
-dresolution=110
@end example
+@cindex Portable Document Format (PDF) output
+
@item --pdf
Generate PDF. This implies @code{--ps}.
@end table
@node Environment variables
-@subsection Environment variables
+@unnumberedsubsec Environment variables
@cindex LANG
input file.
@item Error
+@cindex error
Something is definitely wrong. The current processing step (parsing,
interpreting, or formatting) will be finished, but the next step will
be skipped.
@item Fatal error
-@cindex error
@cindex fatal error
Something is definitely wrong, and LilyPond cannot continue. This
happens rarely. The most usual cause is misinstalled fonts.
other output.
@item Aborted (core dumped)
+@cindex Aborted (core dumped)
This signals a serious programming error that caused the program to
crash. Such errors are considered critical. If you stumble on one,
send a bug-report.
indicated line of your input file, try checking one or two lines
above the indicated position.
+More information about errors is given in @ref{Common errors}.
projects / lilypond.git / blobdiff