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 * Ly2dvi:: Python utility to convert mudela to DVI
11 * midi2ly:: convert MIDI to -mudela-
17 @node Programs, convert-mudela, , Top
26 @node Ly2dvi, Ly2dvi DESCRIPTION, LilyPond Authors, Top
28 * Ly2dvi DESCRIPTION:: Ly2dvi DESCRIPTION
29 * Ly2dvi SYNOPSIS:: Ly2dvi SYNOPSIS
30 * Ly2dvi OPTIONS:: Ly2dvi OPTIONS
31 * Ly2dvi Features:: Ly2dvi Features
32 * Ly2dvi Environment:: Ly2dvi Environment
33 * Ly2dvi Files:: Ly2dvi Files
34 * Ly2dvi Initialization Sequence::Ly2dvi Initialization Sequence
35 * Ly2dvi See Also:: Ly2dvi See Also
36 * Ly2dvi Bugs:: Ly2dvi Bugs
37 * Ly2dvi Remarks:: Ly2dvi Remarks
38 * Ly2dvi Authors:: Ly2dvi Authors
42 @node Ly2dvi DESCRIPTION, Ly2dvi SYNOPSIS, Ly2dvi, Ly2dvi
44 ly2dvi is a Python script which creates input file for LaTeX,
45 based on information from the output files from LilyPond.
46 The script handles multiple files. If a mudela file name is
47 specified LilyPond is run to make an output (TeX) file.
49 One or more LaTeX files are created, based on information found
50 in the output (TeX) files, and latex is finally run to create
51 one or more DVI files.
53 The majority of this utility came from a bourne script written by Jan
54 Arne Fagertun name @file{ly2dvi}.
56 @node Ly2dvi SYNOPSIS, Ly2dvi OPTIONS, Ly2dvi DESCRIPTION, Ly2dvi
59 ly2dvi [options] inputfile[.ly] [....]
61 @node Ly2dvi OPTIONS, Ly2dvi Features, Ly2dvi SYNOPSIS, Ly2dvi
66 Set debug mode. There are two levels - in level one some debug
67 info is written, in level two the command @strong{set -x} is run, which
68 echoes every command in the ly2dvi script.
70 Name of additional LaTeX headers file. This is included in the
71 tex file at the end of the headers, last line before @code{\begin@{document@}}
73 Set paper heigth (points). Used together with width and LaTeX name of
74 papersize in case of papersize unknown to ly2dvi.
75 @item -K,--keeplilypond
76 Keep LilyPond output after the run.
78 Set landscape orientation - portrait is the default.
79 (@strong{-L} produces @code{\usepackage[landscape]@{article@}})
81 Switch off page numbering.
82 @item -O,--orientation=
83 Set orientation landscape - obsolete, use @strong{-L} instead.
85 In addition to the DVI file, also Generate a postsript file.
87 Set paper width (points). Used together with heigth and LaTeX name of
88 papersize in case of papersize unknown to ly2dvi.
89 @item -d,--dependencies
90 Tell lilypond to make dependencies file.
94 Keep the LaTeX file after the run.
96 Specify LaTeX language.
97 (@strong{-l norsk} produces @code{\usepackage[norsk]@{babel@}}).
100 @item -p,--papersize=
102 (@strong{-p a4} produces @code{\usepackage[a4paper]@{article@}})
104 Normally all output files are included into one LaTeX file.
105 With this switch all files are run separately, to produce one
109 @node Ly2dvi Features, Ly2dvi Environment, Ly2dvi OPTIONS, Ly2dvi
112 ly2dvi responds to several parameters specified in the mudela
113 file. They are overridden by corresponding command line options.
117 Specify LaTeX language
118 @item latexheaders="";
119 Specify additional LaTeX headers file
120 @item orientation="";
122 @item paperlinewidth="";
123 Specify the width (pt, mm or cm) of the printed lines.
125 Specify name of papersize.
128 @node Ly2dvi Environment, Ly2dvi Files, Ly2dvi Features, Ly2dvi
133 Sets the root directory of the LilyPond installation
135 Additional directories for input files.
137 Temporary directory name. Default is /tmp
140 @node Ly2dvi Files, Ly2dvi Initialization Sequence, Ly2dvi Environment, Ly2dvi
143 @file{titledefs.tex} is inspected for definitions used to extract
144 additional text definitions from the mudela file. In the current
145 version the following are defined:
149 The title of the music. Centered on top of the first page.
151 Subtitle, centered below the title.
153 Name of the poet, leftflushed below the below subtitle.
155 Name of the composer, rightflushed below the subtitle.
157 Meter string, leftflushed below the below poet.
159 Name of the opus, rightflushed below the below composer.
161 Name of the arranger, rightflushed below the opus.
163 Name of the instrument, centered below the arranger
165 Name of the piece, leftflushed below the instrument
168 @file{$LILYPONDPREFIX/share/.lilyrc $HOME/.lilyrc ./.lilyrc} are files
169 to set up default running conditions. On Windows OS initialization
170 files are named @file{_lilyrc}. The file syntax is as follows:
177 Where @strong{VARIABLE-NAME} is the name of the variable documented below
178 and @strong{VALUE} is either a string, a 1, or a 0. All files are parsed,
179 in the shown sequence. In the current version the following are
184 This turns off (default) or on the debug capabilities. Possible
185 values are 0 (off) and 1 (on).
186 @item DEPENDENCIES=value
187 This turns off (default) or on the ability to generate a Makefile
188 dependency list. Possible values are 0 (off) and 1 (on).
189 @item KEEPLILYPOND=value
190 This turns off (default) or on the ability to keep the log file
191 associated with the LilyPond job. Possible values are 0 (off) and 1
193 @item KEEPLY2DVI=value
194 This turns off (default) or on the ability to keep the temporary files
195 that are generated by the ly2dvi job. Possible values are 0 (off) and
198 Specify LaTeX language. Possible value is a valid LaTeX language.
200 Specify additional LaTeX headers file. Possible value is a file
202 @item LILYINCLUDE=value
203 Additional directories for input files. Possible value is a delimited
205 @item LILYPONDPREFIX=value
206 This defines the LilyPond root directory. Possible value is a valid
207 directory specification to the LilyPond distribution location.
209 This turns off (default) or on the page numbering capability.
210 Possible values are 0 (page numbering enabled) and 1 (page numbering
212 @item ORIENTATION=value
213 This sets the image orientation. Possible values are
214 portrait (default) and landscape.
215 @item OUTPUTDIR=value
216 This defines the directory where the resultant files will be
217 generated. Possible value is a valid directory specification.
218 Default is the current working directory.
219 @item PAPERSIZE=value
220 This defines the papersize the image will be sized to fit. Possible
221 values are a0, a1, a2, a3, a4 (default), a5, a6, a7, a8, a9, a10, b0,
222 b1, b2, b3, b4, b5, archA, archB, archC, archD, archE, flsa, flse,
223 halfletter, ledger, legal, letter, or note.
225 Specify paperheight (points - an inch is 72.27, a cm is 28.453 points).
226 @item POSTSCRIPT=value
227 This turns off (default) or on the capability of additionally
228 generating a postscript file. Possible values are 0 (off) and 1 (on).
230 Specify paperwidth (points - an inch is 72.27, a cm is 28.453 points).
232 This turns off (default) or on the capability of generating multiple
233 dvi and postscript files from multiple source files. The default is
234 to generate a concatenation of the source files. Possible values are
235 0 (single file) and 1 (separate files).
237 This defines the emporary directory. Actually this is not used at the
238 present. Possible value is a valid directory specification that is
239 writable to the user.
242 @node Ly2dvi Initialization Sequence, Ly2dvi See Also, Ly2dvi Files, Ly2dvi
243 @section Initialization Sequence
244 The initialization process reads inputs for several sources. Below is
245 a list of priorities for lowest to hightest proirity.
248 @item Program's defaults
249 @item Values found in LilyPond output file
250 @item Environment variables
251 @item $LILYPONDPREFIX/share/lilypond/.lilyrc
254 @item command line options
257 Note that this differs slightly from the original bourne shell
260 @node Ly2dvi See Also, Ly2dvi Bugs, Ly2dvi Initialization Sequence, Ly2dvi
263 lilypond(1), tex(1), latex(1)
265 @node Ly2dvi Bugs, Ly2dvi Remarks, Ly2dvi See Also, Ly2dvi
268 If you have found a bug, you should send a bugreport.
271 @item Send a copy of the input which causes the error.
272 @item Send a description of the platform you use.
273 @item Send a description of the LilyPond and ly2dvi version you use.
274 @item Send a description of the bug itself.
275 @item Send it to @email{bug-gnu-music@@gnu.org} (you don't have to subscribe
276 to this mailinglist).
279 @node Ly2dvi Remarks, Ly2dvi Authors, Ly2dvi Bugs, Ly2dvi
282 Many papersizes are now supported. Information on other sizes
283 (LaTeX names, horizontal and vertical sizes) should be mailed to
284 the author or to the mailing list.
286 Supported papersizes are:
288 a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, archA, archB, archC, archD,
289 archE, b0, b1, b2, b3, b4, b5, flsa, flse, halfletter, ledger, legal,
292 @node Ly2dvi Authors, midi2ly, Ly2dvi Remarks, Ly2dvi
294 Python Version author:
295 @email{daboys@@austin.rr.com, Jeffrey B. Reed},
296 @uref{http://home.austin.rr.com/jbr/jeff/lilypond/}
298 Original bourne shell version author:
299 @email{Jan.A.Fagertun@@energy.sintef.no, Jan Arne Fagertun},
300 @uref{http://www.termo.unit.no/mtf/people/janaf/}
308 @node midi2ly, midi2ly DESCRIPTION, Ly2dvi Authors, Top
310 * midi2ly DESCRIPTION:: midi2ly DESCRIPTION
311 * midi2ly OPTIONS:: midi2ly OPTIONS
312 * midi2ly DISCLAIMER:: midi2ly DISCLAIMER
313 * midi2ly SEE ALSO:: midi2ly SEE ALSO
314 * midi2ly Authors:: midi2ly Authors
318 @node midi2ly DESCRIPTION, midi2ly OPTIONS, midi2ly, midi2ly
320 midi2ly translates a MIDI input file to Mudela (GNU LilyPond source
321 format). midi2ly is part of the GNU LilyPond music typesetting package.
323 midi2ly [options] midi-file
325 @node midi2ly OPTIONS, midi2ly DISCLAIMER, midi2ly DESCRIPTION, midi2ly
329 @item -b, --no-quantify,
330 Write exact durations, e.g.: `a4*385/384'.
332 Print lots of debugging stuff.
334 Show a summary of usage.
335 @item -I, --include=@file{DIR},
336 Add DIR to search path.
337 @item -k, --key=ACC[:MINOR],
338 Set default key. ACC > 0 sets number of sharps; ACC < 0 sets number
339 of flats. A minor key is indicated by ":1".
340 @item -n, --no-silly,
341 Assume no plets or double dots, assume smallest (reciprocal) duration 16.
342 @item -o, --output=@file{FILE},
343 Set @file{FILE} as default output.
344 @item -p, --no-plets,
348 @item -s, --smallest=N,
349 Assume no shorter (reciprocal) durations than N.
352 @item -w, --warranty,
353 Show the warranty with which midi2ly comes. (It comes with @strong{NO WARRANTY}!)
354 @item -x, --no-double-dots,
355 Assume no double dotted notes.
358 @node midi2ly DISCLAIMER, midi2ly SEE ALSO, midi2ly OPTIONS, midi2ly
361 midi2ly is copyright 1996, 1997 by its authors. midi2ly is distributed
362 as part of GNU LilyPond, under the terms of the GNU General Public
363 License. midi2ly is provided without any warranty what so ever.
364 midi2ly may be freely distributed. For further information consult
365 the GNU General Public License, from the file @file{COPYING}.
367 @node midi2ly SEE ALSO, midi2ly Authors, midi2ly DISCLAIMER, midi2ly
371 @item @strong{lilypond}(1)
372 The GNU LilyPond music typesetter.
375 @node midi2ly Authors, Top, midi2ly SEE ALSO, midi2ly
378 Please consult the documentation file @file{AUTHORS} for more detailed
379 information, and small contributions.
381 @email{janneke@@gnu.org, Jan Nieuwenhuizen}, @uref{http://www.xs4all.nl/~jantien}