1 @c -*- coding: utf-8; mode: texinfo; -*-
4 Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
6 When revising a translation, copy the HEAD committish of the
7 version that you are working on. For details, see the Contributors'
8 Guide, node Updating translation committishes..
11 @include included/generating-output.itexi
18 This chapter gives a basic introduction to working with LilyPond.
22 * How to write input files::
23 * Dealing with errors::
24 * How to read the manuals::
27 @node Compiling a file
28 @section Compiling a file
30 This section introduces @qq{compiling}---the processing of
31 LilyPond input files (written by you) to produce output files.
41 @subsection Entering input
45 @cindex example, first
46 @cindex case sensitive
48 @qq{Compiling} is the term used for processing an input file in
49 LilyPond format to produce output file(s). Output files are
50 generally PDF (for printing or viewing), MIDI (for playing), and
51 PNG (for online use). LilyPond input files are simple text files.
53 This example shows a simple input file:
56 \version "@w{@version{}}"
62 The graphical output is:
64 @c in this case we don't want verbatim
71 @warning{Notes and lyrics in LilyPond input must always be
72 surrounded by @w{@strong{@{ curly braces @}}}. The braces
73 should also be surrounded by a space unless they are at the
74 beginning or end of a line to avoid ambiguities. They may
75 be omitted in some examples in this manual, but don't forget them
76 in your own music! For more information about the display of
77 examples in the manual, see @ref{How to read the manuals}.}
79 In addition, LilyPond input is @strong{case sensitive}.
80 @w{@code{@{ c d e @}}} is valid input; @w{@code{@{ C D E @}}} will
81 produce an error message.
86 @subheading Producing output
92 The method of producing output depends on your operating system
93 and the program(s) you use.
98 @ref{MacOS X, @sourceimage{logo-macosx,,,}}
99 @ref{MacOS X, MacOS X} (graphical)
102 @ref{Windows, @sourceimage{logo-windows,,,}}
103 @ref{Windows, Microsoft Windows} (graphical)
106 @ref{Command-line, @sourceimage{logo-linux,,,}
107 @sourceimage{logo-freebsd,,,}
108 @sourceimage{logo-macosx,,,}
109 @sourceimage{logo-windows,,,}
111 @ref{Command-line, All operating systems} (command-line)
115 There are several other text editors available with specific
116 support for LilyPond. For more information, see
117 @rweb{Easier editing}.
119 @warning{The first time you ever run LilyPond, it may take a
120 minute or two because all of the system fonts have to be analyzed
121 first. After this, LilyPond will be much faster!}
127 @cindex running LilyPond under MacOS X
128 @cindex MacOS X, running LilyPond
136 @cindex running LilyPond under Windows
137 @cindex Windows, running LilyPond
143 @subsection Command-line
145 @cindex running LilyPond under Unix
146 @cindex Unix, running LilyPond
150 @node How to write input files
151 @section How to write input files
153 This section introduces some basic LilyPond syntax to help get you
154 started writing input files.
158 * Working on input files::
162 @node Simple notation
163 @subsection Simple notation
165 @cindex simple notation
166 @cindex notation, simple
168 LilyPond will add some notation elements automatically. In the
169 next example, we have only specified four pitches, but LilyPond
170 has added a clef, time signature, and rhythms.
172 @lilypond[verbatim,quote]
179 This behavior may be altered, but in most cases these automatic
186 @cindex relative mode
187 @cindex quote, single
189 @cindex accidentals and relative mode
190 @cindex relative mode, and accidentals
197 Music Glossary: @rglos{pitch}, @rglos{interval},
198 @rglos{scale}, @rglos{middle C}, @rglos{octave},
201 The easiest way to enter notes is by using @code{\relative} mode.
202 In this mode, the octave is chosen automatically by assuming the
203 following note is always to be placed closest to the previous
204 note, i.e., it is to be placed in the octave which is within three
205 staff spaces of the previous note. We begin by entering the most
206 elementary piece of music, a @notation{scale}, in which every note
207 is within just one staff space of the previous note.
209 @lilypond[verbatim,quote]
210 % set the starting point to middle C
217 The initial note is @notation{middle C}. Each successive note is
218 placed closest to the previous note -- in other words, the first
219 @code{c} is the closest C to middle C. This is followed by the
220 closest D to the previous note. We can create melodies which have
221 larger intervals, still using only @code{\relative} mode:
223 @lilypond[verbatim,quote]
231 It is not necessary for the first note of the melody to start on
232 the note which specifies the starting pitch. In the previous
233 example, the first note -- the @code{d} -- is the closest D to
236 By adding (or removing) quotes @code{'} or commas @code{,} from
237 the @code{@w{\relative c' @{}} command, we can change the starting
240 @lilypond[verbatim,quote]
241 % one octave above middle C
247 Relative mode can be confusing initially, but is the easiest way
248 to enter most melodies. Let us see how this relative calculation
249 works in practice. Starting from a B, which is on the middle line
250 in a treble clef, you can reach a C, D and E within 3 staff spaces
251 going up, and an A, G and F within 3 staff spaces going down. So
252 if the note following a B is a C, D or E it will be assumed to be
253 above the B, and an A, G or F will be assumed to be below.
255 @lilypond[verbatim,quote]
257 b c % c is 1 staff space up, so is the c above
258 b d % d is 2 up or 5 down, so is the d above
259 b e % e is 3 up or 4 down, so is the e above
260 b a % a is 6 up or 1 down, so is the a below
261 b g % g is 5 up or 2 down, so is the g below
262 b f % f is 4 up or 3 down, so is the f below
266 Exactly the same happens even when any of these notes are
267 sharpened or flattened. @notation{Accidentals} are
268 @strong{totally ignored} in the calculation of relative position.
269 Precisely the same staff space counting is done from a note at any
270 other position on the staff.
272 To add intervals that are larger than three staff spaces, we can
273 raise the @notation{octave} by adding a single quote @code{'} (or
274 apostrophe) to the note name. We can lower the octave by adding a
275 comma @code{,} to the note name.
277 @lilypond[verbatim,quote]
285 To change a note by two (or more!) octaves, we use multiple
286 @code{''} or @code{,,} -- but be careful that you use two single
287 quotes @code{''} and not one double quote @code{"}@tie{}! The
288 initial value in @code{@w{\relative c'}} may also be modified like
290 @c " - keeps quotes in order for context-sensitive editor -td
292 @subheading Durations (rhythms)
294 @cindex note durations
301 @cindex notating durations
303 Music Glossary: @rglos{beam}, @rglos{duration},
304 @rglos{whole note}, @rglos{half note}, @rglos{quarter note},
307 The @notation{duration} of a note is specified by a number after
308 the note name: @code{1} for a @notation{whole note}, @code{2} for
309 a @notation{half note}, @code{4} for a @notation{quarter note} and
310 so on. @notation{Beams} are added automatically.
312 If you do not specify a duration, the previous duration is used
313 for the next note. The duration of the first note defaults to a
316 @lilypond[verbatim,quote]
320 a16 a a a a32 a a a a64 a a a a a a a a2
324 To create @notation{dotted notes}, add a dot @code{.} to the
325 duration number. The duration of a dotted note must be stated
326 explicitly (i.e., with a number).
328 @lilypond[verbatim,quote]
339 @cindex notating rests
341 Music Glossary: @rglos{rest}.
343 A @notation{rest} is entered just like a note with the name
346 @lilypond[verbatim,quote]
354 @subheading Time signature
356 @cindex time signature
361 Music Glossary: @rglos{time signature}.
363 The @notation{time signature} can be set with the @code{\time}
366 @lilypond[verbatim,quote]
389 Music Glossary: @rglos{clef}.
391 The @notation{clef} can be set using the @code{\clef} command:
393 @lilypond[verbatim,quote]
407 @subheading All together
409 Here is a small example showing all these elements together:
411 @lilypond[verbatim,quote]
422 Notation Reference: @ruser{Writing pitches},
423 @ruser{Writing rhythms}, @ruser{Writing rests},
424 @ruser{Time signature}, @ruser{Clef}.
427 @node Working on input files
428 @subsection Working on input files
431 @cindex braces, curly
434 @cindex comment, line
435 @cindex block comment
436 @cindex comment, line
437 @cindex case sensitive
438 @cindex whitespace insensitive
442 @cindex version number
447 @funindex %@{ ... %@}
449 LilyPond input files are similar to source files in many common
450 programming languages. They contain a version statement,
451 are case sensitive, and white-space
452 is generally ignored. Expressions are formed with curly braces
453 @{ @}, and comments are denoted with @code{%} or
454 @w{@code{%@{ ... %@}}}.
456 If the previous sentences sound like nonsense, don't worry! We'll
457 explain what all these terms mean:
462 @strong{Version statement}:
463 Every LilyPond file should contain a version statement. A version
464 statement is a line that describes the version of LilyPond for which
465 the file was written, as in the following example:
468 \version "@w{@version{}}"
471 By convention, the version statement is placed at the top of the
474 The version statement is important for at least two reasons. First,
475 it allows automatic updating of the input file as LilyPond syntax
476 changes. Second, it describes the version of LilyPond needed to
479 If the version statement is omitted from an input file, LilyPond will print
480 a warning during the compilation of the file.
483 @strong{Case sensitive}:
484 it matters whether you enter a letter in lower case (e.g.
485 @w{@code{a, b, s, t}}) or upper case (e.g. @w{@code{A, B, S, T}}).
486 Notes are lower case: @w{@code{@{ c d e @}}} is valid input;
487 @w{@code{@{ C D E @}}} will produce an error message.
490 @strong{Whitespace insensitive}:
491 it does not matter how many spaces (or tabs or new lines) you add.
492 @w{@code{@{ c d e @}}} means the same thing as
493 @w{@code{@{ c @tie{}} @tie{} @tie{} d e @}} and:
501 Of course, the previous example is hard to read. A good rule of
502 thumb is to indent code blocks with either a tab or two spaces:
510 However, whitespace @emph{is} required to separate many syntactical
511 elements from others. In other words, whitespace can always be
512 @emph{added}, but it cannot be @emph{eliminated}. As missing
513 whitespace can give rise to strange errors it is advisable to
514 always insert whitespace before and after every syntactic element,
515 for example, before and after every curly brace.
518 @strong{Expressions}:
519 every piece of LilyPond input needs to have @strong{@{ curly
520 braces @}} placed around the input. These braces tell LilyPond
521 that the input is a single music expression, just like parentheses
522 @code{()} in mathematics. The braces should be surrounded by a
523 space unless they are at the beginning or end of a line to avoid
526 A LilyPond command followed by a simple expression in braces (such
527 as @w{@code{\relative @{ @}}}) also counts as a single music
532 @cindex block comment
535 a comment is a remark for the human reader of the music input; it
536 is ignored while parsing, so it has no effect on the printed
537 output. There are two types of comments. The percent symbol
538 @code{%} introduces a line comment; anything after @code{%} on
539 that line is ignored. By convention, a line comment is placed
540 @emph{above} the code it refers to.
544 % this comment refers to the Bs
548 A block comment marks a whole section of music input as a comment.
549 Anything that is enclosed in @code{%@{} and @code{%@}} is ignored.
550 However, block comments do not @q{nest}. This means that you
551 cannot place a block comment inside another block comment. If you
552 try, the first @code{%@}} will terminate @emph{both} block
553 comments. The following fragment shows possible uses for
557 % notes for twinkle twinkle follow
561 This line, and the notes below are ignored,
562 since they are in a block comment.
571 @node Dealing with errors
572 @section Dealing with errors
574 @cindex troubleshooting
576 Sometimes LilyPond doesn't produce the output you expect. This
577 section provides some links to help you solve the problems you
582 * General troubleshooting tips::
583 * Some common errors::
586 @node General troubleshooting tips
587 @subsection General troubleshooting tips
589 Troubleshooting LilyPond problems can be challenging for
590 people who are used to a graphical interface, because invalid
591 input files can be created. When this happens, a logical approach
592 is the best way to identify and solve the problem. Some guidelines
593 to help you learn to do this are provided in @rprogram{Troubleshooting}.
596 @node Some common errors
597 @subsection Some common errors
599 @cindex common errors
600 @cindex errors, common
602 There are a few common errors that are difficult to troubleshoot
603 based simply on the error messages that are displayed. These are
604 described in @rprogram{Common errors}.
608 @node How to read the manuals
609 @section How to read the manuals
611 This section shows how to read the documentation efficiently, and
612 also introduces some useful interactive features available in the
617 * Clickable examples::
618 * Overview of manuals::
622 @node Omitted material
623 @subsection Omitted material
626 @cindex how to read the manual
627 @cindex manual, reading
628 @cindex reading the manual
629 @cindex examples, clickable
630 @cindex clickable examples
631 @cindex tips for constructing files
633 @cindex constructing files, tips
634 @cindex files, tips for constructing
636 LilyPond input must be surrounded by @{ @} marks or a
637 @code{@w{\relative c'' @{ ... @}}}, as we saw in @ref{Working on
638 input files}. For the rest of this manual, most examples will
639 omit this. To replicate the examples, you may copy and paste the
640 displayed input, but you @strong{must} add the
641 @code{@w{\relative c'' @{ @}}} like this:
645 ... example goes here...
649 Why omit the braces? Most examples in this manual can be inserted
650 into the middle of a longer piece of music. For these examples,
651 it does not make sense to add @code{@w{\relative c'' @{ @}}} --
652 you should not place a @code{\relative} inside another
653 @code{\relative}! If we included @code{@w{\relative c'' @{ @}}}
654 around every example, you would not be able to copy a small
655 documentation example and paste it inside a longer piece of your
656 own. Most people want to add material to an existing piece, so we
657 format the manual this way.
659 Also, remember that every LilyPond file should have a @code{@bs{}version}
660 statement. Because the examples in the manuals are snippets, not files,
661 the @code{@bs{}version} statement is omitted. But you should make a
662 practice of including them in your files.
664 @node Clickable examples
665 @subsection Clickable examples
667 @warning{This feature is only available in the HTML manuals.}
669 Many people learn programs by trying and fiddling around with the
670 program. This is also possible with LilyPond. If you click on a
671 picture in the HTML version of this manual, you will see the exact
672 LilyPond input that was used to generate that image. Try it on
678 c-\markup { \bold \huge { Click here. } }
682 By cutting and pasting everything in the @qq{ly snippet} section,
683 you have a starting template for experiments. To see exactly the
684 same output (line-width and all), copy everything from @qq{Start
685 cut-&-pastable section} to the bottom of the file.
691 @n ode Keyboard navigation
692 @s ubsection Keyboard navigation
694 @warning{This features is only available in the HTML manuals.}
696 @c TODO: once this is figured out, insert it here.
698 We are currently working on this feature.
701 @node Overview of manuals
702 @subsection Overview of manuals
704 There is a lot of documentation for LilyPond. New users are
705 sometimes confused about what part(s) they should read, and
706 occasionally skip over reading vital portions.
708 @warning{Please do not skip over important parts of the
709 documentation. You will find it much harder to understand later
715 @strong{Before trying to do @emph{anything}}: read the Learning
716 manual's @ref{Tutorial}, and @ref{Common notation}. If you
717 encounter musical terms which you do not recognize, please look
718 them up in the @rglosnamed{Top, Glossary}.
721 @strong{Before trying to write a complete piece of music}: read
722 the Learning manual's @ref{Fundamental concepts}. After that, you
723 may want to look in relevant sections of the
724 @rusernamed{Top, Notation reference}.
727 @strong{Before trying to change the default output}: read the
728 Learning manual's @ref{Tweaking output}.
731 @strong{Before undertaking a large project}: read Usage document's
732 @rprogram{Suggestions for writing files}.