Documentation/man/ly2dvi.yo

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