Documentation/man/mudela-book.yo

   1
   2 mailto(janneke@gnu.org)
   3 COMMENT(
   4         (PIPETHROUGH(echo -n `date '+%d/%b/%y'|tr '[a-z]' '[A-Z]'`)())
   5 )
   6 manpage(LilyPond)
   7         (1)
   8         (1999)
   9         (The LilyPond package)
  10         (mudela-book)
  11
  12 metalC(Automatically generated by yodl(1) from mudela-book.yo.)
  13
  14 manpagename(mudela-book)(integrate LaTeX and mudela)
  15
  16 manpagesynopsis() bf(mudela-book) [options] inputfile
  17
  18 manpagedescription() file(mudela-book) is a script that helps
  19 integrating mudela and LaTeX.  mudela-book runs LilyPond on
  20 fragments of mudela in your source file, and includes the results into
  21 document that can be processed with LaTeX.  The result is a text
  22 document with formatted music integrated.
  23
  24 Lilypond will by default create all output files in directory file(out).
  25 The file to give to latex has ext file(.latex).
  26
  27 bf(About the input)
  28
  29 If the file contains the ``block''
  30
  31 verb(
  32         \begin{mudela}
  33         CONTENTS
  34         \end{mudela}
  35 )
  36
  37 then LilyPond is run on CONTENTS.  mudela-book puts the result back,
  38 surrounded by code(\preMudelaExample) and code(\postMudelaExample)
  39 commands. code(\preMudelaExample) and code(posMudelaExample) is
  40 defined to nothing by default, and the user can redefine them
  41 to whatever he wants.
  42
  43 code(\begin) takes the following options:
  44
  45 description(
  46 dit(eps)
  47     the music is created as eps graphics that can be inserted in
  48     the middle of a text line, not only as a separate paragraph
  49 dit(verbatim)
  50     CONTENTS is copied into the TeX source enclosed in a verbatim block.
  51 dit(11pt, 13pt, 16pt, 20pt, 26pt)
  52     set the fontsize to use for the music
  53 dit(singleline)
  54   linewidth = -1.
  55 dit(multiline)
  56   linewidth = textwidth
  57 dit(fragment)
  58 dit(nonfragment)
  59     Override mudela-book autodetection of what type of code is in the
  60     mudela block, voice contents or complete code.
  61 )
  62
  63
  64 manpageoptions()
  65
  66 startdit()
  67
  68 dit(--default-mudela-fontsize=??pt)
  69     Set the fontsize to use for mudela if no fontsize is given
  70     as option.
  71 dit(--force-mudela-fontsize=??pt)
  72     Force all mudela to use this fontsize, overriding options
  73     given to \begin{mudela}
  74 dit(--outname=FILE)
  75     The name of LaTeX() file to output. If this option  is not given,
  76 the output name derived from the input name.
  77 dit(--outdir=DIRECTORY)
  78     The name of the directory to output lilypond output and input to.
  79     This must be a name; the subdirectory will be created in the cwd. [FIXME]
  80 dit(--help)
  81         Print a short help message
  82 dit(--dependencies)
  83         Write dependencies to outdir/filename.dep
  84 dit(--force-verbatim)
  85         Make all mudela verbatim.
  86 dit(--initfile=FILE)
  87         read command definitions from file(FILE)
  88 enddit()
  89
  90 manpagefiles()
  91   See file(Documentation/tex/out/mudela-book-doc.dvi) for more info.
  92   You have to install LaTeX.
  93   file(mudela-book) is written in  python 1.5, so you have to install
  94   url(python)(http://www.python.org).
  95
  96 manpagebugs()
  97
  98 The LaTeX \includeonly{...} command is ignored.
  99
 100 You get trouble if you use the --force-verbatim option and have some
 101 music in \footnote{...} or \marginpar{...}.
 102
 103 Ignores almost all LaTeX commands that changes margins and linewidths.
 104
 105 manpageauthor()
 106
 107 nemail(Han-Wen Nienhuys)(hanwen@cs.uu.nl), lurl(http://www.cs.uu.nl/people/hanwen)
 108
 109 nemail(Tom Cato Amundsen)(tomato@xoommail.com)