1 @c -*- coding: utf-8; mode: texinfo; -*-
2 @c This file is part of lilypond-program.tely
4 Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
6 When revising a translation, copy the HEAD committish of the
7 version that you are working on. See TRANSLATION for details.
15 This chapter discusses various post-install configuration options for
16 LilyPond and various other programs. This chapter may be safely treated
17 as a reference: only read a section if it applies to you.
20 * Setup for specific Operating Systems::
21 * Text editor support::
26 @node Setup for specific Operating Systems
27 @section Setup for specific Operating Systems
29 This section explains how to perform additional setup for specific
33 * MacOS X on the command-line::
37 @node MacOS X on the command-line
38 @subsection MacOS X on the command-line
40 The scripts (such as lilypond-book, convert-ly, abc2ly, and even
41 lilypond itself) are included inside the .app file for MacOS@tie{}X. They can be run from
42 the command line by invoking them directly, e.g.
45 @var{path/to}/LilyPond.app/Contents/Resources/bin/lilypond
49 The same is true of the other scripts in that directory, including
50 lilypond-book, convert-ly, abc2ly, etc.
52 Alternatively, you may create scripts which add the path
53 automatically. Create a directory to store these scripts,
60 Create a file called @code{lilypond} which contains
63 exec @var{path/to}/LilyPond.app/Contents/Resources/bin/lilypond "$@@"
66 Create similar files @code{lilypond-book}, @code{convert-ly}, and
67 any other helper programs you use (@code{abc2ly}, @code{midi2ly},
68 etc). Simply replace the @code{bin/lilypond} with
69 @code{bin/convert-ly} (or other program name) in the above file.
71 Make the file executable,
77 Now, add this directory to your path. Modify (or create)
78 a file called @code{.profile} in your home directory such that it contains
81 export PATH=$PATH:~/bin
85 This file should end with a blank line.
87 Note that @var{path/to} will generally be @code{/Applications/}.
90 @node Text editor support
91 @section Text editor support
97 @cindex syntax coloring
98 @cindex coloring, syntax
100 There is support from different text editors for LilyPond.
112 @subsection Emacs mode
114 Emacs has a @file{lilypond-mode}, which provides keyword
115 autocompletion, indentation, LilyPond specific parenthesis matching
116 and syntax coloring, handy compile short-cuts and reading LilyPond
117 manuals using Info. If @file{lilypond-mode} is not installed on your
120 An Emacs mode for entering music and running LilyPond is contained in
121 the source archive in the @file{elisp} directory. Do @command{make
122 install} to install it to @var{elispdir}. The file @file{lilypond-init.el}
123 should be placed to @var{load-path}@file{/site-start.d/} or appended
124 to your @file{~/.emacs} or @file{~/.emacs.el}.
126 As a user, you may want add your source path (e.g. @file{~/site-lisp/}) to
127 your @var{load-path} by appending the following line (as modified) to your
130 @c any reason we do not advise: (push "~/site-lisp" load-path)
132 (setq load-path (append (list (expand-file-name "~/site-lisp")) load-path))
139 For @uref{http://@/www@/.vim@/.org,VIM}, a @file{vimrc} is supplied,
140 along with syntax coloring tools. A Vim mode for entering music and
141 running LilyPond is contained in the source archive in @code{$VIM}
144 The LilyPond file type is detected if the file
145 @file{~/.vim/filetype.vim} has the following content
148 if exists("did_load_filetypes")
151 augroup filetypedetect
152 au! BufNewFile,BufRead *.ly setf lilypond
156 Please include this path by appending the following line to your
160 set runtimepath+=/usr/local/share/lilypond/$@{LILYPOND_VERSION@}/vim/
164 where $@{LILYPOND_VERSION@} is your LilyPond version. If LilyPond was not
165 installed in @file{/usr/local/}, then change this path accordingly.
171 Created as a plugin for the @uref{http://@/www@/.jedit@/.org@/,jEdit}
172 text editor, LilyPondTool is the most feature-rich text-based tool for
173 editing LilyPond scores. Its features include a Document Wizard with
174 lyrics support to set up documents easier, and embedded PDF viewer with
175 advanced point-and-click support. For screenshots, demos and
176 installation instructions, visit
177 @uref{http://lilypondtool@/.organum@/.hu}
183 The @uref{http://@/www@/.uoregon@/.edu/~koch/texshop/index@/.html,TexShop}
184 editor for MacOS@tie{}X can be extended to run LilyPond, lilypond-book and
185 convert-ly from within the editor, using the extensions available at
186 @uref{http://@/www@/.dimi@/.uniud@/.it/vitacolo/freesoftware@/.html}.
192 There is a LilyPond bundle for TextMate. It may be installed by running
195 mkdir -p /Library/Application\ Support/TextMate/Bundles
196 cd /Library/Application\ Support/TextMate/Bundles
197 svn co http://macromates.com/svn/Bundles/trunk/Bundles/Lilypond.tmbundle/
204 @uref{http://lilykde.googlecode.com/,LilyKDE} is a plugin for KDE's
205 text editor @uref{http://kate-editor.org/,Kate}. It has a powerful Score
206 Wizard to quickly setup a LilyPond document and an embedded PDF viewer.
208 LilyKDE can use @uref{http://www.volny.cz/smilauer/rumor/,Rumor},
209 so music can entered by playing on a MIDI keyboard.
211 Other features are lyric hyphenation and running LilyPond on multiple files
212 at once from within the KDE file manager.
215 @node Point and click
216 @section Point and click
217 @cindex point and click
220 Point and click lets you find notes in the input by clicking on them
221 in the PDF viewer. This makes it easier to find input that causes
222 some error in the sheet music.
224 When this functionality is active, LilyPond adds hyperlinks to the PDF
225 file. These hyperlinks are sent to the web-browser, which opens a
226 text-editor with the cursor in the right place.
228 To make this chain work, you should configure your PDF viewer to
229 follow hyperlinks using the @file{lilypond-invoke-editor} script
230 supplied with LilyPond.
232 For Xpdf on UNIX, the following should be present in
233 @file{xpdfrc}@footnote{On UNIX, this file is found either in
234 @file{/etc/xpdfrc} or as @file{.xpdfrc} in your home directory.}
237 urlCommand "lilypond-invoke-editor %s"
240 The program @file{lilypond-invoke-editor} is a small helper
241 program. It will invoke an editor for the special @code{textedit}
242 URIs, and run a web browser for others. It tests the environment
243 variable @code{EDITOR} for the following patterns,
249 emacsclient --no-wait +@var{line}:@var{column} @var{file}
254 gvim --remote +:@var{line}:norm@var{char} @var{file}
260 nc -noask +@var{line} @var{file}'
264 The environment variable @code{LYEDITOR} is used to override this. It
265 contains the command line to start the editor, where @code{%(file)s},
266 @code{%(column)s}, @code{%(line)s} is replaced with the file, column
267 and line respectively. The setting
270 emacsclient --no-wait +%(line)s:%(column)s %(file)s
274 for @code{LYEDITOR} is equivalent to the standard emacsclient
278 @cindex file size, output
280 The point and click links enlarge the output files significantly. For
281 reducing the size of PDF and PS files, point and click may be switched
285 #(ly:set-option 'point-and-click #f)
289 in a @file{.ly} file. Alternately, you may pass this as an command-line
293 lilypond -dno-point-and-click file.ly