Documentation/man/ly2dvi32.yo

   1 mailto(daboys@bga.com)
   2 manpage(LilyPond)
   3        (1)
   4         (1998)
   5        (The LilyPond package)
   6        (Ly2dvi32)
   7
   8 metalC(Automatically generated by yodl(1) from ly2dvi32.yo.)
   9
  10 manpagename(Ly2dvi32)(Python utility to convert mudela to DVI)
  11
  12 manpagedescription()
  13 ly2dvi is a Python script which creates input file for LaTeX,
  14 based on information from the output files from LilyPond.
  15 The script handles multiple files. If a mudela file name is
  16 specified LilyPond is run to make an output (TeX) file.
  17
  18 One or more LaTeX files are created, based on information found
  19 in the output (TeX) files, and latex is finally run to create
  20 one or more DVI files.
  21
  22 The majority of this utility came from a bourne script written by Jan
  23 Arne Fagertun name file(ly2dvi).
  24
  25 manpagesynopsis()
  26
  27         ly2dvi32 [options] inputfile[.ly] [....]
  28
  29 manpageoptions()
  30
  31 description(
  32 dit(-D,--debug)
  33     Set debug mode. There are two levels - in level one some debug
  34     info is written, in level two the command bf(set -x) is run, which
  35     echoes every command in the ly2dvi script.
  36 dit(-F,--headers=)
  37     Name of additional LaTeX headers file. This is included in the
  38     tex file at the end of the headers, last line before code(\begin{document})
  39 dit(-H,--Heigth=)
  40     Set paper heigth (points). Used together with width and LaTeX name of
  41     papersize in case of papersize unknown to ly2dvi.
  42 dit(-F,--headers=)
  43     Name of additional LaTeX headers file. This is included in the
  44     tex file at the end of the headers, last line before code(\begin{document})
  45 dit(-K,--keeplilypond)
  46     Keep LilyPond output after the run.
  47 dit(-L,--landscape)
  48     Set landscape orientation - portrait is the default.
  49     (bf(-L) produces code(\usepackage[landscape]{article}))
  50 dit(-N,--nonumber)
  51     Switch off page numbering.
  52 dit(-O,--orientation=)
  53     Set orientation landscape - obsolete, use bf(-L) instead.
  54 dit(-P,--postscript)
  55     In addition to the DVI file, also Generate a postsript file.
  56 dit(-W,--Width=)
  57     Set paper width (points). Used together with heigth and LaTeX name of
  58     papersize in case of papersize unknown to ly2dvi.
  59 dit(-d,--dependencies)
  60     Tell lilypond to make dependencies file.
  61 dit(-h,--help)
  62     Print help.
  63 dit(-k,--keeply2dvi)
  64     Keep the LaTeX file after the run.
  65 dit(-l,--language=)
  66     Specify LaTeX language.
  67     (bf(-l norsk) produces code(\usepackage[norsk]{babel})).
  68 dit(-o,--output=)
  69     Set output directory.
  70 dit(-p,--papersize=)
  71     Specify papersize.
  72     (bf(-p a4) produces code(\usepackage[a4paper]{article}))
  73 dit(-s,--separate)
  74     Normally all output files are included into one LaTeX file.
  75     With this switch all files are run separately, to produce one
  76     DVI file for each.
  77 )
  78
  79 manpagesection(Features)
  80
  81 ly2dvi responds to several parameters specified in the mudela
  82 file. They are overridden by corresponding command line options.
  83
  84 description(
  85 dit(language="";)
  86     Specify LaTeX language
  87 dit(latexheaders="";)
  88     Specify additional LaTeX headers file
  89 dit(orientation="";)
  90     Set orientation.
  91 dit(paperlinewidth="";)
  92     Specify the width (pt, mm or cm) of the printed lines.
  93 dit(papersize="";)
  94     Specify name of papersize.
  95 )
  96
  97 manpagesection(Environment)
  98
  99 description(
 100 dit(LILYPONDPREFIX)
 101     Sets the root directory of the LilyPond installation
 102 dit(LILYINCLUDE)
 103     Additional directories for input files.
 104 dit(TMP)
 105     Temporary directory name. Default is /tmp
 106 )
 107
 108 manpagesection(Files)
 109
 110 file(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 description(
 115 dit(title)
 116     The title of the music. Centered on top of the first page.
 117 dit(subtitle)
 118     Subtitle, centered below the title.
 119 dit(poet)
 120     Name of the poet, leftflushed below the below subtitle.
 121 dit(composer)
 122     Name of the composer, rightflushed below the subtitle.
 123 dit(metre)
 124     Meter string, leftflushed below the below poet.
 125 dit(opus)
 126     Name of the opus, rightflushed below the below composer.
 127 dit(arranger)
 128     Name of the arranger, rightflushed below the opus.
 129 dit(instrument)
 130     Name of the instrument, centered below the arranger
 131 dit(piece)
 132     Name of the piece, leftflushed below the instrument
 133 )
 134
 135 file($LILYPONDPREFIX/share/.lilyrc $HOME/.lilyrc ./.lilyrc) are files
 136 to set up default running conditions.  On Windows OS initialization
 137 files are named file(_lilyrc). The file syntax is as follows:
 138
 139 verb(VARIABLE-NAME=VALUE)
 140
 141 Where bf(VARIABLE-NAME) is the name of the variable documented below
 142 and bf(VALUE) is either a string, a 1, or a 0.  All files are parsed,
 143 in the shown sequence. In the current version the following are
 144 allowed:
 145
 146 description(
 147 dit(DEBUG=value)
 148 This turns off (default) or on the debug capabilities.  Possible
 149 values are 0 (off) and 1 (on).
 150 dit(DEPENDENCIES=value)
 151 This turns off (default) or on the ability to generate a Makefile
 152 dependency list.  Possible values are 0 (off) and 1 (on).
 153 dit(KEEPLILYPOND=value)
 154 This turns off (default) or on the ability to keep the log file
 155 associated with the LilyPond job.  Possible values are 0 (off) and 1
 156 (on).
 157 dit(KEEPLY2DVI=value)
 158 This turns off (default) or on the ability to keep the temporary files
 159 that are generated by the ly2dvi job.  Possible values are 0 (off) and
 160 1 (on)
 161 dit(LANGUAGE=value)
 162 Specify LaTeX language.  Possible value is a valid LaTeX language.
 163 dit(LATEXHF=value)
 164 Specify additional LaTeX headers file.  Possible value is a file
 165 specification.
 166 dit(LILYINCLUDE=value)
 167 Additional directories for input files.  Possible value is a delimited
 168 directory path list.
 169 dit(LILYPONDPREFIX=value)
 170 This defines the LilyPond root directory.  Possible value is a valid
 171 directory specification to the LilyPond distribution location.
 172 dit(NONUMBER=value)
 173 This turns off (default) or on the page numbering capability.
 174 Possible values are 0 (page numbering enabled) and 1 (page numbering
 175 disabled).
 176 dit(ORIENTATION=value)
 177 This sets the image orientation.  Possible values are
 178 portrait (default) and landscape.
 179 dit(OUTPUTDIR=value)
 180 This defines the directory where the resultant files will be
 181 generated.  Possible value is a valid directory specification.
 182 Default is the current working directory.
 183 dit(PAPERSIZE=value)
 184 This defines the papersize the image will be sized to fit.  Possible
 185 values are a0, a1, a2, a3, a4 (default), a5, a6, a7, a8, a9, a10, b0,
 186 b1, b2, b3, b4, b5, archA, archB, archC, archD, archE, flsa, flse,
 187 halfletter, ledger, legal, letter, or note.
 188 dit(PHEIGHT=value)
 189 Specify paperheight (points - an inch is 72.27, a cm is 28.453 points).
 190 dit(POSTSCRIPT=value)
 191 This turns off (default) or on the capability of additionally
 192 generating a postscript file.  Possible values are 0 (off) and 1 (on).
 193 dit(PWIDTH=value)
 194 Specify paperwidth (points - an inch is 72.27, a cm is 28.453 points).
 195 dit(SEPARATE=value)
 196 This turns off (default) or on the capability of generating multiple
 197 dvi and postscript files from multiple source files.  The default is
 198 to generate a concatenation of the source files.  Possible values are
 199 0 (single file) and 1 (separate files).
 200 dit(TMP=value)
 201 This defines the emporary directory.  Actually this is not used at the
 202 present.  Possible value is a valid directory specification that is
 203 writable to the user.
 204 )
 205
 206 manpagesection(Initialization Sequence)
 207 The initialization process reads inputs for several sources.  Below is
 208 a list of priorities for lowest to hightest proirity.
 209
 210 itemize(
 211 it() Program's defaults
 212 it() Values found in LilyPond output file
 213 it() Environment variables
 214 it() $LILYPONDPREFIX/share/lilypond/.lilyrc
 215 it() $HOME/.lilyrc
 216 it() ./.lilyrc
 217 it() command line options
 218 )
 219
 220 Note that this differs slightly from the original bourne shell
 221 version.
 222
 223
 224 manpagesection(See Also)
 225
 226 lilypond(1), tex(1), latex(1)
 227
 228 manpagesection(Bugs)
 229
 230 If you have found a bug, you should send a bugreport.
 231
 232 itemize(
 233 it()Send a copy of the input which causes the error.
 234 it()Send a description of the platform you use.
 235 it()Send a description of the LilyPond and ly2dvi version you use.
 236 it()Send a description of the bug itself.
 237 it()Send it to email(bug-gnu-music@gnu.org) (you don't have to subscribe
 238     to this mailinglist).
 239 )
 240
 241 manpagesection(Remarks)
 242
 243 Many papersizes are now supported. Information on other sizes
 244 (LaTeX names, horizontal and vertical sizes) should be mailed to
 245 the author or to the mailing list.
 246
 247 Supported papersizes are:
 248
 249 a0, a1, a2, a3, a4, a5, a6, a7, a8, a9, a10, archA, archB, archC, archD,
 250 archE, b0, b1, b2, b3, b4, b5, flsa, flse, halfletter, ledger, legal,
 251 letter, note
 252
 253 manpageauthor()
 254 Python Version author:
 255 nemail(Jeffrey B. Reed)(daboys@bga.com),
 256 lurl(http://www.realtime.net/~daboys/lilypond/)
 257
 258 Original bourne shell version author:
 259 nemail(Jan Arne Fagertun)(Jan.A.Fagertun@energy.sintef.no),
 260 lurl(http://www.termo.unit.no/mtf/people/janaf/)
 261
 262
 263