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