1 \input texinfo @c -*-texinfo-*-
2 @setfilename programs.info
5 @node Top, , midi2ly Authors, (dir)
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-
18 @node Programs, convert-mudela, , Top
28 @node convert-mudela, convert-mudela DESCRIPTION, Programs, Top
30 * convert-mudela DESCRIPTION:: convert-mudela DESCRIPTION
31 * convert-mudela SYNOPSIS:: convert-mudela SYNOPSIS
32 * convert-mudela OPTIONS:: convert-mudela OPTIONS
33 * convert-mudela BUGS:: convert-mudela BUGS
34 * convert-mudela Authors:: convert-mudela Authors
36 @chapter convert-mudela
38 convert-mudela sequentially applies different mudela-conversions to
39 upgrade a Mudela input file.
41 @node convert-mudela DESCRIPTION, convert-mudela SYNOPSIS, convert-mudela, convert-mudela
44 Upgrade a Mudela input file from FROM_PATCHLEVEL to TO_PATCHLEVEL.
45 If no files are given, the standard input and output are used.
47 @node convert-mudela SYNOPSIS, convert-mudela OPTIONS, convert-mudela DESCRIPTION, convert-mudela
50 convert-mudela [options] [files]
52 @node convert-mudela OPTIONS, convert-mudela BUGS, convert-mudela SYNOPSIS, convert-mudela
56 The output file to write.
58 Do an inline edit of the input file. override @code{--output}
60 shows all known conversions, and exit
61 @item --from=FROM_PATCHLEVEL
62 Set the level to convert from. If this is not set, convert-mudela will
63 guess this, on the basis of @code{\version} strings in the file
64 @item --to=TO_PATCHLEVEL
65 Set the goal version of the conversion. It defaults to the latest
69 @node convert-mudela BUGS, convert-mudela Authors, convert-mudela OPTIONS, convert-mudela
72 Not all language changes are handled. Multiple output options won't
75 convert-mudela is written in python, so you have install
76 @uref{http://www.python.org,python}.
78 @node convert-mudela Authors, LilyPond, convert-mudela BUGS, convert-mudela
81 @email{hanwen@@cs.uu.nl, Han-Wen Nienhuys}, @uref{http://www.cs.uu.nl/people/hanwen}
90 @node LilyPond, LilyPond SYNOPSIS, convert-mudela Authors, Top
92 * LilyPond SYNOPSIS:: LilyPond SYNOPSIS
93 * LilyPond DESCRIPTION:: LilyPond DESCRIPTION
94 * LilyPond OPTIONS:: LilyPond OPTIONS
95 * LilyPond FEATURES:: LilyPond FEATURES
96 * LilyPond DISCLAIMER:: LilyPond DISCLAIMER
97 * LilyPond PROBLEMS:: LilyPond PROBLEMS
98 * LilyPond FILES:: LilyPond FILES
99 * LilyPond environment:: LilyPond environment
100 * LilyPond BUGS:: LilyPond BUGS
101 * LilyPond SEE ALSO:: LilyPond SEE ALSO
102 * LilyPond REMARKS:: LilyPond REMARKS
103 * LilyPond Authors:: LilyPond Authors
109 @node LilyPond SYNOPSIS, LilyPond DESCRIPTION, LilyPond, LilyPond
111 @strong{lilypond} [OPTION]... [MUDELA-FILE]...
113 @node LilyPond DESCRIPTION, LilyPond OPTIONS, LilyPond SYNOPSIS, LilyPond
116 LilyPond is a music typesetter. It produces beautiful sheet music
117 using a high level description file as input. LilyPond is part of
121 @node LilyPond OPTIONS, LilyPond FEATURES, LilyPond DESCRIPTION, LilyPond
125 Output format for sheet music. Choices are tex (for TeX
126 output), ps (for PostScript) and scm (for GUILE)
128 add @file{FILE} to the search path for input files.
130 Disable TeX output. If you have a \midi definition, it will do the
132 @item -M,--dependencies
133 Also output rules to be included in Makefile.
135 Turn debugging info on. GNU LilyPond reads the file @file{.dstreamrc},
136 which lists what functions and classes may produce copious debugging
139 Disallow untrusted @code{\include} directives, backslashes in TeX
140 code and named output.
142 Switch on any experimental features. Not for general public use.
144 Show the warranty with which GNU LilyPond comes. (It comes with
145 @strong{NO WARRANTY}!)
146 @item -o,--output=FILE
147 Set the default output file to @file{FILE}.
149 Show a summary of usage.
151 Set init file to @file{FILE} (default: @file{init.ly}).
152 @item --include, -I=DIRECTORY
153 Add @file{DIRECTORY} to the search path for input files.
154 @item --ignore-version, -V
155 Make the incompatible mudela version warning non-fatal.
158 @node LilyPond FEATURES, LilyPond DISCLAIMER, LilyPond OPTIONS, LilyPond
161 This is an overview of the features that GNU LilyPond supports. For
162 details on how to use them, you should consult the Mudela tutorial,
163 which is included with the package.
166 @item ASCII script input, with identifiers (for music reuse),
167 customizable notenames, customisable fontset.
168 @item MIDI output lets you check if you have entered the correct notes.
169 @item MIDI to Mudela conversion through the mi2mu program.
170 @item Multiple staffs in one score. Each staff can have different time signatures.
171 @item Beams, slurs, ties, chords, super/subscripts (accents and text)
172 triplets, general n-plet (triplet, quadruplets, etc.), lyrics,
173 transposition, dynamics (both absolute and hairpin style).
174 @item Multiple voices within one staff; beams optionally shared
175 between voices. Up to four voices is handled cleanly.
176 @item Multiple scores within one input file. Each score is output to
178 @item Clef changes, meter changes, cadenza-mode, key changes, repeat bars.
181 @node LilyPond DISCLAIMER, LilyPond PROBLEMS, LilyPond FEATURES, LilyPond
184 GNU LilyPond is copyright 1996-1999 by its authors. GNU LilyPond is
185 distributed under the terms of the GNU General Public License. GNU LilyPond
186 is provided without any warranty what so ever.
187 GNU LilyPond may be freely distributed. For further information consult
188 the GNU General Public License, from the file @file{COPYING}.
190 @node LilyPond PROBLEMS, LilyPond FILES, LilyPond DISCLAIMER, LilyPond
193 There is an extensive list of todoes and bugs. See the file
194 @file{TODO} distributed with the sources. If you have a problem you
195 should try to find out
198 @item If the bug has been fixed in a newer release.
199 @item If the bug has been found earlier, consult @file{TODO} and @file{BUGS}.
202 If you have found a bug, then we would appreciate it if you sent a
206 @item Send a copy of the input which causes the error.
207 @item Send a description of the platform you use.
208 @item Send a description of the LilyPond version you use
209 (with compile/configure options please).
210 @item Send a description of the bug itself.
211 @item Send it to @email{bug-gnu-music@@gnu.org}; you don't have to be subscribed
215 @node LilyPond FILES, LilyPond environment, LilyPond PROBLEMS, LilyPond
219 The initialisation file with symbol tables etc. It
220 includes files from the directory
221 @file{PREFIX/share/lilypond/ly/}. (@file{PREFIX} typically is @file{/usr/local}
224 @node LilyPond environment, LilyPond BUGS, LilyPond FILES, LilyPond
229 additional directories for finding lilypond data. The
230 format is like the format of @file{PATH}.
234 selects the language for the warning messages of LilyPond.
237 @node LilyPond BUGS, LilyPond SEE ALSO, LilyPond environment, LilyPond
240 Lots of them. See @file{TODO} and @file{BUGS}
242 @node LilyPond SEE ALSO, LilyPond REMARKS, LilyPond BUGS, LilyPond
245 LilyPond comes with various other documentation files. They are
246 included in the source package.
248 A further source for information is the website, which can be found at
249 @uref{http://www.lilypond.org/}. The website contains on-line versions
252 GNU LilyPond is updated very frequently, the latest version is always
253 available at: @uref{ftp://ftp.cs.uu.nl/pub/GNU/LilyPond}. This FTP
254 site is mirrored at a number of sites; consult the project web pages
255 for information about mirrors.
257 For programs which are part of the GNU music project, the following
258 mailing list have been setup:
261 @item @email{info-gnu-music@@gnu.org}
262 For information on the GNU Music project, to subscribe: send mail with
263 subject "subscribe" to @email{info-gnu-music-request@@gnu.org}
264 @item @email{help-gnu-music@@gnu.org}
265 For help with programs from the GNU music project. To subscribe: send
266 mail with subject "subscribe" to @email{help-gnu-music-request@@gnu.org}
267 @item @email{bug-gnu-music@@gnu.org}
268 If you have bugreports, you should send them to this list. If you want
269 to read all bugreports, you should subscribe to this list. To
270 subscribe: send mail with subject "subscribe" to
271 @email{bug-gnu-music-request@@gnu.org}
272 @item @email{gnu-music-discuss@@gnu.org}
273 For discussions concerning the GNU Music project, to subscribe: send
274 mail with subject "subscribe" to
275 @email{gnu-music-discuss-request@@gnu.org}
278 Announces of new versions will be sent to info-gnu-music and
281 @node LilyPond REMARKS, LilyPond Authors, LilyPond SEE ALSO, LilyPond
284 GNU LilyPond has no connection with the music package Rosegarden, other
285 than the names being similar :-)
287 @node LilyPond Authors, Ly2dvi, LilyPond REMARKS, LilyPond
293 @item @email{hanwen@@cs.uu.nl, Han-Wen Nienhuys}
294 @uref{http://www.cs.uu.nl/people/hanwen}
295 @item @email{janneke@@gnu.org, Jan Nieuwenhuizen}
296 @uref{http://www.xs4all.nl/~jantien}
299 Please consult the documentation file @file{AUTHORS} for more detailed
300 information, and small contributions.
305 @node Ly2dvi, Ly2dvi DESCRIPTION, LilyPond Authors, Top
307 * Ly2dvi DESCRIPTION:: Ly2dvi DESCRIPTION
308 * Ly2dvi SYNOPSIS:: Ly2dvi SYNOPSIS
309 * Ly2dvi OPTIONS:: Ly2dvi OPTIONS
310 * Ly2dvi Features:: Ly2dvi Features
311 * Ly2dvi Environment:: Ly2dvi Environment
312 * Ly2dvi Files:: Ly2dvi Files
313 * Ly2dvi Initialization Sequence::Ly2dvi Initialization Sequence
314 * Ly2dvi See Also:: Ly2dvi See Also
315 * Ly2dvi Bugs:: Ly2dvi Bugs
316 * Ly2dvi Remarks:: Ly2dvi Remarks
317 * Ly2dvi Authors:: Ly2dvi Authors
321 @node Ly2dvi DESCRIPTION, Ly2dvi SYNOPSIS, Ly2dvi, Ly2dvi
323 ly2dvi is a Python script which creates input file for LaTeX,
324 based on information from the output files from LilyPond.
325 The script handles multiple files. If a mudela file name is
326 specified LilyPond is run to make an output (TeX) file.
328 One or more LaTeX files are created, based on information found
329 in the output (TeX) files, and latex is finally run to create
330 one or more DVI files.
332 The majority of this utility came from a bourne script written by Jan
333 Arne Fagertun name @file{ly2dvi}.
335 @node Ly2dvi SYNOPSIS, Ly2dvi OPTIONS, Ly2dvi DESCRIPTION, Ly2dvi
338 ly2dvi [options] inputfile[.ly] [....]
340 @node Ly2dvi OPTIONS, Ly2dvi Features, Ly2dvi SYNOPSIS, Ly2dvi
345 Set debug mode. There are two levels - in level one some debug
346 info is written, in level two the command @strong{set -x} is run, which
347 echoes every command in the ly2dvi script.
349 Name of additional LaTeX headers file. This is included in the
350 tex file at the end of the headers, last line before @code{\begin@{document@}}
352 Set paper heigth (points). Used together with width and LaTeX name of
353 papersize in case of papersize unknown to ly2dvi.
354 @item -K,--keeplilypond
355 Keep LilyPond output after the run.
357 Set landscape orientation - portrait is the default.
358 (@strong{-L} produces @code{\usepackage[landscape]@{article@}})
360 Switch off page numbering.
361 @item -O,--orientation=
362 Set orientation landscape - obsolete, use @strong{-L} instead.
363 @item -P,--postscript
364 In addition to the DVI file, also Generate a postsript file.
366 Set paper width (points). Used together with heigth and LaTeX name of
367 papersize in case of papersize unknown to ly2dvi.
368 @item -d,--dependencies
369 Tell lilypond to make dependencies file.
372 @item -k,--keeply2dvi
373 Keep the LaTeX file after the run.
375 Specify LaTeX language.
376 (@strong{-l norsk} produces @code{\usepackage[norsk]@{babel@}}).
378 Set output directory.
379 @item -p,--papersize=
381 (@strong{-p a4} produces @code{\usepackage[a4paper]@{article@}})
383 Normally all output files are included into one LaTeX file.
384 With this switch all files are run separately, to produce one
388 @node Ly2dvi Features, Ly2dvi Environment, Ly2dvi OPTIONS, Ly2dvi
391 ly2dvi responds to several parameters specified in the mudela
392 file. They are overridden by corresponding command line options.
396 Specify LaTeX language
397 @item latexheaders="";
398 Specify additional LaTeX headers file
399 @item orientation="";
401 @item paperlinewidth="";
402 Specify the width (pt, mm or cm) of the printed lines.
404 Specify name of papersize.
407 @node Ly2dvi Environment, Ly2dvi Files, Ly2dvi Features, Ly2dvi
412 Sets the root directory of the LilyPond installation
414 Additional directories for input files.
416 Temporary directory name. Default is /tmp
419 @node Ly2dvi Files, Ly2dvi Initialization Sequence, Ly2dvi Environment, Ly2dvi
422 @file{titledefs.tex} is inspected for definitions used to extract
423 additional text definitions from the mudela file. In the current
424 version the following are defined:
428 The title of the music. Centered on top of the first page.
430 Subtitle, centered below the title.
432 Name of the poet, leftflushed below the below subtitle.
434 Name of the composer, rightflushed below the subtitle.
436 Meter string, leftflushed below the below poet.
438 Name of the opus, rightflushed below the below composer.
440 Name of the arranger, rightflushed below the opus.
442 Name of the instrument, centered below the arranger
444 Name of the piece, leftflushed below the instrument
447 @file{$LILYPONDPREFIX/share/.lilyrc $HOME/.lilyrc ./.lilyrc} are files
448 to set up default running conditions. On Windows OS initialization
449 files are named @file{_lilyrc}. The file syntax is as follows:
456 Where @strong{VARIABLE-NAME} is the name of the variable documented below
457 and @strong{VALUE} is either a string, a 1, or a 0. All files are parsed,
458 in the shown sequence. In the current version the following are
463 This turns off (default) or on the debug capabilities. Possible
464 values are 0 (off) and 1 (on).
465 @item DEPENDENCIES=value
466 This turns off (default) or on the ability to generate a Makefile
467 dependency list. Possible values are 0 (off) and 1 (on).
468 @item KEEPLILYPOND=value
469 This turns off (default) or on the ability to keep the log file
470 associated with the LilyPond job. Possible values are 0 (off) and 1
472 @item KEEPLY2DVI=value
473 This turns off (default) or on the ability to keep the temporary files
474 that are generated by the ly2dvi job. Possible values are 0 (off) and
477 Specify LaTeX language. Possible value is a valid LaTeX language.
479 Specify additional LaTeX headers file. Possible value is a file
481 @item LILYINCLUDE=value
482 Additional directories for input files. Possible value is a delimited
484 @item LILYPONDPREFIX=value
485 This defines the LilyPond root directory. Possible value is a valid
486 directory specification to the LilyPond distribution location.
488 This turns off (default) or on the page numbering capability.
489 Possible values are 0 (page numbering enabled) and 1 (page numbering
491 @item ORIENTATION=value
492 This sets the image orientation. Possible values are
493 portrait (default) and landscape.
494 @item OUTPUTDIR=value
495 This defines the directory where the resultant files will be
496 generated. Possible value is a valid directory specification.
497 Default is the current working directory.
498 @item PAPERSIZE=value
499 This defines the papersize the image will be sized to fit. Possible
500 values are a0, a1, a2, a3, a4 (default), a5, a6, a7, a8, a9, a10, b0,
501 b1, b2, b3, b4, b5, archA, archB, archC, archD, archE, flsa, flse,
502 halfletter, ledger, legal, letter, or note.
504 Specify paperheight (points - an inch is 72.27, a cm is 28.453 points).
505 @item POSTSCRIPT=value
506 This turns off (default) or on the capability of additionally
507 generating a postscript file. Possible values are 0 (off) and 1 (on).
509 Specify paperwidth (points - an inch is 72.27, a cm is 28.453 points).
511 This turns off (default) or on the capability of generating multiple
512 dvi and postscript files from multiple source files. The default is
513 to generate a concatenation of the source files. Possible values are
514 0 (single file) and 1 (separate files).
516 This defines the emporary directory. Actually this is not used at the
517 present. Possible value is a valid directory specification that is
518 writable to the user.
521 @node Ly2dvi Initialization Sequence, Ly2dvi See Also, Ly2dvi Files, Ly2dvi
522 @section Initialization Sequence
523 The initialization process reads inputs for several sources. Below is
524 a list of priorities for lowest to hightest proirity.
527 @item Program's defaults
528 @item Values found in LilyPond output file
529 @item Environment variables
530 @item $LILYPONDPREFIX/share/lilypond/.lilyrc
533 @item command line options
536 Note that this differs slightly from the original bourne shell
539 @node Ly2dvi See Also, Ly2dvi Bugs, Ly2dvi Initialization Sequence, Ly2dvi
542 lilypond(1), tex(1), latex(1)
544 @node Ly2dvi Bugs, Ly2dvi Remarks, Ly2dvi See Also, Ly2dvi
547 If you have found a bug, you should send a bugreport.
550 @item Send a copy of the input which causes the error.
551 @item Send a description of the platform you use.
552 @item Send a description of the LilyPond and ly2dvi version you use.
553 @item Send a description of the bug itself.
554 @item Send it to @email{bug-gnu-music@@gnu.org} (you don't have to subscribe
555 to this mailinglist).
558 @node Ly2dvi Remarks, Ly2dvi Authors, Ly2dvi Bugs, Ly2dvi
561 Many papersizes are now supported. Information on other sizes
562 (LaTeX names, horizontal and vertical sizes) should be mailed to
563 the author or to the mailing list.
565 Supported papersizes are:
567 a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, archA, archB, archC, archD,
568 archE, b0, b1, b2, b3, b4, b5, flsa, flse, halfletter, ledger, legal,
571 @node Ly2dvi Authors, midi2ly, Ly2dvi Remarks, Ly2dvi
573 Python Version author:
574 @email{daboys@@austin.rr.com, Jeffrey B. Reed},
575 @uref{http://home.austin.rr.com/jbr/jeff/lilypond/}
577 Original bourne shell version author:
578 @email{Jan.A.Fagertun@@energy.sintef.no, Jan Arne Fagertun},
579 @uref{http://www.termo.unit.no/mtf/people/janaf/}
587 @node midi2ly, midi2ly DESCRIPTION, Ly2dvi Authors, Top
589 * midi2ly DESCRIPTION:: midi2ly DESCRIPTION
590 * midi2ly OPTIONS:: midi2ly OPTIONS
591 * midi2ly DISCLAIMER:: midi2ly DISCLAIMER
592 * midi2ly SEE ALSO:: midi2ly SEE ALSO
593 * midi2ly Authors:: midi2ly Authors
597 @node midi2ly DESCRIPTION, midi2ly OPTIONS, midi2ly, midi2ly
599 midi2ly translates a MIDI input file to Mudela (GNU LilyPond source
600 format). midi2ly is part of the GNU LilyPond music typesetting package.
602 midi2ly [options] midi-file
604 @node midi2ly OPTIONS, midi2ly DISCLAIMER, midi2ly DESCRIPTION, midi2ly
608 @item -b, --no-quantify,
609 Write exact durations, e.g.: `a4*385/384'.
611 Print lots of debugging stuff.
613 Show a summary of usage.
614 @item -I, --include=@file{DIR},
615 Add DIR to search path.
616 @item -k, --key=ACC[:MINOR],
617 Set default key. ACC > 0 sets number of sharps; ACC < 0 sets number
618 of flats. A minor key is indicated by ":1".
619 @item -n, --no-silly,
620 Assume no plets or double dots, assume smallest (reciprocal) duration 16.
621 @item -o, --output=@file{FILE},
622 Set @file{FILE} as default output.
623 @item -p, --no-plets,
627 @item -s, --smallest=N,
628 Assume no shorter (reciprocal) durations than N.
631 @item -w, --warranty,
632 Show the warranty with which midi2ly comes. (It comes with @strong{NO WARRANTY}!)
633 @item -x, --no-double-dots,
634 Assume no double dotted notes.
637 @node midi2ly DISCLAIMER, midi2ly SEE ALSO, midi2ly OPTIONS, midi2ly
640 midi2ly is copyright 1996, 1997 by its authors. midi2ly is distributed
641 as part of GNU LilyPond, under the terms of the GNU General Public
642 License. midi2ly is provided without any warranty what so ever.
643 midi2ly may be freely distributed. For further information consult
644 the GNU General Public License, from the file @file{COPYING}.
646 @node midi2ly SEE ALSO, midi2ly Authors, midi2ly DISCLAIMER, midi2ly
650 @item @strong{lilypond}(1)
651 The GNU LilyPond music typesetter.
654 @node midi2ly Authors, Top, midi2ly SEE ALSO, midi2ly
657 Please consult the documentation file @file{AUTHORS} for more detailed
658 information, and small contributions.
660 @email{janneke@@gnu.org, Jan Nieuwenhuizen}, @uref{http://www.xs4all.nl/~jantien}