Documentation/man/out/ly2dvi.1

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