Documentation/user/ly2dvi.itexi

   1 @c -*-texinfo-*-
   2
   3 @node ly2dvi
   4 @chapter ly2dvi
   5
   6 @file{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.
  10
  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.
  14
  15 @subsection Invoking ly2dvi
  16
  17 @example
  18 ly2dvi [OPTION]... [FILE]...
  19 @end example
  20
  21 @unnumberedsec Options
  22
  23 @table @code
  24 @item -k,--keep
  25     Keep the temporary directory including LilyPond and ly2dvi output
  26 files. The temporary directory is created in the current directory as @code{ly2dvi.dir}.
  27 @item -d,--dependencies
  28     Write makefile dependencies for every input file.
  29 @item -h,--help
  30     Print help.
  31 @item -I,--include=@var{DIR}
  32     Add @var{DIR} to LilyPond's include path.
  33 @item -m,--no-paper
  34     Produce MIDI output only.
  35 @item --no-lily
  36     Do not run LilyPond; useful for debugging ly2dvi.
  37 @item -o,--output=@var{FILE}
  38     Generate output to @var{FILE}.  The extension of @var{FILE} is ignored.
  39 @item -P,--postscript
  40     Also generate PostScript output.
  41 @item -s,--set=@var{KEY}=@var{VAL}
  42     Add @var{key}= @var{val} to the settings, overriding those specified
  43 in the files. Possible keys: language, latexheaders, latexpackages, latexoptions,
  44 papersize, pagenumber, linewidth, orientation, textheight.
  45 @item -v,--version
  46 Show version information
  47 @item -V,--verbose
  48 Be verbose
  49 @item -w,--warranty
  50 Show the warranty with which GNU LilyPond comes. (It comes with
  51 @strong{NO WARRANTY}!)
  52 @end table
  53
  54 @subsection Titling layout
  55
  56 Ly2dvi extracts the following header fields from the .ly files to
  57 generate titling:
  58
  59 @table @code
  60 @item title
  61     The title of the music. Centered on top of the first page.
  62 @item subtitle
  63     Subtitle, centered below the title.
  64 @item poet
  65     Name of the poet, leftflushed below the below subtitle.
  66 @item composer
  67     Name of the composer, rightflushed below the subtitle.
  68 @item metre
  69     Meter string, leftflushed below the below poet.
  70 @item opus
  71     Name of the opus, rightflushed below the below composer.
  72 @item arranger
  73     Name of the arranger, rightflushed below the opus.
  74 @item instrument
  75     Name of the instrument, centered below the arranger
  76 @item piece
  77     Name of the piece, leftflushed below the instrument
  78 @item tagline
  79     Line to print at the bottom of last page.  Default: ``Lily was here,
  80 @var{version-number}''.
  81 @end table
  82
  83
  84 @subsection Additional parameters
  85
  86 Ly2dvi responds to several parameters specified in the LilyPond
  87 file. They can be overridden by supplying the @code{--set} command line
  88 option.
  89
  90 @table @code
  91 @item language
  92     Specify La@TeX{} language: the @code{babel} package will be
  93 included.  Default: unset.
  94
  95         Read from the @code{\header} block.
  96
  97 @item latexheaders
  98     Specify additional La@TeX{} headers file.
  99
 100         Normally read from the @code{\header} block. Default value: empty
 101
 102 @item latexheaders
 103     Specify additional La@TeX{} packages file. This works cumulative,
 104 so you can add multiple packages using multiple @code{-s=latexpackages} options.
 105        Normally read from the @code{\header} block. Default value:
 106 @code{geometry}.
 107
 108 @item latexoptions
 109     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}
 110
 111 @item orientation
 112     Set orientation. Choices are @code{portrait} or @code{landscape}. Is
 113 read from the @code{\paper} block, if set.
 114
 115 @item linewidth
 116    Is read from the @code{\paper} block.
 117
 118 @item papersize
 119    Specify the papersize. Is read from the @code{\paper} block.
 120 @end table
 121
 122 @subsection Environment variables
 123
 124 @table @code
 125 @item LANG
 126 selects the language for the warning messages of Ly2dvi and LilyPond.
 127 @end table
 128
 129 @subsection  Bugs
 130
 131 Assumes that @code{cp} and @code{rm} are in the path.
 132
 133 Cannot generate @TeX{} or @code{PostScript} only.
 134
 135 If find something that you consider a bug, please send a bugreport (See
 136 @ref{Bug reports}) to @email{bug-gnu-music@@gnu.org}.
 137
 138 @subsection  Authors
 139
 140 @email{hanwen@@cs.uu.nl,Han-Wen Nienhuys}.
 141
 142 Earlier incarnations of ly2dvi were written by
 143 @email{daboys@@austin.rr.com, Jeffrey B. Reed} (Python version), and
 144 @email{Jan.A.Fagertun@@energy.sintef.no, Jan Arne Fagertun} (Bourne
 145 shell version)
 146