For many properties, regardless of the data type of the property, setting the
property to false ( @code{##f} ) will result in turning it off, causing
-Lilypond to ignore that property entirely. This is particularly useful for
+LilyPond to ignore that property entirely. This is particularly useful for
turning off grob properties which may otherwise be causing problems.
We demonstrate how to glean this information from the notation manual
sequencers and XML converters. Refer to the
@uref{http://@/lilypond@/.org,website} for more details.
-These are separate programs from lilypond itself, and are run
+These are separate programs from @command{lilypond} itself, and are run
on the command-line; see @ref{Command-line usage} for more information.
@node Introduction to the LilyPond file structure
@subsection Introduction to the LilyPond file structure
-A basic example of a lilypond input file is
+A basic example of a LilyPond input file is
@example
\version @w{"@version{}"}
@node Input syntax
@chapter Input syntax
-This section deals with general lilypond input syntax issues,
+This section deals with general LilyPond input syntax issues,
rather than specific notation.
FIXME: don't complain about anything in this chapter. It's still
@code{-dclip-systems}. The clips are output as EPS files, and are
converted to PDF and PNG if these formats are switched on as well.
-For more information on output formats, see @rprogram{Invoking lilypond}.
+For more information on output formats, see @rprogram{Invoking LilyPond}.
@seealso
The initialization of LilyPond is done in a number of files that are
included by default when you start the program, normally transparent to the
-user. Run lilypond --verbose to see a list of paths and files that Lily
+user. Run @code{lilypond --verbose} to see a list of paths and files that Lily
finds.
Files placed in directory @file{PATH/TO/share/lilypond/VERSION/ly/} (where
option when invoking @code{lilypond --include=DIR} which adds DIR to the
search path.
-The @code{\include} statement can use full path information, but with the Unix
+The @code{\include} statement can use full path information, but with the UNIX
convention @code{/} rather than the DOS/Windows @code{\}. For example,
if @file{stuff.ly} is located one directory higher than the current working
directory, use
TODO: everything
-By default, lilypond does a pretty jazz'n job of picking
+By default, LilyPond does a pretty jazz'n job of picking
directions. But in some cases, it may be desirable to force a
direction.
@unnumberedsubsubsec Compilation
-In addition to the packages needed for running Lilypond (see below), you
+In addition to the packages needed for running LilyPond (see below), you
need the following extra packages for building.
When installing a binary package FOO, you may need to install the
You can view the documentation online at
@uref{http://lilypond.org/doc/}, but you can also build it locally.
-This process requires a successful compile of lilypond, and some
+This process requires a successful compile of LilyPond, and some
additional tools and packages
@itemize
@node Building documentation without compiling LilyPond
@subsection Building documentation without compiling LilyPond
-The documentation can be built locally without compiling lilypond from
+The documentation can be built locally without compiling LilyPond from
scratch.
From a fresh git checkout, do
exec /usr/bin/pngtopnm "$@"
@end verbatim
-On OSX, I use this:
+On MacOS@tie{}X, I use this:
@verbatim
export DYLD_LIBRARY_PATH=/sw/lib
@verbatim
### run from Documentation/user/
-# possibly required on OSX and/or old texinfo
+# possibly required on OS X and/or old texinfo
# ulimit -n 4096
if [ -e out-www/lilypond.texi ]; then rm out-www/lilypond.* ; fi;
if [ -e out-www/lilypond-program.texi ]; then rm
@unnumberedsubsubsec International fonts
-On MacOs X, all fonts are installed by default. However, finding all
+On MacOS@tie{}X, all fonts are installed by default. However, finding all
system fonts requires a bit of configuration; see
@uref{http://lists.gnu.org/archive/html/lilypond-user/2007-03/msg00472.html,
this post} on the @code{lilypond-user} mailing list.
@item
@emph{@ref{Fundamental concepts}},
-explains some general concepts about the lilypond file format. If
+explains some general concepts about the LilyPond file format. If
you are not certain where to place a command, read this chapter!
@item
input files relative to the top-directory of the source archive. For
example, @file{input/@/lsr/@/dirname/@/bla@/.ly} may refer to the file
@file{lilypond@/2.x.y/@/input/@/lsr/@/dirname/@/bla@/.ly}. On binary
-packages for the Unix platform, the documentation and examples can
+packages for the UNIX platform, the documentation and examples can
typically be found somewhere below
@file{/usr/@/share/@/doc/@/lilypond/}. Initialization files, for
example @file{scm/@/lily@/.scm}, or @file{ly/@/engraver@/-init@/.ly},
@cindex lilypond-internals
@cindex internal documentation
@cindex Scheme
-@cindex extending lilypond
+@cindex extending LilyPond
@cindex index
Finally, this and all other manuals, are available online both as PDF
Sometimes it is useful to display music elements (such as ties and slurs)
as if they continued after the end of the fragment. This can be done by
-breaking the staff and suppressing inclusion of the rest of the lilypond
+breaking the staff and suppressing inclusion of the rest of the LilyPond
output.
In @LaTeX{}, define @code{\betweenLilyPondSystem} in such a way that
To insert LilyPond output in other programs, use @code{lilypond}
instead of @code{lilypond-book}. Each example must be created
individually and added to the document; consult the documentation for
-that program. Most programs will be able to insert lilypond output in
+that program. Most programs will be able to insert LilyPond output in
@file{PNG}, @file{EPS}, or @file{PDF} formats.
-To reduce the white space around your lilypond score, use
+To reduce the white space around your LilyPond score, use
the following options
@example
@node Non-musical notation
@chapter Non-musical notation
-This section deals with general lilypond issues, rather than
+This section deals with general LilyPond issues, rather than
specific notation.
@menu
@end example
To actually display bar numbers where this function is called,
-invoke lilypond with
+invoke @command{lilypond} with
@example
lilypond -d display-bar-numbers FILENAME.ly
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}; OSX users might be more familiar with the terms
-@q{terminal} or @q{console}. OSX users should also consult @ref{MacOS X
+@q{command shell}; MacOS@tie{}X users might be more familiar with the terms
+@q{terminal} or @q{console}. They should also consult @ref{MacOS X
on the command-line}.
Describing how to use this part of an operating system is outside the
@cindex switches
-The @code{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{}
@cindex SVG (Scalable Vector Graphics)
You need a SVG viewer which supports embedded fonts, or a SVG
viewer which is able to replace the embedded fonts with OTF fonts.
- Under Unix, you may use @uref{http://www.inkscape.org,Inkscape}
+ Under UNIX, you may use @uref{http://www.inkscape.org,Inkscape}
(version 0.42 or later), after copying the OTF fonts in directory
@file{PATH/TO/share/lilypond/VERSION/fonts/otf/} to @file{~/.fonts/}.
@item scm
@item -j,--jail=@var{user},@var{group},@var{jail},@var{dir}
-Run LilyPond in a chroot jail.
+Run @command{lilypond} in a chroot jail.
The @code{--jail} option provides a more flexible alternative to
@code{--safe} when LilyPond formatting is available through a web
server or whenever LilyPond executes externally provided
sources.
-The @code{--jail} option works by changing the root of LilyPond to
+The @code{--jail} option works by changing the root of @command{lilypond} to
@var{jail} just before starting the actual compilation process. The user
and group are then changed to match those provided, and the current
directory is changed to @var{dir}. This setup guarantees that it is not
possible (at least in theory) to escape from the jail. Note that for
-@code{--jail} to work LilyPond must be run as root, which is usually
+@code{--jail} to work @command{lilypond} must be run as root, which is usually
accomplished in a safe way using @command{sudo}.
Setting up a jail is a slightly delicate matter, as we must be sure that
@cindex LANG
@cindex LILYPOND_DATADIR
-@code{Lilypond} recognizes the following environment variables:
+@command{lilypond} recognizes the following environment variables:
@table @code
@item LILYPOND_DATADIR
This specifies a directory where locale messages and
@end example
@noindent
-MacOS X users may execute this command under the menu entry
+MacOS@tie{}X users may execute this command under the menu entry
@code{Compile > Update syntax}.
If there are no changes to myfile.ly and file called myfile.ly.NEW
@end example
To upgrade many files at once, combine @code{convert-ly} with
-standard unix commands. This example will upgrade all @code{.ly}
+standard UNIX commands. This example will upgrade all @code{.ly}
files in the current directory
@example
@subsection Problems with @code{convert-ly}
Not all language changes are handled. Only one output option can be
-specified. Automatically updating scheme and lilypond scheme
+specified. Automatically updating scheme and LilyPond scheme
interfaces is quite unlikely; be prepared to tweak scheme code
manually.
@subsection MacOS X on the command-line
The scripts (such as lilypond-book, convert-ly, abc2ly, and even
-lilypond itself) are included inside MacOS X .app. They can be run from
+lilypond itself) are included inside the .app file for MacOS@tie{}X. They can be run from
the command line by invoking them directly, e.g.
@example
@end example
@noindent
-where $@{LILYPOND_VERSION@} is your lilypond version. If Lilypond was not
+where $@{LILYPOND_VERSION@} is your LilyPond version. If LilyPond was not
installed in @file{/usr/local/}, then change this path accordingly.
@subsection TexShop
The @uref{http://@/www@/.uoregon@/.edu/~koch/texshop/index@/.html,TexShop}
-editor for Mac OS X can be extended to run LilyPond, lilypond-book and
+editor for MacOS@tie{}X can be extended to run LilyPond, lilypond-book and
convert-ly from within the editor, using the extensions available at
@uref{http://@/www@/.dimi@/.uniud@/.it/vitacolo/freesoftware@/.html}.
follow hyperlinks using the @file{lilypond-invoke-editor} script
supplied with LilyPond.
-For Xpdf on Unix, the following should be present in
-@file{xpdfrc}@footnote{On unix, this file is found either in
+For Xpdf on UNIX, the following should be present in
+@file{xpdfrc}@footnote{On UNIX, this file is found either in
@file{/etc/xpdfrc} or as @file{.xpdfrc} in your home directory.}
@example
@code{\context} commands. For an explanation on these commands,
see @ref{Creating contexts}.
-There are different predefined staff contexts available in Lilypond:
+There are different predefined staff contexts available in LilyPond:
@itemize
@item
* Vocal ensembles::
* Ancient notation templates::
* Jazz combo::
-* Lilypond-book templates::
+* lilypond-book templates::
@end menu
@end ignore
-@node Lilypond-book templates
-@appendixsec Lilypond-book templates
+@node lilypond-book templates
+@appendixsec lilypond-book templates
These templates are for use with @code{lilypond-book}. If you're not familiar
-with this program, please refer to @rprogram{LilyPond-book}.
+with this program, please refer to @rprogram{lilypond-book}.
@appendixsubsec LaTeX
\usepackage{graphicx}
\begin{document}
-\title{A short document with lilypond and xelatex}
+\title{A short document with LilyPond and xelatex}
\maketitle
Normal \textbf{font} commands inside the \emph{text} work,
You can use this to print the \ifxetex \XeTeX{} command \else
XeTeX command \fi which is not known to normal \LaTeX .
-In normal text you can easily use lilypond commands, like this:
+In normal text you can easily use LilyPond commands, like this:
\begin{lilypond}
{a2 b c'8 c' c' c'}
\noindent
and so on.
-The fonts of snippets set with lilypond will have to be set from
+The fonts of snippets set with LilyPond will have to be set from
inside
of the snippet. For this you should read the AU on how to use
lilypond-book.
@cindex Text, other languages
@warning{To write accented and special text (such as characters
from other languages), simply insert the characters directly into
-the lilypond file. The file must be saved as UTF-8. For more
+the LilyPond file. The file must be saved as UTF-8. For more
information, see @ref{Text encoding}.}
@menu
Checking to make sure that text scripts and lyrics are within the
margins is a relatively large computational task. To speed up
-processing, lilypond does not perform such calculations by
+processing, LilyPond does not perform such calculations by
default; to enable it, use
@example
commands.
@code{\markup} is primarily used for @internalsref{TextScript}s,
-but it can also be used anywhere text is called in lilypond
+but it can also be used anywhere text is called in LilyPond
@lilypond[quote,verbatim]
\header{ title = \markup{ \bold { foo \italic { bar! } } } }
what LilyPond has done to the file. If any errors occur, please
examine this file.
-@subsubheading Unix
+@subsubheading UNIX
Create a text file called @file{test.ly} and enter:
Navigate to
@file{@var{installdir}/lilypond/usr/share/lilypond/current/}
-@strong{OSX}
+@strong{MacOS X}
Navigate to
@file{@var{installdir}/LilyPond.app/Contents/Resources/share/lilypond/current/}
@snippets
Checking to make sure that text scripts and lyrics are within the margins is
-a relatively large computational task. To speed up processing, lilypond does
+a relatively large computational task. To speed up processing, LilyPond does
not perform such calculations by default; to enable it, use
@example
@subsubsection Adding dynamics marks
Stanzas differing in loudness may be indicated by putting a
-dynamics mark before each stanza. In Lilypond, everything coming in
+dynamics mark before each stanza. In LilyPond, everything coming in
front of a stanza goes into the @code{StanzaNumber} object; dynamics marks
are no different. For technical reasons, you have to set the stanza
outside @code{\lyricmode}:
When a piece of music has many verses, they are often printed in
multiple columns across the page. An outdented verse number often
introduces each verse. The following example shows how to produce such
-output in Lilypond.
+output in LilyPond.
@lilypond[ragged-right,quote,verbatim]
melody = \relative c' {
As long as LilyPond can understand your files and produces the output
that you want, it doesn't matter what your files look like. However,
-there are a few other things to consider when writing lilypond files.
+there are a few other things to consider when writing LilyPond files.
@itemize
-@item What if you make a mistake? The structure of a lilypond
+@item What if you make a mistake? The structure of a LilyPond
file can make certain errors easier (or harder) to find.
@item What if you want to share your files with somebody
else? In fact, what if you want to alter your own files in
-a few years? Some lilypond files are understandable at
+a few years? Some LilyPond files are understandable at
first glance; other files may leave you scratching your head
for an hour.
-@item What if you want to upgrade your lilypond file for use
-with a later version of lilypond? The input syntax changes
-occasionally as lilypond improves. Most changes can be
+@item What if you want to upgrade your LilyPond file for use
+with a later version of LilyPond? The input syntax changes
+occasionally as LilyPond improves. Most changes can be
done automatically with @code{convert-ly}, but some changes
-might require manual assistance. Lilypond files can be
+might require manual assistance. LilyPond files can be
structured in order to be easier (or harder) to update.
@end itemize
projects / lilypond.git / commitdiff