From 9286f787be91edb65129fb9f6b7289c4815a4bda Mon Sep 17 00:00:00 2001 From: Graham Percival Date: Sun, 26 Aug 2007 22:17:20 -0700 Subject: [PATCH] First phase of program usage reorg: install and setup. --- Documentation/user/converters.itely | 13 +------------ Documentation/user/install.itely | 19 +++++++----------- Documentation/user/lilypond-book.itely | 3 +++ Documentation/user/running.itely | 27 +++++++++++++++++++++++++- Documentation/user/setup.itely | 27 ++++++++++++++++++-------- 5 files changed, 56 insertions(+), 33 deletions(-) diff --git a/Documentation/user/converters.itely b/Documentation/user/converters.itely index 2968d7fe00..13804252ce 100644 --- a/Documentation/user/converters.itely +++ b/Documentation/user/converters.itely @@ -17,18 +17,7 @@ sequencers and XML converters. Refer to the @uref{http://@/lilypond@/.org,website} for more details. These are separate programs from lilypond itself, and are run -on the command-line. By @q{command-line}, we mean the command -line in the operating system. Windows users -might be more familiar with the terms @q{DOS shell} or -@q{command shell}; OSX users might be more familiar with the -terms @q{terminal} or @q{console}. OSX users should also -consult @ref{Notes for the MacOS X app}. - -Describing how to use -this part of an operating system is outside the scope of this -manual; please consult other documentation on this topic if -you are unfamiliar with the command-line. - +on the command-line; see @ref{Command-line usage} for more information. @menu diff --git a/Documentation/user/install.itely b/Documentation/user/install.itely index 66c0281ef3..a273cf23d8 100644 --- a/Documentation/user/install.itely +++ b/Documentation/user/install.itely @@ -60,6 +60,12 @@ mingw @end example +@c TRANSLATORS: +@c Please **do not** translate anything below this line. Users +@c should not be compiling LilyPond themselves; if they really +@c want to do so, they should be able to read the English docs, +@c because they'll probably need to ask questions in English +@c on the -devel list. -gp @node Compiling from source @section Compiling from source @@ -263,7 +269,7 @@ From a fresh git checkout, do ./autogen.sh % ignore any warning messages cp GNUmakefile.in GNUmakefile make -C python -nice make LILYPOND_EXTERNAL_BINARY=~/Apps/LilyPond.app/Contents/Resources/bin/lilypond web +nice make LILYPOND_EXTERNAL_BINARY=/path/to/bin/lilypond web % change the lilypond directory as appropriate @end example @@ -344,17 +350,6 @@ $ make @end example -@unnumberedsubsubsec MacOS X - -For Fink, use the following command to compile. - -@verbatim -export GUILE=guile-1.6 -export GUILE_CONFIG=guile-1.6-config -export PKG_CONFIG_PATH=/sw/lib/freetype219/lib/pkgconfig/:/sw/lib/fontconfig2/lib/pkgconfig/ -./configure -@end verbatim - @unnumberedsubsubsec Solaris Solaris7, ./configure diff --git a/Documentation/user/lilypond-book.itely b/Documentation/user/lilypond-book.itely index 2cd9d52604..886e5284ee 100644 --- a/Documentation/user/lilypond-book.itely +++ b/Documentation/user/lilypond-book.itely @@ -35,6 +35,9 @@ program extracts snippets of music from your document, runs substituted for the music. The line width and font size definitions for the music are adjusted to match the layout of your document. +This is a separate programs from lilypond itself, and is run +on the command-line; see @ref{Command-line usage} for more information. + This procedure may be applied to @LaTeX{}, HTML, Texinfo or DocBook documents. @menu diff --git a/Documentation/user/running.itely b/Documentation/user/running.itely index 34eca21c20..a758131141 100644 --- a/Documentation/user/running.itely +++ b/Documentation/user/running.itely @@ -19,22 +19,47 @@ line in the operating system. Windows users might be more familiar with the terms @q{DOS shell} or @q{command shell}; OSX users might be more familiar with the terms @q{terminal} or @q{console}. OSX users should also -consult @ref{Notes for the MacOS X app}. +consult @ref{MacOS X on the command-line}. Describing how to use this part of an operating system is outside the scope of this manual; please consult other documentation on this topic if you are unfamiliar with the command-line. +These are separate programs from lilypond itself, and are run +on the command-line; see @ref{Command-line usage} for more information. + @menu +* Command-line usage:: * Invoking lilypond:: * Updating files with convert-ly:: * Reporting bugs:: * Error messages:: @end menu +@node Command-line usage +@section Command-line usage + +This section contains extra information for using LilyPond on the +command-line. This may be desirable to pass extra options to the +program. In addition, there are certain extra @q{helper} programs (such +as @code{midi2ly}) which are only available on the command-line. + +By @q{command-line}, we mean the command line in the operating system. +Windows users might be more familiar with the terms @q{DOS shell} or +@q{command shell}; OSX users might be more familiar with the terms +@q{terminal} or @q{console}. OSX users should also consult @ref{MacOS X +on the command-line}. + +Describing how to use this part of an operating system is outside the +scope of this manual; please consult other documentation on this topic +if you are unfamiliar with the command-line. + + + @node Invoking lilypond @section Invoking lilypond + @cindex Invoking LilyPond @cindex command line options @cindex options, command line diff --git a/Documentation/user/setup.itely b/Documentation/user/setup.itely index 6d7bca23aa..38d8f93b2b 100644 --- a/Documentation/user/setup.itely +++ b/Documentation/user/setup.itely @@ -10,23 +10,34 @@ @node Setup @chapter Setup -This chapter discusses how to set up LilyPond to integrate with various -programs. +This chapter discusses various post-install configuration options for +LilyPond and various other programs. This chapter may be safely treated +as a reference: only read a section if it applies to you. @menu -* Notes for the MacOS X app:: +* Setup for specific Operating Systems:: * Text editor support:: * Point and click:: @end menu -@node Notes for the MacOS X app -@section Notes for the MacOS X app +@node Setup for specific Operating Systems +@section Setup for specific Operating Systems + +This section explains how to perform additional setup for specific +operating systems. + +@menu +* MacOS X on the command-line:: +@end menu + + +@node MacOS X on the command-line +@subsection MacOS X on the command-line The scripts (such as lilypond-book, convert-ly, abc2ly, and even -lilypond itself) are also -included inside MacOS X .app. They can be run from the command line by -invoking them directly, e.g. +lilypond itself) are included inside MacOS X .app. They can be run from +the command line by invoking them directly, e.g. @example @var{path/to}/LilyPond.app/Contents/Resources/bin/lilypond -- 2.39.2