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