6 @file{ly2dvi} is a Python script that creates a nicely title output file
7 from an input file for La@TeX{}. It can create a DVI or PS file. It
8 works by running LilyPond on the input files, creating a La@TeX{}
9 wrapper around the output, and running La@TeX{} (and optionally
12 @unnumberedsubsec Invoking ly2dvi
14 @c ly2dvi needs at least one FILE, can't act as filter yet
16 ly2dvi [@var{OPTION}]@dots{} @var{FILE}@dots{}
19 @unnumberedsec Options
23 Keep the temporary directory including LilyPond and ly2dvi output
24 files. The temporary directory is created in the current directory as @code{ly2dvi.dir}.
25 @item -d,--dependencies
26 Write makefile dependencies for every input file.
29 @item -I,--include=@var{DIR}
30 Add @var{DIR} to LilyPond's include path.
32 Produce MIDI output only.
34 Do not run LilyPond; useful for debugging ly2dvi.
35 @item -o,--output=@var{FILE}
36 Generate output to @var{FILE}. The extension of @var{FILE} is ignored.
38 Also generate PostScript output.
39 @item -s,--set=@var{KEY}=@var{VAL}
40 Add @var{KEY}= @var{VAL} to the settings, overriding those specified
41 in the files. Possible keys: @code{language}, @code{latexheaders},
42 @code{latexpackages}, @code{latexoptions}, @code{papersize},
43 @code{pagenumber}, @code{linewidth}, @code{orientation},
46 Show version information
50 Show the warranty with which GNU LilyPond comes. (It comes with
51 @strong{NO WARRANTY}!)
54 @unnumberedsubsec Titling layout
56 Ly2dvi extracts the following header fields from the LY files to
61 The title of the music. Centered on top of the first page.
63 Subtitle, centered below the title.
65 Name of the poet, left flushed below the below subtitle.
67 Name of the composer, right flushed below the subtitle.
69 Meter string, left flushed below the below poet.
71 Name of the opus, right flushed below the below composer.
73 Name of the arranger, right flushed below the opus.
75 Name of the instrument, centered below the arranger
77 Name of the piece, left flushed below the instrument
79 A text to print in the header of all pages. It is not called
80 @code{header}, because @code{\header} is a reserved word in LilyPond.
82 A text to print in the footer of all pages
84 Line to print at the bottom of last page. The default text is ``Lily
85 was here, @var{version-number}''.
96 @unnumberedsubsec Additional parameters
98 Ly2dvi responds to several parameters specified in the LilyPond
99 file. They can be overridden by supplying a @code{--set} command line
104 Specify La@TeX{} language: the @code{babel} package will be
105 included. Default: unset.
107 Read from the @code{\header} block.
110 Specify additional La@TeX{} headers file.
112 Normally read from the @code{\header} block. Default value: empty
115 Specify additional La@TeX{} packages file. This works cumulative,
116 so you can add multiple packages using multiple @code{-s=latexpackages} options.
117 Normally read from the @code{\header} block. Default value:
121 Specify additional options for the La@TeX{} @code{\documentclass}. You can put any valid value here. This was designed to allow ly2dvi to produce output for double-sided paper, with balanced margins and pagenumbers on alternating sides. To achieve this specify @code{twoside}
124 Set orientation. Choices are @code{portrait} or @code{landscape}. Is
125 read from the @code{\paper} block, if set.
128 The music line width. It is normally read from the @code{\paper}
132 The paper size (as a name, e.g. @code{a4}). It is normally read from
133 the @code{\paper} block.
136 @unnumberedsubsec Environment variables
140 selects the language for the warning messages of Ly2dvi and LilyPond.
143 @unnumberedsubsec Bugs
145 Cannot generate @TeX{} or @code{PostScript} only. Send bugreports to to
146 @email{bug-gnu-music@@gnu.org}.
148 @unnumberedsubsec Authors
150 @email{hanwen@@cs.uu.nl,Han-Wen Nienhuys}.
152 Earlier incarnations of ly2dvi were written by
153 @email{daboys@@austin.rr.com, Jeffrey B. Reed} (Python version), and
154 @email{Jan.A.Fagertun@@energy.sintef.no, Jan Arne Fagertun} (Bourne