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