]> git.donarmstrong.com Git - lilypond.git/commitdiff
doc -dbackend convention. Doc other --foo -> -dfoo changes.
authorHan-Wen Nienhuys <hanwen@xs4all.nl>
Sun, 4 Feb 2007 22:35:19 +0000 (23:35 +0100)
committerHan-Wen Nienhuys <hanwen@xs4all.nl>
Sun, 4 Feb 2007 22:35:19 +0000 (23:35 +0100)
Documentation/topdocs/NEWS.tely
Documentation/user/running.itely

index bf7dc699d5c3e72accd1976d710d2e7dc0fdd740..2387c9250eaf45b0720d871e378d126bf61d966b 100644 (file)
@@ -65,6 +65,13 @@ which scares away people.
 
 @end ignore
 
+@item
+The backend is now switched with the @code{-d} option, e.g.,
+@example
+lilypond -dbackend=svg input-file.ly
+@end example
+
+
 @item
 Improved testing procedure now catch changes in CPU and memory
 performance, page layout, MIDI results and warnings.  This helps to
index e6ed8fa9044a8f6d328a2b0055b3a73a3126b27f..dbf5e5d53d475186d6544d9b618d8a2dacef5c20 100644 (file)
@@ -99,7 +99,81 @@ which formats should be written.  Choices for @code{format} are
 
 Example: @code{lilypond -fpng filename.ly}
 
-@item -b,--backend=@var{format}
+
+
+@item -d,--define-default=@var{var}=@var{val}
+This sets the internal program option @var{var} to the Scheme value
+@var{val}. If @var{val} is not supplied, then @var{#t} is used. To
+switch off an option, @code{no-} may be prefixed to @var{var}, e.g.
+
+@cindex point and click, command line
+
+@example
+-dno-point-and-click
+@end example
+
+@noindent
+is the same as
+@example
+-dpoint-and-click='#f'
+@end example
+
+Here are a few interesting options.
+
+@table @samp
+@item help
+Running @code{lilypond -dhelp} will print all of the @code{-d} options
+available.
+
+@item paper-size
+This option sets the default paper-size, 
+@example
+-dpaper-size=\"letter\"
+@end example
+
+@noindent
+Note that the string must be enclosed in escaped quotes ( @code{\"} ).
+
+
+@item safe
+Do not trust the @code{.ly} input.
+
+When LilyPond formatting is available through a web server, either the
+@code{--safe} or the @code{--jail} option @b{MUST} be passed.  The
+@code{--safe} option will prevent inline Scheme code from wreaking
+havoc, for example
+
+@quotation
+@verbatim
+#(system "rm -rf /")
+{
+  c4^#(ly:export (ly:gulp-file "/etc/passwd"))
+}
+@end verbatim
+@end quotation
+
+The @code{-dsafe} option works by evaluating in-line Scheme
+expressions in a special safe module.  This safe module is derived from
+GUILE @file{safe-r5rs} module, but adds a number of functions of the
+LilyPond API.  These functions are listed in @file{scm/@/safe@/-lily@/.scm}.
+
+In addition, safe mode disallows @code{\include} directives and
+disables the use of backslashes in @TeX{} strings.
+
+In safe mode, it is not possible to import LilyPond variables
+into Scheme.
+
+safe does @emph{not} detect resource overuse.  It is still possible to
+make the program hang indefinitely, for example by feeding cyclic data
+structures into the backend.  Therefore, if using LilyPond on a
+publicly accessible webserver, the process should be limited in both
+CPU and memory usage.
+
+The safe mode will prevent many useful LilyPond snippets from being
+compiled.  The @code{--jail} is a more secure alternative, but
+requires more work to set up.
+
+@item backend
 the output format to use for the back-end.  Choices for @code{format} are
 @table @code
 @item tex
@@ -139,38 +213,12 @@ This mode is used by default by lilypond-book.
 @cindex Scheme dump
 @end table
 
-Example: @code{lilypond -bsvg filename.ly}
+Example: @code{lilypond -dbackend=svg filename.ly}
 
 @cindex output format, setting
+@end table
 
-@item -d,--define-default=@var{var}=@var{val}
-This sets the internal program option @var{var} to the Scheme value
-@var{val}. If @var{val} is not supplied, then @var{#t} is used. To
-switch off an option, @code{no-} may be prefixed to @var{var}, e.g.
-
-@cindex point and click, command line
-
-@example
--dno-point-and-click
-@end example
-
-@noindent
-is the same as
-@example
--dpoint-and-click='#f'
-@end example
-
-Another notable option is
-
-@example
--dpaper-size=\"letter\"
-@end example
-
-@noindent
-Note that the string must be enclosed in escaped quotes ( @code{\"} ).
 
-Setting the @code{-dhelp} option will print a summary of the options
-available, and exit.
 
 @item -h,--help
 Show a summary of usage.
@@ -215,44 +263,6 @@ Generate an output file containing the titles and the first system
 Do not generate the full pages.  Useful in combination with
 @code{--preview}.
 
-@item -s,--safe
-Do not trust the @code{.ly} input.
-
-When LilyPond formatting is available through a web server, either the
-@code{--safe} or the @code{--jail} option @b{MUST} be passed.  The
-@code{--safe} option will prevent inline Scheme code from wreaking
-havoc, for example
-
-@quotation
-@verbatim
-#(system "rm -rf /")
-{
-  c4^#(ly:export (ly:gulp-file "/etc/passwd"))
-}
-@end verbatim
-@end quotation
-
-The @code{--safe} option works by evaluating in-line Scheme
-expressions in a special safe module.  This safe module is derived from
-GUILE @file{safe-r5rs} module, but adds a number of functions of the
-LilyPond API.  These functions are listed in @file{scm/@/safe@/-lily@/.scm}.
-
-In addition, @code{--safe} disallows @code{\include} directives and
-disables the use of backslashes in @TeX{} strings.
-
-In @code{--safe} mode, it is not possible to import LilyPond variables
-into Scheme.
-
-@code{--safe} does @emph{not} detect resource overuse.  It is still
-possible to make the program hang indefinitely, for example by feeding
-cyclic data structures into the backend.  Therefore, if using LilyPond
-on a publicly accessible webserver, the process should be limited in
-both CPU and memory usage.
-
-Note that @code{--safe} will prevent many useful LilyPond snippets from
-being compiled.  For a softer but secure alternative you can use the
-@code{--jail} option.
-
 
 @item -j,--jail=@var{user},@var{group},@var{jail},@var{dir}
 Run LilyPond in a chroot jail.