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