Documentation/web/download.itexi

   1 @c -*- coding: utf-8; mode: texinfo; -*-
   2 @ignore
   3     Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
   4
   5     When revising a translation, copy the HEAD committish of the
   6     version that you are working on.  For details, see the Contributors'
   7     Guide, node Updating translation committishes..
   8 @end ignore
   9
  10 @include included/generating-output.itexi
  11
  12 @macro warningTextBased
  13 @warning{LilyPond is a @strong{text-based} music engraver; it is
  14 more similar to a programming language than a graphical score
  15 editing program.  Before downloading LilyPond, please read about
  16 our @ref{Text input}.}
  17 @end macro
  18
  19 @node Download
  20 @unnumbered Download
  21
  22 @divClass{heading-center}
  23 @ifclear web_version
  24   @c yes, we want versionDevel here, since the online links
  25   @c for @version won't be up yet!
  26   @heading Downloads for LilyPond @versionDevel
  27
  28 @warning{Links for the stable version of LilyPond can be found at
  29 @uref{http://lilypond.org, lilypond.org}}
  30 @end ifclear
  31 @ifset web_version
  32   @heading Downloads for LilyPond @versionStable
  33 @end ifset
  34
  35 @warningTextBased
  36
  37 @divEnd
  38
  39 @divClass{link-headings}
  40
  41 @divClass{column-left-top}
  42 @subheading For users
  43
  44 @itemize
  45
  46 @item
  47 @c ref is duplicated to avoid underlining ref as image.
  48 @ref{Unix, @sourceimage{logo-linux,,,}
  49 @sourceimage{logo-freebsd,,,}}
  50 @ref{Unix, Unix (Linux and FreeBSD)}
  51
  52 @item
  53 @ref{MacOS X, @sourceimage{logo-macosx,,,}}
  54 @ref{MacOS X, MacOS X}
  55
  56 @item
  57 @ref{Windows, @sourceimage{logo-windows,,,}}
  58 @ref{Windows, Microsoft Windows}
  59
  60 @end itemize
  61
  62 @divEnd
  63
  64 @divClass{column-right-top}
  65 @subheading For developers
  66
  67 @itemize
  68
  69 @item
  70 @ref{Source}:
  71 for packagers
  72
  73 @item
  74 @ref{Old downloads}:
  75 old versions
  76
  77 @item @ref{Development}:
  78 latest unstable version
  79
  80 @end itemize
  81 @divEnd
  82
  83 @divEnd
  84
  85 @divClass{column-center-bottom}
  86
  87 @subheading Software License
  88
  89 LilyPond is published under the
  90 @ref{GPL, GNU General Public License}.
  91 @divEnd
  92
  93
  94 @divClass{color1}
  95
  96 @subheading Sponsors
  97
  98 Many thanks to @uref{http://www.vt.edu/, Virginia Tech} and
  99 @uref{http://www.linuxaudio.org/, linuxaudio.org} for sponsoring
 100 our bandwidth.
 101
 102 @sourceimage{VTlogo_ITF,,,}
 103 @sourceimage{lao_banner_06_on_white_demo,,,}
 104
 105 @subheading Legalese
 106
 107 @divClass{legal}
 108 All logos and product images are copyright and trademark
 109 acknowledged.
 110
 111 @logoLegalLinux
 112
 113 @logoLegalFreeBSD
 114
 115 @logoLegalMacOSX
 116
 117 @logoLegalWindows
 118
 119 @divEnd
 120 @divEnd
 121
 122
 123 @divClass{hide}
 124 @menu
 125 * Unix::
 126 * MacOS X::
 127 * Windows::
 128 * Source::
 129 * Old downloads::
 130 * GPL::
 131 @end menu
 132 @divEnd
 133
 134
 135 @node Unix
 136 @unnumberedsec Unix
 137
 138 @divClass{heading-center}
 139 @warningTextBased
 140 @divEnd
 141
 142 @divClass{column-center-top}
 143 @subheading Generic Packages or Distribution-Specific Packages?
 144
 145 Many distributions include LilyPond in their normal package
 146 system.  These versions are easier to install and uninstall than
 147 the generic packages, but they may be older.  If you wish to use
 148 our generic packages, please uninstall the official version from
 149 your system using the normal package manager for your distribution.
 150 See your distribution's documentation about how to use their
 151 package manager.
 152
 153 @divEnd
 154
 155
 156 @divClass{column-left-top}
 157 @subheading Generic Packages
 158
 159 @subsubheading Download
 160
 161 @itemize
 162
 163 @item
 164 @sourceimage{logo-linux,,,}
 165 @ifclear web_version
 166   @downloadDevelLinuxNormal
 167 @end ifclear
 168 @ifset web_version
 169   @downloadStableLinuxNormal
 170 @end ifset
 171
 172 (if in doubt, use this)
 173
 174 @item
 175 @sourceimage{logo-linux,,,}
 176 @downloadStableLinuxBig
 177
 178 @item
 179 @sourceimage{logo-linux,,,}
 180 @downloadStableLinuxPPC
 181
 182 @item
 183 @sourceimage{logo-freebsd,,,}
 184 @downloadStableFreeBSDNormal
 185
 186 @item
 187 @sourceimage{logo-freebsd,,,}
 188 @downloadStableFreeBSDBig
 189
 190 @end itemize
 191
 192
 193 @subsubheading Install
 194
 195 In the shell, type:
 196
 197 @example
 198 cd PATH-TO-DOWNLOAD-DIRECTORY
 199 sh lilypond-@versionStable{}-OS-TYPE.sh
 200 @end example
 201
 202 @subsubheading Uninstall
 203
 204 In the shell, type:
 205
 206 @example
 207 uninstall-lilypond
 208 @end example
 209
 210 @divEnd
 211
 212
 213
 214 @divClass{column-right-top}
 215 @subheading Compiling a file
 216
 217 @lilypadCommandLine
 218
 219 @divEnd
 220
 221
 222 @divClass{column-left-top}
 223 @subheading Distribution-specific Packages
 224
 225 Please use your distribution's package manager to install or
 226 upgrade to these versions.
 227
 228 @itemize
 229
 230 @item
 231 @sourceimage{logo-fedora,,,}
 232 @uref{http://koji.fedoraproject.org/koji/packageinfo?packageID=2447,
 233 Fedora: LilyPond 2.14.1}
 234
 235 @item
 236 @sourceimage{logo-ubuntu,,,}
 237 @uref{http://packages.ubuntu.com/search?keywords=lilypond,
 238 Ubuntu: LilyPond 2.12.3}
 239
 240 @item
 241 @sourceimage{logo-slackware,,,}
 242 @uref{http://www.johannes-schoepfer.de/lilypond/,
 243 Slackware: LilyPond 2.14.1}
 244
 245 @item
 246 @sourceimage{logo-debian,,,}
 247 @uref{http://packages.debian.org/search?keywords=lilypond,
 248 Debian: LilyPond 2.12.3}
 249
 250 @item
 251 @sourceimage{logo-suse,,,}
 252 @uref{http://software.opensuse.org/search?baseproject=openSUSE%3A11.2&p=1&q=lilypond,
 253 openSUSE: LilyPond 2.12.3}
 254
 255 @end itemize
 256
 257 @divEnd
 258
 259
 260 @divClass{column-center-bottom}
 261 @subheading Legalese
 262
 263 @divClass{legal}
 264 All logos and product images are copyright and trademark
 265 acknowledged.
 266
 267 @logoLegalLinux
 268
 269 @logoLegalFreeBSD
 270
 271 @divEnd
 272 @divEnd
 273
 274
 275 @node MacOS X
 276 @unnumberedsec MacOS X
 277
 278 @divClass{heading-center}
 279 @warningTextBased
 280 @divEnd
 281
 282 @divClass{column-left-top}
 283 @subheading Packages
 284
 285 @subsubheading Download
 286
 287 @itemize
 288
 289 @item
 290 @sourceimage{logo-macosx,,,}
 291 @downloadStableDarwinNormal
 292 For MacOS X 10.4 or higher, running on Intel CPUs (if in doubt,
 293 use this).
 294
 295 @item
 296 @sourceimage{logo-macosx,,,}
 297 @downloadStableDarwinPPC
 298 For MacOS X 10.4 or higher, running on G3 and G4 CPUs (old Apple
 299 computers).
 300
 301 @end itemize
 302
 303 @subsubheading Install
 304
 305 Double-click the downloaded file, then drag it to wherever you
 306 want.
 307
 308 @subsubheading Uninstall
 309
 310 Delete the LilyPond.app folder.
 311
 312 @divEnd
 313
 314 @divClass{column-right-top}
 315 @subheading Compiling a file
 316
 317 @lilypadOSX
 318
 319 @divEnd
 320
 321
 322 @divClass{column-left-top}
 323 @subheading Running on the command-line
 324
 325 @warning{If you are happy with the GUI, then please ignore these
 326 instructions.}
 327
 328 @subsubheading MacOS X on the command line
 329
 330 The most convenient way to run lilypond scripts is by setting up
 331 @qq{helper} scripts of your own.
 332
 333 @enumerate
 334
 335 @item
 336 Create a directory to store these scripts,
 337
 338 @example
 339 mkdir -p ~/bin
 340 cd ~/bin
 341 @end example
 342
 343
 344 @item
 345 Create a file called @command{lilypond} which contains
 346
 347 @divClass{h-scroll-auto}
 348 @example
 349 exec @var{DIR}/LilyPond.app/Contents/Resources/bin/lilypond "$@@"
 350 @end example
 351 @divEnd
 352
 353 @warning{@var{DIR} will generally be @code{/Applications/}}
 354
 355
 356 @item
 357 Create similar files @command{lilypond-book},
 358 @command{convert-ly}, and any other scripts you wish to use, by
 359 replacing the @command{bin/lilypond} with @command{bin/convert-ly}
 360 (or other program name).
 361
 362
 363 @item
 364 Make the file executable,
 365
 366 @example
 367 chmod u+x lilypond
 368 @end example
 369
 370
 371 @item
 372 Now, add this directory to your path.  Modify (or create) a file
 373 called @code{.profile} in your home directory such that it
 374 contains
 375
 376 @example
 377 export PATH=$PATH:~/bin
 378 @end example
 379
 380 This file should end with a blank line.
 381
 382 @end enumerate
 383
 384
 385 @subsubheading Invoking individual scripts
 386
 387 The scripts --- such as @command{lilypond-book}, @command{convert-ly},
 388 @command{abc2ly}, and even @command{lilypond} itself --- are included
 389 inside the @code{.app} file for MacOS@tie{}X.
 390
 391 Scripts can also be run from the command line by invoking them
 392 directly:
 393
 394 @divClass{h-scroll-auto}
 395 @example
 396 @var{path/to}/LilyPond.app/Contents/Resources/bin/lilypond
 397 @end example
 398 @divEnd
 399
 400 The same is true for all other scripts in that directory, such as
 401 @command{lilypond-book} and @command{convert-ly}.
 402
 403 @divEnd
 404
 405
 406 @divClass{column-center-bottom}
 407 @subheading Legalese
 408
 409 @divClass{legal}
 410 All logos and product images are copyright and trademark
 411 acknowledged.
 412
 413 @logoLegalMacOSX
 414
 415 @divEnd
 416 @divEnd
 417
 418
 419
 420 @node Windows
 421 @unnumberedsec Windows
 422
 423 @divClass{heading-center}
 424 @warningTextBased
 425 @divEnd
 426
 427 @divClass{column-left-top}
 428 @subheading Packages
 429
 430 @subsubheading Download
 431
 432 @itemize
 433
 434 @item
 435 @sourceimage{logo-windows,,,}
 436 @downloadStableWindows
 437 For Windows 2000, XP, Vista and Windows 7.
 438
 439 @end itemize
 440
 441 @subsubheading Install
 442
 443 @enumerate
 444
 445 @item
 446 Locate the downloaded file and double-click on it to start the
 447 installer.  Follow the instructions given to you by the installer;
 448 we recommend that you leave all the install options checked and
 449 use the default installation location.  Click the @q{Finish} button
 450 when the installer has completed.  LilyPond is now installed.
 451
 452 @end enumerate
 453
 454 @subsubheading Uninstall
 455
 456 To uninstall LilyPond either:
 457
 458 @enumerate
 459
 460 @item
 461 Locate the LilyPond folder from the @q{Start} menu and click on the
 462 @q{Uninstall} icon.  Click the @q{Finish} button when the uninstaller
 463 has completed.
 464
 465 @item
 466 Or from within the Control Panel, locate and select LilyPond and then
 467 choose the option to uninstall/remove the software.  Click the @q{Finish}
 468 button when the uninstaller has completed.
 469
 470 @end enumerate
 471
 472 @divEnd
 473
 474
 475 @divClass{column-right-top}
 476 @subheading Compiling a file
 477
 478 @lilypadWindows
 479
 480 @divEnd
 481
 482
 483 @divClass{column-left-top}
 484 @subheading Running on the command-line
 485
 486 @warning{If you are happy with the GUI, then please ignore these
 487 instructions.}
 488
 489 @subsubheading Windows on the command line
 490
 491 @ignore
 492 CHECK: check the following descriptions.
 493 I don't have English version of Windows.
 494 @end ignore
 495
 496 The most convenient way to run LilyPond is by adding the folder
 497 which contains LilyPond executable files to the environmental variable
 498 @qq{Path}.
 499
 500
 501 @enumerate
 502 @item
 503 Open your @qq{System} on the Control Panel,
 504 select Advanced tab and click Environmental Variables button.
 505
 506 @item
 507 Select the Variable @qq{Path} from Environmental variables list
 508 and click the Edit button.
 509 You will be presented a window titled @qq{Edit System Variable};
 510 append to @qq{Variable value} the name of the folder
 511 which contains LilyPond executable files like this:
 512
 513 @example
 514 [@var{pre-set paths}];@var{DIR}\LilyPond\usr\bin
 515 @end example
 516
 517 @warning{@var{DIR} will generally be @code{C:\Program Files}.}
 518
 519 @noindent
 520 and click @qq{OK} button to close the window.
 521
 522 @end enumerate
 523
 524 @subsubheading Invoking individual executable files
 525
 526 LilyPond executable files
 527 -- such as lilypond, lilypond-book, convert-ly, and so on --
 528 can be run from the command-line by invoking them:
 529
 530 @example
 531 lilypond test.ly
 532 @end example
 533
 534 @divEnd
 535
 536
 537 @divClass{column-center-bottom}
 538 @subheading Legalese
 539
 540 @divClass{legal}
 541 All logos and product images are copyright and trademark
 542 acknowledged.
 543
 544 @logoLegalWindows
 545
 546 @divEnd
 547 @divEnd
 548
 549
 550
 551 @node Source
 552 @unnumberedsec Source
 553
 554 @divClass{heading-center}
 555 @warningTextBased
 556 @divEnd
 557
 558 @warning{We @strong{do not} recommend that you attempt to build
 559 LilyPond yourself; almost all user needs are better met with the
 560 pre-built version.}
 561
 562 @divClass{column-left-bottom}
 563 @subheading Source tarball
 564
 565 @downloadStableSource{}
 566
 567 For an extensive listing of all versions (old and new), see our
 568 @uref{http://download.linuxaudio.org/lilypond/source/?C=N;O=D,
 569 download site}.
 570
 571 @divEnd
 572
 573 @divClass{column-right-bottom}
 574 @subheading Compiling instructions
 575
 576 Instructions are listed in @rcontrib{Compiling}.
 577
 578 @divEnd
 579
 580
 581 @node Old downloads
 582 @unnumberedsec Old downloads
 583
 584 @divClass{heading-center}
 585 @warningTextBased
 586 @divEnd
 587
 588 @divClass{column-center-top}
 589 @subheading All versions
 590
 591 For an extensive listing of all versions (old and new), see our
 592 @uref{http://download.linuxaudio.org/lilypond/binaries/, download
 593 site}.
 594
 595 @divEnd
 596
 597
 598 @node GPL
 599 @unnumberedsec GPL
 600
 601 @divClass{column-center-top}
 602 @subheading Software license
 603
 604 GNU LilyPond is published under the GNU General Public License.
 605 An introduction to this license, and our reasons for choosing it,
 606 is given in @ref{Freedom}.
 607
 608 @divEnd
 609
 610 @divClass{column-center-bottom}
 611 @subheading GNU General Public License
 612
 613 @include gpl.itexi
 614
 615 @divEnd