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