6 Ly2dvi is a Python script which creates input file for La@TeX{},
7 based on information from the output files from LilyPond.
8 The script handles multiple files. If a LilyPond file name is
9 specified LilyPond is run to make an output (@TeX{}) file.
11 One or more La@TeX{} files are created, based on information found
12 in the output (@TeX{}) files, and latex is finally run to create
13 one or more DVI files.
15 The majority of this utility came from a bourne script written by Jan
16 Arne Fagertun name @file{ly2dvi}.
18 @subsection Invoking ly2dvi
20 ly2dvi [options] inputfile[.ly] [....]
25 Set debug mode. There are two levels - in level one some debug
26 info is written, in level two the command @strong{set -x} is run, which
27 echoes every command in the ly2dvi script.
29 Name of additional La@TeX{} headers file. This is included in the
30 tex file at the end of the headers, last line before @code{\begin@{document@}}
32 Set paper heigth (points). Used together with width and La@TeX{} name of
33 papersize in case of papersize unknown to ly2dvi.
34 @item -K,--keeplilypond
35 Keep LilyPond output after the run.
37 Set landscape orientation - portrait is the default.
38 Use together with @code{dvips -t landscape} if you run dvips
41 Switch off page numbering.
42 @item -O,--orientation=
43 Set orientation landscape - obsolete, use @strong{-L} instead.
45 In addition to the DVI file, also Generate a postsript file.
47 Set paper width (points). Used together with heigth and La@TeX{} name of
48 papersize in case of papersize unknown to ly2dvi.
49 @item -d,--dependencies
50 Tell LilyPond to make dependencies file.
54 Keep the La@TeX{} file after the run.
56 Specify La@TeX{} language.
57 (@strong{-l norsk} produces @code{\usepackage[norsk]@{babel@}}).
62 (@strong{-p a4} produces @code{\usepackage[a4paper]@{article@}})
64 Normally all output files are included into one La@TeX{} file.
65 With this switch all files are run separately, to produce one
70 @subsection Ly2dvi Features
72 Ly2dvi responds to several parameters specified in the LilyPond
73 file. They are overridden by corresponding command line options.
77 Specify La@TeX{} language
78 @item latexheaders="";
79 Specify additional La@TeX{} headers file
82 @item paperlinewidth="";
83 Specify the width (pt, mm or cm) of the printed lines.
85 Specify name of papersize.
88 @subsection Ly2dvi Environment
92 Sets the root directory of the LilyPond installation
94 Additional directories for input files.
96 Temporary directory name. Default is /tmp
99 @subsection Ly2dvi Files
101 @file{titledefs.tex} is inspected for definitions used to extract
102 additional text definitions from the LilyPond file. In the current
103 version the following are defined:
107 The title of the music. Centered on top of the first page.
109 Subtitle, centered below the title.
111 Name of the poet, leftflushed below the below subtitle.
113 Name of the composer, rightflushed below the subtitle.
115 Meter string, leftflushed below the below poet.
117 Name of the opus, rightflushed below the below composer.
119 Name of the arranger, rightflushed below the opus.
121 Name of the instrument, centered below the arranger
123 Name of the piece, leftflushed below the instrument
126 @file{$LILYPONDPREFIX/share/.lilyrc $HOME/.lilyrc ./.lilyrc} are files
127 to set up default running conditions. On Windows OS initialization
128 files are named @file{_lilyrc}. The file syntax is as follows:
135 Where @strong{VARIABLE-NAME} is the name of the variable documented below
136 and @strong{VALUE} is either a string, a 1, or a 0. All files are parsed,
137 in the shown sequence. In the current version the following are
142 This turns off (default) or on the debug capabilities. Possible
143 values are 0 (off) and 1 (on).
144 @item DEPENDENCIES=value
145 This turns off (default) or on the ability to generate a Makefile
146 dependency list. Possible values are 0 (off) and 1 (on).
147 @item KEEPLILYPOND=value
148 This turns off (default) or on the ability to keep the log file
149 associated with the LilyPond job. Possible values are 0 (off) and 1
151 @item KEEPLY2DVI=value
152 This turns off (default) or on the ability to keep the temporary files
153 that are generated by the ly2dvi job. Possible values are 0 (off) and
156 Specify La@TeX{} language. Possible value is a valid La@TeX{} language.
158 Specify additional La@TeX{} headers file. Possible value is a file
160 @item LILYINCLUDE=value
161 Additional directories for input files. Possible value is a delimited
163 @item LILYPONDPREFIX=value
164 This defines the LilyPond root directory. Possible value is a valid
165 directory specification to the LilyPond distribution location.
167 This turns off (default) or on the page numbering capability.
168 Possible values are 0 (page numbering enabled) and 1 (page numbering
170 @item ORIENTATION=value
171 This sets the image orientation. Possible values are
172 portrait (default) and landscape.
173 @item OUTPUTDIR=value
174 This defines the directory where the resultant files will be
175 generated. Possible value is a valid directory specification.
176 Default is the current working directory.
177 @item PAPERSIZE=value
178 This defines the papersize the image will be sized to fit. Possible
179 values are a0, a1, a2, a3, a4 (default), a5, a6, a7, a8, a9, a10, b0,
180 b1, b2, b3, b4, b5, archA, archB, archC, archD, archE, flsa, flse,
181 halfletter, ledger, legal, letter, or note.
183 Specify paperheight (points - an inch is 72.27, a cm is 28.453 points).
184 @item POSTSCRIPT=value
185 This turns off (default) or on the capability of additionally
186 generating a postscript file. Possible values are 0 (off) and 1 (on).
188 Specify paperwidth (points - an inch is 72.27, a cm is 28.453 points).
190 This turns off (default) or on the capability of generating multiple
191 dvi and postscript files from multiple source files. The default is
192 to generate a concatenation of the source files. Possible values are
193 0 (single file) and 1 (separate files).
195 This defines the emporary directory. Actually this is not used at the
196 present. Possible value is a valid directory specification that is
197 writable to the user.
200 @subsection Ly2dvi Initialization Sequence
201 The initialization process reads inputs for several sources. Below is
202 a list of priorities for lowest to hightest proirity.
205 @item Program's defaults
206 @item Values found in LilyPond output file
207 @item Environment variables
208 @item $LILYPONDPREFIX/share/lilypond/.lilyrc
211 @item command line options
214 Note that this differs slightly from the original bourne shell
217 @subsection Ly2dvi Bugs
221 See @ref{Bug reports}.
222 If you have found a bug, you should send a bugreport.
225 @item Send a copy of the input which causes the error.
226 @item Send a description of the platform you use.
227 @item Send a description of the LilyPond and ly2dvi version you use.
228 @item Send a description of the bug itself.
229 @item Send it to @email{bug-gnu-music@@gnu.org} (you don't have to subscribe
230 to this mailinglist).
233 @subsection Ly2dvi Remarks
235 Many papersizes are now supported. Information on other sizes
236 (La@TeX{} names, horizontal and vertical sizes) should be mailed to
237 the author or to the mailing list.
239 Supported papersizes are:
241 a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, archA, archB, archC, archD,
242 archE, b0, b1, b2, b3, b4, b5, flsa, flse, halfletter, ledger, legal,
245 @subsection Ly2dvi Authors
246 Python Version author:
247 @email{daboys@@austin.rr.com, Jeffrey B. Reed},
248 @uref{http://home.austin.rr.com/jbr/jeff/lilypond/}
250 Original bourne shell version author:
251 @email{Jan.A.Fagertun@@energy.sintef.no, Jan Arne Fagertun},
252 @uref{http://www.termo.unit.no/mtf/people/janaf/}