Documentation/user/lilypond.tely

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