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