|
|
Node:ly2dvi,
Next:convert-ly,
Previous:Bug reports,
Up:Top
ly2dvi
ly2dvi is a Python script that creates a nicely titled output file
from an input file for LaTeX. It can create a DVI or PS file. It
works by running LilyPond on the input files, creating a LaTeX
wrapper around the output, and running LaTeX (and optionally
dvips).
Invoking ly2dvi
ly2dvi [OPTION]... FILE...
Options
-k,--keep
- Keep the temporary directory including LilyPond and ly2dvi output
files. The temporary directory is created in the current directory as
ly2dvi.dir.
-d,--dependencies
- Write makefile dependencies for every input file.
-h,--help
- Print usage help.
-I,--include=DIR
- Add DIR to LilyPond's include path.
-m,--no-paper
- Produce MIDI output only.
--no-lily
- Do not run LilyPond; useful for debugging ly2dvi.
-o,--output=FILE
- Generate output to FILE. The extension of FILE is ignored.
-P,--postscript
- Also generate PostScript output, using dvips.
-s,--set=KEY=VAL
- Add KEY= VAL to the settings, overriding those specified
in the files. Possible keys:
language, latexheaders,
latexpackages, latexoptions, papersize,
pagenumber, linewidth, orientation,
textheight.
-v,--version
- Show version information
-V,--verbose
- Be verbose
-w,--warranty
- Show the warranty with which GNU LilyPond comes. (It comes with
NO WARRANTY!)
Titling layout
Ly2dvi extracts the following header fields from the LY files to
generate titling:
title
- The title of the music. Centered on top of the first page.
subtitle
- Subtitle, centered below the title.
poet
- Name of the poet, left flushed below the subtitle.
composer
- Name of the composer, right flushed below the subtitle.
meter
- Meter string, left flushed below the poet.
opus
- Name of the opus, right flushed below the composer.
arranger
- Name of the arranger, right flushed below the opus.
instrument
- Name of the instrument, centered below the arranger
piece
- Name of the piece, left flushed below the instrument
head
- A text to print in the header of all pages. It is not called
header, because \header is a reserved word in LilyPond.
copyright
- A text to print in the footer of the first page. Default is to
print the standard footer also on the first page.
footer
- A text to print in the footer of all but the last page.
tagline
- Line to print at the bottom of last page. The default text is "Lily
was here, version-number".
Additional parameters
Ly2dvi responds to several parameters specified in a \paper
section of the LilyPond file. They can be overridden by supplying a
--set command line option.
language
- Specify LaTeX language: the
babel package will be
included. Default: unset.
Read from the \header block.
latexheaders
- Specify additional LaTeX headers file.
Normally read from the \header block. Default value: empty
latexpackages
- Specify additional LaTeX packages file. This works cumulative,
so you can add multiple packages using multiple
-s=latexpackages options.
Normally read from the \header block. Default value:
geometry.
latexoptions
- Specify additional options for the LaTeX
\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 twoside
orientation
- Set orientation. Choices are
portrait or landscape. Is
read from the \paper block, if set.
textheight
- The vertical extension of the music on the page. It is normally
calculated automatically, based on the paper size.
linewidth
- The music line width. It is normally read from the
\paper
block.
papersize
- The paper size (as a name, e.g.
a4). It is normally read from
the \paper block.
pagenumber
- If set to
no, no page numbers will be printed.
Environment variables
LANG
- selects the language for the warning messages of Ly2dvi and LilyPond.
Bugs
Cannot generate TeX or PostScript only. Send bugreports to to
bug-lilypond@gnu.org.
Earlier incarnations of ly2dvi were written by
Jeffrey B. Reed (Python version), and
Jan Arne Fagertun (Bourne
shell version)
|