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