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