Documentation/man/ly2dvi.yo

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