Documentation/man/ly2dvi.pod

   1 =head1 NAME
   2
   3 ly2dvi - convert mudela to DVI
   4
   5 =head1 SYNOPSIS
   6
   7         ly2dvi [options] inputfile[.ly] [....]
   8
   9 =head1 DESCRIPTION
  10
  11 ly2dvi is a shell script which creates input file for LaTeX,
  12 based on information from the output files from lilypond.
  13 The script handles multiple files. If a mudela file name is
  14 specified lilypond is run to make an output (TeX) file.
  15
  16 One or more LaTeX files are created, based on information found
  17 in the output (TeX) files, and latex is finally run to create
  18 one or more DVI files.
  19
  20 =head1 OPTIONS
  21
  22 =over 5
  23
  24 =item B<-D,--debug>
  25
  26 Set debug mode. There are two levels - in level one some debug
  27 info is written, in level two the command C<set -x> is run, which
  28 echoes every command in the ly2dvi script.
  29
  30 =item B<-F,--headers=>
  31
  32 Name of additional LaTeX headers file. This is included in the
  33 tex file at the end of the headers, last line before \begin{document}
  34
  35 =item B<-H,--Heigth=>
  36
  37 Set paper heigth (points). Used together with width and LaTeX name of
  38 papersize in case of papersize unknown to ly2dvi.
  39
  40 =item B<-F,--headers=>
  41
  42 Name of additional LaTeX headers file. This is included in the
  43 tex file at the end of the headers, last line before \begin{document}
  44
  45 =item B<-K,--keeplilypond>
  46
  47 Keep LilyPond output after the run.
  48
  49 =item B<-L,--landscape>
  50
  51 Set landscape orientation - portrait is the default.
  52 (C<-L> produces C<\usepackage[landscape]{article}>)
  53
  54 =item B<-N,--nonumber>
  55
  56 Switch off page numbering.
  57
  58 =item B<-O,--orientation=>
  59
  60 Set orientation landscape - obsolete, use C<-L> instead.
  61
  62 =item B<-W,--Width=>
  63
  64 Set paper width (points). Used together with heigth and LaTeX name of
  65 papersize in case of papersize unknown to ly2dvi.
  66
  67 =item B<-d,--dependencies>
  68
  69 Tell lilypond to make dependencies file.
  70
  71 =item B<-h,--help>
  72
  73 Print help.
  74
  75 =item B<-k,--keeply2dvi>
  76
  77 Keep the LaTeX file after the run.
  78
  79 =item B<-l,--language=>
  80
  81 Specify LaTeX language.
  82 (C<-l norsk> produces C<\usepackage[norsk]{babel}>).
  83
  84 =item B<-o,--output=>
  85
  86 Set output directory.
  87
  88 =item B<-p,--papersize=>
  89
  90 Specify papersize.
  91 (C<-p a4> produces C<\usepackage[a4paper]{article}>)
  92
  93 =item B<-s,--separate>
  94
  95 Normally all output files are included into one LaTeX file.
  96 With this switch all files are run separately, to produce one
  97 DVI file for each.
  98
  99 =back
 100
 101 =head1 FEATURES
 102
 103 ly2dvi responds to several parameters specified in the mudela
 104 file. They are overridden by corresponding command line options.
 105
 106 =over 5
 107
 108 =item B<language="";>
 109
 110 Specify LaTeX language
 111
 112 =item B<latexheaders="";>
 113
 114 Specify additional LaTeX headers file
 115
 116 =item B<orientation="";>
 117
 118 Set orientation.
 119
 120 =item B<paperlinewidth="";>
 121
 122 Specify the width (pt, mm or cm) of the printed lines.
 123
 124 =item B<papersize="";>
 125
 126 Specify name of papersize.
 127
 128 =back
 129
 130 =head1 ENVIRONMENT
 131
 132 =over 5
 133
 134 =item B<LILYINCLUDE>
 135
 136 Additional directories for input files.
 137
 138 =item B<TMP>
 139
 140 Temporary directory name. Default is /tmp
 141
 142 =back
 143
 144 =head1 FILES
 145
 146 F<titledefs.tex> is inspected for definitions used to extract
 147 additional text definitions from the mudela file. In the current
 148 version the following are defined:
 149
 150 =over 5
 151
 152 =item B<title>
 153
 154 The title of the music. Centered on top of the first page.
 155
 156 =item B<subtitle>
 157
 158 Subtitle, centered below the title.
 159
 160 =item B<composer>
 161
 162 Name of the composer, rightflushed below the subtitle.
 163
 164 =item B<arranger>
 165
 166 Name of the arranger, rightflushed below the composer.
 167
 168 =item B<instrument>
 169
 170 Name of the instrument, leftflushed at same level as the composer.
 171
 172 =back
 173
 174 F</usr/local/share/lilyrc /etc/lilyrc $HOME/.lilyrc ./.lilyrc>
 175 are files to set up default running conditions/variables, Bourne shell
 176 syntax. All files are parsed, in the shown sequence. The variables are
 177 overridden by variables in the mudela file, and by command line options.
 178 In the current version the following are allowed:
 179
 180 =over 5
 181
 182 =item B<LANGUAGE=>
 183
 184 Specify LaTeX language.
 185
 186 =item B<LATEXHF=>
 187
 188 Specify additional LaTeX headers file
 189
 190 =item B<LILYINCLUDE=>
 191
 192 Additional directories for input files.
 193
 194 =item B<ORIENTATION=>
 195
 196 Set orientation - portrait is the default.
 197
 198 =item B<OUTPUTDIR=>
 199
 200 Set output directory.
 201
 202 =item B<PAPERSIZE=>
 203
 204 Specify name of papersize.
 205
 206 =item B<PHEIGTH=>
 207
 208 Specify paperheight (points - an inch is 72.27, a cm is 28.453 points).
 209
 210 =item B<TMP=>
 211
 212 Temporary directory name.
 213
 214 =item B<PWIDTH=>
 215
 216 Specify paperwidth (points - an inch is 72.27, a cm is 28.453 points).
 217
 218 =back
 219
 220 =head1 SEE ALSO
 221
 222 lilypond(1), tex(1), latex(1)
 223
 224 =head1 AUTHOR
 225
 226 Jan Arne Fagertun <Jan.A.Fagertun@energy.sintef.no>,
 227 http://www.termo.unit.no/mtf/people/janaf/
 228
 229 =head1 BUGS
 230
 231 If you have found a bug, you should send a bugreport.
 232
 233 =over 4
 234
 235 =item *
 236 Send a copy of the input which causes the error.
 237
 238 =item *
 239 Send a description of the platform you use.
 240
 241 =item *
 242 Send a description of the LilyPond and ly2dvi version you use.
 243
 244 =item *
 245 Send a description of the bug itself.
 246
 247 =item *
 248 Send it to bug-gnu-music@gnu.org (you don't have to subscribe
 249 to this mailinglist).
 250
 251 =back
 252
 253 =head1 REMARKS
 254
 255 Many papersizes are now supported. Information on other sizes
 256 (LaTeX names, horizontal and vertical sizes) should be mailed to
 257 the author or to the mailing list.
 258
 259 Supported papersizes are:
 260
 261 a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, archA, archB, archC, archD,
 262 archE, b0, b1, b2, b3, b4, b5, flsa, flse, halfletter, ledger, legal,
 263 letter, note