release: 1.1.15

[lilypond.git] / Documentation / man / out / mudela-book.1

diff --git a/Documentation/man/out/mudela-book.1 b/Documentation/man/out/mudela-book.1
index ea1166057c2cbbd18ad886ebcb219985dc4bfb04..601d4e1d451326ffe1435f209293f02e865036fd 100644 (file)
--- a/Documentation/man/out/mudela-book.1
+++ b/Documentation/man/out/mudela-book.1
@@ -4,13 +4,21 @@
 .SH "NAME" 
 mudela-book \- integrate LaTeX and mudela
 .PP 
+.SH "SYNOPSIS" 
+\fBmudela-book\fP [options] inputfile
+.PP 
 .SH "DESCRIPTION" 
 \fBmudela-book\fP is a script that helps
-integrating mudela and \&.  mudela-book runs LilyPond on
+integrating mudela and LaTeX\&.  mudela-book runs LilyPond on
 fragments of mudela in your source file, and includes the results into
-document that can be processed with \&.  The result is a text
+document that can be processed with LaTeX\&.  The result is a text
 document with formatted music integrated\&.
 .PP 
+Lilypond will by default create all output files in directory \fBout\fP\&.
+The file to give to latex has ext \fB\&.latex\fP\&.
+.PP 
+\fBAbout the input\fP
+.PP 
 If the file contains the ``block\'\'
 .PP 
 
@@ -27,31 +35,65 @@ If the file contains the ``block\'\'
 .PP 
 then LilyPond is run on CONTENTS\&.  mudela-book puts the result back,
 surrounded by \f(CW\epreMudelaExample\fP and \f(CW\epostMudelaExample\fP
-commands\&. The \f(CW\ebegin\fP takes the following options:
+commands\&. \f(CW\epreMudelaExample\fP and \f(CWposMudelaExample\fP is
+defined to nothing by default, and the user can redefine them
+to whatever he wants\&.
 .PP 
-.IP "fragment" 
-mudela-book adds some redtape\&. You
-can substitute voice-contents for CONTENTS in this case\&.
+\f(CW\ebegin\fP takes the following options:
+.PP 
+.IP "eps" 
+the music is created as eps graphics that can be inserted in 
+the middle of a text line, not only as a separate paragraph
 .IP "verbatim" 
 CONTENTS is copied into the TeX source enclosed in a verbatim block\&.
+.IP "11pt, 13pt, 16pt, 20pt, 26pt" 
+set the fontsize to use for the music
+.IP "fragment" 
+.IP "nonfragment" 
+Override mudela-book autodetection of what type of code is in the
+mudela block, voice contents or complete code\&.
 .PP 
-.SH "Synopsis" 
+.SH "OPTIONS" 
 .PP 
-.IP "--outname" 
+.IP 
+.IP "--default-mudela-fontsize=??pt" 
+Set the fontsize to use for mudela if no fontsize is given
+as option\&.
+.IP "--force-mudela-fontsize=??pt" 
+Force all mudela to use this fontsize, overriding options
+given to \ebegin{mudela}
+.IP "--outname=FILE" 
 The name of  file to output\&. If this option  is not given,
-the output name derived from the input name\&.  The extension \fB\&.doc\fP
-is stripped, and \f(CW\&.mudtex\fP appended\&.
-.IP "--outdir" 
+the output name derived from the input name\&.
+.IP "--outdir=DIRECTORY" 
 The directory to output lilypond output and input to\&.
 .IP "--help" 
-print a short help message
+Print a short help message
+.IP "--dependencies" 
+Write dependencies to outdir/filename\&.dep
+.IP "--force-verbatim" 
+Make all mudela verbatim\&.
+.IP "--initfile=FILE" 
+read command definitions from \fBFILE\fP
+.PP 
+.SH "FILES" 
+See \fBDocumentation/tex/out/mudela-book-doc\&.dvi\fP for more info\&.
+You have to install LaTeX\&.
+\fBmudela-book\fP is written in  python 1\&.5, so you have to install 
+python\&.
 .PP 
 .SH "BUGS" 
 .PP 
-Doesn\'t handle incorrect input sanely\&.   mudela-book is written in
-python, so you have install python\&.
+The LaTeX \eincludeonly{\&.\&.\&.} command is ignored\&.
+.PP 
+You get trouble if you use the --force-verbatim option and have some
+music in \efootnote{\&.\&.\&.} or \emarginpar{\&.\&.\&.}\&.
+.PP 
+Ignores almost all LaTeX commands that changes margins and linewidths\&.
 .PP 
+\fB\ebegin{verbatim}\fP is ignored\&.
 .SH "AUTHOR" 
 .PP 
 Han-Wen Nienhuys <hanwen@cs\&.uu\&.nl>, http://www\&.cs\&.uu\&.nl/people/hanwen
 .PP 
+Tom Cato Amundsen <tomato@xoommail\&.com>