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.
13 This chapter discusses various post-install configuration options for
14 LilyPond and various other programs. This chapter may be safely treated
15 as a reference: only read a section if it applies to you.
18 * Setup for specific Operating Systems::
19 * Text editor support::
24 @node Setup for specific Operating Systems
25 @section Setup for specific Operating Systems
27 This section explains how to perform additional setup for specific
31 * MacOS X on the command-line::
35 @node MacOS X on the command-line
36 @subsection MacOS X on the command-line
38 The scripts (such as lilypond-book, convert-ly, abc2ly, and even
39 lilypond itself) are included inside the .app file for MacOS@tie{}X. They can be run from
40 the command line by invoking them directly, e.g.
43 @var{path/to}/LilyPond.app/Contents/Resources/bin/lilypond
47 The same is true of the other scripts in that directory, including
48 lilypond-book, convert-ly, abc2ly, etc.
50 Alternatively, you may create scripts which add the path
51 automatically. Create a directory to store these scripts,
58 Create a file called @code{lilypond} which contains
61 exec @var{path/to}/LilyPond.app/Contents/Resources/bin/lilypond "$@@"
64 Create similar files @code{lilypond-book}, @code{convert-ly}, and
65 any other helper programs you use (@code{abc2ly}, @code{midi2ly},
66 etc). Simply replace the @code{bin/lilypond} with
67 @code{bin/convert-ly} (or other program name) in the above file.
69 Make the file executable,
75 Now, add this directory to your path. Modify (or create)
76 a file called @code{.profile} in your home directory such that it contains
79 export PATH=$PATH:~/bin
83 This file should end with a blank line.
85 Note that @var{path/to} will generally be @code{/Applications/}.
88 @node Text editor support
89 @section Text editor support
95 @cindex syntax coloring
96 @cindex coloring, syntax
98 There is support from different text editors for LilyPond.
109 @subsection Emacs mode
111 Emacs has a @file{lilypond-mode}, which provides keyword
112 autocompletion, indentation, LilyPond specific parenthesis matching
113 and syntax coloring, handy compile short-cuts and reading LilyPond
114 manuals using Info. If @file{lilypond-mode} is not installed on your
117 An Emacs mode for entering music and running LilyPond is contained in
118 the source archive in the @file{elisp} directory. Do @command{make
119 install} to install it to @var{elispdir}. The file @file{lilypond-init.el}
120 should be placed to @var{load-path}@file{/site-start.d/} or appended
121 to your @file{~/.emacs} or @file{~/.emacs.el}.
123 As a user, you may want add your source path (e.g. @file{~/site-lisp/}) to
124 your @var{load-path} by appending the following line (as modified) to your
127 @c any reason we do not advise: (push "~/site-lisp" load-path)
129 (setq load-path (append (list (expand-file-name "~/site-lisp")) load-path))
136 For @uref{http://@/www@/.vim@/.org,VIM}, a @file{vimrc} is supplied,
137 along with syntax coloring tools. A Vim mode for entering music and
138 running LilyPond is contained in the source archive in @code{$VIM}
141 The LilyPond file type is detected if the file
142 @file{~/.vim/filetype.vim} has the following content
145 if exists("did_load_filetypes")
148 augroup filetypedetect
149 au! BufNewFile,BufRead *.ly setf lilypond
153 Please include this path by appending the following line to your
157 set runtimepath+=/usr/local/share/lilypond/$@{LILYPOND_VERSION@}/vim/
161 where $@{LILYPOND_VERSION@} is your LilyPond version. If LilyPond was not
162 installed in @file{/usr/local/}, then change this path accordingly.
168 Created as a plugin for the @uref{http://@/www@/.jedit@/.org@/,jEdit}
169 text editor, LilyPondTool is the most feature-rich text-based tool for
170 editing LilyPond scores. Its features include a Document Wizard with
171 lyrics support to set up documents easier, and embedded PDF viewer with
172 advanced point-and-click support. For screenshots, demos and
173 installation instructions, visit
174 @uref{http://lilypondtool@/.organum@/.hu}
180 The @uref{http://@/www@/.uoregon@/.edu/~koch/texshop/index@/.html,TexShop}
181 editor for MacOS@tie{}X can be extended to run LilyPond, lilypond-book and
182 convert-ly from within the editor, using the extensions available at
183 @uref{http://@/www@/.dimi@/.uniud@/.it/vitacolo/freesoftware@/.html}.
189 There is a LilyPond bundle for TextMate. It may be installed by running
192 mkdir -p /Library/Application\ Support/TextMate/Bundles
193 cd /Library/Application\ Support/TextMate/Bundles
194 svn co http://macromates.com/svn/Bundles/trunk/Bundles/Lilypond.tmbundle/
199 @node Point and click
200 @section Point and click
201 @cindex point and click
204 Point and click lets you find notes in the input by clicking on them
205 in the PDF viewer. This makes it easier to find input that causes
206 some error in the sheet music.
208 When this functionality is active, LilyPond adds hyperlinks to the PDF
209 file. These hyperlinks are sent to the web-browser, which opens a
210 text-editor with the cursor in the right place.
212 To make this chain work, you should configure your PDF viewer to
213 follow hyperlinks using the @file{lilypond-invoke-editor} script
214 supplied with LilyPond.
216 For Xpdf on UNIX, the following should be present in
217 @file{xpdfrc}@footnote{On UNIX, this file is found either in
218 @file{/etc/xpdfrc} or as @file{.xpdfrc} in your home directory.}
221 urlCommand "lilypond-invoke-editor %s"
224 The program @file{lilypond-invoke-editor} is a small helper
225 program. It will invoke an editor for the special @code{textedit}
226 URIs, and run a web browser for others. It tests the environment
227 variable @code{EDITOR} for the following patterns,
233 emacsclient --no-wait +@var{line}:@var{column} @var{file}
238 gvim --remote +:@var{line}:norm@var{char} @var{file}
244 nc -noask +@var{line} @var{file}'
248 The environment variable @code{LYEDITOR} is used to override this. It
249 contains the command line to start the editor, where @code{%(file)s},
250 @code{%(column)s}, @code{%(line)s} is replaced with the file, column
251 and line respectively. The setting
254 emacsclient --no-wait +%(line)s:%(column)s %(file)s
258 for @code{LYEDITOR} is equivalent to the standard emacsclient
262 @cindex file size, output
264 The point and click links enlarge the output files significantly. For
265 reducing the size of PDF and PS files, point and click may be switched
269 #(ly:set-option 'point-and-click #f)
273 in a @file{.ly} file. Alternately, you may pass this as an command-line
277 lilypond -dno-point-and-click file.ly