| 1 |
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.4. |
| 2 |
.TH LILYPOND-BOOK "1" "December 2025" "lilypond-book 2.24.4" "User Commands" |
| 3 |
.SH NAME |
| 4 |
lilypond-book \- manual page for lilypond-book 2.24.4 |
| 5 |
.SH SYNOPSIS |
| 6 |
.B lilypond-book |
| 7 |
[\fI\,OPTION\/\fR]... \fI\,FILE\/\fR |
| 8 |
.SH DESCRIPTION |
| 9 |
Process LilyPond snippets in hybrid HTML, LaTeX, texinfo or DocBook document. |
| 10 |
.SH OPTIONS |
| 11 |
.TP |
| 12 |
\fB\-F\fR, \fB\-\-filter\fR=\fI\,FILTER\/\fR |
| 13 |
pipe snippets through FILTER [default: `convert\-ly \fB\-n\fR |
| 14 |
\-'] |
| 15 |
.TP |
| 16 |
\fB\-f\fR, \fB\-\-format\fR=\fI\,FORMAT\/\fR |
| 17 |
use output format FORMAT (texi [default], texi\-html, |
| 18 |
latex, html, docbook) |
| 19 |
.TP |
| 20 |
\fB\-h\fR, \fB\-\-help\fR |
| 21 |
show this help and exit |
| 22 |
.TP |
| 23 |
\fB\-I\fR, \fB\-\-include\fR=\fI\,DIR\/\fR |
| 24 |
add DIR to include path |
| 25 |
.TP |
| 26 |
\fB\-\-info\-images\-dir\fR=\fI\,DIR\/\fR |
| 27 |
format Texinfo output so that Info will look for |
| 28 |
images of music in DIR |
| 29 |
.TP |
| 30 |
\fB\-\-left\-padding\fR=\fI\,PAD\/\fR |
| 31 |
pad left side of music to align music in spite of |
| 32 |
uneven bar numbers (in mm) [default: 3.0] |
| 33 |
.TP |
| 34 |
\fB\-\-lily\-loglevel\fR=\fI\,LOGLEVEL\/\fR |
| 35 |
print lilypond log messages according to LOGLEVEL |
| 36 |
[default: none] |
| 37 |
.TP |
| 38 |
\fB\-\-lily\-output\-dir\fR=\fI\,DIR\/\fR |
| 39 |
write lily\-XXX files to DIR, link into \fB\-\-output\fR dir |
| 40 |
.TP |
| 41 |
\fB\-l\fR, \fB\-\-loglevel\fR=\fI\,LOGLEVEL\/\fR |
| 42 |
print log messages according to LOGLEVEL (NONE, ERROR, |
| 43 |
WARNING, PROGRESS [default], DEBUG) |
| 44 |
.TP |
| 45 |
\fB\-o\fR, \fB\-\-output\fR=\fI\,DIR\/\fR |
| 46 |
write output to DIR |
| 47 |
.TP |
| 48 |
\fB\-P\fR, \fB\-\-process\fR=\fI\,COMMAND\/\fR |
| 49 |
process ly_files using COMMAND FILE... |
| 50 |
.TP |
| 51 |
\fB\-\-redirect\-lilypond\-output\fR |
| 52 |
redirect the lilypond output |
| 53 |
.TP |
| 54 |
\fB\-s\fR, \fB\-\-safe\fR |
| 55 |
removed; using this option results in an error |
| 56 |
.TP |
| 57 |
\fB\-\-skip\-lily\-check\fR |
| 58 |
do not fail if no lilypond output is found |
| 59 |
.TP |
| 60 |
\fB\-\-skip\-png\-check\fR |
| 61 |
do not fail if no PNG images are found for EPS files |
| 62 |
.TP |
| 63 |
\fB\-\-use\-source\-file\-names\fR |
| 64 |
write snippet output files with the same base name as |
| 65 |
their source file |
| 66 |
.TP |
| 67 |
\fB\-V\fR, \fB\-\-verbose\fR |
| 68 |
be verbose |
| 69 |
.TP |
| 70 |
\fB\-\-version\fR |
| 71 |
show version number and exit |
| 72 |
.TP |
| 73 |
\fB\-w\fR, \fB\-\-warranty\fR |
| 74 |
show warranty and copyright |
| 75 |
.SS "Options only for the latex and texinfo backends:" |
| 76 |
.TP |
| 77 |
\fB\-\-latex\-program\fR=\fI\,PROG\/\fR |
| 78 |
run executable PROG instead of latex or, in case \fB\-\-pdf\fR |
| 79 |
option is set, instead of pdflatex |
| 80 |
.TP |
| 81 |
\fB\-\-texinfo\-program\fR=\fI\,PROG\/\fR |
| 82 |
run executable PROG instead of texi2pdf |
| 83 |
.TP |
| 84 |
\fB\-\-pdf\fR |
| 85 |
create PDF files for use with pdftex |
| 86 |
.SH EXAMPLES |
| 87 |
.IP |
| 88 |
\f(CW$ lilypond-book --filter="tr '[a-z]' '[A-Z]'" BOOK\fR |
| 89 |
.br |
| 90 |
\f(CW$ lilypond-book -F "convert-ly --no-version --from=2.0.0 -" BOOK\fR |
| 91 |
.br |
| 92 |
\f(CW$ lilypond-book --process='lilypond -I include' BOOK\fR |
| 93 |
.SH "REPORTING BUGS" |
| 94 |
Report bugs via bug\[email protected] |
| 95 |
.SH "SEE ALSO" |
| 96 |
The full documentation for |
| 97 |
.B lilypond-book |
| 98 |
is maintained as a Texinfo manual. If the |
| 99 |
.B info |
| 100 |
and |
| 101 |
.B lilypond-book |
| 102 |
programs are properly installed at your site, the command |
| 103 |
.IP |
| 104 |
.B info lilypond-book |
| 105 |
.PP |
| 106 |
should give you access to the complete manual. |