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 create a directory to put temporary files, the default
  18 dir name is \fBout\fP\&. When you run mudela on a file, like this:
  19 .PP
  20
  21 .DS
  22
  23 mudelab-book myfile\&.tex
  24 .DE
  25
  26
  27 .PP
  28 the a file \fBout/myfile\&.latex\fP will be created\&. And to create
  29 the \fB\&.dvi\fP file you should type:
  30 .PP
  31
  32 .DS
  33
  34 latex out/myfile\&.latex
  35 .DE
  36
  37
  38 .PP
  39 This will create \fBmyfile\&.dvi\fP in the current directory\&. Bad things
  40 will happen if you cd to \fBout\fP and then runs
  41 .DS
  42
  43 latex myfile\&.latex
  44 .DE
  45
  46
  47 .PP
  48 \fBAbout the input\fP
  49 .PP
  50 If the file contains the ``block\'\'
  51 .PP
  52
  53 .DS
  54
  55
  56         \ebegin{mudela}
  57         CONTENTS
  58         \eend{mudela}
  59
  60 .DE
  61
  62
  63 .PP
  64 then LilyPond is run on CONTENTS\&.  mudela-book puts the result back,
  65 surrounded by \f(CW\epreMudelaExample\fP and \f(CW\epostMudelaExample\fP
  66 commands\&. \f(CW\epreMudelaExample\fP and \f(CWposMudelaExample\fP is
  67 defined to nothing by default, and the user can redefine them
  68 to whatever he wants\&.
  69 .PP
  70 \f(CW\ebegin\fP takes the following options:
  71 .PP
  72 .IP "floating"
  73 the created graphics can be inserted in the middle of a text line,
  74 not only as a separate paragraph
  75 .IP "fragment"
  76 mudela-book adds some redtape\&. You
  77 can substitute voice-contents for CONTENTS in this case\&.
  78 .IP "verbatim"
  79 CONTENTS is copied into the TeX source enclosed in a verbatim block\&.
  80 .IP "11pt, 13pt, 16pt, 20pt, 26pt"
  81 set the fontsize to use for the music
  82 .PP
  83 .SH "OPTIONS"
  84 .PP
  85 .IP
  86 .IP "--mudela-fontsize"
  87 Set the fontsize to use for mudela if no fontsize is given
  88 as option\&.
  89 .IP "--force-mudela-fontsize"
  90 Force all mudela to use this fontsize, overriding options
  91 given to \ebegin{mudela}
  92 .IP "--outname"
  93 The name of  file to output\&. If this option  is not given,
  94 the output name derived from the input name\&.
  95 .IP "--outdir"
  96 The directory to output lilypond output and input to\&.
  97 .IP "--help"
  98 Print a short help message
  99 .IP "--dependencies"
 100 Write dependencies to outdir/filename\&.dep
 101 .IP "--force-verbatim"
 102 Make all mudela verbatim\&.
 103 .PP
 104 .SH "FILES"
 105 You have to install LaTeX\&. \fBmudela-book\fP is not tested on LaTeX 2\&.09
 106 and will probably fail on something else than LaTeX2e\&.
 107 .PP
 108 \fBmudela-book\fP is written in  python 1\&.5, so you have to install
 109 python\&.
 110 .PP
 111 .SH "BUGS"
 112 .PP
 113 The LaTeX \eincludeonly{\&.\&.\&.} command is ignored\&.
 114 .PP
 115 You get trouble if you use the --force-verbatim option and have some
 116 music in \efootnote{\&.\&.\&.} or \emarginpar{\&.\&.\&.}\&.
 117 .PP
 118 Ignores almost all LaTeX commands that changes margins and linewidths\&.
 119 .PP
 120 .SH "AUTHOR"
 121 .PP
 122 Han-Wen Nienhuys <hanwen@cs\&.uu\&.nl>, http://www\&.cs\&.uu\&.nl/people/hanwen
 123 .PP
 124 Tom Cato Amundsen <tomato@xoommail\&.com>