Documentation/user/lilypond.tely

   1 \input texinfo @c -*- coding: latin-1; mode: texinfo; -*-
   2 @setfilename lilypond.info
   3 @settitle GNU LilyPond
   4 @iftex
   5 @afourpaper
   6 @end iftex
   7
   8 @dircategory GNU music project
   9 @direntry
  10
  11 @ignore
  12 (I think)
  13 Current version of the manual: 2.5.18
  14 Please update this whenever you run convert-ly on the docs.
  15
  16 %%%%%
  17
  18 Distributions will want to install lilypond.info in postinstall, doing:
  19
  20     install-info --info-dir=/usr/share/info out/lilypond.info
  21
  22 %%%%%
  23
  24   * Prepend GNU for dir, must be unique.
  25
  26   * Do not list the `lilypond' node at toplevel, so that `info lilypond'
  27     goes to Top.
  28
  29   * List all commands in direntry.
  30
  31 @c  * lilypond: (lilypond/lilypond)Running LilyPond.      Invoking the
  32 @c    LilyPond  program.
  33
  34 @end ignore
  35
  36 * LilyPond: (lilypond/lilypond).           The GNU music typesetter.
  37 * abc2ly: (lilypond/lilypond)Invoking abc2ly.          Importing ABC.
  38 * convert-ly: (lilypond/lilypond)Invoking convert-ly.  Older LilyPond versions.
  39 * etf2ly: (lilypond/lilypond)Invoking etf2ly.          Importing Finale.
  40 * lilypond-book: (lilypond/lilypond)LilyPond-book.     Itegrating text and music.
  41 * midi2ly: (lilypond/lilypond)Invoking midi2ly.        Importing MIDI.
  42 * mup2ly: (lilypond/lilypond)Invoking mup2ly.          Importing Mup.
  43 * musedata2ly: (lilypond/lilypond)Invoking musedata2ly.        Importing MuseData.
  44 @end direntry
  45
  46
  47 @ignore
  48 @omfcreator Han-Wen Nienhuys and Jan Nieuwenhuizen
  49 @omfdescription User manual of the LilyPond music engraving system
  50 @omftype user manual
  51 @omfcategory Applications|Publishing
  52 @omflanguage English
  53 @end ignore
  54
  55 @c don't remove this comment.
  56
  57 @ignore
  58
  59 HINTS FOR STYLE
  60
  61 * Do not forget to create @cindex entries for new sections of text.
  62
  63 * Try not to use punctuation between an introductory sentence and
  64   display material (music, example code).
  65
  66 * Do not refer to LilyPond in the text.  The reader knows what the
  67   manual is about.  If you do, capitalization is LilyPond.
  68
  69 * If you explicitly refer to `lilypond', the program (or any other
  70   command to be executed), say `@command{lilypond}'.
  71
  72 * Do not explicitly refer to the reader/user.  There is no one else
  73   besides the reader and the writer.
  74
  75 * Do not use abbreviations (don't, won't, etc.).  If you do, use a
  76   comma after it:
  77
  78     blabla blabla, i.e., blabla blabla
  79
  80 * Avoid fluff (``Notice that,'' ``as you can see,'' ``Currently,'').
  81
  82 * The use of the word `illegal' is inappropriate in most cases.  Say
  83   `invalid' instead.
  84
  85 * Avoid long stretches of input code.  Noone is going to read them in
  86   print.  Instead refer to an example input file (@inputfileref), these
  87   are clickable in HTML.
  88
  89 * Abbrevs in caps, e.g., HTML, DVI, MIDI, etc.
  90
  91 * Colon usage
  92
  93   0. Do not use a colon to introduce examples, sentences just continue
  94
  95       in the display material.
  96
  97   1. To introduce lists
  98   2. When beginning a quote: "So, he said,..."
  99      This usage is rarer.  Americans often just use a comma.
 100   3. When adding a defining example at the end of a sentence.
 101
 102 * To produce good looking texinfo output (for both TTY and DVI) some
 103   additional formatting rules should be followed.
 104
 105   . Do not use tabs.  They expand to nothing in DVI output.
 106
 107   . Do not use spaces at the beginning of a line (except in @example
 108     or @verbatim environments), and do not use more than a single space
 109     between words.  `makeinfo' copies the input lines verbatim without
 110     removing those spaces.
 111
 112   . Variables or numbers which consist of a single character (probably
 113     followed by a punctuation mark) should be tied properly, either to
 114     the previous or the next word.  Example:
 115
 116       The variable@tie{}@var{a} ...
 117
 118   . To get consistent indentation in the DVI output it is better to avoid
 119     the @verbatim environment.  Use the @example environment instead if
 120     possible, but without extraneous indentation.  For example, this
 121
 122       @example
 123         foo {
 124           bar
 125         }
 126       @end example
 127
 128     should be replaced with
 129
 130       @example
 131       foo {
 132         bar
 133       }
 134       @end example
 135
 136     where `@example' starts the line (without leading spaces).
 137
 138   . Use the `quote' option in @lilypond commands if possible.
 139
 140   . Do not compress the input vertically; this is, do not use
 141
 142       Beginning of logical unit
 143       @example
 144       ...
 145       @end example
 146       continuation of logical unit
 147
 148     but
 149
 150       Beginning of logical unit
 151
 152       @example
 153       ...
 154       @end example
 155
 156       @noindent
 157       continuation of logical unit
 158
 159     This makes it easier to not forget `@noindent'.
 160
 161   . Non-ASCII characters which are in latin-1 should be directly used;
 162     this is, don't say `Ba@ss{}tuba' but `Baßtuba'.  This ensures that
 163     all such characters appear in all output formats.
 164
 165 @end ignore
 166
 167 @ifhtml
 168 This document is also available in @uref{source/Documentation/user/out-www/lilypond.pdf,PDF}.
 169 @end ifhtml
 170
 171
 172 @documentlanguage en
 173 @documentencoding ISO-8859-1
 174
 175 @syncodeindex fn cp
 176 @syncodeindex ky cp
 177 @syncodeindex pg cp
 178 @syncodeindex tp cp
 179 @syncodeindex vr cp
 180
 181
 182 @finalout
 183
 184 @titlepage
 185 @title LilyPond
 186 @subtitle The music typesetter
 187 @author The LilyPond development team
 188
 189
 190
 191 Copyright @copyright{} 1999--2005 by the authors
 192
 193   Permission is granted to copy, distribute and/or modify this document
 194   under the terms of the GNU Free Documentation License, Version 1.1
 195   or any later version published by the Free Software Foundation;
 196   with no Invariant Sections.
 197   A copy of the license is included in the section entitled ``GNU
 198   Free Documentation License''.
 199
 200 @vskip 20pt
 201
 202 @c Not yet debugged or reported.  This crashes gs-8.01:
 203 @c compiling gs-8.01 right now... -- jcn
 204 @lilypond[raggedright]
 205 \score {
 206     \context Lyrics {
 207         \override Score.RehearsalMark #'self-alignment-X = #LEFT
 208         \override Score.RehearsalMark #'font-size = #-2
 209         \mark #(ly:export (string-append
 210              "(For LilyPond version " (lilypond-version) ")"))
 211         s2
 212      }
 213      \layout {
 214          indent = 0.0\pt
 215          raggedright = ##t
 216      }
 217 }
 218 @end lilypond
 219
 220 @end titlepage
 221
 222
 223 @ifnottex
 224 This file documents GNU LilyPond.
 225
 226 Copyright 1999--2005 by the authors
 227
 228   Permission is granted to copy, distribute and/or modify this document
 229   under the terms of the GNU Free Documentation License, Version 1.1
 230   or any later version published by the Free Software Foundation;
 231   with no Invariant Sections.
 232   A copy of the license is included in the section entitled ``GNU
 233   Free Documentation License''.
 234
 235 @end ifnottex
 236
 237
 238 @ifnottex
 239 @node Top
 240 @top GNU LilyPond --- The music typesetter
 241 @c HJJ: Info needs `@top', which is a synonym for `@unnumbered' in TeX.
 242
 243 This is the user manual for GNU LilyPond 2.6.x series.
 244 @ifhtml
 245 (See the bottom of this page for the exact version number).
 246 @end ifhtml
 247
 248 @cindex web site
 249 @cindex URL
 250
 251 A further source of information is the website, which can be found at
 252 @uref{http://@/www@/.lilypond@/.org/}.  The website contains on-line copies
 253 of this and other documentation.
 254
 255 @include dedication.itely
 256
 257 @menu
 258 * Preface::                        Preface.
 259 * Introduction::                   What, Why, How.
 260 * Tutorial::                       A tutorial introduction.
 261 * Example templates::              Larger examples.
 262 * Putting it all together::        Demonstrates real-life LilyPond usage.
 263 * Running LilyPond::               Operation.
 264 * Basic notation::                 Standard musical notation.
 265 * Instrument-specific notation::   Notation that is only used for some
 266                                    instruments.
 267 * Advanced notation::              Less frequently used notation.
 268 * Changing defaults::              Tuning output.
 269 * Output formats::                 What LilyPond produces.
 270
 271 * Interfaces for programmers::
 272 * LilyPond-book::                  Integrating text and music.
 273 * Converting from other formats::  Converting to lilypond source format.
 274 * Literature list::
 275 * Scheme tutorial::
 276 * Notation manual details::
 277 * Point and click::
 278 * Cheat sheet::
 279 * GNU Free Documentation License:: FDL.
 280 * LilyPond index::
 281 @end menu
 282 @end ifnottex
 283
 284 @contents
 285
 286
 287 @include macros.itexi
 288 @include preface.itely
 289 @include introduction.itely
 290 @include tutorial.itely
 291 @include examples.itely
 292 @include putting.itely
 293 @include invoking.itely
 294 @include basic-notation.itely
 295 @include instrument-notation.itely
 296 @include advanced-notation.itely
 297 @include changing-defaults.itely
 298 @include global.itely
 299
 300 @include programming-interface.itely
 301 @include lilypond-book.itely
 302 @include converters.itely
 303
 304
 305 @c FIXME: Index has two alphabetically sorted lists @code vs plain?
 306
 307
 308 @include literature.itely
 309 @include scheme-tutorial.itely
 310 @include notation-appendices.itely
 311 @include point-and-click.itely
 312 @include cheatsheet.itely
 313 @include fdl.itexi
 314
 315 @node LilyPond index
 316 @appendix LilyPond index
 317
 318 @printindex cp
 319
 320 @bye