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