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 [options] inputfile[.ly] [....]
  19 @end example
  20
  21 @unnumberedsec Options
  22
  23 @table @code
  24 @item -s,--set=@var{KEY}=@var{VAL}
  25     Add @var{key}= @var{val} to the settings, overriding those specified
  26 in the files. Possible keys: language, latexheaders, latexpackages,
  27 papersizename, pagenumber, linewidth, orientation, textheight.
  28
  29 @item -k,--keep
  30     Keep the temporary directory including LilyPond and ly2dvi output
  31 files. The temporary directory is created in the current directory as @code{ly2dvi.dir}.
  32 @item -P,--postscript
  33     Generate  PostScript in stead of DVI.
  34 @item --no-lily
  35     Do not run LilyPond; useful for debugging ly2dvi.
  36 @item -h,--help
  37     Print help.
  38 @item -I,--include
  39     Add to the lilypond include path.
  40 @item -d,--dependencies
  41     Make a dependency file for the output.
  42 @item --outdir=@var{dir}
  43     Generate output (including MIDI files) in @var{dir}
  44
  45 @end table
  46
  47 @subsection Titling layout
  48
  49 Ly2dvi extracts the following header fields from the .ly files to
  50 generate titling:
  51
  52 @table @code
  53 @item title
  54     The title of the music. Centered on top of the first page.
  55 @item subtitle
  56     Subtitle, centered below the title.
  57 @item poet
  58     Name of the poet, leftflushed below the below subtitle.
  59 @item composer
  60     Name of the composer, rightflushed below the subtitle.
  61 @item metre
  62     Meter string, leftflushed below the below poet.
  63 @item opus
  64     Name of the opus, rightflushed below the below composer.
  65 @item arranger
  66     Name of the arranger, rightflushed below the opus.
  67 @item instrument
  68     Name of the instrument, centered below the arranger
  69 @item piece
  70     Name of the piece, leftflushed below the instrument
  71 @end table
  72
  73
  74 @subsection Additional parameters
  75
  76 Ly2dvi responds to several parameters specified in the LilyPond
  77 file. They can be overridden by supplying the @code{--set} command line
  78 option.
  79
  80 @table @code
  81 @item language
  82     Specify La@TeX{} language: the @code{babel} package will be
  83 included.  Default: unset.
  84
  85         Read from the @code{\header} block.
  86
  87 @item latexheaders
  88     Specify additional La@TeX{} headers file.
  89
  90         Normally read from the @code{\header} block. Default value: empty
  91
  92 @item latexheaders
  93     Specify additional La@TeX{} packages file. This works cumulative,
  94 so you can add multiple packages using multiple @code{-s=latexpackages} options.
  95        Normally read from the @code{\header} block. Default value:
  96 @code{geometry}.
  97
  98 @item orientation
  99     Set orientation. Choices are @code{portrait} or @code{landscape}. Is
 100 read from the @code{\paper} block, if set.
 101
 102 @item linewidth
 103    Is read from the @code{\paper} block.
 104
 105 @item papersizename
 106    Specify name of papersize. Is read from the @code{\paper} block.
 107 @end table
 108
 109 @subsection  Bugs
 110
 111 Assumes that settings for LilyPond are correct. Assumes that @code{cp}
 112 and @code{rm} are in the path.
 113
 114 If find something that you consider a bug, please send a bugreport (See
 115 @ref{Bug reports}) to @email{bug-gnu-music@@gnu.org}.
 116
 117 @subsection  Authors
 118
 119 @email{hanwen@@cs.uu.nl,Han-Wen Nienhuys}.
 120
 121 Earlier incarnations of ly2dvi were written by
 122 @email{daboys@@austin.rr.com, Jeffrey B. Reed} (Python version), and
 123 @email{Jan.A.Fagertun@@energy.sintef.no, Jan Arne Fagertun} (Bourne
 124 shell version)
 125