2.4 Command-line options for convert-ly

The program is invoked as follows:

convert-ly [option]… filename

By default, convert-ly writes its data to standard output.

The following options can be given:


Show version number and exit.

-h, --help

Show usage help and exit.

-d, --diff-version-update

Increase the \version string only if the file has actually been changed. In that case, the version header will correspond to the version after the last actual change. An unstable version number will be rounded up to the next stable version number unless that would exceed the target version number. Without this option, the version will instead reflect the last attempted conversion.

-e, --edit

Apply the conversions directly to the input file, modifying it in-place. If the original file is called myfile.ly, a backup is retained under the name myfile.ly~, i.e., a tilde character gets appended. This backup file may be a hidden file on some operating systems.

If you want the converted output to be stored under a different name, redirect the standard output to a file.

convert-ly myfile.ly > mynewfile.ly

See also option --backup-numbered.

-b, --backup-numbered

When used with the ‘-e’ option, number the backup files so that no previous version is overwritten. Assuming the input file is called myfile.ly, try to store the backup in myfile.ly.~1~. If it exists, try myfile.ly.~2~ instead, etc. The backup files may be hidden on some operating systems.

-f, --from=from-patchlevel

Set the version to convert from. If this is not set, convert-ly will guess it on the basis of the (first) \version string in the file. Example: --from=2.10.25

-h, --help

Print usage help.

-l loglevel, --loglevel=loglevel

Set the output verbosity to loglevel. Possible values, in upper case, are PROGRESS (the default), NONE, WARN, ERROR, and DEBUG.

-n, --no-version

Normally, convert-ly adds a \version indicator to the output. Specifying this option suppresses this.

-c, --current-version

By default, convert-ly updates the \version string to the lowest necessary version. If this option is given, the current LilyPond version (2.25.18) is used instead.

-s, --show-rules

Show conversion descriptions and exit. The amount of information can be adjusted with options --from and --to.

-t, --to=to-patchlevel

Explicitly set which \version to convert to, otherwise the default is the most current value. It must be higher than the starting version.

convert-ly --to=2.14.1 myfile.ly
-v, --verbose

Display rule descriptions during conversion.

-w, --warranty

Show warranty and copyright and exit.

To upgrade LilyPond fragments in Texinfo files, use

convert-ly --from=… --to=… --no-version *.itely

To see the changes in the LilyPond syntax between two versions, use

convert-ly --from=… --to=… -s

LilyPond Application Usage v2.25.18 (development-branch).