LILYPOND-BOOK(1)

πŸ’– NAME πŸ’–

okay bestie, this is lilypond-book β€” literally the LILYPOND-BOOK(1) manual page for lilypond-book 2.26.0 πŸ’…βœ¨


✨ SYNOPSIS ✨

lilypond-book [OPTION]... FILE

πŸŽ€ DESCRIPTION πŸŽ€

The whole vibe: process LilyPond snippets in hybrid HTML, LaTeX, texinfo or DocBook document. periodt πŸ’œ


πŸ’… OPTIONS πŸ’…

okay options time, bestie β€” every flag, every default, no skipping, fr fr 🫢

  • -F, --filter=FILTER β€” pipe snippets through FILTER [default: convert-ly -n -]
  • -f, --format=FORMAT β€” use output format FORMAT (texi [default], texi-html, latex, html, docbook)
  • -h, --help β€” show this help and exit
  • -I, --include=DIR β€” add DIR to include path
  • --info-images-dir=DIR β€” format Texinfo output so that Info will look for images of music in DIR
  • --left-padding=PAD β€” set minimum distance between left margin and staff to PAD (in mm) [default: 3.0]
  • --lily-loglevel=LOGLEVEL β€” print lilypond log messages according to LOGLEVEL [default: none]
  • --lily-output-dir=DIR β€” write lily-XXX files to DIR, link into --output dir
  • -l, --loglevel=LOGLEVEL β€” print log messages according to LOGLEVEL (NONE, ERROR, WARN, PROGRESS [default], DEBUG)
  • -o, --output=DIR β€” write output to DIR
  • -P, --process=COMMAND β€” process ly_files using COMMAND FILE...
  • --redirect-lilypond-output β€” redirect lilypond output messages to log files
  • -s, --safe β€” removed; using this option results in an error
  • --skip-lily-check β€” do not fail if no lilypond output is found
  • --skip-png-check β€” do not fail if no PNG images are found for EPS files
  • --use-source-file-names β€” write snippet output files with the same base name as their source file
  • -V, --verbose β€” be verbose
  • --version β€” show version number and exit
  • -w, --warranty β€” show warranty and copyright
heads up, bestie: -s / --safe is removed β€” using it gives you an error, no cap πŸ’€

🌸 Options only for the latex and texinfo backends 🌸

  • --pdf β€” create PDF files for use with pdftex

πŸ¦‹ Options only for the latex backend πŸ¦‹

  • --inline-vshift=VSHIFT β€” shift inline images vertically by VSHIFT (a factor of an image's height) [default: -0.3]
  • --latex-program=PROG β€” run executable PROG instead of latex or, in case --pdf option is set, instead of pdflatex

πŸ“ Options only for the texinfo backend πŸ“

  • --texinfo-program=PROG β€” run executable PROG instead of texi2pdf

🌈 EXAMPLES 🌈

iconic little demo moments: ✨

$ lilypond-book --format=latex --pdf FILE
$ lilypond-book --process='lilypond -I include' FILE
$ lilypond-book -F "convert-ly --no-version --from=2.0.0 -" FILE

😭 REPORTING BUGS 😭

Report bugs via bug-lilypond@gnu.org 🫢


πŸ‘‘ SEE ALSO πŸ‘‘

The full documentation for lilypond-book is maintained as a Texinfo manual. If the info and lilypond-book programs are properly installed at your site, the command

info lilypond-book

should give you access to the complete manual. iykyk πŸ’–


that's the whole vibe from lilypond-book 2.26.0, dated May 2026, on the LILYPOND-BOOK(1) manual page β€” mwah πŸ’‹βœ¨

πŸ“¦ where this page comes from