[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Doc: Canged @table example in Usage (issue 5492066)
From: |
pkx166h |
Subject: |
Doc: Canged @table example in Usage (issue 5492066) |
Date: |
Sat, 17 Dec 2011 13:11:26 +0000 |
Reviewers: ,
Message:
I'm deprecating this because of another Tracker Item that I can also add
in a single patch with this.
Description:
Doc: Canged @table example in Usage
In response to Tracker Item 2114
Application Usage 1.2
Changed the way the @table is formatted so that the single quotes are
removed.
Took some time to edit he linebreaks within the *.itely file so that
it follows the line lengths as per the CG.
Minor line spacing edits to make existing @cindex and @item enries
clearer to see in the source file for future editing
Please review this at http://codereview.appspot.com/5492066/
Affected files:
M Documentation/usage/running.itely
Index: Documentation/usage/running.itely
diff --git a/Documentation/usage/running.itely
b/Documentation/usage/running.itely
index
4abfcf09b13b677717081af5facce9cb36bb5fad..a1f178fd010ddacf97ee0e0455973b72b47fc545
100644
--- a/Documentation/usage/running.itely
+++ b/Documentation/usage/running.itely
@@ -180,11 +180,12 @@ is the same as
-dpoint-and-click='#f'
@end example
-Here are a few interesting options.
+The following options are supported:
@cindex help, command line
address@hidden @samp
address@hidden @code
+
@item help
Running @code{lilypond -dhelp} will print all of the @option{-d} options
available.
@@ -228,39 +229,44 @@ 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.
+In safe mode, it is not possible to import LilyPond variables into
+Scheme.
address@hidden 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.
address@hidden 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 @option{--jail} is a more secure alternative, but
requires more work to set up.
@cindex output format, setting
+
@item backend
-the output format to use for the back-end. Choices for @code{format} are
+the output format to use for the back-end. Choices for @code{format}
+are:
+
@table @code
@item ps
+
@cindex PostScript output
- for PostScript.
- Postscript files include TTF, Type1 and OTF fonts. No subsetting of
- these fonts is done. When using oriental character sets, this can
- lead to huge files.
+for PostScript.
+
+Postscript files include TTF, Type1 and OTF fonts. No subsetting of
+these fonts is done. When using oriental character sets, this can lead
+to huge files.
@item eps
@cindex Postscript, encapsulated
@cindex EPS (Encapsulated PostScript)
- for encapsulated PostScript. This dumps every page (system) as a separate
address@hidden file, without fonts, and as one collated @file{EPS} file with
-all pages (systems) including fonts.
+for encapsulated PostScript. This dumps every page (system) as a
+separate @file{EPS} file, without fonts, and as one collated @file{EPS}
+file with all pages (systems) including fonts.
This mode is used by default by @command{lilypond-book}.
@@ -268,36 +274,36 @@ This mode is used by default by
@command{lilypond-book}.
@cindex SVG (Scalable Vector Graphics)
- for SVG (Scalable Vector Graphics).
+for SVG (Scalable Vector Graphics).
- This creates a single SVG file, without embedded fonts, for every
- page of output. It is recommended to install the Century
- Schoolbook fonts, included with your LilyPond installation, for
- optimal rendering. Under UNIX, simply copy these fonts from the
- LilyPond directory (typically
- @file{/usr/share/lilypond/VERSION/fonts/otf/}) to
- @file{~/.fonts/}. The SVG output should be compatible with any
- SVG editor or user agent.
+This creates a single SVG file, without embedded fonts, for every page
+of output. It is recommended to install the Century Schoolbook fonts,
+included with your LilyPond installation, for optimal rendering. Under
+UNIX, simply copy these fonts from the LilyPond directory (typically
address@hidden/usr/share/lilypond/VERSION/fonts/otf/}) to @file{~/.fonts/}. The
+SVG output should be compatible with any SVG editor or user agent.
@item scm
@cindex Scheme dump
- for a dump of the raw, internal Scheme-based drawing commands.
+for a dump of the raw, internal Scheme-based drawing commands.
@item null
- do not output a printed score; has the same effect as
@option{-dno-print-pages}.
+do not output a printed score; has the same effect as
address@hidden
@end table
Example: @code{lilypond -dbackend=svg @var{filename}.ly}
@item preview
+
@cindex preview, command line
-Generate an output file containing the titles and the first system
-of music. If @code{\bookpart} blocks are used, the titles and
-first system of every @code{\bookpart} will appear in the output.
-The @code{ps}, @code{eps}, and @code{svg} backends support this
-option.
+
+Generate an output file containing the titles and the first system of
+music. If @code{\bookpart} blocks are used, the titles and first system
+of every @code{\bookpart} will appear in the output. The @code{ps},
address@hidden, and @code{svg} backends support this option.
@item gui
Runs silently and redirect all output to a log file.
@@ -308,15 +314,12 @@ does not and returns a prompt, with no progress
information, immediately
at the command line. The @option{-dgui} option can be used in this case
to redirect output to a log file.
-
@item print-pages
Generate the full pages, the default. @option{-dno-print-pages} is
useful in combination with @option{-dpreview}.
@end table
-
-
@item -h,--help
Show a summary of usage.
@@ -325,12 +328,13 @@ Dump a header field to file
@address@hidden
@cindex file searching
@cindex search path
+
@item --include, address@hidden
Add @var{directory} to the search path for input files.
-Multiple -I options may be given. The search will start in the
-first defined directory, and if the file to be included is not
-found the search will continue in subsequent directories.
+Multiple -I options may be given. The search will start in the first
+defined directory, and if the file to be included is not found the
+search will continue in subsequent directories.
@item -i,address@hidden
Set init file to @var{file} (default: @file{init.ly}).
@@ -339,8 +343,11 @@ Set init file to @var{file} (default: @file{init.ly}).
@cindex output verbosity, setting
@item -l,address@hidden
-Set the verbosity of the console output to @var{LEVEL}. Possible values
are:
+Set the verbosity of the console output to @var{LEVEL}. Possible values
+are:
+
@table @code
+
@item NONE
No output at all, not even error messages.
@@ -363,15 +370,14 @@ Progress messages, warnings, errors and further
execution information.
All possible messages, including verbose debug output.
@end table
-
@cindex folder, directing output to
@cindex output filename, setting
@item -o,address@hidden or @var{FOLDER}
-Set the default output file to @var{FILE} or, if a folder with
-that name exists, direct the output to @var{FOLDER}, taking the
-file name from the input file. The appropriate suffix will be
-added (e.g. @code{.pdf} for pdf) in both cases.
+Set the default output file to @var{FILE} or, if a folder with that name
+exists, direct the output to @var{FOLDER}, taking the file name from the
+input file. The appropriate suffix will be added (e.g. @code{.pdf} for
+pdf) in both cases.
@cindex PostScript output
- Doc: Canged @table example in Usage (issue 5492066),
pkx166h <=