]> git.donarmstrong.com Git - lilypond.git/blob - Documentation/man/out/mudela-book.1
601d4e1d451326ffe1435f209293f02e865036fd
[lilypond.git] / Documentation / man / out / mudela-book.1
1 .TH "LilyPond" "1" "1998" "The LilyPond package" "mudela-book" 
2 .PP 
3 .PP 
4 .SH "NAME" 
5 mudela-book \- integrate LaTeX and mudela
6 .PP 
7 .SH "SYNOPSIS" 
8 \fBmudela-book\fP [options] inputfile
9 .PP 
10 .SH "DESCRIPTION" 
11 \fBmudela-book\fP is a script that helps
12 integrating mudela and LaTeX\&.  mudela-book runs LilyPond on
13 fragments of mudela in your source file, and includes the results into
14 document that can be processed with LaTeX\&.  The result is a text
15 document with formatted music integrated\&.
16 .PP 
17 Lilypond will by default create all output files in directory \fBout\fP\&.
18 The file to give to latex has ext \fB\&.latex\fP\&.
19 .PP 
20 \fBAbout the input\fP
21 .PP 
22 If the file contains the ``block\'\'
23 .PP 
24
25 .DS 
26  
27
28         \ebegin{mudela}
29         CONTENTS
30         \eend{mudela}
31
32 .DE 
33  
34
35 .PP 
36 then LilyPond is run on CONTENTS\&.  mudela-book puts the result back,
37 surrounded by \f(CW\epreMudelaExample\fP and \f(CW\epostMudelaExample\fP
38 commands\&. \f(CW\epreMudelaExample\fP and \f(CWposMudelaExample\fP is
39 defined to nothing by default, and the user can redefine them
40 to whatever he wants\&.
41 .PP 
42 \f(CW\ebegin\fP takes the following options:
43 .PP 
44 .IP "eps" 
45 the music is created as eps graphics that can be inserted in 
46 the middle of a text line, not only as a separate paragraph
47 .IP "verbatim" 
48 CONTENTS is copied into the TeX source enclosed in a verbatim block\&.
49 .IP "11pt, 13pt, 16pt, 20pt, 26pt" 
50 set the fontsize to use for the music
51 .IP "fragment" 
52 .IP "nonfragment" 
53 Override mudela-book autodetection of what type of code is in the
54 mudela block, voice contents or complete code\&.
55 .PP 
56 .SH "OPTIONS" 
57 .PP 
58 .IP 
59 .IP "--default-mudela-fontsize=??pt" 
60 Set the fontsize to use for mudela if no fontsize is given
61 as option\&.
62 .IP "--force-mudela-fontsize=??pt" 
63 Force all mudela to use this fontsize, overriding options
64 given to \ebegin{mudela}
65 .IP "--outname=FILE" 
66 The name of  file to output\&. If this option  is not given,
67 the output name derived from the input name\&.
68 .IP "--outdir=DIRECTORY" 
69 The directory to output lilypond output and input to\&.
70 .IP "--help" 
71 Print a short help message
72 .IP "--dependencies" 
73 Write dependencies to outdir/filename\&.dep
74 .IP "--force-verbatim" 
75 Make all mudela verbatim\&.
76 .IP "--initfile=FILE" 
77 read command definitions from \fBFILE\fP
78 .PP 
79 .SH "FILES" 
80 See \fBDocumentation/tex/out/mudela-book-doc\&.dvi\fP for more info\&.
81 You have to install LaTeX\&.
82 \fBmudela-book\fP is written in  python 1\&.5, so you have to install 
83 python\&.
84 .PP 
85 .SH "BUGS" 
86 .PP 
87 The LaTeX \eincludeonly{\&.\&.\&.} command is ignored\&.
88 .PP 
89 You get trouble if you use the --force-verbatim option and have some
90 music in \efootnote{\&.\&.\&.} or \emarginpar{\&.\&.\&.}\&.
91 .PP 
92 Ignores almost all LaTeX commands that changes margins and linewidths\&.
93 .PP 
94 \fB\ebegin{verbatim}\fP is ignored\&.
95 .SH "AUTHOR" 
96 .PP 
97 Han-Wen Nienhuys <hanwen@cs\&.uu\&.nl>, http://www\&.cs\&.uu\&.nl/people/hanwen
98 .PP 
99 Tom Cato Amundsen <tomato@xoommail\&.com>