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