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 (GNU/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 @subsubheading Help
 211
 212 In the shell, type:
 213
 214 @example
 215 sh lilypond-@versionStable{}-OS-TYPE.sh --help
 216 @end example
 217
 218 @divEnd
 219
 220
 221
 222 @divClass{column-right-top}
 223 @subheading Compiling a file
 224
 225 @lilypadCommandLine
 226
 227 @divEnd
 228
 229
 230 @divClass{column-left-top}
 231 @subheading Distribution-specific Packages
 232
 233 Please use your distribution's package manager to install or
 234 upgrade to these versions.
 235
 236 @itemize
 237
 238 @item
 239 @sourceimage{logo-fedora,,,}
 240 @uref{http://koji.fedoraproject.org/koji/packageinfo?packageID=2447,
 241 Fedora: LilyPond 2.14.2}
 242
 243 @item
 244 @sourceimage{logo-ubuntu,,,}
 245 @uref{http://packages.ubuntu.com/search?keywords=lilypond,
 246 Ubuntu: LilyPond 2.14.2}
 247
 248 @item
 249 @sourceimage{logo-slackware,,,}
 250 @uref{http://www.johannes-schoepfer.de/lilypond/,
 251 Slackware: LilyPond 2.14.2}
 252
 253 @item
 254 @sourceimage{logo-debian,,,}
 255 @uref{http://packages.debian.org/search?keywords=lilypond,
 256 Debian: LilyPond 2.12.3}
 257
 258 @item
 259 @sourceimage{logo-suse,,,}
 260 @uref{http://software.opensuse.org/search?baseproject=openSUSE%3A11.2&p=1&q=lilypond,
 261 openSUSE: LilyPond 2.12.3}
 262
 263 @end itemize
 264
 265 @divEnd
 266
 267
 268 @divClass{column-center-bottom}
 269 @subheading Legalese
 270
 271 @divClass{legal}
 272 All logos and product images are copyright and trademark
 273 acknowledged.
 274
 275 @logoLegalLinux
 276
 277 @logoLegalFreeBSD
 278
 279 @divEnd
 280 @divEnd
 281
 282
 283 @node MacOS X
 284 @unnumberedsec MacOS X
 285
 286 @divClass{heading-center}
 287 @warningTextBased
 288 @divEnd
 289
 290 @divClass{column-left-top}
 291 @subheading Packages
 292
 293 @subsubheading Download
 294
 295 @itemize
 296
 297 @item
 298 @sourceimage{logo-macosx,,,}
 299 @downloadStableDarwinNormal
 300 For MacOS X 10.4 or higher, running on Intel CPUs (if in doubt,
 301 use this).
 302
 303 MacOS X 10.7 Lion is not yet supported.
 304
 305 @item
 306 @sourceimage{logo-macosx,,,}
 307 @downloadStableDarwinPPC
 308 For MacOS X 10.4 or higher, running on G3 and G4 CPUs (old Apple
 309 computers).
 310
 311 MacOS X 10.7 Lion is not yet supported.
 312
 313 @end itemize
 314
 315 @subsubheading Install
 316
 317 Double-click the downloaded file, then drag it to wherever you
 318 want.
 319
 320 @subsubheading Uninstall
 321
 322 Delete the LilyPond.app folder.
 323
 324 @divEnd
 325
 326 @divClass{column-right-top}
 327 @subheading Compiling a file
 328
 329 @lilypadOSX
 330
 331 @divEnd
 332
 333
 334 @divClass{column-left-top}
 335 @subheading Running on the command-line
 336
 337 @warning{If you are happy with the GUI, then please ignore these
 338 instructions.}
 339
 340 @subsubheading MacOS X on the command line
 341
 342 The most convenient way to run lilypond scripts is by setting up
 343 @qq{helper} scripts of your own.
 344
 345 @enumerate
 346
 347 @item
 348 Create a directory to store these scripts,
 349
 350 @example
 351 mkdir -p ~/bin
 352 cd ~/bin
 353 @end example
 354
 355
 356 @item
 357 Create a file called @command{lilypond} which contains
 358
 359 @divClass{h-scroll-auto}
 360 @example
 361 #!/bin/bash
 362 exec @var{DIR}/LilyPond.app/Contents/Resources/bin/lilypond "$@@"
 363 @end example
 364 @divEnd
 365
 366 @warning{@var{DIR} will generally be @code{/Applications/}}
 367
 368
 369 @item
 370 Create similar files @command{lilypond-book},
 371 @command{convert-ly}, and any other scripts you wish to use, by
 372 replacing the @command{bin/lilypond} with @command{bin/convert-ly}
 373 (or other program name).
 374
 375
 376 @item
 377 Make the file executable,
 378
 379 @example
 380 chmod u+x lilypond
 381 @end example
 382
 383
 384 @item
 385 Now, add this directory to your path.  Modify (or create) a file
 386 called @code{.profile} in your home directory such that it
 387 contains
 388
 389 @example
 390 export PATH=$PATH:~/bin
 391 @end example
 392
 393 This file should end with a blank line.
 394
 395 @end enumerate
 396
 397
 398 @subsubheading Invoking individual scripts
 399
 400 The scripts --- such as @command{lilypond-book}, @command{convert-ly},
 401 @command{abc2ly}, and even @command{lilypond} itself --- are included
 402 inside the @code{.app} file for MacOS@tie{}X.
 403
 404 Scripts can also be run from the command line by invoking them
 405 directly:
 406
 407 @divClass{h-scroll-auto}
 408 @example
 409 @var{path/to}/LilyPond.app/Contents/Resources/bin/lilypond
 410 @end example
 411 @divEnd
 412
 413 The same is true for all other scripts in that directory, such as
 414 @command{lilypond-book} and @command{convert-ly}.
 415
 416 @divEnd
 417
 418
 419 @divClass{column-center-bottom}
 420 @subheading Legalese
 421
 422 @divClass{legal}
 423 All logos and product images are copyright and trademark
 424 acknowledged.
 425
 426 @logoLegalMacOSX
 427
 428 @divEnd
 429 @divEnd
 430
 431
 432
 433 @node Windows
 434 @unnumberedsec Windows
 435
 436 @divClass{heading-center}
 437 @warningTextBased
 438 @divEnd
 439
 440 @divClass{column-left-top}
 441 @subheading Packages
 442
 443 @subsubheading Download
 444
 445 @itemize
 446
 447 @item
 448 @sourceimage{logo-windows,,,}
 449 @downloadStableWindows
 450 For Windows 2000, XP, Vista and Windows 7.
 451
 452 @end itemize
 453
 454 @subsubheading Install
 455
 456 @enumerate
 457
 458 @item
 459 Locate the downloaded file and double-click on it to start the
 460 installer.  Follow the instructions given to you by the installer;
 461 we recommend that you leave all the install options checked and
 462 use the default installation location.  Click the @q{Finish} button
 463 when the installer has completed.  LilyPond is now installed.
 464
 465 @end enumerate
 466
 467 @subsubheading Uninstall
 468
 469 To uninstall LilyPond either:
 470
 471 @enumerate
 472
 473 @item
 474 Locate the LilyPond folder from the @q{Start} menu and click on the
 475 @q{Uninstall} icon.  Click the @q{Finish} button when the uninstaller
 476 has completed.
 477
 478 @item
 479 Or from within the Control Panel, locate and select LilyPond and then
 480 choose the option to uninstall/remove the software.  Click the @q{Finish}
 481 button when the uninstaller has completed.
 482
 483 @end enumerate
 484
 485 @divEnd
 486
 487
 488 @divClass{column-right-top}
 489 @subheading Compiling a file
 490
 491 @lilypadWindows
 492
 493 @divEnd
 494
 495
 496 @divClass{column-left-top}
 497 @subheading Running on the command-line
 498
 499 @warning{If you are happy with the GUI, then please ignore these
 500 instructions.}
 501
 502 @subsubheading Windows on the command line
 503
 504 @ignore
 505 CHECK: check the following descriptions.
 506 I don't have English version of Windows.
 507 @end ignore
 508
 509 The most convenient way to run LilyPond is by adding the folder
 510 which contains LilyPond executable files to the environmental variable
 511 @qq{Path}.
 512
 513
 514 @enumerate
 515 @item
 516 Open your @qq{System} on the Control Panel,
 517 select Advanced tab and click Environmental Variables button.
 518
 519 @item
 520 Select the Variable @qq{Path} from Environmental variables list
 521 and click the Edit button.
 522 You will be presented a window titled @qq{Edit System Variable};
 523 append to @qq{Variable value} the name of the folder
 524 which contains LilyPond executable files like this:
 525
 526 @example
 527 [@var{pre-set paths}];@var{DIR}\LilyPond\usr\bin
 528 @end example
 529
 530 @warning{@var{DIR} will generally be @code{C:@bs{}Program Files}.}
 531
 532 @noindent
 533 and click @qq{OK} button to close the window.
 534
 535 @end enumerate
 536
 537 @subsubheading Invoking individual executable files
 538
 539 LilyPond executable files
 540 -- such as lilypond, lilypond-book, convert-ly, and so on --
 541 can be run from the command-line by invoking them:
 542
 543 @example
 544 lilypond test.ly
 545 @end example
 546
 547 @divEnd
 548
 549
 550 @divClass{column-center-bottom}
 551 @subheading Legalese
 552
 553 @divClass{legal}
 554 All logos and product images are copyright and trademark
 555 acknowledged.
 556
 557 @logoLegalWindows
 558
 559 @divEnd
 560 @divEnd
 561
 562
 563
 564 @node Source
 565 @unnumberedsec Source
 566
 567 @divClass{heading-center}
 568 @warningTextBased
 569 @divEnd
 570
 571 @warning{We @strong{do not} recommend that you attempt to build
 572 LilyPond yourself; almost all user needs are better met with the
 573 pre-built version.}
 574
 575 @divClass{column-left-bottom}
 576 @subheading Source tarball
 577
 578 @downloadStableSource{}
 579
 580 For an extensive listing of all versions (old and new), see our
 581 @uref{http://download.linuxaudio.org/lilypond/source/?C=N;O=D,
 582 download site}.
 583
 584 @divEnd
 585
 586 @divClass{column-right-bottom}
 587 @subheading Compiling instructions
 588
 589 Instructions are listed in @rcontrib{Compiling}.
 590
 591 @divEnd
 592
 593
 594 @node Old downloads
 595 @unnumberedsec Old downloads
 596
 597 @divClass{heading-center}
 598 @warningTextBased
 599 @divEnd
 600
 601 @divClass{column-center-top}
 602 @subheading All versions
 603
 604 For an extensive listing of all versions (old and new), see our
 605 @uref{http://download.linuxaudio.org/lilypond/binaries/, download
 606 site}.
 607
 608 @divEnd
 609
 610
 611 @node GPL
 612 @unnumberedsec GPL
 613
 614 @divClass{column-center-top}
 615 @subheading Software license
 616
 617 GNU LilyPond is published under the GNU General Public License.
 618 An introduction to this license, and our reasons for choosing it,
 619 is given in @ref{Freedom}.
 620
 621 @divEnd
 622
 623 @divClass{column-center-bottom}
 624 @subheading GNU General Public License
 625
 626 @include gpl.itexi
 627
 628 @divEnd