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.  See TRANSLATION for details.
   7 @end ignore
   8
   9 @macro warningTextBased
  10 @warning{LilyPond is a @strong{text-based} music engraver; it is
  11 more similar to a programming language than a graphical score
  12 editing program.  Before downloading LilyPond, please read about
  13 our @ref{Text input}.}
  14 @end macro
  15
  16 @node Download
  17 @unnumbered Download
  18
  19 @divClass{heading-center}
  20 @ifclear web_version
  21   @c yes, we want verisonDevel here, since the online links
  22   @c for @version won't be up yet!
  23   @heading Downloads for LilyPond @versionDevel
  24
  25 Links for the stable version of LilyPond can be found on
  26 @uref{http://lilypond.org, lilypond.org}
  27 @end ifclear
  28 @ifset web_version
  29   @heading Downloads for LilyPond @versionStable
  30 @end ifset
  31
  32 @warningTextBased
  33
  34 @divEnd
  35
  36 @divClass{column-left-top}
  37 @subheading For users
  38
  39 @itemize
  40
  41 @item
  42 @c TODO: duplicate to avoid underlined refs in HTML?  icky.
  43 @ref{Unix, @sourceimage{logo-linux,,,}
  44 @sourceimage{logo-freebsd,,,}}
  45 @ref{Unix, Unix (Linux and FreeBSD)}
  46
  47 @item
  48 @ref{MacOS X, @sourceimage{logo-macosx,,,}}
  49 @ref{MacOS X, MacOS X}
  50
  51 @item
  52 @ref{Windows, @sourceimage{logo-windows,,,}}
  53 @ref{Windows, Microsoft Windows}
  54
  55 @end itemize
  56
  57 @divEnd
  58
  59 @divClass{column-right-top}
  60 @subheading For developers
  61
  62 @itemize
  63
  64 @item
  65 @ref{Source}:
  66 for packagers
  67
  68 @item
  69 @ref{Old downloads}:
  70 old versions
  71
  72 @item @ref{Development}:
  73 latest unstable version
  74
  75 @end itemize
  76 @divEnd
  77
  78
  79 @divClass{column-center-bottom}
  80
  81 @subheading Software License
  82
  83 LilyPond is published under the
  84 @ref{GPL, GNU General Public License}.
  85 @divEnd
  86
  87
  88 @divClass{color1}
  89
  90 @subheading Sponsors
  91
  92 Many thanks to @uref{http://www.vt.edu/, Virgina Tech} and
  93 @uref{http://www.linuxaudio.org/, linuxaudio.org} for sponsoring
  94 our bandwidth.
  95
  96 @sourceimage{VTlogo_ITF,,,}
  97 @sourceimage{lao_banner_06_on_white_demo,,,}
  98
  99 @subheading Legalese
 100
 101 @divClass{legal}
 102 All logos and product images are copyright and trademark
 103 acknowledged.
 104
 105 @logoLegalLinux
 106
 107 @logoLegalFreeBSD
 108
 109 @logoLegalMacOSX
 110
 111 @logoLegalWindows
 112
 113 @divEnd
 114 @divEnd
 115
 116
 117 @divClass{hide}
 118 @menu
 119 * Unix::
 120 * MacOS X::
 121 * Windows::
 122 * Source::
 123 * Old downloads::
 124 * GPL::
 125 @end menu
 126 @divEnd
 127
 128
 129 @node Unix
 130 @unnumberedsec Unix
 131
 132 @divClass{heading-center}
 133 @warningTextBased
 134 @divEnd
 135
 136 @divClass{column-center-top}
 137 @subheading Generic Packages or Distribution-Specific Packages?
 138
 139 Many distributions include LilyPond in their normal package
 140 system.  These versions are easier to install and uninstall than
 141 the generic packages, but they may be older.  If you wish to use
 142 our generic packages, please uninstall the official version from
 143 your system using the normal package manager for your distribution.
 144 See your distribution's documentation about how to use their
 145 package manager.
 146
 147 @divEnd
 148
 149
 150 @divClass{column-left-top}
 151 @subheading Generic Packages
 152
 153 @subsubheading Download
 154
 155 @itemize
 156
 157 @item
 158 @sourceimage{logo-linux,,,}
 159 @ifclear web_version
 160   @downloadDevelLinuxNormal
 161 @end ifclear
 162 @ifset web_version
 163   @downloadStableLinuxNormal
 164 @end ifset
 165
 166 (if in doubt, use this)
 167
 168 @item
 169 @sourceimage{logo-linux,,,}
 170 @downloadStableLinuxBig
 171
 172 @item
 173 @sourceimage{logo-linux,,,}
 174 @downloadStableLinuxPPC
 175
 176 @item
 177 @sourceimage{logo-freebsd,,,}
 178 @downloadStableFreeBSDNormal
 179
 180 @item
 181 @sourceimage{logo-freebsd,,,}
 182 @downloadStableFreeBSDBig
 183
 184 @end itemize
 185
 186
 187 @subsubheading Install
 188
 189 In the shell, type:
 190
 191 @example
 192 cd PATH-TO-DOWNLOAD-DIRECTORY
 193 sh lilypond-@versionStable{}-OS-TYPE.sh
 194 @end example
 195
 196 @subsubheading Uninstall
 197
 198 In the shell, type:
 199
 200 @example
 201 uninstall-lilypond
 202 @end example
 203
 204 @divEnd
 205
 206
 207 @divClass{column-right-top}
 208 @subheading Distribution-specific Packages
 209
 210 Please use your distribution's package manager to install or
 211 upgrade to these versions.
 212
 213 @itemize
 214
 215 @item
 216 @sourceimage{logo-fedora,,,}
 217 @uref{http://koji.fedoraproject.org/koji/packageinfo?packageID=2447,
 218 Fedora: LilyPond 2.12.2}
 219
 220 @item
 221 @sourceimage{logo-ubuntu,,,}
 222 @uref{http://packages.ubuntu.com/search?keywords=lilypond,
 223 Ubuntu: LilyPond 2.12.2}
 224
 225 @item
 226 @sourceimage{logo-slackware,,,}
 227 @uref{http://www.johannes-schoepfer.de/lilypond/,
 228 Slackware: LilyPond 2.12.2}
 229
 230 @item
 231 @sourceimage{logo-debian,,,}
 232 @uref{http://packages.debian.org/search?keywords=lilypond,
 233 Debian: LilyPond 2.12.2}
 234
 235 @item
 236 @sourceimage{logo-suse,,,}
 237 @uref{http://download.opensuse.org/repositories/openSUSE:/Factory:/Contrib/standard/,
 238 openSUSE: LilyPond 2.12.2}
 239
 240 @end itemize
 241
 242 @divEnd
 243
 244
 245 @divClass{column-center-bottom}
 246 @subheading Legalese
 247
 248 @divClass{legal}
 249 All logos and product images are copyright and trademark
 250 acknowledged.
 251
 252 @logoLegalLinux
 253
 254 @logoLegalFreeBSD
 255
 256 @divEnd
 257 @divEnd
 258
 259
 260 @node MacOS X
 261 @unnumberedsec MacOS X
 262
 263 @divClass{heading-center}
 264 @warningTextBased
 265 @divEnd
 266
 267 @divClass{column-left-top}
 268 @subheading Packages
 269
 270 @subsubheading Download
 271
 272 @itemize
 273
 274 @item
 275 @sourceimage{logo-macosx,,,}
 276 @downloadStableDarwinNormal
 277 For Intel chips (if in doubt, use this).
 278
 279 @item
 280 @sourceimage{logo-macosx,,,}
 281 @downloadStableDarwinPPC
 282 For G3 and G4 CPUs (old Apple computers).
 283
 284 @end itemize
 285
 286 @subsubheading Install
 287
 288 Double-click the downloaded file, then drag it to wherever you
 289 want.
 290
 291 @subsubheading Uninstall
 292
 293 Delete the LilyPond.app folder.
 294
 295 @divEnd
 296
 297
 298 @divClass{column-right-top}
 299 @subheading Running on the command-line
 300
 301 @warning{If you are happy with the GUI, then please ignore these
 302 instructions.}
 303
 304 @ignore
 305 FIXME: I had one report that we don't need this stuff; will delete
 306 after confirmation.  -gp
 307
 308 @subsubheading Using Python scripts on MacOS 10.3 or 10.4
 309
 310 LilyPond binaries for MacOS X do not provide Python, but Python 2.4 or
 311 newer is required by @command{convert-ly}.  Therefore, if you use MacOS
 312 10.3 or 10.4, you must install a newer Python version from
 313 @uref{http://python.org/download/}, then edit the first line of
 314 @command{convert-ly} and @command{lilypond-book} as follows: if the
 315 Python binary you just installed is in your @var{PATH}, the first line
 316 should be
 317
 318 @example
 319 #!/usr/bin/env python
 320 @end example
 321
 322 @noindent
 323 otherwise it should be
 324
 325 @example
 326 #!@var{/path/to/newly_installed/python}
 327 @end example
 328 @end ignore
 329
 330 @subsubheading MacOS X on the command line
 331
 332 The most convenient way to run lilypond scripts is by setting up
 333 @qq{helper} scripts of your own.
 334
 335 @enumerate
 336
 337 @item
 338 Create a directory to store these scripts,
 339
 340 @example
 341 mkdir -p ~/bin
 342 cd ~/bin
 343 @end example
 344
 345
 346 @item
 347 Create a file called @command{lilypond} which contains
 348
 349 @help obvious css issue to be dealt with.  :(
 350 @c we need a small font here to fit.  -gp
 351 @smallexample
 352 exec @var{DIR}/LilyPond.app/Contents/Resources/bin/lilypond "$@@"
 353 @end smallexample
 354
 355 @warning{@var{DIR} will generally be @code{/Applications/}}
 356
 357
 358 @item
 359 Create similar files @command{lilypond-book},
 360 @command{convert-ly}, and any other scripts you wish to use, by
 361 replacing the @command{bin/lilypond} with @command{bin/convert-ly}
 362 (or other program name).
 363
 364
 365 @item
 366 Make the file executable,
 367
 368 @example
 369 chmod u+x lilypond
 370 @end example
 371
 372
 373 @item
 374 Now, add this directory to your path.  Modify (or create) a file
 375 called @code{.profile} in your home directory such that it
 376 contains
 377
 378 @example
 379 export PATH=$PATH:~/bin
 380 @end example
 381
 382 This file should end with a blank line.
 383
 384 @end enumerate
 385
 386
 387 @subsubheading Invoking individual scripts
 388
 389 The scripts --- such as @command{lilypond-book}, @command{convert-ly},
 390 @command{abc2ly}, and even @command{lilypond} itself --- are included
 391 inside the @code{.app} file for MacOS@tie{}X.
 392
 393 Scripts can also be run from the command line by invoking them
 394 directly:
 395
 396 @example
 397 @var{path/to}/LilyPond.app/Contents/Resources/bin/lilypond
 398 @end example
 399
 400 The same is true for all other scripts in that directory, such as
 401 @command{lilypond-book} and @command{convert-ly}.
 402
 403 @divEnd
 404
 405
 406 @divClass{column-center-bottom}
 407 @subheading Legalese
 408
 409 @divClass{legal}
 410 All logos and product images are copyright and trademark
 411 acknowledged.
 412
 413 @logoLegalMacOSX
 414
 415 @divEnd
 416 @divEnd
 417
 418
 419
 420 @node Windows
 421 @unnumberedsec Windows
 422
 423 @divClass{heading-center}
 424 @warningTextBased
 425 @divEnd
 426
 427 @divClass{column-left-top}
 428 @subheading Packages
 429
 430 @subsubheading Download
 431
 432 @itemize
 433
 434 @item
 435 @sourceimage{logo-windows,,,}
 436 @downloadStableWindows
 437 For Windows ME, NT, 2000, XP, Vista, and Windows 7.
 438
 439 @end itemize
 440
 441 @subsubheading Install
 442
 443 @enumerate
 444
 445 @item
 446 Locate the downloaded file and double-click on it to start the
 447 installer. Follow the instructions given to you by the installer;
 448 we recommend that you leave all the install options checked and
 449 use the default installation location. Click the @q{Finish} button
 450 when the installer has completed. Lilypond is now installed.
 451
 452 @end enumerate
 453
 454 @subsubheading Uninstall
 455
 456 To uninstall Lilypond either:
 457
 458 @enumerate
 459
 460 @item
 461 Locate the Lilypond folder from the @q{Start} menu and click on the
 462 @q{Uninstall} icon. Click the @q{Finish} button when the uninstaller
 463 has completed.
 464
 465 @item
 466 Or from witin the Control Panel,locate and select Lilypond and then
 467 choose the option to uninstall/remove the software. Click the @q{Finish}
 468 button when the uninstaller has completed.
 469
 470 @end enumerate
 471
 472 @divEnd
 473
 474
 475 @divClass{column-right-top}
 476 @subheading Running on the command-line
 477
 478 @warning{If you are happy with the GUI, then please ignore these
 479 instructions.}
 480
 481 @subsubheading Windows on the command line
 482
 483 @ignore
 484 CHECK: check the following descriptions.
 485 I don't have English version of Windows.
 486 @end ignore
 487
 488 The most convenient way to run LilyPond is by adding the folder
 489 which contains LilyPond executable files to the environmental variable
 490 @qq{Path}.
 491
 492
 493 @enumerate
 494 @item
 495 Open your @qq{System} on the Control Panel,
 496 select Advanced tab and click Environmental Variables button.
 497
 498 @item
 499 Select the Variable @qq{Path} from Environmental variables list
 500 and click the Edit button.
 501 You will be presented a window titled @qq{Edit System Variable};
 502 append to @qq{Variable value} the name of the folder
 503 which contains LilyPond executable files like this:
 504
 505 @example
 506 [@var{pre-set paths}];@var{DIR}\LilyPond\usr\bin
 507 @end example
 508
 509 @warning{@var{DIR} will generally be @code{C:\Program Files}.}
 510
 511 @noindent
 512 and click @qq{OK} button to close the window.
 513
 514 @end enumerate
 515
 516 @subsubheading Invoking individual excecutable files
 517
 518 LilyPond excecutable files
 519 -- such as lilypond, lilypond-book, convert-ly, and so on --
 520 can be run from the command-line by invoking them:
 521
 522 @example
 523 lilypond test.ly
 524 @end example
 525
 526 @divEnd
 527
 528
 529 @divClass{column-center-bottom}
 530 @subheading Legalese
 531
 532 @divClass{legal}
 533 All logos and product images are copyright and trademark
 534 acknowledged.
 535
 536 @logoLegalWindows
 537
 538 @divEnd
 539 @divEnd
 540
 541
 542
 543 @node Source
 544 @unnumberedsec Source
 545
 546 @divClass{heading-center}
 547 @warningTextBased
 548 @divEnd
 549
 550 @warning{We @strong{do not} recommend that you attempt to build
 551 LilyPond yourself; almost all user needs are better met with the
 552 pre-built version.}
 553
 554 @divClass{column-left-bottom}
 555 @subheading Source tarball
 556
 557 @downloadStableSource{}
 558
 559 For an extensive listing of all versions (old and new), see our
 560 @uref{http://download.linuxaudio.org/lilypond/binaries/, download
 561 site}.
 562
 563 @divEnd
 564
 565 @divClass{column-right-bottom}
 566 @subheading Compiling instructions
 567
 568 Instructions are listed in @rcontrib{Compiling LilyPond}.
 569
 570 @divEnd
 571
 572
 573 @node Old downloads
 574 @unnumberedsec Old downloads
 575
 576 @divClass{heading-center}
 577 @warningTextBased
 578 @divEnd
 579
 580 @divClass{column-center-top}
 581 @subheading All versions
 582
 583 For an extensive listing of all versions (old and new), see our
 584 @uref{http://download.linuxaudio.org/lilypond/binaries/, download
 585 site}.
 586
 587 @divEnd
 588
 589
 590 @node GPL
 591 @unnumberedsec GPL
 592
 593 @divClass{column-center-top}
 594 @subheading Software license
 595
 596 GNU LilyPond is published under the GNU General Public License.
 597 An introduction to this license, and our reasons for choosing it,
 598 is given in @ref{Freedom}.
 599
 600 @divEnd
 601
 602 @divClass{column-center-bottom}
 603 @subheading GNU General Public License
 604
 605 @include gpl.itexi
 606
 607 @divEnd
 608
 609
 610