Documentation/faq.pod

   1 =head1 NAME
   2
   3 FAQ - GNU LilyPond FAQs
   4
   5 =head1 DESCRIPTION
   6
   7 Some questions that have been answered before.
   8
   9 =head2 Installing
  10
  11 Q: I get all kinds of errors while  compiling parser.cc
  12
  13 A: LilyPond uses features of bison version 1.25. Please confirm that
  14 you are using a version 1.25 or better. Don't forget to do "make
  15 clean" after installing it. Don't forget to remove the stale
  16 bison.simple as well.
  17
  18 If the problem persists, then please mail me.
  19
  20 Q: Some of your neat scripts fail, what directories do you use:
  21
  22 A:
  23
  24         ~/something/
  25
  26 which contains:
  27
  28           lilypond/     # the directory as unpacked from the tarball
  29           releases/     # directory for .tar.gz releases
  30           patches/      # directory for patches between different releases
  31           test/
  32
  33 ~/something/lilypond/bin is in the PATH, and contains symlinks to the
  34 compiled executables.
  35
  36 If you don't use patches, you'd probably want to symlink
  37
  38         lilypond -> lilypond-x.y.z
  39
  40 =head2 Language: mudela
  41
  42 Q: Why can't you type C<#c> in stead of C<cis> ?
  43
  44 A: We think that C<#c> looks as if you are entering the symbols to
  45 print (which you are not; remember, you're entering the musical
  46 content in Mudela)
  47
  48 We're not sure on leaving out this feature. If you think this is a
  49 good idea, please let us know.
  50
  51 Be warned we will I<not> allow you to leave out the C<#> if the note
  52 already has an accidental. We won't allow
  53
  54         c# c    % no way!
  55
  56 in stead of:
  57
  58         cis cis
  59         #c #c
  60
  61 Why, you might ask? Because independently of how it was written, you
  62 would say that you are playing and reading "two C-sharp" notes.
  63
  64
  65 Q: What is C<cis> anyway
  66
  67 A: C<cis> is the dutch naming for C-sharp. The notes are named
  68 a, b,.., g. The suffix -is means sharp, and -es flat. This system is
  69 common in a number of languages (such as swedish, dutch, german.)
  70 Certain other languages (such as English, French and Italian) just add
  71 the word for "sharp" to the notename.
  72
  73 We chose the Dutch system, because we're dutch. You are free to chose
  74 whatever names you like; they are user definable.
  75
  76 Q: I can type
  77
  78         <a c> <e g>
  79
  80 to make a few chords, but why do I have to type
  81
  82
  83         < { a~ e } { c ~ g } >
  84
  85 instead of
  86
  87         <a~ c~> <e g>
  88
  89 to generate ties between the chords?
  90
  91 A: When you type
  92
  93         <a c> <e g>
  94
  95 this is shorthand for
  96
  97         < { a } { c } > < { e } { g } >
  98
  99 Ties have to be confined to `voices', and the a and the e are in
 100 different {} blocks, so they are in different voices. You should view
 101 the desired construct as a "generalised chord" (two voices stacked
 102 vertically). It might help you visualise this by using the following
 103 formatting:
 104
 105         < { a ~ e }
 106           { c ~ g }
 107         >
 108
 109 Q: and where do the beams come into this picture?
 110
 111 A: Beams are voicegroup-wide, and may be entered in any part of the
 112 voicegroup:
 113
 114         < { [a ~ e] } { c ~ g } >
 115         < { [a ~ e } { c ~ g] } >
 116         < { [a ~ e] } { [c ~ g] } >
 117
 118 These all give the same result.
 119
 120 Q: Why are [] around the notes, and () inbetween?
 121
 122 A: [] designate beams, a note can only be in one beam at the same
 123 time. () is a slur, which connects notes.  You need to be able to
 124 specify
 125
 126         a()a()a
 127
 128 Q: I want to insert some TeX commands
 129
 130 A: You shouldn't: it's against LilyPond philosophy to have typesetting
 131 commands in the mudela source. Moreover, this would be difficult. The
 132 manner in which Request (the basic building blocks of mudela) are
 133 translated into printable items is complex: it is not always possible
 134 to associate one Request with one Item or Spanner.
 135
 136 As a further notice, we want to move away from TeX (and perhaps
 137 output PostScript or render to an X window too)
 138
 139 =head2 Miscellaneous
 140
 141 Q: How do I change the TeX layout?
 142
 143 A: See lilyponddefs.tex, it has some comments.
 144
 145 Q: How do I learn the C++ code?
 146
 147 A: The entry point is in main(). Good luck. :-)
 148
 149 Seriously, read, reread and reread lilygut and CodingStyle, and
 150 just start anywhere.
 151
 152 Anywhere? Well, most of the comment doco are in the header files, so
 153 your best bet would be C<less lily/include/*.hh>. Some of the most
 154 important data-structures are to be found in:
 155
 156         - p-col.hh
 157         - *request.hh
 158         - engraver.hh
 159         - performer.hh
 160         - translator.hh
 161         - score-elem.hh
 162         - music.hh
 163         - music-list.hh
 164         - music-iterator.hh
 165         - item.hh
 166         - spanner.hh
 167
 168
 169 Q: Why GPL?
 170
 171 A: Yes.
 172
 173 Q: Could you implement feature XXXX? It is really easy, just extend
 174 the syntax to allow YYYY!
 175
 176 A: If it is reasonable, I'll add XXXX to the TODO list. In general
 177 finding a cute syntax (such as YYYY) isn't very hard. The complicated
 178 issue how to adapt the internals to do XXXX. The parser is really a
 179 simple front end to the complicated internals.
 180
 181 Q: Why do I need g++ >= 2.7?
 182
 183 A: By using g++, GNU LilyPond is portable to all platforms which support
 184 g++ (there are quite a few). Not having to support other compilers
 185 saves us a I<lot> of trouble.
 186
 187 =head2 Running
 188
 189 Q: I get
 190
 191         can't load library 'libflower.so'
 192
 193 A: You are using the dynamically compiled Flower library. Please set
 194 LD_LIBRARY_PATH to a directory containing F<libflower.so>
 195
 196 =head2 DOZE
 197
 198 Q: I want a DOS/NT/W95 port.
 199
 200 A.0: Reconsider.  Try Linux.  It's fun!
 201
 202 A.1: Currently (patchlevel 27), GNU LilyPond (and flowerLib) compiles, links
 203 and runs on windhoos-nt, using the cygnus gnu port (release b17.1).
 204 I (JCN) only had to make a minor workaround for missing library calls.
 205 Have a look at http://www.cygnus.com/gnu-win32.  To make GNU LilyPond type
 206 C<make $OSTYPE>. (I am not promising to maintain this platform, it is just
 207 that when having to use doze, i-m sometimes too lazy to reboot.)
 208
 209 A.2: I haven't had time to find a GCC crosscompiler (I<with> g++ and
 210 libg++, mind you) to DOS/win (in rpm, please :-)
 211
 212
 213 Q: I-m dozed enough to run the (sometimes bit stale) .exe-s you distribute.
 214 Why do i need cygwin.dll?
 215
 216 A: It-s all in this cut-n-paste:
 217
 218 Minimalist GNU-Win32 Readme
 219 version 0.1.3
 220 March 20, 1997
 221 Colin Peters <colin@bird.fu.is.saga-u.ac.jp>
 222
 223 [...]
 224
 225 0.3 Fixes and Improvements
 226
 227 [...]
 228 In the "coming soon" category I have a version of the GNU Standard C++
 229 library ported to Mingw32. This means you can use iostreams, complex
 230 numbers and all those neat STL (Standard Template Library) things
 231 without needing the Cygwin DLL. I hope to put this port up for
 232 downloading soon (along with the source of course).
 233
 234 [...]
 235
 236 3.2 C++ Support
 237
 238 To add C++ Support to the above the following extra files are required:
 239
 240 In C:\cygnus\H-i386-cygwin32\lib\gcc-lib\i386-cygwin32\cygnus-2.7.2-
 241 961023:
 242         cc1plus.exe
 243
 244 Note that this does not include support for the standard C++ libraries
 245 (only the C run time libraries) or for iostreams. That support is still
 246 only available with the Cygwin32 API.
 247