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