Documentation/programs.texi

   1 \input texinfo @c -*-texinfo-*-
   2 @setfilename programs.info
   3 @settitle Programs
   4
   5 @node Top, , mudela-book Authors, (dir)
   6 @top
   7 @menu
   8 * Programs::                      Your Softs-
   9 * convert-mudela::                convert-mudela to newer versions
  10 * LilyPond::                      the GNU Music Typesetter
  11 * Ly2dvi::                        Python utility to convert mudela to DVI
  12 * midi2ly::                       convert MIDI to -mudela-
  13 * mudela-book::                   integrate LaTeX and mudela
  14 @end menu
  15
  16
  17
  18
  19 @node Programs, convert-mudela, , Top
  20 @chapter Programs
  21
  22
  23
  24
  25
  26
  27
  28
  29 @node convert-mudela, convert-mudela DESCRIPTION, Programs, Top
  30 @menu
  31 * convert-mudela DESCRIPTION::    convert-mudela DESCRIPTION
  32 * convert-mudela SYNOPSIS::       convert-mudela SYNOPSIS
  33 * convert-mudela OPTIONS::        convert-mudela OPTIONS
  34 * convert-mudela BUGS::           convert-mudela BUGS
  35 * convert-mudela Authors::        convert-mudela Authors
  36 @end menu
  37 @chapter convert-mudela
  38
  39 convert-mudela sequentially applies different mudela-conversions to
  40 upgrade a Mudela input file.
  41
  42 @node convert-mudela DESCRIPTION, convert-mudela SYNOPSIS, convert-mudela, convert-mudela
  43 @section DESCRIPTION
  44
  45 Upgrade a Mudela input file from FROM_PATCHLEVEL to TO_PATCHLEVEL.
  46 If no files are given, the standard input and output are used.
  47
  48 @node convert-mudela SYNOPSIS, convert-mudela OPTIONS, convert-mudela DESCRIPTION, convert-mudela
  49 @section SYNOPSIS
  50
  51         convert-mudela [options] [files]
  52
  53 @node convert-mudela OPTIONS, convert-mudela BUGS, convert-mudela SYNOPSIS, convert-mudela
  54 @section OPTIONS
  55 @table @samp
  56 @item --output
  57     The output file to write.
  58 @item --edit
  59     Do an inline edit of the input file. override @code{--output}
  60 @item --show-rules
  61     shows all known conversions, and exit
  62 @item --from=FROM_PATCHLEVEL
  63     Set the level to convert from. If this is not set, convert-mudela will
  64     guess this, on the basis of @code{\version} strings in the file
  65 @item --to=TO_PATCHLEVEL
  66     Set the goal version of the conversion. It defaults to the latest
  67     available version.
  68 @end table
  69
  70 @node convert-mudela BUGS, convert-mudela Authors, convert-mudela OPTIONS, convert-mudela
  71 @section BUGS
  72
  73 Not all language changes are handled. Multiple output options won't
  74 work.
  75
  76 convert-mudela is written in python, so you have install
  77 @uref{http://www.python.org,python}.
  78
  79 @node convert-mudela Authors, LilyPond, convert-mudela BUGS, convert-mudela
  80 @section Authors
  81
  82 @email{hanwen@@cs.uu.nl, Han-Wen Nienhuys}, @uref{http://www.cs.uu.nl/people/hanwen}
  83
  84
  85
  86
  87
  88
  89
  90
  91 @node LilyPond, LilyPond SYNOPSIS, convert-mudela Authors, Top
  92 @menu
  93 * LilyPond SYNOPSIS::             LilyPond SYNOPSIS
  94 * LilyPond DESCRIPTION::          LilyPond DESCRIPTION
  95 * LilyPond OPTIONS::              LilyPond OPTIONS
  96 * LilyPond FEATURES::             LilyPond FEATURES
  97 * LilyPond DISCLAIMER::           LilyPond DISCLAIMER
  98 * LilyPond PROBLEMS::             LilyPond PROBLEMS
  99 * LilyPond FILES::                LilyPond FILES
 100 * LilyPond environment::          LilyPond environment
 101 * LilyPond BUGS::                 LilyPond BUGS
 102 * LilyPond SEE ALSO::             LilyPond SEE ALSO
 103 * LilyPond REMARKS::              LilyPond REMARKS
 104 * LilyPond Authors::              LilyPond Authors
 105 @end menu
 106 @chapter LilyPond
 107
 108 @cindex LilyPond
 109
 110 @node LilyPond SYNOPSIS, LilyPond DESCRIPTION, LilyPond, LilyPond
 111 @section SYNOPSIS
 112         @strong{lilypond} [OPTION]... [MUDELA-FILE]...
 113
 114 @node LilyPond DESCRIPTION, LilyPond OPTIONS, LilyPond SYNOPSIS, LilyPond
 115 @section DESCRIPTION
 116
 117 LilyPond is a music typesetter.  It produces beautiful sheet music
 118 using a high level description file as input.  LilyPond is part of
 119 the GNU Project.
 120
 121
 122 @node LilyPond OPTIONS, LilyPond FEATURES, LilyPond DESCRIPTION, LilyPond
 123 @section OPTIONS
 124 @table @samp
 125 @item -f,--format=
 126         Output format for sheet music. Choices are tex (for TeX
 127         output), ps (for PostScript) and scm (for GUILE)
 128 @item -I,--include=
 129     add @file{FILE} to the search path for input files.
 130 @item -m,--midi
 131     Disable TeX output. If you have a \midi definition, it will do the
 132     midi output only.
 133 @item -M,--dependencies
 134     Also output rules to be included in Makefile.
 135 @item -d,--debug
 136     Turn debugging info on.  GNU LilyPond reads the file @file{.dstreamrc},
 137     which lists what functions and classes may produce copious debugging
 138     output.
 139 @item -s,--safe
 140     Disallow untrusted @code{\include} directives, backslashes in TeX
 141 code and named output.
 142 @item -t,--test
 143     Switch on any experimental features.  Not for general public use.
 144 @item -w,--warranty
 145     Show the warranty with which GNU LilyPond comes. (It comes with
 146     @strong{NO WARRANTY}!)
 147 @item -o,--output=FILE
 148     Set the default output file to @file{FILE}.
 149 @item -h,--help
 150     Show a summary of usage.
 151 @item -i,--init=FILE
 152     Set init file to @file{FILE} (default: @file{init.ly}).
 153 @item --include, -I=DIRECTORY
 154     Add @file{DIRECTORY} to the search path for input files.
 155 @item --ignore-version, -V
 156     Make the incompatible mudela version warning non-fatal.
 157 @end table
 158
 159 @node LilyPond FEATURES, LilyPond DISCLAIMER, LilyPond OPTIONS, LilyPond
 160 @section FEATURES
 161
 162 This is an overview of the features that GNU LilyPond supports.  For
 163 details on how to use them, you should consult the Mudela tutorial,
 164 which is included with the package.
 165
 166 @itemize @bullet
 167 @item ASCII script input, with identifiers (for music reuse),
 168     customizable notenames, customisable fontset.
 169 @item MIDI output lets you check if you have entered the correct notes.
 170 @item MIDI to Mudela conversion through the mi2mu program.
 171 @item Multiple staffs in one score.  Each staff can have different time signatures.
 172 @item Beams, slurs, ties, chords, super/subscripts (accents and text)
 173     triplets, general n-plet (triplet, quadruplets, etc.), lyrics,
 174     transposition, dynamics (both absolute and hairpin style).
 175 @item Multiple voices within one staff; beams optionally shared
 176     between voices.  Up to four voices is handled cleanly.
 177 @item Multiple scores within one input file.  Each score is output to
 178     a different file.
 179 @item Clef changes, meter changes, cadenza-mode, key changes, repeat bars.
 180 @end itemize
 181
 182 @node LilyPond DISCLAIMER, LilyPond PROBLEMS, LilyPond FEATURES, LilyPond
 183 @section DISCLAIMER
 184
 185 GNU LilyPond is copyright 1996-1999 by its authors.  GNU LilyPond is
 186 distributed under the terms of the GNU General Public License.  GNU LilyPond
 187 is provided without any warranty what so ever.
 188 GNU LilyPond may be freely distributed.  For further information consult
 189 the GNU General Public License, from the file @file{COPYING}.
 190
 191 @node LilyPond PROBLEMS, LilyPond FILES, LilyPond DISCLAIMER, LilyPond
 192 @section PROBLEMS
 193
 194 There is an extensive list of todoes and bugs.  See the file
 195 @file{TODO} distributed with the sources.  If you have a problem you
 196 should try to find out
 197
 198 @itemize @bullet
 199 @item If the bug has been fixed in a newer release.
 200 @item If the bug has been found earlier, consult @file{TODO} and @file{BUGS}.
 201 @end itemize
 202
 203 If you have found a bug, then we would appreciate it if you sent a
 204 bugreport.
 205
 206 @itemize @bullet
 207 @item Send a copy of the input which causes the error.
 208 @item Send a description of the platform you use.
 209 @item Send a description of the LilyPond version you use
 210     (with compile/configure options please).
 211 @item Send a description of the bug itself.
 212 @item Send it to @email{bug-gnu-music@@gnu.org}; you don't have to be subscribed
 213     to this mailinglist.
 214 @end itemize
 215
 216 @node LilyPond FILES, LilyPond environment, LilyPond PROBLEMS, LilyPond
 217 @section FILES
 218 @table @samp
 219 @item @file{init.ly}
 220     The initialisation file with symbol tables etc.  It
 221     includes files from the directory
 222     @file{PREFIX/share/lilypond/ly/}. (@file{PREFIX} typically is @file{/usr/local}
 223 )@end table
 224
 225 @node LilyPond environment, LilyPond BUGS, LilyPond FILES, LilyPond
 226 @section environment
 227
 228 @table @samp
 229 @item LILYINCLUDE
 230     additional directories for finding lilypond data.  The
 231     format is like the format of @file{PATH}.
 232 @item LILYPREFIX
 233         [FIXME]
 234 @item LANG
 235     selects the language for the warning messages of LilyPond.
 236 @end table
 237
 238 @node LilyPond BUGS, LilyPond SEE ALSO, LilyPond environment, LilyPond
 239 @section BUGS
 240
 241 Lots of them.  See @file{TODO} and @file{BUGS}
 242
 243 @node LilyPond SEE ALSO, LilyPond REMARKS, LilyPond BUGS, LilyPond
 244 @section SEE ALSO
 245
 246 LilyPond comes with various other documentation files.  They are
 247 included in the source package.
 248
 249 A further source for information is the website, which can be found at
 250 @uref{http://www.lilypond.org/}.  The website contains on-line versions
 251 of the documentation
 252
 253 GNU LilyPond is updated very frequently, the latest version is always
 254 available at: @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond}.  This FTP
 255 site is mirrored at a number of sites; consult the project web pages
 256 for information about mirrors.
 257
 258 For programs which are part of the GNU music project, the following
 259 mailing list have been setup:
 260
 261 @table @samp
 262 @item @email{info-gnu-music@@gnu.org}
 263     For information on the GNU Music project, to subscribe: send mail with
 264     subject "subscribe" to @email{info-gnu-music-request@@gnu.org}
 265 @item @email{help-gnu-music@@gnu.org}
 266     For help with programs from the GNU music project.  To subscribe: send
 267     mail with subject "subscribe" to @email{help-gnu-music-request@@gnu.org}
 268 @item @email{bug-gnu-music@@gnu.org}
 269     If you have bugreports, you should send them to this list.  If you want
 270     to read all bugreports, you should subscribe to this list.  To
 271     subscribe: send mail with subject "subscribe" to
 272     @email{bug-gnu-music-request@@gnu.org}
 273 @item @email{gnu-music-discuss@@gnu.org}
 274     For discussions concerning the GNU Music project, to subscribe: send
 275     mail with subject "subscribe" to
 276     @email{gnu-music-discuss-request@@gnu.org}
 277 @end table
 278
 279 Announces of new versions will be sent to info-gnu-music and
 280 gnu-music-discuss.
 281
 282 @node LilyPond REMARKS, LilyPond Authors, LilyPond SEE ALSO, LilyPond
 283 @section REMARKS
 284
 285 GNU LilyPond has no connection with the music package Rosegarden, other
 286 than the names being similar :-)
 287
 288 @node LilyPond Authors, Ly2dvi, LilyPond REMARKS, LilyPond
 289 @section Authors
 290
 291 @cindex Author
 292
 293 @itemize @bullet
 294 @item @email{hanwen@@cs.uu.nl, Han-Wen Nienhuys}
 295     @uref{http://www.cs.uu.nl/people/hanwen}
 296 @item @email{janneke@@gnu.org, Jan Nieuwenhuizen}
 297     @uref{http://www.xs4all.nl/~jantien}
 298 @end itemize
 299
 300 Please consult the documentation file @file{AUTHORS} for more detailed
 301 information, and small contributions.
 302
 303
 304
 305
 306 @node Ly2dvi, Ly2dvi DESCRIPTION, LilyPond Authors, Top
 307 @menu
 308 * Ly2dvi DESCRIPTION::            Ly2dvi DESCRIPTION
 309 * Ly2dvi SYNOPSIS::               Ly2dvi SYNOPSIS
 310 * Ly2dvi OPTIONS::                Ly2dvi OPTIONS
 311 * Ly2dvi Features::               Ly2dvi Features
 312 * Ly2dvi Environment::            Ly2dvi Environment
 313 * Ly2dvi Files::                  Ly2dvi Files
 314 * Ly2dvi Initialization Sequence::Ly2dvi Initialization Sequence
 315 * Ly2dvi See Also::               Ly2dvi See Also
 316 * Ly2dvi Bugs::                   Ly2dvi Bugs
 317 * Ly2dvi Remarks::                Ly2dvi Remarks
 318 * Ly2dvi Authors::                Ly2dvi Authors
 319 @end menu
 320 @chapter Ly2dvi
 321
 322 @node Ly2dvi DESCRIPTION, Ly2dvi SYNOPSIS, Ly2dvi, Ly2dvi
 323 @section DESCRIPTION
 324 ly2dvi is a Python script which creates input file for LaTeX,
 325 based on information from the output files from LilyPond.
 326 The script handles multiple files. If a mudela file name is
 327 specified LilyPond is run to make an output (TeX) file.
 328
 329 One or more LaTeX files are created, based on information found
 330 in the output (TeX) files, and latex is finally run to create
 331 one or more DVI files.
 332
 333 The majority of this utility came from a bourne script written by Jan
 334 Arne Fagertun name @file{ly2dvi}.
 335
 336 @node Ly2dvi SYNOPSIS, Ly2dvi OPTIONS, Ly2dvi DESCRIPTION, Ly2dvi
 337 @section SYNOPSIS
 338
 339         ly2dvi [options] inputfile[.ly] [....]
 340
 341 @node Ly2dvi OPTIONS, Ly2dvi Features, Ly2dvi SYNOPSIS, Ly2dvi
 342 @section OPTIONS
 343
 344 @table @samp
 345 @item -D,--debug
 346     Set debug mode. There are two levels - in level one some debug
 347     info is written, in level two the command @strong{set -x} is run, which
 348     echoes every command in the ly2dvi script.
 349 @item -F,--headers=
 350     Name of additional LaTeX headers file. This is included in the
 351     tex file at the end of the headers, last line before @code{\begin@{document@}}
 352 @item -H,--Heigth=
 353     Set paper heigth (points). Used together with width and LaTeX name of
 354     papersize in case of papersize unknown to ly2dvi.
 355 @item -K,--keeplilypond
 356     Keep LilyPond output after the run.
 357 @item -L,--landscape
 358     Set landscape orientation - portrait is the default.
 359     (@strong{-L} produces @code{\usepackage[landscape]@{article@}})
 360 @item -N,--nonumber
 361     Switch off page numbering.
 362 @item -O,--orientation=
 363     Set orientation landscape - obsolete, use @strong{-L} instead.
 364 @item -P,--postscript
 365     In addition to the DVI file, also Generate a postsript file.
 366 @item -W,--Width=
 367     Set paper width (points). Used together with heigth and LaTeX name of
 368     papersize in case of papersize unknown to ly2dvi.
 369 @item -d,--dependencies
 370     Tell lilypond to make dependencies file.
 371 @item -h,--help
 372     Print help.
 373 @item -k,--keeply2dvi
 374     Keep the LaTeX file after the run.
 375 @item -l,--language=
 376     Specify LaTeX language.
 377     (@strong{-l norsk} produces @code{\usepackage[norsk]@{babel@}}).
 378 @item -o,--output=
 379     Set output directory.
 380 @item -p,--papersize=
 381     Specify papersize.
 382     (@strong{-p a4} produces @code{\usepackage[a4paper]@{article@}})
 383 @item -s,--separate
 384     Normally all output files are included into one LaTeX file.
 385     With this switch all files are run separately, to produce one
 386     DVI file for each.
 387 @end table
 388
 389 @node Ly2dvi Features, Ly2dvi Environment, Ly2dvi OPTIONS, Ly2dvi
 390 @section Features
 391
 392 ly2dvi responds to several parameters specified in the mudela
 393 file. They are overridden by corresponding command line options.
 394
 395 @table @samp
 396 @item language="";
 397     Specify LaTeX language
 398 @item latexheaders="";
 399     Specify additional LaTeX headers file
 400 @item orientation="";
 401     Set orientation.
 402 @item paperlinewidth="";
 403     Specify the width (pt, mm or cm) of the printed lines.
 404 @item papersize="";
 405     Specify name of papersize.
 406 @end table
 407
 408 @node Ly2dvi Environment, Ly2dvi Files, Ly2dvi Features, Ly2dvi
 409 @section Environment
 410
 411 @table @samp
 412 @item LILYPONDPREFIX
 413     Sets the root directory of the LilyPond installation
 414 @item LILYINCLUDE
 415     Additional directories for input files.
 416 @item TMP
 417     Temporary directory name. Default is /tmp
 418 @end table
 419
 420 @node Ly2dvi Files, Ly2dvi Initialization Sequence, Ly2dvi Environment, Ly2dvi
 421 @section Files
 422
 423 @file{titledefs.tex} is inspected for definitions used to extract
 424 additional text definitions from the mudela file. In the current
 425 version the following are defined:
 426
 427 @table @samp
 428 @item title
 429     The title of the music. Centered on top of the first page.
 430 @item subtitle
 431     Subtitle, centered below the title.
 432 @item poet
 433     Name of the poet, leftflushed below the below subtitle.
 434 @item composer
 435     Name of the composer, rightflushed below the subtitle.
 436 @item metre
 437     Meter string, leftflushed below the below poet.
 438 @item opus
 439     Name of the opus, rightflushed below the below composer.
 440 @item arranger
 441     Name of the arranger, rightflushed below the opus.
 442 @item instrument
 443     Name of the instrument, centered below the arranger
 444 @item piece
 445     Name of the piece, leftflushed below the instrument
 446 @end table
 447
 448 @file{$LILYPONDPREFIX/share/.lilyrc $HOME/.lilyrc ./.lilyrc} are files
 449 to set up default running conditions.  On Windows OS initialization
 450 files are named @file{_lilyrc}. The file syntax is as follows:
 451
 452 @example
 453 VARIABLE-NAME=VALUE
 454 @end example
 455
 456
 457 Where @strong{VARIABLE-NAME} is the name of the variable documented below
 458 and @strong{VALUE} is either a string, a 1, or a 0.  All files are parsed,
 459 in the shown sequence. In the current version the following are
 460 allowed:
 461
 462 @table @samp
 463 @item DEBUG=value
 464 This turns off (default) or on the debug capabilities.  Possible
 465 values are 0 (off) and 1 (on).
 466 @item DEPENDENCIES=value
 467 This turns off (default) or on the ability to generate a Makefile
 468 dependency list.  Possible values are 0 (off) and 1 (on).
 469 @item KEEPLILYPOND=value
 470 This turns off (default) or on the ability to keep the log file
 471 associated with the LilyPond job.  Possible values are 0 (off) and 1
 472 (on).
 473 @item KEEPLY2DVI=value
 474 This turns off (default) or on the ability to keep the temporary files
 475 that are generated by the ly2dvi job.  Possible values are 0 (off) and
 476 1 (on)
 477 @item LANGUAGE=value
 478 Specify LaTeX language.  Possible value is a valid LaTeX language.
 479 @item LATEXHF=value
 480 Specify additional LaTeX headers file.  Possible value is a file
 481 specification.
 482 @item LILYINCLUDE=value
 483 Additional directories for input files.  Possible value is a delimited
 484 directory path list.
 485 @item LILYPONDPREFIX=value
 486 This defines the LilyPond root directory.  Possible value is a valid
 487 directory specification to the LilyPond distribution location.
 488 @item NONUMBER=value
 489 This turns off (default) or on the page numbering capability.
 490 Possible values are 0 (page numbering enabled) and 1 (page numbering
 491 disabled).
 492 @item ORIENTATION=value
 493 This sets the image orientation.  Possible values are
 494 portrait (default) and landscape.
 495 @item OUTPUTDIR=value
 496 This defines the directory where the resultant files will be
 497 generated.  Possible value is a valid directory specification.
 498 Default is the current working directory.
 499 @item PAPERSIZE=value
 500 This defines the papersize the image will be sized to fit.  Possible
 501 values are a0, a1, a2, a3, a4 (default), a5, a6, a7, a8, a9, a10, b0,
 502 b1, b2, b3, b4, b5, archA, archB, archC, archD, archE, flsa, flse,
 503 halfletter, ledger, legal, letter, or note.
 504 @item PHEIGHT=value
 505 Specify paperheight (points - an inch is 72.27, a cm is 28.453 points).
 506 @item POSTSCRIPT=value
 507 This turns off (default) or on the capability of additionally
 508 generating a postscript file.  Possible values are 0 (off) and 1 (on).
 509 @item PWIDTH=value
 510 Specify paperwidth (points - an inch is 72.27, a cm is 28.453 points).
 511 @item SEPARATE=value
 512 This turns off (default) or on the capability of generating multiple
 513 dvi and postscript files from multiple source files.  The default is
 514 to generate a concatenation of the source files.  Possible values are
 515 0 (single file) and 1 (separate files).
 516 @item TMP=value
 517 This defines the emporary directory.  Actually this is not used at the
 518 present.  Possible value is a valid directory specification that is
 519 writable to the user.
 520 @end table
 521
 522 @node Ly2dvi Initialization Sequence, Ly2dvi See Also, Ly2dvi Files, Ly2dvi
 523 @section Initialization Sequence
 524 The initialization process reads inputs for several sources.  Below is
 525 a list of priorities for lowest to hightest proirity.
 526
 527 @itemize @bullet
 528 @item  Program's defaults
 529 @item  Values found in LilyPond output file
 530 @item  Environment variables
 531 @item  $LILYPONDPREFIX/share/lilypond/.lilyrc
 532 @item  $HOME/.lilyrc
 533 @item  ./.lilyrc
 534 @item  command line options
 535 @end itemize
 536
 537 Note that this differs slightly from the original bourne shell
 538 version.
 539
 540 @node Ly2dvi See Also, Ly2dvi Bugs, Ly2dvi Initialization Sequence, Ly2dvi
 541 @section See Also
 542
 543 lilypond(1), tex(1), latex(1)
 544
 545 @node Ly2dvi Bugs, Ly2dvi Remarks, Ly2dvi See Also, Ly2dvi
 546 @section Bugs
 547
 548 If you have found a bug, you should send a bugreport.
 549
 550 @itemize @bullet
 551 @item Send a copy of the input which causes the error.
 552 @item Send a description of the platform you use.
 553 @item Send a description of the LilyPond and ly2dvi version you use.
 554 @item Send a description of the bug itself.
 555 @item Send it to @email{bug-gnu-music@@gnu.org} (you don't have to subscribe
 556     to this mailinglist).
 557 @end itemize
 558
 559 @node Ly2dvi Remarks, Ly2dvi Authors, Ly2dvi Bugs, Ly2dvi
 560 @section Remarks
 561
 562 Many papersizes are now supported. Information on other sizes
 563 (LaTeX names, horizontal and vertical sizes) should be mailed to
 564 the author or to the mailing list.
 565
 566 Supported papersizes are:
 567
 568 a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, archA, archB, archC, archD,
 569 archE, b0, b1, b2, b3, b4, b5, flsa, flse, halfletter, ledger, legal,
 570 letter, note
 571
 572 @node Ly2dvi Authors, midi2ly, Ly2dvi Remarks, Ly2dvi
 573 @section Authors
 574 Python Version author:
 575 @email{daboys@@austin.rr.com, Jeffrey B. Reed},
 576 @uref{http://home.austin.rr.com/jbr/jeff/lilypond/}
 577
 578 Original bourne shell version author:
 579 @email{Jan.A.Fagertun@@energy.sintef.no, Jan Arne Fagertun},
 580 @uref{http://www.termo.unit.no/mtf/people/janaf/}
 581
 582
 583
 584
 585
 586
 587
 588 @node midi2ly, midi2ly DESCRIPTION, Ly2dvi Authors, Top
 589 @menu
 590 * midi2ly DESCRIPTION::           midi2ly DESCRIPTION
 591 * midi2ly OPTIONS::               midi2ly OPTIONS
 592 * midi2ly DISCLAIMER::            midi2ly DISCLAIMER
 593 * midi2ly SEE ALSO::              midi2ly SEE ALSO
 594 * midi2ly Authors::               midi2ly Authors
 595 @end menu
 596 @chapter midi2ly
 597
 598 @node midi2ly DESCRIPTION, midi2ly OPTIONS, midi2ly, midi2ly
 599 @section DESCRIPTION
 600 midi2ly translates a MIDI input file to Mudela (GNU LilyPond source
 601 format).  midi2ly is part of the GNU LilyPond music typesetting package.
 602
 603         midi2ly [options] midi-file
 604
 605 @node midi2ly OPTIONS, midi2ly DISCLAIMER, midi2ly DESCRIPTION, midi2ly
 606 @section OPTIONS
 607
 608 @table @samp
 609 @item -b, --no-quantify,
 610     Write exact durations, e.g.: `a4*385/384'.
 611 @item -D, --debug,
 612     Print lots of debugging stuff.
 613 @item -h, --help,
 614     Show a summary of usage.
 615 @item -I, --include=@file{DIR},
 616     Add DIR to search path.
 617 @item -k, --key=ACC[:MINOR],
 618     Set default key.  ACC > 0 sets number of sharps; ACC < 0 sets number
 619     of flats.  A minor key is indicated by ":1".
 620 @item -n, --no-silly,
 621     Assume no plets or double dots, assume smallest (reciprocal) duration 16.
 622 @item -o, --output=@file{FILE},
 623     Set @file{FILE} as default output.
 624 @item -p, --no-plets,
 625     Assume no plets.
 626 @item -q, --quiet,
 627     Be quiet.
 628 @item -s, --smallest=N,
 629     Assume no shorter (reciprocal) durations than N.
 630 @item -v, --verbose,
 631     Be verbose.
 632 @item -w, --warranty,
 633     Show the warranty with which midi2ly comes. (It comes with @strong{NO WARRANTY}!)
 634 @item -x, --no-double-dots,
 635     Assume no double dotted notes.
 636 @end table
 637
 638 @node midi2ly DISCLAIMER, midi2ly SEE ALSO, midi2ly OPTIONS, midi2ly
 639 @section DISCLAIMER
 640
 641 midi2ly is copyright 1996, 1997 by its authors. midi2ly is distributed
 642 as part of GNU LilyPond, under the terms of the GNU General Public
 643 License.  midi2ly is provided without any warranty what so ever.
 644 midi2ly may be freely distributed.  For further information consult
 645 the GNU General Public License, from the file @file{COPYING}.
 646
 647 @node midi2ly SEE ALSO, midi2ly Authors, midi2ly DISCLAIMER, midi2ly
 648 @section SEE ALSO
 649
 650 @table @samp
 651 @item @strong{lilypond}(1)
 652     The GNU LilyPond music typesetter.
 653 @end table
 654
 655 @node midi2ly Authors, mudela-book, midi2ly SEE ALSO, midi2ly
 656 @section Authors
 657
 658 Please consult the documentation file @file{AUTHORS} for more detailed
 659 information, and small contributions.
 660
 661 @email{janneke@@gnu.org, Jan Nieuwenhuizen}, @uref{http://www.xs4all.nl/~jantien}
 662
 663
 664
 665
 666
 667 @node mudela-book, mudela-book SYNOPSIS, midi2ly Authors, Top
 668 @menu
 669 * mudela-book SYNOPSIS::          mudela-book SYNOPSIS
 670 * mudela-book DESCRIPTION::       mudela-book DESCRIPTION
 671 * mudela-book OPTIONS::           mudela-book OPTIONS
 672 * mudela-book FILES::             mudela-book FILES
 673 * mudela-book BUGS::              mudela-book BUGS
 674 * mudela-book Authors::           mudela-book Authors
 675 @end menu
 676 @chapter mudela-book
 677
 678 @node mudela-book SYNOPSIS, mudela-book DESCRIPTION, mudela-book, mudela-book
 679 @section SYNOPSIS @strong{mudela-book} [options] inputfile
 680
 681 @node mudela-book DESCRIPTION, mudela-book OPTIONS, mudela-book SYNOPSIS, mudela-book
 682 @section DESCRIPTION @file{mudela-book} is a script that helps
 683 integrating mudela and LaTeX.  mudela-book runs LilyPond on
 684 fragments of mudela in your source file, and includes the results into
 685 document that can be processed with LaTeX.  The result is a text
 686 document with formatted music integrated.
 687
 688 Lilypond will by default create all output files in directory @file{out}.
 689 The file to give to latex has ext @file{.latex}.
 690
 691 @strong{About the input}
 692
 693 If the file contains the ``block''
 694
 695 @example
 696
 697         \begin@{mudela@}
 698         CONTENTS
 699         \end@{mudela@}
 700
 701 @end example
 702
 703 then LilyPond is run on CONTENTS.  mudela-book puts the result back,
 704 surrounded by @code{\preMudelaExample} and @code{\postMudelaExample}
 705 commands. @code{\preMudelaExample} and @code{posMudelaExample} is
 706 defined to nothing by default, and the user can redefine them
 707 to whatever he wants.
 708
 709 @code{\begin} takes the following options:
 710
 711 @table @samp
 712 @item eps
 713     the music is created as eps graphics that can be inserted in
 714     the middle of a text line, not only as a separate paragraph
 715 @item verbatim
 716     CONTENTS is copied into the TeX source enclosed in a verbatim block.
 717 @item 11pt, 13pt, 16pt, 20pt, 26pt
 718     set the fontsize to use for the music
 719 @item singleline
 720   linewidth = -1.
 721 @item multiline
 722   linewidth = textwidth
 723 @item fragment
 724 @item nonfragment
 725     Override mudela-book autodetection of what type of code is in the
 726     mudela block, voice contents or complete code.
 727 @end table
 728
 729 @node mudela-book OPTIONS, mudela-book FILES, mudela-book DESCRIPTION, mudela-book
 730 @section OPTIONS
 731
 732 @table @samp
 733
 734 @item --default-mudela-fontsize=??pt
 735     Set the fontsize to use for mudela if no fontsize is given
 736     as option.
 737 @item --force-mudela-fontsize=??pt
 738     Force all mudela to use this fontsize, overriding options
 739     given to \begin@{mudela@}
 740 @item --outname=FILE
 741     The name of LaTeX file to output. If this option  is not given,
 742 the output name derived from the input name.
 743 @item --out-www=DIRECTORY
 744     The name of the directory to output lilypond output and input to.
 745     This must be a name; the subdirectory will be created in the cwd. [FIXME]
 746 @item --help
 747         Print a short help message
 748 @item --dependencies
 749         Write dependencies to out-www/filename.dep
 750 @item --force-verbatim
 751         Make all mudela verbatim.
 752 @item --initfile=FILE
 753         read command definitions from @file{FILE}
 754 @end table
 755
 756 @node mudela-book FILES, mudela-book BUGS, mudela-book OPTIONS, mudela-book
 757 @section FILES
 758   See @file{Documentation/tex/out/mudela-book-doc.dvi} for more info.
 759   You have to install LaTeX.
 760   @file{mudela-book} is written in  python 1.5, so you have to install
 761   @uref{http://www.python.org,python}.
 762
 763 @node mudela-book BUGS, mudela-book Authors, mudela-book FILES, mudela-book
 764 @section BUGS
 765
 766 The LaTeX \includeonly@{...@} command is ignored.
 767
 768 You get trouble if you use the --force-verbatim option and have some
 769 music in \footnote@{...@} or \marginpar@{...@}.
 770
 771 Ignores almost all LaTeX commands that changes margins and linewidths.
 772
 773 @node mudela-book Authors, Top, mudela-book BUGS, mudela-book
 774 @section Authors
 775
 776 @email{hanwen@@cs.uu.nl, Han-Wen Nienhuys}, @uref{http://www.cs.uu.nl/people/hanwen}
 777
 778 @email{tomato@@xoommail.com, Tom Cato Amundsen}
 779
 780
 781 @bye