Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code | Sign in
(340)

Delta Between Two Patch Sets: Documentation/usage/running.itely

Issue 5843060: Doc: AU - document -dhelp CLI options (Closed)
Left Patch Set: Created 12 years ago
Right Patch Set: applies to current master Created 12 years ago
Left:
Right:
Use n/p to move between diff chunks; N/P to move between comments. Please Sign in to add in-line comments.
Jump to:
Left: Side by side diff | Download
Right: Side by side diff | Download
« no previous file with change/comment | « no previous file | no next file » | no next file with change/comment »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
LEFTRIGHT
1 @c -*- coding: utf-8; mode: texinfo; -*- 1 @c -*- coding: utf-8; mode: texinfo; -*-
2 2
3 @ignore 3 @ignore
4 Translation of GIT committish: FILL-IN-HEAD-COMMITTISH 4 Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
5 5
6 When revising a translation, copy the HEAD committish of the 6 When revising a translation, copy the HEAD committish of the
7 version that you are working on. For details, see the Contributors' 7 version that you are working on. For details, see the Contributors'
8 Guide, node Updating translation committishes.. 8 Guide, node Updating translation committishes..
9 @end ignore 9 @end ignore
10 10
(...skipping 35 matching lines...) Expand 10 before | Expand all | Expand 10 after
46 @q{command shell}. MacOS@tie{}X users might be more familiar with the terms 46 @q{command shell}. MacOS@tie{}X users might be more familiar with the terms
47 @q{terminal} or @q{console}. Some additional setup is required 47 @q{terminal} or @q{console}. Some additional setup is required
48 for MacOS@tie{}X users; please see @rweb{MacOS X}. 48 for MacOS@tie{}X users; please see @rweb{MacOS X}.
49 49
50 Describing how to use this part of an operating system is outside the 50 Describing how to use this part of an operating system is outside the
51 scope of this manual; please consult other documentation on this topic 51 scope of this manual; please consult other documentation on this topic
52 if you are unfamiliar with the command-line. 52 if you are unfamiliar with the command-line.
53 53
54 @menu 54 @menu
55 * Invoking lilypond:: 55 * Invoking lilypond::
56 * Basic command line options for lilypond:: 56 * Basic command line options for lilypond::
Graham Percival 2012/03/19 02:03:46 how about: Command-line options with --help Comma
pkx166h 2012/03/20 07:55:13 Made it simpler - I used 'Basic' and 'Advanced' co
57 * Command line options using scheme values:: 57 * Advanced command line options for LilyPond::
58 * Environment variables:: 58 * Environment variables::
59 * LilyPond in chroot jail:: 59 * LilyPond in chroot jail::
60 @end menu 60 @end menu
61 61
62 @node Invoking lilypond 62 @node Invoking lilypond
63 @unnumberedsubsec Invoking @command{lilypond} 63 @unnumberedsubsec Invoking @command{lilypond}
64 64
65 The @command{lilypond} executable may be called as follows from 65 The @command{lilypond} executable may be called as follows from
66 the command line. 66 the command line.
67 67
(...skipping 60 matching lines...) Expand 10 before | Expand all | Expand 10 after
128 @cindex Invoking @command{lilypond} 128 @cindex Invoking @command{lilypond}
129 @cindex command line options for @command{lilypond} 129 @cindex command line options for @command{lilypond}
130 @cindex options, command line 130 @cindex options, command line
131 @cindex switches 131 @cindex switches
132 132
133 The following options are supported: 133 The following options are supported:
134 134
135 @table @code 135 @table @code
136 136
137 @item -d,--define-default=@var{var}=@var{val} 137 @item -d,--define-default=@var{var}=@var{val}
138 See @ref{Command line options using scheme values}. 138 See @ref{Advanced command line options for LilyPond}.
139 139
140 @cindex Scheme, expression evaluation 140 @cindex Scheme, expression evaluation
141 @cindex expression evaluation, Scheme 141 @cindex expression evaluation, Scheme
142 142
143 @item -e,--evaluate=@var{expr} 143 @item -e,--evaluate=@var{expr}
144 Evaluate the Scheme @var{expr} before parsing any @file{.ly} files. 144 Evaluate the Scheme @var{expr} before parsing any @file{.ly} files.
145 Multiple @option{-e} options may be given, they will be evaluated 145 Multiple @option{-e} options may be given, they will be evaluated
146 sequentially. 146 sequentially.
147 147
148 The expression will be evaluated in the @code{guile-user} module, so 148 The expression will be evaluated in the @code{guile-user} module, so
(...skipping 42 matching lines...) Expand 10 before | Expand all | Expand 10 after
191 Multiple -I options may be given. The search will start in the first 191 Multiple -I options may be given. The search will start in the first
192 defined directory, and if the file to be included is not found the 192 defined directory, and if the file to be included is not found the
193 search will continue in subsequent directories. 193 search will continue in subsequent directories.
194 194
195 @cindex chroot jail, running inside 195 @cindex chroot jail, running inside
196 196
197 @item -j,--jail=@var{user},@var{group},@var{jail},@var{dir} 197 @item -j,--jail=@var{user},@var{group},@var{jail},@var{dir}
198 Run @command{lilypond} in a chroot jail. 198 Run @command{lilypond} in a chroot jail.
199 199
200 The @option{--jail} option provides a more flexible alternative to 200 The @option{--jail} option provides a more flexible alternative to
201 @option{-dsafe}, see @ref{Command line options using scheme values} 201 @option{-dsafe}, when LilyPond formatting is being provided via a web
Graham Percival 2012/03/19 02:03:46 @ref should come at the end of a sentence, or at l
pkx166h 2012/03/20 07:55:13 Done.
202 when LilyPond formatting is being provided via a web server, or whenever 202 server, or whenever LilyPond executes commands sent by external sources
203 LilyPond executes commands sent by external sources. 203 (see @ref{Advanced command line options for LilyPond}).
204 204
205 It works by changing the root of @command{lilypond} to @var{jail} just 205 It works by changing the root of @command{lilypond} to @var{jail} just
206 before starting the actual compilation process. The user and group are 206 before starting the actual compilation process. The user and group are
207 then changed to match those provided, and the current directory is 207 then changed to match those provided, and the current directory is
208 changed to @var{dir}. This setup guarantees that it is not possible (at 208 changed to @var{dir}. This setup guarantees that it is not possible (at
209 least in theory) to escape from the jail. Note that for @option{--jail} 209 least in theory) to escape from the jail. Note that for @option{--jail}
210 to work, @command{lilypond} must be run as root, which is usually 210 to work, @command{lilypond} must be run as root, which is usually
211 accomplished in a safe way using @command{sudo}. 211 accomplished in a safe way using @command{sudo}.
212 212
213 Setting up a jail can be a relatively complex matter, as we must be sure 213 Setting up a jail can be a relatively complex matter, as we must be sure
(...skipping 112 matching lines...) Expand 10 before | Expand all | Expand 10 after
326 Be verbose: show full paths of all files read, and give timing 326 Be verbose: show full paths of all files read, and give timing
327 information. 327 information.
328 328
329 @item -w,--warranty 329 @item -w,--warranty
330 Show the warranty with which GNU LilyPond comes. (It comes with 330 Show the warranty with which GNU LilyPond comes. (It comes with
331 @strong{NO WARRANTY}!) 331 @strong{NO WARRANTY}!)
332 332
333 @end table 333 @end table
334 334
335 335
336 @node Command line options using scheme values 336 @node Advanced command line options for LilyPond
337 @unnumberedsubsec Command line options using scheme values 337 @unnumberedsubsec Advanced command line options for LilyPond
338 338
339 @table @code 339 @table @code
340 340
341 @item -d@var{symbol}=@var{value},--define-default=@var{symbol}=@var{value} 341 @item -d@var{[option-name]}=@var{[value]},--define-default=@var{[option-name]}=@ var{[value]}
342 This sets the internal Scheme @var{symbol} to the value @var{value}. If 342 This sets the equivalent internal Scheme function to @var{value}. If a
343 @var{value} is not supplied, then the default value is used. The prefix 343 @var{value} is not supplied, then the default value is used. The prefix
344 @code{no-} may be added to @var{symbol} to switch @emph{off} an option, 344 @code{no-} may be added to @var{option-name} to switch @q{off} an
345 e.g. 345 option, e.g.
346 346
347 @cindex point and click, command line 347 @cindex point and click, command line
348 348
349 @example 349 @example
350 -dpoint-and-click=#f 350 -dpoint-and-click=#f
351 @end example 351 @end example
352 352
353 @noindent 353 @noindent
354 is the same as 354 is the same as
355 @example 355 @example
(...skipping 709 matching lines...) Expand 10 before | Expand all | Expand 10 after
1065 messages can be avoided by making one of the contexts behave as a 1065 messages can be avoided by making one of the contexts behave as a
1066 staff by inserting 1066 staff by inserting
1067 1067
1068 @example 1068 @example
1069 \override VerticalAxisGroup #'staff-affinity = ##f 1069 \override VerticalAxisGroup #'staff-affinity = ##f
1070 @end example 1070 @end example
1071 1071
1072 @noindent 1072 @noindent
1073 at its start. For details, see @qq{Spacing of non-staff lines} in 1073 at its start. For details, see @qq{Spacing of non-staff lines} in
1074 @ruser{Flexible vertical spacing within systems}. 1074 @ruser{Flexible vertical spacing within systems}.
LEFTRIGHT
« no previous file | no next file » | Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Toggle Comments ('s')

Powered by Google App Engine
RSS Feeds Recent Issues | This issue
This is Rietveld f62528b