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