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 @macro warningTextBased
  11 @warning{LilyPond is a @strong{text-based} music engraver; it is
  12 more similar to a programming language than a graphical score
  13 editing program.  Before downloading LilyPond, please read about
  14 our @ref{Text input}.}
  15 @end macro
  16
  17 @node Download
  18 @unnumbered Download
  19
  20 @divClass{heading-center}
  21 @ifclear web_version
  22   @c yes, we want verisonDevel here, since the online links
  23   @c for @version won't be up yet!
  24   @heading Downloads for LilyPond @versionDevel
  25
  26 @warning{Links for the stable version of LilyPond can be found at
  27 @uref{http://lilypond.org, lilypond.org}}
  28 @end ifclear
  29 @ifset web_version
  30   @heading Downloads for LilyPond @versionStable
  31 @end ifset
  32
  33 @warningTextBased
  34
  35 @divEnd
  36
  37 @divClass{column-left-top}
  38 @subheading For users
  39
  40 @itemize
  41
  42 @item
  43 @c TODO: duplicate to avoid underlined refs in HTML?  icky.
  44 @ref{Unix, @sourceimage{logo-linux,,,}
  45 @sourceimage{logo-freebsd,,,}}
  46 @ref{Unix, Unix (Linux and FreeBSD)}
  47
  48 @item
  49 @ref{MacOS X, @sourceimage{logo-macosx,,,}}
  50 @ref{MacOS X, MacOS X}
  51
  52 @item
  53 @ref{Windows, @sourceimage{logo-windows,,,}}
  54 @ref{Windows, Microsoft Windows}
  55
  56 @end itemize
  57
  58 @divEnd
  59
  60 @divClass{column-right-top}
  61 @subheading For developers
  62
  63 @itemize
  64
  65 @item
  66 @ref{Source}:
  67 for packagers
  68
  69 @item
  70 @ref{Old downloads}:
  71 old versions
  72
  73 @item @ref{Development}:
  74 latest unstable version
  75
  76 @end itemize
  77 @divEnd
  78
  79
  80 @divClass{column-center-bottom}
  81
  82 @subheading Software License
  83
  84 LilyPond is published under the
  85 @ref{GPL, GNU General Public License}.
  86 @divEnd
  87
  88
  89 @divClass{color1}
  90
  91 @subheading Sponsors
  92
  93 Many thanks to @uref{http://www.vt.edu/, Virgina Tech} and
  94 @uref{http://www.linuxaudio.org/, linuxaudio.org} for sponsoring
  95 our bandwidth.
  96
  97 @sourceimage{VTlogo_ITF,,,}
  98 @sourceimage{lao_banner_06_on_white_demo,,,}
  99
 100 @subheading Legalese
 101
 102 @divClass{legal}
 103 All logos and product images are copyright and trademark
 104 acknowledged.
 105
 106 @logoLegalLinux
 107
 108 @logoLegalFreeBSD
 109
 110 @logoLegalMacOSX
 111
 112 @logoLegalWindows
 113
 114 @divEnd
 115 @divEnd
 116
 117
 118 @divClass{hide}
 119 @menu
 120 * Unix::
 121 * MacOS X::
 122 * Windows::
 123 * Source::
 124 * Old downloads::
 125 * GPL::
 126 @end menu
 127 @divEnd
 128
 129
 130 @node Unix
 131 @unnumberedsec Unix
 132
 133 @divClass{heading-center}
 134 @warningTextBased
 135 @divEnd
 136
 137 @divClass{column-center-top}
 138 @subheading Generic Packages or Distribution-Specific Packages?
 139
 140 Many distributions include LilyPond in their normal package
 141 system.  These versions are easier to install and uninstall than
 142 the generic packages, but they may be older.  If you wish to use
 143 our generic packages, please uninstall the official version from
 144 your system using the normal package manager for your distribution.
 145 See your distribution's documentation about how to use their
 146 package manager.
 147
 148 @divEnd
 149
 150
 151 @divClass{column-left-top}
 152 @subheading Generic Packages
 153
 154 @subsubheading Download
 155
 156 @itemize
 157
 158 @item
 159 @sourceimage{logo-linux,,,}
 160 @ifclear web_version
 161   @downloadDevelLinuxNormal
 162 @end ifclear
 163 @ifset web_version
 164   @downloadStableLinuxNormal
 165 @end ifset
 166
 167 (if in doubt, use this)
 168
 169 @item
 170 @sourceimage{logo-linux,,,}
 171 @downloadStableLinuxBig
 172
 173 @item
 174 @sourceimage{logo-linux,,,}
 175 @downloadStableLinuxPPC
 176
 177 @item
 178 @sourceimage{logo-freebsd,,,}
 179 @downloadStableFreeBSDNormal
 180
 181 @item
 182 @sourceimage{logo-freebsd,,,}
 183 @downloadStableFreeBSDBig
 184
 185 @end itemize
 186
 187
 188 @subsubheading Install
 189
 190 In the shell, type:
 191
 192 @example
 193 cd PATH-TO-DOWNLOAD-DIRECTORY
 194 sh lilypond-@versionStable{}-OS-TYPE.sh
 195 @end example
 196
 197 @subsubheading Uninstall
 198
 199 In the shell, type:
 200
 201 @example
 202 uninstall-lilypond
 203 @end example
 204
 205 @divEnd
 206
 207
 208 @divClass{column-right-top}
 209 @subheading Distribution-specific Packages
 210
 211 Please use your distribution's package manager to install or
 212 upgrade to these versions.
 213
 214 @itemize
 215
 216 @item
 217 @sourceimage{logo-fedora,,,}
 218 @uref{http://koji.fedoraproject.org/koji/packageinfo?packageID=2447,
 219 Fedora: LilyPond 2.12.3}
 220
 221 @item
 222 @sourceimage{logo-ubuntu,,,}
 223 @uref{http://packages.ubuntu.com/search?keywords=lilypond,
 224 Ubuntu: LilyPond 2.12.2}
 225
 226 @item
 227 @sourceimage{logo-slackware,,,}
 228 @uref{http://www.johannes-schoepfer.de/lilypond/,
 229 Slackware: LilyPond 2.12.3}
 230
 231 @item
 232 @sourceimage{logo-debian,,,}
 233 @uref{http://packages.debian.org/search?keywords=lilypond,
 234 Debian: LilyPond 2.12.2}
 235
 236 @item
 237 @sourceimage{logo-suse,,,}
 238 @uref{http://software.opensuse.org/search?baseproject=openSUSE%3A11.2&p=1&q=lilypond,
 239 openSUSE: LilyPond 2.12.3}
 240
 241 @end itemize
 242
 243 @divEnd
 244
 245
 246 @divClass{column-center-bottom}
 247 @subheading Legalese
 248
 249 @divClass{legal}
 250 All logos and product images are copyright and trademark
 251 acknowledged.
 252
 253 @logoLegalLinux
 254
 255 @logoLegalFreeBSD
 256
 257 @divEnd
 258 @divEnd
 259
 260
 261 @node MacOS X
 262 @unnumberedsec MacOS X
 263
 264 @divClass{heading-center}
 265 @warningTextBased
 266 @divEnd
 267
 268 @divClass{column-left-top}
 269 @subheading Packages
 270
 271 @subsubheading Download
 272
 273 @itemize
 274
 275 @item
 276 @sourceimage{logo-macosx,,,}
 277 @downloadStableDarwinNormal
 278 For Intel chips (if in doubt, use this).
 279
 280 @item
 281 @sourceimage{logo-macosx,,,}
 282 @downloadStableDarwinPPC
 283 For G3 and G4 CPUs (old Apple computers).
 284
 285 @end itemize
 286
 287 @subsubheading Install
 288
 289 Double-click the downloaded file, then drag it to wherever you
 290 want.
 291
 292 @subsubheading Uninstall
 293
 294 Delete the LilyPond.app folder.
 295
 296 @divEnd
 297
 298
 299 @divClass{column-right-top}
 300 @subheading Running on the command-line
 301
 302 @warning{If you are happy with the GUI, then please ignore these
 303 instructions.}
 304
 305 @subsubheading MacOS X on the command line
 306
 307 The most convenient way to run lilypond scripts is by setting up
 308 @qq{helper} scripts of your own.
 309
 310 @enumerate
 311
 312 @item
 313 Create a directory to store these scripts,
 314
 315 @example
 316 mkdir -p ~/bin
 317 cd ~/bin
 318 @end example
 319
 320
 321 @item
 322 Create a file called @command{lilypond} which contains
 323
 324 @help obvious css issue to be dealt with.  :(
 325 @c we need a small font here to fit.  -gp
 326 @smallexample
 327 exec @var{DIR}/LilyPond.app/Contents/Resources/bin/lilypond "$@@"
 328 @end smallexample
 329
 330 @warning{@var{DIR} will generally be @code{/Applications/}}
 331
 332
 333 @item
 334 Create similar files @command{lilypond-book},
 335 @command{convert-ly}, and any other scripts you wish to use, by
 336 replacing the @command{bin/lilypond} with @command{bin/convert-ly}
 337 (or other program name).
 338
 339
 340 @item
 341 Make the file executable,
 342
 343 @example
 344 chmod u+x lilypond
 345 @end example
 346
 347
 348 @item
 349 Now, add this directory to your path.  Modify (or create) a file
 350 called @code{.profile} in your home directory such that it
 351 contains
 352
 353 @example
 354 export PATH=$PATH:~/bin
 355 @end example
 356
 357 This file should end with a blank line.
 358
 359 @end enumerate
 360
 361
 362 @subsubheading Invoking individual scripts
 363
 364 The scripts --- such as @command{lilypond-book}, @command{convert-ly},
 365 @command{abc2ly}, and even @command{lilypond} itself --- are included
 366 inside the @code{.app} file for MacOS@tie{}X.
 367
 368 Scripts can also be run from the command line by invoking them
 369 directly:
 370
 371 @example
 372 @var{path/to}/LilyPond.app/Contents/Resources/bin/lilypond
 373 @end example
 374
 375 The same is true for all other scripts in that directory, such as
 376 @command{lilypond-book} and @command{convert-ly}.
 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 ME, NT, 2000, XP, Vista, and Windows 7.
 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 witin 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, then please ignore these
 454 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:\Program Files}.}
 485
 486 @noindent
 487 and click @qq{OK} button to close the window.
 488
 489 @end enumerate
 490
 491 @subsubheading Invoking individual excecutable files
 492
 493 LilyPond excecutable 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-bottom}
 505 @subheading Legalese
 506
 507 @divClass{legal}
 508 All logos and product images are copyright and trademark
 509 acknowledged.
 510
 511 @logoLegalWindows
 512
 513 @divEnd
 514 @divEnd
 515
 516
 517
 518 @node Source
 519 @unnumberedsec Source
 520
 521 @divClass{heading-center}
 522 @warningTextBased
 523 @divEnd
 524
 525 @warning{We @strong{do not} recommend that you attempt to build
 526 LilyPond yourself; almost all user needs are better met with the
 527 pre-built version.}
 528
 529 @divClass{column-left-bottom}
 530 @subheading Source tarball
 531
 532 @downloadStableSource{}
 533
 534 For an extensive listing of all versions (old and new), see our
 535 @uref{http://download.linuxaudio.org/lilypond/source/?C=N;O=D,
 536 download site}.
 537
 538 @divEnd
 539
 540 @divClass{column-right-bottom}
 541 @subheading Compiling instructions
 542
 543 Instructions are listed in @rcontrib{Compiling LilyPond}.
 544
 545 @divEnd
 546
 547
 548 @node Old downloads
 549 @unnumberedsec Old downloads
 550
 551 @divClass{heading-center}
 552 @warningTextBased
 553 @divEnd
 554
 555 @divClass{column-center-top}
 556 @subheading All versions
 557
 558 For an extensive listing of all versions (old and new), see our
 559 @uref{http://download.linuxaudio.org/lilypond/binaries/, download
 560 site}.
 561
 562 @divEnd
 563
 564
 565 @node GPL
 566 @unnumberedsec GPL
 567
 568 @divClass{column-center-top}
 569 @subheading Software license
 570
 571 GNU LilyPond is published under the GNU General Public License.
 572 An introduction to this license, and our reasons for choosing it,
 573 is given in @ref{Freedom}.
 574
 575 @divEnd
 576
 577 @divClass{column-center-bottom}
 578 @subheading GNU General Public License
 579
 580 @include gpl.itexi
 581
 582 @divEnd
 583
 584
 585