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