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<-H,--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<-K,--keeplilypond>
  36
  37 Keep LilyPond output after the run.
  38
  39 =item B<-L,--landscape>
  40
  41 Set landscape orientation - portrait is the default.
  42 (C<-L> produces C<\usepackage[landscape]{article}>)
  43
  44 =item B<-N,--nonumber>
  45
  46 Switch off page numbering.
  47
  48 =item B<-O,--orientation=>
  49
  50 Set orientation - portrait is the default.
  51 (C<-O> landscape produces C<\usepackage[landscape]{article}>)
  52
  53 =item B<-h,--help>
  54
  55 Print help.
  56
  57 =item B<-k,--keeply2dvi>
  58
  59 Keep the LaTeX file after the run.
  60
  61 =item B<-l,--language=>
  62
  63 Specify LaTeX language.
  64 (C<-l norsk> produces C<\usepackage[norsk]{babel}>).
  65
  66 =item B<-o,--output=>
  67
  68 Set output directory.
  69
  70 =item B<-p,--papersize=>
  71
  72 Specify papersize.
  73 (C<-p a4paper> produces C<\usepackage[a4paper]{article}>)
  74
  75 =item B<-s,--separate>
  76
  77 Normally all output files are included into one LaTeX file.
  78 With this switch all files are run separately, to produce one
  79 DVI file for each.
  80
  81 =back
  82
  83 =head1 FEATURES
  84
  85 ly2dvi responds to several parameters specified in the mudela
  86 file. They are overridden by corresponding command line options.
  87
  88 =over 5
  89
  90 =item B<language="";>
  91
  92 Specify LaTeX language
  93
  94 =item B<latexheaders="";>
  95
  96 Specify additional LaTeX headers file
  97
  98 =item B<orientation="";>
  99
 100 Set orientation.
 101
 102 =item B<paperlinewidth="";>
 103
 104 Specify the width (pt, mm or cm) of the printed lines.
 105
 106 =item B<papersize="";>
 107
 108 Specify papersize.
 109
 110 =back
 111
 112 =head1 ENVIRONMENT
 113
 114 =over 5
 115
 116 =item B<LILYINCLUDE>
 117
 118 Additional directories for input files.
 119
 120 =item B<TMP>
 121
 122 Temporary directory name. Default is /tmp
 123
 124 =back
 125
 126 =head1 FILES
 127
 128 F<titledefs.tex> is inspected for definitions used to extract
 129 additional text definitions from the mudela file. In the current
 130 version the following are defined:
 131
 132 =over 5
 133
 134 =item B<title>
 135
 136 The title of the music. Centered on top of the first page.
 137
 138 =item B<subtitle>
 139
 140 Subtitle, centered below the title.
 141
 142 =item B<composer>
 143
 144 Name of the composer, rightflushed below the subtitle.
 145
 146 =item B<arranger>
 147
 148 Name of the arranger, rightflushed below the composer.
 149
 150 =item B<instrument>
 151
 152 Name of the instrument, leftflushed at same level as the composer.
 153
 154 =back
 155
 156 F</usr/local/share/lilyrc /etc/lilyrc $HOME/.lilyrc ./.lilyrc>
 157 are files to set up default running conditions/variables, Bourne shell
 158 syntax. All files are parsed, in the shown sequence. The variables are
 159 overridden by variables in the mudela file, and by command line options.
 160 In the current version the following are allowed:
 161
 162 =over 5
 163
 164 =item B<LANGUAGE=>
 165
 166 Specify LaTeX language.
 167
 168 =item B<LATEXHF=>
 169
 170 Specify additional LaTeX headers file
 171
 172 =item B<LILYINCLUDE=>
 173
 174 Additional directories for input files.
 175
 176 =item B<ORIENTATION=>
 177
 178 Set orientation - portrait is the default.
 179
 180 =item B<OUTPUTDIR=>
 181
 182 Set output directory.
 183
 184 =item B<PAPERSIZE=>
 185
 186 Specify papersize.
 187
 188 =item B<TMP=>
 189
 190 Temporary directory name.
 191
 192 =back
 193
 194 =head1 SEE ALSO
 195
 196 lilypond(1), tex(1), latex(1)
 197
 198 =head1 AUTHOR
 199
 200 Jan Arne Fagertun <Jan.A.Fagertun@energy.sintef.no>,
 201 http://www.termo.unit.no/mtf/people/janaf/
 202
 203 =head1 BUGS
 204
 205 If you have found a bug, you should send a bugreport.
 206
 207 =over 4
 208
 209 =item *
 210 Send a copy of the input which causes the error.
 211
 212 =item *
 213 Send a description of the platform you use.
 214
 215 =item *
 216 Send a description of the LilyPond and ly2dvi version you use.
 217
 218 =item *
 219 Send a description of the bug itself.
 220
 221 =item *
 222 Send it to bug-gnu-music@gnu.org (you don't have to subscribe
 223 to this mailinglist).
 224
 225 =back
 226
 227 =head1 REMARKS
 228
 229 Only one papersize is supported, A4. Information on other sizes
 230 (LaTeX names, horizontal and vertical sizes) should be mailed to
 231 the author or to the mailing list.
 232