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