Documentation/man/out/ly2dvi.1

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