summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support/lyluatex/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/support/lyluatex/README.md')
-rw-r--r--Master/texmf-dist/doc/support/lyluatex/README.md70
1 files changed, 46 insertions, 24 deletions
diff --git a/Master/texmf-dist/doc/support/lyluatex/README.md b/Master/texmf-dist/doc/support/lyluatex/README.md
index d331ae9a6c2..4d9f3690e52 100644
--- a/Master/texmf-dist/doc/support/lyluatex/README.md
+++ b/Master/texmf-dist/doc/support/lyluatex/README.md
@@ -1,3 +1,4 @@
+Main author: [Fr. Jacques Peron](mailto:cataclop@hotmail.com)
This material is subject to the MIT license.
# Lyluatex
@@ -5,60 +6,81 @@ This material is subject to the MIT license.
In the preable of your document, include the package `lyluatex`:
- \usepackage{lyluatex}
+```TeX
+\usepackage{lyluatex}
+```
The `program` option permits the definition of an alternative path to
`lilypond`, for example:
- \usepackage[program=/opt/lilypond-dev/lilypond]{lyluatex}
+```TeX
+\usepackage[program=/opt/lilypond-dev/lilypond]{lyluatex}
+```
Thereafter, you can include a lilypond file with the command:
- \includely[staffsize=17]{PATH/TO/THE/FILE}
+```TeX
+\lilypondfile[staffsize=17]{PATH/TO/THE/FILE}
+```
The argument `staffsize`, which is optional, changes the size of the score. You
can change the size for all the subsequent scores in a document by placing the
following command before your first include statement to be so affected:
- \def\staffsize{24}
+```TeX
+\lysetoption{staffsize}{24}
+```
Next, you simply need to compile the document normally with the command
`lualatex -shell-escape` :
- lualatex -shell-escape DOCUMENT.TEX
+```bash
+lualatex -shell-escape DOCUMENT.TEX
+```
-Another "more secure" option is to add `lilypond` to default allowed commands :
+Another "more secure" option is to add `lilypond` and `gs` to default allowed commands :
- shell_escape_commands=$(kpsewhich -expand-var '$shell_escape_commands'),lilypond lualatex DOCUMENT.TEX
+```bash
+shell_escape_commands=$(kpsewhich -expand-var '$shell_escape_commands'),lilypond,gs lualatex DOCUMENT.TEX
+```
On systems with low RAM, when working on big documents, you could encounter
*buffer overflows* in `lilypond` calls. In that case, first compile with option
`-draftmode`, then compile again without this option.
-You can also input music directly into your docoment with the `ly` environment.
+You can also input music directly into your docoment with the `lilypond` environment.
This is only recommended for relatively short snippets. For example:
- \begin{ly}
- \relative c' { c d e f g a b c }
- \end{ly}
+```TeX
+\begin{lilypond}
+\relative c' { c d e f g a b c }
+\end{lilypond}
+```
Finally, for truly short snippets, there is also the `\lily` command. Example:
- \lily[staffsize=12]{c' d' g'}
-
-**Nota bene:** The `\lily` command *does not* support blocks of LilyPond code
-with explicit `\score` blocks. Such code must be included with the `ly`
-environment or as a separate file.
+```TeX
+\lilypond[staffsize=12]{c' d' g'}
+```
+**Nota bene:** The `\lilypond` command *does not* support blocks of LilyPond
+code with explicit `\score` blocks. Such code must be included with the
+`lilypond` environment or as a separate file.
## Migration from `lilypond-book`
-In order to facilitate the migration from `lilypond-book`, `lyluatex` defines
-the command `\lilypondfile` with the same arguments as `\includely`. There is
-also the environment `lilypond` which is the same as `ly`, and the command
-`\lilypond` should work as with `lilypond-book`.
+In order to facilitate the migration from `lilypond-book`, `\lilypondfile`,
+the environment `lilypond` and the command `\lilypond` should work nearly
+as with `lilypond-book` ; for even more identical behaviour, call `lyluatex`
+like follows:
+
+```TeX
+\usepackage[program=/opt/lilypond-dev/lilypond]{lyluatex}
+```
+
+That way, documents typeset with `lilypond-book` can be adapted to use
+`lyluatex` without much difficulty.
+
+# Credits
-In this manner, documents typeset with `lilypond-book` can be adapted to use
-`lyluatex` without much difficulty. Just keep in mind that apart from the
-`staffsize` parameter, the optional parameters that `lilypond-book` supports are
-not supported by `lyluatex` (at least for now).
+Cf. [Contributors.md](Contributors.md)